generator-mico-cli 0.2.29 → 0.2.30

package/generators/micro-react/templates/packages/common-intl/package.json

@@ -13,7 +13,7 @@
     "src"
   ],
   "dependencies": {
-    "@common-web/common-intl": "0.2.2"
+    "@common-web/common-intl": "0.3.1"
   },
   "keywords": [
     "i18n",

package/generators/micro-react/templates/packages/common-intl/src/index.ts

@@ -1,4 +1,6 @@
+// 上游全量导出（含 initIntl、addIntl 等）；子应用需与主应用不同 tag 时可再次 initIntl，见 README「不同 tag」
 export * from '@common-web/common-intl';
 
-// 导出 intl 对象、fetchMultilingualData、i18n（均绑定 intl.ts 中配置的 tag）
-export { default as intl, fetchMultilingualData, i18n } from './intl';
+// 默认 intl、fetchMultilingualData、i18n（均绑定 intl.ts 中的默认 tag）；主/子应用入口可 configureLocale
+export type { LocaleBridge } from './intl';
+export { configureLocale, default as intl, fetchMultilingualData, i18n } from './intl';

package/generators/micro-react/templates/packages/common-intl/src/intl.ts

@@ -1,14 +1,88 @@
-import { initIntl, addIntl } from '@common-web/common-intl';
+import { initIntl, addIntl, type ILang } from '@common-web/common-intl';
+import {
+  getCurrentLocaleForIntl,
+  ilangToUmiLocale,
+  setLocaleToStorageForIntl,
+  umiLocaleToILang,
+} from './umiLocaleBridge';
 
-// 在模块加载时即完成 tag 绑定
-// tag 请根据项目实际值替换
-const { fetchMultilingualData, i18n } = initIntl({
+/** 与 layout 注入的 __MICO_CONFIG__.intl / commonIntl 对齐（本包不依赖 layout 全局类型） */
+type MicoIntlSlice = {
+  tag?: string;
+  app_name?: string;
+  indexedDBParams?: {
+    dbName?: string;
+    dbVersion?: number;
+    storeName?: string;
+    keyPathKey?: string;
+  };
+};
+
+/** 构建期默认；运行时由 window.__MICO_CONFIG__.intl（或 commonIntl）覆盖 */
+const DEFAULT_INTL_OPTIONS = {
   tag: '<%= intlTag %>',
   app_name: 'middle', // 多语言中台的应用名。这个一般不需要改，应该就是 middle
   indexedDBParams: { dbName: 'mico_i18n_db' },
+} as const;
+
+function readMicoIntlOverride(): MicoIntlSlice | undefined {
+  if (typeof window === 'undefined') return undefined;
+  const w = (
+    window as Window & {
+      __MICO_CONFIG__?: { intl?: MicoIntlSlice; commonIntl?: MicoIntlSlice };
+    }
+  ).__MICO_CONFIG__;
+  return w?.intl ?? w?.commonIntl;
+}
+
+function getInitIntlOptions() {
+  const fromConfig = readMicoIntlOverride();
+  return {
+    ...DEFAULT_INTL_OPTIONS,
+    ...fromConfig,
+  };
+}
+
+/**
+ * common-intl 侧语言读写（ILang）与 Umi 存储（zh-CN / en-US）的桥接。
+ * 主应用与子应用均应在入口最早调用 {@link configureLocale}（layout `app.tsx`、子应用 `app.tsx`）。
+ */
+export type LocaleBridge = {
+  getLocale: () => ILang;
+  setLocale: (lang: ILang) => void;
+};
+
+function createDefaultLocaleBridge(): LocaleBridge {
+  return {
+    getLocale: () => umiLocaleToILang(getCurrentLocaleForIntl()),
+    setLocale: (lang) => {
+      setLocaleToStorageForIntl(ilangToUmiLocale(lang));
+    },
+  };
+}
+
+let localeBridge: LocaleBridge = createDefaultLocaleBridge();
+
+/**
+ * 覆盖 initIntl 使用的 getLocale / setLocale，完成 Umi locale ↔ ILang 转换。
+ * - 主应用：与 `locale.getLocale`、`umi_locale` 一致（见 layout `app.tsx`）。
+ * - 子应用：与主应用注入的 `props.locale` 及本地 `umi_locale` 一致（见 subapp `app.tsx`、`getSubappCurrentLocale`）。
+ */
+export function configureLocale(patch: Partial<LocaleBridge>): void {
+  localeBridge = {
+    ...localeBridge,
+    ...patch,
+  };
+}
+
+// 在模块加载时即完成 tag 绑定（读取 head 注入的 __MICO_CONFIG__）
+const { fetchMultilingualData, i18n } = initIntl({
+  ...getInitIntlOptions(),
+  getLocale: () => localeBridge.getLocale(),
+  setLocale: (lang: ILang) => localeBridge.setLocale(lang),
 });
 
-export { fetchMultilingualData, i18n };
+export { fetchMultilingualData, i18n, initIntl };
 
 /**
  * 国际化文案汇总
@@ -17,9 +91,9 @@ export { fetchMultilingualData, i18n };
  * import { intl } from '<%= packageScope %>/common-intl';
  * intl.common_hello()
  *
- * 子应用默认使用本文件的 intl 对象（与主应用共享同一个 tag）。
- * 如果子应用需要使用独立的 tag，应直接依赖 @common-web/common-intl，
- * 在子应用内自行调用 initIntl，不需要经过本中转包。
+ * 子应用默认使用本文件的 intl 对象（与主应用共享同一默认 tag）。
+ * 若需与主应用不同 tag：上游支持多 tag，可在子应用内再次 initIntl（推荐从本包 import initIntl，
+ * 见 index.ts 对 @common-web/common-intl 的 re-export）；亦可直接依赖 @common-web/common-intl。
  * 详见 @common-web/common-intl README：
  * https://gitlab-vywrajy.micoworld.net/micocenter/mico-portal/portal-center/common-web/-/blob/release/0.0.9/packages/common-intl/README.md
  */
@@ -36,6 +110,28 @@ const intl = addIntl({
       interpolations: [name],
       defaultMessage: `欢迎, ${name}`,
     }),
+
+  // ============ SSO 认证失败弹框 ============
+  sso_auth_failure_modal_title: () =>
+    i18n({
+      key: 'sso_auth_failure_modal_title',
+      defaultMessage: '登录提示',
+    }),
+  sso_auth_failure_modal_content: () =>
+    i18n({
+      key: 'sso_auth_failure_modal_content',
+      defaultMessage: '自动登录失败，是否重新尝试登录？',
+    }),
+  sso_auth_failure_modal_ok: () =>
+    i18n({
+      key: 'sso_auth_failure_modal_ok',
+      defaultMessage: '重新登录',
+    }),
+  sso_auth_failure_modal_cancel: () =>
+    i18n({
+      key: 'sso_auth_failure_modal_cancel',
+      defaultMessage: '取消',
+    }),
 }, i18n);
 
 export default intl;

package/generators/micro-react/templates/packages/common-intl/src/umiLocaleBridge.ts

@@ -0,0 +1,101 @@
+/**
+ * Umi locale ↔ ILang 桥接，供 initIntl 的 getLocale / setLocale 使用。
+ * 逻辑须与 apps/layout/src/common/locale.ts、common/intl/localeMapping.ts 保持一致（复制自 layout 模板）。
+ */
+import { LANG, type ILang } from '@common-web/common-intl';
+
+const LOCALE_STORAGE_KEY = 'umi_locale';
+const URL_PARAM_KEY = 'lang';
+
+const SUPPORTED_LOCALES = ['zh-CN', 'en-US'] as const;
+type SupportedLocale = (typeof SUPPORTED_LOCALES)[number];
+
+const LOCALE = {
+  ZH_CN: 'zh-CN',
+  EN_US: 'en-US',
+} as const;
+
+const DEFAULT_LOCALE: SupportedLocale = 'en-US';
+
+function getLocaleFromUrl(): string | null {
+  if (typeof window === 'undefined') {
+    return null;
+  }
+  const urlParams = new URLSearchParams(window.location.search);
+  return urlParams.get(URL_PARAM_KEY);
+}
+
+function getLocaleFromStorage(): string | null {
+  if (typeof window === 'undefined') {
+    return null;
+  }
+  try {
+    return localStorage.getItem(LOCALE_STORAGE_KEY);
+  } catch {
+    return null;
+  }
+}
+
+function getBrowserLocale(): SupportedLocale {
+  if (typeof window === 'undefined') {
+    return DEFAULT_LOCALE;
+  }
+  const browserLang = navigator.language || (navigator as { userLanguage?: string }).userLanguage;
+  const locales = [...SUPPORTED_LOCALES];
+  if (locales.includes(browserLang as SupportedLocale)) {
+    return browserLang as SupportedLocale;
+  }
+  const langPrefix = browserLang.split('-')[0];
+  const matchedLocale = locales.find((locale) => locale.startsWith(langPrefix));
+  return matchedLocale || DEFAULT_LOCALE;
+}
+
+function isValidLocale(locale: string | null): locale is SupportedLocale {
+  if (!locale) {
+    return false;
+  }
+  return ([...SUPPORTED_LOCALES] as string[]).includes(locale);
+}
+
+export function getCurrentLocaleForIntl(): SupportedLocale {
+  const urlLocale = getLocaleFromUrl();
+  if (isValidLocale(urlLocale)) {
+    return urlLocale;
+  }
+  const storageLocale = getLocaleFromStorage();
+  if (isValidLocale(storageLocale)) {
+    return storageLocale;
+  }
+  return getBrowserLocale();
+}
+
+export function setLocaleToStorageForIntl(locale: SupportedLocale): void {
+  if (typeof window === 'undefined') {
+    return;
+  }
+  try {
+    localStorage.setItem(LOCALE_STORAGE_KEY, locale);
+  } catch (error) {
+    console.error('Failed to save locale to localStorage:', error);
+  }
+}
+
+const UMI_TO_ILANG: Record<SupportedLocale, ILang> = {
+  [LOCALE.ZH_CN]: LANG.ZH_CN,
+  [LOCALE.EN_US]: LANG.EN,
+};
+
+export function umiLocaleToILang(locale: SupportedLocale): ILang {
+  return UMI_TO_ILANG[locale] ?? LANG.EN;
+}
+
+const ILANG_TO_UMI: Partial<Record<ILang, SupportedLocale>> = {
+  [LANG.ZH_CN]: LOCALE.ZH_CN,
+  [LANG.EN]: LOCALE.EN_US,
+  [LANG.AR]: LOCALE.EN_US,
+  [LANG.TR]: LOCALE.EN_US,
+};
+
+export function ilangToUmiLocale(lang: ILang): SupportedLocale {
+  return ILANG_TO_UMI[lang] ?? LOCALE.EN_US;
+}

package/generators/micro-react/templates/packages/shared/README.md

@@ -0,0 +1,120 @@
+# shared
+
+平台共享业务服务层骨架。当前提供两个对外模块：
+
+- `./services`
+  - `configureRequest` / `getRequest`：统一 request 注入器
+  - `common`：通用类型（分页、响应包装）与工具函数（`isSuccess`）
+- `./timezone`
+  - `TIMEZONE` / `TIMEZONE_HASH` / `TTimezone`：UTC 与 IANA 时区映射
+  - `utcOffsetToTimezone` / `utcOffsetToTimeZoneStr`：纯转换工具
+  - `configureTimezone({ getTimezone })`：注入「当前 IANA 时区」获取器
+  - `parseDateInTimezone` / `getShortcutDateRange` / `formatTimestampToDateTime` / `formatTimestampToDateTimeWithTimezone`：当前时区下的解析与格式化
+
+后续共享模块（业务服务、常量、工具函数等）由各项目按需新增，本包只提供骨架与扩展约定。
+
+## 目录约定
+
+- 每个共享模块 = `services/` 同级的一个独立目录（例如 `services/`、`constants/`、`utils/`）
+- 每个目录有且只有一个对外入口 `index.ts`
+- `package.json` 的 `exports` 中**每个目录对应且仅对应一条**入口（如 `./constants → ./constants/index.ts`）
+- 禁止暴露目录内部任何深层路径（例如 `./services/user`、`./services/common` 等都不允许）
+
+## 初始化
+
+在应用入口注入一次 request 实例：
+
+```ts
+import { configureRequest } from '<%= packageScope %>/shared/services';
+import { request } from '@/common/request';
+
+// 主应用：在 app.tsx 顶层
+configureRequest(request);
+
+// 子应用（qiankun）：在收到 mount props 后
+configureRequest(props.request);
+```
+
+## 使用通用类型
+
+```ts
+import { isSuccess, type IPagedResponse } from '<%= packageScope %>/shared/services';
+```
+
+## 使用时区工具
+
+`./timezone` 不内置时区存储，本包通过 `configureTimezone` 接收主应用的「当前 IANA 时区」获取器：
+
+```ts
+// apps/layout/src/app.tsx
+import { configureTimezone } from '<%= packageScope %>/shared/timezone';
+import { getTimezone } from '@/common/helpers';
+
+configureTimezone({ getTimezone });
+```
+
+随后业务代码可直接调用：
+
+```ts
+import {
+  parseDateInTimezone,
+  getShortcutDateRange,
+  formatTimestampToDateTime,
+  formatTimestampToDateTimeWithTimezone,
+  TIMEZONE,
+} from '<%= packageScope %>/shared/timezone';
+
+parseDateInTimezone('2025-11-04 16:20:21'); // Dayjs（按当前业务时区解析）
+getShortcutDateRange('week');                // [周一 00:00, 周日 23:59]
+formatTimestampToDateTime(Date.now());       // '2025.11.04 16:20:21'
+formatTimestampToDateTimeWithTimezone(Date.now(), TIMEZONE['UTC+8']);
+```
+
+> 依赖前置：本模块依赖 `dayjs` + `utc / timezone / customParseFormat` 插件（声明为 `peerDependencies`，由消费方提供）。请在应用入口预先调用：
+>
+> ```ts
+> import dayjs from 'dayjs';
+> import utc from 'dayjs/plugin/utc';
+> import timezone from 'dayjs/plugin/timezone';
+> import customParseFormat from 'dayjs/plugin/customParseFormat';
+> dayjs.extend(utc);
+> dayjs.extend(timezone);
+> dayjs.extend(customParseFormat);
+> ```
+>
+> 模板的 `apps/layout/src/common/helpers.ts` 已扩展 `utc / timezone`，仅需补 `customParseFormat`。
+
+## 在 services 内新增业务子模块
+
+`services/` 是后端业务接口的聚合包，新增业务接口时在其内部组织子目录、统一从 `services/index.ts` 聚合出口：
+
+1. 在 `services/` 下新建子目录，例如 `services/user/`
+2. 在该目录下创建 `index.ts`（如有需要可再拆 `type.ts`，但仅由 `index.ts` re-export）
+3. 在 `services/user/index.ts` 中：
+   - 用 `export type {...}` 转发对外类型
+   - 用 `getRequest()` 调用后端，导出业务函数
+4. 在 [services/index.ts](./services/index.ts) 顶层 barrel 中追加 `export * from './user';`
+
+> 不要在 [package.json](./package.json) 的 `exports` 中新增 `./services/user` 等深层路径——`services` 域的所有出口都收敛在 `./services` 一条入口。
+
+## 新增同级共享模块（如 constants / utils）
+
+当一类共享内容明显**不属于** `services` 域（例如纯常量、纯工具函数、纯类型定义），新增一个 `services/` 同级的目录，作为一个全新的独立模块对外暴露：
+
+1. 在包根目录下新建模块目录，例如 `constants/`
+2. 创建唯一对外入口 `constants/index.ts`，内部需要细分时只允许 `index.ts` re-export
+3. 在 [package.json](./package.json) 的 `exports` 中追加且仅追加一条：
+
+   ```json
+   "./constants": "./constants/index.ts"
+   ```
+
+4. 在 [package.json](./package.json) 的 `files` 字段追加目录名 `"constants"`，确保发包时一并打包
+
+> 同样禁止新增任何 `./constants/<sub>` 形式的深层路径。
+
+## 为什么限制导出粒度
+
+- **封装边界**：消费方只能通过模块 index 拿到类型与函数，内部实现拆分（拆分 type.ts、新增 helpers）不会破坏外部契约
+- **重构自由度**：未来调整目录结构时，只要保持 index.ts 出口稳定，即可零成本重构
+- **依赖图清晰**：避免出现"某处只 import 了一个深层 type"导致的隐式耦合

package/generators/micro-react/templates/packages/shared/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "<%= packageScope %>/shared",
+  "version": "0.0.1",
+  "description": "平台共享业务服务层骨架（request 注入器 + 通用类型 + 时区工具）",
+  "private": true,
+  "type": "module",
+  "exports": {
+    "./services": "./services/index.ts",
+    "./timezone": "./timezone/index.ts"
+  },
+  "files": [
+    "services",
+    "timezone"
+  ],
+  "peerDependencies": {
+    "dayjs": "^1.11.0"
+  },
+  "peerDependenciesMeta": {
+    "dayjs": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.0.3"
+  }
+}

