bmad-method 6.0.0-alpha.6 → 6.0.0-alpha.7

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 (367) hide show
  1. package/.claude/settings.local.json +13 -6
  2. package/.github/workflows/{lint.yaml → quality.yaml} +19 -2
  3. package/.husky/pre-commit +4 -0
  4. package/README.md +59 -1
  5. package/bmad/_cfg/agent-manifest.csv +2 -8
  6. package/bmad/_cfg/files-manifest.csv +8 -202
  7. package/bmad/_cfg/ides/claude-code.yaml +3 -4
  8. package/bmad/_cfg/manifest.yaml +5 -4
  9. package/bmad/_cfg/task-manifest.csv +8 -1
  10. package/bmad/_cfg/tool-manifest.csv +2 -0
  11. package/bmad/_cfg/workflow-manifest.csv +4 -31
  12. package/bmad/bmb/config.yaml +2 -2
  13. package/bmad/bmb/workflows/create-agent/instructions.md +25 -9
  14. package/bmad/bmb/workflows/create-module/module-structure.md +34 -0
  15. package/bmad/core/config.yaml +2 -2
  16. package/docs/installers-bundlers/installers-modules-platforms-reference.md +61 -0
  17. package/package.json +5 -3
  18. package/src/core/tasks/adv-elicit.xml +1 -1
  19. package/src/modules/bmb/workflows/create-agent/instructions.md +25 -9
  20. package/src/modules/bmb/workflows/create-module/module-structure.md +34 -0
  21. package/src/modules/bmgd/README.md +208 -0
  22. package/src/modules/bmgd/_module-installer/install-config.yaml +66 -0
  23. package/src/modules/{bmm → bmgd}/agents/game-architect.agent.yaml +5 -12
  24. package/src/modules/{bmm → bmgd}/agents/game-designer.agent.yaml +10 -22
  25. package/src/modules/{bmm → bmgd}/agents/game-dev.agent.yaml +9 -10
  26. package/src/modules/bmgd/agents/game-scrum-master.agent.yaml +70 -0
  27. package/{bmad/bmm → src/modules/bmgd}/teams/team-gamedev.yaml +3 -1
  28. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/workflow.yaml +7 -7
  29. package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/workflow.yaml +9 -9
  30. package/src/modules/bmgd/workflows/2-design/gdd/workflow.yaml +81 -0
  31. package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/narrative/workflow.yaml +6 -6
  32. package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/workflow.yaml +16 -16
  33. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/workflow.yaml +3 -1
  34. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/correct-course/workflow.yaml +3 -1
  35. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/workflow.yaml +3 -1
  36. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/workflow.yaml +3 -1
  37. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/workflow.yaml +3 -1
  38. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/retrospective/workflow.yaml +3 -1
  39. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/workflow.yaml +3 -1
  40. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/workflow.yaml +3 -1
  41. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-done/workflow.yaml +3 -1
  42. package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-ready/workflow.yaml +3 -1
  43. package/src/modules/bmm/docs/README.md +8 -9
  44. package/src/modules/bmm/docs/agents-guide.md +0 -1
  45. package/src/modules/bmm/docs/brownfield-guide.md +5 -9
  46. package/src/modules/bmm/docs/faq.md +4 -6
  47. package/src/modules/bmm/docs/glossary.md +0 -1
  48. package/src/modules/bmm/docs/quick-spec-flow.md +4 -4
  49. package/src/modules/bmm/docs/quick-start.md +4 -4
  50. package/src/modules/bmm/docs/scale-adaptive-system.md +5 -5
  51. package/src/modules/bmm/docs/test-architecture.md +183 -118
  52. package/src/modules/bmm/docs/workflows-analysis.md +203 -539
  53. package/src/modules/bmm/docs/workflows-planning.md +326 -850
  54. package/src/modules/bmm/docs/workflows-solutioning.md +250 -505
  55. package/src/modules/bmm/workflows/1-analysis/domain-research/workflow.yaml +65 -32
  56. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +4 -0
  57. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +1 -1
  58. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +34 -5
  59. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +1 -1
  60. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +8 -0
  61. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +6 -0
  62. package/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml +47 -0
  63. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +50 -0
  64. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +18 -11
  65. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +18 -11
  66. package/src/modules/bmm/workflows/workflow-status/paths/game-design.yaml +42 -65
  67. package/test/test-installation-components.js +214 -0
  68. package/tools/cli/bundlers/web-bundler.js +127 -8
  69. package/tools/cli/installers/lib/ide/auggie.js +9 -20
  70. package/tools/cli/installers/lib/ide/claude-code.js +33 -3
  71. package/tools/cli/installers/lib/ide/cursor.js +17 -0
  72. package/tools/cli/installers/lib/modules/manager.js +128 -0
  73. package/tools/cli/lib/yaml-xml-builder.js +9 -1
  74. package/tools/schema/agent.js +1 -0
  75. package/v6-open-items.md +3 -9
  76. package/web-bundles/bmm/agents/analyst.xml +5028 -0
  77. package/web-bundles/bmm/agents/architect.xml +2047 -0
  78. package/web-bundles/bmm/agents/dev.xml +68 -0
  79. package/web-bundles/bmm/agents/pm.xml +3808 -0
  80. package/web-bundles/bmm/agents/sm.xml +77 -0
  81. package/web-bundles/bmm/agents/tea.xml +66 -0
  82. package/web-bundles/bmm/agents/tech-writer.xml +84 -0
  83. package/web-bundles/bmm/agents/ux-designer.xml +2018 -0
  84. package/web-bundles/bmm/teams/team-fullstack.xml +12039 -0
  85. package/.claude/agents/bmad-analysis/api-documenter.md +0 -102
  86. package/.claude/agents/bmad-analysis/codebase-analyzer.md +0 -82
  87. package/.claude/agents/bmad-analysis/data-analyst.md +0 -101
  88. package/.claude/agents/bmad-analysis/pattern-detector.md +0 -84
  89. package/.claude/agents/bmad-planning/dependency-mapper.md +0 -83
  90. package/.claude/agents/bmad-planning/epic-optimizer.md +0 -81
  91. package/.claude/agents/bmad-planning/requirements-analyst.md +0 -61
  92. package/.claude/agents/bmad-planning/technical-decisions-curator.md +0 -168
  93. package/.claude/agents/bmad-planning/trend-spotter.md +0 -115
  94. package/.claude/agents/bmad-planning/user-journey-mapper.md +0 -123
  95. package/.claude/agents/bmad-planning/user-researcher.md +0 -72
  96. package/.claude/agents/bmad-research/market-researcher.md +0 -51
  97. package/.claude/agents/bmad-research/tech-debt-auditor.md +0 -106
  98. package/.claude/agents/bmad-review/document-reviewer.md +0 -102
  99. package/.claude/agents/bmad-review/technical-evaluator.md +0 -68
  100. package/.claude/agents/bmad-review/test-coverage-analyzer.md +0 -108
  101. package/.claude/commands/bmad/bmb/workflows/README.md +0 -67
  102. package/.claude/commands/bmad/bmm/agents/analyst.md +0 -67
  103. package/.claude/commands/bmad/bmm/agents/architect.md +0 -72
  104. package/.claude/commands/bmad/bmm/agents/dev.md +0 -69
  105. package/.claude/commands/bmad/bmm/agents/pm.md +0 -76
  106. package/.claude/commands/bmad/bmm/agents/sm.md +0 -85
  107. package/.claude/commands/bmad/bmm/agents/tea.md +0 -72
  108. package/.claude/commands/bmad/bmm/agents/tech-writer.md +0 -82
  109. package/.claude/commands/bmad/bmm/agents/ux-designer.md +0 -71
  110. package/.claude/commands/bmad/bmm/workflows/README.md +0 -132
  111. package/.claude/commands/bmad/bmm/workflows/architecture.md +0 -15
  112. package/.claude/commands/bmad/bmm/workflows/brainstorm-project.md +0 -15
  113. package/.claude/commands/bmad/bmm/workflows/code-review.md +0 -15
  114. package/.claude/commands/bmad/bmm/workflows/correct-course.md +0 -15
  115. package/.claude/commands/bmad/bmm/workflows/create-epics-and-stories.md +0 -15
  116. package/.claude/commands/bmad/bmm/workflows/create-story.md +0 -15
  117. package/.claude/commands/bmad/bmm/workflows/create-ux-design.md +0 -15
  118. package/.claude/commands/bmad/bmm/workflows/dev-story.md +0 -15
  119. package/.claude/commands/bmad/bmm/workflows/document-project.md +0 -15
  120. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +0 -15
  121. package/.claude/commands/bmad/bmm/workflows/narrative.md +0 -15
  122. package/.claude/commands/bmad/bmm/workflows/prd.md +0 -15
  123. package/.claude/commands/bmad/bmm/workflows/product-brief.md +0 -15
  124. package/.claude/commands/bmad/bmm/workflows/research.md +0 -15
  125. package/.claude/commands/bmad/bmm/workflows/retrospective.md +0 -15
  126. package/.claude/commands/bmad/bmm/workflows/solutioning-gate-check.md +0 -15
  127. package/.claude/commands/bmad/bmm/workflows/sprint-planning.md +0 -15
  128. package/.claude/commands/bmad/bmm/workflows/story-context.md +0 -15
  129. package/.claude/commands/bmad/bmm/workflows/story-done.md +0 -15
  130. package/.claude/commands/bmad/bmm/workflows/story-ready.md +0 -15
  131. package/.claude/commands/bmad/bmm/workflows/tech-spec.md +0 -15
  132. package/.claude/commands/bmad/bmm/workflows/workflow-init.md +0 -15
  133. package/.claude/commands/bmad/bmm/workflows/workflow-status.md +0 -15
  134. package/.claude/commands/bmad/cis/agents/README.md +0 -104
  135. package/.claude/commands/bmad/cis/agents/brainstorming-coach.md +0 -62
  136. package/.claude/commands/bmad/cis/agents/creative-problem-solver.md +0 -62
  137. package/.claude/commands/bmad/cis/agents/design-thinking-coach.md +0 -62
  138. package/.claude/commands/bmad/cis/agents/innovation-strategist.md +0 -62
  139. package/.claude/commands/bmad/cis/agents/storyteller.md +0 -59
  140. package/.claude/commands/bmad/cis/workflows/README.md +0 -37
  141. package/.claude/commands/bmad/cis/workflows/design-thinking.md +0 -15
  142. package/.claude/commands/bmad/cis/workflows/innovation-strategy.md +0 -15
  143. package/.claude/commands/bmad/cis/workflows/problem-solving.md +0 -15
  144. package/.claude/commands/bmad/cis/workflows/storytelling.md +0 -15
  145. package/.claude/commands/bmad/core/workflows/README.md +0 -27
  146. package/bmad/_cfg/agents/bmm-analyst.customize.yaml +0 -42
  147. package/bmad/_cfg/agents/bmm-architect.customize.yaml +0 -42
  148. package/bmad/_cfg/agents/bmm-dev.customize.yaml +0 -42
  149. package/bmad/_cfg/agents/bmm-pm.customize.yaml +0 -42
  150. package/bmad/_cfg/agents/bmm-sm.customize.yaml +0 -42
  151. package/bmad/_cfg/agents/bmm-tea.customize.yaml +0 -42
  152. package/bmad/_cfg/agents/bmm-tech-writer.customize.yaml +0 -42
  153. package/bmad/_cfg/agents/bmm-ux-designer.customize.yaml +0 -42
  154. package/bmad/bmm/README.md +0 -128
  155. package/bmad/bmm/agents/analyst.md +0 -67
  156. package/bmad/bmm/agents/architect.md +0 -72
  157. package/bmad/bmm/agents/dev.md +0 -69
  158. package/bmad/bmm/agents/pm.md +0 -76
  159. package/bmad/bmm/agents/sm.md +0 -85
  160. package/bmad/bmm/agents/tea.md +0 -72
  161. package/bmad/bmm/agents/tech-writer.md +0 -82
  162. package/bmad/bmm/agents/ux-designer.md +0 -71
  163. package/bmad/bmm/config.yaml +0 -18
  164. package/bmad/bmm/tasks/daily-standup.xml +0 -85
  165. package/bmad/bmm/teams/team-fullstack.yaml +0 -11
  166. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  167. package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  168. package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  169. package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  170. package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  171. package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  172. package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  173. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  174. package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
  175. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  176. package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  177. package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  178. package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  179. package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  180. package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  181. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  182. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  183. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  184. package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  185. package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  186. package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  187. package/bmad/bmm/testarch/tea-index.csv +0 -22
  188. package/bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md +0 -110
  189. package/bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md +0 -25
  190. package/bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +0 -26
  191. package/bmad/bmm/workflows/1-analysis/domain-research/instructions.md +0 -423
  192. package/bmad/bmm/workflows/1-analysis/domain-research/template.md +0 -180
  193. package/bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml +0 -36
  194. package/bmad/bmm/workflows/1-analysis/product-brief/checklist.md +0 -115
  195. package/bmad/bmm/workflows/1-analysis/product-brief/instructions.md +0 -524
  196. package/bmad/bmm/workflows/1-analysis/product-brief/template.md +0 -181
  197. package/bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml +0 -45
  198. package/bmad/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +0 -144
  199. package/bmad/bmm/workflows/1-analysis/research/checklist-technical.md +0 -249
  200. package/bmad/bmm/workflows/1-analysis/research/checklist.md +0 -299
  201. package/bmad/bmm/workflows/1-analysis/research/claude-code/injections.yaml +0 -114
  202. package/bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +0 -439
  203. package/bmad/bmm/workflows/1-analysis/research/instructions-market.md +0 -679
  204. package/bmad/bmm/workflows/1-analysis/research/instructions-router.md +0 -133
  205. package/bmad/bmm/workflows/1-analysis/research/instructions-technical.md +0 -538
  206. package/bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md +0 -94
  207. package/bmad/bmm/workflows/1-analysis/research/template-market.md +0 -347
  208. package/bmad/bmm/workflows/1-analysis/research/template-technical.md +0 -245
  209. package/bmad/bmm/workflows/1-analysis/research/workflow.yaml +0 -44
  210. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md +0 -310
  211. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +0 -1301
  212. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +0 -145
  213. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +0 -64
  214. package/bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml +0 -29
  215. package/bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +0 -350
  216. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +0 -52
  217. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +0 -169
  218. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +0 -45
  219. package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +0 -13
  220. package/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +0 -408
  221. package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +0 -237
  222. package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +0 -11
  223. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +0 -46
  224. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +0 -214
  225. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +0 -80
  226. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-level0-story.md +0 -200
  227. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-level1-stories.md +0 -451
  228. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +0 -1115
  229. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +0 -181
  230. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +0 -90
  231. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +0 -60
  232. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/checklist.md +0 -175
  233. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +0 -305
  234. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/template.md +0 -146
  235. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/validation-criteria.yaml +0 -189
  236. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +0 -64
  237. package/bmad/bmm/workflows/document-project/checklist.md +0 -245
  238. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +0 -12
  239. package/bmad/bmm/workflows/document-project/instructions.md +0 -222
  240. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +0 -345
  241. package/bmad/bmm/workflows/document-project/templates/index-template.md +0 -169
  242. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +0 -103
  243. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +0 -160
  244. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +0 -135
  245. package/bmad/bmm/workflows/document-project/workflow.yaml +0 -34
  246. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -298
  247. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
  248. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1106
  249. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
  250. package/bmad/bmm/workflows/techdoc/documentation-standards.md +0 -262
  251. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  252. package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -373
  253. package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -785
  254. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -52
  255. package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -580
  256. package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1303
  257. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -61
  258. package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -246
  259. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -165
  260. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -128
  261. package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -517
  262. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -53
  263. package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -321
  264. package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -455
  265. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -53
  266. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -405
  267. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -722
  268. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -443
  269. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -56
  270. package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -234
  271. package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -621
  272. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -285
  273. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -52
  274. package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -470
  275. package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -608
  276. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -388
  277. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -53
  278. package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -654
  279. package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1045
  280. package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -673
  281. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -66
  282. package/bmad/bmm/workflows/workflow-status/init/instructions.md +0 -771
  283. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +0 -27
  284. package/bmad/bmm/workflows/workflow-status/instructions.md +0 -386
  285. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +0 -120
  286. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +0 -108
  287. package/bmad/bmm/workflows/workflow-status/paths/game-design.yaml +0 -75
  288. package/bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +0 -97
  289. package/bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +0 -88
  290. package/bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml +0 -58
  291. package/bmad/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml +0 -47
  292. package/bmad/bmm/workflows/workflow-status/project-levels.yaml +0 -59
  293. package/bmad/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +0 -49
  294. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +0 -31
  295. package/bmad/bmm/workflows/workflow-status/workflow.yaml +0 -28
  296. package/src/modules/bmm/docs/troubleshooting.md +0 -680
  297. package/src/modules/bmm/teams/team-gamedev.yaml +0 -14
  298. package/src/modules/bmm/workflows/2-plan-workflows/gdd/workflow.yaml +0 -81
  299. package/src/modules/bmm/workflows/2-plan-workflows/narrative/checklist.md +0 -139
  300. package/src/modules/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +0 -608
  301. package/src/modules/bmm/workflows/2-plan-workflows/narrative/narrative-template.md +0 -195
  302. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/game-brain-methods.csv +0 -0
  303. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/game-context.md +0 -0
  304. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/brainstorm-game/instructions.md +0 -0
  305. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/checklist.md +0 -0
  306. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/instructions.md +0 -0
  307. /package/src/modules/{bmm/workflows/1-analysis → bmgd/workflows/1-preproduction}/game-brief/template.md +0 -0
  308. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/checklist.md +0 -0
  309. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/action-platformer.md +0 -0
  310. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/adventure.md +0 -0
  311. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/card-game.md +0 -0
  312. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/fighting.md +0 -0
  313. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/horror.md +0 -0
  314. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/idle-incremental.md +0 -0
  315. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/metroidvania.md +0 -0
  316. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/moba.md +0 -0
  317. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/party-game.md +0 -0
  318. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/puzzle.md +0 -0
  319. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/racing.md +0 -0
  320. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/rhythm.md +0 -0
  321. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/roguelike.md +0 -0
  322. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/rpg.md +0 -0
  323. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/sandbox.md +0 -0
  324. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/shooter.md +0 -0
  325. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/simulation.md +0 -0
  326. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/sports.md +0 -0
  327. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/strategy.md +0 -0
  328. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/survival.md +0 -0
  329. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/text-based.md +0 -0
  330. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/tower-defense.md +0 -0
  331. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/turn-based-tactics.md +0 -0
  332. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types/visual-novel.md +0 -0
  333. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/game-types.csv +0 -0
  334. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/gdd-template.md +0 -0
  335. /package/src/modules/{bmm/workflows/2-plan-workflows → bmgd/workflows/2-design}/gdd/instructions-gdd.md +0 -0
  336. /package/{bmad/bmm/workflows/2-plan-workflows → src/modules/bmgd/workflows/2-design}/narrative/checklist.md +0 -0
  337. /package/{bmad/bmm/workflows/2-plan-workflows → src/modules/bmgd/workflows/2-design}/narrative/instructions-narrative.md +0 -0
  338. /package/{bmad/bmm/workflows/2-plan-workflows → src/modules/bmgd/workflows/2-design}/narrative/narrative-template.md +0 -0
  339. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/architecture-patterns.yaml +0 -0
  340. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/architecture-template.md +0 -0
  341. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/checklist.md +0 -0
  342. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/decision-catalog.yaml +0 -0
  343. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/instructions.md +0 -0
  344. /package/{bmad/bmm/workflows/3-solutioning/architecture → src/modules/bmgd/workflows/3-technical/game-architecture}/pattern-categories.csv +0 -0
  345. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/backlog_template.md +0 -0
  346. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/checklist.md +0 -0
  347. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/code-review/instructions.md +0 -0
  348. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/correct-course/checklist.md +0 -0
  349. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/correct-course/instructions.md +0 -0
  350. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/checklist.md +0 -0
  351. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/instructions.md +0 -0
  352. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/create-story/template.md +0 -0
  353. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/AUDIT-REPORT.md +0 -0
  354. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/checklist.md +0 -0
  355. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/dev-story/instructions.md +0 -0
  356. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/checklist.md +0 -0
  357. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/instructions.md +0 -0
  358. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/epic-tech-context/template.md +0 -0
  359. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/retrospective/instructions.md +0 -0
  360. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/checklist.md +0 -0
  361. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/instructions.md +0 -0
  362. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/sprint-planning/sprint-status-template.yaml +0 -0
  363. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/checklist.md +0 -0
  364. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/context-template.xml +0 -0
  365. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-context/instructions.md +0 -0
  366. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-done/instructions.md +0 -0
  367. /package/{bmad/bmm/workflows/4-implementation → src/modules/bmgd/workflows/4-production}/story-ready/instructions.md +0 -0
