@yss123/cage-cli 0.3.1 → 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 (324) hide show
  1. package/README.md +7 -3
  2. package/dist/capabilities.js +40 -40
  3. package/dist/capabilities.js.map +1 -1
  4. package/dist/main.js +1 -1
  5. package/dist/main.js.map +1 -1
  6. package/dist/project-structure.js +2 -2
  7. package/dist/project-structure.js.map +1 -1
  8. package/dist/sync.d.ts +1 -1
  9. package/dist/sync.js +25 -108
  10. package/dist/sync.js.map +1 -1
  11. package/package.json +6 -6
  12. package/templates/app/.agents/skills/cage-development/SKILL.md +10 -0
  13. package/templates/app/AGENTS.md +39 -122
  14. package/templates/app/CLAUDE.md +6 -0
  15. package/templates/app/README.md +4 -4
  16. package/templates/app/apps/api/package.json +2 -2
  17. package/templates/app/apps/web/package.json +1 -1
  18. package/templates/app/docs/README.md +11 -0
  19. package/templates/app/docs/development/README.md +64 -0
  20. package/templates/app/docs/development/examples/note/note-detail-page.tsx +106 -0
  21. package/templates/app/docs/development/examples/note/note.ts +67 -0
  22. package/templates/app/docs/development/examples/note/notes-page.tsx +87 -0
  23. package/templates/{blank/docs/ai → app/docs/development/examples}/purchase-example.md +5 -5
  24. package/templates/{blank/docs/ai → app/docs/development/getting-started}/architecture.md +4 -4
  25. package/templates/app/docs/development/getting-started/first-feature.md +66 -0
  26. package/templates/app/docs/{ai → development/getting-started}/workflow.md +13 -12
  27. package/templates/app/docs/{ai → development/guides}/approvals.md +16 -6
  28. package/templates/app/docs/development/guides/business-collaboration.md +63 -0
  29. package/templates/{blank/docs/ai → app/docs/development/guides}/files.md +5 -1
  30. package/templates/app/docs/{ai → development/guides}/intelligence.md +4 -4
  31. package/templates/app/docs/{ai → development/guides}/recipes.md +31 -11
  32. package/templates/app/docs/{ai → development/guides}/relations.md +2 -2
  33. package/templates/{blank/docs/ai → app/docs/development/guides}/routing.md +1 -1
  34. package/templates/app/docs/{ai → development/guides}/transfers.md +1 -1
  35. package/templates/{blank/docs/ai → app/docs/development/reference}/commenting.md +1 -1
  36. package/templates/app/docs/{ai → development/reference}/primitives.md +8 -62
  37. package/templates/app/docs/{ai → development/reference}/project-structure.md +2 -2
  38. package/templates/app/docs/development/skills/cage-development/SKILL.md +134 -0
  39. package/templates/{blank/docs/ai → app/docs/development/tools}/diagnostics.md +3 -3
  40. package/templates/{blank/docs/ai → app/docs/development/tools}/ontology-context.md +3 -3
  41. package/templates/app/docs/{ai → development/tools}/troubleshooting.md +7 -1
  42. package/templates/app/docs/errors/CAGE-AI-001.md +1 -1
  43. package/templates/app/docs/errors/CAGE-APPR-001.md +2 -2
  44. package/templates/app/docs/errors/CAGE-APPR-002.md +1 -1
  45. package/templates/app/docs/errors/CAGE-APPR-003.md +1 -1
  46. package/templates/app/docs/errors/CAGE-APPR-004.md +1 -1
  47. package/templates/app/docs/errors/CAGE-APPR-005.md +1 -1
  48. package/templates/app/docs/errors/CAGE-APPR-006.md +1 -1
  49. package/templates/app/docs/errors/CAGE-APPR-007.md +1 -1
  50. package/templates/app/docs/errors/CAGE-APPR-010.md +1 -1
  51. package/templates/app/docs/errors/CAGE-AUDIT-001.md +1 -1
  52. package/templates/app/docs/errors/CAGE-AUTH-001.md +1 -1
  53. package/templates/app/docs/errors/CAGE-BIZ-001.md +1 -1
  54. package/templates/app/docs/errors/CAGE-BIZ-002.md +1 -1
  55. package/templates/app/docs/errors/CAGE-BUDGET-001.md +1 -1
  56. package/templates/app/docs/errors/CAGE-BUDGET-002.md +1 -1
  57. package/templates/app/docs/errors/CAGE-BUDGET-003.md +1 -1
  58. package/templates/app/docs/errors/CAGE-CMD-002.md +1 -1
  59. package/templates/app/docs/errors/CAGE-CMD-003.md +1 -1
  60. package/templates/app/docs/errors/CAGE-CONN-001.md +1 -1
  61. package/templates/app/docs/errors/CAGE-CONN-002.md +1 -1
  62. package/templates/app/docs/errors/CAGE-CONN-003.md +1 -1
  63. package/templates/app/docs/errors/CAGE-CONN-004.md +1 -1
  64. package/templates/app/docs/errors/CAGE-CONN-005.md +1 -1
  65. package/templates/app/docs/errors/CAGE-CONN-006.md +1 -1
  66. package/templates/app/docs/errors/CAGE-CONN-007.md +1 -1
  67. package/templates/app/docs/errors/CAGE-CONN-008.md +1 -1
  68. package/templates/app/docs/errors/CAGE-CONN-009.md +1 -1
  69. package/templates/app/docs/errors/CAGE-CONN-010.md +1 -1
  70. package/templates/app/docs/errors/CAGE-CONN-011.md +1 -1
  71. package/templates/app/docs/errors/CAGE-CONN-012.md +1 -1
  72. package/templates/app/docs/errors/CAGE-CONN-013.md +1 -1
  73. package/templates/app/docs/errors/CAGE-CONN-014.md +1 -1
  74. package/templates/app/docs/errors/CAGE-CONN-015.md +1 -1
  75. package/templates/app/docs/errors/CAGE-CREATE-001.md +2 -2
  76. package/templates/app/docs/errors/CAGE-DECL-001.md +1 -1
  77. package/templates/app/docs/errors/CAGE-DECL-002.md +1 -1
  78. package/templates/app/docs/errors/CAGE-DECL-003.md +1 -1
  79. package/templates/app/docs/errors/CAGE-DECL-004.md +1 -1
  80. package/templates/app/docs/errors/CAGE-DEP-001.md +1 -1
  81. package/templates/app/docs/errors/CAGE-DEP-002.md +1 -1
  82. package/templates/app/docs/errors/CAGE-DEP-003.md +1 -1
  83. package/templates/app/docs/errors/CAGE-DEP-004.md +1 -1
  84. package/templates/app/docs/errors/CAGE-DEP-005.md +1 -1
  85. package/templates/app/docs/errors/CAGE-DIAG-001.md +1 -1
  86. package/templates/app/docs/errors/CAGE-DLQ-001.md +1 -1
  87. package/templates/app/docs/errors/CAGE-ENV-001.md +1 -1
  88. package/templates/app/docs/errors/CAGE-ENV-002.md +1 -1
  89. package/templates/app/docs/errors/CAGE-ENV-003.md +1 -1
  90. package/templates/app/docs/errors/CAGE-EVENT-001.md +1 -1
  91. package/templates/app/docs/errors/CAGE-EVENT-002.md +1 -1
  92. package/templates/app/docs/errors/CAGE-FIELD-001.md +1 -1
  93. package/templates/app/docs/errors/CAGE-FIELD-002.md +1 -1
  94. package/templates/app/docs/errors/CAGE-FIELD-003.md +1 -1
  95. package/templates/app/docs/errors/CAGE-FIELD-004.md +1 -1
  96. package/templates/app/docs/errors/CAGE-FILE-001.md +1 -1
  97. package/templates/app/docs/errors/CAGE-GEN-001.md +1 -1
  98. package/templates/app/docs/errors/CAGE-GEN-002.md +1 -1
  99. package/templates/app/docs/errors/CAGE-GEN-003.md +1 -1
  100. package/templates/app/docs/errors/CAGE-GRANT-001.md +1 -1
  101. package/templates/app/docs/errors/CAGE-GRANT-002.md +1 -1
  102. package/templates/app/docs/errors/CAGE-GRANT-003.md +1 -1
  103. package/templates/app/docs/errors/CAGE-IMPACT-001.md +1 -1
  104. package/templates/app/docs/errors/CAGE-IMPACT-002.md +1 -1
  105. package/templates/app/docs/errors/CAGE-INIT-001.md +1 -1
  106. package/templates/app/docs/errors/CAGE-INIT-002.md +1 -1
  107. package/templates/app/docs/errors/CAGE-INIT-003.md +1 -1
  108. package/templates/app/docs/errors/CAGE-INIT-004.md +1 -1
  109. package/templates/app/docs/errors/CAGE-INIT-005.md +1 -1
  110. package/templates/app/docs/errors/CAGE-JOB-001.md +1 -1
  111. package/templates/app/docs/errors/CAGE-JOB-002.md +1 -1
  112. package/templates/app/docs/errors/CAGE-JOB-003.md +1 -1
  113. package/templates/app/docs/errors/CAGE-LINT-001.md +1 -1
  114. package/templates/app/docs/errors/CAGE-MIG-001.md +1 -1
  115. package/templates/app/docs/errors/CAGE-MIG-002.md +1 -1
  116. package/templates/app/docs/errors/CAGE-MIG-005.md +1 -1
  117. package/templates/app/docs/errors/CAGE-NAME-001.md +1 -1
  118. package/templates/app/docs/errors/CAGE-NAME-002.md +1 -1
  119. package/templates/app/docs/errors/CAGE-NAME-003.md +1 -1
  120. package/templates/app/docs/errors/CAGE-NAME-004.md +1 -1
  121. package/templates/app/docs/errors/CAGE-NAME-005.md +1 -1
  122. package/templates/app/docs/errors/CAGE-NAME-006.md +1 -1
  123. package/templates/app/docs/errors/CAGE-ORG-001.md +1 -1
  124. package/templates/app/docs/errors/CAGE-PAIR-002.md +1 -1
  125. package/templates/app/docs/errors/CAGE-QUERY-001.md +1 -1
  126. package/templates/app/docs/errors/CAGE-QUERY-002.md +1 -1
  127. package/templates/app/docs/errors/CAGE-QUERY-003.md +1 -1
  128. package/templates/app/docs/errors/CAGE-REACT-001.md +1 -1
  129. package/templates/app/docs/errors/CAGE-REACT-002.md +1 -1
  130. package/templates/app/docs/errors/CAGE-REACT-003.md +1 -1
  131. package/templates/app/docs/errors/CAGE-READS-001.md +1 -1
  132. package/templates/app/docs/errors/CAGE-REG-001.md +1 -1
  133. package/templates/app/docs/errors/CAGE-REG-002.md +1 -1
  134. package/templates/app/docs/errors/CAGE-REG-003.md +1 -1
  135. package/templates/app/docs/errors/CAGE-REL-001.md +1 -1
  136. package/templates/app/docs/errors/CAGE-ROUTE-001.md +1 -1
  137. package/templates/app/docs/errors/CAGE-SCOPE-001.md +1 -1
  138. package/templates/app/docs/errors/CAGE-SCOPE-002.md +1 -1
  139. package/templates/app/docs/errors/CAGE-SECRET-001.md +1 -1
  140. package/templates/app/docs/errors/CAGE-SECRET-002.md +1 -1
  141. package/templates/app/docs/errors/CAGE-SENS-001.md +1 -1
  142. package/templates/app/docs/errors/CAGE-SQL-001.md +1 -1
  143. package/templates/app/docs/errors/CAGE-SQL-002.md +1 -1
  144. package/templates/app/docs/errors/CAGE-STATE-001.md +1 -1
  145. package/templates/app/docs/errors/CAGE-STATE-002.md +1 -1
  146. package/templates/app/docs/errors/CAGE-STATE-003.md +1 -1
  147. package/templates/app/docs/errors/CAGE-STATE-004.md +1 -1
  148. package/templates/app/docs/errors/CAGE-STATE-005.md +1 -1
  149. package/templates/app/docs/errors/CAGE-STATE-010.md +1 -1
  150. package/templates/app/docs/errors/CAGE-STATE-011.md +1 -1
  151. package/templates/app/docs/errors/CAGE-STRUCT-001.md +4 -4
  152. package/templates/app/docs/errors/CAGE-STRUCT-002.md +3 -3
  153. package/templates/app/docs/errors/CAGE-SYNC-001.md +4 -4
  154. package/templates/app/docs/errors/CAGE-TEST-001.md +1 -1
  155. package/templates/app/docs/errors/CAGE-TEST-002.md +1 -1
  156. package/templates/app/docs/errors/CAGE-TEST-003.md +1 -1
  157. package/templates/app/docs/errors/CAGE-UNSAFE-001.md +1 -1
  158. package/templates/app/docs/errors/CAGE-UPGRADE-001.md +1 -1
  159. package/templates/app/docs/errors/CAGE-WORKER-001.md +1 -1
  160. package/templates/app/docs/errors/CAGE-WORKER-002.md +1 -1
  161. package/templates/app/docs/errors/CAGE-WORKER-003.md +1 -1
  162. package/templates/app/docs/errors/README.md +1 -1
  163. package/templates/app/docs/errors/runtime.md +1 -1
  164. package/templates/app/package.json +3 -3
  165. package/templates/app/packages/contracts/package.json +1 -1
  166. package/templates/app/packages/domain/package.json +5 -5
  167. package/templates/blank/.agents/skills/cage-development/SKILL.md +10 -0
  168. package/templates/blank/AGENTS.md +39 -122
  169. package/templates/blank/CLAUDE.md +6 -0
  170. package/templates/blank/README.md +3 -3
  171. package/templates/blank/apps/api/package.json +1 -1
  172. package/templates/blank/apps/web/package.json +1 -1
  173. package/templates/blank/docs/README.md +11 -0
  174. package/templates/blank/docs/development/README.md +64 -0
  175. package/templates/blank/docs/development/examples/note/note-detail-page.tsx +106 -0
  176. package/templates/blank/docs/development/examples/note/note.ts +67 -0
  177. package/templates/blank/docs/development/examples/note/notes-page.tsx +87 -0
  178. package/templates/{app/docs/ai → blank/docs/development/examples}/purchase-example.md +5 -5
  179. package/templates/{app/docs/ai → blank/docs/development/getting-started}/architecture.md +4 -4
  180. package/templates/blank/docs/development/getting-started/first-feature.md +66 -0
  181. package/templates/blank/docs/{ai → development/getting-started}/workflow.md +13 -12
  182. package/templates/blank/docs/{ai → development/guides}/approvals.md +16 -6
  183. package/templates/blank/docs/development/guides/business-collaboration.md +63 -0
  184. package/templates/{app/docs/ai → blank/docs/development/guides}/files.md +5 -1
  185. package/templates/blank/docs/{ai → development/guides}/intelligence.md +4 -4
  186. package/templates/blank/docs/{ai → development/guides}/recipes.md +31 -11
  187. package/templates/blank/docs/{ai → development/guides}/relations.md +2 -2
  188. package/templates/{app/docs/ai → blank/docs/development/guides}/routing.md +1 -1
  189. package/templates/blank/docs/{ai → development/guides}/transfers.md +1 -1
  190. package/templates/{app/docs/ai → blank/docs/development/reference}/commenting.md +1 -1
  191. package/templates/blank/docs/{ai → development/reference}/primitives.md +8 -62
  192. package/templates/blank/docs/{ai → development/reference}/project-structure.md +2 -2
  193. package/templates/blank/docs/development/skills/cage-development/SKILL.md +134 -0
  194. package/templates/{app/docs/ai → blank/docs/development/tools}/diagnostics.md +3 -3
  195. package/templates/{app/docs/ai → blank/docs/development/tools}/ontology-context.md +3 -3
  196. package/templates/blank/docs/{ai → development/tools}/troubleshooting.md +7 -1
  197. package/templates/blank/docs/errors/CAGE-AI-001.md +1 -1
  198. package/templates/blank/docs/errors/CAGE-APPR-001.md +2 -2
  199. package/templates/blank/docs/errors/CAGE-APPR-002.md +1 -1
  200. package/templates/blank/docs/errors/CAGE-APPR-003.md +1 -1
  201. package/templates/blank/docs/errors/CAGE-APPR-004.md +1 -1
  202. package/templates/blank/docs/errors/CAGE-APPR-005.md +1 -1
  203. package/templates/blank/docs/errors/CAGE-APPR-006.md +1 -1
  204. package/templates/blank/docs/errors/CAGE-APPR-007.md +1 -1
  205. package/templates/blank/docs/errors/CAGE-APPR-010.md +1 -1
  206. package/templates/blank/docs/errors/CAGE-AUDIT-001.md +1 -1
  207. package/templates/blank/docs/errors/CAGE-AUTH-001.md +1 -1
  208. package/templates/blank/docs/errors/CAGE-BIZ-001.md +1 -1
  209. package/templates/blank/docs/errors/CAGE-BIZ-002.md +1 -1
  210. package/templates/blank/docs/errors/CAGE-BUDGET-001.md +1 -1
  211. package/templates/blank/docs/errors/CAGE-BUDGET-002.md +1 -1
  212. package/templates/blank/docs/errors/CAGE-BUDGET-003.md +1 -1
  213. package/templates/blank/docs/errors/CAGE-CMD-002.md +1 -1
  214. package/templates/blank/docs/errors/CAGE-CMD-003.md +1 -1
  215. package/templates/blank/docs/errors/CAGE-CONN-001.md +1 -1
  216. package/templates/blank/docs/errors/CAGE-CONN-002.md +1 -1
  217. package/templates/blank/docs/errors/CAGE-CONN-003.md +1 -1
  218. package/templates/blank/docs/errors/CAGE-CONN-004.md +1 -1
  219. package/templates/blank/docs/errors/CAGE-CONN-005.md +1 -1
  220. package/templates/blank/docs/errors/CAGE-CONN-006.md +1 -1
  221. package/templates/blank/docs/errors/CAGE-CONN-007.md +1 -1
  222. package/templates/blank/docs/errors/CAGE-CONN-008.md +1 -1
  223. package/templates/blank/docs/errors/CAGE-CONN-009.md +1 -1
  224. package/templates/blank/docs/errors/CAGE-CONN-010.md +1 -1
  225. package/templates/blank/docs/errors/CAGE-CONN-011.md +1 -1
  226. package/templates/blank/docs/errors/CAGE-CONN-012.md +1 -1
  227. package/templates/blank/docs/errors/CAGE-CONN-013.md +1 -1
  228. package/templates/blank/docs/errors/CAGE-CONN-014.md +1 -1
  229. package/templates/blank/docs/errors/CAGE-CONN-015.md +1 -1
  230. package/templates/blank/docs/errors/CAGE-CREATE-001.md +2 -2
  231. package/templates/blank/docs/errors/CAGE-DECL-001.md +1 -1
  232. package/templates/blank/docs/errors/CAGE-DECL-002.md +1 -1
  233. package/templates/blank/docs/errors/CAGE-DECL-003.md +1 -1
  234. package/templates/blank/docs/errors/CAGE-DECL-004.md +1 -1
  235. package/templates/blank/docs/errors/CAGE-DEP-001.md +1 -1
  236. package/templates/blank/docs/errors/CAGE-DEP-002.md +1 -1
  237. package/templates/blank/docs/errors/CAGE-DEP-003.md +1 -1
  238. package/templates/blank/docs/errors/CAGE-DEP-004.md +1 -1
  239. package/templates/blank/docs/errors/CAGE-DEP-005.md +1 -1
  240. package/templates/blank/docs/errors/CAGE-DIAG-001.md +1 -1
  241. package/templates/blank/docs/errors/CAGE-DLQ-001.md +1 -1
  242. package/templates/blank/docs/errors/CAGE-ENV-001.md +1 -1
  243. package/templates/blank/docs/errors/CAGE-ENV-002.md +1 -1
  244. package/templates/blank/docs/errors/CAGE-ENV-003.md +1 -1
  245. package/templates/blank/docs/errors/CAGE-EVENT-001.md +1 -1
  246. package/templates/blank/docs/errors/CAGE-EVENT-002.md +1 -1
  247. package/templates/blank/docs/errors/CAGE-FIELD-001.md +1 -1
  248. package/templates/blank/docs/errors/CAGE-FIELD-002.md +1 -1
  249. package/templates/blank/docs/errors/CAGE-FIELD-003.md +1 -1
  250. package/templates/blank/docs/errors/CAGE-FIELD-004.md +1 -1
  251. package/templates/blank/docs/errors/CAGE-FILE-001.md +1 -1
  252. package/templates/blank/docs/errors/CAGE-GEN-001.md +1 -1
  253. package/templates/blank/docs/errors/CAGE-GEN-002.md +1 -1
  254. package/templates/blank/docs/errors/CAGE-GEN-003.md +1 -1
  255. package/templates/blank/docs/errors/CAGE-GRANT-001.md +1 -1
  256. package/templates/blank/docs/errors/CAGE-GRANT-002.md +1 -1
  257. package/templates/blank/docs/errors/CAGE-GRANT-003.md +1 -1
  258. package/templates/blank/docs/errors/CAGE-IMPACT-001.md +1 -1
  259. package/templates/blank/docs/errors/CAGE-IMPACT-002.md +1 -1
  260. package/templates/blank/docs/errors/CAGE-INIT-001.md +1 -1
  261. package/templates/blank/docs/errors/CAGE-INIT-002.md +1 -1
  262. package/templates/blank/docs/errors/CAGE-INIT-003.md +1 -1
  263. package/templates/blank/docs/errors/CAGE-INIT-004.md +1 -1
  264. package/templates/blank/docs/errors/CAGE-INIT-005.md +1 -1
  265. package/templates/blank/docs/errors/CAGE-JOB-001.md +1 -1
  266. package/templates/blank/docs/errors/CAGE-JOB-002.md +1 -1
  267. package/templates/blank/docs/errors/CAGE-JOB-003.md +1 -1
  268. package/templates/blank/docs/errors/CAGE-LINT-001.md +1 -1
  269. package/templates/blank/docs/errors/CAGE-MIG-001.md +1 -1
  270. package/templates/blank/docs/errors/CAGE-MIG-002.md +1 -1
  271. package/templates/blank/docs/errors/CAGE-MIG-005.md +1 -1
  272. package/templates/blank/docs/errors/CAGE-NAME-001.md +1 -1
  273. package/templates/blank/docs/errors/CAGE-NAME-002.md +1 -1
  274. package/templates/blank/docs/errors/CAGE-NAME-003.md +1 -1
  275. package/templates/blank/docs/errors/CAGE-NAME-004.md +1 -1
  276. package/templates/blank/docs/errors/CAGE-NAME-005.md +1 -1
  277. package/templates/blank/docs/errors/CAGE-NAME-006.md +1 -1
  278. package/templates/blank/docs/errors/CAGE-ORG-001.md +1 -1
  279. package/templates/blank/docs/errors/CAGE-PAIR-002.md +1 -1
  280. package/templates/blank/docs/errors/CAGE-QUERY-001.md +1 -1
  281. package/templates/blank/docs/errors/CAGE-QUERY-002.md +1 -1
  282. package/templates/blank/docs/errors/CAGE-QUERY-003.md +1 -1
  283. package/templates/blank/docs/errors/CAGE-REACT-001.md +1 -1
  284. package/templates/blank/docs/errors/CAGE-REACT-002.md +1 -1
  285. package/templates/blank/docs/errors/CAGE-REACT-003.md +1 -1
  286. package/templates/blank/docs/errors/CAGE-READS-001.md +1 -1
  287. package/templates/blank/docs/errors/CAGE-REG-001.md +1 -1
  288. package/templates/blank/docs/errors/CAGE-REG-002.md +1 -1
  289. package/templates/blank/docs/errors/CAGE-REG-003.md +1 -1
  290. package/templates/blank/docs/errors/CAGE-REL-001.md +1 -1
  291. package/templates/blank/docs/errors/CAGE-ROUTE-001.md +1 -1
  292. package/templates/blank/docs/errors/CAGE-SCOPE-001.md +1 -1
  293. package/templates/blank/docs/errors/CAGE-SCOPE-002.md +1 -1
  294. package/templates/blank/docs/errors/CAGE-SECRET-001.md +1 -1
  295. package/templates/blank/docs/errors/CAGE-SECRET-002.md +1 -1
  296. package/templates/blank/docs/errors/CAGE-SENS-001.md +1 -1
  297. package/templates/blank/docs/errors/CAGE-SQL-001.md +1 -1
  298. package/templates/blank/docs/errors/CAGE-SQL-002.md +1 -1
  299. package/templates/blank/docs/errors/CAGE-STATE-001.md +1 -1
  300. package/templates/blank/docs/errors/CAGE-STATE-002.md +1 -1
  301. package/templates/blank/docs/errors/CAGE-STATE-003.md +1 -1
  302. package/templates/blank/docs/errors/CAGE-STATE-004.md +1 -1
  303. package/templates/blank/docs/errors/CAGE-STATE-005.md +1 -1
  304. package/templates/blank/docs/errors/CAGE-STATE-010.md +1 -1
  305. package/templates/blank/docs/errors/CAGE-STATE-011.md +1 -1
  306. package/templates/blank/docs/errors/CAGE-STRUCT-001.md +4 -4
  307. package/templates/blank/docs/errors/CAGE-STRUCT-002.md +3 -3
  308. package/templates/blank/docs/errors/CAGE-SYNC-001.md +4 -4
  309. package/templates/blank/docs/errors/CAGE-TEST-001.md +1 -1
  310. package/templates/blank/docs/errors/CAGE-TEST-002.md +1 -1
  311. package/templates/blank/docs/errors/CAGE-TEST-003.md +1 -1
  312. package/templates/blank/docs/errors/CAGE-UNSAFE-001.md +1 -1
  313. package/templates/blank/docs/errors/CAGE-UPGRADE-001.md +1 -1
  314. package/templates/blank/docs/errors/CAGE-WORKER-001.md +1 -1
  315. package/templates/blank/docs/errors/CAGE-WORKER-002.md +1 -1
  316. package/templates/blank/docs/errors/CAGE-WORKER-003.md +1 -1
  317. package/templates/blank/docs/errors/README.md +1 -1
  318. package/templates/blank/docs/errors/runtime.md +1 -1
  319. package/templates/blank/docs/examples/purchase-admin/README.md +1 -1
  320. package/templates/blank/package.json +3 -3
  321. package/templates/blank/packages/contracts/package.json +1 -1
  322. package/templates/blank/packages/domain/package.json +5 -5
  323. package/templates/app/docs/ai/README.md +0 -103
  324. package/templates/blank/docs/ai/README.md +0 -103
