@sixthsummit/ship-api 0.0.0-stage → 4.1.1

package/lib/app/auth/permissionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissionDefinition.js","sourceRoot":"","sources":["../../../src/app/auth/permissionDefinition.ts"],"names":[],"mappings":""}

package/lib/app/context/RequestContext.d.ts

@@ -0,0 +1,59 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+/**
+ * Canonical per-request context for the framework.
+ *
+ * One `AsyncLocalStorage` instance shared across the whole stack so the same
+ * `requestId` / `userId` / `tenantId` flow into:
+ *   - the pino logger's mixin (every log line auto-includes them)
+ *   - `DrizzleEntityService` lifecycle hooks (audit / CDC / multi-tenant scoping)
+ *   - OTel span attributes (via the framework's `withSpan` helper, when wired)
+ *
+ * The shape is intentionally narrow: framework-stable fields up top, free-form
+ * overflow under `extra` so consumers can attach module-specific data without
+ * mutating the type. The optional `tx` field is populated inside
+ * `withTransaction(...)` so lifecycle hooks know they're inside an active
+ * transaction (and what `tx` to use for nested writes).
+ *
+ * `tx` is typed `unknown` here to avoid a circular dep on Drizzle types from
+ * the context layer; callers cast to `DrizzleTx` (or equivalent) at the use
+ * site. This keeps `RequestContext` a pure type primitive that both the
+ * logger and the data layer can depend on without importing each other.
+ */
+export interface RequestContext {
+    /** Stable per-request identifier propagated end-to-end. */
+    requestId?: string;
+    /** Authenticated account identifier set by `requireAuth`. */
+    userId?: string;
+    /**
+     * Active tenant for the request, published by `resolveTenant()`. Read the
+     * active tenant from here — never from `account.tenantId` directly — so a
+     * future one-tenant-per-user → membership move (Model A → B) stays a
+     * one-middleware change. `undefined` for single-tenant products.
+     */
+    tenantId?: string;
+    /**
+     * Active database transaction handle when running inside `withTransaction`.
+     * `unknown` here to avoid a context → Drizzle dependency.
+     */
+    tx?: unknown;
+    /**
+     * Free-form extras included under their own keys in log lines and
+     * available to lifecycle hooks. Use sparingly; prefer first-class fields
+     * if a value is framework-wide.
+     */
+    extra?: Record<string, unknown>;
+}
+/**
+ * The single framework-wide `AsyncLocalStorage`. All context-aware code
+ * (logger, services, hooks, tracing) reads from this one store.
+ */
+export declare const requestContextStore: AsyncLocalStorage<RequestContext>;
+export declare function getRequestContext(): RequestContext | undefined;
+export declare function runWithRequestContext<T>(ctx: RequestContext, fn: () => T): T;
+/**
+ * Mutate the *current* context if one is active. Returns `false` if no context
+ * exists (e.g., called outside an HTTP request). Useful from middleware that
+ * resolves a user mid-request, or from `withTransaction` setting `tx`.
+ */
+export declare function setRequestContextField<K extends keyof RequestContext>(key: K, value: RequestContext[K]): boolean;
+//# sourceMappingURL=RequestContext.d.ts.map

package/lib/app/context/RequestContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestContext.d.ts","sourceRoot":"","sources":["../../../src/app/context/RequestContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,mCAA0C,CAAC;AAE3E,wBAAgB,iBAAiB,IAAI,cAAc,GAAG,SAAS,CAE9D;AAED,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAE5E;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,cAAc,EACnE,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,GACvB,OAAO,CAKT"}

package/lib/app/context/RequestContext.js

