@yss123/cage-cli 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/dist/analyze.js +3 -0
- package/dist/analyze.js.map +1 -1
- package/dist/capabilities.js +50 -40
- package/dist/capabilities.js.map +1 -1
- package/dist/config.d.ts +4 -0
- package/dist/config.js.map +1 -1
- package/dist/context.js +2 -2
- package/dist/context.js.map +1 -1
- package/dist/doctor.js +1 -1
- package/dist/doctor.js.map +1 -1
- package/dist/findings.d.ts +1 -1
- package/dist/findings.js +2 -2
- package/dist/findings.js.map +1 -1
- package/dist/graph-business.d.ts +11 -8
- package/dist/graph-business.js +16 -16
- package/dist/graph-business.js.map +1 -1
- package/dist/graph-relations.js +3 -5
- package/dist/graph-relations.js.map +1 -1
- package/dist/impact.js +1 -4
- package/dist/impact.js.map +1 -1
- package/dist/main.js +1 -1
- package/dist/main.js.map +1 -1
- package/dist/ontology-names.d.ts +17 -0
- package/dist/ontology-names.js +42 -0
- package/dist/ontology-names.js.map +1 -0
- package/dist/project-structure.js +2 -2
- package/dist/project-structure.js.map +1 -1
- package/dist/sync.d.ts +5 -1
- package/dist/sync.js +45 -121
- package/dist/sync.js.map +1 -1
- package/graph-ui/app.js +3 -2
- package/graph-ui/business.js +11 -3
- package/graph-ui/graph-business.js +16 -16
- package/graph-ui/graph-relations.js +3 -5
- package/package.json +6 -6
- package/templates/app/.agents/skills/cage-development/SKILL.md +10 -0
- package/templates/app/AGENTS.md +42 -122
- package/templates/app/CLAUDE.md +6 -0
- package/templates/app/README.md +6 -6
- package/templates/app/apps/api/package.json +2 -2
- package/templates/app/apps/web/package.json +3 -1
- package/templates/app/apps/web/src/app/styles/global.css +12 -11
- package/templates/app/apps/web/src/main.tsx +18 -7
- package/templates/app/apps/web/src/shared/lib/error-message.ts +1 -1
- package/templates/app/apps/web/src/shared/ui/approval-member-picker.tsx +1 -1
- package/templates/app/cage.config.json +2 -1
- package/templates/app/docs/README.md +13 -0
- package/templates/app/docs/development/README.md +80 -0
- package/templates/app/docs/development/examples/note/note-detail-page.tsx +106 -0
- package/templates/app/docs/development/examples/note/note.ts +71 -0
- package/templates/app/docs/development/examples/note/notes-page.tsx +87 -0
- package/templates/{blank/docs/ai → app/docs/development/examples}/purchase-example.md +10 -10
- package/templates/{blank/docs/ai → app/docs/development/getting-started}/architecture.md +9 -9
- package/templates/app/docs/development/getting-started/first-feature.md +66 -0
- package/templates/{blank/docs/ai → app/docs/development/getting-started}/workflow.md +22 -27
- package/templates/app/docs/{ai → development/guides}/approvals.md +19 -9
- package/templates/app/docs/development/guides/business-collaboration.md +65 -0
- package/templates/{blank/docs/ai → app/docs/development/guides}/files.md +5 -1
- package/templates/app/docs/development/guides/frontend-ui.md +30 -0
- package/templates/app/docs/{ai → development/guides}/intelligence.md +18 -16
- package/templates/app/docs/development/guides/ontology-modeling.md +83 -0
- package/templates/app/docs/development/guides/recipes.md +123 -0
- package/templates/app/docs/{ai → development/guides}/relations.md +33 -10
- package/templates/{blank/docs/ai → app/docs/development/guides}/routing.md +1 -1
- package/templates/app/docs/{ai → development/guides}/transfers.md +1 -1
- package/templates/{blank/docs/ai → app/docs/development/reference}/commenting.md +8 -5
- package/templates/app/docs/{ai → development/reference}/primitives.md +12 -64
- package/templates/app/docs/{ai → development/reference}/project-structure.md +2 -2
- package/templates/app/docs/development/skills/cage-development/SKILL.md +144 -0
- package/templates/{blank/docs/ai → app/docs/development/tools}/diagnostics.md +7 -4
- package/templates/{blank/docs/ai → app/docs/development/tools}/ontology-context.md +4 -4
- package/templates/app/docs/{ai → development/tools}/troubleshooting.md +10 -4
- package/templates/app/docs/errors/CAGE-AI-001.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-001.md +2 -2
- package/templates/app/docs/errors/CAGE-APPR-002.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-003.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-004.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-005.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-006.md +1 -1
- package/templates/app/docs/errors/CAGE-APPR-007.md +2 -2
- package/templates/app/docs/errors/CAGE-APPR-010.md +1 -1
- package/templates/app/docs/errors/CAGE-AUDIT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-AUTH-001.md +1 -1
- package/templates/app/docs/errors/CAGE-BIZ-001.md +1 -1
- package/templates/app/docs/errors/CAGE-BIZ-002.md +1 -1
- package/templates/app/docs/errors/CAGE-BUDGET-001.md +1 -1
- package/templates/app/docs/errors/CAGE-BUDGET-002.md +1 -1
- package/templates/app/docs/errors/CAGE-BUDGET-003.md +1 -1
- package/templates/app/docs/errors/CAGE-CMD-002.md +1 -1
- package/templates/app/docs/errors/CAGE-CMD-003.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-001.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-002.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-003.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-004.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-005.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-006.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-007.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-008.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-009.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-010.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-011.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-012.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-013.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-014.md +1 -1
- package/templates/app/docs/errors/CAGE-CONN-015.md +1 -1
- package/templates/app/docs/errors/CAGE-CREATE-001.md +2 -2
- package/templates/app/docs/errors/CAGE-DECL-001.md +1 -1
- package/templates/app/docs/errors/CAGE-DECL-002.md +1 -1
- package/templates/app/docs/errors/CAGE-DECL-003.md +1 -1
- package/templates/app/docs/errors/CAGE-DECL-004.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-001.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-002.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-003.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-004.md +1 -1
- package/templates/app/docs/errors/CAGE-DEP-005.md +1 -1
- package/templates/app/docs/errors/CAGE-DIAG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-DLQ-001.md +1 -1
- package/templates/app/docs/errors/CAGE-ENV-001.md +1 -1
- package/templates/app/docs/errors/CAGE-ENV-002.md +1 -1
- package/templates/app/docs/errors/CAGE-ENV-003.md +1 -1
- package/templates/app/docs/errors/CAGE-EVENT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-EVENT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-001.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-002.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-003.md +1 -1
- package/templates/app/docs/errors/CAGE-FIELD-004.md +1 -1
- package/templates/app/docs/errors/CAGE-FILE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-GEN-001.md +1 -1
- package/templates/app/docs/errors/CAGE-GEN-002.md +1 -1
- package/templates/app/docs/errors/CAGE-GEN-003.md +1 -1
- package/templates/app/docs/errors/CAGE-GRANT-001.md +19 -13
- package/templates/app/docs/errors/CAGE-GRANT-002.md +3 -3
- package/templates/app/docs/errors/CAGE-GRANT-003.md +4 -4
- package/templates/app/docs/errors/CAGE-IMPACT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-IMPACT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-003.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-004.md +1 -1
- package/templates/app/docs/errors/CAGE-INIT-005.md +1 -1
- package/templates/app/docs/errors/CAGE-JOB-001.md +1 -1
- package/templates/app/docs/errors/CAGE-JOB-002.md +1 -1
- package/templates/app/docs/errors/CAGE-JOB-003.md +1 -1
- package/templates/app/docs/errors/CAGE-LINT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-MIG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-MIG-002.md +1 -1
- package/templates/app/docs/errors/CAGE-MIG-005.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-001.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-002.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-003.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-004.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-005.md +1 -1
- package/templates/app/docs/errors/CAGE-NAME-006.md +1 -1
- package/templates/app/docs/errors/CAGE-ONTOLOGY-001.md +52 -0
- package/templates/app/docs/errors/CAGE-ORG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-PAIR-002.md +1 -1
- package/templates/app/docs/errors/CAGE-QUERY-001.md +1 -1
- package/templates/app/docs/errors/CAGE-QUERY-002.md +1 -1
- package/templates/app/docs/errors/CAGE-QUERY-003.md +1 -1
- package/templates/app/docs/errors/CAGE-REACT-001.md +1 -1
- package/templates/app/docs/errors/CAGE-REACT-002.md +1 -1
- package/templates/app/docs/errors/CAGE-REACT-003.md +1 -1
- package/templates/app/docs/errors/CAGE-READS-001.md +1 -1
- package/templates/app/docs/errors/CAGE-REG-001.md +1 -1
- package/templates/app/docs/errors/CAGE-REG-002.md +1 -1
- package/templates/app/docs/errors/CAGE-REG-003.md +1 -1
- package/templates/app/docs/errors/CAGE-REL-001.md +1 -1
- package/templates/app/docs/errors/CAGE-ROUTE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SCOPE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SCOPE-002.md +1 -1
- package/templates/app/docs/errors/CAGE-SECRET-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SECRET-002.md +1 -1
- package/templates/app/docs/errors/CAGE-SENS-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SQL-001.md +1 -1
- package/templates/app/docs/errors/CAGE-SQL-002.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-002.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-003.md +2 -2
- package/templates/app/docs/errors/CAGE-STATE-004.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-005.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-010.md +1 -1
- package/templates/app/docs/errors/CAGE-STATE-011.md +1 -1
- package/templates/app/docs/errors/CAGE-STRUCT-001.md +4 -4
- package/templates/app/docs/errors/CAGE-STRUCT-002.md +3 -3
- package/templates/app/docs/errors/CAGE-SYNC-001.md +4 -4
- package/templates/app/docs/errors/CAGE-TEST-001.md +1 -1
- package/templates/app/docs/errors/CAGE-TEST-002.md +1 -1
- package/templates/app/docs/errors/CAGE-TEST-003.md +1 -1
- package/templates/app/docs/errors/CAGE-UNSAFE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-UPGRADE-001.md +1 -1
- package/templates/app/docs/errors/CAGE-WORKER-001.md +1 -1
- package/templates/app/docs/errors/CAGE-WORKER-002.md +1 -1
- package/templates/app/docs/errors/CAGE-WORKER-003.md +1 -1
- package/templates/app/docs/errors/README.md +8 -2
- package/templates/app/docs/errors/runtime.md +2 -2
- package/templates/app/package.json +3 -3
- package/templates/app/packages/contracts/package.json +1 -1
- package/templates/app/packages/contracts/src/aggregates/role/index.ts +2 -2
- package/templates/app/packages/contracts/src/aggregates/user/index.ts +3 -3
- package/templates/app/packages/domain/package.json +5 -5
- package/templates/app/packages/domain/src/modules/purchase/approval-members.ts +1 -1
- package/templates/app/packages/domain/src/modules/purchase/approvals.ts +2 -2
- package/templates/app/packages/domain/src/modules/purchase/intelligence.test.ts +4 -4
- package/templates/app/packages/domain/src/modules/purchase/purchase-order.test.ts +10 -17
- package/templates/app/packages/domain/src/modules/purchase/purchase-order.ts +4 -5
- package/templates/app/packages/domain/src/workflows/purchase-process.ts +1 -1
- package/templates/blank/.agents/skills/cage-development/SKILL.md +10 -0
- package/templates/blank/AGENTS.md +42 -122
- package/templates/blank/CLAUDE.md +6 -0
- package/templates/blank/README.md +3 -3
- package/templates/blank/apps/api/package.json +1 -1
- package/templates/blank/apps/web/package.json +3 -1
- package/templates/blank/apps/web/src/app/styles/global.css +6 -5
- package/templates/blank/apps/web/src/main.tsx +18 -7
- package/templates/blank/cage.config.json +1 -0
- package/templates/blank/docs/README.md +13 -0
- package/templates/blank/docs/development/README.md +80 -0
- package/templates/blank/docs/development/examples/note/note-detail-page.tsx +106 -0
- package/templates/blank/docs/development/examples/note/note.ts +71 -0
- package/templates/blank/docs/development/examples/note/notes-page.tsx +87 -0
- package/templates/{app/docs/ai → blank/docs/development/examples}/purchase-example.md +10 -10
- package/templates/{app/docs/ai → blank/docs/development/getting-started}/architecture.md +9 -9
- package/templates/blank/docs/development/getting-started/first-feature.md +66 -0
- package/templates/{app/docs/ai → blank/docs/development/getting-started}/workflow.md +22 -27
- package/templates/blank/docs/{ai → development/guides}/approvals.md +19 -9
- package/templates/blank/docs/development/guides/business-collaboration.md +65 -0
- package/templates/{app/docs/ai → blank/docs/development/guides}/files.md +5 -1
- package/templates/blank/docs/development/guides/frontend-ui.md +30 -0
- package/templates/blank/docs/{ai → development/guides}/intelligence.md +18 -16
- package/templates/blank/docs/development/guides/ontology-modeling.md +83 -0
- package/templates/blank/docs/development/guides/recipes.md +123 -0
- package/templates/blank/docs/{ai → development/guides}/relations.md +33 -10
- package/templates/{app/docs/ai → blank/docs/development/guides}/routing.md +1 -1
- package/templates/blank/docs/{ai → development/guides}/transfers.md +1 -1
- package/templates/{app/docs/ai → blank/docs/development/reference}/commenting.md +8 -5
- package/templates/blank/docs/{ai → development/reference}/primitives.md +12 -64
- package/templates/blank/docs/{ai → development/reference}/project-structure.md +2 -2
- package/templates/blank/docs/development/skills/cage-development/SKILL.md +144 -0
- package/templates/{app/docs/ai → blank/docs/development/tools}/diagnostics.md +7 -4
- package/templates/{app/docs/ai → blank/docs/development/tools}/ontology-context.md +4 -4
- package/templates/blank/docs/{ai → development/tools}/troubleshooting.md +10 -4
- package/templates/blank/docs/errors/CAGE-AI-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-001.md +2 -2
- package/templates/blank/docs/errors/CAGE-APPR-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-006.md +1 -1
- package/templates/blank/docs/errors/CAGE-APPR-007.md +2 -2
- package/templates/blank/docs/errors/CAGE-APPR-010.md +1 -1
- package/templates/blank/docs/errors/CAGE-AUDIT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-AUTH-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-BIZ-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-BIZ-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-BUDGET-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-BUDGET-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-BUDGET-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-CMD-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-CMD-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-006.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-007.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-008.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-009.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-010.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-011.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-012.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-013.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-014.md +1 -1
- package/templates/blank/docs/errors/CAGE-CONN-015.md +1 -1
- package/templates/blank/docs/errors/CAGE-CREATE-001.md +2 -2
- package/templates/blank/docs/errors/CAGE-DECL-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-DECL-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-DECL-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-DECL-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-DEP-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-DIAG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-DLQ-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-ENV-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-ENV-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-ENV-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-EVENT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-EVENT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-FIELD-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-FILE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-GEN-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-GEN-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-GEN-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-GRANT-001.md +19 -13
- package/templates/blank/docs/errors/CAGE-GRANT-002.md +3 -3
- package/templates/blank/docs/errors/CAGE-GRANT-003.md +4 -4
- package/templates/blank/docs/errors/CAGE-IMPACT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-IMPACT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-INIT-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-JOB-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-JOB-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-JOB-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-LINT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-MIG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-MIG-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-MIG-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-NAME-006.md +1 -1
- package/templates/blank/docs/errors/CAGE-ONTOLOGY-001.md +52 -0
- package/templates/blank/docs/errors/CAGE-ORG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-PAIR-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-QUERY-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-QUERY-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-QUERY-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-REACT-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-REACT-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-REACT-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-READS-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-REG-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-REG-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-REG-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-REL-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-ROUTE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SCOPE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SCOPE-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-SECRET-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SECRET-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-SENS-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SQL-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-SQL-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-003.md +2 -2
- package/templates/blank/docs/errors/CAGE-STATE-004.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-005.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-010.md +1 -1
- package/templates/blank/docs/errors/CAGE-STATE-011.md +1 -1
- package/templates/blank/docs/errors/CAGE-STRUCT-001.md +4 -4
- package/templates/blank/docs/errors/CAGE-STRUCT-002.md +3 -3
- package/templates/blank/docs/errors/CAGE-SYNC-001.md +4 -4
- package/templates/blank/docs/errors/CAGE-TEST-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-TEST-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-TEST-003.md +1 -1
- package/templates/blank/docs/errors/CAGE-UNSAFE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-UPGRADE-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-WORKER-001.md +1 -1
- package/templates/blank/docs/errors/CAGE-WORKER-002.md +1 -1
- package/templates/blank/docs/errors/CAGE-WORKER-003.md +1 -1
- package/templates/blank/docs/errors/README.md +8 -2
- package/templates/blank/docs/errors/runtime.md +2 -2
- package/templates/blank/docs/examples/purchase-admin/README.md +1 -1
- package/templates/blank/docs/examples/purchase-admin/apps/web/src/app/styles/global.css +12 -11
- package/templates/blank/docs/examples/purchase-admin/apps/web/src/main.tsx +18 -7
- package/templates/blank/docs/examples/purchase-admin/apps/web/src/shared/lib/error-message.ts +1 -1
- package/templates/blank/docs/examples/purchase-admin/apps/web/src/shared/ui/approval-member-picker.tsx +1 -1
- package/templates/blank/docs/examples/purchase-admin/cage.config.json +2 -1
- package/templates/blank/docs/examples/purchase-admin/packages/contracts/src/aggregates/role/index.ts +2 -2
- package/templates/blank/docs/examples/purchase-admin/packages/contracts/src/aggregates/user/index.ts +3 -3
- package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/approval-members.ts +1 -1
- package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/approvals.ts +2 -2
- package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/intelligence.test.ts +4 -4
- package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/purchase-order.test.ts +10 -17
- package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/purchase-order.ts +4 -5
- package/templates/blank/docs/examples/purchase-admin/packages/domain/src/workflows/purchase-process.ts +1 -1
- package/templates/blank/package.json +3 -3
- package/templates/blank/packages/contracts/package.json +1 -1
- package/templates/blank/packages/contracts/src/aggregates/role/index.ts +2 -2
- package/templates/blank/packages/contracts/src/aggregates/user/index.ts +3 -3
- package/templates/blank/packages/domain/package.json +5 -5
- package/templates/app/docs/ai/README.md +0 -103
- package/templates/app/docs/ai/recipes.md +0 -89
- package/templates/blank/docs/ai/README.md +0 -103
- package/templates/blank/docs/ai/recipes.md +0 -89
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 业务对象之间的关系
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [最小业务](primitives.md) · [开发步骤](workflow.md)
|
|
3
|
+
[返回学习入口](../README.md) · [最小业务](../reference/primitives.md) · [开发步骤](../getting-started/workflow.md)
|
|
4
4
|
|
|
5
5
|
关系和普通属性统一写在 `aggregate(...).fields` 中。业务不需要另写 `relations` 区块,也不用为单纯“便笺与用户的关联”创建 `NoteMember` 聚合。
|
|
6
6
|
|
|
@@ -20,43 +20,60 @@
|
|
|
20
20
|
|
|
21
21
|
## 完整领域例子
|
|
22
22
|
|
|
23
|
-
下面可作为 `packages/domain/src/modules/note/note.ts`。它是[最小便笺](primitives.md)的关系版本,按需要替换原文件,避免重复声明 Note。
|
|
23
|
+
下面可作为 `packages/domain/src/modules/note/note.ts`。它是[最小便笺](../reference/primitives.md)的关系版本,按需要替换原文件,避免重复声明 Note。
|
|
24
24
|
|
|
25
25
|
```ts
|
|
26
|
+
/**
|
|
27
|
+
* 便笺关系示例,由 domain 入口导出后参与注册、契约和图谱生成。
|
|
28
|
+
* Note 维护协作人集合,NoteComment 通过 noteId 归属便笺;命令只返回变化,持久化由内核完成。
|
|
29
|
+
* 名称使用 description/describe/labels 写入本体,中文注释不代替这些结构化信息。
|
|
30
|
+
*/
|
|
26
31
|
import {
|
|
27
32
|
aggregate, command, fail, hasMany, manyToMany, ref, scope, states, text,
|
|
28
33
|
} from '@yss123/cage-kernel';
|
|
29
34
|
import { z } from 'zod';
|
|
30
35
|
|
|
36
|
+
/** 部门便笺独立维护状态和协作人;评论有自己的聚合,本例没有提供便笺归档命令。 */
|
|
31
37
|
export const Note = aggregate('Note', {
|
|
32
38
|
description: '部门便笺',
|
|
33
39
|
fields: {
|
|
34
|
-
title: text(120),
|
|
35
|
-
deptId: ref('Dept'),
|
|
36
|
-
createdBy: ref('User'),
|
|
40
|
+
title: text(120).describe('便笺标题'),
|
|
41
|
+
deptId: ref('Dept').describe('所属部门'),
|
|
42
|
+
createdBy: ref('User').describe('创建人'),
|
|
37
43
|
// 这是 ID 集合。框架负责物理中间表、约束、关联写入和事务。
|
|
38
44
|
members: manyToMany('User', { description: '协作成员' }),
|
|
39
45
|
// 从评论上的 noteId 反查;这不是一份可写的评论 ID 数组。
|
|
40
46
|
comments: hasMany('NoteComment', { mappedBy: 'noteId', description: '便笺评论' }),
|
|
41
47
|
},
|
|
42
|
-
states: states('active', 'archived', {
|
|
48
|
+
states: states('active', 'archived', {
|
|
49
|
+
terminal: ['archived'],
|
|
50
|
+
labels: { active: '使用中', archived: '已归档' },
|
|
51
|
+
}),
|
|
43
52
|
scope: scope.deptSubtree('deptId'),
|
|
44
53
|
invariants: { titleNotBlank: (note) => note.title.trim().length > 0 },
|
|
45
54
|
});
|
|
46
55
|
|
|
56
|
+
/** 评论以 noteId 归属便笺;创建命令读取便笺并复制部门,不依赖 ref 自动继承范围。 */
|
|
47
57
|
export const NoteComment = aggregate('NoteComment', {
|
|
48
58
|
description: '便笺评论',
|
|
49
59
|
fields: {
|
|
50
|
-
noteId: ref('Note'),
|
|
51
|
-
body: text(2000),
|
|
52
|
-
deptId: ref('Dept'),
|
|
53
|
-
createdBy: ref('User'),
|
|
60
|
+
noteId: ref('Note').describe('所属便笺'),
|
|
61
|
+
body: text(2000).describe('评论内容'),
|
|
62
|
+
deptId: ref('Dept').describe('所属部门'),
|
|
63
|
+
createdBy: ref('User').describe('评论人'),
|
|
54
64
|
},
|
|
65
|
+
// 与框架默认的 active/deleted 生命周期相同,仅显式补齐图谱名称,不新增删除操作。
|
|
66
|
+
states: states('active', 'deleted', {
|
|
67
|
+
terminal: ['deleted'],
|
|
68
|
+
labels: { active: '有效评论', deleted: '已删除' },
|
|
69
|
+
}),
|
|
55
70
|
scope: scope.deptSubtree('deptId'),
|
|
56
71
|
});
|
|
57
72
|
|
|
73
|
+
/** 创建使用中的便笺,可选初始协作人;部门与创建人由内核按当前主体填入。 */
|
|
58
74
|
export const createNote = command(Note, {
|
|
59
75
|
name: 'create', from: 'new', to: 'active',
|
|
76
|
+
description: '创建部门便笺',
|
|
60
77
|
input: z.object({
|
|
61
78
|
title: z.string().trim().min(1).max(120),
|
|
62
79
|
members: z.array(z.string().uuid()).optional(),
|
|
@@ -65,23 +82,29 @@ export const createNote = command(Note, {
|
|
|
65
82
|
handler: (draft) => draft,
|
|
66
83
|
});
|
|
67
84
|
|
|
85
|
+
/** 完整替换使用中便笺的协作人,空数组表示全部解绑;调用方负责提供完整目标集合。 */
|
|
68
86
|
export const setNoteMembers = command(Note, {
|
|
69
87
|
name: 'setMembers', from: 'active', to: null,
|
|
88
|
+
description: '替换便笺协作人',
|
|
70
89
|
input: z.object({ id: z.string().uuid(), members: z.array(z.string().uuid()) }),
|
|
71
90
|
// 完整替换集合;[] 表示全部解绑。只改关系也会递增便笺版本并写审计。
|
|
72
91
|
handler: (_draft, input) => ({ members: input.members }),
|
|
73
92
|
});
|
|
74
93
|
|
|
94
|
+
/** 向完整草稿追加协作人,保留既有关联;内核在事务中校验新增目标并规范化集合。 */
|
|
75
95
|
export const addNoteMembers = command(Note, {
|
|
76
96
|
name: 'addMembers', from: 'active', to: null,
|
|
97
|
+
description: '追加便笺协作人',
|
|
77
98
|
input: z.object({ id: z.string().uuid(), memberIds: z.array(z.string().uuid()) }),
|
|
78
99
|
// 草稿包含完整的既有关联。增量追加可以保留当前操作者看不到的旧成员。
|
|
79
100
|
// 数组去重与排序由框架统一处理,业务不再维护第二套集合规范化。
|
|
80
101
|
handler: (draft, input) => ({ members: [...draft.members, ...input.memberIds] }),
|
|
81
102
|
});
|
|
82
103
|
|
|
104
|
+
/** 读取当前可见便笺后创建评论;便笺不可见或已归档时拒绝,成功时沿用其部门。 */
|
|
83
105
|
export const createNoteComment = command(NoteComment, {
|
|
84
106
|
name: 'create', from: 'new', to: 'active', reads: { notes: Note },
|
|
107
|
+
description: '评论便笺',
|
|
85
108
|
input: z.object({ noteId: z.string().uuid(), body: z.string().trim().min(1).max(2000) }),
|
|
86
109
|
handler: async (_draft, input, { notes }) => {
|
|
87
110
|
const note = await notes.get(input.noteId);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 业务前端路由与浏览器验收
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [工程目录](project-structure.md) · [开发步骤](workflow.md)
|
|
3
|
+
[返回学习入口](../README.md) · [工程目录](../reference/project-structure.md) · [开发步骤](../getting-started/workflow.md)
|
|
4
4
|
|
|
5
5
|
多页面业务默认使用 React Router 的 BrowserRouter。列表、详情、报表等可独立访问的页面必须有 URL;在 app 中统一组合路由和工作台布局,页面从模块 index.ts 导出。useState 用于弹窗、未提交表单和按钮忙碌状态。筛选、分页和需要分享的选项使用 useSearchParams。
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 详细中文注释规范
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [工程目录](project-structure.md) · [开发步骤](workflow.md)
|
|
3
|
+
[返回学习入口](../README.md) · [工程目录](project-structure.md) · [开发步骤](../getting-started/workflow.md)
|
|
4
4
|
|
|
5
5
|
本规范同时适用于 Cage 框架源码、标准范例,以及通过脚手架创建后由 Codex 等 agent 编写和维护的应用源码。**详细中文注释是代码交付的一部分。** 新建或修改代码时,必须让后续开发者仅凭源码及其注释理解职责、输入输出、关键步骤、设计原因、调用关系和行为边界,不能只在聊天回复或外部设计文档中解释。
|
|
6
6
|
|
|
@@ -79,14 +79,17 @@ export const Note = aggregate('Note', {
|
|
|
79
79
|
description: '部门便笺',
|
|
80
80
|
fields: {
|
|
81
81
|
/** 便笺标题,最多 120 个字符;命令去除首尾空白后要求非空,不接受 null。 */
|
|
82
|
-
title: text(120),
|
|
82
|
+
title: text(120).describe('便笺标题'),
|
|
83
83
|
/** 所属部门 UUID;创建输入不允许指定,内核从当前主体部门补入,用于范围判断。 */
|
|
84
|
-
deptId: ref('Dept'),
|
|
84
|
+
deptId: ref('Dept').describe('所属部门'),
|
|
85
85
|
/** 创建人 UUID;内核在新建结果中填入操作者,已有记录更新时保留原值。 */
|
|
86
|
-
createdBy: ref('User'),
|
|
86
|
+
createdBy: ref('User').describe('创建人'),
|
|
87
87
|
},
|
|
88
88
|
/** active 可改标题;archived 为终态,update 的 from 会拒绝对归档记录的修改。 */
|
|
89
|
-
states: states('active', 'archived', {
|
|
89
|
+
states: states('active', 'archived', {
|
|
90
|
+
terminal: ['archived'],
|
|
91
|
+
labels: { active: '使用中', archived: '已归档' },
|
|
92
|
+
}),
|
|
90
93
|
/** 声明部门范围字段和建议范围,实际授权由角色决定,并非自动授予部门可见权。 */
|
|
91
94
|
scope: scope.deptSubtree('deptId'),
|
|
92
95
|
invariants: {
|
|
@@ -1,70 +1,16 @@
|
|
|
1
1
|
# 原语与最小业务
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [开发步骤](workflow.md)
|
|
3
|
+
[返回学习入口](../README.md) · [开发步骤](../getting-started/workflow.md)
|
|
4
4
|
|
|
5
5
|
本页代码使用当前公开导出。完整文件示例可直接放入应用;标为“片段”的代码需要结合采购范例已有符号使用。不要把片段中的变量名当成新的框架 API。
|
|
6
6
|
|
|
7
|
-
文件字段使用 `file({ maxBytes, accept }).optional()` 或 `files({ maxBytes, accept, maxCount })`。字段保存文件 ID,上传/续传先获得临时文件,最终通过业务命令绑定;完整流程、限制和存储配置见[文件指南](files.md)。
|
|
7
|
+
文件字段使用 `file({ maxBytes, accept }).optional()` 或 `files({ maxBytes, accept, maxCount })`。字段保存文件 ID,上传/续传先获得临时文件,最终通过业务命令绑定;完整流程、限制和存储配置见[文件指南](../guides/files.md)。
|
|
8
8
|
|
|
9
9
|
## 最小的增、查、改、归档业务
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
完整教学代码统一维护在[便笺声明](../examples/note/note.ts)。[第一条完整业务链](../getting-started/first-feature.md)带你依次完成领域导出、契约生成、权限配置与真实页面接入,包含可编译的列表、新建、详情、修改和归档组件。
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
import { aggregate, command, ref, scope, states, text } from '@yss123/cage-kernel';
|
|
15
|
-
import { z } from 'zod';
|
|
16
|
-
|
|
17
|
-
export const Note = aggregate('Note', {
|
|
18
|
-
description: '部门便笺',
|
|
19
|
-
fields: {
|
|
20
|
-
title: text(120),
|
|
21
|
-
deptId: ref('Dept'),
|
|
22
|
-
createdBy: ref('User'),
|
|
23
|
-
},
|
|
24
|
-
states: states('active', 'archived', { terminal: ['archived'] }),
|
|
25
|
-
// 指明部门字段。最终能看哪个部门,由角色的数据范围决定。
|
|
26
|
-
scope: scope.deptSubtree('deptId'),
|
|
27
|
-
invariants: { titleNotBlank: (o) => o.title.trim().length > 0 },
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
export const createNote = command(Note, {
|
|
31
|
-
// 使用独立导出名避免多个文件 export * 时 create 重名;能力仍叫 Note.create。
|
|
32
|
-
name: 'create',
|
|
33
|
-
from: 'new',
|
|
34
|
-
to: 'active',
|
|
35
|
-
input: z.object({ title: z.string().trim().min(1).max(120) }),
|
|
36
|
-
// 新建草稿已有输入字段;deptId 和 createdBy 由内核按当前主体填入。
|
|
37
|
-
handler: (draft) => draft,
|
|
38
|
-
});
|
|
39
|
-
|
|
40
|
-
export const updateNote = command(Note, {
|
|
41
|
-
name: 'update',
|
|
42
|
-
from: 'active',
|
|
43
|
-
to: null,
|
|
44
|
-
input: z.object({ id: z.string().uuid(), title: z.string().trim().min(1).max(120) }),
|
|
45
|
-
// 只返回业务变化,状态、版本及审计仍由内核维护。
|
|
46
|
-
handler: (_draft, input) => ({ title: input.title }),
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
export const archiveNote = command(Note, {
|
|
50
|
-
name: 'archive',
|
|
51
|
-
from: 'active',
|
|
52
|
-
to: 'archived',
|
|
53
|
-
// 省略 input 时,已有记录命令默认使用 { id: uuid }。
|
|
54
|
-
handler: (draft) => draft,
|
|
55
|
-
});
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
先在 `packages/domain/src/modules/note/index.ts` 写 `export * from './note.js';`,再在 `packages/domain/src/index.ts` 保留组织模型及已有模块,加入新模块:
|
|
59
|
-
|
|
60
|
-
```ts
|
|
61
|
-
export * from '@yss123/cage-admin/domain';
|
|
62
|
-
export * from './modules/note/index.js';
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
随后 `pnpm exec cage check`、`pnpm gen`,审查迁移后 `pnpm migrate`。管理员给目标角色配置 `Note.create / Note.update / Note.archive / Note.read` 和 `Note` 数据范围;前端使用生成的 `note.create({ title })`、`note.update(id, { title }, version)`、`note.archive(id, version)`、`note.list()`、`note.get(id)`。
|
|
66
|
-
|
|
67
|
-
这里的删除选择“归档”这一业务命令,没有硬删表行。读侧列表默认行为以生成契约与实际过滤参数为准,页面要按需求选择是否展示归档记录。系统默认状态并不意味着自动拥有完整 CRUD 命令。
|
|
13
|
+
原语参考从下文查字段与选项;无需重复复制一份入门代码。便笺的删除选择“归档”命令,保留历史;系统默认状态不会自动提供完整 CRUD 命令。
|
|
68
14
|
|
|
69
15
|
## 字段速查
|
|
70
16
|
|
|
@@ -85,7 +31,9 @@ export * from './modules/note/index.js';
|
|
|
85
31
|
|
|
86
32
|
字段可链式使用 `.optional()`、`.unique()`、`.sensitive('phone')`、`.hidden()` 等。可用敏感种类以包导出的 `SENSITIVE_KINDS` 为准;hidden 字段不会作为普通公开读字段,sensitive 字段按权限掩码。不要通过前端隐藏来替代它们。
|
|
87
33
|
|
|
88
|
-
|
|
34
|
+
业务含义同步写在框架能抽取的位置:字段 `.describe('所属部门')`、对象和操作的 `description`、每个状态的 `labels`。普通注释与前端文案不替代这些名称;完整填写位置、对象关系与检查方式见[本体建模指南](../guides/ontology-modeling.md)。
|
|
35
|
+
|
|
36
|
+
集合关系也放在 `fields` 中,但不是普通 SQL 列,不支持上述四种修饰。完整声明、成员命令、分页接口、权限与迁移见[对象关系指南](../guides/relations.md)。纯关联不手写 NoteMember 聚合,具有职位、状态等业务属性的关联仍应建业务聚合。
|
|
89
37
|
|
|
90
38
|
不要定义 `id/version/status/createdAt/updatedAt/tenantId` 同名业务字段。聚合名和事件名用大驼峰,字段、命令、查询和任务名用小驼峰,状态名用小写下划线。
|
|
91
39
|
|
|
@@ -124,10 +72,10 @@ handler: async (order, _input, { stock }) => {
|
|
|
124
72
|
```ts
|
|
125
73
|
// 片段:放在采购 approve 的配置中。
|
|
126
74
|
invokedBy: 'process',
|
|
127
|
-
constraints: [sod.notSameAs('createdBy')
|
|
75
|
+
constraints: [sod.notSameAs('createdBy')],
|
|
128
76
|
```
|
|
129
77
|
|
|
130
|
-
`sod`
|
|
78
|
+
`sod` 防止提单人审批自己。审批流程的业务条件按需声明:采购示例按金额决定是否进入财务节点;其他流程也可以按类型、部门等字段分流,或不使用金额。
|
|
131
79
|
|
|
132
80
|
不变量写在 `aggregate(..., { invariants: { 名称: 对象 => boolean } })`,在最终结果合并和目标状态确定后检查。例如 `Number(o.amount) > 0`。约束回答“这次操作允许吗”,不变量回答“结果对象合法吗”。可用 `Constraint` 类型定义自定义约束对象;先核对公开导出,不假设所有内部 helper 都是公共 API。
|
|
133
81
|
|
|
@@ -231,7 +179,7 @@ export const recentOrders = query('recentOrders', {
|
|
|
231
179
|
|
|
232
180
|
`sql` 与 `build` 必须二选一。SQL 用数据库的 snake_case 列名和 `:参数名`;不要拼接输入,也不要查询 `core.*`/`sys.*` 基表。`reads` 列出所有涉及的聚合,不能漏掉 join 的对象。业务前端调用生成的 `queries.*`,不复制查询 SQL。
|
|
233
181
|
|
|
234
|
-
有目的级审计要求时,在 query 中声明 `audit: { purpose: '月度结算核对' }`。目的应为固定说明,不包含敏感输入。查询会先可靠写入用途审计再交付结果;潜在敏感明文还按 `reads` 保守审计,不假定任意 SQL 投影能精确推导字段和对象。审计故障返回 `CAGE-AUDIT-001`,不交付查询数据。完整保证见[审计矩阵](architecture.md#审计保证)。
|
|
182
|
+
有目的级审计要求时,在 query 中声明 `audit: { purpose: '月度结算核对' }`。目的应为固定说明,不包含敏感输入。查询会先可靠写入用途审计再交付结果;潜在敏感明文还按 `reads` 保守审计,不假定任意 SQL 投影能精确推导字段和对象。审计故障返回 `CAGE-AUDIT-001`,不交付查询数据。完整保证见[审计矩阵](../getting-started/architecture.md#审计保证)。
|
|
235
183
|
|
|
236
184
|
通用列表参数要求正安全整数 page/pageSize;数值筛选必须有限并满足字段 schema,布尔只接受 true/false,日期必须合法,排序字段必须来自公开字段。非法值返回字段级 `INVALID_INPUT`,不会把任意非 true 字符串转成 false。当前仍采用 offset 分页及精确计数,大规模分页成本需按实际数据测量。
|
|
237
185
|
|
|
@@ -261,9 +209,9 @@ export const poRoute = route('po-approval', [
|
|
|
261
209
|
|
|
262
210
|
`approval` 绑定事件与结论命令;`route` 决定步骤与人;`routable` 限制交给路由的数据字段。`onApproved/onRejected` 必须属于同一聚合,且允许 process 调用。
|
|
263
211
|
|
|
264
|
-
内置选人器是 `approver.deptLeader(字段名)`、`approver.role(角色code)`、`approver.user(用户id)`。条件使用 `gt/gte/lt/lte/eq/ne/isIn` 等封闭表达式。`mode: 'any'/'all'` 描述一步内的人如何完成,不表示任意并行分支。人工节点可通过 `actions: { transfer: true, delegate: true, addSign: true }` 显式开放转办、委派归还和当前节点并行必签,默认关闭;任务版本、权限、SDK 与边界见[审批任务流转](approvals.md)。任意函数选人、前后加签和并行流程分支仍需扩展。
|
|
212
|
+
内置选人器是 `approver.deptLeader(字段名)`、`approver.role(角色code)`、`approver.user(用户id)`。条件使用 `gt/gte/lt/lte/eq/ne/isIn` 等封闭表达式。`mode: 'any'/'all'` 描述一步内的人如何完成,不表示任意并行分支。人工节点可通过 `actions: { transfer: true, delegate: true, addSign: true }` 显式开放转办、委派归还和当前节点并行必签,默认关闭;任务版本、权限、SDK 与边界见[审批任务流转](../guides/approvals.md)。任意函数选人、前后加签和并行流程分支仍需扩展。
|
|
265
213
|
|
|
266
|
-
|
|
214
|
+
被选中的审批人还要具备结论命令所需能力和范围。部门负责人为空会产生 `CAGE-APPR-007`,详见[排错](../tools/troubleshooting.md)。
|
|
267
215
|
|
|
268
216
|
## 连接器、定时任务和逃生口
|
|
269
217
|
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
│ │ └─ user/index.ts
|
|
61
61
|
│ └─ queries/index.ts
|
|
62
62
|
├─ db/migrations/
|
|
63
|
-
└─ docs/
|
|
63
|
+
└─ docs/development/、docs/errors/
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
树中的采购文件可在采购模板中运行;空白模板把它们作为离线参考放在 `docs/examples/purchase-admin`,真实源码只有认证、工作台和组织模型。空白项目没有需要用到的目录可以不创建。
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
3. 需要驱动其他模块时,把 reaction 放在 `workflows/expense-xxx.ts`,从双方模块公开入口取声明。第三方接口放 `integrations/<系统名>.ts`,声明 hosts、schema、secret 名、outbound/inbound,不直接发网络请求。
|
|
75
75
|
4. 运行 `pnpm gen`,审查 `contracts/src/aggregates/expense/index.ts` 和迁移草稿。根 `@app/contracts` 自动导出 Expense API/类型。不要在 contracts 里手工建“报销 service”。
|
|
76
76
|
5. 在 `apps/web/src/modules/expense/pages/expense-list-page.tsx` 使用生成 hooks。新建表单放该模块 `components/expense-form.tsx`,模块专用 hooks 放自己的 `hooks`,专用接口封装按需放自己的 `api`,专用常量留在模块内。
|
|
77
|
-
6. 从前端模块 `index.ts` 导出页面,应用壳从 `../modules/expense` 引入并注册列表、详情 URL,通过 Outlet 放入工作台布局。导航用 Link/NavLink,筛选和分页用 useSearchParams;弹窗和提交状态留在页面,不把整个页面切换写成 useState。按[路由指南](routing.md)验收深链接、刷新、前进后退和登录回跳。
|
|
77
|
+
6. 从前端模块 `index.ts` 导出页面,应用壳从 `../modules/expense` 引入并注册列表、详情 URL,通过 Outlet 放入工作台布局。导航用 Link/NavLink,筛选和分页用 useSearchParams;弹窗和提交状态留在页面,不把整个页面切换写成 useState。按[路由指南](../guides/routing.md)验收深链接、刷新、前进后退和登录回跳。
|
|
78
78
|
|
|
79
79
|
前后端可以有相同的业务模块名,但文件不混放:领域定义授权和行为,前端管理交互,通过生成契约连接。API 启动入口维持薄壳,普通业务无需新增 controller/service/repository。
|
|
80
80
|
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: cage-development
|
|
3
|
+
description: 使用 Cage 框架开发、修改和排查业务应用。适用于依赖 @yss123/cage-*、具有 cage.config.json 的项目,与用户澄清需求、比较方案,再完成业务建模、框架接入与验收;维护框架内部实现时先遵守框架仓库的 AGENTS.md。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 使用 Cage 开发业务
|
|
7
|
+
|
|
8
|
+
本 Skill 是编程 agent 的工作流程:**读项目 → 理解需求并澄清 → 查证框架与现有实现 → 说明实现映射 → 编码 → 按业务验收**。先知道用户要什么、Cage 如何实现,再改代码;不要从一句需求直接套用熟悉的技术方案。
|
|
9
|
+
|
|
10
|
+
按当前任务使用本流程,保留项目自己的业务规则和用户授权边界。案例中的对象、角色和流程不代表当前应用的需求。这里指导开发阶段的 agent;应用内原生 AI 的接入另见[智能化指南](../../guides/intelligence.md)。
|
|
11
|
+
|
|
12
|
+
## 先建立正确的运行模型
|
|
13
|
+
|
|
14
|
+
Cage 是由业务声明驱动的框架。应用定义业务含义,框架执行这些声明。
|
|
15
|
+
|
|
16
|
+
```text
|
|
17
|
+
定义阶段:领域声明 → domain 导出 → 注册表
|
|
18
|
+
├─ 能力、HTTP 接口与运行时
|
|
19
|
+
└─ 本体图、前端契约与迁移草稿
|
|
20
|
+
写入阶段:页面 → 生成契约 → HTTP → 内核执行命令 → 数据、审计与事件
|
|
21
|
+
读取阶段:页面 → 生成的 list/get 或 query → 安全读侧 → 当前主体可见的数据
|
|
22
|
+
后续阶段:事件 → 同事务反应,或 outbox → worker → 反应 / 审批 / 连接器
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
- **聚合**定义一个业务对象的字段、状态、归属和不变量。以生命周期和一致性要求划分边界;关联对象可以有自己的生命周期。
|
|
26
|
+
- **命令**表达业务意图,是业务写入口。`from/to` 声明允许的状态变化,handler 根据草稿、输入与 `reads` 依赖返回变化;内核处理授权、范围、版本、事务、审计与 outbox。handler 不执行数据库、网络或文件 IO。
|
|
27
|
+
- **读取**使用生成的读取接口;复杂汇总声明 query,通过 `safe.*` 查询。页面展示的数据来自这些服务端结果。
|
|
28
|
+
- **事件**表达已发生的事实;reaction 调用后续命令。共同成功的变化用 `tx: 'same'`,允许稍后完成的变化使用异步执行,并处理失败和重试。
|
|
29
|
+
- **权限**分别考虑角色分配、能力点、数据范围、调用身份和业务约束。`user/process/job/external` 是调用身份;`can()` 是界面提示。角色名称、页面门户和审批选人均不能代替授权。
|
|
30
|
+
- **页面**管理表单、弹窗与展示,并通过契约执行业务。声明存在、接口生成、应用启用和实际执行成功是四种不同证据。
|
|
31
|
+
|
|
32
|
+
首次接触 Cage,先读[架构与执行模型](../../getting-started/architecture.md),再沿[第一条完整业务链](../../getting-started/first-feature.md)理解声明如何变成真实读写。已经熟悉框架时只读当前缺失的部分;不要把教学案例整体加入用户项目。
|
|
33
|
+
|
|
34
|
+
## 1. 确认正在修改什么
|
|
35
|
+
|
|
36
|
+
读取当前项目的 AGENTS.md、package.json、cage.config.json,以及相关模块的入口和现有测试。确认:
|
|
37
|
+
|
|
38
|
+
- 当前工作目录是框架源码仓库,还是依赖框架的应用。框架仓库的业务范例在 `examples/purchase-admin`;普通应用命令在对应应用根目录执行。
|
|
39
|
+
- 当前安装版本、domain 入口、契约目录和真实前端入口。API 以该版本的公开导出与生成契约为准。
|
|
40
|
+
- 任务属于新建业务、扩展已有业务、排错,还是界面调整。界面文案或样式调整不重新建模;排错先定位现有链路,避免重写一套实现。
|
|
41
|
+
- 参考代码和正在运行的代码分别在哪里。空白项目的 `docs/examples/purchase-admin` 只供阅读。
|
|
42
|
+
|
|
43
|
+
先复用已存在的声明、客户端与组织基础。区分用户希望实现的规则、文档中的约定与代码当前的行为;现有代码只能证明现在怎样运行,不能替用户决定目标业务。用户已明确的条件直接采用,发现仍未解决的歧义、冲突或遗漏时按下一节共同澄清。
|
|
44
|
+
|
|
45
|
+
## 2. 提出疑问和建议,与用户共同确定业务
|
|
46
|
+
|
|
47
|
+
先用业务语言整理本次目标:谁要完成什么事,操作前后发生什么变化,哪些条件必须成立,怎样才算完成。区分用户明确提出的规则、文档和代码提供的事实、尚待决定的问题及可选建议;只整理本次相关内容,不能用一份功能名列表代替业务理解。
|
|
48
|
+
|
|
49
|
+
按[业务澄清与共同设计](../../guides/business-collaboration.md)处理不完整的描述和不清楚的文档。主动指出可能影响业务含义、使用体验、实现范围或验收的疑点,不等到实现失败才询问,也不默默补成自定规则。
|
|
50
|
+
|
|
51
|
+
- 先读相关上下文;API、版本与当前行为由 agent 查文档、公开签名和实现证据。查证后仍涉及业务取舍的,交给用户选择。
|
|
52
|
+
- 提问带上具体疑点及来源、可行选项与影响、推荐方案及理由。用用户能判断的业务语言表达,允许用户提出选项之外的方案;框架缺口和额外实现成本要说明。
|
|
53
|
+
- 按对当前工作的影响分批提出问题,也可提出有价值的改进建议。需要选择的业务规则先取得答案再实现相关部分;等待时推进独立工作。可选建议不阻塞已明确的任务。
|
|
54
|
+
- 沿用用户已给出的选择和授权,不重复确认。普通技术细节自行解决;用户明确委托 agent 决定时,在委托范围内选择并说明依据。推荐、预选和未回复均不等于用户已选择。
|
|
55
|
+
- 将回答更新为业务规则和验收例子,再映射到框架;实现中发现新疑问仍按此方式处理,用户改主意时同步调整受影响的部分。
|
|
56
|
+
|
|
57
|
+
## 3. 选择已有能力并核对用法
|
|
58
|
+
|
|
59
|
+
带着已理解的业务动作,按[业务设计与能力选择](../../guides/recipes.md)判断聚合、一致性和能力边界,再按下表查用法。先看当前应用有没有对应实现,再决定复用、修改还是新增;不要先设计一套通用后端,再尝试套进 Cage。先看最小接入,再查高级选项,不要一次加载所有专题。
|
|
60
|
+
|
|
61
|
+
| 需求 | 选择方法与学习入口 |
|
|
62
|
+
| --- | --- |
|
|
63
|
+
| 新对象、状态、业务操作 | [原语](../../reference/primitives.md):先确定命令意图;已有记录只改字段使用 `to: null`,仍检查允许状态 |
|
|
64
|
+
| 对象/状态看不懂、关系和联动不清楚 | [本体建模](../../guides/ontology-modeling.md):业务含义落实到真实声明,名称完整性与业务正确性分别核对 |
|
|
65
|
+
| 一对多、多对多 | [关系](../../guides/relations.md):只读反查选 hasMany;纯链接选 manyToMany;关系有独立状态/属性时再建聚合 |
|
|
66
|
+
| 列表、详情、统计 | 普通 list/get 优先;汇总或联表使用[query](../../reference/primitives.md#两种查询写法),显式 reads 与安全视图 |
|
|
67
|
+
| 角色、本人/部门范围、敏感字段 | [授权模型](../../getting-started/architecture.md#权限是几层判断):先定归属字段,再配置能力和范围,核对当前会话公开字段 |
|
|
68
|
+
| 审批和人员流转 | [审批](../../guides/approvals.md):提交事件、approval 绑定、route、结论命令;页面通过待办接口决定,选人和授权分别检查 |
|
|
69
|
+
| 事件联动、资源占用、定时动作 | [原语](../../reference/primitives.md):显式 emits/reads/calls,按一致性要求选择事务边界;资源标签还需实际命令落实 |
|
|
70
|
+
| 上传、下载、断点续传 | [文件](../../guides/files.md):上传字节获得文件 ID,业务命令绑定,受控接口下载 |
|
|
71
|
+
| 导入、导出 | [数据传输](../../guides/transfers.md):导入逐条或原子执行命令,导出异步读取;跟踪任务到终态 |
|
|
72
|
+
| 第三方系统 | [连接器配方](../../guides/recipes.md#接入外部系统):外呼、验签、幂等、回写命令与失败恢复 |
|
|
73
|
+
| 原生 AI、AI 审批、随页助理 | [智能化](../../guides/intelligence.md):先检查已有框架能力和 domain 启用状态,再配置策略、授权、模型与界面 |
|
|
74
|
+
| 页面、导航、会话与组件 | [目录](../../reference/project-structure.md)、[路由](../../guides/routing.md)与[前端组件](../../guides/frontend-ui.md):AI 生成真实 React 页面、Ant Design 组合、模块公开入口、独立 URL、会话恢复与用户缓存清理 |
|
|
75
|
+
|
|
76
|
+
知道任务类别时直接阅读上表的章节;需要定位具体术语时先用本地文本搜索。在应用根目录使用:
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
rg -n "术语或符号" docs/development docs/errors
|
|
80
|
+
pnpm exec cage capabilities "公开符号" --format json
|
|
81
|
+
pnpm exec cage context "当前业务关键词" --format json
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
三者分别回答“手册怎样教”“当前版本提供什么”“当前应用在哪里实现”。没有 rg 时使用宿主的本地文件搜索。按命中位置阅读完整规则和代码上下文;结果为空时改用目录中的术语或公开符号,不能由一次未命中推断能力缺失。教材直接保存在本地,无需向量模型、索引构建或独立服务。
|
|
85
|
+
|
|
86
|
+
调用前确认真实签名、参数、返回结果和前提。类型断言不能增加服务端实际未返回的字段。若当前版本确有缺口,说明具体缺口,给出有依据的可行方案及其业务影响,让用户选择涉及目标或范围变化的方案,同时继续处理独立部分;不要编造 API、复制框架运行时或用本地模拟补足正式业务。
|
|
87
|
+
|
|
88
|
+
## 4. 写代码前说明实现映射
|
|
89
|
+
|
|
90
|
+
对准备实现的部分,向用户简述以下对应关系;示例见[规则到实现的映射](../../guides/recipes.md#写代码前的实现映射)。这一步应发生在修改业务代码之前,不能写完后再补一份解释。
|
|
91
|
+
|
|
92
|
+
| 要说明什么 | 必须有的依据 |
|
|
93
|
+
| --- | --- |
|
|
94
|
+
| 本次要实现的业务行为 | 已明确的目标、规则和来源;尚待决定的事项单列 |
|
|
95
|
+
| Cage 如何实现 | 已查证的聚合、命令、状态、范围及必要的后续流程;具体指南、公开签名或现有声明位置 |
|
|
96
|
+
| 具体改哪里 | 复用或修改的模块与导出、需要生成的契约/迁移、页面入口及运行前提;区分框架已提供和应用需完成的部分 |
|
|
97
|
+
| 怎样证明完成 | 用户能观察到的成功结果,以及相关的权限、状态、边界值或失败情形 |
|
|
98
|
+
|
|
99
|
+
每个业务提交按钮应对应真实契约,每项可见范围应有服务端归属和授权依据,每个自动后续动作应有执行与失败处理路径。对应不上时先查证或补设计;涉及业务取舍则回到第 2 步,不用猜测、类型断言或模拟数据填空。
|
|
100
|
+
|
|
101
|
+
新建或修改领域时,按[本体建模](../../guides/ontology-modeling.md)说明相关对象的业务含义、关系方向/基数、状态与动作前后结果,再映射到 ref/集合关系、states、命令及必要的触发链。自然语言、文档、表格和原型都是需求证据;不能按页面建表、按字段名猜外键,或把读取箭头当自动联动。聚合/字段/命令等填写结构化描述,每个状态填写 labels;普通注释和页面文案不会自动进入图谱。
|
|
102
|
+
|
|
103
|
+
清楚的小改动用一两句话即可,不要求新建计划文件,也不要求用户批准普通技术方案。已有明确需求与授权就继续实施;只有尚未确定的业务选择阻塞依赖它的部分。需求或能力证据变化时更新这份映射,避免实现与已选规则脱节。
|
|
104
|
+
|
|
105
|
+
## 5. 沿一条真实链路实施,再扩展
|
|
106
|
+
|
|
107
|
+
新业务先完成一个动作的保存与读取;已有业务只贯通受影响的动作。按[开发步骤](../../getting-started/workflow.md)操作:
|
|
108
|
+
|
|
109
|
+
1. 涉及已有领域含义变化时先保存本体基线。按[目录规范](../../reference/project-structure.md)修改声明,从模块 index 到 domain 入口导出;handler 的读取与 job 的调用声明依赖。
|
|
110
|
+
2. 运行 check/gen,检查生成契约和迁移草稿。生成内容说明声明被识别;需要结构变化时审查后执行迁移,保留已发布迁移。
|
|
111
|
+
3. 按当前环境准备实际授权与必要配置;应用入口和 worker 加载一致的 domain。新能力不自动授给生产角色,沿用用户已授权的配置范围。
|
|
112
|
+
4. 页面调用实际生成的方法并处理业务失败。底层 `CageResult` 检查 `ok`;hook 的成功/失败语义以当前 API 为准。成功后重新读取或失效对应查询;失败保留输入并给出可操作提示。
|
|
113
|
+
5. 验证一个完整动作后复用该模式扩展。前端临时状态可保存草稿、筛选和弹窗;正式业务记录、审批结果及权限由服务端决定。测试夹具或用户明确要求的原型要标明用途,不作为正式运行结果交付。
|
|
114
|
+
|
|
115
|
+
编写时同步遵守[中文注释规范](../../reference/commenting.md):说明职责、输入输出、调用关系和实际边界。注释中的保证必须能在代码中找到实现。
|
|
116
|
+
|
|
117
|
+
## 6. 用观察结果决定完成程度
|
|
118
|
+
|
|
119
|
+
验证与改动匹配,不因小改动运行全部数据库测试。逐项回到编码前的规则与验收例子,检查实现和生成结果是否落实了选择、是否混入未要求的业务行为;待决定事项不能报告为已完成。对新的业务读写链,至少核对所涉及的以下证据:
|
|
120
|
+
|
|
121
|
+
| 要证明什么 | 应取得的证据 |
|
|
122
|
+
| --- | --- |
|
|
123
|
+
| 声明与接口相符 | check、生成一致性、类型检查以及实际契约调用 |
|
|
124
|
+
| 本体可理解且符合需求 | 处理本次声明的 CAGE-ONTOLOGY-001,按业务用语检查图谱/context;逐项核对关系、状态和触发依据,再用业务例子验证,名称齐全不等于业务正确 |
|
|
125
|
+
| 数据持久保存 | 命令成功后通过安全接口独立读取;页面重新加载使用同一服务端记录 |
|
|
126
|
+
| 权限与范围生效 | 允许主体成功,范围外或缺能力主体的直接请求被拒绝 |
|
|
127
|
+
| 流程真正执行 | 提交、待办、决定、结论命令及最终业务状态对应起来 |
|
|
128
|
+
| 文件真正保存 | 上传原始内容,绑定成功,授权下载内容一致,越权下载拒绝 |
|
|
129
|
+
| 异步工作完成 | 实际任务终态和业务结果;接受请求或 fake 成功只证明对应阶段 |
|
|
130
|
+
| 页面可用 | 按[浏览器验收](../../guides/routing.md)实际操作对应路径,包含错误/无权限及相关导航行为 |
|
|
131
|
+
|
|
132
|
+
检查通过不能扩大解释为未检查的业务结果。交付分别报告通过、跳过、未执行,附具体行为与证据;缺少运行条件时明确剩余验证,不伪造成功记录。
|
|
133
|
+
|
|
134
|
+
## 7. 遇到失败,沿边界定位
|
|
135
|
+
|
|
136
|
+
先保留 `code / at / reason / fix` 和相关操作事实,查[排错方法](../../tools/troubleshooting.md)与[错误码册](../../../errors/README.md)。从页面真实调用开始,定位第一个不符合预期的边界,再做最小修正:
|
|
137
|
+
|
|
138
|
+
- 页面未发请求:查事件处理器和数据来源。
|
|
139
|
+
- 契约缺方法或图中缺节点:查导出、生成及当前版本。
|
|
140
|
+
- 请求拒绝:查认证、能力、范围、状态、版本和业务约束。
|
|
141
|
+
- 请求成功但后续未完成:查实际事件、worker、待办或任务执行记录。
|
|
142
|
+
- 服务端正确但页面陈旧:查查询失效、URL 和用户缓存。
|
|
143
|
+
|
|
144
|
+
不要通过放宽授权、删除约束、关闭门禁或改写迁移历史消除错误。找到具体实现缺口再扩展框架;框架内部修改遵守框架仓库的维护规则。
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 能力发现与状态诊断
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
业务开发方法见[框架开发 Skill](../skills/cage-development/SKILL.md)。按任务目录或本地文本搜索定位手册,再用 `capabilities` 核对当前安装版本的公开类型、`context` 定位当前应用的声明。三者分别提供教学说明、API 签名和应用证据,不需要独立知识服务或向量索引。
|
|
4
4
|
|
|
5
5
|
```powershell
|
|
6
6
|
pnpm exec cage capabilities 本人 --format json
|
|
@@ -8,13 +8,16 @@ pnpm exec cage capabilities reactionEach --format json
|
|
|
8
8
|
pnpm exec cage capabilities "AI审批" --format json
|
|
9
9
|
pnpm exec cage capabilities "页面上下文" --format json
|
|
10
10
|
pnpm exec cage capabilities "性格" --format json
|
|
11
|
+
pnpm exec cage capabilities "状态名称" --format json
|
|
11
12
|
pnpm exec cage context "设备归还" --format json
|
|
12
13
|
pnpm exec cage doctor --format json
|
|
13
14
|
```
|
|
14
15
|
|
|
15
|
-
公开能力报告包含包版本、真实签名、公开导出名、声明位置与本地学习指南。未安装的包标为未检查;未命中关键词不能证明能力不存在。完整例子见 [原语](primitives.md) 和 [任务配方](recipes.md)。
|
|
16
|
+
公开能力报告包含包版本、真实签名、公开导出名、声明位置与本地学习指南。未安装的包标为未检查;未命中关键词不能证明能力不存在。完整例子见 [原语](../reference/primitives.md) 和 [任务配方](../guides/recipes.md)。
|
|
16
17
|
|
|
17
|
-
|
|
18
|
+
“本体建模”“状态名称”“对象关系”分别召回真实的领域声明、状态 labels 和关系 API。按[本体建模指南](../guides/ontology-modeling.md)填写结构化名称;`CAGE-ONTOLOGY-001` 对本地可定位且支持命名的节点检查非空名称,默认警告,`graph.naming: 'required'` 时阻止 check/gen/verify。它不从注释或页面推断含义,也不把名称存在判为业务关系正确。
|
|
19
|
+
|
|
20
|
+
原生智能化可用“AI审批”“业务助理”“随页助理”“模型管理”“性格”“Responses”“上下文预算”等关键词检索,结果指向[智能化指南](../guides/intelligence.md)。例如 AI 审批返回现有 `step` 的重载及 `AiStepOptions`,不是另造 `aiStep` 原语。公开能力可被检索,不代表本应用已经导出 `ai()`、执行迁移、配置模型或授予角色权限;接着核对项目启用状态,最后进行实际功能验证。
|
|
18
21
|
|
|
19
22
|
`doctor` 复用 `check`、`gen --check`,输出统一的 `schemaVersion / observedAt / checks / findings / registration / routes`。每个检查包含 `status / source / reason / next`。`pass` 表示相应证据通过,`fail` 表示已发现问题,`unknown` 表示未检查;`complete: false` 不能作为完整验收通过。注册报告列出声明位置、domain 入口、注册节点和对应路由,集合反应还包含上限、排序键、顺序和事务。
|
|
20
23
|
|
|
@@ -26,7 +29,7 @@ pnpm exec cage doctor --format json
|
|
|
26
29
|
pnpm exec cage doctor --runtime-url http://127.0.0.1:3000 --cookie-file .cage/diagnostic-cookie.txt
|
|
27
30
|
```
|
|
28
31
|
|
|
29
|
-
此模式只调用受 `Sys.ops.read` 保护的诊断接口。证据缺失、服务未运行、没有权限或没有 worker 心跳时标记 `unknown
|
|
32
|
+
此模式只调用受 `Sys.ops.read` 保护的诊断接口。证据缺失、服务未运行、没有权限或没有 worker 心跳时标记 `unknown`;接口显示已加载版本和注册指纹,不能仅凭磁盘源码推断进程已经更新。能力已配置给某个角色也不代表任意用户具备范围或调用身份。完成修改后仍需运行 `verify` 和实际业务验收。
|
|
30
33
|
|
|
31
34
|
运行指纹优先使用项目标准 `src→dist` 的实际编译入口,并逐文件检查源码与对应产物的修改时间。缺少构建或使用非标准输出布局时标记未知;编译后还需要重启 API 和 worker。源码经不同转换器执行时的函数文本可能不同,因此不把源码指纹直接当作生产产物指纹。
|
|
32
35
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 用本体图辅助 AI 开发业务
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [开发步骤](workflow.md)
|
|
3
|
+
[返回学习入口](../README.md) · [开发步骤](../getting-started/workflow.md)
|
|
4
4
|
|
|
5
5
|
本页命令在**应用根目录**运行,使用项目安装的 CLI。工具直接分析当前注册的 domain,无需启动 API、worker 或数据库。不要把 Web 截图作为 AI 理解业务的唯一材料:优先取得结构化上下文,再按源码位置阅读实现。
|
|
6
6
|
|
|
@@ -56,9 +56,9 @@ export const purchaseOverview = businessProcess('purchase-overview', {
|
|
|
56
56
|
- `branch: true` 将次要路径收起;每个阶段都需要从入口可达,并能到达至少一个 `kind: 'end'` 的结果。回路直接指向原阶段 ID。
|
|
57
57
|
- 同一板块 ID 的名称和说明保持一致;流程按源码声明顺序展示,可把全流程放在专题流程之前。
|
|
58
58
|
|
|
59
|
-
`cage check` 用 [CAGE-BIZ-001](
|
|
59
|
+
`cage check` 用 [CAGE-BIZ-001](../../errors/CAGE-BIZ-001.md) 和 [CAGE-BIZ-002](../../errors/CAGE-BIZ-002.md) 检查声明与实现关系。它不执行 handler、map 或审批,所以仍需业务回归证明运行行为。
|
|
60
60
|
|
|
61
|
-
阶段直接使用 `title`、`description`、`actor`
|
|
61
|
+
阶段直接使用 `title`、`description`、`actor` 的业务文案;对象和操作使用声明的 `description`,字段使用 `.describe(...)`,每个状态都在 `states(..., { labels: { draft: '草稿' } })` 中填写名称。`graph.labels` 用于显示覆盖及无通用描述选项的节点,例如 `"role:finance": "财务"`。普通注释与前端状态映射不会被抽取,`CAGE-ONTOLOGY-001` 会报告缺失的结构化名称;填写位置与业务验收边界见[本体建模指南](../guides/ontology-modeling.md)。这些名称不更改机器标识。
|
|
62
62
|
|
|
63
63
|
## 开发一项需求的入口
|
|
64
64
|
|
|
@@ -163,7 +163,7 @@ pnpm exec cage impact --snapshot before-change
|
|
|
163
163
|
可直接交给编程工具的要求:
|
|
164
164
|
|
|
165
165
|
```text
|
|
166
|
-
先读 AGENTS.md 和 docs/
|
|
166
|
+
先读 AGENTS.md 和 docs/development/README.md。
|
|
167
167
|
需求:修改……
|
|
168
168
|
先运行 cage context 查询需求相关业务,再用 graph inspect/path 消除入口和关系歧义。
|
|
169
169
|
按报告的源码位置阅读条件与实现;说明选中的业务入口、影响范围和图的覆盖边界。
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
# 排错方法
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## 先找第一个失败的边界
|
|
4
|
+
|
|
5
|
+
从真实用户动作开始,检查页面是否调用契约、请求是否发出、接口如何返回、持久记录是否改变,再看异步后续和页面刷新。页面显示成功但没有请求时,先修页面的数据来源;不要先改数据库或重写领域模型。
|
|
6
|
+
|
|
7
|
+
接口成功与流程完成分开判断。使用[诊断工具](diagnostics.md)按需要收集注册、构建、迁移、授权和执行记录;未取得的运行证据保持 unknown。保留失败输入与错误码,修复最小缺口后复验同一路径,避免同时改变多层而失去原因。
|
|
8
|
+
|
|
9
|
+
[返回学习入口](../README.md) · [错误码册](../../errors/README.md) · [HTTP 运行时错误](../../errors/runtime.md)
|
|
4
10
|
|
|
5
11
|
先保留完整诊断的 code、源码位置、reason/fix、requestId 或 outboxId。检查所在阶段,再修复原因;不要通过改业务状态、给全局权限、注释约束或禁用 lint 消除现象。
|
|
6
12
|
|
|
7
|
-
先执行 `pnpm exec cage doctor` 查看各阶段证据;异步动作按 requestId/outboxId/业务对象用 `cage timeline`
|
|
13
|
+
先执行 `pnpm exec cage doctor` 查看各阶段证据;异步动作按 requestId/outboxId/业务对象用 `cage timeline` 关联实际执行记录。能力、范围或调用身份不清楚时,有权诊断的管理员可使用 `cage explain`,不会执行目标命令。完整参数与权限见[诊断指南](diagnostics.md)。
|
|
8
14
|
|
|
9
15
|
## 按现象定位
|
|
10
16
|
|
|
@@ -13,7 +19,7 @@
|
|
|
13
19
|
| dev 启不动 | `.env` 是否在项目根目录,数据库服务是否可连接 | 缺连接、密码/端口错误、没执行迁移、端口占用 |
|
|
14
20
|
| init 提示账号已存在 | CAGE-INIT-002;找已有 APP/READ/MIGRATE 连接 | 角色在 PG 集群内共享;不应覆盖原密码 |
|
|
15
21
|
| 新业务不出现在接口/图谱 | 顶层 export const 和 domain/index.ts | 漏导出、重名导出、放进函数/条件声明 |
|
|
16
|
-
| API 403 | code/detail、角色能力、调用身份、硬约束 | 能力不足、CSRF
|
|
22
|
+
| API 403 | code/detail、角色能力、调用身份、硬约束 | 能力不足、CSRF、职责分离或其他业务约束不满足 |
|
|
17
23
|
| 详情 404 | 记录 id、租户和数据范围 | 不存在或在范围外;不能仅凭 404 断言被删除 |
|
|
18
24
|
| 列表为空 | read 能力、范围与相应字段 | 默认本人范围、无 owner 字段或部门不匹配 |
|
|
19
25
|
| 电话看不到明文 | sensitive 标注、unmask 能力 | 默认掩码是正常安全行为 |
|
|
@@ -36,7 +42,7 @@
|
|
|
36
42
|
| `approver.role('finance')` | 创建 code 为 finance 的角色,并给实际用户分配 | 选人看角色 code,不是中文显示名称 |
|
|
37
43
|
| `approver.user(id)` | 使用存在的用户 UUID,核对业务可用性 | 把用户名或角色名当成 UUID |
|
|
38
44
|
|
|
39
|
-
|
|
45
|
+
选人成功后,再检查此人所需能力、数据范围及结论命令的业务约束。示例中提单人不能审批自己;采购金额决定是否进入财务节点,不需要配置角色额度。
|
|
40
46
|
|
|
41
47
|
若事件已进入死信,在 `/admin` 查看对应 outboxId 的错误并修正配置,再点击重放。原 submit 通常已提交,单据处于 pending_approval;不要重复提交,更不要直接 SQL 改回 draft。重放后确认待办及后续事件,不把“点击重放成功”当成整条链路已经完成。
|
|
42
48
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CAGE-APPR-001:审批字段声明无效
|
|
2
2
|
|
|
3
|
-
[返回错误码册](README.md) · [业务排错](../
|
|
3
|
+
[返回错误码册](README.md) · [业务排错](../development/tools/troubleshooting.md)
|
|
4
4
|
|
|
5
5
|
> 本页由框架生成。正反例为局部声明或操作说明,完整写法见业务开发指南及本项目 domain。
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@ approval.routable 引用了不存在字段,或 approver.field 指向未声明
|
|
|
13
13
|
## 修复步骤
|
|
14
14
|
|
|
15
15
|
1. 先在聚合声明实际字段,再将需要给审批路由的非隐藏字段放入 routable;不要把任意输入直接交给流程。
|
|
16
|
-
2. 字段选人值应为 UUID 或非空 UUID 数组,见 docs/
|
|
16
|
+
2. 字段选人值应为 UUID 或非空 UUID 数组,见 docs/development/guides/approvals.md;字段公开并不自动授予审批能力。
|
|
17
17
|
|
|
18
18
|
## 正例
|
|
19
19
|
|