@@ -1,6 +1,6 @@
1
1
  # 标准采购范例:从声明到业务页面
2
2
 
3
- [返回学习入口](README.md) · [业务任务配方](recipes.md)
3
+ [返回学习入口](../README.md) · [业务任务配方](../guides/recipes.md)
4
4
 
5
5
  选择 `--template purchase` 创建的是可运行的采购应用,下面的路径相对应用根目录;选择 `--template blank` 时,同一份范例仅作为参考源码保存在 `docs/examples/purchase-admin`,下面路径相对该参考目录,它不参与当前应用的编译、注册或迁移。框架能力来自 npm 依赖。先沿一条真实链路读代码,再把需要的模式应用到自己的业务。
6
6
 
@@ -71,13 +71,13 @@ submit 返回成功只表示单据和事件已提交,不表示待办、ERP 或
71
71
 
72
72
  ## 首次体验所需业务配置
73
73
 
74
- 以下体验需要采购模板;空白模板不会出现采购页面和审批配置。先按[开发步骤](workflow.md)准备已有数据库并启动 API、worker、Web。首次管理员凭证按 API 提示获取,不把凭证写到仓库。以下是业务配置,不是需要写进框架内核的逻辑。
74
+ 以下体验需要采购模板;空白模板不会出现采购页面和审批配置。先按[开发步骤](../getting-started/workflow.md)准备已有数据库并启动 API、worker、Web。首次管理员凭证按 API 提示获取,不把凭证写到仓库。以下是业务配置,不是需要写进框架内核的逻辑。
75
75
 