@@ -0,0 +1,25 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+/**
+ * The single framework-wide `AsyncLocalStorage`. All context-aware code
+ * (logger, services, hooks, tracing) reads from this one store.
+ */
+export const requestContextStore = new AsyncLocalStorage();
+export function getRequestContext() {
+    return requestContextStore.getStore();
+}
+export function runWithRequestContext(ctx, fn) {
+    return requestContextStore.run(ctx, fn);
+}
+/**
+ * Mutate the *current* context if one is active. Returns `false` if no context
+ * exists (e.g., called outside an HTTP request). Useful from middleware that
+ * resolves a user mid-request, or from `withTransaction` setting `tx`.
+ */
+export function setRequestContextField(key, value) {
+    const ctx = requestContextStore.getStore();
+    if (!ctx)
+        return false;
+    ctx[key] = value;
+    return true;
+}
+//# sourceMappingURL=RequestContext.js.map

package/lib/app/context/RequestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestContext.js","sourceRoot":"","sources":["../../../src/app/context/RequestContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAmDrD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,iBAAiB,EAAkB,CAAC;AAE3E,MAAM,UAAU,iBAAiB;IAC/B,OAAO,mBAAmB,CAAC,QAAQ,EAAE,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAI,GAAmB,EAAE,EAAW;IACvE,OAAO,mBAAmB,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,GAAM,EACN,KAAwB;IAExB,MAAM,GAAG,GAAG,mBAAmB,CAAC,QAAQ,EAAE,CAAC;IAC3C,IAAI,CAAC,GAAG;QAAE,OAAO,KAAK,CAAC;IACvB,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACjB,OAAO,IAAI,CAAC;AACd,CAAC"}

package/lib/app/db/QueryOptions.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Neutral query-operator DSL — load-bearing decision #2 from the v4 plan.
+ *
+ * The DSL is the contract between the HTTP layer (which parses query-strings
+ * like `?where[name][ilike]=foo&where[age][gte]=18`) and the data layer
+ * (`DrizzleEntityService` translates DSL → Drizzle `where` SQL). It is
+ * deliberately ORM-neutral: keeping query semantics decoupled from Drizzle
+ * means a future ORM swap doesn't break the public REST contract, and the
+ * same DSL feeds both Drizzle and any future read-replica / cache-aware
+ * variants.
+ *
+ * Documented operators only. Anything outside this set rejects at parse
+ * time so consumers can't smuggle ORM-specific syntax through.
+ *
+ * v3's `services/interfaces/QueryOptions.ts` (TypeORM-flavored) stays in
+ * place during the parallel-path build; this v4 module replaces it at the
+ * cut-over.
+ */
+export type QueryOperator = "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike" | "isNull";
+/**
+ * One column's filter clause. Either a bare value (shorthand for `eq`) or an
+ * operator-keyed object. Multiple operators on one column are AND-combined
+ * (e.g., `{ age: { gte: 18, lt: 30 } }`).
+ */
+export type ColumnFilter<TValue = unknown> = TValue | {
+    eq?: TValue;
+    ne?: TValue;
+    gt?: TValue;
+    gte?: TValue;
+    lt?: TValue;
+    lte?: TValue;
+    in?: readonly TValue[];
+    /** SQL `LIKE`. Pattern uses `%` / `_` wildcards. */
+    like?: string;
+    /** Case-insensitive `LIKE` (Postgres `ILIKE`). */
+    ilike?: string;
+    /** `IS NULL` (true) or `IS NOT NULL` (false). */
+    isNull?: boolean;
+};
+/**
+ * A `where` filter — record of column names to per-column filters.
+ *
+ * Multiple columns are AND-combined. To express OR, callers pass an array
+ * of filters at the service level (`getAll({ where: [filterA, filterB] })`)
+ * — the OR layer is at the service surface, not the DSL — keeps the DSL
+ * flat and analyzable.
+ */
+export type DslQueryFilter<TRow = Record<string, unknown>> = {
+    [K in keyof TRow]?: ColumnFilter<TRow[K]>;
+};
+/** A single `ORDER BY` clause. */
+export interface OrderClause<TRow = Record<string, unknown>> {
+    field: keyof TRow & string;
+    direction: "asc" | "desc";
+    /** `nulls first|last` — defaults to Postgres' default per direction. */
+    nulls?: "first" | "last";
+}
+/**
+ * Full query options accepted by `DrizzleEntityService` reads. Used by both
+ * controller-side parsing (from query strings) and direct service calls.
+ */
+export interface QueryOptions<TRow = Record<string, unknown>, TRelation extends string = string> {
+    where?: DslQueryFilter<TRow>;
+    /** Relations to eager-load (Drizzle `with: { role: true }`). */
+    relations?: readonly TRelation[];
+    order?: readonly OrderClause<TRow>[];
+    limit?: number;
+    offset?: number;
+    /** Free-text search across the entity's `getDefaultSearchFields()`. */
+    search?: string;
+    /**
+     * Include soft-deleted rows (rows with non-null `deletedAt`). Defaults
+     * `false` — soft-deleted rows are filtered out automatically.
+     */
+    includeDeleted?: boolean;
+}
+/**
+ * Type guards / refinement helpers for the parser layer.
+ */
+export declare const QUERY_OPERATORS: ReadonlySet<QueryOperator>;
+export declare function isQueryOperator(value: unknown): value is QueryOperator;
+//# sourceMappingURL=QueryOptions.d.ts.map

