@yss123/cage-cli 0.0.0-stage → 0.2.0

package/templates/blank/packages/contracts/src/aggregates/user/index.ts

@@ -0,0 +1,89 @@
+// 生成物：由 cage gen 从 domain 声明生成，不要手改。
+/* eslint-disable */
+
+import { z } from 'zod';
+import { client, useCageList, useCageQuery, type TransferTask } from '@yss123/cage-client';
+
+/** 用户：读侧快照（敏感字段是按权限掩码后的值） */
+export const UserSchema = z.object({
+  id: z.string().uuid(),
+  username: z.string(),
+  name: z.string(),
+  deptId: z.string().uuid(),
+  roleIds: z.array(z.string().uuid()),
+  phone: z.string().nullable().optional(),
+  email: z.string().nullable().optional(),
+  ssoSubject: z.string().nullable().optional(),
+  status: z.enum(["active", "disabled"]),
+  version: z.number().int(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+export type User = z.infer<typeof UserSchema>;
+export type UserStatus = User['status'];
+export const UserStates = ['active', 'disabled'] as const;
+
+/** 命令输入：和后端命令的输入校验完全一致 */
+export const UserInputs = {
+  assignRoles: z.object({ id: z.string().uuid(), roleIds: z.array(z.string().uuid()).max(50) }),
+  create: z.object({ username: z.string().min(2).max(64).regex(new RegExp("^[A-Za-z0-9_.@-]+$")), name: z.string().min(1).max(100), deptId: z.string().uuid(), phone: z.string().max(32).nullable().optional(), email: z.string().email().max(200).nullable().optional(), ssoSubject: z.string().max(200).nullable().optional() }),
+  disable: z.object({ id: z.string().uuid() }),
+  enable: z.object({ id: z.string().uuid() }),
+  setPassword: z.object({ id: z.string().uuid(), password: z.string().min(8).max(200) }),
+  update: z.object({ id: z.string().uuid(), name: z.string().min(1).max(100).optional(), deptId: z.string().uuid().optional(), phone: z.string().max(32).nullable().optional(), email: z.string().email().max(200).nullable().optional() }),
+};
+
+/** User.assignRoles 可能返回的错误码 */
+export type UserAssignRolesError = 'CONFLICT' | 'CONSTRAINT_VIOLATED' | 'DOMAIN_ERROR' | 'FORBIDDEN' | 'INVALID_INPUT' | 'INVALID_TRANSITION' | 'NOT_FOUND';
+/** User.create 可能返回的错误码 */
+export type UserCreateError = 'CONFLICT' | 'CONSTRAINT_VIOLATED' | 'DOMAIN_ERROR' | 'FORBIDDEN' | 'INVALID_INPUT';
+/** User.disable 可能返回的错误码 */
+export type UserDisableError = 'CONFLICT' | 'DOMAIN_ERROR' | 'FORBIDDEN' | 'INVALID_INPUT' | 'INVALID_TRANSITION' | 'NOT_FOUND';
+/** User.enable 可能返回的错误码 */
+export type UserEnableError = 'CONFLICT' | 'DOMAIN_ERROR' | 'FORBIDDEN' | 'INVALID_INPUT' | 'INVALID_TRANSITION' | 'NOT_FOUND';
+/** User.setPassword 可能返回的错误码 */
+export type UserSetPasswordError = 'CONFLICT' | 'DOMAIN_ERROR' | 'FORBIDDEN' | 'INVALID_INPUT' | 'INVALID_TRANSITION' | 'NOT_FOUND';
+/** User.update 可能返回的错误码 */
+export type UserUpdateError = 'CONFLICT' | 'DOMAIN_ERROR' | 'FORBIDDEN' | 'INVALID_INPUT' | 'INVALID_TRANSITION' | 'NOT_FOUND';
+
+export type UserSortKey = 'createdAt' | 'updatedAt' | 'username' | 'name' | 'deptId' | 'phone' | 'email' | 'ssoSubject';
+export interface UserListParams {
+  page?: number;
+  pageSize?: number;
+  /** 排序：字段名，前面加 - 表示倒序 */
+  sort?: UserSortKey | `-${UserSortKey}`;
+  /** 可以逗号分隔多个状态 */
+  status?: string;
+  createdAfter?: string;
+  createdBefore?: string;
+  username?: string | number | boolean;
+  deptId?: string | number | boolean;
+  ssoSubject?: string | number | boolean;
+}
+
+/** 调用方法：每个命令一个；client 自动生成并附带幂等键和 CSRF 令牌 */
+export const user = {
+  /** 设置用户的角色（不能分配包含自己没有的能力的角色） */
+  assignRoles: (id: string, input: Omit<z.input<typeof UserInputs.assignRoles>, 'id'>, expectedVersion?: number) => client.post<User, UserAssignRolesError>(`/api/user/${encodeURIComponent(id)}/assign-roles`, { ...input, expectedVersion }),
+  /** 新建用户（默认没有任何角色） */
+  create: (input: z.input<typeof UserInputs.create>) => client.post<User, UserCreateError>('/api/user/create', input),
+  /** 停用用户 */
+  disable: (id: string, expectedVersion?: number) => client.post<User, UserDisableError>(`/api/user/${encodeURIComponent(id)}/disable`, { expectedVersion }),
+  /** 启用用户 */
+  enable: (id: string, expectedVersion?: number) => client.post<User, UserEnableError>(`/api/user/${encodeURIComponent(id)}/enable`, { expectedVersion }),
+  /** 重置密码 */
+  setPassword: (id: string, input: Omit<z.input<typeof UserInputs.setPassword>, 'id'>, expectedVersion?: number) => client.post<User, UserSetPasswordError>(`/api/user/${encodeURIComponent(id)}/set-password`, { ...input, expectedVersion }),
+  /** 修改用户信息 */
+  update: (id: string, input: Omit<z.input<typeof UserInputs.update>, 'id'>, expectedVersion?: number) => client.post<User, UserUpdateError>(`/api/user/${encodeURIComponent(id)}/update`, { ...input, expectedVersion }),
+  /** 异步导出 CSV：返回任务，使用 client.transfer(id) 查状态，完成后下载。需要 User.export 能力。 */
+  export: (params: UserListParams = {}, options: { idempotencyKey?: string } = {}) => client.post<TransferTask, 'CONFLICT'>('/api/user/export', params, options),
+  get: (id: string) => client.get<User>(`/api/user/${encodeURIComponent(id)}`),
+  list: (params: UserListParams = {}) => client.get<{ items: User[]; total: number; page: number; pageSize: number }>('/api/user', params as Record<string, unknown>),
+};
+
+/** 详情查询 hook：响应也用 schema 校验；范围外返回 NOT_FOUND */
+export const useUser = (id: string) => useCageQuery(['user', id], `/api/user/${encodeURIComponent(id)}`, UserSchema, { enabled: !!id });
+/** 列表查询 hook：走读侧账号与安全视图 */
+export const useUserList = (params: UserListParams = {}) => useCageList(['user'], '/api/user', params as Record<string, unknown>, UserSchema);
+/** 查询缓存键前缀：命令成功后让它失效 */
+export const userKeys = { all: ['user'] as const, one: (id: string) => ['user', id] as const };

package/templates/blank/packages/contracts/src/index.ts

@@ -0,0 +1,55 @@
+// 生成物：由 cage gen 从 domain 声明生成，不要手改。
+/* eslint-disable */
+
+export * from './aggregates/dept';
+export * from './aggregates/role';
+export * from './aggregates/user';
+export * from './queries';
+import { can as baseCan, useCan as baseUseCan } from '@yss123/cage-client';
+import { DeptInputs } from './aggregates/dept';
+import { RoleInputs } from './aggregates/role';
+import { UserInputs } from './aggregates/user';
+export { client, configureClient, loadMe, currentUser, CageQueryError, useTransfer, type CageResult, type CommonError, type TransferTask, type ImportReport } from '@yss123/cage-client';
+
+/** 能力目录（由代码派生）：写错能力点名会编译失败 */
+export const capabilities = [
+  'Dept.archive',
+  'Dept.create',
+  'Dept.export',
+  'Dept.read',
+  'Dept.update',
+  'Role.archive',
+  'Role.create',
+  'Role.export',
+  'Role.grantCapability',
+  'Role.read',
+  'Role.rename',
+  'Role.revokeCapability',
+  'Role.setScope',
+  'Sys.audit.read',
+  'Sys.ops.manage',
+  'Sys.ops.read',
+  'User.assignRoles',
+  'User.create',
+  'User.disable',
+  'User.enable',
+  'User.export',
+  'User.read',
+  'User.setPassword',
+  'User.unmask.email',
+  'User.unmask.name',
+  'User.unmask.phone',
+  'User.update',
+] as const;
+export type Capability = (typeof capabilities)[number];
+
+/** 当前用户有没有某个能力点。只影响界面显示：绕过前端直接调接口，内核一样会拒绝 */
+export const can = (capability: Capability): boolean => baseCan(capability);
+export const useCan = (capability: Capability): boolean => baseUseCan(capability);
+
+/** 各聚合的命令输入 schema：按聚合名、命令名访问，可直接供表单库校验 */
+export const schemas = {
+  Dept: DeptInputs,
+  Role: RoleInputs,
+  User: UserInputs,
+};

package/templates/blank/packages/contracts/src/queries/index.ts

@@ -0,0 +1,13 @@
+// 生成物：由 cage gen 从 domain 声明生成，不要手改。
+/* eslint-disable */
+
+import { z } from 'zod';
+import { client, useCageQuery } from '@yss123/cage-client';
+
+/** 查询输入 */
+export const QueryInputs = {
+};
+
+export const queries = {
+};
+

package/templates/blank/packages/contracts/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": { "module": "ESNext", "moduleResolution": "Bundler", "outDir": "dist", "rootDir": "src" },
+  "include": ["src"]
+}

package/templates/blank/packages/domain/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@app/domain",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "development": "./src/index.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@yss123/cage-kernel": "0.2.0",
+    "@yss123/cage-admin": "0.2.0",
+    "@yss123/cage-approval": "0.2.0",
+    "@yss123/cage-connectors": "0.2.0",
+    "zod": "^4.1.5"
+  }
+}

