@ai-matrx/records 0.87.32 → 0.92.1

package/dist/data/index.d.cts

@@ -1,144 +1,14 @@
-import { bP as EntityRefWithWords } from '../table-kind-BZu8mtND.cjs';
-import { U as Uuid, i as RecordsResult, o as RecordPageSort, n as ReadRow } from '../record-DpB2QgAZ.cjs';
-import { R as RecordsClient } from '../client-C3ZZNfGH.cjs';
-import { b as Field } from '../field-BanTVGK2.cjs';
-import { u as RuleExpression } from '../subscription-BD9DnJxX.cjs';
-import '../ports-D8-iuY1P.cjs';
-
-/** §0. A link to any thing: `{token, id, label}`. A custom row's token is `record`. Every link reads as `EntityRef[]`. */
-type EntityRef = EntityRefWithWords;
-/** The token a custom table's row carries (platform.entity_types maps `record` → `custom.record`). */
-declare const CUSTOM_ROW_TOKEN = "record";
-/** §0. One column, read live — never from a generated file. */
-interface Column {
-    /** The store's stable field key — never derived from the label. No platform key starts with "_". */
-    key: string;
-    label: string;
-    /** The store's word for what the value is: text, number, date, datetime, boolean, list, relation, formula, … */
-    type: string;
-    origin: "platform" | "custom";
-    required: boolean;
-    /** For a choice column: the words a person picks from (what a cell reads as and a write takes). */
-    choices?: string[];
-    /** For a link column: what it may point at (a custom table's id, or entity tokens). */
-    linksTo?: string[];
-    /**
-     * For a link column: the alias, in the SAME port, that serves the table it points at — so a form can list
-     * the linked rows to pick from. Absent when no source of this Applet serves that table.
-     */
-    linksToSource?: string;
-    /**
-     * The store's own answer to "does this column hold more than one value" (`custom.field.multi`). A choice
-     * column's type is `list` whether it takes one word or many — only this tells them apart (Status, one
-     * value, drew as four switches and the store refused the list it sent: social planner, 2026-10-08).
-     */
-    multi?: boolean;
-    /** The column a row is named by (the table's `title_field`) — what a link to the row reads as. */
-    title?: boolean;
-    readOnly: boolean;
-}
-/** §0. One row, keyed by `Column.key`. Underscore keys are the runtime's own. */
-interface Row {
-    _id: Uuid;
-    _version: number;
-    _organization_id: Uuid;
-    /** On a platform row only: the organization's custom fields (a real column may be named `custom`). */
-    _custom?: Record<string, unknown>;
-    [key: string]: unknown;
-}
-/** §0. What a write carries, keyed by `Column.key`; `_custom` on platform sources. */
-type Values = Record<string, unknown> & {
-    _custom?: Record<string, unknown>;
-};
-type WhereOp = "eq" | "neq" | "lt" | "lte" | "gt" | "gte" | "contains" | "in" | "empty";
-interface WhereClause {
-    column: string;
-    op: WhereOp;
-    value?: unknown;
-}
-type Lane = "all" | "mine" | "team" | "orgs" | "shared" | "public" | "system";
-/** §4. A question of one source. Every clause must hold. */
-interface Query {
-    where?: WhereClause[];
-    search?: string;
-    sort?: {
-        column: string;
-        direction?: "asc" | "desc";
-    }[];
-    pageSize?: number;
-    /** Default: the type's "Shown to by default" knob. A custom table has one lane: what row security shows. */
-    lane?: Lane;
-    /** A filter, never a lock. Default "all". */
-    org?: Uuid | "all";
-}
-/** §4. One page; `cursor` is null on the last one. */
-interface Page {
-    rows: Row[];
-    total: number | null;
-    cursor: string | null;
-}
-interface DataSource {
-    alias: string;
-    label: string;
-    kind: "table" | "entity";
-    canCreate: boolean;
-    canUpdate: boolean;
-}
-/** The one event stream a source has: these ids moved — re-read only them. `null`: cannot tell which. */
-interface RowsEvent {
-    ids: Uuid[] | null;
-    /** The table's columns moved (one added, retired or changed): re-read `columns()` too. */
-    shape?: true;
-}
-type DataPortEventName = `rows:${string}`;
-/** §4. The host's data port, scoped to ONE mounted Applet's aliases. Every call answers, never throws. */
-interface DataPort {
-    sources(): Promise<RecordsResult<DataSource[]>>;
-    columns(alias: string): Promise<RecordsResult<Column[]>>;
-    list(alias: string, q: Query, cursor?: string): Promise<RecordsResult<Page>>;
-    get(alias: string, id: Uuid): Promise<RecordsResult<Row | null>>;
-    create(alias: string, values: Values): Promise<RecordsResult<Row>>;
-    update(alias: string, id: Uuid, patch: Values, baseVersion: number): Promise<RecordsResult<Row>>;
-    archive(alias: string, id: Uuid): Promise<RecordsResult<void>>;
-    restore(alias: string, id: Uuid): Promise<RecordsResult<void>>;
-}
-/**
- * The frame's side of the §1 event stream `rows:<alias>` (the AppletHost's `host.events`). The listener
- * stays in the frame; only the event payload `{ids, shape?}` crosses the channel.
- */
-interface DataEvents {
-    on(event: DataPortEventName, listener: (event: RowsEvent) => void): () => void;
-}
-/**
- * The HOST's DataPort (contracts amendment 2.2): the port plus the producer of its event streams.
- * `subscribe` never crosses the frame/host channel — the AppletHost turns it into `rows:<alias>`.
- */
-interface HostDataPort extends DataPort {
-    subscribe(event: DataPortEventName, listener: (event: RowsEvent) => void): () => void;
-}
-/** An alias as the Applet record declares it: one table plus its organization (an entity token is phase B). */
-interface TableAlias {
-    kind: "table";
-    tableId: Uuid;
-    organizationId: Uuid;
-    /** Shown in `sources()`; the table's own name when left out. */
-    label?: string;
-}
-/**
- * An alias bound to one PLATFORM entity type (contacts, projects, tasks…), served by `@ai-matrx/entity-data`'s port.
- * `organizationId` is an assumed organization FILTER for its lists, never a lock; writes carry the active organization.
- */
-interface EntityAlias {
-    kind: "entity";
-    /** The type's token in `platform.entity_types` (`party`, `project`, `task`, …). */
-    token: string;
-    organizationId?: Uuid;
-    label?: string;
-}
-/** Every alias an Applet record can declare. A host routes each kind to the port that serves it. */
-type AnyAlias = TableAlias | EntityAlias;
-/** What the table port takes (it serves `table` aliases only). */
-type AliasBinding = TableAlias;
+import { C as Column, Q as Query, A as AliasBinding, H as HostDataPort } from '../types-BKYEeFt4.cjs';
+export { a as AnyAlias, b as CUSTOM_ROW_TOKEN, D as DataEvents, c as DataPort, d as DataPortEventName, e as DataSource, E as EntityAlias, f as EntityRef, L as Lane, P as Page, R as Row, g as RowsEvent, T as TableAlias, V as Values, W as WhereClause, h as WhereOp } from '../types-BKYEeFt4.cjs';
+import { R as RecordsClient } from '../client-Cn3odIIB.cjs';
+import { b as Field } from '../field-CCY1rG9l.cjs';
+import { U as Uuid, R as RecordsResult, r as RecordPageSort, q as ReadRow } from '../record-BwCf9wKW.cjs';
+import { R as RuleExpression } from '../rule-wHI5B0Ka.cjs';
+import '../relation-8vAWCa67.cjs';
+import '../ports-s0D2jvqn.cjs';
+import '../table-kind-DzctQ7dO.cjs';
+import '../subscription-CdoI-UaB.cjs';
+import '../portal-DRdmZ-xv.cjs';
 
 interface TableShape {
     columns: Column[];
@@ -173,4 +43,4 @@ interface CreateTableDataPortOptions {
 }
 declare function createTableDataPort({ client, aliases }: CreateTableDataPortOptions): HostDataPort;
 
-export { type AliasBinding, type AnyAlias, CUSTOM_ROW_TOKEN, type Column, type CreateTableDataPortOptions, DATA_PAGE_CEILING, DATA_PAGE_DEFAULT, type DataEvents, type DataPort, type DataPortEventName, type DataSource, type EntityAlias, type EntityRef, type HostDataPort, type Lane, type Page, type Query, type Row, type RowsEvent, type TableAlias, type TableShape, Uuid, type Values, type VersionedReadRow, type WhereClause, type WhereOp, columnTypeOf, compileSort, compileWhere, containsPattern, createTableDataPort, readTableShape };
+export { AliasBinding, Column, type CreateTableDataPortOptions, DATA_PAGE_CEILING, DATA_PAGE_DEFAULT, HostDataPort, Query, type TableShape, Uuid, type VersionedReadRow, columnTypeOf, compileSort, compileWhere, containsPattern, createTableDataPort, readTableShape };

package/dist/data/index.d.ts

@@ -1,144 +1,14 @@
-import { bP as EntityRefWithWords } from '../table-kind-xKxTHtrV.js';
-import { U as Uuid, i as RecordsResult, o as RecordPageSort, n as ReadRow } from '../record-DpB2QgAZ.js';
-import { R as RecordsClient } from '../client-E0VQ0NPO.js';
-import { b as Field } from '../field-BPABOJ2Y.js';
-import { u as RuleExpression } from '../subscription-D7KQBHXN.js';
-import '../ports-TMWX-t9l.js';
-
-/** §0. A link to any thing: `{token, id, label}`. A custom row's token is `record`. Every link reads as `EntityRef[]`. */
-type EntityRef = EntityRefWithWords;
-/** The token a custom table's row carries (platform.entity_types maps `record` → `custom.record`). */
-declare const CUSTOM_ROW_TOKEN = "record";
-/** §0. One column, read live — never from a generated file. */
-interface Column {
-    /** The store's stable field key — never derived from the label. No platform key starts with "_". */
-    key: string;
-    label: string;
-    /** The store's word for what the value is: text, number, date, datetime, boolean, list, relation, formula, … */
-    type: string;
-    origin: "platform" | "custom";
-    required: boolean;
-    /** For a choice column: the words a person picks from (what a cell reads as and a write takes). */
-    choices?: string[];
-    /** For a link column: what it may point at (a custom table's id, or entity tokens). */
-    linksTo?: string[];
-    /**
-     * For a link column: the alias, in the SAME port, that serves the table it points at — so a form can list
-     * the linked rows to pick from. Absent when no source of this Applet serves that table.
-     */
-    linksToSource?: string;
-    /**
-     * The store's own answer to "does this column hold more than one value" (`custom.field.multi`). A choice
-     * column's type is `list` whether it takes one word or many — only this tells them apart (Status, one
-     * value, drew as four switches and the store refused the list it sent: social planner, 2026-10-08).
-     */
-    multi?: boolean;
-    /** The column a row is named by (the table's `title_field`) — what a link to the row reads as. */
-    title?: boolean;
-    readOnly: boolean;
-}
-/** §0. One row, keyed by `Column.key`. Underscore keys are the runtime's own. */
-interface Row {
-    _id: Uuid;
-    _version: number;
-    _organization_id: Uuid;
-    /** On a platform row only: the organization's custom fields (a real column may be named `custom`). */
-    _custom?: Record<string, unknown>;
-    [key: string]: unknown;
-}
-/** §0. What a write carries, keyed by `Column.key`; `_custom` on platform sources. */
-type Values = Record<string, unknown> & {
-    _custom?: Record<string, unknown>;
-};
-type WhereOp = "eq" | "neq" | "lt" | "lte" | "gt" | "gte" | "contains" | "in" | "empty";
-interface WhereClause {
-    column: string;
-    op: WhereOp;
-    value?: unknown;
-}
-type Lane = "all" | "mine" | "team" | "orgs" | "shared" | "public" | "system";
-/** §4. A question of one source. Every clause must hold. */
-interface Query {
-    where?: WhereClause[];
-    search?: string;
-    sort?: {
-        column: string;
-        direction?: "asc" | "desc";
-    }[];
-    pageSize?: number;
-    /** Default: the type's "Shown to by default" knob. A custom table has one lane: what row security shows. */
-    lane?: Lane;
-    /** A filter, never a lock. Default "all". */
-    org?: Uuid | "all";
-}
-/** §4. One page; `cursor` is null on the last one. */
-interface Page {
-    rows: Row[];
-    total: number | null;
-    cursor: string | null;
-}
-interface DataSource {
-    alias: string;
-    label: string;
-    kind: "table" | "entity";
-    canCreate: boolean;
-    canUpdate: boolean;
-}
-/** The one event stream a source has: these ids moved — re-read only them. `null`: cannot tell which. */
-interface RowsEvent {
-    ids: Uuid[] | null;
-    /** The table's columns moved (one added, retired or changed): re-read `columns()` too. */
-    shape?: true;
-}
-type DataPortEventName = `rows:${string}`;
-/** §4. The host's data port, scoped to ONE mounted Applet's aliases. Every call answers, never throws. */
-interface DataPort {
-    sources(): Promise<RecordsResult<DataSource[]>>;
-    columns(alias: string): Promise<RecordsResult<Column[]>>;
-    list(alias: string, q: Query, cursor?: string): Promise<RecordsResult<Page>>;
-    get(alias: string, id: Uuid): Promise<RecordsResult<Row | null>>;
-    create(alias: string, values: Values): Promise<RecordsResult<Row>>;
-    update(alias: string, id: Uuid, patch: Values, baseVersion: number): Promise<RecordsResult<Row>>;
-    archive(alias: string, id: Uuid): Promise<RecordsResult<void>>;
-    restore(alias: string, id: Uuid): Promise<RecordsResult<void>>;
-}
-/**
- * The frame's side of the §1 event stream `rows:<alias>` (the AppletHost's `host.events`). The listener
- * stays in the frame; only the event payload `{ids, shape?}` crosses the channel.
- */
-interface DataEvents {
-    on(event: DataPortEventName, listener: (event: RowsEvent) => void): () => void;
-}
-/**
- * The HOST's DataPort (contracts amendment 2.2): the port plus the producer of its event streams.
- * `subscribe` never crosses the frame/host channel — the AppletHost turns it into `rows:<alias>`.
- */
-interface HostDataPort extends DataPort {
-    subscribe(event: DataPortEventName, listener: (event: RowsEvent) => void): () => void;
-}
-/** An alias as the Applet record declares it: one table plus its organization (an entity token is phase B). */
-interface TableAlias {
-    kind: "table";
-    tableId: Uuid;
-    organizationId: Uuid;
-    /** Shown in `sources()`; the table's own name when left out. */
-    label?: string;
-}
-/**
- * An alias bound to one PLATFORM entity type (contacts, projects, tasks…), served by `@ai-matrx/entity-data`'s port.
- * `organizationId` is an assumed organization FILTER for its lists, never a lock; writes carry the active organization.
- */
-interface EntityAlias {
-    kind: "entity";
-    /** The type's token in `platform.entity_types` (`party`, `project`, `task`, …). */
-    token: string;
-    organizationId?: Uuid;
-    label?: string;
-}
-/** Every alias an Applet record can declare. A host routes each kind to the port that serves it. */
-type AnyAlias = TableAlias | EntityAlias;
-/** What the table port takes (it serves `table` aliases only). */
-type AliasBinding = TableAlias;
+import { C as Column, Q as Query, A as AliasBinding, H as HostDataPort } from '../types-cpKY7Pjb.js';
+export { a as AnyAlias, b as CUSTOM_ROW_TOKEN, D as DataEvents, c as DataPort, d as DataPortEventName, e as DataSource, E as EntityAlias, f as EntityRef, L as Lane, P as Page, R as Row, g as RowsEvent, T as TableAlias, V as Values, W as WhereClause, h as WhereOp } from '../types-cpKY7Pjb.js';
+import { R as RecordsClient } from '../client-Dzd8gtAo.js';
+import { b as Field } from '../field-enufS5ry.js';
+import { U as Uuid, R as RecordsResult, r as RecordPageSort, q as ReadRow } from '../record-BwCf9wKW.js';
+import { R as RuleExpression } from '../rule-D9yNiorf.js';
+import '../relation-eLMgv_dV.js';
+import '../ports-BeOgjwYl.js';
+import '../table-kind-i3lZJa3f.js';
+import '../subscription-BynsG1K6.js';
+import '../portal-or_f7BkT.js';
 
 interface TableShape {
     columns: Column[];
@@ -173,4 +43,4 @@ interface CreateTableDataPortOptions {
 }
 declare function createTableDataPort({ client, aliases }: CreateTableDataPortOptions): HostDataPort;
 
-export { type AliasBinding, type AnyAlias, CUSTOM_ROW_TOKEN, type Column, type CreateTableDataPortOptions, DATA_PAGE_CEILING, DATA_PAGE_DEFAULT, type DataEvents, type DataPort, type DataPortEventName, type DataSource, type EntityAlias, type EntityRef, type HostDataPort, type Lane, type Page, type Query, type Row, type RowsEvent, type TableAlias, type TableShape, Uuid, type Values, type VersionedReadRow, type WhereClause, type WhereOp, columnTypeOf, compileSort, compileWhere, containsPattern, createTableDataPort, readTableShape };
+export { AliasBinding, Column, type CreateTableDataPortOptions, DATA_PAGE_CEILING, DATA_PAGE_DEFAULT, HostDataPort, Query, type TableShape, Uuid, type VersionedReadRow, columnTypeOf, compileSort, compileWhere, containsPattern, createTableDataPort, readTableShape };

package/dist/data/index.js

@@ -290,9 +290,18 @@ function stableFilterKey(filter) {
   return `{${parts.join(",")}}`;
 }
 function liftWithheld(rows) {
+  let shared;
+  for (const row of rows) {
+    const m = (row.measures ?? {})["_withheld"];
+    if (m !== void 0 && m !== null && typeof m === "object") {
+      shared = m;
+      break;
+    }
+  }
   return rows.map((row) => {
     const measures = row.measures ?? {};
-    const marker = measures["_withheld"];
+    const own = measures["_withheld"];
+    const marker = own !== void 0 && own !== null && typeof own === "object" ? own : shared;
     const rowCount = row.row_count ?? 0;
     if (marker === void 0 || marker === null || typeof marker !== "object") {
       return rowCount === row.row_count ? row : { ...row, row_count: rowCount };
@@ -3222,24 +3231,27 @@ function createRecordsClient(given) {
       if (!pass.ok) return pass;
       return carryOnCopy(pass.data, onProgress);
     },
-    async recordRead({ record_id, withComputed = false, organization_id }) {
+    async recordRead({ record_id, withComputed = false, withVersion = false, organization_id }) {
       if (organization_id && organization_id !== org) {
-        return clientFor(organization_id).recordRead({ record_id, withComputed, organization_id });
+        return clientFor(organization_id).recordRead({ record_id, withComputed, withVersion, organization_id });
       }
       if (readOrgs(organization_id).length > 1) {
         return openInOwnOrg(
           record_id,
           organization_id,
-          (sub) => sub.recordRead({ record_id, withComputed, organization_id: sub.config.organizationId }),
+          (sub) => sub.recordRead({ record_id, withComputed, withVersion, organization_id: sub.config.organizationId }),
           () => true
         );
       }
-      const door = await callDoor(
-        DOORS.readRecord,
-        { p_organization_id: org, p_record_id: record_id },
-        "recordRead"
-      );
+      const [door, header] = await Promise.all([
+        callDoor(DOORS.readRecord, { p_organization_id: org, p_record_id: record_id }, "recordRead"),
+        // A version that cannot be read never takes the record away: it comes back as null.
+        withVersion ? callDoor(DOORS.recordHeaders, { p_organization_id: org, p_ids: [record_id] }, "recordRead.version").catch(
+          () => null
+        ) : Promise.resolve(null)
+      ]);
       if (!door.ok) return err(door.error);
+      const version = header && header.ok ? header.data?.find((h) => h.id === record_id)?.version ?? null : null;
       const { document, hidden } = unfold(door.data);
       let computed = [];
       let computedUnavailable = null;
@@ -3252,7 +3264,7 @@ function createRecordsClient(given) {
         if (provenance.ok) computed = provenance.data ?? [];
         else computedUnavailable = provenance.error;
       }
-      return ok({ record_id, document, hidden, computed, computedUnavailable });
+      return ok({ record_id, document, hidden, computed, computedUnavailable, ...withVersion ? { version } : {} });
     },
     async listByIds({ table_id, ids }) {
       if (ids.length === 0) return ok([]);