@jskit-ai/console-web 0.1.4 → 0.1.7

package/package.descriptor.mjs

@@ -1,20 +1,20 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/console-web",
-  version: "0.1.4",
+  version: "0.1.7",
   kind: "runtime",
   description: "Authenticated console surface scaffold and surface policy wiring.",
   dependsOn: [
     "@jskit-ai/auth-web",
+    "@jskit-ai/console-core",
     "@jskit-ai/shell-web",
-    "@jskit-ai/users-core"
   ],
   capabilities: {
     provides: [
       "console.web"
     ],
     requires: [
-      "users.core"
+      "console.core"
     ]
   },
   runtime: {
@@ -37,14 +37,37 @@ export default Object.freeze({
         server: [],
         client: []
       }
+    },
+    ui: {
+      placements: {
+        outlets: [
+          {
+            target: "console-settings:primary-menu",
+            defaultLinkComponentToken: "local.main.ui.surface-aware-menu-link-item",
+            surfaces: ["console"],
+            source: "templates/src/pages/console/settings.vue"
+          }
+        ],
+        contributions: [
+          {
+            id: "console.web.menu.settings",
+            target: "shell-layout:primary-menu",
+            surfaces: ["console"],
+            order: 100,
+            componentToken: "local.main.ui.menu-link-item",
+            when: "auth.authenticated === true",
+            source: "mutations.text#console-web-console-settings-placement"
+          }
+        ]
+      }
     }
   },
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/auth-web": "0.1.38",
-        "@jskit-ai/shell-web": "0.1.36",
-        "@jskit-ai/users-core": "0.1.47"
+        "@jskit-ai/auth-web": "0.1.40",
+        "@jskit-ai/console-core": "0.1.2",
+        "@jskit-ai/shell-web": "0.1.38",
       },
       dev: {}
     },
@@ -74,6 +97,24 @@ export default Object.freeze({
         reason: "Install shell-driven console page starter.",
         category: "console-web",
         id: "console-web-page-console"
+      },
+      {
+        from: "templates/src/pages/console/settings.vue",
+        toSurface: "console",
+        toSurfacePath: "settings.vue",
+        ownership: "app",
+        reason: "Install console settings shell route scaffold for console-web.",
+        category: "console-web",
+        id: "console-web-page-console-settings-shell"
+      },
+      {
+        from: "templates/src/pages/console/settings/index.vue",
+        toSurface: "console",
+        toSurfacePath: "settings/index.vue",
+        ownership: "app",
+        reason: "Install console settings index stub scaffold for app-owned landing or redirect behavior.",
+        category: "console-web",
+        id: "console-web-page-console-settings"
       }
     ],
     text: [
@@ -93,10 +134,21 @@ export default Object.freeze({
         position: "bottom",
         skipIfContains: "config.surfaceDefinitions.console = {",
         value:
-          "\nconfig.surfaceDefinitions.console = {\n  id: \"console\",\n  label: \"Console\",\n  pagesRoot: \"console\",\n  enabled: true,\n  requiresAuth: true,\n  requiresWorkspace: false,\n  accessPolicyId: \"console_owner\",\n  origin: \"\"\n};\n",
+          "\nconfig.surfaceDefinitions.console = {\n  id: \"console\",\n  label: \"Console\",\n  pagesRoot: \"console\",\n  enabled: true,\n  requiresAuth: true,\n  requiresWorkspace: false,\n  accessPolicyId: \"console_owner\",\n  icon: \"mdi-console-network-outline\",\n  origin: \"\"\n};\n",
         reason: "Register console surface definition once console-web is installed.",
         category: "console-web",
         id: "console-web-surface-config-console"
+      },
+      {
+        op: "append-text",
+        file: "src/placement.js",
+        position: "bottom",
+        skipIfContains: "id: \"console.web.menu.settings\"",
+        value:
+          "\naddPlacement({\n  id: \"console.web.menu.settings\",\n  target: \"shell-layout:primary-menu\",\n  surfaces: [\"console\"],\n  order: 100,\n  componentToken: \"local.main.ui.menu-link-item\",\n  props: {\n    label: \"Settings\",\n    to: \"/console/settings\",\n    icon: \"mdi-cog-outline\"\n  },\n  when: ({ auth }) => Boolean(auth?.authenticated)\n});\n",
+        reason: "Append console-web settings menu placement into app-owned placement registry.",
+        category: "console-web",
+        id: "console-web-console-settings-placement"
       }
     ]
   }

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@jskit-ai/console-web",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "type": "module",
   "scripts": {
     "test": "node --test"
+  },
+  "dependencies": {
+    "@jskit-ai/auth-web": "0.1.40",
+    "@jskit-ai/console-core": "0.1.2",
+    "@jskit-ai/shell-web": "0.1.38"
   }
 }

