@ai-matrx/records-ui 0.93.133 → 0.93.142

package/dist/pickers.d.cts

@@ -0,0 +1,137 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { Uuid, RecordsDataSource, Field, Table } from '@ai-matrx/records';
+
+/** One row of `custom.data_home_tables()`. */
+interface TableAnywhere {
+    table_id: Uuid;
+    table_name: string;
+    organization_id: Uuid;
+    organization_name: string;
+    kind: string | null;
+    kept_by_the_app: boolean;
+}
+interface TablesAnywhere {
+    loading: boolean;
+    /** The store's own sentence when the list was refused. */
+    error: string | null;
+    rows: TableAnywhere[];
+}
+/** Every Table the person can open, in every organization, sorted by name. */
+declare function useTablesAnywhere(dataSource: RecordsDataSource): TablesAnywhere;
+interface TablePickerProps {
+    dataSource: RecordsDataSource;
+    value: string | null;
+    onChange: (tableId: string) => void;
+    disabled?: boolean;
+    /** Hand in an already-read list to skip a second read. */
+    tables?: TablesAnywhere;
+}
+/** Pick a Table by its name; the id is what `onChange` hands back. */
+declare function TablePicker({ dataSource, value, onChange, disabled, tables }: TablePickerProps): react.JSX.Element;
+interface TableScopeProps {
+    dataSource: RecordsDataSource;
+    /** The signed-in person — the actor every read runs as. */
+    userId: Uuid | null;
+    tableId: string | null;
+    children: ReactNode;
+    /** Shown while the Table's organization is unknown, or when no Table is chosen. */
+    fallback?: ReactNode;
+    tables?: TablesAnywhere;
+}
+/** The record store, bound to the organization the chosen Table lives in. */
+declare function TableScope({ dataSource, userId, tableId, children, fallback, tables }: TableScopeProps): react.JSX.Element;
+interface ColumnValuesEditorProps {
+    tableId: string;
+    /** `{field key: stored value}` — what the step matches on or writes. */
+    value: Record<string, unknown>;
+    onChange: (next: Record<string, unknown>) => void;
+    disabled?: boolean;
+    /** The add button's label: "Add a condition" for a lookup, "Add a value" for a write. */
+    addLabel: string;
+}
+/** Column / value rows for one Table. Must sit inside a `TableScope`. */
+declare function ColumnValuesEditor({ tableId, value, onChange, disabled, addLabel }: ColumnValuesEditorProps): react.JSX.Element;
+interface RecordPickerProps {
+    tableId: string;
+    value: string | null;
+    onChange: (recordId: string) => void;
+    disabled?: boolean;
+}
+/** Pick one record of a Table by its name. Must sit inside a `TableScope`. */
+declare function RecordPicker({ tableId, value, onChange, disabled }: RecordPickerProps): react.JSX.Element;
+
+interface DataBinding {
+    kind: "merge_field";
+    source: "record";
+    semantic_type: "collection" | "reference" | "value";
+    table_id: string;
+    record_id?: string;
+    field_key?: string;
+    match?: Record<string, string | number | boolean | null>;
+    limit?: number;
+    transform?: {
+        name: "list";
+        template: string;
+        join?: string;
+        max?: number;
+    };
+    missing: "absent" | "block";
+    override_policy: "shown_locked";
+}
+type DataBindingShape = DataBinding["semantic_type"];
+declare const DATA_BINDING_SHAPES: {
+    value: DataBindingShape;
+    label: string;
+}[];
+declare const DATA_BINDING_MISSING: {
+    value: DataBinding["missing"];
+    label: string;
+}[];
+/** A fresh, empty whole-table binding. */
+declare function emptyDataBinding(): DataBinding;
+/** True when a value is a merge-field binding (the one shape this picker reads and writes). */
+declare function isDataBinding(value: unknown): value is DataBinding;
+/** Ready to run only when the shape has everything it needs. */
+declare function isCompleteDataBinding(binding: DataBinding): boolean;
+/** The placeholders one column offers; an entity reference offers its words and its id apart. */
+declare function bindingPlaceholdersFor(field: Field): {
+    token: string;
+    label: string;
+}[];
+/** The starting row template: the table's name column, then one or two describing columns. */
+declare function defaultBindingTemplate(table: Pick<Table, "title_field"> | null, fields: readonly Field[]): string;
+interface DataBindingPickerProps {
+    dataSource: RecordsDataSource;
+    /** The signed-in person — every read runs as them. */
+    userId: Uuid | null;
+    binding: DataBinding;
+    onChange: (binding: DataBinding) => void;
+    disabled?: boolean;
+    /** The host's starting row cap for a whole-table read (a knob the host reads), if any. */
+    defaultRowLimit?: number | null;
+}
+/** "From my data": table → shape → record / field → template → when it's missing. */
+declare function DataBindingPicker({ dataSource, userId, binding, onChange, disabled, defaultRowLimit }: DataBindingPickerProps): react.JSX.Element;
+
+/** The chosen table's name, or `—` when it is not one this person can open. */
+declare function TableNameText({ dataSource, tableId }: {
+    dataSource: RecordsDataSource;
+    tableId: string | null;
+}): react.JSX.Element;
+/** `{column key: value}` as "Column is value, Other is value" for one table. */
+declare function ColumnValuesText({ dataSource, userId, tableId, value, }: {
+    dataSource: RecordsDataSource;
+    userId: Uuid | null;
+    tableId: string | null;
+    value: Record<string, unknown>;
+}): react.JSX.Element;
+/** One record of a table, read back as its name. */
+declare function RecordNameText({ dataSource, userId, tableId, recordId, }: {
+    dataSource: RecordsDataSource;
+    userId: Uuid | null;
+    tableId: string | null;
+    recordId: string | null;
+}): react.JSX.Element;
+
+export { ColumnValuesEditor, type ColumnValuesEditorProps, ColumnValuesText, DATA_BINDING_MISSING, DATA_BINDING_SHAPES, type DataBinding, DataBindingPicker, type DataBindingPickerProps, type DataBindingShape, RecordNameText, RecordPicker, type RecordPickerProps, type TableAnywhere, TableNameText, TablePicker, type TablePickerProps, TableScope, type TableScopeProps, type TablesAnywhere, bindingPlaceholdersFor, defaultBindingTemplate, emptyDataBinding, isCompleteDataBinding, isDataBinding, useTablesAnywhere };

