generator-mico-cli 0.2.28 → 0.2.30

package/generators/micro-react/templates/apps/layout/src/services/user.ts

@@ -1,52 +1,110 @@
-import { request } from '@/common/request';
-import type { IUserInfo } from '@/common/auth/type';
+import { getStoredTenantCode, setStoredTenantCode } from '@/common/auth/tenant';
+import type { IUserInfo, IUserInfoApiData } from '@/common/auth/type';
+import { ETenantModel } from '@/common/auth/type';
 import { getCurrentLocale, type SupportedLocale } from '@/common/locale';
+import { request } from '@/common/request';
 
-const USER_INFO_API = '/api/user/info';
+/** 新用户信息接口（与 OpenAPI `GET /api/user/info/` 一致，非旧 `/api/user/info`） */
+const USER_INFO_API = '/api/user/info/';
 
 /**
  * 语言代码到接口 lang 参数的映射
  * - zh_CN: 1 (中文)
  * - en: 2 (英文)
  */
-const LOCALE_TO_LANG: Partial<Record<SupportedLocale, number>> = {
-  'zh-CN': 1,
-  'en-US': 2,
-};
+// const LOCALE_TO_LANG: Partial<Record<SupportedLocale, number>> = {
+//   'zh-CN': 1,
+//   'en-US': 2,
+// };
 