package/lib/app/db/QueryOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryOptions.d.ts","sourceRoot":"","sources":["../../../src/app/db/QueryOptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,MAAM,GACN,OAAO,GACP,QAAQ,CAAC;AAEb;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,MAAM,GAAG,OAAO,IACrC,MAAM,GACN;IACE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACvB,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEN;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;KAC1D,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC1C,CAAC;AAEF,kCAAkC;AAClC,MAAM,WAAW,WAAW,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzD,KAAK,EAAE,MAAM,IAAI,GAAG,MAAM,CAAC;IAC3B,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B,wEAAwE;IACxE,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,SAAS,MAAM,GAAG,MAAM;IAC7F,KAAK,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC7B,gEAAgE;IAChE,SAAS,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC;IACjC,KAAK,CAAC,EAAE,SAAS,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,WAAW,CAAC,aAAa,CAWrD,CAAC;AAEH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE"}

package/lib/app/db/QueryOptions.js

@@ -0,0 +1,37 @@
+/**
+ * Neutral query-operator DSL — load-bearing decision #2 from the v4 plan.
+ *
+ * The DSL is the contract between the HTTP layer (which parses query-strings
+ * like `?where[name][ilike]=foo&where[age][gte]=18`) and the data layer
+ * (`DrizzleEntityService` translates DSL → Drizzle `where` SQL). It is
+ * deliberately ORM-neutral: keeping query semantics decoupled from Drizzle
+ * means a future ORM swap doesn't break the public REST contract, and the
+ * same DSL feeds both Drizzle and any future read-replica / cache-aware
+ * variants.
+ *
+ * Documented operators only. Anything outside this set rejects at parse
+ * time so consumers can't smuggle ORM-specific syntax through.
+ *
+ * v3's `services/interfaces/QueryOptions.ts` (TypeORM-flavored) stays in
+ * place during the parallel-path build; this v4 module replaces it at the
+ * cut-over.
+ */
+/**
+ * Type guards / refinement helpers for the parser layer.
+ */
+export const QUERY_OPERATORS = new Set([
+    "eq",
+    "ne",
+    "gt",
+    "gte",
+    "lt",
+    "lte",
+    "in",
+    "like",
+    "ilike",
+    "isNull",
+]);
+export function isQueryOperator(value) {
+    return typeof value === "string" && QUERY_OPERATORS.has(value);
+}
+//# sourceMappingURL=QueryOptions.js.map

package/lib/app/db/QueryOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryOptions.js","sourceRoot":"","sources":["../../../src/app/db/QueryOptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AA6EH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAA+B,IAAI,GAAG,CAAgB;IAChF,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,MAAM;IACN,OAAO;IACP,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,eAAe,CAAC,GAAG,CAAC,KAAsB,CAAC,CAAC;AAClF,CAAC"}

