@yss123/cage-cli 0.3.0 → 0.3.2

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.
Files changed (388) hide show
  1. package/README.md +7 -3
  2. package/dist/approval-tree.d.ts +88 -0
  3. package/dist/approval-tree.js +18 -0
  4. package/dist/approval-tree.js.map +1 -0
  5. package/dist/capabilities.js +46 -31
  6. package/dist/capabilities.js.map +1 -1
  7. package/dist/graph-approvals.d.ts +11 -1
  8. package/dist/graph-approvals.js +18 -5
  9. package/dist/graph-approvals.js.map +1 -1
  10. package/dist/graph-relations.js +10 -8
  11. package/dist/graph-relations.js.map +1 -1
  12. package/dist/graph.js +2 -0
  13. package/dist/graph.js.map +1 -1
  14. package/dist/main.js +1 -1
  15. package/dist/main.js.map +1 -1
  16. package/dist/ontology.js +8 -5
  17. package/dist/ontology.js.map +1 -1
  18. package/dist/project-structure.js +2 -2
  19. package/dist/project-structure.js.map +1 -1
  20. package/dist/sync.d.ts +1 -1
  21. package/dist/sync.js +25 -108
  22. package/dist/sync.js.map +1 -1
  23. package/graph-ui/approval-flow.js +28 -8
  24. package/graph-ui/approval-parallel.js +110 -0
  25. package/graph-ui/approval-tree.js +17 -0
  26. package/graph-ui/business.css +26 -0
  27. package/graph-ui/business.js +30 -13
  28. package/graph-ui/graph-approvals.js +18 -5
  29. package/graph-ui/graph-relations.js +10 -8
  30. package/package.json +6 -6
  31. package/templates/app/.agents/skills/cage-development/SKILL.md +10 -0
  32. package/templates/app/AGENTS.md +39 -122
  33. package/templates/app/CLAUDE.md +6 -0
  34. package/templates/app/README.md +9 -8
  35. package/templates/app/apps/api/package.json +2 -2
  36. package/templates/app/apps/web/package.json +1 -1
  37. package/templates/app/apps/web/src/modules/approval/components/task-operation-dialog.tsx +61 -0
  38. package/templates/app/apps/web/src/modules/approval/hooks/use-approval-tasks.ts +6 -9
  39. package/templates/app/apps/web/src/modules/approval/pages/approval-tasks-page.tsx +81 -49
  40. package/templates/app/apps/web/src/modules/approval/pages/approval-tasks.css +18 -0
  41. package/templates/app/apps/web/src/modules/purchase/components/approval-history.tsx +39 -4
  42. package/templates/app/apps/web/src/modules/purchase/components/order-reviewers.tsx +38 -0
  43. package/templates/app/apps/web/src/modules/purchase/components/purchase-order-form.tsx +9 -2
  44. package/templates/app/apps/web/src/modules/purchase/pages/purchase-intelligence.css +2 -0
  45. package/templates/app/apps/web/src/modules/purchase/pages/purchase-order-detail-page.tsx +2 -0
  46. package/templates/app/apps/web/src/modules/purchase/pages/purchase-orders-page.tsx +2 -0
  47. package/templates/app/apps/web/src/shared/lib/error-message.ts +6 -1
  48. package/templates/app/apps/web/src/shared/ui/approval-member-picker.css +10 -0
  49. package/templates/app/apps/web/src/shared/ui/approval-member-picker.tsx +51 -0
  50. package/templates/app/cage.config.json +14 -0
  51. package/templates/app/db/migrations/0004_draft.sql +27 -0
  52. package/templates/app/docs/README.md +11 -0
  53. package/templates/app/docs/development/README.md +64 -0
  54. package/templates/app/docs/development/examples/note/note-detail-page.tsx +106 -0
  55. package/templates/app/docs/development/examples/note/note.ts +67 -0
  56. package/templates/app/docs/development/examples/note/notes-page.tsx +87 -0
  57. package/templates/{blank/docs/ai → app/docs/development/examples}/purchase-example.md +24 -10
  58. package/templates/{blank/docs/ai → app/docs/development/getting-started}/architecture.md +4 -4
  59. package/templates/app/docs/development/getting-started/first-feature.md +66 -0
  60. package/templates/{blank/docs/ai → app/docs/development/getting-started}/workflow.md +13 -12
  61. package/templates/app/docs/development/guides/approvals.md +270 -0
  62. package/templates/app/docs/development/guides/business-collaboration.md +63 -0
  63. package/templates/{blank/docs/ai → app/docs/development/guides}/files.md +5 -1
  64. package/templates/app/docs/{ai → development/guides}/intelligence.md +4 -4
  65. package/templates/{blank/docs/ai → app/docs/development/guides}/recipes.md +31 -11
  66. package/templates/app/docs/{ai → development/guides}/relations.md +2 -2
  67. package/templates/app/docs/{ai → development/guides}/routing.md +1 -1
  68. package/templates/{blank/docs/ai → app/docs/development/guides}/transfers.md +1 -1
  69. package/templates/{blank/docs/ai → app/docs/development/reference}/commenting.md +1 -1
  70. package/templates/app/docs/{ai → development/reference}/primitives.md +8 -62
  71. package/templates/app/docs/{ai → development/reference}/project-structure.md +2 -2
  72. package/templates/app/docs/development/skills/cage-development/SKILL.md +134 -0
  73. package/templates/{blank/docs/ai → app/docs/development/tools}/diagnostics.md +3 -3
  74. package/templates/{blank/docs/ai → app/docs/development/tools}/ontology-context.md +3 -3
  75. package/templates/app/docs/{ai → development/tools}/troubleshooting.md +7 -1
  76. package/templates/app/docs/errors/CAGE-AI-001.md +3 -3
  77. package/templates/app/docs/errors/CAGE-APPR-001.md +13 -10
  78. package/templates/app/docs/errors/CAGE-APPR-002.md +1 -1
  79. package/templates/app/docs/errors/CAGE-APPR-003.md +1 -1
  80. package/templates/app/docs/errors/CAGE-APPR-004.md +1 -1
  81. package/templates/app/docs/errors/CAGE-APPR-005.md +5 -5
  82. package/templates/app/docs/errors/CAGE-APPR-006.md +25 -10
  83. package/templates/app/docs/errors/CAGE-APPR-007.md +9 -7
  84. package/templates/app/docs/errors/CAGE-APPR-010.md +1 -1
  85. package/templates/app/docs/errors/CAGE-AUDIT-001.md +1 -1
  86. package/templates/app/docs/errors/CAGE-AUTH-001.md +1 -1
  87. package/templates/app/docs/errors/CAGE-BIZ-001.md +1 -1
  88. package/templates/app/docs/errors/CAGE-BIZ-002.md +1 -1
  89. package/templates/app/docs/errors/CAGE-BUDGET-001.md +1 -1
  90. package/templates/app/docs/errors/CAGE-BUDGET-002.md +1 -1
  91. package/templates/app/docs/errors/CAGE-BUDGET-003.md +1 -1
  92. package/templates/app/docs/errors/CAGE-CMD-002.md +1 -1
  93. package/templates/app/docs/errors/CAGE-CMD-003.md +1 -1
  94. package/templates/app/docs/errors/CAGE-CONN-001.md +1 -1
  95. package/templates/app/docs/errors/CAGE-CONN-002.md +1 -1
  96. package/templates/app/docs/errors/CAGE-CONN-003.md +1 -1
  97. package/templates/app/docs/errors/CAGE-CONN-004.md +1 -1
  98. package/templates/app/docs/errors/CAGE-CONN-005.md +1 -1
  99. package/templates/app/docs/errors/CAGE-CONN-006.md +1 -1
  100. package/templates/app/docs/errors/CAGE-CONN-007.md +1 -1
  101. package/templates/app/docs/errors/CAGE-CONN-008.md +1 -1
  102. package/templates/app/docs/errors/CAGE-CONN-009.md +1 -1
  103. package/templates/app/docs/errors/CAGE-CONN-010.md +1 -1
  104. package/templates/app/docs/errors/CAGE-CONN-011.md +1 -1
  105. package/templates/app/docs/errors/CAGE-CONN-012.md +1 -1
  106. package/templates/app/docs/errors/CAGE-CONN-013.md +1 -1
  107. package/templates/app/docs/errors/CAGE-CONN-014.md +1 -1
  108. package/templates/app/docs/errors/CAGE-CONN-015.md +1 -1
  109. package/templates/app/docs/errors/CAGE-CREATE-001.md +2 -2
  110. package/templates/app/docs/errors/CAGE-DECL-001.md +1 -1
  111. package/templates/app/docs/errors/CAGE-DECL-002.md +1 -1
  112. package/templates/app/docs/errors/CAGE-DECL-003.md +1 -1
  113. package/templates/app/docs/errors/CAGE-DECL-004.md +1 -1
  114. package/templates/app/docs/errors/CAGE-DEP-001.md +1 -1
  115. package/templates/app/docs/errors/CAGE-DEP-002.md +1 -1
  116. package/templates/app/docs/errors/CAGE-DEP-003.md +1 -1
  117. package/templates/app/docs/errors/CAGE-DEP-004.md +1 -1
  118. package/templates/app/docs/errors/CAGE-DEP-005.md +1 -1
  119. package/templates/app/docs/errors/CAGE-DIAG-001.md +1 -1
  120. package/templates/app/docs/errors/CAGE-DLQ-001.md +1 -1
  121. package/templates/app/docs/errors/CAGE-ENV-001.md +1 -1
  122. package/templates/app/docs/errors/CAGE-ENV-002.md +1 -1
  123. package/templates/app/docs/errors/CAGE-ENV-003.md +1 -1
  124. package/templates/app/docs/errors/CAGE-EVENT-001.md +2 -2
  125. package/templates/app/docs/errors/CAGE-EVENT-002.md +1 -1
  126. package/templates/app/docs/errors/CAGE-FIELD-001.md +1 -1
  127. package/templates/app/docs/errors/CAGE-FIELD-002.md +1 -1
  128. package/templates/app/docs/errors/CAGE-FIELD-003.md +1 -1
  129. package/templates/app/docs/errors/CAGE-FIELD-004.md +1 -1
  130. package/templates/app/docs/errors/CAGE-FILE-001.md +1 -1
  131. package/templates/app/docs/errors/CAGE-GEN-001.md +1 -1
  132. package/templates/app/docs/errors/CAGE-GEN-002.md +1 -1
  133. package/templates/app/docs/errors/CAGE-GEN-003.md +1 -1
  134. package/templates/app/docs/errors/CAGE-GRANT-001.md +1 -1
  135. package/templates/app/docs/errors/CAGE-GRANT-002.md +1 -1
  136. package/templates/app/docs/errors/CAGE-GRANT-003.md +1 -1
  137. package/templates/app/docs/errors/CAGE-IMPACT-001.md +1 -1
  138. package/templates/app/docs/errors/CAGE-IMPACT-002.md +1 -1
  139. package/templates/app/docs/errors/CAGE-INIT-001.md +1 -1
  140. package/templates/app/docs/errors/CAGE-INIT-002.md +1 -1
  141. package/templates/app/docs/errors/CAGE-INIT-003.md +1 -1
  142. package/templates/app/docs/errors/CAGE-INIT-004.md +1 -1
  143. package/templates/app/docs/errors/CAGE-INIT-005.md +1 -1
  144. package/templates/app/docs/errors/CAGE-JOB-001.md +1 -1
  145. package/templates/app/docs/errors/CAGE-JOB-002.md +1 -1
  146. package/templates/app/docs/errors/CAGE-JOB-003.md +1 -1
  147. package/templates/app/docs/errors/CAGE-LINT-001.md +1 -1
  148. package/templates/app/docs/errors/CAGE-MIG-001.md +1 -1
  149. package/templates/app/docs/errors/CAGE-MIG-002.md +1 -1
  150. package/templates/app/docs/errors/CAGE-MIG-005.md +1 -1
  151. package/templates/app/docs/errors/CAGE-NAME-001.md +1 -1
  152. package/templates/app/docs/errors/CAGE-NAME-002.md +1 -1
  153. package/templates/app/docs/errors/CAGE-NAME-003.md +1 -1
  154. package/templates/app/docs/errors/CAGE-NAME-004.md +1 -1
  155. package/templates/app/docs/errors/CAGE-NAME-005.md +1 -1
  156. package/templates/app/docs/errors/CAGE-NAME-006.md +1 -1
  157. package/templates/app/docs/errors/CAGE-ORG-001.md +1 -1
  158. package/templates/app/docs/errors/CAGE-PAIR-002.md +1 -1
  159. package/templates/app/docs/errors/CAGE-QUERY-001.md +1 -1
  160. package/templates/app/docs/errors/CAGE-QUERY-002.md +1 -1
  161. package/templates/app/docs/errors/CAGE-QUERY-003.md +1 -1
  162. package/templates/app/docs/errors/CAGE-REACT-001.md +1 -1
  163. package/templates/app/docs/errors/CAGE-REACT-002.md +1 -1
  164. package/templates/app/docs/errors/CAGE-REACT-003.md +1 -1
  165. package/templates/app/docs/errors/CAGE-READS-001.md +1 -1
  166. package/templates/app/docs/errors/CAGE-REG-001.md +2 -2
  167. package/templates/app/docs/errors/CAGE-REG-002.md +1 -1
  168. package/templates/app/docs/errors/CAGE-REG-003.md +1 -1
  169. package/templates/app/docs/errors/CAGE-REL-001.md +1 -1
  170. package/templates/app/docs/errors/CAGE-ROUTE-001.md +1 -1
  171. package/templates/app/docs/errors/CAGE-SCOPE-001.md +1 -1
  172. package/templates/app/docs/errors/CAGE-SCOPE-002.md +1 -1
  173. package/templates/app/docs/errors/CAGE-SECRET-001.md +1 -1
  174. package/templates/app/docs/errors/CAGE-SECRET-002.md +1 -1
  175. package/templates/app/docs/errors/CAGE-SENS-001.md +1 -1
  176. package/templates/app/docs/errors/CAGE-SQL-001.md +1 -1
  177. package/templates/app/docs/errors/CAGE-SQL-002.md +1 -1
  178. package/templates/app/docs/errors/CAGE-STATE-001.md +1 -1
  179. package/templates/app/docs/errors/CAGE-STATE-002.md +1 -1
  180. package/templates/app/docs/errors/CAGE-STATE-003.md +1 -1
  181. package/templates/app/docs/errors/CAGE-STATE-004.md +1 -1
  182. package/templates/app/docs/errors/CAGE-STATE-005.md +1 -1
  183. package/templates/app/docs/errors/CAGE-STATE-010.md +1 -1
  184. package/templates/app/docs/errors/CAGE-STATE-011.md +1 -1
  185. package/templates/app/docs/errors/CAGE-STRUCT-001.md +4 -4
  186. package/templates/app/docs/errors/CAGE-STRUCT-002.md +3 -3
  187. package/templates/app/docs/errors/CAGE-SYNC-001.md +4 -4
  188. package/templates/app/docs/errors/CAGE-TEST-001.md +1 -1
  189. package/templates/app/docs/errors/CAGE-TEST-002.md +1 -1
  190. package/templates/app/docs/errors/CAGE-TEST-003.md +1 -1
  191. package/templates/app/docs/errors/CAGE-UNSAFE-001.md +1 -1
  192. package/templates/app/docs/errors/CAGE-UPGRADE-001.md +1 -1
  193. package/templates/app/docs/errors/CAGE-WORKER-001.md +1 -1
  194. package/templates/app/docs/errors/CAGE-WORKER-002.md +1 -1
  195. package/templates/app/docs/errors/CAGE-WORKER-003.md +1 -1
  196. package/templates/app/docs/errors/README.md +3 -3
  197. package/templates/app/docs/errors/runtime.md +1 -1
  198. package/templates/app/package.json +3 -3
  199. package/templates/app/packages/contracts/package.json +1 -1
  200. package/templates/app/packages/contracts/src/aggregates/approval-member/index.ts +70 -0
  201. package/templates/app/packages/contracts/src/aggregates/purchase-order/index.ts +10 -2
  202. package/templates/app/packages/contracts/src/index.ts +9 -0
  203. package/templates/app/packages/domain/package.json +5 -5
  204. package/templates/app/packages/domain/src/modules/purchase/approval-members.ts +54 -0
  205. package/templates/app/packages/domain/src/modules/purchase/approvals.ts +19 -8
  206. package/templates/app/packages/domain/src/modules/purchase/index.ts +2 -1
  207. package/templates/app/packages/domain/src/modules/purchase/intelligence.test.ts +169 -7
  208. package/templates/app/packages/domain/src/modules/purchase/purchase-order.ts +56 -5
  209. package/templates/blank/.agents/skills/cage-development/SKILL.md +10 -0
  210. package/templates/blank/AGENTS.md +39 -122
  211. package/templates/blank/CLAUDE.md +6 -0
  212. package/templates/blank/README.md +3 -3
  213. package/templates/blank/apps/api/package.json +1 -1
  214. package/templates/blank/apps/web/package.json +1 -1
  215. package/templates/blank/docs/README.md +11 -0
  216. package/templates/blank/docs/development/README.md +64 -0
  217. package/templates/blank/docs/development/examples/note/note-detail-page.tsx +106 -0
  218. package/templates/blank/docs/development/examples/note/note.ts +67 -0
  219. package/templates/blank/docs/development/examples/note/notes-page.tsx +87 -0
  220. package/templates/{app/docs/ai → blank/docs/development/examples}/purchase-example.md +24 -10
  221. package/templates/{app/docs/ai → blank/docs/development/getting-started}/architecture.md +4 -4
  222. package/templates/blank/docs/development/getting-started/first-feature.md +66 -0
  223. package/templates/{app/docs/ai → blank/docs/development/getting-started}/workflow.md +13 -12
  224. package/templates/blank/docs/development/guides/approvals.md +270 -0
  225. package/templates/blank/docs/development/guides/business-collaboration.md +63 -0
  226. package/templates/{app/docs/ai → blank/docs/development/guides}/files.md +5 -1
  227. package/templates/blank/docs/{ai → development/guides}/intelligence.md +4 -4
  228. package/templates/{app/docs/ai → blank/docs/development/guides}/recipes.md +31 -11
  229. package/templates/blank/docs/{ai → development/guides}/relations.md +2 -2
  230. package/templates/blank/docs/{ai → development/guides}/routing.md +1 -1
  231. package/templates/{app/docs/ai → blank/docs/development/guides}/transfers.md +1 -1
  232. package/templates/{app/docs/ai → blank/docs/development/reference}/commenting.md +1 -1
  233. package/templates/blank/docs/{ai → development/reference}/primitives.md +8 -62
  234. package/templates/blank/docs/{ai → development/reference}/project-structure.md +2 -2
  235. package/templates/blank/docs/development/skills/cage-development/SKILL.md +134 -0
  236. package/templates/{app/docs/ai → blank/docs/development/tools}/diagnostics.md +3 -3
  237. package/templates/{app/docs/ai → blank/docs/development/tools}/ontology-context.md +3 -3
  238. package/templates/blank/docs/{ai → development/tools}/troubleshooting.md +7 -1
  239. package/templates/blank/docs/errors/CAGE-AI-001.md +3 -3
  240. package/templates/blank/docs/errors/CAGE-APPR-001.md +13 -10
  241. package/templates/blank/docs/errors/CAGE-APPR-002.md +1 -1
  242. package/templates/blank/docs/errors/CAGE-APPR-003.md +1 -1
  243. package/templates/blank/docs/errors/CAGE-APPR-004.md +1 -1
  244. package/templates/blank/docs/errors/CAGE-APPR-005.md +5 -5
  245. package/templates/blank/docs/errors/CAGE-APPR-006.md +25 -10
  246. package/templates/blank/docs/errors/CAGE-APPR-007.md +9 -7
  247. package/templates/blank/docs/errors/CAGE-APPR-010.md +1 -1
  248. package/templates/blank/docs/errors/CAGE-AUDIT-001.md +1 -1
  249. package/templates/blank/docs/errors/CAGE-AUTH-001.md +1 -1
  250. package/templates/blank/docs/errors/CAGE-BIZ-001.md +1 -1
  251. package/templates/blank/docs/errors/CAGE-BIZ-002.md +1 -1
  252. package/templates/blank/docs/errors/CAGE-BUDGET-001.md +1 -1
  253. package/templates/blank/docs/errors/CAGE-BUDGET-002.md +1 -1
  254. package/templates/blank/docs/errors/CAGE-BUDGET-003.md +1 -1
  255. package/templates/blank/docs/errors/CAGE-CMD-002.md +1 -1
  256. package/templates/blank/docs/errors/CAGE-CMD-003.md +1 -1
  257. package/templates/blank/docs/errors/CAGE-CONN-001.md +1 -1
  258. package/templates/blank/docs/errors/CAGE-CONN-002.md +1 -1
  259. package/templates/blank/docs/errors/CAGE-CONN-003.md +1 -1
  260. package/templates/blank/docs/errors/CAGE-CONN-004.md +1 -1
  261. package/templates/blank/docs/errors/CAGE-CONN-005.md +1 -1
  262. package/templates/blank/docs/errors/CAGE-CONN-006.md +1 -1
  263. package/templates/blank/docs/errors/CAGE-CONN-007.md +1 -1
  264. package/templates/blank/docs/errors/CAGE-CONN-008.md +1 -1
  265. package/templates/blank/docs/errors/CAGE-CONN-009.md +1 -1
  266. package/templates/blank/docs/errors/CAGE-CONN-010.md +1 -1
  267. package/templates/blank/docs/errors/CAGE-CONN-011.md +1 -1
  268. package/templates/blank/docs/errors/CAGE-CONN-012.md +1 -1
  269. package/templates/blank/docs/errors/CAGE-CONN-013.md +1 -1
  270. package/templates/blank/docs/errors/CAGE-CONN-014.md +1 -1
  271. package/templates/blank/docs/errors/CAGE-CONN-015.md +1 -1
  272. package/templates/blank/docs/errors/CAGE-CREATE-001.md +2 -2
  273. package/templates/blank/docs/errors/CAGE-DECL-001.md +1 -1
  274. package/templates/blank/docs/errors/CAGE-DECL-002.md +1 -1
  275. package/templates/blank/docs/errors/CAGE-DECL-003.md +1 -1
  276. package/templates/blank/docs/errors/CAGE-DECL-004.md +1 -1
  277. package/templates/blank/docs/errors/CAGE-DEP-001.md +1 -1
  278. package/templates/blank/docs/errors/CAGE-DEP-002.md +1 -1
  279. package/templates/blank/docs/errors/CAGE-DEP-003.md +1 -1
  280. package/templates/blank/docs/errors/CAGE-DEP-004.md +1 -1
  281. package/templates/blank/docs/errors/CAGE-DEP-005.md +1 -1
  282. package/templates/blank/docs/errors/CAGE-DIAG-001.md +1 -1
  283. package/templates/blank/docs/errors/CAGE-DLQ-001.md +1 -1
  284. package/templates/blank/docs/errors/CAGE-ENV-001.md +1 -1
  285. package/templates/blank/docs/errors/CAGE-ENV-002.md +1 -1
  286. package/templates/blank/docs/errors/CAGE-ENV-003.md +1 -1
  287. package/templates/blank/docs/errors/CAGE-EVENT-001.md +2 -2
  288. package/templates/blank/docs/errors/CAGE-EVENT-002.md +1 -1
  289. package/templates/blank/docs/errors/CAGE-FIELD-001.md +1 -1
  290. package/templates/blank/docs/errors/CAGE-FIELD-002.md +1 -1
  291. package/templates/blank/docs/errors/CAGE-FIELD-003.md +1 -1
  292. package/templates/blank/docs/errors/CAGE-FIELD-004.md +1 -1
  293. package/templates/blank/docs/errors/CAGE-FILE-001.md +1 -1
  294. package/templates/blank/docs/errors/CAGE-GEN-001.md +1 -1
  295. package/templates/blank/docs/errors/CAGE-GEN-002.md +1 -1
  296. package/templates/blank/docs/errors/CAGE-GEN-003.md +1 -1
  297. package/templates/blank/docs/errors/CAGE-GRANT-001.md +1 -1
  298. package/templates/blank/docs/errors/CAGE-GRANT-002.md +1 -1
  299. package/templates/blank/docs/errors/CAGE-GRANT-003.md +1 -1
  300. package/templates/blank/docs/errors/CAGE-IMPACT-001.md +1 -1
  301. package/templates/blank/docs/errors/CAGE-IMPACT-002.md +1 -1
  302. package/templates/blank/docs/errors/CAGE-INIT-001.md +1 -1
  303. package/templates/blank/docs/errors/CAGE-INIT-002.md +1 -1
  304. package/templates/blank/docs/errors/CAGE-INIT-003.md +1 -1
  305. package/templates/blank/docs/errors/CAGE-INIT-004.md +1 -1
  306. package/templates/blank/docs/errors/CAGE-INIT-005.md +1 -1
  307. package/templates/blank/docs/errors/CAGE-JOB-001.md +1 -1
  308. package/templates/blank/docs/errors/CAGE-JOB-002.md +1 -1
  309. package/templates/blank/docs/errors/CAGE-JOB-003.md +1 -1
  310. package/templates/blank/docs/errors/CAGE-LINT-001.md +1 -1
  311. package/templates/blank/docs/errors/CAGE-MIG-001.md +1 -1
  312. package/templates/blank/docs/errors/CAGE-MIG-002.md +1 -1
  313. package/templates/blank/docs/errors/CAGE-MIG-005.md +1 -1
  314. package/templates/blank/docs/errors/CAGE-NAME-001.md +1 -1
  315. package/templates/blank/docs/errors/CAGE-NAME-002.md +1 -1
  316. package/templates/blank/docs/errors/CAGE-NAME-003.md +1 -1
  317. package/templates/blank/docs/errors/CAGE-NAME-004.md +1 -1
  318. package/templates/blank/docs/errors/CAGE-NAME-005.md +1 -1
  319. package/templates/blank/docs/errors/CAGE-NAME-006.md +1 -1
  320. package/templates/blank/docs/errors/CAGE-ORG-001.md +1 -1
  321. package/templates/blank/docs/errors/CAGE-PAIR-002.md +1 -1
  322. package/templates/blank/docs/errors/CAGE-QUERY-001.md +1 -1
  323. package/templates/blank/docs/errors/CAGE-QUERY-002.md +1 -1
  324. package/templates/blank/docs/errors/CAGE-QUERY-003.md +1 -1
  325. package/templates/blank/docs/errors/CAGE-REACT-001.md +1 -1
  326. package/templates/blank/docs/errors/CAGE-REACT-002.md +1 -1
  327. package/templates/blank/docs/errors/CAGE-REACT-003.md +1 -1
  328. package/templates/blank/docs/errors/CAGE-READS-001.md +1 -1
  329. package/templates/blank/docs/errors/CAGE-REG-001.md +2 -2
  330. package/templates/blank/docs/errors/CAGE-REG-002.md +1 -1
  331. package/templates/blank/docs/errors/CAGE-REG-003.md +1 -1
  332. package/templates/blank/docs/errors/CAGE-REL-001.md +1 -1
  333. package/templates/blank/docs/errors/CAGE-ROUTE-001.md +1 -1
  334. package/templates/blank/docs/errors/CAGE-SCOPE-001.md +1 -1
  335. package/templates/blank/docs/errors/CAGE-SCOPE-002.md +1 -1
  336. package/templates/blank/docs/errors/CAGE-SECRET-001.md +1 -1
  337. package/templates/blank/docs/errors/CAGE-SECRET-002.md +1 -1
  338. package/templates/blank/docs/errors/CAGE-SENS-001.md +1 -1
  339. package/templates/blank/docs/errors/CAGE-SQL-001.md +1 -1
  340. package/templates/blank/docs/errors/CAGE-SQL-002.md +1 -1
  341. package/templates/blank/docs/errors/CAGE-STATE-001.md +1 -1
  342. package/templates/blank/docs/errors/CAGE-STATE-002.md +1 -1
  343. package/templates/blank/docs/errors/CAGE-STATE-003.md +1 -1
  344. package/templates/blank/docs/errors/CAGE-STATE-004.md +1 -1
  345. package/templates/blank/docs/errors/CAGE-STATE-005.md +1 -1
  346. package/templates/blank/docs/errors/CAGE-STATE-010.md +1 -1
  347. package/templates/blank/docs/errors/CAGE-STATE-011.md +1 -1
  348. package/templates/blank/docs/errors/CAGE-STRUCT-001.md +4 -4
  349. package/templates/blank/docs/errors/CAGE-STRUCT-002.md +3 -3
  350. package/templates/blank/docs/errors/CAGE-SYNC-001.md +4 -4
  351. package/templates/blank/docs/errors/CAGE-TEST-001.md +1 -1
  352. package/templates/blank/docs/errors/CAGE-TEST-002.md +1 -1
  353. package/templates/blank/docs/errors/CAGE-TEST-003.md +1 -1
  354. package/templates/blank/docs/errors/CAGE-UNSAFE-001.md +1 -1
  355. package/templates/blank/docs/errors/CAGE-UPGRADE-001.md +1 -1
  356. package/templates/blank/docs/errors/CAGE-WORKER-001.md +1 -1
  357. package/templates/blank/docs/errors/CAGE-WORKER-002.md +1 -1
  358. package/templates/blank/docs/errors/CAGE-WORKER-003.md +1 -1
  359. package/templates/blank/docs/errors/README.md +3 -3
  360. package/templates/blank/docs/errors/runtime.md +1 -1
  361. package/templates/blank/docs/examples/purchase-admin/README.md +1 -1
  362. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/approval/components/task-operation-dialog.tsx +61 -0
  363. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/approval/hooks/use-approval-tasks.ts +6 -9
  364. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/approval/pages/approval-tasks-page.tsx +81 -49
  365. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/approval/pages/approval-tasks.css +18 -0
  366. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/purchase/components/approval-history.tsx +39 -4
  367. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/purchase/components/order-reviewers.tsx +38 -0
  368. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/purchase/components/purchase-order-form.tsx +9 -2
  369. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/purchase/pages/purchase-intelligence.css +2 -0
  370. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/purchase/pages/purchase-order-detail-page.tsx +2 -0
  371. package/templates/blank/docs/examples/purchase-admin/apps/web/src/modules/purchase/pages/purchase-orders-page.tsx +2 -0
  372. package/templates/blank/docs/examples/purchase-admin/apps/web/src/shared/lib/error-message.ts +6 -1
  373. package/templates/blank/docs/examples/purchase-admin/apps/web/src/shared/ui/approval-member-picker.css +10 -0
  374. package/templates/blank/docs/examples/purchase-admin/apps/web/src/shared/ui/approval-member-picker.tsx +51 -0
  375. package/templates/blank/docs/examples/purchase-admin/cage.config.json +14 -0
  376. package/templates/blank/docs/examples/purchase-admin/packages/contracts/src/aggregates/approval-member/index.ts +70 -0
  377. package/templates/blank/docs/examples/purchase-admin/packages/contracts/src/aggregates/purchase-order/index.ts +10 -2
  378. package/templates/blank/docs/examples/purchase-admin/packages/contracts/src/index.ts +9 -0
  379. package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/approval-members.ts +54 -0
  380. package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/approvals.ts +19 -8
  381. package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/index.ts +2 -1
  382. package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/intelligence.test.ts +169 -7
  383. package/templates/blank/docs/examples/purchase-admin/packages/domain/src/modules/purchase/purchase-order.ts +56 -5
  384. package/templates/blank/package.json +3 -3
  385. package/templates/blank/packages/contracts/package.json +1 -1
  386. package/templates/blank/packages/domain/package.json +5 -5
  387. package/templates/app/docs/ai/README.md +0 -98
  388. package/templates/blank/docs/ai/README.md +0 -98
