@vuu-ui/vuu-utils 2.1.4 → 2.1.5

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

@@ -6,23 +6,23 @@ var React = require('react');
 const DataEditingContext = React.createContext(void 0);
 const DataEditingProvider = ({
   children,
-  editTracker
+  editSession
 }) => {
-  return /* @__PURE__ */ jsxRuntime.jsx(DataEditingContext.Provider, { value: editTracker, children });
+  return /* @__PURE__ */ jsxRuntime.jsx(DataEditingContext.Provider, { value: editSession, children });
 };
-function useEditTracker(throwIfUnavailable = false) {
-  const editTracker = React.useContext(DataEditingContext);
-  if (editTracker === void 0) {
+function useEditSession(throwIfUnavailable = false) {
+  const editSession = React.useContext(DataEditingContext);
+  if (editSession === void 0) {
     if (throwIfUnavailable) {
       throw Error(
-        "[useEditTracker] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider"
+        "[useEditSession] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider"
       );
     }
   } else {
-    return editTracker;
+    return editSession;
   }
 }
 
 exports.DataEditingProvider = DataEditingProvider;
-exports.useEditTracker = useEditTracker;
+exports.useEditSession = useEditSession;
 //# sourceMappingURL=DataEditingProvider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"DataEditingProvider.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/DataEditingProvider.tsx"],"sourcesContent":["import { createContext, ReactNode, useContext } from \"react\";\nimport { EditTracker } from \"./EditTracker\";\n\nconst DataEditingContext = createContext<EditTracker | undefined>(undefined);\n\nexport const DataEditingProvider = ({\n  children,\n  editTracker,\n}: {\n  children: ReactNode;\n  editTracker: EditTracker;\n}) => {\n  return (\n    <DataEditingContext.Provider value={editTracker}>\n      {children}\n    </DataEditingContext.Provider>\n  );\n};\n\nexport function useEditTracker(\n  throwIfUnavailable?: false,\n): EditTracker | undefined;\nexport function useEditTracker(throwIfUnavailable: true): EditTracker;\nexport function useEditTracker(throwIfUnavailable = false) {\n  const editTracker = useContext(DataEditingContext);\n  if (editTracker === undefined) {\n    if (throwIfUnavailable) {\n      throw Error(\n        \"[useEditTracker] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider\",\n      );\n    }\n  } else {\n    return editTracker;\n  }\n}\n"],"names":["createContext","useContext"],"mappings":";;;;;AAGA,MAAM,kBAAA,GAAqBA,oBAAuC,KAAS,CAAA,CAAA;AAEpE,MAAM,sBAAsB,CAAC;AAAA,EAClC,QAAA;AAAA,EACA;AACF,CAGM,KAAA;AACJ,EAAA,sCACG,kBAAmB,CAAA,QAAA,EAAnB,EAA4B,KAAA,EAAO,aACjC,QACH,EAAA,CAAA;AAEJ;AAMgB,SAAA,cAAA,CAAe,qBAAqB,KAAO,EAAA;AACzD,EAAM,MAAA,WAAA,GAAcC,iBAAW,kBAAkB,CAAA;AACjD,EAAA,IAAI,gBAAgB,KAAW,CAAA,EAAA;AAC7B,IAAA,IAAI,kBAAoB,EAAA;AACtB,MAAM,MAAA,KAAA;AAAA,QACJ;AAAA,OACF;AAAA;AACF,GACK,MAAA;AACL,IAAO,OAAA,WAAA;AAAA;AAEX;;;;;"}
+{"version":3,"file":"DataEditingProvider.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/DataEditingProvider.tsx"],"sourcesContent":["import { createContext, ReactNode, useContext } from \"react\";\nimport { EditSession } from \"./EditSession\";\n\nconst DataEditingContext = createContext<EditSession | undefined>(undefined);\n\nexport const DataEditingProvider = ({\n  children,\n  editSession,\n}: {\n  children: ReactNode;\n  editSession: EditSession;\n}) => {\n  return (\n    <DataEditingContext.Provider value={editSession}>\n      {children}\n    </DataEditingContext.Provider>\n  );\n};\n\nexport function useEditSession(\n  throwIfUnavailable?: false,\n): EditSession | undefined;\nexport function useEditSession(throwIfUnavailable: true): EditSession;\nexport function useEditSession(throwIfUnavailable = false) {\n  const editSession = useContext(DataEditingContext);\n  if (editSession === undefined) {\n    if (throwIfUnavailable) {\n      throw Error(\n        \"[useEditSession] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider\",\n      );\n    }\n  } else {\n    return editSession;\n  }\n}\n"],"names":["createContext","useContext"],"mappings":";;;;;AAGA,MAAM,kBAAA,GAAqBA,oBAAuC,KAAS,CAAA,CAAA;AAEpE,MAAM,sBAAsB,CAAC;AAAA,EAClC,QAAA;AAAA,EACA;AACF,CAGM,KAAA;AACJ,EAAA,sCACG,kBAAmB,CAAA,QAAA,EAAnB,EAA4B,KAAA,EAAO,aACjC,QACH,EAAA,CAAA;AAEJ;AAMgB,SAAA,cAAA,CAAe,qBAAqB,KAAO,EAAA;AACzD,EAAM,MAAA,WAAA,GAAcC,iBAAW,kBAAkB,CAAA;AACjD,EAAA,IAAI,gBAAgB,KAAW,CAAA,EAAA;AAC7B,IAAA,IAAI,kBAAoB,EAAA;AACtB,MAAM,MAAA,KAAA;AAAA,QACJ;AAAA,OACF;AAAA;AACF,GACK,MAAA;AACL,IAAO,OAAA,WAAA;AAAA;AAEX;;;;;"}

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

@@ -5,14 +5,14 @@ var core = require('@salt-ds/core');
 var React = require('react');
 
 const EditButtons = ({
-  editTracker,
+  editSession,
   onCancel,
   onSave
 }) => {
   const [editState, setEditState] = React.useState("clean");
   React.useMemo(() => {
-    editTracker?.on("editState", setEditState);
-  }, [editTracker]);
+    editSession?.on("editState", setEditState);
+  }, [editSession]);
   return /* @__PURE__ */ jsxRuntime.jsxs(jsxRuntime.Fragment, { children: [
     /* @__PURE__ */ jsxRuntime.jsx(
       core.Button,

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

@@ -1 +1 @@
-{"version":3,"file":"EditButtons.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditButtons.tsx"],"sourcesContent":["import { Button } from \"@salt-ds/core\";\nimport { EditState, EditTracker } from \"./EditTracker\";\nimport { useMemo, useState } from \"react\";\n\nexport interface EditButtonProps {\n  editTracker?: EditTracker;\n  onCancel: () => void;\n  onSave: () => void;\n}\n\nexport const EditButtons = ({\n  editTracker,\n  onCancel,\n  onSave,\n}: EditButtonProps) => {\n  const [editState, setEditState] = useState<EditState>(\"clean\");\n\n  useMemo(() => {\n    editTracker?.on(\"editState\", setEditState);\n  }, [editTracker]);\n\n  return (\n    <>\n      <Button\n        disabled={editState === \"clean\"}\n        onClick={onSave}\n        sentiment=\"accented\"\n      >\n        Save\n      </Button>\n      <Button onClick={onCancel}>Cancel</Button>\n    </>\n  );\n};\n"],"names":["useState","useMemo","jsxs","Fragment","jsx","Button"],"mappings":";;;;;;AAUO,MAAM,cAAc,CAAC;AAAA,EAC1B,WAAA;AAAA,EACA,QAAA;AAAA,EACA;AACF,CAAuB,KAAA;AACrB,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,CAAA,GAAIA,eAAoB,OAAO,CAAA;AAE7D,EAAAC,aAAA,CAAQ,MAAM;AACZ,IAAa,WAAA,EAAA,EAAA,CAAG,aAAa,YAAY,CAAA;AAAA,GAC3C,EAAG,CAAC,WAAW,CAAC,CAAA;AAEhB,EAAA,uBAEIC,eAAA,CAAAC,mBAAA,EAAA,EAAA,QAAA,EAAA;AAAA,oBAAAC,cAAA;AAAA,MAACC,WAAA;AAAA,MAAA;AAAA,QACC,UAAU,SAAc,KAAA,OAAA;AAAA,QACxB,OAAS,EAAA,MAAA;AAAA,QACT,SAAU,EAAA,UAAA;AAAA,QACX,QAAA,EAAA;AAAA;AAAA,KAED;AAAA,oBACCD,cAAA,CAAAC,WAAA,EAAA,EAAO,OAAS,EAAA,QAAA,EAAU,QAAM,EAAA,QAAA,EAAA;AAAA,GACnC,EAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"EditButtons.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditButtons.tsx"],"sourcesContent":["import { Button } from \"@salt-ds/core\";\nimport { EditState, EditSession } from \"./EditSession\";\nimport { useMemo, useState } from \"react\";\n\nexport interface EditButtonProps {\n  editSession?: EditSession;\n  onCancel: () => void;\n  onSave: () => void;\n}\n\nexport const EditButtons = ({\n  editSession,\n  onCancel,\n  onSave,\n}: EditButtonProps) => {\n  const [editState, setEditState] = useState<EditState>(\"clean\");\n\n  useMemo(() => {\n    editSession?.on(\"editState\", setEditState);\n  }, [editSession]);\n\n  return (\n    <>\n      <Button\n        disabled={editState === \"clean\"}\n        onClick={onSave}\n        sentiment=\"accented\"\n      >\n        Save\n      </Button>\n      <Button onClick={onCancel}>Cancel</Button>\n    </>\n  );\n};\n"],"names":["useState","useMemo","jsxs","Fragment","jsx","Button"],"mappings":";;;;;;AAUO,MAAM,cAAc,CAAC;AAAA,EAC1B,WAAA;AAAA,EACA,QAAA;AAAA,EACA;AACF,CAAuB,KAAA;AACrB,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,CAAA,GAAIA,eAAoB,OAAO,CAAA;AAE7D,EAAAC,aAAA,CAAQ,MAAM;AACZ,IAAa,WAAA,EAAA,EAAA,CAAG,aAAa,YAAY,CAAA;AAAA,GAC3C,EAAG,CAAC,WAAW,CAAC,CAAA;AAEhB,EAAA,uBAEIC,eAAA,CAAAC,mBAAA,EAAA,EAAA,QAAA,EAAA;AAAA,oBAAAC,cAAA;AAAA,MAACC,WAAA;AAAA,MAAA;AAAA,QACC,UAAU,SAAc,KAAA,OAAA;AAAA,QACxB,OAAS,EAAA,MAAA;AAAA,QACT,SAAU,EAAA,UAAA;AAAA,QACX,QAAA,EAAA;AAAA;AAAA,KAED;AAAA,oBACCD,cAAA,CAAAC,WAAA,EAAA,EAAO,OAAS,EAAA,QAAA,EAAU,QAAM,EAAA,QAAA,EAAA;AAAA,GACnC,EAAA,CAAA;AAEJ;;;;"}

package/cjs/packages/vuu-utils/src/data-editing/{EditTracker.js → EditSession.js}

@@ -11,7 +11,7 @@ var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read fr
 var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
 var _active, _rowEdits, _editCount, _dataSource, _inEditMode;
-class EditTracker extends eventEmitter.EventEmitter {
+class EditSession extends eventEmitter.EventEmitter {
   constructor() {
     super(...arguments);
     __privateAdd(this, _active, false);
@@ -52,11 +52,8 @@ class EditTracker extends eventEmitter.EventEmitter {
   }
   async enterEditMode() {
     __privateSet(this, _inEditMode, true);
-    const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "ENTER_EDIT_MODE",
-      params: {}
-    });
+    const rpcResponse = await __privateGet(this, _dataSource)?.beginEditSession?.();
+    console.log({ rpcResponse });
     if (protocolMessageUtils.isRpcSuccess(rpcResponse)) {
       const { table: sessionTable } = rpcResponse.data;
       return sessionTable;
@@ -73,7 +70,7 @@ class EditTracker extends eventEmitter.EventEmitter {
   async cancelChanges() {
     const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
       type: "RPC_REQUEST",
-      rpcName: "EXIT_EDIT_MODE",
+      rpcName: "endEditSession",
       params: {}
     });
     this.clear();
@@ -82,7 +79,7 @@ class EditTracker extends eventEmitter.EventEmitter {
   async saveChanges() {
     const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
       type: "RPC_REQUEST",
-      rpcName: "EXIT_EDIT_MODE",
+      rpcName: "endEditSession",
       params: { save: true }
     });
     this.clear();
@@ -121,22 +118,18 @@ class EditTracker extends eventEmitter.EventEmitter {
       this.editCount = __privateGet(this, _editCount) + 1;
     }
   }
-  //TODO alow a shortcut commit that allows a value, bypassing need
-  // for edit. Thids caters for boolean values, dropdown list etc
-  // that have no intermediate edit phase
-  async commit(key, columnName) {
+  async commit(key, columnName, typedValue) {
     const rowEditDetails = __privateGet(this, _rowEdits).get(key);
     if (rowEditDetails) {
       const { cellEdits } = rowEditDetails;
       const cellEditValues = cellEdits.get(columnName);
       if (cellEditValues) {
-        const { editedValue } = cellEditValues;
         const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
           type: "RPC_REQUEST",
           rpcName: "editCell",
           params: {
             column: columnName,
-            data: editedValue,
+            data: typedValue,
             key
           }
         });
@@ -156,5 +149,5 @@ _editCount = new WeakMap();
 _dataSource = new WeakMap();
 _inEditMode = new WeakMap();
 
-exports.EditTracker = EditTracker;
-//# sourceMappingURL=EditTracker.js.map
+exports.EditSession = EditSession;
+//# sourceMappingURL=EditSession.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EditSession.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditSession.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 EditSessionEvents = {\n  editState: (editState: EditState) => void;\n};\n\nexport class EditSession extends EventEmitter<EditSessionEvents> {\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?.beginEditSession?.();\n\n    console.log({ rpcResponse });\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: \"endEditSession\",\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: \"endEditSession\",\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  async commit(\n    key: string,\n    columnName: string,\n    typedValue: string | number | boolean,\n  ) {\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 rpcResponse = await this.#dataSource?.rpcRequest?.({\n          type: \"RPC_REQUEST\",\n          rpcName: \"editCell\",\n          params: {\n            column: columnName,\n            data: typedValue,\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,gBAAmB,IAAA;AAE/D,IAAQ,OAAA,CAAA,GAAA,CAAI,EAAE,WAAA,EAAa,CAAA;AAE3B,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,EAEA,MAAM,MAAA,CACJ,GACA,EAAA,UAAA,EACA,UACA,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,cAAA,GAAiB,SAAU,CAAA,GAAA,CAAI,UAAU,CAAA;AAC/C,MAAA,IAAI,cAAgB,EAAA;AAClB,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,UAAA;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;AAzJE,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/cjs/packages/vuu-utils/src/data-editing/useEditableTable.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var React = require('react');
-var EditTracker = require('./EditTracker.js');
+var EditSession = require('./EditSession.js');
 var DataProvider = require('../context-definitions/DataProvider.js');
 var protocolMessageUtils = require('../protocol-message-utils.js');
 var useLayoutEffectSkipFirst = require('../useLayoutEffectSkipFirst.js');
@@ -26,47 +26,54 @@ const useEditableTable = ({
     console.warn(`[useEditableTable] columns and or table changed`);
   }, [columns, table]);
   const dataSource = React.useMemo(() => {
-    return dataSourceProp ?? new VuuDataSource({ columns, table });
+    if (dataSourceProp) {
+      return dataSourceProp;
+    } else if (table) {
+      return new VuuDataSource({ columns, table });
+    } else {
+      throw Error(
+        `useEditableTable unable to provide DataSource, neither dataSource nor table available as props`
+      );
+    }
   }, [VuuDataSource, columns, dataSourceProp, table]);
-  const editTracker = React.useMemo(() => new EditTracker.EditTracker(), []);
+  const editSession = React.useMemo(() => new EditSession.EditSession(), []);
   React.useMemo(() => {
     if (dataSource) {
-      editTracker.dataSource = dataSource;
+      editSession.dataSource = dataSource;
     }
-  }, [dataSource, editTracker]);
+  }, [dataSource, editSession]);
   const handleCancel = React.useCallback(() => {
-    editTracker.cancelChanges();
+    editSession.cancelChanges();
     onCancel();
     clearSessionDataSource();
     dataSource.resume?.();
-  }, [clearSessionDataSource, dataSource, editTracker, onCancel]);
+  }, [clearSessionDataSource, dataSource, editSession, onCancel]);
   const handleSave = React.useCallback(async () => {
     dataSource.resume?.();
-    const response = await editTracker.saveChanges();
+    const response = await editSession.saveChanges();
     if (protocolMessageUtils.isRpcSuccess(response)) {
       onSave();
       clearSessionDataSource();
     }
-  }, [clearSessionDataSource, dataSource, editTracker, onSave]);
+  }, [clearSessionDataSource, dataSource, editSession, onSave]);
   React.useMemo(async () => {
     if (isEditMode) {
-      const sessionTable = await editTracker.enterEditMode();
+      const sessionTable = await editSession.enterEditMode();
       if (sessionTable && dataSource.tableSchema) {
-        dataSource.suspend?.(false);
         const sessionDataSource2 = new VuuDataSource({
           columns: dataSource.columns,
           table: sessionTable,
           viewport: sessionTable.table
         });
         setSessionDataSource(sessionDataSource2);
-        editTracker.dataSource = sessionDataSource2;
+        editSession.dataSource = sessionDataSource2;
       }
     }
-  }, [VuuDataSource, dataSource, editTracker, isEditMode]);
+  }, [VuuDataSource, dataSource, editSession, isEditMode]);
   return {
     // DO we need to reset the dataSource or could useDataSOurce detect the sessiondataSOurce from the editSession ?
     dataSource: sessionDataSource ?? dataSource,
-    editTracker,
+    editSession,
     onCancel: handleCancel,
     onSave: handleSave
   };

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