package/lib/app/db/baseFields.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Audit + soft-delete columns spread into every framework `pgTable` definition.
+ *
+ * The v4 standard column set, replacing v3's `createdDate` / `updatedDate` /
+ * `deletedDate`. Renamed for consistency with industry convention (`*At` suffix
+ * for timestamps, separate `*By` foreign keys for audit attribution).
+ *
+ * - `createdAt` / `updatedAt`: `timestamptz` defaulting to `now()`. `updatedAt`
+ *   is also auto-updated on row modification at the SQL level (`$onUpdateFn`)
+ *   so consumers don't have to remember to set it. Drizzle propagates this
+ *   into `update()` calls.
+ * - `deletedAt`: nullable timestamp. Soft-delete-aware services (see
+ *   `DrizzleEntityService`) filter `isNull(deletedAt)` by default.
+ * - `createdBy` / `updatedBy`: nullable UUIDs referencing the actor who
+ *   created / last modified the row. Auto-stamped from `RequestContext.userId`
+ *   by `DrizzleEntityService` lifecycle hooks.
+ *
+ * Usage:
+ *
+ * ```ts
+ * import { pgTable, varchar } from "drizzle-orm/pg-core";
+ * import { baseFields } from "@sixthsummit/ship-api/app/db/baseFields";
+ *
+ * export const accounts = pgTable("accounts", {
+ *   id: uuid("id").primaryKey().defaultRandom(),
+ *   email: varchar("email", { length: 255 }).notNull().unique(),
+ *   ...baseFields,
+ * });
+ * ```
+ */
+export declare const baseFields: {
+    readonly createdAt: import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"created_at">>>;
+    readonly updatedAt: import("drizzle-orm").HasDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"updated_at">>>>;
+    readonly deletedAt: import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"deleted_at">;
+    readonly createdBy: import("drizzle-orm/pg-core").PgUUIDBuilderInitial<"created_by">;
+    readonly updatedBy: import("drizzle-orm/pg-core").PgUUIDBuilderInitial<"updated_by">;
+};
+/**
+ * Subset for tables that need only the timestamps, not the actor columns
+ * (e.g., system-generated rows where attribution is meaningless: rate-limit
+ * logs, idempotency-key cache, OTel-like telemetry). Use sparingly — most
+ * domain tables should use the full `baseFields`.
+ */
+export declare const baseFieldsTimestampsOnly: {
+    readonly createdAt: import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"created_at">>>;
+    readonly updatedAt: import("drizzle-orm").HasDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"updated_at">>>>;
+    readonly deletedAt: import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"deleted_at">;
+};
+/**
+ * Type alias representing the shape of a row that includes `baseFields`
+ * (for use in service-level type constraints).
+ */
+export type BaseFields = {
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    createdBy: string | null;
+    updatedBy: string | null;
+};
+//# sourceMappingURL=baseFields.d.ts.map

package/lib/app/db/baseFields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseFields.d.ts","sourceRoot":"","sources":["../../../src/app/db/baseFields.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,UAAU;;;;;;CASb,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;CAI3B,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC"}

package/lib/app/db/baseFields.js

