@yss123/cage-cli 0.1.0 → 0.2.0

package/templates/blank/docs/errors/CAGE-DEP-002.md

@@ -0,0 +1,47 @@
+# CAGE-DEP-002：适配器绕过命令写库
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：静态检查 / verify。
+
+packages/adapters 依赖数据库访问包并可能直接写业务表。
+
+## 修复步骤
+
+1. 将适配器输出映射为领域命令输入，通过命令网关落实状态、审计和权限。
+
+## 正例
+
+```text
+验签后调用 external 命令
+```
+
+## 反例
+
+```text
+适配器直接 update core.purchase_order
+```
+
+## 修复后验证
+
+重跑 cage check 和 verify，确认边界修复而不是禁用规则。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/lint/dependency-cruiser.cjs:17`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+      severity: 'error',
+      comment: '[CAGE-DEP-002] 适配器必须通过命令网关写数据',
+      from: { path: '^packages/adapters' },
+      to: { path: 'node_modules/(pg|kysely)/' },
+    },
+```

package/templates/blank/docs/errors/CAGE-DEP-003.md

@@ -0,0 +1,47 @@
+# CAGE-DEP-003：前端依赖服务端实现
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：静态检查 / verify。
+
+apps/web 导入 domain 或 kernel/http/admin/connectors/approval/testkit 等服务端包。
+
+## 修复步骤
+
+1. 前端使用 @app/contracts 与 @yss123/cage-client；共享快照类型通过生成契约取得。
+
+## 正例
+
+```text
+import { purchaseOrder } from '@app/contracts'
+```
+
+## 反例
+
+```text
+import { approve } from '@app/domain'
+```
+
+## 修复后验证
+
+重跑 cage check 和 verify，确认边界修复而不是禁用规则。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/lint/dependency-cruiser.cjs:24`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+      severity: 'error',
+      comment: '[CAGE-DEP-003] 前端只能依赖 @app/contracts',
+      from: { path: '^apps/web' },
+      to: { path: '^packages/domain|node_modules/@yss123/cage-(kernel|http|admin|connectors|approval|testkit)/' },
+    },
+```

package/templates/blank/docs/errors/CAGE-DEP-004.md

@@ -0,0 +1,47 @@
+# CAGE-DEP-004：声明或 handler 直接发请求/动态导入
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：静态检查 / verify。
+
+静态检查发现 domain 调用 fetch 或动态 import。
+
+## 修复步骤
+
+1. 把外部 IO 声明成连接器，把声明改为静态导出，避免在运行时动态生成业务规格。
+
+## 正例
+
+```text
+event → outbound → onSuccess.command
+```
+
+## 反例
+
+```text
+handler 里 await fetch(...) 或动态 import 数据库模块
+```
+
+## 修复后验证
+
+重跑 cage check 和 verify，确认边界修复而不是禁用规则。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/cli/src/static-check.ts:155`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+          findings.push({
+            code: 'CAGE-DEP-004',
+            at: loc(node),
+            reason: name === 'fetch' ? 'handler 里直接发网络请求' : '声明文件里使用了动态 import',
+            fix: '第三方调用改为连接器声明 + outbound 出站映射',
+```

package/templates/blank/docs/errors/CAGE-DEP-005.md

@@ -0,0 +1,47 @@
+# CAGE-DEP-005：domain 反向依赖生成物
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：静态检查 / verify。
+
+domain 引用 generated 或 packages/contracts，形成生成循环。
+
+## 修复步骤
+
+1. 领域源码是生成源头；前端/适配层使用 contracts，domain 使用本地领域类型和公开声明 API。
+
+## 正例
+
+```text
+domain 从 './purchase-order.js' 读领域符号
+```
+
+## 反例
+
+```text
+domain 从 '@app/contracts' 导入自己生成的快照
+```
+
+## 修复后验证
+
+重跑 cage check 和 verify，确认边界修复而不是禁用规则。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/lint/dependency-cruiser.cjs:31`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+      severity: 'error',
+      comment: '[CAGE-DEP-005] domain 不能依赖生成物',
+      from: { path: '^packages/domain' },
+      to: { path: '^(generated|packages/contracts)/' },
+    },
+```

package/templates/blank/docs/errors/CAGE-DLQ-001.md

