@ai-matrx/records-ui 0.89.2 → 0.90.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import { ReactNode, ComponentType, RefObject } from 'react';
 import * as _ai_matrx_records from '@ai-matrx/records';
-import { PermissionLevel, Table, RecordScopeContext, EnrichCell, RecordsError, Field, TableDecorations, Uuid as Uuid$1, StoreFilter, AggregateFilter, RecordDocument, ReadRow, RelationDisplay, WriteConflict, RecordsErrorCode, RecordFilter, RuleExpression, RecordsResult, SavedViewRow, DeclarableFieldKind, ParityFieldType, NewFieldDeclaration, HiddenFieldNotice, ValueEnvelope, ChecklistRequirementKind, ContextPolicy, WorkDueState, FieldSensitivity, StageRuleOnFail, SubscriptionCadence, WorkApprovalState, WorkInboxKind, FieldKind, ArchiveLane, ArchivedRow, WorkInboxView, WorkInboxItem, FormSummary, PortalCard, PortalPrincipal, PortalPreviewRow, MySubscription, DashboardBlockKind, AggregateBucket, AggregateMeasure, AggregateCompare, DashboardTarget, DashboardBlock, DashboardSummary, DocTemplateRow, DocRenderRow, QuietHours, DashboardBlockResult, ChecklistRunStep, BookingSummary, CaptureSheetFace, CaptureField, AnonTokenBinding, RecordsConfig, RecordsActor, RecordsDataSource, HistoryActor, FieldHistoryEntry } from '@ai-matrx/records';
+import { PermissionLevel, Table, RecordScopeContext, EnrichCell, RecordsError, Field, TableDecorations, Uuid as Uuid$1, RowAction, RecordDocument, StoreFilter, AggregateFilter, ReadRow, RelationDisplay, WriteConflict, RecordsErrorCode, RecordFilter, RuleExpression, RecordsResult, SavedViewRow, DeclarableFieldKind, ParityFieldType, NewFieldDeclaration, HiddenFieldNotice, ValueEnvelope, ChecklistRequirementKind, ContextPolicy, WorkDueState, FieldSensitivity, StageRuleOnFail, SubscriptionCadence, WorkApprovalState, WorkInboxKind, FieldKind, ArchiveLane, ArchivedRow, WorkInboxView, WorkInboxItem, FormSummary, PortalCard, PortalPrincipal, PortalPreviewRow, MySubscription, DashboardBlockKind, AggregateBucket, AggregateMeasure, AggregateCompare, DashboardTarget, DashboardBlock, DashboardSummary, DocTemplateRow, DocRenderRow, QuietHours, DashboardBlockResult, ChecklistRunStep, BookingSummary, CaptureSheetFace, CaptureField, AnonTokenBinding, RecordsConfig, RecordsActor, RecordsDataSource, HistoryActor, FieldHistoryEntry } from '@ai-matrx/records';
 import { Uuid, Field as Field$1, ReadRow as ReadRow$1, StoreFilter as StoreFilter$1 } from '@ai-matrx/records/react';
 import { TableStyle, GroupAggregateSpec, GroupOrder, ChoiceColorLookup } from '@ai-matrx/design-system/data-table';
 import { FieldFormatConfig } from '@ai-matrx/design-system/field-formats';
