@gridengine/angular-datagrid-enterprise 0.10.0 → 0.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gridengine/angular-datagrid-enterprise",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Pro/Enterprise features for the GridEngine Angular data grid (license-gated).",
   "license": "SEE LICENSE IN LICENSE",
   "publishConfig": {

package/types/gridengine-angular-datagrid-enterprise.d.ts

@@ -1,7 +1,7 @@
 import { ColDef } from '@gridengine/angular-datagrid';
 export * from '@gridengine/angular-datagrid';
 import * as _angular_core from '@angular/core';
-import { EnvironmentProviders, OnDestroy } from '@angular/core';
+import { EnvironmentProviders, Signal, OnDestroy } from '@angular/core';
 import { LicenseValidationResult, LicenseTier } from '@gridengine/license-core';
 export { LicensePayload, LicenseStatus, LicenseTier, LicenseValidationResult, SupportLevel, TIER_FEATURES } from '@gridengine/license-core';
 
@@ -447,6 +447,62 @@ declare class TransactionEngine {
     private _buildDelta;
 }
 
+/**
+ * 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.
+ */
+
+interface TransactionControllerOptions {
+    /** Field used as the unique row ID. Default: 'id' */
+    rowIdField?: string;
+    onCommit?: (delta: TransactionDelta) => void;
+    onRollback?: () => void;
+}
+/** Minimal shape of the grid's cellValueChanged event this controller needs. */
+interface CellValueChange<TData> {
+    row: TData;
+    field?: string;
+    newValue: unknown;
+}
+declare class TransactionController<TData extends GridRow = GridRow> {
+    private readonly _engine;
+    private readonly _rowIdField;
+    private readonly _version;
+    /** The current merged rows (base + staged changes) as shallow clones. */
+    readonly displayRows: Signal<TData[]>;
+    /** Whether there are uncommitted staged changes. */
+    readonly isDirty: Signal<boolean>;
+    constructor(initialRows: TData[], options?: TransactionControllerOptions);
+    /** Stage an inline edit emitted by the grid's `(cellValueChanged)`. */
+    onCellValueChanged(event: CellValueChange<TData>): void;
+    addRows(rows: TData[]): void;
+    updateRows(rows: TData[]): void;
+    removeRows(ids: (string | number)[]): void;
+    /** All current staged changes, grouped by kind. */
+    getDirtyRows(): {
+        added: GridRow[];
+        updated: GridRow[];
+        removed: GridRow[];
+    };
+    commit(): void;
+    rollback(): void;
+    /** Replace the base rows (e.g. after a server refresh); staged changes are kept. */
+    resetRows(rows: TData[]): void;
+    private _bump;
+}
+
 /**
  * MasterDetailEngine — manages expand/collapse state and lazy-loaded, cached
  * detail data for master rows. Pure logic. Detail data is fetched once per row
@@ -1028,5 +1084,5 @@ declare class RangeSelectionDirective implements OnDestroy {
     static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RangeSelectionDirective, "[gdRangeSelection]", never, {}, { "rangeCopy": "rangeCopy"; "rangePaste": "rangePaste"; "rangeClear": "rangeClear"; }, never, never, true, never>;
 }
 
-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 type { AuditEntry, AuditTrailEngineOptions, Block, BlockState, CellEditCommand, CellPermission, CellPermissionEngineOptions, CellRange, ClipboardEngineOptions, DeleteCommand, DetailEntry, DetailLoadState, ExcelImportEngineOptions, FillCell, FillCommand, FillDirection, FillHandleEngineOptions, FillResult, FilterCondition, FilterGroup, FilterNode, FilterOperator, FilterPreset, FilterPresetEngineOptions, FormEditorEngineOptions, FormulaEngineOptions, GridRow, ImportColumn, ImportColumnType, ImportPreview, ImportValidationError, LockedRow, MasterDetailEngineOptions, PDFExportEngineOptions, PasteCommand, PdfColumn, PdfDocumentModel, PdfExportOptions, PdfPage, PdfPageFooter, PdfPageHeader, RangePasteEvent, RangeSelectionEngineOptions, RowLockEngineOptions, SSRMDataSource, SSRMEngineOptions, SSRMGetRowsParams, SSRMGetRowsResult, SavedView, SavedViewsEngineOptions, TransactionDelta, TransactionEngineOptions, UndoRedoCommand, UndoRedoManagerOptions };
+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 };
+export type { AuditEntry, AuditTrailEngineOptions, Block, BlockState, CellEditCommand, CellPermission, CellPermissionEngineOptions, CellRange, CellValueChange, ClipboardEngineOptions, DeleteCommand, DetailEntry, DetailLoadState, ExcelImportEngineOptions, FillCell, FillCommand, FillDirection, FillHandleEngineOptions, FillResult, FilterCondition, FilterGroup, FilterNode, FilterOperator, FilterPreset, FilterPresetEngineOptions, FormEditorEngineOptions, FormulaEngineOptions, GridRow, ImportColumn, ImportColumnType, ImportPreview, ImportValidationError, LockedRow, MasterDetailEngineOptions, PDFExportEngineOptions, PasteCommand, PdfColumn, PdfDocumentModel, PdfExportOptions, PdfPage, PdfPageFooter, PdfPageHeader, RangePasteEvent, RangeSelectionEngineOptions, RowLockEngineOptions, SSRMDataSource, SSRMEngineOptions, SSRMGetRowsParams, SSRMGetRowsResult, SavedView, SavedViewsEngineOptions, TransactionControllerOptions, TransactionDelta, TransactionEngineOptions, UndoRedoCommand, UndoRedoManagerOptions };