package/templates/src/pages/console/settings/index.vue

@@ -0,0 +1,8 @@
+<script setup>
+// To redirect this settings shell to a child page, uncomment and edit the example below.
+// definePage({
+//   redirect: (to) => `${to.path}/your_child_segment`
+// });
+</script>
+
+<template />

package/templates/src/pages/console/settings.vue

@@ -0,0 +1,32 @@
+<script setup>
+import ShellOutlet from "@jskit-ai/shell-web/client/components/ShellOutlet";
+import { RouterView } from "vue-router";
+</script>
+
+<template>
+  <section class="settings-shell d-flex flex-column ga-4">
+    <v-card rounded="lg" elevation="1" border>
+      <v-card-item>
+        <v-card-title>Console settings</v-card-title>
+        <v-card-subtitle>Global configuration and reference data for the whole app.</v-card-subtitle>
+      </v-card-item>
+      <v-divider />
+      <v-card-text class="pt-4">
+        <v-row no-gutters>
+          <v-col cols="12" md="3" lg="2" class="pr-md-4 mb-4 mb-md-0">
+            <v-list nav density="comfortable" rounded="lg" border>
+              <ShellOutlet
+                target="console-settings:primary-menu"
+                default-link-component-token="local.main.ui.surface-aware-menu-link-item"
+              />
+            </v-list>
+          </v-col>
+
+          <v-col cols="12" md="9" lg="10">
+            <RouterView />
+          </v-col>
+        </v-row>
+      </v-card-text>
+    </v-card>
+  </section>
+</template>

package/test/packageDescriptor.test.js

@@ -46,6 +46,24 @@ test("console-web installs console surface scripts and files", () => {
     category: "console-web",
     id: "console-web-page-console"
   });
+  assert.deepEqual(findFileMutation("console-web-page-console-settings-shell"), {
+    from: "templates/src/pages/console/settings.vue",
+    toSurface: "console",
+    toSurfacePath: "settings.vue",
+    ownership: "app",
+    reason: "Install console settings shell route scaffold for console-web.",
+    category: "console-web",
+    id: "console-web-page-console-settings-shell"
+  });
+  assert.deepEqual(findFileMutation("console-web-page-console-settings"), {
+    from: "templates/src/pages/console/settings/index.vue",
+    toSurface: "console",
+    toSurfacePath: "settings/index.vue",
+    ownership: "app",
+    reason: "Install console settings index stub scaffold for app-owned landing or redirect behavior.",
+    category: "console-web",
+    id: "console-web-page-console-settings"
+  });
 });
 
 test("console-web wires console surface policy into app config", () => {
@@ -55,13 +73,22 @@ test("console-web wires console surface policy into app config", () => {
   );
   assert.equal(findTextMutation("console-web-surface-config-console")?.file, "config/public.js");
   assert.match(findTextMutation("console-web-surface-config-console")?.value || "", /accessPolicyId: "console_owner"/);
+  assert.match(findTextMutation("console-web-surface-config-console")?.value || "", /icon: "mdi-console-network-outline"/);
+  assert.equal(findTextMutation("console-web-console-settings-placement")?.file, "src/placement.js");
 });
 
 test("console-web console templates stay shell-driven", async () => {
   const wrapperSource = await readFile(path.join(PACKAGE_DIR, "templates", "src", "pages", "console.vue"), "utf8");
   const indexSource = await readFile(path.join(PACKAGE_DIR, "templates", "src", "pages", "console", "index.vue"), "utf8");
+  const settingsSource = await readFile(path.join(PACKAGE_DIR, "templates", "src", "pages", "console", "settings.vue"), "utf8");
+  const settingsIndexSource = await readFile(path.join(PACKAGE_DIR, "templates", "src", "pages", "console", "settings", "index.vue"), "utf8");
 
   assert.match(wrapperSource, /ShellLayout/);
   assert.match(wrapperSource, /"surface": "console"/);
   assert.match(indexSource, /Operations Console/);
+  assert.match(settingsSource, /target="console-settings:primary-menu"/);
+  assert.match(settingsSource, /default-link-component-token="local\.main\.ui\.surface-aware-menu-link-item"/);
+  assert.match(settingsSource, /<RouterView \/>/);
+  assert.match(settingsIndexSource, /definePage/);
+  assert.match(settingsIndexSource, /your_child_segment/);
 });