@happyvertical/smrt-ui 0.51.3 → 0.51.5

package/dist/components/data/__tests__/data-table-surface.test.js

@@ -0,0 +1,49 @@
+import { describe, expect, it } from 'vitest';
+import { DATA_TABLE_SURFACE_CONTROL_IDS, dataTableCommandFromDataSurfaceCommand, } from '../data-table-surface.js';
+const identity = { surfaceId: 'pin', kind: 'table' };
+function command(controlId, payload) {
+    return {
+        version: 1,
+        commandId: 'pin',
+        identity,
+        expectedRevision: 0,
+        controlId,
+        ...(payload === undefined ? {} : { payload }),
+    };
+}
+/**
+ * A minimal, valid payload for each canonical table controlId — proof that
+ * `DATA_TABLE_SURFACE_CONTROL_IDS` names exactly the ids
+ * `dataTableCommandFromDataSurfaceCommand` translates, not a superset or
+ * subset. Consumers (e.g. `@happyvertical/smrt-svelte`'s
+ * `mountListDataSurface`) rely on this enumeration to distinguish "a table
+ * command whose payload failed to translate" from "a genuinely unknown
+ * control" — drift here would silently break that distinction.
+ */
+const VALID_PAYLOADS = {
+    'set-search': { search: 'x' },
+    'set-filters': { filters: [] },
+    'set-sorting': { sorting: [] },
+    'toggle-sorting': { columnId: 'title' },
+    'set-page': { page: 1 },
+    'set-page-size': { pageSize: 25 },
+    'set-column-order': { columnIds: ['title'] },
+    'set-column-visibility': { columns: [] },
+    'set-selected-rows': { rowIds: [] },
+    'toggle-row-selection': { rowId: 'a' },
+    'set-expanded-rows': { rowIds: [] },
+    'toggle-row-expansion': { rowId: 'a' },
+    reset: undefined,
+};
+describe('DATA_TABLE_SURFACE_CONTROL_IDS', () => {
+    it('names exactly the ids dataTableCommandFromDataSurfaceCommand translates', () => {
+        for (const controlId of DATA_TABLE_SURFACE_CONTROL_IDS) {
+            expect(dataTableCommandFromDataSurfaceCommand(command(controlId, VALID_PAYLOADS[controlId])), `expected controlId "${controlId}" to translate with its documented valid payload`).not.toBeNull();
+        }
+    });
+    it('does not include a genuinely unknown/custom controlId', () => {
+        expect(DATA_TABLE_SURFACE_CONTROL_IDS).not.toContain('refresh');
+        expect(DATA_TABLE_SURFACE_CONTROL_IDS).not.toContain('focus');
+        expect(dataTableCommandFromDataSurfaceCommand(command('a-bespoke-control'))).toBeNull();
+    });
+});

package/dist/components/data/data-table-surface.d.ts

@@ -1,6 +1,24 @@
 /** Maps declared DataSurface controls onto the existing DataTable command model. */
 import type { DataTableCommand } from './DataTableController.js';
 import type { DataSurfaceVisibleCommand } from './data-surface.js';
