@vuu-ui/vuu-utils 2.1.4 → 2.1.6

package/types/data-editing/DataEditingProvider.d.ts

@@ -1,8 +1,8 @@
 import { ReactNode } from "react";
-import { EditTracker } from "./EditTracker";
-export declare const DataEditingProvider: ({ children, editTracker, }: {
+import { EditSession } from "./EditSession";
+export declare const DataEditingProvider: ({ children, editSession, }: {
     children: ReactNode;
-    editTracker: EditTracker;
+    editSession: EditSession;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare function useEditTracker(throwIfUnavailable?: false): EditTracker | undefined;
-export declare function useEditTracker(throwIfUnavailable: true): EditTracker;
+export declare function useEditSession(throwIfUnavailable?: false): EditSession | undefined;
+export declare function useEditSession(throwIfUnavailable: true): EditSession;

package/types/data-editing/EditButtons.d.ts

@@ -1,7 +1,7 @@
-import { EditTracker } from "./EditTracker";
+import { EditSession } from "./EditSession";
 export interface EditButtonProps {
-    editTracker?: EditTracker;
+    editSession?: EditSession;
     onCancel: () => void;
     onSave: () => void;
 }
-export declare const EditButtons: ({ editTracker, onCancel, onSave, }: EditButtonProps) => import("react/jsx-runtime").JSX.Element;
+export declare const EditButtons: ({ editSession, onCancel, onSave, }: EditButtonProps) => import("react/jsx-runtime").JSX.Element;

package/types/data-editing/EditSession.d.ts

@@ -0,0 +1,24 @@
+import { DataSource, EditSessionMode } from "@vuu-ui/vuu-data-types";
+import type { RpcResultError, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { EventEmitter } from "../event-emitter";
+export type EditState = "clean" | "dirty";
+type EditSessionEvents = {
+    editState: (editState: EditState) => void;
+};
+export declare class EditSession extends EventEmitter<EditSessionEvents> {
+    #private;
+    constructor(dataSource: DataSource);
+    get active(): boolean;
+    set active(isActive: boolean);
+    get editCount(): number;
+    set editCount(val: number);
+    clear(): void;
+    begin(editSessionMode?: EditSessionMode): Promise<DataSource | undefined>;
+    get dataSource(): DataSource | undefined;
+    end(saveChanges?: boolean): Promise<void>;
+    get inEditMode(): boolean;
+    get editState(): EditState;
+    edit(key: string, columnName: string, originalValue: VuuRowDataItemType, newValue: VuuRowDataItemType): void;
+    commit(key: string, columnName: string, typedValue: string | number | boolean): Promise<RpcResultError | undefined>;
+}
+export {};

package/types/data-editing/edit-utils.d.ts

@@ -0,0 +1,2 @@
+import { EditSessionMode, InlineEditSessionMode } from "@vuu-ui/vuu-data-types";
+export declare const isInlineEditingSession: (editSessionMode: EditSessionMode) => editSessionMode is InlineEditSessionMode;

package/types/data-editing/useEditableTable.d.ts

@@ -1,6 +1,6 @@
+import { DataSource, EditSessionMode } from "@vuu-ui/vuu-data-types";
 import { VuuTable } from "@vuu-ui/vuu-protocol-types";
-import { EditTracker } from "./EditTracker";
-import { DataSource } from "@vuu-ui/vuu-data-types";
+import { EditSession } from "./EditSession";
 export type EditMode = "edit" | "view";
 export interface EditableTableHookProps {
     /**
@@ -9,6 +9,7 @@ export interface EditableTableHookProps {
      */
     columns?: string[];
     dataSource?: DataSource;
+    editSessionMode?: EditSessionMode;
     isEditMode: boolean;
     onCancel: () => void;
     onSave: () => void;
@@ -16,11 +17,12 @@ export interface EditableTableHookProps {
      * If dataSource not provided, new DataSource
      * will be created using table and columns
      */
-    table: VuuTable;
+    table?: VuuTable;
 }
-export declare const useEditableTable: ({ columns, dataSource: dataSourceProp, isEditMode, onCancel, onSave, table, }: EditableTableHookProps) => {
+export declare const useEditableTable: ({ columns, dataSource: dataSourceProp, editSessionMode, isEditMode, onCancel, onSave, table, }: EditableTableHookProps) => {
     dataSource: DataSource;
-    editTracker: EditTracker;
+    editSession: EditSession;
     onCancel: () => void;
     onSave: () => Promise<void>;
+    sessionDataSource: DataSource | undefined;
 };

package/types/form-utils.d.ts

@@ -2,6 +2,11 @@ import { DataValueTypeSimple } from "@vuu-ui/vuu-data-types";
 import { VuuColumnDataType, VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
 import { KeyboardEvent, SyntheticEvent } from "react";
 import { ExtendedFilterOptions } from "@vuu-ui/vuu-filter-types";
+export declare class DataValidationError extends Error {
+    actualType: string;
+    expectedType: string;
+    constructor(message: string, expectedType: string, actualType: string);
+}
 /**
  * Use with the following convention:
  *

package/types/index.d.ts

@@ -12,9 +12,9 @@ export * from "./common-types";
 export * from "./component-registry";
 export * from "./cookie-utils";
 export * from "./css-utils";
+export { DataEditingProvider, useEditSession, } from "./data-editing/DataEditingProvider";
 export { EditButtons, type EditButtonProps } from "./data-editing/EditButtons";
-export { DataEditingProvider, useEditTracker, } from "./data-editing/DataEditingProvider";
-export { EditTracker, type EditState } from "./data-editing/EditTracker";
+export { EditSession, type EditState } from "./data-editing/EditSession";
 export { useEditableTable } from "./data-editing/useEditableTable";
 export * from "./data-utils";
 export * from "./datasource/BaseDataSource";
@@ -73,6 +73,7 @@ export { DataContext } from "./context-definitions/DataContext";
 export * from "./context-definitions/DataProvider";
 export { DataSourceProvider, useDataSource, } from "./context-definitions/DataSourceProvider";
 export * from "./context-definitions/WorkspaceContext";
+export { isInlineEditingSession } from "./data-editing/edit-utils";
 export { PageVisibilityObserver } from "./PageVisibilityObserver";
 export * from "./ShellContext";
 export { ThemeLoadChecker } from "./theme-utils";

package/cjs/packages/vuu-utils/src/data-editing/EditTracker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EditTracker.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditTracker.tsx"],"sourcesContent":["import { DataSource } from \"@vuu-ui/vuu-data-types\";\nimport type {\n  RpcResultError,\n  VuuRowDataItemType,\n  VuuTable,\n} from \"@vuu-ui/vuu-protocol-types\";\nimport { EventEmitter } from \"../event-emitter\";\nimport { isRpcSuccess } from \"../protocol-message-utils\";\n\nexport type EditState = \"clean\" | \"dirty\";\n\ntype CellEdit = {\n  originalValue: VuuRowDataItemType;\n  editedValue: VuuRowDataItemType;\n};\n\ntype RowEditDetails = {\n  /**\n   * Column name => cell edit details\n   */\n  cellEdits: Map<string, CellEdit>;\n};\n\ntype EditTrackerEvents = {\n  editState: (editState: EditState) => void;\n};\n\nexport class EditTracker extends EventEmitter<EditTrackerEvents> {\n  #active = false;\n  /**\n   *  Row key => row edits\n   */\n  #rowEdits = new Map<string, RowEditDetails>();\n  #editCount = 0;\n  #dataSource?: DataSource;\n  #inEditMode = false;\n\n  get active() {\n    return this.#active;\n  }\n  set active(isActive: boolean) {\n    this.#active = isActive;\n  }\n  get editCount() {\n    return this.#editCount;\n  }\n\n  set editCount(val: number) {\n    if (val !== this.#editCount) {\n      const oldCount = this.#editCount;\n      this.#editCount = val;\n      if (val === 0) {\n        this.emit(\"editState\", \"clean\");\n      } else if (oldCount === 0) {\n        this.emit(\"editState\", \"dirty\");\n      }\n    }\n  }\n\n  set dataSource(ds: DataSource) {\n    this.#dataSource = ds;\n  }\n\n  clear() {\n    this.#rowEdits.clear();\n    this.#editCount = 0;\n  }\n\n  async enterEditMode() {\n    this.#inEditMode = true;\n\n    const rpcResponse = await this.#dataSource?.rpcRequest?.({\n      type: \"RPC_REQUEST\",\n      rpcName: \"ENTER_EDIT_MODE\",\n      params: {},\n    });\n\n    if (isRpcSuccess(rpcResponse)) {\n      const { table: sessionTable } = rpcResponse.data as { table: VuuTable };\n      return sessionTable;\n    } else {\n      console.log(\"fail\");\n    }\n  }\n\n  get inEditMode() {\n    return this.#inEditMode;\n  }\n\n  get editState(): EditState {\n    return this.editCount === 0 ? \"clean\" : \"dirty\";\n  }\n\n  async cancelChanges() {\n    const rpcResponse = await this.#dataSource?.rpcRequest?.({\n      type: \"RPC_REQUEST\",\n      rpcName: \"EXIT_EDIT_MODE\",\n      params: {},\n    });\n    this.clear();\n    return rpcResponse;\n  }\n\n  async saveChanges() {\n    const rpcResponse = await this.#dataSource?.rpcRequest?.({\n      type: \"RPC_REQUEST\",\n      rpcName: \"EXIT_EDIT_MODE\",\n      params: { save: true },\n    });\n    this.clear();\n    return rpcResponse;\n  }\n\n  // TODO how do we deal with the '_edited' pattern\n  edit(\n    key: string,\n    columnName: string,\n    originalValue: VuuRowDataItemType,\n    newValue: VuuRowDataItemType,\n  ) {\n    const rowEditDetails = this.#rowEdits.get(key);\n    if (rowEditDetails) {\n      const { cellEdits } = rowEditDetails;\n      const cellEdit = cellEdits.get(columnName);\n      if (cellEdit) {\n        if (newValue === cellEdit.originalValue) {\n          if (cellEdits.size === 1) {\n            this.#rowEdits.delete(key);\n          } else {\n            // re-editing a cell had removed the edit\n            cellEdits.delete(columnName);\n          }\n          this.editCount = this.#editCount - 1;\n        } else {\n          cellEdit.editedValue = newValue;\n        }\n      } else {\n        // row has already been edited, but this column has not\n        cellEdits.set(columnName, {\n          originalValue,\n          editedValue: newValue,\n        });\n        this.editCount = this.#editCount + 1;\n      }\n    } else {\n      this.#rowEdits.set(key, {\n        cellEdits: new Map([\n          [columnName, { originalValue, editedValue: newValue }],\n        ]),\n      });\n      this.editCount = this.#editCount + 1;\n    }\n  }\n\n  //TODO alow a shortcut commit that allows a value, bypassing need\n  // for edit. Thids caters for boolean values, dropdown list etc\n  // that have no intermediate edit phase\n  async commit(key: string, columnName: string) {\n    const rowEditDetails = this.#rowEdits.get(key);\n    if (rowEditDetails) {\n      const { cellEdits } = rowEditDetails;\n      const cellEditValues = cellEdits.get(columnName);\n      if (cellEditValues) {\n        const { editedValue } = cellEditValues;\n        const rpcResponse = await this.#dataSource?.rpcRequest?.({\n          type: \"RPC_REQUEST\",\n          rpcName: \"editCell\",\n          params: {\n            column: columnName,\n            data: editedValue,\n            key,\n          },\n        });\n\n        return rpcResponse;\n      }\n    } else {\n      return {\n        errorMessage: \"CHANGE_REVERTED\",\n        type: \"ERROR_RESULT\",\n      } as RpcResultError;\n    }\n  }\n}\n"],"names":["EventEmitter","isRpcSuccess"],"mappings":";;;;;;;;;;;;AAAA,IAAA,OAAA,EAAA,SAAA,EAAA,UAAA,EAAA,WAAA,EAAA,WAAA;AA2BO,MAAM,oBAAoBA,yBAAgC,CAAA;AAAA,EAA1D,WAAA,GAAA;AAAA,IAAA,KAAA,CAAA,GAAA,SAAA,CAAA;AACL,IAAU,YAAA,CAAA,IAAA,EAAA,OAAA,EAAA,KAAA,CAAA;AAIV;AAAA;AAAA;AAAA,IAAA,YAAA,CAAA,IAAA,EAAA,SAAA,sBAAgB,GAA4B,EAAA,CAAA;AAC5C,IAAa,YAAA,CAAA,IAAA,EAAA,UAAA,EAAA,CAAA,CAAA;AACb,IAAA,YAAA,CAAA,IAAA,EAAA,WAAA,CAAA;AACA,IAAc,YAAA,CAAA,IAAA,EAAA,WAAA,EAAA,KAAA,CAAA;AAAA;AAAA,EAEd,IAAI,MAAS,GAAA;AACX,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,OAAA,CAAA;AAAA;AACd,EACA,IAAI,OAAO,QAAmB,EAAA;AAC5B,IAAA,YAAA,CAAA,IAAA,EAAK,OAAU,EAAA,QAAA,CAAA;AAAA;AACjB,EACA,IAAI,SAAY,GAAA;AACd,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,UAAA,CAAA;AAAA;AACd,EAEA,IAAI,UAAU,GAAa,EAAA;AACzB,IAAI,IAAA,GAAA,KAAQ,mBAAK,UAAY,CAAA,EAAA;AAC3B,MAAA,MAAM,WAAW,YAAK,CAAA,IAAA,EAAA,UAAA,CAAA;AACtB,MAAA,YAAA,CAAA,IAAA,EAAK,UAAa,EAAA,GAAA,CAAA;AAClB,MAAA,IAAI,QAAQ,CAAG,EAAA;AACb,QAAK,IAAA,CAAA,IAAA,CAAK,aAAa,OAAO,CAAA;AAAA,OAChC,MAAA,IAAW,aAAa,CAAG,EAAA;AACzB,QAAK,IAAA,CAAA,IAAA,CAAK,aAAa,OAAO,CAAA;AAAA;AAChC;AACF;AACF,EAEA,IAAI,WAAW,EAAgB,EAAA;AAC7B,IAAA,YAAA,CAAA,IAAA,EAAK,WAAc,EAAA,EAAA,CAAA;AAAA;AACrB,EAEA,KAAQ,GAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,WAAU,KAAM,EAAA;AACrB,IAAA,YAAA,CAAA,IAAA,EAAK,UAAa,EAAA,CAAA,CAAA;AAAA;AACpB,EAEA,MAAM,aAAgB,GAAA;AACpB,IAAA,YAAA,CAAA,IAAA,EAAK,WAAc,EAAA,IAAA,CAAA;AAEnB,IAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,MACvD,IAAM,EAAA,aAAA;AAAA,MACN,OAAS,EAAA,iBAAA;AAAA,MACT,QAAQ;AAAC,KACV,CAAA;AAED,IAAI,IAAAC,iCAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,MAAA,MAAM,EAAE,KAAA,EAAO,YAAa,EAAA,GAAI,WAAY,CAAA,IAAA;AAC5C,MAAO,OAAA,YAAA;AAAA,KACF,MAAA;AACL,MAAA,OAAA,CAAQ,IAAI,MAAM,CAAA;AAAA;AACpB;AACF,EAEA,IAAI,UAAa,GAAA;AACf,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA;AAAA;AACd,EAEA,IAAI,SAAuB,GAAA;AACzB,IAAO,OAAA,IAAA,CAAK,SAAc,KAAA,CAAA,GAAI,OAAU,GAAA,OAAA;AAAA;AAC1C,EAEA,MAAM,aAAgB,GAAA;AACpB,IAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,MACvD,IAAM,EAAA,aAAA;AAAA,MACN,OAAS,EAAA,gBAAA;AAAA,MACT,QAAQ;AAAC,KACV,CAAA;AACD,IAAA,IAAA,CAAK,KAAM,EAAA;AACX,IAAO,OAAA,WAAA;AAAA;AACT,EAEA,MAAM,WAAc,GAAA;AAClB,IAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,MACvD,IAAM,EAAA,aAAA;AAAA,MACN,OAAS,EAAA,gBAAA;AAAA,MACT,MAAA,EAAQ,EAAE,IAAA,EAAM,IAAK;AAAA,KACtB,CAAA;AACD,IAAA,IAAA,CAAK,KAAM,EAAA;AACX,IAAO,OAAA,WAAA;AAAA;AACT;AAAA,EAGA,IACE,CAAA,GAAA,EACA,UACA,EAAA,aAAA,EACA,QACA,EAAA;AACA,IAAA,MAAM,cAAiB,GAAA,YAAA,CAAA,IAAA,EAAK,SAAU,CAAA,CAAA,GAAA,CAAI,GAAG,CAAA;AAC7C,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAM,MAAA,EAAE,WAAc,GAAA,cAAA;AACtB,MAAM,MAAA,QAAA,GAAW,SAAU,CAAA,GAAA,CAAI,UAAU,CAAA;AACzC,MAAA,IAAI,QAAU,EAAA;AACZ,QAAI,IAAA,QAAA,KAAa,SAAS,aAAe,EAAA;AACvC,UAAI,IAAA,SAAA,CAAU,SAAS,CAAG,EAAA;AACxB,YAAK,YAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAU,OAAO,GAAG,CAAA;AAAA,WACpB,MAAA;AAEL,YAAA,SAAA,CAAU,OAAO,UAAU,CAAA;AAAA;AAE7B,UAAK,IAAA,CAAA,SAAA,GAAY,mBAAK,UAAa,CAAA,GAAA,CAAA;AAAA,SAC9B,MAAA;AACL,UAAA,QAAA,CAAS,WAAc,GAAA,QAAA;AAAA;AACzB,OACK,MAAA;AAEL,QAAA,SAAA,CAAU,IAAI,UAAY,EAAA;AAAA,UACxB,aAAA;AAAA,UACA,WAAa,EAAA;AAAA,SACd,CAAA;AACD,QAAK,IAAA,CAAA,SAAA,GAAY,mBAAK,UAAa,CAAA,GAAA,CAAA;AAAA;AACrC,KACK,MAAA;AACL,MAAK,YAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAU,IAAI,GAAK,EAAA;AAAA,QACtB,SAAA,sBAAe,GAAI,CAAA;AAAA,UACjB,CAAC,UAAY,EAAA,EAAE,aAAe,EAAA,WAAA,EAAa,UAAU;AAAA,SACtD;AAAA,OACF,CAAA;AACD,MAAK,IAAA,CAAA,SAAA,GAAY,mBAAK,UAAa,CAAA,GAAA,CAAA;AAAA;AACrC;AACF;AAAA;AAAA;AAAA,EAKA,MAAM,MAAO,CAAA,GAAA,EAAa,UAAoB,EAAA;AAC5C,IAAA,MAAM,cAAiB,GAAA,YAAA,CAAA,IAAA,EAAK,SAAU,CAAA,CAAA,GAAA,CAAI,GAAG,CAAA;AAC7C,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAM,MAAA,EAAE,WAAc,GAAA,cAAA;AACtB,MAAM,MAAA,cAAA,GAAiB,SAAU,CAAA,GAAA,CAAI,UAAU,CAAA;AAC/C,MAAA,IAAI,cAAgB,EAAA;AAClB,QAAM,MAAA,EAAE,aAAgB,GAAA,cAAA;AACxB,QAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,UACvD,IAAM,EAAA,aAAA;AAAA,UACN,OAAS,EAAA,UAAA;AAAA,UACT,MAAQ,EAAA;AAAA,YACN,MAAQ,EAAA,UAAA;AAAA,YACR,IAAM,EAAA,WAAA;AAAA,YACN;AAAA;AACF,SACD,CAAA;AAED,QAAO,OAAA,WAAA;AAAA;AACT,KACK,MAAA;AACL,MAAO,OAAA;AAAA,QACL,YAAc,EAAA,iBAAA;AAAA,QACd,IAAM,EAAA;AAAA,OACR;AAAA;AACF;AAEJ;AA3JE,OAAA,GAAA,IAAA,OAAA,EAAA;AAIA,SAAA,GAAA,IAAA,OAAA,EAAA;AACA,UAAA,GAAA,IAAA,OAAA,EAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA;;;;"}

package/esm/packages/vuu-utils/src/data-editing/EditTracker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EditTracker.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditTracker.tsx"],"sourcesContent":["import { DataSource } from \"@vuu-ui/vuu-data-types\";\nimport type {\n  RpcResultError,\n  VuuRowDataItemType,\n  VuuTable,\n} from \"@vuu-ui/vuu-protocol-types\";\nimport { EventEmitter } from \"../event-emitter\";\nimport { isRpcSuccess } from \"../protocol-message-utils\";\n\nexport type EditState = \"clean\" | \"dirty\";\n\ntype CellEdit = {\n  originalValue: VuuRowDataItemType;\n  editedValue: VuuRowDataItemType;\n};\n\ntype RowEditDetails = {\n  /**\n   * Column name => cell edit details\n   */\n  cellEdits: Map<string, CellEdit>;\n};\n\ntype EditTrackerEvents = {\n  editState: (editState: EditState) => void;\n};\n\nexport class EditTracker extends EventEmitter<EditTrackerEvents> {\n  #active = false;\n  /**\n   *  Row key => row edits\n   */\n  #rowEdits = new Map<string, RowEditDetails>();\n  #editCount = 0;\n  #dataSource?: DataSource;\n  #inEditMode = false;\n\n  get active() {\n    return this.#active;\n  }\n  set active(isActive: boolean) {\n    this.#active = isActive;\n  }\n  get editCount() {\n    return this.#editCount;\n  }\n\n  set editCount(val: number) {\n    if (val !== this.#editCount) {\n      const oldCount = this.#editCount;\n      this.#editCount = val;\n      if (val === 0) {\n        this.emit(\"editState\", \"clean\");\n      } else if (oldCount === 0) {\n        this.emit(\"editState\", \"dirty\");\n      }\n    }\n  }\n\n  set dataSource(ds: DataSource) {\n    this.#dataSource = ds;\n  }\n\n  clear() {\n    this.#rowEdits.clear();\n    this.#editCount = 0;\n  }\n\n  async enterEditMode() {\n    this.#inEditMode = true;\n\n    const rpcResponse = await this.#dataSource?.rpcRequest?.({\n      type: \"RPC_REQUEST\",\n      rpcName: \"ENTER_EDIT_MODE\",\n      params: {},\n    });\n\n    if (isRpcSuccess(rpcResponse)) {\n      const { table: sessionTable } = rpcResponse.data as { table: VuuTable };\n      return sessionTable;\n    } else {\n      console.log(\"fail\");\n    }\n  }\n\n  get inEditMode() {\n    return this.#inEditMode;\n  }\n\n  get editState(): EditState {\n    return this.editCount === 0 ? \"clean\" : \"dirty\";\n  }\n\n  async cancelChanges() {\n    const rpcResponse = await this.#dataSource?.rpcRequest?.({\n      type: \"RPC_REQUEST\",\n      rpcName: \"EXIT_EDIT_MODE\",\n      params: {},\n    });\n    this.clear();\n    return rpcResponse;\n  }\n\n  async saveChanges() {\n    const rpcResponse = await this.#dataSource?.rpcRequest?.({\n      type: \"RPC_REQUEST\",\n      rpcName: \"EXIT_EDIT_MODE\",\n      params: { save: true },\n    });\n    this.clear();\n    return rpcResponse;\n  }\n\n  // TODO how do we deal with the '_edited' pattern\n  edit(\n    key: string,\n    columnName: string,\n    originalValue: VuuRowDataItemType,\n    newValue: VuuRowDataItemType,\n  ) {\n    const rowEditDetails = this.#rowEdits.get(key);\n    if (rowEditDetails) {\n      const { cellEdits } = rowEditDetails;\n      const cellEdit = cellEdits.get(columnName);\n      if (cellEdit) {\n        if (newValue === cellEdit.originalValue) {\n          if (cellEdits.size === 1) {\n            this.#rowEdits.delete(key);\n          } else {\n            // re-editing a cell had removed the edit\n            cellEdits.delete(columnName);\n          }\n          this.editCount = this.#editCount - 1;\n        } else {\n          cellEdit.editedValue = newValue;\n        }\n      } else {\n        // row has already been edited, but this column has not\n        cellEdits.set(columnName, {\n          originalValue,\n          editedValue: newValue,\n        });\n        this.editCount = this.#editCount + 1;\n      }\n    } else {\n      this.#rowEdits.set(key, {\n        cellEdits: new Map([\n          [columnName, { originalValue, editedValue: newValue }],\n        ]),\n      });\n      this.editCount = this.#editCount + 1;\n    }\n  }\n\n  //TODO alow a shortcut commit that allows a value, bypassing need\n  // for edit. Thids caters for boolean values, dropdown list etc\n  // that have no intermediate edit phase\n  async commit(key: string, columnName: string) {\n    const rowEditDetails = this.#rowEdits.get(key);\n    if (rowEditDetails) {\n      const { cellEdits } = rowEditDetails;\n      const cellEditValues = cellEdits.get(columnName);\n      if (cellEditValues) {\n        const { editedValue } = cellEditValues;\n        const rpcResponse = await this.#dataSource?.rpcRequest?.({\n          type: \"RPC_REQUEST\",\n          rpcName: \"editCell\",\n          params: {\n            column: columnName,\n            data: editedValue,\n            key,\n          },\n        });\n\n        return rpcResponse;\n      }\n    } else {\n      return {\n        errorMessage: \"CHANGE_REVERTED\",\n        type: \"ERROR_RESULT\",\n      } as RpcResultError;\n    }\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;AAAA,IAAA,OAAA,EAAA,SAAA,EAAA,UAAA,EAAA,WAAA,EAAA,WAAA;AA2BO,MAAM,oBAAoB,YAAgC,CAAA;AAAA,EAA1D,WAAA,GAAA;AAAA,IAAA,KAAA,CAAA,GAAA,SAAA,CAAA;AACL,IAAU,YAAA,CAAA,IAAA,EAAA,OAAA,EAAA,KAAA,CAAA;AAIV;AAAA;AAAA;AAAA,IAAA,YAAA,CAAA,IAAA,EAAA,SAAA,sBAAgB,GAA4B,EAAA,CAAA;AAC5C,IAAa,YAAA,CAAA,IAAA,EAAA,UAAA,EAAA,CAAA,CAAA;AACb,IAAA,YAAA,CAAA,IAAA,EAAA,WAAA,CAAA;AACA,IAAc,YAAA,CAAA,IAAA,EAAA,WAAA,EAAA,KAAA,CAAA;AAAA;AAAA,EAEd,IAAI,MAAS,GAAA;AACX,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,OAAA,CAAA;AAAA;AACd,EACA,IAAI,OAAO,QAAmB,EAAA;AAC5B,IAAA,YAAA,CAAA,IAAA,EAAK,OAAU,EAAA,QAAA,CAAA;AAAA;AACjB,EACA,IAAI,SAAY,GAAA;AACd,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,UAAA,CAAA;AAAA;AACd,EAEA,IAAI,UAAU,GAAa,EAAA;AACzB,IAAI,IAAA,GAAA,KAAQ,mBAAK,UAAY,CAAA,EAAA;AAC3B,MAAA,MAAM,WAAW,YAAK,CAAA,IAAA,EAAA,UAAA,CAAA;AACtB,MAAA,YAAA,CAAA,IAAA,EAAK,UAAa,EAAA,GAAA,CAAA;AAClB,MAAA,IAAI,QAAQ,CAAG,EAAA;AACb,QAAK,IAAA,CAAA,IAAA,CAAK,aAAa,OAAO,CAAA;AAAA,OAChC,MAAA,IAAW,aAAa,CAAG,EAAA;AACzB,QAAK,IAAA,CAAA,IAAA,CAAK,aAAa,OAAO,CAAA;AAAA;AAChC;AACF;AACF,EAEA,IAAI,WAAW,EAAgB,EAAA;AAC7B,IAAA,YAAA,CAAA,IAAA,EAAK,WAAc,EAAA,EAAA,CAAA;AAAA;AACrB,EAEA,KAAQ,GAAA;AACN,IAAA,YAAA,CAAA,IAAA,EAAK,WAAU,KAAM,EAAA;AACrB,IAAA,YAAA,CAAA,IAAA,EAAK,UAAa,EAAA,CAAA,CAAA;AAAA;AACpB,EAEA,MAAM,aAAgB,GAAA;AACpB,IAAA,YAAA,CAAA,IAAA,EAAK,WAAc,EAAA,IAAA,CAAA;AAEnB,IAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,MACvD,IAAM,EAAA,aAAA;AAAA,MACN,OAAS,EAAA,iBAAA;AAAA,MACT,QAAQ;AAAC,KACV,CAAA;AAED,IAAI,IAAA,YAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,MAAA,MAAM,EAAE,KAAA,EAAO,YAAa,EAAA,GAAI,WAAY,CAAA,IAAA;AAC5C,MAAO,OAAA,YAAA;AAAA,KACF,MAAA;AACL,MAAA,OAAA,CAAQ,IAAI,MAAM,CAAA;AAAA;AACpB;AACF,EAEA,IAAI,UAAa,GAAA;AACf,IAAA,OAAO,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA;AAAA;AACd,EAEA,IAAI,SAAuB,GAAA;AACzB,IAAO,OAAA,IAAA,CAAK,SAAc,KAAA,CAAA,GAAI,OAAU,GAAA,OAAA;AAAA;AAC1C,EAEA,MAAM,aAAgB,GAAA;AACpB,IAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,MACvD,IAAM,EAAA,aAAA;AAAA,MACN,OAAS,EAAA,gBAAA;AAAA,MACT,QAAQ;AAAC,KACV,CAAA;AACD,IAAA,IAAA,CAAK,KAAM,EAAA;AACX,IAAO,OAAA,WAAA;AAAA;AACT,EAEA,MAAM,WAAc,GAAA;AAClB,IAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,MACvD,IAAM,EAAA,aAAA;AAAA,MACN,OAAS,EAAA,gBAAA;AAAA,MACT,MAAA,EAAQ,EAAE,IAAA,EAAM,IAAK;AAAA,KACtB,CAAA;AACD,IAAA,IAAA,CAAK,KAAM,EAAA;AACX,IAAO,OAAA,WAAA;AAAA;AACT;AAAA,EAGA,IACE,CAAA,GAAA,EACA,UACA,EAAA,aAAA,EACA,QACA,EAAA;AACA,IAAA,MAAM,cAAiB,GAAA,YAAA,CAAA,IAAA,EAAK,SAAU,CAAA,CAAA,GAAA,CAAI,GAAG,CAAA;AAC7C,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAM,MAAA,EAAE,WAAc,GAAA,cAAA;AACtB,MAAM,MAAA,QAAA,GAAW,SAAU,CAAA,GAAA,CAAI,UAAU,CAAA;AACzC,MAAA,IAAI,QAAU,EAAA;AACZ,QAAI,IAAA,QAAA,KAAa,SAAS,aAAe,EAAA;AACvC,UAAI,IAAA,SAAA,CAAU,SAAS,CAAG,EAAA;AACxB,YAAK,YAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAU,OAAO,GAAG,CAAA;AAAA,WACpB,MAAA;AAEL,YAAA,SAAA,CAAU,OAAO,UAAU,CAAA;AAAA;AAE7B,UAAK,IAAA,CAAA,SAAA,GAAY,mBAAK,UAAa,CAAA,GAAA,CAAA;AAAA,SAC9B,MAAA;AACL,UAAA,QAAA,CAAS,WAAc,GAAA,QAAA;AAAA;AACzB,OACK,MAAA;AAEL,QAAA,SAAA,CAAU,IAAI,UAAY,EAAA;AAAA,UACxB,aAAA;AAAA,UACA,WAAa,EAAA;AAAA,SACd,CAAA;AACD,QAAK,IAAA,CAAA,SAAA,GAAY,mBAAK,UAAa,CAAA,GAAA,CAAA;AAAA;AACrC,KACK,MAAA;AACL,MAAK,YAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAU,IAAI,GAAK,EAAA;AAAA,QACtB,SAAA,sBAAe,GAAI,CAAA;AAAA,UACjB,CAAC,UAAY,EAAA,EAAE,aAAe,EAAA,WAAA,EAAa,UAAU;AAAA,SACtD;AAAA,OACF,CAAA;AACD,MAAK,IAAA,CAAA,SAAA,GAAY,mBAAK,UAAa,CAAA,GAAA,CAAA;AAAA;AACrC;AACF;AAAA;AAAA;AAAA,EAKA,MAAM,MAAO,CAAA,GAAA,EAAa,UAAoB,EAAA;AAC5C,IAAA,MAAM,cAAiB,GAAA,YAAA,CAAA,IAAA,EAAK,SAAU,CAAA,CAAA,GAAA,CAAI,GAAG,CAAA;AAC7C,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAM,MAAA,EAAE,WAAc,GAAA,cAAA;AACtB,MAAM,MAAA,cAAA,GAAiB,SAAU,CAAA,GAAA,CAAI,UAAU,CAAA;AAC/C,MAAA,IAAI,cAAgB,EAAA;AAClB,QAAM,MAAA,EAAE,aAAgB,GAAA,cAAA;AACxB,QAAA,MAAM,WAAc,GAAA,MAAM,YAAK,CAAA,IAAA,EAAA,WAAA,CAAA,EAAa,UAAa,GAAA;AAAA,UACvD,IAAM,EAAA,aAAA;AAAA,UACN,OAAS,EAAA,UAAA;AAAA,UACT,MAAQ,EAAA;AAAA,YACN,MAAQ,EAAA,UAAA;AAAA,YACR,IAAM,EAAA,WAAA;AAAA,YACN;AAAA;AACF,SACD,CAAA;AAED,QAAO,OAAA,WAAA;AAAA;AACT,KACK,MAAA;AACL,MAAO,OAAA;AAAA,QACL,YAAc,EAAA,iBAAA;AAAA,QACd,IAAM,EAAA;AAAA,OACR;AAAA;AACF;AAEJ;AA3JE,OAAA,GAAA,IAAA,OAAA,EAAA;AAIA,SAAA,GAAA,IAAA,OAAA,EAAA;AACA,UAAA,GAAA,IAAA,OAAA,EAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA;;;;"}

package/types/data-editing/EditTracker.d.ts

@@ -1,24 +0,0 @@
-import { DataSource } from "@vuu-ui/vuu-data-types";
-import type { RpcResultError, VuuRowDataItemType, VuuTable } from "@vuu-ui/vuu-protocol-types";
-import { EventEmitter } from "../event-emitter";
-export type EditState = "clean" | "dirty";
-type EditTrackerEvents = {
-    editState: (editState: EditState) => void;
-};
-export declare class EditTracker extends EventEmitter<EditTrackerEvents> {
-    #private;
-    get active(): boolean;
-    set active(isActive: boolean);
-    get editCount(): number;
-    set editCount(val: number);
-    set dataSource(ds: DataSource);
-    clear(): void;
-    enterEditMode(): Promise<VuuTable | undefined>;
-    get inEditMode(): boolean;
-    get editState(): EditState;
-    cancelChanges(): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | RpcResultError | undefined>;
-    saveChanges(): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | RpcResultError | undefined>;
-    edit(key: string, columnName: string, originalValue: VuuRowDataItemType, newValue: VuuRowDataItemType): void;
-    commit(key: string, columnName: string): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | RpcResultError | undefined>;
-}
-export {};