@vuu-ui/vuu-data-remote 3.3.4 → 3.3.6

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.3.4",
+  "version": "3.3.6",
   "main": "./src/index.js",
   "author": "heswell",
   "license": "Apache-2.0",
@@ -11,14 +11,14 @@
     "type-defs": "node ../../scripts/build-type-defs.mjs"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "3.3.4",
-    "@vuu-ui/vuu-table-types": "3.3.4",
-    "@vuu-ui/vuu-filter-types": "3.3.4",
-    "@vuu-ui/vuu-protocol-types": "3.3.4"
+    "@vuu-ui/vuu-data-types": "3.3.6",
+    "@vuu-ui/vuu-table-types": "3.3.6",
+    "@vuu-ui/vuu-filter-types": "3.3.6",
+    "@vuu-ui/vuu-protocol-types": "3.3.6"
   },
   "dependencies": {
-    "@vuu-ui/vuu-filter-parser": "3.3.4",
-    "@vuu-ui/vuu-utils": "3.3.4"
+    "@vuu-ui/vuu-filter-parser": "3.3.6",
+    "@vuu-ui/vuu-utils": "3.3.6"
   },
   "files": [
     "README.md",

package/src/VuuDataSource.js

@@ -26,8 +26,8 @@ class VuuDataSource extends BaseDataSource {
     #optimize = "throttle";
     #selectedRowsCount = 0;
     #session;
-    #sessionDataSource = void 0;
     #sessionTableMessageColumn = void 0;
+    #sourceTableDataSource;
     #status = "initialising";
     #tableSchema;
     isRemote = true;
@@ -92,12 +92,6 @@ class VuuDataSource extends BaseDataSource {
                     this.size = message.size;
                     this.emit("resize", message.size, this.#maxRangeEnd);
                 }
-                if (Array.isArray(message.rows) && message.rows.length > 0 && this.#sessionDataSource) {
-                    this.emit("remote-update-during-local-edit", message.rows);
-                    console.log(`updates incoming whilst edit in progress ${this.viewport}`);
-                    console.table(message.rows);
-                    return;
-                }
             } else if ("viewport-clear" === message.type) {
                 this.size = 0;
                 this.emit("resize", 0);
@@ -158,6 +152,9 @@ class VuuDataSource extends BaseDataSource {
             viewport: this.viewport
         });
     }
+    isSessionDataSourceOf(dataSource) {
+        return this.#sourceTableDataSource === dataSource;
+    }
     resume(callback) {
         const isDisabled = this.#status.startsWith("disabl");
         const isSuspended = "suspended" === this.#status;
@@ -380,7 +377,6 @@ class VuuDataSource extends BaseDataSource {
     }
     set range(range) {
         super.range = range;
-        if (this.#sessionDataSource) this.#sessionDataSource.range = range;
     }
     get title() {
         return super.title || `${this.table.module} ${this.table.table}`;
@@ -436,39 +432,40 @@ class VuuDataSource extends BaseDataSource {
             const { table: sessionTable } = rpcResponse.data;
             const effectiveOverrides = overrides ?? this.#session;
             assertExpectedSessionTable(sessionTable, effectiveOverrides?.table);
-            return new VuuDataSource({
+            const sessionDataSource = new VuuDataSource({
                 ...sessionDataSourceConfig(this.config, effectiveOverrides?.columns),
                 table: sessionTable,
                 viewport: sessionTable.table
             });
+            sessionDataSource.#sourceTableDataSource = this;
+            return sessionDataSource;
         }
         throw Error(`[VuuDataSource] createSessionDataSource ${rpcResponse?.errorMessage}`);
     }
-    async beginEditSession(editSessionMode = "all-rows") {
+    async beginEditSession() {
         const rpcResponse = await this?.rpcRequest?.({
             type: "RPC_REQUEST",
             rpcName: "beginEditSession",
             params: {
-                editSessionMode
+                editSessionMode: 'all-rows'
             }
         });
         if (isRpcSuccess(rpcResponse)) {
             const { table: sessionTable } = rpcResponse.data;
             const columns = this.#sessionTableMessageColumn ? this.columns.concat(this.#sessionTableMessageColumn) : this.columns;
-            this.#sessionDataSource = new VuuDataSource({
+            const sessionDataSource = new VuuDataSource({
                 ...this.config,
                 columns,
                 table: sessionTable,
                 viewport: sessionTable.table
             });
-            this.#sessionDataSource.subscribe({
-                range: this.range
-            }, this.handleSessionMessageFromServer);
-        } else throw Error(`[VuuDataSource] beginEditSession ${rpcResponse.errorMessage}`);
+            sessionDataSource.#sourceTableDataSource = this;
+            return sessionDataSource;
+        }
+        throw Error(`[VuuDataSource] beginEditSession ${rpcResponse.errorMessage}`);
     }
     async editCell(key, column, data) {
-        const rpcHost = this.#sessionDataSource ?? this;
-        return rpcHost.rpcRequest?.({
+        return this.rpcRequest?.({
             type: "RPC_REQUEST",
             rpcName: "editCell",
             params: {
@@ -481,10 +478,7 @@ class VuuDataSource extends BaseDataSource {
     async endEditSession(saveChanges = false, force = false) {
         const type = "RPC_REQUEST";
         const rpcName = "endEditSession";
-        const sessionDataSource = this.#sessionDataSource;
-        const rpcHost = sessionDataSource ?? this;
-        if (sessionDataSource) this.#sessionDataSource = void 0;
-        const rpcResponse = await rpcHost.rpcRequest?.(saveChanges ? {
+        const rpcResponse = await this.rpcRequest(saveChanges ? {
             type,
             rpcName,
             params: {
@@ -497,12 +491,13 @@ class VuuDataSource extends BaseDataSource {
             params: {}
         });
         if (isRpcSuccess(rpcResponse)) {
-            if (sessionDataSource) sessionDataSource?.unsubscribe();
-        } else if (rpcResponse?.errorMessage === "stale update") {
-            this.#sessionDataSource = sessionDataSource;
-            throw new StaleUpdateError(rpcResponse.errorMessage);
-        } else throw Error("unknown error");
-        this.sendResumeMessage();
+            const sourceTableDataSource = this.#sourceTableDataSource;
+            if (sourceTableDataSource) {
+                this.#sourceTableDataSource = void 0;
+                this.unsubscribe();
+            } else this.sendResumeMessage();
+        } else if (rpcResponse?.errorMessage === "stale update") throw new StaleUpdateError(rpcResponse.errorMessage);
+        else throw Error(rpcResponse?.errorMessage ?? "endEditSession failed");
     }
     async rpcRequest(rpcRequest) {
         if (this.viewport && this.server) return this.server?.rpcCall({
@@ -524,8 +519,7 @@ class VuuDataSource extends BaseDataSource {
         return Promise.resolve("not supported");
     }
     async deleteRow(key, mode = "hard") {
-        const rpcHost = this.#sessionDataSource ?? this;
-        const response = await rpcHost.rpcRequest?.({
+        const response = await this.rpcRequest?.({
             type: "RPC_REQUEST",
             rpcName: "deleteRow",
             params: {
@@ -537,8 +531,7 @@ class VuuDataSource extends BaseDataSource {
         return response?.errorMessage ?? "deleteRow failed";
     }
     async deleteSelectedRows(mode = "soft") {
-        const rpcHost = this.#sessionDataSource ?? this;
-        const response = await rpcHost.rpcRequest?.({
+        const response = await this.rpcRequest?.({
             type: "RPC_REQUEST",
             rpcName: "deleteSelectedRows",
             params: {
@@ -562,8 +555,7 @@ class VuuDataSource extends BaseDataSource {
         return response?.errorMessage ?? "addRow failed";
     }
     async undoRowChange(key) {
-        const rpcHost = this.#sessionDataSource ?? this;
-        const response = await rpcHost.rpcRequest?.({
+        const response = await this.rpcRequest?.({
             type: "RPC_REQUEST",
             rpcName: "undoRowChange",
             params: {

package/types/VuuDataSource.d.ts

@@ -1,4 +1,4 @@
-import type { CopyOption, DataSourceBase, SessionType, DataSourceCallbackMessage, DataSourceConstructorProps, DataSourceStatus, DataSourceSubscribeCallback, DataSourceSubscribeProps, DeleteRowMode, EditSessionMode, OptimizeStrategy, SessionDataSourceOverrides, TableSchema, WithBaseFilter, WithFullConfig } from "@vuu-ui/vuu-data-types";
+import type { CopyOption, DataSource, DataSourceBase, SessionType, DataSourceCallbackMessage, DataSourceConstructorProps, DataSourceStatus, DataSourceSubscribeCallback, DataSourceSubscribeProps, DeleteRowMode, OptimizeStrategy, SessionDataSourceOverrides, TableSchema, WithBaseFilter, WithFullConfig } from "@vuu-ui/vuu-data-types";
 import type { MenuRpcResponse } from "@vuu-ui/vuu-data-types";
 import type { LinkDescriptorWithLabel, RpcResultError, RpcResultSuccess, SelectRequest, VuuGroupBy, VuuMenu, VuuRange, VuuRowDataItemType, VuuRpcMenuRequest, VuuRpcResponse, VuuRpcServiceRequest, VuuTable } from "@vuu-ui/vuu-protocol-types";
 import { BaseDataSource, Range } from "@vuu-ui/vuu-utils";
@@ -23,6 +23,7 @@ export declare class VuuDataSource extends BaseDataSource implements DataSourceB
      * some updates.
      */
     private sendResumeMessage;
+    isSessionDataSourceOf(dataSource: DataSource): boolean;
     resume(callback?: DataSourceSubscribeCallback): void;
     freeze(): void;
     unfreeze(): void;
@@ -59,8 +60,8 @@ export declare class VuuDataSource extends BaseDataSource implements DataSourceB
     set visualLink(visualLink: LinkDescriptorWithLabel | undefined);
     remoteProcedureCall<T extends VuuRpcResponse = VuuRpcResponse>(): Promise<T>;
     createSessionDataSource(copyOption: CopyOption, sessionType?: SessionType, overrides?: SessionDataSourceOverrides): Promise<VuuDataSource | undefined>;
-    beginEditSession(editSessionMode?: EditSessionMode): Promise<void>;
-    editCell(key: string, column: string, data: VuuRowDataItemType): Promise<RpcResultSuccess | RpcResultError | undefined>;
+    beginEditSession(): Promise<VuuDataSource>;
+    editCell(key: string, column: string, data: VuuRowDataItemType): Promise<RpcResultSuccess | RpcResultError>;
     endEditSession(saveChanges?: boolean, force?: boolean): Promise<void>;
     rpcRequest(rpcRequest: Omit<VuuRpcServiceRequest, "context">): Promise<RpcResultSuccess | RpcResultError>;
     menuRpcCall(rpcRequest: Omit<VuuRpcMenuRequest, "vpId">): Promise<MenuRpcResponse<any> | undefined>;