@palbase/backend 8.4.0 → 8.6.0

package/dist/{index-LGFGRWCB.d.ts → index-CFD7RDMY.d.ts}

@@ -4,7 +4,7 @@ import { D as DBClient } from './endpoint-fW9yWla0.js';
 /** On delete action for foreign key references. */
 type OnDeleteAction = 'cascade' | 'set null' | 'restrict' | 'no action';
 /** Column type identifiers. */
-type ColumnType = 'uuid' | 'text' | 'integer' | 'bigint' | 'boolean' | 'timestamp' | 'jsonb' | 'enum';
+type ColumnType = 'uuid' | 'text' | 'integer' | 'bigint' | 'numeric' | 'boolean' | 'timestamp' | 'jsonb' | 'enum';
 /** Base column definition shared by all column types. */
 interface ColumnDef {
     type: ColumnType;
@@ -26,57 +26,75 @@ declare const __colKind: unique symbol;
 declare const __colNullable: unique symbol;
 declare const __colHasDefault: unique symbol;
 declare const __colEnumValues: unique symbol;
+declare const __colPayload: unique symbol;
 /**
  * Fluent column builder with phantom type params:
  *  K — ColumnType literal (e.g. "text", "integer")
  *  N — boolean: true when nullable() has been called last (false = NOT NULL)
  *  D — boolean: true when a default has been set
  *  E — enum value union (never for non-enum columns)
+ *  P — jsonb payload shape (unknown unless jsonb<T>() supplied one)
  *
- * All four params have defaults so bare `ColumnBuilder` (no args) still
+ * All five params have defaults so bare `ColumnBuilder` (no args) still
  * satisfies `Record<string, ColumnBuilder>` in schema.ts without modification.
  *
- * The four `declare readonly` brand fields carry the phantom types into the
+ * The five `declare readonly` brand fields carry the phantom types into the
  * structural shape so that conditional types like ColValue<C> can discriminate
  * on K without requiring runtime values on those fields.
  */
-declare class ColumnBuilder<K extends ColumnType = ColumnType, N extends boolean = boolean, D extends boolean = boolean, E = unknown> {
+declare class ColumnBuilder<K extends ColumnType = ColumnType, N extends boolean = boolean, D extends boolean = boolean, E = unknown, P = unknown> {
     readonly [__colKind]: K;
     readonly [__colNullable]: N;
     readonly [__colHasDefault]: D;
     readonly [__colEnumValues]: E;
+    readonly [__colPayload]: P;
     readonly _def: ColumnDef;
     constructor(type: K, existingDef?: ColumnDef);
     /** Mark this column as the primary key. */
-    primaryKey(): ColumnBuilder<K, N, D, E>;
+    primaryKey(): ColumnBuilder<K, N, D, E, P>;
     /** Mark this column as NOT NULL (default). */
-    notNull(): ColumnBuilder<K, false, D, E>;
+    notNull(): ColumnBuilder<K, false, D, E, P>;
     /** Allow NULL values. */
-    nullable(): ColumnBuilder<K, true, D, E>;
+    nullable(): ColumnBuilder<K, true, D, E, P>;
     /** Set a default value. */
-    default(value: unknown): ColumnBuilder<K, N, true, E>;
+    default(value: unknown): ColumnBuilder<K, N, true, E, P>;
     /** UUID: generate a random default (gen_random_uuid()). */
-    defaultRandom(): ColumnBuilder<K, N, true, E>;
+    defaultRandom(): ColumnBuilder<K, N, true, E, P>;
     /** Timestamp: default to now(). */
-    defaultNow(): ColumnBuilder<K, N, true, E>;
+    defaultNow(): ColumnBuilder<K, N, true, E, P>;
     /** Add a foreign key reference. */
-    references(table: string, column: string): ColumnBuilder<K, N, D, E>;
+    references(table: string, column: string): ColumnBuilder<K, N, D, E, P>;
+    /**
+     * Add a real DB-level foreign key to the built-in auth users
+     * (`REFERENCES auth.users(id)`), so a column like `user_id` gets true
+     * database cascade/integrity instead of app-layer-only. Sugar for
+     * `.references("auth.users", "id")`.
+     *
+     * `auth.users` lives in the SAME tenant database (palauth-owned), so this is
+     * a genuine cross-schema integrity constraint scoped to THIS tenant's users.
+     * The referenced `auth.users.id` is `text` (palauth ids are `usr_<uuid>`), so
+     * the referencing column must be `text()` too. Combine with `.onDelete(...)`
+     * for cascade behaviour, e.g. a `user_id` column defined as
+     * `text().notNull().referencesAuthUser().onDelete("cascade")`.
+     */
+    referencesAuthUser(): ColumnBuilder<K, N, D, E, P>;
     /** Set the ON DELETE action for a foreign key reference. */
-    onDelete(action: OnDeleteAction): ColumnBuilder<K, N, D, E>;
+    onDelete(action: OnDeleteAction): ColumnBuilder<K, N, D, E, P>;
     /** Add a single-column UNIQUE constraint. */
-    unique(): ColumnBuilder<K, N, D, E>;
+    unique(): ColumnBuilder<K, N, D, E, P>;
 }
 /**
  * Extracts the TypeScript value type for a column, respecting nullability.
- * - "uuid" | "text" | "timestamp" | "bigint" → string (or string | null when N = true)
- *   Note: bigint surfaces as string because JS number loses precision past 2^53;
- *   pgx/PostgREST serialize int8 as string. App code uses BigInt(row.amount).
+ * - "uuid" | "text" | "timestamp" | "bigint" | "numeric" → string (or string | null when N = true)
+ *   Note: bigint/numeric surface as string — JS number loses precision past 2^53,
+ *   and pgx/PostgREST serialize int8/numeric as strings. App code uses
+ *   BigInt(row.amount) for bigint, or a decimal lib for numeric.
  * - "integer" → number
  * - "boolean" → boolean
- * - "jsonb" → unknown (opaque JSON)
+ * - "jsonb" → P (the dev-supplied payload shape from jsonb<T>(), else unknown)
  * - "enum" → E (the union of literal values)
  */
-type ColValue<C> = C extends ColumnBuilder<'uuid' | 'text' | 'timestamp' | 'bigint', infer N, infer _D, infer _E> ? N extends true ? string | null : string : C extends ColumnBuilder<'integer', infer N, infer _D, infer _E> ? N extends true ? number | null : number : C extends ColumnBuilder<'boolean', infer N, infer _D, infer _E> ? N extends true ? boolean | null : boolean : C extends ColumnBuilder<'jsonb', infer _N, infer _D, infer _E> ? unknown : C extends ColumnBuilder<'enum', infer N, infer _D, infer E> ? N extends true ? E | null : E : never;
+type ColValue<C> = C extends ColumnBuilder<'uuid' | 'text' | 'timestamp' | 'bigint' | 'numeric', infer N, infer _D, infer _E, infer _P> ? N extends true ? string | null : string : C extends ColumnBuilder<'integer', infer N, infer _D, infer _E, infer _P> ? N extends true ? number | null : number : C extends ColumnBuilder<'boolean', infer N, infer _D, infer _E, infer _P> ? N extends true ? boolean | null : boolean : C extends ColumnBuilder<'jsonb', infer N, infer _D, infer _E, infer P> ? N extends true ? P | null : P : C extends ColumnBuilder<'enum', infer N, infer _D, infer E, infer _P> ? N extends true ? E | null : E : never;
 /**
  * True when a column is optional on INSERT:
  *  - nullable columns (N = true) — the DB allows NULL so the field may be omitted
@@ -95,12 +113,31 @@ declare function integer(): ColumnBuilder<'integer', false, false, never>;
  * and pgx/PostgREST serialize int8 as a JSON string. Use BigInt(row.column) in app code.
  */
 declare function bigint(): ColumnBuilder<'bigint', false, false, never>;
+/**
+ * Create a NUMERIC column (Postgres `numeric`/`decimal`, arbitrary precision).
+ * For exact fractional values (money with cents as a decimal, rates, weights)
+ * where int4/int8 don't fit. Surfaces as `string` in row/insert types — JS
+ * number can't hold arbitrary-precision decimals without rounding, and
+ * pgx/PostgREST serialize numeric as a JSON string. Parse with a decimal lib
+ * (or BigInt for scaled integers) in app code.
+ */
+declare function numeric(): ColumnBuilder<'numeric', false, false, never>;
 /** Create a BOOLEAN column. */
 declare function boolean(): ColumnBuilder<'boolean', false, false, never>;
 /** Create a TIMESTAMP column. */
 declare function timestamp(): ColumnBuilder<'timestamp', false, false, never>;
-/** Create a JSONB column. */
-declare function jsonb(): ColumnBuilder<'jsonb', false, false, never>;
+/**
+ * Create a JSONB column. Pass a payload type to make the generated row/insert
+ * type concrete instead of `unknown`:
+ *
+ *   tags: jsonb<string[]>()           // row.tags: string[]
+ *   meta: jsonb<{ tier: string }>()   // row.meta: { tier: string }
+ *   raw:  jsonb()                      // row.raw: unknown (back-compat)
+ *
+ * The runtime accepts a plain JS object/array directly (no JSON.stringify); the
+ * generic only refines the TYPE the env codegen emits.
+ */
+declare function jsonb<T = unknown>(): ColumnBuilder<'jsonb', false, false, never, T>;
 /**
  * Create an ENUM column.
  * @param name   The PostgreSQL enum type name (used in DDL).
@@ -545,4 +582,4 @@ interface EnvTypedDatabase extends Omit<DBClient, "transaction" | "asService"> {
     asService(): EnvServiceDatabase;
 }
 
-export { makeTypedDB as A, policy as B, ColumnBuilder as C, raw as D, type EnvTypedDatabase as E, text as F, timestamp as G, uuid as H, type InsertShape as I, type OnDeleteAction as O, PALBASE_EXTENSIONS as P, type RawConstraintDef as R, type SchemaDef as S, type TableDef as T, type ColumnDef as a, type ColumnMap as b, type ColumnType as c, EXTENSION_DEPENDENCIES as d, type EnvServiceDatabase as e, type EnvTables as f, type EnvTypedTable as g, type EnvTypedTx as h, type PalbaseExtension as i, PolicyBuilder as j, type PolicyCommand as k, type PolicyDef as l, type PolicyMode as m, type RowShape as n, type SchemaInput as o, type TableInput as p, type TypedDB as q, type TypedTable as r, type TypedTx as s, bigint as t, boolean as u, defineSchema as v, enumType as w, integer as x, isPalbaseExtension as y, jsonb as z };
+export { makeTypedDB as A, numeric as B, ColumnBuilder as C, policy as D, type EnvTypedDatabase as E, raw as F, text as G, timestamp as H, type InsertShape as I, uuid as J, type OnDeleteAction as O, PALBASE_EXTENSIONS as P, type RawConstraintDef as R, type SchemaDef as S, type TableDef as T, type ColumnDef as a, type ColumnMap as b, type ColumnType as c, EXTENSION_DEPENDENCIES as d, type EnvServiceDatabase as e, type EnvTables as f, type EnvTypedTable as g, type EnvTypedTx as h, type PalbaseExtension as i, PolicyBuilder as j, type PolicyCommand as k, type PolicyDef as l, type PolicyMode as m, type RowShape as n, type SchemaInput as o, type TableInput as p, type TypedDB as q, type TypedTable as r, type TypedTx as s, bigint as t, boolean as u, defineSchema as v, enumType as w, integer as x, isPalbaseExtension as y, jsonb as z };

package/dist/index.cjs

@@ -94,6 +94,7 @@ __export(src_exports, {
   jsonb: () => jsonb,
   makeEnvDts: () => makeEnvDts,
   makeTypedDB: () => makeTypedDB,
+  numeric: () => numeric,
   parseFileSizeLimit: () => parseFileSizeLimit,
   policy: () => policy,
   raw: () => raw,
@@ -387,6 +388,22 @@ var ColumnBuilder = class _ColumnBuilder {
     this._def.references = { table, column };
     return new _ColumnBuilder(this._def.type, this._def);
   }
+  /**
+   * Add a real DB-level foreign key to the built-in auth users
+   * (`REFERENCES auth.users(id)`), so a column like `user_id` gets true
+   * database cascade/integrity instead of app-layer-only. Sugar for
+   * `.references("auth.users", "id")`.
+   *
+   * `auth.users` lives in the SAME tenant database (palauth-owned), so this is
+   * a genuine cross-schema integrity constraint scoped to THIS tenant's users.
+   * The referenced `auth.users.id` is `text` (palauth ids are `usr_<uuid>`), so
+   * the referencing column must be `text()` too. Combine with `.onDelete(...)`
+   * for cascade behaviour, e.g. a `user_id` column defined as
+   * `text().notNull().referencesAuthUser().onDelete("cascade")`.
+   */
+  referencesAuthUser() {
+    return this.references("auth.users", "id");
+  }
   /** Set the ON DELETE action for a foreign key reference. */
   onDelete(action) {
     this._def.onDeleteAction = action;
@@ -410,6 +427,9 @@ function integer() {
 function bigint() {
   return new ColumnBuilder("bigint");
 }
+function numeric() {
+  return new ColumnBuilder("numeric");
+}
 function boolean() {
   return new ColumnBuilder("boolean");
 }
@@ -1558,6 +1578,7 @@ var import_zod2 = require("zod");
   jsonb,
   makeEnvDts,
   makeTypedDB,
+  numeric,
   parseFileSizeLimit,
   policy,
   raw,