@heswell/vuu-portal 2.2.3 → 2.2.4

package/195.js

@@ -1,4 +1,4 @@
-import { MODULE_ADMIN_RPC, executeModuleAdminRpc, managedModuleColumnValues, managedModulePermissionValues, splitNotificationTopics, validateModuleConfig } from "@heswell/module-admin";
+import { MODULE_ADMIN_RPC, deserializeModuleWorkspace, executeModuleAdminRpc, managedModuleColumnValues, managedModulePermissionValues, normalizeModuleWorkspace, 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";
@@ -32,7 +32,8 @@ function readModules(table) {
             mfScope: stringValue(table, row, "mfScope"),
             mfUrl: stringValue(table, row, "mfUrl"),
             ...navIcon(table, row),
-            ...navMetadata(table, row)
+            ...navMetadata(table, row),
+            ...workspaceMetadata(table, row)
         };
     });
 }
@@ -55,6 +56,12 @@ function navMetadata(table, row) {
     }
     return metadata;
 }
+function workspaceMetadata(table, row) {
+    const workspace = deserializeModuleWorkspace(optionalValue(table, row, "workspace"));
+    return workspace ? {
+        workspace
+    } : {};
+}
 function optionalValue(table, row, column) {
     const index = table.tableDef.columns.findIndex(({ name })=>name === column);
     return -1 === index ? void 0 : row[index];
@@ -188,6 +195,10 @@ const modulesTable = TableDef({
             name: "notificationTopics",
             dataType: "string"
         },
+        {
+            name: "workspace",
+            dataType: "string"
+        },
         ...VUU_DEFAULT_COLUMNS
     ],
     keyField: "id",
@@ -370,11 +381,17 @@ function readModulesFile(filePath) {
 function cloneModules(modules) {
     return modules.map((module)=>Object.fromEntries(Object.entries(module).filter(([, value])=>void 0 !== value).map(([key, value])=>[
                 key,
-                Array.isArray(value) ? [
-                    ...value
-                ] : value
+                cloneValue(value)
             ])));
 }
+function cloneValue(value) {
+    if (Array.isArray(value)) return value.map(cloneValue);
+    if (isRecord(value)) return Object.fromEntries(Object.entries(value).map(([key, item])=>[
+            key,
+            cloneValue(item)
+        ]));
+    return value;
+}
 const managedModuleKeys = [
     "id",
     "version",
@@ -396,7 +413,8 @@ const managedModuleKeys = [
 const optionalModuleKeys = [
     "navOrder",
     "navBadge",
-    "notificationTopics"
+    "notificationTopics",
+    "workspace"
 ];
 const retiredModuleKeys = [
     "vuuConnectionId",
@@ -424,6 +442,11 @@ function parseManagedModule(value, index) {
     for (const key of optionalModuleKeys){
         const fieldValue = value[key];
         if (null == fieldValue) continue;
+        if ("workspace" === key) {
+            if (!isRecord(fieldValue)) throw new Error(`Modules file entry ${index} field 'workspace' must be an object`);
+            module[key] = cloneValue(normalizeModuleWorkspace(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";

package/config/default-modules.yaml

@@ -12,7 +12,7 @@
 #     title: "Manage remote modules"
 #     description: "Create new remote module, update existing modules"
 #     enabled: true
-#     location: "/Modules/Manage Modules"
+#     location: "/Admin/Manage Modules"
 #     path: "/modules/admin"
 #     mfComponent: "ModuleAdmin"
 #     mfScope: "moduleAdmin"
@@ -23,4 +23,9 @@
 #     navOrder: 1
 #     navBadge: "modules.pending"
 #     notificationTopics: ["modules"]
+#     # Optional: list the module in the workspace Panels palette.
+#     workspace:
+#       paletteGroup: "Admin"
+#       iconUrl: ""            # optional; data:image/... or http(s) URL
+#       defaultSize: { cols: 6, rows: 4 }  # optional; positive integers
 modules: []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heswell/vuu-portal",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "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.1.0"
+    "@heswell/module-admin": "^2.2.0"
   },
   "peerDependencies": {
     "@heswell/vuu-server": "^3.1.0 || ^4.0.0",