agentvibes 2.17.1 → 2.17.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (340) hide show
  1. package/.claude/config/audio-effects.cfg +1 -1
  2. package/.claude/config/audio-effects.cfg.sample +1 -1
  3. package/.claude/hooks/play-tts-piper.sh +11 -6
  4. package/.claude/hooks/voice-manager.sh +8 -5
  5. package/README.md +2 -2
  6. package/package.json +1 -1
  7. package/src/cli/list-voices.js +1 -1
  8. package/src/installer.js +13 -9
  9. package/src/utils/dependency-checker.js +1 -1
  10. package/.bmad/_cfg/agent-manifest.csv +0 -11
  11. package/.bmad/_cfg/agent-voice-map.csv +0 -11
  12. package/.bmad/_cfg/agents/bmm-analyst.customize.yaml +0 -42
  13. package/.bmad/_cfg/agents/bmm-architect.customize.yaml +0 -42
  14. package/.bmad/_cfg/agents/bmm-dev.customize.yaml +0 -42
  15. package/.bmad/_cfg/agents/bmm-frame-expert.customize.yaml +0 -42
  16. package/.bmad/_cfg/agents/bmm-pm.customize.yaml +0 -42
  17. package/.bmad/_cfg/agents/bmm-sm.customize.yaml +0 -42
  18. package/.bmad/_cfg/agents/bmm-tea.customize.yaml +0 -42
  19. package/.bmad/_cfg/agents/bmm-tech-writer.customize.yaml +0 -42
  20. package/.bmad/_cfg/agents/bmm-ux-designer.customize.yaml +0 -42
  21. package/.bmad/_cfg/agents/core-bmad-master.customize.yaml +0 -42
  22. package/.bmad/_cfg/files-manifest.csv +0 -243
  23. package/.bmad/_cfg/ides/claude-code.yaml +0 -6
  24. package/.bmad/_cfg/manifest.yaml +0 -9
  25. package/.bmad/_cfg/task-manifest.csv +0 -5
  26. package/.bmad/_cfg/tool-manifest.csv +0 -2
  27. package/.bmad/_cfg/workflow-manifest.csv +0 -38
  28. package/.bmad/bmm/README.md +0 -128
  29. package/.bmad/bmm/agents/analyst.md +0 -79
  30. package/.bmad/bmm/agents/analyst.md.backup-pre-tts +0 -75
  31. package/.bmad/bmm/agents/architect.md +0 -80
  32. package/.bmad/bmm/agents/dev.md +0 -70
  33. package/.bmad/bmm/agents/frame-expert.md +0 -72
  34. package/.bmad/bmm/agents/pm.md +0 -84
  35. package/.bmad/bmm/agents/sm.md +0 -93
  36. package/.bmad/bmm/agents/tea.md +0 -80
  37. package/.bmad/bmm/agents/tech-writer.md +0 -84
  38. package/.bmad/bmm/agents/ux-designer.md +0 -79
  39. package/.bmad/bmm/config.yaml +0 -17
  40. package/.bmad/bmm/docs/README.md +0 -236
  41. package/.bmad/bmm/docs/agents-guide.md +0 -1058
  42. package/.bmad/bmm/docs/brownfield-guide.md +0 -762
  43. package/.bmad/bmm/docs/enterprise-agentic-development.md +0 -686
  44. package/.bmad/bmm/docs/faq.md +0 -588
  45. package/.bmad/bmm/docs/glossary.md +0 -320
  46. package/.bmad/bmm/docs/party-mode.md +0 -224
  47. package/.bmad/bmm/docs/quick-spec-flow.md +0 -652
  48. package/.bmad/bmm/docs/quick-start.md +0 -376
  49. package/.bmad/bmm/docs/scale-adaptive-system.md +0 -612
  50. package/.bmad/bmm/docs/test-architecture.md +0 -396
  51. package/.bmad/bmm/docs/workflow-architecture-reference.md +0 -366
  52. package/.bmad/bmm/docs/workflow-document-project-reference.md +0 -489
  53. package/.bmad/bmm/docs/workflows-analysis.md +0 -370
  54. package/.bmad/bmm/docs/workflows-implementation.md +0 -286
  55. package/.bmad/bmm/docs/workflows-planning.md +0 -612
  56. package/.bmad/bmm/docs/workflows-solutioning.md +0 -554
  57. package/.bmad/bmm/teams/default-party.csv +0 -20
  58. package/.bmad/bmm/teams/team-fullstack.yaml +0 -13
  59. package/.bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  60. package/.bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  61. package/.bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  62. package/.bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  63. package/.bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  64. package/.bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  65. package/.bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  66. package/.bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  67. package/.bmad/bmm/testarch/knowledge/network-first.md +0 -486
  68. package/.bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  69. package/.bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  70. package/.bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  71. package/.bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  72. package/.bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  73. package/.bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  74. package/.bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  75. package/.bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  76. package/.bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  77. package/.bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  78. package/.bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  79. package/.bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  80. package/.bmad/bmm/testarch/tea-index.csv +0 -22
  81. package/.bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md +0 -112
  82. package/.bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md +0 -25
  83. package/.bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +0 -26
  84. package/.bmad/bmm/workflows/1-analysis/domain-research/instructions.md +0 -425
  85. package/.bmad/bmm/workflows/1-analysis/domain-research/template.md +0 -180
  86. package/.bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml +0 -28
  87. package/.bmad/bmm/workflows/1-analysis/product-brief/checklist.md +0 -115
  88. package/.bmad/bmm/workflows/1-analysis/product-brief/instructions.md +0 -524
  89. package/.bmad/bmm/workflows/1-analysis/product-brief/template.md +0 -181
  90. package/.bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml +0 -45
  91. package/.bmad/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +0 -144
  92. package/.bmad/bmm/workflows/1-analysis/research/checklist-technical.md +0 -249
  93. package/.bmad/bmm/workflows/1-analysis/research/checklist.md +0 -299
  94. package/.bmad/bmm/workflows/1-analysis/research/claude-code/injections.yaml +0 -114
  95. package/.bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +0 -438
  96. package/.bmad/bmm/workflows/1-analysis/research/instructions-market.md +0 -675
  97. package/.bmad/bmm/workflows/1-analysis/research/instructions-router.md +0 -134
  98. package/.bmad/bmm/workflows/1-analysis/research/instructions-technical.md +0 -534
  99. package/.bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md +0 -94
  100. package/.bmad/bmm/workflows/1-analysis/research/template-market.md +0 -347
  101. package/.bmad/bmm/workflows/1-analysis/research/template-technical.md +0 -245
  102. package/.bmad/bmm/workflows/1-analysis/research/workflow.yaml +0 -44
  103. package/.bmad/bmm/workflows/2-plan-workflows/create-epics-and-stories/epics-template.md +0 -80
  104. package/.bmad/bmm/workflows/2-plan-workflows/create-epics-and-stories/instructions.md +0 -616
  105. package/.bmad/bmm/workflows/2-plan-workflows/create-epics-and-stories/workflow.yaml +0 -53
  106. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md +0 -310
  107. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +0 -1308
  108. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +0 -145
  109. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +0 -61
  110. package/.bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +0 -346
  111. package/.bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +0 -13
  112. package/.bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +0 -703
  113. package/.bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +0 -204
  114. package/.bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +0 -11
  115. package/.bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +0 -52
  116. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +0 -217
  117. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +0 -74
  118. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-generate-stories.md +0 -436
  119. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +0 -980
  120. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +0 -181
  121. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +0 -90
  122. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +0 -58
  123. package/.bmad/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml +0 -321
  124. package/.bmad/bmm/workflows/3-solutioning/architecture/architecture-template.md +0 -103
  125. package/.bmad/bmm/workflows/3-solutioning/architecture/checklist.md +0 -240
  126. package/.bmad/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml +0 -222
  127. package/.bmad/bmm/workflows/3-solutioning/architecture/instructions.md +0 -768
  128. package/.bmad/bmm/workflows/3-solutioning/architecture/pattern-categories.csv +0 -13
  129. package/.bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml +0 -55
  130. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/checklist.md +0 -169
  131. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/instructions.md +0 -332
  132. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/template.md +0 -146
  133. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml +0 -62
  134. package/.bmad/bmm/workflows/4-implementation/code-review/backlog_template.md +0 -12
  135. package/.bmad/bmm/workflows/4-implementation/code-review/checklist.md +0 -22
  136. package/.bmad/bmm/workflows/4-implementation/code-review/instructions.md +0 -398
  137. package/.bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +0 -60
  138. package/.bmad/bmm/workflows/4-implementation/correct-course/checklist.md +0 -279
  139. package/.bmad/bmm/workflows/4-implementation/correct-course/instructions.md +0 -206
  140. package/.bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +0 -56
  141. package/.bmad/bmm/workflows/4-implementation/create-story/checklist.md +0 -240
  142. package/.bmad/bmm/workflows/4-implementation/create-story/instructions.md +0 -256
  143. package/.bmad/bmm/workflows/4-implementation/create-story/template.md +0 -51
  144. package/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +0 -71
  145. package/.bmad/bmm/workflows/4-implementation/dev-story/checklist.md +0 -38
  146. package/.bmad/bmm/workflows/4-implementation/dev-story/instructions.md +0 -267
  147. package/.bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +0 -56
  148. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/checklist.md +0 -17
  149. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/instructions.md +0 -164
  150. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/template.md +0 -76
  151. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +0 -57
  152. package/.bmad/bmm/workflows/4-implementation/retrospective/instructions.md +0 -1443
  153. package/.bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +0 -56
  154. package/.bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +0 -33
  155. package/.bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +0 -234
  156. package/.bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +0 -55
  157. package/.bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +0 -49
  158. package/.bmad/bmm/workflows/4-implementation/story-context/checklist.md +0 -16
  159. package/.bmad/bmm/workflows/4-implementation/story-context/context-template.xml +0 -34
  160. package/.bmad/bmm/workflows/4-implementation/story-context/instructions.md +0 -209
  161. package/.bmad/bmm/workflows/4-implementation/story-context/workflow.yaml +0 -61
  162. package/.bmad/bmm/workflows/4-implementation/story-done/instructions.md +0 -111
  163. package/.bmad/bmm/workflows/4-implementation/story-done/workflow.yaml +0 -26
  164. package/.bmad/bmm/workflows/4-implementation/story-ready/instructions.md +0 -117
  165. package/.bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml +0 -23
  166. package/.bmad/bmm/workflows/document-project/checklist.md +0 -245
  167. package/.bmad/bmm/workflows/document-project/documentation-requirements.csv +0 -12
  168. package/.bmad/bmm/workflows/document-project/instructions.md +0 -222
  169. package/.bmad/bmm/workflows/document-project/templates/deep-dive-template.md +0 -345
  170. package/.bmad/bmm/workflows/document-project/templates/index-template.md +0 -169
  171. package/.bmad/bmm/workflows/document-project/templates/project-overview-template.md +0 -103
  172. package/.bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +0 -160
  173. package/.bmad/bmm/workflows/document-project/templates/source-tree-template.md +0 -135
  174. package/.bmad/bmm/workflows/document-project/workflow.yaml +0 -29
  175. package/.bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -298
  176. package/.bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
  177. package/.bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1106
  178. package/.bmad/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
  179. package/.bmad/bmm/workflows/frame-expert/_shared/excalidraw-helpers.md +0 -127
  180. package/.bmad/bmm/workflows/frame-expert/_shared/excalidraw-library.json +0 -90
  181. package/.bmad/bmm/workflows/frame-expert/_shared/excalidraw-templates.yaml +0 -127
  182. package/.bmad/bmm/workflows/frame-expert/_shared/validate-json-instructions.md +0 -79
  183. package/.bmad/bmm/workflows/frame-expert/create-dataflow/checklist.md +0 -39
  184. package/.bmad/bmm/workflows/frame-expert/create-dataflow/instructions.md +0 -131
  185. package/.bmad/bmm/workflows/frame-expert/create-dataflow/workflow.yaml +0 -23
  186. package/.bmad/bmm/workflows/frame-expert/create-diagram/checklist.md +0 -43
  187. package/.bmad/bmm/workflows/frame-expert/create-diagram/instructions.md +0 -142
  188. package/.bmad/bmm/workflows/frame-expert/create-diagram/workflow.yaml +0 -24
  189. package/.bmad/bmm/workflows/frame-expert/create-flowchart/checklist.md +0 -49
  190. package/.bmad/bmm/workflows/frame-expert/create-flowchart/instructions.md +0 -242
  191. package/.bmad/bmm/workflows/frame-expert/create-flowchart/workflow.yaml +0 -27
  192. package/.bmad/bmm/workflows/frame-expert/create-wireframe/checklist.md +0 -38
  193. package/.bmad/bmm/workflows/frame-expert/create-wireframe/instructions.md +0 -133
  194. package/.bmad/bmm/workflows/frame-expert/create-wireframe/workflow.yaml +0 -23
  195. package/.bmad/bmm/workflows/techdoc/documentation-standards.md +0 -262
  196. package/.bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  197. package/.bmad/bmm/workflows/testarch/atdd/checklist.md +0 -373
  198. package/.bmad/bmm/workflows/testarch/atdd/instructions.md +0 -785
  199. package/.bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -45
  200. package/.bmad/bmm/workflows/testarch/automate/checklist.md +0 -580
  201. package/.bmad/bmm/workflows/testarch/automate/instructions.md +0 -1303
  202. package/.bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -52
  203. package/.bmad/bmm/workflows/testarch/ci/checklist.md +0 -246
  204. package/.bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -165
  205. package/.bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -128
  206. package/.bmad/bmm/workflows/testarch/ci/instructions.md +0 -517
  207. package/.bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -45
  208. package/.bmad/bmm/workflows/testarch/framework/checklist.md +0 -321
  209. package/.bmad/bmm/workflows/testarch/framework/instructions.md +0 -455
  210. package/.bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -47
  211. package/.bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -405
  212. package/.bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -722
  213. package/.bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -443
  214. package/.bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -47
  215. package/.bmad/bmm/workflows/testarch/test-design/checklist.md +0 -234
  216. package/.bmad/bmm/workflows/testarch/test-design/instructions.md +0 -782
  217. package/.bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -285
  218. package/.bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -48
  219. package/.bmad/bmm/workflows/testarch/test-review/checklist.md +0 -470
  220. package/.bmad/bmm/workflows/testarch/test-review/instructions.md +0 -608
  221. package/.bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -388
  222. package/.bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -46
  223. package/.bmad/bmm/workflows/testarch/trace/checklist.md +0 -654
  224. package/.bmad/bmm/workflows/testarch/trace/instructions.md +0 -1045
  225. package/.bmad/bmm/workflows/testarch/trace/trace-template.md +0 -673
  226. package/.bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -55
  227. package/.bmad/bmm/workflows/workflow-status/init/instructions.md +0 -334
  228. package/.bmad/bmm/workflows/workflow-status/init/workflow.yaml +0 -28
  229. package/.bmad/bmm/workflows/workflow-status/instructions.md +0 -388
  230. package/.bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +0 -138
  231. package/.bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +0 -126
  232. package/.bmad/bmm/workflows/workflow-status/paths/game-design.yaml +0 -52
  233. package/.bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +0 -122
  234. package/.bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +0 -113
  235. package/.bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml +0 -58
  236. package/.bmad/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml +0 -47
  237. package/.bmad/bmm/workflows/workflow-status/project-levels.yaml +0 -59
  238. package/.bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +0 -24
  239. package/.bmad/bmm/workflows/workflow-status/workflow.yaml +0 -28
  240. package/.bmad/core/agents/bmad-master.md +0 -72
  241. package/.bmad/core/agents/bmad-web-orchestrator.agent.xml +0 -113
  242. package/.bmad/core/config.yaml +0 -1
  243. package/.bmad/core/tasks/adv-elicit-methods.csv +0 -39
  244. package/.bmad/core/tasks/advanced-elicitation-methods.csv +0 -21
  245. package/.bmad/core/tasks/advanced-elicitation.xml +0 -106
  246. package/.bmad/core/tasks/index-docs.xml +0 -65
  247. package/.bmad/core/tasks/validate-workflow.xml +0 -89
  248. package/.bmad/core/tasks/workflow.xml +0 -270
  249. package/.bmad/core/tools/shard-doc.xml +0 -109
  250. package/.bmad/core/workflows/brainstorming/README.md +0 -261
  251. package/.bmad/core/workflows/brainstorming/brain-methods.csv +0 -36
  252. package/.bmad/core/workflows/brainstorming/instructions.md +0 -315
  253. package/.bmad/core/workflows/brainstorming/template.md +0 -106
  254. package/.bmad/core/workflows/brainstorming/workflow.yaml +0 -38
  255. package/.bmad/core/workflows/party-mode/instructions.md +0 -203
  256. package/.bmad/core/workflows/party-mode/workflow.yaml +0 -28
  257. package/.bmad/docs/claude-code-instructions.md +0 -25
  258. package/.claude/commands/BMad/analyst.md +0 -88
  259. package/.claude/commands/BMad/architect.md +0 -89
  260. package/.claude/commands/BMad/bmad-master.md +0 -114
  261. package/.claude/commands/BMad/bmad-orchestrator.md +0 -151
  262. package/.claude/commands/BMad/dev.md +0 -85
  263. package/.claude/commands/BMad/pm.md +0 -88
  264. package/.claude/commands/BMad/po.md +0 -83
  265. package/.claude/commands/BMad/qa.md +0 -91
  266. package/.claude/commands/BMad/sm.md +0 -69
  267. package/.claude/commands/BMad/tasks/advanced-elicitation.md +0 -123
  268. package/.claude/commands/BMad/tasks/apply-qa-fixes.md +0 -154
  269. package/.claude/commands/BMad/tasks/brownfield-create-epic.md +0 -166
  270. package/.claude/commands/BMad/tasks/brownfield-create-story.md +0 -153
  271. package/.claude/commands/BMad/tasks/correct-course.md +0 -76
  272. package/.claude/commands/BMad/tasks/create-brownfield-story.md +0 -318
  273. package/.claude/commands/BMad/tasks/create-deep-research-prompt.md +0 -284
  274. package/.claude/commands/BMad/tasks/create-doc.md +0 -107
  275. package/.claude/commands/BMad/tasks/create-next-story.md +0 -118
  276. package/.claude/commands/BMad/tasks/document-project.md +0 -349
  277. package/.claude/commands/BMad/tasks/execute-checklist.md +0 -92
  278. package/.claude/commands/BMad/tasks/facilitate-brainstorming-session.md +0 -142
  279. package/.claude/commands/BMad/tasks/generate-ai-frontend-prompt.md +0 -57
  280. package/.claude/commands/BMad/tasks/index-docs.md +0 -179
  281. package/.claude/commands/BMad/tasks/kb-mode-interaction.md +0 -81
  282. package/.claude/commands/BMad/tasks/nfr-assess.md +0 -349
  283. package/.claude/commands/BMad/tasks/qa-gate.md +0 -167
  284. package/.claude/commands/BMad/tasks/review-story.md +0 -320
  285. package/.claude/commands/BMad/tasks/risk-profile.md +0 -359
  286. package/.claude/commands/BMad/tasks/shard-doc.md +0 -191
  287. package/.claude/commands/BMad/tasks/test-design.md +0 -180
  288. package/.claude/commands/BMad/tasks/trace-requirements.md +0 -270
  289. package/.claude/commands/BMad/tasks/validate-next-story.md +0 -140
  290. package/.claude/commands/BMad/ux-expert.md +0 -73
  291. package/.claude/commands/bmad/bmm/agents/analyst.md +0 -14
  292. package/.claude/commands/bmad/bmm/agents/architect.md +0 -14
  293. package/.claude/commands/bmad/bmm/agents/dev.md +0 -14
  294. package/.claude/commands/bmad/bmm/agents/frame-expert.md +0 -14
  295. package/.claude/commands/bmad/bmm/agents/pm.md +0 -14
  296. package/.claude/commands/bmad/bmm/agents/sm.md +0 -14
  297. package/.claude/commands/bmad/bmm/agents/tea.md +0 -14
  298. package/.claude/commands/bmad/bmm/agents/tech-writer.md +0 -14
  299. package/.claude/commands/bmad/bmm/agents/ux-designer.md +0 -14
  300. package/.claude/commands/bmad/bmm/workflows/architecture.md +0 -13
  301. package/.claude/commands/bmad/bmm/workflows/brainstorm-project.md +0 -13
  302. package/.claude/commands/bmad/bmm/workflows/code-review.md +0 -13
  303. package/.claude/commands/bmad/bmm/workflows/correct-course.md +0 -13
  304. package/.claude/commands/bmad/bmm/workflows/create-dataflow.md +0 -13
  305. package/.claude/commands/bmad/bmm/workflows/create-diagram.md +0 -13
  306. package/.claude/commands/bmad/bmm/workflows/create-epics-and-stories.md +0 -13
  307. package/.claude/commands/bmad/bmm/workflows/create-flowchart.md +0 -13
  308. package/.claude/commands/bmad/bmm/workflows/create-story.md +0 -13
  309. package/.claude/commands/bmad/bmm/workflows/create-ux-design.md +0 -13
  310. package/.claude/commands/bmad/bmm/workflows/create-wireframe.md +0 -13
  311. package/.claude/commands/bmad/bmm/workflows/dev-story.md +0 -13
  312. package/.claude/commands/bmad/bmm/workflows/document-project.md +0 -13
  313. package/.claude/commands/bmad/bmm/workflows/domain-research.md +0 -13
  314. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +0 -13
  315. package/.claude/commands/bmad/bmm/workflows/implementation-readiness.md +0 -13
  316. package/.claude/commands/bmad/bmm/workflows/prd.md +0 -13
  317. package/.claude/commands/bmad/bmm/workflows/product-brief.md +0 -13
  318. package/.claude/commands/bmad/bmm/workflows/research.md +0 -13
  319. package/.claude/commands/bmad/bmm/workflows/retrospective.md +0 -13
  320. package/.claude/commands/bmad/bmm/workflows/sprint-planning.md +0 -13
  321. package/.claude/commands/bmad/bmm/workflows/story-context.md +0 -13
  322. package/.claude/commands/bmad/bmm/workflows/story-done.md +0 -13
  323. package/.claude/commands/bmad/bmm/workflows/story-ready.md +0 -13
  324. package/.claude/commands/bmad/bmm/workflows/tech-spec.md +0 -13
  325. package/.claude/commands/bmad/bmm/workflows/workflow-init.md +0 -13
  326. package/.claude/commands/bmad/bmm/workflows/workflow-status.md +0 -13
  327. package/.claude/commands/bmad/core/agents/bmad-master.md +0 -14
  328. package/.claude/commands/bmad/core/tasks/advanced-elicitation.md +0 -9
  329. package/.claude/commands/bmad/core/tasks/index-docs.md +0 -9
  330. package/.claude/commands/bmad/core/tools/shard-doc.md +0 -9
  331. package/.claude/commands/bmad/core/workflows/brainstorming.md +0 -13
  332. package/.claude/commands/bmad/core/workflows/party-mode.md +0 -13
  333. package/.claude/config/background-music-position.txt +0 -25
  334. package/.claude/config/background-music-volume.txt +0 -1
  335. package/.claude/config/background-music.cfg +0 -1
  336. package/.claude/config/tts-verbosity.txt +0 -1
  337. package/.claude/github-star-reminder.txt +0 -1
  338. package/.claude/hooks/bmad-party-manager.sh +0 -225
  339. package/.claude/piper-voices-dir.txt +0 -1
  340. package/.mcp.json +0 -23
@@ -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_