package/dist/pickers.d.ts

@@ -0,0 +1,137 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { Uuid, RecordsDataSource, Field, Table } from '@ai-matrx/records';
+
+/** One row of `custom.data_home_tables()`. */
+interface TableAnywhere {
+    table_id: Uuid;
+    table_name: string;
+    organization_id: Uuid;
+    organization_name: string;
+    kind: string | null;
+    kept_by_the_app: boolean;
+}
+interface TablesAnywhere {
+    loading: boolean;
+    /** The store's own sentence when the list was refused. */
+    error: string | null;
+    rows: TableAnywhere[];
+}
+/** Every Table the person can open, in every organization, sorted by name. */
+declare function useTablesAnywhere(dataSource: RecordsDataSource): TablesAnywhere;
+interface TablePickerProps {
+    dataSource: RecordsDataSource;
+    value: string | null;
+    onChange: (tableId: string) => void;
+    disabled?: boolean;
+    /** Hand in an already-read list to skip a second read. */
+    tables?: TablesAnywhere;
+}
+/** Pick a Table by its name; the id is what `onChange` hands back. */
+declare function TablePicker({ dataSource, value, onChange, disabled, tables }: TablePickerProps): react.JSX.Element;
+interface TableScopeProps {
+    dataSource: RecordsDataSource;
+    /** The signed-in person — the actor every read runs as. */
+    userId: Uuid | null;
+    tableId: string | null;
+    children: ReactNode;
+    /** Shown while the Table's organization is unknown, or when no Table is chosen. */
+    fallback?: ReactNode;
+    tables?: TablesAnywhere;
+}
+/** The record store, bound to the organization the chosen Table lives in. */
+declare function TableScope({ dataSource, userId, tableId, children, fallback, tables }: TableScopeProps): react.JSX.Element;
+interface ColumnValuesEditorProps {
+    tableId: string;
+    /** `{field key: stored value}` — what the step matches on or writes. */
+    value: Record<string, unknown>;
+    onChange: (next: Record<string, unknown>) => void;
+    disabled?: boolean;
+    /** The add button's label: "Add a condition" for a lookup, "Add a value" for a write. */
+    addLabel: string;
+}
+/** Column / value rows for one Table. Must sit inside a `TableScope`. */
+declare function ColumnValuesEditor({ tableId, value, onChange, disabled, addLabel }: ColumnValuesEditorProps): react.JSX.Element;
+interface RecordPickerProps {
+    tableId: string;
+    value: string | null;
+    onChange: (recordId: string) => void;
+    disabled?: boolean;
+}
+/** Pick one record of a Table by its name. Must sit inside a `TableScope`. */
+declare function RecordPicker({ tableId, value, onChange, disabled }: RecordPickerProps): react.JSX.Element;
+
+interface DataBinding {
+    kind: "merge_field";
+    source: "record";
+    semantic_type: "collection" | "reference" | "value";
+    table_id: string;
+    record_id?: string;
+    field_key?: string;
+    match?: Record<string, string | number | boolean | null>;
+    limit?: number;
+    transform?: {
+        name: "list";
+        template: string;
+        join?: string;
+        max?: number;
+    };
+    missing: "absent" | "block";
+    override_policy: "shown_locked";
+}
+type DataBindingShape = DataBinding["semantic_type"];
+declare const DATA_BINDING_SHAPES: {
+    value: DataBindingShape;
+    label: string;
+}[];
+declare const DATA_BINDING_MISSING: {
+    value: DataBinding["missing"];
+    label: string;
+}[];
+/** A fresh, empty whole-table binding. */
+declare function emptyDataBinding(): DataBinding;
+/** True when a value is a merge-field binding (the one shape this picker reads and writes). */
+declare function isDataBinding(value: unknown): value is DataBinding;
+/** Ready to run only when the shape has everything it needs. */
+declare function isCompleteDataBinding(binding: DataBinding): boolean;
+/** The placeholders one column offers; an entity reference offers its words and its id apart. */
+declare function bindingPlaceholdersFor(field: Field): {
+    token: string;
+    label: string;
+}[];
+/** The starting row template: the table's name column, then one or two describing columns. */
+declare function defaultBindingTemplate(table: Pick<Table, "title_field"> | null, fields: readonly Field[]): string;
+interface DataBindingPickerProps {
+    dataSource: RecordsDataSource;
+    /** The signed-in person — every read runs as them. */
+    userId: Uuid | null;
+    binding: DataBinding;
+    onChange: (binding: DataBinding) => void;
+    disabled?: boolean;
+    /** The host's starting row cap for a whole-table read (a knob the host reads), if any. */
+    defaultRowLimit?: number | null;
+}
+/** "From my data": table → shape → record / field → template → when it's missing. */
+declare function DataBindingPicker({ dataSource, userId, binding, onChange, disabled, defaultRowLimit }: DataBindingPickerProps): react.JSX.Element;
+
+/** The chosen table's name, or `—` when it is not one this person can open. */
+declare function TableNameText({ dataSource, tableId }: {
+    dataSource: RecordsDataSource;
+    tableId: string | null;
+}): react.JSX.Element;
+/** `{column key: value}` as "Column is value, Other is value" for one table. */
+declare function ColumnValuesText({ dataSource, userId, tableId, value, }: {
+    dataSource: RecordsDataSource;
+    userId: Uuid | null;
+    tableId: string | null;
+    value: Record<string, unknown>;
+}): react.JSX.Element;
+/** One record of a table, read back as its name. */
+declare function RecordNameText({ dataSource, userId, tableId, recordId, }: {
+    dataSource: RecordsDataSource;
+    userId: Uuid | null;
+    tableId: string | null;
+    recordId: string | null;
+}): react.JSX.Element;
+
+export { ColumnValuesEditor, type ColumnValuesEditorProps, ColumnValuesText, DATA_BINDING_MISSING, DATA_BINDING_SHAPES, type DataBinding, DataBindingPicker, type DataBindingPickerProps, type DataBindingShape, RecordNameText, RecordPicker, type RecordPickerProps, type TableAnywhere, TableNameText, TablePicker, type TablePickerProps, TableScope, type TableScopeProps, type TablesAnywhere, bindingPlaceholdersFor, defaultBindingTemplate, emptyDataBinding, isCompleteDataBinding, isDataBinding, useTablesAnywhere };