@ai-matrx/records-ui 0.86.0 → 0.88.0

package/dist/index.d.cts

@@ -2,7 +2,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 { Uuid, StoreFilter as StoreFilter$1, Field as Field$1, ReadRow as ReadRow$1 } from '@ai-matrx/records/react';
+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';
 import { RecordsClient } from '@ai-matrx/records/core';
@@ -289,6 +289,12 @@ type GridPresentation = {
      * on, rather than a second "fields shown" list nobody kept in sync.
      */
     hiddenFields?: string[];
+    /**
+     * THE ORDER A PERSON DRAGGED THE COLUMNS INTO, by Field key (merge tranche 6a). Sparse like
+     * `widths`: a key it does not name keeps its Field's own place after the named ones, and a key
+     * whose Field is gone is skipped — a column order can never hide or invent a column.
+     */
+    columnOrder?: string[];
     /**
      * The gallery's card size, remembered the same way the grid remembers its
      * row height — a per-view look, not a global default.
@@ -480,6 +486,14 @@ 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
+     * as it shipped in 0.86; `merged` — the same grid with the older /data grid's control layer on
+     * it (the column header menu, the right-click Cell / Row / Column / Table sections, column
+     * settings, column order and hidden columns kept on the view). Left out: `classic`. Removed at
+     * merge step 9, when `merged` is the only grid.
+     */
+    grid?: "classic" | "merged";
     /** Layouts the host draws beside the package's own. See `HostLayout`. */
     layouts?: HostLayout[];
     /** Answer the rights question for one table. Synchronous: a screen renders now. */
@@ -1106,10 +1120,6 @@ interface CellRefusal {
     /** The value that was being written, so Retry can write it again. */
     attempted: unknown;
 }
-/**
- * FLD-9. A computed Field is not editable and never will be — the store works
- * it out. Saying so here, once, keeps every caller from re-deciding it.
- */
 declare function fieldIsEditable(field: Field): boolean;
 interface GridEditing {
     /** The value to DRAW for one cell — the optimistic one when there is one. */
@@ -1121,7 +1131,12 @@ interface GridEditing {
     type: (value: unknown) => void;
     stateOf: (rowId: Uuid$1, key: string) => CellState;
     refusalOf: (rowId: Uuid$1, key: string) => CellRefusal | null;
-    begin: (address: CellAddress) => void;
+    /**
+     * Open a cell's editor. `seed` is what the person TYPED to open it (type-to-edit: a letter, an
+     * IME composition, an Option/AltGr character): a column a person types into opens holding
+     * exactly that, replacing the value, as every spreadsheet does; a picker column opens as usual.
+     */
+    begin: (address: CellAddress, seed?: string | null) => void;
     cancel: () => void;
     /**
      * Commit the open cell — whatever is in `draft`. `move` opens the
@@ -1592,6 +1607,28 @@ declare function handOrderSortState(args: {
     saving?: boolean | undefined;
 }): SortStateControlProps;
 
+/**
+ * One Field becomes one column. The header is the Field's own NAME — never its
+ * key (`names.ts`) — and the cell is the value, rendered by its parity type and
+ * editable in place when an editing session is passed.
+ */
+declare function columnForField(field: Field$1, editing?: GridEditing | null, mayWriteRow?: (rowId: Uuid) => boolean, whyNotRow?: (rowId: Uuid) => string, look?: {
+    format?: FieldFormatConfig;
+    frozen?: boolean;
+}, 
+/** "Who changed this?" from the cell's own menu. Absent, no control is drawn. */
+onAskWhoChanged?: ((fieldKey: string, recordId: Uuid) => void) | undefined, 
+/**
+ * PRODUCTS row 10 — the provenance of a cell a MODEL owns. `cellFor` answers the page's
+ * already-fetched badge data for one row; `onPin` is bound only where this person may
+ * change the record, so a viewer reads every badge and is offered no control they do not
+ * have. Absent entirely, no badge is drawn and the column looks exactly as it did.
+ */
+enrich?: {
+    cellFor: (recordId: Uuid) => _ai_matrx_records.EnrichCell | undefined;
+    onPin?: ((recordId: Uuid, fieldKey: string, pinned: boolean) => void | Promise<void>) | undefined;
+}): MatrxColumnDef<ReadRow$1>;
+
 /**
  * WHAT A TABLE WITH NO COLUMNS SAYS. Named here because the gate asserts on it:
  * the state it describes is what a first-time person met for two days.
@@ -1702,27 +1739,6 @@ interface GridProps {
     className?: string | undefined;
 }
 declare function Grid({ tableId, pageSize, filter, onOpenRecord, onAddField, onNewRecordForm, toolbarActions, editable, presentation, onPresentationChange, viewOrder, footer, className, onAskWhoChanged, }: GridProps): react.JSX.Element;
-/**
- * One Field becomes one column. The header is the Field's own NAME — never its
- * key (`names.ts`) — and the cell is the value, rendered by its parity type and
- * editable in place when an editing session is passed.
- */
-declare function columnForField(field: Field$1, editing?: GridEditing | null, mayWriteRow?: (rowId: Uuid) => boolean, whyNotRow?: (rowId: Uuid) => string, look?: {
-    format?: FieldFormatConfig;
-    frozen?: boolean;
-}, 
-/** "Who changed this?" from the cell's own menu. Absent, no control is drawn. */
-onAskWhoChanged?: ((fieldKey: string, recordId: Uuid) => void) | undefined, 
-/**
- * PRODUCTS row 10 — the provenance of a cell a MODEL owns. `cellFor` answers the page's
- * already-fetched badge data for one row; `onPin` is bound only where this person may
- * change the record, so a viewer reads every badge and is offered no control they do not
- * have. Absent entirely, no badge is drawn and the column looks exactly as it did.
- */
-enrich?: {
-    cellFor: (recordId: Uuid) => _ai_matrx_records.EnrichCell | undefined;
-    onPin?: ((recordId: Uuid, fieldKey: string, pinned: boolean) => void | Promise<void>) | undefined;
-}): MatrxColumnDef<ReadRow$1>;
 
 /** Answers "what is the record with this id called", for one Field's values. */
 type LabelLookup = (field: Field$1, id: string) => string | null;
@@ -2536,6 +2552,8 @@ declare const LOOK_WORDS: {
     readonly saveToView: "Save to view";
     readonly saveAsNew: "Save as new view";
     readonly reset: "Reset to view";
+    /** The one button your look's doors fold into when the toolbar row has no room for three. */
+    readonly folded: "Your look";
     readonly newName: "Name for the new view";
 };
 

package/dist/index.d.ts

@@ -2,7 +2,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 { Uuid, StoreFilter as StoreFilter$1, Field as Field$1, ReadRow as ReadRow$1 } from '@ai-matrx/records/react';
+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';
 import { RecordsClient } from '@ai-matrx/records/core';
@@ -289,6 +289,12 @@ type GridPresentation = {
      * on, rather than a second "fields shown" list nobody kept in sync.
      */
     hiddenFields?: string[];
+    /**
+     * THE ORDER A PERSON DRAGGED THE COLUMNS INTO, by Field key (merge tranche 6a). Sparse like
+     * `widths`: a key it does not name keeps its Field's own place after the named ones, and a key
+     * whose Field is gone is skipped — a column order can never hide or invent a column.
+     */
+    columnOrder?: string[];
     /**
      * The gallery's card size, remembered the same way the grid remembers its
      * row height — a per-view look, not a global default.
@@ -480,6 +486,14 @@ 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
+     * as it shipped in 0.86; `merged` — the same grid with the older /data grid's control layer on
+     * it (the column header menu, the right-click Cell / Row / Column / Table sections, column
+     * settings, column order and hidden columns kept on the view). Left out: `classic`. Removed at
+     * merge step 9, when `merged` is the only grid.
+     */
+    grid?: "classic" | "merged";
     /** Layouts the host draws beside the package's own. See `HostLayout`. */
     layouts?: HostLayout[];
     /** Answer the rights question for one table. Synchronous: a screen renders now. */
@@ -1106,10 +1120,6 @@ interface CellRefusal {
     /** The value that was being written, so Retry can write it again. */
     attempted: unknown;
 }
-/**
- * FLD-9. A computed Field is not editable and never will be — the store works
- * it out. Saying so here, once, keeps every caller from re-deciding it.
- */
 declare function fieldIsEditable(field: Field): boolean;
 interface GridEditing {
     /** The value to DRAW for one cell — the optimistic one when there is one. */
@@ -1121,7 +1131,12 @@ interface GridEditing {
     type: (value: unknown) => void;
     stateOf: (rowId: Uuid$1, key: string) => CellState;
     refusalOf: (rowId: Uuid$1, key: string) => CellRefusal | null;
-    begin: (address: CellAddress) => void;
+    /**
+     * Open a cell's editor. `seed` is what the person TYPED to open it (type-to-edit: a letter, an
+     * IME composition, an Option/AltGr character): a column a person types into opens holding
+     * exactly that, replacing the value, as every spreadsheet does; a picker column opens as usual.
+     */
+    begin: (address: CellAddress, seed?: string | null) => void;
     cancel: () => void;
     /**
      * Commit the open cell — whatever is in `draft`. `move` opens the
@@ -1592,6 +1607,28 @@ declare function handOrderSortState(args: {
     saving?: boolean | undefined;
 }): SortStateControlProps;
 
+/**
+ * One Field becomes one column. The header is the Field's own NAME — never its
+ * key (`names.ts`) — and the cell is the value, rendered by its parity type and
+ * editable in place when an editing session is passed.
+ */
+declare function columnForField(field: Field$1, editing?: GridEditing | null, mayWriteRow?: (rowId: Uuid) => boolean, whyNotRow?: (rowId: Uuid) => string, look?: {
+    format?: FieldFormatConfig;
+    frozen?: boolean;
+}, 
+/** "Who changed this?" from the cell's own menu. Absent, no control is drawn. */
+onAskWhoChanged?: ((fieldKey: string, recordId: Uuid) => void) | undefined, 
+/**
+ * PRODUCTS row 10 — the provenance of a cell a MODEL owns. `cellFor` answers the page's
+ * already-fetched badge data for one row; `onPin` is bound only where this person may
+ * change the record, so a viewer reads every badge and is offered no control they do not
+ * have. Absent entirely, no badge is drawn and the column looks exactly as it did.
+ */
+enrich?: {
+    cellFor: (recordId: Uuid) => _ai_matrx_records.EnrichCell | undefined;
+    onPin?: ((recordId: Uuid, fieldKey: string, pinned: boolean) => void | Promise<void>) | undefined;
+}): MatrxColumnDef<ReadRow$1>;
+
 /**
  * WHAT A TABLE WITH NO COLUMNS SAYS. Named here because the gate asserts on it:
  * the state it describes is what a first-time person met for two days.
@@ -1702,27 +1739,6 @@ interface GridProps {
     className?: string | undefined;
 }
 declare function Grid({ tableId, pageSize, filter, onOpenRecord, onAddField, onNewRecordForm, toolbarActions, editable, presentation, onPresentationChange, viewOrder, footer, className, onAskWhoChanged, }: GridProps): react.JSX.Element;
-/**
- * One Field becomes one column. The header is the Field's own NAME — never its
- * key (`names.ts`) — and the cell is the value, rendered by its parity type and
- * editable in place when an editing session is passed.
- */
-declare function columnForField(field: Field$1, editing?: GridEditing | null, mayWriteRow?: (rowId: Uuid) => boolean, whyNotRow?: (rowId: Uuid) => string, look?: {
-    format?: FieldFormatConfig;
-    frozen?: boolean;
-}, 
-/** "Who changed this?" from the cell's own menu. Absent, no control is drawn. */
-onAskWhoChanged?: ((fieldKey: string, recordId: Uuid) => void) | undefined, 
-/**
- * PRODUCTS row 10 — the provenance of a cell a MODEL owns. `cellFor` answers the page's
- * already-fetched badge data for one row; `onPin` is bound only where this person may
- * change the record, so a viewer reads every badge and is offered no control they do not
- * have. Absent entirely, no badge is drawn and the column looks exactly as it did.
- */
-enrich?: {
-    cellFor: (recordId: Uuid) => _ai_matrx_records.EnrichCell | undefined;
-    onPin?: ((recordId: Uuid, fieldKey: string, pinned: boolean) => void | Promise<void>) | undefined;
-}): MatrxColumnDef<ReadRow$1>;
 
 /** Answers "what is the record with this id called", for one Field's values. */
 type LabelLookup = (field: Field$1, id: string) => string | null;
@@ -2536,6 +2552,8 @@ declare const LOOK_WORDS: {
     readonly saveToView: "Save to view";
     readonly saveAsNew: "Save as new view";
     readonly reset: "Reset to view";
+    /** The one button your look's doors fold into when the toolbar row has no room for three. */
+    readonly folded: "Your look";
     readonly newName: "Name for the new view";
 };