@heswell/vuu-portal 2.2.0 → 2.2.2

package/195.js

@@ -1,5 +1,5 @@
-import { ConfigFactory, EditSessionRpcHandler, ModuleFactory, Provider, TableDef, VUU_DEFAULT_COLUMNS, ViewPortDef, createConfiguredAuthProviders, createVuuServerApplication, getLogger } from "@heswell/vuu-server";
-import { MODULE_ADMIN_RPC, executeModuleAdminRpc, managedModuleColumnValues, managedModulePermissionValues, validateModuleConfig } from "@heswell/module-admin";
+import { MODULE_ADMIN_RPC, executeModuleAdminRpc, managedModuleColumnValues, managedModulePermissionValues, splitNotificationTopics, validateModuleConfig } from "@heswell/module-admin";
+import { ConfigFactory, EditSessionRpcHandler, ModuleFactory, NotificationModule, NullProvider, PermissionFilter, Provider, TableDef, VUU_DEFAULT_COLUMNS, ViewPortDef, createConfiguredAuthProviders, createVuuServerApplication, getLogger } from "@heswell/vuu-server";
 import node_fs from "node:fs";
 import node_path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -31,7 +31,8 @@ function readModules(table) {
             mfComponent: stringValue(table, row, "mfComponent"),
             mfScope: stringValue(table, row, "mfScope"),
             mfUrl: stringValue(table, row, "mfUrl"),
-            ...navIcon(table, row)
+            ...navIcon(table, row),
+            ...navMetadata(table, row)
         };
     });
 }
@@ -41,6 +42,23 @@ function navIcon(table, row) {
         navIconUrl
     } : {};
 }
