bmalph 1.0.0 → 2.2.1

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 (455) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +398 -217
  3. package/bmad/bmm/agents/analyst.agent.yaml +43 -36
  4. package/bmad/bmm/agents/architect.agent.yaml +29 -28
  5. package/bmad/bmm/agents/dev.agent.yaml +38 -38
  6. package/bmad/bmm/agents/pm.agent.yaml +44 -46
  7. package/bmad/bmm/agents/qa.agent.yaml +58 -0
  8. package/bmad/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -32
  9. package/bmad/bmm/agents/sm.agent.yaml +37 -36
  10. package/bmad/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +223 -223
  11. package/bmad/bmm/agents/tech-writer/tech-writer.agent.yaml +46 -45
  12. package/bmad/bmm/agents/ux-designer.agent.yaml +27 -26
  13. package/bmad/bmm/data/project-context-template.md +26 -26
  14. package/bmad/bmm/module-help.csv +31 -31
  15. package/bmad/bmm/module.yaml +50 -44
  16. package/bmad/bmm/teams/default-party.csv +20 -21
  17. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  18. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  19. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -177
  20. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -161
  21. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -199
  22. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -202
  23. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -205
  24. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -219
  25. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -162
  26. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -58
  27. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  28. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  29. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  30. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  31. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  32. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  33. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  34. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  35. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  36. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  37. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  38. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  39. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  40. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  41. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  42. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  43. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  44. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +233 -239
  45. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  46. package/bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
  47. package/bmad/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
  48. package/bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
  49. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/domain-complexity.csv +14 -12
  50. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/prd-purpose.md +197 -197
  51. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/project-types.csv +10 -10
  52. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01-init.md +191 -191
  53. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01b-continue.md +153 -153
  54. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-02-discovery.md +224 -224
  55. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
  56. package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
  57. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-03-success.md +226 -226
  58. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-04-journeys.md +213 -213
  59. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-05-domain.md +207 -207
  60. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-06-innovation.md +226 -226
  61. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-07-project-type.md +237 -237
  62. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-08-scoping.md +228 -228
  63. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-09-functional.md +231 -231
  64. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-10-nonfunctional.md +242 -242
  65. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-11-polish.md +217 -217
  66. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-12-complete.md +124 -124
  67. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01-discovery.md +247 -247
  68. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01b-legacy-conversion.md +208 -208
  69. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-02-review.md +249 -249
  70. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-03-edit.md +253 -253
  71. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-04-complete.md +168 -168
  72. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-01-discovery.md +226 -218
  73. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02-format-detection.md +191 -191
  74. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02b-parity-check.md +209 -209
  75. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-03-density-validation.md +174 -174
  76. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-04-brief-coverage-validation.md +214 -214
  77. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-05-measurability-validation.md +228 -228
  78. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-06-traceability-validation.md +217 -217
  79. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-07-implementation-leakage-validation.md +205 -205
  80. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-08-domain-compliance-validation.md +243 -243
  81. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-09-project-type-validation.md +263 -263
  82. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-10-smart-validation.md +209 -209
  83. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-11-holistic-quality-validation.md +264 -264
  84. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-12-completeness-validation.md +242 -242
  85. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-13-report-complete.md +231 -231
  86. package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/templates/prd-template.md +10 -10
  87. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
  88. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
  89. package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -0
  90. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  91. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  92. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  93. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  94. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  95. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  96. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  97. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  98. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  99. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  100. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  101. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
  102. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  103. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  104. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -171
  105. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  106. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +42 -43
  107. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -190
  108. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -178
  109. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -179
  110. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -139
  111. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -252
  112. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -135
  113. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  114. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -55
  115. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  116. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +12 -10
  117. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  118. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -153
  119. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  120. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  121. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -331
  122. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -318
  123. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -359
  124. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  125. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -359
  126. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -76
  127. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -50
  128. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  129. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  130. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  131. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -149
  132. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  133. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -59
  134. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  135. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +226 -226
  136. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +44 -51
  137. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -288
  138. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +207 -206
  139. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +54 -60
  140. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  141. package/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +346 -345
  142. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  143. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +53 -61
  144. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -80
  145. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -410
  146. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +21 -27
  147. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -1443
  148. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +53 -58
  149. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  150. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -225
  151. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  152. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -54
  153. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -229
  154. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -36
  155. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -156
  156. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -120
  157. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -113
  158. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -113
  159. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -106
  160. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -140
  161. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -50
  162. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +191 -189
  163. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -144
  164. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +127 -128
  165. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -191
  166. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -74
  167. package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -79
  168. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  169. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  170. package/bmad/bmm/workflows/document-project/instructions.md +130 -221
  171. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  172. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  173. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  174. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  175. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  176. package/bmad/bmm/workflows/document-project/workflow.yaml +22 -30
  177. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  178. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  179. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  180. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  181. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
  182. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
  183. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
  184. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
  185. package/bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
  186. package/bmad/bmm/workflows/qa/automate/checklist.md +33 -0
  187. package/bmad/bmm/workflows/qa/automate/instructions.md +110 -0
  188. package/bmad/bmm/workflows/qa/automate/workflow.yaml +44 -0
  189. package/bmad/core/agents/bmad-master.agent.yaml +30 -30
  190. package/bmad/core/module-help.csv +9 -11
  191. package/bmad/core/module.yaml +25 -25
  192. package/bmad/core/tasks/editorial-review-prose.xml +102 -91
  193. package/bmad/core/tasks/editorial-review-structure.xml +209 -198
  194. package/bmad/core/tasks/help.md +85 -0
  195. package/bmad/core/tasks/index-docs.xml +64 -64
  196. package/bmad/core/tasks/review-adversarial-general.xml +48 -48
  197. package/bmad/core/tasks/shard-doc.xml +107 -108
  198. package/bmad/core/tasks/workflow.xml +234 -234
  199. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  200. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  201. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  202. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  203. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  204. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  205. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  206. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  207. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  208. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -399
  209. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  210. package/bmad/core/workflows/brainstorming/template.md +15 -15
  211. package/bmad/core/workflows/brainstorming/workflow.md +58 -58
  212. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -138
  213. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -187
  214. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +168 -157
  215. package/bmad/core/workflows/party-mode/workflow.md +194 -194
  216. package/bundled-versions.json +3 -0
  217. package/dist/cli.js +61 -6
  218. package/dist/commands/check-updates.d.ts +5 -0
  219. package/dist/commands/check-updates.js +63 -0
  220. package/dist/commands/doctor.d.ts +39 -1
  221. package/dist/commands/doctor.js +348 -79
  222. package/dist/commands/init.d.ts +2 -0
  223. package/dist/commands/init.js +41 -15
  224. package/dist/commands/status.d.ts +7 -1
  225. package/dist/commands/status.js +111 -42
  226. package/dist/commands/upgrade.d.ts +7 -1
  227. package/dist/commands/upgrade.js +43 -12
  228. package/dist/installer.d.ts +19 -2
  229. package/dist/installer.js +305 -66
  230. package/dist/transition/artifacts.d.ts +2 -0
  231. package/dist/transition/artifacts.js +46 -0
  232. package/dist/transition/context.d.ts +19 -0
  233. package/dist/transition/context.js +261 -0
  234. package/dist/transition/fix-plan.d.ts +15 -0
  235. package/dist/transition/fix-plan.js +94 -0
  236. package/dist/transition/index.d.ts +9 -0
  237. package/dist/transition/index.js +16 -0
  238. package/dist/transition/orchestration.d.ts +2 -0
  239. package/dist/transition/orchestration.js +243 -0
  240. package/dist/transition/specs-changelog.d.ts +3 -0
  241. package/dist/transition/specs-changelog.js +75 -0
  242. package/dist/transition/specs-index.d.ts +22 -0
  243. package/dist/transition/specs-index.js +157 -0
  244. package/dist/transition/story-parsing.d.ts +7 -0
  245. package/dist/transition/story-parsing.js +124 -0
  246. package/dist/transition/tech-stack.d.ts +3 -0
  247. package/dist/transition/tech-stack.js +79 -0
  248. package/dist/transition/types.d.ts +60 -0
  249. package/dist/transition/types.js +1 -0
  250. package/dist/utils/config.d.ts +4 -0
  251. package/dist/utils/config.js +14 -4
  252. package/dist/utils/constants.d.ts +70 -0
  253. package/dist/utils/constants.js +97 -0
  254. package/dist/utils/dryrun.d.ts +7 -0
  255. package/dist/utils/dryrun.js +48 -0
  256. package/dist/utils/errors.d.ts +63 -0
  257. package/dist/utils/errors.js +86 -0
  258. package/dist/utils/file-system.d.ts +24 -0
  259. package/dist/utils/file-system.js +99 -0
  260. package/dist/utils/github.d.ts +83 -0
  261. package/dist/utils/github.js +230 -0
  262. package/dist/utils/json.js +3 -3
  263. package/dist/utils/logger.d.ts +6 -0
  264. package/dist/utils/logger.js +27 -0
  265. package/dist/utils/state.d.ts +4 -7
  266. package/dist/utils/state.js +147 -26
  267. package/dist/utils/validate.d.ts +40 -0
  268. package/dist/utils/validate.js +175 -1
  269. package/package.json +75 -59
  270. package/ralph/RALPH-REFERENCE.md +412 -0
  271. package/ralph/lib/circuit_breaker.sh +463 -330
  272. package/ralph/lib/date_utils.sh +104 -53
  273. package/ralph/lib/enable_core.sh +815 -0
  274. package/ralph/lib/response_analyzer.sh +884 -768
  275. package/ralph/lib/task_sources.sh +577 -0
  276. package/ralph/lib/timeout_utils.sh +145 -145
  277. package/ralph/lib/wizard_utils.sh +547 -0
  278. package/ralph/ralph_import.sh +636 -0
  279. package/ralph/ralph_loop.sh +1793 -1391
  280. package/ralph/ralph_monitor.sh +125 -0
  281. package/ralph/templates/AGENT.md +158 -158
  282. package/ralph/templates/PROMPT.md +285 -292
  283. package/ralph/templates/fix_plan.md +27 -27
  284. package/ralph/templates/ralphrc.template +102 -0
  285. package/ralph/templates/specs/.gitkeep +1 -1
  286. package/slash-commands/advanced-elicitation.md +1 -1
  287. package/slash-commands/adversarial-review.md +1 -1
  288. package/slash-commands/analyst.md +1 -1
  289. package/slash-commands/architect.md +1 -1
  290. package/slash-commands/bmad-help.md +1 -1
  291. package/slash-commands/bmalph-implement.md +152 -152
  292. package/slash-commands/brainstorm-project.md +1 -1
  293. package/slash-commands/brainstorming.md +1 -1
  294. package/slash-commands/correct-course.md +1 -1
  295. package/slash-commands/create-architecture.md +1 -1
  296. package/slash-commands/create-brief.md +1 -1
  297. package/slash-commands/create-epics-stories.md +1 -1
  298. package/slash-commands/create-prd.md +1 -1
  299. package/slash-commands/create-story.md +1 -1
  300. package/slash-commands/create-ux.md +1 -1
  301. package/slash-commands/dev.md +1 -1
  302. package/slash-commands/document-project.md +1 -1
  303. package/slash-commands/domain-research.md +1 -1
  304. package/slash-commands/editorial-prose.md +1 -1
  305. package/slash-commands/editorial-structure.md +1 -1
  306. package/slash-commands/execute-workflow.md +1 -1
  307. package/slash-commands/generate-project-context.md +1 -0
  308. package/slash-commands/implementation-readiness.md +1 -1
  309. package/slash-commands/index-docs.md +1 -1
  310. package/slash-commands/market-research.md +1 -1
  311. package/slash-commands/party-mode.md +1 -1
  312. package/slash-commands/pm.md +1 -1
  313. package/slash-commands/qa-automate.md +1 -0
  314. package/slash-commands/qa.md +1 -0
  315. package/slash-commands/quick-dev.md +1 -1
  316. package/slash-commands/quick-flow-solo-dev.md +1 -1
  317. package/slash-commands/retrospective.md +1 -1
  318. package/slash-commands/shard-doc.md +1 -1
  319. package/slash-commands/sm.md +1 -1
  320. package/slash-commands/sprint-planning.md +1 -1
  321. package/slash-commands/sprint-status.md +1 -1
  322. package/slash-commands/tech-spec.md +1 -1
  323. package/slash-commands/tech-writer.md +1 -0
  324. package/slash-commands/technical-research.md +1 -1
  325. package/slash-commands/ux-designer.md +1 -1
  326. package/slash-commands/validate-architecture.md +1 -1
  327. package/slash-commands/validate-brief.md +1 -1
  328. package/slash-commands/validate-epics-stories.md +1 -1
  329. package/slash-commands/validate-prd.md +1 -1
  330. package/slash-commands/validate-story.md +1 -1
  331. package/slash-commands/validate-ux.md +1 -1
  332. package/bmad/bmm/agents/tea.agent.yaml +0 -63
  333. package/bmad/bmm/sub-modules/claude-code/config.yaml +0 -4
  334. package/bmad/bmm/sub-modules/claude-code/injections.yaml +0 -242
  335. package/bmad/bmm/sub-modules/claude-code/readme.md +0 -87
  336. package/bmad/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +0 -350
  337. package/bmad/bmm/testarch/knowledge/api-request.md +0 -442
  338. package/bmad/bmm/testarch/knowledge/api-testing-patterns.md +0 -843
  339. package/bmad/bmm/testarch/knowledge/auth-session.md +0 -552
  340. package/bmad/bmm/testarch/knowledge/burn-in.md +0 -273
  341. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  342. package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  343. package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  344. package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  345. package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  346. package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  347. package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  348. package/bmad/bmm/testarch/knowledge/file-utils.md +0 -463
  349. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  350. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +0 -382
  351. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +0 -430
  352. package/bmad/bmm/testarch/knowledge/log.md +0 -429
  353. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +0 -405
  354. package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
  355. package/bmad/bmm/testarch/knowledge/network-recorder.md +0 -527
  356. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  357. package/bmad/bmm/testarch/knowledge/overview.md +0 -286
  358. package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  359. package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  360. package/bmad/bmm/testarch/knowledge/recurse.md +0 -421
  361. package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  362. package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  363. package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  364. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  365. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  366. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  367. package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  368. package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  369. package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  370. package/bmad/bmm/testarch/tea-index.csv +0 -35
  371. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +0 -200
  372. package/bmad/bmm/workflows/1-analysis/research/workflow.md +0 -173
  373. package/bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +0 -433
  374. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +0 -150
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +0 -59
  376. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +0 -90
  377. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +0 -127
  378. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +0 -39
  379. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +0 -130
  380. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +0 -27
  381. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +0 -43
  382. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +0 -141
  383. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +0 -27
  384. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +0 -49
  385. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +0 -241
  386. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +0 -27
  387. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +0 -38
  388. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +0 -133
  389. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +0 -27
  390. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  391. package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -374
  392. package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -806
  393. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -47
  394. package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -582
  395. package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1324
  396. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -54
  397. package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -247
  398. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -198
  399. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -149
  400. package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -536
  401. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -47
  402. package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -320
  403. package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -481
  404. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -49
  405. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -407
  406. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -726
  407. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -461
  408. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -49
  409. package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -407
  410. package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -1158
  411. package/bmad/bmm/workflows/testarch/test-design/test-design-architecture-template.md +0 -213
  412. package/bmad/bmm/workflows/testarch/test-design/test-design-qa-template.md +0 -286
  413. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -294
  414. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -71
  415. package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -472
  416. package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -628
  417. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -390
  418. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -48
  419. package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -642
  420. package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1030
  421. package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -675
  422. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -57
  423. package/bmad/core/resources/excalidraw/README.md +0 -160
  424. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +0 -127
  425. package/bmad/core/resources/excalidraw/library-loader.md +0 -50
  426. package/bmad/core/resources/excalidraw/validate-json-instructions.md +0 -79
  427. package/bmad/core/tasks/bmad-help.md +0 -62
  428. package/dist/commands/guide.d.ts +0 -1
  429. package/dist/commands/guide.js +0 -19
  430. package/dist/commands/implement.d.ts +0 -1
  431. package/dist/commands/implement.js +0 -83
  432. package/dist/commands/plan.d.ts +0 -5
  433. package/dist/commands/plan.js +0 -44
  434. package/dist/commands/reset.d.ts +0 -5
  435. package/dist/commands/reset.js +0 -35
  436. package/dist/commands/resume.d.ts +0 -1
  437. package/dist/commands/resume.js +0 -44
  438. package/dist/commands/start.d.ts +0 -5
  439. package/dist/commands/start.js +0 -54
  440. package/dist/transition.d.ts +0 -52
  441. package/dist/transition.js +0 -656
  442. package/slash-commands/atdd.md +0 -1
  443. package/slash-commands/continuous-integration.md +0 -1
  444. package/slash-commands/create-dataflow.md +0 -1
  445. package/slash-commands/create-diagram.md +0 -1
  446. package/slash-commands/create-flowchart.md +0 -1
  447. package/slash-commands/create-wireframe.md +0 -1
  448. package/slash-commands/nfr-assess.md +0 -1
  449. package/slash-commands/tea.md +0 -1
  450. package/slash-commands/test-automate.md +0 -1
  451. package/slash-commands/test-design.md +0 -1
  452. package/slash-commands/test-framework.md +0 -1
  453. package/slash-commands/test-review.md +0 -1
  454. package/slash-commands/test-trace.md +0 -1
  455. package/slash-commands/validate-test-design.md +0 -1
