@vuu-ui/vuu-data-test 4.1.2 → 4.2.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.1.2",
+  "version": "4.2.0",
   "main": "./src/index.js",
   "author": "heswell",
   "license": "Apache-2.0",
@@ -8,13 +8,13 @@
     "type-defs": "node ../../scripts/build-type-defs.mjs"
   },
   "dependencies": {
-    "@vuu-ui/vuu-data-local": "4.1.2",
-    "@vuu-ui/vuu-utils": "4.1.2"
+    "@vuu-ui/vuu-data-local": "4.2.0",
+    "@vuu-ui/vuu-utils": "4.2.0"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-protocol-types": "4.1.2",
-    "@vuu-ui/vuu-data-types": "4.1.2",
-    "@vuu-ui/vuu-table-types": "4.1.2"
+    "@vuu-ui/vuu-protocol-types": "4.2.0",
+    "@vuu-ui/vuu-data-types": "4.2.0",
+    "@vuu-ui/vuu-table-types": "4.2.0"
   },
   "sideEffects": false,
   "files": [

package/src/core/module/VuuModule.js

@@ -22,6 +22,7 @@ class VuuModule {
         this.#sessionTableMessageColumn = sessionTableMessageColumn;
         ModuleContainer.register(this);
     }
+    validateEdit(_tableName, _column, _value) {}
     getTableSchema(tableName) {
         return this.schemas[tableName] ?? this.#sessionTableMap[tableName]?.schema;
     }
@@ -305,14 +306,20 @@ class VuuModule {
             const { column, data, key } = rpcRequest.params;
             const sessionTable = this.#sessionTableMap[viewPortId];
             let targetTable = sessionTable;
+            let sourceTableName = this.#sessionSourceTableMap[viewPortId];
             if (!targetTable) {
                 const { dataSource } = this.getSubscriptionByViewport(viewPortId);
-                if (dataSource.table) targetTable = this.tables[dataSource.table.table];
+                if (dataSource.table) {
+                    sourceTableName = dataSource.table.table;
+                    targetTable = this.tables[sourceTableName];
+                }
             }
             if (targetTable) try {
                 const sessionRow = sessionTable?.findByKey(key);
                 if (sessionRow?.[sessionTable.map.vuuAction] === "deleteRow") throw Error("editCell: cannot edit a deleted row");
                 assertUpdateIsValid(targetTable.schema, column, data);
+                const validationError = void 0 === sourceTableName ? void 0 : this.validateEdit(sourceTableName, column, data);
+                if (void 0 !== validationError) throw Error(validationError);
                 targetTable.update(key, column, data);
                 if (sessionTable && sessionTable.findByKey(key)?.[sessionTable.map.vuuAction] !== "addRow") sessionTable.update(key, "vuuAction", "editCell");
                 return {
@@ -460,6 +467,14 @@ class VuuModule {
                 errorMessage: `addRow: no active session table for viewport ${viewPortId}`
             };
             const { data, key } = rpcRequest.params;
+            const sourceTableName = this.#sessionSourceTableMap[sessionTableName];
+            if (void 0 !== sourceTableName) for (const [column, value] of Object.entries(data)){
+                const validationError = this.validateEdit(sourceTableName, column, value);
+                if (void 0 !== validationError) return {
+                    type: "ERROR_RESULT",
+                    errorMessage: validationError
+                };
+            }
             const keyColumn = sessionTable.schema.key;
             const rowKey = data[keyColumn] ?? key ?? uuid();
             const rowData = {

package/src/test/TestModule.js

@@ -39,6 +39,17 @@ const testEditColumns = [
         serverDataType: "long"
     }
 ];
+const TEST_EDIT_VALIDATION_QUANTITY_MESSAGE = "quantity must be between 1 and 1000";
+const TEST_EDIT_VALIDATION_PRICE_MESSAGE = "price must be greater than zero";
+const validateTestEditValidation = (column, value)=>{
+    if ("quantity" === column) {
+        const quantity = Number(value);
+        if (!Number.isInteger(quantity) || quantity < 1 || quantity > 1000) return TEST_EDIT_VALIDATION_QUANTITY_MESSAGE;
+    } else if ("price" === column) {
+        const price = Number(value);
+        if (!(price > 0)) return TEST_EDIT_VALIDATION_PRICE_MESSAGE;
+    }
+};
 class TestModule extends VuuModule {
     #schemas = {
         TestDates: {
@@ -185,6 +196,15 @@ class TestModule extends VuuModule {
                 module: "TEST",
                 table: "TestEdit"
             }
+        },
+        TestEditValidation: {
+            columns: testEditColumns,
+            key: "id",
+            rangeLimits: DEFAULT_RANGE_LIMITS,
+            table: {
+                module: "TEST",
+                table: "TestEditValidation"
+            }
         }
     };
     #tables = {
@@ -562,7 +582,49 @@ class TestModule extends VuuModule {
                 withNanoMs(Date.now(), 5),
                 1000000000000000005n
             ]
-        ], buildDataColumnMap(this.#schemas, "TestEdit"))
+        ], buildDataColumnMap(this.#schemas, "TestEdit")),
+        TestEditValidation: TableContainer.createTable(this.#schemas.TestEditValidation, [
+            [
+                "VAL-001",
+                "Alpha",
+                12,
+                101.25,
+                true,
+                1001
+            ],
+            [
+                "VAL-002",
+                "Bravo",
+                24,
+                202.5,
+                false,
+                1002
+            ],
+            [
+                "VAL-003",
+                "Charlie",
+                36,
+                303.75,
+                true,
+                1003
+            ],
+            [
+                "VAL-004",
+                "Delta",
+                48,
+                405,
+                true,
+                1004
+            ],
+            [
+                "VAL-005",
+                "Echo",
+                60,
+                506.25,
+                false,
+                1005
+            ]
+        ], buildDataColumnMap(this.#schemas, "TestEditValidation"))
     };
     constructor(){
         super("TEST");
@@ -577,6 +639,9 @@ class TestModule extends VuuModule {
         return this.#tables;
     }
     get visualLinks() {}
+    validateEdit(tableName, column, value) {
+        return "TestEditValidation" === tableName ? validateTestEditValidation(column, value) : void 0;
+    }
 }
 const testModule = new TestModule();
-export { testModule };
+export { TEST_EDIT_VALIDATION_PRICE_MESSAGE, TEST_EDIT_VALIDATION_QUANTITY_MESSAGE, testModule };

package/types/core/module/VuuModule.d.ts

@@ -1,5 +1,5 @@
 import type { DataSourceBase, DataSourceConfig, DataSourceRowWithBigint, DataSourceSubscribedMessage, DataSourceVisualLinkCreatedMessage, EditSessionMode, CopyOption, SessionDataSourceOverrides, SessionType, TableSchema } from "@vuu-ui/vuu-data-types";
-import type { VuuMenu, VuuLink, LinkDescriptorWithLabel, VuuRpcMenuResponse, VuuCreateVisualLink, VuuRemoveVisualLink, VuuRpcServiceRequest, RpcResultSuccess, RpcResultError, VuuRpcMenuRequest } from "@vuu-ui/vuu-protocol-types";
+import type { VuuMenu, VuuRowDataItemType, VuuLink, LinkDescriptorWithLabel, VuuRpcMenuResponse, VuuCreateVisualLink, VuuRemoveVisualLink, VuuRpcServiceRequest, RpcResultSuccess, RpcResultError, VuuRpcMenuRequest } from "@vuu-ui/vuu-protocol-types";
 import { Table } from "../../Table";
 import { TickingArrayDataSource } from "../../TickingArrayDataSource";
 export interface IVuuModule<T extends string = string> {
@@ -38,6 +38,12 @@ export declare abstract class VuuModule<T extends string = string> implements IV
     protected abstract menuServices?: Record<T, RpcMenuService[] | undefined> | undefined;
     protected abstract services?: Record<T, RpcService[] | undefined> | undefined;
     protected abstract visualLinks?: Record<T, VuuLink[] | undefined>;
+    /**
+     * Server-side validation applied to every value submitted by editCell and
+     * addRow. `tableName` is the source table, also when the edit targets a
+     * session table. Return a message to reject the value, undefined to accept.
+     */
+    protected validateEdit(_tableName: T, _column: string, _value: VuuRowDataItemType): string | undefined;
     getTableSchema(tableName: string): Record<T, Readonly<TableSchema>>[T];
     getTableList(): string[];
     protected handlePostSubscribeActivities: ({ clientViewportId, tableSchema, }: DataSourceSubscribedMessage) => void;

package/types/test/TestModule.d.ts

@@ -1,7 +1,10 @@
 import { type RpcMenuService, VuuModule } from "../core/module/VuuModule";
 import { type Table } from "../Table";
 import type { TableSchema } from "@vuu-ui/vuu-data-types";
-export type TestTableName = "TestDates" | "TwoHundredColumns" | "LinkParent" | "LinkChild" | "ChartTable" | "MaxScrollEndTable" | "TestEditEmpty" | "TestEdit";
+import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+export type TestTableName = "TestDates" | "TwoHundredColumns" | "LinkParent" | "LinkChild" | "ChartTable" | "MaxScrollEndTable" | "TestEditEmpty" | "TestEdit" | "TestEditValidation";
+export declare const TEST_EDIT_VALIDATION_QUANTITY_MESSAGE = "quantity must be between 1 and 1000";
+export declare const TEST_EDIT_VALIDATION_PRICE_MESSAGE = "price must be greater than zero";
 declare class TestModule extends VuuModule<TestTableName> {
     #private;
     constructor();
@@ -11,6 +14,7 @@ declare class TestModule extends VuuModule<TestTableName> {
     get schemas(): Record<TestTableName, TableSchema>;
     get tables(): Record<TestTableName, Table>;
     get visualLinks(): undefined;
+    protected validateEdit(tableName: TestTableName, column: string, value: VuuRowDataItemType): string | undefined;
 }
 export declare const testModule: TestModule;
 export {};