@gridengine/angular-datagrid-enterprise 0.9.0 → 0.11.0

package/fesm2022/gridengine-angular-datagrid-enterprise.mjs

@@ -1,6 +1,6 @@
 export * from '@gridengine/angular-datagrid';
 import * as i0 from '@angular/core';
-import { input, ChangeDetectionStrategy, Component, computed, effect, makeEnvironmentProviders, provideEnvironmentInitializer, output, inject, ElementRef, HostListener, Directive } from '@angular/core';
+import { input, ChangeDetectionStrategy, Component, computed, effect, makeEnvironmentProviders, provideEnvironmentInitializer, signal, output, inject, ElementRef, HostListener, Directive } from '@angular/core';
 import { validateLicense, resolveFeatures as resolveFeatures$1, TIER_FEATURES } from '@gridengine/license-core';
 export { TIER_FEATURES } from '@gridengine/license-core';
 import { DOCUMENT } from '@angular/common';
@@ -1380,6 +1380,92 @@ class TransactionEngine {
     }
 }
 
+/**
+ * TransactionController — a reactive (signals) wrapper around `TransactionEngine`
+ * for the open-source `<gd-data-grid>`. Bind `displayRows()` to `[rowData]` and
+ * pipe `(cellValueChanged)` into `onCellValueChanged` to stage inline edits
+ * without mutating the base data; then `commit()` / `rollback()`:
+ *
+ * ```html
+ * <gd-data-grid [rowData]="txn.displayRows()" [columnDefs]="cols" [getRowId]="byId"
+ *   (cellValueChanged)="txn.onCellValueChanged($event)" />
+ * <button [disabled]="!txn.isDirty()" (click)="txn.commit()">Save</button>
+ * ```
+ *
+ * `displayRows()` returns shallow clones, so the grid's in-place cell edits
+ * change the copy while the base stays clean (rollback restores it). Use a
+ * field-based `getRowId` so row identity survives cloning.
+ */
+class TransactionController {
+    _engine;
+    _rowIdField;
+    _version = signal(0, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "_version" }] : /* istanbul ignore next */ []));
+    /** The current merged rows (base + staged changes) as shallow clones. */
+    displayRows;
+    /** Whether there are uncommitted staged changes. */
+    isDirty;
+    constructor(initialRows, options = {}) {
+        this._rowIdField = options.rowIdField ?? 'id';
+        this._engine = new TransactionEngine({
+            initialRows,
+            rowIdField: this._rowIdField,
+            onTransactionCommit: options.onCommit,
+            onTransactionRollback: options.onRollback,
+        });
+        this.displayRows = computed(() => {
+            this._version();
+            return this._engine.getDisplayRows().map((r) => ({ ...r }));
+        }, /* @ts-ignore */
+        ...(ngDevMode ? [{ debugName: "displayRows" }] : /* istanbul ignore next */ []));
+        this.isDirty = computed(() => {
+            this._version();
+            return this._engine.isDirty();
+        }, /* @ts-ignore */
+        ...(ngDevMode ? [{ debugName: "isDirty" }] : /* istanbul ignore next */ []));
+    }
+    /** Stage an inline edit emitted by the grid's `(cellValueChanged)`. */
+    onCellValueChanged(event) {
+        if (!event.field)
+            return;
+        const id = event.row[this._rowIdField];
+        this._engine.updateRows([{ [this._rowIdField]: id, [event.field]: event.newValue }]);
+        this._bump();
+    }
+    addRows(rows) {
+        this._engine.addRows(rows);
+        this._bump();
+    }
+    updateRows(rows) {
+        this._engine.updateRows(rows);
+        this._bump();
+    }
+    removeRows(ids) {
+        this._engine.removeRows(ids);
+        this._bump();
+    }
+    /** All current staged changes, grouped by kind. */
+    getDirtyRows() {
+        return this._engine.getDirtyRows();
+    }
+    commit() {
+        this._engine.commitTransaction();
+        this._bump();
+    }
+    rollback() {
+        this._engine.rollbackTransaction();
+        this._bump();
+    }
+    /** Replace the base rows (e.g. after a server refresh); staged changes are kept. */
+    resetRows(rows) {
+        this._engine.resetRows(rows);
+        this._bump();
+    }
+    _bump() {
+        this._version.update((v) => v + 1);
+    }
+}
+
 class MasterDetailEngine {
     _getDetailRowData;
     _onExpand;
@@ -2465,11 +2551,13 @@ function toPdfColumns(columnDefs) {
  * </div>
  * ```
  *
- * Drag across cells to select a block, then Ctrl/Cmd+C to copy it to the
- * clipboard as TSV (paste-ready into Excel / Sheets). It reads cell coordinates
- * from the grid's ARIA attributes (`role="gridcell"` + `aria-colindex`, and the
- * row's `aria-rowindex`), so it needs no changes to the base grid. Selection
- * state is driven by the Pro `RangeSelectionEngine`.
+ * Drag across cells to select a block, then Ctrl/Cmd+C to copy it as TSV
+ * (paste-ready into Excel / Sheets). Ctrl/Cmd+V emits `(rangePaste)` with the
+ * parsed matrix and Delete/Backspace emits `(rangeClear)` — the consumer writes
+ * those back into its own data (one-way binding, like the grid's other events).
+ * Cell coordinates come from the grid's ARIA attributes (`role="gridcell"` +
+ * `aria-colindex`, and the row's `aria-rowindex`), so no base-grid changes are
+ * needed. Selection state is driven by the Pro `RangeSelectionEngine`.
  */
 const STYLE_ID = 'gd-range-selection-styles';
 const SELECTED_CLASS = 'gd-range-selected';
@@ -2477,6 +2565,10 @@ const NON_DATA_ROW = ['gd-row--header', 'gd-row--filter', 'gd-row--group', 'gd-r
 class RangeSelectionDirective {
     /** Emits the copied cell matrix (rows × cols of displayed text) on Ctrl/Cmd+C. */
     rangeCopy = output();
+    /** Emits the parsed clipboard matrix on Ctrl/Cmd+V for the consumer to write back. */
+    rangePaste = output();
+    /** Emits the selected range on Delete/Backspace for the consumer to clear. */
+    rangeClear = output();
     _host = inject(ElementRef);
     _doc = inject(DOCUMENT);
     _engine = new RangeSelectionEngine({ onChange: () => this._paint() });
@@ -2506,9 +2598,18 @@ class RangeSelectionDirective {
             this._engine.extendSelection(pos.row, pos.col);
     }
     onKeyDown(event) {
-        if ((event.ctrlKey || event.metaKey) && (event.key === 'c' || event.key === 'C')) {
+        const mod = event.ctrlKey || event.metaKey;
+        if (mod && (event.key === 'c' || event.key === 'C')) {
+            if (this._engine.getSelection())
+                event.preventDefault();
             this._copy();
         }
+        else if (mod && (event.key === 'v' || event.key === 'V')) {
+            this._paste();
+        }
+        else if (event.key === 'Delete' || event.key === 'Backspace') {
+            this._clear(event);
+        }
     }
     /** The current selection engine (for advanced consumers / testing). */
     get engine() {
@@ -2560,6 +2661,28 @@ class RangeSelectionDirective {
         void navigator.clipboard?.writeText?.(tsv);
         this.rangeCopy.emit(matrix);
     }
+    _paste() {
+        const read = navigator.clipboard?.readText?.();
+        if (!read)
+            return;
+        void read.then((text) => {
+            if (!text)
+                return;
+            const selection = this._engine.getSelection();
+            this.rangePaste.emit({
+                startRow: selection?.startRowIndex ?? 0,
+                startCol: selection?.startColIndex ?? 0,
+                data: parseTSV(text),
+            });
+        });
+    }
+    _clear(event) {
+        const selection = this._engine.getSelection();
+        if (!selection)
+            return;
+        event.preventDefault();
+        this.rangeClear.emit(selection);
+    }
     _ensureStyles() {
         if (this._doc.getElementById(STYLE_ID))
             return;
@@ -2569,7 +2692,7 @@ class RangeSelectionDirective {
         this._doc.head.appendChild(style);
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.2", ngImport: i0, type: RangeSelectionDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
-    static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "22.1.2", type: RangeSelectionDirective, isStandalone: true, selector: "[gdRangeSelection]", outputs: { rangeCopy: "rangeCopy" }, host: { listeners: { "mousedown": "onMouseDown($event)", "mousemove": "onMouseMove($event)", "keydown": "onKeyDown($event)" } }, ngImport: i0 });
+    static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "22.1.2", type: RangeSelectionDirective, isStandalone: true, selector: "[gdRangeSelection]", outputs: { rangeCopy: "rangeCopy", rangePaste: "rangePaste", rangeClear: "rangeClear" }, host: { listeners: { "mousedown": "onMouseDown($event)", "mousemove": "onMouseMove($event)", "keydown": "onKeyDown($event)" } }, ngImport: i0 });
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.2", ngImport: i0, type: RangeSelectionDirective, decorators: [{
             type: Directive,
@@ -2577,7 +2700,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.2", ngImpor
                     selector: '[gdRangeSelection]',
                     standalone: true,
                 }]
-        }], ctorParameters: () => [], propDecorators: { rangeCopy: [{ type: i0.Output, args: ["rangeCopy"] }], onMouseDown: [{
+        }], ctorParameters: () => [], propDecorators: { rangeCopy: [{ type: i0.Output, args: ["rangeCopy"] }], rangePaste: [{ type: i0.Output, args: ["rangePaste"] }], rangeClear: [{ type: i0.Output, args: ["rangeClear"] }], onMouseDown: [{
                 type: HostListener,
                 args: ['mousedown', ['$event']]
             }], onMouseMove: [{
@@ -2600,5 +2723,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.2", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { AuditTrailEngine, CellPermissionEngine, ClipboardEngine, DEFAULT_MASK, DataGridPro, ExcelImportEngine, FillHandleEngine, FilterPresetEngine, FormEditorEngine, FormulaEngine, GridLicenseWatermark, LicenseManager, MasterDetailEngine, PDFExportEngine, PRODUCT_ID, PURCHASE_URL, RangeSelectionDirective, RangeSelectionEngine, RowLockEngine, SSRMEngine, SavedViewsEngine, TransactionEngine, UndoRedoManager, applyCellPermissions, deserializeFilter, evaluateFilter, parseCSV, parseTSV, provideGridEngineLicense, serializeFilter, toNumber, toPdfColumns, toTimestamp };
+export { AuditTrailEngine, CellPermissionEngine, ClipboardEngine, DEFAULT_MASK, DataGridPro, ExcelImportEngine, FillHandleEngine, FilterPresetEngine, FormEditorEngine, FormulaEngine, GridLicenseWatermark, LicenseManager, MasterDetailEngine, PDFExportEngine, PRODUCT_ID, PURCHASE_URL, RangeSelectionDirective, RangeSelectionEngine, RowLockEngine, SSRMEngine, SavedViewsEngine, TransactionController, TransactionEngine, UndoRedoManager, applyCellPermissions, deserializeFilter, evaluateFilter, parseCSV, parseTSV, provideGridEngineLicense, serializeFilter, toNumber, toPdfColumns, toTimestamp };
 //# sourceMappingURL=gridengine-angular-datagrid-enterprise.mjs.map