@toolbox-web/grid 1.23.2 → 1.23.3

package/lib/plugins/editing/internal/cell-validation.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Cell Validation Manager
+ *
+ * Manages invalid-cell state for the Editing Plugin.
+ * Extracted from EditingPlugin to reduce the main plugin file size.
+ *
+ * The manager owns the `Map<rowId, Map<field, message>>` state and exposes
+ * read/write methods. DOM synchronization is handled via an injected callback.
+ *
+ * @internal
+ */
+/** Callback to sync the data-invalid attribute on a cell element in the DOM. */
+export type SyncInvalidAttributeFn = (rowId: string, field: string, invalid: boolean) => void;
+/**
+ * Manages validation state for grid cells.
+ *
+ * Tracks which cells are marked invalid and their validation messages.
+ * The DOM side-effect (adding/removing `data-invalid` attribute) is delegated
+ * to the `syncAttribute` callback provided at construction time.
+ */
+export declare class CellValidationManager {
+    #private;
+    constructor(syncAttribute: SyncInvalidAttributeFn);
+    /**
+     * Mark a cell as invalid with an optional validation message.
+     *
+     * @param rowId - The row ID (from getRowId)
+     * @param field - The field name
+     * @param message - Optional validation message (for tooltips or display)
+     */
+    setInvalid(rowId: string, field: string, message?: string): void;
+    /**
+     * Clear the invalid state for a specific cell.
+     *
+     * @param rowId - The row ID (from getRowId)
+     * @param field - The field name
+     */
+    clearInvalid(rowId: string, field: string): void;
+    /**
+     * Clear all invalid cells for a specific row.
+     *
+     * @param rowId - The row ID (from getRowId)
+     */
+    clearRowInvalid(rowId: string): void;
+    /**
+     * Clear all invalid cell states across all rows.
+     */
+    clearAllInvalid(): void;
+    /**
+     * Check if a specific cell is marked as invalid.
+     *
+     * @param rowId - The row ID (from getRowId)
+     * @param field - The field name
+     * @returns True if the cell is marked as invalid
+     */
+    isCellInvalid(rowId: string, field: string): boolean;
+    /**
+     * Get the validation message for an invalid cell.
+     *
+     * @param rowId - The row ID (from getRowId)
+     * @param field - The field name
+     * @returns The validation message, or undefined if cell is valid
+     */
+    getInvalidMessage(rowId: string, field: string): string | undefined;
+    /**
+     * Check if a row has any invalid cells.
+     *
+     * @param rowId - The row ID (from getRowId)
+     * @returns True if the row has at least one invalid cell
+     */
+    hasInvalidCells(rowId: string): boolean;
+    /**
+     * Get all invalid fields for a row.
+     *
+     * @param rowId - The row ID (from getRowId)
+     * @returns Map of field names to validation messages
+     */
+    getInvalidFields(rowId: string): Map<string, string>;
+}
+//# sourceMappingURL=cell-validation.d.ts.map

package/lib/plugins/editing/internal/cell-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cell-validation.d.ts","sourceRoot":"","sources":["../../../../../../../libs/grid/src/lib/plugins/editing/internal/cell-validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,gFAAgF;AAChF,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAE9F;;;;;;GAMG;AACH,qBAAa,qBAAqB;;gBAOpB,aAAa,EAAE,sBAAsB;IAMjD;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,SAAK,GAAG,IAAI;IAU5D;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAWhD;;;;OAIG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IASpC;;OAEG;IACH,eAAe,IAAI,IAAI;IAYvB;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAIpD;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAInE;;;;;OAKG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAKvC;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;CAKrD"}

package/lib/plugins/editing/internal/dirty-tracking-manager.d.ts