+function navMetadata(table, row) {
+    const metadata = {};
+    const navOrder = optionalValue(table, row, "navOrder");
+    if ("number" == typeof navOrder && Number.isFinite(navOrder)) metadata.navOrder = navOrder;
+    const navBadge = optionalValue(table, row, "navBadge");
+    if ("string" == typeof navBadge && navBadge) metadata.navBadge = navBadge;
+    const topics = optionalValue(table, row, "notificationTopics");
+    if ("string" == typeof topics) {
+        const notificationTopics = splitNotificationTopics(topics);
+        if (notificationTopics.length) metadata.notificationTopics = notificationTopics;
+    }
+    return metadata;
+}
+function optionalValue(table, row, column) {
+    const index = table.tableDef.columns.findIndex(({ name })=>name === column);
+    return -1 === index ? void 0 : row[index];
+}
 function readModulePermissions(table) {
     return table.rows.map((row)=>({
             moduleId: numberValue(table, row, "module_id"),
@@ -70,7 +88,13 @@ function selectModules(modules, modulePermissions, authorizations) {
         ...latestByName.values()
     ];
     const permittedIds = new Set(permittedModules.map(({ id })=>id));
-    return permittedModules.filter(({ parentModuleId })=>0 === parentModuleId || permittedIds.has(parentModuleId)).map(({ parentModuleId: _parentModuleId, ...module })=>module).sort((left, right)=>left.name.localeCompare(right.name));
+    return permittedModules.filter(({ parentModuleId })=>0 === parentModuleId || permittedIds.has(parentModuleId)).map(({ parentModuleId: _parentModuleId, ...module })=>module).sort(compareModules);
+}
+function compareModules(left, right) {
+    const leftOrder = left.navOrder ?? 1 / 0;
+    const rightOrder = right.navOrder ?? 1 / 0;
+    if (leftOrder !== rightOrder) return leftOrder < rightOrder ? -1 : 1;
+    return left.name.localeCompare(right.name);
 }
 function accessRoleForModule(module, moduleRoles, permittedModuleRoles) {
     const ownRole = permittedModuleRoles.get(module.id);
@@ -152,6 +176,18 @@ const modulesTable = TableDef({
             name: "navIconUrl",
             dataType: "string"
         },
+        {
+            name: "navOrder",
+            dataType: "double"
+        },
+        {
+            name: "navBadge",
+            dataType: "string"
+        },
+        {
+            name: "notificationTopics",
+            dataType: "string"
+        },
         ...VUU_DEFAULT_COLUMNS
     ],
     keyField: "id",
@@ -332,9 +368,12 @@ function readModulesFile(filePath) {
     return parsed.modules;
 }
 function cloneModules(modules) {
-    return modules.map((module)=>({
-            ...module
-        }));
+    return modules.map((module)=>Object.fromEntries(Object.entries(module).filter(([, value])=>void 0 !== value).map(([key, value])=>[
+                key,
+                Array.isArray(value) ? [
+                    ...value
+                ] : value
+            ])));
 }
 const managedModuleKeys = [
     "id",
@@ -354,6 +393,11 @@ const managedModuleKeys = [
     "navIconUrl",
     "accessRole"
 ];
+const optionalModuleKeys = [
+    "navOrder",
+    "navBadge",
+    "notificationTopics"
+];
 const retiredModuleKeys = [
     "vuuConnectionId",
     "vuuWebsocketUrl",
@@ -361,7 +405,7 @@ const retiredModuleKeys = [
 ];
 function parseManagedModule(value, index) {
     if (!isRecord(value)) throw new Error(`Modules file entry ${index} must be an object`);
-    for (const key of Object.keys(value))if (!managedModuleKeys.includes(key) && !retiredModuleKeys.includes(key)) throw new Error(`Modules file entry ${index} contains unknown field '${key}'`);
+    for (const key of Object.keys(value))if (!managedModuleKeys.includes(key) && !optionalModuleKeys.includes(key) && !retiredModuleKeys.includes(key)) throw new Error(`Modules file entry ${index} contains unknown field '${key}'`);
     const module = {};
     for (const key of managedModuleKeys){
         const fieldValue = value[key];
@@ -377,6 +421,18 @@ function parseManagedModule(value, index) {
         if ("number" === expected && !Number.isInteger(fieldValue)) throw new Error(`Modules file entry ${index} field '${key}' must be an integer`);
         module[key] = fieldValue;
     }
+    for (const key of optionalModuleKeys){
+        const fieldValue = value[key];
+        if (null == fieldValue) continue;
+        const valid = "navOrder" === key ? "number" == typeof fieldValue : "navBadge" === key ? "string" == typeof fieldValue : Array.isArray(fieldValue) && fieldValue.every((topic)=>"string" == typeof topic);
+        if (!valid) {
+            const expected = "navOrder" === key ? "a number" : "navBadge" === key ? "a string" : "a list of strings";
+            throw new Error(`Modules file entry ${index} field '${key}' must be ${expected}`);
+        }
+        module[key] = Array.isArray(fieldValue) ? [
+            ...fieldValue
+        ] : fieldValue;
+    }
     return module;
 }
 function assertValidManagedModules(modules, filePath) {
@@ -498,6 +554,10 @@ function createPortalApplication({ config, configFile } = {}) {
                 moduleRegistry: createModuleRegistry(tableContainer, user)
             }),
         modules: [
+            NotificationModule((table)=>new NullProvider(table), (viewport)=>PermissionFilter("audience", new Set([
+                    "all",
+                    viewport.user.name
+                ])), (table)=>ViewPortDef["default"](table.tableDef.columns)),
             ModuleDiscoveryModule(loadModuleState(portalConfig), {
                 adminRole: loadModuleAdminRole(portalConfig)
             })

package/README.md

@@ -1,7 +1,7 @@
 # @heswell/vuu-portal
 
 Vuu portal server: a [`@heswell/vuu-server`](../vuu-server) application that
-hosts the `MODULE_DISCOVERY` module and returns each user's module registry in
+hosts the `MODULE_DISCOVERY` and `NOTIFICATIONS` modules and returns each user's module registry in
 the login response. Requires the [Bun](https://bun.sh) runtime to run the
 server. The library exports can be imported under Node.js too.
 

package/config/default-modules.yaml

@@ -19,4 +19,8 @@
 #     mfUrl: "http://localhost:5002"
 #     navIconUrl: ""
 #     accessRole: "module-admin-access"
+#     # Optional nav metadata:
+#     navOrder: 1
+#     navBadge: "modules.pending"
+#     notificationTopics: ["modules"]
 modules: []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heswell/vuu-portal",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "VUU portal server with remote module discovery",
   "type": "module",
   "main": "./index.js",
@@ -26,7 +26,7 @@
   "author": "heswell",
   "license": "MIT",
   "dependencies": {
-    "@heswell/module-admin": "^2.0.1"
+    "@heswell/module-admin": "^2.1.0"
   },
   "peerDependencies": {
     "@heswell/vuu-server": "^3.1.0 || ^4.0.0",

package/src/modules/ModuleDiscovery/ModuleStore.d.ts

@@ -6,48 +6,14 @@ export interface ModuleStore {
 export declare class InMemoryModuleStore implements ModuleStore {
     private modules;
     constructor(modules?: readonly ManagedModule[]);
-    load(): {
-        parentModuleId: number;
-        name: string;
-        title: string;
-        description: string;
-        enabled: boolean;
-        location: string;
-        path: string;
-        mfComponent: string;
-        mfScope: string;
-        mfUrl: string;
-        navIconUrl: string;
-        accessRole: string;
-        id: number;
-        version: number;
-        created: number;
-        updated: number;
-    }[];
+    load(): ManagedModule[];
     save(modules: readonly ManagedModule[]): void;
 }
 export declare class ModuleState {
     #private;
     private readonly store;
     constructor(store: ModuleStore, modules: readonly ManagedModule[]);
-    get modules(): {
-        parentModuleId: number;
-        name: string;
-        title: string;
-        description: string;
-        enabled: boolean;
-        location: string;
-        path: string;
-        mfComponent: string;
-        mfScope: string;
-        mfUrl: string;
-        navIconUrl: string;
-        accessRole: string;
-        id: number;
-        version: number;
-        created: number;
-        updated: number;
-    }[];
+    get modules(): ManagedModule[];
     replaceAndSave(modules: readonly ManagedModule[]): void;
 }
 export declare class YamlModuleStore implements ModuleStore {