76
76
  | 对象 | 配置要点 |
77
77
  | --- | --- |
78
78
  | 采购员 | 创建/查看/提交/取消采购单等所需能力,所属部门,以及采购单数据范围;配置专业复核需 `PurchaseOrder.setReviewers` 和 `ApprovalMember.read` |
79
79
  | 智能助理使用人 | 显式授予 `Sys.ai.use`;编辑用途还需 `PurchaseOrder.explainPurpose` |
80
- | 模型管理者 | `Sys.ai.models.manage`;在 `/admin/#/models` 配置并启用 `main`,部署主密钥见[智能能力指南](intelligence.md) |
80
+ | 模型管理者 | `Sys.ai.models.manage`;在 `/admin/#/models` 配置并启用 `main`,部署主密钥见[智能能力指南](../guides/intelligence.md) |
81
81
  | 助理性格管理者 | `Sys.ai.personalities.manage`;在 `/admin/#/personalities` 编辑预设、自定义性格、设置默认并试聊 |
82
82
  | AI 预审角色 | 创建 code 为 `purchase_ai_reviewer` 的角色,授予 `PurchaseOrder.read/returnForChanges` 及覆盖申请范围的数据权限;本例 AI 仅预审,不执行最终 approve |
83
83
  | 经理 | `PurchaseOrder.read/approve/reject/returnForChanges`,适当数据范围,`approve` 的 `ceiling` 额度参数 |
