@heswell/vuu-portal 2.2.5 → 2.4.0

package/195.js

@@ -410,6 +410,10 @@ const managedModuleKeys = [
     "navIconUrl",
     "accessRole"
 ];
+const navEntryKeys = [
+    "location",
+    "path"
+];
 const optionalModuleKeys = [
     "navOrder",
     "navBadge",
@@ -426,7 +430,7 @@ function parseManagedModule(value, index) {
     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];
+        const fieldValue = void 0 === value[key] && navEntryKeys.includes(key) ? "" : value[key];
         if (void 0 === fieldValue) throw new Error(`Modules file entry ${index} is missing '${key}'`);
         const expected = [
             "id",

package/README.md

@@ -166,6 +166,12 @@ for the field. In [`default-modules.yaml`](./default-modules.yaml):
 | `vuu-table-browser` | none | It is itself a workspace page; its tables are in the palette's Tables tab |
 | `vuu-table-viewer` | none | Nested module; it only works inside the table browser |
 
+A top-level module with a `workspace` descriptor may leave `location` and
+`path` empty (or omit them from the YAML) to be offered only in the palette,
+with no nav entry or route. It is still sent in `LOGIN_SUCCESS`, with an empty
+`navLocation` and `path`. Top-level modules without `workspace` still need
+both.
+
 The seed only applies when `modules.yaml` is first created. To change an
 existing deployment, edit `modules.yaml` or use the module admin
 (`updateModule` with `workspace`, or `workspace: null` to remove a module from

package/config/default-modules.yaml

@@ -23,7 +23,8 @@
 #     navOrder: 1
 #     navBadge: "modules.pending"
 #     notificationTopics: ["modules"]
-#     # Optional: list the module in the workspace Panels palette.
+#     # Optional: list the module in the workspace Panels palette. With it,
+#     # location and path may be "" (or omitted) for a palette-only module.
 #     workspace:
 #       paletteGroup: "Admin"
 #       iconUrl: ""            # optional; data:image/... or http(s) URL

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heswell/vuu-portal",
-  "version": "2.2.5",
+  "version": "2.4.0",
   "description": "VUU portal server with remote module discovery",
   "type": "module",
   "main": "./index.js",
@@ -26,12 +26,12 @@
   "author": "heswell",
   "license": "MIT",
   "dependencies": {
-    "@heswell/module-admin": "^2.2.0"
+    "@heswell/module-admin": "^2.3.0"
   },
   "peerDependencies": {
     "@heswell/vuu-server": "^3.1.0 || ^4.0.0",
     "@heswell/vuu-table": "^1.0.1",
-    "@vuu-ui/vuu-protocol-types": "^4.0.0-alpha.26"
+    "@vuu-ui/vuu-protocol-types": "^5.0.0-alpha.2"
   },
   "repository": {
     "type": "git",