finovision-i18n-resource 1.0.0

package/README.md

@@ -0,0 +1,76 @@
+# finovision-i18n-resource
+
+参照 Coze `studio-i18n-resource` 的 **资源适配包**。文案在 `src/locales/*.json`，由 `config.ts` 静态 import，**构建时打进主包**，浏览器 / Node 用法一致。
+
+## 使用
+
+```ts
+import { buildDefaultConfig, defaultConfig, Locale } from 'finovision-i18n-resource';
+import i18n from 'i18next';
+
+// 按语言 ID 筛选（JSON 已在包内，无需 await、无需再 import JSON）
+const resources = buildDefaultConfig([Locale.En, Locale.ZhCN]);
+// 或全部语言：defaultConfig
+
+await i18n.init({
+  resources,
+  lng: Locale.En,
+  defaultNS: 'i18n',
+  keySeparator: false,
+});
+
+await i18n.changeLanguage(Locale.ZhCN);
+```
+
+### Vue 3 + vue-i18n
+
+```ts
+import { createI18n } from 'vue-i18n';
+import { buildDefaultConfig, Locale } from 'finovision-i18n-resource';
+
+const resources = buildDefaultConfig([Locale.En, Locale.ZhCN]);
+
+export const i18n = createI18n({
+  legacy: false,
+  locale: Locale.En,
+  messages: {
+    en: resources.en!.i18n,
+    'zh-CN': resources['zh-CN']!.i18n,
+  },
+});
+```
+
+## 手动传入 JSON（可选，覆盖部分语言）
+
+```ts
+import { assembleI18nResources } from 'finovision-i18n-resource';
+import customEn from './my-en.json';
+
+const resources = assembleI18nResources({ en: customEn });
+```
+
+## 安装
+
+```bash
+npm install finovision-i18n-resource
+# 本地联调
+npm install file:../fv-i18n-resource
+```
+
+## 新增语言
+
+1. 添加 `src/locales/ja.json`
+2. `npm run dl-i18n`（更新 `Locale` 枚举、`config.ts` 内 import 区块）
+3. `npm run build`
+
+## 脚本
+
+| 命令 | 说明 |
+|------|------|
+| `npm run dl-i18n` | 生成类型、`locale-meta.ts`、`config.ts` 内联 import |
+| `npm run build` | Rollup 打包（含 JSON） |
+| `npm test` | 构建并测试 |
+
+## License
+
+MIT

package/dist/i18n-resource.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="i18n",o={en:{"404_title":"Sorry, this page doesn't exist","404_content":"Please check your link or try again",Cancel:"Cancel",Confirm:"Confirm",AddSuccessToast:'"{name}" has been added',Coze_token_body:"{num, plural, one {Coze token} other {Coze tokens}}"},"zh-CN":{"404_title":"抱歉，页面不存在","404_content":"请检查链接后重试",Cancel:"取消",Confirm:"确认",AddSuccessToast:"已添加「{name}」",Coze_token_body:"{num, plural, other {Coze 代币}}"}};function t(o,t){const n=t??e,r={};for(const[e,t]of Object.entries(o))t&&(r[e]={[n]:t});return r}const n=t(o);var r;exports.Locale=void 0,(r=exports.Locale||(exports.Locale={})).En="en",r.ZhCN="zh-CN",exports.DEFAULT_I18N_NAMESPACE=e,exports.SUPPORTED_LOCALES=["en","zh-CN"],exports.assembleI18nResources=t,exports.buildDefaultConfig=function(e,n){const r=function(e){return"string"==typeof e?[e]:[...e]}(e),s={};for(const e of r)s[e]=o[e];return t(s,n)},exports.defaultConfig=n,exports.loadLocale=function(e){return o[e]};

package/dist/i18n-resource.d.ts