@@ -0,0 +1,54 @@
+import { sql } from "drizzle-orm";
+import { timestamp, uuid } from "drizzle-orm/pg-core";
+/**
+ * Audit + soft-delete columns spread into every framework `pgTable` definition.
+ *
+ * The v4 standard column set, replacing v3's `createdDate` / `updatedDate` /
+ * `deletedDate`. Renamed for consistency with industry convention (`*At` suffix
+ * for timestamps, separate `*By` foreign keys for audit attribution).
+ *
+ * - `createdAt` / `updatedAt`: `timestamptz` defaulting to `now()`. `updatedAt`
+ *   is also auto-updated on row modification at the SQL level (`$onUpdateFn`)
+ *   so consumers don't have to remember to set it. Drizzle propagates this
+ *   into `update()` calls.
+ * - `deletedAt`: nullable timestamp. Soft-delete-aware services (see
+ *   `DrizzleEntityService`) filter `isNull(deletedAt)` by default.
+ * - `createdBy` / `updatedBy`: nullable UUIDs referencing the actor who
+ *   created / last modified the row. Auto-stamped from `RequestContext.userId`
+ *   by `DrizzleEntityService` lifecycle hooks.
+ *
+ * Usage:
+ *
+ * ```ts
+ * import { pgTable, varchar } from "drizzle-orm/pg-core";
+ * import { baseFields } from "@sixthsummit/ship-api/app/db/baseFields";
+ *
+ * export const accounts = pgTable("accounts", {
+ *   id: uuid("id").primaryKey().defaultRandom(),
+ *   email: varchar("email", { length: 255 }).notNull().unique(),
+ *   ...baseFields,
+ * });
+ * ```
+ */
+export const baseFields = {
+    createdAt: timestamp("created_at", { withTimezone: true }).notNull().default(sql `now()`),
+    updatedAt: timestamp("updated_at", { withTimezone: true })
+        .notNull()
+        .default(sql `now()`)
+        .$onUpdate(() => new Date()),
+    deletedAt: timestamp("deleted_at", { withTimezone: true }),
+    createdBy: uuid("created_by"),
+    updatedBy: uuid("updated_by"),
+};
+/**
+ * Subset for tables that need only the timestamps, not the actor columns
+ * (e.g., system-generated rows where attribution is meaningless: rate-limit
+ * logs, idempotency-key cache, OTel-like telemetry). Use sparingly — most
+ * domain tables should use the full `baseFields`.
+ */
+export const baseFieldsTimestampsOnly = {
+    createdAt: baseFields.createdAt,
+    updatedAt: baseFields.updatedAt,
+    deletedAt: baseFields.deletedAt,
+};
+//# sourceMappingURL=baseFields.js.map

package/lib/app/db/baseFields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseFields.js","sourceRoot":"","sources":["../../../src/app/db/baseFields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,GAAG,CAAA,OAAO,CAAC;IACxF,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;SACvD,OAAO,EAAE;SACT,OAAO,CAAC,GAAG,CAAA,OAAO,CAAC;SACnB,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;IAC9B,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAC1D,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC;IAC7B,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC;CACrB,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,SAAS,EAAE,UAAU,CAAC,SAAS;IAC/B,SAAS,EAAE,UAAU,CAAC,SAAS;IAC/B,SAAS,EAAE,UAAU,CAAC,SAAS;CACvB,CAAC"}

package/lib/app/db/buildWhere.d.ts

@@ -0,0 +1,22 @@
+import type { Table } from "drizzle-orm";
+import { type SQL } from "drizzle-orm";
+import type { DslQueryFilter } from "./QueryOptions.js";
+/**
+ * Translate the neutral `DslQueryFilter` DSL into a Drizzle `SQL` expression
+ * suitable for `db.query.<table>.findMany({ where: ... })` or
+ * `db.select().from(table).where(...)`.
+ *
+ * Filters are AND-combined across columns. Per-column filter objects with
+ * multiple operators are also AND-combined (e.g., `{ age: { gte: 18, lt: 30 } }`
+ * → `age >= 18 AND age < 30`).
+ *
+ * Returns `undefined` when the filter is empty so callers can spread it
+ * conditionally without producing an empty `WHERE`.
+ *
+ * Unknown columns (not present on the table) are *silently dropped*, which
+ * matches the `validate('query', schema)` upstream contract — by the time
+ * a filter reaches `buildWhere`, the schema layer has already validated
+ * shape; this function is the ORM-translation step, not validation.
+ */
+export declare function buildWhere<TTable extends Table>(table: TTable, filter?: DslQueryFilter): SQL | undefined;
+//# sourceMappingURL=buildWhere.d.ts.map

