model add

Define a typed entity and its repo. Requires db init first.

vsceasy model add --name user --fields "id:string!,name:string,email?:string@,active:boolean"

Flags

Flag	Type	Notes
--name	text	Required. Model name (singular, e.g. user).
--fields	spec	Compact field spec. Omit to use the interactive loop.
--plural	text	Repo handle. Defaults to <Name>s.
--collection	text	On-disk collection name. Defaults to the lowercased plural.

Field spec

Comma-separated name:type entries with flags:

Flag	Position	Meaning
!	after type	primary key
@	after type	indexed
?	after name	optional

id:string!            primary key
name:string           required
email?:string@        optional + indexed
role:"admin"|"user"   literal union
score:number!@        primary key + indexed

If no ! is set, id (or the first field) becomes the primary key.

Relations

Point a field at another model with ref(Model) — Symfony-style. The field becomes a <name>Id foreign key, and the relation is recorded so crud add renders a populated dropdown for it.

category:ref(Category)              FK categoryId, dropdown of Category rows
category:ref(Category, label=name)  show Category.name in the dropdown

The referenced model must already exist (model add errors otherwise, naming the model to create first). In the interactive loop, the prompt lists the models you can relate to.

vsceasy model add --name category --fields "id:string!,name:string"
vsceasy model add --name todo \
  --fields "id:string!,title:string,category:ref(Category)"

src/models/Todo.ts

export interface Todo {
  id: string;
  title: string;
  categoryId: string;  // → Category
}

export const Todos = defineEntity<Todo>('todos', { primaryKey: 'id' });
export const TodosRepo = () => db()(Todos);

/** Relation metadata — used by `vsceasy crud add` to populate pickers. */
export const TodoRelations = {
  categoryId: { model: 'Category' },
} as const;

The default dropdown label is the related model’s first string field; override it with label=<field>.

Note

Relations are ManyToOne (a foreign key on this model). The FK stores the related row’s id; there’s no join table or cascade — the mini-ORM stays simple.

Examples

# one-shot spec
vsceasy model add --name user --fields "id:string!,name:string,email?:string@"

# interactive — type one field per line, blank to finish
vsceasy model add --name post

src/models/User.ts

import { defineEntity, db } from '../helpers/db';

export interface User {
  id: string;
  name: string;
  email?: string;
}

export const Users = defineEntity<User>('users', {
  primaryKey: 'id',
  indexes: ['email'],
});

export const UsersRepo = () => db()(Users);

Use the repo anywhere after initDb ran:

await UsersRepo().insert({ id: 'u1', name: 'Jane' });
const u = await UsersRepo().findById('u1');