@@ -0,0 +1,77 @@
+import { DirtyRowEntry } from './dirty-tracking';
+/**
+ * Callback that resolves a row object by its ID.
+ * Returns `undefined` when the row is not found.
+ */
+export type RowResolver<T> = (rowId: string) => T | undefined;
+export declare class DirtyTrackingManager<T> {
+    /** Baseline snapshots: rowId → deep-cloned original row data (first-write-wins) */
+    readonly baselines: Map<string, T>;
+    /** Whether new baselines were captured during the current processRows cycle */
+    private baselinesWereCaptured;
+    /** Row IDs inserted via `insertRow()` (no baseline available) */
+    readonly newRowIds: Set<string>;
+    /** Row IDs that have been modified (edit committed) */
+    readonly changedRowIds: Set<string>;
+    /** Row IDs whose edit session was committed (gates `tbw-row-dirty` CSS class) */
+    readonly committedDirtyRowIds: Set<string>;
+    /** Reset all dirty tracking state (called from detach / resetChangedRows). */
+    clear(): void;
+    /**
+     * Capture baselines for rows not already tracked (first-write-wins).
+     * Sets the `baselinesWereCaptured` flag when new rows are snapshotted.
+     */
+    capture(rows: readonly T[], getRowId: (r: T) => string | undefined): void;
+    /**
+     * Drain the baselines-captured flag (called from afterRender).
+     * Returns `null` when no new captures occurred, or the baseline count.
+     */
+    drainCapturedFlag(): number | null;
+    /** Check if a specific row differs from its baseline. */
+    isRowDirty(rowId: string, row: T): boolean;
+    /** Check if ANY row is dirty (requires row resolver for baseline iteration). */
+    hasAnyDirty(resolveRow: RowResolver<T>): boolean;
+    /** Check if a single cell differs from its baseline value. */
+    isCellDirty(rowId: string, row: T, field: string): boolean;
+    /**
+     * Get the dirty-state tuple needed by afterRowRender to toggle CSS classes.
+     *
+     * `isCommittedDirty` requires BOTH committed status AND actual data divergence
+     * from baseline (handles undo: after CTRL+Z, row is no longer visually dirty).
+     */
+    getRowDirtyState(rowId: string, row: T): {
+        isNew: boolean;
+        isCommittedDirty: boolean;
+        hasBaseline: boolean;
+    };
+    /** Re-snapshot baseline from current data and remove from all sets. */
+    markPristine(rowId: string, row: T): void;
+    /** Mark a row as newly inserted (no baseline). */
+    markNew(rowId: string): void;
+    /** Mark a row as dirty (external mutation). */
+    markDirty(rowId: string): void;
+    /** Re-snapshot all baselines and clear all tracking sets. */
+    markAllPristine(resolveRow: RowResolver<T>): void;
+    /** Get deep-cloned baseline (undefined for new/untracked rows). */
+    getOriginalRow(rowId: string): T | undefined;
+    /** Lightweight check whether a baseline exists (no cloning). */
+    hasBaseline(rowId: string): boolean;
+    /** Get all dirty rows with original + current data. Requires a row resolver. */
+    getDirtyRows(resolveRow: RowResolver<T>): DirtyRowEntry<T>[];
+    /** Get IDs of all dirty rows. Requires a row resolver. */
+    getDirtyRowIds(resolveRow: RowResolver<T>): string[];
+    /**
+     * Revert a row to its baseline values (mutates row in-place).
+     * Returns `true` when baseline existed and row was reverted.
+     */
+    revertRow(rowId: string, row: T): boolean;
+    /** Revert all rows to baseline values. Requires a row resolver. */
+    revertAll(resolveRow: RowResolver<T>): void;
+    /** Resolve changed row IDs to row objects. */
+    getChangedRows(resolveRow: RowResolver<T>): T[];
+    /** Get a copy of changed row IDs. */
+    getChangedRowIds(): string[];
+    /** Check if a row has been marked as changed. */
+    isRowChanged(rowId: string): boolean;
+}
+//# sourceMappingURL=dirty-tracking-manager.d.ts.map