package/lib/app/db/buildWhere.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildWhere.d.ts","sourceRoot":"","sources":["../../../src/app/db/buildWhere.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,KAAK,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAaL,KAAK,GAAG,EACT,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAgB,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,UAAU,CAAC,MAAM,SAAS,KAAK,EAC7C,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,cAAc,GACtB,GAAG,GAAG,SAAS,CAkBjB"}

package/lib/app/db/buildWhere.js

@@ -0,0 +1,75 @@
+import { and, eq, gt, gte, ilike, inArray, isNotNull, isNull, like, lt, lte, ne, } from "drizzle-orm";
+/**
+ * Translate the neutral `DslQueryFilter` DSL into a Drizzle `SQL` expression
+ * suitable for `db.query.<table>.findMany({ where: ... })` or
+ * `db.select().from(table).where(...)`.
+ *
+ * Filters are AND-combined across columns. Per-column filter objects with
+ * multiple operators are also AND-combined (e.g., `{ age: { gte: 18, lt: 30 } }`
+ * → `age >= 18 AND age < 30`).
+ *
+ * Returns `undefined` when the filter is empty so callers can spread it
+ * conditionally without producing an empty `WHERE`.
+ *
+ * Unknown columns (not present on the table) are *silently dropped*, which
+ * matches the `validate('query', schema)` upstream contract — by the time
+ * a filter reaches `buildWhere`, the schema layer has already validated
+ * shape; this function is the ORM-translation step, not validation.
+ */
+export function buildWhere(table, filter) {
+    if (!filter)
+        return undefined;
+    const columns = table;
+    const conditions = [];
+    for (const [key, raw] of Object.entries(filter)) {
+        if (raw === undefined)
+            continue;
+        const column = columns[key];
+        if (!column || !isColumn(column))
+            continue; // silently drop unknown columns
+        appendColumnConditions(column, raw, conditions);
+    }
+    if (conditions.length === 0)
+        return undefined;
+    if (conditions.length === 1)
+        return conditions[0];
+    return and(...conditions);
+}
+function isColumn(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        // Drizzle columns expose `.name` and `.dataType` consistently.
+        typeof value.name === "string");
+}
+function appendColumnConditions(column, raw, out) {
+    // Bare value → eq shorthand
+    if (raw === null || typeof raw !== "object" || Array.isArray(raw) || raw instanceof Date) {
+        out.push(eq(column, raw));
+        return;
+    }
+    const f = raw;
+    const filter = f;
+    if ("eq" in filter && filter.eq !== undefined)
+        out.push(eq(column, filter.eq));
+    if ("ne" in filter && filter.ne !== undefined)
+        out.push(ne(column, filter.ne));
+    if ("gt" in filter && filter.gt !== undefined)
+        out.push(gt(column, filter.gt));
+    if ("gte" in filter && filter.gte !== undefined)
+        out.push(gte(column, filter.gte));
+    if ("lt" in filter && filter.lt !== undefined)
+        out.push(lt(column, filter.lt));
+    if ("lte" in filter && filter.lte !== undefined)
+        out.push(lte(column, filter.lte));
+    if ("in" in filter && Array.isArray(filter.in)) {
+        out.push(inArray(column, filter.in));
+    }
+    if ("like" in filter && typeof filter.like === "string")
+        out.push(like(column, filter.like));
+    if ("ilike" in filter && typeof filter.ilike === "string")
+        out.push(ilike(column, filter.ilike));
+    if ("isNull" in filter && typeof filter.isNull === "boolean") {
+        out.push(filter.isNull ? isNull(column) : isNotNull(column));
+    }
+}
+//# sourceMappingURL=buildWhere.js.map

