bmm-opencode 1.5.0 → 1.6.0

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