@@ -2,7 +2,7 @@
2
2
 
3
3
  这是 create-cage-app 的空白业务项目。真实运行的 domain 仅包含用户、部门和角色组织模型;从 packages/domain/src 新建客户自己的业务,再从 index.ts 导出。框架通过 @yss123/cage-* 依赖提供。
4
4
 
5
- 先读 [业务开发指南](docs/ai/README.md)、[任务配方](docs/ai/recipes.md) 和 [错误码册](docs/errors/README.md)。[采购范例参考源码](docs/examples/purchase-admin/README.md) 只用于学习,未注册到应用;导读中的采购路径在 docs/examples/purchase-admin 下查找。普通业务路径仍相对项目根目录。
5
+ 先读 [业务开发指南](docs/development/README.md)、[任务配方](docs/development/guides/recipes.md) 和 [错误码册](docs/errors/README.md)。[采购范例参考源码](docs/examples/purchase-admin/README.md) 只用于学习,未注册到应用;导读中的采购路径在 docs/examples/purchase-admin 下查找。普通业务路径仍相对项目根目录。
6
6
 
7
7
  ## 项目自己的业务约定
8
8
 
@@ -10,127 +10,44 @@
10
10
 
11
11
  本节位于托管区之外,cage sync 会保留。下面的托管区提供框架工作方法。