package/lib/app/db/buildWhere.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildWhere.js","sourceRoot":"","sources":["../../../src/app/db/buildWhere.ts"],"names":[],"mappings":"AACA,OAAO,EACL,GAAG,EACH,EAAE,EACF,EAAE,EACF,GAAG,EACH,KAAK,EACL,OAAO,EACP,SAAS,EACT,MAAM,EACN,IAAI,EACJ,EAAE,EACF,GAAG,EACH,EAAE,GAEH,MAAM,aAAa,CAAC;AAGrB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,UAAU,CACxB,KAAa,EACb,MAAuB;IAEvB,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAE9B,MAAM,OAAO,GAAG,KAAqE,CAAC;IACtF,MAAM,UAAU,GAAU,EAAE,CAAC;IAE7B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,GAAG,KAAK,SAAS;YAAE,SAAS;QAEhC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,SAAS,CAAC,gCAAgC;QAE5E,sBAAsB,CAAC,MAAM,EAAE,GAAmB,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,+DAA+D;QAC/D,OAAQ,KAA4B,CAAC,IAAI,KAAK,QAAQ,CACvD,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAc,EAAE,GAAiB,EAAE,GAAU;IAC3E,4BAA4B;IAC5B,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;QACzF,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAY,CAAC,CAAC,CAAC;QACnC,OAAO;IACT,CAAC;IAED,MAAM,CAAC,GAAG,GAAqF,CAAC;IAChG,MAAM,MAAM,GAAG,CAA4B,CAAC;IAE5C,IAAI,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAW,CAAC,CAAC,CAAC;IACxF,IAAI,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAW,CAAC,CAAC,CAAC;IACxF,IAAI,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAW,CAAC,CAAC,CAAC;IACxF,IAAI,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAY,CAAC,CAAC,CAAC;IAC5F,IAAI,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAW,CAAC,CAAC,CAAC;IACxF,IAAI,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAY,CAAC,CAAC,CAAC;IAC5F,IAAI,IAAI,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,EAAa,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,MAAM,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;QAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7F,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ;QAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjG,IAAI,QAAQ,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC7D,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC"}

package/lib/app/db/client.d.ts

