@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
|
# 原生智能助理与 AI 审批
|
|
2
2
|
|
|
3
|
-
[返回学习入口](README.md) · [审批与命令](primitives.md) · [架构与执行模型](architecture.md)
|
|
3
|
+
[返回学习入口](../README.md) · [审批与命令](../reference/primitives.md) · [架构与执行模型](../getting-started/architecture.md)
|
|
4
4
|
|
|
5
5
|
这是当前框架的可选运行能力,使用自研持久状态机,不依赖 DeepSeek-Harness。框架提供模型适配、工具、任务、记忆、HTTP 和 SDK;应用提供领域声明、审核策略、角色授权及界面。开发阶段的 `cage context` 查询源码本体,与这里面向登录用户的运行时助理用途不同。
|
|
6
6
|
|
|
@@ -10,13 +10,13 @@
|
|
|
10
10
|
|
|
11
11
|
| 需求关键词 | 公开入口 | 本页使用说明 |
|
|
12
12
|
| --- | --- | --- |
|
|
13
|
-
| AI审批、智能审批、转人工 | `@yss123/cage-approval` 的 `step`、`AiStepOptions` |
|
|
14
|
-
| 业务助理、本体助理 | `@yss123/cage-ai` 的 `ai` |
|
|
15
|
-
| 页面上下文、随页助理 | `@yss123/cage-client` 的 `useAssistant`、`useAiPageContext`、`AiPageContext` |
|
|
16
|
-
| 模型管理、动态配置 | `@yss123/cage-ai` 的 `managedModel` |
|
|
17
|
-
| Responses | `managedModel` 的 Admin 协议选项;代码配置用 `responsesModel` |
|
|
18
|
-
| 性格、自定义人设 | `useAssistant`、`client.ai`;类型由 `@yss123/cage-ai-protocol` 提供 |
|
|
19
|
-
| 上下文预算、大本体 | `@yss123/cage-ai` 的 `AiContextOptions`,传入 `ai({ context: ... })` |
|
|
13
|
+
| AI审批、智能审批、转人工 | `@yss123/cage-approval` 的 `step`、`AiStepOptions` | [AI 审批步骤](#ai-是一个正常审批步骤);沿用 `approval`,声明三态及真实角色 |
|
|
14
|
+
| 业务助理、本体助理 | `@yss123/cage-ai` 的 `ai` | [启用后端](#启用后端)、[工具来源](#助理工具来自注册表);框架编译工具,应用提供声明 |
|
|
15
|
+
| 页面上下文、随页助理 | `@yss123/cage-client` 的 `useAssistant`、`useAiPageContext`、`AiPageContext` | [SDK 与页面内容](#sdk-传入页面内容);应用维护界面与语义快照 |
|
|
16
|
+
| 模型管理、动态配置 | `@yss123/cage-ai` 的 `managedModel` | [启用后端](#启用后端);Admin 配置连接,部署配置凭据加密密钥 |
|
|
17
|
+
| Responses | `managedModel` 的 Admin 协议选项;代码配置用 `responsesModel` | [Responses 配置](#responses-会话与上下文配置);实际验证网关接续及压缩支持 |
|
|
18
|
+
| 性格、自定义人设 | `useAssistant`、`client.ai`;类型由 `@yss123/cage-ai-protocol` 提供 | [Admin 性格配置](#admin-配置助理性格);内置预设与自定义表达,不改变审核策略 |
|
|
19
|
+
| 上下文预算、大本体 | `@yss123/cage-ai` 的 `AiContextOptions`,传入 `ai({ context: ... })` | [按需加载](#大本体按需加载);工具、历史、页面与输出共同受预算约束 |
|
|
20
20
|
|
|
21
21
|
在应用根目录按需查询,例如:
|
|
22
22
|
|
|
@@ -36,7 +36,9 @@ pnpm exec cage capabilities "Responses" --format json
|
|
|
36
36
|
| 项目已启用 | domain 根入口导出 `ai()`、API/worker 使用相同声明、系统迁移已执行、模型及相关角色权限已配置;有助理需求时包含 `assistant` 并接入 SDK |
|
|
37
37
|
| 实际验证通过 | 真实角色和模型下完成本次需求的读取、交互、审批或写入验收;报告通过、跳过与未执行项 |
|
|
38
38
|
|
|
39
|
-
先查现有 domain 入口,已有 AI 运行时就扩展该声明;框架只允许一个 `ai()` 运行时。空白模板只注册组织模型,`docs/examples/purchase-admin` 是参考源码,不代表启用了助理。标准范例可沿 `packages/domain/src/integrations/intelligence.ts`、`packages/domain/src/modules/purchase/approvals.ts` 和 `apps/web/src/shared/ui/assistant-panel.tsx` 阅读,路径规则见[学习入口](README.md)。后端循环、通用工具、会话表和性格管理使用框架;应用侧完成业务策略、授权与界面组合。
|
|
39
|
+
先查现有 domain 入口,已有 AI 运行时就扩展该声明;框架只允许一个 `ai()` 运行时。空白模板只注册组织模型,`docs/examples/purchase-admin` 是参考源码,不代表启用了助理。标准范例可沿 `packages/domain/src/integrations/intelligence.ts`、`packages/domain/src/modules/purchase/approvals.ts` 和 `apps/web/src/shared/ui/assistant-panel.tsx` 阅读,路径规则见[学习入口](../README.md)。后端循环、通用工具、会话表和性格管理使用框架;应用侧完成业务策略、授权与界面组合。
|
|
40
|
+
|
|
41
|
+
按本次实现范围选择阅读顺序:业务助理走[后端启用与迁移授权](#启用后端) → [工具边界](#助理工具来自注册表) → [页面 SDK](#sdk-传入页面内容) → [验收](#接入后的验收);AI 审批走同一后端前提 → [审批步骤](#ai-是一个正常审批步骤) → [验收](#接入后的验收)。Responses、性格和预算按需求补读。先按 Skill 明确助理应帮助用户完成哪些动作、审批采用哪些规则,再选择接入点。
|
|
40
42
|
|
|
41
43
|
## 启用后端
|
|
42
44
|
|
|
@@ -61,6 +63,8 @@ export const intelligence = ai({
|
|
|
61
63
|
});
|
|
62
64
|
```
|
|
63
65
|
|
|
66
|
+
只有 AI 审批时可以省略 `assistant`。审查并执行 `pnpm migrate` 后再启动 API/worker;新增命名系统迁移由框架携带,`cage doctor` 会列出未执行项,不把建表放到服务启动。管理员显式向使用助理的人授予 `Sys.ai.use`,再按需授予领域 `read`、命令与范围;启用服务不自动授予业务权限。AI 审批的执行角色与授权按下文审批步骤配置。
|
|
67
|
+
|
|
64
68
|
`managedModel` 是框架托管的模型入口。应用引用稳定别名,实际模型名称、HTTP / HTTPS API 基地址、API Key、接口协议、上下文窗口、超时及启停状态在 `/admin/#/models` 配置。可声明多个入口供审批和助理分别使用。不需要在业务项目定义模型配置表、管理路由或环境变量读取逻辑。
|
|
65
69
|
|
|
66
70
|
部署向 API 和 worker 注入同一份 `CAGE_AI_ENCRYPTION_KEY`(32 字节随机密钥的标准 Base64),也可通过连接器 `SecretProvider` 提供。它是加密模型凭据的部署主密钥,不是模型 API Key;应稳定保存并与数据库分开备份。不要随进程启动重新生成,也不要直接轮换它而不重新加密旧配置。未配置时不能保存 API Key。
|
|
@@ -71,6 +75,8 @@ export const intelligence = ai({
|
|
|
71
75
|
|
|
72
76
|
需要代码配置或离线测试时,可使用 `chatModel('language-model', { model, hosts, secret, fake })` 或同包导出的 `responsesModel`:`secret` 是 SecretProvider 的密钥名称;默认遵循 `CAGE_STAGE`,fake 阶段必须显式提供模拟函数且禁止外呼;`environment: 'test' | 'prod'` 可独立选择真实模型环境。自定义 `credential` 解析器只在服务端按次调用,不参与声明序列化。两者默认 HTTPS,可显式设置 `protocol: 'http:'` 连接 HTTP 网关。所有标准模型外呼经过框架连接器的地址校验、限流、取消和超时。
|
|
73
77
|
|
|
78
|
+
`ModelProvider` 是服务端扩展接口,可适配其他协议;适配器必须响应 `AbortSignal`。运行时仍会在超时后放弃等待,迟到结果不会被提交。
|
|
79
|
+
|
|
74
80
|
### Responses 会话与上下文配置
|
|
75
81
|
|
|
76
82
|
Admin 的 `apiFormat` 默认 `chat-completions`,旧模型升级后保持该协议;选择 `responses` 后启用服务端接续。`contextWindowTokens` 默认 32768,可配置 8192 至 2000000,必须按实际模型容量填写;窗口包括输入、输出及推理 Token,和 `assistant.limits.tokenBudget` 的单轮累计消耗分别控制。代码模型使用同名选项。
|
|
@@ -83,10 +89,6 @@ Responses 请求使用 `store: true` 和 `previous_response_id`。框架持久
|
|
|
83
89
|
|
|
84
90
|
升级执行系统迁移 `cage:ai_context_001` 和 `cage:ai_execution_001`:前者增加模型协议/窗口及接续状态,后者将调用预留、尝试次数、接续兼容性及工具预算单独持久化;不改写已有迁移。旧运行的已有计数保留,不追溯推测其费用。前端调用 `client.ai` 的发送、流式订阅与交互方法不变。
|
|
85
91
|
|
|
86
|
-
只有 AI 审批时可以省略 `assistant`。`ModelProvider` 是服务端扩展接口,可适配其他协议;适配器必须响应 `AbortSignal`。运行时仍会在超时后放弃等待,迟到结果不会被提交。
|
|
87
|
-
|
|
88
|
-
审查并执行 `pnpm migrate` 后再启动 API/worker。新增命名系统迁移由框架携带,`cage doctor` 会列出未执行项。不要把建表放到服务启动。管理员显式向使用助理的人授予 `Sys.ai.use`,再按需授予领域 `read`、命令与范围;启用服务不自动授予业务权限。
|
|
89
|
-
|
|
90
92
|
## Admin 配置助理性格
|
|
91
93
|
|
|
92
94
|
性格是框架提供的租户配置,无需应用声明性格聚合或编写工具。启用 `ai({ models, assistant })`、执行系统迁移后即可使用;管理员需显式获得 **`Sys.ai.personalities.manage`**,从 `/admin/#/personalities` 管理。它与 `Sys.ai.models.manage`、普通用户的 `Sys.ai.use` 分开授权。
|
|
@@ -173,7 +175,7 @@ export const reviewRoute = route('document-review', [
|
|
|
173
175
|
|
|
174
176
|
三个结论命令必须属于该聚合并声明 `invokedBy: 'process'`。`onReturned` 与最终拒绝 `onRejected` 独立。修订后再次触发 start 事件,会创建新轮次,从第一个步骤重新开始;旧步骤和旧任务不能继续生效。通知申请人可以由结论命令发事件,再接已有通知反应/连接器;框架不会猜测通知渠道。
|
|
175
177
|
|
|
176
|
-
`automatedBy` 是真实组织角色的 code
|
|
178
|
+
`automatedBy` 是真实组织角色的 code,不是模型可选身份。角色需显式拥有对象读取、所需查询读取、通过/退回命令,以及相应范围。没有隐式全范围,也不冒充提交人。`sod.notSameAs` 要求可核验的真人操作人,自动节点不能绕过该约束;这种命令会转人工。
|
|
177
179
|
|
|
178
180
|
`context.fields` 白名单定义单据上下文;`context.queries` 引用已导出的 query 名称,AI 可按查询 schema 补参数。审核阶段只能调用这些查询、`review_decide` 及读取本次证据的 `context_read`,不能访问其他会话、动态加载其他业务工具或调用助理写工具。证据引用会校验来源是否已提供,但不会把模型判断当作数学证明。
|
|
179
181
|
|
|
@@ -292,7 +294,7 @@ const assistant = useAssistant(client.ai, page);
|
|
|
292
294
|
// progress.tool / toolName / toolState:当前工具及执行状态。
|
|
293
295
|
```
|
|
294
296
|
|
|
295
|
-
以上片段的 hooks 从 `@yss123/cage-client` 导入,record/location 是应用路由与数据。SDK 会在卸载、退出和切换账号时取消订阅并清理 hook 状态;应用其他缓存仍须按[开发步骤](workflow.md)处理。
|
|
297
|
+
以上片段的 hooks 从 `@yss123/cage-client` 导入,record/location 是应用路由与数据。SDK 会在卸载、退出和切换账号时取消订阅并清理 hook 状态;应用其他缓存仍须按[开发步骤](../getting-started/workflow.md)处理。
|
|
296
298
|
|
|
297
299
|
`send` / `respond` 返回的 Promise 等待本轮完成或需要用户交互;界面应在等待期间渲染 `streamingText` 和 `progress`。`run.status`、步数、工具调用数和待确认操作也随事件更新,不必等 Promise 返回。`model.started` 表示开始一次模型调用,`message.delta` 是增量文本,`tool.started` / `tool.completed` 表示实际工具进度;这些事件不包含模型的私有推理内容。新的模型步骤会重置当前文本,最终以 `message.completed` 校准。
|
|
298
300
|
|
|
@@ -345,4 +347,4 @@ Token 使用优先按模型返回 usage 核算;缺少 usage 时使用文本估
|
|
|
345
347
|
- AI 审批:覆盖 pass、return、manual,检查退回修改后的新轮次从头开始;模型失败应按节点配置转人工或留在失败状态,不得伪造通过。
|
|
346
348
|
- 管理配置:验证模型连接和一次实际工具交互,性格切换作用于后续消息;需要 Responses 接续或压缩时分别核对实际支持,连接成功不能替代这些验证。
|
|
347
349
|
|
|
348
|
-
`cage doctor` 可辅助检查注册、迁移和进程证据,但未知项不能当作通过;诊断用法见[能力发现与状态诊断](diagnostics.md)。模型输出质量需要应用使用自己的规则样例评测。框架验证的是权限、状态、预算和事务边界;发布前需使用实际模型服务、实际角色和审批样例联调。
|
|
350
|
+
`cage doctor` 可辅助检查注册、迁移和进程证据,但未知项不能当作通过;诊断用法见[能力发现与状态诊断](../tools/diagnostics.md)。模型输出质量需要应用使用自己的规则样例评测。框架验证的是权限、状态、预算和事务边界;发布前需使用实际模型服务、实际角色和审批样例联调。
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# 把业务含义写进本体声明
|
|
2
|
+
|
|
3
|
+
[返回学习入口](../README.md) · [业务澄清](business-collaboration.md) · [能力选择](recipes.md) · [本体查询](../tools/ontology-context.md)
|
|
4
|
+
|
|
5
|
+
Cage 的本体来自实际注册的领域声明。对象是什么、状态表示什么、对象之间如何关联、操作后影响谁,都应落实到这些声明及其实现中。图谱用来检查和解释它们;不另建一份与运行代码分离的本体配置来代替领域设计。
|
|
6
|
+
|
|
7
|
+
用户可以通过自然语言、业务文档、已有系统、表格或原型表达需求。原型只能提供其中一部分线索:页面上的“所属部门”可能是对象引用,也可能只是历史名称快照,必须结合业务含义判断。模板和参考例子提供框架用法,不能替用户决定对象、关系或流程。
|
|
8
|
+
|
|
9
|
+
## 编码前,把相关业务说清楚
|
|
10
|
+
|
|
11
|
+
新建或修改领域时,沿[Skill 的实现映射](../skills/cage-development/SKILL.md#4-写代码前说明实现映射),说明本次涉及的对象、关系、动作与结果。小改动用几句话即可;已有清楚的业务文档直接引用,不要求每次另建文档或让用户逐项填表。
|
|
12
|
+
|
|
13
|
+
| 要说清楚什么 | 应落实到哪里 | 如何核对 |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| 对象代表什么,是否有独立身份和生命周期 | aggregate、fields、states、不变量 | 不按页面数建表,不把独立业务对象藏进任意 JSON |
|
|
16
|
+
| 谁属于谁,双方各能关联几个,关系可否为空 | ref、unique、optional、hasMany、manyToMany 或关系聚合 | 外键方向、基数、目标声明、mappedBy 和实际查询一致 |
|
|
17
|
+
| 状态表示什么,哪些操作允许进入或离开 | states 的 labels、terminal、command 的 from/to | 状态名称和允许操作符合用户规则,保留状态的操作用 to: null |
|
|
18
|
+
| 谁能执行,能作用于哪些记录 | 能力、scope、invokedBy、constraints | 页面隐藏按钮和审批选人不能代替服务端授权 |
|
|
19
|
+
| 操作完成后,其他对象或系统怎样变化 | emits、reaction、approval、job、connector 及执行代码 | 明确触发、输入映射、事务、失败和重试;读取依赖不等于自动联动 |
|
|
20
|
+
| 怎样才算业务完成 | 已确认规则及成功、失败例子 | 独立读取结果,验证关键反例,区分静态声明和实际执行 |
|
|
21
|
+
|
|
22
|
+
涉及取舍时按[业务澄清](business-collaboration.md)提出疑点及选项。例如“一个员工是否允许同时有两个有效任职”“删除父对象后子记录如何处理”不能由字段名推断。已明确的规则直接采用,普通技术用法由 agent 查证。
|
|
23
|
+
|
|
24
|
+
## 名称写在真实 API 中
|
|
25
|
+
|
|
26
|
+
机器标识负责存储、能力点、路由和代码引用,业务名称负责让用户与 agent 理解它们。中文业务用中文名称,其他语言的应用用对应业务用语;不要为翻译而改已有状态值、表名或能力点。
|
|
27
|
+
|
|
28
|
+
| 内容 | 结构化填写位置 | 边界 |
|
|
29
|
+
| --- | --- | --- |
|
|
30
|
+
| 业务对象 | `aggregate('Note', { description: '部门便笺', ... })` | 说明对象含义;长篇规则仍由代码、JSDoc 和业务文档解释 |
|
|
31
|
+
| 字段及引用 | `text(120).describe('便笺标题')`、`ref('Dept').describe('所属部门')` | 描述不能代替 ref 关系、输入校验或 scope |
|
|
32
|
+
| 集合关系 | `.describe(...)` 或工厂选项 `description` | `hasMany` 仍需真实的 `mappedBy`,`manyToMany` 不会自动生成有业务状态的关系对象 |
|
|
33
|
+
| 每个状态 | `states(..., { labels: { active: '使用中', archived: '已归档' } })` | 每个状态都应有业务名;初态、终态和可达性单独声明/检查 |
|
|
34
|
+
| 业务操作 | `command(对象, { description: '归档便笺', ... })` | 用业务意图命名,实际条件由 from、constraints、handler 等落实 |
|
|
35
|
+
| 事件 | `event('NoteArchived', { ... }, { description: '便笺已归档' })` | 描述已发生的事实;没有下游需求时不必添加事件 |
|
|
36
|
+
| 查询、定时任务 | 各自选项中的 `description` | reads/calls、SQL 或 run 才表达实际依赖和处理 |
|
|
37
|
+
| 完整业务阅读流程 | `businessProcess` 的 `title/description`,阶段的 `title/description/actor` | action 和连接引用真实实现;阅读规格本身不会执行命令或补出缺失联动 |
|
|
38
|
+
| 板块、角色、无通用描述选项的协作节点、短标题覆盖 | `cage.config.json` 的 `graph.labels`,键为完整节点 key | 属于显示覆盖;不会修正错误关系,也不会自动成为其他界面的文案 |
|
|
39
|
+
|
|
40
|
+
优先把名称与领域声明一起维护。已有项目可用 `graph.labels` 适配:`state:Note.archived`、`field:Note.deptId`、`command:Note.archive`。配置覆盖优先于声明文案;字段也能使用本体属性里的 description。不要为每个节点发明不存在的 `label` 或 `description` 选项,先用 `cage capabilities` 核对公开签名。
|
|
41
|
+
|
|
42
|
+
普通源码注释和前端的 `statusLabel` 映射不会自动被抽取。仅在注释写“archived 表示已归档”,或者仅在页面翻译 archived,图谱仍缺少该状态的业务名。`graph.labels` 只作用于 CLI 图谱及上下文;页面文案与领域状态含义仍需核对一致,前端不得为读取文案导入 domain。
|
|
43
|
+
|
|
44
|
+
完整可编译示例见[便笺领域声明](../examples/note/note.ts)。其中 active/archived 保持机器标识,labels 写“使用中/已归档”,字段和命令分别填写自己的业务名称。便笺不需要审批和事件,不为凑齐图谱节点而添加它们。
|
|
45
|
+
|
|
46
|
+
## 对象关系要落到声明与执行
|
|
47
|
+
|
|
48
|
+
参考[关系指南](relations.md)选择方向与保存方式。例如“每条评论属于一条便笺”:
|
|
49
|
+
|
|
50
|
+
- 评论上的 `noteId: ref('Note').describe('所属便笺')` 表达真正引用;普通 `id()`、`text()` 或命名为 noteId 的字段不会自动建立引用。
|
|
51
|
+
- 便笺上的 `hasMany('NoteComment', { mappedBy: 'noteId', description: '便笺评论' })` 只是反查。修改归属仍执行评论命令,不能写父对象的只读集合。
|
|
52
|
+
- 评论是否沿用便笺部门、便笺归档后能否评论,分别由评论命令的 reads、handler 和允许规则落实;ref 不会自动继承权限、状态或删除行为。
|
|
53
|
+
|
|
54
|
+
跨对象动作也要有真实执行链。“批准后占用资源”应能找到命令发事件、反应接收、调用目标命令的完整声明,以及数据映射与事务选择。`reads` 箭头只证明读取,`from/to` 只证明允许的迁移,`invokedBy: 'process'` 只证明调用身份;它们都不能独自证明审批或自动执行。
|
|
55
|
+
|
|
56
|
+
业务阅读确实跨多个对象时,可以声明 `businessProcess` 解释完整主线并引用真实实现;简单对象生命周期不必额外包一层流程。图谱看起来有连线不能代替实际业务用例。
|
|
57
|
+
|
|
58
|
+
## 检查名称,再按业务验收
|
|
59
|
+
|
|
60
|
+
在应用根目录执行:
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
pnpm exec cage check
|
|
64
|
+
pnpm gen
|
|
65
|
+
pnpm exec cage graph
|
|
66
|
+
pnpm exec cage context "本次业务用语" --format json
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
`CAGE-ONTOLOGY-001` 报告当前项目有源码位置的聚合、字段、状态、命令、事件、查询和任务缺少非空结构化名称。字段和状态的位置指向所属聚合,不是假装精确的成员行号。来自依赖包且没有本地声明位置的节点不在本检查范围;协作节点没有统一的 description API,也不纳入该完整性规则。
|
|
70
|
+
|
|
71
|
+
旧配置默认产生警告;新脚手架启用以下门禁,也可在已有应用补齐名称后启用:
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"graph": {
|
|
76
|
+
"naming": "required"
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
将 naming 合并进原有 graph 配置,保留 title 和 labels。required 让缺名阻止 check/gen/verify;图谱仍会展示可抽取的图及诊断,便于修复。默认警告并不表示业务文案已经完成,应在交付中说明仍缺什么。
|
|
82
|
+
|
|
83
|
+
静态检查只能验证名称存在和框架可识别的结构,不能判断中文是否准确,也不能判断一条外键是否符合任意用户需求。检查后逐项返回编码前的规则:对象含义、关系方向与基数、状态迁移、触发链及权限是否一致?成功和关键失败例子是否得到预期结果?按这些证据报告完成程度,不把“命名门禁通过”当作“理解了业务”。
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# 业务设计与能力选择
|
|
2
|
+
|
|
3
|
+
[返回学习入口](../README.md) · [原语示例](../reference/primitives.md) · [开发步骤](../getting-started/workflow.md)
|
|
4
|
+
|
|
5
|
+
本页负责业务规则到 Cage 能力的设计映射;工作顺序由[框架开发 Skill](../skills/cage-development/SKILL.md)统一规定,具体命令见[开发步骤](../getting-started/workflow.md)。按需要读对应配方,不要求为每个任务加载所有能力。
|
|
6
|
+
|
|
7
|
+
需要 AI 审批、业务助理、随页聊天、模型管理或性格配置时,先用 `cage capabilities` 查框架能力,再按[原生智能化指南](intelligence.md)接入。普通业务建模仍按下文声明聚合和命令;接入已有框架服务无需另建一套通用后端。
|
|
8
|
+
|
|
9
|
+
## 先确定业务边界与执行路径
|
|
10
|
+
|
|
11
|
+
开始编码前,从用户需求、业务文档和现有实现中确定以下信息。按[业务澄清与共同设计](business-collaboration.md)主动提出歧义、冲突、遗漏及有价值的建议,给出选项、影响与推荐理由,让用户选择业务规则。已明确的条件直接采用,API 和普通技术细节由 agent 查证处理;下表用于发现相关问题,不要求用户逐项填表。
|
|
12
|
+
|
|
13
|
+
| 业务问题 | 落到什么声明 | 例如 |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| 管理什么对象?有哪些字段? | aggregate、字段与 Zod 输入 | 报销单:金额、事由、部门、提单人、明细 |
|
|
16
|
+
| 有哪些阶段?谁能做什么? | states、command、invokedBy | 草稿可编辑、提交后审批、完成后不可撤回 |
|
|
17
|
+
| 数据属于谁/哪个部门? | 范围字段 + 角色数据范围 | 申请人看本人,经理看部门及下级 |
|
|
18
|
+
| 每次操作有什么硬规则? | constraints、invariants、fail | 提单人不可审批、金额必须为正 |
|
|
19
|
+
| 成功后还要发生什么? | event、reaction、approval、outbound | 启动审批、登记资源占用、推送财务系统 |
|
|
20
|
+
| 取消/失败要撤销什么? | cancelOn、释放命令、补偿流程 | 取消待办、释放占用、远端撤销或人工补偿 |
|
|
21
|
+
| 页面需要看什么? | 生成的 list/get、query、业务页面 | 分页、详情、按状态汇总、导出与导入 |
|
|
22
|
+
|
|
23
|
+
聚合按业务身份、生命周期和一致性要求划分。一个页面可展示多个聚合,一个聚合也可服务多个页面;不要把页面数量直接当成聚合数量。先识别必须始终成立的不变量,再确定哪些变化需要共同提交。需求没有审批或第三方时,普通命令和生成读取接口就能构成完整功能。
|
|
24
|
+
|
|
25
|
+
### 在相近能力之间作选择
|
|
26
|
+
|
|
27
|
+
| 判断依据 | 选择与边界 |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| 关系只有成员链接,还是有自己的状态与业务属性? | 纯链接用 manyToMany;需要管理关系生命周期时建独立聚合。hasMany 是对目标 ref 的反查,变更归属走目标命令 |
|
|
30
|
+
| 是改变阶段,还是在当前阶段修改字段? | 改阶段用 from/to;仅修改已有记录字段用 to: null,仍声明 from,不让 handler 直接改变 status |
|
|
31
|
+
| 是普通对象读取,还是汇总/联表? | 前者使用生成 list/get;后者声明 query、reads 与安全视图。前端筛选不能承担后端数据范围 |
|
|
32
|
+
| 两项业务变化是否必须一起成功? | 必须共同提交时使用同事务反应;允许稍后完成时走 outbox,明确失败、重试和结果展示 |
|
|
33
|
+
| 是否涉及事务外系统? | 网络 IO 放连接器;超时可能已经远端成功,需要幂等与核对/补偿,不能用数据库事务保证远端回滚 |
|
|
34
|
+
| 需要人工决定,还是确定的业务联动? | 人工/AI 审批使用现有审批流程;确定的自动联动使用事件与反应,不给每个状态变化都加审批 |
|
|
35
|
+
|
|
36
|
+
### 主体与范围必须能够落实到数据
|
|
37
|
+
|
|
38
|
+
先确定真实账号及组织关系,再列出各主体需要的能力和记录范围。当前授权模型使用已声明的归属字段;`scope.none()` 仍要求授权,但不能表达部门/创建人范围。声明了一个自定义 applicantId 或 companyName 不会自动获得“本人/本企业”过滤,应核对框架实际支持的范围字段与当前组织映射。
|
|
39
|
+
|
|
40
|
+
角色是后台分配的数据,能力是被授权的动作,门户是界面组织方式。当前会话公开类型不应通过类型断言凭空添加 roles;若需求要展示实际角色列表,应查找当前允许的读取接口或明确所需接口缺口。多角色能力/范围按框架规则合并,前端切换菜单不会自动切换服务端执行身份。用不同真实主体验证权限,不能用固定姓名或公司名称模拟范围。
|
|
41
|
+
|
|
42
|
+
## 写代码前的实现映射
|
|
43
|
+
|
|
44
|
+
理解规则并核对能力后,把“规则 → 框架机制与证据 → 修改位置 → 验收”连接起来。按当前任务写一段说明或小表即可;这里是设计示例,不是要求复制的业务或固定计划文件。
|
|
45
|
+
|
|
46
|
+
例如,用户已经明确:“已有部门通知增加归档;原有编辑者能归档;归档后保留记录、禁止修改;可见范围不变。”先查现有通知声明、编辑权限、页面及生成契约,再查[命令原语](../reference/primitives.md)。在这些证据一致的前提下,可以形成以下映射:
|
|
47
|
+
|
|
48
|
+
| 已确认规则 | 已查证的框架做法 | 受影响的位置 | 可观察的验收 |
|
|
49
|
+
| --- | --- | --- | --- |
|
|
50
|
+
| 通知可以归档并保留历史 | 在原聚合增加归档状态与命令,使用 `from/to` 表达转换;复用现有记录 | 原通知领域模块、导出、重新生成的契约与迁移草稿 | 授权主体归档后独立读取仍是同一记录,状态已改变 |
|
|
51
|
+
| 归档后禁止修改 | 核对所有相关修改命令的允许状态,让服务端拒绝归档状态的修改 | 原修改命令及必要的规则用例,页面按状态更新操作入口 | 直接请求修改归档记录被拒绝,刷新后内容仍未改变 |
|
|
52
|
+
| 原有编辑者能归档,可见范围不变 | 沿用原归属字段和读范围,明确新增归档能力由哪些现有角色获得;选人或隐藏按钮不代替授权 | 角色配置、命令能力、页面实际契约调用 | 原编辑者获得对应授权后成功;缺能力主体拒绝;范围外主体仍不能读取 |
|
|
53
|
+
|
|
54
|
+
实际任务中把“原通知领域模块”等替换为查到的具体文件、声明和签名位置;生成前说明预期契约,生成后核对实际方法。迁移是否新增、需要哪些数据处理,以真实生成差异和已有数据为准。不要从这个例子推断所有项目都需要归档,也不要顺手加入恢复、删除或通知订阅。
|
|
55
|
+
|
|
56
|
+
如果需求只说“加一个归档”,是否可恢复、谁能归档、归档后能否修改等应按对本次设计的影响提出;用户未要求恢复功能时可作为可选建议,不能擅自纳入实现。业务决定尚未取得时,映射中的相关行为保持待定,继续查证和推进独立部分。
|
|
57
|
+
|
|
58
|
+
## 新增一个普通管理对象
|
|
59
|
+
|
|
60
|
+
参考[最小便笺业务](../reference/primitives.md)在 `packages/domain/src/modules/<业务>/<对象>.ts` 声明字段、范围、不变量和本次确需的命令。便笺演示 create/update/archive;当前业务是否需要这些动作由已确认规则决定。采用唯一的导出名和必要的 `name` 覆盖,避免 index 的 `export *` 丢失重名符号。
|
|
61
|
+
|
|
62
|
+
声明时同步填写对象、字段、操作的业务名称及每个状态的 labels,按[本体建模指南](ontology-modeling.md)核对对象含义、关系和操作结果。从模块 index 到 domain 入口导出后运行 check/gen,处理缺名诊断并审查迁移,再在 `apps/web/src/modules/<业务>` 使用生成 contracts 做列表、详情、表单和操作按钮,经模块公开入口注册到 app 路由。列表和详情都有独立 URL,筛选/分页进入 query,按[浏览器配方](routing.md)检查导航,并为需要的角色授权。完整归属规则见[目录规范](../reference/project-structure.md)。不要手写后端增删改查路由、ORM 实体与 repository,也不要复制框架鉴权代码。
|
|
63
|
+
|
|
64
|
+
完成标准:已要求的动作由授权主体执行,范围外数据不可见,状态和失败行为符合已确认规则,生成契约和迁移一致。没有审批需求时不必添加审批;没有外部系统时不必添加连接器。
|
|
65
|
+
|
|
66
|
+
## 增加一对多或多对多
|
|
67
|
+
|
|
68
|
+
参考[对象关系](relations.md),在聚合的同一个 fields 中添加 `hasMany/manyToMany`。纯关联交给框架生成中间表;关系本身有职位、状态等业务属性时再建立有意义的聚合。hasMany 反查目标上的 ref,修改归属执行子对象命令;manyToMany 用所属对象的命令返回 ID 数组。
|
|
69
|
+
|
|
70
|
+
生成后前端通过 `对象.related.字段(id, params)` 或 `use对象Related字段` 分页读取,不从普通 get 响应猜测已加载关联。给角色配置两侧 read 能力与范围;添加成员时也检查目标可见性。修改关系执行版本检查,不能把当前一页当作完整集合替换。不要创建新的业务连接池、ORM 中间实体或手写关系路由。
|
|
71
|
+
|
|
72
|
+
## 给业务单据加审批
|
|
73
|
+
|
|
74
|
+
1. 为单据补草稿、待审批、通过、驳回等真实状态及命令;提交时发事件。
|
|
75
|
+
2. 通过/驳回使用 process 命令,根据业务添加职责分离等约束;分支条件写在审批路由中。
|
|
76
|
+
3. 添加 approval 绑定和 route;只将需要的字段放进 routable,取消命令发事件并配置 cancelOn。
|
|
77
|
+
4. 配置实际部门负责人、角色或指定用户;给审批人配置能力和范围。
|
|
78
|
+
5. 页面通过待办接口操作。通过后需占用资源时用反应调用资源命令,按业务一致性选择同事务。
|
|
79
|
+
|
|
80
|
+
完成标准:提交生成待办、正确的人审批、越权和自审批拒绝、取消能结束待办、资源配对完整。转办、委派归还及当前节点前签、后签和并行必签见[审批任务流转](approvals.md),须显式启用政策并传任务版本,旧实例是否开放签序以其快照为准。任意流程设计器、动态 JS 选人和指定节点退回仍需明确扩展范围。
|
|
81
|
+
|
|
82
|
+
## 加入 AI 审批或随页助理
|
|
83
|
+
|
|
84
|
+
先检查 domain 是否已经导出 `ai()`,再按需求修改已有声明或启用一次。AI 审批配置在业务模块的现有 `step` 内,填写 `kind: 'ai'`、审核策略、取证字段/查询与 `handoff`,由 `approval` 绑定自动执行角色和结论命令。业务助理使用框架生成的工具,前端通过 `useAssistant` 与 `useAiPageContext` 接入当前页面;悬浮窗、Markdown 和确认交互由应用实现。
|
|
85
|
+
|
|
86
|
+
模型地址、协议和密钥通过 `managedModel` 对应的 Admin 配置管理,性格也使用框架现有管理页。先完成系统迁移和必要授权,按[智能化指南](intelligence.md)的接入顺序、SDK 示例和验收步骤验证。分别说明框架支持、应用已启用和真实联调结果;空白模板中的参考代码不参与运行。
|
|
87
|
+
|
|
88
|
+
## 增加报表或复杂列表
|
|
89
|
+
|
|
90
|
+
普通分页和详情先使用生成的 list/get;汇总、联表等需求再添加 query。写清 reads、输入 schema,选择参数化 SQL 或 build;只查对应 safe 视图,不为“报表方便”切到管理员连接。
|
|
91
|
+
|
|
92
|
+
重新生成后使用 `queries.你的查询()` 或生成 hook。检查真实调用人的 read 能力和数据范围;管理员能看到结果不能证明普通用户的报表正确。
|
|
93
|
+
|
|
94
|
+
## 接入外部系统
|
|
95
|
+
|
|
96
|
+
沿 `packages/domain/src/integrations/erp.ts` 的结构声明 host、密钥名、操作 schema、outbound 和 inbound。远端成功后的字段回写也走 external 命令。先用 fake 完成本地链路,再在测试环境做真实联调。
|
|
97
|
+
|
|
98
|
+
明确重复请求如何识别、哪些错误重试、回执晚到怎么办、取消后如何补偿。不要假设本地事务可以回滚已经提交给第三方的写入。
|
|
99
|
+
|
|
100
|
+
## 增加导入或导出
|
|
101
|
+
|
|
102
|
+
在客户实际需要的业务页调用客户端/生成契约,展示任务进行中、完成和失败。导入映射到用户可调用的命令,准备与该命令输入匹配的 CSV;不要生成直接写业务表的上传接口。
|
|
103
|
+
|
|
104
|
+
明确逐行还是整批原子模式、失败报告如何呈现、任务过期如何处理。任务提交成功不能立即标成导入/导出完成,worker 与下载时授权也是链路的一部分。完整方法、CSV 例子与协议见[业务页导入导出](transfers.md)。
|
|
105
|
+
|
|
106
|
+
## 由采购演示换成客户业务
|
|
107
|
+
|
|
108
|
+
空白模板不需要清理采购业务,直接从 `packages/domain/src` 新增自己的声明和页面;参考源码在 `docs/examples/purchase-admin`,不在运行入口中。下面的替换步骤只适用于采购模板。
|
|
109
|
+
|
|
110
|
+
建议先保留运行薄壳和一条可验证的演示链路,新增真实业务并接通页面,再移除不需要的演示引用。清理时沿领域导出、反应、审批、连接器、查询、任务、页面和 graph.labels 一起检查,避免残留仍在运行的自动任务。
|
|
111
|
+
|
|
112
|
+
组织模型仍从 `@yss123/cage-admin/domain` 导出。已执行迁移作为历史保留,新表/删表通过新迁移表达;需要保存旧数据时先制定迁移方案,不能只把整个 migrations 文件夹删除。
|
|
113
|
+
|
|
114
|
+
## 给编程工具的任务模板
|
|
115
|
+
|
|
116
|
+
```text
|
|
117
|
+
阅读当前项目 AGENTS.md,按 docs/development/skills/cage-development/SKILL.md 完成理解、澄清、能力查证、实现映射、编码和验收。
|
|
118
|
+
业务:……;角色与数据范围:……;状态与允许动作:……;审批/外部系统/资源占用:……。
|
|
119
|
+
先用业务语言说明对本次目标的理解,主动指出疑点,给出可行选项、影响与推荐,让我选择;已明确条件不重复询问,普通技术细节自行查证处理。
|
|
120
|
+
查现有实现和当前版本 API,写代码前简述已确定规则如何落到 Cage、改哪些模块、如何验收;能明确实现的部分直接推进,等待业务决定时继续独立工作。
|
|
121
|
+
遵守项目目录与中文注释规范,生成文件通过 cage gen 更新,按改动完成必要验证。
|
|
122
|
+
交付时说明用户如何体验、管理员需配置什么,以及通过/跳过/未执行的检查。
|
|
123
|
+
```
|
|
@@ -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
|
|