@@ -0,0 +1,48 @@
+# CAGE-DLQ-001：死信不存在或已经处理
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：系统管理接口。
+
+重放/丢弃时目标死信已被处理或不在待处理集合。
+
+## 修复步骤
+
+1. 刷新死信列表，核对 outboxId 和审计记录；确认是否已由其他人处理，不直接重建/修改系统行。
+
+## 正例
+
+```text
+查看当前状态后只处理待处理的死信
+```
+
+## 反例
+
+```text
+反复提交旧页面上的重放请求或手改 sys.outbox
+```
+
+## 修复后验证
+
+刷新死信列表并查看审计及当前处理结果；核对原始 outboxId。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/kernel/src/worker/outbox.ts:128`
+- `packages/kernel/src/worker/outbox.ts:139`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+    const d = await tx.selectFrom('sys.dead_letter').selectAll().where('id', '=', deadLetterId).where('handled_at', 'is', null).forUpdate().executeTakeFirst();
+    if (!d) throw new Error('[CAGE-DLQ-001] 死信不存在或已处理');
+    await tx.updateTable('sys.outbox').set({ status: 'pending', attempts: 0, next_at: sql`now()`, last_error: null }).where('id', '=', d.outbox_id).execute();
+    await tx.updateTable('sys.dead_letter').set({ handled_by: handledBy, handled_at: sql`now()`, resolution: 'replayed' }).where('id', '=', deadLetterId).execute();
+    await sql`select pg_notify('cage_outbox', '')`.execute(tx);
+```

package/templates/blank/docs/errors/CAGE-ENV-001.md

@@ -0,0 +1,52 @@
+# CAGE-ENV-001：缺少数据库连接配置
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：init / migrate / 启动。
+
+API、worker、迁移或初始化没有取得所需的数据库连接。
+
+## 修复步骤
+
+1. 在应用根目录 .env 配置 CAGE_ADMIN_DATABASE_URL，指向已存在的数据库，运行 pnpm exec cage init 自动生成三种账号连接。
+2. 已有账号则直接提供 APP/READ/MIGRATE URL；主机、端口、库名一致，账号各司其职。migrate 需要迁移连接。
+3. 确认运行目录、部署环境覆盖值及服务已重启；不要输出凭证，也不要给日常服务改用管理员连接。
+
+## 正例
+
+```text
+配置已有库 → cage init → gen → 审查后 migrate → dev
+```
+
+## 反例
+
+```text
+未配置连接就启动，或新增自动临时数据库兜底掩盖错误
+```
+
+## 修复后验证
+
+重跑原先失败的命令，确认使用预期库与账号；输出脱敏信息。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/cli/src/init.ts:74`
+- `packages/cli/src/migrate.ts:22`
+- `packages/kernel/src/db/connect.ts:74`
+- `packages/kernel/src/kernel.ts:100`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+  if (!configured(adminUrl)) {
+    if (!hasSaved) throw new Error('[CAGE-ENV-001] 首次初始化请在项目 .env 填写 CAGE_ADMIN_DATABASE_URL，连接已有数据库后运行 pnpm exec cage init');
+    await verifyConnections(saved);
+    return { status: 'reused', envFile };
+  }
+```

package/templates/blank/docs/errors/CAGE-EVENT-001.md

@@ -0,0 +1,47 @@
+# CAGE-EVENT-001：事件载荷不满足声明
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：写事务 / 基线比较。
+
+命令要写入 outbox 的载荷没有通过事件字段 schema。
+
+## 修复步骤
+
+1. 核对默认载荷映射及字段类型；需要旧状态、改名字段或复杂数据时使用 emit 显式映射。事务失败应回滚，不单独补写消息。
+
+## 正例
+
+```text
+emit(OrderCancelled, (o, _i, prev) => ({ orderId: o.id, previousStatus: prev.status }))
+```
+
+## 反例
+
+```text
+事件要求 orderId，却从错误字段映射成 undefined
+```
+
+## 修复后验证
+
+运行相关命令与消费者测试；兼容性使用修改前基线检查，考虑尚未消费的旧事件。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/kernel/src/kernel.ts:380`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+      if (!p.success) {
+        throw new Error(`[CAGE-EVENT-001] 事件 ${ev.name} 的载荷不符合声明：${JSON.stringify(zodIssues(p.error))}`);
+      }
+      const payload = maskEventPayload(ev, p.data as Record<string, unknown>);
+      const row = await tx
+```

