@jskit-ai/auth-web 0.1.33 → 0.1.35

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   "packageVersion": 1,
   "packageId": "@jskit-ai/auth-web",
-  "version": "0.1.33",
+  "version": "0.1.35",
   "kind": "runtime",
   "description": "Auth web module: Fastify auth routes plus web login/sign-out scaffolds.",
   "dependsOn": [
@@ -177,8 +177,8 @@ export default Object.freeze({
       "placements": {
         "outlets": [
           {
-            "host": "auth-profile-menu",
-            "position": "primary-menu",
+            "target": "auth-profile-menu:primary-menu",
+            "defaultLinkComponentToken": "auth.web.profile.menu.link-item",
             "surfaces": ["*"],
             "source": "src/client/views/AuthProfileWidget.vue"
           }
@@ -186,8 +186,7 @@ export default Object.freeze({
         "contributions": [
           {
             "id": "auth.profile.widget",
-            "host": "shell-layout",
-            "position": "top-right",
+            "target": "shell-layout:top-right",
             "surfaces": ["*"],
             "order": 1000,
             "componentToken": "auth.web.profile.widget",
@@ -195,8 +194,7 @@ export default Object.freeze({
           },
           {
             "id": "auth.profile.menu.sign-in",
-            "host": "auth-profile-menu",
-            "position": "primary-menu",
+            "target": "auth-profile-menu:primary-menu",
             "surfaces": ["*"],
             "order": 200,
             "componentToken": "auth.web.profile.menu.link-item",
@@ -205,8 +203,7 @@ export default Object.freeze({
           },
           {
             "id": "auth.profile.menu.sign-out",
-            "host": "auth-profile-menu",
-            "position": "primary-menu",
+            "target": "auth-profile-menu:primary-menu",
             "surfaces": ["*"],
             "order": 1000,
             "componentToken": "auth.web.profile.menu.link-item",
@@ -223,10 +220,10 @@ export default Object.freeze({
         "@tanstack/vue-query": "5.92.12",
         "@mdi/js": "^7.4.47",
         "@fastify/type-provider-typebox": "^6.1.0",
-        "@jskit-ai/auth-core": "0.1.31",
-        "@jskit-ai/http-runtime": "0.1.31",
-        "@jskit-ai/kernel": "0.1.32",
-        "@jskit-ai/shell-web": "0.1.31",
+        "@jskit-ai/auth-core": "0.1.33",
+        "@jskit-ai/http-runtime": "0.1.33",
+        "@jskit-ai/kernel": "0.1.34",
+        "@jskit-ai/shell-web": "0.1.33",
         "vuetify": "^4.0.0"
       },
       "dev": {}
@@ -285,7 +282,7 @@ export default Object.freeze({
         "file": "src/placement.js",
         "position": "bottom",
         "skipIfContains": "id: \"auth.profile.widget\"",
-        "value": "\naddPlacement({\n  id: \"auth.profile.widget\",\n  host: \"shell-layout\",\n  position: \"top-right\",\n  surfaces: [\"*\"],\n  order: 1000,\n  componentToken: \"auth.web.profile.widget\"\n});\n\naddPlacement({\n  id: \"auth.profile.menu.sign-in\",\n  host: \"auth-profile-menu\",\n  position: \"primary-menu\",\n  surfaces: [\"*\"],\n  order: 200,\n  componentToken: \"auth.web.profile.menu.link-item\",\n  props: {\n    label: \"Sign in\",\n    to: \"/auth/login\"\n  },\n  when: ({ auth }) => !Boolean(auth?.authenticated)\n});\n\naddPlacement({\n  id: \"auth.profile.menu.sign-out\",\n  host: \"auth-profile-menu\",\n  position: \"primary-menu\",\n  surfaces: [\"*\"],\n  order: 1000,\n  componentToken: \"auth.web.profile.menu.link-item\",\n  props: {\n    label: \"Sign out\",\n    to: \"/auth/signout\"\n  },\n  when: ({ auth }) => Boolean(auth?.authenticated)\n});\n",
+        "value": "\naddPlacement({\n  id: \"auth.profile.widget\",\n  target: \"shell-layout:top-right\",\n  surfaces: [\"*\"],\n  order: 1000,\n  componentToken: \"auth.web.profile.widget\"\n});\n\naddPlacement({\n  id: \"auth.profile.menu.sign-in\",\n  target: \"auth-profile-menu:primary-menu\",\n  surfaces: [\"*\"],\n  order: 200,\n  componentToken: \"auth.web.profile.menu.link-item\",\n  props: {\n    label: \"Sign in\",\n    to: \"/auth/login\"\n  },\n  when: ({ auth }) => !Boolean(auth?.authenticated)\n});\n\naddPlacement({\n  id: \"auth.profile.menu.sign-out\",\n  target: \"auth-profile-menu:primary-menu\",\n  surfaces: [\"*\"],\n  order: 1000,\n  componentToken: \"auth.web.profile.menu.link-item\",\n  props: {\n    label: \"Sign out\",\n    to: \"/auth/signout\"\n  },\n  when: ({ auth }) => Boolean(auth?.authenticated)\n});\n",
         "reason": "Append auth profile placement entries into app-owned placement registry.",
         "category": "auth-web",
         "id": "auth-web-placement-block"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/auth-web",
-  "version": "0.1.33",
+  "version": "0.1.35",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -18,12 +18,12 @@
   },
   "dependencies": {
     "@tanstack/vue-query": "^5.90.5",
-    "@jskit-ai/auth-core": "0.1.31",
+    "@jskit-ai/auth-core": "0.1.33",
     "@mdi/js": "^7.4.47",
     "@fastify/type-provider-typebox": "^6.1.0",
-    "@jskit-ai/kernel": "0.1.32",
-    "@jskit-ai/shell-web": "0.1.31",
+    "@jskit-ai/kernel": "0.1.34",
+    "@jskit-ai/shell-web": "0.1.33",
     "vuetify": "^4.0.0",
-    "@jskit-ai/http-runtime": "0.1.31"
+    "@jskit-ai/http-runtime": "0.1.33"
   }
 }

package/src/client/lib/profileMenuLinkTarget.js

@@ -0,0 +1,97 @@
+import { appendQueryString } from "@jskit-ai/kernel/shared/support";
+import { isExternalLinkTarget, splitPathQueryHash } from "@jskit-ai/kernel/shared/support/linkPath";
+import { normalizeText } from "@jskit-ai/kernel/shared/support/normalize";
+import {
+  resolveSurfaceDefinitionFromPlacementContext,
+  resolveSurfaceNavigationTargetFromPlacementContext,
+  resolveSurfacePathFromPlacementContext
+} from "@jskit-ai/shell-web/client/placement";
+
+const ACCOUNT_SURFACE_ID = "account";
+const ACCOUNT_SETTINGS_FALLBACK_PATH = "/account";
+
+function resolvePathnameFromLinkTarget(target = "") {
+  const normalizedTarget = normalizeText(target);
+  if (!normalizedTarget) {
+    return "";
+  }
+
+  if (isExternalLinkTarget(normalizedTarget)) {
+    try {
+      return normalizeText(new URL(normalizedTarget).pathname);
+    } catch {
+      return "";
+    }
+  }
+
+  return normalizeText(splitPathQueryHash(normalizedTarget).pathname);
+}
+
+function resolveAccountSettingsPathFromPlacementContext(contextValue = null) {
+  const accountSurfaceDefinition = resolveSurfaceDefinitionFromPlacementContext(contextValue, ACCOUNT_SURFACE_ID);
+  if (!accountSurfaceDefinition) {
+    return ACCOUNT_SETTINGS_FALLBACK_PATH;
+  }
+
+  return resolveSurfacePathFromPlacementContext(contextValue, ACCOUNT_SURFACE_ID, "/");
+}
+
+function resolveFallbackReturnTo({
+  currentFullPath = "",
+  currentPath = "",
+  currentHref = "",
+  absolute = false
+} = {}) {
+  if (absolute) {
+    const normalizedCurrentHref = normalizeText(currentHref);
+    if (normalizedCurrentHref) {
+      return normalizedCurrentHref;
+    }
+  }
+
+  return normalizeText(currentFullPath) || normalizeText(currentPath) || "/";
+}
+
+function appendAccountReturnToIfNeeded(
+  target = "",
+  {
+    placementContext = null,
+    currentFullPath = "",
+    currentPath = "",
+    currentHref = ""
+  } = {}
+) {
+  const normalizedTarget = normalizeText(target);
+  if (!normalizedTarget || normalizedTarget.includes("returnTo=")) {
+    return normalizedTarget;
+  }
+
+  const targetPathname = resolvePathnameFromLinkTarget(normalizedTarget);
+  const accountSettingsPathname = resolvePathnameFromLinkTarget(
+    resolveAccountSettingsPathFromPlacementContext(placementContext)
+  );
+  if (!targetPathname || !accountSettingsPathname || targetPathname !== accountSettingsPathname) {
+    return normalizedTarget;
+  }
+
+  const accountSettingsTarget = resolveSurfaceNavigationTargetFromPlacementContext(placementContext, {
+    path: normalizedTarget,
+    surfaceId: ACCOUNT_SURFACE_ID
+  });
+  const returnTo = resolveFallbackReturnTo({
+    currentFullPath,
+    currentPath,
+    currentHref,
+    absolute: accountSettingsTarget.sameOrigin !== true
+  });
+  const queryParams = new URLSearchParams({
+    returnTo
+  });
+
+  return appendQueryString(normalizedTarget, queryParams.toString());
+}
+
+export {
+  appendAccountReturnToIfNeeded,
+  resolveAccountSettingsPathFromPlacementContext
+};

package/src/client/views/AuthProfileMenuLinkItem.vue

@@ -1,10 +1,9 @@
 <script setup>
 import { computed } from "vue";
-import { mdiAccountCogOutline, mdiCogOutline, mdiLogin, mdiLogout } from "@mdi/js";
-import {
-  useWebPlacementContext,
-  resolveSurfaceNavigationTargetFromPlacementContext
-} from "@jskit-ai/shell-web/client/placement";
+import { useRoute } from "vue-router";
+import { useWebPlacementContext } from "@jskit-ai/shell-web/client/placement";
+import ShellMenuLinkItem from "@jskit-ai/shell-web/client/components/ShellMenuLinkItem";
+import { appendAccountReturnToIfNeeded } from "../lib/profileMenuLinkTarget.js";
 
 const props = defineProps({
   label: {
@@ -18,66 +17,37 @@ const props = defineProps({
   icon: {
     type: String,
     default: ""
+  },
+  disabled: {
+    type: Boolean,
+    default: false
   }
 });
+const route = useRoute();
 const { context: placementContext } = useWebPlacementContext();
 
-const resolvedNavigationTarget = computed(() => {
-  const target = String(props.to || "").trim();
-  if (!target) {
-    return {
-      href: "",
-      sameOrigin: true
-    };
-  }
-
-  const navigationTarget = resolveSurfaceNavigationTargetFromPlacementContext(placementContext.value, {
-    path: target
-  });
-  return {
-    href: navigationTarget.href,
-    sameOrigin: navigationTarget.sameOrigin
-  };
-});
-
-const resolvedIcon = computed(() => {
-  const explicitIcon = String(props.icon || "").trim();
-  if (explicitIcon) {
-    return explicitIcon;
-  }
-
-  const normalizedLabel = String(props.label || "").trim().toLowerCase();
-  const normalizedTarget = String(props.to || "").trim().toLowerCase();
-  if (
-    normalizedLabel.includes("sign in") ||
-    normalizedTarget.includes("/auth/login")
-  ) {
-    return mdiLogin;
+function resolveWindowHref() {
+  if (typeof window !== "object" || !window || !window.location) {
+    return "/";
   }
-
-  if (
-    normalizedLabel.includes("sign out") ||
-    normalizedTarget.includes("/auth/signout")
-  ) {
-    return mdiLogout;
-  }
-
-  if (normalizedLabel.includes("settings") || normalizedTarget.includes("/settings")) {
-    if (normalizedTarget.includes("/account")) {
-      return mdiAccountCogOutline;
-    }
-    return mdiCogOutline;
-  }
-
-  return "";
-});
+  return String(window.location.href || "").trim() || "/";
+}
+
+const resolvedTo = computed(() =>
+  appendAccountReturnToIfNeeded(props.to, {
+    placementContext: placementContext.value,
+    currentFullPath: route?.fullPath,
+    currentPath: route?.path,
+    currentHref: resolveWindowHref()
+  })
+);
 </script>
 
 <template>
-  <v-list-item
-    :title="props.label || undefined"
-    :to="resolvedNavigationTarget.sameOrigin ? resolvedNavigationTarget.href || undefined : undefined"
-    :href="resolvedNavigationTarget.sameOrigin ? undefined : resolvedNavigationTarget.href || undefined"
-    :prepend-icon="resolvedIcon || undefined"
+  <ShellMenuLinkItem
+    :label="props.label"
+    :to="resolvedTo"
+    :icon="props.icon"
+    :disabled="props.disabled"
   />
 </template>

package/src/client/views/AuthProfileWidget.vue

@@ -91,8 +91,8 @@ onBeforeUnmount(() => {
 
     <v-list min-width="220" density="comfortable" class="py-1">
       <ShellOutlet
-        host="auth-profile-menu"
-        position="primary-menu"
+        target="auth-profile-menu:primary-menu"
+        default-link-component-token="auth.web.profile.menu.link-item"
         :context="placementContext"
       />
     </v-list>

package/test/authProfileMenuLinkItemContract.test.js

@@ -0,0 +1,17 @@
+import assert from "node:assert/strict";
+import path from "node:path";
+import test from "node:test";
+import { readFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+
+const TEST_DIRECTORY = path.dirname(fileURLToPath(import.meta.url));
+const COMPONENT_PATH = path.resolve(TEST_DIRECTORY, "../src/client/views/AuthProfileMenuLinkItem.vue");
+
+test("AuthProfileMenuLinkItem delegates generic menu-link rendering to shell-web and passes disabled through explicitly", async () => {
+  const source = await readFile(COMPONENT_PATH, "utf8");
+
+  assert.match(source, /import ShellMenuLinkItem from "@jskit-ai\/shell-web\/client\/components\/ShellMenuLinkItem"/);
+  assert.match(source, /disabled:\s*\{\s*type:\s*Boolean,\s*default:\s*false\s*\}/s);
+  assert.match(source, /<ShellMenuLinkItem[\s\S]*:to="resolvedTo"[\s\S]*:disabled="props\.disabled"/);
+  assert.doesNotMatch(source, /<v-list-item\b/);
+});

package/test/profileMenuLinkTarget.test.js

@@ -0,0 +1,64 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import { appendAccountReturnToIfNeeded } from "../src/client/lib/profileMenuLinkTarget.js";
+
+test("appendAccountReturnToIfNeeded appends relative returnTo for same-origin account settings targets", () => {
+  const context = {
+    surfaceConfig: {
+      defaultSurfaceId: "home",
+      surfacesById: {
+        home: { id: "home", routeBase: "/home", origin: "https://www.example.com" },
+        account: { id: "account", routeBase: "/account", origin: "https://www.example.com" }
+      }
+    }
+  };
+
+  assert.equal(
+    appendAccountReturnToIfNeeded("/account", {
+      placementContext: context,
+      currentFullPath: "/home/profile?tab=security"
+    }),
+    "/account?returnTo=%2Fhome%2Fprofile%3Ftab%3Dsecurity"
+  );
+});
+
+test("appendAccountReturnToIfNeeded appends absolute returnTo for cross-origin account settings targets", () => {
+  const context = {
+    surfaceConfig: {
+      defaultSurfaceId: "home",
+      surfacesById: {
+        home: { id: "home", routeBase: "/home", origin: "https://www.example.com" },
+        account: { id: "account", routeBase: "/account", origin: "https://account.example.com" }
+      }
+    }
+  };
+
+  assert.equal(
+    appendAccountReturnToIfNeeded("/account", {
+      placementContext: context,
+      currentFullPath: "/home/profile?tab=security",
+      currentHref: "https://www.example.com/home/profile?tab=security"
+    }),
+    "/account?returnTo=https%3A%2F%2Fwww.example.com%2Fhome%2Fprofile%3Ftab%3Dsecurity"
+  );
+});
+
+test("appendAccountReturnToIfNeeded leaves non-account targets unchanged", () => {
+  const context = {
+    surfaceConfig: {
+      defaultSurfaceId: "home",
+      surfacesById: {
+        home: { id: "home", routeBase: "/home", origin: "https://www.example.com" },
+        account: { id: "account", routeBase: "/account", origin: "https://www.example.com" }
+      }
+    }
+  };
+
+  assert.equal(
+    appendAccountReturnToIfNeeded("/console/settings", {
+      placementContext: context,
+      currentFullPath: "/home/profile"
+    }),
+    "/console/settings"
+  );
+});