@marktiderman/genesis-core 1.4.0 → 1.5.0

package/dist/{types-zILrlHuV.d.ts → types-C5bjsbxz.d.ts}

@@ -239,6 +239,17 @@ interface ProviderCapabilities {
     readonly actions?: boolean;
     /** `comments` and `addComment` are served. */
     readonly comments?: boolean;
+    /**
+     * The most rows one `getList` page may ask for. A request for more is
+     * refused (it is not cut short, which would shift later page boundaries),
+     * so a client that wants every row must page at this size or less.
+     */
+    readonly maxPerPage?: number;
+    /**
+     * A delete moves the record to a recycle bin (it can be restored) instead
+     * of removing it. Asked per resource: `capabilities(resource)`.
+     */
+    readonly softDelete?: boolean;
 }
 /** One audit record, as committed alongside the edit it describes. */
 interface AuditEntry {
@@ -260,282 +271,4 @@ interface AuditEntry {
     readonly after: DataRow | null;
 }
 
-/** Record identifier — supports both string UUIDs and numeric auto-increment IDs. */
-type Identifier = string | number;
-/** Base record type — all resources must have an id. */
-type BaseRecord = {
-    id: Identifier;
-    [key: string]: unknown;
-};
-/** Pagination parameters (offset-based, with optional cursor for future use). */
-interface PaginationParam {
-    page: number;
-    perPage: number;
-    cursor?: string;
-}
-/** Sort direction for a single field. */
-interface SortParam {
-    field: string;
-    order: "asc" | "desc";
-}
-/**
- * Filter expressions — discriminated union by operator.
- * Filters are AND-ed together in queries.
- */
-/** Operators that compare a field against a single scalar value. */
-interface ScalarFilter {
-    field: string;
-    operator: "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "contains";
-    value: string | number | boolean;
-}
-/** Operator that checks field membership in a list. */
-interface ArrayFilter {
-    field: string;
-    operator: "in";
-    value: (string | number | boolean)[];
-}
-/** Operator that checks field is within a range. */
-interface RangeFilter {
-    field: string;
-    operator: "between";
-    value: [string | number, string | number];
-}
-/** Operators that check for null/non-null — no value needed. */
-interface NullFilter {
-    field: string;
-    operator: "is_null" | "is_not_null";
-}
-type FilterParam = ScalarFilter | ArrayFilter | RangeFilter | NullFilter;
-/** Parameters for `getList`. */
-interface ListParams {
-    pagination?: PaginationParam;
-    sort?: SortParam;
-    /**
-     * Sort by several fields, first one first. Wins over `sort` on a provider
-     * whose capabilities report `multiSort`; others use only `sort`.
-     */
-    sorts?: SortParam[];
-    filters?: FilterParam[];
-    /** Supabase select syntax, e.g. "*, author:profiles(name)". Mock provider ignores this. */
-    select?: string;
-    /** Multi-field text search (case-insensitive). */
-    search?: {
-        query: string;
-        fields: string[];
-    };
-}
-/** Result of `getList`. */
-interface ListResult<T> {
-    data: T[];
-    total: number;
-}
-/** Parameters for `getOne`. */
-interface GetOneParams {
-    id: Identifier;
-    /** Supabase select syntax, e.g. "*, author:profiles(name)". Defaults to "*". */
-    select?: string;
-}
-/** Result of `getOne`. */
-interface GetOneResult<T> {
-    data: T;
-}
-/** Parameters for `getMany`. */
-interface GetManyParams {
-    ids: Identifier[];
-}
-/** Result of `getMany`. */
-interface GetManyResult<T> {
-    data: T[];
-}
-/** Parameters for `create`. */
-interface CreateParams<T> {
-    data: Partial<T>;
-}
-/** Result of `create`. */
-interface CreateResult<T> {
-    data: T;
-    /** The audit entry committed with the new row, from a provider that audits. */
-    audit?: AuditEntry;
-}
-/** Parameters for `update`. */
-interface UpdateParams<T> {
-    /**
-     * The record's identifier. For a composite key, the canonical string from
-     * `encodeRecordKey` (`@marktiderman/genesis-core/schema`).
-     */
-    id: Identifier;
-    data: Partial<T>;
-    /**
-     * The version token the caller read the row at. A provider that reports
-     * `versionedWrites` in its capabilities rejects the update with a
-     * `DataWriteError` (`conflict`) when the row has moved on since, instead of
-     * overwriting someone else's edit. Providers without versioned writes
-     * ignore it.
-     */
-    expectedVersion?: string | null;
-}
-/** Result of `update`. */
-interface UpdateResult<T> {
-    data: T;
-    /** The row's new version token, from a provider with versioned writes. */
-    version?: string | null;
-    /** The audit entry committed with the edit, from a provider that audits. */
-    audit?: AuditEntry;
-}
-/** Parameters for `deleteOne`. */
-interface DeleteParams {
-    id: Identifier;
-    /** The version token the row was read at; see `UpdateParams.expectedVersion`. */
-    expectedVersion?: string | null;
-}
-/** Result of `deleteOne`. */
-interface DeleteResult {
-    data: {
-        id: Identifier;
-    };
-    /** The audit entry committed with the deletion, from a provider that audits. */
-    audit?: AuditEntry;
-}
-/** One row's change in a bulk update. */
-interface BulkChange {
-    id: Identifier;
-    data: Record<string, unknown>;
-    /** The version token the row was read at. */
-    expectedVersion?: string | null;
-}
-/** Why one row of a bulk write or import didn't go through. */
-interface RowFailure {
-    /** The row's position in the request, from 0. */
-    index: number;
-    id?: Identifier;
-    outcome: string;
-    message: string;
-}
-/** Result of a bulk write: every row changed, or none did. */
-interface BulkResult {
-    /** Rows changed; always the number requested when `ok`. */
-    count: number;
-    ok: boolean;
-    /** Present when `ok` is false: every row that failed, so the caller can fix them all at once. */
-    failures?: RowFailure[];
-    /** One audit entry per row changed. */
-    audit?: AuditEntry[];
-}
-/** Parameters for `importRows`. */
-interface ImportParams {
-    rows: Record<string, unknown>[];
-    /** Check every row against the database and change nothing. */
-    dryRun: boolean;
-}
-/** Parameters for `history`. */
-interface HistoryParams {
-    id: Identifier;
-    /** Most recent first; default and maximum are the provider's. */
-    limit?: number;
-}
-/** A write that committed, as passed to a provider's `onWrite` and `invalidates`. */
-interface WriteEvent {
-    resource: string;
-    kind: "create" | "update" | "delete";
-    id: Identifier;
-    /** The row as written, when the provider has it (not for a delete). */
-    record?: BaseRecord;
-}
-/**
- * A cache key to invalidate after a write. Shaped like a TanStack Query
- * `QueryKey` (`readonly unknown[]`), matched by prefix.
- */
-type InvalidationKey = readonly unknown[];
-interface DataProvider {
-    getList<T extends BaseRecord = BaseRecord>(resource: string, params: ListParams): Promise<ListResult<T>>;
-    getOne<T extends BaseRecord = BaseRecord>(resource: string, params: GetOneParams): Promise<GetOneResult<T>>;
-    getMany<T extends BaseRecord = BaseRecord>(resource: string, params: GetManyParams): Promise<GetManyResult<T>>;
-    create<T extends BaseRecord = BaseRecord>(resource: string, params: CreateParams<T>): Promise<CreateResult<T>>;
-    update<T extends BaseRecord = BaseRecord>(resource: string, params: UpdateParams<T>): Promise<UpdateResult<T>>;
-    deleteOne(resource: string, params: DeleteParams): Promise<DeleteResult>;
-    /**
-     * The resource's real shape for the CURRENT user: fields, key, version
-     * field, and per-field read and update rights. Fields the user may not read
-     * are omitted entirely.
-     */
-    describe?(resource: string): Promise<ResourceSchema>;
-    /** Every resource this user may see, for a sidebar or a picker. */
-    listResources?(): Promise<ResourceSummary[]>;
-    /**
-     * What this provider can do, optionally for one resource. A UI hides the
-     * controls a provider cannot serve instead of letting them error.
-     */
-    capabilities?(resource?: string): Promise<ProviderCapabilities>;
-    /**
-     * A record's audit history, most recent first, limited to the fields this
-     * user may read.
-     */
-    history?(resource: string, params: HistoryParams): Promise<AuditEntry[]>;
-    /**
-     * Update many rows in ONE transaction. All of them change or none do: a
-     * single conflict, refusal or invalid value rolls back the rest, and the
-     * result lists every row that failed.
-     */
-    updateMany?(resource: string, params: {
-        changes: BulkChange[];
-    }): Promise<BulkResult>;
-    /** Delete many rows in one transaction, all or none, each at its version. */
-    deleteMany?(resource: string, params: {
-        items: {
-            id: Identifier;
-            expectedVersion?: string | null;
-        }[];
-    }): Promise<BulkResult>;
-    /**
-     * Add rows from an import. With `dryRun`, every row is tried against the
-     * database and nothing is kept, so the result lists every row that would
-     * fail; without it, all rows are added in one transaction or none are.
-     */
-    importRows?(resource: string, params: ImportParams): Promise<BulkResult>;
-    /**
-     * Undo one audited change with a compensating write: put the changed
-     * fields back, remove an added row, or restore a deleted one. Refused when
-     * the row has changed since.
-     */
-    undo?(resource: string, params: {
-        auditId: string;
-    }): Promise<{
-        audit?: AuditEntry;
-    }>;
-    /**
-     * Run one of the resource's row actions (`ResourceSchema.actions`) on a
-     * row, at the version it was read. The app's function does the work; the
-     * row's change is audited.
-     */
-    runAction?(resource: string, params: {
-        id: Identifier;
-        action: string;
-        expectedVersion?: string | null;
-    }): Promise<{
-        data: Record<string, unknown> | null;
-        audit?: AuditEntry;
-    }>;
-    /** A record's comments, oldest first. */
-    comments?(resource: string, params: {
-        id: Identifier;
-    }): Promise<RecordComment[]>;
-    /** Add a comment to a record, as the signed-in user. */
-    addComment?(resource: string, params: {
-        id: Identifier;
-        body: string;
-    }): Promise<RecordComment>;
-    /**
-     * Maps a stored row to the values an edit form starts from, for a resource
-     * whose form shape differs from its table (the reverse of a write's
-     * `prepare`). `useResourceForm` applies it in edit mode.
-     */
-    toFormValues?(resource: string, record: Record<string, unknown>): Record<string, unknown>;
-    /**
-     * Other cache keys a committed write makes stale, beyond the resource's
-     * own `[resource]` keys. `useResource` and `useResourceForm` invalidate
-     * them after their writes.
-     */
-    invalidates?(event: WriteEvent): InvalidationKey[];
-}
-
-export type { ArrayFilter as A, BaseRecord as B, CreateParams as C, DataProvider as D, SortParam as E, FieldPermissions as F, GetManyParams as G, HistoryParams as H, Identifier as I, StorageType as J, UpdateResult as K, ListParams as L, NullFilter as N, PaginationParam as P, RangeFilter as R, ScalarFilter as S, UpdateParams as U, VersionField as V, WriteEvent as W, AuditEntry as a, BulkChange as b, BulkResult as c, CreateResult as d, DataRow as e, DeleteParams as f, DeleteResult as g, FieldReference as h, FieldSchema as i, FilterOperator as j, FilterParam as k, GetManyResult as l, GetOneParams as m, GetOneResult as n, ImportParams as o, InvalidationKey as p, ListResult as q, ProviderCapabilities as r, RecordComment as s, ResourceAccess as t, ResourceContract as u, ResourceRelation as v, ResourceSchema as w, ResourceSummary as x, RowAction as y, RowFailure as z };
+export type { AuditEntry as A, DataRow as D, FieldPermissions as F, ProviderCapabilities as P, RecordComment as R, StorageType as S, VersionField as V, FieldReference as a, FieldSchema as b, FilterOperator as c, ResourceAccess as d, ResourceContract as e, ResourceRelation as f, ResourceSchema as g, ResourceSummary as h, RowAction as i };

package/dist/types-Dsqqr9s7.d.ts

@@ -0,0 +1,281 @@
+import { A as AuditEntry, g as ResourceSchema, h as ResourceSummary, P as ProviderCapabilities, R as RecordComment } from './types-C5bjsbxz.js';
+
+/** Record identifier — supports both string UUIDs and numeric auto-increment IDs. */
+type Identifier = string | number;
+/** Base record type — all resources must have an id. */
+type BaseRecord = {
+    id: Identifier;
+    [key: string]: unknown;
+};
+/** Pagination parameters (offset-based, with optional cursor for future use). */
+interface PaginationParam {
+    page: number;
+    perPage: number;
+    cursor?: string;
+}
+/** Sort direction for a single field. */
+interface SortParam {
+    field: string;
+    order: "asc" | "desc";
+}
+/**
+ * Filter expressions — discriminated union by operator.
+ * Filters are AND-ed together in queries.
+ */
+/** Operators that compare a field against a single scalar value. */
+interface ScalarFilter {
+    field: string;
+    operator: "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "contains";
+    value: string | number | boolean;
+}
+/** Operator that checks field membership in a list. */
+interface ArrayFilter {
+    field: string;
+    operator: "in";
+    value: (string | number | boolean)[];
+}
+/** Operator that checks field is within a range. */
+interface RangeFilter {
+    field: string;
+    operator: "between";
+    value: [string | number, string | number];
+}
+/** Operators that check for null/non-null — no value needed. */
+interface NullFilter {
+    field: string;
+    operator: "is_null" | "is_not_null";
+}
+type FilterParam = ScalarFilter | ArrayFilter | RangeFilter | NullFilter;
+/** Parameters for `getList`. */
+interface ListParams {
+    pagination?: PaginationParam;
+    sort?: SortParam;
+    /**
+     * Sort by several fields, first one first. Wins over `sort` on a provider
+     * whose capabilities report `multiSort`; others use only `sort`.
+     */
+    sorts?: SortParam[];
+    filters?: FilterParam[];
+    /** Supabase select syntax, e.g. "*, author:profiles(name)". Mock provider ignores this. */
+    select?: string;
+    /** Multi-field text search (case-insensitive). */
+    search?: {
+        query: string;
+        fields: string[];
+    };
+}
+/** Result of `getList`. */
+interface ListResult<T> {
+    data: T[];
+    total: number;
+}
+/** Parameters for `getOne`. */
+interface GetOneParams {
+    id: Identifier;
+    /** Supabase select syntax, e.g. "*, author:profiles(name)". Defaults to "*". */
+    select?: string;
+}
+/** Result of `getOne`. */
+interface GetOneResult<T> {
+    data: T;
+}
+/** Parameters for `getMany`. */
+interface GetManyParams {
+    ids: Identifier[];
+}
+/** Result of `getMany`. */
+interface GetManyResult<T> {
+    data: T[];
+}
+/** Parameters for `create`. */
+interface CreateParams<T> {
+    data: Partial<T>;
+}
+/** Result of `create`. */
+interface CreateResult<T> {
+    data: T;
+    /** The audit entry committed with the new row, from a provider that audits. */
+    audit?: AuditEntry;
+}
+/** Parameters for `update`. */
+interface UpdateParams<T> {
+    /**
+     * The record's identifier. For a composite key, the canonical string from
+     * `encodeRecordKey` (`@marktiderman/genesis-core/schema`).
+     */
+    id: Identifier;
+    data: Partial<T>;
+    /**
+     * The version token the caller read the row at. A provider that reports
+     * `versionedWrites` in its capabilities rejects the update with a
+     * `DataWriteError` (`conflict`) when the row has moved on since, instead of
+     * overwriting someone else's edit. Providers without versioned writes
+     * ignore it.
+     */
+    expectedVersion?: string | null;
+}
+/** Result of `update`. */
+interface UpdateResult<T> {
+    data: T;
+    /** The row's new version token, from a provider with versioned writes. */
+    version?: string | null;
+    /** The audit entry committed with the edit, from a provider that audits. */
+    audit?: AuditEntry;
+}
+/** Parameters for `deleteOne`. */
+interface DeleteParams {
+    id: Identifier;
+    /** The version token the row was read at; see `UpdateParams.expectedVersion`. */
+    expectedVersion?: string | null;
+}
+/** Result of `deleteOne`. */
+interface DeleteResult {
+    data: {
+        id: Identifier;
+    };
+    /** The audit entry committed with the deletion, from a provider that audits. */
+    audit?: AuditEntry;
+}
+/** One row's change in a bulk update. */
+interface BulkChange {
+    id: Identifier;
+    data: Record<string, unknown>;
+    /** The version token the row was read at. */
+    expectedVersion?: string | null;
+}
+/** Why one row of a bulk write or import didn't go through. */
+interface RowFailure {
+    /** The row's position in the request, from 0. */
+    index: number;
+    id?: Identifier;
+    outcome: string;
+    message: string;
+}
+/** Result of a bulk write: every row changed, or none did. */
+interface BulkResult {
+    /** Rows changed; always the number requested when `ok`. */
+    count: number;
+    ok: boolean;
+    /** Present when `ok` is false: every row that failed, so the caller can fix them all at once. */
+    failures?: RowFailure[];
+    /** One audit entry per row changed. */
+    audit?: AuditEntry[];
+}
+/** Parameters for `importRows`. */
+interface ImportParams {
+    rows: Record<string, unknown>[];
+    /** Check every row against the database and change nothing. */
+    dryRun: boolean;
+}
+/** Parameters for `history`. */
+interface HistoryParams {
+    id: Identifier;
+    /** Most recent first; default and maximum are the provider's. */
+    limit?: number;
+}
+/** A write that committed, as passed to a provider's `onWrite` and `invalidates`. */
+interface WriteEvent {
+    resource: string;
+    kind: "create" | "update" | "delete";
+    id: Identifier;
+    /** The row as written, when the provider has it (not for a delete). */
+    record?: BaseRecord;
+}
+/**
+ * A cache key to invalidate after a write. Shaped like a TanStack Query
+ * `QueryKey` (`readonly unknown[]`), matched by prefix.
+ */
+type InvalidationKey = readonly unknown[];
+interface DataProvider {
+    getList<T extends BaseRecord = BaseRecord>(resource: string, params: ListParams): Promise<ListResult<T>>;
+    getOne<T extends BaseRecord = BaseRecord>(resource: string, params: GetOneParams): Promise<GetOneResult<T>>;
+    getMany<T extends BaseRecord = BaseRecord>(resource: string, params: GetManyParams): Promise<GetManyResult<T>>;
+    create<T extends BaseRecord = BaseRecord>(resource: string, params: CreateParams<T>): Promise<CreateResult<T>>;
+    update<T extends BaseRecord = BaseRecord>(resource: string, params: UpdateParams<T>): Promise<UpdateResult<T>>;
+    deleteOne(resource: string, params: DeleteParams): Promise<DeleteResult>;
+    /**
+     * The resource's real shape for the CURRENT user: fields, key, version
+     * field, and per-field read and update rights. Fields the user may not read
+     * are omitted entirely.
+     */
+    describe?(resource: string): Promise<ResourceSchema>;
+    /** Every resource this user may see, for a sidebar or a picker. */
+    listResources?(): Promise<ResourceSummary[]>;
+    /**
+     * What this provider can do, optionally for one resource. A UI hides the
+     * controls a provider cannot serve instead of letting them error.
+     */
+    capabilities?(resource?: string): Promise<ProviderCapabilities>;
+    /**
+     * A record's audit history, most recent first, limited to the fields this
+     * user may read.
+     */
+    history?(resource: string, params: HistoryParams): Promise<AuditEntry[]>;
+    /**
+     * Update many rows in ONE transaction. All of them change or none do: a
+     * single conflict, refusal or invalid value rolls back the rest, and the
+     * result lists every row that failed.
+     */
+    updateMany?(resource: string, params: {
+        changes: BulkChange[];
+    }): Promise<BulkResult>;
+    /** Delete many rows in one transaction, all or none, each at its version. */
+    deleteMany?(resource: string, params: {
+        items: {
+            id: Identifier;
+            expectedVersion?: string | null;
+        }[];
+    }): Promise<BulkResult>;
+    /**
+     * Add rows from an import. With `dryRun`, every row is tried against the
+     * database and nothing is kept, so the result lists every row that would
+     * fail; without it, all rows are added in one transaction or none are.
+     */
+    importRows?(resource: string, params: ImportParams): Promise<BulkResult>;
+    /**
+     * Undo one audited change with a compensating write: put the changed
+     * fields back, remove an added row, or restore a deleted one. Refused when
+     * the row has changed since.
+     */
+    undo?(resource: string, params: {
+        auditId: string;
+    }): Promise<{
+        audit?: AuditEntry;
+    }>;
+    /**
+     * Run one of the resource's row actions (`ResourceSchema.actions`) on a
+     * row, at the version it was read. The app's function does the work; the
+     * row's change is audited.
+     */
+    runAction?(resource: string, params: {
+        id: Identifier;
+        action: string;
+        expectedVersion?: string | null;
+    }): Promise<{
+        data: Record<string, unknown> | null;
+        audit?: AuditEntry;
+    }>;
+    /** A record's comments, oldest first. */
+    comments?(resource: string, params: {
+        id: Identifier;
+    }): Promise<RecordComment[]>;
+    /** Add a comment to a record, as the signed-in user. */
+    addComment?(resource: string, params: {
+        id: Identifier;
+        body: string;
+    }): Promise<RecordComment>;
+    /**
+     * Maps a stored row to the values an edit form starts from, for a resource
+     * whose form shape differs from its table (the reverse of a write's
+     * `prepare`). `useResourceForm` applies it in edit mode.
+     */
+    toFormValues?(resource: string, record: Record<string, unknown>): Record<string, unknown>;
+    /**
+     * Other cache keys a committed write makes stale, beyond the resource's
+     * own `[resource]` keys. `useResource` and `useResourceForm` invalidate
+     * them after their writes.
+     */
+    invalidates?(event: WriteEvent): InvalidationKey[];
+}
+
+export type { ArrayFilter as A, BaseRecord as B, CreateParams as C, DataProvider as D, FilterParam as F, GetManyParams as G, HistoryParams as H, Identifier as I, ListParams as L, NullFilter as N, PaginationParam as P, RangeFilter as R, ScalarFilter as S, UpdateParams as U, WriteEvent as W, BulkChange as a, BulkResult as b, CreateResult as c, DeleteParams as d, DeleteResult as e, GetManyResult as f, GetOneParams as g, GetOneResult as h, ImportParams as i, InvalidationKey as j, ListResult as k, RowFailure as l, SortParam as m, UpdateResult as n };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marktiderman/genesis-core",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "private": false,
   "type": "module",
   "sideEffects": false,

package/dist/chunk-6MBACQYA.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/schema/write-outcome.ts"],"names":[],"mappings":";AAgDO,IAAM,cAAA,GAAN,cAA6B,KAAA,CAAM;AAAA,EAC/B,OAAA;AAAA,EACA,OAAA;AAAA,EACA,cAAA;AAAA;AAAA,EAEA,IAAA;AAAA,EAET,WAAA,CAAY,OAAA,EAAuB,OAAA,EAAiB,OAAA,GAAiC,EAAC,EAAG;AACvF,IAAA,KAAA,CAAM,OAAA,EAAS,QAAQ,KAAA,KAAU,MAAA,GAAY,SAAY,EAAE,KAAA,EAAO,OAAA,CAAQ,KAAA,EAAO,CAAA;AACjF,IAAA,IAAA,CAAK,IAAA,GAAO,gBAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,OAAA;AACvB,IAAA,IAAA,CAAK,iBAAiB,OAAA,CAAQ,cAAA;AAC9B,IAAA,IAAI,OAAA,CAAQ,IAAA,KAAS,MAAA,EAAW,IAAA,CAAK,OAAO,OAAA,CAAQ,IAAA;AAAA,EACtD;AACF;AAMO,SAAS,iBAAiB,KAAA,EAAyC;AACxE,EAAA,OACE,iBAAiB,KAAA,IACjB,KAAA,CAAM,SAAS,gBAAA,IACf,OAAQ,MAAgC,OAAA,KAAY,QAAA;AAExD","file":"chunk-6MBACQYA.js","sourcesContent":["// ---------------------------------------------------------------------------\n// Why a write did not save (DATA-STUDIO.md \"Write safety\")\n//\n// A write that changes nothing is never reported as \"permission denied\" by\n// assumption. The provider re-reads the row and says what actually happened.\n// ---------------------------------------------------------------------------\n\nimport type { DataRow } from \"./types\";\n\n/**\n * - `conflict`: someone else changed the row since it was read. `current`\n *   carries the row as it is now.\n * - `gone`: the row was deleted, or is no longer visible to this user. The\n *   two cannot be told apart without a privileged look at the table, which\n *   would show this user a fact about a row they cannot see.\n * - `forbidden`: the row is visible and unchanged, but the app or the\n *   database does not let this user make this change. Only reported when\n *   that is proven, never assumed from \"zero rows changed\".\n * - `invalid`: the store rejected the value (type, constraint, not-null).\n * - `audit_failed`: the audit entry could not be written, so the edit was\n *   rolled back with it.\n * - `unauthenticated`: no signed-in user, or the session expired.\n * - `error`: anything else. The edit did not commit.\n */\nexport type WriteOutcome =\n  | \"conflict\"\n  | \"gone\"\n  | \"forbidden\"\n  | \"invalid\"\n  | \"audit_failed\"\n  | \"unauthenticated\"\n  | \"error\";\n\nexport interface DataWriteErrorOptions {\n  /** The row as it is now, for a `conflict`. Only fields the user may read. */\n  current?: DataRow;\n  /** The row's current version token, for a `conflict`. */\n  currentVersion?: string | null;\n  /**\n   * The store's own error code, when it gave one (a Postgres SQLSTATE such as\n   * `23505`, or a PostgREST code such as `PGRST301`).\n   */\n  code?: string;\n  /** The underlying error, kept for logging. */\n  cause?: unknown;\n}\n\n/** Thrown by a provider when a write did not commit. */\nexport class DataWriteError extends Error {\n  readonly outcome: WriteOutcome;\n  readonly current?: DataRow;\n  readonly currentVersion?: string | null;\n  /** The store's own error code, when it gave one. */\n  readonly code?: string;\n\n  constructor(outcome: WriteOutcome, message: string, options: DataWriteErrorOptions = {}) {\n    super(message, options.cause === undefined ? undefined : { cause: options.cause });\n    this.name = \"DataWriteError\";\n    this.outcome = outcome;\n    this.current = options.current;\n    this.currentVersion = options.currentVersion;\n    if (options.code !== undefined) this.code = options.code;\n  }\n}\n\n/**\n * `instanceof` fails when two copies of this package are installed, so check\n * the shape instead.\n */\nexport function isDataWriteError(error: unknown): error is DataWriteError {\n  return (\n    error instanceof Error &&\n    error.name === \"DataWriteError\" &&\n    typeof (error as { outcome?: unknown }).outcome === \"string\"\n  );\n}\n"]}

package/dist/chunk-EL7YGOTY.js

@@ -1,3 +0,0 @@
-
-//# sourceMappingURL=chunk-EL7YGOTY.js.map
-//# sourceMappingURL=chunk-EL7YGOTY.js.map