@jskit-ai/workspaces-web 0.1.8 → 0.1.10

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/workspaces-web",
-  version: "0.1.8",
+  version: "0.1.10",
   kind: "runtime",
   description: "Workspace web module: workspace selector, tools widget, workspace surfaces, and members/settings UI.",
   dependsOn: [
@@ -45,8 +45,7 @@ export default Object.freeze({
           "users.web.workspace.tools.widget",
           "users.web.workspace-settings.menu-item",
           "users.web.workspace-members.menu-item",
-          "users.web.members-admin.element",
-          "users.web.workspace-settings.element"
+          "users.web.members-admin.element"
         ]
       }
     },
@@ -54,8 +53,8 @@ export default Object.freeze({
       placements: {
         outlets: [
           {
-            host: "admin-settings",
-            position: "primary-menu",
+            target: "admin-settings:primary-menu",
+            defaultLinkComponentToken: "local.main.ui.surface-aware-menu-link-item",
             surfaces: ["admin"],
             source: "templates/src/pages/admin/workspace/settings.vue"
           }
@@ -63,8 +62,7 @@ export default Object.freeze({
         contributions: [
           {
             id: "users.workspace.selector",
-            host: "shell-layout",
-            position: "top-left",
+            target: "shell-layout:top-left",
             surfaces: ["*"],
             order: 200,
             componentToken: "users.web.workspace.selector",
@@ -73,8 +71,7 @@ export default Object.freeze({
           },
           {
             id: "users.account.invites.cue",
-            host: "shell-layout",
-            position: "top-right",
+            target: "shell-layout:top-right",
             surfaces: ["*"],
             order: 850,
             componentToken: "local.main.account.pending-invites.cue",
@@ -83,8 +80,7 @@ export default Object.freeze({
           },
           {
             id: "users.workspace.tools.widget",
-            host: "shell-layout",
-            position: "top-right",
+            target: "shell-layout:top-right",
             surfaces: ["admin"],
             order: 900,
             componentToken: "users.web.workspace.tools.widget",
@@ -92,8 +88,7 @@ export default Object.freeze({
           },
           {
             id: "users.workspace.menu.workspace-settings",
-            host: "workspace-tools",
-            position: "primary-menu",
+            target: "workspace-tools:primary-menu",
             surfaces: ["admin"],
             order: 100,
             componentToken: "users.web.workspace-settings.menu-item",
@@ -101,22 +96,12 @@ export default Object.freeze({
           },
           {
             id: "users.workspace.menu.members",
-            host: "workspace-tools",
-            position: "primary-menu",
+            target: "workspace-tools:primary-menu",
             surfaces: ["admin"],
             order: 200,
             componentToken: "users.web.workspace-members.menu-item",
             source: "mutations.text#users-web-placement-block"
           },
-          {
-            id: "users.workspace.settings.general",
-            host: "admin-settings",
-            position: "primary-menu",
-            surfaces: ["admin"],
-            order: 100,
-            componentToken: "users.web.shell.surface-aware-menu-link-item",
-            source: "mutations.text#users-web-workspace-settings-general-placement"
-          }
         ]
       }
     }
@@ -124,8 +109,8 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/workspaces-core": "0.1.8",
-        "@jskit-ai/users-web": "0.1.47"
+        "@jskit-ai/workspaces-core": "0.1.10",
+        "@jskit-ai/users-web": "0.1.49"
       },
       dev: {}
     },
@@ -244,7 +229,7 @@ export default Object.freeze({
         from: "templates/src/pages/admin/workspace/settings/index.vue",
         toSurface: "admin",
         toSurfacePath: "workspace/settings/index.vue",
-        reason: "Install workspace settings landing page scaffold for workspaces-web workspace admin UI.",
+        reason: "Install workspace settings index stub scaffold for app-owned landing or redirect behavior.",
         category: "workspaces-web",
         id: "users-web-page-admin-workspace-settings",
         when: {
@@ -259,7 +244,7 @@ export default Object.freeze({
         file: "src/placement.js",
         position: "bottom",
         skipIfContains: "id: \"users.workspace.selector\"",
-        value: "\naddPlacement({\n  id: \"users.workspace.selector\",\n  host: \"shell-layout\",\n  position: \"top-left\",\n  surfaces: [\"*\"],\n  order: 200,\n  componentToken: \"users.web.workspace.selector\",\n  props: {\n    allowOnNonWorkspaceSurface: true,\n    targetSurfaceId: \"app\"\n  },\n  when: ({ auth }) => {\n    return Boolean(auth?.authenticated);\n  }\n});\n\naddPlacement({\n  id: \"users.account.invites.cue\",\n  host: \"shell-layout\",\n  position: \"top-right\",\n  surfaces: [\"*\"],\n  order: 850,\n  componentToken: \"local.main.account.pending-invites.cue\",\n  when: ({ auth }) => Boolean(auth?.authenticated)\n});\n\naddPlacement({\n  id: \"users.workspace.tools.widget\",\n  host: \"shell-layout\",\n  position: \"top-right\",\n  surfaces: [\"admin\"],\n  order: 900,\n  componentToken: \"users.web.workspace.tools.widget\"\n});\n\naddPlacement({\n  id: \"users.workspace.menu.workspace-settings\",\n  host: \"workspace-tools\",\n  position: \"primary-menu\",\n  surfaces: [\"admin\"],\n  order: 100,\n  componentToken: \"users.web.workspace-settings.menu-item\"\n});\n\naddPlacement({\n  id: \"users.workspace.menu.members\",\n  host: \"workspace-tools\",\n  position: \"primary-menu\",\n  surfaces: [\"admin\"],\n  order: 200,\n  componentToken: \"users.web.workspace-members.menu-item\"\n});\n",
+        value: "\naddPlacement({\n  id: \"users.workspace.selector\",\n  target: \"shell-layout:top-left\",\n  surfaces: [\"*\"],\n  order: 200,\n  componentToken: \"users.web.workspace.selector\",\n  props: {\n    allowOnNonWorkspaceSurface: true,\n    targetSurfaceId: \"app\"\n  },\n  when: ({ auth }) => {\n    return Boolean(auth?.authenticated);\n  }\n});\n\naddPlacement({\n  id: \"users.account.invites.cue\",\n  target: \"shell-layout:top-right\",\n  surfaces: [\"*\"],\n  order: 850,\n  componentToken: \"local.main.account.pending-invites.cue\",\n  when: ({ auth }) => Boolean(auth?.authenticated)\n});\n\naddPlacement({\n  id: \"users.workspace.tools.widget\",\n  target: \"shell-layout:top-right\",\n  surfaces: [\"admin\"],\n  order: 900,\n  componentToken: \"users.web.workspace.tools.widget\"\n});\n\naddPlacement({\n  id: \"users.workspace.menu.workspace-settings\",\n  target: \"workspace-tools:primary-menu\",\n  surfaces: [\"admin\"],\n  order: 100,\n  componentToken: \"users.web.workspace-settings.menu-item\"\n});\n\naddPlacement({\n  id: \"users.workspace.menu.members\",\n  target: \"workspace-tools:primary-menu\",\n  surfaces: [\"admin\"],\n  order: 200,\n  componentToken: \"users.web.workspace-members.menu-item\"\n});\n",
         reason: "Append workspace placement entries into app-owned placement registry.",
         category: "workspaces-web",
         id: "users-web-placement-block",
@@ -288,21 +273,6 @@ export default Object.freeze({
         reason: "Bind app-owned account pending invites cue component token into local main client provider registry.",
         category: "workspaces-web",
         id: "users-web-main-client-provider-account-invites-register"
-      },
-      {
-        op: "append-text",
-        file: "src/placement.js",
-        position: "bottom",
-        skipIfContains: "id: \"users.workspace.settings.general\"",
-        value:
-          "\naddPlacement({\n  id: \"users.workspace.settings.general\",\n  host: \"admin-settings\",\n  position: \"primary-menu\",\n  surfaces: [\"admin\"],\n  order: 100,\n  componentToken: \"users.web.shell.surface-aware-menu-link-item\",\n  props: {\n    label: \"General\",\n    surface: \"admin\",\n    workspaceSuffix: \"/workspace/settings\",\n    nonWorkspaceSuffix: \"/workspace/settings\"\n  },\n  when: ({ auth }) => Boolean(auth?.authenticated)\n});\n",
-        reason: "Append workspace settings general-page placement into app-owned placement registry.",
-        category: "workspaces-web",
-        id: "users-web-workspace-settings-general-placement",
-        when: {
-          config: "tenancyMode",
-          in: ["personal", "workspaces"]
-        }
       }
     ]
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/workspaces-web",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -10,6 +10,6 @@
     "./client/providers/WorkspacesWebClientProvider": "./src/client/providers/WorkspacesWebClientProvider.js"
   },
   "dependencies": {
-    "@jskit-ai/users-web": "0.1.47"
+    "@jskit-ai/users-web": "0.1.49"
   }
 }

package/templates/src/pages/admin/workspace/settings/index.vue

@@ -1,7 +1,8 @@
 <script setup>
-import WorkspaceSettingsClientElement from "@jskit-ai/users-web/client/components/WorkspaceSettingsClientElement";
+// 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>
-  <WorkspaceSettingsClientElement />
-</template>
+<template />

package/templates/src/pages/admin/workspace/settings.vue

@@ -15,7 +15,10 @@ import { RouterView } from "vue-router";
         <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 host="admin-settings" position="primary-menu" />
+              <ShellOutlet
+                target="admin-settings:primary-menu"
+                default-link-component-token="local.main.ui.surface-aware-menu-link-item"
+              />
             </v-list>
           </v-col>
 

package/test/settingsPlacementContract.test.js

@@ -11,7 +11,7 @@ const PACKAGE_DIR = path.resolve(TEST_DIRECTORY, "..");
 function readSettingsOutlets() {
   const outlets = descriptor?.metadata?.ui?.placements?.outlets;
   return Array.isArray(outlets)
-    ? outlets.filter((entry) => String(entry?.host || "").trim() === "admin-settings")
+    ? outlets.filter((entry) => String(entry?.target || "").trim() === "admin-settings:primary-menu")
     : [];
 }
 
@@ -22,35 +22,57 @@ function findContribution(id) {
     : null;
 }
 
+function findFileMutation(id) {
+  const fileMutations = descriptor?.mutations?.files;
+  return Array.isArray(fileMutations)
+    ? fileMutations.find((entry) => String(entry?.id || "").trim() === id) || null
+    : null;
+}
+
 test("workspaces-web admin settings template exposes surface-derived settings outlets", async () => {
   const source = await readFile(
     path.join(PACKAGE_DIR, "templates", "src", "pages", "admin", "workspace", "settings.vue"),
     "utf8"
   );
 
-  assert.match(source, /<ShellOutlet host="admin-settings" position="primary-menu" \/>/);
+  assert.match(source, /target="admin-settings:primary-menu"/);
+  assert.match(source, /default-link-component-token="local\.main\.ui\.surface-aware-menu-link-item"/);
+  assert.match(source, /<RouterView \/>/);
+});
+
+test("workspaces-web admin settings index template is a simple developer-owned stub", async () => {
+  const source = await readFile(
+    path.join(PACKAGE_DIR, "templates", "src", "pages", "admin", "workspace", "settings", "index.vue"),
+    "utf8"
+  );
+
+  assert.match(source, /definePage/);
+  assert.match(source, /your_child_segment/);
 });
 
-test("workspaces-web descriptor metadata advertises admin settings outlets and general-page placement on the derived host", () => {
+test("workspaces-web descriptor metadata advertises admin settings outlets", () => {
   assert.deepEqual(
     readSettingsOutlets(),
     [
       {
-        host: "admin-settings",
-        position: "primary-menu",
+        target: "admin-settings:primary-menu",
+        defaultLinkComponentToken: "local.main.ui.surface-aware-menu-link-item",
         surfaces: ["admin"],
         source: "templates/src/pages/admin/workspace/settings.vue"
       }
     ]
   );
-
-  assert.deepEqual(findContribution("users.workspace.settings.general"), {
-    id: "users.workspace.settings.general",
-    host: "admin-settings",
-    position: "primary-menu",
-    surfaces: ["admin"],
-    order: 100,
-    componentToken: "users.web.shell.surface-aware-menu-link-item",
-    source: "mutations.text#users-web-workspace-settings-general-placement"
+  assert.equal(findContribution("users.workspace.settings.general"), null);
+  assert.deepEqual(findFileMutation("users-web-page-admin-workspace-settings"), {
+    from: "templates/src/pages/admin/workspace/settings/index.vue",
+    toSurface: "admin",
+    toSurfacePath: "workspace/settings/index.vue",
+    reason: "Install workspace settings index stub scaffold for app-owned landing or redirect behavior.",
+    category: "workspaces-web",
+    id: "users-web-page-admin-workspace-settings",
+    when: {
+      config: "tenancyMode",
+      in: ["personal", "workspaces"]
+    }
   });
 });