@lavalogic/scoria 0.37.1 → 0.37.3

package/dist/Components/Table/ColumnFactory.svelte.js

@@ -29,6 +29,7 @@ import { ExpandDef } from './Types/Columns/Definitions/Expand/ExpandDef.svelte.j
 import { FilterOnlyDef } from './Types/Columns/Definitions/FilterOnly/FilterOnlyDef.svelte.js';
 import { RowSelectionDef } from './Types/Columns/Definitions/RowSelection/RowSelectionDef.svelte.js';
 import { FilterValueType } from './Types/Filtering/FilterValueType.js';
+import { ToolbarPosition } from './Types/Toolbar/ToolbarPosition.js';
 import { scoriaStorageKey } from '../../Helpers/Helpers.svelte.js';
 // ─────────────────────────────────────────────────────────────────────────
 // Internal payload carried on every spec
@@ -215,6 +216,11 @@ export function createColumnFactory() {
                 ...commonProps(opts),
                 accessorFn: opts.value,
                 modal: opts.modal,
+                // Display columns have no implicit filter type (unlike the
+                // typed kinds where the factory pins one based on the
+                // column kind). Consumers opt in by passing the type they
+                // want the filter input rendered as.
+                filterValueType: opts.filterValueType,
             });
             return makeSpec('display', def);
         },
@@ -225,6 +231,7 @@ export function createColumnFactory() {
                 ...commonProps(opts),
                 accessorFn: opts.value,
                 getColour: opts.colour,
+                filterValueType: opts.filterValueType,
             });
             return makeSpec('bubble', def);
         },
@@ -250,6 +257,7 @@ export function createColumnFactory() {
                 ...commonProps(opts),
                 accessorFn: tupleAccessor,
                 getColour,
+                filterValueType: opts.filterValueType,
             });
             return makeSpec('progress', def);
         },
@@ -300,12 +308,13 @@ export function createColumnFactory() {
             const childRowIdFn = typeof opts.childRowId === 'function'
                 ? opts.childRowId
                 : (inner) => inner[opts.childRowId];
+            const userIsEnabled = opts.isEnabled;
             const def = new ExpandDef({
                 id: mintSyntheticId('expand'),
                 header: opts.header ?? '',
-                isEnabled: () => true,
+                isEnabled: userIsEnabled ?? (() => true),
                 accessorFn: opts.childRows,
-                headerIcon: 'chevron-down',
+                headerIcon: opts.headerIcon ?? 'chevron-down',
                 innerTableName: scoriaStorageKey(opts.name),
                 getInnerColumnDefs: () => {
                     const innerFactory = createColumnFactory();
@@ -315,7 +324,14 @@ export function createColumnFactory() {
                 },
                 innerTableOptions: {
                     selectionExtractor: childRowIdFn,
-                    getUserId: () => undefined,
+                    getUserId: opts.inner?.getUserId ?? (() => undefined),
+                    toolbar: translateInnerToolbar(opts.inner?.toolbar),
+                    displayFooter: opts.inner?.showFooter,
+                    allowAdvancedFiltering: opts.inner?.allowAdvancedFilter,
+                    allowQuickFiltering: opts.inner?.allowQuickFilter,
+                    allowColumnReordering: opts.inner?.allowReorder,
+                    enableResize: opts.inner?.allowResize,
+                    allowCopy: opts.inner?.allowCopy,
                 },
             });
             return makeSpec('expand', def);
@@ -337,3 +353,25 @@ export function createColumnFactory() {
     };
     return factory;
 }
+/**
+ * Translate the public string-literal `inner.toolbar` option on
+ * `ExpandColumnOptions` into the internal `ToolbarPosition` enum used by
+ * `TableInitOptions`. Mirrors the outer-table translator in
+ * `createTable.svelte.ts`; kept local to the factory so the public API
+ * stays free of the enum.
+ */
+function translateInnerToolbar(toolbar) {
+    if (!toolbar) {
+        return undefined;
+    }
+    switch (toolbar) {
+        case 'top':
+            return ToolbarPosition.Top;
+        case 'right':
+            return ToolbarPosition.Right;
+        case 'left':
+            return ToolbarPosition.Left;
+        case 'none':
+            return ToolbarPosition.None;
+    }
+}

package/dist/Components/Table/Types/Public/ColumnOptions.d.ts

@@ -4,6 +4,7 @@ import type { CustomFilter } from '../Filtering/CustomFilter.js';
 import type { FilterValueType } from '../Filtering/FilterValueType.js';
 import type { Primitive } from '../Context/TableInitOptions.js';
 import type { BubbleColour } from '../../../BubbleColour.js';
+import type { IconProps } from '../../../IconProps.js';
 import type { SelectOption } from '../../../../Types/Internal/SelectOption.js';
 import type { ValidationFn } from '../Columns/Definitions/ValidationFn.js';
 import type { ColourSet } from '../../../../scss/colours.js';
@@ -132,6 +133,21 @@ export interface DisplayColumnOptions<TRow extends object, TValue = unknown> ext
     /** Override the auto-generated id. Rare; only useful when the consumer
      *  needs a stable id for preset persistence or test selectors. */
     idHint?: string;
+    /**
+     * Filter-input shape for this column. Display columns have no
+     * implicit filter type (unlike `col.number` / `col.date` etc.
+     * which derive theirs from the column kind). Set this when the
+     * displayed `value` is a computed string but the underlying field
+     * the server filters on is a number / date / select - this keeps
+     * the typed filter UI (e.g. number ranges, date pickers) for
+     * foreign-key columns that show a human-readable name.
+     *
+     * When omitted, the filter row renders a generic string input.
+     *
+     * The filter targets the column id (use `idHint` to set a stable
+     * id matching the server field name).
+     */
+    filterValueType?: FilterValueType;
 }
 /** Options for `col.bubble({ header, value, colour, ... })`. Renders one or
  *  more coloured pill bubbles per row. */