12
12
 
13
- <!-- cage:begin v0.3.0 -->
13
+ <!-- cage:begin v0.3.2 -->
14
14
  ## Cage 业务开发约定(框架托管)
15
15
 
16
- ### 先读,再按需求改业务
17
-
18
- 本项目由 create-cage-app 创建。框架来自 `@yss123/cage-*` 依赖,业务写在本项目;不需要克隆框架仓库,也不要复制框架内部实现。
19
-
20
- 先读项目说明指定的学习资料,默认入口为 `docs/ai/README.md`。第一次读 `architecture.md`、`project-structure.md` 和 `primitives.md`;具体任务读 `recipes.md`,采购全链路读 `purchase-example.md`,错误查 `docs/errors/README.md` 和 `docs/ai/troubleshooting.md`。资料相对该学习目录,项目说明可指定源码仓库中的规范资料位置。
21
-
22
- ### 详细中文注释(每次开发必须遵守)
23
-
24
- 所有新增和维护的手写源码都必须写详细中文注释,先读学习目录中的 `commenting.md`(独立项目为 `docs/ai/commenting.md`)。注释是交付内容,不能以“代码自解释”或“保持简洁”为由省略。
25
-
26
- - 每个文件开头说明模块职责、谁调用它、主要调用链和责任边界;纯导出入口也说明如何组合模块。
27
- - 导出函数、类、组件、hooks、接口和业务声明使用 JSDoc,写清用途、参数含义、返回结果、主要步骤、前置条件、失败行为和副作用;复杂内部函数同样说明。参数类型已表达的语法无需重复,业务单位、空值、默认行为与约束必须解释。
28
- - 领域代码说明字段和状态的业务意义、命令调用身份与权限/范围、reads 依赖、事件用途、事务与异步边界、幂等/重试及资源释放;只写实际声明和实现已有的保证。
29
- - 页面说明 URL/查询参数、数据来源、临时状态、加载/空态/失败/无权限、提交后的刷新、会话与订阅清理;复杂分支、计算、顺序、并发和缓存规则在附近解释原因与过程。
30
- - 测试说明场景、前置条件、动作、断言和所防止的回归;脚本说明输入、读写路径、执行顺序、外部副作用与退出条件。注释不含密钥、凭据或个人数据。
31
- - 注释同时回答“做什么、为什么、如何完成、有哪些边界”,不能只有一句标题,也不能机械逐行翻译、凑字数或批量粘贴空泛模板。代码变更时同步更新注释,交付前逐文件核对。
32
- - 生成契约的注释由生成器维护,不手改生成物;已执行/已发布迁移不能改写。仅补注释时不得顺便重构或改变逻辑、接口、配置值和运行文案。
33
-
34
- ### 原生 AI 能力入口
35
-
36
- 遇到以下需求,先读 `docs/ai/intelligence.md`,用 `pnpm exec cage capabilities "关键词" --format json` 核对当前安装版本的公开 API,再检查本项目 domain 导出和页面接入。关键词可直接使用下表需求名称;未命中时缩短关键词或查公开符号,不能据此断言能力不存在。
37
-
38
- | 需求 | 框架入口与应用职责 |
39
- | --- | --- |
40
- | AI审批 / 智能审批 | 现有 `step` 使用 `kind: 'ai'`,支持 pass 通过、return 退回修改、manual 转人工;应用声明策略、结论命令、自动执行角色及接管人 |
41
- | 业务助理 / 本体助理 | 导出 `ai({ models, assistant })`;框架提供执行循环、按领域声明生成的工具、会话、偏好记忆和 HTTP;应用配置授权及界面 |
42
- | 页面上下文 / 随页助理 | `useAssistant(client.ai, page)` 配合 `useAiPageContext` / `AiPageContext`;应用上报页面、对象、选中项和草稿,服务端重读并校验业务事实 |
43
- | 模型管理 / Responses | `managedModel` 接入 Admin 动态配置,支持 Chat Completions / Responses;应用配置部署加密密钥并显式授权管理者 |
44
- | 性格 / 流式输出 | Admin 管理性格,SDK 提供选择、增量文字与执行进度;应用实现悬浮窗、Markdown 和确认卡片 |
45
- | 上下文预算 | `ai({ context: ... })` 的配置形状见 `AiContextOptions`;框架按预算选择完整工具或发现模式,历史和本体按需读取 |
46
-
47
- 前端只使用客户端、协议与契约;后端循环、通用工具和记忆使用框架实现。页面快照和性格不授予权限。分别核对**框架支持**(公开导出)、**项目已启用**(domain 导出、迁移、模型、权限、worker、SDK)和**实际验证通过**(真实角色与模型联调);空白模板的参考代码不表示已启用。具体接入顺序和验收步骤见该指南,不必将整份指南塞入每次任务上下文。
48
-
49
- ### 业务代码放在哪里
50
-
51
- | 位置 | 职责 |
52
- | --- | --- |
53
- | `packages/domain/src/modules/<业务>` | 同业务聚合、状态、命令、事件、审批、查询、任务;模块 index.ts 公开导出 |
54
- | `packages/domain/src/workflows`、`integrations` | 跨模块反应 / 第三方协议与映射;不堆到全局 reactions.ts、queries.ts |
55
- | `packages/domain/src/index.ts` | 统一导出全部业务及组织模型;没导出的声明不会注册 |
56
- | `packages/contracts/src/aggregates/<聚合>`、`queries` | 生成协议;根 index.ts 提供 @app/contracts 公共入口,只用 cage gen 更新 |
57
- | `apps/api/src` | API/worker 薄启动入口,普通业务不手写 HTTP 路由 |
58
- | `apps/web/src/app` | 会话、URL 路由、布局、模块组合;main.tsx 只挂载和装配 Provider |
59
- | `apps/web/src/modules/<业务>` | 页面、表单、专用 hooks/API/样式;从模块 index.ts 暴露页面 |
60
- | `apps/web/src/shared` | 跨模块复用且不绑定业务的 UI、hooks、纯辅助函数 |
61
- | `db/migrations` | 审查过的结构迁移,作用于已配置的数据库 |
62
- | `cage.config.json` | 项目路径、检查配置、graph.labels 中文图谱名称 |
63
- | `.env` | 本机真实连接和密钥;不提交、不输出完整内容 |
64
-
65
- 新增业务不得继续平铺在 src 根目录。前端模块只依赖自己和 shared,由 app 通过公开入口组合;shared 不反向依赖业务。领域模块间确有读取依赖时走目标模块 index.ts;跨模块反应写 workflows。小模块不创建空层级,已有独立职责再拆文件。完整命名、目录树和示例见 `docs/ai/project-structure.md`。新模板启用 `structure: modular`,check/verify 检查目录和导入边界,遇到 CAGE-STRUCT 错误按职责修正。
66
-
67
- ### 实现一项需求的顺序
68
-
69
- 1. 先运行 `pnpm exec cage context "需求关键词"`;按需 `graph search` 查候选、`graph inspect` 查完整节点、`graph path` 看关系路径。确认中文匹配入口后按源码位置阅读实现;候选和子图不是全部依赖,具体条件不能凭连线推断。完整用法见 `docs/ai/ontology-context.md`。从用户需求确定字段、状态/动作、角色/范围、约束与后续动作;能由业务声明表达的不改框架。
70
- 2. 已有业务含义变化时,修改前用 `pnpm exec cage snapshot save before-change` 保存不可覆盖的命名基线;或使用真实 Git 提交/独立本体图文件。
71
- 3. 先声明 aggregate/states/command/constraints/event,再写 handler、reaction/query/approval/connector,最后接业务页面。声明使用模块顶层 `export const`,从 domain 入口导出,跨文件导出名保持唯一。
72
- 4. 运行 `pnpm exec cage check` 和 `pnpm gen`,审查 contracts 和迁移草稿。按需运行 `pnpm exec cage impact --snapshot before-change`,补中文图谱名。
73
- 5. 页面使用生成方法并处理 code/domainCode;列表、详情等多页面注册到 React Router,Link/NavLink 导航,筛选/分页进入 URL。组件状态用于弹窗和表单等临时交互。新增能力由管理员授权。数据库结构变化审查后显式 `pnpm migrate`,dev 不代办迁移。
74
- 6. 按 `commenting.md` 逐文件检查详细中文注释与实现一致,再按改动运行必要验证;交付时说明体验步骤、授权配置、迁移、注释覆盖,以及通过/跳过/未执行项。
75
-
76
- ### 必守边界
77
-
78
- - 聚合定义对象字段、状态、范围字段与不变量;命令是业务写入口。handler 只计算业务变化和读取 reads 中的依赖,不直接操作数据库、网络或文件。
79
- - 对象关系统一放在 fields:ref 为外键,hasMany 为只读反查,manyToMany 自动生成中间表并随所属对象命令提交。前端用生成的 related 方法分页读取;不手写纯中间表聚合,不把单页结果当完整集合替换。完整例子见 docs/ai/relations.md。
80
- - command 的 input 使用 Zod;已有记录输入必须含 id。from/to 表达状态迁移;`to: null` 只适用于已有记录并保留状态,不能靠 handler 改 status 绕过状态机。
81
- - 写入、审计、版本、幂等和事务交给内核;不要在业务项目重建 repository、连接池或权限流水线。
82
- - 自定义查询声明 reads,二选一使用 sql/build,只读 `safe.*`;值参数化。不得拼接 SQL、查询基表绕过范围或硬编码密钥。
83
- - scope 描述范围字段,角色数据决定实际范围;`scope.none()` 不代表所有人可访问。`can/useCan` 只控制按钮,后端负责授权。
84
- - 前端从 `@app/contracts` 导入生成 API/类型,按需使用 `@yss123/cage-client`;不导入 domain、内核或数据库包。
85
- - 多页面业务必须有独立 URL,不用 useState/tab 模拟整页导航;详情从 URL 取 ID 并独立加载。前端路由集中在 app,页面从模块公开入口接入 Outlet。登录后保留原路径/query/hash,401 回登录,403 展示权限提示;/admin/ 使用普通链接进入独立系统管理。前端路由不替代后端授权。实现、SPA 部署回退和浏览器配方见 docs/ai/routing.md。
86
- - 跨聚合写入通过 reaction 调用命令。`tx: 'same'` 共同提交/回滚,默认 outbox 异步执行。资源 acquires/releases 是图规则标签,实际占用/释放仍由命令完成;离开持有状态要检查每条释放路径。
87
- - 批量调用同一命令使用 reactionEach,声明 maxItems、唯一排序字段 orderBy、items 和 map;稳定键排序后串行执行。步骤依赖用 order,同事件同事务分组不得混用有序/无序或重复顺序。保持同事务回滚边界,见 docs/ai/primitives.md。
88
- - 审批通过 approval + route 配置,结论是 process 命令;选中审批人不等于已具备能力、范围和额度。第三方 IO 通过连接器,回调验签后调用 external 命令。
89
- - job 的读取与调用必须列入 reads/calls。业务导入/导出放在需要的业务页面调用通用任务接口,202 只代表任务已接受;worker 必须运行。
90
- - 已部署事件只做兼容扩展;新增字段设为 optional,不兼容含义用新事件。已执行/已发布迁移不能改写,结构更新新增迁移。
91
- - 不手改生成物,不关闭门禁掩盖错误,不因方便自动授予生产角色新能力。unsafe 必须写明 reason/owner,不能替代普通业务声明。
92
- - 按前述详细中文注释规范完成文件、API、业务声明和关键流程说明;避免无业务价值的防御分支和静默兜底。维护脚本用 TypeScript,不新增 .mjs。
93
-
94
- ### 最小命令形状
95
-
96
- ```ts
97
- // 片段:Order 为已导出的聚合,OrderSubmitted 为事件,业务校验按需求添加。
98
- /**
99
- * 将草稿订单提交审批:只有 draft 可进入 pending_approval。
100
- * 入口使用 Order.submit 能力,真实授权、范围、状态和版本由内核检查;声明本身不自动授予权限。
101
- * handler 返回草稿供后续校验和持久化,OrderSubmitted 随命令事务登记,后续由已配置消费者处理。
102
- * 失败不会提交这次业务变更;事件已登记也不代表后续审批已经完成。
103
- */
104
- export const submitOrder = command(Order, {
105
- name: 'submit',
106
- from: 'draft',
107
- to: 'pending_approval',
108
- emits: [OrderSubmitted],
109
- handler: (draft) => draft,
110
- });
111
- ```
112
-
113
- 完整可添加的普通管理对象见 `docs/ai/primitives.md` 的 Note;采购模板的审批、资源、第三方示例在 `packages/domain/src`,空白模板的参考源码在 `docs/examples/purchase-admin`。先读本项目 AGENTS.md 中的模板说明,区分运行代码与参考资料。API 以当前包公开导出和生成契约为准,不发明不存在的配置和方法。
114
-
115
- ### 启动、验证与排错
116
-
117
- 在项目根目录执行:首次 `pnpm install`,复制并编辑 .env.example,仅提供已有库管理员连接后 `pnpm exec cage init`;再 `pnpm build:app`、`pnpm gen`,审查后 `pnpm migrate`;用 `pnpm exec cage bootstrap --credentials-file .cage/admin-credentials.json` 显式初始化组织,最后 `pnpm dev`。已有配置不能覆盖,凭据文件必须是新受限文件且父目录存在。
118
-
119
- init 只准备账号/schema/授权并填写三个连接,不创建数据库;APP/READ/MIGRATE 指向同一个库。已有集群账号复用原密码,日常启动不用管理员。普通项目不新增 Docker 生命周期命令。
120
-
121
- API 日常启动不初始化组织、不输出管理员密码;生产缺少合格 Cookie 密钥会拒绝启动。bootstrap 不自动授予业务能力。`/healthz` 只表示存活,`/readyz` 检查必要依赖。首阶段 API 与 worker 同版本部署,查看实际注册指纹和消费者心跳。
122
-
123
- - `pnpm exec cage graph`:浏览器图谱,默认端口 15418,以终端为准。
124
- - `pnpm exec cage context command:对象.命令 --format json --out .cage/context.json`:按完整 key 取精简上下文;默认 Markdown,可用 --depth/--limit 调整范围。CLI 每次重新抽取;Web“复制 AI 上下文”使用当前页面快照,改代码后先刷新图谱。
125
- - `graph inspect/path` 有歧义时复制候选完整 key;path 默认沿箭头,--direction both 的逆向遍历不表示执行方向。报告中的测试/前端文件是候选,须核对;context 与图谱查询不覆盖当前图或命名快照。
126
- - `pnpm exec cage capabilities 关键词 --format json`:查当前安装版本公开签名;`cage doctor`:区分注册、生成、构建、迁移、授权与实际进程证据,unknown 不能当作通过。`cage timeline/explain` 关联实际异步证据与解释授权,参数和权限见 docs/ai/diagnostics.md。
127
- - 生成方法支持 signal/timeoutMs/idempotencyKey 请求选项。底层 CageResult 与 mutation 行为有区别:useCageCommand 失败抛 CageCommandError,成功才返回业务数据。订阅 client.subscribe 在退出、401、切换账号时取消查询并清除应用缓存。
128
- - `pnpm exec cage gen --check`:生成一致性;`pnpm exec cage sync --check`:本托管区一致性。
129
- - `pnpm exec cage test --only project`:业务测试;`pnpm verify`:类型、依赖、lint、图规则、生成、托管区、预算和测试。
130
- - `pnpm exec cage verify --skip-tests` 表示不完整门禁;派生测试跳过不能当作通过。测试连接只用独立测试集群。
131
- - 重要业务改动验证成功路径及有风险的反例;文档或可逆的小改动不反复跑全量数据库测试。
132
- - 修改页面/导航后实际验收深链接、刷新、前进后退、登录回跳、无权限和 404;生产再查 SPA 回退。check/verify 不自动完成浏览器验收,未执行要明确报告。见 docs/ai/routing.md。
133
- - CLI 报错先看 code/at/reason/fix,再查错误码册;HTTP 错误查 runtime.md。异步失败先看 worker、同步记录和死信,修复后重放,不能直接 SQL 改状态。
134
-
135
- 框架托管区由 cage sync 更新;项目独有的业务规则写在标记之外,避免升级覆盖。
16
+ ### 学习与任务入口
17
+
18
+ 本项目使用 `@yss123/cage-*`,业务写在本项目。先读项目说明指定的教材;独立项目默认入口是 `docs/development/README.md`。
19
+
20
+ 开始 Cage 业务开发或排错时,加载 `docs/development/skills/cage-development/SKILL.md`。它讲清运行模型、业务澄清、能力选择、实施与验收方法;首次学习配合 `docs/development/getting-started/first-feature.md`。已熟悉时只读受影响专题,普通样式/文案改动无需重走业务建模。
21
+
22
+ 支持 Agent Skills 的工具可发现 `.agents/skills/cage-development`;其他工具直接读取上述 Markdown,使用相同流程。教材随框架版本分发,均为本地文件,不需要额外服务、模型或索引。框架仓库范例使用项目说明指定的规范教材位置。
23
+
24
+ ### 框架执行什么
25
+
26
+ - 业务声明从 domain 总入口导出,框架据此构建注册表、能力、HTTP 接口、本体图、契约与迁移草稿;只有文件而未导出不会生效。
27
+ - 命令是业务写入口;handler 描述变化与显式 reads,内核处理授权、状态、范围、版本、事务、审计及 outbox。读侧通过生成契约或 query 的安全视图,外部 IO 通过连接器。
28
+ - 角色、能力、数据范围、调用身份与业务约束分别建模。前端 can() 只影响显示,新增能力不自动授给生产角色;审批选人不授予能力。
29
+ - 页面依赖生成契约及客户端。表单、弹窗等临时状态留在前端;正式业务数据和流程结果通过服务端读写。实际记录不能用模拟仓储或固定统计替代。
30
+
31
+ ### 实现与排错
32
+
33
+ 1. 阅读需求、文档和现有实现后,按 `docs/development/guides/business-collaboration.md` 主动提出疑点、可行选项、影响与推荐理由,让用户选择业务规则;沿用已明确的选择与授权,等待回答时推进独立部分,可选建议不阻塞已明确任务。再把确定的规则映射到聚合、命令、归属/范围、后续行为与验收,沿已有模块修改。具体选择看 `docs/development/guides/recipes.md`,目录归属看 `docs/development/reference/project-structure.md`。
34
+ 2. 不熟悉的 API 先按手册任务目录定位,用本地文件搜索查术语,再执行 `pnpm exec cage capabilities 符号 --format json` 核对当前版本签名;`cage context "业务关键词"` 定位当前应用。未命中不代表不支持,不发明方法或返回字段。
35
+ 3. 涉及已有领域含义变化,先 `pnpm exec cage snapshot save before-change` 保存本体基线,或使用真实 Git 基线。修改声明与导出,运行 check/gen,审查契约和迁移草稿。生成物不手改,已执行迁移不可改写。
36
+ 4. 页面使用真实契约,处理业务失败、版本冲突、会话与缓存;多页面使用独立 URL,列表筛选/分页进入查询参数。按 `docs/development/guides/routing.md` 验收深链接、刷新、登录回跳和无权限行为。
37
+ 5. 出错保留 code/at/reason/fix,查 `docs/errors/README.md` 与 `docs/development/tools/troubleshooting.md`;从真实调用逐层定位。不得放宽权限、删约束或关闭门禁来掩盖问题。
38
+
39
+ 遇到原生 AI、AI 审批或随页助理,先读 `docs/development/guides/intelligence.md`,核对已有能力及应用启用状态。审批、文件、关系、数据传输等专题由 Skill 按需引导,不重建框架已有运行时。
40
+
41
+ ### 代码与环境边界
42
+
43
+ - 所有手写代码遵守 `docs/development/reference/commenting.md`:文件职责与调用链、导出 API/字段、复杂分支的中文说明,写清做什么、为什么、怎样完成及实际边界;随代码更新。生成物注释从生成器维护。
44
+ - domain 按 modules/workflows/integrations/shared 组织,Web 按 app/modules/shared 组织。模块通过 index.ts 公开入口组合,前端不导入 domain、数据库或内核运行时;不关闭 modular 目录门禁。
45
+ - 新项目启动步骤见 `docs/development/getting-started/workflow.md`。使用已有 PostgreSQL 和项目 .env;init 准备账号,migrate 更新结构,bootstrap 显式初始化组织,dev 启动进程。普通业务不新增连接池或管理 Docker。
46
+ - 不输出或提交 .env、数据库密码、Cookie 密钥及初始化凭据。API 与 worker 使用一致的 domain,修改配置后按实际需要重启。
47
+
48
+ ### 完成依据
49
+
50
+ 验证与改动匹配。check/gen/typecheck/build 证明各自检查范围;业务读写还需独立读取结果,权限需直接请求验证,审批需待办与结论,文件需实际内容,异步需任务终态,页面需浏览器操作。
51
+
52
+ `pnpm verify` 汇总门禁;`verify --skip-tests` 不代表完整通过。诊断用 `cage doctor`、`timeline`、`explain`,具体前提见 `docs/development/tools/diagnostics.md`。交付分别说明通过、跳过、未执行及剩余配置;文档和可逆小改动不反复执行全量数据库回归。
136
53
  <!-- cage:end -->