@@ -110,11 +110,11 @@ submit 返回成功只表示单据和事件已提交,不表示待办、ERP 或
110
110
 
111
111
  `apps/web` 中对字段和按钮的中文名称属于业务文案。图谱名称来自 `cage.config.json` 的 `graph.labels`,比如 `command:PurchaseOrder.submit` 对应“提交审批”。替换业务时别忘了更新这些名称,不要改英文能力标识来做翻译。
112
112
 
113
- 导出按钮是调用通用异步接口的一个例子;框架不规定所有业务都要放相同的按钮。导入、导出、任务列表与错误报告应按客户页面需要接入,参考[开发步骤](workflow.md)中的客户端方法。
113
+ 导出按钮是调用通用异步接口的一个例子;框架不规定所有业务都要放相同的按钮。导入、导出、任务列表与错误报告应按客户页面需要接入,参考[开发步骤](../getting-started/workflow.md)中的客户端方法。
114
114
 
115
115
  ## 把示例改成自己的业务
116
116
 
117
- 先按[目录规范](project-structure.md)新增自己的领域模块和前端模块,完成一条完整链路,再逐步移除不需要的采购导出、路由、反应、连接器和页面引用。`@app/domain`、`@app/contracts` 是应用内包名,可以保留;npm 框架包也不需要重命名。
117
+ 先按[目录规范](../reference/project-structure.md)新增自己的领域模块和前端模块,完成一条完整链路,再逐步移除不需要的采购导出、路由、反应、连接器和页面引用。`@app/domain`、`@app/contracts` 是应用内包名,可以保留;npm 框架包也不需要重命名。
118
118
 
119
119
  若数据库尚未投入使用,可为新应用审查和规划初始结构;只要迁移已执行或已发布,就不能通过覆盖 `0001_init.sql` 来假装采购表从未存在。用新迁移表达后续变更,并明确已有数据处理方式。
120
120
 
@@ -1,6 +1,6 @@
1
1
  # 架构与执行模型
2
2
 
3
- [返回学习入口](README.md) · [下一篇:原语](primitives.md)
3
+ [返回学习入口](../README.md) · [下一篇:原语](../reference/primitives.md)
4
4
 
5
5
  ## 业务声明是一份可执行规格
6
6
 
@@ -34,7 +34,7 @@ domain/index.ts 导出的声明
34
34
 
35
35
  一个采购单可以有明细列表,也可以引用库存等其他聚合。跨聚合写入要调用对方的命令,通过反应表达关系,不能拿到对方数据库表直接更新。
36
36
 
37
- 对象关联统一写在 fields:ref 为本表外键,hasMany 依据目标外键反查,manyToMany 自动生成中间表。多对多链接属于来源对象的命令事务,但不授权修改目标内容;公开关联通过两侧安全视图分页读取。完整模式见[对象关系](relations.md)。
37
+ 对象关联统一写在 fields:ref 为本表外键,hasMany 依据目标外键反查,manyToMany 自动生成中间表。多对多链接属于来源对象的命令事务,但不授权修改目标内容;公开关联通过两侧安全视图分页读取。完整模式见[对象关系](../guides/relations.md)。
38
38
 
39
39
  ## 一次写入的完整路径
40
40
 
@@ -69,7 +69,7 @@ worker → 消费 outbox → 异步反应 / 审批 / 连接器
69
69
 
70
70
  资源标签 `acquires: 'inventory.lock'`、`releases: 'inventory.lock'` 为图规则提供证据。它们不会自动加锁或释放,真正效果来自 `acquireLock/releaseLock` 命令。
71
71
 