@@ -143,6 +159,12 @@ export interface BubbleColumnOptions<TRow extends object, TValue = unknown> exte
      *  so multi-bubble cells can colour each independently. */
     colour: (row: TRow, index: number, value: TValue) => BubbleColour | Promise<BubbleColour>;
     idHint?: string;
+    /**
+     * Filter-input shape for this column. See `DisplayColumnOptions.filterValueType`
+     * - same semantics, applied to bubble cells. Common case: a tag-bubble column
+     * where the displayed values are strings but the server filter is a select.
+     */
+    filterValueType?: FilterValueType;
 }
 /** Options for `col.progress({ header, value, ... })`. Renders a horizontal
  *  progress bar from a numeric ratio. */
@@ -152,6 +174,12 @@ export interface ProgressColumnOptions<TRow extends object> extends BaseColumnOp
     /** Optional colour override. Defaults to scoria's progress colour ramp. */
     colour?: (row: TRow, index: number, fraction: number) => ColourSet | Promise<ColourSet>;
     idHint?: string;
+    /**
+     * Filter-input shape for this column. See `DisplayColumnOptions.filterValueType`
+     * - same semantics. Progress columns most commonly filter on a numeric
+     * "percent complete" field, in which case set this to `'Number'`.
+     */
+    filterValueType?: FilterValueType;
 }
 /** Options for `col.validity({ header, ... })`. Renders the row's overall
  *  validity indicator and (optionally) opens a modal with the validity
@@ -197,6 +225,43 @@ export interface RowAction<TRow extends object> {
      *  this specific action when both are set. Async supported. */
     isEnabled?: (row: TRow) => boolean | Promise<boolean>;
 }