package/lib/plugins/editing/internal/dirty-tracking-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dirty-tracking-manager.d.ts","sourceRoot":"","sources":["../../../../../../../libs/grid/src/lib/plugins/editing/internal/dirty-tracking-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAOL,KAAK,aAAa,EACnB,MAAM,kBAAkB,CAAC;AAI1B;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,GAAG,SAAS,CAAC;AAM9D,qBAAa,oBAAoB,CAAC,CAAC;IAGjC,mFAAmF;IACnF,QAAQ,CAAC,SAAS,iBAAwB;IAE1C,+EAA+E;IAC/E,OAAO,CAAC,qBAAqB,CAAS;IAEtC,iEAAiE;IACjE,QAAQ,CAAC,SAAS,cAAqB;IAEvC,uDAAuD;IACvD,QAAQ,CAAC,aAAa,cAAqB;IAE3C,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,cAAqB;IAIlD,8EAA8E;IAC9E,KAAK,IAAI,IAAI;IAUb;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,GAAG,SAAS,GAAG,IAAI;IAQzE;;;OAGG;IACH,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAQlC,yDAAyD;IACzD,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO;IAI1C,gFAAgF;IAChF,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO;IAWhD,8DAA8D;IAC9D,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAM1D;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,gBAAgB,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE;IAQ5G,uEAAuE;IACvE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI;IAOzC,kDAAkD;IAClD,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK5B,+CAA+C;IAC/C,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK9B,6DAA6D;IAC7D,eAAe,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI;IAYjD,mEAAmE;IACnE,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI5C,gEAAgE;IAChE,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAMnC,gFAAgF;IAChF,YAAY,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,EAAE;IAiB5D,0DAA0D;IAC1D,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE;IAYpD;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO;IASzC,mEAAmE;IACnE,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI;IAW3C,8CAA8C;IAC9C,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;IAS/C,qCAAqC;IACrC,gBAAgB,IAAI,MAAM,EAAE;IAI5B,iDAAiD;IACjD,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;CAGrC"}

package/lib/plugins/editing/internal/editor-injection.d.ts

@@ -0,0 +1,33 @@
+import { ColumnConfig, InternalGrid } from '../../../core/types';
+import { EditingConfig } from '../types';
+/**
+ * Dependencies injected by the EditingPlugin so the extraction
+ * can call back into plugin-owned state and methods.
+ */
+export interface EditorInjectionDeps<T> {
+    /** Internal grid reference (also usable as HTMLElement via cast). */
+    grid: InternalGrid<T>;
+    /** Whether the grid is in always-editing "grid" mode. */
+    isGridMode: boolean;
+    /** Plugin configuration. */
+    config: EditingConfig;
+    /** Set of cells currently in edit mode ("rowIndex:colIndex"). */
+    editingCells: Set<string>;
+    /** Value-change callbacks keyed by "rowIndex:field". */
+    editorValueCallbacks: Map<string, (newValue: unknown) => void>;
+    /** Returns `true` when an edit session is active (#activeEditRow !== -1). */
+    isEditSessionActive: () => boolean;
+    /** Commit a single cell value change. */
+    commitCellValue: (rowIndex: number, column: ColumnConfig<T>, newValue: unknown, rowData: T) => void;
+    /** Exit editing for a row (commit or revert). */
+    exitRowEdit: (rowIndex: number, revert: boolean) => void;
+}
+/**
+ * Inject an editor into a cell element.
+ *
+ * Handles the full editor lifecycle: creates the editor host, resolves
+ * the editor spec (template / custom-element / factory / component),
+ * wires commit/cancel callbacks, and registers value-change listeners.
+ */
+export declare function injectEditor<T>(deps: EditorInjectionDeps<T>, rowData: T, rowIndex: number, column: ColumnConfig<T>, colIndex: number, cell: HTMLElement, skipFocus: boolean): void;
+//# sourceMappingURL=editor-injection.d.ts.map