package/generators/micro-react/templates/packages/shared/services/common/index.ts

@@ -0,0 +1,43 @@
+/**
+ * 通用类型与工具函数
+ */
+
+/** 通用接口响应结果码 */
+export enum EResultCode {
+  OK = 0,
+  UnknownErr = -1,
+}
+
+export type ResultCode = EResultCode | number;
+
+/** 通用接口响应结果 */
+export interface IResult {
+  code?: ResultCode;
+  msg?: string;
+}
+
+/**
+ * 判断接口响应是否成功（code === 0）
+ */
+export function isSuccess(result: IResult = {}): boolean {
+  return (result.code ?? 0) === 0;
+}
+
+/** 通用分页请求参数 */
+export interface IPagedRequest {
+  page?: number;
+  page_size?: number;
+}
+
+/** 通用分页响应结构（后端返回 count + results，与 DRF 默认格式一致） */
+export interface IPagedResponse<T> {
+  results: T[];
+  count: number;
+}
+
+/** 通用接口响应包装 */
+export interface IApiResponse<T = unknown> {
+  code: number;
+  msg: string;
+  data: T;
+}

package/generators/micro-react/templates/packages/shared/services/index.ts

@@ -0,0 +1,21 @@
+// request 注入器
+export { configureRequest, getRequest } from './request';
+export type { RequestFn } from './request';
+
+// 通用类型与工具
+export * from './common';
+
+/**
+ * 模块扩展规范：
+ *
+ * 1) 新增「业务接口」：在 services/ 下新建子目录（如 services/user/），
+ *    在本文件追加 `export * from './<module>';`，
+ *    不要在 package.json 的 exports 中新增子路径。
+ *
+ * 2) 新增「services 之外的共享模块」（如 constants / utils）：
+ *    在包根目录新建与 services/ 同级的目录（如 constants/），
+ *    在 package.json 的 exports 中新增「且仅新增」一条：
+ *      "./<module>": "./<module>/index.ts"
+ *    并将目录名加入 package.json 的 files 数组。
+ *    禁止暴露任何 `./<module>/<sub>` 形式的深层路径。
+ */