@@ -0,0 +1,6 @@
1
+ <!-- 由 scripts/sync-agent-skill.ts 生成;共享同一套框架教材。 -->
2
+ # Cage 开发入口
3
+
4
+ 先读本目录 [AGENTS.md](AGENTS.md) 的项目说明和约定。
5
+ 进行 Cage 业务开发或排错时,阅读[框架开发 Skill](docs/development/skills/cage-development/SKILL.md),按任务选择章节并完成对应验证。
6
+ 这是框架维护的通用教学流程;具体业务以用户需求和项目约定为准。
@@ -2,7 +2,7 @@
2
2
 
3
3
  这是可直接开发业务的 TypeScript + React 项目,框架由 `@yss123/cage-*` npm 包提供。当前仅注册用户、部门、角色基础模型,保留登录、权限、系统管理、审计和异步任务;没有采购、库存、审批演示声明或演示业务表。
4
4
 
5
- 先读 [AGENTS.md](AGENTS.md) 和 [业务开发指南](docs/ai/README.md)。给 Codex 等工具描述自己的业务需求,按 [任务配方](docs/ai/recipes.md) 开发即可。[采购范例导读](docs/ai/purchase-example.md) 对应 `docs/examples/purchase-admin` 中的参考源码;这些文件不参与编译、领域注册或迁移。
5
+ 先读 [AGENTS.md](AGENTS.md) 和 [业务开发指南](docs/development/README.md)。给 Codex 等工具描述自己的业务需求,按 [任务配方](docs/development/guides/recipes.md) 开发即可。[采购范例导读](docs/development/examples/purchase-example.md) 对应 `docs/examples/purchase-admin` 中的参考源码;这些文件不参与编译、领域注册或迁移。
6
6
 
