@lavalogic/scoria 0.36.0 → 0.37.0

package/dist/Components/Table/NestedTable.svelte.d.ts

@@ -1,13 +1,5 @@
-import type { DefsWrapper } from './Types/Columns/DefsWrapper.js';
-import type { Primitive, TableInitOptions } from './Types/Context/TableInitOptions.js';
-export interface NestedTableProps<T extends object, IdType extends Primitive> {
-    tableName: string;
-    data: Array<T>;
-    columnDefWrapper: DefsWrapper<T>;
-    options: Pick<TableInitOptions<T, IdType>, 'selectionExtractor'> & Partial<TableInitOptions<T, IdType>>;
-    oncontextmenu?: (e: MouseEvent) => void;
-    getUserId: () => string | undefined;
-}
+import type { NestedTableProps } from './NestedTableProps.js';
+import type { Primitive } from './Types/Context/TableInitOptions.js';
 declare function $$render<T extends object, IdType extends Primitive>(): {
     props: NestedTableProps<T, IdType>;
     exports: {};

package/dist/Components/Table/NestedTableProps.d.ts

@@ -0,0 +1,25 @@
+import type { ScoriaStorageKey } from '../../Types/Internal/Misc.js';
+import type { DefsWrapper } from './Types/Columns/DefsWrapper.js';
+import type { Primitive, TableInitOptions } from './Types/Context/TableInitOptions.js';
+/**
+ * Props for `NestedTable.svelte`. Constructed inside the expand-row of
+ * an outer `Table` so the consumer can render a per-row inline data
+ * grid without manually wiring up a fresh `TableContext` /
+ * `LocalTableDataRepository`.
+ *
+ * - `tableName` is used to scope localStorage preset keys; nested tables
+ *   typically include the parent row's id so two expanded rows do not
+ *   share their column-visibility state.
+ * - `options` must supply a `selectionExtractor`; everything else has
+ *   read-only-display defaults defined in `DEFAULT_NESTED_TABLE_OPTIONS`.
+ * - `getUserId` is passed through to the inner repository for the
+ *   localStorage prefix.
+ */
+export interface NestedTableProps<T extends object, IdType extends Primitive> {
+    tableName: ScoriaStorageKey;
+    data: Array<T>;
+    columnDefWrapper: DefsWrapper<T>;
+    options: Pick<TableInitOptions<T, IdType>, 'selectionExtractor'> & Partial<TableInitOptions<T, IdType>>;
+    oncontextmenu?: (e: MouseEvent) => void;
+    getUserId: () => string | undefined;
+}

package/dist/Components/Table/NestedTableProps.js

@@ -0,0 +1 @@
+export {};

package/dist/Components/Table/SubApis.svelte.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Sub-API facade constructors. Each `makeXxxApi(tableContext)` returns a
+ * frozen object literal whose shape matches the corresponding interface in
+ * `Types/Public/TableSubApis.ts`. Reads delegate to the underlying Phase 6
+ * sub-context (`tableContext._selection`, `_filtering`, etc.); writes
+ * delegate to the matching setter or method.
+ *
+ * Phase 1 ships these as a thin facade over the existing internals. Phase 2
+ * will collapse the duplication once the legacy delegating accessors on
+ * `TableContext` are removed.
+ */
+import type { TableContext } from './Types/Context/TableContext.svelte.js';
+import type { Primitive } from './Types/Context/TableInitOptions.js';
+import type { ClipboardApi, ColumnsApi, FilteringApi, FocusApi, PaginationApi, PreferencesApi, SelectionApi, SortingApi } from './Types/Public/TableSubApis.js';
+import type { ColumnSpec } from './Types/Public/ColumnSpec.js';
+export declare function makeSelectionApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): SelectionApi<TRow, TRowId>;
+export declare function makeFilteringApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): FilteringApi<TRow>;
+export declare function makeSortingApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): SortingApi<TRow>;
+export declare function makePaginationApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): PaginationApi;
+export declare function makeColumnsApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>, specsById: ReadonlyMap<string, ColumnSpec<TRow>>): ColumnsApi<TRow>;
+export declare function makeFocusApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): FocusApi<TRow>;
+export declare function makePreferencesApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): PreferencesApi<TRow>;
+export declare function makeClipboardApi<TRow extends object, TRowId extends Primitive>(ctx: TableContext<TRow, TRowId>): ClipboardApi<TRow>;

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