-/**
- * 获取当前语言对应的 API lang 参数
- */
-function getApiLangParam(): number {
-  const locale = getCurrentLocale();
-  return LOCALE_TO_LANG[locale] ?? 1;
+// function getApiLangParam(): number {
+//   const locale = getCurrentLocale();
+//   return LOCALE_TO_LANG[locale] ?? 1;
+// }
+
+function normalizeUserInfo(data: IUserInfoApiData): IUserInfo {
+  const name = data.name || '';
+  const tenant_model = data.tenant_model ?? ETenantModel.Single;
+  return {
+    ...data,
+    app_perms: Array.isArray(data.app_perms) ? data.app_perms : [],
+    region_perms: Array.isArray(data.region_perms) ? data.region_perms : [],
+    menu_perms: Array.isArray(data.menu_perms) ? data.menu_perms : [],
+    button_perms: Array.isArray(data.button_perms) ? data.button_perms : [],
+    is_superuser: Boolean(data.is_superuser),
+    tenant_model,
+    tenant: Array.isArray(data.tenant) ? data.tenant : [],
+    isMultiTenant: tenant_model === ETenantModel.Multi,
+    user_name: name,
+    username: name || data.email || '',
+  };
 }
 
 export interface IUserInfoResponse {
   code: number;
-  data: IUserInfo;
+  data: IUserInfoApiData;
   msg: string;
 }
 
+export interface ISimpleUser {
+  id: number;
+  email: string;
+  is_superuser: number;
+  is_active: number;
+  user_name: string;
+}
+
+export interface IAllUsersResponse {
+  code: number;
+  msg: string;
+  data: {
+    count: number;
+    results: ISimpleUser[];
+  };
+}
+
+export async function fetchAllUsers(params?: {
+  email?: string;
+}): Promise<IAllUsersResponse> {
+  return request<IAllUsersResponse>('/api/user/all/', {
+    method: 'GET',
+    skipProxy: true,
+    params,
+  });
+}
+
 /**
  * 获取用户信息
  * @returns 用户信息对象
  * @throws 当接口返回非 200 code 时抛出错误
  */
-export async function fetchUserInfo(): Promise<IUserInfo> {
-  const lang = getApiLangParam();
-  const url = `${USER_INFO_API}?lang=${lang}`;
+export async function fetchUserInfo(params?: {
+  lang?: number;
+  tenant_code?: string;
+}): Promise<IUserInfo> {
+  const url = USER_INFO_API;
+
+  // 若未显式指定 tenant_code，则自动注入 localStorage 中的当前租户
+  // 单租户或首次进入时无值，后端会取默认租户并通过 current_tenant 回包
+  const tenantCode = params?.tenant_code ?? getStoredTenantCode() ?? undefined;
+  const requestParams = {
+    ...params,
+    ...(tenantCode ? { tenant_code: tenantCode } : {}),
+  };
 
   const response = await request<IUserInfoResponse>(url, {
     method: 'GET',
     skipProxy: true,
+    params: requestParams,
   });
   if (response.code === 200 && response.data) {
-    const data = response.data;
-    if (!data.user_name) {
-      data.user_name = data.username || '';
+    const userInfo = normalizeUserInfo(response.data);
+    // 回写当前租户到本地存储，保证后续请求与 UI 展示一致
+    const currentTenantCode = userInfo.current_tenant;
+    if (currentTenantCode) {
+      setStoredTenantCode(currentTenantCode);
     }
-    return data;
+    return userInfo;
   }
   throw new Error(response.msg || '获取用户信息失败');
 }

package/generators/micro-react/templates/apps/layout/typings.d.ts

@@ -1 +1,17 @@
 import '@umijs/max/typings';
+
+/**
+ * Window 上挂载的构建信息
+ */
+declare global {
+  interface Window {
+    __MICO_BUILD__?: {
+      branchOrTag?: string;
+      gitCommit?: string;
+      version?: string;
+      buildTime?: string;
+      /** Jenkins 等 CI 的构建号 */
+      buildNumber?: string;
+    };
+  }
+}

package/generators/micro-react/templates/docs/package-shared.md

@@ -0,0 +1,189 @@
+# shared 共享包使用说明
+
+> 创建时间：2026-04-23
+
+## 功能概述
+
+`<%= packageScope %>/shared` 是平台跨应用（主应用 + qiankun 子应用）复用的业务服务层骨架，当前对外暴露两个独立模块：
+
+- **`./services`**
+  - `configureRequest` / `getRequest`：统一 request 注入器
+  - `common`：通用类型（分页、响应包装）与 `isSuccess`
+- **`./timezone`**
+  - `TIMEZONE` / `TIMEZONE_HASH` / `TTimezone`：UTC 与 IANA 映射表
+  - `utcOffsetToTimezone` / `utcOffsetToTimeZoneStr`：纯转换
+  - `configureTimezone({ getTimezone })`：注入「当前 IANA 时区」获取器
+  - `parseDateInTimezone` / `getShortcutDateRange` / `formatTimestampToDateTime` / `formatTimestampToDateTimeWithTimezone`
+
+业务接口、业务常量、业务工具等由各项目按需新增，本包只定义骨架与扩展规范。
+
+## 包结构
+
+```
+packages/shared/
+├── package.json        # 仅导出 ./services 与 ./timezone
+├── tsconfig.json
+├── README.md
+├── services/
+│   ├── index.ts        # services 域唯一对外 barrel
+│   ├── request.ts      # request 注入器
+│   └── common/
+│       └── index.ts    # 通用类型与工具
+└── timezone/
+    └── index.ts        # 时区工具 + 时区获取器
+```
+
+## 导出约定
+
+| 约定 | 说明 |
+|---|---|
+| 一目录一入口 | 每个根目录（`services/`、`timezone/` 等）在 `exports` 中只对应一条入口 |
+| 无根入口 | 不导出 `.`、不设置 `main`/`types`，消费方**不能** `import from '<%= packageScope %>/shared'` |
+| 禁止深层路径 | 不允许 `./services/user`、`./services/common`、`./timezone/sub` 等子路径 |
+| 同级扩展 | 新增共享模块时新建与 `services/`、`timezone/` 同级的目录 |
+
+## 消费方使用
+
+### 1. 初始化（必须，仅一次）
+
+主应用与子应用都在 `app.tsx` 顶层注入本应用的 `request`，模板已默认接好：
+
+```ts
+// apps/layout/src/app.tsx
+import { configureRequest } from '<%= packageScope %>/shared/services';
+import { request as commonRequest } from './common/request';
+
+configureRequest(commonRequest);
+```
+
+```ts
+// apps/<subapp>/src/app.tsx
+import { configureRequest } from '<%= packageScope %>/shared/services';
+import { request } from './common/request';
+
+// 子应用 request 内部已自动桥接主应用 / 独立 umi，
+// 顶层注入即可，无需在 mount 里反复设置
+configureRequest(request);
+```
+
+> 子应用 `./common/request` 的实现会在 qiankun 模式下走 `getMainAppRequest()`，独立运行时走 `umiRequest`，因此顶层注入的是同一个稳定函数引用，运行期才决定具体走哪条链路。
+
+未初始化即调用 `getRequest()` 会抛出 `[shared/services] request 未初始化，请先调用 configureRequest()`，提示检查初始化时序。
+
+### 2. 业务代码调用
+
+```ts
+import {
+  getRequest,
+  isSuccess,
+  type IPagedResponse,
+} from '<%= packageScope %>/shared/services';
+
+async function fetchUsers(): Promise<IPagedResponse<IUser>> {
+  const res = await getRequest()<{ code: number; data: IPagedResponse<IUser> }>(
+    '/api/user/',
+    { method: 'GET' },
+  );
+  if (!isSuccess(res)) throw new Error('fetch users failed');
+  return res.data;
+}
+```
+
+### 3. 时区模块初始化
+
+`./timezone` 不内置时区存储，由消费方注入「当前 IANA 时区获取器」（通常代理到主应用的时区管理模块）：
+
+```ts
+// apps/layout/src/app.tsx
+import { configureTimezone } from '<%= packageScope %>/shared/timezone';
+import { getTimezone } from '@/common/helpers';
+
+configureTimezone({ getTimezone });
+```
+
+依赖前置：本模块以 `peerDependencies` 声明 dayjs。**消费方需在入口扩展三个插件**（`utc / timezone / customParseFormat`）：
+
+```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`。
+
+业务调用示例：
+
+```ts
+import {
+  TIMEZONE,
+  parseDateInTimezone,
+  getShortcutDateRange,
+  formatTimestampToDateTime,
+  formatTimestampToDateTimeWithTimezone,
+} from '<%= packageScope %>/shared/timezone';
+
+parseDateInTimezone('2025-11-04 16:20:21');
+const [start, end] = getShortcutDateRange('week');
+formatTimestampToDateTime(Date.now());
+formatTimestampToDateTimeWithTimezone(Date.now(), TIMEZONE['UTC+8']);
+```
+
+## 扩展规范
+
+### 场景 A：新增业务接口（归属 services 域）
+
+1. 新建子目录 `services/<module>/`
+2. 在其中创建唯一对外入口 `index.ts`；如需细分，新增 `type.ts` 等文件但只由 `index.ts` re-export
+3. 在 `services/<module>/index.ts` 中：
+   - 用 `export type {...}` 对外暴露类型
+   - 用 `getRequest()` 调后端，导出业务函数
+4. 在 `services/index.ts` 追加一行聚合：`export * from './<module>';`
+5. **不要**改动 `package.json` 的 `exports`
+
+### 场景 B：新增非 services 共享模块（如 constants / utils）
+
+当一类共享内容明显**不属于** services 域，新建与 `services/` 同级的目录，作为全新独立对外模块：
+
+1. 在包根新建目录，例如 `constants/`
+2. 创建唯一对外入口 `constants/index.ts`
+3. 在 `package.json` 的 `exports` 中追加且仅追加一条：
+
+   ```json
+   "./constants": "./constants/index.ts"
+   ```
+
+4. 在 `package.json` 的 `files` 数组追加目录名 `"constants"`
+5. **禁止**新增任何 `./constants/<sub>` 深层路径
+
+## 设计决策
+
+| 决策点 | 选择 | 理由 |
+|---|---|---|
+| 包定位 | 仅骨架，无业务实现 | 模板场景下各项目业务差异大，留空可避免强耦合业务假设 |
+| request 注入器 | 运行时注入而非直接依赖某 request 包 | 主应用 / 子应用在 qiankun 模式下共享同一请求实例，注入模式可一次定义、多处复用 |
+| 仅 `./services` 入口 | 不开放 `.` 根入口与深层路径 | 强约束消费方统一从命名空间入口导入，内部重构不影响外部契约 |
+| 一目录一模块 | 同级目录都只暴露 `index.ts` | 保持"外部可见面 = exports 列表"，依赖图清晰，重构自由度高 |
+| 保留 `common` 内联于 services | 不独立成 `common/` 同级目录 | 当前只有分页和响应结果等通用类型，体量小；后续若通用工具增多再拆 |
+
+## 注意事项
+
+- `configureRequest` 必须在任何业务调用**之前**执行。主应用与子应用模板均在 `app.tsx` 顶层注入；子应用注入的是本地的 `./common/request` 函数（运行期由它自动桥接主应用 / 独立 umi），所以无需在 `mount` 里重复注入 `props.request`。
+- `RequestFn` 签名为 `<T = unknown>(url: string, options?: Record<string, unknown>) => Promise<T>`，各应用的 request 实例需兼容这一签名。
+- 新增子目录时，如果消费方只依赖类型，也要通过 `services/index.ts` re-export，不要引导外部直接 import 内部 `type.ts`。
+- 若后续需要支持多实例 request（例如不同域名的后端），可以在本包扩展成 `configureRequest(name, req)` + `getRequest(name)` 的多命名空间形式，当前版本按单实例设计。
+
+## 相关文件
+
+| 文件 | 说明 |
+|---|---|
+| [packages/shared/package.json](../packages/shared/package.json) | 导出声明，约束外部可见面 |
+| [packages/shared/services/index.ts](../packages/shared/services/index.ts) | 对外 barrel 与扩展规范注释 |
+| [packages/shared/services/request.ts](../packages/shared/services/request.ts) | request 注入器实现 |
+| [packages/shared/services/common/index.ts](../packages/shared/services/common/index.ts) | 通用类型与 `isSuccess` |
+| [packages/shared/timezone/index.ts](../packages/shared/timezone/index.ts) | 时区常量、纯转换、注入器与格式化函数 |
+| [packages/shared/README.md](../packages/shared/README.md) | 包内使用文档 |
+| [apps/layout/src/common/helpers.ts](../apps/layout/src/common/helpers.ts) | 主应用时区管理实现（被 `configureTimezone` 注入） |

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

@@ -32,7 +32,7 @@
   "devDependencies": {
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
-    "@common-web/sentry": "^0.0.4",
+    "@common-web/sentry": "0.0.7",
     "@sentry/webpack-plugin": "^4.9.1",
 		"@typescript-eslint/eslint-plugin": "^8.54.0",
 		"@typescript-eslint/parser": "^8.54.0",