@nocobase/portal-template-default 1.0.0 → 1.0.2

package/registry/nocobase-i18n/locales/zh-CN.ts

@@ -0,0 +1,85 @@
+const zhCN = {
+  starter: {
+    "shell.workspace": "AI 应用工作区",
+    "shell.footer.freedom": "AI 自由构建。",
+    "shell.footer.reliability": "NocoBase 保障可靠运行。",
+    "auth.signOut": "退出登录",
+    "auth.signingOut": "正在退出...",
+    "buttons.apply": "应用",
+    "buttons.clear": "清除",
+    "buttons.undo": "撤销",
+    "pages.error.title": "页面不存在",
+    "pages.error.description": "你访问的页面不存在。",
+    "pages.error.backHome": "返回首页",
+    "table.filter.text.placeholder": "输入筛选内容...",
+    "table.filter.numeric.placeholder": "输入筛选数值...",
+    "table.filter.combobox.placeholder": "请选择...",
+    "table.filter.combobox.search": "搜索...",
+    "table.filter.combobox.noResults": "没有找到结果。",
+    "table.filter.operator.placeholder": "搜索操作符...",
+    "table.filter.operator.noResults": "没有找到操作符。",
+    "table.filter.operator.eq": "等于",
+    "table.filter.operator.ne": "不等于",
+    "table.filter.operator.lt": "小于",
+    "table.filter.operator.gt": "大于",
+    "table.filter.operator.lte": "小于或等于",
+    "table.filter.operator.gte": "大于或等于",
+    "table.filter.operator.in": "包含于数组",
+    "table.filter.operator.nin": "不包含于数组",
+    "table.filter.operator.ina": "包含于数组（区分大小写）",
+    "table.filter.operator.nina": "不包含于数组（区分大小写）",
+    "table.filter.operator.contains": "包含",
+    "table.filter.operator.ncontains": "不包含",
+    "table.filter.operator.containss": "包含（区分大小写）",
+    "table.filter.operator.ncontainss": "不包含（区分大小写）",
+    "table.filter.operator.between": "介于",
+    "table.filter.operator.nbetween": "不介于",
+    "table.filter.operator.null": "为空",
+    "table.filter.operator.nnull": "不为空",
+    "table.filter.operator.startswith": "开头是",
+    "table.filter.operator.nstartswith": "开头不是",
+    "table.filter.operator.startswiths": "开头是（区分大小写）",
+    "table.filter.operator.nstartswiths": "开头不是（区分大小写）",
+    "table.filter.operator.endswith": "结尾是",
+    "table.filter.operator.nendswith": "结尾不是",
+    "table.filter.operator.endswiths": "结尾是（区分大小写）",
+    "table.filter.operator.nendswiths": "结尾不是（区分大小写）",
+    "table.filter.operator.eqs": "等于（区分大小写）",
+    "table.filter.operator.nes": "不等于（区分大小写）",
+  },
+  "nocobase-i18n": {
+    "language.label": "语言",
+    "language.current": "当前语言",
+    "language.switchError": "无法切换语言。",
+    "navigation.group": "本地化",
+    "navigation.demo": "国际化",
+    "demo.title": "国际化",
+    "demo.description":
+      "结合前端 UI 资源和指定 NocoBase 动态 namespace 的可选混合语言运行时。",
+    "demo.switcher.title": "语言切换器",
+    "demo.switcher.description": "同一个可复用组件也会集成到登录用户菜单中。",
+    "demo.switcher.unavailable.title": "当前仅启用一种语言",
+    "demo.switcher.unavailable.description":
+      "请在 NocoBase 系统设置中启用其他语言，语言切换器才会显示。",
+    "demo.frontend.title": "应用 UI 文案翻译",
+    "demo.frontend.description":
+      "Starter 和 Registry 组件的界面文案保存在各自的本地语言资源中。",
+    "demo.frontend.actions": "常用操作",
+    "demo.server.title": "NocoBase 元数据翻译",
+    "demo.server.description":
+      "数据表和字段名称从 lm-collections 等服务端动态 namespace 加载。",
+    "demo.currentLocale": "当前语言：{{locale}}",
+    "demo.prompt.title": "提示词生成器",
+    "demo.prompt.description": "描述完整的多语言应用场景并生成实现提示词。",
+    "demo.prompt.settings": "场景设置",
+    "demo.prompt.scene": "应用场景",
+    "demo.prompt.languages": "语言",
+    "demo.prompt.copy": "复制提示词",
+    "demo.prompt.copied": "已复制",
+    "demo.prompt.copyError": "无法访问剪贴板，请手动选中并复制提示词。",
+    "demo.prompt.output": "生成的提示词",
+    "demo.prompt.outputDescription": "修改场景和语言要求时会实时更新。",
+  },
+} as const;
+
+export default zhCN;