+/**
+ * Layout / behaviour options for the inner Table mounted inside an expanded
+ * row. Each field maps 1:1 onto the matching `CreateTableOptions` field that
+ * configures an outer Table; supply only the ones that should differ from the
+ * scoria defaults.
+ *
+ * Common per-table overrides flowms (and most consumers) need:
+ * - `toolbar: 'none'` to hide the toolbar on inner detail tables
+ * - `showFooter: false` to hide pagination on inner tables backed by an
+ *   already-bounded child collection
+ * - `getUserId` so inner-table preset persistence keys are namespaced per user
+ */
+export interface ExpandInnerTableOptions {
+    /** Inner-table toolbar position. Defaults to scoria's outer-table default
+     *  (`'right'`). Pass `'none'` to hide the toolbar entirely. */
+    toolbar?: 'top' | 'right' | 'left' | 'none';
+    /** Whether the inner table's pagination footer renders. Defaults to true. */
+    showFooter?: boolean;
+    /** Whether the inner table's advanced filter panel renders. Defaults to
+     *  the outer Table's default (`true`). */
+    allowAdvancedFilter?: boolean;
+    /** Whether the inner table's quick-filter input row renders. Defaults to
+     *  the outer Table's default (`true`). */
+    allowQuickFilter?: boolean;
+    /** Whether the inner table allows column reordering. Defaults to scoria's
+     *  outer-table default (`true`). */
+    allowReorder?: boolean;
+    /** Whether the inner table allows column resizing. Defaults to scoria's
+     *  outer-table default (`true`). */
+    allowResize?: boolean;
+    /** Whether the inner table allows clipboard copy. Defaults to scoria's
+     *  outer-table default (`true`). */
+    allowCopy?: boolean;
+    /** Returns the current user id for the inner table's persistence
+     *  namespacing. Defaults to `() => undefined` (no per-user keying). */
+    getUserId?: () => string | undefined;
+}
 /** Options for `col.expand({ name, childRows, childRowId, childColumns })`.
  *  Each row exposes an expand affordance that mounts an inner Table over
  *  the inner row collection. */
@@ -216,6 +281,26 @@ export interface ExpandColumnOptions<TRow extends object, TInner extends object,
     /** Inner column declarations. Builder closure receives a typed
      *  `ColumnFactory<TInner>`. */
     childColumns: (col: ColumnFactory<TInner>) => ReadonlyArray<ColumnSpec<TInner>>;