package/generators/micro-react/templates/packages/shared/services/request.ts

@@ -0,0 +1,43 @@
+/**
+ * request 注入器
+ *
+ * 各消费方在初始化时调用 configureRequest 注入 request 实例：
+ * - 主应用（layout 独立运行）：在 app.tsx 顶层调用
+ * - 子应用（qiankun 模式）：在收到 mount props 后的 setMicroAppProps 中调用
+ *
+ * @example
+ * // 主应用
+ * import { configureRequest } from '<packageScope>/shared/services';
+ * configureRequest(request);
+ *
+ * // 子应用
+ * import { configureRequest } from '<packageScope>/shared/services';
+ * configureRequest(props.request);
+ */
+
+export type RequestFn = <T = unknown>(
+  url: string,
+  options?: Record<string, unknown>,
+) => Promise<T>;
+
+let _request: RequestFn | null = null;
+
+/**
+ * 注入 request 实例，应在应用初始化阶段调用一次
+ */
+export function configureRequest(req: RequestFn): void {
+  _request = req;
+}
+
+/**
+ * 获取已注入的 request 实例
+ * 若未初始化则抛出错误，提示调用方检查初始化时序
+ */
+export function getRequest(): RequestFn {
+  if (!_request) {
+    throw new Error(
+      '[shared/services] request 未初始化，请先调用 configureRequest()',
+    );
+  }
+  return _request;
+}