7
7
  ## 首次启动
8
8
 
@@ -17,11 +17,11 @@
17
17
 
18
18
  登录后可从“系统管理”配置用户、部门、角色与权限,再按业务需求添加模块。页面不会显示虚构业务数据。`.env` 中三个账号连接同一个数据库;日常运行不需要管理员账号。首次迁移应在为本项目准备的库中执行,接管历史业务表需要额外映射和迁移审查。
19
19
 
20
- 前端已配置 React Router:`/login` 登录、`/workspace` 工作台、`/directory/users` 成员列表、`/directory/users/:id` 成员详情,以及应用 404。成员页面只读取已有组织模型,需要 User.read,未增加演示业务或数据。详情可直达、刷新,登录后返回原地址。新增业务与生产 SPA 回退按[路由和浏览器验收指南](docs/ai/routing.md)执行;反向代理示例见 [deploy/nginx.conf](deploy/nginx.conf)。
20
+ 前端已配置 React Router:`/login` 登录、`/workspace` 工作台、`/directory/users` 成员列表、`/directory/users/:id` 成员详情,以及应用 404。成员页面只读取已有组织模型,需要 User.read,未增加演示业务或数据。详情可直达、刷新,登录后返回原地址。新增业务与生产 SPA 回退按[路由和浏览器验收指南](docs/development/guides/routing.md)执行;反向代理示例见 [deploy/nginx.conf](deploy/nginx.conf)。
21
21
 
