@frigear-nu/menu 0.0.7 → 0.0.9

package/dist/module.d.mts

@@ -16,7 +16,15 @@ type MenuItem = {
      * entries, so content-sourced and module-sourced items share the exact same shape.
      */
     label: string;
+    /**
+     * Optional i18n key (e.g. `users.menu.logout.label`). When `@nuxtjs/i18n` is installed and the
+     * key exists for the active locale, `useMenu` returns its translation as `label`; otherwise the
+     * plain `label` above is the fallback. Ids are always derived from the untranslated `label`.
+     */
+    labelKey?: string;
     description?: string;
+    /** Optional i18n key for `description`, resolved the same way as `labelKey`. */
+    descriptionKey?: string;
     icon?: string;
     to?: string;
     external?: boolean;

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@frigear-nu/menu",
   "configKey": "menus",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,5 +1,5 @@
-import { defineNuxtModule, createResolver, addImports, hasNuxtModule, addTypeTemplate, addTemplate, addPlugin, addServerImports } from '@nuxt/kit';
-import { registerModule } from '@frigear-nu/module-kit/utils';
+import { defineNuxtModule, createResolver, addImports, hasNuxtModule, addTypeTemplate, addPlugin, addServerImports } from '@nuxt/kit';
+import { registerModule, defineVirtualRegistry } from '@frigear-nu/module-kit/utils';
 
 const DEFAULT_CONTENT_COLLECTION = "config";
 const DEFAULT_CONTENT_FIELD = "navigation";
@@ -39,20 +39,32 @@ const module$1 = defineNuxtModule({
 }
 `
     });
-    nuxt.hook("modules:done", () => {
-      const staticItems = nuxt.options.menus?._extensions ?? {};
-      const sources = Array.isArray(nuxt.options.menus?._sources) ? nuxt.options.menus._sources : [];
-      const sourcesTemplate = addTemplate({
-        filename: "#menus/sources.mjs",
-        write: true,
-        getContents: () => `
+    defineVirtualRegistry(nuxt, {
+      filename: "#menus/sources.mjs",
+      alias: "#menus/sources",
+      collect: () => ({
+        staticItems: nuxt.options.menus?._extensions ?? {},
+        sources: Array.isArray(nuxt.options.menus?._sources) ? nuxt.options.menus._sources : []
+      }),
+      contents: ({ staticItems, sources }) => `
+export const staticItems = ${JSON.stringify(staticItems)}
+${sources.map((source, index) => `import source${index} from ${JSON.stringify(source.file)}`).join("\n")}
+export const sources = [${sources.map((source, index) => `{ menu: ${JSON.stringify(source.menu)}, source: source${index} }`).join(", ")}]
+`,
+      resolved: ({ staticItems }) => nuxt.callHook("menus:resolved", staticItems)
+    });
+    defineVirtualRegistry(nuxt, {
+      filename: "#menus/server-sources",
+      target: "server",
+      collect: () => ({
+        staticItems: nuxt.options.menus?._extensions ?? {},
+        sources: Array.isArray(nuxt.options.menus?._sources) ? nuxt.options.menus._sources : []
+      }),
+      contents: ({ staticItems, sources }) => `
 export const staticItems = ${JSON.stringify(staticItems)}
 ${sources.map((source, index) => `import source${index} from ${JSON.stringify(source.file)}`).join("\n")}
 export const sources = [${sources.map((source, index) => `{ menu: ${JSON.stringify(source.menu)}, source: source${index} }`).join(", ")}]
 `
-      });
-      nuxt.options.alias["#menus/sources"] = sourcesTemplate.dst;
-      nuxt.callHook("menus:resolved", staticItems);
     });
     addPlugin(resolver.resolve("./runtime/app/plugins/menus"));
     addServerImports({

package/dist/runtime/app/composables/useMenu.js

@@ -1,6 +1,6 @@
 import { computed, unref } from "vue";
 import { useAsyncData, useNuxtApp, useRuntimeConfig } from "#imports";
-import { collectMenuItems, matchesMenuGroup, parseMenuPath, sortByOrder } from "../../utils/menu.js";
+import { collectMenuItems, matchesMenuGroup, parseMenuPath, sortByOrder, translateMenuItem } from "../../utils/menu.js";
 import { menus } from "../utils/state.js";
 function useMenuLocale() {
   const nuxtApp = useNuxtApp();
@@ -29,7 +29,8 @@ export const useMenu = (path) => {
   return useAsyncData(
     () => `menu:${path}:${locale.value ?? ""}`,
     async () => {
-      const registered = collectMenuItems(menus[menu], parsed);
+      const i18n = nuxtApp.$i18n?.t && nuxtApp.$i18n.te ? nuxtApp.$i18n : void 0;
+      const registered = collectMenuItems(menus[menu], parsed).map((item) => translateMenuItem(item, i18n));
       const content = await loadContentItems(menu, parsed, unref(locale));
       const result = sortByOrder([...content, ...registered]);
       await nuxtApp.callHook("menus:visible", menu);

package/dist/runtime/server/utils.d.ts

@@ -1,3 +1,15 @@
-import { type MenuItem } from '../utils/menu.js';
 import type { H3Event } from 'h3';
-export declare const useMenu: (event: H3Event, path: string) => Promise<MenuItem[]>;
+import { type MenuItem } from '../utils/menu.js';
+/**
+ * Server counterpart of the client `useMenu`: resolves a menu's (or menu group's) items merged from
+ * every source - `extendMenu` items, `runtime/menus.ts` sources and the `@nuxt/content` source -
+ * with content items first, sorted by `order`. Accepts the same paths, wildcards included.
+ * Labels are not translated; pass `locale` to read a localized content collection.
+ *
+ * ```ts
+ * export default defineEventHandler(event => useMenu(event, 'dashboard.*'))
+ * ```
+ */
+export declare const useMenu: (event: H3Event, path: string, options?: {
+    locale?: string;
+}) => Promise<MenuItem[]>;

package/dist/runtime/server/utils.js

@@ -1,27 +1,45 @@
-import { collectMenuItems, matchesMenuGroup, parseMenuPath, sortByOrder } from "../utils/menu.js";
 import { useRuntimeConfig } from "nitropack/runtime";
-export const useMenu = async (event, path) => {
-  const parsed = parseMenuPath(path);
-  const { menu } = parsed;
-  const config = useRuntimeConfig(event);
-  const menus = config.public.menus;
-  const registered = collectMenuItems(menus[menu], parsed);
-  const content = await loadContentItems(menu, parsed, "");
-  const result = sortByOrder([...registered, ...content]);
-  return result;
-};
+import { staticItems, sources } from "#menus/server-sources";
+import { collectMenuItems, matchesMenuGroup, parseMenuPath, sortByOrder } from "../utils/menu.js";
+import { menus, pushMenuItems, resetMenus } from "../app/utils/state.js";
+let registered;
+function registerItems() {
+  registered ??= (async () => {
+    resetMenus();
+    for (const [menu, groups] of Object.entries(staticItems)) {
+      for (const [group, items] of Object.entries(groups)) {
+        if (items.length > 0) pushMenuItems(menu, group, items);
+      }
+    }
+    for (const { menu, source } of sources) {
+      const items = [];
+      await source(items);
+      if (items.length > 0) pushMenuItems(menu, "", items);
+    }
+  })().catch((error) => {
+    registered = void 0;
+    throw error;
+  });
+  return registered;
+}
 function localizedCollectionName(name, locale) {
   return locale ? `${name}_${locale.replace(/-/g, "_")}` : name;
 }
-async function loadContentItems(menu, parsed, locale) {
-  const config = useRuntimeConfig().public.menus ?? {};
+async function loadContentItems(event, menu, parsed, locale) {
+  const config = useRuntimeConfig(event).public.menus ?? {};
   const source = config.content?.[menu];
   if (!source) return [];
-  const collection = localizedCollectionName(source.collection, locale);
-  const entry = await queryCollection(collection).first();
+  const { queryCollection } = await import("@nuxt/content/server");
+  const entry = await queryCollection(event, localizedCollectionName(source.collection, locale)).first();
   const items = entry?.[source.field] ?? [];
   return items.filter((item) => {
     const group = item.group ?? "";
     return parsed.wildcard ? matchesMenuGroup(group, parsed.group) : group === parsed.group;
   });
 }
+export const useMenu = async (event, path, options = {}) => {
+  const parsed = parseMenuPath(path);
+  await registerItems();
+  const content = await loadContentItems(event, parsed.menu, parsed, options.locale);
+  return sortByOrder([...content, ...collectMenuItems(menus[parsed.menu], parsed)]);
+};

package/dist/runtime/utils/menu.d.ts

@@ -37,6 +37,17 @@ export declare function collectMenuItems(groups: Record<string, MenuItem[]> | un
 export declare function sortByOrder(items: MenuItem[]): MenuItem[];
 /** Deterministic id for an item missing one: its `to` if present, else a slug of its `label`. */
 export declare function deriveMenuItemId(item: MenuItem): string;
+/** The slice of `@nuxtjs/i18n`'s `$i18n` that `translateMenuItem` needs. */
+export type MenuTranslator = {
+    t: (key: string) => string;
+    te: (key: string) => boolean;
+};
+/**
+ * Resolves an item's `labelKey`/`descriptionKey` against the active locale, falling back to the
+ * plain `label`/`description` when no translator is available or the key has no message. The
+ * `id` is derived first, so it stays identical across locales.
+ */
+export declare function translateMenuItem(item: MenuItem, i18n?: MenuTranslator): MenuItem;
 /**
  * Build-time API for other modules to contribute static items to a menu, without the host app
  * wiring anything. Call it once during a module's own `setup()`:

package/dist/runtime/utils/menu.js

@@ -46,6 +46,14 @@ function slugify(value) {
 export function deriveMenuItemId(item) {
   return item.id ?? item.to ?? slugify(item.label);
 }
+export function translateMenuItem(item, i18n) {
+  if (!i18n || !item.labelKey && !item.descriptionKey) return item;
+  const id = deriveMenuItemId(item);
+  const translated = { ...item, id };
+  if (item.labelKey && i18n.te(item.labelKey)) translated.label = i18n.t(item.labelKey);
+  if (item.descriptionKey && i18n.te(item.descriptionKey)) translated.description = i18n.t(item.descriptionKey);
+  return translated;
+}
 function normalizeItems(group, items) {
   const list = Array.isArray(items) ? items : [items];
   const seen = /* @__PURE__ */ new Set();

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@frigear-nu/menu",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Named, shareable navigation menus - modules contribute items (extendMenu / a runtime/menus.ts source) and/or Nuxt Content, consumers read them via useMenu and render them however they like.",
+  "homepage": "https://docs.frigear.dev/modules/menu",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/frigear-nu/frigear-nu.git",
@@ -30,7 +31,7 @@
   ],
   "dependencies": {
     "@nuxt/kit": "^4.6.0",
-    "@frigear-nu/module-kit": "0.1.5",
+    "@frigear-nu/module-kit": "0.1.7",
     "zod": "^4.6.5"
   },
   "devDependencies": {