@@ -0,0 +1,111 @@
+import { type NodePgDatabase } from "drizzle-orm/node-postgres";
+import pg from "pg";
+import { type HealthCheck, type HealthCheckRegistry } from "../health/HealthCheck.js";
+/**
+ * Drizzle client + `pg.Pool` factory for ShipAPI v4.
+ *
+ * Replaces the v3 TypeORM `DataSource` initialization. One shared `pg.Pool`
+ * underlies the Drizzle client; the `pool` is exposed for callers that need
+ * raw access (e.g., `LISTEN/NOTIFY`, `pg-boss`-compatible workers, the
+ * graceful-shutdown manager which calls `pool.end()`).
+ *
+ * Connection-pool defaults are deliberately conservative for production
+ * Postgres: `max: 20` connections, 30s idle timeout, 5s acquire timeout, and
+ * a per-statement timeout to bound runaway queries. All overridable via
+ * `DbConfig` at construction time.
+ *
+ * The factory is **schema-agnostic** — pass your composed schema as the
+ * `TSchema` generic so `db.query.<table>` is fully typed against the consumer's
+ * tables. The framework ships no default tables; compose each module's schema
+ * fragment (e.g. `accountsSchema` from the accounts module) into your schema.
+ */
+export interface DbConfig {
+    /** Full Postgres connection URL (`postgres://...`). Preferred. */
+    connectionString?: string;
+    /** Or piecewise. Used when `connectionString` is not provided. */
+    host?: string;
+    port?: number;
+    database?: string;
+    user?: string;
+    password?: string;
+    ssl?: boolean | pg.ConnectionConfig["ssl"];
+    /** Max connections in pool. Default 20. */
+    max?: number;
+    /** Idle timeout (ms) before a pooled connection is released. Default 30_000. */
+    idleTimeoutMillis?: number;
+    /** Max time (ms) to wait for an available connection. Default 5_000. */
+    connectionTimeoutMillis?: number;
+    /**
+     * Per-statement timeout in ms. Set as a session-level Postgres parameter
+     * via the pg `application_name` + `statement_timeout` mechanism. Default
+     * 30_000 (30 seconds). Set to `0` to disable.
+     */
+    statementTimeoutMillis?: number;
+    /** Optional `application_name` reported to Postgres. */
+    applicationName?: string;
+}
+export declare function createPool(config: DbConfig): pg.Pool;
+/**
+ * Keep a broken idle connection from killing the process.
+ *
+ * `pg` emits `error` on the pool when an idle pooled client's connection fails. A Cloud SQL
+ * restart, failover or maintenance window ends every connection with `57P01 terminating
+ * connection due to administrator command`, and with no listener Node treats that event as an
+ * uncaught exception and exits. The pool has already discarded the broken client and the next
+ * checkout opens a fresh connection, so logging is all that is needed. Only the error's code,
+ * name and syscall are logged (the same fields `/readyz` logs for a thrown check error), because
+ * connection error messages can name the database host or user.
+ *
+ * `createPool` and `createDb` call this; call it yourself on any pool you build with
+ * `new pg.Pool()` (migration scripts, workers). A pool that already has an `error` listener is
+ * left alone, so a caller's own handling wins.
+ */
+export declare function handleIdleClientErrors(pool: pg.Pool): pg.Pool;
+export interface DbHealthCheckOptions {
+    /** Check name reported by `/readyz`. Default `"db.primary"`. */
+    name?: string;
+    /** Registry to add the check to. Default: the framework-wide `healthCheckRegistry`. */
+    registry?: HealthCheckRegistry;
+}
+/**
+ * Readiness check that runs `select 1` on `pool`. The registry measures the
+ * latency and enforces the per-check timeout; a failure throws, so the raw
+ * error reaches the registry's failure callback (which `/readyz` logs as
+ * code/name/syscall only) rather than the response body. This is the
+ * recommended database check: a thrown driver error never puts its message in
+ * the log, where a hand-written check returning `error: err.message` would.
+ */
+export declare function dbHealthCheck(pool: pg.Pool, opts?: {
+    name?: string;
+}): HealthCheck;
+export interface CreateDbResult<TSchema extends Record<string, unknown>> {
+    pool: pg.Pool;
+    db: NodePgDatabase<TSchema>;
+}
+/**
+ * Build a Drizzle client + pool. The `schema` is the composed schema record
+ * (`{ accounts, roles, permissions, ...customTables }`); `db.query.<key>` is
+ * typed against it.
+ */
+export declare function createDb<TSchema extends Record<string, unknown>>(args: {
+    config: DbConfig;
+    schema: TSchema;
+    /** Inject an existing pool (e.g., shared with another worker). */
+    pool?: pg.Pool;
+    /**
+     * Readiness check. By default `createDb` adds a `db.primary` check (runs
+     * `select 1` on this pool) to the framework-wide `healthCheckRegistry`, so
+     * `/readyz` reflects database reachability with no extra wiring.
+     *
+     * The check is registered as replaceable: if the app later adds its own
+     * check with the same name, that check replaces this one. If a check with
+     * the name already exists (say, a second `createDb` call), this one is
+     * skipped — the first pool's check stays. Either way exactly one runs.
+     *
+     * Pass `false` to register nothing (e.g. a secondary pool for a worker or
+     * migration script), or an object to change the name or registry.
+     */
+    healthCheck?: false | DbHealthCheckOptions;
+}): CreateDbResult<TSchema>;
+export type ShipDb<TSchema extends Record<string, unknown>> = NodePgDatabase<TSchema>;
+//# sourceMappingURL=client.d.ts.map

package/lib/app/db/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/app/db/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,MAAM,IAAI,CAAC;AAGpB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,mBAAmB,EAEzB,MAAM,0BAA0B,CAAC;AAElC;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,WAAW,QAAQ;IACvB,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,GAAG,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC3C,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wEAAwE;IACxE,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAWD,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,EAAE,CAAC,IAAI,CA+BpD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAM7D;AAED,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,WAAW,CAStF;AAED,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IACd,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE;IACtE,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,kEAAkE;IAClE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;IACf;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,oBAAoB,CAAC;CAC5C,GAAG,cAAc,CAAC,OAAO,CAAC,CAU1B;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC"}