@@ -0,0 +1,70 @@
+/** i18next 默认命名空间，与 {@link defaultConfig} 的 resources 结构一致 */
+declare const DEFAULT_I18N_NAMESPACE = "i18n";
+type DefaultI18nNamespace = typeof DEFAULT_I18N_NAMESPACE;
+
+/** 支持的语言 ID 列表 */
+declare const SUPPORTED_LOCALES: readonly ["en", "zh-CN"];
+type SupportedLocale = (typeof SUPPORTED_LOCALES)[number];
+/**
+ * 语言枚举，供 i18next / vue-i18n 使用：
+ * i18n.changeLanguage(Locale.ZhCN)
+ */
+declare enum Locale {
+    En = "en",
+    ZhCN = "zh-CN"
+}
+
+/** 扁平 key 文案表 */
+type FlatLocale = Record<string, string>;
+/**
+ * 已加载的文案表（手动传入 JSON 时使用）
+ */
+type LocalesInput = Partial<Record<SupportedLocale, FlatLocale>>;
+/** i18next 资源结构：{ [语言]: { [命名空间]: 文案表 } } */
+type I18nResources<NS extends string = string> = Partial<Record<SupportedLocale, Record<NS, FlatLocale>>>;
+/** 按语言 ID 取已打包的文案表 */
+declare function loadLocale(lng: SupportedLocale): FlatLocale;
+/**
+ * 将已加载的文案组装为 i18next resources
+ */
+declare function assembleI18nResources<NS extends string = DefaultI18nNamespace>(locales: LocalesInput, ns?: NS): I18nResources<NS>;
+/** 全部语言对应的 i18next resources（文案 JSON 已内联进包） */
+declare const defaultConfig: Partial<Record<"en" | "zh-CN", Record<"i18n", FlatLocale>>>;
+/**
+ * 按语言 ID 从包内已打包文案组装 resources（浏览器与 Node 用法相同）
+ *
+ * @example
+ * const resources = buildDefaultConfig(['en', 'zh-CN']);
+ * i18n.init({ resources, defaultNS: DEFAULT_I18N_NAMESPACE, lng: Locale.En });
+ */
+declare function buildDefaultConfig<NS extends string = DefaultI18nNamespace>(locales: SupportedLocale | readonly SupportedLocale[], ns?: NS): I18nResources<NS>;
+
+// 本文件由 npm run dl-i18n 自动生成，请勿手改
+/** 插值参数类型，仅支持 string | number */
+type InterpolationValue = string | number;
+
+// #region 插值参数映射
+interface I18nOptionsMap {
+  'AddSuccessToast': { name: InterpolationValue /* 字符串 */ };
+  'Coze_token_body': { num: InterpolationValue /* 数字 */ };
+}
+// #endregion
+
+// #region 带插值的文案键
+type I18nKeysHasOptionsType = keyof I18nOptionsMap;
+// #endregion
+
+// #region 不带插值的文案键
+type I18nKeysNoOptionsType =
+  | '404_content'
+  | '404_title'
+  | 'Cancel'
+  | 'Confirm';
+// #endregion
+
+// #region 全部文案键
+type Expand<T extends string> = T extends infer U ? U : never;
+type LocaleData = Expand<I18nKeysHasOptionsType | I18nKeysNoOptionsType>;
+
+export { DEFAULT_I18N_NAMESPACE, Locale, SUPPORTED_LOCALES, assembleI18nResources, buildDefaultConfig, defaultConfig, loadLocale };
+export type { DefaultI18nNamespace, FlatLocale, I18nKeysHasOptionsType, I18nKeysNoOptionsType, I18nOptionsMap, I18nResources, InterpolationValue, LocaleData, LocalesInput, SupportedLocale };

package/dist/i18n-resource.esm.js

