@ai-matrx/records 0.98.6 → 0.98.8

package/dist/core/index.d.cts

@@ -578,6 +578,95 @@ declare function supabaseDataSource(client: object): RecordsDataSource;
  */
 declare function asRecordsDataSource(source: unknown): RecordsDataSource;
 
+/** The schema every door of the record store lives in. The only place an app-facing string says it. */
+declare const STORE_SCHEMA = "custom";
+/** What a door refused with, as PostgREST gave it. */
+interface StoreDoorError {
+    message: string;
+    code?: string | null;
+    hint?: string | null;
+    details?: string | null;
+}
+interface StoreDoorAnswer<T = unknown> {
+    data: T | null;
+    error: StoreDoorError | null;
+}
+/** The bare caller: the same `rpc(fn, args)` shape the hand-written layers declared. */
+interface StoreCaller {
+    rpc(fn: string, args?: Record<string, unknown>): PromiseLike<{
+        data: unknown;
+        error: StoreDoorError | null;
+    }>;
+}
+/** The named doors an app calls most. Every member is a thin call over `rpc`; nothing is added to the answer. */
+interface StoreDoors extends StoreCaller {
+    /** `custom.where_id_opens(p_id)` — which organization an object lives in. `data` is null when it is not given to the caller; the error is plain JSON (it streams to a browser as is). */
+    whereIdOpens(id: string): PromiseLike<{
+        data: unknown;
+        error: {
+            code: string | null;
+            message: string;
+        } | null;
+    }>;
+    /** `custom.table_kernel_id()` — the id of the store's Table kernel (a constant of the store). */
+    tableKernelId(): PromiseLike<StoreDoorAnswer<string>>;
+    /** `custom.read_records_by_ids` — the records of `ids` the caller may read in `tableId`, in `organizationId`. */
+    readRecordsByIds(organizationId: string, tableId: string, ids: readonly string[]): PromiseLike<StoreDoorAnswer>;
+    /** `custom.read_records_page` — one page; `args` are the door's own named arguments. */
+    readRecordsPage(args: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.record_table` — the table a record lives in. */
+    recordTable(organizationId: string, recordId: string): PromiseLike<StoreDoorAnswer<string>>;
+    /** `custom.applicable_fields` — the fields of a table. */
+    applicableFields(organizationId: string, tableId: string): PromiseLike<StoreDoorAnswer>;
+    /** `custom.field_declare` — declare one field on a table. */
+    fieldDeclare(organizationId: string, tableId: string, spec: Record<string, unknown>): PromiseLike<StoreDoorAnswer<string>>;
+    /** `custom.record_update` — patch a record's values. */
+    recordUpdate(organizationId: string, recordId: string, patch: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.entity_reference_words` — the labels of `{token,id}` refs, withheld when the caller may not open them. */
+    entityReferenceWords(organizationId: string, refs: ReadonlyArray<{
+        token: string;
+        id: string;
+    }>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.templates` — the catalogue (one page of cards for `filter`). */
+    templates(filter: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_from_tables` — draft a template spec from existing tables. */
+    templateFromTables(args: {
+        organizationId: string;
+        tableIds: readonly string[];
+        includeRows: boolean;
+        rowsPerTable: number;
+    }): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_declare` — declare a template (`scope` is `"org"` for an organization's own). */
+    templateDeclare(scope: string, spec: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_keep` — keep a one-off template in the organization's own. */
+    templateKeep(templateId: string): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_archive` — archive (or, with `restore`, bring back) an organization's own template. */
+    templateArchive(templateId: string, restore?: boolean): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_install_claim` — the host step's lease on one install step. */
+    templateInstallClaim(args: {
+        organizationId: string;
+        installId: string;
+        kind: string;
+        label: string;
+        sourceId?: string | null;
+        leaseSeconds: number;
+    }): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_install_note` — record the thing a host step made. */
+    templateInstallNote(args: {
+        organizationId: string;
+        installId: string;
+        kind: string;
+        id: string;
+        label: string;
+    }): PromiseLike<StoreDoorAnswer>;
+}
+/**
+ * Bind a supabase-js client (browser, server session, anon, or service-role) to the store's
+ * doors. A client with no `schema()` is refused by name on every call (`data_source_unbound`), never
+ * a thrown `undefined is not a function` in a render.
+ */
+declare function storeDoors(client: unknown): StoreDoors;
+
 /** The SQLSTATEs this package claims to understand. Exported for the guard. */
 declare const MAPPED_SQLSTATES: string[];
 /** Map a PostgREST/supabase-js failure into the package's refusal shape. */
@@ -763,4 +852,4 @@ declare function seededDataSource(index: Map<string, unknown>): {
     missed: () => boolean;
 };
 
-export { type BlockOutcome, DEFAULT_DOCUMENT_MAX_BYTES, DEFAULT_VALUE_MAX_BYTES, DOORS, type DoorKey, type ExportRow, Field, LANDING_SOURCE_TYPE, LANDING_TARGET_TYPES, type Landing, type LandingBlock, type LandingOutcomes, type LandingState, type LandingStore, MAPPED_SQLSTATES, type MirrorLimits, OUTPUT_KEPT_KEY, PRIMED_DOOR_TTL_MS, PRODUCED_BY_LABEL, type ParsedImport, PgError, PredictedRefusal, type PrimedBundleAnswer, type ReadFileText, ReadValue, RecordDocument, RecordsDataSource, RecordsError, RecordsResult, type RecordsSeed, type RecordsSeedAnswer, StaleWriteDetail, type SupabaseLike, TableKindFacts, Uuid, WHOLE_VALUE_SOURCE_KIND, type WholeValuePointer, announceRecordChanged, announceTableStructureChanged, archivedOrganizationId, asRecordsDataSource, blockLandedInStore, cellText, doorAbsent, doorCensus, doorExists, doorReady, dropPrimedDoorAnswers, exportCellText, exportCsv, exportMarkdown, exportXlsx, forgetPrimedTablePageBundles, importCsv, importXlsx, isRecordRemoved, landingOutcomesFor, mapPgError, mapThrownError, markRecordRemoved, markRecordRestored, onRecordChanged, onTableStructureChanged, outcomeForBlock, outputIsKept, parseCsv, predictEnvelopeRefusal, predictSizeRefusal, predictValueRefusals, predictWriteRefusals, primeDoorAnswer, primeRecordPageBundle, primeTablePageBundle, recordingDataSource, seedIndex, seedKey, seededDataSource, staleWriteDetail, supabaseDataSource, tableKindFacts, takePrimedTablePageBundle, toAoa, valuesAreUnconfirmed, wholeValueNotRead, wholeValueOf, wholeValueOfRead, wholeValueSize, withWholeValues };
+export { type BlockOutcome, DEFAULT_DOCUMENT_MAX_BYTES, DEFAULT_VALUE_MAX_BYTES, DOORS, type DoorKey, type ExportRow, Field, LANDING_SOURCE_TYPE, LANDING_TARGET_TYPES, type Landing, type LandingBlock, type LandingOutcomes, type LandingState, type LandingStore, MAPPED_SQLSTATES, type MirrorLimits, OUTPUT_KEPT_KEY, PRIMED_DOOR_TTL_MS, PRODUCED_BY_LABEL, type ParsedImport, PgError, PredictedRefusal, type PrimedBundleAnswer, type ReadFileText, ReadValue, RecordDocument, RecordsDataSource, RecordsError, RecordsResult, type RecordsSeed, type RecordsSeedAnswer, STORE_SCHEMA, StaleWriteDetail, type StoreCaller, type StoreDoorAnswer, type StoreDoorError, type StoreDoors, type SupabaseLike, TableKindFacts, Uuid, WHOLE_VALUE_SOURCE_KIND, type WholeValuePointer, announceRecordChanged, announceTableStructureChanged, archivedOrganizationId, asRecordsDataSource, blockLandedInStore, cellText, doorAbsent, doorCensus, doorExists, doorReady, dropPrimedDoorAnswers, exportCellText, exportCsv, exportMarkdown, exportXlsx, forgetPrimedTablePageBundles, importCsv, importXlsx, isRecordRemoved, landingOutcomesFor, mapPgError, mapThrownError, markRecordRemoved, markRecordRestored, onRecordChanged, onTableStructureChanged, outcomeForBlock, outputIsKept, parseCsv, predictEnvelopeRefusal, predictSizeRefusal, predictValueRefusals, predictWriteRefusals, primeDoorAnswer, primeRecordPageBundle, primeTablePageBundle, recordingDataSource, seedIndex, seedKey, seededDataSource, staleWriteDetail, storeDoors, supabaseDataSource, tableKindFacts, takePrimedTablePageBundle, toAoa, valuesAreUnconfirmed, wholeValueNotRead, wholeValueOf, wholeValueOfRead, wholeValueSize, withWholeValues };

package/dist/core/index.d.ts

@@ -578,6 +578,95 @@ declare function supabaseDataSource(client: object): RecordsDataSource;
  */
 declare function asRecordsDataSource(source: unknown): RecordsDataSource;
 
+/** The schema every door of the record store lives in. The only place an app-facing string says it. */
+declare const STORE_SCHEMA = "custom";
+/** What a door refused with, as PostgREST gave it. */
+interface StoreDoorError {
+    message: string;
+    code?: string | null;
+    hint?: string | null;
+    details?: string | null;
+}
+interface StoreDoorAnswer<T = unknown> {
+    data: T | null;
+    error: StoreDoorError | null;
+}
+/** The bare caller: the same `rpc(fn, args)` shape the hand-written layers declared. */
+interface StoreCaller {
+    rpc(fn: string, args?: Record<string, unknown>): PromiseLike<{
+        data: unknown;
+        error: StoreDoorError | null;
+    }>;
+}
+/** The named doors an app calls most. Every member is a thin call over `rpc`; nothing is added to the answer. */
+interface StoreDoors extends StoreCaller {
+    /** `custom.where_id_opens(p_id)` — which organization an object lives in. `data` is null when it is not given to the caller; the error is plain JSON (it streams to a browser as is). */
+    whereIdOpens(id: string): PromiseLike<{
+        data: unknown;
+        error: {
+            code: string | null;
+            message: string;
+        } | null;
+    }>;
+    /** `custom.table_kernel_id()` — the id of the store's Table kernel (a constant of the store). */
+    tableKernelId(): PromiseLike<StoreDoorAnswer<string>>;
+    /** `custom.read_records_by_ids` — the records of `ids` the caller may read in `tableId`, in `organizationId`. */
+    readRecordsByIds(organizationId: string, tableId: string, ids: readonly string[]): PromiseLike<StoreDoorAnswer>;
+    /** `custom.read_records_page` — one page; `args` are the door's own named arguments. */
+    readRecordsPage(args: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.record_table` — the table a record lives in. */
+    recordTable(organizationId: string, recordId: string): PromiseLike<StoreDoorAnswer<string>>;
+    /** `custom.applicable_fields` — the fields of a table. */
+    applicableFields(organizationId: string, tableId: string): PromiseLike<StoreDoorAnswer>;
+    /** `custom.field_declare` — declare one field on a table. */
+    fieldDeclare(organizationId: string, tableId: string, spec: Record<string, unknown>): PromiseLike<StoreDoorAnswer<string>>;
+    /** `custom.record_update` — patch a record's values. */
+    recordUpdate(organizationId: string, recordId: string, patch: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.entity_reference_words` — the labels of `{token,id}` refs, withheld when the caller may not open them. */
+    entityReferenceWords(organizationId: string, refs: ReadonlyArray<{
+        token: string;
+        id: string;
+    }>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.templates` — the catalogue (one page of cards for `filter`). */
+    templates(filter: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_from_tables` — draft a template spec from existing tables. */
+    templateFromTables(args: {
+        organizationId: string;
+        tableIds: readonly string[];
+        includeRows: boolean;
+        rowsPerTable: number;
+    }): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_declare` — declare a template (`scope` is `"org"` for an organization's own). */
+    templateDeclare(scope: string, spec: Record<string, unknown>): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_keep` — keep a one-off template in the organization's own. */
+    templateKeep(templateId: string): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_archive` — archive (or, with `restore`, bring back) an organization's own template. */
+    templateArchive(templateId: string, restore?: boolean): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_install_claim` — the host step's lease on one install step. */
+    templateInstallClaim(args: {
+        organizationId: string;
+        installId: string;
+        kind: string;
+        label: string;
+        sourceId?: string | null;
+        leaseSeconds: number;
+    }): PromiseLike<StoreDoorAnswer>;
+    /** `custom.template_install_note` — record the thing a host step made. */
+    templateInstallNote(args: {
+        organizationId: string;
+        installId: string;
+        kind: string;
+        id: string;
+        label: string;
+    }): PromiseLike<StoreDoorAnswer>;
+}
+/**
+ * Bind a supabase-js client (browser, server session, anon, or service-role) to the store's
+ * doors. A client with no `schema()` is refused by name on every call (`data_source_unbound`), never
+ * a thrown `undefined is not a function` in a render.
+ */
+declare function storeDoors(client: unknown): StoreDoors;
+
 /** The SQLSTATEs this package claims to understand. Exported for the guard. */
 declare const MAPPED_SQLSTATES: string[];
 /** Map a PostgREST/supabase-js failure into the package's refusal shape. */
@@ -763,4 +852,4 @@ declare function seededDataSource(index: Map<string, unknown>): {
     missed: () => boolean;
 };
 
-export { type BlockOutcome, DEFAULT_DOCUMENT_MAX_BYTES, DEFAULT_VALUE_MAX_BYTES, DOORS, type DoorKey, type ExportRow, Field, LANDING_SOURCE_TYPE, LANDING_TARGET_TYPES, type Landing, type LandingBlock, type LandingOutcomes, type LandingState, type LandingStore, MAPPED_SQLSTATES, type MirrorLimits, OUTPUT_KEPT_KEY, PRIMED_DOOR_TTL_MS, PRODUCED_BY_LABEL, type ParsedImport, PgError, PredictedRefusal, type PrimedBundleAnswer, type ReadFileText, ReadValue, RecordDocument, RecordsDataSource, RecordsError, RecordsResult, type RecordsSeed, type RecordsSeedAnswer, StaleWriteDetail, type SupabaseLike, TableKindFacts, Uuid, WHOLE_VALUE_SOURCE_KIND, type WholeValuePointer, announceRecordChanged, announceTableStructureChanged, archivedOrganizationId, asRecordsDataSource, blockLandedInStore, cellText, doorAbsent, doorCensus, doorExists, doorReady, dropPrimedDoorAnswers, exportCellText, exportCsv, exportMarkdown, exportXlsx, forgetPrimedTablePageBundles, importCsv, importXlsx, isRecordRemoved, landingOutcomesFor, mapPgError, mapThrownError, markRecordRemoved, markRecordRestored, onRecordChanged, onTableStructureChanged, outcomeForBlock, outputIsKept, parseCsv, predictEnvelopeRefusal, predictSizeRefusal, predictValueRefusals, predictWriteRefusals, primeDoorAnswer, primeRecordPageBundle, primeTablePageBundle, recordingDataSource, seedIndex, seedKey, seededDataSource, staleWriteDetail, supabaseDataSource, tableKindFacts, takePrimedTablePageBundle, toAoa, valuesAreUnconfirmed, wholeValueNotRead, wholeValueOf, wholeValueOfRead, wholeValueSize, withWholeValues };
+export { type BlockOutcome, DEFAULT_DOCUMENT_MAX_BYTES, DEFAULT_VALUE_MAX_BYTES, DOORS, type DoorKey, type ExportRow, Field, LANDING_SOURCE_TYPE, LANDING_TARGET_TYPES, type Landing, type LandingBlock, type LandingOutcomes, type LandingState, type LandingStore, MAPPED_SQLSTATES, type MirrorLimits, OUTPUT_KEPT_KEY, PRIMED_DOOR_TTL_MS, PRODUCED_BY_LABEL, type ParsedImport, PgError, PredictedRefusal, type PrimedBundleAnswer, type ReadFileText, ReadValue, RecordDocument, RecordsDataSource, RecordsError, RecordsResult, type RecordsSeed, type RecordsSeedAnswer, STORE_SCHEMA, StaleWriteDetail, type StoreCaller, type StoreDoorAnswer, type StoreDoorError, type StoreDoors, type SupabaseLike, TableKindFacts, Uuid, WHOLE_VALUE_SOURCE_KIND, type WholeValuePointer, announceRecordChanged, announceTableStructureChanged, archivedOrganizationId, asRecordsDataSource, blockLandedInStore, cellText, doorAbsent, doorCensus, doorExists, doorReady, dropPrimedDoorAnswers, exportCellText, exportCsv, exportMarkdown, exportXlsx, forgetPrimedTablePageBundles, importCsv, importXlsx, isRecordRemoved, landingOutcomesFor, mapPgError, mapThrownError, markRecordRemoved, markRecordRestored, onRecordChanged, onTableStructureChanged, outcomeForBlock, outputIsKept, parseCsv, predictEnvelopeRefusal, predictSizeRefusal, predictValueRefusals, predictWriteRefusals, primeDoorAnswer, primeRecordPageBundle, primeTablePageBundle, recordingDataSource, seedIndex, seedKey, seededDataSource, staleWriteDetail, storeDoors, supabaseDataSource, tableKindFacts, takePrimedTablePageBundle, toAoa, valuesAreUnconfirmed, wholeValueNotRead, wholeValueOf, wholeValueOfRead, wholeValueSize, withWholeValues };

package/dist/core/index.js

@@ -10731,6 +10731,58 @@ function blockLandedInStore(outcomes, block) {
   return false;
 }
 
+// src/core/storeDoors.ts
+var STORE_SCHEMA = "custom";
+function storeDoors(client) {
+  const source = supabaseDataSource(client ?? {});
+  const call = (fn, args = {}) => source.rpc(fn, args, { schema: STORE_SCHEMA });
+  const typed = (fn, args) => call(fn, args);
+  return {
+    rpc: call,
+    async whereIdOpens(id) {
+      const raw = await call("where_id_opens", { p_id: id });
+      const e = raw.error;
+      return {
+        data: raw.data ?? null,
+        error: e ? { code: typeof e.code === "string" ? e.code : null, message: typeof e.message === "string" ? e.message : "The record store refused." } : null
+      };
+    },
+    tableKernelId: () => typed("table_kernel_id", {}),
+    readRecordsByIds: (organizationId, tableId, ids) => typed("read_records_by_ids", { p_organization_id: organizationId, p_table_id: tableId, p_record_ids: ids }),
+    readRecordsPage: (args) => typed("read_records_page", args),
+    recordTable: (organizationId, recordId) => typed("record_table", { p_organization_id: organizationId, p_record_id: recordId }),
+    applicableFields: (organizationId, tableId) => typed("applicable_fields", { p_organization_id: organizationId, p_table_id: tableId }),
+    fieldDeclare: (organizationId, tableId, spec) => typed("field_declare", { p_organization_id: organizationId, p_table_id: tableId, p_spec: spec }),
+    recordUpdate: (organizationId, recordId, patch) => typed("record_update", { p_organization_id: organizationId, p_record_id: recordId, p_patch: patch }),
+    entityReferenceWords: (organizationId, refs) => typed("entity_reference_words", { p_organization_id: organizationId, p_refs: refs.map((r) => ({ token: r.token, id: r.id })) }),
+    templates: (filter) => typed("templates", { p_filter: filter }),
+    templateFromTables: ({ organizationId, tableIds, includeRows, rowsPerTable }) => typed("template_from_tables", {
+      p_organization_id: organizationId,
+      p_table_ids: tableIds,
+      p_include_rows: includeRows,
+      p_rows_per_table: rowsPerTable
+    }),
+    templateDeclare: (scope, spec) => typed("template_declare", { p_scope: scope, p_spec: spec }),
+    templateKeep: (templateId) => typed("template_keep", { p_template_id: templateId }),
+    templateArchive: (templateId, restore) => typed("template_archive", restore === void 0 ? { p_template_id: templateId } : { p_template_id: templateId, p_restore: restore }),
+    templateInstallClaim: ({ organizationId, installId, kind, label, sourceId, leaseSeconds }) => typed("template_install_claim", {
+      p_organization_id: organizationId,
+      p_install_id: installId,
+      p_kind: kind,
+      p_label: label,
+      ...sourceId ? { p_source_id: sourceId } : {},
+      p_lease_seconds: leaseSeconds
+    }),
+    templateInstallNote: ({ organizationId, installId, kind, id, label }) => typed("template_install_note", {
+      p_organization_id: organizationId,
+      p_install_id: installId,
+      p_kind: kind,
+      p_id: id,
+      p_label: label
+    })
+  };
+}
+
 // src/core/validation.ts
 import { isUuidShape as isUuidShape6 } from "@ai-matrx/kit/uuid";
 var DEFAULT_VALUE_MAX_BYTES = 1e5;
@@ -11350,6 +11402,7 @@ export {
   STORE_DOORS,
   STORE_KNOBS,
   STORE_REFUSAL_CODES,
+  STORE_SCHEMA,
   SYSTEM_WRITER_WORDS,
   TABLE_DISPLAYS,
   TABLE_KIND_PREFIX,
@@ -11543,6 +11596,7 @@ export {
   stableFilterKey,
   staleWriteDetail,
   statusGroupOf,
+  storeDoors,
   supabaseDataSource,
   tableIdOf,
   tableJsonSchema,