@@ -1,843 +0,0 @@
1
- # API Testing Patterns
2
-
3
- ## Principle
4
-
5
- Test APIs and backend services directly without browser overhead. Use Playwright's `request` context for HTTP operations, `apiRequest` utility for enhanced features, and `recurse` for async operations. Pure API tests run faster, are more stable, and provide better coverage for service-layer logic.
6
-
7
- ## Rationale
8
-
9
- Many teams over-rely on E2E/browser tests when API tests would be more appropriate:
10
-
11
- - **Slower feedback**: Browser tests take seconds, API tests take milliseconds
12
- - **More brittle**: UI changes break tests even when API works correctly
13
- - **Wrong abstraction**: Testing business logic through UI layers adds noise
14
- - **Resource heavy**: Browsers consume memory and CPU
15
-
16
- API-first testing provides:
17
-
18
- - **Fast execution**: No browser startup, no rendering, no JavaScript execution
19
- - **Direct validation**: Test exactly what the service returns
20
- - **Better isolation**: Test service logic independent of UI
21
- - **Easier debugging**: Clear request/response without DOM noise
22
- - **Contract validation**: Verify API contracts explicitly
23
-
24
- ## When to Use API Tests vs E2E Tests
25
-
26
- | Scenario | API Test | E2E Test |
27
- |----------|----------|----------|
28
- | CRUD operations | ✅ Primary | ❌ Overkill |
29
- | Business logic validation | ✅ Primary | ❌ Overkill |
30
- | Error handling (4xx, 5xx) | ✅ Primary | ⚠️ Supplement |
31
- | Authentication flows | ✅ Primary | ⚠️ Supplement |
32
- | Data transformation | ✅ Primary | ❌ Overkill |
33
- | User journeys | ❌ Can't test | ✅ Primary |
34
- | Visual regression | ❌ Can't test | ✅ Primary |
35
- | Cross-browser issues | ❌ Can't test | ✅ Primary |
36
-
37
- **Rule of thumb**: If you're testing what the server returns (not how it looks), use API tests.
38
-
39
- ## Pattern Examples
40
-
41
- ### Example 1: Pure API Test (No Browser)
42
-
43
- **Context**: Test REST API endpoints directly without any browser context.
44
-
45
- **Implementation**:
46
-
47
- ```typescript
48
- // tests/api/users.spec.ts
49
- import { test, expect } from '@playwright/test';
50
-
51
- // No page, no browser - just API
52
- test.describe('Users API', () => {
53
- test('should create user', async ({ request }) => {
54
- const response = await request.post('/api/users', {
55
- data: {
56
- name: 'John Doe',
57
- email: 'john@example.com',
58
- role: 'user',
59
- },
60
- });
61
-
62
- expect(response.status()).toBe(201);
63
-
64
- const user = await response.json();
65
- expect(user.id).toBeDefined();
66
- expect(user.name).toBe('John Doe');
67
- expect(user.email).toBe('john@example.com');
68
- });
69
-
70
- test('should get user by ID', async ({ request }) => {
71
- // Create user first
72
- const createResponse = await request.post('/api/users', {
73
- data: { name: 'Jane Doe', email: 'jane@example.com' },
74
- });
75
- const { id } = await createResponse.json();
76
-
77
- // Get user
78
- const getResponse = await request.get(`/api/users/${id}`);
79
- expect(getResponse.status()).toBe(200);
80
-
81
- const user = await getResponse.json();
82
- expect(user.id).toBe(id);
83
- expect(user.name).toBe('Jane Doe');
84
- });
85
-
86
- test('should return 404 for non-existent user', async ({ request }) => {
87
- const response = await request.get('/api/users/non-existent-id');
88
- expect(response.status()).toBe(404);
89
-
90
- const error = await response.json();
91
- expect(error.code).toBe('USER_NOT_FOUND');
92
- });
93
-
94
- test('should validate required fields', async ({ request }) => {
95
- const response = await request.post('/api/users', {
96
- data: { name: 'Missing Email' }, // email is required
97
- });
98
-
99
- expect(response.status()).toBe(400);
100
-
101
- const error = await response.json();
102
- expect(error.code).toBe('VALIDATION_ERROR');
103
- expect(error.details).toContainEqual(
104
- expect.objectContaining({ field: 'email', message: expect.any(String) })
105
- );
106
- });
107
- });
108
- ```
109
-
110
- **Key Points**:
111
-
112
- - No `page` fixture needed - only `request`
113
- - Tests run without browser overhead
114
- - Direct HTTP assertions
115
- - Clear error handling tests
116
-
117
- ### Example 2: API Test with apiRequest Utility
118
-
119
- **Context**: Use enhanced apiRequest for schema validation, retry, and type safety.
120
-
121
- **Implementation**:
122
-
123
- ```typescript
124
- // tests/api/orders.spec.ts
125
- import { test, expect } from '@seontechnologies/playwright-utils/api-request/fixtures';
126
- import { z } from 'zod';
127
-
128
- // Define schema for type safety and validation
129
- const OrderSchema = z.object({
130
- id: z.string().uuid(),
131
- userId: z.string(),
132
- items: z.array(
133
- z.object({
134
- productId: z.string(),
135
- quantity: z.number().positive(),
136
- price: z.number().positive(),
137
- })
138
- ),
139
- total: z.number().positive(),
140
- status: z.enum(['pending', 'processing', 'shipped', 'delivered']),
141
- createdAt: z.string().datetime(),
142
- });
143
-
144
- type Order = z.infer<typeof OrderSchema>;
145
-
146
- test.describe('Orders API', () => {
147
- test('should create order with schema validation', async ({ apiRequest }) => {
148
- const { status, body } = await apiRequest<Order>({
149
- method: 'POST',
150
- path: '/api/orders',
151
- body: {
152
- userId: 'user-123',
153
- items: [
154
- { productId: 'prod-1', quantity: 2, price: 29.99 },
155
- { productId: 'prod-2', quantity: 1, price: 49.99 },
156
- ],
157
- },
158
- validateSchema: OrderSchema, // Validates response matches schema
159
- });
160
-
161
- expect(status).toBe(201);
162
- expect(body.id).toBeDefined();
163
- expect(body.status).toBe('pending');
164
- expect(body.total).toBe(109.97); // 2*29.99 + 49.99
165
- });
166
-
167
- test('should handle server errors with retry', async ({ apiRequest }) => {
168
- // apiRequest retries 5xx errors by default
169
- const { status, body } = await apiRequest({
170
- method: 'GET',
171
- path: '/api/orders/order-123',
172
- retryConfig: {
173
- maxRetries: 3,
174
- retryDelay: 1000,
175
- },
176
- });
177
-
178
- expect(status).toBe(200);
179
- });
180
-
181
- test('should list orders with pagination', async ({ apiRequest }) => {
182
- const { status, body } = await apiRequest<{ orders: Order[]; total: number; page: number }>({
183
- method: 'GET',
184
- path: '/api/orders',
185
- params: { page: 1, limit: 10, status: 'pending' },
186
- });
187
-
188
- expect(status).toBe(200);
189
- expect(body.orders).toHaveLength(10);
190
- expect(body.total).toBeGreaterThan(10);
191
- expect(body.page).toBe(1);
192
- });
193
- });
194
- ```
195
-
196
- **Key Points**:
197
-
198
- - Zod schema for runtime validation AND TypeScript types
199
- - `validateSchema` throws if response doesn't match
200
- - Built-in retry for transient failures
201
- - Type-safe `body` access
202
-
203
- ### Example 3: Microservice-to-Microservice Testing
204
-
205
- **Context**: Test service interactions without browser - validate API contracts between services.
206
-
207
- **Implementation**:
208
-
209
- ```typescript
210
- // tests/api/service-integration.spec.ts
211
- import { test, expect } from '@seontechnologies/playwright-utils/fixtures';
212
-
213
- test.describe('Service Integration', () => {
214
- const USER_SERVICE_URL = process.env.USER_SERVICE_URL || 'http://localhost:3001';
215
- const ORDER_SERVICE_URL = process.env.ORDER_SERVICE_URL || 'http://localhost:3002';
216
- const INVENTORY_SERVICE_URL = process.env.INVENTORY_SERVICE_URL || 'http://localhost:3003';
217
-
218
- test('order service should validate user exists', async ({ apiRequest }) => {
219
- // Create user in user-service
220
- const { body: user } = await apiRequest({
221
- method: 'POST',
222
- path: '/api/users',
223
- baseUrl: USER_SERVICE_URL,
224
- body: { name: 'Test User', email: 'test@example.com' },
225
- });
226
-
227
- // Create order in order-service (should validate user via user-service)
228
- const { status, body: order } = await apiRequest({
229
- method: 'POST',
230
- path: '/api/orders',
231
- baseUrl: ORDER_SERVICE_URL,
232
- body: {
233
- userId: user.id,
234
- items: [{ productId: 'prod-1', quantity: 1 }],
235
- },
236
- });
237
-
238
- expect(status).toBe(201);
239
- expect(order.userId).toBe(user.id);
240
- });
241
-
242
- test('order service should reject invalid user', async ({ apiRequest }) => {
243
- const { status, body } = await apiRequest({
244
- method: 'POST',
245
- path: '/api/orders',
246
- baseUrl: ORDER_SERVICE_URL,
247
- body: {
248
- userId: 'non-existent-user',
249
- items: [{ productId: 'prod-1', quantity: 1 }],
250
- },
251
- });
252
-
253
- expect(status).toBe(400);
254
- expect(body.code).toBe('INVALID_USER');
255
- });
256
-
257
- test('order should decrease inventory', async ({ apiRequest, recurse }) => {
258
- // Get initial inventory
259
- const { body: initialInventory } = await apiRequest({
260
- method: 'GET',
261
- path: '/api/inventory/prod-1',
262
- baseUrl: INVENTORY_SERVICE_URL,
263
- });
264
-
265
- // Create order
266
- await apiRequest({
267
- method: 'POST',
268
- path: '/api/orders',
269
- baseUrl: ORDER_SERVICE_URL,
270
- body: {
271
- userId: 'user-123',
272
- items: [{ productId: 'prod-1', quantity: 2 }],
273
- },
274
- });
275
-
276
- // Poll for inventory update (eventual consistency)
277
- const { body: updatedInventory } = await recurse(
278
- () =>
279
- apiRequest({
280
- method: 'GET',
281
- path: '/api/inventory/prod-1',
282
- baseUrl: INVENTORY_SERVICE_URL,
283
- }),
284
- (response) => response.body.quantity === initialInventory.quantity - 2,
285
- { timeout: 10000, interval: 500 }
286
- );
287
-
288
- expect(updatedInventory.quantity).toBe(initialInventory.quantity - 2);
289
- });
290
- });
291
- ```
292
-
293
- **Key Points**:
294
-
295
- - Multiple service URLs for microservice testing
296
- - Tests service-to-service communication
297
- - Uses `recurse` for eventual consistency
298
- - No browser needed for full integration testing
299
-
300
- ### Example 4: GraphQL API Testing
301
-
302
- **Context**: Test GraphQL endpoints with queries and mutations.
303
-
304
- **Implementation**:
305
-
306
- ```typescript
307
- // tests/api/graphql.spec.ts
308
- import { test, expect } from '@seontechnologies/playwright-utils/api-request/fixtures';
309
-
310
- const GRAPHQL_ENDPOINT = '/graphql';
311
-
312
- test.describe('GraphQL API', () => {
313
- test('should query users', async ({ apiRequest }) => {
314
- const query = `
315
- query GetUsers($limit: Int) {
316
- users(limit: $limit) {
317
- id
318
- name
319
- email
320
- role
321
- }
322
- }
323
- `;
324
-
325
- const { status, body } = await apiRequest({
326
- method: 'POST',
327
- path: GRAPHQL_ENDPOINT,
328
- body: {
329
- query,
330
- variables: { limit: 10 },
331
- },
332
- });
333
-
334
- expect(status).toBe(200);
335
- expect(body.errors).toBeUndefined();
336
- expect(body.data.users).toHaveLength(10);
337
- expect(body.data.users[0]).toHaveProperty('id');
338
- expect(body.data.users[0]).toHaveProperty('name');
339
- });
340
-
341
- test('should create user via mutation', async ({ apiRequest }) => {
342
- const mutation = `
343
- mutation CreateUser($input: CreateUserInput!) {
344
- createUser(input: $input) {
345
- id
346
- name
347
- email
348
- }
349
- }
350
- `;
351
-
352
- const { status, body } = await apiRequest({
353
- method: 'POST',
354
- path: GRAPHQL_ENDPOINT,
355
- body: {
356
- query: mutation,
357
- variables: {
358
- input: {
359
- name: 'GraphQL User',
360
- email: 'graphql@example.com',
361
- },
362
- },
363
- },
364
- });
365
-
366
- expect(status).toBe(200);
367
- expect(body.errors).toBeUndefined();
368
- expect(body.data.createUser.id).toBeDefined();
369
- expect(body.data.createUser.name).toBe('GraphQL User');
370
- });
371
-
372
- test('should handle GraphQL errors', async ({ apiRequest }) => {
373
- const query = `
374
- query GetUser($id: ID!) {
375
- user(id: $id) {
376
- id
377
- name
378
- }
379
- }
380
- `;
381
-
382
- const { status, body } = await apiRequest({
383
- method: 'POST',
384
- path: GRAPHQL_ENDPOINT,
385
- body: {
386
- query,
387
- variables: { id: 'non-existent' },
388
- },
389
- });
390
-
391
- expect(status).toBe(200); // GraphQL returns 200 even for errors
392
- expect(body.errors).toBeDefined();
393
- expect(body.errors[0].message).toContain('not found');
394
- expect(body.data.user).toBeNull();
395
- });
396
-
397
- test('should handle validation errors', async ({ apiRequest }) => {
398
- const mutation = `
399
- mutation CreateUser($input: CreateUserInput!) {
400
- createUser(input: $input) {
401
- id
402
- }
403
- }
404
- `;
405
-
406
- const { status, body } = await apiRequest({
407
- method: 'POST',
408
- path: GRAPHQL_ENDPOINT,
409
- body: {
410
- query: mutation,
411
- variables: {
412
- input: {
413
- name: '', // Invalid: empty name
414
- email: 'invalid-email', // Invalid: bad format
415
- },
416
- },
417
- },
418
- });
419
-
420
- expect(status).toBe(200);
421
- expect(body.errors).toBeDefined();
422
- expect(body.errors[0].extensions.code).toBe('BAD_USER_INPUT');
423
- });
424
- });
425
- ```
426
-
427
- **Key Points**:
428
-
429
- - GraphQL queries and mutations via POST
430
- - Variables passed in request body
431
- - GraphQL returns 200 even for errors (check `body.errors`)
432
- - Test validation and business logic errors
433
-
434
- ### Example 5: Database Seeding and Cleanup via API
435
-
436
- **Context**: Use API calls to set up and tear down test data without direct database access.
437
-
438
- **Implementation**:
439
-
440
- ```typescript
441
- // tests/api/with-data-setup.spec.ts
442
- import { test, expect } from '@seontechnologies/playwright-utils/fixtures';
443
-
444
- test.describe('Orders with Data Setup', () => {
445
- let testUser: { id: string; email: string };
446
- let testProducts: Array<{ id: string; name: string; price: number }>;
447
-
448
- test.beforeAll(async ({ request }) => {
449
- // Seed user via API
450
- const userResponse = await request.post('/api/users', {
451
- data: {
452
- name: 'Test User',
453
- email: `test-${Date.now()}@example.com`,
454
- },
455
- });
456
- testUser = await userResponse.json();
457
-
458
- // Seed products via API
459
- testProducts = [];
460
- for (const product of [
461
- { name: 'Widget A', price: 29.99 },
462
- { name: 'Widget B', price: 49.99 },
463
- { name: 'Widget C', price: 99.99 },
464
- ]) {
465
- const productResponse = await request.post('/api/products', {
466
- data: product,
467
- });
468
- testProducts.push(await productResponse.json());
469
- }
470
- });
471
-
472
- test.afterAll(async ({ request }) => {
473
- // Cleanup via API
474
- if (testUser?.id) {
475
- await request.delete(`/api/users/${testUser.id}`);
476
- }
477
- for (const product of testProducts) {
478
- await request.delete(`/api/products/${product.id}`);
479
- }
480
- });
481
-
482
- test('should create order with seeded data', async ({ apiRequest }) => {
483
- const { status, body } = await apiRequest({
484
- method: 'POST',
485
- path: '/api/orders',
486
- body: {
487
- userId: testUser.id,
488
- items: [
489
- { productId: testProducts[0].id, quantity: 2 },
490
- { productId: testProducts[1].id, quantity: 1 },
491
- ],
492
- },
493
- });
494
-
495
- expect(status).toBe(201);
496
- expect(body.userId).toBe(testUser.id);
497
- expect(body.items).toHaveLength(2);
498
- expect(body.total).toBe(2 * 29.99 + 49.99);
499
- });
500
-
501
- test('should list user orders', async ({ apiRequest }) => {
502
- // Create an order first
503
- await apiRequest({
504
- method: 'POST',
505
- path: '/api/orders',
506
- body: {
507
- userId: testUser.id,
508
- items: [{ productId: testProducts[2].id, quantity: 1 }],
509
- },
510
- });
511
-
512
- // List orders for user
513
- const { status, body } = await apiRequest({
514
- method: 'GET',
515
- path: '/api/orders',
516
- params: { userId: testUser.id },
517
- });
518
-
519
- expect(status).toBe(200);
520
- expect(body.orders.length).toBeGreaterThanOrEqual(1);
521
- expect(body.orders.every((o: any) => o.userId === testUser.id)).toBe(true);
522
- });
523
- });
524
- ```
525
-
526
- **Key Points**:
527
-
528
- - `beforeAll`/`afterAll` for test data setup/cleanup
529
- - API-based seeding (no direct DB access needed)
530
- - Unique emails to prevent conflicts in parallel runs
531
- - Cleanup after all tests complete
532
-
533
- ### Example 6: Background Job Testing with Recurse
534
-
535
- **Context**: Test async operations like background jobs, webhooks, and eventual consistency.
536
-
537
- **Implementation**:
538
-
539
- ```typescript
540
- // tests/api/background-jobs.spec.ts
541
- import { test, expect } from '@seontechnologies/playwright-utils/fixtures';
542
-
543
- test.describe('Background Jobs', () => {
544
- test('should process export job', async ({ apiRequest, recurse }) => {
545
- // Trigger export job
546
- const { body: job } = await apiRequest({
547
- method: 'POST',
548
- path: '/api/exports',
549
- body: {
550
- type: 'users',
551
- format: 'csv',
552
- filters: { createdAfter: '2024-01-01' },
553
- },
554
- });
555
-
556
- expect(job.id).toBeDefined();
557
- expect(job.status).toBe('pending');
558
-
559
- // Poll until job completes
560
- const { body: completedJob } = await recurse(
561
- () => apiRequest({ method: 'GET', path: `/api/exports/${job.id}` }),
562
- (response) => response.body.status === 'completed',
563
- {
564
- timeout: 60000,
565
- interval: 2000,
566
- log: `Waiting for export job ${job.id} to complete`,
567
- }
568
- );
569
-
570
- expect(completedJob.status).toBe('completed');
571
- expect(completedJob.downloadUrl).toBeDefined();
572
- expect(completedJob.recordCount).toBeGreaterThan(0);
573
- });
574
-
575
- test('should handle job failure gracefully', async ({ apiRequest, recurse }) => {
576
- // Trigger job that will fail
577
- const { body: job } = await apiRequest({
578
- method: 'POST',
579
- path: '/api/exports',
580
- body: {
581
- type: 'invalid-type', // This will cause failure
582
- format: 'csv',
583
- },
584
- });
585
-
586
- // Poll until job fails
587
- const { body: failedJob } = await recurse(
588
- () => apiRequest({ method: 'GET', path: `/api/exports/${job.id}` }),
589
- (response) => ['completed', 'failed'].includes(response.body.status),
590
- { timeout: 30000 }
591
- );
592
-
593
- expect(failedJob.status).toBe('failed');
594
- expect(failedJob.error).toBeDefined();
595
- expect(failedJob.error.code).toBe('INVALID_EXPORT_TYPE');
596
- });
597
-
598
- test('should process webhook delivery', async ({ apiRequest, recurse }) => {
599
- // Trigger action that sends webhook
600
- const { body: order } = await apiRequest({
601
- method: 'POST',
602
- path: '/api/orders',
603
- body: {
604
- userId: 'user-123',
605
- items: [{ productId: 'prod-1', quantity: 1 }],
606
- webhookUrl: 'https://webhook.site/test-endpoint',
607
- },
608
- });
609
-
610
- // Poll for webhook delivery status
611
- const { body: webhookStatus } = await recurse(
612
- () => apiRequest({ method: 'GET', path: `/api/webhooks/order/${order.id}` }),
613
- (response) => response.body.delivered === true,
614
- { timeout: 30000, interval: 1000 }
615
- );
616
-
617
- expect(webhookStatus.delivered).toBe(true);
618
- expect(webhookStatus.deliveredAt).toBeDefined();
619
- expect(webhookStatus.responseStatus).toBe(200);
620
- });
621
- });
622
- ```
623
-
624
- **Key Points**:
625
-
626
- - `recurse` for polling async operations
627
- - Test both success and failure scenarios
628
- - Configurable timeout and interval
629
- - Log messages for debugging
630
-
631
- ### Example 7: Service Authentication (No Browser)
632
-
633
- **Context**: Test authenticated API endpoints using tokens directly - no browser login needed.
634
-
635
- **Implementation**:
636
-
637
- ```typescript
638
- // tests/api/authenticated.spec.ts
639
- import { test, expect } from '@seontechnologies/playwright-utils/fixtures';
640
-
641
- test.describe('Authenticated API Tests', () => {
642
- let authToken: string;
643
-
644
- test.beforeAll(async ({ request }) => {
645
- // Get token via API (no browser!)
646
- const response = await request.post('/api/auth/login', {
647
- data: {
648
- email: process.env.TEST_USER_EMAIL,
649
- password: process.env.TEST_USER_PASSWORD,
650
- },
651
- });
652
-
653
- const { token } = await response.json();
654
- authToken = token;
655
- });
656
-
657
- test('should access protected endpoint with token', async ({ apiRequest }) => {
658
- const { status, body } = await apiRequest({
659
- method: 'GET',
660
- path: '/api/me',
661
- headers: {
662
- Authorization: `Bearer ${authToken}`,
663
- },
664
- });
665
-
666
- expect(status).toBe(200);
667
- expect(body.email).toBe(process.env.TEST_USER_EMAIL);
668
- });
669
-
670
- test('should reject request without token', async ({ apiRequest }) => {
671
- const { status, body } = await apiRequest({
672
- method: 'GET',
673
- path: '/api/me',
674
- // No Authorization header
675
- });
676
-
677
- expect(status).toBe(401);
678
- expect(body.code).toBe('UNAUTHORIZED');
679
- });
680
-
681
- test('should reject expired token', async ({ apiRequest }) => {
682
- const expiredToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'; // Expired token
683
-
684
- const { status, body } = await apiRequest({
685
- method: 'GET',
686
- path: '/api/me',
687
- headers: {
688
- Authorization: `Bearer ${expiredToken}`,
689
- },
690
- });
691
-
692
- expect(status).toBe(401);
693
- expect(body.code).toBe('TOKEN_EXPIRED');
694
- });
695
-
696
- test('should handle role-based access', async ({ apiRequest }) => {
697
- // User token (non-admin)
698
- const { status } = await apiRequest({
699
- method: 'GET',
700
- path: '/api/admin/users',
701
- headers: {
702
- Authorization: `Bearer ${authToken}`,
703
- },
704
- });
705
-
706
- expect(status).toBe(403); // Forbidden for non-admin
707
- });
708
- });
709
- ```
710
-
711
- **Key Points**:
712
-
713
- - Token obtained via API login (no browser)
714
- - Token reused across all tests in describe block
715
- - Test auth, expired tokens, and RBAC
716
- - Pure API testing without UI
717
-
718
- ## API Test Configuration
719
-
720
- ### Playwright Config for API-Only Tests
721
-
722
- ```typescript
723
- // playwright.config.ts
724
- import { defineConfig } from '@playwright/test';
725
-
726
- export default defineConfig({
727
- testDir: './tests/api',
728
-
729
- // No browser needed for API tests
730
- use: {
731
- baseURL: process.env.API_URL || 'http://localhost:3000',
732
- extraHTTPHeaders: {
733
- 'Accept': 'application/json',
734
- 'Content-Type': 'application/json',
735
- },
736
- },
737
-
738
- // Faster without browser overhead
739
- timeout: 30000,
740
-
741
- // Run API tests in parallel
742
- workers: 4,
743
- fullyParallel: true,
744
-
745
- // No screenshots/traces needed for API tests
746
- reporter: [['html'], ['json', { outputFile: 'api-test-results.json' }]],
747
- });
748
- ```
749
-
750
- ### Separate API Test Project
751
-
752
- ```typescript
753
- // playwright.config.ts
754
- export default defineConfig({
755
- projects: [
756
- {
757
- name: 'api',
758
- testDir: './tests/api',
759
- use: {
760
- baseURL: process.env.API_URL,
761
- },
762
- },
763
- {
764
- name: 'e2e',
765
- testDir: './tests/e2e',
766
- use: {
767
- baseURL: process.env.APP_URL,
768
- ...devices['Desktop Chrome'],
769
- },
770
- },
771
- ],
772
- });
773
- ```
774
-
775
- ## Comparison: API Tests vs E2E Tests
776
-
777
- | Aspect | API Test | E2E Test |
778
- |--------|----------|----------|
779
- | **Speed** | ~50-100ms per test | ~2-10s per test |
780
- | **Stability** | Very stable | More flaky (UI timing) |
781
- | **Setup** | Minimal | Browser, context, page |
782
- | **Debugging** | Clear request/response | DOM, screenshots, traces |
783
- | **Coverage** | Service logic | User experience |
784
- | **Parallelization** | Easy (stateless) | Complex (browser resources) |
785
- | **CI Cost** | Low (no browser) | High (browser containers) |
786
-
787
- ## Related Fragments
788
-
789
- - `api-request.md` - apiRequest utility details
790
- - `recurse.md` - Polling patterns for async operations
791
- - `auth-session.md` - Token management
792
- - `contract-testing.md` - Pact contract testing
793
- - `test-levels-framework.md` - When to use which test level
794
- - `data-factories.md` - Test data setup patterns
795
-
796
- ## Anti-Patterns
797
-
798
- **DON'T use E2E for API validation:**
799
-
800
- ```typescript
801
- // Bad: Testing API through UI
802
- test('validate user creation', async ({ page }) => {
803
- await page.goto('/admin/users');
804
- await page.fill('#name', 'John');
805
- await page.click('#submit');
806
- await expect(page.getByText('User created')).toBeVisible();
807
- });
808
- ```
809
-
810
- **DO test APIs directly:**
811
-
812
- ```typescript
813
- // Good: Direct API test
814
- test('validate user creation', async ({ apiRequest }) => {
815
- const { status, body } = await apiRequest({
816
- method: 'POST',
817
- path: '/api/users',
818
- body: { name: 'John' },
819
- });
820
- expect(status).toBe(201);
821
- expect(body.id).toBeDefined();
822
- });
823
- ```
824
-
825
- **DON'T ignore API tests because "E2E covers it":**
826
-
827
- ```typescript
828
- // Bad thinking: "Our E2E tests create users, so API is tested"
829
- // Reality: E2E tests one happy path; API tests cover edge cases
830
- ```
831
-
832
- **DO have dedicated API test coverage:**
833
-
834
- ```typescript
835
- // Good: Explicit API test suite
836
- test.describe('Users API', () => {
837
- test('creates user', async ({ apiRequest }) => { /* ... */ });
838
- test('handles duplicate email', async ({ apiRequest }) => { /* ... */ });
839
- test('validates required fields', async ({ apiRequest }) => { /* ... */ });
840
- test('handles malformed JSON', async ({ apiRequest }) => { /* ... */ });
841
- test('rate limits requests', async ({ apiRequest }) => { /* ... */ });
842
- });
843
- ```