package/lib/plugins/editing/internal/editor-injection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor-injection.d.ts","sourceRoot":"","sources":["../../../../../../../libs/grid/src/lib/plugins/editing/internal/editor-injection.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAkB,YAAY,EAAsB,MAAM,qBAAqB,CAAC;AAE1G,OAAO,KAAK,EAAE,aAAa,EAAiB,MAAM,UAAU,CAAC;AAa7D;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC,qEAAqE;IACrE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACtB,yDAAyD;IACzD,UAAU,EAAE,OAAO,CAAC;IACpB,4BAA4B;IAC5B,MAAM,EAAE,aAAa,CAAC;IACtB,iEAAiE;IACjE,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,wDAAwD;IACxD,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC;IAC/D,6EAA6E;IAC7E,mBAAmB,EAAE,MAAM,OAAO,CAAC;IACnC,yCAAyC;IACzC,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC;IACpG,iDAAiD;IACjD,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CAC1D;AAMD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAC5B,OAAO,EAAE,CAAC,EACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,WAAW,EACjB,SAAS,EAAE,OAAO,GACjB,IAAI,CAiPN"}

package/lib/plugins/editing/internal/helpers.d.ts

@@ -0,0 +1,55 @@
+import { ColumnConfig, ColumnEditorSpec, ColumnInternal, InternalGrid, RowElementInternal } from '../../../core/types';
+import { EditingConfig } from '../types';
+/**
+ * CSS selector for focusable editor elements inside a cell.
+ * Duplicated from core/internal/rows to avoid cross-boundary imports
+ * that Vite externalises to `@toolbox-web/grid` during plugin bundling.
+ *
+ * @internal
+ */
+export declare const FOCUSABLE_EDITOR_SELECTOR = "input,select,textarea,[contenteditable=\"true\"],[contenteditable=\"\"],[tabindex]:not([tabindex=\"-1\"])";
+/**
+ * Resolves the editor for a column using the priority chain:
+ * 1. Column-level (`column.editor`)
+ * 2. Light DOM template (`__editorTemplate` → returns 'template')
+ * 3. Grid-level (`gridConfig.typeDefaults[column.type]`)
+ * 4. App-level (framework adapter's `getTypeDefault`)
+ * 5. Returns undefined (caller uses built-in defaultEditorFor)
+ */
+export declare function resolveEditor<TRow>(grid: InternalGrid<TRow>, col: ColumnInternal<TRow>): ColumnEditorSpec<TRow, unknown> | 'template' | undefined;
+/**
+ * Returns true if the given property key is safe to use on a plain object.
+ */
+export declare function isSafePropertyKey(key: unknown): key is string;
+/**
+ * Increment the editing cell count on a row element.
+ */
+export declare function incrementEditingCount(rowEl: RowElementInternal): void;
+/**
+ * Clear all editing state from a row element.
+ */
+export declare function clearEditingState(rowEl: RowElementInternal): void;
+/**
+ * No-op updateRow function for rows without IDs.
+ * Extracted to a named function to satisfy eslint no-empty-function.
+ */
+export declare function noopUpdateRow(_changes: unknown): void;
+/**
+ * Auto-wire commit/cancel lifecycle for input elements in string-returned editors.
+ */
+export declare function wireEditorInputs(editorHost: HTMLElement, column: ColumnConfig<unknown>, commit: (value: unknown) => void, originalValue?: unknown): void;
+/**
+ * Returns `true` when the configured `onBeforeEditClose` callback vetoes
+ * the close (i.e. returns `false`).  Use as a one-liner guard:
+ *
+ * ```ts
+ * if (shouldPreventEditClose(config, e)) return;
+ * ```
+ */
+export declare function shouldPreventEditClose(config: EditingConfig, event: MouseEvent | KeyboardEvent): boolean;
+/**
+ * Shallow-compare a snapshot against the current row to detect changes.
+ * Returns `true` if any own-property value differs between the two objects.
+ */
+export declare function hasRowChanged<T>(snapshot: T | undefined, current: T): boolean;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/plugins/editing/internal/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../../../../libs/grid/src/lib/plugins/editing/internal/helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAI9C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,8GACiE,CAAC;AAMxG;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAChC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,EACxB,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,GACxB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,UAAU,GAAG,SAAS,CA6B1D;AAMD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAI7D;AAMD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAIrE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAGjE;AAMD;;;GAGG;AAEH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAErD;AAMD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,WAAW,EACvB,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,EAC7B,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,IAAI,CAiBN;AAMD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,GAAG,aAAa,GAAG,OAAO,CAExG;AAMD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAS7E"}