22
22
  ## 添加第一个业务模块
23
23
 
24
- 先读[工程目录与代码组织](docs/ai/project-structure.md)。在 `packages/domain/src/modules/<业务>` 新建声明,通过模块 index.ts 从领域总入口导出;运行 `pnpm exec cage check`、`pnpm gen`,审查生成契约和迁移。在 `apps/web/src/modules/<业务>` 使用 `@app/contracts` 实现页面和表单,通过模块公开入口接入 `app` 导航;共享 UI/工具放 `shared`。最后按需迁移,并由管理员分配新增能力。完整的 Note 对象示例见 [原语与最小业务](docs/ai/primitives.md)。
24
+ 先读[工程目录与代码组织](docs/development/reference/project-structure.md)。在 `packages/domain/src/modules/<业务>` 新建声明,通过模块 index.ts 从领域总入口导出;运行 `pnpm exec cage check`、`pnpm gen`,审查生成契约和迁移。在 `apps/web/src/modules/<业务>` 使用 `@app/contracts` 实现页面和表单,通过模块公开入口接入 `app` 导航;共享 UI/工具放 `shared`。最后按需迁移,并由管理员分配新增能力。完整的 Note 对象示例见 [原语与最小业务](docs/development/reference/primitives.md)。
25
25
 
26
26
  `src/main.tsx` 只挂载 React 和全局 Provider,业务不平铺到 src 根目录。`cage.config.json` 已启用 `structure: modular`,check/verify 会检查目录和依赖边界;不要关闭检查或将所有业务移入 shared 来消除提示。
27
27
 
@@ -10,6 +10,6 @@
10
10
  },
11
11
  "dependencies": {
12
12
  "@app/domain": "workspace:*",
13
- "@yss123/cage-http": "0.3.0"
13
+ "@yss123/cage-http": "0.3.2"
14
14
  }
15
15
  }