@@ -1 +1 @@
-{"version":3,"file":"useEditableTable.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/useEditableTable.ts"],"sourcesContent":["import { VuuTable } from \"@vuu-ui/vuu-protocol-types\";\nimport { useCallback, useMemo, useState } from \"react\";\nimport { EditTracker } from \"./EditTracker\";\nimport { useData } from \"../context-definitions/DataProvider\";\nimport { DataSource } from \"@vuu-ui/vuu-data-types\";\nimport { isRpcSuccess } from \"../protocol-message-utils\";\nimport { useLayoutEffectSkipFirst } from \"../useLayoutEffectSkipFirst\";\n\nexport type EditMode = \"edit\" | \"view\";\n\nexport interface EditableTableHookProps {\n  /**\n   * columns to be included in subscription. If not provided,\n   * default will be '*'. Ignored if dataSource prop present.\n   */\n  columns?: string[];\n  dataSource?: DataSource;\n  isEditMode: boolean;\n  onCancel: () => void;\n  onSave: () => void;\n  /**\n   * If dataSource not provided, new DataSource\n   * will be created using table and columns\n   */\n  table: VuuTable;\n}\n\nexport const useEditableTable = ({\n  columns,\n  dataSource: dataSourceProp,\n  isEditMode,\n  onCancel,\n  onSave,\n  table,\n}: EditableTableHookProps) => {\n  const { VuuDataSource } = useData();\n  const [sessionDataSource, setSessionDataSource] = useState<\n    DataSource | undefined\n  >(undefined);\n\n  const clearSessionDataSource = useCallback(() => {\n    setSessionDataSource((dataSource) => {\n      dataSource?.unsubscribe();\n      return undefined;\n    });\n  }, []);\n\n  useLayoutEffectSkipFirst(() => {\n    console.warn(`[useEditableTable] columns and or table changed`);\n  }, [columns, table]);\n\n  const dataSource = useMemo(() => {\n    return dataSourceProp ?? new VuuDataSource({ columns, table });\n  }, [VuuDataSource, columns, dataSourceProp, table]);\n\n  const editTracker = useMemo(() => new EditTracker(), []);\n\n  useMemo(() => {\n    if (dataSource) {\n      editTracker.dataSource = dataSource;\n    }\n  }, [dataSource, editTracker]);\n\n  const handleCancel = useCallback(() => {\n    // editTracker.dataSource = dataSource;\n    editTracker.cancelChanges();\n    onCancel();\n    clearSessionDataSource();\n    dataSource.resume?.();\n  }, [clearSessionDataSource, dataSource, editTracker, onCancel]);\n\n  const handleSave = useCallback(async () => {\n    dataSource.resume?.();\n    const response = await editTracker.saveChanges();\n    if (isRpcSuccess(response)) {\n      onSave();\n      clearSessionDataSource();\n    }\n  }, [clearSessionDataSource, dataSource, editTracker, onSave]);\n\n  useMemo(async () => {\n    if (isEditMode) {\n      const sessionTable = await editTracker.enterEditMode();\n      if (sessionTable && dataSource.tableSchema) {\n        dataSource.suspend?.(false);\n        const sessionDataSource = new VuuDataSource({\n          columns: dataSource.columns,\n          table: sessionTable,\n          viewport: sessionTable.table,\n        });\n        setSessionDataSource(sessionDataSource);\n        editTracker.dataSource = sessionDataSource;\n      }\n    }\n  }, [VuuDataSource, dataSource, editTracker, isEditMode]);\n\n  return {\n    // DO we need to reset the dataSource or could useDataSOurce detect the sessiondataSOurce from the editSession ?\n    dataSource: sessionDataSource ?? dataSource,\n    editTracker,\n    onCancel: handleCancel,\n    onSave: handleSave,\n  };\n};\n"],"names":["useData","useState","useCallback","dataSource","useLayoutEffectSkipFirst","useMemo","EditTracker","isRpcSuccess","sessionDataSource"],"mappings":";;;;;;;;AA2BO,MAAM,mBAAmB,CAAC;AAAA,EAC/B,OAAA;AAAA,EACA,UAAY,EAAA,cAAA;AAAA,EACZ,UAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAA8B,KAAA;AAC5B,EAAM,MAAA,EAAE,aAAc,EAAA,GAAIA,oBAAQ,EAAA;AAClC,EAAA,MAAM,CAAC,iBAAA,EAAmB,oBAAoB,CAAA,GAAIC,eAEhD,KAAS,CAAA,CAAA;AAEX,EAAM,MAAA,sBAAA,GAAyBC,kBAAY,MAAM;AAC/C,IAAA,oBAAA,CAAqB,CAACC,WAAe,KAAA;AACnC,MAAAA,aAAY,WAAY,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA;AAAA,KACR,CAAA;AAAA,GACH,EAAG,EAAE,CAAA;AAEL,EAAAC,iDAAA,CAAyB,MAAM;AAC7B,IAAA,OAAA,CAAQ,KAAK,CAAiD,+CAAA,CAAA,CAAA;AAAA,GAC7D,EAAA,CAAC,OAAS,EAAA,KAAK,CAAC,CAAA;AAEnB,EAAM,MAAA,UAAA,GAAaC,cAAQ,MAAM;AAC/B,IAAA,OAAO,kBAAkB,IAAI,aAAA,CAAc,EAAE,OAAA,EAAS,OAAO,CAAA;AAAA,KAC5D,CAAC,aAAA,EAAe,OAAS,EAAA,cAAA,EAAgB,KAAK,CAAC,CAAA;AAElD,EAAA,MAAM,cAAcA,aAAQ,CAAA,MAAM,IAAIC,uBAAY,EAAA,EAAG,EAAE,CAAA;AAEvD,EAAAD,aAAA,CAAQ,MAAM;AACZ,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,WAAA,CAAY,UAAa,GAAA,UAAA;AAAA;AAC3B,GACC,EAAA,CAAC,UAAY,EAAA,WAAW,CAAC,CAAA;AAE5B,EAAM,MAAA,YAAA,GAAeH,kBAAY,MAAM;AAErC,IAAA,WAAA,CAAY,aAAc,EAAA;AAC1B,IAAS,QAAA,EAAA;AACT,IAAuB,sBAAA,EAAA;AACvB,IAAA,UAAA,CAAW,MAAS,IAAA;AAAA,KACnB,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,QAAQ,CAAC,CAAA;AAE9D,EAAM,MAAA,UAAA,GAAaA,kBAAY,YAAY;AACzC,IAAA,UAAA,CAAW,MAAS,IAAA;AACpB,IAAM,MAAA,QAAA,GAAW,MAAM,WAAA,CAAY,WAAY,EAAA;AAC/C,IAAI,IAAAK,iCAAA,CAAa,QAAQ,CAAG,EAAA;AAC1B,MAAO,MAAA,EAAA;AACP,MAAuB,sBAAA,EAAA;AAAA;AACzB,KACC,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,MAAM,CAAC,CAAA;AAE5D,EAAAF,aAAA,CAAQ,YAAY;AAClB,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,YAAA,GAAe,MAAM,WAAA,CAAY,aAAc,EAAA;AACrD,MAAI,IAAA,YAAA,IAAgB,WAAW,WAAa,EAAA;AAC1C,QAAA,UAAA,CAAW,UAAU,KAAK,CAAA;AAC1B,QAAMG,MAAAA,kBAAAA,GAAoB,IAAI,aAAc,CAAA;AAAA,UAC1C,SAAS,UAAW,CAAA,OAAA;AAAA,UACpB,KAAO,EAAA,YAAA;AAAA,UACP,UAAU,YAAa,CAAA;AAAA,SACxB,CAAA;AACD,QAAA,oBAAA,CAAqBA,kBAAiB,CAAA;AACtC,QAAA,WAAA,CAAY,UAAaA,GAAAA,kBAAAA;AAAA;AAC3B;AACF,KACC,CAAC,aAAA,EAAe,UAAY,EAAA,WAAA,EAAa,UAAU,CAAC,CAAA;AAEvD,EAAO,OAAA;AAAA;AAAA,IAEL,YAAY,iBAAqB,IAAA,UAAA;AAAA,IACjC,WAAA;AAAA,IACA,QAAU,EAAA,YAAA;AAAA,IACV,MAAQ,EAAA;AAAA,GACV;AACF;;;;"}
+{"version":3,"file":"useEditableTable.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/useEditableTable.ts"],"sourcesContent":["import { VuuTable } from \"@vuu-ui/vuu-protocol-types\";\nimport { useCallback, useMemo, useState } from \"react\";\nimport { EditSession } from \"./EditSession\";\nimport { useData } from \"../context-definitions/DataProvider\";\nimport { DataSource } from \"@vuu-ui/vuu-data-types\";\nimport { isRpcSuccess } from \"../protocol-message-utils\";\nimport { useLayoutEffectSkipFirst } from \"../useLayoutEffectSkipFirst\";\n\nexport type EditMode = \"edit\" | \"view\";\n\nexport interface EditableTableHookProps {\n  /**\n   * columns to be included in subscription. If not provided,\n   * default will be '*'. Ignored if dataSource prop present.\n   */\n  columns?: string[];\n  dataSource?: DataSource;\n  isEditMode: boolean;\n  onCancel: () => void;\n  onSave: () => void;\n  /**\n   * If dataSource not provided, new DataSource\n   * will be created using table and columns\n   */\n  table?: VuuTable;\n}\n\nexport const useEditableTable = ({\n  columns,\n  dataSource: dataSourceProp,\n  isEditMode,\n  onCancel,\n  onSave,\n  table,\n}: EditableTableHookProps) => {\n  const { VuuDataSource } = useData();\n  const [sessionDataSource, setSessionDataSource] = useState<\n    DataSource | undefined\n  >(undefined);\n\n  const clearSessionDataSource = useCallback(() => {\n    setSessionDataSource((dataSource) => {\n      dataSource?.unsubscribe();\n      return undefined;\n    });\n  }, []);\n\n  useLayoutEffectSkipFirst(() => {\n    console.warn(`[useEditableTable] columns and or table changed`);\n  }, [columns, table]);\n\n  const dataSource = useMemo(() => {\n    // The dataSource would normally be managed by client and passed in, but for\n    // simple use cases we can create it here.\n    if (dataSourceProp) {\n      return dataSourceProp;\n    } else if (table) {\n      return new VuuDataSource({ columns, table });\n    } else {\n      throw Error(\n        `useEditableTable unable to provide DataSource, neither dataSource nor table available as props`,\n      );\n    }\n  }, [VuuDataSource, columns, dataSourceProp, table]);\n\n  // The editSession will be made available to all the edit controls in scope by\n  // wrapping the edit component with a DataEditingProvider.\n  const editSession = useMemo(() => new EditSession(), []);\n\n  useMemo(() => {\n    if (dataSource) {\n      editSession.dataSource = dataSource;\n    }\n  }, [dataSource, editSession]);\n\n  const handleCancel = useCallback(() => {\n    // editTracker.dataSource = dataSource;\n    editSession.cancelChanges();\n    onCancel();\n    clearSessionDataSource();\n    dataSource.resume?.();\n  }, [clearSessionDataSource, dataSource, editSession, onCancel]);\n\n  const handleSave = useCallback(async () => {\n    dataSource.resume?.();\n    const response = await editSession.saveChanges();\n    if (isRpcSuccess(response)) {\n      onSave();\n      clearSessionDataSource();\n    }\n  }, [clearSessionDataSource, dataSource, editSession, onSave]);\n\n  useMemo(async () => {\n    if (isEditMode) {\n      const sessionTable = await editSession.enterEditMode();\n      if (sessionTable && dataSource.tableSchema) {\n        // dataSource.suspend?.(false);\n        const sessionDataSource = new VuuDataSource({\n          columns: dataSource.columns,\n          table: sessionTable,\n          viewport: sessionTable.table,\n        });\n        setSessionDataSource(sessionDataSource);\n        editSession.dataSource = sessionDataSource;\n      }\n    }\n  }, [VuuDataSource, dataSource, editSession, isEditMode]);\n\n  return {\n    // DO we need to reset the dataSource or could useDataSOurce detect the sessiondataSOurce from the editSession ?\n    dataSource: sessionDataSource ?? dataSource,\n    editSession,\n    onCancel: handleCancel,\n    onSave: handleSave,\n  };\n};\n"],"names":["useData","useState","useCallback","dataSource","useLayoutEffectSkipFirst","useMemo","EditSession","isRpcSuccess","sessionDataSource"],"mappings":";;;;;;;;AA2BO,MAAM,mBAAmB,CAAC;AAAA,EAC/B,OAAA;AAAA,EACA,UAAY,EAAA,cAAA;AAAA,EACZ,UAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAA8B,KAAA;AAC5B,EAAM,MAAA,EAAE,aAAc,EAAA,GAAIA,oBAAQ,EAAA;AAClC,EAAA,MAAM,CAAC,iBAAA,EAAmB,oBAAoB,CAAA,GAAIC,eAEhD,KAAS,CAAA,CAAA;AAEX,EAAM,MAAA,sBAAA,GAAyBC,kBAAY,MAAM;AAC/C,IAAA,oBAAA,CAAqB,CAACC,WAAe,KAAA;AACnC,MAAAA,aAAY,WAAY,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA;AAAA,KACR,CAAA;AAAA,GACH,EAAG,EAAE,CAAA;AAEL,EAAAC,iDAAA,CAAyB,MAAM;AAC7B,IAAA,OAAA,CAAQ,KAAK,CAAiD,+CAAA,CAAA,CAAA;AAAA,GAC7D,EAAA,CAAC,OAAS,EAAA,KAAK,CAAC,CAAA;AAEnB,EAAM,MAAA,UAAA,GAAaC,cAAQ,MAAM;AAG/B,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAO,OAAA,cAAA;AAAA,eACE,KAAO,EAAA;AAChB,MAAA,OAAO,IAAI,aAAA,CAAc,EAAE,OAAA,EAAS,OAAO,CAAA;AAAA,KACtC,MAAA;AACL,MAAM,MAAA,KAAA;AAAA,QACJ,CAAA,8FAAA;AAAA,OACF;AAAA;AACF,KACC,CAAC,aAAA,EAAe,OAAS,EAAA,cAAA,EAAgB,KAAK,CAAC,CAAA;AAIlD,EAAA,MAAM,cAAcA,aAAQ,CAAA,MAAM,IAAIC,uBAAY,EAAA,EAAG,EAAE,CAAA;AAEvD,EAAAD,aAAA,CAAQ,MAAM;AACZ,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,WAAA,CAAY,UAAa,GAAA,UAAA;AAAA;AAC3B,GACC,EAAA,CAAC,UAAY,EAAA,WAAW,CAAC,CAAA;AAE5B,EAAM,MAAA,YAAA,GAAeH,kBAAY,MAAM;AAErC,IAAA,WAAA,CAAY,aAAc,EAAA;AAC1B,IAAS,QAAA,EAAA;AACT,IAAuB,sBAAA,EAAA;AACvB,IAAA,UAAA,CAAW,MAAS,IAAA;AAAA,KACnB,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,QAAQ,CAAC,CAAA;AAE9D,EAAM,MAAA,UAAA,GAAaA,kBAAY,YAAY;AACzC,IAAA,UAAA,CAAW,MAAS,IAAA;AACpB,IAAM,MAAA,QAAA,GAAW,MAAM,WAAA,CAAY,WAAY,EAAA;AAC/C,IAAI,IAAAK,iCAAA,CAAa,QAAQ,CAAG,EAAA;AAC1B,MAAO,MAAA,EAAA;AACP,MAAuB,sBAAA,EAAA;AAAA;AACzB,KACC,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,MAAM,CAAC,CAAA;AAE5D,EAAAF,aAAA,CAAQ,YAAY;AAClB,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,YAAA,GAAe,MAAM,WAAA,CAAY,aAAc,EAAA;AACrD,MAAI,IAAA,YAAA,IAAgB,WAAW,WAAa,EAAA;AAE1C,QAAMG,MAAAA,kBAAAA,GAAoB,IAAI,aAAc,CAAA;AAAA,UAC1C,SAAS,UAAW,CAAA,OAAA;AAAA,UACpB,KAAO,EAAA,YAAA;AAAA,UACP,UAAU,YAAa,CAAA;AAAA,SACxB,CAAA;AACD,QAAA,oBAAA,CAAqBA,kBAAiB,CAAA;AACtC,QAAA,WAAA,CAAY,UAAaA,GAAAA,kBAAAA;AAAA;AAC3B;AACF,KACC,CAAC,aAAA,EAAe,UAAY,EAAA,WAAA,EAAa,UAAU,CAAC,CAAA;AAEvD,EAAO,OAAA;AAAA;AAAA,IAEL,YAAY,iBAAqB,IAAA,UAAA;AAAA,IACjC,WAAA;AAAA,IACA,QAAU,EAAA,YAAA;AAAA,IACV,MAAQ,EAAA;AAAA,GACV;AACF;;;;"}

