@voltro/database 0.11.0 → 0.11.2

package/dist/index.d.ts

@@ -82,6 +82,9 @@ export declare interface AnnClause {
 
 export declare type AnyMixin = MixinDefinition<Record<string, ColumnDefinition<unknown>>>;
 
+/** Any table — the loose shape these helpers accept structurally. */
+declare type AnyTable = Table<string, Record<string, ColumnDefinition<unknown>>, boolean, string>;
+
 /**
  * Array column — wraps another column constructor to declare an
  * array of that element type. Postgres-native (`text[]`, `integer[]`,
@@ -173,6 +176,18 @@ export declare const auditAllTableIndexes: (tables: ReadonlyArray<Table<string,
  */
 export declare const auditTableIndexes: (table: Table<string, Record<string, ColumnDefinition<unknown>>, boolean, string>) => ReadonlyArray<IndexAuditIssue>;
 
+/** Columns the framework fills on write (auto-id floor + tenant/audit mixins),
+ *  so an insert need not supply them. Name-based on purpose: a hand-declared
+ *  `createdAt` with no default reads as optional here (the lenient direction —
+ *  never rejects valid code), while the mixin-managed ones are always filled.
+ *  Runtime tuple + the type derived from it, so a consumer that must skip these
+ *  at runtime (e.g. `@voltro/testing`'s `fixtureRow`, which fills only
+ *  caller-owned required columns) reads the SAME list the insert-row type uses —
+ *  no second copy to drift. */
+export declare const AUTO_FILLED_COLUMNS: readonly ["id", "tenantId", "createdAt", "updatedAt", "createdBy", "updatedBy", "deletedAt", "deletedBy"];
+
+declare type AutoFilledColumn = (typeof AUTO_FILLED_COLUMNS)[number];
+
 export declare const avg: (column: string, alias?: string) => AggregateColumn;
 
 export declare const avgOver: (column: string, alias?: string) => WindowBuilder;
@@ -223,7 +238,7 @@ export declare interface BackfillSpec<TsType = unknown> {
  * bytesStored: bigint().default('0'),
  * ```
  */
-export declare const bigint: () => ColumnBuilder<string, "bigint">;
+export declare const bigint: () => ColumnBuilder<string, "bigint", boolean>;
 
 /**
  * Bind the request to the store for the subject's home region. `stores` is the
@@ -238,7 +253,7 @@ export declare const bindResidentStore: <S>(subject: ResidencySubject, config: R
     readonly placement: ResidentPlacement;
 };
 
-export declare const boolean: () => ColumnBuilder<boolean, "boolean">;
+export declare const boolean: () => ColumnBuilder<boolean, "boolean", boolean>;
 
 export declare type BranchEvent = 'provision' | 'provisioned' | 'fail' | 'destroy' | 'destroyed';
 
@@ -387,7 +402,7 @@ export declare class BranchTransitionInvalid extends Error {
  *  (mysql/mariadb) / `VARBINARY(MAX)` (mssql). Values round-trip as
  *  `Uint8Array`. Use for storing bytes IN the database (e.g. the
  *  `database` storage provider); keep large blobs in object storage. */
-export declare const bytes: () => ColumnBuilder<Uint8Array<ArrayBufferLike>, "bytes">;
+export declare const bytes: () => ColumnBuilder<Uint8Array<ArrayBufferLike>, "bytes", boolean>;
 
 export declare type CaughtUpVerdict = 'caught-up' | 'behind';
 
@@ -504,9 +519,9 @@ export declare const collectSubqueries: (predicate: Predicate) => Generator<{
  */
 export declare const column: <T = string | number | boolean | Date | null>(columnName: string, alias?: string) => AggregateColumn<T>;
 
-export declare class ColumnBuilder<TsType, Type extends ColumnType> {
+export declare class ColumnBuilder<TsType, Type extends ColumnType, HasDefault extends boolean = boolean> {
     private readonly definition;
-    constructor(definition: ColumnDefinition<TsType, Type>);
+    constructor(definition: ColumnDefinition<TsType, Type, HasDefault>);
     /**
      * `raw(ddl)` columns reject any modifier that would add a second
      * source of truth for nullability / default / uniqueness. The DDL
@@ -516,7 +531,7 @@ export declare class ColumnBuilder<TsType, Type extends ColumnType> {
      * the error site is the schema file.
      */
     private rejectIfRaw;
-    nullable(): ColumnBuilder<TsType | null, Type>;
+    nullable(): ColumnBuilder<TsType | null, Type, HasDefault>;
     /**
      * Encrypt this column's value at rest (AES-256-GCM). The runtime
      * store middleware transparently encrypts on write + decrypts on
@@ -601,7 +616,7 @@ export declare class ColumnBuilder<TsType, Type extends ColumnType> {
      * SQL-side fill (legacy seeds, raw inserts); factory wins for
      * framework-routed inserts.
      */
-    default(value: TsType | 'now' | (() => TsType)): this;
+    default(value: TsType | 'now' | (() => TsType)): ColumnBuilder<TsType, Type, true>;
     /**
      * Mark this column as computed from other row fields. The function
      * runs on INSERT AFTER defaults are applied, and again on every
@@ -657,7 +672,7 @@ export declare class ColumnBuilder<TsType, Type extends ColumnType> {
      */
     generatedAs(expr: string, options?: {
         stored?: boolean;
-    }): this;
+    }): ColumnBuilder<TsType, Type, true>;
     /**
      * Migration backfill. Tells the planner how to populate existing rows
      * when this column is added as NOT NULL to a populated table — without
@@ -754,7 +769,7 @@ export declare class ColumnBuilder<TsType, Type extends ColumnType> {
      * Pass `as const` or a `const`-typed array — the TS inference
      * preserves the literals only when the array is a tuple of literals.
      */
-    oneOf<const Values extends readonly [string, ...string[]]>(this: ColumnBuilder<TsType, 'text'>, values: Values): ColumnBuilder<null extends TsType ? Values[number] | null : Values[number], 'text'>;
+    oneOf<const Values extends readonly [string, ...string[]]>(this: ColumnBuilder<TsType, 'text', HasDefault>, values: Values): ColumnBuilder<null extends TsType ? Values[number] | null : Values[number], 'text', HasDefault>;
     /**
      * Cap a text column's length → `VARCHAR(n)` (postgres / mysql / mariadb) /
      * `NVARCHAR(n)` (mssql), instead of the unbounded `LONGTEXT` / `TEXT`
@@ -777,7 +792,7 @@ export declare class ColumnBuilder<TsType, Type extends ColumnType> {
      * Method only resolves on `text()` builders (the `Type extends 'text'`
      * guard), like `oneOf`. `n` is a character count.
      */
-    maxLength(this: ColumnBuilder<TsType, 'text'>, n: number): ColumnBuilder<TsType, 'text'>;
+    maxLength(this: ColumnBuilder<TsType, 'text', HasDefault>, n: number): ColumnBuilder<TsType, 'text', HasDefault>;
     /**
      * Attach a raw SQL `CHECK` to this column — a DB-ENFORCED invariant
      * that holds regardless of which client writes the row (defense-in-
@@ -804,11 +819,12 @@ export declare class ColumnBuilder<TsType, Type extends ColumnType> {
     __definition(): ColumnDefinition<TsType, Type>;
 }
 
-export declare interface ColumnDefinition<TsType, Type extends ColumnType = ColumnType> {
+export declare interface ColumnDefinition<TsType, Type extends ColumnType = ColumnType, HasDefault extends boolean = boolean> {
     readonly type: Type;
     readonly nullable: boolean;
     readonly unique: boolean;
     readonly hasDefault: boolean;
+    /* Excluded from this release type: __hasDefault */
     readonly defaultValue?: unknown;
     /**
      * Application-side default factory. When set, the MutationStore
@@ -1128,6 +1144,15 @@ export declare interface ColumnDefinition<TsType, Type extends ColumnType = Colu
     readonly __tsType?: TsType;
 }
 
+/** `true` when the column's declared default flag is `true` (`.default()` narrows
+ *  it; a plain column reads `boolean`, which is NOT `[true]`). Tuple-wrapped so
+ *  `boolean` does not distribute. */
+declare type ColumnHasDefault<D> = D extends ColumnDefinition<unknown, ColumnType, infer HD> ? ([HD] extends [true] ? true : false) : false;
+
+/** A column may be omitted from an insert when it is auto-filled, has a default,
+ *  or is nullable. */
+declare type ColumnOptionalForInsert<K extends PropertyKey, D> = K extends AutoFilledColumn ? true : ColumnHasDefault<D> extends true ? true : null extends InferColumn<D> ? true : false;
+
 /**
  * The per-column mapping, over a column DEFINITION — what `table.fields` holds.
  *
@@ -1562,7 +1587,7 @@ export declare interface DataStore {
 }
 
 /** Calendar date without time. */
-export declare const date: () => ColumnBuilder<Date, "date">;
+export declare const date: () => ColumnBuilder<Date, "date", boolean>;
 
 export declare const dbEnum: <const Values extends ReadonlyArray<string>>(name: string, values: Values) => DbEnumHandle<Values>;
 
@@ -1670,7 +1695,17 @@ export declare const decodeRowsFromSchema: <T extends Record<string, unknown>>(r
  * through untouched, so turning encryption on doesn't break reads of
  * rows written before it. Operates per-row on shallow copies.
  */
-export declare const decryptFieldsOnRead: (rows: ReadonlyArray<Row>, table: TableLike | undefined, cipher: FieldCipher | undefined) => ReadonlyArray<Row>;
+export declare const decryptFieldsOnRead: (rows: ReadonlyArray<Row>, table: TableLike | undefined, cipher: FieldCipher | undefined, options?: {
+    /** Default `'throw'` — see `OnDecryptError`. */
+    readonly onError?: OnDecryptError;
+    /** Called once per undecryptable column when `onError: 'null'`, so the
+     *  degraded read leaves a trace naming the `table.column`. */
+    readonly warn?: (info: {
+        readonly table: string;
+        readonly column: string;
+        readonly reason: string;
+    }) => void;
+}) => ReadonlyArray<Row>;
 
 export declare const defineMigration: (input: MigrationDefinitionInput) => MigrationDefinition;
 
@@ -2002,8 +2037,31 @@ export declare interface FieldCipher {
     readonly decrypt: (ciphertext: string) => string;
 }
 
+/**
+ * An `.encrypted()` column could not be decrypted with the ACTIVE cipher —
+ * almost always a value encrypted under a DIFFERENT key (a prod/staging snapshot
+ * restored into a dev DB whose key differs). Typed and `_tag`-carrying (the same
+ * shape `storeErrors.ts` uses, deliberately NOT `Data.TaggedError` — that trips
+ * TS2742 on the `.d.ts` and drags `effect/Cause` into this browser-safe codec) so
+ * it is `catchTag`-matchable and, above all, READABLE: the message names the
+ * `table.column` and the reason instead of surfacing a raw
+ * `field cipher: malformed ciphertext` with no context. The ciphertext itself is
+ * NEVER included.
+ */
+export declare class FieldDecryptionError extends Error {
+    readonly _tag = "FieldDecryptionError";
+    readonly table: string;
+    readonly column: string;
+    readonly reason: string;
+    constructor(info: {
+        readonly table: string;
+        readonly column: string;
+        readonly reason: string;
+    });
+}
+
 export declare type FieldDefinitions<F extends FieldsInput> = {
-    [K in keyof F]: F[K] extends ColumnBuilder<infer T, infer Type> ? ColumnDefinition<T, Type> : never;
+    [K in keyof F]: F[K] extends ColumnBuilder<infer T, infer Type, infer HD> ? ColumnDefinition<T, Type, HD> : never;
 };
 
 export declare type FieldsInput = Record<string, ColumnBuilder<unknown, ColumnType>>;
@@ -2069,6 +2127,11 @@ export declare interface FileMigrationContext {
     readonly appliedAt: string;
 }
 
+/** Flatten an intersection into a single object type for readable errors/hovers. */
+declare type Flatten<O> = {
+    [K in keyof O]: O[K];
+};
+
 /**
  * Multi-line pretty block for the terminal. Tries to teach, not just
  * complain — labels every section (`table` / `redundant` / `covered
@@ -2218,7 +2281,7 @@ export declare interface HybridSearchOptions {
  * `row.id`; for `numeric` the key is omitted so the dialect's
  * SERIAL/AUTO_INCREMENT/IDENTITY clause fires.
  */
-export declare const id: (options?: IdSchemeInput) => ColumnBuilder<string, "id">;
+export declare const id: (options?: IdSchemeInput) => ColumnBuilder<string, "id", boolean>;
 
 /**
  * Fully-resolved scheme stored on the `id` column definition AFTER
@@ -2390,6 +2453,12 @@ export declare const inferForeignKey: (target: TableLike, sourceTableName: strin
  */
 export declare type InferIndexNames<T> = T extends Table<string, Record<string, ColumnDefinition<unknown>>, boolean, infer N> ? N : never;
 
+export declare type InferInsertRow<T> = T extends Table<string, infer F, boolean, string> ? Flatten<{
+    readonly [K in keyof F as ColumnOptionalForInsert<K, F[K]> extends true ? never : K]: InferColumn<F[K]>;
+} & {
+    readonly [K in keyof F as ColumnOptionalForInsert<K, F[K]> extends true ? K : never]?: InferColumn<F[K]>;
+}> : never;
+
 /** Row type for the table — useful for typing application code. */
 export declare type InferRow<T> = T extends Table<string, infer F, boolean, string> ? InferRowFromFields<F> : never;
 
@@ -2400,11 +2469,18 @@ export declare type InferRowFromFields<F extends Record<string, ColumnDefinition
 /** Row type for a view — mirrors `InferRow` for tables. */
 export declare type InferViewRow<V> = V extends View<string, infer F> ? InferRowFromFields<F> : never;
 
+/**
+ * Insert a row, typed against the table: the payload must carry every required
+ * column (NOT NULL, no default, not auto-filled) or it is a compile error.
+ * Returns the stored row typed as `InferRow<T>`.
+ */
+export declare const insertRow: <T extends AnyTable>(store: TypedInsertStore, table: T, row: InferInsertRow<T>) => Promise<InferRow<T>>;
+
 export declare const inSet: <RowOf = Record<string, unknown>, K extends keyof RowOf & string = keyof RowOf & string>(column: K, values: ReadonlyArray<RowOf[K]>) => PredicateLeaf;
 
 export declare const inSubquery: <RowOf = Record<string, unknown>, K extends keyof RowOf & string = keyof RowOf & string>(column: K, subquery: QueryWithDescriptor | QueryDescriptor) => SubqueryInPredicate;
 
-export declare const integer: () => ColumnBuilder<number, "integer">;
+export declare const integer: () => ColumnBuilder<number, "integer", boolean>;
 
 /** `INTERSECT` — rows present in EVERY input. */
 export declare const intersect: (...queries: ReadonlyArray<QueryWithDescriptorAny>) => Query<Row, string>;
@@ -2419,7 +2495,7 @@ export declare const intersect: (...queries: ReadonlyArray<QueryWithDescriptorAn
  * slaDeadline: interval()
  * ```
  */
-export declare const interval: () => ColumnBuilder<string, "interval">;
+export declare const interval: () => ColumnBuilder<string, "interval", boolean>;
 
 /** Is this namespace one of ours? (so a teardown sweep never touches a real
  *  tenant namespace). */
@@ -2427,6 +2503,8 @@ export declare const isBranchNamespace: (namespace: string) => boolean;
 
 export declare const isEncrypted: (value: unknown) => value is string;
 
+export declare const isFieldDecryptionError: (e: unknown) => e is FieldDecryptionError;
+
 /** Type-guard for the discovery walker. */
 export declare const isFileMigration: (value: unknown) => value is FileMigration;
 
@@ -2494,7 +2572,7 @@ export declare const isView: (t: TableLike) => t is View<string, Record<string,
 export declare type JoinsMap = Record<string, Record<string, unknown>>;
 
 /** Typed JSON column. Pass the type parameter to record the expected shape. */
-export declare const json: <T = unknown>() => ColumnBuilder<T, "json">;
+export declare const json: <T = unknown>() => ColumnBuilder<T, "json", boolean>;
 
 export declare const jsonField: (column: string, ...path: ReadonlyArray<string | number>) => JsonFieldFilter;
 
@@ -2760,6 +2838,21 @@ export declare interface MigrationStepContext {
 
 export declare const min: (column: string, alias?: string) => AggregateColumn;
 
+/**
+ * The `conflictColumns` an upsert names that are absent from its payload. An
+ * upsert keyed on a column the row doesn't set can't match a conflict target —
+ * the dialect fails obscurely (or worse, inserts a duplicate). Naming it at the
+ * call is the difference between a one-line fix and reading a driver error.
+ */
+export declare const missingConflictColumns: (conflictColumns: ReadonlyArray<string>, row: Row) => ReadonlyArray<string>;
+
+/**
+ * Columns the row must carry but doesn't. Empty when the row is complete.
+ * `null` counts as missing for a NOT NULL column — the dialect would reject it
+ * just the same, and a clear message beats a driver error either way.
+ */
+export declare const missingRequiredColumns: (table: TableLike, row: Row) => ReadonlyArray<string>;
+
 export declare const mixin: <const Input extends FieldsInput>(options: MixinOptions<Input>) => MixinDefinition<MaterializedMixinFields<Input>>;
 
 export declare interface MixinDefinition<F extends Record<string, ColumnDefinition<unknown>>> {
@@ -2887,6 +2980,17 @@ export declare interface NotPredicate {
  */
 export declare const numeric: (precision: number, scale?: number) => ColumnBuilder<string, "decimal">;
 
+/**
+ * What a decrypt failure does. `'throw'` (default, and the ONLY safe production
+ * behaviour) surfaces a typed `FieldDecryptionError`. `'null'` degrades the one
+ * unreadable column to `null` and warns — for DEV / a data migration where a
+ * snapshot carries ciphertext bound to another key: one undecryptable row must
+ * not nuke every read (and its siblings that WOULD decrypt), it should surface as
+ * "re-enter this credential", not a 500. Never enable `'null'` in production — it
+ * silently hides a real key mismatch.
+ */
+export declare type OnDecryptError = 'throw' | 'null';
+
 export declare const one: (target: TableRef, options?: {
     readonly foreignKey?: string;
     readonly sourceKey?: string;
@@ -3867,7 +3971,7 @@ declare interface RawSqlFragment {
  *  mssql `FLOAT`, sqlite `REAL`. Drivers return JS numbers — no codec. Use for
  *  fractional values (ratings, percentages, measurements) where `integer()`
  *  would truncate. */
-export declare const real: () => ColumnBuilder<number, "real">;
+export declare const real: () => ColumnBuilder<number, "real", boolean>;
 
 /**
  * Foreign-key reference to another table's id column.
@@ -5061,9 +5165,9 @@ export declare class TenantResidencyUnresolved extends Error {
     constructor(message: string);
 }
 
-export declare const text: () => ColumnBuilder<string, "text">;
+export declare const text: () => ColumnBuilder<string, "text", boolean>;
 
-export declare const timestamp: () => ColumnBuilder<Date, "timestamp">;
+export declare const timestamp: () => ColumnBuilder<Date, "timestamp", boolean>;
 
 /**
  * The timestamp mapping as a STANDALONE field schema: `Date` in the
@@ -5106,6 +5210,19 @@ export declare const timestampMs: Schema.Schema<Date, number>;
  */
 export declare const timestampMsOrNull: Schema.Schema<Date | null, number | null>;
 
+/** The minimal store surface `insertRow` needs — satisfied by `ctx.store`. */
+export declare interface TypedInsertStore {
+    readonly insert: (table: string, row: Row) => Promise<Row>;
+}
+
+/** The minimal store surface `upsertRow` needs. */
+export declare interface TypedUpsertStore {
+    readonly upsert: (table: string, row: Row, options: {
+        conflictColumns: ReadonlyArray<string>;
+        update?: ReadonlyArray<string> | ((existing: Row) => Readonly<Record<string, unknown>>);
+    }) => Promise<Row>;
+}
+
 /**
  * `(SELECT ...) UNION (SELECT ...) ...` — dedup-merge. Q6.
  *
@@ -5139,6 +5256,15 @@ export declare interface UniqueSpec {
     readonly dedup?: 'fail' | 'suffix-counter' | Statement.Fragment;
 }
 
+/**
+ * Upsert a row, typed the same way. `conflictColumns` is constrained to the
+ * table's own column names, so a typo'd conflict key is a compile error too.
+ */
+export declare const upsertRow: <T extends AnyTable>(store: TypedUpsertStore, table: T, row: InferInsertRow<T>, options: {
+    readonly conflictColumns: ReadonlyArray<keyof InferRow<T> & string>;
+    readonly update?: ReadonlyArray<keyof InferRow<T> & string> | ((existing: InferRow<T>) => Readonly<Partial<InferRow<T>>>);
+}) => Promise<InferRow<T>>;
+
 /**
  * Validate one column-name key on a table's fields map. Throws on
  * empty / invalid characters / > 63 bytes. Records a WARN above 50.