@@ -1,721 +0,0 @@
1
- # Email-Based Authentication Testing
2
-
3
- ## Principle
4
-
5
- Email-based authentication (magic links, one-time codes, passwordless login) requires specialized testing with email capture services like Mailosaur or Ethereal. Extract magic links via HTML parsing or use built-in link extraction, preserve browser storage (local/session/cookies) when processing links, cache email payloads to avoid exhausting inbox quotas, and cover negative cases (expired links, reused links, multiple rapid requests). Log email IDs and links for troubleshooting, but scrub PII before committing artifacts.
6
-
7
- ## Rationale
8
-
9
- Email authentication introduces unique challenges: asynchronous email delivery, quota limits (AWS Cognito: 50/day), cost per email, and complex state management (session preservation across link clicks). Without proper patterns, tests become slow (wait for email each time), expensive (quota exhaustion), and brittle (timing issues, missing state). Using email capture services + session caching + state preservation patterns makes email auth tests fast, reliable, and cost-effective.
10
-
11
- ## Pattern Examples
12
-
13
- ### Example 1: Magic Link Extraction with Mailosaur
14
-
15
- **Context**: Passwordless login flow where user receives magic link via email, clicks it, and is authenticated.
16
-
17
- **Implementation**:
18
-
19
- ```typescript
20
- // tests/e2e/magic-link-auth.spec.ts
21
- import { test, expect } from '@playwright/test';
22
-
23
- /**
24
- * Magic Link Authentication Flow
25
- * 1. User enters email
26
- * 2. Backend sends magic link
27
- * 3. Test retrieves email via Mailosaur
28
- * 4. Extract and visit magic link
29
- * 5. Verify user is authenticated
30
- */
31
-
32
- // Mailosaur configuration
33
- const MAILOSAUR_API_KEY = process.env.MAILOSAUR_API_KEY!;
34
- const MAILOSAUR_SERVER_ID = process.env.MAILOSAUR_SERVER_ID!;
35
-
36
- /**
37
- * Extract href from HTML email body
38
- * DOMParser provides XML/HTML parsing in Node.js
39
- */
40
- function extractMagicLink(htmlString: string): string | null {
41
- const { JSDOM } = require('jsdom');
42
- const dom = new JSDOM(htmlString);
43
- const link = dom.window.document.querySelector('#magic-link-button');
44
- return link ? (link as HTMLAnchorElement).href : null;
45
- }
46
-
47
- /**
48
- * Alternative: Use Mailosaur's built-in link extraction
49
- * Mailosaur automatically parses links - no regex needed!
50
- */
51
- async function getMagicLinkFromEmail(email: string): Promise<string> {
52
- const MailosaurClient = require('mailosaur');
53
- const mailosaur = new MailosaurClient(MAILOSAUR_API_KEY);
54
-
55
- // Wait for email (timeout: 30 seconds)
56
- const message = await mailosaur.messages.get(
57
- MAILOSAUR_SERVER_ID,
58
- {
59
- sentTo: email,
60
- },
61
- {
62
- timeout: 30000, // 30 seconds
63
- },
64
- );
65
-
66
- // Mailosaur extracts links automatically - no parsing needed!
67
- const magicLink = message.html?.links?.[0]?.href;
68
-
69
- if (!magicLink) {
70
- throw new Error(`Magic link not found in email to ${email}`);
71
- }
72
-
73
- console.log(`📧 Email received. Magic link extracted: ${magicLink}`);
74
- return magicLink;
75
- }
76
-
77
- test.describe('Magic Link Authentication', () => {
78
- test('should authenticate user via magic link', async ({ page, context }) => {
79
- // Arrange: Generate unique test email
80
- const randomId = Math.floor(Math.random() * 1000000);
81
- const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
82
-
83
- // Act: Request magic link
84
- await page.goto('/login');
85
- await page.getByTestId('email-input').fill(testEmail);
86
- await page.getByTestId('send-magic-link').click();
87
-
88
- // Assert: Success message
89
- await expect(page.getByTestId('check-email-message')).toBeVisible();
90
- await expect(page.getByTestId('check-email-message')).toContainText('Check your email');
91
-
92
- // Retrieve magic link from email
93
- const magicLink = await getMagicLinkFromEmail(testEmail);
94
-
95
- // Visit magic link
96
- await page.goto(magicLink);
97
-
98
- // Assert: User is authenticated
99
- await expect(page.getByTestId('user-menu')).toBeVisible();
100
- await expect(page.getByTestId('user-email')).toContainText(testEmail);
101
-
102
- // Verify session storage preserved
103
- const localStorage = await page.evaluate(() => JSON.stringify(window.localStorage));
104
- expect(localStorage).toContain('authToken');
105
- });
106
-
107
- test('should handle expired magic link', async ({ page }) => {
108
- // Use pre-expired link (older than 15 minutes)
109
- const expiredLink = 'http://localhost:3000/auth/verify?token=expired-token-123';
110
-
111
- await page.goto(expiredLink);
112
-
113
- // Assert: Error message displayed
114
- await expect(page.getByTestId('error-message')).toBeVisible();
115
- await expect(page.getByTestId('error-message')).toContainText('link has expired');
116
-
117
- // Assert: User NOT authenticated
118
- await expect(page.getByTestId('user-menu')).not.toBeVisible();
119
- });
120
-
121
- test('should prevent reusing magic link', async ({ page }) => {
122
- const randomId = Math.floor(Math.random() * 1000000);
123
- const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
124
-
125
- // Request magic link
126
- await page.goto('/login');
127
- await page.getByTestId('email-input').fill(testEmail);
128
- await page.getByTestId('send-magic-link').click();
129
-
130
- const magicLink = await getMagicLinkFromEmail(testEmail);
131
-
132
- // Visit link first time (success)
133
- await page.goto(magicLink);
134
- await expect(page.getByTestId('user-menu')).toBeVisible();
135
-
136
- // Sign out
137
- await page.getByTestId('sign-out').click();
138
-
139
- // Try to reuse same link (should fail)
140
- await page.goto(magicLink);
141
- await expect(page.getByTestId('error-message')).toBeVisible();
142
- await expect(page.getByTestId('error-message')).toContainText('link has already been used');
143
- });
144
- });
145
- ```
146
-
147
- **Cypress equivalent with Mailosaur plugin**:
148
-
149
- ```javascript
150
- // cypress/e2e/magic-link-auth.cy.ts
151
- describe('Magic Link Authentication', () => {
152
- it('should authenticate user via magic link', () => {
153
- const serverId = Cypress.env('MAILOSAUR_SERVERID');
154
- const randomId = Cypress._.random(1e6);
155
- const testEmail = `user-${randomId}@${serverId}.mailosaur.net`;
156
-
157
- // Request magic link
158
- cy.visit('/login');
159
- cy.get('[data-cy="email-input"]').type(testEmail);
160
- cy.get('[data-cy="send-magic-link"]').click();
161
- cy.get('[data-cy="check-email-message"]').should('be.visible');
162
-
163
- // Retrieve and visit magic link
164
- cy.mailosaurGetMessage(serverId, { sentTo: testEmail })
165
- .its('html.links.0.href') // Mailosaur extracts links automatically!
166
- .should('exist')
167
- .then((magicLink) => {
168
- cy.log(`Magic link: ${magicLink}`);
169
- cy.visit(magicLink);
170
- });
171
-
172
- // Verify authenticated
173
- cy.get('[data-cy="user-menu"]').should('be.visible');
174
- cy.get('[data-cy="user-email"]').should('contain', testEmail);
175
- });
176
- });
177
- ```
178
-
179
- **Key Points**:
180
-
181
- - **Mailosaur auto-extraction**: `html.links[0].href` or `html.codes[0].value`
182
- - **Unique emails**: Random ID prevents collisions
183
- - **Negative testing**: Expired and reused links tested
184
- - **State verification**: localStorage/session checked
185
- - **Fast email retrieval**: 30 second timeout typical
186
-
187
- ---
188
-
189
- ### Example 2: State Preservation Pattern with cy.session / Playwright storageState
190
-
191
- **Context**: Cache authenticated session to avoid requesting magic link on every test.
192
-
193
- **Implementation**:
194
-
195
- ```typescript
196
- // playwright/fixtures/email-auth-fixture.ts
197
- import { test as base } from '@playwright/test';
198
- import { getMagicLinkFromEmail } from '../support/mailosaur-helpers';
199
-
200
- type EmailAuthFixture = {
201
- authenticatedUser: { email: string; token: string };
202
- };
203
-
204
- export const test = base.extend<EmailAuthFixture>({
205
- authenticatedUser: async ({ page, context }, use) => {
206
- const randomId = Math.floor(Math.random() * 1000000);
207
- const testEmail = `user-${randomId}@${process.env.MAILOSAUR_SERVER_ID}.mailosaur.net`;
208
-
209
- // Check if we have cached auth state for this email
210
- const storageStatePath = `./test-results/auth-state-${testEmail}.json`;
211
-
212
- try {
213
- // Try to reuse existing session
214
- await context.storageState({ path: storageStatePath });
215
- await page.goto('/dashboard');
216
-
217
- // Validate session is still valid
218
- const isAuthenticated = await page.getByTestId('user-menu').isVisible({ timeout: 2000 });
219
-
220
- if (isAuthenticated) {
221
- console.log(`✅ Reusing cached session for ${testEmail}`);
222
- await use({ email: testEmail, token: 'cached' });
223
- return;
224
- }
225
- } catch (error) {
226
- console.log(`📧 No cached session, requesting magic link for ${testEmail}`);
227
- }
228
-
229
- // Request new magic link
230
- await page.goto('/login');
231
- await page.getByTestId('email-input').fill(testEmail);
232
- await page.getByTestId('send-magic-link').click();
233
-
234
- // Get magic link from email
235
- const magicLink = await getMagicLinkFromEmail(testEmail);
236
-
237
- // Visit link and authenticate
238
- await page.goto(magicLink);
239
- await expect(page.getByTestId('user-menu')).toBeVisible();
240
-
241
- // Extract auth token from localStorage
242
- const authToken = await page.evaluate(() => localStorage.getItem('authToken'));
243
-
244
- // Save session state for reuse
245
- await context.storageState({ path: storageStatePath });
246
-
247
- console.log(`💾 Cached session for ${testEmail}`);
248
-
249
- await use({ email: testEmail, token: authToken || '' });
250
- },
251
- });
252
- ```
253
-
254
- **Cypress equivalent with cy.session + data-session**:
255
-
256
- ```javascript
257
- // cypress/support/commands/email-auth.js
258
- import { dataSession } from 'cypress-data-session';
259
-
260
- /**
261
- * Authenticate via magic link with session caching
262
- * - First run: Requests email, extracts link, authenticates
263
- * - Subsequent runs: Reuses cached session (no email)
264
- */
265
- Cypress.Commands.add('authViaMagicLink', (email) => {
266
- return dataSession({
267
- name: `magic-link-${email}`,
268
-
269
- // First-time setup: Request and process magic link
270
- setup: () => {
271
- cy.visit('/login');
272
- cy.get('[data-cy="email-input"]').type(email);
273
- cy.get('[data-cy="send-magic-link"]').click();
274
-
275
- // Get magic link from Mailosaur
276
- cy.mailosaurGetMessage(Cypress.env('MAILOSAUR_SERVERID'), {
277
- sentTo: email,
278
- })
279
- .its('html.links.0.href')
280
- .should('exist')
281
- .then((magicLink) => {
282
- cy.visit(magicLink);
283
- });
284
-
285
- // Wait for authentication
286
- cy.get('[data-cy="user-menu"]', { timeout: 10000 }).should('be.visible');
287
-
288
- // Preserve authentication state
289
- return cy.getAllLocalStorage().then((storage) => {
290
- return { storage, email };
291
- });
292
- },
293
-
294
- // Validate cached session is still valid
295
- validate: (cached) => {
296
- return cy.wrap(Boolean(cached?.storage));
297
- },
298
-
299
- // Recreate session from cache (no email needed)
300
- recreate: (cached) => {
301
- // Restore localStorage
302
- cy.setLocalStorage(cached.storage);
303
- cy.visit('/dashboard');
304
- cy.get('[data-cy="user-menu"]', { timeout: 5000 }).should('be.visible');
305
- },
306
-
307
- shareAcrossSpecs: true, // Share session across all tests
308
- });
309
- });
310
- ```
311
-
312
- **Usage in tests**:
313
-
314
- ```javascript
315
- // cypress/e2e/dashboard.cy.ts
316
- describe('Dashboard', () => {
317
- const serverId = Cypress.env('MAILOSAUR_SERVERID');
318
- const testEmail = `test-user@${serverId}.mailosaur.net`;
319
-
320
- beforeEach(() => {
321
- // First test: Requests magic link
322
- // Subsequent tests: Reuses cached session (no email!)
323
- cy.authViaMagicLink(testEmail);
324
- });
325
-
326
- it('should display user dashboard', () => {
327
- cy.get('[data-cy="dashboard-content"]').should('be.visible');
328
- });
329
-
330
- it('should show user profile', () => {
331
- cy.get('[data-cy="user-email"]').should('contain', testEmail);
332
- });
333
-
334
- // Both tests share same session - only 1 email consumed!
335
- });
336
- ```
337
-
338
- **Key Points**:
339
-
340
- - **Session caching**: First test requests email, rest reuse session
341
- - **State preservation**: localStorage/cookies saved and restored
342
- - **Validation**: Check cached session is still valid
343
- - **Quota optimization**: Massive reduction in email consumption
344
- - **Fast tests**: Cached auth takes seconds vs. minutes
345
-
346
- ---
347
-
348
- ### Example 3: Negative Flow Tests (Expired, Invalid, Reused Links)
349
-
350
- **Context**: Comprehensive negative testing for email authentication edge cases.
351
-
352
- **Implementation**:
353
-
354
- ```typescript
355
- // tests/e2e/email-auth-negative.spec.ts
356
- import { test, expect } from '@playwright/test';
357
- import { getMagicLinkFromEmail } from '../support/mailosaur-helpers';
358
-
359
- const MAILOSAUR_SERVER_ID = process.env.MAILOSAUR_SERVER_ID!;
360
-
361
- test.describe('Email Auth Negative Flows', () => {
362
- test('should reject expired magic link', async ({ page }) => {
363
- // Generate expired link (simulate 24 hours ago)
364
- const expiredToken = Buffer.from(
365
- JSON.stringify({
366
- email: 'test@example.com',
367
- exp: Date.now() - 24 * 60 * 60 * 1000, // 24 hours ago
368
- }),
369
- ).toString('base64');
370
-
371
- const expiredLink = `http://localhost:3000/auth/verify?token=${expiredToken}`;
372
-
373
- // Visit expired link
374
- await page.goto(expiredLink);
375
-
376
- // Assert: Error displayed
377
- await expect(page.getByTestId('error-message')).toBeVisible();
378
- await expect(page.getByTestId('error-message')).toContainText(/link.*expired|expired.*link/i);
379
-
380
- // Assert: Link to request new one
381
- await expect(page.getByTestId('request-new-link')).toBeVisible();
382
-
383
- // Assert: User NOT authenticated
384
- await expect(page.getByTestId('user-menu')).not.toBeVisible();
385
- });
386
-
387
- test('should reject invalid magic link token', async ({ page }) => {
388
- const invalidLink = 'http://localhost:3000/auth/verify?token=invalid-garbage';
389
-
390
- await page.goto(invalidLink);
391
-
392
- // Assert: Error displayed
393
- await expect(page.getByTestId('error-message')).toBeVisible();
394
- await expect(page.getByTestId('error-message')).toContainText(/invalid.*link|link.*invalid/i);
395
-
396
- // Assert: User not authenticated
397
- await expect(page.getByTestId('user-menu')).not.toBeVisible();
398
- });
399
-
400
- test('should reject already-used magic link', async ({ page, context }) => {
401
- const randomId = Math.floor(Math.random() * 1000000);
402
- const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
403
-
404
- // Request magic link
405
- await page.goto('/login');
406
- await page.getByTestId('email-input').fill(testEmail);
407
- await page.getByTestId('send-magic-link').click();
408
-
409
- const magicLink = await getMagicLinkFromEmail(testEmail);
410
-
411
- // Visit link FIRST time (success)
412
- await page.goto(magicLink);
413
- await expect(page.getByTestId('user-menu')).toBeVisible();
414
-
415
- // Sign out
416
- await page.getByTestId('user-menu').click();
417
- await page.getByTestId('sign-out').click();
418
- await expect(page.getByTestId('user-menu')).not.toBeVisible();
419
-
420
- // Try to reuse SAME link (should fail)
421
- await page.goto(magicLink);
422
-
423
- // Assert: Link already used error
424
- await expect(page.getByTestId('error-message')).toBeVisible();
425
- await expect(page.getByTestId('error-message')).toContainText(/already.*used|link.*used/i);
426
-
427
- // Assert: User not authenticated
428
- await expect(page.getByTestId('user-menu')).not.toBeVisible();
429
- });
430
-
431
- test('should handle rapid successive link requests', async ({ page }) => {
432
- const randomId = Math.floor(Math.random() * 1000000);
433
- const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
434
-
435
- // Request magic link 3 times rapidly
436
- for (let i = 0; i < 3; i++) {
437
- await page.goto('/login');
438
- await page.getByTestId('email-input').fill(testEmail);
439
- await page.getByTestId('send-magic-link').click();
440
- await expect(page.getByTestId('check-email-message')).toBeVisible();
441
- }
442
-
443
- // Only the LATEST link should work
444
- const MailosaurClient = require('mailosaur');
445
- const mailosaur = new MailosaurClient(process.env.MAILOSAUR_API_KEY);
446
-
447
- const messages = await mailosaur.messages.list(MAILOSAUR_SERVER_ID, {
448
- sentTo: testEmail,
449
- });
450
-
451
- // Should receive 3 emails
452
- expect(messages.items.length).toBeGreaterThanOrEqual(3);
453
-
454
- // Get the LATEST magic link
455
- const latestMessage = messages.items[0]; // Most recent first
456
- const latestLink = latestMessage.html.links[0].href;
457
-
458
- // Latest link works
459
- await page.goto(latestLink);
460
- await expect(page.getByTestId('user-menu')).toBeVisible();
461
-
462
- // Older links should NOT work (if backend invalidates previous)
463
- await page.getByTestId('sign-out').click();
464
- const olderLink = messages.items[1].html.links[0].href;
465
-
466
- await page.goto(olderLink);
467
- await expect(page.getByTestId('error-message')).toBeVisible();
468
- });
469
-
470
- test('should rate-limit excessive magic link requests', async ({ page }) => {
471
- const randomId = Math.floor(Math.random() * 1000000);
472
- const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
473
-
474
- // Request magic link 10 times rapidly (should hit rate limit)
475
- for (let i = 0; i < 10; i++) {
476
- await page.goto('/login');
477
- await page.getByTestId('email-input').fill(testEmail);
478
- await page.getByTestId('send-magic-link').click();
479
-
480
- // After N requests, should show rate limit error
481
- const errorVisible = await page
482
- .getByTestId('rate-limit-error')
483
- .isVisible({ timeout: 1000 })
484
- .catch(() => false);
485
-
486
- if (errorVisible) {
487
- console.log(`Rate limit hit after ${i + 1} requests`);
488
- await expect(page.getByTestId('rate-limit-error')).toContainText(/too many.*requests|rate.*limit/i);
489
- return;
490
- }
491
- }
492
-
493
- // If no rate limit after 10 requests, log warning
494
- console.warn('⚠️ No rate limit detected after 10 requests');
495
- });
496
- });
497
- ```
498
-
499
- **Key Points**:
500
-
501
- - **Expired links**: Test 24+ hour old tokens
502
- - **Invalid tokens**: Malformed or garbage tokens rejected
503
- - **Reuse prevention**: Same link can't be used twice
504
- - **Rapid requests**: Multiple requests handled gracefully
505
- - **Rate limiting**: Excessive requests blocked
506
-
507
- ---
508
-
509
- ### Example 4: Caching Strategy with cypress-data-session / Playwright Projects
510
-
511
- **Context**: Minimize email consumption by sharing authentication state across tests and specs.
512
-
513
- **Implementation**:
514
-
515
- ```javascript
516
- // cypress/support/commands/register-and-sign-in.js
517
- import { dataSession } from 'cypress-data-session';
518
-
519
- /**
520
- * Email Authentication Caching Strategy
521
- * - One email per test run (not per spec, not per test)
522
- * - First spec: Full registration flow (form → email → code → sign in)
523
- * - Subsequent specs: Only sign in (reuse user)
524
- * - Subsequent tests in same spec: Session already active (no sign in)
525
- */
526
-
527
- // Helper: Fill registration form
528
- function fillRegistrationForm({ fullName, userName, email, password }) {
529
- cy.intercept('POST', 'https://cognito-idp*').as('cognito');
530
- cy.contains('Register').click();
531
- cy.get('#reg-dialog-form').should('be.visible');
532
- cy.get('#first-name').type(fullName, { delay: 0 });
533
- cy.get('#last-name').type(lastName, { delay: 0 });
534
- cy.get('#email').type(email, { delay: 0 });
535
- cy.get('#username').type(userName, { delay: 0 });
536
- cy.get('#password').type(password, { delay: 0 });
537
- cy.contains('button', 'Create an account').click();
538
- cy.wait('@cognito').its('response.statusCode').should('equal', 200);
539
- }
540
-
541
- // Helper: Confirm registration with email code
542
- function confirmRegistration(email) {
543
- return cy
544
- .mailosaurGetMessage(Cypress.env('MAILOSAUR_SERVERID'), { sentTo: email })
545
- .its('html.codes.0.value') // Mailosaur auto-extracts codes!
546
- .then((code) => {
547
- cy.intercept('POST', 'https://cognito-idp*').as('cognito');
548
- cy.get('#verification-code').type(code, { delay: 0 });
549
- cy.contains('button', 'Confirm registration').click();
550
- cy.wait('@cognito');
551
- cy.contains('You are now registered!').should('be.visible');
552
- cy.contains('button', /ok/i).click();
553
- return cy.wrap(code); // Return code for reference
554
- });
555
- }
556
-
557
- // Helper: Full registration (form + email)
558
- function register({ fullName, userName, email, password }) {
559
- fillRegistrationForm({ fullName, userName, email, password });
560
- return confirmRegistration(email);
561
- }
562
-
563
- // Helper: Sign in
564
- function signIn({ userName, password }) {
565
- cy.intercept('POST', 'https://cognito-idp*').as('cognito');
566
- cy.contains('Sign in').click();
567
- cy.get('#sign-in-username').type(userName, { delay: 0 });
568
- cy.get('#sign-in-password').type(password, { delay: 0 });
569
- cy.contains('button', 'Sign in').click();
570
- cy.wait('@cognito');
571
- cy.contains('Sign out').should('be.visible');
572
- }
573
-
574
- /**
575
- * Register and sign in with email caching
576
- * ONE EMAIL PER MACHINE (cypress run or cypress open)
577
- */
578
- Cypress.Commands.add('registerAndSignIn', ({ fullName, userName, email, password }) => {
579
- return dataSession({
580
- name: email, // Unique session per email
581
-
582
- // First time: Full registration (form → email → code)
583
- init: () => register({ fullName, userName, email, password }),
584
-
585
- // Subsequent specs: Just check email exists (code already used)
586
- setup: () => confirmRegistration(email),
587
-
588
- // Always runs after init/setup: Sign in
589
- recreate: () => signIn({ userName, password }),
590
-
591
- // Share across ALL specs (one email for entire test run)
592
- shareAcrossSpecs: true,
593
- });
594
- });
595
- ```
596
-
597
- **Usage across multiple specs**:
598
-
599
- ```javascript
600
- // cypress/e2e/place-order.cy.ts
601
- describe('Place Order', () => {
602
- beforeEach(() => {
603
- cy.visit('/');
604
- cy.registerAndSignIn({
605
- fullName: Cypress.env('fullName'), // From cypress.config
606
- userName: Cypress.env('userName'),
607
- email: Cypress.env('email'), // SAME email across all specs
608
- password: Cypress.env('password'),
609
- });
610
- });
611
-
612
- it('should place order', () => {
613
- /* ... */
614
- });
615
- it('should view order history', () => {
616
- /* ... */
617
- });
618
- });
619
-
620
- // cypress/e2e/profile.cy.ts
621
- describe('User Profile', () => {
622
- beforeEach(() => {
623
- cy.visit('/');
624
- cy.registerAndSignIn({
625
- fullName: Cypress.env('fullName'),
626
- userName: Cypress.env('userName'),
627
- email: Cypress.env('email'), // SAME email - no new email sent!
628
- password: Cypress.env('password'),
629
- });
630
- });
631
-
632
- it('should update profile', () => {
633
- /* ... */
634
- });
635
- });
636
- ```
637
-
638
- **Playwright equivalent with storageState**:
639
-
640
- ```typescript
641
- // playwright.config.ts
642
- import { defineConfig } from '@playwright/test';
643
-
644
- export default defineConfig({
645
- projects: [
646
- {
647
- name: 'setup',
648
- testMatch: /global-setup\.ts/,
649
- },
650
- {
651
- name: 'authenticated',
652
- testMatch: /.*\.spec\.ts/,
653
- dependencies: ['setup'],
654
- use: {
655
- storageState: '.auth/user-session.json', // Reuse auth state
656
- },
657
- },
658
- ],
659
- });
660
- ```
661
-
662
- ```typescript
663
- // tests/global-setup.ts (runs once)
664
- import { test as setup } from '@playwright/test';
665
- import { getMagicLinkFromEmail } from './support/mailosaur-helpers';
666
-
667
- const authFile = '.auth/user-session.json';
668
-
669
- setup('authenticate via magic link', async ({ page }) => {
670
- const testEmail = process.env.TEST_USER_EMAIL!;
671
-
672
- // Request magic link
673
- await page.goto('/login');
674
- await page.getByTestId('email-input').fill(testEmail);
675
- await page.getByTestId('send-magic-link').click();
676
-
677
- // Get and visit magic link
678
- const magicLink = await getMagicLinkFromEmail(testEmail);
679
- await page.goto(magicLink);
680
-
681
- // Verify authenticated
682
- await expect(page.getByTestId('user-menu')).toBeVisible();
683
-
684
- // Save authenticated state (ONE TIME for all tests)
685
- await page.context().storageState({ path: authFile });
686
-
687
- console.log('✅ Authentication state saved to', authFile);
688
- });
689
- ```
690
-
691
- **Key Points**:
692
-
693
- - **One email per run**: Global setup authenticates once
694
- - **State reuse**: All tests use cached storageState
695
- - **cypress-data-session**: Intelligently manages cache lifecycle
696
- - **shareAcrossSpecs**: Session shared across all spec files
697
- - **Massive savings**: 500 tests = 1 email (not 500!)
698
-
699
- ---
700
-
701
- ## Email Authentication Testing Checklist
702
-
703
- Before implementing email auth tests, verify:
704
-
705
- - [ ] **Email service**: Mailosaur/Ethereal/MailHog configured with API keys
706
- - [ ] **Link extraction**: Use built-in parsing (html.links[0].href) over regex
707
- - [ ] **State preservation**: localStorage/session/cookies saved and restored
708
- - [ ] **Session caching**: cypress-data-session or storageState prevents redundant emails
709
- - [ ] **Negative flows**: Expired, invalid, reused, rapid requests tested
710
- - [ ] **Quota awareness**: One email per run (not per test)
711
- - [ ] **PII scrubbing**: Email IDs logged for debug, but scrubbed from artifacts
712
- - [ ] **Timeout handling**: 30 second email retrieval timeout configured
713
-
714
- ## Integration Points
715
-
716
- - Used in workflows: `*framework` (email auth setup), `*automate` (email auth test generation)
717
- - Related fragments: `fixture-architecture.md`, `test-quality.md`
718
- - Email services: Mailosaur (recommended), Ethereal (free), MailHog (self-hosted)
719
- - Plugins: cypress-mailosaur, cypress-data-session
720
-
721
- _Source: Email authentication blog, Murat testing toolkit, Mailosaur documentation_