package/cjs/packages/vuu-utils/src/form-utils.js

@@ -7,6 +7,18 @@ require('@internationalized/date');
 var htmlUtils = require('./html-utils.js');
 var ScaledDecimal = require('./ScaledDecimal.js');
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+class DataValidationError extends Error {
+  constructor(message, expectedType, actualType) {
+    super(message);
+    __publicField(this, "actualType");
+    __publicField(this, "expectedType");
+    this.actualType = actualType;
+    this.expectedType = expectedType;
+  }
+}
 const getFieldName = (target) => {
   const saltFormField = htmlUtils.queryClosest(target, "[data-field]");
   const fieldName = saltFormField?.dataset.field;
@@ -29,6 +41,16 @@ function getTypedRange([value1, value2], dataType, options) {
     getTypedValue(value2, dataType, false, options)
   ];
 }
+const getActualType = (value) => {
+  if (typeof value === "boolean") {
+    return "boolean";
+  } else if (typeof value === "number") {
+    return "number";
+  } else if (typeof value === "string") {
+    return "string";
+  }
+  return "string";
+};
 function getTypedValue(value, type, throwIfInvalid = false, options) {
   switch (type) {
     case "int":
@@ -56,7 +78,11 @@ function getTypedValue(value, type, throwIfInvalid = false, options) {
       if (dataUtils.stringIsValidDecimal(value)) {
         return parseFloat(value);
       } else if (throwIfInvalid) {
-        throw Error(`value ${value} is not a valid ${type}`);
+        throw new DataValidationError(
+          `value ${value} is not a valid ${type}`,
+          "decimal",
+          getActualType(value)
+        );
       } else {
         return void 0;
       }
@@ -82,6 +108,7 @@ function getTypedValue(value, type, throwIfInvalid = false, options) {
   }
 }
 
+exports.DataValidationError = DataValidationError;
 exports.getFieldName = getFieldName;
 exports.getTypedRange = getTypedRange;
 exports.getTypedValue = getTypedValue;

package/cjs/packages/vuu-utils/src/form-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-utils.js","sources":["../../../../../../packages/vuu-utils/src/form-utils.ts"],"sourcesContent":["import { DataValueTypeSimple } from \"@vuu-ui/vuu-data-types\";\nimport {\n  VuuColumnDataType,\n  VuuRowDataItemType,\n} from \"@vuu-ui/vuu-protocol-types\";\nimport { KeyboardEvent, SyntheticEvent } from \"react\";\nimport { stringIsValidDecimal, stringIsValidInt } from \"./data-utils\";\nimport { isValidTimeString, Time } from \"./date\";\nimport { queryClosest } from \"./html-utils\";\nimport { ExtendedFilterOptions } from \"@vuu-ui/vuu-filter-types\";\nimport {\n  type ScaledDecimal,\n  ScaledDecimal2,\n  ScaledDecimal4,\n  ScaledDecimal6,\n  ScaledDecimal8,\n} from \"./ScaledDecimal\";\n\n/**\n * Use with the following convention:\n *\n * <FormField data-field=\"my-field-name\">\n */\nexport const getFieldName = (target: EventTarget | HTMLElement): string => {\n  const saltFormField = queryClosest(target, \"[data-field]\") as HTMLElement;\n  const fieldName = saltFormField?.dataset.field;\n  if (fieldName) {\n    return fieldName;\n  } else {\n    throw Error(\"named form field not found\");\n  }\n};\n\nexport type InputSource = \"typeahead-suggestion\" | \"text-input\";\n\nexport const isNumber = (\n  type: string,\n  value: VuuRowDataItemType,\n): value is number => type === \"number\";\n\nexport type CommitHandler<\n  E extends HTMLElement = HTMLInputElement,\n  T = VuuRowDataItemType,\n> = (\n  evt: SyntheticEvent<E> | KeyboardEvent<E>,\n  value: T,\n  source?: InputSource,\n) => void;\n\nexport const isValidRange = <T>([val1, val2]: [T, T]) => {\n  if (isValidTimeString(val1) && isValidTimeString(val2)) {\n    return val2 > val1;\n  }\n  return true;\n};\n\n/**\n * Convert a pair of string values to the type appropriate for the\n * associated column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n */\nexport function getTypedRange(\n  [value1, value2]: [string, string],\n  dataType: VuuColumnDataType | DataValueTypeSimple,\n  options?: ExtendedFilterOptions,\n) {\n  return [\n    getTypedValue(value1, dataType, false, options),\n    getTypedValue(value2, dataType, false, options),\n  ];\n}\n\n/**\n * Convert a string value to the type appropriate for the associated\n * column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n * @param value\n * @param type\n * @param throwIfInvalid\n */\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid?: false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | undefined;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid: true,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid = false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | ScaledDecimal | undefined {\n  switch (type) {\n    case \"int\":\n    case \"long\": {\n      if (stringIsValidInt(value)) {\n        return parseInt(value, 10);\n      } else if (isValidTimeString(value)) {\n        //TOCHECK\n        return value;\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"scaleddecimal2\":\n      return ScaledDecimal2(value);\n    case \"scaleddecimal4\":\n      return ScaledDecimal4(value);\n    case \"scaleddecimal6\":\n      return ScaledDecimal6(value);\n    case \"scaleddecimal8\":\n      return ScaledDecimal8(value);\n    case \"double\":\n    case \"number\": {\n      if (stringIsValidDecimal(value)) {\n        return parseFloat(value);\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"boolean\":\n      return value === \"true\" ? true : false;\n\n    case \"time\":\n      if (isValidTimeString(value)) {\n        // We don't manipulate the values of 'extended' filters, the\n        // ExtendedFilter impementation will do that.\n        if (options?.type === \"TimeString\") {\n          return value;\n        } else {\n          return +Time(value).asDate();\n        }\n      } else if (value.length > 0 && Time.isDateInMillis(value)) {\n        //if value previously converted\n        return Number(value);\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    default:\n      return value;\n  }\n}\n"],"names":["queryClosest","isValidTimeString","stringIsValidInt","ScaledDecimal2","ScaledDecimal4","ScaledDecimal6","ScaledDecimal8","stringIsValidDecimal","Time"],"mappings":";;;;;;;;;AAuBa,MAAA,YAAA,GAAe,CAAC,MAA8C,KAAA;AACzE,EAAM,MAAA,aAAA,GAAgBA,sBAAa,CAAA,MAAA,EAAQ,cAAc,CAAA;AACzD,EAAM,MAAA,SAAA,GAAY,eAAe,OAAQ,CAAA,KAAA;AACzC,EAAA,IAAI,SAAW,EAAA;AACb,IAAO,OAAA,SAAA;AAAA,GACF,MAAA;AACL,IAAA,MAAM,MAAM,4BAA4B,CAAA;AAAA;AAE5C;AAIO,MAAM,QAAW,GAAA,CACtB,IACA,EAAA,KAAA,KACoB,IAAS,KAAA;AAWxB,MAAM,YAAe,GAAA,CAAI,CAAC,IAAA,EAAM,IAAI,CAAc,KAAA;AACvD,EAAA,IAAIC,2BAAkB,CAAA,IAAI,CAAK,IAAAA,2BAAA,CAAkB,IAAI,CAAG,EAAA;AACtD,IAAA,OAAO,IAAO,GAAA,IAAA;AAAA;AAEhB,EAAO,OAAA,IAAA;AACT;AAQO,SAAS,cACd,CAAC,MAAA,EAAQ,MAAM,CAAA,EACf,UACA,OACA,EAAA;AACA,EAAO,OAAA;AAAA,IACL,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO,CAAA;AAAA,IAC9C,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO;AAAA,GAChD;AACF;AAuBO,SAAS,aACd,CAAA,KAAA,EACA,IACA,EAAA,cAAA,GAAiB,OACjB,OACgD,EAAA;AAChD,EAAA,QAAQ,IAAM;AAAA,IACZ,KAAK,KAAA;AAAA,IACL,KAAK,MAAQ,EAAA;AACX,MAAI,IAAAC,0BAAA,CAAiB,KAAK,CAAG,EAAA;AAC3B,QAAO,OAAA,QAAA,CAAS,OAAO,EAAE,CAAA;AAAA,OAC3B,MAAA,IAAWD,2BAAkB,CAAA,KAAK,CAAG,EAAA;AAEnC,QAAO,OAAA,KAAA;AAAA,iBACE,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,gBAAA;AACH,MAAA,OAAOE,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAOC,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAOC,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAOC,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,QAAA;AAAA,IACL,KAAK,QAAU,EAAA;AACb,MAAI,IAAAC,8BAAA,CAAqB,KAAK,CAAG,EAAA;AAC/B,QAAA,OAAO,WAAW,KAAK,CAAA;AAAA,iBACd,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,SAAA;AACH,MAAO,OAAA,KAAA,KAAU,SAAS,IAAO,GAAA,KAAA;AAAA,IAEnC,KAAK,MAAA;AACH,MAAI,IAAAN,2BAAA,CAAkB,KAAK,CAAG,EAAA;AAG5B,QAAI,IAAA,OAAA,EAAS,SAAS,YAAc,EAAA;AAClC,UAAO,OAAA,KAAA;AAAA,SACF,MAAA;AACL,UAAA,OAAO,CAACO,cAAA,CAAK,KAAK,CAAA,CAAE,MAAO,EAAA;AAAA;AAC7B,iBACS,KAAM,CAAA,MAAA,GAAS,KAAKA,cAAK,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAEzD,QAAA,OAAO,OAAO,KAAK,CAAA;AAAA,iBACV,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT,IACF;AACE,MAAO,OAAA,KAAA;AAAA;AAEb;;;;;;;;"}
+{"version":3,"file":"form-utils.js","sources":["../../../../../../packages/vuu-utils/src/form-utils.ts"],"sourcesContent":["import { DataValueTypeSimple } from \"@vuu-ui/vuu-data-types\";\nimport {\n  VuuColumnDataType,\n  VuuRowDataItemType,\n} from \"@vuu-ui/vuu-protocol-types\";\nimport { KeyboardEvent, SyntheticEvent } from \"react\";\nimport { stringIsValidDecimal, stringIsValidInt } from \"./data-utils\";\nimport { isValidTimeString, Time } from \"./date\";\nimport { queryClosest } from \"./html-utils\";\nimport { ExtendedFilterOptions } from \"@vuu-ui/vuu-filter-types\";\nimport {\n  type ScaledDecimal,\n  ScaledDecimal2,\n  ScaledDecimal4,\n  ScaledDecimal6,\n  ScaledDecimal8,\n} from \"./ScaledDecimal\";\n\nexport class DataValidationError extends Error {\n  actualType: string;\n  expectedType: string;\n  constructor(message: string, expectedType: string, actualType: string) {\n    super(message);\n    this.actualType = actualType;\n    this.expectedType = expectedType;\n  }\n}\n\n/**\n * Use with the following convention:\n *\n * <FormField data-field=\"my-field-name\">\n */\nexport const getFieldName = (target: EventTarget | HTMLElement): string => {\n  const saltFormField = queryClosest(target, \"[data-field]\") as HTMLElement;\n  const fieldName = saltFormField?.dataset.field;\n  if (fieldName) {\n    return fieldName;\n  } else {\n    throw Error(\"named form field not found\");\n  }\n};\n\nexport type InputSource = \"typeahead-suggestion\" | \"text-input\";\n\nexport const isNumber = (\n  type: string,\n  value: VuuRowDataItemType,\n): value is number => type === \"number\";\n\nexport type CommitHandler<\n  E extends HTMLElement = HTMLInputElement,\n  T = VuuRowDataItemType,\n> = (\n  evt: SyntheticEvent<E> | KeyboardEvent<E>,\n  value: T,\n  source?: InputSource,\n) => void;\n\nexport const isValidRange = <T>([val1, val2]: [T, T]) => {\n  if (isValidTimeString(val1) && isValidTimeString(val2)) {\n    return val2 > val1;\n  }\n  return true;\n};\n\n/**\n * Convert a pair of string values to the type appropriate for the\n * associated column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n */\nexport function getTypedRange(\n  [value1, value2]: [string, string],\n  dataType: VuuColumnDataType | DataValueTypeSimple,\n  options?: ExtendedFilterOptions,\n) {\n  return [\n    getTypedValue(value1, dataType, false, options),\n    getTypedValue(value2, dataType, false, options),\n  ];\n}\n\nconst getActualType = (\n  value: string | number | boolean,\n): \"string\" | \"number\" | \"boolean\" => {\n  if (typeof value === \"boolean\") {\n    return \"boolean\";\n  } else if (typeof value === \"number\") {\n    return \"number\";\n  } else if (typeof value === \"string\") {\n    return \"string\";\n  }\n  return \"string\";\n};\n\n/**\n * Convert a string value to the type appropriate for the associated\n * column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n * @param value\n * @param type\n * @param throwIfInvalid\n */\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid?: false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | undefined;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid: true,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid = false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | ScaledDecimal | undefined {\n  switch (type) {\n    case \"int\":\n    case \"long\": {\n      if (stringIsValidInt(value)) {\n        return parseInt(value, 10);\n      } else if (isValidTimeString(value)) {\n        //TOCHECK\n        return value;\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"scaleddecimal2\":\n      return ScaledDecimal2(value);\n    case \"scaleddecimal4\":\n      return ScaledDecimal4(value);\n    case \"scaleddecimal6\":\n      return ScaledDecimal6(value);\n    case \"scaleddecimal8\":\n      return ScaledDecimal8(value);\n    case \"double\":\n    case \"number\": {\n      if (stringIsValidDecimal(value)) {\n        return parseFloat(value);\n      } else if (throwIfInvalid) {\n        throw new DataValidationError(\n          `value ${value} is not a valid ${type}`,\n          \"decimal\",\n          getActualType(value),\n        );\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"boolean\":\n      return value === \"true\" ? true : false;\n\n    case \"time\":\n      if (isValidTimeString(value)) {\n        // We don't manipulate the values of 'extended' filters, the\n        // ExtendedFilter impementation will do that.\n        if (options?.type === \"TimeString\") {\n          return value;\n        } else {\n          return +Time(value).asDate();\n        }\n      } else if (value.length > 0 && Time.isDateInMillis(value)) {\n        //if value previously converted\n        return Number(value);\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    default:\n      return value;\n  }\n}\n"],"names":["queryClosest","isValidTimeString","stringIsValidInt","ScaledDecimal2","ScaledDecimal4","ScaledDecimal6","ScaledDecimal8","stringIsValidDecimal","Time"],"mappings":";;;;;;;;;;;;AAkBO,MAAM,4BAA4B,KAAM,CAAA;AAAA,EAG7C,WAAA,CAAY,OAAiB,EAAA,YAAA,EAAsB,UAAoB,EAAA;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AAHf,IAAA,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA;AACA,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA;AAGE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA;AAAA;AAExB;AAOa,MAAA,YAAA,GAAe,CAAC,MAA8C,KAAA;AACzE,EAAM,MAAA,aAAA,GAAgBA,sBAAa,CAAA,MAAA,EAAQ,cAAc,CAAA;AACzD,EAAM,MAAA,SAAA,GAAY,eAAe,OAAQ,CAAA,KAAA;AACzC,EAAA,IAAI,SAAW,EAAA;AACb,IAAO,OAAA,SAAA;AAAA,GACF,MAAA;AACL,IAAA,MAAM,MAAM,4BAA4B,CAAA;AAAA;AAE5C;AAIO,MAAM,QAAW,GAAA,CACtB,IACA,EAAA,KAAA,KACoB,IAAS,KAAA;AAWxB,MAAM,YAAe,GAAA,CAAI,CAAC,IAAA,EAAM,IAAI,CAAc,KAAA;AACvD,EAAA,IAAIC,2BAAkB,CAAA,IAAI,CAAK,IAAAA,2BAAA,CAAkB,IAAI,CAAG,EAAA;AACtD,IAAA,OAAO,IAAO,GAAA,IAAA;AAAA;AAEhB,EAAO,OAAA,IAAA;AACT;AAQO,SAAS,cACd,CAAC,MAAA,EAAQ,MAAM,CAAA,EACf,UACA,OACA,EAAA;AACA,EAAO,OAAA;AAAA,IACL,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO,CAAA;AAAA,IAC9C,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO;AAAA,GAChD;AACF;AAEA,MAAM,aAAA,GAAgB,CACpB,KACoC,KAAA;AACpC,EAAI,IAAA,OAAO,UAAU,SAAW,EAAA;AAC9B,IAAO,OAAA,SAAA;AAAA,GACT,MAAA,IAAW,OAAO,KAAA,KAAU,QAAU,EAAA;AACpC,IAAO,OAAA,QAAA;AAAA,GACT,MAAA,IAAW,OAAO,KAAA,KAAU,QAAU,EAAA;AACpC,IAAO,OAAA,QAAA;AAAA;AAET,EAAO,OAAA,QAAA;AACT,CAAA;AAuBO,SAAS,aACd,CAAA,KAAA,EACA,IACA,EAAA,cAAA,GAAiB,OACjB,OACgD,EAAA;AAChD,EAAA,QAAQ,IAAM;AAAA,IACZ,KAAK,KAAA;AAAA,IACL,KAAK,MAAQ,EAAA;AACX,MAAI,IAAAC,0BAAA,CAAiB,KAAK,CAAG,EAAA;AAC3B,QAAO,OAAA,QAAA,CAAS,OAAO,EAAE,CAAA;AAAA,OAC3B,MAAA,IAAWD,2BAAkB,CAAA,KAAK,CAAG,EAAA;AAEnC,QAAO,OAAA,KAAA;AAAA,iBACE,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,gBAAA;AACH,MAAA,OAAOE,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAOC,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAOC,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAOC,6BAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,QAAA;AAAA,IACL,KAAK,QAAU,EAAA;AACb,MAAI,IAAAC,8BAAA,CAAqB,KAAK,CAAG,EAAA;AAC/B,QAAA,OAAO,WAAW,KAAK,CAAA;AAAA,iBACd,cAAgB,EAAA;AACzB,QAAA,MAAM,IAAI,mBAAA;AAAA,UACR,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAA,CAAA;AAAA,UACrC,SAAA;AAAA,UACA,cAAc,KAAK;AAAA,SACrB;AAAA,OACK,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,SAAA;AACH,MAAO,OAAA,KAAA,KAAU,SAAS,IAAO,GAAA,KAAA;AAAA,IAEnC,KAAK,MAAA;AACH,MAAI,IAAAN,2BAAA,CAAkB,KAAK,CAAG,EAAA;AAG5B,QAAI,IAAA,OAAA,EAAS,SAAS,YAAc,EAAA;AAClC,UAAO,OAAA,KAAA;AAAA,SACF,MAAA;AACL,UAAA,OAAO,CAACO,cAAA,CAAK,KAAK,CAAA,CAAE,MAAO,EAAA;AAAA;AAC7B,iBACS,KAAM,CAAA,MAAA,GAAS,KAAKA,cAAK,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAEzD,QAAA,OAAO,OAAO,KAAK,CAAA;AAAA,iBACV,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT,IACF;AACE,MAAO,OAAA,KAAA;AAAA;AAEb;;;;;;;;;"}