package/templates/blank/docs/errors/CAGE-EVENT-002.md

@@ -0,0 +1,50 @@
+# CAGE-EVENT-002：事件变更不向后兼容
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：写事务 / 基线比较。
+
+与基线相比，删除旧载荷字段、改变字段 kind，或新增必填字段。
+
+## 修复步骤
+
+1. 保留旧字段和类型，新字段 optional；不兼容含义新建事件，并考虑旧 outbox 消息和消费者升级顺序。
+
+## 正例
+
+```text
+note: text().optional() // 新增字段
+```
+
+## 反例
+
+```text
+给线上已有事件新增必填 note，旧消息没有该值
+```
+
+## 修复后验证
+
+运行相关命令与消费者测试；兼容性使用修改前基线检查，考虑尚未消费的旧事件。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/cli/src/rules.ts:225`
+- `packages/cli/src/rules.ts:237`
+- `packages/cli/src/rules.ts:244`
+- `packages/cli/src/rules.ts:254`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+
+/** CAGE-EVENT-002：事件载荷只允许向后兼容的变更（只能新增可选字段） */
+export function checkEventCompat(base: Ontology, head: Ontology): Finding[] {
+  const findings: Finding[] = [];
+  const b = new Map(base.nodes.filter((n) => n.kind === 'event').map((n) => [n.id, n]));
+```

package/templates/blank/docs/errors/CAGE-FIELD-001.md

@@ -0,0 +1,47 @@
+# CAGE-FIELD-001：敏感字段种类不存在
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：声明加载。
+
+sensitive 使用了 SENSITIVE_KINDS 之外的值。
+
+## 修复步骤
+
+1. 选用当前包导出的敏感种类；确需新掩码规则时评估框架扩展，不以 any 绕过声明。
+
+## 正例
+
+```text
+supplierPhone: text(32).sensitive('phone')
+```
+
+## 反例
+
+```text
+text().sensitive('自定义随意字符串')
+```
+
+## 修复后验证
+
+重跑 cage check/gen，审查契约与迁移；敏感字段还要验证普通用户读结果。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/kernel/src/primitives/fields.ts:100`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+    if (isRelation(this)) throw declError('CAGE-REL-001', '关系字段不支持 sensitive；目标字段按目标聚合权限掩码');
+    if (!SENSITIVE_KINDS.includes(kind)) throw declError('CAGE-FIELD-001', `未知的敏感种类 ${kind}`);
+    return this.with({ sensitiveKind: kind });
+  }
+  /** 唯一约束（租户内） */
+```

package/templates/blank/docs/errors/CAGE-FIELD-002.md

@@ -0,0 +1,47 @@
+# CAGE-FIELD-002：引用目标为空
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：声明加载。
+
+ref 收到空目标，常见原因是循环导入。
+
+## 修复步骤
+
+1. 使用 ref("聚合名") 避免循环求值，确保对应聚合从入口导出且名称正确。
+
+## 正例
+
+```text
+deptId: ref('Dept')
+```
+
+## 反例
+
+```text
+deptId: ref(undefined)
+```
+
+## 修复后验证
+
+重跑 cage check/gen，审查契约与迁移；敏感字段还要验证普通用户读结果。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/kernel/src/primitives/fields.ts:160`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+  const target = typeof to === 'string' ? to : to?.name;
+  if (!target) throw declError('CAGE-FIELD-002', 'ref() 的目标为空，可能是循环导入；可改为 ref("聚合名")');
+  return mk(z.string().uuid(), { kind: 'ref', sql: 'uuid', ref: target });
+}
+
+```

package/templates/blank/docs/errors/CAGE-FIELD-003.md

@@ -0,0 +1,47 @@
+# CAGE-FIELD-003：字段不是字段原语
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：声明加载。
+
+aggregate.fields 中存在不是 field/states 描述对象的值。
+
+## 修复步骤
+
+1. 使用 text/int/money/ref/list 等公开字段工厂；Zod 用在命令输入或 json schema，不能直接代替 fields 的字段描述。
+
+## 正例
+
+```text
+fields: { amount: money() }
+```
+
+## 反例
+
+```text
+fields: { amount: z.string() }
+```
+
+## 修复后验证
+
+重跑 cage check/gen，审查契约与迁移；敏感字段还要验证普通用户读结果。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/kernel/src/primitives/aggregate.ts:83`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+    }
+    if (!isField(v)) throw declError('CAGE-FIELD-003', `${name}.${k} 不是字段原语`);
+    if ((RESERVED_FIELDS as readonly string[]).includes(k)) {
+      throw declError('CAGE-FIELD-004', `${name}.${k} 是保留字段名，由内核维护`);
+    }
+```

