@vuu-ui/vuu-data-test 4.0.0-alpha.20 → 4.0.0-alpha.21

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.0.0-alpha.20",
+  "version": "4.0.0-alpha.21",
   "main": "./src/index.js",
   "type": "module",
   "author": "heswell",
@@ -12,14 +12,14 @@
   "dependencies": {
     "@heswell/module-admin": "1.1.0",
     "@heswell/user-admin": "1.0.1",
-    "@vuu-ui/vuu-data-editing": "4.0.0-alpha.20",
-    "@vuu-ui/vuu-data-local": "4.0.0-alpha.20",
-    "@vuu-ui/vuu-utils": "4.0.0-alpha.20"
+    "@vuu-ui/vuu-data-editing": "4.0.0-alpha.21",
+    "@vuu-ui/vuu-data-local": "4.0.0-alpha.21",
+    "@vuu-ui/vuu-utils": "4.0.0-alpha.21"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "4.0.0-alpha.20",
-    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.20",
-    "@vuu-ui/vuu-table-types": "4.0.0-alpha.20"
+    "@vuu-ui/vuu-data-types": "4.0.0-alpha.21",
+    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.21",
+    "@vuu-ui/vuu-table-types": "4.0.0-alpha.21"
   },
   "sideEffects": false,
   "files": [

package/src/TickingArrayDataSource.js

@@ -181,14 +181,19 @@ class TickingArrayDataSource extends ArrayDataSource {
     get columns() {
         return super.columns;
     }
-    async endEditSession(saveChanges = false) {
+    async endEditSession(saveChanges = false, force = false) {
+        if ("unsubscribed" === this.status || !this.viewport) {
+            if (!saveChanges) return;
+            throw Error("Cannot save changes: datasource is unsubscribed");
+        }
         const type = "RPC_REQUEST";
         const rpcName = "endEditSession";
         const rpcResponse = await this.rpcRequest(saveChanges ? {
             type,
             rpcName,
             params: {
-                save: true
+                save: true,
+                force
             }
         } : {
             type,

package/src/core/module/VuuModule.js

@@ -501,7 +501,9 @@ class VuuModule {
             sessionTable.insert(row);
             return {
                 type: "SUCCESS_RESULT",
-                data: void 0
+                data: {
+                    key: rowKey
+                }
             };
         }
         return {

package/src/local-datasource-provider/LocalDatasourceProvider.js

@@ -2,16 +2,26 @@ import { jsx } from "react/jsx-runtime";
 import { DataProvider } from "@vuu-ui/core";
 import { DataProvider as vuu_utils_DataProvider } from "@vuu-ui/vuu-utils";
 import ModuleContainer, { ensureVuuModule } from "../core/module/ModuleContainer.js";
-import TableContainer from "../core/table/TableContainer.js";
-const createLocalDataSourceProvider = (moduleNames)=>{
+const createLocalDataSourceProvider = (modules)=>{
+    const ownModules = modules ? new Map(modules.map((module)=>[
+            module.name,
+            module
+        ])) : void 0;
     const getModule = (moduleName)=>{
-        if (moduleNames && !moduleNames.has(moduleName)) throw Error(`[LocalDataSourceProvider] module ${moduleName} is not available on this server`);
+        if (ownModules) {
+            const module = ownModules.get(moduleName);
+            if (module) return module;
+            throw Error(`[LocalDataSourceProvider] module ${moduleName} is not available on this server`);
+        }
         return ModuleContainer.get(moduleName);
     };
     const serverAPI = {
         getTableList: async ()=>{
             const tables = [];
-            for (const moduleName of moduleNames ?? ModuleContainer.moduleNames)for (const tableName of getModule(moduleName).getTableList())tables.push(TableContainer.getTable(tableName).schema.table);
+            for (const moduleName of ownModules?.keys() ?? ModuleContainer.moduleNames){
+                const module = getModule(moduleName);
+                for (const tableName of module.getTableList())tables.push(module.getTableSchema(tableName).table);
+            }
             return {
                 tables
             };
@@ -54,7 +64,7 @@ const createLocalVuuServer = ({ connectionId, modules })=>{
     modules.forEach(ensureVuuModule);
     return {
         connectionId,
-        DataSourceProvider: createLocalDataSourceProvider(new Set(modules.map(({ name })=>name)))
+        DataSourceProvider: createLocalDataSourceProvider(modules)
     };
 };
 export { LocalDataSourceProvider, createLocalVuuServer };

package/src/module-admin/ModuleAdminModule.js

@@ -46,9 +46,9 @@ const EXAMPLE_MODULES = [
         mfScope: "orderBlotter",
         mfUrl: "http://localhost:5009",
         navIconUrl: MODULE_NAV_ICONS.tables,
-        vuuConnectionId: "orders",
-        vuuWebsocketUrl: "wss://localhost:8095/websocket-orders",
-        vuuRestUrl: "https://localhost:8447/api/authn",
+        vuuConnectionId: "",
+        vuuWebsocketUrl: "",
+        vuuRestUrl: "",
         accessRole: "",
         created: INITIAL_TIMESTAMP,
         updated: INITIAL_TIMESTAMP

package/src/module-admin/module-admin-schemas.js

@@ -55,18 +55,6 @@ const MODULE_ADMIN_TABLE_SCHEMAS = {
                 name: "mfUrl",
                 serverDataType: "string"
             },
-            {
-                name: "vuuConnectionId",
-                serverDataType: "string"
-            },
-            {
-                name: "vuuWebsocketUrl",
-                serverDataType: "string"
-            },
-            {
-                name: "vuuRestUrl",
-                serverDataType: "string"
-            },
             {
                 name: "navIconUrl",
                 serverDataType: "string"

package/src/notifications/NotificationModule.js

@@ -25,6 +25,8 @@ const VUU_DEFAULT_COLUMNS = [
 class NotificationModule extends VuuModule {
     static NAME = NAME;
     static TABLE_NAME = TABLE_NAME;
+    #autoStarted = false;
+    #expiryTimers = new Map();
     #provider;
     #running = false;
     #schemas;
@@ -60,7 +62,42 @@ class NotificationModule extends VuuModule {
         };
     }
     beforeCreateDataSource() {
-        this.start();
+        if (!this.#autoStarted) {
+            this.#autoStarted = true;
+            this.start();
+        }
+    }
+    publish(notification = {}) {
+        const table = this.#tables[TABLE_NAME];
+        const { map, schema } = table;
+        const id = notification.id ?? crypto.randomUUID();
+        const values = {
+            type: "toast",
+            title: "Notification",
+            message: "",
+            level: "INFO",
+            audience: "all",
+            ...notification,
+            id
+        };
+        const row = schema.columns.map(({ serverDataType })=>"string" === serverDataType ? "" : "boolean" === serverDataType ? false : 0);
+        for (const [name, value] of Object.entries(values)){
+            const idx = map[name];
+            if (void 0 !== idx && void 0 !== value) row[idx] = value;
+        }
+        const existingRow = table.findByKey(id);
+        if (existingRow) {
+            row[map.vuuCreatedTimestamp] = existingRow[map.vuuCreatedTimestamp];
+            table.updateRow(row);
+        } else table.insert(row);
+        clearTimeout(this.#expiryTimers.get(id));
+        this.#expiryTimers.delete(id);
+        const { expiryTime } = values;
+        if ("number" == typeof expiryTime && expiryTime > 0) this.#expiryTimers.set(id, setTimeout(()=>{
+            this.#expiryTimers.delete(id);
+            if (table.findByKey(id)) table.delete(id);
+        }, Math.max(0, expiryTime - Date.now())));
+        return id;
     }
     get isRunning() {
         return this.#running;
@@ -72,6 +109,7 @@ class NotificationModule extends VuuModule {
         }
     }
     stop() {
+        this.#autoStarted = true;
         if (this.#running) {
             this.#running = false;
             this.#provider.stop();

package/src/notifications/simulated/SimulatedNotificationsModule.js

@@ -2,7 +2,11 @@ import { PermissionFilter } from "../../core/filter/PermissionFilter.js";
 import { NotificationModule } from "../NotificationModule.js";
 import { DismissNotificationRpcHandler } from "./DismissNotificationRpcHandler.js";
 import { SimulatedNotificationsProvider } from "./SimulatedNotificationsProvider.js";
-const SimulatedNotificationsModule = ()=>new NotificationModule((table)=>new SimulatedNotificationsProvider(table), (viewport)=>{
+const noSimulation = {
+    start: ()=>void 0,
+    stop: ()=>void 0
+};
+const SimulatedNotificationsModule = ({ simulate = true } = {})=>new NotificationModule((table)=>simulate ? new SimulatedNotificationsProvider(table) : noSimulation, (viewport)=>{
         const currentUser = viewport.user.name;
         return PermissionFilter("audience", new Set([
             "all",

package/types/TickingArrayDataSource.d.ts

@@ -33,7 +33,7 @@ export declare class TickingArrayDataSource extends ArrayDataSource {
     undoRowChange: (key: string) => Promise<RpcResultSuccess | RpcResultError>;
     set columns(columns: string[]);
     get columns(): string[];
-    endEditSession(saveChanges?: boolean): Promise<void>;
+    endEditSession(saveChanges?: boolean, force?: boolean): Promise<void>;
     rpcRequest(rpcRequest: Omit<VuuRpcServiceRequest, "context">): Promise<RpcResultSuccess | RpcResultError>;
     menuRpcCall(rpcRequest: Omit<VuuRpcMenuRequest, "vpId">): Promise<VuuRpcMenuResponse>;
     getTypeaheadSuggestions(column: string, pattern?: string): Promise<string[]>;

package/types/local-datasource-provider/LocalDatasourceProvider.d.ts

@@ -4,7 +4,7 @@ import type { VuuModule } from "../core/module/VuuModule";
 /** Data context covering every VuuModule registered in the browser. */
 export declare const LocalDataSourceProvider: ({ children }: {
     children: ReactNode;
-}) => import("react").JSX.Element;
+}) => import("react/jsx-runtime").JSX.Element;
 export interface LocalVuuServerOptions {
     /** Matches the `vuu.connectionId` of the modules this server serves. */
     connectionId: string;
@@ -12,7 +12,9 @@ export interface LocalVuuServerOptions {
 }
 /**
  * Simulates a Vuu server in the browser, publishing the tables of the given
- * modules. Pass the result to a local-mode `AuthenticationProvider` as one of
+ * modules. Module instances are resolved from this server, not by name from
+ * the global registry, so servers can each have their own instance of a
+ * module (e.g. NOTIFICATIONS). Pass the result to a local-mode `AuthenticationProvider` as one of
  * its `localServers`.
  */
 export declare const createLocalVuuServer: ({ connectionId, modules, }: LocalVuuServerOptions) => LocalVuuServer;

package/types/notifications/NotificationModule.d.ts

@@ -1,4 +1,5 @@
 import type { TableSchema } from "@vuu-ui/vuu-data-types";
+import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
 import { type RpcService, VuuModule } from "../core/module/VuuModule";
 import type { PermissionFunction } from "../core/filter/PermissionFilter";
 import { type Table } from "../Table";
@@ -13,6 +14,20 @@ export interface NotificationsProvider {
     stop: () => void;
 }
 export type NotificationsProviderFactory = (table: Table) => NotificationsProvider;
+/**
+ * A notification to publish. Values are keyed by column name; columns not
+ * supplied are defaulted. `expiryTime` (epoch ms) schedules deletion of the row.
+ */
+export interface NotificationInput {
+    id?: string;
+    type?: string;
+    expiryTime?: number;
+    title?: string;
+    message?: string;
+    level?: string;
+    audience?: string;
+    [columnName: string]: VuuRowDataItemType | undefined;
+}
 export type NotificationsServiceFactory = (table: Table, module: NotificationModule) => RpcService[];
 /**
  * A generic Notifications module, exposing a single 'notifications' table.
@@ -27,6 +42,12 @@ export declare class NotificationModule extends VuuModule<NotificationsTableName
     static readonly TABLE_NAME: "notifications";
     constructor(providerFactory: NotificationsProviderFactory, permissionFunction: PermissionFunction, serviceFactory: NotificationsServiceFactory, ...additionalColumns: ColumnDefinition[]);
     protected beforeCreateDataSource(): void;
+    /**
+     * Inserts a notification row, as a server-side publisher would. Defaults:
+     * a random `id`, `type` "toast", `level` "INFO", `audience` "all" and
+     * empty strings for other string columns. Returns the row id.
+     */
+    publish(notification?: NotificationInput): string;
     get isRunning(): boolean;
     start(): void;
     stop(): void;

package/types/notifications/simulated/SimulatedNotificationsModule.d.ts

@@ -1,2 +1,9 @@
 import { NotificationModule } from "../NotificationModule";
-export declare const SimulatedNotificationsModule: () => NotificationModule;
+export interface SimulatedNotificationsModuleOptions {
+    /**
+     * Generate random notifications. When false, notifications are only
+     * created by calls to `publish`. Default true.
+     */
+    simulate?: boolean;
+}
+export declare const SimulatedNotificationsModule: ({ simulate, }?: SimulatedNotificationsModuleOptions) => NotificationModule;