package/cjs/packages/vuu-utils/src/index.js

@@ -14,7 +14,7 @@ var cookieUtils = require('./cookie-utils.js');
 var cssUtils = require('./css-utils.js');
 var EditButtons = require('./data-editing/EditButtons.js');
 var DataEditingProvider = require('./data-editing/DataEditingProvider.js');
-var EditTracker = require('./data-editing/EditTracker.js');
+var EditSession = require('./data-editing/EditSession.js');
 var useEditableTable = require('./data-editing/useEditableTable.js');
 var dataUtils = require('./data-utils.js');
 var BaseDataSource = require('./datasource/BaseDataSource.js');
@@ -205,8 +205,8 @@ exports.setCookieValue = cookieUtils.setCookieValue;
 exports.importCSS = cssUtils.importCSS;
 exports.EditButtons = EditButtons.EditButtons;
 exports.DataEditingProvider = DataEditingProvider.DataEditingProvider;
-exports.useEditTracker = DataEditingProvider.useEditTracker;
-exports.EditTracker = EditTracker.EditTracker;
+exports.useEditSession = DataEditingProvider.useEditSession;
+exports.EditSession = EditSession.EditSession;
 exports.useEditableTable = useEditableTable.useEditableTable;
 exports.DOWN1 = dataUtils.DOWN1;
 exports.DOWN2 = dataUtils.DOWN2;
@@ -310,6 +310,7 @@ exports.stripFilterFromColumns = filterUtils.stripFilterFromColumns;
 exports.ONE_DAY_IN_MILLIS = filterAsQuery.ONE_DAY_IN_MILLIS;
 exports.dateFilterAsQuery = filterAsQuery.dateFilterAsQuery;
 exports.filterAsQuery = filterAsQuery.filterAsQuery;
+exports.DataValidationError = formUtils.DataValidationError;
 exports.getFieldName = formUtils.getFieldName;
 exports.getTypedRange = formUtils.getTypedRange;
 exports.getTypedValue = formUtils.getTypedValue;

package/cjs/packages/vuu-utils/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

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

@@ -4,22 +4,22 @@ import { createContext, useContext } from 'react';
 const DataEditingContext = createContext(void 0);
 const DataEditingProvider = ({
   children,
-  editTracker
+  editSession
 }) => {
-  return /* @__PURE__ */ jsx(DataEditingContext.Provider, { value: editTracker, children });
+  return /* @__PURE__ */ jsx(DataEditingContext.Provider, { value: editSession, children });
 };
