@ai-matrx/records 0.73.3 → 0.73.5

package/dist/memory/index.d.cts

@@ -3,6 +3,58 @@ import { T as TemplateSpec } from '../types-F7PcHWG_.cjs';
 import { P as PgError } from '../field-CugcsP2y.cjs';
 import '../types-DT_Sk6qp.cjs';
 
+type Json$1 = Record<string, unknown>;
+/** One presented column, exactly as `platform.drill_describe(...).api.columns[]` says it. */
+interface MemoryEntityColumn {
+    api_name: string;
+    name: string;
+    /** "text" | "number" | "choice" | "date" | "datetime" | "checkbox" | … */
+    type: string;
+    writable?: boolean;
+    choices?: string[];
+    /** A column shown as the words another table holds (`replaces`: the id column itself). */
+    lookup?: {
+        via: string;
+        token: string;
+        column: string;
+        replaces: boolean;
+    };
+}
+interface MemoryEntitySpec {
+    token: string;
+    label: string;
+    columns: MemoryEntityColumn[];
+    /** Rows as the door returns them: `id` plus api_name → value, lookups and choices in words. */
+    rows: Json$1[];
+}
+interface MemoryEntity extends MemoryEntitySpec {
+    rows: Json$1[];
+}
+type Answer = {
+    data: unknown;
+    error: null;
+} | {
+    data: null;
+    error: {
+        code: string;
+        message: string;
+        details: null;
+        hint: string | null;
+    };
+};
+/** What `drill_describe` answers for a memory entity (dimensions from its choices, count + sums). */
+declare function memoryEntityDescribe(e: MemoryEntity): Json$1;
+/** What `drill_rows` answers: one page, rows in words. */
+declare function memoryEntityRows(e: MemoryEntity, question: Json$1): Json$1;
+/**
+ * What `drill_ask` answers for a memory entity: one row per group of the asked Dimensions (a choice
+ * or a lookup, both already words here), then the `total` row; `count`, `sum_<col>` and ad hoc
+ * `{op, of}` measures keyed `<op>_<of>` exactly as the live door keys them; `where` narrows first.
+ */
+declare function memoryEntityAsk(e: MemoryEntity, question: Json$1): Json$1[];
+/** What `entity_row_write` does: a choice by its word (any case), refused in the door's words otherwise. */
+declare function memoryEntityWrite(e: MemoryEntity, recordId: string, columns: Json$1): Answer;
+
 type Json = Record<string, unknown>;
 /** The ids the store's kernel tables carry everywhere (custom.table_kernel_id() and its siblings). */
 declare const MEMORY_KERNEL: {
@@ -78,6 +130,8 @@ interface MemoryWorld {
     recordTable: Map<string, MemoryTable>;
     /** Table id → the field key that is its pipeline stage. */
     stageField: Map<string, string>;
+    /** Standard sources (`{ kind: "entity", token }`) this world answers — `withEntities`. */
+    entities?: Map<string, MemoryEntity>;
 }
 interface TemplateWorldOptions {
     /** "YYYY-MM-DD" the template's relative dates resolve against. Default: today (UTC). */
@@ -95,6 +149,9 @@ declare function memoryDataSource(world: MemoryWorld): RecordsDataSource & {
     readonly world: MemoryWorld;
 };
 
+/** Add standard sources (`{ kind: "entity", token }`) to a memory world, in the live doors' shapes. */
+declare function withEntities(world: MemoryWorld, specs: MemoryEntitySpec[]): MemoryWorld;
+
 interface TemplatePreview {
     /** Mount this: `<RecordsMount config={preview.config}>` / `<RecordsProvider config={preview.config}>`. */
     config: RecordsConfig;
@@ -122,5 +179,12 @@ interface TemplatePreview {
 }
 /** A template, installed into memory and ready to mount. Pure for a given spec and day. */
 declare function templatePreview(spec: TemplateSpec, options?: TemplateWorldOptions): TemplatePreview;
+/** A memory store holding only standard sources — mount it like a template preview. */
+declare function entityStore(specs: MemoryEntitySpec[], options?: {
+    today?: string;
+}): {
+    config: RecordsConfig;
+    world: MemoryWorld;
+};
 
-export { MEMORY_KERNEL, type MemoryDashboard, type MemoryField, type MemoryForm, type MemoryOption, type MemoryTable, type MemoryView, type MemoryWorld, PREVIEW_REFUSAL, type TemplatePreview, type TemplateWorldOptions, memoryDataSource, stableId, templatePreview, templateWorld };
+export { MEMORY_KERNEL, type MemoryDashboard, type MemoryEntity, type MemoryEntityColumn, type MemoryEntitySpec, type MemoryField, type MemoryForm, type MemoryOption, type MemoryTable, type MemoryView, type MemoryWorld, PREVIEW_REFUSAL, type TemplatePreview, type TemplateWorldOptions, entityStore, memoryDataSource, memoryEntityAsk, memoryEntityDescribe, memoryEntityRows, memoryEntityWrite, stableId, templatePreview, templateWorld, withEntities };

package/dist/memory/index.d.ts

@@ -3,6 +3,58 @@ import { T as TemplateSpec } from '../types-DL7FEBKg.js';
 import { P as PgError } from '../field-CugcsP2y.js';
 import '../types-DZgTYEVh.js';
 
+type Json$1 = Record<string, unknown>;
+/** One presented column, exactly as `platform.drill_describe(...).api.columns[]` says it. */
+interface MemoryEntityColumn {
+    api_name: string;
+    name: string;
+    /** "text" | "number" | "choice" | "date" | "datetime" | "checkbox" | … */
+    type: string;
+    writable?: boolean;
+    choices?: string[];
+    /** A column shown as the words another table holds (`replaces`: the id column itself). */
+    lookup?: {
+        via: string;
+        token: string;
+        column: string;
+        replaces: boolean;
+    };
+}
+interface MemoryEntitySpec {
+    token: string;
+    label: string;
+    columns: MemoryEntityColumn[];
+    /** Rows as the door returns them: `id` plus api_name → value, lookups and choices in words. */
+    rows: Json$1[];
+}
+interface MemoryEntity extends MemoryEntitySpec {
+    rows: Json$1[];
+}
+type Answer = {
+    data: unknown;
+    error: null;
+} | {
+    data: null;
+    error: {
+        code: string;
+        message: string;
+        details: null;
+        hint: string | null;
+    };
+};
+/** What `drill_describe` answers for a memory entity (dimensions from its choices, count + sums). */
+declare function memoryEntityDescribe(e: MemoryEntity): Json$1;
+/** What `drill_rows` answers: one page, rows in words. */
+declare function memoryEntityRows(e: MemoryEntity, question: Json$1): Json$1;
+/**
+ * What `drill_ask` answers for a memory entity: one row per group of the asked Dimensions (a choice
+ * or a lookup, both already words here), then the `total` row; `count`, `sum_<col>` and ad hoc
+ * `{op, of}` measures keyed `<op>_<of>` exactly as the live door keys them; `where` narrows first.
+ */
+declare function memoryEntityAsk(e: MemoryEntity, question: Json$1): Json$1[];
+/** What `entity_row_write` does: a choice by its word (any case), refused in the door's words otherwise. */
+declare function memoryEntityWrite(e: MemoryEntity, recordId: string, columns: Json$1): Answer;
+
 type Json = Record<string, unknown>;
 /** The ids the store's kernel tables carry everywhere (custom.table_kernel_id() and its siblings). */
 declare const MEMORY_KERNEL: {
@@ -78,6 +130,8 @@ interface MemoryWorld {
     recordTable: Map<string, MemoryTable>;
     /** Table id → the field key that is its pipeline stage. */
     stageField: Map<string, string>;
+    /** Standard sources (`{ kind: "entity", token }`) this world answers — `withEntities`. */
+    entities?: Map<string, MemoryEntity>;
 }
 interface TemplateWorldOptions {
     /** "YYYY-MM-DD" the template's relative dates resolve against. Default: today (UTC). */
@@ -95,6 +149,9 @@ declare function memoryDataSource(world: MemoryWorld): RecordsDataSource & {
     readonly world: MemoryWorld;
 };
 
+/** Add standard sources (`{ kind: "entity", token }`) to a memory world, in the live doors' shapes. */
+declare function withEntities(world: MemoryWorld, specs: MemoryEntitySpec[]): MemoryWorld;
+
 interface TemplatePreview {
     /** Mount this: `<RecordsMount config={preview.config}>` / `<RecordsProvider config={preview.config}>`. */
     config: RecordsConfig;
@@ -122,5 +179,12 @@ interface TemplatePreview {
 }
 /** A template, installed into memory and ready to mount. Pure for a given spec and day. */
 declare function templatePreview(spec: TemplateSpec, options?: TemplateWorldOptions): TemplatePreview;
+/** A memory store holding only standard sources — mount it like a template preview. */
+declare function entityStore(specs: MemoryEntitySpec[], options?: {
+    today?: string;
+}): {
+    config: RecordsConfig;
+    world: MemoryWorld;
+};
 
-export { MEMORY_KERNEL, type MemoryDashboard, type MemoryField, type MemoryForm, type MemoryOption, type MemoryTable, type MemoryView, type MemoryWorld, PREVIEW_REFUSAL, type TemplatePreview, type TemplateWorldOptions, memoryDataSource, stableId, templatePreview, templateWorld };
+export { MEMORY_KERNEL, type MemoryDashboard, type MemoryEntity, type MemoryEntityColumn, type MemoryEntitySpec, type MemoryField, type MemoryForm, type MemoryOption, type MemoryTable, type MemoryView, type MemoryWorld, PREVIEW_REFUSAL, type TemplatePreview, type TemplateWorldOptions, entityStore, memoryDataSource, memoryEntityAsk, memoryEntityDescribe, memoryEntityRows, memoryEntityWrite, stableId, templatePreview, templateWorld, withEntities };