package/registry/nocobase-i18n/provider.tsx

@@ -0,0 +1,32 @@
+import { useEffect, useState, type PropsWithChildren } from "react";
+
+import { LoadingState } from "@/components/app-shell/loading-state";
+import { setTranslationResolver } from "@/lib/i18n";
+import { loadServerLocaleResources } from "./server-resources";
+import { translate } from "./runtime";
+
+export function LocalePreferenceProvider({ children }: PropsWithChildren) {
+  const [ready, setReady] = useState(false);
+
+  useEffect(() => setTranslationResolver(translate), []);
+
+  useEffect(() => {
+    let active = true;
+    void loadServerLocaleResources()
+      .catch((error) => {
+        console.warn("Unable to load NocoBase locale resources", error);
+      })
+      .finally(() => {
+        if (active) setReady(true);
+      });
+    return () => {
+      active = false;
+    };
+  }, []);
+
+  if (!ready) {
+    return <LoadingState className="min-h-80" />;
+  }
+
+  return children;
+}

package/registry/nocobase-i18n/runtime.ts

@@ -0,0 +1,118 @@
+import { createInstance, type TOptions } from "i18next";
+
+import {
+  getTranslationResources,
+  registerTranslationResources,
+  subscribeTranslationResources,
+  type TranslationOptions,
+} from "@/lib/i18n";
+import { nocobaseClient } from "@/lib/nocobase/client";
+import {
+  DEFAULT_LOCALE,
+  getLocaleDefinition,
+  getLocaleDirection,
+  getLocaleLabel,
+  registerLocale,
+  resolveSupportedLocale,
+} from "./locale-store";
+import enUS from "./locales/en-US";
+import zhCN from "./locales/zh-CN";
+
+export type LocaleResources = Record<
+  string,
+  Record<string, string | number | boolean>
+>;
+
+export const i18n = createInstance();
+
+void i18n.init({
+  lng: resolveSupportedLocale(nocobaseClient.getLocale()),
+  fallbackLng: DEFAULT_LOCALE,
+  defaultNS: "starter",
+  fallbackNS: "starter",
+  keySeparator: false,
+  nsSeparator: false,
+  initImmediate: false,
+  interpolation: {
+    escapeValue: false,
+  },
+  resources: {
+    "en-US": enUS,
+    "zh-CN": zhCN,
+  },
+});
+
+function addLocaleResources(namespace: string, resources: LocaleResources) {
+  for (const [locale, resource] of Object.entries(resources)) {
+    i18n.addResourceBundle(locale, namespace, resource, true, true);
+    registerLocale({
+      locale,
+      label: getLocaleLabel(locale),
+      direction: getLocaleDirection(locale),
+    });
+  }
+}
+
+getTranslationResources().forEach(([namespace, resources]) =>
+  addLocaleResources(namespace, resources)
+);
+
+subscribeTranslationResources(addLocaleResources);
+
+export function getCurrentLocale() {
+  return resolveSupportedLocale(i18n.resolvedLanguage ?? i18n.language);
+}
+
+export function registerLocaleResources(
+  namespace: string,
+  resources: LocaleResources
+) {
+  registerTranslationResources(namespace, resources);
+}
+
+export function translate(
+  key: string,
+  options?: TranslationOptions | string,
+  defaultMessage?: string
+) {
+  const normalizedOptions = typeof options === "string" ? undefined : options;
+  const normalizedDefault =
+    typeof options === "string" ? options : defaultMessage;
+  const value = i18n.t(key, {
+    ...(normalizedOptions as TOptions),
+    defaultValue: normalizedDefault ?? normalizedOptions?.defaultValue ?? key,
+  });
+
+  return typeof value === "string" ? value : String(value);
+}
+
+export function applyDocumentLocale(locale = getCurrentLocale()) {
+  if (typeof document === "undefined") return;
+  const direction =
+    getLocaleDefinition(locale)?.direction ?? getLocaleDirection(locale);
+  document.documentElement.lang = locale;
+  document.documentElement.dir = direction;
+}
+
+export async function changeLocale(locale: string) {
+  const nextLocale = resolveSupportedLocale(locale);
+
+  if (nocobaseClient.getToken()) {
+    try {
+      await nocobaseClient.action("users", "updateLang", {
+        method: "POST",
+        body: { appLang: nextLocale },
+      });
+    } catch (error) {
+      console.warn("Unable to persist the NocoBase language preference", error);
+    }
+  }
+
+  nocobaseClient.setLocale(nextLocale);
+  await i18n.changeLanguage(nextLocale);
+  applyDocumentLocale(nextLocale);
+
+  if (typeof window !== "undefined") window.location.reload();
+}
+
+applyDocumentLocale();