+/**
+ * Every `controlId` {@link dataTableCommandFromDataSurfaceCommand} below
+ * understands as a table command (as opposed to a component-local control it
+ * returns `null` for). Declared once, here, as the sole source of truth: the
+ * `Record` below is a mapped type over this union, so the compiler — not a
+ * comment — rejects both a missing handler for a listed id and a handler
+ * keyed by an id not listed here. There is no second list and no `switch` to
+ * drift out of sync with it.
+ */
+export type DataTableSurfaceControlId = 'set-search' | 'set-filters' | 'set-sorting' | 'toggle-sorting' | 'set-page' | 'set-page-size' | 'set-column-order' | 'set-column-visibility' | 'set-selected-rows' | 'toggle-row-selection' | 'set-expanded-rows' | 'toggle-row-expansion' | 'reset';
+/**
+ * Mechanically derived from {@link dataTableSurfaceControlHandlers} — never
+ * hand-copy this list. A consumer that must distinguish "this controlId
+ * names a table command whose payload failed to translate" from "this is a
+ * genuinely unknown/custom control" (for example to deny the former outright
+ * rather than forwarding it to a generic escape hatch) imports this.
+ */
+export declare const DATA_TABLE_SURFACE_CONTROL_IDS: DataTableSurfaceControlId[];
 /**
  * Returns `null` for a component-local control (focus, reveal, refresh, …) or
  * an invalid table command. The mounted component owns those local controls.

package/dist/components/data/data-table-surface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-table-surface.d.ts","sourceRoot":"","sources":["../../../src/components/data/data-table-surface.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAEpF,OAAO,KAAK,EAEV,gBAAgB,EAKjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAEV,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAqJ3B;;;GAGG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,yBAAyB,GACjC,gBAAgB,GAAG,IAAI,CA8EzB"}
+{"version":3,"file":"data-table-surface.d.ts","sourceRoot":"","sources":["../../../src/components/data/data-table-surface.ts"],"names":[],"mappings":"AAAA,oFAAoF;AAEpF,OAAO,KAAK,EAEV,gBAAgB,EAKjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAEV,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAqJ3B;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,GACjC,YAAY,GACZ,aAAa,GACb,aAAa,GACb,gBAAgB,GAChB,UAAU,GACV,eAAe,GACf,kBAAkB,GAClB,uBAAuB,GACvB,mBAAmB,GACnB,sBAAsB,GACtB,mBAAmB,GACnB,sBAAsB,GACtB,OAAO,CAAC;AAmFZ;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,EAEtC,yBAAyB,EAAE,CAAC;AAQjC;;;GAGG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,yBAAyB,GACjC,gBAAgB,GAAG,IAAI,CAIzB"}

package/dist/components/data/data-table-surface.js

@@ -106,90 +106,101 @@ function dataTableRowIds(value) {
         ? values
         : undefined;
 }
+const dataTableSurfaceControlHandlers = {
+    'set-search': (payload) => {
+        const search = stringValue(payload?.search);
+        return search === undefined ? null : { type: 'setSearch', search };
+    },
+    'set-filters': (payload) => {
+        const filters = dataTableFilters(payload?.filters);
+        return filters === undefined ? null : { type: 'setFilters', filters };
+    },
+    'set-sorting': (payload) => {
+        const sorting = dataTableSorting(payload?.sorting);
+        return sorting === undefined ? null : { type: 'setSorting', sorting };
+    },
+    'toggle-sorting': (payload) => {
+        const columnId = stringValue(payload?.columnId);
+        if (!columnId)
+            return null;
+        const multi = booleanValue(payload?.multi);
+        return {
+            type: 'toggleSorting',
+            columnId,
+            ...(multi === undefined ? {} : { multi }),
+        };
+    },
+    'set-page': (payload) => {
+        const page = numberValue(payload?.page);
+        return page === undefined ? null : { type: 'setPage', page };
+    },
+    'set-page-size': (payload) => {
+        const pageSize = payload?.pageSize;
+        if (pageSize === null)
+            return { type: 'setPageSize', pageSize: null };
+        const numericPageSize = numberValue(pageSize);
+        return numericPageSize === undefined
+            ? null
+            : { type: 'setPageSize', pageSize: numericPageSize };
+    },
+    'set-column-order': (payload) => {
+        const columnIds = arrayValue(payload?.columnIds);
+        if (!columnIds?.every((value) => typeof value === 'string'))
+            return null;
+        const ids = [];
+        for (const value of columnIds) {
+            if (typeof value !== 'string' || value.length === 0)
+                return null;
+            ids.push(value);
+        }
+        return { type: 'setColumnOrder', columnIds: ids };
+    },
+    'set-column-visibility': (payload) => {
+        const columns = dataTableVisibilities(payload?.columns);
+        return columns === undefined
+            ? null
+            : { type: 'setColumnVisibility', columns };
+    },
+    'set-selected-rows': (payload) => {
+        const rowIds = dataTableRowIds(payload?.rowIds);
+        return rowIds === undefined ? null : { type: 'setSelectedRows', rowIds };
+    },
+    'toggle-row-selection': (payload) => {
+        const rowId = payload?.rowId;
+        return typeof rowId === 'string' || typeof rowId === 'number'
+            ? { type: 'toggleRowSelection', rowId }
+            : null;
+    },
+    'set-expanded-rows': (payload) => {
+        const rowIds = dataTableRowIds(payload?.rowIds);
+        return rowIds === undefined ? null : { type: 'setExpandedRows', rowIds };
+    },
+    'toggle-row-expansion': (payload) => {
+        const rowId = payload?.rowId;
+        return typeof rowId === 'string' || typeof rowId === 'number'
+            ? { type: 'toggleRowExpansion', rowId }
+            : null;
+    },
+    reset: () => ({ type: 'reset' }),
+};
+/**
+ * Mechanically derived from {@link dataTableSurfaceControlHandlers} — never
+ * hand-copy this list. A consumer that must distinguish "this controlId
+ * names a table command whose payload failed to translate" from "this is a
+ * genuinely unknown/custom control" (for example to deny the former outright
+ * rather than forwarding it to a generic escape hatch) imports this.
+ */
+export const DATA_TABLE_SURFACE_CONTROL_IDS = Object.keys(dataTableSurfaceControlHandlers);
+function isDataTableSurfaceControlId(value) {
+    return Object.hasOwn(dataTableSurfaceControlHandlers, value);
+}
 /**
  * Returns `null` for a component-local control (focus, reveal, refresh, …) or
  * an invalid table command. The mounted component owns those local controls.
  */
 export function dataTableCommandFromDataSurfaceCommand(command) {
+    if (!isDataTableSurfaceControlId(command.controlId))
+        return null;
     const payload = payloadObject(command.payload);
-    switch (command.controlId) {
-        case 'set-search': {
-            const search = stringValue(payload?.search);
-            return search === undefined ? null : { type: 'setSearch', search };
-        }
-        case 'set-filters': {
-            const filters = dataTableFilters(payload?.filters);
-            return filters === undefined ? null : { type: 'setFilters', filters };
-        }
-        case 'set-sorting': {
-            const sorting = dataTableSorting(payload?.sorting);
-            return sorting === undefined ? null : { type: 'setSorting', sorting };
-        }
-        case 'toggle-sorting': {
-            const columnId = stringValue(payload?.columnId);
-            if (!columnId)
-                return null;
-            const multi = booleanValue(payload?.multi);
-            return {
-                type: 'toggleSorting',
-                columnId,
-                ...(multi === undefined ? {} : { multi }),
-            };
-        }
-        case 'set-page': {
-            const page = numberValue(payload?.page);
-            return page === undefined ? null : { type: 'setPage', page };
-        }
-        case 'set-page-size': {
-            const pageSize = payload?.pageSize;
-            if (pageSize === null)
-                return { type: 'setPageSize', pageSize: null };
-            const numericPageSize = numberValue(pageSize);
-            return numericPageSize === undefined
-                ? null
-                : { type: 'setPageSize', pageSize: numericPageSize };
-        }
-        case 'set-column-order': {
-            const columnIds = arrayValue(payload?.columnIds);
-            if (!columnIds?.every((value) => typeof value === 'string'))
-                return null;
-            const ids = [];
-            for (const value of columnIds) {
-                if (typeof value !== 'string' || value.length === 0)
-                    return null;
-                ids.push(value);
-            }
-            return { type: 'setColumnOrder', columnIds: ids };
-        }
-        case 'set-column-visibility': {
-            const columns = dataTableVisibilities(payload?.columns);
-            return columns === undefined
-                ? null
-                : { type: 'setColumnVisibility', columns };
-        }
-        case 'set-selected-rows': {
-            const rowIds = dataTableRowIds(payload?.rowIds);
-            return rowIds === undefined ? null : { type: 'setSelectedRows', rowIds };
-        }
-        case 'toggle-row-selection': {
-            const rowId = payload?.rowId;
-            return typeof rowId === 'string' || typeof rowId === 'number'
-                ? { type: 'toggleRowSelection', rowId }
-                : null;
-        }
-        case 'set-expanded-rows': {
-            const rowIds = dataTableRowIds(payload?.rowIds);
-            return rowIds === undefined ? null : { type: 'setExpandedRows', rowIds };
-        }
-        case 'toggle-row-expansion': {
-            const rowId = payload?.rowId;
-            return typeof rowId === 'string' || typeof rowId === 'number'
-                ? { type: 'toggleRowExpansion', rowId }
-                : null;
-        }
-        case 'reset':
-            return { type: 'reset' };
-        default:
-            return null;
-    }
+    return dataTableSurfaceControlHandlers[command.controlId](payload);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@happyvertical/smrt-ui",
-  "version": "0.51.3",
+  "version": "0.51.5",
   "smrtJsdoc": "strict",
   "description": "Domain-agnostic Svelte 5 UI runtime for SMRT: primitives, i18n client, theme system, and module UI registry",
   "type": "module",
@@ -129,7 +129,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@happyvertical/smrt-types": "0.51.3",
+    "@happyvertical/smrt-types": "0.51.5",
     "esm-env": "^1.2.2"
   },
   "peerDependencies": {