@@ -10,7 +10,7 @@
10
10
  "dependencies": {
11
11
  "@app/contracts": "workspace:*",
12
12
  "@tanstack/react-query": "^5.87.1",
13
- "@yss123/cage-client": "0.3.0",
13
+ "@yss123/cage-client": "0.3.2",
14
14
  "react": "^19.1.1",
15
15
  "react-dom": "^19.1.1",
16
16
  "react-markdown": "^10.1.0",
@@ -0,0 +1,11 @@
1
+ # 本地框架文档
2
+
3
+ 从 [框架学习入口](development/README.md) 或 [Cage 开发 Skill](development/skills/cage-development/SKILL.md) 开始。
4
+
5
+ - `development/getting-started`:运行模型、完整入门课和开发步骤。
6
+ - `development/guides`:[业务澄清与共同设计](development/guides/business-collaboration.md)、能力选择与各专题接入。
7
+ - `development/reference`:原语与工程规范。
8
+ - `development/tools`:诊断、本体查询和排错。
9
+ - `development/examples`:教学源码与采购导读。
10
+ - `development/skills`:框架开发方法。
11
+ - [错误码册](errors/README.md):按实际错误定位原因。
@@ -0,0 +1,64 @@
1
+ # Cage 框架学习入口
2
+
3
+ 本目录是开发者与编程 Agent 共用的 Cage 应用开发教材,帮助你理解框架并把业务需求落实为可运行的应用。开发方法的统一入口是 [cage-development Skill](skills/cage-development/SKILL.md)。教材由框架维护,随脚手架分发;读取教材无需额外服务、模型或向量索引。
4
+
5
+ 模型接入、智能助理和 AI 审批属于框架的原生 AI 能力,具体接入见[原生 AI 专题](guides/intelligence.md)。
6
+
7
+ ## 按当前阶段阅读
8
+
9
+ | 你现在需要什么 | 从哪里开始 | 应得到什么 |
10
+ | --- | --- | --- |
11
+ | 第一次使用 Cage | [Skill 的运行模型](skills/cage-development/SKILL.md#先建立正确的运行模型) → [第一条完整业务链](getting-started/first-feature.md) | 理解声明、导出、生成、授权、契约与持久读写如何连接 |
12
+ | 用户描述或文档不清楚 | [业务澄清与共同设计](guides/business-collaboration.md) | 主动提出疑问、可行选项与建议,与用户选择业务规则,再落实到实现和验收 |
13
+ | 把需求转成设计 | [业务设计与能力选择](guides/recipes.md) | 确定聚合边界、命令、范围、关系和一致性要求 |
14
+ | 实现或修改功能 | [Skill 的实施流程](skills/cage-development/SKILL.md#4-沿一条真实链路实施再扩展) → [开发步骤](getting-started/workflow.md) | 沿实际调用链完成受影响的功能,并取得验证证据 |
15
+ | 已有功能不正常 | [排错方法](tools/troubleshooting.md) → [诊断工具](tools/diagnostics.md) / [错误码册](../errors/README.md) | 找到第一个失败边界,修复原因并复验 |
16
+ | 查询一个能力的用法 | 下方专题表,必要时本地搜索术语 | 找到当前任务的 API、接入前提与限制 |
17
+
18
+ 已经熟悉框架时不必每次重读课程。不要将所有专题一次加载,也不要把参考业务注册到客户应用。
19
+
20
+ ## 按资料用途查找
21
+
22
+ | 目录 | 内容与入口 |
23
+ | --- | --- |
24
+ | `getting-started/` 入门 | [运行模型](getting-started/architecture.md)、[完整入门课](getting-started/first-feature.md)、[开发步骤](getting-started/workflow.md) |
25
+ | `guides/` 专题指南 | [业务澄清](guides/business-collaboration.md)、[能力选择](guides/recipes.md)、[审批](guides/approvals.md)、[文件](guides/files.md)、[关系](guides/relations.md)、[路由](guides/routing.md)、[数据传输](guides/transfers.md)、[原生 AI](guides/intelligence.md) |
26
+ | `reference/` 参考规范 | [原语](reference/primitives.md)、[目录组织](reference/project-structure.md)、[中文注释](reference/commenting.md) |
27
+ | `tools/` 工具与排错 | [诊断](tools/diagnostics.md)、[本体上下文](tools/ontology-context.md)、[排错方法](tools/troubleshooting.md) |
28
+ | `examples/` 教学示例 | [便笺源码](examples/note/note.ts)、[采购导读](examples/purchase-example.md);按入门课与导读阅读,源码不自动注册 |
29
+ | `skills/` agent 开发流程 | [cage-development](skills/cage-development/SKILL.md),按任务加载上述教材 |
30
+
31
+ 查明确符号可用 `rg -n "术语或符号" docs/development docs/errors`,没有 rg 时使用 agent 的本地文件搜索。用 `pnpm exec cage capabilities 符号 --format json` 核对已安装版本公开签名,用 `pnpm exec cage context "业务关键词" --format json` 定位当前应用。候选命中不能代替阅读上下文,未命中也不能证明框架不支持。
32
+
33
+ ## 确认代码与资料的位置
34
+
35
+ 本指南的业务路径和命令默认相对应用根目录。应用的 `packages/domain/src` 定义业务,`packages/contracts/src` 是生成契约,`apps/web/src` 是界面,`apps/api/src` 是薄启动入口,`db/migrations` 保存审查过的迁移。
36
+
37
+ 空白模板只启用组织基础;`docs/examples/purchase-admin` 是离线采购参考源码,不参与注册、编译或迁移。采购模板直接在业务目录包含该范例。框架仓库的应用根目录是 `examples/purchase-admin`,规范教材位于仓库 `docs/development`,以应用 AGENTS.md 的说明为准。
38
+
39
+ `docs/development` 是框架教学内容的唯一手写来源;Skills 发现入口和模板副本由同步脚本生成。用户的业务约定保留在项目 AGENTS.md 的托管区外。教材分发检查只能证明资料存在且一致,模型是否学会需要框架维护者另做任务评估。
40
+
41
+ ## 当前实现边界
42
+
43
+ 以下区分可避免 agent 把方案中的愿景写成不存在的功能。
44
+
45
+ | 已有能力 | 使用边界 |
46
+ | --- | --- |
47
+ | 真实 PostgreSQL 连接、分账号、表结构迁移 | 连接已有数据库;`init` 不建库;不会自动识别并接管任意历史表 |
48
+ | 聚合/命令、能力与范围、掩码、审计、outbox、worker | handler 不做数据库/网络 IO;生产角色不会自动拿到新能力 |
49
+ | fields 中的 ref / hasMany / manyToMany | hasMany 为只读反查;manyToMany 自动中间表并随主对象事务写入,公开读取独立分页;双向集合不会自动互为镜像 |
50
+ | 本体抽取、中文检索/节点/路径/AI 上下文、图规则、图谱、生成、影响分析与门禁 | 上下文注明证据、源码和覆盖边界;名称与测试匹配是候选线索,不能证明任意 JS 正确;跳过用例仍需补足 |
51
+ | 有界集合 reactionEach、显式步骤 order | 稳定唯一键排序后串行调用目标命令;同事务整体回滚,异步链按 outbox 恢复;不是并行写表接口 |
52
+ | capabilities、doctor、timeline、explain、snapshot | 实际运行诊断需要受控会话与权限;未取得的证据为 unknown,授权解释不执行 handler |
53
+ | 代码审批路由与任务流转 | 顺序/条件、`parallel/branch` 结构化 AND 分支与汇合、any/all、字段选人、候选领取/释放、转办、单层委派归还、前后/并行必签和动作历史;候选池仅支持 any,追加票全部必签。条件和依赖随提交冻结,currentStep 仅为最小活动索引;尚无任意连线/循环/OR 网关、岗位/代理规则、通用恢复、任意 JS 选人或在途迁移,见[任务流转](guides/approvals.md) |
54
+ | 审批时限、站内提醒与催办 | 人工节点按实际开启时间计算自然分钟 SLA,worker 持久投递临期/超时提醒;申请人可按完整活动集合催办,同实例共享冷却,接收人可标已读。旧快照不自动获得政策;尚无工作日历、自动升级、抄送或邮件/短信通知 |
55
+ | 审批界面与 SDK | Admin/采购待办可领取、释放、归还受托任务并查看等待加签;采购另有协作名录选人器、转办/委派/三种加签及分页人工历史,view 查询参数保留视图。启用运营后通用 Admin 提供我的申请、催办和流程提醒;页面仍需应用启用、真实授权与浏览器验收。AI 助理目前只查询本人待办及提交决定,无人员管理写工具 |
56
+ | 原生 AI 审批与领域助理 | 现有 `step` 支持 `kind: 'ai'`;三态审核、自动工具、会话及偏好记忆可复用;需显式启用、授权并做模型质量验收 |
57
+ | Admin 模型与性格、助理 SDK | 动态模型连接和性格管理;Chat Completions / Responses 兼容性以实际服务为准;SDK 提供流式状态与页面快照,悬浮窗和 Markdown 由应用实现 |
58
+ | 连接器 fake、出站、入站验签、同步记录 | fake 不等于真实 ERP 联调,也不等于完整请求录制/回放平台 |
59
+ | 异步 CSV 导入/导出接口与客户端任务查询 | 界面由业务项目决定;导出结果不是可直接回导的命令输入模板 |
60
+ | 私有文件字段、流式分片上传、暂停与续传、范围下载 | 默认本地存储,提供对象存储适配接口;尚无内置 S3/OSS、签名直传、病毒扫描及文件共享 |
61
+ | 组织模型、系统管理界面 | 暂无移动部门(改上级)的完整支持、菜单配置页 |
62
+ | 库存锁采购范例 | 演示资源生命周期;不是仓库级并发库存扣减、退货或 ERP 撤销补偿系统 |
63
+
64
+ 文档与实现冲突时,以当前代码和检查结果为依据,指出冲突并修正文档;不要默默扩展公开 API。规划、代码存在、构建通过、真实联调通过是不同状态,交付时分别说明。
@@ -0,0 +1,106 @@
1
+ /**
2
+ * 入门课详情页,从 URL 的 id 独立读取便笺并通过契约修改或归档。
3
+ * 由 app 组合到 /notes/:id;query 缓存与退出清理由现有应用会话层管理。
4
+ * 每次写入传服务端记录版本;冲突后刷新而不自动覆盖,归档后仅展示结果。
5
+ */
6
+ import { useRef, useState } from 'react';
7
+ import { Link, useParams } from 'react-router-dom';
8
+ import { note, useNote } from '@app/contracts';
9
+ import { useCan } from '@yss123/cage-client';
10
+
11
+ /** 加载独立详情;标题草稿为 null 时显示服务端标题,空字符串仍表示用户正在编辑。 */
12
+ export function NoteDetailPage() {
13
+ const { id = '' } = useParams();
14
+ const query = useNote(id);
15
+ const canUpdate = useCan('Note.update');
16
+ const canArchive = useCan('Note.archive');
17
+ const [draft, setDraft] = useState<{ id: string; title: string } | null>(null);
18
+ const [error, setError] = useState('');
19
+ const [saving, setSaving] = useState(false);
20
+ const submitting = useRef(false);
21
+ const record = query.data;
22
+ const title = draft?.id === id ? draft.title : (record?.title ?? '');
23
+
24
+ /**
25
+ * 保存或归档当前记录,使用读取版本防止覆盖并发变更;失败保留草稿,成功后清除草稿并读取。
26
+ * 冲突刷新后要求用户核对再提交;按钮禁用与引用锁限制本页同时提交,不替代内核检查。
27
+ */
28
+ async function save(action: 'update' | 'archive') {
29
+ if (!record || submitting.current) return;
30
+ submitting.current = true;
31
+ setSaving(true);
32
+ setError('');
33
+ try {
34
+ const result =
35
+ action === 'update'
36
+ ? await note.update(record.id, { title }, record.version)
37
+ : await note.archive(record.id, record.version);
38
+ if (!result.ok) {
39
+ setError(
40
+ result.code === 'CONFLICT'
41
+ ? '记录已变化,请核对最新数据和当前草稿后再提交。'
42
+ : `操作失败:${result.code}`,
43
+ );
44
+ if (result.code === 'CONFLICT') await query.refetch();
45
+ return;
46
+ }
47
+ setDraft(null);
48
+ await query.refetch();
49
+ } catch {
50
+ setError('请求未完成,请重新读取记录确认结果。');
51
+ } finally {
52
+ submitting.current = false;
53
+ setSaving(false);
54
+ }
55
+ }
56
+
57
+ return (
58
+ <section>
59
+ <Link to="/notes">返回列表</Link>
60
+ {query.isPending && <p role="status">正在加载…</p>}
61
+ {query.isError && (
62
+ <p role="alert">
63
+ 无法读取记录:可能不存在、会话失效或不在可见范围。
64
+ <button onClick={() => void query.refetch()}>重试</button>
65
+ </p>
66
+ )}
67
+ {record && (
68
+ <>
69
+ <h1>{record.title}</h1>
70
+ <p>
71
+ 状态:{record.status};版本:{record.version}
72
+ </p>
73
+ {record.status === 'active' && (
74
+ <>
75
+ {canUpdate && (
76
+ <form
77
+ onSubmit={(event) => {
78
+ event.preventDefault();
79
+ void save('update');
80
+ }}
81
+ >
82
+ <label>
83
+ 标题
84
+ <input
85
+ value={title}
86
+ required
87
+ maxLength={120}
88
+ onChange={(event) => setDraft({ id, title: event.target.value })}
89
+ />
90
+ </label>
91
+ <button disabled={saving || !title.trim()}>保存</button>
92
+ </form>
93
+ )}
94
+ {canArchive && (
95
+ <button disabled={saving} onClick={() => void save('archive')}>
96
+ 归档
97
+ </button>
98
+ )}
99
+ </>
100
+ )}
101
+ </>
102
+ )}
103
+ {error && <p role="alert">{error}</p>}
104
+ </section>
105
+ );
106
+ }
@@ -0,0 +1,67 @@
1
+ /**
2
+ * 框架入门课的部门便笺声明,由学习者放入应用领域模块后从 domain 入口导出。
3
+ * 聚合维护标题、归属和状态;命令仅描述业务变化,实际权限、事务与持久化由内核执行。
4
+ * 本文件作为教材分发,不自动注册到空白应用;不存在文件、审批或外部 IO 副作用。
5
+ */
6
+ import { aggregate, command, ref, scope, states, text } from '@yss123/cage-kernel';
7
+ import { z } from 'zod';
8
+
9
+ /**
10
+ * 部门便笺以标题和生命周期为一致性边界,通过部门与创建人字段支持安全读取。
11
+ * 声明被 domain 导出后参与注册和生成;实际可见范围取决于角色授权,本声明不授予权限。
12
+ * 所有命令结果均须满足非空标题不变量,归档保留记录并关闭修改入口。
13
+ */
14
+ export const Note = aggregate('Note', {
15
+ description: '部门便笺',
16
+ fields: {
17
+ /** 标题最多 120 字符;命令先去除两端空白,不变量拒绝空白标题。 */
18
+ title: text(120),
19
+ /** 内核新建时按当前主体填充的部门,用于服务端范围过滤。 */
20
+ deptId: ref('Dept'),
21
+ /** 内核新建时记录的创建人,可用于本人范围;不接受客户端指定。 */
22
+ createdBy: ref('User'),
23
+ },
24
+ states: states('active', 'archived', { terminal: ['archived'] }),
25
+ scope: scope.deptSubtree('deptId'),
26
+ invariants: { titleNotBlank: (record) => record.title.trim().length > 0 },
27
+ });
28
+
29
+ /**
30
+ * 创建 active 便笺,输入只有去除两端空白后的标题,草稿直接作为业务结果返回。
31
+ * 内核填写归属并执行 Note.create 授权、审计及事务;空标题、无能力或不合格范围会拒绝写入。
32
+ * 不发布额外业务事件,也不接受客户端指定归属字段。
33
+ */
34
+ export const createNote = command(Note, {
35
+ name: 'create',
36
+ description: '创建便笺',
37
+ from: 'new',
38
+ to: 'active',
39
+ input: z.object({ title: z.string().trim().min(1).max(120) }),
40
+ handler: (draft) => draft,
41
+ });
42
+
43
+ /**
44
+ * 修改 active 便笺标题;id 用于内核按范围锁定记录,页面另传已读取的 expectedVersion。
45
+ * to: null 保留状态,返回值只包含标题变化;归档或版本冲突由内核拒绝,handler 不直接写库。
46
+ */
47
+ export const updateNote = command(Note, {
48
+ name: 'update',
49
+ description: '修改便笺标题',
50
+ from: 'active',
51
+ to: null,
52
+ input: z.object({ id: z.string().uuid(), title: z.string().trim().min(1).max(120) }),
53
+ handler: (_draft, input) => ({ title: input.title }),
54
+ });
55
+
56
+ /**
57
+ * 归档 active 便笺,输入沿用已有对象命令的默认 id,返回草稿以保留标题与归属。
58
+ * 内核检查 Note.archive、范围与版本,再设置 archived;已有归档记录的修改和重复归档会拒绝。
59
+ * 本动作不删除历史记录,不发布需 worker 处理的业务事件。
60
+ */
61
+ export const archiveNote = command(Note, {
62
+ name: 'archive',
63
+ description: '归档便笺',
64
+ from: 'active',
65
+ to: 'archived',
66
+ handler: (draft) => draft,
67
+ });
@@ -0,0 +1,87 @@
1
+ /**
2
+ * 入门课的便笺列表与创建页面,通过生成契约读写服务端记录,不维护本地业务仓储。
3
+ * 由 app 路由在已登录且具备 Note.read 的页面内挂载;服务端仍执行全部权限与范围判断。
4
+ * 表单状态只保留未提交标题,失败不清空;创建成功后重新查询列表,详情使用独立 URL。
5
+ */
6
+ import { useRef, useState, type FormEvent } from 'react';
7
+ import { Link } from 'react-router-dom';
8
+ import { note, useNoteList } from '@app/contracts';
9
+ import { useCan } from '@yss123/cage-client';
10
+
11
+ /** 显示当前主体可见的第一页便笺并提供创建入口;分页扩展应按路由规范放入 URL 参数。 */
12
+ export function NotesPage() {
13
+ const query = useNoteList();
14
+ const canCreate = useCan('Note.create');
15
+ const [title, setTitle] = useState('');
16
+ const [error, setError] = useState('');
17
+ const [saving, setSaving] = useState(false);
18
+ const submitting = useRef(false);
19
+
20
+ /**
21
+ * 提交一次创建,立即锁住重复点击;业务失败保留输入,成功后从安全接口重新读取。
22
+ * 此锁只限制当前页面的并发点击,不承诺跨刷新重试去重;业务需恢复同次请求时另保存幂等键。
23
+ */
24
+ async function create(event: FormEvent<HTMLFormElement>) {
25
+ event.preventDefault();
26
+ if (submitting.current) return;
27
+ submitting.current = true;
28
+ setSaving(true);
29
+ setError('');
30
+ try {
31
+ const result = await note.create({ title });
32
+ if (!result.ok) {
33
+ setError(`创建失败:${result.code}`);
34
+ return;
35
+ }
36
+ setTitle('');
37
+ await query.refetch();
38
+ } catch {
39
+ setError('请求未完成,请重新读取列表确认结果后再决定是否重试。');
40
+ } finally {
41
+ submitting.current = false;
42
+ setSaving(false);
43
+ }
44
+ }
45
+
46
+ return (
47
+ <section>
48
+ <h1>部门便笺</h1>
49
+ {canCreate && (
50
+ <form onSubmit={create}>
51
+ <label>
52
+ 标题
53
+ <input
54
+ value={title}
55
+ maxLength={120}
56
+ required
57
+ onChange={(event) => setTitle(event.target.value)}
58
+ />
59
+ </label>
60
+ <button disabled={saving || !title.trim()}>{saving ? '正在保存…' : '创建'}</button>
61
+ </form>
62
+ )}
63
+ {error && <p role="alert">{error}</p>}
64
+ {query.isPending && <p role="status">正在加载…</p>}
65
+ {query.isError && (
66
+ <p role="alert">
67
+ 读取失败,请检查会话和读取权限。<button onClick={() => void query.refetch()}>重试</button>
68
+ </p>
69
+ )}
70
+ {query.data && (
71
+ <>
72
+ <p>
73
+ 共 {query.data.total} 条,当前显示 {query.data.items.length} 条。
74
+ </p>
75
+ <ul>
76
+ {query.data.items.map((record) => (
77
+ <li key={record.id}>
78
+ <Link to={`/notes/${encodeURIComponent(record.id)}`}>{record.title}</Link>({record.status})
79
+ </li>
80
+ ))}
81
+ </ul>
82
+ {query.data.items.length === 0 && <p>当前可见范围内没有便笺。</p>}
83
+ </>
84
+ )}
85
+ </section>
86
+ );
87
+ }