package/registry/nocobase-i18n/server-resources.ts

@@ -0,0 +1,184 @@
+import { nocobaseClient } from "@/lib/nocobase/client";
+import {
+  getLocaleDefinitions,
+  registerLocale,
+  setEnabledLocales,
+} from "./locale-store";
+import { applyDocumentLocale, getCurrentLocale, i18n } from "./runtime";
+
+type ServerLanguagePayload = {
+  lang?: string;
+  resources?: Record<string, Record<string, string>>;
+};
+
+type SystemSettingsPayload = {
+  enabledLanguages?: string[];
+};
+
+const serverResourceNamespaces = new Set(["lm-collections"]);
+const loadedServerResourceNamespaces = new Set<string>();
+const namespaceLoadPromises = new Map<string, Promise<void>>();
+let cachedServerResources: ServerLanguagePayload["resources"] = {};
+let serverResourcesPromise: Promise<void> | undefined;
+let bootstrapStarted = false;
+let bootstrapComplete = false;
+
+function mergeNamespace(namespace: string, locale?: string) {
+  const resource = cachedServerResources?.[namespace];
+  if (!locale || !resource) return false;
+  i18n.addResourceBundle(locale, namespace, resource, true, false);
+  loadedServerResourceNamespaces.add(namespace);
+  return true;
+}
+
+async function requestServerResources(
+  namespaces: string[],
+  requestedLocale?: string
+) {
+  const payload = await nocobaseClient.action<ServerLanguagePayload>(
+    "app",
+    "getLang",
+    {
+      method: "GET",
+      query: {
+        ...(requestedLocale ? { locale: requestedLocale } : {}),
+        ...(namespaces.length ? { ns: namespaces.join(",") } : {}),
+      },
+      includeRole: false,
+      withAclMeta: false,
+    }
+  );
+
+  cachedServerResources = {
+    ...cachedServerResources,
+    ...payload.resources,
+  };
+  for (const namespace of namespaces) {
+    mergeNamespace(namespace, payload.lang);
+    loadedServerResourceNamespaces.add(namespace);
+  }
+
+  return payload;
+}
+
+async function ensureServerResourceNamespaces(namespaces: string[]) {
+  const pending: Promise<void>[] = [];
+  const missing: string[] = [];
+
+  for (const namespace of namespaces) {
+    if (loadedServerResourceNamespaces.has(namespace)) continue;
+    if (mergeNamespace(namespace, getCurrentLocale())) continue;
+    const existing = namespaceLoadPromises.get(namespace);
+    if (existing) pending.push(existing);
+    else missing.push(namespace);
+  }
+
+  if (missing.length) {
+    const request = requestServerResources(
+      missing,
+      nocobaseClient.getStoredLocale() ?? getCurrentLocale()
+    ).then(() => undefined);
+    for (const namespace of missing) {
+      namespaceLoadPromises.set(namespace, request);
+    }
+    const cleanup = () => {
+      for (const namespace of missing) {
+        if (namespaceLoadPromises.get(namespace) === request) {
+          namespaceLoadPromises.delete(namespace);
+        }
+      }
+    };
+    void request.then(cleanup, cleanup);
+    pending.push(request);
+  }
+
+  await Promise.all(pending);
+}
+
+export function registerServerResourceNamespace(namespace: string) {
+  if (!namespace) return;
+  serverResourceNamespaces.add(namespace);
+
+  if (
+    mergeNamespace(namespace, getCurrentLocale()) ||
+    !bootstrapStarted ||
+    !bootstrapComplete
+  ) {
+    return;
+  }
+
+  void ensureServerResourceNamespaces([namespace]).catch((error) => {
+    console.warn(
+      `Unable to load NocoBase locale namespace ${namespace}`,
+      error
+    );
+  });
+}
+
+export function getServerResourceNamespaces() {
+  return [...serverResourceNamespaces];
+}
+
+export function loadServerLocaleResources() {
+  if (serverResourcesPromise) return serverResourcesPromise;
+
+  bootstrapStarted = true;
+  const requestedLocale = nocobaseClient.getStoredLocale();
+  const initialNamespaces = [...serverResourceNamespaces];
+  const systemSettingsPromise = nocobaseClient
+    .action<SystemSettingsPayload>("systemSettings", "get", {
+      method: "GET",
+      includeRole: false,
+      withAclMeta: false,
+    })
+    .catch((error) => {
+      console.warn("Unable to load enabled NocoBase languages", error);
+      return undefined;
+    })
+    .then((systemSettings) => {
+      const configuredLocales = Array.isArray(systemSettings?.enabledLanguages)
+        ? systemSettings.enabledLanguages
+        : [];
+      if (configuredLocales.length) setEnabledLocales(configuredLocales);
+      return systemSettings;
+    });
+  const languagePromise = requestServerResources(
+    initialNamespaces,
+    requestedLocale
+  );
+
+  serverResourcesPromise = Promise.all([systemSettingsPromise, languagePromise])
+    .then(async ([systemSettings, payload]) => {
+      const configuredLocales = systemSettings?.enabledLanguages ?? [];
+      const serverLocale = payload.lang;
+
+      if (!configuredLocales.length && serverLocale) {
+        setEnabledLocales([serverLocale]);
+      }
+
+      if (serverLocale) {
+        registerLocale({ locale: serverLocale, label: serverLocale });
+        nocobaseClient.setLocale(serverLocale);
+        await i18n.changeLanguage(serverLocale);
+        applyDocumentLocale(serverLocale);
+      }
+
+      bootstrapComplete = true;
+      const lateNamespaces = [...serverResourceNamespaces].filter(
+        (namespace) => !loadedServerResourceNamespaces.has(namespace)
+      );
+      if (lateNamespaces.length) {
+        await ensureServerResourceNamespaces(lateNamespaces);
+      }
+    })
+    .catch((error) => {
+      bootstrapComplete = true;
+      if (!getLocaleDefinitions().length) {
+        setEnabledLocales([getCurrentLocale()]);
+      }
+      serverResourcesPromise = undefined;
+      throw error;
+    });
+
+  return serverResourcesPromise;
+}