@@ -413,6 +413,49 @@ declare function styleFromDecorations(decorations: TableDecorations | null | und
  */
 declare function resolveTableStyle(decorations: TableDecorations | null | undefined, fields: readonly Field[], viewStyle: TableStyle | undefined): TableStyle;
 
+/** One record as the grid shows it: its id, its name (the row label) and its masked document. */
+interface GridContextRecord {
+    id: Uuid$1;
+    title: string;
+    document: RecordDocument;
+}
+interface GridContextSnapshot {
+    tableId: Uuid$1;
+    tableName: string;
+    /** The table's own description (`metadata.description`), when it has one. */
+    tableDescription: string | null;
+    /** The Field key that names each record (`title_field`), or null. */
+    titleField: string | null;
+    /** The columns in the order the grid draws them (hidden columns left out). */
+    fields: Field[];
+    /** The table's row actions as the store lists them (update and agent). */
+    rowActions: RowAction[];
+    /** May this person change records here at all. */
+    canWrite: boolean;
+    /** The cell the cursor is on: its record, its Field key and the value drawn in it. */
+    currentCell: {
+        rowId: Uuid$1;
+        key: string;
+        value: unknown;
+    } | null;
+    /** The record the cursor is on (or whose editor is open). */
+    currentRow: GridContextRecord | null;
+    /** A block of more than one cell: Excel/Sheets TSV with a header line of Field keys. */
+    selectedRange: {
+        tsv: string;
+        cellCount: number;
+        rowIds: Uuid$1[];
+        keys: string[];
+    } | null;
+    /** The rows ticked with the row boxes. */
+    selectedRows: GridContextRecord[];
+    /** The page of records on screen, in screen order. */
+    visibleRows: GridContextRecord[];
+    /** How many records match the search and filters, when the store said. */
+    total: number | null;
+    search: string;
+}
+
 /**
  * What a person may do to one table. The four words and the ladder are the
  * store's (`rights.ts`), not ours.
@@ -485,6 +528,7 @@ interface HostLayout {
 }
 /** The authored-text slots `renderText` is asked to draw. */
 type RenderTextSlot = "form-intro" | "form-help" | "form-thank-you";
+
 interface RecordsUiHost {
     /**
      * TEMPORARY (one-grid merge, steps 5-8). Which table grid draws: `classic` — the default Grid
@@ -496,6 +540,38 @@ interface RecordsUiHost {
     grid?: "classic" | "merged";
     /** Layouts the host draws beside the package's own. See `HostLayout`. */
     layouts?: HostLayout[];
+    /**
+     * OPTIONAL. CLEAN A PASTED PIECE OF HTML INTO PLAIN TEXT (merge tranche 6m, inventory A7).
+     *
+     * A cell pasted from a web page or an email carries its tags, entities and inline styles. The
+     * platform has ONE cleaner (the host's content-cleanup), so this is a port rather than a second
+     * one here. The merged grid offers "Clean HTML" in a text cell's right-click Cell section and in
+     * the whole-text editor; the cleaned text is written through the grid's own one-cell write (one
+     * undo step). Unbound, the item is ABSENT, never dead.
+     */
+    cleanText?: (text: string) => string;
+    /**
+     * OPTIONAL. WHERE THE PERSON IS IN THE GRID, told as it changes (merge tranche 6l, inventory H1).
+     *
+     * An agent in the host's side chat is asked about "this cell", "these rows", "the table". Only
+     * the grid knows the table, its columns, the cell the cursor is on, the selected block, the
+     * ticked rows, the rows on screen and the search. The merged grid calls this after any of them
+     * changes (identical snapshots are not repeated); the host builds its agent scope from it. The
+     * snapshot carries the store's own `Field` records and the masked documents exactly as drawn.
+     * Unbound, nothing is built.
+     */
+    onGridContext?: (snapshot: GridContextSnapshot) => void;
+    /**
+     * OPTIONAL. THE PLATFORM'S ONE ICON PICKER (merge tranche 6j, inventory G2). A row action's
+     * button may carry an icon from the canonical icon set; that set and its picker are the host's
+     * (this package carries no icon library). Unbound, the row-action editor draws no icon control
+     * and keeps whatever icon an action already carries.
+     */
+    iconPicker?: (props: {
+        value: string;
+        label: string;
+        onChange: (name: string) => void;
+    }) => ReactNode;
     /** Answer the rights question for one table. Synchronous: a screen renders now. */
     rights?: (table: Table) => TableRights;
     /** Where a record's own page lives, when the host has one. A peek is used when it does not. */

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import { ReactNode, ComponentType, RefObject } from 'react';
 import * as _ai_matrx_records from '@ai-matrx/records';
-import { PermissionLevel, Table, RecordScopeContext, EnrichCell, RecordsError, Field, TableDecorations, Uuid as Uuid$1, StoreFilter, AggregateFilter, RecordDocument, ReadRow, RelationDisplay, WriteConflict, RecordsErrorCode, RecordFilter, RuleExpression, RecordsResult, SavedViewRow, DeclarableFieldKind, ParityFieldType, NewFieldDeclaration, HiddenFieldNotice, ValueEnvelope, ChecklistRequirementKind, ContextPolicy, WorkDueState, FieldSensitivity, StageRuleOnFail, SubscriptionCadence, WorkApprovalState, WorkInboxKind, FieldKind, ArchiveLane, ArchivedRow, WorkInboxView, WorkInboxItem, FormSummary, PortalCard, PortalPrincipal, PortalPreviewRow, MySubscription, DashboardBlockKind, AggregateBucket, AggregateMeasure, AggregateCompare, DashboardTarget, DashboardBlock, DashboardSummary, DocTemplateRow, DocRenderRow, QuietHours, DashboardBlockResult, ChecklistRunStep, BookingSummary, CaptureSheetFace, CaptureField, AnonTokenBinding, RecordsConfig, RecordsActor, RecordsDataSource, HistoryActor, FieldHistoryEntry } from '@ai-matrx/records';
+import { PermissionLevel, Table, RecordScopeContext, EnrichCell, RecordsError, Field, TableDecorations, Uuid as Uuid$1, RowAction, RecordDocument, StoreFilter, AggregateFilter, ReadRow, RelationDisplay, WriteConflict, RecordsErrorCode, RecordFilter, RuleExpression, RecordsResult, SavedViewRow, DeclarableFieldKind, ParityFieldType, NewFieldDeclaration, HiddenFieldNotice, ValueEnvelope, ChecklistRequirementKind, ContextPolicy, WorkDueState, FieldSensitivity, StageRuleOnFail, SubscriptionCadence, WorkApprovalState, WorkInboxKind, FieldKind, ArchiveLane, ArchivedRow, WorkInboxView, WorkInboxItem, FormSummary, PortalCard, PortalPrincipal, PortalPreviewRow, MySubscription, DashboardBlockKind, AggregateBucket, AggregateMeasure, AggregateCompare, DashboardTarget, DashboardBlock, DashboardSummary, DocTemplateRow, DocRenderRow, QuietHours, DashboardBlockResult, ChecklistRunStep, BookingSummary, CaptureSheetFace, CaptureField, AnonTokenBinding, RecordsConfig, RecordsActor, RecordsDataSource, HistoryActor, FieldHistoryEntry } from '@ai-matrx/records';
 import { Uuid, Field as Field$1, ReadRow as ReadRow$1, StoreFilter as StoreFilter$1 } from '@ai-matrx/records/react';
 import { TableStyle, GroupAggregateSpec, GroupOrder, ChoiceColorLookup } from '@ai-matrx/design-system/data-table';
 import { FieldFormatConfig } from '@ai-matrx/design-system/field-formats';
@@ -413,6 +413,49 @@ declare function styleFromDecorations(decorations: TableDecorations | null | und
  */
 declare function resolveTableStyle(decorations: TableDecorations | null | undefined, fields: readonly Field[], viewStyle: TableStyle | undefined): TableStyle;
 
+/** One record as the grid shows it: its id, its name (the row label) and its masked document. */
+interface GridContextRecord {
+    id: Uuid$1;
+    title: string;
+    document: RecordDocument;
+}
+interface GridContextSnapshot {
+    tableId: Uuid$1;
+    tableName: string;
+    /** The table's own description (`metadata.description`), when it has one. */
+    tableDescription: string | null;
+    /** The Field key that names each record (`title_field`), or null. */
+    titleField: string | null;
+    /** The columns in the order the grid draws them (hidden columns left out). */
+    fields: Field[];
+    /** The table's row actions as the store lists them (update and agent). */
+    rowActions: RowAction[];
+    /** May this person change records here at all. */
+    canWrite: boolean;
+    /** The cell the cursor is on: its record, its Field key and the value drawn in it. */
+    currentCell: {
+        rowId: Uuid$1;
+        key: string;
+        value: unknown;
+    } | null;
+    /** The record the cursor is on (or whose editor is open). */
+    currentRow: GridContextRecord | null;
+    /** A block of more than one cell: Excel/Sheets TSV with a header line of Field keys. */
+    selectedRange: {
+        tsv: string;
+        cellCount: number;
+        rowIds: Uuid$1[];
+        keys: string[];
+    } | null;
+    /** The rows ticked with the row boxes. */
+    selectedRows: GridContextRecord[];
+    /** The page of records on screen, in screen order. */
+    visibleRows: GridContextRecord[];
+    /** How many records match the search and filters, when the store said. */
+    total: number | null;
+    search: string;
+}
+
 /**
  * What a person may do to one table. The four words and the ladder are the
  * store's (`rights.ts`), not ours.
@@ -485,6 +528,7 @@ interface HostLayout {
 }
 /** The authored-text slots `renderText` is asked to draw. */
 type RenderTextSlot = "form-intro" | "form-help" | "form-thank-you";
+
 interface RecordsUiHost {
     /**
      * TEMPORARY (one-grid merge, steps 5-8). Which table grid draws: `classic` — the default Grid
@@ -496,6 +540,38 @@ interface RecordsUiHost {
     grid?: "classic" | "merged";
     /** Layouts the host draws beside the package's own. See `HostLayout`. */
     layouts?: HostLayout[];
+    /**
+     * OPTIONAL. CLEAN A PASTED PIECE OF HTML INTO PLAIN TEXT (merge tranche 6m, inventory A7).
+     *
+     * A cell pasted from a web page or an email carries its tags, entities and inline styles. The
+     * platform has ONE cleaner (the host's content-cleanup), so this is a port rather than a second
+     * one here. The merged grid offers "Clean HTML" in a text cell's right-click Cell section and in
+     * the whole-text editor; the cleaned text is written through the grid's own one-cell write (one
+     * undo step). Unbound, the item is ABSENT, never dead.
+     */
+    cleanText?: (text: string) => string;
+    /**
+     * OPTIONAL. WHERE THE PERSON IS IN THE GRID, told as it changes (merge tranche 6l, inventory H1).
+     *
+     * An agent in the host's side chat is asked about "this cell", "these rows", "the table". Only
+     * the grid knows the table, its columns, the cell the cursor is on, the selected block, the
+     * ticked rows, the rows on screen and the search. The merged grid calls this after any of them
+     * changes (identical snapshots are not repeated); the host builds its agent scope from it. The
+     * snapshot carries the store's own `Field` records and the masked documents exactly as drawn.
+     * Unbound, nothing is built.
+     */
+    onGridContext?: (snapshot: GridContextSnapshot) => void;
+    /**
+     * OPTIONAL. THE PLATFORM'S ONE ICON PICKER (merge tranche 6j, inventory G2). A row action's
+     * button may carry an icon from the canonical icon set; that set and its picker are the host's
+     * (this package carries no icon library). Unbound, the row-action editor draws no icon control
+     * and keeps whatever icon an action already carries.
+     */
+    iconPicker?: (props: {
+        value: string;
+        label: string;
+        onChange: (name: string) => void;
+    }) => ReactNode;
     /** Answer the rights question for one table. Synchronous: a screen renders now. */
     rights?: (table: Table) => TableRights;
     /** Where a record's own page lives, when the host has one. A peek is used when it does not. */