72
- 有界批量步骤可用 `reactionEach`:声明目标命令、最大项数、唯一排序键和映射,按稳定顺序串行调用。`order` 表达同一事件的步骤依赖,同事务链仍整体回滚。具体声明见[原语指南](primitives.md#有界集合与步骤顺序)。
72
+ 有界批量步骤可用 `reactionEach`:声明目标命令、最大项数、唯一排序键和映射,按稳定顺序串行调用。`order` 表达同一事件的步骤依赖,同事务链仍整体回滚。具体声明见[原语指南](../reference/primitives.md#有界集合与步骤顺序)。
73
73
 
74
74
  出站分成外部执行与短事务回写两个阶段。框架先领取本地执行租约,用 `${tenantId}:${declaredKey}` 作为远端幂等键,可靠保存回执后再在短事务调用成功命令;回写失败可复用已保存回执。远端必须实际支持幂等,框架不能承诺任意外部系统恰好一次。不可安全重试的写入结果未知时隔离并要求核对,不能把超时当作远端未执行。
75
75
 
@@ -141,7 +141,7 @@ APP、READ、MIGRATE 指向**同一个已经存在的数据库**,用不同账
141
141
 
142
142
  ## 本体图为什么有这些连线
143
143
 
144
- 图谱抽取命令状态迁移与事件、反应调用、审批 start/cancelOn、约束/路由字段、查询读依赖和外部映射;另以虚线标记按标识推导的所属聚合。关系解释区分显式声明、规则推导与文本匹配,箭头要按各自含义阅读。开发前可用[本体上下文工具](ontology-context.md)检索相关业务与源码。
144
+ 图谱抽取命令状态迁移与事件、反应调用、审批 start/cancelOn、约束/路由字段、查询读依赖和外部映射;另以虚线标记按标识推导的所属聚合。关系解释区分显式声明、规则推导与文本匹配,箭头要按各自含义阅读。开发前可用[本体上下文工具](../tools/ontology-context.md)检索相关业务与源码。
145
145
 
146
146
  `cage analyze` 将图写到 `.cage/ontology.json`;`cage graph` 提供浏览器工作台。中文显示名写在 `cage.config.json` 的 `graph.labels`,例如 `"command:PurchaseOrder.submit": "提交审批"`。显示名不更改能力标识、源码符号或表名。
147
147
 
@@ -0,0 +1,66 @@
1
+ # 第一条完整业务链
2
+
3
+ [学习入口](../README.md) · [框架开发 Skill](../skills/cage-development/SKILL.md) · [原语参考](../reference/primitives.md)
4
+
5
+ 本课教会你把声明、契约、页面和持久数据连接起来。以“部门便笺”解释方法:创建便笺、查看列表与详情、修改标题、归档。这个对象只用于教学;开发真实业务时替换对象含义和规则,不需要向用户项目添加便笺。
6
+
7
+ ## 先确定业务,再选择声明
8
+
9
+ 一条便笺有标题、所属部门和创建人,状态为 active 或 archived。创建、修改标题、归档都是命令;列表和详情使用生成的读取接口。标题不能为空是不变量,归档后不能修改由 update 的 from 表达。
10
+
11
+ 归属字段使用 `deptId: ref('Dept')` 与 `createdBy: ref('User')`,内核新建时根据当前主体填写;`scope.deptSubtree('deptId')` 描述范围字段。实际授权仍由角色配置决定,普通用户不能通过提交任意部门 ID 把记录放进其他部门。公司、项目组等自定义归属不能仅改一个字段名字就假定沿用同样规则,应核对当前支持的范围模型。
12
+
13
+ 完整领域代码见[便笺声明](../examples/note/note.ts)。依次阅读聚合、createNote、updateNote、archiveNote,注意命令导出名不同于 `name` 指定的能力名称。
14
+
15
+ ## 让声明进入应用
16
+
17
+ 把本课声明放入应用的 `packages/domain/src/modules/note/note.ts`,在模块 index.ts 导出它,再从 domain 总入口导出模块。保留原有组织模型及其他业务;不要让不同模块的 `export *` 带来重名导出。
18
+
19
+ 在应用根目录执行:
20
+
21
+ ```sh
22
+ pnpm exec cage check
23
+ pnpm gen
24
+ ```
25
+
26
+ 检查生成的 Note 契约、图节点、路由信息及迁移草稿。应能找到 `note.create`、`note.update`、`note.archive`、`note.list` 和 `note.get`。这里验证的是注册和生成;尚未证明数据库里有表或用户有权执行。
27
+
28
+ 数据库初次准备按[开发步骤](workflow.md#第一次启动应用)进行;已有项目复用现有配置。审查新迁移后执行 `pnpm migrate`,再按当前环境启动/重启 API 与 worker。不要改已执行迁移,也不要为学习案例覆盖业务数据库配置。
29
+
30
+ ## 给真实主体配置权限
31
+
32
+ 在独立验收环境准备有能力的主体、同部门另一主体和范围外主体。为所需角色明确配置 `Note.read`、`Note.create`、`Note.update`、`Note.archive` 及对应数据范围。按业务分别选择本人、部门或部门及下级等范围;创建一个角色名称不会自动获得这些能力。
33
+
34
+ `scope.none()` 缺少部门/创建人范围表达,不能拿它替代“仅看本部门”。当前框架合并多角色能力与范围;只切换前端门户不会把后端权限自动缩减到所选角色。产品确需切换执行身份时,先确认当前公开协议是否支持该语义,不能通过本地 role 变量伪装授权。
35
+
36
+ ## 页面调用真实契约
37
+
38
+ [列表与新建页面](../examples/note/notes-page.tsx)演示创建成功后重新读取服务端列表;[详情页面](../examples/note/note-detail-page.tsx)从 URL 读取 ID,直接加载服务端记录,修改和归档带上读取到的版本。它们是可编译的完整教学组件,样式由应用自行设计。
39
+
40
+ 将组件放到 `apps/web/src/modules/note/pages`,从模块 index.ts 公开导出。再在已有 app 路由组合层导入模块入口,在登录后的 Outlet 内加入以下路由片段:
41
+
42
+ ```tsx
43
+ <Route path="notes" element={<RequireCapability capability="Note.read" home="/workspace"><NotesPage /></RequireCapability>} />
44
+ <Route path="notes/:id" element={<RequireCapability capability="Note.read" home="/workspace"><NoteDetailPage /></RequireCapability>} />
45
+ ```
46
+
47
+ 片段中的 Route、RequireCapability 和两个页面要从当前应用真实入口导入;保留已有会话恢复、退出清理和 404。新增菜单使用 Link 指向 `/notes`。完整导航要求见[路由与浏览器验收](../guides/routing.md)。
48
+
49
+ 创建按钮检查 `Note.create` 只是界面提示。提交后检查 `result.ok`,成功才清空输入并重新读取;失败展示错误并保留输入。详情请求可能返回范围外的 NOT_FOUND,不能显示“该记录已删除”这种未经证明的结论。编辑冲突后重新读取版本并让用户核对,不静默覆盖他人修改。
50
+
51
+ ## 沿操作观察结果
52
+
53
+ | 操作 | 预期观察 | 若失败,优先检查 |
54
+ | --- | --- | --- |
55
+ | 有权用户创建便笺 | 真实请求成功,服务端返回 ID,独立 list/get 可读 | 契约调用、迁移、能力与归属字段 |
56
+ | 新标签页打开详情 URL | 重新请求后显示同一条记录 | URL ID、会话恢复、读取范围 |
57
+ | 另一位有同部门范围的用户查看 | 服务端读取同一条记录 | 实际部门、角色范围、接口结果 |
58
+ | 范围外主体直接请求详情 | 请求拒绝或安全地返回不可见 | 服务端范围,不能只看菜单是否隐藏 |
59
+ | 两个页面使用同一旧版本修改 | 后一次得到冲突,不覆盖新值 | expectedVersion 和页面刷新策略 |
60
+ | 归档后再次修改 | 业务状态拒绝;页面重新读取为 archived | from/to 与真实状态 |
61
+
62
+ 运行受影响包的类型检查和构建、生成一致性与必要业务测试,再按浏览器配方操作。未配置测试账号、未连接独立测试库或没有浏览器能力时,写清未执行项;不要用编译通过替代本表结果。
63
+
64
+ ## 从本课迁移到其他业务
65
+
66
+ 先替换对象、字段、归属与动作,保留“声明 → 导出 → 生成 → 运行配置 → 契约 → 观察结果”的方法。只有需求需要时再增加能力:审批学习[审批单元](../guides/approvals.md),附件学习[文件单元](../guides/files.md),关联学习[关系单元](../guides/relations.md),跨对象联动参考[事务选择](architecture.md#同事务与异步的选择)。完整组合范例见[采购导读](../examples/purchase-example.md),无需一次复制全部采购实现。
@@ -1,6 +1,6 @@
1
1
  # 开发步骤与交付要求
2
2
 
3
- [返回学习入口](README.md) · [范例导读](purchase-example.md) · [详细中文注释](commenting.md)
3
+ [返回学习入口](../README.md) · [框架开发 Skill](../skills/cage-development/SKILL.md) · [完整入门课](first-feature.md) · [详细中文注释](../reference/commenting.md)
4
4
 
5
5
  本页命令在**应用根目录**执行,除非注明“框架根目录”。使用项目安装的 CLI:`pnpm exec cage ...`。项目脚本可简写为 `pnpm gen / pnpm migrate / pnpm dev / pnpm verify`;不要假定机器已全局安装 cage。
6
6
 
@@ -25,7 +25,7 @@ pnpm dev
25
25
 
26
26
  `init` 自动创建独立账号与随机密码,填写 APP/READ/MIGRATE 连接和 Cookie 密钥,成功后删除文件中的管理员连接。三个连接使用同一数据库。已有 Cage 集群账号时复用原连接,不能重置其他应用的账号密码。生产环境可由平台直接提供账号连接,不必执行本地 init。
27
27
 
28
- `bootstrap` 独立初始化组织,不自动授予业务能力。管理员凭据只进入新的受限文件,不进入服务控制台;已有用户时不重置。交付后移除凭据文件。日常 API 启动不初始化组织;生产缺少合格 Cookie 密钥会拒绝启动。具体文件权限与诊断用法见[能力发现与状态诊断](diagnostics.md)。
28
+ `bootstrap` 独立初始化组织,不自动授予业务能力。管理员凭据只进入新的受限文件,不进入服务控制台;已有用户时不重置。交付后移除凭据文件。日常 API 启动不初始化组织;生产缺少合格 Cookie 密钥会拒绝启动。具体文件权限与诊断用法见[能力发现与状态诊断](../tools/diagnostics.md)。
29
29
 
30
30
  `.env.example` 是配置说明,`.env` 是本机私密配置,二者不混用。CLI 自动加载应用 `.env`,部署环境同名变量优先。API 和 worker 启动需重启后读取变更;不要输出整个 `.env` 排障。
31
31
 
@@ -33,12 +33,12 @@ pnpm dev
33
33
 
34
34
  ## 做一项业务修改
35
35
 
36
- 1. 读 AGENTS.md、[目录规范](project-structure.md)和[详细中文注释规范](commenting.md),确认需求落在领域模块、前端模块、组织配置还是框架。先 `pnpm exec cage context "需求关键词"`,按需 `graph search/inspect/path` 定位,确认候选入口后阅读对应源码、范例与测试;证据和边界见[本体上下文指南](ontology-context.md)。发现能力缺口先说明,不编造 API。
36
+ 1. 读 AGENTS.md 和[框架开发 Skill](../skills/cage-development/SKILL.md),确认需求属于领域模块、前端模块、组织配置还是框架。阅读需求和文档后,按[业务澄清与共同设计](../guides/business-collaboration.md)主动提出疑问、选项和建议,与用户确定相关规则及验收;已明确部分继续推进。按任务选手册,必要时本地搜索术语;用 `capabilities` 核对公开 API、`context "需求关键词"` 定位当前业务。按需 `graph search/inspect/path`,阅读对应源码、范例与测试;证据边界见[本体上下文指南](../tools/ontology-context.md)。遵守[目录规范](../reference/project-structure.md)和[详细中文注释规范](../reference/commenting.md),发现能力缺口先说明,不编造 API。
37
37
  2. 涉及已存在业务含义变化时,**修改前**运行 `pnpm exec cage snapshot save before-change` 保存命名基线;也可使用真实 Git 提交或独立本体图文件。
38
38
  3. 在所属领域模块写字段、状态、不变量和命令输入;再实现 handler、事件、查询与审批。跨模块反应放 workflows,第三方协议放 integrations。从模块 index 到 domain 总入口逐层导出,避免跨文件 export 名冲突。同步编写详细中文注释:文件职责与调用链、导出声明及输入字段、权限/状态/reads/事件/事务、关键步骤和失败边界;涉及已有行为时补齐受影响的上下游说明。
39
39
  4. `pnpm exec cage check` 检查声明和图规则;`pnpm gen` 更新契约与迁移草稿。聚合和命令填写中文 `description`,需要覆盖时补 `cage.config.json` 的 `graph.labels`(如 `aggregate:Note`、`command:Note.archive`、`capability:Note.export`)。这些名称同时用于图谱和 `/admin` 授权界面;修改后重启 API。不重命名实际能力点来实现翻译。在图谱确认连接与资源生命周期。
40
40
  5. 审查数据库变更,特别是非空字段、数据回填、删列和索引。已执行的迁移不可改写。需要落库时显式 `pnpm migrate`。
41
- 6. 页面和表单放 `apps/web/src/modules/<业务>`,从模块公开入口接入 app 的 URL 路由;依赖生成 contracts,处理失败结果。列表、详情等多页面使用 React Router,筛选和分页进入 URL;组件状态只管理页面内临时交互。新增能力由管理员授权,页面按钮可用 `useCan` 控制。按[路由与浏览器验收](routing.md)检查直达、刷新、前进后退和登录回跳。
41
+ 6. 页面和表单放 `apps/web/src/modules/<业务>`,从模块公开入口接入 app 的 URL 路由;依赖生成 contracts,处理失败结果。列表、详情等多页面使用 React Router,筛选和分页进入 URL;组件状态只管理页面内临时交互。新增能力由管理员授权,页面按钮可用 `useCan` 控制。按[路由与浏览器验收](../guides/routing.md)检查直达、刷新、前进后退和登录回跳。
42
42
  7. 补足重要业务反例并运行相关验证;测试解释夹具目的、所保护的规则和覆盖边界。按注释规范审查本次 diff,核对页面、组件/hooks、类型字段、脚本副作用和恢复流程的说明是否完整准确。提交源声明、契约和审查过的迁移,报告跳过及未执行项。
43
43
 
44
44
  ### 如何保存和比较基线
@@ -98,7 +98,7 @@ if (!result.ok) {
98
98
  - `atomic: true` 请求整批原子处理,普通逐行导入需展示成功/失败计数及报告。HTTP 202 仅代表接受任务,不能立即提示处理完成。
99
99
  - worker 必须运行;任务可能 queued/retrying/failed/expired。下载会再次校验当前权限。导出的系统列和掩码值不能原样回导。
100
100
 
101
- CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入导出](transfers.md)。给新业务做入口时按实际生成的签名调用,不硬编码采购单专属逻辑进框架。
101
+ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入导出](../guides/transfers.md)。给新业务做入口时按实际生成的签名调用,不硬编码采购单专属逻辑进框架。
102
102
 
103
103
  ## 工具做什么,结果在哪里
104
104
 
@@ -106,12 +106,12 @@ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入
106
106
  | --- | --- | --- |
107
107
  | `pnpm exec cage analyze` | 抽取显式声明与源码位置 | `.cage/ontology.json` |
108
108
  | `pnpm exec cage capabilities 关键词 --format json` | 查询当前安装版本的公开能力 | 公开签名、声明位置和学习入口 |
109
- | `pnpm exec cage doctor` | 统一核对注册、生成、构建及可用运行证据 | pass / fail / unknown 与下一步;见[诊断指南](diagnostics.md) |
109
+ | `pnpm exec cage doctor` | 统一核对注册、生成、构建及可用运行证据 | pass / fail / unknown 与下一步;见[诊断指南](../tools/diagnostics.md) |
110
110
  | `pnpm exec cage snapshot save 名称` | 保存不可覆盖的命名基线 | `.cage/snapshots`;配合 `impact --snapshot 名称` |
111
111
  | `pnpm exec cage check` | 静态检查、注册表与图规则 | 终端 `code/at/reason/fix` |
112
112
  | `pnpm exec cage graph` | 启动中文本体图谱 | 默认 `http://127.0.0.1:15418`,按终端地址访问 |
113
113
  | `pnpm exec cage context "需求或节点"` | 开发前取得相关子图、原因、源码与候选验证 | 默认终端 Markdown;`--format json --out .cage/context.json` 保存结构化报告 |
114
- | `pnpm exec cage graph search/inspect/path ...` | 检索候选 / 精确节点 / 关系路径 | 同源中文与证据;每次重新抽取,见[用法](ontology-context.md) |
114
+ | `pnpm exec cage graph search/inspect/path ...` | 检索候选 / 精确节点 / 关系路径 | 同源中文与证据;每次重新抽取,见[用法](../tools/ontology-context.md) |
115
115
  | `pnpm gen` | 更新契约、结构说明、迁移草稿 | `packages/contracts/src`、`db/migrations`、`generated`、`.cage/ontology.json` |
116
116
  | `pnpm exec cage gen --check` | 只比较需提交的生成物 | 不一致时报 CAGE-GEN;不是实际数据库漂移扫描 |
117
117
  | `pnpm exec cage test --only project` | 项目测试 | `.cage/test-results.json` 与终端 |
@@ -127,10 +127,10 @@ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入
127
127
  ## 验证要与改动匹配
128
128
 
129
129
  - 文档、文案、可逆的小改动:检查链接、格式、资料分发;不需要重复运行全套数据库测试。
130
- - 所有源码变更:按[注释交付清单](commenting.md#交付前逐项核对)人工核对中文职责、接口与关键流程说明;静态检查不能替代注释准确性检查。仅补注释时不新增复述实现的测试、不改写已执行迁移。
130
+ - 所有源码变更:按[注释交付清单](../reference/commenting.md#交付前逐项核对)人工核对中文职责、接口与关键流程说明;静态检查不能替代注释准确性检查。仅补注释时不新增复述实现的测试、不改写已执行迁移。
131
131
  - 命令/约束/反应变化:针对成功路径及真正的风险增加用例,如越权拒绝、额度边界、资源释放、同事务回滚。不要写只复述实现的测试。
132
132
  - 领域结构变化:check、gen、生成一致性、类型检查;有数据库影响时在独立测试库验证迁移和读写。
133
- - 页面或导航变化:构建后按[浏览器配方](routing.md)实际操作,包含深链接、新标签页、刷新、前进后退、登录回跳、无权限和 404。check/verify 不自动执行浏览器验收;未操作时明确报告未执行,不能写“页面功能完整”。
133
+ - 页面或导航变化:构建后按[浏览器配方](../guides/routing.md)实际操作,包含深链接、新标签页、刷新、前进后退、登录回跳、无权限和 404。check/verify 不自动执行浏览器验收;未操作时明确报告未执行,不能写“页面功能完整”。
134
134
  - 发布前:按项目要求执行完整 verify/build/test,核对分发包。没有执行的项目明确写出原因。
135
135
 
136
136
  测试使用真实 PostgreSQL。`CAGE_TEST_DATABASE_URL` 供独立测试集群使用,测试工具会准备角色和临时数据库;不要指向业务/生产集群。没有设置时 testkit 可使用内嵌的真实 PostgreSQL,这与 dev 的固定已有库流程不同。
@@ -140,12 +140,13 @@ CSV 编码、限制、SDK 与完整接口见本项目自带的[业务页导入
140
140
  ## 可以交给 AI 的任务描述
141
141
 
142
142
  ```text
143
- 先读 AGENTS.md 和它指定的 docs/ai/README.md,再参考对应标准范例。
143
+ 先读 AGENTS.md 和它指定的 docs/development/README.md,再参考对应标准范例。
144
144
  需求:为某业务增加……
145
+ 阅读需求、业务文档和现有代码,主动指出疑点与建议,给出可行选项、影响和推荐理由,让我选择业务规则;已给出的答案直接沿用,技术事实自行查证。
145
146
  先用 cage context 查询现有业务,必要时 graph inspect/path,确认候选与关系后阅读实现。
146
- 说明字段、状态、能力与范围、事件/资源的影响,再修改 domain、生成契约和迁移草稿、接入业务页面。
147
+ 把已确定的规则映射到字段、状态、能力与范围、事件/资源和验收,再修改 domain、生成契约和迁移草稿、接入业务页面;等待业务选择时推进独立部分。
147
148
  使用真实公开 API;不要手写业务路由、直接写表或新增本地数据库生命周期命令。
148
- 按 docs/ai/commenting.md 给新建和修改代码写详细中文注释,覆盖职责、API/字段、步骤、原因和边界,同步修正相关上下游说明。
149
+ 按 docs/development/reference/commenting.md 给新建和修改代码写详细中文注释,覆盖职责、API/字段、步骤、原因和边界,同步修正相关上下游说明。
149
150
  按改动运行必要检查,报告通过/跳过/未执行项和需要的管理员配置。
150
151
  ```
151
152
 
@@ -1,6 +1,18 @@
1
1
  # 审批任务流转、并行分支与流程时效
2
2
 
3
- [返回学习入口](README.md) · [审批原语](primitives.md) · [AI 审批](intelligence.md)
3
+ ## 第一次接入审批
4
+
5
+ 审批负责谁在什么步骤作出决定,业务状态由领域结论命令落实。先完成下列最小链路,再按需要阅读后面的并行、加签与时效选项。普通自动状态变化直接使用命令和反应,无需套审批。
6
+
7
+ 1. 业务对象有草稿、待审批和相应结论状态。提交命令声明 emits 并成功发出提交事件;通过/拒绝等结论声明为 process 命令。
8
+ 2. approval 绑定提交事件、结论命令和取消事件,route 定义步骤与选人;两者都从 domain 入口导出。routable 只包含选路和任务需要的业务快照字段。
9
+ 3. 配置实际负责人/角色成员,并分别授予所需能力、范围和额度;声明 role code 不会创建角色或分配人员。检查迁移和运行中的 worker。
10
+ 4. 页面先通过业务契约提交,再读取真实待办,通过公开任务接口携带当前 revision 作出决定。业务列表中的“待审批”不等于当前用户拥有待办。
11
+ 5. 观察提交事件、待办、决定与领域最终状态;用不合格主体验证拒绝,按需求验证撤回。缺少待办时按[排错方法](../tools/troubleshooting.md)查具体断点,不直接把单据改成通过。
12
+
13
+ 完整跨文件参考见[采购导读](../examples/purchase-example.md),基础声明见[审批绑定与选人](../reference/primitives.md#审批绑定与选人)。本页后续的客户端操作是接入片段,业务符号与 UI 需来自当前应用。
14
+
15
+ [返回学习入口](../README.md) · [审批原语](../reference/primitives.md) · [AI 审批](intelligence.md)
4
16
 
5
17
  本页描述 Cage 原生审批引擎的顺序/条件/结构化 AND 并行、字段选人、候选领取/释放、转办、委派归还、前后/并行必签、操作记录,以及框架通用的自然分钟时限、站内提醒和申请人催办。它参考 Flowable 的任务责任划分和并行汇合语义,不表示支持全部 BPMN 或与 Flowable XML 兼容。
6
18
 
@@ -190,13 +202,11 @@ if (candidates.ok && candidates.data.length) {
190
202
 
191
203
  框架 Admin 用同一收件箱表格展示本人、可领取和等待加签任务及各类数量;采购范例提供“待我处理 / 可领取 / 等待加签”三个视图。两者都有领取、释放、受托任务归还及正常决定入口。waiting 仅展示,不显示决定按钮;候选和受托任务分别显示领取、归还入口。采购 `/approvals` 用 `view=candidates`、`view=waiting` 保存视图,默认本人待办不需要 view 参数。界面可提示操作,未完成子票等动态限制仍由服务端拒绝。
192
204
 
193
- 采购范例后续已接入协作名录选人、转办/委派/三种加签及分页人工操作历史,详见 [采购导读](purchase-example.md)。框架 Admin 保留通用任务收件箱,启用审批运营后新增“我的申请”和“流程提醒”,不依赖采购的页面、名录或额外业务字段。框架支持、应用路由启用、浏览器验收仍是不同状态。
194
-
195
- 本批真实 PostgreSQL/HTTP 定向回归共 144 项通过、最终 0 跳过:新增候选/签序 38 项、既有人员动作 27 项和内核/HTTP/AI/恢复 79 项。先执行六文件 143 项,再补旧实例签序权限用例并复跑两个审批文件 65 项,重复用例不累加。包含 8 人抢领、超过五连接池容量的并发、字段非法/停用/跨租户、动态候选身份、前后签 any/all、取消、领域命令失败回滚和真实旧库升级。首次内嵌测试数据库短暂拒绝连接造成的跳过,已由后续完整执行覆盖;该次跳过不计入通过。
205
+ 采购范例包含协作名录选人、转办/委派/三种加签及分页人工操作历史,详见 [采购导读](../examples/purchase-example.md)。框架 Admin 提供通用任务收件箱,启用审批运营后提供“我的申请”和“流程提醒”,不依赖采购的页面、名录或额外业务字段。框架支持、应用路由启用、浏览器验收仍是不同状态。
196
206
 
197
- 上述第二批基础页面曾使用真实构建和内存 HTTP 夹具验收;后续采购场景已另做真实隔离 PostgreSQL、API、worker 和账号登录的浏览器验证。各次记录不累加为全部功能验收;本页 API 说明也不能代替部署后的实际验证。
207
+ 应用接入需检查真实角色、路由、迁移、worker 与浏览器路径,覆盖相关成功和拒绝场景;框架历史回归结果不能代替当前应用验收。
198
208
 
199
- 尚未实现受限岗位规则、代理时间段、嵌套委派、无可用人员的通用恢复、减签/撤销加签、任意串行加签链、指定节点退回、任意流程图/循环/OR 网关、工作日计时、自动升级、抄送、邮件/短信通知和可视化运行时设计器。应用接入仍需检查真实角色、路由、迁移与浏览器路径;上述历史测试数量不作为本次 AND 并行的验证数量。
209
+ 尚未实现受限岗位规则、代理时间段、嵌套委派、无可用人员的通用恢复、减签/撤销加签、任意串行加签链、指定节点退回、任意流程图/循环/OR 网关、工作日计时、自动升级、抄送、邮件/短信通知和可视化运行时设计器。
200
210
 
201
211
  ## 框架通用时限、提醒与催办
202
212
 
@@ -0,0 +1,63 @@
1
+ # 业务澄清与共同设计
2
+
3
+ [返回学习入口](../README.md) · [框架开发 Skill](../skills/cage-development/SKILL.md) · [业务设计与能力选择](recipes.md)
4
+
5
+ 用户可能只有一个目标,业务文档也可能有遗漏、歧义或相互冲突的规则。agent 阅读后应主动提出疑问和建议,帮助用户比较方案、作出选择,再把选择落实为 Cage 业务声明与验收结果。本页用于开发时的协作,不是应用内 AI 助理的交互协议。
6
+
7
+ ## 先核对事实,找出需要共同决定的事
8
+
9
+ 先读当前对话、项目业务约定和受影响的源码,区分“用户希望怎样”“文档约定怎样”“系统现在怎样”。已经明确的需求沿用;用户明确要求改变旧规则时说明影响并执行,不因为旧文档不同而重复请求同一决定。
10
+
11
+ 主动检查对象和术语、参与人及范围、状态与动作、金额/数量/时间口径、失败与撤回、页面体验和验收标准。只检查本次相关内容,不要求用户先填写一份完整问卷。发现疑点应尽量说明具体位置和影响,不把未说明的内容当作默认允许,也不照搬采购示例中的规则。
12
+
13
+ | 发现的情况 | agent 如何处理 | 用户需要决定什么 |
14
+ | --- | --- | --- |
15
+ | “大额需审批”“负责人可见”等描述有多种解释 | 指出缺失的阈值、负责人来源或可见范围,列出可行理解及影响 | 业务口径与希望的行为 |
16
+ | 业务文档互相矛盾,或与现有行为不一致 | 引用冲突位置,说明当前实现;已有明确新要求时直接采用,否则给出调整方案 | 哪条规则应作为目标,变更适用范围 |
17
+ | 框架文档写法不清、签名或版本不一致 | 按[能力诊断](../tools/diagnostics.md)核对安装版本、公开导出与实现,说明查证结果和仍不确定的部分 | 仅在影响业务目标或实现范围时选择方案;API 是否存在由证据确定 |
18
+ | 需求无法由当前能力直接表达 | 说明缺口,比较已有能力可实现的方案、应用扩展或框架扩展及成本;只提供有依据的选项 | 保留目标并扩展、接受明确的行为调整,或延后相关部分 |
19
+ | 规则可实现,但存在更清楚的使用方式或遗漏的失败体验 | 提出具体建议,解释收益和额外工作,标明是可选改进 | 是否纳入本次;未采纳不妨碍已明确工作 |
20
+ | 命名、目录归属、普通组件组织等技术选择 | 按项目约定和框架指南自行解决;有实质业务影响时再说明 | 通常无需选择实现细节 |
21
+
22
+ 代码能说明当前行为,框架文档能说明能力边界,都不能单独证明用户希望的业务。查证不能解决的业务疑问要提出;已经查明的技术事实不转交用户猜测。资料确有错误时指出来源,在任务授权范围内修正或记录,不把猜测写成已实现能力。
23
+
24
+ ## 每次提问都帮助用户作选择
25
+
26
+ 一个有用的问题通常包含以下内容,按复杂程度合并表达即可:
27
+
28
+ 1. **疑点与依据**:哪句话、哪段规则或哪个现有行为有问题,以及为什么会影响结果。
29
+ 2. **选项与影响**:给出少量可行方案,通常两到三个;说明用户能观察到的区别,以及必要的配置、实现成本或框架限制。允许用户补充其他方案。
30
+ 3. **推荐与理由**:结合已知业务、现有实现和框架能力推荐一个方案。缺乏推荐依据时说明还缺什么事实,不为了给建议而编造行业规则。
31
+ 4. **本次需要的决定**:明确让用户选择哪个业务规则,以及未决定前哪一部分暂不落实。
32
+
33
+ 例如应问“提交后哪些人可以修改申请”,再由 agent 选择对应命令和状态约束;不要让用户先决定 `from/to` 怎样写。金额阈值、审批人、数据可见范围等也不能从示例或技术便利性推断。
34
+
35
+ 优先提出影响下一步设计的少量问题,相关问题可以合并。其余已发现疑点简短列为后续事项,随工作推进继续澄清;不要为了减少提问而隐去重要疑点,也不要一次倾倒所有可能的问题。用户只回答一部分时,保留这些答案,下一轮只追问剩余的相关事项。
36
+
37
+ ## 在选择中推进实现
38
+
39
+ - 对需要业务选择的部分,在获得答案前保留为待定;可以继续阅读、核对能力、实现不依赖该决定的部分。不要把待定策略写成生效的权限、金额计算或状态规则。
40
+ - 可选改进单独说明;已明确任务照常推进。不要把每个建议都变成一个必须批准的关卡。
41
+ - 用户已有明确选择、授权或要求“你来定”时,按该范围推进并说明采用的规则。推荐选项、界面预选、等待时间和沉默均不构成新的选择;用户委托决定也不扩大任务或外部操作的授权范围。
42
+ - 实现中发现约定无法落地时,带着实际证据和替代方案回到用户,不默默降低要求。用户改变规则时,先指出受影响的声明、页面、数据和验收,再修改相关部分,无需重新确认无关规则。
43
+
44
+ 简单任务在对话中简短记录即可;需要后续维护的规则写入项目已有业务文档或 AGENTS.md 的托管区外,并从项目入口引用。保留“已确定的规则及依据”“尚待决定的事项”“可选建议”的区别。客户业务事实不写进框架通用教材,也不写进会被 `cage sync` 覆盖的区域。
45
+
46
+ 确定规则后,按[能力选择](recipes.md)映射到聚合、命令、状态、范围、审批或连接器,同时补充能观察结果的验收例子。记录不要求固定文件格式,也不要求每项小改动新增计划文件。
47
+
48
+ ## 示例:文档没有写清金额边界
49
+
50
+ 业务文档写着:“金额低于 5000 元由部门负责人审批;超过 5000 元增加财务审批。”
51
+
52
+ agent 读后可以提出:
53
+
54
+ > 这两条规则没有覆盖恰好 5000 元,会影响审批路径。可以选择:
55
+ >
56
+ > - A:满 5000 元就增加财务审批。
57
+ > - B:5000 元仍只由部门负责人审批,超过才增加财务。
58
+ >
59
+ > 我建议 A,让阈值本身也经过财务审核;这是一项待你选择的业务规则。你希望采用哪一种?也可以指定其他边界。
60
+
61
+ 用户选择 A 后,agent 将规则落实为“低于 5000 元仅部门负责人审批;大于等于 5000 元增加财务”,按当前审批能力实现条件,并验证 4999.99、5000、5000.01 元三种输入。金额精度和单位仍沿用项目约定;若尚未约定且影响实现,也应继续提出。
62
+
63
+ 如果文档还没说明财务与部门负责人的先后关系,这仍是独立疑点:说明顺序审批和并行审批的业务区别及当前支持方式,再让用户选择。金额边界已有答案,不再重复询问;选人、授权和真实待办的验收按[审批指南](approvals.md)落实。
@@ -1,6 +1,10 @@
1
1
  # 私有文件字段与断点续传
2
2
 
3
- [返回学习入口](README.md) · [原语](primitives.md) · [权限与执行模型](architecture.md)
3
+ 先理解三个独立动作:上传原始字节得到文件 ID,业务命令将该 ID 绑定到字段,通过受控下载接口读取内容。只声明 file 字段不会上传文件,只保存文件名也不会保存内容。
4
+
5
+ 第一次接入依次完成本页的声明、客户端上传与授权下载,再增加暂停/续传等交互。验证上传内容与下载内容一致、业务保存失败有明确反馈、范围外主体下载被拒绝;文件目录存在或页面显示附件名都不足以证明链路成功。
6
+
7
+ [返回学习入口](../README.md) · [原语](../reference/primitives.md) · [权限与执行模型](../getting-started/architecture.md)
4
8
 
5
9
  文件字节由 `@yss123/cage-files` 管理;业务字段只保存文件 ID。上传完成得到临时文件,业务命令成功后才正式绑定。不要把文件内容、Base64、存储路径或公开 URL 放进业务字段、事件或审计。
6
10
 
@@ -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
 
@@ -36,7 +36,7 @@ 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
40
 
41
41
  ## 启用后端
42
42
 
@@ -292,7 +292,7 @@ const assistant = useAssistant(client.ai, page);
292
292
  // progress.tool / toolName / toolState:当前工具及执行状态。
293
293
  ```
294
294
 
295
- 以上片段的 hooks 从 `@yss123/cage-client` 导入,record/location 是应用路由与数据。SDK 会在卸载、退出和切换账号时取消订阅并清理 hook 状态;应用其他缓存仍须按[开发步骤](workflow.md)处理。
295
+ 以上片段的 hooks 从 `@yss123/cage-client` 导入,record/location 是应用路由与数据。SDK 会在卸载、退出和切换账号时取消订阅并清理 hook 状态;应用其他缓存仍须按[开发步骤](../getting-started/workflow.md)处理。
296
296
 
297
297
  `send` / `respond` 返回的 Promise 等待本轮完成或需要用户交互;界面应在等待期间渲染 `streamingText` 和 `progress`。`run.status`、步数、工具调用数和待确认操作也随事件更新,不必等 Promise 返回。`model.started` 表示开始一次模型调用,`message.delta` 是增量文本,`tool.started` / `tool.completed` 表示实际工具进度;这些事件不包含模型的私有推理内容。新的模型步骤会重置当前文本,最终以 `message.completed` 校准。
298
298
 
@@ -345,4 +345,4 @@ Token 使用优先按模型返回 usage 核算;缺少 usage 时使用文本估
345
345
  - AI 审批:覆盖 pass、return、manual,检查退回修改后的新轮次从头开始;模型失败应按节点配置转人工或留在失败状态,不得伪造通过。
346
346
  - 管理配置:验证模型连接和一次实际工具交互,性格切换作用于后续消息;需要 Responses 接续或压缩时分别核对实际支持,连接成功不能替代这些验证。
347
347
 
348
- `cage doctor` 可辅助检查注册、迁移和进程证据,但未知项不能当作通过;诊断用法见[能力发现与状态诊断](diagnostics.md)。模型输出质量需要应用使用自己的规则样例评测。框架验证的是权限、状态、预算和事务边界;发布前需使用实际模型服务、实际角色和审批样例联调。
348
+ `cage doctor` 可辅助检查注册、迁移和进程证据,但未知项不能当作通过;诊断用法见[能力发现与状态诊断](../tools/diagnostics.md)。模型输出质量需要应用使用自己的规则样例评测。框架验证的是权限、状态、预算和事务边界;发布前需使用实际模型服务、实际角色和审批样例联调。
@@ -1,14 +1,14 @@
1
- # 业务任务配方
1
+ # 业务设计与能力选择
2
2
 
3
- [返回学习入口](README.md) · [原语示例](primitives.md) · [开发步骤](workflow.md)
3
+ [返回学习入口](../README.md) · [原语示例](../reference/primitives.md) · [开发步骤](../getting-started/workflow.md)
4
4
 
5
- 本页用于把用户的业务描述转成 Cage 项目的可执行修改。按需要读对应配方即可,不需要修改框架内部。
5
+ 本页用于把用户的业务描述转成 Cage 项目的可执行修改。先通过[框架开发 Skill](../skills/cage-development/SKILL.md)理解执行模型,首次使用可沿[完整入门课](../getting-started/first-feature.md)学习。按需要读对应配方,不要求为每个任务加载所有能力。
6
6
 
7
7
  需要 AI 审批、业务助理、随页聊天、模型管理或性格配置时,先用 `cage capabilities` 查框架能力,再按[原生智能化指南](intelligence.md)接入。普通业务建模仍按下文声明聚合和命令;接入已有框架服务无需另建一套通用后端。
8
8
 
9
- ## 先把需求落到一张业务表
9
+ ## 先确定业务边界与执行路径
10
10
 
11
- 开始编码前,从用户需求或现有业务中确定以下信息。能从上下文确认的直接使用;真正缺失且影响实现的再询问,不要为技术细节反复让用户确认。
11
+ 开始编码前,从用户需求、业务文档和现有实现中确定以下信息。按[业务澄清与共同设计](business-collaboration.md)主动提出歧义、冲突、遗漏及有价值的建议,给出选项、影响与推荐理由,让用户选择业务规则。已明确的条件直接采用,API 和普通技术细节由 agent 查证处理;下表用于发现相关问题,不要求用户逐项填表。
12
12
 
13
13
  | 业务问题 | 落到什么声明 | 例如 |
14
14
  | --- | --- | --- |
@@ -20,11 +20,30 @@
20
20
  | 取消/失败要撤销什么? | cancelOn、释放命令、补偿流程 | 取消待办、释放占用、远端撤销或人工补偿 |
21
21
  | 页面需要看什么? | 生成的 list/get、query、业务页面 | 分页、详情、按状态汇总、导出与导入 |
22
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
+
23
42
  ## 新增一个普通管理对象
24
43
 
25
- 按[最小便笺业务](primitives.md)新增 `packages/domain/src/modules/<业务>/<对象>.ts`:字段、范围、不变量、create/update/archive 命令。采用唯一的导出名和必要的 `name` 覆盖,避免 index 的 `export *` 丢失重名符号。
44
+ 按[最小便笺业务](../reference/primitives.md)新增 `packages/domain/src/modules/<业务>/<对象>.ts`:字段、范围、不变量、create/update/archive 命令。采用唯一的导出名和必要的 `name` 覆盖,避免 index 的 `export *` 丢失重名符号。
26
45
 
27
- 从模块 index 到 domain 入口导出后运行 check/gen,审查迁移,再在 `apps/web/src/modules/<业务>` 使用生成 contracts 做列表、详情、表单和操作按钮,经模块公开入口注册到 app 路由。列表和详情都有独立 URL,筛选/分页进入 query,按[浏览器配方](routing.md)检查导航。最后给角色授权并补图谱中文名。完整归属规则见[目录规范](project-structure.md)。不要手写后端增删改查路由、ORM 实体与 repository,也不要复制框架鉴权代码。
46
+ 从模块 index 到 domain 入口导出后运行 check/gen,审查迁移,再在 `apps/web/src/modules/<业务>` 使用生成 contracts 做列表、详情、表单和操作按钮,经模块公开入口注册到 app 路由。列表和详情都有独立 URL,筛选/分页进入 query,按[浏览器配方](routing.md)检查导航。最后给角色授权并补图谱中文名。完整归属规则见[目录规范](../reference/project-structure.md)。不要手写后端增删改查路由、ORM 实体与 repository,也不要复制框架鉴权代码。
28
47
 
29
48
  完成标准:授权用户能创建和修改,范围外数据不可见,归档后的允许行为符合业务要求,生成契约和迁移一致。没有审批需求时不必添加审批;没有外部系统时不必添加连接器。
30
49
 
@@ -42,7 +61,7 @@
42
61
  4. 配置实际部门负责人、角色或指定用户;给审批人配置能力、范围和额度。
43
62
  5. 页面通过待办接口操作。通过后需占用资源时用反应调用资源命令,按业务一致性选择同事务。
44
63
 
45
- 完成标准:提交生成待办、正确的人审批、越权和自审批拒绝、取消能结束待办、资源配对完整。转办、委派归还和当前节点并行必签见[审批任务流转](approvals.md),须显式启用政策并传任务版本。任意流程设计器、动态 JS 选人、前后加签和指定节点退回仍需明确扩展范围。
64
+ 完成标准:提交生成待办、正确的人审批、越权和自审批拒绝、取消能结束待办、资源配对完整。转办、委派归还及当前节点前签、后签和并行必签见[审批任务流转](approvals.md),须显式启用政策并传任务版本,旧实例是否开放签序以其快照为准。任意流程设计器、动态 JS 选人和指定节点退回仍需明确扩展范围。
46
65
 
47
66
  ## 加入 AI 审批或随页助理
48
67
 
@@ -79,10 +98,11 @@
79
98
  ## 给编程工具的任务模板
80
99
 
81
100
  ```text
82
- 阅读当前项目 AGENTS.md,按 docs/ai/README.md 找到本次需求对应的原语和标准范例。
83
- 遵守 docs/ai/project-structure.md:领域和前端按业务建 modules,app 组合页面,shared 只放通用代码,不平铺 src 或堆进 main.tsx。
101
+ 阅读当前项目 AGENTS.md,按 docs/development/README.md 找到本次需求对应的原语和标准范例。
102
+ 遵守 docs/development/reference/project-structure.md:领域和前端按业务建 modules,app 组合页面,shared 只放通用代码,不平铺 src 或堆进 main.tsx。
84
103
  业务:……;角色与数据范围:……;状态与允许动作:……;审批/外部系统/资源占用:……。
85
- 先列出需要修改的 domain、页面、契约、迁移和授权,再直接完成实现。
104
+ 阅读后主动指出描述或文档中的疑点,按 docs/development/guides/business-collaboration.md 给出可行选项、影响与推荐,让我选择;已明确条件不重复询问,普通技术细节自行查证处理。
105
+ 将已选择的规则映射到 domain、页面、契约、迁移、授权和验收,再完成实现;等待业务决定时继续不依赖该决定的工作,可选建议不阻塞已明确任务。
86
106
  使用当前公开 API;对无法表达的需求说明具体缺口,不编造方法。
87
107
  生成文件通过 cage gen 更新,数据库使用已有 .env 配置,按改动完成必要验证。
88
108
  交付时说明用户如何体验、管理员需配置什么,以及通过/跳过/未执行的检查。
@@ -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,7 +20,7 @@
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
26
  import {
@@ -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) · [开发步骤](workflow.md)
3
+ [返回学习入口](../README.md) · [开发步骤](../getting-started/workflow.md)
4
4
 
5
5
  框架提供持久化任务、CSV 处理、权限和下载接口。业务项目决定入口、列名、上传表单、任务状态与报告如何展示;不要求用户进入系统管理页,也不要求具备 Sys.ops 能力。路径中的 `/api/sys/transfers` 是通用任务接口。
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