@@ -0,0 +1 @@
+const n="i18n",e={en:{"404_title":"Sorry, this page doesn't exist","404_content":"Please check your link or try again",Cancel:"Cancel",Confirm:"Confirm",AddSuccessToast:'"{name}" has been added',Coze_token_body:"{num, plural, one {Coze token} other {Coze tokens}}"},"zh-CN":{"404_title":"抱歉，页面不存在","404_content":"请检查链接后重试",Cancel:"取消",Confirm:"确认",AddSuccessToast:"已添加「{name}」",Coze_token_body:"{num, plural, other {Coze 代币}}"}};function o(n){return e[n]}function t(e,o){const t=o??n,r={};for(const[n,o]of Object.entries(e))o&&(r[n]={[t]:o});return r}const r=t(e);function c(n,o){const r=function(n){return"string"==typeof n?[n]:[...n]}(n),c={};for(const n of r)c[n]=e[n];return t(c,o)}const s=["en","zh-CN"];var i;!function(n){n.En="en",n.ZhCN="zh-CN"}(i||(i={}));export{n as DEFAULT_I18N_NAMESPACE,i as Locale,s as SUPPORTED_LOCALES,t as assembleI18nResources,c as buildDefaultConfig,r as defaultConfig,o as loadLocale};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "finovision-i18n-resource",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "i18n resource adapter with Coze-style flat keys and TypeScript definitions (studio-i18n-resource)",
+  "type": "module",
+  "main": "./dist/i18n-resource.cjs",
+  "module": "./dist/i18n-resource.esm.js",
+  "types": "./dist/i18n-resource.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/i18n-resource.d.ts",
+      "import": "./dist/i18n-resource.esm.js",
+      "require": "./dist/i18n-resource.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "dl-i18n": "node scripts/dl-i18n.mjs",
+    "clean": "node -e \"import('node:fs').then(fs=>fs.rmSync('dist',{recursive:true,force:true}))\"",
+    "build": "npm run dl-i18n && npm run clean && cross-env NODE_ENV=production rollup -c",
+    "build:dev": "npm run dl-i18n && rollup -c",
+    "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json --noEmit",
+    "test": "npm run build:dev && tsx --test test/*.test.ts",
+    "test:unit": "tsx --test test/*.test.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "i18n",
+    "locale",
+    "resource",
+    "flat-key",
+    "coze",
+    "typescript",
+    "finovision"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.0",
+    "@types/node": "^22.10.0",
+    "cross-env": "^7.0.3",
+    "rollup": "^4.27.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "tslib": "^2.8.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.7.0"
+  }
+}

package/src/config.ts

@@ -0,0 +1,77 @@
+import { DEFAULT_I18N_NAMESPACE, type DefaultI18nNamespace } from './constants';
+import type { SupportedLocale } from './locale-meta';
+
+/** 扁平 key 文案表 */
+export type FlatLocale = Record<string, string>;
+
+// #region locale-bundles — 由 npm run dl-i18n 生成，请勿手改
+import localeEn from './locales/en.json';
+import localeZhCN from './locales/zh-CN.json';
+
+const LOCALE_BUNDLES: Record<SupportedLocale, FlatLocale> = {
+  'en': localeEn,
+  'zh-CN': localeZhCN,
+};
+// #endregion
+
+/**
+ * 已加载的文案表（手动传入 JSON 时使用）
+ */
+export type LocalesInput = Partial<Record<SupportedLocale, FlatLocale>>;
+
+/** i18next 资源结构：{ [语言]: { [命名空间]: 文案表 } } */
+export type I18nResources<NS extends string = string> = Partial<
+  Record<SupportedLocale, Record<NS, FlatLocale>>
+>;
+
+function normalizeLocaleIds(
+  locales: SupportedLocale | readonly SupportedLocale[],
+): SupportedLocale[] {
+  return typeof locales === 'string' ? [locales] : [...locales];
+}
+
+/** 按语言 ID 取已打包的文案表 */
+export function loadLocale(lng: SupportedLocale): FlatLocale {
+  return LOCALE_BUNDLES[lng];
+}
+
+/**
+ * 将已加载的文案组装为 i18next resources
+ */
+export function assembleI18nResources<NS extends string = DefaultI18nNamespace>(
+  locales: LocalesInput,
+  ns?: NS,
+): I18nResources<NS> {
+  const namespace = (ns ?? DEFAULT_I18N_NAMESPACE) as NS;
+  const config = {} as I18nResources<NS>;
+  for (const [lng, messages] of Object.entries(locales) as [
+    SupportedLocale,
+    FlatLocale,
+  ][]) {
+    if (!messages) continue;
+    config[lng] = { [namespace]: messages } as I18nResources<NS>[SupportedLocale];
+  }
+  return config;
+}
+
+/** 全部语言对应的 i18next resources（文案 JSON 已内联进包） */
+export const defaultConfig = assembleI18nResources(LOCALE_BUNDLES);
+
+/**
+ * 按语言 ID 从包内已打包文案组装 resources（浏览器与 Node 用法相同）
+ *
+ * @example
+ * const resources = buildDefaultConfig(['en', 'zh-CN']);
+ * i18n.init({ resources, defaultNS: DEFAULT_I18N_NAMESPACE, lng: Locale.En });
+ */
+export function buildDefaultConfig<NS extends string = DefaultI18nNamespace>(
+  locales: SupportedLocale | readonly SupportedLocale[],
+  ns?: NS,
+): I18nResources<NS> {
+  const ids = normalizeLocaleIds(locales);
+  const loaded: LocalesInput = {};
+  for (const lng of ids) {
+    loaded[lng] = LOCALE_BUNDLES[lng];
+  }
+  return assembleI18nResources(loaded, ns);
+}