+    /**
+     * Icon rendered on the per-row expand toggle button. Defaults to
+     * `'chevron-down'`. Useful when the parent context needs a richer
+     * visual cue (e.g. `'list'` for an order-lines drill-down).
+     */
+    headerIcon?: IconProps['name'];
+    /**
+     * Per-row predicate for whether the expand affordance is enabled.
+     * When the predicate resolves to `false`, the toggle is rendered
+     * disabled (or hidden) so users cannot expand rows that have no
+     * inner content. Async supported. Defaults to `() => true`.
+     */
+    isEnabled?: (row: TRow, index: number) => boolean | Promise<boolean>;
+    /**
+     * Inner-table configuration. Each field maps 1:1 onto the equivalent
+     * `CreateTableOptions` field that configures an outer Table; supply
+     * only the ones that should differ from scoria's outer-table defaults.
+     * See {@link ExpandInnerTableOptions}.
+     */
+    inner?: ExpandInnerTableOptions;
 }
 /** Options for `col.filterOnly({ id, header, ... })`. Renders in the filter
  *  panel only; does not produce a body cell. Useful for surfacing a

package/dist/Components/Table/Types/Public/index.d.ts

@@ -8,7 +8,7 @@
 export type { AnyEditEvent } from './AnyEditEvent.js';
 export type { BaseColumnOptions } from './BaseColumnOptions.js';
 export type { ColumnFactory } from './ColumnFactory.js';
-export type { ActionsColumnOptions, BubbleColumnOptions, CheckboxColumnOptions, DateColumnOptions, DisplayColumnOptions, DisplayModalProps, ExpandColumnOptions, FilterOnlyColumnOptions, NumberColumnOptions, ProgressColumnOptions, QueryColumnOptions, RowAction, RowSelectionColumnOptions, SelectColumnOptions, TextColumnOptions, ValidityColumnOptions, } from './ColumnOptions.js';
+export type { ActionsColumnOptions, BubbleColumnOptions, CheckboxColumnOptions, DateColumnOptions, DisplayColumnOptions, DisplayModalProps, ExpandColumnOptions, ExpandInnerTableOptions, FilterOnlyColumnOptions, NumberColumnOptions, ProgressColumnOptions, QueryColumnOptions, RowAction, RowSelectionColumnOptions, SelectColumnOptions, TextColumnOptions, ValidityColumnOptions, } from './ColumnOptions.js';
 export type { ColumnKind, ColumnSpec } from './ColumnSpec.js';
 export type { CreateTableOptions } from './CreateTableOptions.js';
 export type { BooleanKeyOf, DateKeyOf, LiteralRowIdKey, NumberKeyOf, StringKeyOf, } from './KeyConstraints.js';

package/dist/index.d.ts

@@ -104,7 +104,7 @@ export type { TabGroupButtonProps } from './Components/TabGroupButtonProps.js';
 export { default as Table, type TableProps } from './Components/Table/Table.svelte';
 export { createTable, customRows, localRows, remoteRows, } from './Components/Table/createTable.svelte.js';
 export type { ColumnSpecInternals } from './Components/Table/ColumnFactory.svelte.js';
-export type { ActionsColumnOptions, AnyEditEvent, BaseColumnOptions, BooleanKeyOf, BubbleColumnOptions, CheckboxColumnOptions, ClipboardApi, ColumnFactory as TableColumnFactory, ColumnKind, ColumnSpec, ColumnsApi, CreateTableOptions, CustomRowSource, DateColumnOptions, DateKeyOf, DisplayColumnOptions, DisplayModalProps, ExpandColumnOptions, FilterOnlyColumnOptions, FilteringApi, FocusApi, LiteralRowIdKey, LocalRowSource, ModalApi, NumberColumnOptions, NumberKeyOf, PaginationApi, PreferencesApi, ProgressColumnOptions, QueryColumnOptions, RemoteRowSource, RowAction, RowFetchRequest, RowFetchResponse, RowSelectionColumnOptions, RowSource, SavedPreset, SelectColumnOptions, SelectionApi, SelectionOptions, SortingApi, StringKeyOf, Table as TableInstance, TableInitialState, TablePersistence, TablePersistenceObject, TableStorageAdapter, TextColumnOptions, ValidityColumnOptions, } from './Components/Table/Types/Public/index.js';
+export type { ActionsColumnOptions, AnyEditEvent, BaseColumnOptions, BooleanKeyOf, BubbleColumnOptions, CheckboxColumnOptions, ClipboardApi, ColumnFactory as TableColumnFactory, ColumnKind, ColumnSpec, ColumnsApi, CreateTableOptions, CustomRowSource, DateColumnOptions, DateKeyOf, DisplayColumnOptions, DisplayModalProps, ExpandColumnOptions, ExpandInnerTableOptions, FilterOnlyColumnOptions, FilteringApi, FocusApi, LiteralRowIdKey, LocalRowSource, ModalApi, NumberColumnOptions, NumberKeyOf, PaginationApi, PreferencesApi, ProgressColumnOptions, QueryColumnOptions, RemoteRowSource, RowAction, RowFetchRequest, RowFetchResponse, RowSelectionColumnOptions, RowSource, SavedPreset, SelectColumnOptions, SelectionApi, SelectionOptions, SortingApi, StringKeyOf, Table as TableInstance, TableInitialState, TablePersistence, TablePersistenceObject, TableStorageAdapter, TextColumnOptions, ValidityColumnOptions, } from './Components/Table/Types/Public/index.js';
 export { type CellCoordinates } from './Components/Table/Types/Coordinates/CellCoordinates.js';
 export { type ColumnPinningState } from './Components/Table/Types/Columns/ColumnPinningState.js';
 export { type ColumnSizingState } from './Components/Table/Types/Columns/ColumnSizingState.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lavalogic/scoria",
   "description": "Svelte components used for the FloWMS Web Frontend",
-  "version": "0.37.1",
+  "version": "0.37.3",
   "publishConfig": {
     "access": "restricted"
   },