package/templates/blank/packages/domain/src/index.ts

@@ -0,0 +1,4 @@
+// CLI、API 与 worker 共用这个领域入口。空白项目只注册组织基础模型，
+// 不注册采购示例；新增业务写在同目录的 .ts 文件，再从这里统一导出。
+// 完整采购代码保存在 docs/examples/purchase-admin，仅作离线参考。
+export * from '@yss123/cage-admin/domain';

package/templates/blank/packages/domain/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": { "outDir": "dist", "rootDir": "src" },
+  "include": ["src"], "exclude": ["src/**/*.test.ts"]
+}

package/templates/blank/pnpm-workspace.yaml

@@ -0,0 +1,10 @@
+packages:
+  - apps/*
+  - packages/*
+onlyBuiltDependencies:
+  - esbuild
+  - embedded-postgres
+  - '@embedded-postgres/windows-x64'
+  - '@embedded-postgres/linux-x64'
+  - '@embedded-postgres/darwin-arm64'
+  - '@embedded-postgres/darwin-x64'

package/templates/blank/renovate.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended"],
+  "packageRules": [{ "matchPackageNames": ["@yss123/cage-**"], "groupName": "cage" }]
+}

package/templates/blank/tsconfig.base.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "ES2023", "lib": ["ES2023", "DOM"],
+    "module": "NodeNext", "moduleResolution": "NodeNext", "strict": true,
+    "esModuleInterop": true, "skipLibCheck": true, "declaration": true,
+    "sourceMap": true, "resolveJsonModule": true, "isolatedModules": true
+  }
+}