package/registry/nocobase-i18n/tests/i18n-regression.mjs

@@ -0,0 +1,42 @@
+import assert from "node:assert/strict";
+import { createServer } from "vite";
+
+const server = await createServer({
+  appType: "custom",
+  logLevel: "silent",
+  server: { middlewareMode: true },
+});
+
+try {
+  await server.ssrLoadModule("/src/locales/index.ts");
+  const { i18n, registerLocaleResources, translate } =
+    await server.ssrLoadModule("/registry/nocobase-i18n/runtime.ts");
+  const { resolveTranslatableText, setTranslationResolver } =
+    await server.ssrLoadModule("/src/lib/i18n.ts");
+
+  setTranslationResolver(translate);
+
+  await i18n.changeLanguage("en-US");
+  assert.equal(translate("resources.users", { ns: "app" }, "Users"), "Users");
+
+  await i18n.changeLanguage("zh-CN");
+  assert.equal(translate("resources.users", { ns: "app" }, "Users"), "用户");
+  assert.equal(resolveTranslatableText('{{t("Admin")}}'), "管理员");
+  assert.equal(
+    resolveTranslatableText("Full permissions", { ns: "starter" }),
+    "全部权限"
+  );
+
+  registerLocaleResources("example-feature", {
+    "en-US": { title: "Example" },
+    "zh-CN": { title: "示例" },
+  });
+  assert.equal(
+    translate("title", { ns: "example-feature" }, "Example"),
+    "示例"
+  );
+
+  console.log("NocoBase i18n regression tests passed");
+} finally {
+  await server.close();
+}