package/src/constants.ts

@@ -0,0 +1,4 @@
+/** i18next 默认命名空间，与 {@link defaultConfig} 的 resources 结构一致 */
+export const DEFAULT_I18N_NAMESPACE = 'i18n';
+
+export type DefaultI18nNamespace = typeof DEFAULT_I18N_NAMESPACE;

package/src/index.ts

@@ -0,0 +1,28 @@
+export {
+  DEFAULT_I18N_NAMESPACE,
+  type DefaultI18nNamespace,
+} from './constants';
+
+export {
+  buildDefaultConfig,
+  assembleI18nResources,
+  defaultConfig,
+  loadLocale,
+  type FlatLocale,
+  type LocalesInput,
+  type I18nResources,
+} from './config';
+
+export {
+  SUPPORTED_LOCALES,
+  Locale,
+  type SupportedLocale,
+} from './locale-meta';
+
+export type {
+  InterpolationValue,
+  I18nOptionsMap,
+  I18nKeysHasOptionsType,
+  I18nKeysNoOptionsType,
+  LocaleData,
+} from './locale-data';

package/src/locale-data.d.ts

@@ -0,0 +1,27 @@
+// 本文件由 npm run dl-i18n 自动生成，请勿手改
+/** 插值参数类型，仅支持 string | number */
+export type InterpolationValue = string | number;
+
+// #region 插值参数映射
+export interface I18nOptionsMap {
+  'AddSuccessToast': { name: InterpolationValue /* 字符串 */ };
+  'Coze_token_body': { num: InterpolationValue /* 数字 */ };
+}
+// #endregion
+
+// #region 带插值的文案键
+export type I18nKeysHasOptionsType = keyof I18nOptionsMap;
+// #endregion
+
+// #region 不带插值的文案键
+export type I18nKeysNoOptionsType =
+  | '404_content'
+  | '404_title'
+  | 'Cancel'
+  | 'Confirm';
+// #endregion
+
+// #region 全部文案键
+type Expand<T extends string> = T extends infer U ? U : never;
+export type LocaleData = Expand<I18nKeysHasOptionsType | I18nKeysNoOptionsType>;
+// #endregion

package/src/locale-meta.ts

@@ -0,0 +1,14 @@
+// 文件由 npm run dl-i18n 自动生成，请勿手改
+/** 支持的语言 ID 列表 */
+export const SUPPORTED_LOCALES = ["en","zh-CN"] as const;
+
+export type SupportedLocale = (typeof SUPPORTED_LOCALES)[number];
+
+/**
+ * 语言枚举，供 i18next / vue-i18n 使用：
+ * i18n.changeLanguage(Locale.ZhCN)
+ */
+export enum Locale {
+  En = 'en',
+  ZhCN = 'zh-CN',
+}

package/src/locales/en.json

@@ -0,0 +1,8 @@
+{
+  "404_title": "Sorry, this page doesn't exist",
+  "404_content": "Please check your link or try again",
+  "Cancel": "Cancel",
+  "Confirm": "Confirm",
+  "AddSuccessToast": "\"{name}\" has been added",
+  "Coze_token_body": "{num, plural, one {Coze token} other {Coze tokens}}"
+}

package/src/locales/zh-CN.json

@@ -0,0 +1,8 @@
+{
+  "404_title": "抱歉，页面不存在",
+  "404_content": "请检查链接后重试",
+  "Cancel": "取消",
+  "Confirm": "确认",
+  "AddSuccessToast": "已添加「{name}」",
+  "Coze_token_body": "{num, plural, other {Coze 代币}}"
+}