package/templates/blank/docs/errors/CAGE-FIELD-004.md

@@ -0,0 +1,47 @@
+# CAGE-FIELD-004：覆盖系统保留列
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：声明加载。
+
+业务 fields 定义了 id/version/status/createdAt/updatedAt/tenantId 等保留字段。
+
+## 修复步骤
+
+1. 移除重复系统字段；状态使用 aggregate.states 或唯一 fields.status 状态声明；业务另取有意义名称。
+
+## 正例
+
+```text
+fields: { externalId: text() }, states: POStatus
+```
+
+## 反例
+
+```text
+fields: { version: text() }
+```
+
+## 修复后验证
+
+重跑 cage check/gen，审查契约与迁移；敏感字段还要验证普通用户读结果。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/kernel/src/primitives/aggregate.ts:85`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+    if ((RESERVED_FIELDS as readonly string[]).includes(k)) {
+      throw declError('CAGE-FIELD-004', `${name}.${k} 是保留字段名，由内核维护`);
+    }
+    if (!/^[a-z][A-Za-z0-9]*$/.test(k)) throw declError('CAGE-NAME-002', `字段名 ${name}.${k} 必须是小驼峰`);
+    fields[k] = v;
+```

package/templates/blank/docs/errors/CAGE-GEN-001.md

@@ -0,0 +1,48 @@
+# CAGE-GEN-001：契约等生成结果过期
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：gen --check / verify。
+
+gen --check/verify 比较发现需提交的生成文件缺失或与声明不一致。
+
+## 修复步骤
+
+1. 改源声明后运行 pnpm gen，审查并提交结果；手改生成物会被覆盖，不靠更新预期掩盖错误。
+
+## 正例
+
+```text
+修改 domain → pnpm gen → pnpm exec cage gen --check
+```
+
+## 反例
+
+```text
+直接编辑 packages/contracts/src/aggregates/purchase-order/index.ts
+```
+
+## 修复后验证
+
+重新生成并审查后执行 cage gen --check；结构变化还需审查并执行 migrate。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/cli/src/gen/index.ts:48`
+- `packages/cli/src/gen/index.ts:90`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+  findings: Finding[],
+  code = 'CAGE-GEN-001',
+) {
+  const cur = existsSync(path) ? readFileSync(path, 'utf8') : null;
+  if (cur === content) return;
+```

package/templates/blank/docs/errors/CAGE-GEN-002.md

@@ -0,0 +1,47 @@
+# CAGE-GEN-002：声明结构没有对应迁移
+
+[返回错误码册](README.md) · [业务排错](../ai/troubleshooting.md)
+
+> 本页由框架生成。正反例为局部声明或操作说明，完整写法见业务开发指南及本项目 domain。
+
+## 何时出现
+
+阶段：gen --check / verify。
+
+声明的期望结构与最后一个迁移内嵌的结构快照不一致。
+
+## 修复步骤
+
+1. 运行 pnpm gen 生成新迁移草稿，审查回填、非空与破坏性变更后提交；实际落库还需 pnpm migrate。
+
+## 正例
+
+```text
+新增字段 → gen → 审查新迁移 → migrate
+```
+
+## 反例
+
+```text
+修改已执行 0001_init.sql，或把 gen 当作已更新数据库
+```
+
+## 修复后验证
+
+重新生成并审查后执行 cage gen --check；结构变化还需审查并执行 migrate。
+
+## 框架内的检查位置
+
+以下路径相对框架源码仓库，不是要求业务项目创建这些文件。当前项目先修业务声明、配置或授权；明确属于框架缺口时反馈错误码和脱敏上下文。
+
+- `packages/cli/src/gen/index.ts:162`
+
+实现片段（位置随框架版本更新）：
+
+```ts
+      findings.push({
+        code: 'CAGE-GEN-002',
+        at: cfg.migrations,
+        reason: `声明的表结构与迁移不一致（${stmts.length} 处变化）`,
+        fix: '运行 cage gen 生成迁移草稿，人审后提交',
+```