-function useEditTracker(throwIfUnavailable = false) {
-  const editTracker = useContext(DataEditingContext);
-  if (editTracker === void 0) {
+function useEditSession(throwIfUnavailable = false) {
+  const editSession = useContext(DataEditingContext);
+  if (editSession === void 0) {
     if (throwIfUnavailable) {
       throw Error(
-        "[useEditTracker] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider"
+        "[useEditSession] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider"
       );
     }
   } else {
-    return editTracker;
+    return editSession;
   }
 }
 
-export { DataEditingProvider, useEditTracker };
+export { DataEditingProvider, useEditSession };
 //# sourceMappingURL=DataEditingProvider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"DataEditingProvider.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/DataEditingProvider.tsx"],"sourcesContent":["import { createContext, ReactNode, useContext } from \"react\";\nimport { EditTracker } from \"./EditTracker\";\n\nconst DataEditingContext = createContext<EditTracker | undefined>(undefined);\n\nexport const DataEditingProvider = ({\n  children,\n  editTracker,\n}: {\n  children: ReactNode;\n  editTracker: EditTracker;\n}) => {\n  return (\n    <DataEditingContext.Provider value={editTracker}>\n      {children}\n    </DataEditingContext.Provider>\n  );\n};\n\nexport function useEditTracker(\n  throwIfUnavailable?: false,\n): EditTracker | undefined;\nexport function useEditTracker(throwIfUnavailable: true): EditTracker;\nexport function useEditTracker(throwIfUnavailable = false) {\n  const editTracker = useContext(DataEditingContext);\n  if (editTracker === undefined) {\n    if (throwIfUnavailable) {\n      throw Error(\n        \"[useEditTracker] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider\",\n      );\n    }\n  } else {\n    return editTracker;\n  }\n}\n"],"names":[],"mappings":";;;AAGA,MAAM,kBAAA,GAAqB,cAAuC,KAAS,CAAA,CAAA;AAEpE,MAAM,sBAAsB,CAAC;AAAA,EAClC,QAAA;AAAA,EACA;AACF,CAGM,KAAA;AACJ,EAAA,2BACG,kBAAmB,CAAA,QAAA,EAAnB,EAA4B,KAAA,EAAO,aACjC,QACH,EAAA,CAAA;AAEJ;AAMgB,SAAA,cAAA,CAAe,qBAAqB,KAAO,EAAA;AACzD,EAAM,MAAA,WAAA,GAAc,WAAW,kBAAkB,CAAA;AACjD,EAAA,IAAI,gBAAgB,KAAW,CAAA,EAAA;AAC7B,IAAA,IAAI,kBAAoB,EAAA;AACtB,MAAM,MAAA,KAAA;AAAA,QACJ;AAAA,OACF;AAAA;AACF,GACK,MAAA;AACL,IAAO,OAAA,WAAA;AAAA;AAEX;;;;"}
+{"version":3,"file":"DataEditingProvider.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/DataEditingProvider.tsx"],"sourcesContent":["import { createContext, ReactNode, useContext } from \"react\";\nimport { EditSession } from \"./EditSession\";\n\nconst DataEditingContext = createContext<EditSession | undefined>(undefined);\n\nexport const DataEditingProvider = ({\n  children,\n  editSession,\n}: {\n  children: ReactNode;\n  editSession: EditSession;\n}) => {\n  return (\n    <DataEditingContext.Provider value={editSession}>\n      {children}\n    </DataEditingContext.Provider>\n  );\n};\n\nexport function useEditSession(\n  throwIfUnavailable?: false,\n): EditSession | undefined;\nexport function useEditSession(throwIfUnavailable: true): EditSession;\nexport function useEditSession(throwIfUnavailable = false) {\n  const editSession = useContext(DataEditingContext);\n  if (editSession === undefined) {\n    if (throwIfUnavailable) {\n      throw Error(\n        \"[useEditSession] no DataEditingContext in scope. You need to enclose editable component(s) with DataEditingProvider\",\n      );\n    }\n  } else {\n    return editSession;\n  }\n}\n"],"names":[],"mappings":";;;AAGA,MAAM,kBAAA,GAAqB,cAAuC,KAAS,CAAA,CAAA;AAEpE,MAAM,sBAAsB,CAAC;AAAA,EAClC,QAAA;AAAA,EACA;AACF,CAGM,KAAA;AACJ,EAAA,2BACG,kBAAmB,CAAA,QAAA,EAAnB,EAA4B,KAAA,EAAO,aACjC,QACH,EAAA,CAAA;AAEJ;AAMgB,SAAA,cAAA,CAAe,qBAAqB,KAAO,EAAA;AACzD,EAAM,MAAA,WAAA,GAAc,WAAW,kBAAkB,CAAA;AACjD,EAAA,IAAI,gBAAgB,KAAW,CAAA,EAAA;AAC7B,IAAA,IAAI,kBAAoB,EAAA;AACtB,MAAM,MAAA,KAAA;AAAA,QACJ;AAAA,OACF;AAAA;AACF,GACK,MAAA;AACL,IAAO,OAAA,WAAA;AAAA;AAEX;;;;"}

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

@@ -3,14 +3,14 @@ import { Button } from '@salt-ds/core';
 import { useState, useMemo } from 'react';
 
 const EditButtons = ({
-  editTracker,
+  editSession,
   onCancel,
   onSave
 }) => {
   const [editState, setEditState] = useState("clean");
   useMemo(() => {
-    editTracker?.on("editState", setEditState);
-  }, [editTracker]);
+    editSession?.on("editState", setEditState);
+  }, [editSession]);
   return /* @__PURE__ */ jsxs(Fragment, { children: [
     /* @__PURE__ */ jsx(
       Button,

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

@@ -1 +1 @@
-{"version":3,"file":"EditButtons.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditButtons.tsx"],"sourcesContent":["import { Button } from \"@salt-ds/core\";\nimport { EditState, EditTracker } from \"./EditTracker\";\nimport { useMemo, useState } from \"react\";\n\nexport interface EditButtonProps {\n  editTracker?: EditTracker;\n  onCancel: () => void;\n  onSave: () => void;\n}\n\nexport const EditButtons = ({\n  editTracker,\n  onCancel,\n  onSave,\n}: EditButtonProps) => {\n  const [editState, setEditState] = useState<EditState>(\"clean\");\n\n  useMemo(() => {\n    editTracker?.on(\"editState\", setEditState);\n  }, [editTracker]);\n\n  return (\n    <>\n      <Button\n        disabled={editState === \"clean\"}\n        onClick={onSave}\n        sentiment=\"accented\"\n      >\n        Save\n      </Button>\n      <Button onClick={onCancel}>Cancel</Button>\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;AAUO,MAAM,cAAc,CAAC;AAAA,EAC1B,WAAA;AAAA,EACA,QAAA;AAAA,EACA;AACF,CAAuB,KAAA;AACrB,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,CAAA,GAAI,SAAoB,OAAO,CAAA;AAE7D,EAAA,OAAA,CAAQ,MAAM;AACZ,IAAa,WAAA,EAAA,EAAA,CAAG,aAAa,YAAY,CAAA;AAAA,GAC3C,EAAG,CAAC,WAAW,CAAC,CAAA;AAEhB,EAAA,uBAEI,IAAA,CAAA,QAAA,EAAA,EAAA,QAAA,EAAA;AAAA,oBAAA,GAAA;AAAA,MAAC,MAAA;AAAA,MAAA;AAAA,QACC,UAAU,SAAc,KAAA,OAAA;AAAA,QACxB,OAAS,EAAA,MAAA;AAAA,QACT,SAAU,EAAA,UAAA;AAAA,QACX,QAAA,EAAA;AAAA;AAAA,KAED;AAAA,oBACC,GAAA,CAAA,MAAA,EAAA,EAAO,OAAS,EAAA,QAAA,EAAU,QAAM,EAAA,QAAA,EAAA;AAAA,GACnC,EAAA,CAAA;AAEJ;;;;"}
+{"version":3,"file":"EditButtons.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditButtons.tsx"],"sourcesContent":["import { Button } from \"@salt-ds/core\";\nimport { EditState, EditSession } from \"./EditSession\";\nimport { useMemo, useState } from \"react\";\n\nexport interface EditButtonProps {\n  editSession?: EditSession;\n  onCancel: () => void;\n  onSave: () => void;\n}\n\nexport const EditButtons = ({\n  editSession,\n  onCancel,\n  onSave,\n}: EditButtonProps) => {\n  const [editState, setEditState] = useState<EditState>(\"clean\");\n\n  useMemo(() => {\n    editSession?.on(\"editState\", setEditState);\n  }, [editSession]);\n\n  return (\n    <>\n      <Button\n        disabled={editState === \"clean\"}\n        onClick={onSave}\n        sentiment=\"accented\"\n      >\n        Save\n      </Button>\n      <Button onClick={onCancel}>Cancel</Button>\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;AAUO,MAAM,cAAc,CAAC;AAAA,EAC1B,WAAA;AAAA,EACA,QAAA;AAAA,EACA;AACF,CAAuB,KAAA;AACrB,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,CAAA,GAAI,SAAoB,OAAO,CAAA;AAE7D,EAAA,OAAA,CAAQ,MAAM;AACZ,IAAa,WAAA,EAAA,EAAA,CAAG,aAAa,YAAY,CAAA;AAAA,GAC3C,EAAG,CAAC,WAAW,CAAC,CAAA;AAEhB,EAAA,uBAEI,IAAA,CAAA,QAAA,EAAA,EAAA,QAAA,EAAA;AAAA,oBAAA,GAAA;AAAA,MAAC,MAAA;AAAA,MAAA;AAAA,QACC,UAAU,SAAc,KAAA,OAAA;AAAA,QACxB,OAAS,EAAA,MAAA;AAAA,QACT,SAAU,EAAA,UAAA;AAAA,QACX,QAAA,EAAA;AAAA;AAAA,KAED;AAAA,oBACC,GAAA,CAAA,MAAA,EAAA,EAAO,OAAS,EAAA,QAAA,EAAU,QAAM,EAAA,QAAA,EAAA;AAAA,GACnC,EAAA,CAAA;AAEJ;;;;"}

package/esm/packages/vuu-utils/src/data-editing/{EditTracker.js → EditSession.js}

@@ -9,7 +9,7 @@ var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read fr
 var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
 var _active, _rowEdits, _editCount, _dataSource, _inEditMode;
-class EditTracker extends EventEmitter {
+class EditSession extends EventEmitter {
   constructor() {
     super(...arguments);
     __privateAdd(this, _active, false);
@@ -50,11 +50,8 @@ class EditTracker extends EventEmitter {
   }
   async enterEditMode() {
     __privateSet(this, _inEditMode, true);
-    const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "ENTER_EDIT_MODE",
-      params: {}
-    });
+    const rpcResponse = await __privateGet(this, _dataSource)?.beginEditSession?.();
+    console.log({ rpcResponse });
     if (isRpcSuccess(rpcResponse)) {
       const { table: sessionTable } = rpcResponse.data;
       return sessionTable;
@@ -71,7 +68,7 @@ class EditTracker extends EventEmitter {
   async cancelChanges() {
     const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
       type: "RPC_REQUEST",
-      rpcName: "EXIT_EDIT_MODE",
+      rpcName: "endEditSession",
       params: {}
     });
     this.clear();
@@ -80,7 +77,7 @@ class EditTracker extends EventEmitter {
   async saveChanges() {
     const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
       type: "RPC_REQUEST",
-      rpcName: "EXIT_EDIT_MODE",
+      rpcName: "endEditSession",
       params: { save: true }
     });
     this.clear();
@@ -119,22 +116,18 @@ class EditTracker extends EventEmitter {
       this.editCount = __privateGet(this, _editCount) + 1;
     }
   }
-  //TODO alow a shortcut commit that allows a value, bypassing need
-  // for edit. Thids caters for boolean values, dropdown list etc
-  // that have no intermediate edit phase
-  async commit(key, columnName) {
+  async commit(key, columnName, typedValue) {
     const rowEditDetails = __privateGet(this, _rowEdits).get(key);
     if (rowEditDetails) {
       const { cellEdits } = rowEditDetails;
       const cellEditValues = cellEdits.get(columnName);
       if (cellEditValues) {
-        const { editedValue } = cellEditValues;
         const rpcResponse = await __privateGet(this, _dataSource)?.rpcRequest?.({
           type: "RPC_REQUEST",
           rpcName: "editCell",
           params: {
             column: columnName,
-            data: editedValue,
+            data: typedValue,
             key
           }
         });
@@ -154,5 +147,5 @@ _editCount = new WeakMap();
 _dataSource = new WeakMap();
 _inEditMode = new WeakMap();
 
-export { EditTracker };
-//# sourceMappingURL=EditTracker.js.map
+export { EditSession };
+//# sourceMappingURL=EditSession.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EditSession.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/EditSession.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 EditSessionEvents = {\n  editState: (editState: EditState) => void;\n};\n\nexport class EditSession extends EventEmitter<EditSessionEvents> {\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?.beginEditSession?.();\n\n    console.log({ rpcResponse });\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: \"endEditSession\",\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: \"endEditSession\",\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  async commit(\n    key: string,\n    columnName: string,\n    typedValue: string | number | boolean,\n  ) {\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 rpcResponse = await this.#dataSource?.rpcRequest?.({\n          type: \"RPC_REQUEST\",\n          rpcName: \"editCell\",\n          params: {\n            column: columnName,\n            data: typedValue,\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,gBAAmB,IAAA;AAE/D,IAAQ,OAAA,CAAA,GAAA,CAAI,EAAE,WAAA,EAAa,CAAA;AAE3B,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,EAEA,MAAM,MAAA,CACJ,GACA,EAAA,UAAA,EACA,UACA,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,cAAA,GAAiB,SAAU,CAAA,GAAA,CAAI,UAAU,CAAA;AAC/C,MAAA,IAAI,cAAgB,EAAA;AAClB,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,UAAA;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;AAzJE,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/useEditableTable.js

@@ -1,5 +1,5 @@
 import { useState, useCallback, useMemo } from 'react';
-import { EditTracker } from './EditTracker.js';
+import { EditSession } from './EditSession.js';
 import { useData } from '../context-definitions/DataProvider.js';
 import { isRpcSuccess } from '../protocol-message-utils.js';
 import { useLayoutEffectSkipFirst } from '../useLayoutEffectSkipFirst.js';
@@ -24,47 +24,54 @@ const useEditableTable = ({
     console.warn(`[useEditableTable] columns and or table changed`);
   }, [columns, table]);
   const dataSource = useMemo(() => {
-    return dataSourceProp ?? new VuuDataSource({ columns, table });
+    if (dataSourceProp) {
+      return dataSourceProp;
+    } else if (table) {
+      return new VuuDataSource({ columns, table });
+    } else {
+      throw Error(
+        `useEditableTable unable to provide DataSource, neither dataSource nor table available as props`
+      );
+    }
   }, [VuuDataSource, columns, dataSourceProp, table]);
-  const editTracker = useMemo(() => new EditTracker(), []);
+  const editSession = useMemo(() => new EditSession(), []);
   useMemo(() => {
     if (dataSource) {
-      editTracker.dataSource = dataSource;
+      editSession.dataSource = dataSource;
     }
-  }, [dataSource, editTracker]);
+  }, [dataSource, editSession]);
   const handleCancel = useCallback(() => {
-    editTracker.cancelChanges();
+    editSession.cancelChanges();
     onCancel();
     clearSessionDataSource();
     dataSource.resume?.();
-  }, [clearSessionDataSource, dataSource, editTracker, onCancel]);
+  }, [clearSessionDataSource, dataSource, editSession, onCancel]);
   const handleSave = useCallback(async () => {
     dataSource.resume?.();
-    const response = await editTracker.saveChanges();
+    const response = await editSession.saveChanges();
     if (isRpcSuccess(response)) {
       onSave();
       clearSessionDataSource();
     }
-  }, [clearSessionDataSource, dataSource, editTracker, onSave]);
+  }, [clearSessionDataSource, dataSource, editSession, onSave]);
   useMemo(async () => {
     if (isEditMode) {
-      const sessionTable = await editTracker.enterEditMode();
+      const sessionTable = await editSession.enterEditMode();
       if (sessionTable && dataSource.tableSchema) {
-        dataSource.suspend?.(false);
         const sessionDataSource2 = new VuuDataSource({
           columns: dataSource.columns,
           table: sessionTable,
           viewport: sessionTable.table
         });
         setSessionDataSource(sessionDataSource2);
-        editTracker.dataSource = sessionDataSource2;
+        editSession.dataSource = sessionDataSource2;
       }
     }
-  }, [VuuDataSource, dataSource, editTracker, isEditMode]);
+  }, [VuuDataSource, dataSource, editSession, isEditMode]);
   return {
     // DO we need to reset the dataSource or could useDataSOurce detect the sessiondataSOurce from the editSession ?
     dataSource: sessionDataSource ?? dataSource,
-    editTracker,
+    editSession,
     onCancel: handleCancel,
     onSave: handleSave
   };

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

@@ -1 +1 @@
-{"version":3,"file":"useEditableTable.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/useEditableTable.ts"],"sourcesContent":["import { VuuTable } from \"@vuu-ui/vuu-protocol-types\";\nimport { useCallback, useMemo, useState } from \"react\";\nimport { EditTracker } from \"./EditTracker\";\nimport { useData } from \"../context-definitions/DataProvider\";\nimport { DataSource } from \"@vuu-ui/vuu-data-types\";\nimport { isRpcSuccess } from \"../protocol-message-utils\";\nimport { useLayoutEffectSkipFirst } from \"../useLayoutEffectSkipFirst\";\n\nexport type EditMode = \"edit\" | \"view\";\n\nexport interface EditableTableHookProps {\n  /**\n   * columns to be included in subscription. If not provided,\n   * default will be '*'. Ignored if dataSource prop present.\n   */\n  columns?: string[];\n  dataSource?: DataSource;\n  isEditMode: boolean;\n  onCancel: () => void;\n  onSave: () => void;\n  /**\n   * If dataSource not provided, new DataSource\n   * will be created using table and columns\n   */\n  table: VuuTable;\n}\n\nexport const useEditableTable = ({\n  columns,\n  dataSource: dataSourceProp,\n  isEditMode,\n  onCancel,\n  onSave,\n  table,\n}: EditableTableHookProps) => {\n  const { VuuDataSource } = useData();\n  const [sessionDataSource, setSessionDataSource] = useState<\n    DataSource | undefined\n  >(undefined);\n\n  const clearSessionDataSource = useCallback(() => {\n    setSessionDataSource((dataSource) => {\n      dataSource?.unsubscribe();\n      return undefined;\n    });\n  }, []);\n\n  useLayoutEffectSkipFirst(() => {\n    console.warn(`[useEditableTable] columns and or table changed`);\n  }, [columns, table]);\n\n  const dataSource = useMemo(() => {\n    return dataSourceProp ?? new VuuDataSource({ columns, table });\n  }, [VuuDataSource, columns, dataSourceProp, table]);\n\n  const editTracker = useMemo(() => new EditTracker(), []);\n\n  useMemo(() => {\n    if (dataSource) {\n      editTracker.dataSource = dataSource;\n    }\n  }, [dataSource, editTracker]);\n\n  const handleCancel = useCallback(() => {\n    // editTracker.dataSource = dataSource;\n    editTracker.cancelChanges();\n    onCancel();\n    clearSessionDataSource();\n    dataSource.resume?.();\n  }, [clearSessionDataSource, dataSource, editTracker, onCancel]);\n\n  const handleSave = useCallback(async () => {\n    dataSource.resume?.();\n    const response = await editTracker.saveChanges();\n    if (isRpcSuccess(response)) {\n      onSave();\n      clearSessionDataSource();\n    }\n  }, [clearSessionDataSource, dataSource, editTracker, onSave]);\n\n  useMemo(async () => {\n    if (isEditMode) {\n      const sessionTable = await editTracker.enterEditMode();\n      if (sessionTable && dataSource.tableSchema) {\n        dataSource.suspend?.(false);\n        const sessionDataSource = new VuuDataSource({\n          columns: dataSource.columns,\n          table: sessionTable,\n          viewport: sessionTable.table,\n        });\n        setSessionDataSource(sessionDataSource);\n        editTracker.dataSource = sessionDataSource;\n      }\n    }\n  }, [VuuDataSource, dataSource, editTracker, isEditMode]);\n\n  return {\n    // DO we need to reset the dataSource or could useDataSOurce detect the sessiondataSOurce from the editSession ?\n    dataSource: sessionDataSource ?? dataSource,\n    editTracker,\n    onCancel: handleCancel,\n    onSave: handleSave,\n  };\n};\n"],"names":["dataSource","sessionDataSource"],"mappings":";;;;;;AA2BO,MAAM,mBAAmB,CAAC;AAAA,EAC/B,OAAA;AAAA,EACA,UAAY,EAAA,cAAA;AAAA,EACZ,UAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAA8B,KAAA;AAC5B,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,OAAQ,EAAA;AAClC,EAAA,MAAM,CAAC,iBAAA,EAAmB,oBAAoB,CAAA,GAAI,SAEhD,KAAS,CAAA,CAAA;AAEX,EAAM,MAAA,sBAAA,GAAyB,YAAY,MAAM;AAC/C,IAAA,oBAAA,CAAqB,CAACA,WAAe,KAAA;AACnC,MAAAA,aAAY,WAAY,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA;AAAA,KACR,CAAA;AAAA,GACH,EAAG,EAAE,CAAA;AAEL,EAAA,wBAAA,CAAyB,MAAM;AAC7B,IAAA,OAAA,CAAQ,KAAK,CAAiD,+CAAA,CAAA,CAAA;AAAA,GAC7D,EAAA,CAAC,OAAS,EAAA,KAAK,CAAC,CAAA;AAEnB,EAAM,MAAA,UAAA,GAAa,QAAQ,MAAM;AAC/B,IAAA,OAAO,kBAAkB,IAAI,aAAA,CAAc,EAAE,OAAA,EAAS,OAAO,CAAA;AAAA,KAC5D,CAAC,aAAA,EAAe,OAAS,EAAA,cAAA,EAAgB,KAAK,CAAC,CAAA;AAElD,EAAA,MAAM,cAAc,OAAQ,CAAA,MAAM,IAAI,WAAY,EAAA,EAAG,EAAE,CAAA;AAEvD,EAAA,OAAA,CAAQ,MAAM;AACZ,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,WAAA,CAAY,UAAa,GAAA,UAAA;AAAA;AAC3B,GACC,EAAA,CAAC,UAAY,EAAA,WAAW,CAAC,CAAA;AAE5B,EAAM,MAAA,YAAA,GAAe,YAAY,MAAM;AAErC,IAAA,WAAA,CAAY,aAAc,EAAA;AAC1B,IAAS,QAAA,EAAA;AACT,IAAuB,sBAAA,EAAA;AACvB,IAAA,UAAA,CAAW,MAAS,IAAA;AAAA,KACnB,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,QAAQ,CAAC,CAAA;AAE9D,EAAM,MAAA,UAAA,GAAa,YAAY,YAAY;AACzC,IAAA,UAAA,CAAW,MAAS,IAAA;AACpB,IAAM,MAAA,QAAA,GAAW,MAAM,WAAA,CAAY,WAAY,EAAA;AAC/C,IAAI,IAAA,YAAA,CAAa,QAAQ,CAAG,EAAA;AAC1B,MAAO,MAAA,EAAA;AACP,MAAuB,sBAAA,EAAA;AAAA;AACzB,KACC,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,MAAM,CAAC,CAAA;AAE5D,EAAA,OAAA,CAAQ,YAAY;AAClB,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,YAAA,GAAe,MAAM,WAAA,CAAY,aAAc,EAAA;AACrD,MAAI,IAAA,YAAA,IAAgB,WAAW,WAAa,EAAA;AAC1C,QAAA,UAAA,CAAW,UAAU,KAAK,CAAA;AAC1B,QAAMC,MAAAA,kBAAAA,GAAoB,IAAI,aAAc,CAAA;AAAA,UAC1C,SAAS,UAAW,CAAA,OAAA;AAAA,UACpB,KAAO,EAAA,YAAA;AAAA,UACP,UAAU,YAAa,CAAA;AAAA,SACxB,CAAA;AACD,QAAA,oBAAA,CAAqBA,kBAAiB,CAAA;AACtC,QAAA,WAAA,CAAY,UAAaA,GAAAA,kBAAAA;AAAA;AAC3B;AACF,KACC,CAAC,aAAA,EAAe,UAAY,EAAA,WAAA,EAAa,UAAU,CAAC,CAAA;AAEvD,EAAO,OAAA;AAAA;AAAA,IAEL,YAAY,iBAAqB,IAAA,UAAA;AAAA,IACjC,WAAA;AAAA,IACA,QAAU,EAAA,YAAA;AAAA,IACV,MAAQ,EAAA;AAAA,GACV;AACF;;;;"}
+{"version":3,"file":"useEditableTable.js","sources":["../../../../../../../packages/vuu-utils/src/data-editing/useEditableTable.ts"],"sourcesContent":["import { VuuTable } from \"@vuu-ui/vuu-protocol-types\";\nimport { useCallback, useMemo, useState } from \"react\";\nimport { EditSession } from \"./EditSession\";\nimport { useData } from \"../context-definitions/DataProvider\";\nimport { DataSource } from \"@vuu-ui/vuu-data-types\";\nimport { isRpcSuccess } from \"../protocol-message-utils\";\nimport { useLayoutEffectSkipFirst } from \"../useLayoutEffectSkipFirst\";\n\nexport type EditMode = \"edit\" | \"view\";\n\nexport interface EditableTableHookProps {\n  /**\n   * columns to be included in subscription. If not provided,\n   * default will be '*'. Ignored if dataSource prop present.\n   */\n  columns?: string[];\n  dataSource?: DataSource;\n  isEditMode: boolean;\n  onCancel: () => void;\n  onSave: () => void;\n  /**\n   * If dataSource not provided, new DataSource\n   * will be created using table and columns\n   */\n  table?: VuuTable;\n}\n\nexport const useEditableTable = ({\n  columns,\n  dataSource: dataSourceProp,\n  isEditMode,\n  onCancel,\n  onSave,\n  table,\n}: EditableTableHookProps) => {\n  const { VuuDataSource } = useData();\n  const [sessionDataSource, setSessionDataSource] = useState<\n    DataSource | undefined\n  >(undefined);\n\n  const clearSessionDataSource = useCallback(() => {\n    setSessionDataSource((dataSource) => {\n      dataSource?.unsubscribe();\n      return undefined;\n    });\n  }, []);\n\n  useLayoutEffectSkipFirst(() => {\n    console.warn(`[useEditableTable] columns and or table changed`);\n  }, [columns, table]);\n\n  const dataSource = useMemo(() => {\n    // The dataSource would normally be managed by client and passed in, but for\n    // simple use cases we can create it here.\n    if (dataSourceProp) {\n      return dataSourceProp;\n    } else if (table) {\n      return new VuuDataSource({ columns, table });\n    } else {\n      throw Error(\n        `useEditableTable unable to provide DataSource, neither dataSource nor table available as props`,\n      );\n    }\n  }, [VuuDataSource, columns, dataSourceProp, table]);\n\n  // The editSession will be made available to all the edit controls in scope by\n  // wrapping the edit component with a DataEditingProvider.\n  const editSession = useMemo(() => new EditSession(), []);\n\n  useMemo(() => {\n    if (dataSource) {\n      editSession.dataSource = dataSource;\n    }\n  }, [dataSource, editSession]);\n\n  const handleCancel = useCallback(() => {\n    // editTracker.dataSource = dataSource;\n    editSession.cancelChanges();\n    onCancel();\n    clearSessionDataSource();\n    dataSource.resume?.();\n  }, [clearSessionDataSource, dataSource, editSession, onCancel]);\n\n  const handleSave = useCallback(async () => {\n    dataSource.resume?.();\n    const response = await editSession.saveChanges();\n    if (isRpcSuccess(response)) {\n      onSave();\n      clearSessionDataSource();\n    }\n  }, [clearSessionDataSource, dataSource, editSession, onSave]);\n\n  useMemo(async () => {\n    if (isEditMode) {\n      const sessionTable = await editSession.enterEditMode();\n      if (sessionTable && dataSource.tableSchema) {\n        // dataSource.suspend?.(false);\n        const sessionDataSource = new VuuDataSource({\n          columns: dataSource.columns,\n          table: sessionTable,\n          viewport: sessionTable.table,\n        });\n        setSessionDataSource(sessionDataSource);\n        editSession.dataSource = sessionDataSource;\n      }\n    }\n  }, [VuuDataSource, dataSource, editSession, isEditMode]);\n\n  return {\n    // DO we need to reset the dataSource or could useDataSOurce detect the sessiondataSOurce from the editSession ?\n    dataSource: sessionDataSource ?? dataSource,\n    editSession,\n    onCancel: handleCancel,\n    onSave: handleSave,\n  };\n};\n"],"names":["dataSource","sessionDataSource"],"mappings":";;;;;;AA2BO,MAAM,mBAAmB,CAAC;AAAA,EAC/B,OAAA;AAAA,EACA,UAAY,EAAA,cAAA;AAAA,EACZ,UAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAA8B,KAAA;AAC5B,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,OAAQ,EAAA;AAClC,EAAA,MAAM,CAAC,iBAAA,EAAmB,oBAAoB,CAAA,GAAI,SAEhD,KAAS,CAAA,CAAA;AAEX,EAAM,MAAA,sBAAA,GAAyB,YAAY,MAAM;AAC/C,IAAA,oBAAA,CAAqB,CAACA,WAAe,KAAA;AACnC,MAAAA,aAAY,WAAY,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA;AAAA,KACR,CAAA;AAAA,GACH,EAAG,EAAE,CAAA;AAEL,EAAA,wBAAA,CAAyB,MAAM;AAC7B,IAAA,OAAA,CAAQ,KAAK,CAAiD,+CAAA,CAAA,CAAA;AAAA,GAC7D,EAAA,CAAC,OAAS,EAAA,KAAK,CAAC,CAAA;AAEnB,EAAM,MAAA,UAAA,GAAa,QAAQ,MAAM;AAG/B,IAAA,IAAI,cAAgB,EAAA;AAClB,MAAO,OAAA,cAAA;AAAA,eACE,KAAO,EAAA;AAChB,MAAA,OAAO,IAAI,aAAA,CAAc,EAAE,OAAA,EAAS,OAAO,CAAA;AAAA,KACtC,MAAA;AACL,MAAM,MAAA,KAAA;AAAA,QACJ,CAAA,8FAAA;AAAA,OACF;AAAA;AACF,KACC,CAAC,aAAA,EAAe,OAAS,EAAA,cAAA,EAAgB,KAAK,CAAC,CAAA;AAIlD,EAAA,MAAM,cAAc,OAAQ,CAAA,MAAM,IAAI,WAAY,EAAA,EAAG,EAAE,CAAA;AAEvD,EAAA,OAAA,CAAQ,MAAM;AACZ,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,WAAA,CAAY,UAAa,GAAA,UAAA;AAAA;AAC3B,GACC,EAAA,CAAC,UAAY,EAAA,WAAW,CAAC,CAAA;AAE5B,EAAM,MAAA,YAAA,GAAe,YAAY,MAAM;AAErC,IAAA,WAAA,CAAY,aAAc,EAAA;AAC1B,IAAS,QAAA,EAAA;AACT,IAAuB,sBAAA,EAAA;AACvB,IAAA,UAAA,CAAW,MAAS,IAAA;AAAA,KACnB,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,QAAQ,CAAC,CAAA;AAE9D,EAAM,MAAA,UAAA,GAAa,YAAY,YAAY;AACzC,IAAA,UAAA,CAAW,MAAS,IAAA;AACpB,IAAM,MAAA,QAAA,GAAW,MAAM,WAAA,CAAY,WAAY,EAAA;AAC/C,IAAI,IAAA,YAAA,CAAa,QAAQ,CAAG,EAAA;AAC1B,MAAO,MAAA,EAAA;AACP,MAAuB,sBAAA,EAAA;AAAA;AACzB,KACC,CAAC,sBAAA,EAAwB,UAAY,EAAA,WAAA,EAAa,MAAM,CAAC,CAAA;AAE5D,EAAA,OAAA,CAAQ,YAAY;AAClB,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,YAAA,GAAe,MAAM,WAAA,CAAY,aAAc,EAAA;AACrD,MAAI,IAAA,YAAA,IAAgB,WAAW,WAAa,EAAA;AAE1C,QAAMC,MAAAA,kBAAAA,GAAoB,IAAI,aAAc,CAAA;AAAA,UAC1C,SAAS,UAAW,CAAA,OAAA;AAAA,UACpB,KAAO,EAAA,YAAA;AAAA,UACP,UAAU,YAAa,CAAA;AAAA,SACxB,CAAA;AACD,QAAA,oBAAA,CAAqBA,kBAAiB,CAAA;AACtC,QAAA,WAAA,CAAY,UAAaA,GAAAA,kBAAAA;AAAA;AAC3B;AACF,KACC,CAAC,aAAA,EAAe,UAAY,EAAA,WAAA,EAAa,UAAU,CAAC,CAAA;AAEvD,EAAO,OAAA;AAAA;AAAA,IAEL,YAAY,iBAAqB,IAAA,UAAA;AAAA,IACjC,WAAA;AAAA,IACA,QAAU,EAAA,YAAA;AAAA,IACV,MAAQ,EAAA;AAAA,GACV;AACF;;;;"}

package/esm/packages/vuu-utils/src/form-utils.js

@@ -5,6 +5,18 @@ import '@internationalized/date';
 import { queryClosest } from './html-utils.js';
 import { ScaledDecimal8, ScaledDecimal6, ScaledDecimal4, ScaledDecimal2 } from './ScaledDecimal.js';
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+class DataValidationError extends Error {
+  constructor(message, expectedType, actualType) {
+    super(message);
+    __publicField(this, "actualType");
+    __publicField(this, "expectedType");
+    this.actualType = actualType;
+    this.expectedType = expectedType;
+  }
+}
 const getFieldName = (target) => {
   const saltFormField = queryClosest(target, "[data-field]");
   const fieldName = saltFormField?.dataset.field;
@@ -27,6 +39,16 @@ function getTypedRange([value1, value2], dataType, options) {
     getTypedValue(value2, dataType, false, options)
   ];
 }
+const getActualType = (value) => {
+  if (typeof value === "boolean") {
+    return "boolean";
+  } else if (typeof value === "number") {
+    return "number";
+  } else if (typeof value === "string") {
+    return "string";
+  }
+  return "string";
+};
 function getTypedValue(value, type, throwIfInvalid = false, options) {
   switch (type) {
     case "int":
@@ -54,7 +76,11 @@ function getTypedValue(value, type, throwIfInvalid = false, options) {
       if (stringIsValidDecimal(value)) {
         return parseFloat(value);
       } else if (throwIfInvalid) {
-        throw Error(`value ${value} is not a valid ${type}`);
+        throw new DataValidationError(
+          `value ${value} is not a valid ${type}`,
+          "decimal",
+          getActualType(value)
+        );
       } else {
         return void 0;
       }
@@ -80,5 +106,5 @@ function getTypedValue(value, type, throwIfInvalid = false, options) {
   }
 }
 
-export { getFieldName, getTypedRange, getTypedValue, isNumber, isValidRange };
+export { DataValidationError, getFieldName, getTypedRange, getTypedValue, isNumber, isValidRange };
 //# sourceMappingURL=form-utils.js.map

package/esm/packages/vuu-utils/src/form-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-utils.js","sources":["../../../../../../packages/vuu-utils/src/form-utils.ts"],"sourcesContent":["import { DataValueTypeSimple } from \"@vuu-ui/vuu-data-types\";\nimport {\n  VuuColumnDataType,\n  VuuRowDataItemType,\n} from \"@vuu-ui/vuu-protocol-types\";\nimport { KeyboardEvent, SyntheticEvent } from \"react\";\nimport { stringIsValidDecimal, stringIsValidInt } from \"./data-utils\";\nimport { isValidTimeString, Time } from \"./date\";\nimport { queryClosest } from \"./html-utils\";\nimport { ExtendedFilterOptions } from \"@vuu-ui/vuu-filter-types\";\nimport {\n  type ScaledDecimal,\n  ScaledDecimal2,\n  ScaledDecimal4,\n  ScaledDecimal6,\n  ScaledDecimal8,\n} from \"./ScaledDecimal\";\n\n/**\n * Use with the following convention:\n *\n * <FormField data-field=\"my-field-name\">\n */\nexport const getFieldName = (target: EventTarget | HTMLElement): string => {\n  const saltFormField = queryClosest(target, \"[data-field]\") as HTMLElement;\n  const fieldName = saltFormField?.dataset.field;\n  if (fieldName) {\n    return fieldName;\n  } else {\n    throw Error(\"named form field not found\");\n  }\n};\n\nexport type InputSource = \"typeahead-suggestion\" | \"text-input\";\n\nexport const isNumber = (\n  type: string,\n  value: VuuRowDataItemType,\n): value is number => type === \"number\";\n\nexport type CommitHandler<\n  E extends HTMLElement = HTMLInputElement,\n  T = VuuRowDataItemType,\n> = (\n  evt: SyntheticEvent<E> | KeyboardEvent<E>,\n  value: T,\n  source?: InputSource,\n) => void;\n\nexport const isValidRange = <T>([val1, val2]: [T, T]) => {\n  if (isValidTimeString(val1) && isValidTimeString(val2)) {\n    return val2 > val1;\n  }\n  return true;\n};\n\n/**\n * Convert a pair of string values to the type appropriate for the\n * associated column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n */\nexport function getTypedRange(\n  [value1, value2]: [string, string],\n  dataType: VuuColumnDataType | DataValueTypeSimple,\n  options?: ExtendedFilterOptions,\n) {\n  return [\n    getTypedValue(value1, dataType, false, options),\n    getTypedValue(value2, dataType, false, options),\n  ];\n}\n\n/**\n * Convert a string value to the type appropriate for the associated\n * column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n * @param value\n * @param type\n * @param throwIfInvalid\n */\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid?: false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | undefined;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid: true,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid = false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | ScaledDecimal | undefined {\n  switch (type) {\n    case \"int\":\n    case \"long\": {\n      if (stringIsValidInt(value)) {\n        return parseInt(value, 10);\n      } else if (isValidTimeString(value)) {\n        //TOCHECK\n        return value;\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"scaleddecimal2\":\n      return ScaledDecimal2(value);\n    case \"scaleddecimal4\":\n      return ScaledDecimal4(value);\n    case \"scaleddecimal6\":\n      return ScaledDecimal6(value);\n    case \"scaleddecimal8\":\n      return ScaledDecimal8(value);\n    case \"double\":\n    case \"number\": {\n      if (stringIsValidDecimal(value)) {\n        return parseFloat(value);\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"boolean\":\n      return value === \"true\" ? true : false;\n\n    case \"time\":\n      if (isValidTimeString(value)) {\n        // We don't manipulate the values of 'extended' filters, the\n        // ExtendedFilter impementation will do that.\n        if (options?.type === \"TimeString\") {\n          return value;\n        } else {\n          return +Time(value).asDate();\n        }\n      } else if (value.length > 0 && Time.isDateInMillis(value)) {\n        //if value previously converted\n        return Number(value);\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    default:\n      return value;\n  }\n}\n"],"names":[],"mappings":";;;;;;;AAuBa,MAAA,YAAA,GAAe,CAAC,MAA8C,KAAA;AACzE,EAAM,MAAA,aAAA,GAAgB,YAAa,CAAA,MAAA,EAAQ,cAAc,CAAA;AACzD,EAAM,MAAA,SAAA,GAAY,eAAe,OAAQ,CAAA,KAAA;AACzC,EAAA,IAAI,SAAW,EAAA;AACb,IAAO,OAAA,SAAA;AAAA,GACF,MAAA;AACL,IAAA,MAAM,MAAM,4BAA4B,CAAA;AAAA;AAE5C;AAIO,MAAM,QAAW,GAAA,CACtB,IACA,EAAA,KAAA,KACoB,IAAS,KAAA;AAWxB,MAAM,YAAe,GAAA,CAAI,CAAC,IAAA,EAAM,IAAI,CAAc,KAAA;AACvD,EAAA,IAAI,iBAAkB,CAAA,IAAI,CAAK,IAAA,iBAAA,CAAkB,IAAI,CAAG,EAAA;AACtD,IAAA,OAAO,IAAO,GAAA,IAAA;AAAA;AAEhB,EAAO,OAAA,IAAA;AACT;AAQO,SAAS,cACd,CAAC,MAAA,EAAQ,MAAM,CAAA,EACf,UACA,OACA,EAAA;AACA,EAAO,OAAA;AAAA,IACL,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO,CAAA;AAAA,IAC9C,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO;AAAA,GAChD;AACF;AAuBO,SAAS,aACd,CAAA,KAAA,EACA,IACA,EAAA,cAAA,GAAiB,OACjB,OACgD,EAAA;AAChD,EAAA,QAAQ,IAAM;AAAA,IACZ,KAAK,KAAA;AAAA,IACL,KAAK,MAAQ,EAAA;AACX,MAAI,IAAA,gBAAA,CAAiB,KAAK,CAAG,EAAA;AAC3B,QAAO,OAAA,QAAA,CAAS,OAAO,EAAE,CAAA;AAAA,OAC3B,MAAA,IAAW,iBAAkB,CAAA,KAAK,CAAG,EAAA;AAEnC,QAAO,OAAA,KAAA;AAAA,iBACE,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,QAAA;AAAA,IACL,KAAK,QAAU,EAAA;AACb,MAAI,IAAA,oBAAA,CAAqB,KAAK,CAAG,EAAA;AAC/B,QAAA,OAAO,WAAW,KAAK,CAAA;AAAA,iBACd,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,SAAA;AACH,MAAO,OAAA,KAAA,KAAU,SAAS,IAAO,GAAA,KAAA;AAAA,IAEnC,KAAK,MAAA;AACH,MAAI,IAAA,iBAAA,CAAkB,KAAK,CAAG,EAAA;AAG5B,QAAI,IAAA,OAAA,EAAS,SAAS,YAAc,EAAA;AAClC,UAAO,OAAA,KAAA;AAAA,SACF,MAAA;AACL,UAAA,OAAO,CAAC,IAAA,CAAK,KAAK,CAAA,CAAE,MAAO,EAAA;AAAA;AAC7B,iBACS,KAAM,CAAA,MAAA,GAAS,KAAK,IAAK,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAEzD,QAAA,OAAO,OAAO,KAAK,CAAA;AAAA,iBACV,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT,IACF;AACE,MAAO,OAAA,KAAA;AAAA;AAEb;;;;"}
+{"version":3,"file":"form-utils.js","sources":["../../../../../../packages/vuu-utils/src/form-utils.ts"],"sourcesContent":["import { DataValueTypeSimple } from \"@vuu-ui/vuu-data-types\";\nimport {\n  VuuColumnDataType,\n  VuuRowDataItemType,\n} from \"@vuu-ui/vuu-protocol-types\";\nimport { KeyboardEvent, SyntheticEvent } from \"react\";\nimport { stringIsValidDecimal, stringIsValidInt } from \"./data-utils\";\nimport { isValidTimeString, Time } from \"./date\";\nimport { queryClosest } from \"./html-utils\";\nimport { ExtendedFilterOptions } from \"@vuu-ui/vuu-filter-types\";\nimport {\n  type ScaledDecimal,\n  ScaledDecimal2,\n  ScaledDecimal4,\n  ScaledDecimal6,\n  ScaledDecimal8,\n} from \"./ScaledDecimal\";\n\nexport class DataValidationError extends Error {\n  actualType: string;\n  expectedType: string;\n  constructor(message: string, expectedType: string, actualType: string) {\n    super(message);\n    this.actualType = actualType;\n    this.expectedType = expectedType;\n  }\n}\n\n/**\n * Use with the following convention:\n *\n * <FormField data-field=\"my-field-name\">\n */\nexport const getFieldName = (target: EventTarget | HTMLElement): string => {\n  const saltFormField = queryClosest(target, \"[data-field]\") as HTMLElement;\n  const fieldName = saltFormField?.dataset.field;\n  if (fieldName) {\n    return fieldName;\n  } else {\n    throw Error(\"named form field not found\");\n  }\n};\n\nexport type InputSource = \"typeahead-suggestion\" | \"text-input\";\n\nexport const isNumber = (\n  type: string,\n  value: VuuRowDataItemType,\n): value is number => type === \"number\";\n\nexport type CommitHandler<\n  E extends HTMLElement = HTMLInputElement,\n  T = VuuRowDataItemType,\n> = (\n  evt: SyntheticEvent<E> | KeyboardEvent<E>,\n  value: T,\n  source?: InputSource,\n) => void;\n\nexport const isValidRange = <T>([val1, val2]: [T, T]) => {\n  if (isValidTimeString(val1) && isValidTimeString(val2)) {\n    return val2 > val1;\n  }\n  return true;\n};\n\n/**\n * Convert a pair of string values to the type appropriate for the\n * associated column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n */\nexport function getTypedRange(\n  [value1, value2]: [string, string],\n  dataType: VuuColumnDataType | DataValueTypeSimple,\n  options?: ExtendedFilterOptions,\n) {\n  return [\n    getTypedValue(value1, dataType, false, options),\n    getTypedValue(value2, dataType, false, options),\n  ];\n}\n\nconst getActualType = (\n  value: string | number | boolean,\n): \"string\" | \"number\" | \"boolean\" => {\n  if (typeof value === \"boolean\") {\n    return \"boolean\";\n  } else if (typeof value === \"number\") {\n    return \"number\";\n  } else if (typeof value === \"string\") {\n    return \"string\";\n  }\n  return \"string\";\n};\n\n/**\n * Convert a string value to the type appropriate for the associated\n * column or form field. Can be used when processing a string value\n * from an input used for user editing.\n *\n * @param value\n * @param type\n * @param throwIfInvalid\n */\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid?: false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | undefined;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid: true,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType;\nexport function getTypedValue(\n  value: string,\n  type: VuuColumnDataType | DataValueTypeSimple,\n  throwIfInvalid = false,\n  options?: ExtendedFilterOptions,\n): VuuRowDataItemType | ScaledDecimal | undefined {\n  switch (type) {\n    case \"int\":\n    case \"long\": {\n      if (stringIsValidInt(value)) {\n        return parseInt(value, 10);\n      } else if (isValidTimeString(value)) {\n        //TOCHECK\n        return value;\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"scaleddecimal2\":\n      return ScaledDecimal2(value);\n    case \"scaleddecimal4\":\n      return ScaledDecimal4(value);\n    case \"scaleddecimal6\":\n      return ScaledDecimal6(value);\n    case \"scaleddecimal8\":\n      return ScaledDecimal8(value);\n    case \"double\":\n    case \"number\": {\n      if (stringIsValidDecimal(value)) {\n        return parseFloat(value);\n      } else if (throwIfInvalid) {\n        throw new DataValidationError(\n          `value ${value} is not a valid ${type}`,\n          \"decimal\",\n          getActualType(value),\n        );\n      } else {\n        return undefined;\n      }\n    }\n\n    case \"boolean\":\n      return value === \"true\" ? true : false;\n\n    case \"time\":\n      if (isValidTimeString(value)) {\n        // We don't manipulate the values of 'extended' filters, the\n        // ExtendedFilter impementation will do that.\n        if (options?.type === \"TimeString\") {\n          return value;\n        } else {\n          return +Time(value).asDate();\n        }\n      } else if (value.length > 0 && Time.isDateInMillis(value)) {\n        //if value previously converted\n        return Number(value);\n      } else if (throwIfInvalid) {\n        throw Error(`value ${value} is not a valid ${type}`);\n      } else {\n        return undefined;\n      }\n    default:\n      return value;\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;AAkBO,MAAM,4BAA4B,KAAM,CAAA;AAAA,EAG7C,WAAA,CAAY,OAAiB,EAAA,YAAA,EAAsB,UAAoB,EAAA;AACrE,IAAA,KAAA,CAAM,OAAO,CAAA;AAHf,IAAA,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA;AACA,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA;AAGE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA;AAAA;AAExB;AAOa,MAAA,YAAA,GAAe,CAAC,MAA8C,KAAA;AACzE,EAAM,MAAA,aAAA,GAAgB,YAAa,CAAA,MAAA,EAAQ,cAAc,CAAA;AACzD,EAAM,MAAA,SAAA,GAAY,eAAe,OAAQ,CAAA,KAAA;AACzC,EAAA,IAAI,SAAW,EAAA;AACb,IAAO,OAAA,SAAA;AAAA,GACF,MAAA;AACL,IAAA,MAAM,MAAM,4BAA4B,CAAA;AAAA;AAE5C;AAIO,MAAM,QAAW,GAAA,CACtB,IACA,EAAA,KAAA,KACoB,IAAS,KAAA;AAWxB,MAAM,YAAe,GAAA,CAAI,CAAC,IAAA,EAAM,IAAI,CAAc,KAAA;AACvD,EAAA,IAAI,iBAAkB,CAAA,IAAI,CAAK,IAAA,iBAAA,CAAkB,IAAI,CAAG,EAAA;AACtD,IAAA,OAAO,IAAO,GAAA,IAAA;AAAA;AAEhB,EAAO,OAAA,IAAA;AACT;AAQO,SAAS,cACd,CAAC,MAAA,EAAQ,MAAM,CAAA,EACf,UACA,OACA,EAAA;AACA,EAAO,OAAA;AAAA,IACL,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO,CAAA;AAAA,IAC9C,aAAc,CAAA,MAAA,EAAQ,QAAU,EAAA,KAAA,EAAO,OAAO;AAAA,GAChD;AACF;AAEA,MAAM,aAAA,GAAgB,CACpB,KACoC,KAAA;AACpC,EAAI,IAAA,OAAO,UAAU,SAAW,EAAA;AAC9B,IAAO,OAAA,SAAA;AAAA,GACT,MAAA,IAAW,OAAO,KAAA,KAAU,QAAU,EAAA;AACpC,IAAO,OAAA,QAAA;AAAA,GACT,MAAA,IAAW,OAAO,KAAA,KAAU,QAAU,EAAA;AACpC,IAAO,OAAA,QAAA;AAAA;AAET,EAAO,OAAA,QAAA;AACT,CAAA;AAuBO,SAAS,aACd,CAAA,KAAA,EACA,IACA,EAAA,cAAA,GAAiB,OACjB,OACgD,EAAA;AAChD,EAAA,QAAQ,IAAM;AAAA,IACZ,KAAK,KAAA;AAAA,IACL,KAAK,MAAQ,EAAA;AACX,MAAI,IAAA,gBAAA,CAAiB,KAAK,CAAG,EAAA;AAC3B,QAAO,OAAA,QAAA,CAAS,OAAO,EAAE,CAAA;AAAA,OAC3B,MAAA,IAAW,iBAAkB,CAAA,KAAK,CAAG,EAAA;AAEnC,QAAO,OAAA,KAAA;AAAA,iBACE,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,gBAAA;AACH,MAAA,OAAO,eAAe,KAAK,CAAA;AAAA,IAC7B,KAAK,QAAA;AAAA,IACL,KAAK,QAAU,EAAA;AACb,MAAI,IAAA,oBAAA,CAAqB,KAAK,CAAG,EAAA;AAC/B,QAAA,OAAO,WAAW,KAAK,CAAA;AAAA,iBACd,cAAgB,EAAA;AACzB,QAAA,MAAM,IAAI,mBAAA;AAAA,UACR,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAA,CAAA;AAAA,UACrC,SAAA;AAAA,UACA,cAAc,KAAK;AAAA,SACrB;AAAA,OACK,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT;AACF,IAEA,KAAK,SAAA;AACH,MAAO,OAAA,KAAA,KAAU,SAAS,IAAO,GAAA,KAAA;AAAA,IAEnC,KAAK,MAAA;AACH,MAAI,IAAA,iBAAA,CAAkB,KAAK,CAAG,EAAA;AAG5B,QAAI,IAAA,OAAA,EAAS,SAAS,YAAc,EAAA;AAClC,UAAO,OAAA,KAAA;AAAA,SACF,MAAA;AACL,UAAA,OAAO,CAAC,IAAA,CAAK,KAAK,CAAA,CAAE,MAAO,EAAA;AAAA;AAC7B,iBACS,KAAM,CAAA,MAAA,GAAS,KAAK,IAAK,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAEzD,QAAA,OAAO,OAAO,KAAK,CAAA;AAAA,iBACV,cAAgB,EAAA;AACzB,QAAA,MAAM,KAAM,CAAA,CAAA,MAAA,EAAS,KAAK,CAAA,gBAAA,EAAmB,IAAI,CAAE,CAAA,CAAA;AAAA,OAC9C,MAAA;AACL,QAAO,OAAA,KAAA,CAAA;AAAA;AACT,IACF;AACE,MAAO,OAAA,KAAA;AAAA;AAEb;;;;"}

package/esm/packages/vuu-utils/src/index.js

@@ -11,8 +11,8 @@ export { getCellConfigPanelRenderer, getCellRenderer, getCellRendererOptions, ge
 export { getCookieValue, setCookieValue } from './cookie-utils.js';
 export { importCSS } from './css-utils.js';
 export { EditButtons } from './data-editing/EditButtons.js';
-export { DataEditingProvider, useEditTracker } from './data-editing/DataEditingProvider.js';
-export { EditTracker } from './data-editing/EditTracker.js';
+export { DataEditingProvider, useEditSession } from './data-editing/DataEditingProvider.js';
+export { EditSession } from './data-editing/EditSession.js';
 export { useEditableTable } from './data-editing/useEditableTable.js';
 export { DOWN1, DOWN2, UP1, UP2, asInteger, dataDescriptorTypeToVuuRowDataItemType, getMovingValueDirection, isValidNumber, numericTypeOfStringValue, shallowEquals, stringIsValidDecimal, stringIsValidInt, stringIsValidNumber } from './data-utils.js';
 export { BaseDataSource, defaultSuspenseProps } from './datasource/BaseDataSource.js';
@@ -28,7 +28,7 @@ export { EventEmitter } from './event-emitter.js';
 export { assertComponentRegistered, assertComponentsRegistered, byModule, env, featureFromJson, getCustomAndTableFeatures, getFilterTableFeatures, hasFilterTableFeatureProps, isCustomFeature, isSameTable, isStaticFeatures, isVuuTables, isWildcardSchema } from './feature-utils.js';
 export { applyFilterToColumns, extractFilterForColumn, filtersAreEqual, getColumnValueFromFilter, isAndFilter, isBetweenFilter, isBetweenOperator, isCompleteFilter, isExtendedFilter, isFilter, isFilterClause, isFilteredColumn, isInFilter, isMultiClauseFilter, isMultiValueFilter, isNamedFilter, isOrFilter, isScaledDecimalFilterClause, isSerializableFilter, isSingleValueFilter, isValidFilterClauseOp, stripFilterFromColumns } from './filters/filter-utils.js';
 export { ONE_DAY_IN_MILLIS, dateFilterAsQuery, filterAsQuery } from './filters/filterAsQuery.js';
-export { getFieldName, getTypedRange, getTypedValue, isNumber, isValidRange } from './form-utils.js';
+export { DataValidationError, getFieldName, getTypedRange, getTypedValue, isNumber, isValidRange } from './form-utils.js';
 export { defaultValueFormatter, getValueFormatter, lowerCase, numericFormatter } from './formatting-utils.js';
 export { getUniqueId } from './getUniqueId.js';
 export { addGroupColumn, getGroupStatus, removeGroupColumn } from './group-utils.js';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.4",
+  "version": "2.1.5",
   "author": "heswell",
   "license": "Apache-2.0",
   "types": "types/index.d.ts",
@@ -7,14 +7,14 @@
     "@salt-ds/core": "1.54.1"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "2.1.4",
-    "@vuu-ui/vuu-table-types": "2.1.4",
-    "@vuu-ui/vuu-filter-types": "2.1.4",
-    "@vuu-ui/vuu-protocol-types": "2.1.4"
+    "@vuu-ui/vuu-data-types": "2.1.5",
+    "@vuu-ui/vuu-table-types": "2.1.5",
+    "@vuu-ui/vuu-filter-types": "2.1.5",
+    "@vuu-ui/vuu-protocol-types": "2.1.5"
   },
   "peerDependencies": {
     "@internationalized/date": "^3.0.0",
-    "@vuu-ui/vuu-filter-parser": "2.1.4",
+    "@vuu-ui/vuu-filter-parser": "2.1.5",
     "clsx": "^2.0.0",
     "react": "^19.2.3",
     "react-dom": "^19.2.3"

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/{EditTracker.d.ts → EditSession.d.ts}

@@ -2,10 +2,10 @@ 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 = {
+type EditSessionEvents = {
     editState: (editState: EditState) => void;
 };
-export declare class EditTracker extends EventEmitter<EditTrackerEvents> {
+export declare class EditSession extends EventEmitter<EditSessionEvents> {
     #private;
     get active(): boolean;
     set active(isActive: boolean);
@@ -19,6 +19,6 @@ export declare class EditTracker extends EventEmitter<EditTrackerEvents> {
     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>;
+    commit(key: string, columnName: string, typedValue: string | number | boolean): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | RpcResultError | undefined>;
 }
 export {};

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

@@ -1,5 +1,5 @@
 import { VuuTable } from "@vuu-ui/vuu-protocol-types";
-import { EditTracker } from "./EditTracker";
+import { EditSession } from "./EditSession";
 import { DataSource } from "@vuu-ui/vuu-data-types";
 export type EditMode = "edit" | "view";
 export interface EditableTableHookProps {
@@ -16,11 +16,11 @@ 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) => {
     dataSource: DataSource;
-    editTracker: EditTracker;
+    editSession: EditSession;
     onCancel: () => void;
     onSave: () => Promise<void>;
 };

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

@@ -13,8 +13,8 @@ export * from "./component-registry";
 export * from "./cookie-utils";
 export * from "./css-utils";
 export { EditButtons, type EditButtonProps } from "./data-editing/EditButtons";
-export { DataEditingProvider, useEditTracker, } from "./data-editing/DataEditingProvider";
-export { EditTracker, type EditState } from "./data-editing/EditTracker";
+export { DataEditingProvider, useEditSession, } from "./data-editing/DataEditingProvider";
+export { EditSession, type EditState } from "./data-editing/EditSession";
 export { useEditableTable } from "./data-editing/useEditableTable";
 export * from "./data-utils";
 export * from "./datasource/BaseDataSource";

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;;;;"}