@ultimat3/entity 1.0.0 → 1.1.0

package/src/types.d.ts

@@ -1,99 +0,0 @@
-/** Postgres types the blessed builders emit. `money` expands to `bigint` + `char(3)`. */
-export type ColumnKind = 'uuid' | 'text' | 'char' | 'boolean' | 'integer' | 'bigint' | 'timestamptz' | 'jsonb' | 'money';
-export type ColumnDefault = {
-    readonly kind: 'value';
-    readonly value: string | number | boolean | null;
-} | {
-    readonly kind: 'generated';
-    readonly by: 'uuid-v7' | 'now';
-};
-export type OnDelete = 'cascade' | 'restrict' | 'set null';
-export interface ReferenceOptions {
-    readonly onDelete?: OnDelete;
-}
-/** The single value a money column puts on the row. Two physical columns back it. */
-export interface MoneyValue {
-    readonly minor: bigint;
-    readonly currency: string;
-}
-/** What a writer may hand a money column. An integer `number` widens; a float throws. */
-export interface MoneyInput {
-    readonly minor: bigint | number;
-    readonly currency: string;
-}
-/**
- * What the author declared. Where it landed — table, property key, physical name — is the
- * binding `entity()` records (see `column.ts`), so a name is never written twice.
- */
-export interface ColumnMeta {
-    readonly kind: ColumnKind;
-    readonly notNull: boolean;
-    readonly primaryKey: boolean;
-    readonly unique: boolean;
-    readonly index: boolean;
-    /** Presence of a tenant column is what turns tenancy on. See `tenancy.ts`. */
-    readonly tenant: boolean;
-    readonly length?: number;
-    readonly values?: readonly string[];
-    readonly default?: ColumnDefault;
-    readonly onUpdate?: ColumnDefault;
-    /** Takes the physical name, so a CHECK can be written before that name is known. */
-    readonly check?: (column: string) => string;
-    /** A thunk: schema modules reference each other in a cycle. */
-    readonly references?: () => AnyColumn;
-    readonly onDelete?: OnDelete;
-}
-/**
- * `Optional` is the phantom that says "this column has a default", so an insert may omit it.
- * It is a real boolean at runtime too, so nothing has to be re-derived to check it.
- */
-export interface Column<T, Optional extends boolean = false> {
-    readonly $meta: ColumnMeta;
-    /** Runtime guard AND the carrier of the column's TypeScript type. */
-    readonly $parse: (value: unknown) => T;
-    readonly $optional: Optional;
-    /** `boolean`: only a uuid key carries a generated default, so only it becomes optional. */
-    primaryKey(): Column<T, boolean>;
-    nullable(): Column<T | null, Optional>;
-    unique(): Column<T, Optional>;
-    /** Marks the tenant column; a query without an org predicate then throws. */
-    tenant(): Column<T, Optional>;
-    references(target: () => AnyColumn, options?: ReferenceOptions): Column<T, Optional>;
-    default(value: T): Column<T, true>;
-}
-/** A uuid primary key is generated (v7) when omitted, which is why it narrows to `true`. */
-export interface UuidColumn<Optional extends boolean = false> extends Column<string, Optional> {
-    primaryKey(): Column<string, true>;
-}
-export interface TimestampColumn<Optional extends boolean = false> extends Column<Date, Optional> {
-    defaultNow(): TimestampColumn<true>;
-    onUpdateNow(): TimestampColumn<Optional>;
-}
-export type AnyColumn = Column<unknown, boolean>;
-export type ColumnMap = Readonly<Record<string, AnyColumn>>;
-export type TypeOf<C> = C extends Column<infer T, boolean> ? T : never;
-/** The row type a column set describes. This derivation is why the package exists. */
-export type RowOf<C extends ColumnMap> = {
-    readonly [K in keyof C]: TypeOf<C[K]>;
-};
-type DefaultedKeys<C extends ColumnMap> = {
-    [K in keyof C]-?: C[K]['$optional'] extends true ? K : never;
-}[keyof C];
-/** Money is the one column whose write shape is wider than its row shape. */
-type InputOf<T> = T extends MoneyValue ? MoneyInput : T;
-/** What an insert must supply: every column except the ones carrying a default. */
-export type Insertable<C extends ColumnMap> = {
-    readonly [K in Exclude<keyof C, DefaultedKeys<C>>]: InputOf<TypeOf<C[K]>>;
-} & {
-    readonly [K in DefaultedKeys<C>]?: InputOf<TypeOf<C[K]>>;
-};
-export interface IndexDef {
-    readonly name: string;
-    readonly columns: readonly string[];
-    readonly unique: boolean;
-    readonly order?: 'asc' | 'desc';
-    /** Partial index predicate — a soft-deleted row is excluded with this. */
-    readonly where?: string;
-}
-export {};
-//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAOA,yFAAyF;AACzF,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,MAAM,GACN,SAAS,GACT,SAAS,GACT,QAAQ,GACR,aAAa,GACb,OAAO,GACP,OAAO,CAAC;AAEZ,MAAM,MAAM,aAAa,GACrB;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;CAAE,GAC5E;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,GAAG,KAAK,CAAA;CAAE,CAAC;AAEnE,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;AAE3D,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAC9B;AAED,qFAAqF;AACrF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,yFAAyF;AACzF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,8EAA8E;IAC9E,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,oFAAoF;IACpF,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;IAC5C,+DAA+D;IAC/D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,SAAS,CAAC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,EAAE,QAAQ,SAAS,OAAO,GAAG,KAAK;IACzD,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,qEAAqE;IACrE,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC7B,2FAA2F;IAC3F,UAAU,IAAI,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACjC,QAAQ,IAAI,MAAM,CAAC,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,MAAM,IAAI,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9B,6EAA6E;IAC7E,MAAM,IAAI,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9B,UAAU,CAAC,MAAM,EAAE,MAAM,SAAS,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACrF,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;CACpC;AAED,4FAA4F;AAC5F,MAAM,WAAW,UAAU,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5F,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,eAAe,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC;IAC/F,UAAU,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IACpC,WAAW,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;CAC1C;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAEjD,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAE5D,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEvE,sFAAsF;AACtF,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,IAAI;IACvC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACtC,CAAC;AAEF,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,IAAI;KACvC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;CAC7D,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,6EAA6E;AAC7E,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,UAAU,GAAG,UAAU,GAAG,CAAC,CAAC;AAExD,mFAAmF;AACnF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI;IAC5C,QAAQ,EAAE,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1E,GAAG;IACF,QAAQ,EAAE,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,0EAA0E;IAC1E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/src/types.js

@@ -1,8 +0,0 @@
-// The structural vocabulary of a column. Drizzle is the production backing for the physical
-// layer (see README); declaring the shape we consume instead of depending on an ORM keeps the
-// emitted SQL readable and keeps this package free of a dependency an agent must learn to read.
-//
-// A column carries its TypeScript type in `$parse`, which is what lets the row type be derived
-// from the column set instead of being written a second time as a hand-maintained schema.
-export {};
-//# sourceMappingURL=types.js.map

package/src/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,8FAA8F;AAC9F,gGAAgG;AAChG,EAAE;AACF,+FAA+F;AAC/F,0FAA0F"}