@@ -0,0 +1,359 @@
+/**
+ * Sub-API facade constructors. Each `makeXxxApi(tableContext)` returns a
+ * frozen object literal whose shape matches the corresponding interface in
+ * `Types/Public/TableSubApis.ts`. Reads delegate to the underlying Phase 6
+ * sub-context (`tableContext._selection`, `_filtering`, etc.); writes
+ * delegate to the matching setter or method.
+ *
+ * Phase 1 ships these as a thin facade over the existing internals. Phase 2
+ * will collapse the duplication once the legacy delegating accessors on
+ * `TableContext` are removed.
+ */
+// ─────────────────────────────────────────────────────────────────────────
+// Selection
+// ─────────────────────────────────────────────────────────────────────────
+export function makeSelectionApi(ctx) {
+    return Object.freeze({
+        get map() {
+            return ctx._selection.selectedItems;
+        },
+        get size() {
+            return ctx._selection.selectedItems.size;
+        },
+        toggle(row) {
+            void ctx._selection.toggleSelected(row);
+        },
+        set(rowId, row) {
+            ctx._selection.selectedItems.set(rowId, row);
+        },
+        delete(rowId) {
+            ctx._selection.selectedItems.delete(rowId);
+        },
+        clear() {
+            ctx._selection.resetSelectedItems();
+        },
+        values() {
+            return ctx._selection.selectedItems.values();
+        },
+        keys() {
+            return ctx._selection.selectedItems.keys();
+        },
+        entries() {
+            return ctx._selection.selectedItems.entries();
+        },
+        selectAll() {
+            void ctx._selection.selectAllInCurrentPage();
+        },
+        get invalidMap() {
+            return ctx._selection.invalidValues;
+        },
+        get hasInvalid() {
+            return ctx._selection.invalidValues.size > 0;
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Filtering
+// ─────────────────────────────────────────────────────────────────────────
+export function makeFilteringApi(ctx) {
+    return Object.freeze({
+        get state() {
+            return ctx.dataRepo.filtering;
+        },
+        set(columnId, value) {
+            ctx.dataRepo.filterBy(columnId, value);
+        },
+        reset() {
+            ctx.dataRepo.resetFilters();
+        },
+        setMode(columnId, mode) {
+            ctx.dataRepo.setFilterMode(columnId, mode);
+        },
+        get showQuickFilter() {
+            return ctx._filtering.showQuickFiltering;
+        },
+        set showQuickFilter(v) {
+            ctx._filtering.showQuickFiltering = v;
+        },
+        get showSelectedOnly() {
+            return ctx._filtering.showSelectedOnly;
+        },
+        set showSelectedOnly(v) {
+            ctx._filtering.showSelectedOnly = v;
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Sorting
+// ─────────────────────────────────────────────────────────────────────────
+export function makeSortingApi(ctx) {
+    return Object.freeze({
+        get state() {
+            return ctx.dataRepo.sorting;
+        },
+        setSort(columnId, desc = false) {
+            ctx.dataRepo.updateSorting?.([{ id: columnId, desc }]);
+        },
+        clear() {
+            ctx.dataRepo.updateSorting?.([]);
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Pagination
+// ─────────────────────────────────────────────────────────────────────────
+export function makePaginationApi(ctx) {
+    return Object.freeze({
+        get page() {
+            return ctx.dataRepo.paginationState.pageIndex;
+        },
+        get pageSize() {
+            return ctx.dataRepo.paginationState.pageSize;
+        },
+        get totalPages() {
+            return ctx.dataRepo.lastPage ?? 0;
+        },
+        get totalRows() {
+            return ctx.dataRepo.totalRows;
+        },
+        next() {
+            ctx.dataRepo.nextPage();
+        },
+        prev() {
+            ctx.dataRepo.prevPage();
+        },
+        goTo(page) {
+            ctx.dataRepo.setPage(page);
+        },
+        setPageSize(size) {
+            ctx.dataRepo.setPageSize(size);
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Columns
+// ─────────────────────────────────────────────────────────────────────────
+export function makeColumnsApi(ctx, specsById) {
+    return Object.freeze({
+        get specs() {
+            return ctx._columnLayout.columnDefs
+                .map((def) => specsById.get(def.id))
+                .filter((spec) => spec !== undefined);
+        },
+        get byId() {
+            return specsById;
+        },
+        get visualOrder() {
+            return ctx._columnLayout.visualColumns.map((def) => def.id);
+        },
+        get visibility() {
+            return ctx._columnLayout.columnVisibility;
+        },
+        get pinning() {
+            return ctx._columnLayout.columnPinning;
+        },
+        get sizing() {
+            return ctx._columnLayout.columnSizing;
+        },
+        setVisibility(columnId, visible) {
+            const next = { ...ctx._columnLayout.columnVisibility, [columnId]: visible };
+            ctx._columnLayout.columnVisibility = next;
+        },
+        setPinning(columnId, side) {
+            // `ColumnPinningState` is `{ left?: ReadonlyMap<string, number>;
+            // right?: ReadonlyMap<string, number>; }`. Each map keys a column
+            // id to the width at which it is pinned. The columns sub-context
+            // fills in widths from the column-sizing state when we delegate;
+            // here we provide 0 as a placeholder for newly-pinned columns.
+            const current = ctx._columnLayout.columnPinning;
+            // Local, single-shot rebuild before reassigning the reactive container.
+            // eslint-disable-next-line svelte/prefer-svelte-reactivity
+            const left = new Map(current.left ?? []);
+            // eslint-disable-next-line svelte/prefer-svelte-reactivity
+            const right = new Map(current.right ?? []);
+            left.delete(columnId);
+            right.delete(columnId);
+            if (side === 'left') {
+                left.set(columnId, 0);
+            }
+            else if (side === 'right') {
+                right.set(columnId, 0);
+            }
+            ctx._columnLayout.columnPinning = { left, right };
+        },
+        resize(columnId, width) {
+            const next = { ...ctx._columnLayout.columnSizing, [columnId]: width };
+            ctx._columnLayout.columnSizing = next;
+        },
+        reorder(fromIndex, toIndex) {
+            const defs = [...ctx._columnLayout.columnDefs];
+            if (fromIndex < 0 || fromIndex >= defs.length) {
+                return;
+            }
+            const [moved] = defs.splice(fromIndex, 1);
+            defs.splice(toIndex, 0, moved);
+            ctx._columnLayout.columnDefs = defs;
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Focus
+// ─────────────────────────────────────────────────────────────────────────
+export function makeFocusApi(ctx) {
+    return Object.freeze({
+        get start() {
+            return ctx._focus.focusStart ?? undefined;
+        },
+        get end() {
+            return ctx._focus.focusEnd ?? undefined;
+        },
+        get isEditing() {
+            return ctx._focus.focusStartIsBeingEdited;
+        },
+        moveTo(row, column) {
+            // `CellCoordinates` carries `{ id, row, column }` so the focus
+            // target is addressable by both ordinal index and stable id. We
+            // look up the id from the column-layout's ordered defs.
+            const defs = ctx._columnLayout.columnDefs;
+            if (column < 0 || column >= defs.length) {
+                return;
+            }
+            const def = defs[column];
+            ctx._focus.moveFocus({ id: def.id, row, column: column });
+        },
+        clear() {
+            ctx._focus.unfocus();
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Preferences
+// ─────────────────────────────────────────────────────────────────────────
+export function makePreferencesApi(ctx) {
+    // Adapt the internal `ColumnDefSet<T>` shape to the public `SavedPreset`
+    // shape. The internal `ColumnDefSet` carries `name`, `sortingState`,
+    // `visibilityState`, `columnPinningState`, and `columnDefs`. It does NOT
+    // carry a `savedAt` timestamp or a per-column `columnSizing` map; the
+    // public `SavedPreset.savedAt` is a placeholder until Phase 2 extends
+    // the internal shape, and the per-column `width` falls back to the def's
+    // `minSize`.
+    const adapt = (set) => ({
+        name: set.name,
+        // Static epoch-zero placeholder until Phase 2 extends ColumnDefSet with a
+        // real timestamp; no reactivity needed for a literal placeholder.
+        // eslint-disable-next-line svelte/prefer-svelte-reactivity
+        savedAt: new Date(0).toISOString(),
+        columns: set.columnDefs.map((c) => ({
+            id: c.id,
+            visible: set.visibilityState[c.id] !== false,
+            width: c.minSize,
+            pinned: set.columnPinningState.left?.has(c.id)
+                ? 'left'
+                : set.columnPinningState.right?.has(c.id)
+                    ? 'right'
+                    : 'none',
+        })),
+    });
+    return Object.freeze({
+        get presets() {
+            return ctx._preferences.columnPresets.map(adapt);
+        },
+        get selectedPreset() {
+            const sel = ctx._preferences.selectedPreset;
+            return sel ? adapt(sel) : undefined;
+        },
+        savePreset(name) {
+            ctx._preferences.saveColumnPreset(name);
+        },
+        applyPreset(preset) {
+            const internal = ctx._preferences.columnPresets.find((p) => p.name === preset.name);
+            if (internal) {
+                ctx._preferences.setSelectedPreset(internal);
+            }
+        },
+        deletePreset(name) {
+            const next = ctx._preferences.columnPresets.filter((p) => p.name !== name);
+            ctx._preferences.setPresets(next);
+            ctx._preferences.persistPresets(next);
+        },
+        get settings() {
+            return Object.freeze({
+                isCompact: ctx.isCompact,
+                singleClickEditing: ctx.singleClickEditing,
+                alternateRowColours: ctx.alternateRowColours,
+                changeColourOnHover: ctx.changeColourOnHover,
+                copyWithHeaders: ctx.copyWithHeaders,
+                commaSeparatedCopy: ctx.commaSeparatedCopy,
+            });
+        },
+        get compact() {
+            return ctx.isCompact;
+        },
+        set compact(v) {
+            ctx.setIsCompact(v);
+        },
+        get alternateRowColours() {
+            return ctx.alternateRowColours;
+        },
+        set alternateRowColours(v) {
+            ctx.setAlternateRowColours(v);
+        },
+        get singleClickEditing() {
+            return ctx.singleClickEditing;
+        },
+        set singleClickEditing(v) {
+            ctx.setSingleClickEditing(v);
+        },
+        get changeColourOnHover() {
+            return ctx.changeColourOnHover;
+        },
+        set changeColourOnHover(v) {
+            ctx.setChangeColourOnHover(v);
+        },
+        get copyWithHeaders() {
+            return ctx.copyWithHeaders;
+        },
+        set copyWithHeaders(v) {
+            ctx.setCopyWithHeaders(v);
+        },
+        get commaSeparatedCopy() {
+            return ctx.commaSeparatedCopy;
+        },
+        set commaSeparatedCopy(v) {
+            ctx.setCommaSeparatedCopy(v);
+        },
+    });
+}
+// ─────────────────────────────────────────────────────────────────────────
+// Clipboard
+// ─────────────────────────────────────────────────────────────────────────
+export function makeClipboardApi(ctx) {
+    return Object.freeze({
+        async copySelection() {
+            await ctx.copyDataToClipboard();
+        },
+        async copyHighlighted() {
+            await ctx.copyHighlightedRowsToClipboard();
+        },
+        async copyCell(row, columnId) {
+            // Phase 1: minimal implementation. Phase 2 will route through the
+            // shared `escapeForSpreadsheet` helper to neutralise formula-
+            // injection prefixes consistently with the other copy paths.
+            const def = ctx._columnLayout.columnDefsById.get(columnId);
+            if (!def) {
+                return;
+            }
+            const value = def.accessorFn
+                ? await def.accessorFn(row, -1)
+                : row[columnId];
+            const text = value === null || value === undefined
+                ? ''
+                : typeof value === 'string'
+                    ? value
+                    : typeof value === 'number' || typeof value === 'boolean'
+                        ? value.toString()
+                        : JSON.stringify(value);
+            await navigator.clipboard.writeText(text);
+        },
+    });
+}