package/registry.config.json

@@ -0,0 +1,163 @@
+{
+  "name": "nocobase-ai",
+  "homepage": "https://www.nocobase.com",
+  "items": [
+    {
+      "name": "i18n",
+      "type": "registry:block",
+      "title": "NocoBase i18n",
+      "description": "Optional hybrid internationalization with frontend-owned UI resources, selected NocoBase dynamic namespaces, X-Locale synchronization, a reusable language switcher, and an integrated showcase.",
+      "dependencies": [
+        "@refinedev/core@^5.0.8",
+        "i18next@^25.3.2",
+        "lucide-react@^0.487.0",
+        "react-router@^7.0.2"
+      ],
+      "registryDependencies": [
+        "badge",
+        "button",
+        "card",
+        "dropdown-menu",
+        "input",
+        "label",
+        "select",
+        "textarea"
+      ],
+      "docs": "Requires a compatible NocoBase Starter with the generic AppExtension i18nProvider and UserMenuItems host fields. Starter and Registry translations stay local; app:getLang is used only to merge registered dynamic namespaces such as lm-collections. The integrated Demo route documents the complete usage model.",
+      "source": {
+        "root": "registry/nocobase-i18n",
+        "target": "src/extensions/nocobase-i18n",
+        "install": false,
+        "include": ["."]
+      }
+    },
+    {
+      "name": "ai-runtime",
+      "type": "registry:lib",
+      "title": "NocoBase AI Runtime",
+      "description": "NocoBase AI services, providers, transports, controllers, and avatars.",
+      "dependencies": [
+        "@ai-sdk/react@2.0.0",
+        "ai@5.0.0",
+        "@dicebear/core@^9.4.3",
+        "@nocobase/ai-employee-avatars@^1.0.2",
+        "eventsource-parser@3.1.0"
+      ],
+      "source": {
+        "root": "registry/nocobase-ai",
+        "target": "src/extensions/nocobase-ai",
+        "include": ["providers", "services"]
+      }
+    },
+    {
+      "name": "ai-chat",
+      "type": "registry:block",
+      "title": "NocoBase AI Chat Components",
+      "description": "Reusable NocoBase AI chat window, containers, floating trigger, and employee shortcut.",
+      "dependencies": [
+        "echarts@^5.5.0",
+        "echarts-for-react@3.0.2",
+        "lucide-react@^0.487.0",
+        "next-themes@^0.4.6",
+        "react-markdown@^10.1.0",
+        "remark-gfm@^4.0.1"
+      ],
+      "registryDependencies": [
+        "@nocobase/ai-runtime",
+        "badge",
+        "button",
+        "collapsible",
+        "dialog",
+        "dropdown-menu",
+        "hover-card",
+        "input",
+        "input-group",
+        "label",
+        "popover",
+        "select",
+        "tabs",
+        "textarea",
+        "tooltip"
+      ],
+      "source": {
+        "root": "registry/nocobase-ai",
+        "target": "src/extensions/nocobase-ai",
+        "include": ["components", "assets", "index.ts", "README.md"]
+      }
+    },
+    {
+      "name": "ai-react-hook-form",
+      "type": "registry:lib",
+      "title": "NocoBase AI React Hook Form Adapter",
+      "description": "Optional React Hook Form adapter for the built-in AI Form filler.",
+      "dependencies": ["react-hook-form@^7.57.0"],
+      "registryDependencies": ["@nocobase/ai-chat"],
+      "source": {
+        "root": "registry/nocobase-ai",
+        "target": "src/extensions/nocobase-ai",
+        "include": ["adapters/react-hook-form.ts"]
+      }
+    },
+    {
+      "name": "ai",
+      "type": "registry:block",
+      "title": "NocoBase AI Components and Demo",
+      "description": "Complete NocoBase AI component runtime with application resources, routes, and component showcase pages.",
+      "dependencies": ["@refinedev/core@^5.0.8", "react-router@^7.0.2"],
+      "registryDependencies": [
+        "@nocobase/ai-chat",
+        "@nocobase/ai-react-hook-form",
+        "accordion",
+        "alert",
+        "badge",
+        "card",
+        "checkbox",
+        "input",
+        "switch",
+        "table",
+        "textarea"
+      ],
+      "docs": "This item includes the AI extension integration and Demo pages. It is designed for a compatible starter with the AppExtension host enabled. After installation, src/extensions/nocobase-ai/extension.tsx is discovered automatically and contributes its application resources and routes without AI-specific App.tsx edits.",
+      "source": {
+        "root": "registry/nocobase-ai",
+        "target": "src/extensions/nocobase-ai",
+        "include": ["demo", "extension.tsx", "global-ai-chat.tsx"]
+      }
+    },
+    {
+      "name": "acl-ui",
+      "type": "registry:block",
+      "title": "NocoBase ACL UI",
+      "description": "Page, region, field, and role-switching components backed by the Starter's NocoBase accessControlProvider.",
+      "dependencies": ["@refinedev/core@^5.0.8", "lucide-react@^0.487.0"],
+      "registryDependencies": ["badge", "select"],
+      "docs": "Requires a compatible NocoBase Starter with the built-in accessControlProvider and ACL store.",
+      "source": {
+        "root": "registry/nocobase-acl",
+        "target": "src/extensions/nocobase-acl",
+        "include": ["components", "index.ts", "README.md"]
+      }
+    },
+    {
+      "name": "acl",
+      "type": "registry:block",
+      "title": "NocoBase ACL Components and Demo",
+      "description": "Complete ACL composition demo with live role switching, action matrix, multi-collection regions, and field permissions.",
+      "dependencies": ["@refinedev/core@^5.0.8", "react-router@^7.0.2"],
+      "registryDependencies": [
+        "@nocobase/acl-ui",
+        "button",
+        "card",
+        "input",
+        "label",
+        "table",
+        "textarea"
+      ],
+      "source": {
+        "root": "registry/nocobase-acl",
+        "target": "src/extensions/nocobase-acl",
+        "include": ["demo", "extension.tsx"]
+      }
+    }
+  ]
+}