siesa-agents 2.1.40 → 2.1.42

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 (552) hide show
  1. package/README.md +147 -147
  2. package/bin/install.js +534 -534
  3. package/bin/prepare-publish.js +26 -26
  4. package/bin/restore-folders.js +26 -26
  5. package/bmad/_config/agent-manifest.csv +20 -20
  6. package/bmad/_config/agents/bmb-agent-builder.customize.yaml +41 -41
  7. package/bmad/_config/agents/bmb-module-builder.customize.yaml +41 -41
  8. package/bmad/_config/agents/bmb-workflow-builder.customize.yaml +41 -41
  9. package/bmad/_config/files-manifest.csv +469 -469
  10. package/bmad/_config/ides/claude-code.yaml +6 -6
  11. package/bmad/_config/manifest.yaml +14 -14
  12. package/bmad/_config/task-manifest.csv +6 -6
  13. package/bmad/_config/tool-manifest.csv +1 -1
  14. package/bmad/_config/workflow-manifest.csv +45 -45
  15. package/bmad/_memory/config.yaml +11 -11
  16. package/bmad/bmb/README.md +25 -25
  17. package/bmad/bmb/agents/agent-builder.md +57 -57
  18. package/bmad/bmb/agents/module-builder.md +60 -60
  19. package/bmad/bmb/agents/workflow-builder.md +56 -56
  20. package/bmad/bmb/config.yaml +12 -12
  21. package/bmad/bmb/docs/workflows/architecture.md +220 -220
  22. package/bmad/bmb/docs/workflows/common-workflow-tools.csv +18 -18
  23. package/bmad/bmb/docs/workflows/csv-data-file-standards.md +206 -206
  24. package/bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +220 -220
  25. package/bmad/bmb/docs/workflows/step-file-rules.md +469 -469
  26. package/bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md +241 -241
  27. package/bmad/bmb/docs/workflows/templates/step-1b-template.md +223 -223
  28. package/bmad/bmb/docs/workflows/templates/step-file.md +139 -139
  29. package/bmad/bmb/docs/workflows/templates/step-template.md +290 -290
  30. package/bmad/bmb/docs/workflows/templates/workflow-template.md +104 -104
  31. package/bmad/bmb/docs/workflows/templates/workflow.md +58 -58
  32. package/bmad/bmb/docs/workflows/terms.md +97 -97
  33. package/bmad/bmb/reference/agents/simple-examples/README.md +223 -223
  34. package/bmad/bmb/reference/readme.md +3 -3
  35. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  36. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  37. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +27 -27
  38. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +177 -177
  39. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +121 -121
  40. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +165 -165
  41. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +154 -154
  42. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +183 -183
  43. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +168 -168
  44. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +195 -195
  45. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +25 -25
  46. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  47. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  48. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +47 -47
  49. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +37 -37
  50. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +18 -18
  51. package/bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md +59 -59
  52. package/bmad/bmb/workflows/agent/data/agent-compilation.md +273 -273
  53. package/bmad/bmb/workflows/agent/data/agent-menu-patterns.md +233 -233
  54. package/bmad/bmb/workflows/agent/data/agent-metadata.md +208 -208
  55. package/bmad/bmb/workflows/agent/data/brainstorm-context.md +146 -146
  56. package/bmad/bmb/workflows/agent/data/communication-presets.csv +61 -61
  57. package/bmad/bmb/workflows/agent/data/critical-actions.md +120 -120
  58. package/bmad/bmb/workflows/agent/data/expert-agent-architecture.md +236 -236
  59. package/bmad/bmb/workflows/agent/data/expert-agent-validation.md +173 -173
  60. package/bmad/bmb/workflows/agent/data/module-agent-validation.md +124 -124
  61. package/bmad/bmb/workflows/agent/data/persona-properties.md +266 -266
  62. package/bmad/bmb/workflows/agent/data/principles-crafting.md +292 -292
  63. package/bmad/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md +16 -16
  64. package/bmad/bmb/workflows/agent/data/reference/module-examples/architect.md +68 -68
  65. package/bmad/bmb/workflows/agent/data/simple-agent-architecture.md +204 -204
  66. package/bmad/bmb/workflows/agent/data/simple-agent-validation.md +132 -132
  67. package/bmad/bmb/workflows/agent/data/understanding-agent-types.md +222 -222
  68. package/bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md +126 -126
  69. package/bmad/bmb/workflows/agent/steps-c/step-02-discovery.md +168 -168
  70. package/bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md +294 -294
  71. package/bmad/bmb/workflows/agent/steps-c/step-04-persona.md +210 -210
  72. package/bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md +176 -176
  73. package/bmad/bmb/workflows/agent/steps-c/step-06-activation.md +275 -275
  74. package/bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md +185 -185
  75. package/bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md +201 -201
  76. package/bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md +258 -258
  77. package/bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +203 -203
  78. package/bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md +135 -135
  79. package/bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md +161 -161
  80. package/bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md +158 -158
  81. package/bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +306 -306
  82. package/bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +462 -462
  83. package/bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md +244 -244
  84. package/bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md +214 -214
  85. package/bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md +191 -191
  86. package/bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md +78 -78
  87. package/bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md +76 -76
  88. package/bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md +75 -75
  89. package/bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md +75 -75
  90. package/bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md +78 -78
  91. package/bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md +119 -119
  92. package/bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md +122 -122
  93. package/bmad/bmb/workflows/agent/steps-e/e-05-persona.md +132 -132
  94. package/bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md +120 -120
  95. package/bmad/bmb/workflows/agent/steps-e/e-07-activation.md +122 -122
  96. package/bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +134 -134
  97. package/bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +117 -117
  98. package/bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md +120 -120
  99. package/bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +70 -70
  100. package/bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +70 -70
  101. package/bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +69 -69
  102. package/bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +69 -69
  103. package/bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +70 -70
  104. package/bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +111 -111
  105. package/bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md +150 -150
  106. package/bmad/bmb/workflows/agent/steps-v/v-01-load-review.md +128 -128
  107. package/bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +73 -73
  108. package/bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +72 -72
  109. package/bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +71 -71
  110. package/bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +71 -71
  111. package/bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +76 -76
  112. package/bmad/bmb/workflows/agent/steps-v/v-03-summary.md +100 -100
  113. package/bmad/bmb/workflows/agent/templates/agent-plan.template.md +5 -5
  114. package/bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md +76 -76
  115. package/bmad/bmb/workflows/agent/templates/simple-agent.template.md +71 -71
  116. package/bmad/bmb/workflows/agent/workflow.md +123 -123
  117. package/bmad/bmb/workflows/create-module/steps/step-01-init.md +156 -156
  118. package/bmad/bmb/workflows/create-module/steps/step-01b-continue.md +170 -170
  119. package/bmad/bmb/workflows/create-module/steps/step-02-concept.md +218 -218
  120. package/bmad/bmb/workflows/create-module/steps/step-03-components.md +268 -268
  121. package/bmad/bmb/workflows/create-module/steps/step-04-structure.md +229 -229
  122. package/bmad/bmb/workflows/create-module/steps/step-05-config.md +234 -234
  123. package/bmad/bmb/workflows/create-module/steps/step-06-agents.md +297 -297
  124. package/bmad/bmb/workflows/create-module/steps/step-07-workflows.md +229 -229
  125. package/bmad/bmb/workflows/create-module/steps/step-08-installer.md +187 -187
  126. package/bmad/bmb/workflows/create-module/steps/step-09-documentation.md +310 -310
  127. package/bmad/bmb/workflows/create-module/steps/step-10-roadmap.md +338 -338
  128. package/bmad/bmb/workflows/create-module/steps/step-11-validate.md +336 -336
  129. package/bmad/bmb/workflows/create-module/templates/agent.template.md +313 -313
  130. package/bmad/bmb/workflows/create-module/templates/installer.template.js +47 -47
  131. package/bmad/bmb/workflows/create-module/templates/module-plan.template.md +5 -5
  132. package/bmad/bmb/workflows/create-module/templates/module.template.yaml +53 -53
  133. package/bmad/bmb/workflows/create-module/templates/workflow-plan-template.md +23 -23
  134. package/bmad/bmb/workflows/create-module/validation.md +126 -126
  135. package/bmad/bmb/workflows/create-module/workflow.md +56 -56
  136. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  137. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  138. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv +27 -27
  139. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md +177 -177
  140. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md +150 -150
  141. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md +164 -164
  142. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md +152 -152
  143. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md +182 -182
  144. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md +167 -167
  145. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md +194 -194
  146. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md +25 -25
  147. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  148. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  149. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md +47 -47
  150. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md +37 -37
  151. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md +18 -18
  152. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md +58 -58
  153. package/bmad/bmb/workflows/create-workflow/steps/step-01-init.md +158 -158
  154. package/bmad/bmb/workflows/create-workflow/steps/step-02-gather.md +212 -212
  155. package/bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +251 -251
  156. package/bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md +217 -217
  157. package/bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +290 -290
  158. package/bmad/bmb/workflows/create-workflow/steps/step-06-design.md +272 -272
  159. package/bmad/bmb/workflows/create-workflow/steps/step-07-build.md +323 -323
  160. package/bmad/bmb/workflows/create-workflow/steps/step-08-review.md +285 -285
  161. package/bmad/bmb/workflows/create-workflow/steps/step-09-complete.md +188 -188
  162. package/bmad/bmb/workflows/create-workflow/workflow.md +59 -59
  163. package/bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md +217 -217
  164. package/bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md +254 -254
  165. package/bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md +218 -218
  166. package/bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md +194 -194
  167. package/bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +246 -246
  168. package/bmad/bmb/workflows/edit-workflow/templates/completion-summary.md +75 -75
  169. package/bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md +68 -68
  170. package/bmad/bmb/workflows/edit-workflow/templates/improvement-log.md +40 -40
  171. package/bmad/bmb/workflows/edit-workflow/templates/validation-results.md +51 -51
  172. package/bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md +56 -56
  173. package/bmad/bmb/workflows/edit-workflow/workflow.md +59 -59
  174. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +153 -153
  175. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +244 -244
  176. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +275 -275
  177. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +296 -296
  178. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +265 -265
  179. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +361 -361
  180. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +259 -259
  181. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +302 -302
  182. package/bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +140 -140
  183. package/bmad/bmb/workflows/workflow-compliance-check/workflow.md +59 -59
  184. package/bmad/bmb/workflows-legacy/edit-module/README.md +171 -171
  185. package/bmad/bmb/workflows-legacy/edit-module/checklist.md +163 -163
  186. package/bmad/bmb/workflows-legacy/edit-module/instructions.md +340 -340
  187. package/bmad/bmb/workflows-legacy/edit-module/workflow.yaml +32 -32
  188. package/bmad/bmb/workflows-legacy/module-brief/README.md +264 -264
  189. package/bmad/bmb/workflows-legacy/module-brief/checklist.md +116 -116
  190. package/bmad/bmb/workflows-legacy/module-brief/instructions.md +268 -268
  191. package/bmad/bmb/workflows-legacy/module-brief/template.md +275 -275
  192. package/bmad/bmb/workflows-legacy/module-brief/workflow.yaml +34 -34
  193. package/bmad/bmm/agents/analyst.md +76 -76
  194. package/bmad/bmm/agents/architect.md +68 -68
  195. package/bmad/bmm/agents/dev.md +70 -70
  196. package/bmad/bmm/agents/pm.md +70 -70
  197. package/bmad/bmm/agents/quick-flow-solo-dev.md +68 -68
  198. package/bmad/bmm/agents/sm.md +71 -71
  199. package/bmad/bmm/agents/tea.md +71 -71
  200. package/bmad/bmm/agents/tech-writer.md +72 -72
  201. package/bmad/bmm/agents/ux-designer.md +68 -68
  202. package/bmad/bmm/config.yaml +18 -18
  203. package/bmad/bmm/data/README.md +29 -29
  204. package/bmad/bmm/data/documentation-standards.md +262 -262
  205. package/bmad/bmm/data/project-context-template.md +40 -40
  206. package/bmad/bmm/teams/default-party.csv +21 -21
  207. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  208. package/bmad/bmm/testarch/knowledge/api-request.md +303 -303
  209. package/bmad/bmm/testarch/knowledge/auth-session.md +356 -356
  210. package/bmad/bmm/testarch/knowledge/burn-in.md +273 -273
  211. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -675
  212. package/bmad/bmm/testarch/knowledge/component-tdd.md +486 -486
  213. package/bmad/bmm/testarch/knowledge/contract-testing.md +957 -957
  214. package/bmad/bmm/testarch/knowledge/data-factories.md +500 -500
  215. package/bmad/bmm/testarch/knowledge/email-auth.md +721 -721
  216. package/bmad/bmm/testarch/knowledge/error-handling.md +725 -725
  217. package/bmad/bmm/testarch/knowledge/feature-flags.md +750 -750
  218. package/bmad/bmm/testarch/knowledge/file-utils.md +260 -260
  219. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -401
  220. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +382 -382
  221. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +280 -280
  222. package/bmad/bmm/testarch/knowledge/log.md +294 -294
  223. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +272 -272
  224. package/bmad/bmm/testarch/knowledge/network-first.md +486 -486
  225. package/bmad/bmm/testarch/knowledge/network-recorder.md +265 -265
  226. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -670
  227. package/bmad/bmm/testarch/knowledge/overview.md +283 -283
  228. package/bmad/bmm/testarch/knowledge/playwright-config.md +730 -730
  229. package/bmad/bmm/testarch/knowledge/probability-impact.md +601 -601
  230. package/bmad/bmm/testarch/knowledge/recurse.md +296 -296
  231. package/bmad/bmm/testarch/knowledge/risk-governance.md +615 -615
  232. package/bmad/bmm/testarch/knowledge/selective-testing.md +732 -732
  233. package/bmad/bmm/testarch/knowledge/selector-resilience.md +527 -527
  234. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -644
  235. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -473
  236. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -373
  237. package/bmad/bmm/testarch/knowledge/test-quality.md +664 -664
  238. package/bmad/bmm/testarch/knowledge/timing-debugging.md +372 -372
  239. package/bmad/bmm/testarch/knowledge/visual-debugging.md +524 -524
  240. package/bmad/bmm/testarch/tea-index.csv +33 -33
  241. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  242. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +182 -182
  243. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +166 -166
  244. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +204 -204
  245. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +207 -207
  246. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +210 -210
  247. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +224 -224
  248. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +199 -199
  249. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -58
  250. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  251. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  252. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  253. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  254. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  255. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  256. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  257. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  258. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -200
  259. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  260. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  261. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  262. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  263. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  264. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  265. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  266. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  267. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  268. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -239
  269. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  270. package/bmad/bmm/workflows/1-analysis/research/workflow.md +173 -173
  271. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  272. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  273. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  274. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  275. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  276. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  277. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  278. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  279. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  280. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  281. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  282. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +332 -248
  283. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  284. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  285. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -228
  286. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  287. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +59 -43
  288. package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +12 -12
  289. package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +11 -11
  290. package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +10 -10
  291. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +197 -197
  292. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +166 -166
  293. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +421 -421
  294. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +290 -290
  295. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +291 -291
  296. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +271 -271
  297. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +262 -262
  298. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +258 -258
  299. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +299 -299
  300. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +270 -270
  301. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +294 -294
  302. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +186 -186
  303. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +63 -63
  304. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -190
  305. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -178
  306. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -179
  307. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -139
  308. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -252
  309. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -133
  310. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  311. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -55
  312. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  313. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/architecture-patterns.md +415 -415
  314. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/backend-standards.md +811 -811
  315. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/frontend-standards.md +375 -375
  316. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technical-preferences-ux.md +422 -422
  317. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technology-stack.md +235 -235
  318. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +10 -10
  319. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  320. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +166 -166
  321. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  322. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  323. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +342 -342
  324. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +328 -328
  325. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +368 -368
  326. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  327. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +366 -366
  328. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -352
  329. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +51 -51
  330. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  331. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  332. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  333. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -145
  334. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  335. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -59
  336. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  337. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +224 -224
  338. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +49 -49
  339. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +279 -279
  340. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +206 -206
  341. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +58 -58
  342. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  343. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-01-determine-story.md +85 -85
  344. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-02-analyze.md +67 -67
  345. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-03-architecture.md +71 -71
  346. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-04-web-research.md +58 -58
  347. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-05-create-file.md +76 -76
  348. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-06-finalize.md +66 -66
  349. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  350. package/bmad/bmm/workflows/4-implementation/create-story/workflow.md +58 -58
  351. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml.bak +63 -63
  352. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +85 -85
  353. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +470 -470
  354. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +25 -25
  355. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -1443
  356. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +56 -56
  357. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  358. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -225
  359. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  360. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +52 -52
  361. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -229
  362. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +34 -34
  363. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-01-understand.md +189 -189
  364. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-02-investigate.md +144 -144
  365. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-03-generate.md +128 -128
  366. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-04-review.md +173 -173
  367. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/tech-spec-template.md +74 -74
  368. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md +79 -79
  369. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -156
  370. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -120
  371. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -113
  372. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -113
  373. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -106
  374. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -140
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -52
  376. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  377. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  378. package/bmad/bmm/workflows/document-project/instructions.md +221 -221
  379. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  380. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  381. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  382. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  383. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  384. package/bmad/bmm/workflows/document-project/workflow.yaml +28 -28
  385. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  386. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  387. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  388. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  389. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -90
  390. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -127
  391. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -39
  392. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -130
  393. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +25 -25
  394. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -43
  395. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -141
  396. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +25 -25
  397. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -49
  398. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -241
  399. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +25 -25
  400. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -38
  401. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -133
  402. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +25 -25
  403. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -21
  404. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +218 -218
  405. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -318
  406. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -278
  407. package/bmad/bmm/workflows/generate-project-context/workflow.md +50 -50
  408. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -364
  409. package/bmad/bmm/workflows/testarch/atdd/checklist.md +374 -374
  410. package/bmad/bmm/workflows/testarch/atdd/instructions.md +806 -806
  411. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +45 -45
  412. package/bmad/bmm/workflows/testarch/automate/checklist.md +582 -582
  413. package/bmad/bmm/workflows/testarch/automate/instructions.md +1324 -1324
  414. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +52 -52
  415. package/bmad/bmm/workflows/testarch/ci/checklist.md +248 -248
  416. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -198
  417. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -149
  418. package/bmad/bmm/workflows/testarch/ci/instructions.md +536 -536
  419. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +45 -45
  420. package/bmad/bmm/workflows/testarch/framework/checklist.md +321 -321
  421. package/bmad/bmm/workflows/testarch/framework/instructions.md +481 -481
  422. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +47 -47
  423. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +407 -407
  424. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +722 -722
  425. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -445
  426. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +47 -47
  427. package/bmad/bmm/workflows/testarch/test-design/checklist.md +235 -235
  428. package/bmad/bmm/workflows/testarch/test-design/instructions.md +788 -788
  429. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +294 -294
  430. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +54 -54
  431. package/bmad/bmm/workflows/testarch/test-review/checklist.md +472 -472
  432. package/bmad/bmm/workflows/testarch/test-review/instructions.md +628 -628
  433. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +390 -390
  434. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +46 -46
  435. package/bmad/bmm/workflows/testarch/trace/checklist.md +655 -655
  436. package/bmad/bmm/workflows/testarch/trace/instructions.md +1047 -1047
  437. package/bmad/bmm/workflows/testarch/trace/trace-template.md +675 -675
  438. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +55 -55
  439. package/bmad/bmm/workflows/workflow-status/init/instructions.md +346 -346
  440. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +28 -28
  441. package/bmad/bmm/workflows/workflow-status/instructions.md +395 -395
  442. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -103
  443. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -100
  444. package/bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -103
  445. package/bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -100
  446. package/bmad/bmm/workflows/workflow-status/project-levels.yaml +59 -59
  447. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -24
  448. package/bmad/bmm/workflows/workflow-status/workflow.yaml +30 -30
  449. package/bmad/cis/agents/brainstorming-coach.md +60 -60
  450. package/bmad/cis/agents/creative-problem-solver.md +60 -60
  451. package/bmad/cis/agents/design-thinking-coach.md +60 -60
  452. package/bmad/cis/agents/innovation-strategist.md +60 -60
  453. package/bmad/cis/agents/presentation-master.md +66 -66
  454. package/bmad/cis/agents/storyteller/storyteller.md +57 -57
  455. package/bmad/cis/config.yaml +11 -11
  456. package/bmad/cis/teams/creative-squad.yaml +7 -7
  457. package/bmad/cis/teams/default-party.csv +12 -12
  458. package/bmad/cis/workflows/README.md +139 -139
  459. package/bmad/cis/workflows/design-thinking/README.md +56 -56
  460. package/bmad/cis/workflows/design-thinking/design-methods.csv +30 -30
  461. package/bmad/cis/workflows/design-thinking/instructions.md +202 -202
  462. package/bmad/cis/workflows/design-thinking/template.md +111 -111
  463. package/bmad/cis/workflows/design-thinking/workflow.yaml +27 -27
  464. package/bmad/cis/workflows/innovation-strategy/README.md +56 -56
  465. package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +30 -30
  466. package/bmad/cis/workflows/innovation-strategy/instructions.md +276 -276
  467. package/bmad/cis/workflows/innovation-strategy/template.md +189 -189
  468. package/bmad/cis/workflows/innovation-strategy/workflow.yaml +27 -27
  469. package/bmad/cis/workflows/problem-solving/README.md +56 -56
  470. package/bmad/cis/workflows/problem-solving/instructions.md +252 -252
  471. package/bmad/cis/workflows/problem-solving/solving-methods.csv +30 -30
  472. package/bmad/cis/workflows/problem-solving/template.md +165 -165
  473. package/bmad/cis/workflows/problem-solving/workflow.yaml +27 -27
  474. package/bmad/cis/workflows/storytelling/README.md +58 -58
  475. package/bmad/cis/workflows/storytelling/instructions.md +293 -293
  476. package/bmad/cis/workflows/storytelling/story-types.csv +25 -25
  477. package/bmad/cis/workflows/storytelling/template.md +113 -113
  478. package/bmad/cis/workflows/storytelling/workflow.yaml +27 -27
  479. package/bmad/core/agents/bmad-master.md +57 -57
  480. package/bmad/core/config.yaml +9 -9
  481. package/bmad/core/resources/excalidraw/README.md +160 -160
  482. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +127 -127
  483. package/bmad/core/resources/excalidraw/library-loader.md +50 -50
  484. package/bmad/core/resources/excalidraw/validate-json-instructions.md +79 -79
  485. package/bmad/core/tasks/index-docs.xml +64 -64
  486. package/bmad/core/tasks/review-adversarial-general.xml +41 -41
  487. package/bmad/core/tasks/shard-doc.xml +108 -108
  488. package/bmad/core/tasks/validate-workflow.xml +88 -88
  489. package/bmad/core/tasks/workflow.xml +234 -234
  490. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  491. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  492. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  493. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  494. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  495. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  496. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  497. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  498. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  499. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +340 -340
  500. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  501. package/bmad/core/workflows/brainstorming/template.md +15 -15
  502. package/bmad/core/workflows/brainstorming/workflow.md +51 -51
  503. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +139 -139
  504. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +204 -204
  505. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +159 -159
  506. package/bmad/core/workflows/party-mode/workflow.md +206 -206
  507. package/claude/hooks/file-restriction-hook.py +51 -51
  508. package/claude/hooks/track-agent.py +67 -67
  509. package/claude/settings.local.json +76 -76
  510. package/gemini/commands/BMad/agents/analyst.toml +6 -0
  511. package/gemini/commands/BMad/agents/architect.toml +6 -0
  512. package/gemini/commands/BMad/agents/bmad-master.toml +6 -0
  513. package/gemini/commands/BMad/agents/bmad-orchestrator.toml +6 -0
  514. package/gemini/commands/BMad/agents/dev.toml +6 -0
  515. package/gemini/commands/BMad/agents/pm.toml +6 -0
  516. package/gemini/commands/BMad/agents/po.toml +6 -0
  517. package/gemini/commands/BMad/agents/qa.toml +6 -0
  518. package/gemini/commands/BMad/agents/sm.toml +6 -0
  519. package/gemini/commands/BMad/agents/ux-expert.toml +6 -0
  520. package/gemini/commands/BMad/tasks/advanced-elicitation.toml +6 -0
  521. package/gemini/commands/BMad/tasks/apply-qa-fixes.toml +6 -0
  522. package/gemini/commands/BMad/tasks/brownfield-create-epic.toml +6 -0
  523. package/gemini/commands/BMad/tasks/brownfield-create-story.toml +6 -0
  524. package/gemini/commands/BMad/tasks/correct-course.toml +6 -0
  525. package/gemini/commands/BMad/tasks/create-brownfield-story.toml +6 -0
  526. package/gemini/commands/BMad/tasks/create-deep-research-prompt.toml +6 -0
  527. package/gemini/commands/BMad/tasks/create-doc.toml +6 -0
  528. package/gemini/commands/BMad/tasks/create-next-story.toml +6 -0
  529. package/gemini/commands/BMad/tasks/document-project.toml +6 -0
  530. package/gemini/commands/BMad/tasks/execute-checklist.toml +6 -0
  531. package/gemini/commands/BMad/tasks/facilitate-brainstorming-session.toml +6 -0
  532. package/gemini/commands/BMad/tasks/generate-ai-frontend-prompt.toml +6 -0
  533. package/gemini/commands/BMad/tasks/index-docs.toml +6 -0
  534. package/gemini/commands/BMad/tasks/kb-mode-interaction.toml +6 -0
  535. package/gemini/commands/BMad/tasks/nfr-assess.toml +6 -0
  536. package/gemini/commands/BMad/tasks/qa-gate.toml +6 -0
  537. package/gemini/commands/BMad/tasks/review-story.toml +6 -0
  538. package/gemini/commands/BMad/tasks/risk-profile.toml +6 -0
  539. package/gemini/commands/BMad/tasks/shard-doc.toml +6 -0
  540. package/gemini/commands/BMad/tasks/test-design.toml +6 -0
  541. package/gemini/commands/BMad/tasks/trace-requirements.toml +6 -0
  542. package/gemini/commands/BMad/tasks/validate-next-story.toml +6 -0
  543. package/github/workflows/publish.yml +150 -150
  544. package/index.js +9 -9
  545. package/mcp.json +14 -14
  546. package/package.json +41 -40
  547. package/resources/images/Siesa_Logosimbolo_Azul.svg +24 -24
  548. package/resources/images/Siesa_Logosimbolo_Blanco.svg +24 -24
  549. package/resources/images/Siesa_Simbolo_Azul.svg +14 -14
  550. package/resources/images/Siesa_Simbolo_Blanco.svg +14 -14
  551. package/vscode/mcp.json +15 -15
  552. package/vscode/settings.json +12 -12
@@ -1,957 +1,957 @@
1
- # Contract Testing Essentials (Pact)
2
-
3
- ## Principle
4
-
5
- Contract testing validates API contracts between consumer and provider services without requiring integrated end-to-end tests. Store consumer contracts alongside integration specs, version contracts semantically, and publish on every CI run. Provider verification before merge surfaces breaking changes immediately, while explicit fallback behavior (timeouts, retries, error payloads) captures resilience guarantees in contracts.
6
-
7
- ## Rationale
8
-
9
- Traditional integration testing requires running both consumer and provider simultaneously, creating slow, flaky tests with complex setup. Contract testing decouples services: consumers define expectations (pact files), providers verify against those expectations independently. This enables parallel development, catches breaking changes early, and documents API behavior as executable specifications. Pair contract tests with API smoke tests to validate data mapping and UI rendering in tandem.
10
-
11
- ## Pattern Examples
12
-
13
- ### Example 1: Pact Consumer Test (Frontend → Backend API)
14
-
15
- **Context**: React application consuming a user management API, defining expected interactions.
16
-
17
- **Implementation**:
18
-
19
- ```typescript
20
- // tests/contract/user-api.pact.spec.ts
21
- import { PactV3, MatchersV3 } from '@pact-foundation/pact';
22
- import { getUserById, createUser, User } from '@/api/user-service';
23
-
24
- const { like, eachLike, string, integer } = MatchersV3;
25
-
26
- /**
27
- * Consumer-Driven Contract Test
28
- * - Consumer (React app) defines expected API behavior
29
- * - Generates pact file for provider to verify
30
- * - Runs in isolation (no real backend required)
31
- */
32
-
33
- const provider = new PactV3({
34
- consumer: 'user-management-web',
35
- provider: 'user-api-service',
36
- dir: './pacts', // Output directory for pact files
37
- logLevel: 'warn',
38
- });
39
-
40
- describe('User API Contract', () => {
41
- describe('GET /users/:id', () => {
42
- it('should return user when user exists', async () => {
43
- // Arrange: Define expected interaction
44
- await provider
45
- .given('user with id 1 exists') // Provider state
46
- .uponReceiving('a request for user 1')
47
- .withRequest({
48
- method: 'GET',
49
- path: '/users/1',
50
- headers: {
51
- Accept: 'application/json',
52
- Authorization: like('Bearer token123'), // Matcher: any string
53
- },
54
- })
55
- .willRespondWith({
56
- status: 200,
57
- headers: {
58
- 'Content-Type': 'application/json',
59
- },
60
- body: like({
61
- id: integer(1),
62
- name: string('John Doe'),
63
- email: string('john@example.com'),
64
- role: string('user'),
65
- createdAt: string('2025-01-15T10:00:00Z'),
66
- }),
67
- })
68
- .executeTest(async (mockServer) => {
69
- // Act: Call consumer code against mock server
70
- const user = await getUserById(1, {
71
- baseURL: mockServer.url,
72
- headers: { Authorization: 'Bearer token123' },
73
- });
74
-
75
- // Assert: Validate consumer behavior
76
- expect(user).toEqual(
77
- expect.objectContaining({
78
- id: 1,
79
- name: 'John Doe',
80
- email: 'john@example.com',
81
- role: 'user',
82
- }),
83
- );
84
- });
85
- });
86
-
87
- it('should handle 404 when user does not exist', async () => {
88
- await provider
89
- .given('user with id 999 does not exist')
90
- .uponReceiving('a request for non-existent user')
91
- .withRequest({
92
- method: 'GET',
93
- path: '/users/999',
94
- headers: { Accept: 'application/json' },
95
- })
96
- .willRespondWith({
97
- status: 404,
98
- headers: { 'Content-Type': 'application/json' },
99
- body: {
100
- error: 'User not found',
101
- code: 'USER_NOT_FOUND',
102
- },
103
- })
104
- .executeTest(async (mockServer) => {
105
- // Act & Assert: Consumer handles 404 gracefully
106
- await expect(getUserById(999, { baseURL: mockServer.url })).rejects.toThrow('User not found');
107
- });
108
- });
109
- });
110
-
111
- describe('POST /users', () => {
112
- it('should create user and return 201', async () => {
113
- const newUser: Omit<User, 'id' | 'createdAt'> = {
114
- name: 'Jane Smith',
115
- email: 'jane@example.com',
116
- role: 'admin',
117
- };
118
-
119
- await provider
120
- .given('no users exist')
121
- .uponReceiving('a request to create a user')
122
- .withRequest({
123
- method: 'POST',
124
- path: '/users',
125
- headers: {
126
- 'Content-Type': 'application/json',
127
- Accept: 'application/json',
128
- },
129
- body: like(newUser),
130
- })
131
- .willRespondWith({
132
- status: 201,
133
- headers: { 'Content-Type': 'application/json' },
134
- body: like({
135
- id: integer(2),
136
- name: string('Jane Smith'),
137
- email: string('jane@example.com'),
138
- role: string('admin'),
139
- createdAt: string('2025-01-15T11:00:00Z'),
140
- }),
141
- })
142
- .executeTest(async (mockServer) => {
143
- const createdUser = await createUser(newUser, {
144
- baseURL: mockServer.url,
145
- });
146
-
147
- expect(createdUser).toEqual(
148
- expect.objectContaining({
149
- id: expect.any(Number),
150
- name: 'Jane Smith',
151
- email: 'jane@example.com',
152
- role: 'admin',
153
- }),
154
- );
155
- });
156
- });
157
- });
158
- });
159
- ```
160
-
161
- **package.json scripts**:
162
-
163
- ```json
164
- {
165
- "scripts": {
166
- "test:contract": "jest tests/contract --testTimeout=30000",
167
- "pact:publish": "pact-broker publish ./pacts --consumer-app-version=$GIT_SHA --broker-base-url=$PACT_BROKER_URL --broker-token=$PACT_BROKER_TOKEN"
168
- }
169
- }
170
- ```
171
-
172
- **Key Points**:
173
-
174
- - **Consumer-driven**: Frontend defines expectations, not backend
175
- - **Matchers**: `like`, `string`, `integer` for flexible matching
176
- - **Provider states**: given() sets up test preconditions
177
- - **Isolation**: No real backend needed, runs fast
178
- - **Pact generation**: Automatically creates JSON pact files
179
-
180
- ---
181
-
182
- ### Example 2: Pact Provider Verification (Backend validates contracts)
183
-
184
- **Context**: Node.js/Express API verifying pacts published by consumers.
185
-
186
- **Implementation**:
187
-
188
- ```typescript
189
- // tests/contract/user-api.provider.spec.ts
190
- import { Verifier, VerifierOptions } from '@pact-foundation/pact';
191
- import { server } from '../../src/server'; // Your Express/Fastify app
192
- import { seedDatabase, resetDatabase } from '../support/db-helpers';
193
-
194
- /**
195
- * Provider Verification Test
196
- * - Provider (backend API) verifies against published pacts
197
- * - State handlers setup test data for each interaction
198
- * - Runs before merge to catch breaking changes
199
- */
200
-
201
- describe('Pact Provider Verification', () => {
202
- let serverInstance;
203
- const PORT = 3001;
204
-
205
- beforeAll(async () => {
206
- // Start provider server
207
- serverInstance = server.listen(PORT);
208
- console.log(`Provider server running on port ${PORT}`);
209
- });
210
-
211
- afterAll(async () => {
212
- // Cleanup
213
- await serverInstance.close();
214
- });
215
-
216
- it('should verify pacts from all consumers', async () => {
217
- const opts: VerifierOptions = {
218
- // Provider details
219
- provider: 'user-api-service',
220
- providerBaseUrl: `http://localhost:${PORT}`,
221
-
222
- // Pact Broker configuration
223
- pactBrokerUrl: process.env.PACT_BROKER_URL,
224
- pactBrokerToken: process.env.PACT_BROKER_TOKEN,
225
- publishVerificationResult: process.env.CI === 'true',
226
- providerVersion: process.env.GIT_SHA || 'dev',
227
-
228
- // State handlers: Setup provider state for each interaction
229
- stateHandlers: {
230
- 'user with id 1 exists': async () => {
231
- await seedDatabase({
232
- users: [
233
- {
234
- id: 1,
235
- name: 'John Doe',
236
- email: 'john@example.com',
237
- role: 'user',
238
- createdAt: '2025-01-15T10:00:00Z',
239
- },
240
- ],
241
- });
242
- return 'User seeded successfully';
243
- },
244
-
245
- 'user with id 999 does not exist': async () => {
246
- // Ensure user doesn't exist
247
- await resetDatabase();
248
- return 'Database reset';
249
- },
250
-
251
- 'no users exist': async () => {
252
- await resetDatabase();
253
- return 'Database empty';
254
- },
255
- },
256
-
257
- // Request filters: Add auth headers to all requests
258
- requestFilter: (req, res, next) => {
259
- // Mock authentication for verification
260
- req.headers['x-user-id'] = 'test-user';
261
- req.headers['authorization'] = 'Bearer valid-test-token';
262
- next();
263
- },
264
-
265
- // Timeout for verification
266
- timeout: 30000,
267
- };
268
-
269
- // Run verification
270
- await new Verifier(opts).verifyProvider();
271
- });
272
- });
273
- ```
274
-
275
- **CI integration**:
276
-
277
- ```yaml
278
- # .github/workflows/pact-provider.yml
279
- name: Pact Provider Verification
280
- on:
281
- pull_request:
282
- push:
283
- branches: [main]
284
-
285
- jobs:
286
- verify-contracts:
287
- runs-on: ubuntu-latest
288
- steps:
289
- - uses: actions/checkout@v4
290
-
291
- - name: Setup Node.js
292
- uses: actions/setup-node@v4
293
- with:
294
- node-version-file: '.nvmrc'
295
-
296
- - name: Install dependencies
297
- run: npm ci
298
-
299
- - name: Start database
300
- run: docker-compose up -d postgres
301
-
302
- - name: Run migrations
303
- run: npm run db:migrate
304
-
305
- - name: Verify pacts
306
- run: npm run test:contract:provider
307
- env:
308
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
309
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
310
- GIT_SHA: ${{ github.sha }}
311
- CI: true
312
-
313
- - name: Can I Deploy?
314
- run: |
315
- npx pact-broker can-i-deploy \
316
- --pacticipant user-api-service \
317
- --version ${{ github.sha }} \
318
- --to-environment production
319
- env:
320
- PACT_BROKER_BASE_URL: ${{ secrets.PACT_BROKER_URL }}
321
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
322
- ```
323
-
324
- **Key Points**:
325
-
326
- - **State handlers**: Setup provider data for each given() state
327
- - **Request filters**: Add auth/headers for verification requests
328
- - **CI publishing**: Verification results sent to broker
329
- - **can-i-deploy**: Safety check before production deployment
330
- - **Database isolation**: Reset between state handlers
331
-
332
- ---
333
-
334
- ### Example 3: Contract CI Integration (Consumer & Provider Workflow)
335
-
336
- **Context**: Complete CI/CD workflow coordinating consumer pact publishing and provider verification.
337
-
338
- **Implementation**:
339
-
340
- ```yaml
341
- # .github/workflows/pact-consumer.yml (Consumer side)
342
- name: Pact Consumer Tests
343
- on:
344
- pull_request:
345
- push:
346
- branches: [main]
347
-
348
- jobs:
349
- consumer-tests:
350
- runs-on: ubuntu-latest
351
- steps:
352
- - uses: actions/checkout@v4
353
-
354
- - name: Setup Node.js
355
- uses: actions/setup-node@v4
356
- with:
357
- node-version-file: '.nvmrc'
358
-
359
- - name: Install dependencies
360
- run: npm ci
361
-
362
- - name: Run consumer contract tests
363
- run: npm run test:contract
364
-
365
- - name: Publish pacts to broker
366
- if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
367
- run: |
368
- npx pact-broker publish ./pacts \
369
- --consumer-app-version ${{ github.sha }} \
370
- --branch ${{ github.head_ref || github.ref_name }} \
371
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
372
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
373
-
374
- - name: Tag pact with environment (main branch only)
375
- if: github.ref == 'refs/heads/main'
376
- run: |
377
- npx pact-broker create-version-tag \
378
- --pacticipant user-management-web \
379
- --version ${{ github.sha }} \
380
- --tag production \
381
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
382
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
383
- ```
384
-
385
- ```yaml
386
- # .github/workflows/pact-provider.yml (Provider side)
387
- name: Pact Provider Verification
388
- on:
389
- pull_request:
390
- push:
391
- branches: [main]
392
- repository_dispatch:
393
- types: [pact_changed] # Webhook from Pact Broker
394
-
395
- jobs:
396
- verify-contracts:
397
- runs-on: ubuntu-latest
398
- steps:
399
- - uses: actions/checkout@v4
400
-
401
- - name: Setup Node.js
402
- uses: actions/setup-node@v4
403
- with:
404
- node-version-file: '.nvmrc'
405
-
406
- - name: Install dependencies
407
- run: npm ci
408
-
409
- - name: Start dependencies
410
- run: docker-compose up -d
411
-
412
- - name: Run provider verification
413
- run: npm run test:contract:provider
414
- env:
415
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
416
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
417
- GIT_SHA: ${{ github.sha }}
418
- CI: true
419
-
420
- - name: Publish verification results
421
- if: always()
422
- run: echo "Verification results published to broker"
423
-
424
- - name: Can I Deploy to Production?
425
- if: github.ref == 'refs/heads/main'
426
- run: |
427
- npx pact-broker can-i-deploy \
428
- --pacticipant user-api-service \
429
- --version ${{ github.sha }} \
430
- --to-environment production \
431
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
432
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }} \
433
- --retry-while-unknown 6 \
434
- --retry-interval 10
435
-
436
- - name: Record deployment (if can-i-deploy passed)
437
- if: success() && github.ref == 'refs/heads/main'
438
- run: |
439
- npx pact-broker record-deployment \
440
- --pacticipant user-api-service \
441
- --version ${{ github.sha }} \
442
- --environment production \
443
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
444
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
445
- ```
446
-
447
- **Pact Broker Webhook Configuration**:
448
-
449
- ```json
450
- {
451
- "events": [
452
- {
453
- "name": "contract_content_changed"
454
- }
455
- ],
456
- "request": {
457
- "method": "POST",
458
- "url": "https://api.github.com/repos/your-org/user-api/dispatches",
459
- "headers": {
460
- "Authorization": "Bearer ${user.githubToken}",
461
- "Content-Type": "application/json",
462
- "Accept": "application/vnd.github.v3+json"
463
- },
464
- "body": {
465
- "event_type": "pact_changed",
466
- "client_payload": {
467
- "pact_url": "${pactbroker.pactUrl}",
468
- "consumer": "${pactbroker.consumerName}",
469
- "provider": "${pactbroker.providerName}"
470
- }
471
- }
472
- }
473
- }
474
- ```
475
-
476
- **Key Points**:
477
-
478
- - **Automatic trigger**: Consumer pact changes trigger provider verification via webhook
479
- - **Branch tracking**: Pacts published per branch for feature testing
480
- - **can-i-deploy**: Safety gate before production deployment
481
- - **Record deployment**: Track which version is in each environment
482
- - **Parallel dev**: Consumer and provider teams work independently
483
-
484
- ---
485
-
486
- ### Example 4: Resilience Coverage (Testing Fallback Behavior)
487
-
488
- **Context**: Capture timeout, retry, and error handling behavior explicitly in contracts.
489
-
490
- **Implementation**:
491
-
492
- ```typescript
493
- // tests/contract/user-api-resilience.pact.spec.ts
494
- import { PactV3, MatchersV3 } from '@pact-foundation/pact';
495
- import { getUserById, ApiError } from '@/api/user-service';
496
-
497
- const { like, string } = MatchersV3;
498
-
499
- const provider = new PactV3({
500
- consumer: 'user-management-web',
501
- provider: 'user-api-service',
502
- dir: './pacts',
503
- });
504
-
505
- describe('User API Resilience Contract', () => {
506
- /**
507
- * Test 500 error handling
508
- * Verifies consumer handles server errors gracefully
509
- */
510
- it('should handle 500 errors with retry logic', async () => {
511
- await provider
512
- .given('server is experiencing errors')
513
- .uponReceiving('a request that returns 500')
514
- .withRequest({
515
- method: 'GET',
516
- path: '/users/1',
517
- headers: { Accept: 'application/json' },
518
- })
519
- .willRespondWith({
520
- status: 500,
521
- headers: { 'Content-Type': 'application/json' },
522
- body: {
523
- error: 'Internal server error',
524
- code: 'INTERNAL_ERROR',
525
- retryable: true,
526
- },
527
- })
528
- .executeTest(async (mockServer) => {
529
- // Consumer should retry on 500
530
- try {
531
- await getUserById(1, {
532
- baseURL: mockServer.url,
533
- retries: 3,
534
- retryDelay: 100,
535
- });
536
- fail('Should have thrown error after retries');
537
- } catch (error) {
538
- expect(error).toBeInstanceOf(ApiError);
539
- expect((error as ApiError).code).toBe('INTERNAL_ERROR');
540
- expect((error as ApiError).retryable).toBe(true);
541
- }
542
- });
543
- });
544
-
545
- /**
546
- * Test 429 rate limiting
547
- * Verifies consumer respects rate limits
548
- */
549
- it('should handle 429 rate limit with backoff', async () => {
550
- await provider
551
- .given('rate limit exceeded for user')
552
- .uponReceiving('a request that is rate limited')
553
- .withRequest({
554
- method: 'GET',
555
- path: '/users/1',
556
- })
557
- .willRespondWith({
558
- status: 429,
559
- headers: {
560
- 'Content-Type': 'application/json',
561
- 'Retry-After': '60', // Retry after 60 seconds
562
- },
563
- body: {
564
- error: 'Too many requests',
565
- code: 'RATE_LIMIT_EXCEEDED',
566
- },
567
- })
568
- .executeTest(async (mockServer) => {
569
- try {
570
- await getUserById(1, {
571
- baseURL: mockServer.url,
572
- respectRateLimit: true,
573
- });
574
- fail('Should have thrown rate limit error');
575
- } catch (error) {
576
- expect(error).toBeInstanceOf(ApiError);
577
- expect((error as ApiError).code).toBe('RATE_LIMIT_EXCEEDED');
578
- expect((error as ApiError).retryAfter).toBe(60);
579
- }
580
- });
581
- });
582
-
583
- /**
584
- * Test timeout handling
585
- * Verifies consumer has appropriate timeout configuration
586
- */
587
- it('should timeout after 10 seconds', async () => {
588
- await provider
589
- .given('server is slow to respond')
590
- .uponReceiving('a request that times out')
591
- .withRequest({
592
- method: 'GET',
593
- path: '/users/1',
594
- })
595
- .willRespondWith({
596
- status: 200,
597
- headers: { 'Content-Type': 'application/json' },
598
- body: like({ id: 1, name: 'John' }),
599
- })
600
- .withDelay(15000) // Simulate 15 second delay
601
- .executeTest(async (mockServer) => {
602
- try {
603
- await getUserById(1, {
604
- baseURL: mockServer.url,
605
- timeout: 10000, // 10 second timeout
606
- });
607
- fail('Should have timed out');
608
- } catch (error) {
609
- expect(error).toBeInstanceOf(ApiError);
610
- expect((error as ApiError).code).toBe('TIMEOUT');
611
- }
612
- });
613
- });
614
-
615
- /**
616
- * Test partial response (optional fields)
617
- * Verifies consumer handles missing optional data
618
- */
619
- it('should handle response with missing optional fields', async () => {
620
- await provider
621
- .given('user exists with minimal data')
622
- .uponReceiving('a request for user with partial data')
623
- .withRequest({
624
- method: 'GET',
625
- path: '/users/1',
626
- })
627
- .willRespondWith({
628
- status: 200,
629
- headers: { 'Content-Type': 'application/json' },
630
- body: {
631
- id: integer(1),
632
- name: string('John Doe'),
633
- email: string('john@example.com'),
634
- // role, createdAt, etc. omitted (optional fields)
635
- },
636
- })
637
- .executeTest(async (mockServer) => {
638
- const user = await getUserById(1, { baseURL: mockServer.url });
639
-
640
- // Consumer handles missing optional fields gracefully
641
- expect(user.id).toBe(1);
642
- expect(user.name).toBe('John Doe');
643
- expect(user.role).toBeUndefined(); // Optional field
644
- expect(user.createdAt).toBeUndefined(); // Optional field
645
- });
646
- });
647
- });
648
- ```
649
-
650
- **API client with retry logic**:
651
-
652
- ```typescript
653
- // src/api/user-service.ts
654
- import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
655
-
656
- export class ApiError extends Error {
657
- constructor(
658
- message: string,
659
- public code: string,
660
- public retryable: boolean = false,
661
- public retryAfter?: number,
662
- ) {
663
- super(message);
664
- }
665
- }
666
-
667
- /**
668
- * User API client with retry and error handling
669
- */
670
- export async function getUserById(
671
- id: number,
672
- config?: AxiosRequestConfig & { retries?: number; retryDelay?: number; respectRateLimit?: boolean },
673
- ): Promise<User> {
674
- const { retries = 3, retryDelay = 1000, respectRateLimit = true, ...axiosConfig } = config || {};
675
-
676
- let lastError: Error;
677
-
678
- for (let attempt = 1; attempt <= retries; attempt++) {
679
- try {
680
- const response = await axios.get(`/users/${id}`, axiosConfig);
681
- return response.data;
682
- } catch (error: any) {
683
- lastError = error;
684
-
685
- // Handle rate limiting
686
- if (error.response?.status === 429) {
687
- const retryAfter = parseInt(error.response.headers['retry-after'] || '60');
688
- throw new ApiError('Too many requests', 'RATE_LIMIT_EXCEEDED', false, retryAfter);
689
- }
690
-
691
- // Retry on 500 errors
692
- if (error.response?.status === 500 && attempt < retries) {
693
- await new Promise((resolve) => setTimeout(resolve, retryDelay * attempt));
694
- continue;
695
- }
696
-
697
- // Handle 404
698
- if (error.response?.status === 404) {
699
- throw new ApiError('User not found', 'USER_NOT_FOUND', false);
700
- }
701
-
702
- // Handle timeout
703
- if (error.code === 'ECONNABORTED') {
704
- throw new ApiError('Request timeout', 'TIMEOUT', true);
705
- }
706
-
707
- break;
708
- }
709
- }
710
-
711
- throw new ApiError('Request failed after retries', 'INTERNAL_ERROR', true);
712
- }
713
- ```
714
-
715
- **Key Points**:
716
-
717
- - **Resilience contracts**: Timeouts, retries, errors explicitly tested
718
- - **State handlers**: Provider sets up each test scenario
719
- - **Error handling**: Consumer validates graceful degradation
720
- - **Retry logic**: Exponential backoff tested
721
- - **Optional fields**: Consumer handles partial responses
722
-
723
- ---
724
-
725
- ### Example 4: Pact Broker Housekeeping & Lifecycle Management
726
-
727
- **Context**: Automated broker maintenance to prevent contract sprawl and noise.
728
-
729
- **Implementation**:
730
-
731
- ```typescript
732
- // scripts/pact-broker-housekeeping.ts
733
- /**
734
- * Pact Broker Housekeeping Script
735
- * - Archive superseded contracts
736
- * - Expire unused pacts
737
- * - Tag releases for environment tracking
738
- */
739
-
740
- import { execSync } from 'child_process';
741
-
742
- const PACT_BROKER_URL = process.env.PACT_BROKER_URL!;
743
- const PACT_BROKER_TOKEN = process.env.PACT_BROKER_TOKEN!;
744
- const PACTICIPANT = 'user-api-service';
745
-
746
- /**
747
- * Tag release with environment
748
- */
749
- function tagRelease(version: string, environment: 'staging' | 'production') {
750
- console.log(`🏷️ Tagging ${PACTICIPANT} v${version} as ${environment}`);
751
-
752
- execSync(
753
- `npx pact-broker create-version-tag \
754
- --pacticipant ${PACTICIPANT} \
755
- --version ${version} \
756
- --tag ${environment} \
757
- --broker-base-url ${PACT_BROKER_URL} \
758
- --broker-token ${PACT_BROKER_TOKEN}`,
759
- { stdio: 'inherit' },
760
- );
761
- }
762
-
763
- /**
764
- * Record deployment to environment
765
- */
766
- function recordDeployment(version: string, environment: 'staging' | 'production') {
767
- console.log(`📝 Recording deployment of ${PACTICIPANT} v${version} to ${environment}`);
768
-
769
- execSync(
770
- `npx pact-broker record-deployment \
771
- --pacticipant ${PACTICIPANT} \
772
- --version ${version} \
773
- --environment ${environment} \
774
- --broker-base-url ${PACT_BROKER_URL} \
775
- --broker-token ${PACT_BROKER_TOKEN}`,
776
- { stdio: 'inherit' },
777
- );
778
- }
779
-
780
- /**
781
- * Clean up old pact versions (retention policy)
782
- * Keep: last 30 days, all production tags, latest from each branch
783
- */
784
- function cleanupOldPacts() {
785
- console.log(`🧹 Cleaning up old pacts for ${PACTICIPANT}`);
786
-
787
- execSync(
788
- `npx pact-broker clean \
789
- --pacticipant ${PACTICIPANT} \
790
- --broker-base-url ${PACT_BROKER_URL} \
791
- --broker-token ${PACT_BROKER_TOKEN} \
792
- --keep-latest-for-branch 1 \
793
- --keep-min-age 30`,
794
- { stdio: 'inherit' },
795
- );
796
- }
797
-
798
- /**
799
- * Check deployment compatibility
800
- */
801
- function canIDeploy(version: string, toEnvironment: string): boolean {
802
- console.log(`🔍 Checking if ${PACTICIPANT} v${version} can deploy to ${toEnvironment}`);
803
-
804
- try {
805
- execSync(
806
- `npx pact-broker can-i-deploy \
807
- --pacticipant ${PACTICIPANT} \
808
- --version ${version} \
809
- --to-environment ${toEnvironment} \
810
- --broker-base-url ${PACT_BROKER_URL} \
811
- --broker-token ${PACT_BROKER_TOKEN} \
812
- --retry-while-unknown 6 \
813
- --retry-interval 10`,
814
- { stdio: 'inherit' },
815
- );
816
- return true;
817
- } catch (error) {
818
- console.error(`❌ Cannot deploy to ${toEnvironment}`);
819
- return false;
820
- }
821
- }
822
-
823
- /**
824
- * Main housekeeping workflow
825
- */
826
- async function main() {
827
- const command = process.argv[2];
828
- const version = process.argv[3];
829
- const environment = process.argv[4] as 'staging' | 'production';
830
-
831
- switch (command) {
832
- case 'tag-release':
833
- tagRelease(version, environment);
834
- break;
835
-
836
- case 'record-deployment':
837
- recordDeployment(version, environment);
838
- break;
839
-
840
- case 'can-i-deploy':
841
- const canDeploy = canIDeploy(version, environment);
842
- process.exit(canDeploy ? 0 : 1);
843
-
844
- case 'cleanup':
845
- cleanupOldPacts();
846
- break;
847
-
848
- default:
849
- console.error('Unknown command. Use: tag-release | record-deployment | can-i-deploy | cleanup');
850
- process.exit(1);
851
- }
852
- }
853
-
854
- main();
855
- ```
856
-
857
- **package.json scripts**:
858
-
859
- ```json
860
- {
861
- "scripts": {
862
- "pact:tag": "ts-node scripts/pact-broker-housekeeping.ts tag-release",
863
- "pact:record": "ts-node scripts/pact-broker-housekeeping.ts record-deployment",
864
- "pact:can-deploy": "ts-node scripts/pact-broker-housekeeping.ts can-i-deploy",
865
- "pact:cleanup": "ts-node scripts/pact-broker-housekeeping.ts cleanup"
866
- }
867
- }
868
- ```
869
-
870
- **Deployment workflow integration**:
871
-
872
- ```yaml
873
- # .github/workflows/deploy-production.yml
874
- name: Deploy to Production
875
- on:
876
- push:
877
- tags:
878
- - 'v*'
879
-
880
- jobs:
881
- verify-contracts:
882
- runs-on: ubuntu-latest
883
- steps:
884
- - uses: actions/checkout@v4
885
-
886
- - name: Check pact compatibility
887
- run: npm run pact:can-deploy ${{ github.ref_name }} production
888
- env:
889
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
890
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
891
-
892
- deploy:
893
- needs: verify-contracts
894
- runs-on: ubuntu-latest
895
- steps:
896
- - name: Deploy to production
897
- run: ./scripts/deploy.sh production
898
-
899
- - name: Record deployment in Pact Broker
900
- run: npm run pact:record ${{ github.ref_name }} production
901
- env:
902
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
903
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
904
- ```
905
-
906
- **Scheduled cleanup**:
907
-
908
- ```yaml
909
- # .github/workflows/pact-housekeeping.yml
910
- name: Pact Broker Housekeeping
911
- on:
912
- schedule:
913
- - cron: '0 2 * * 0' # Weekly on Sunday at 2 AM
914
-
915
- jobs:
916
- cleanup:
917
- runs-on: ubuntu-latest
918
- steps:
919
- - uses: actions/checkout@v4
920
-
921
- - name: Cleanup old pacts
922
- run: npm run pact:cleanup
923
- env:
924
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
925
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
926
- ```
927
-
928
- **Key Points**:
929
-
930
- - **Automated tagging**: Releases tagged with environment
931
- - **Deployment tracking**: Broker knows which version is where
932
- - **Safety gate**: can-i-deploy blocks incompatible deployments
933
- - **Retention policy**: Keep recent, production, and branch-latest pacts
934
- - **Webhook triggers**: Provider verification runs on consumer changes
935
-
936
- ---
937
-
938
- ## Contract Testing Checklist
939
-
940
- Before implementing contract testing, verify:
941
-
942
- - [ ] **Pact Broker setup**: Hosted (Pactflow) or self-hosted broker configured
943
- - [ ] **Consumer tests**: Generate pacts in CI, publish to broker on merge
944
- - [ ] **Provider verification**: Runs on PR, verifies all consumer pacts
945
- - [ ] **State handlers**: Provider implements all given() states
946
- - [ ] **can-i-deploy**: Blocks deployment if contracts incompatible
947
- - [ ] **Webhooks configured**: Consumer changes trigger provider verification
948
- - [ ] **Retention policy**: Old pacts archived (keep 30 days, all production tags)
949
- - [ ] **Resilience tested**: Timeouts, retries, error codes in contracts
950
-
951
- ## Integration Points
952
-
953
- - Used in workflows: `*automate` (integration test generation), `*ci` (contract CI setup)
954
- - Related fragments: `test-levels-framework.md`, `ci-burn-in.md`
955
- - Tools: Pact.js, Pact Broker (Pactflow or self-hosted), Pact CLI
956
-
957
- _Source: Pact consumer/provider sample repos, Murat contract testing blog, Pact official documentation_
1
+ # Contract Testing Essentials (Pact)
2
+
3
+ ## Principle
4
+
5
+ Contract testing validates API contracts between consumer and provider services without requiring integrated end-to-end tests. Store consumer contracts alongside integration specs, version contracts semantically, and publish on every CI run. Provider verification before merge surfaces breaking changes immediately, while explicit fallback behavior (timeouts, retries, error payloads) captures resilience guarantees in contracts.
6
+
7
+ ## Rationale
8
+
9
+ Traditional integration testing requires running both consumer and provider simultaneously, creating slow, flaky tests with complex setup. Contract testing decouples services: consumers define expectations (pact files), providers verify against those expectations independently. This enables parallel development, catches breaking changes early, and documents API behavior as executable specifications. Pair contract tests with API smoke tests to validate data mapping and UI rendering in tandem.
10
+
11
+ ## Pattern Examples
12
+
13
+ ### Example 1: Pact Consumer Test (Frontend → Backend API)
14
+
15
+ **Context**: React application consuming a user management API, defining expected interactions.
16
+
17
+ **Implementation**:
18
+
19
+ ```typescript
20
+ // tests/contract/user-api.pact.spec.ts
21
+ import { PactV3, MatchersV3 } from '@pact-foundation/pact';
22
+ import { getUserById, createUser, User } from '@/api/user-service';
23
+
24
+ const { like, eachLike, string, integer } = MatchersV3;
25
+
26
+ /**
27
+ * Consumer-Driven Contract Test
28
+ * - Consumer (React app) defines expected API behavior
29
+ * - Generates pact file for provider to verify
30
+ * - Runs in isolation (no real backend required)
31
+ */
32
+
33
+ const provider = new PactV3({
34
+ consumer: 'user-management-web',
35
+ provider: 'user-api-service',
36
+ dir: './pacts', // Output directory for pact files
37
+ logLevel: 'warn',
38
+ });
39
+
40
+ describe('User API Contract', () => {
41
+ describe('GET /users/:id', () => {
42
+ it('should return user when user exists', async () => {
43
+ // Arrange: Define expected interaction
44
+ await provider
45
+ .given('user with id 1 exists') // Provider state
46
+ .uponReceiving('a request for user 1')
47
+ .withRequest({
48
+ method: 'GET',
49
+ path: '/users/1',
50
+ headers: {
51
+ Accept: 'application/json',
52
+ Authorization: like('Bearer token123'), // Matcher: any string
53
+ },
54
+ })
55
+ .willRespondWith({
56
+ status: 200,
57
+ headers: {
58
+ 'Content-Type': 'application/json',
59
+ },
60
+ body: like({
61
+ id: integer(1),
62
+ name: string('John Doe'),
63
+ email: string('john@example.com'),
64
+ role: string('user'),
65
+ createdAt: string('2025-01-15T10:00:00Z'),
66
+ }),
67
+ })
68
+ .executeTest(async (mockServer) => {
69
+ // Act: Call consumer code against mock server
70
+ const user = await getUserById(1, {
71
+ baseURL: mockServer.url,
72
+ headers: { Authorization: 'Bearer token123' },
73
+ });
74
+
75
+ // Assert: Validate consumer behavior
76
+ expect(user).toEqual(
77
+ expect.objectContaining({
78
+ id: 1,
79
+ name: 'John Doe',
80
+ email: 'john@example.com',
81
+ role: 'user',
82
+ }),
83
+ );
84
+ });
85
+ });
86
+
87
+ it('should handle 404 when user does not exist', async () => {
88
+ await provider
89
+ .given('user with id 999 does not exist')
90
+ .uponReceiving('a request for non-existent user')
91
+ .withRequest({
92
+ method: 'GET',
93
+ path: '/users/999',
94
+ headers: { Accept: 'application/json' },
95
+ })
96
+ .willRespondWith({
97
+ status: 404,
98
+ headers: { 'Content-Type': 'application/json' },
99
+ body: {
100
+ error: 'User not found',
101
+ code: 'USER_NOT_FOUND',
102
+ },
103
+ })
104
+ .executeTest(async (mockServer) => {
105
+ // Act & Assert: Consumer handles 404 gracefully
106
+ await expect(getUserById(999, { baseURL: mockServer.url })).rejects.toThrow('User not found');
107
+ });
108
+ });
109
+ });
110
+
111
+ describe('POST /users', () => {
112
+ it('should create user and return 201', async () => {
113
+ const newUser: Omit<User, 'id' | 'createdAt'> = {
114
+ name: 'Jane Smith',
115
+ email: 'jane@example.com',
116
+ role: 'admin',
117
+ };
118
+
119
+ await provider
120
+ .given('no users exist')
121
+ .uponReceiving('a request to create a user')
122
+ .withRequest({
123
+ method: 'POST',
124
+ path: '/users',
125
+ headers: {
126
+ 'Content-Type': 'application/json',
127
+ Accept: 'application/json',
128
+ },
129
+ body: like(newUser),
130
+ })
131
+ .willRespondWith({
132
+ status: 201,
133
+ headers: { 'Content-Type': 'application/json' },
134
+ body: like({
135
+ id: integer(2),
136
+ name: string('Jane Smith'),
137
+ email: string('jane@example.com'),
138
+ role: string('admin'),
139
+ createdAt: string('2025-01-15T11:00:00Z'),
140
+ }),
141
+ })
142
+ .executeTest(async (mockServer) => {
143
+ const createdUser = await createUser(newUser, {
144
+ baseURL: mockServer.url,
145
+ });
146
+
147
+ expect(createdUser).toEqual(
148
+ expect.objectContaining({
149
+ id: expect.any(Number),
150
+ name: 'Jane Smith',
151
+ email: 'jane@example.com',
152
+ role: 'admin',
153
+ }),
154
+ );
155
+ });
156
+ });
157
+ });
158
+ });
159
+ ```
160
+
161
+ **package.json scripts**:
162
+
163
+ ```json
164
+ {
165
+ "scripts": {
166
+ "test:contract": "jest tests/contract --testTimeout=30000",
167
+ "pact:publish": "pact-broker publish ./pacts --consumer-app-version=$GIT_SHA --broker-base-url=$PACT_BROKER_URL --broker-token=$PACT_BROKER_TOKEN"
168
+ }
169
+ }
170
+ ```
171
+
172
+ **Key Points**:
173
+
174
+ - **Consumer-driven**: Frontend defines expectations, not backend
175
+ - **Matchers**: `like`, `string`, `integer` for flexible matching
176
+ - **Provider states**: given() sets up test preconditions
177
+ - **Isolation**: No real backend needed, runs fast
178
+ - **Pact generation**: Automatically creates JSON pact files
179
+
180
+ ---
181
+
182
+ ### Example 2: Pact Provider Verification (Backend validates contracts)
183
+
184
+ **Context**: Node.js/Express API verifying pacts published by consumers.
185
+
186
+ **Implementation**:
187
+
188
+ ```typescript
189
+ // tests/contract/user-api.provider.spec.ts
190
+ import { Verifier, VerifierOptions } from '@pact-foundation/pact';
191
+ import { server } from '../../src/server'; // Your Express/Fastify app
192
+ import { seedDatabase, resetDatabase } from '../support/db-helpers';
193
+
194
+ /**
195
+ * Provider Verification Test
196
+ * - Provider (backend API) verifies against published pacts
197
+ * - State handlers setup test data for each interaction
198
+ * - Runs before merge to catch breaking changes
199
+ */
200
+
201
+ describe('Pact Provider Verification', () => {
202
+ let serverInstance;
203
+ const PORT = 3001;
204
+
205
+ beforeAll(async () => {
206
+ // Start provider server
207
+ serverInstance = server.listen(PORT);
208
+ console.log(`Provider server running on port ${PORT}`);
209
+ });
210
+
211
+ afterAll(async () => {
212
+ // Cleanup
213
+ await serverInstance.close();
214
+ });
215
+
216
+ it('should verify pacts from all consumers', async () => {
217
+ const opts: VerifierOptions = {
218
+ // Provider details
219
+ provider: 'user-api-service',
220
+ providerBaseUrl: `http://localhost:${PORT}`,
221
+
222
+ // Pact Broker configuration
223
+ pactBrokerUrl: process.env.PACT_BROKER_URL,
224
+ pactBrokerToken: process.env.PACT_BROKER_TOKEN,
225
+ publishVerificationResult: process.env.CI === 'true',
226
+ providerVersion: process.env.GIT_SHA || 'dev',
227
+
228
+ // State handlers: Setup provider state for each interaction
229
+ stateHandlers: {
230
+ 'user with id 1 exists': async () => {
231
+ await seedDatabase({
232
+ users: [
233
+ {
234
+ id: 1,
235
+ name: 'John Doe',
236
+ email: 'john@example.com',
237
+ role: 'user',
238
+ createdAt: '2025-01-15T10:00:00Z',
239
+ },
240
+ ],
241
+ });
242
+ return 'User seeded successfully';
243
+ },
244
+
245
+ 'user with id 999 does not exist': async () => {
246
+ // Ensure user doesn't exist
247
+ await resetDatabase();
248
+ return 'Database reset';
249
+ },
250
+
251
+ 'no users exist': async () => {
252
+ await resetDatabase();
253
+ return 'Database empty';
254
+ },
255
+ },
256
+
257
+ // Request filters: Add auth headers to all requests
258
+ requestFilter: (req, res, next) => {
259
+ // Mock authentication for verification
260
+ req.headers['x-user-id'] = 'test-user';
261
+ req.headers['authorization'] = 'Bearer valid-test-token';
262
+ next();
263
+ },
264
+
265
+ // Timeout for verification
266
+ timeout: 30000,
267
+ };
268
+
269
+ // Run verification
270
+ await new Verifier(opts).verifyProvider();
271
+ });
272
+ });
273
+ ```
274
+
275
+ **CI integration**:
276
+
277
+ ```yaml
278
+ # .github/workflows/pact-provider.yml
279
+ name: Pact Provider Verification
280
+ on:
281
+ pull_request:
282
+ push:
283
+ branches: [main]
284
+
285
+ jobs:
286
+ verify-contracts:
287
+ runs-on: ubuntu-latest
288
+ steps:
289
+ - uses: actions/checkout@v4
290
+
291
+ - name: Setup Node.js
292
+ uses: actions/setup-node@v4
293
+ with:
294
+ node-version-file: '.nvmrc'
295
+
296
+ - name: Install dependencies
297
+ run: npm ci
298
+
299
+ - name: Start database
300
+ run: docker-compose up -d postgres
301
+
302
+ - name: Run migrations
303
+ run: npm run db:migrate
304
+
305
+ - name: Verify pacts
306
+ run: npm run test:contract:provider
307
+ env:
308
+ PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
309
+ PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
310
+ GIT_SHA: ${{ github.sha }}
311
+ CI: true
312
+
313
+ - name: Can I Deploy?
314
+ run: |
315
+ npx pact-broker can-i-deploy \
316
+ --pacticipant user-api-service \
317
+ --version ${{ github.sha }} \
318
+ --to-environment production
319
+ env:
320
+ PACT_BROKER_BASE_URL: ${{ secrets.PACT_BROKER_URL }}
321
+ PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
322
+ ```
323
+
324
+ **Key Points**:
325
+
326
+ - **State handlers**: Setup provider data for each given() state
327
+ - **Request filters**: Add auth/headers for verification requests
328
+ - **CI publishing**: Verification results sent to broker
329
+ - **can-i-deploy**: Safety check before production deployment
330
+ - **Database isolation**: Reset between state handlers
331
+
332
+ ---
333
+
334
+ ### Example 3: Contract CI Integration (Consumer & Provider Workflow)
335
+
336
+ **Context**: Complete CI/CD workflow coordinating consumer pact publishing and provider verification.
337
+
338
+ **Implementation**:
339
+
340
+ ```yaml
341
+ # .github/workflows/pact-consumer.yml (Consumer side)
342
+ name: Pact Consumer Tests
343
+ on:
344
+ pull_request:
345
+ push:
346
+ branches: [main]
347
+
348
+ jobs:
349
+ consumer-tests:
350
+ runs-on: ubuntu-latest
351
+ steps:
352
+ - uses: actions/checkout@v4
353
+
354
+ - name: Setup Node.js
355
+ uses: actions/setup-node@v4
356
+ with:
357
+ node-version-file: '.nvmrc'
358
+
359
+ - name: Install dependencies
360
+ run: npm ci
361
+
362
+ - name: Run consumer contract tests
363
+ run: npm run test:contract
364
+
365
+ - name: Publish pacts to broker
366
+ if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
367
+ run: |
368
+ npx pact-broker publish ./pacts \
369
+ --consumer-app-version ${{ github.sha }} \
370
+ --branch ${{ github.head_ref || github.ref_name }} \
371
+ --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
372
+ --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
373
+
374
+ - name: Tag pact with environment (main branch only)
375
+ if: github.ref == 'refs/heads/main'
376
+ run: |
377
+ npx pact-broker create-version-tag \
378
+ --pacticipant user-management-web \
379
+ --version ${{ github.sha }} \
380
+ --tag production \
381
+ --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
382
+ --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
383
+ ```
384
+
385
+ ```yaml
386
+ # .github/workflows/pact-provider.yml (Provider side)
387
+ name: Pact Provider Verification
388
+ on:
389
+ pull_request:
390
+ push:
391
+ branches: [main]
392
+ repository_dispatch:
393
+ types: [pact_changed] # Webhook from Pact Broker
394
+
395
+ jobs:
396
+ verify-contracts:
397
+ runs-on: ubuntu-latest
398
+ steps:
399
+ - uses: actions/checkout@v4
400
+
401
+ - name: Setup Node.js
402
+ uses: actions/setup-node@v4
403
+ with:
404
+ node-version-file: '.nvmrc'
405
+
406
+ - name: Install dependencies
407
+ run: npm ci
408
+
409
+ - name: Start dependencies
410
+ run: docker-compose up -d
411
+
412
+ - name: Run provider verification
413
+ run: npm run test:contract:provider
414
+ env:
415
+ PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
416
+ PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
417
+ GIT_SHA: ${{ github.sha }}
418
+ CI: true
419
+
420
+ - name: Publish verification results
421
+ if: always()
422
+ run: echo "Verification results published to broker"
423
+
424
+ - name: Can I Deploy to Production?
425
+ if: github.ref == 'refs/heads/main'
426
+ run: |
427
+ npx pact-broker can-i-deploy \
428
+ --pacticipant user-api-service \
429
+ --version ${{ github.sha }} \
430
+ --to-environment production \
431
+ --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
432
+ --broker-token ${{ secrets.PACT_BROKER_TOKEN }} \
433
+ --retry-while-unknown 6 \
434
+ --retry-interval 10
435
+
436
+ - name: Record deployment (if can-i-deploy passed)
437
+ if: success() && github.ref == 'refs/heads/main'
438
+ run: |
439
+ npx pact-broker record-deployment \
440
+ --pacticipant user-api-service \
441
+ --version ${{ github.sha }} \
442
+ --environment production \
443
+ --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
444
+ --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
445
+ ```
446
+
447
+ **Pact Broker Webhook Configuration**:
448
+
449
+ ```json
450
+ {
451
+ "events": [
452
+ {
453
+ "name": "contract_content_changed"
454
+ }
455
+ ],
456
+ "request": {
457
+ "method": "POST",
458
+ "url": "https://api.github.com/repos/your-org/user-api/dispatches",
459
+ "headers": {
460
+ "Authorization": "Bearer ${user.githubToken}",
461
+ "Content-Type": "application/json",
462
+ "Accept": "application/vnd.github.v3+json"
463
+ },
464
+ "body": {
465
+ "event_type": "pact_changed",
466
+ "client_payload": {
467
+ "pact_url": "${pactbroker.pactUrl}",
468
+ "consumer": "${pactbroker.consumerName}",
469
+ "provider": "${pactbroker.providerName}"
470
+ }
471
+ }
472
+ }
473
+ }
474
+ ```
475
+
476
+ **Key Points**:
477
+
478
+ - **Automatic trigger**: Consumer pact changes trigger provider verification via webhook
479
+ - **Branch tracking**: Pacts published per branch for feature testing
480
+ - **can-i-deploy**: Safety gate before production deployment
481
+ - **Record deployment**: Track which version is in each environment
482
+ - **Parallel dev**: Consumer and provider teams work independently
483
+
484
+ ---
485
+
486
+ ### Example 4: Resilience Coverage (Testing Fallback Behavior)
487
+
488
+ **Context**: Capture timeout, retry, and error handling behavior explicitly in contracts.
489
+
490
+ **Implementation**:
491
+
492
+ ```typescript
493
+ // tests/contract/user-api-resilience.pact.spec.ts
494
+ import { PactV3, MatchersV3 } from '@pact-foundation/pact';
495
+ import { getUserById, ApiError } from '@/api/user-service';
496
+
497
+ const { like, string } = MatchersV3;
498
+
499
+ const provider = new PactV3({
500
+ consumer: 'user-management-web',
501
+ provider: 'user-api-service',
502
+ dir: './pacts',
503
+ });
504
+
505
+ describe('User API Resilience Contract', () => {
506
+ /**
507
+ * Test 500 error handling
508
+ * Verifies consumer handles server errors gracefully
509
+ */
510
+ it('should handle 500 errors with retry logic', async () => {
511
+ await provider
512
+ .given('server is experiencing errors')
513
+ .uponReceiving('a request that returns 500')
514
+ .withRequest({
515
+ method: 'GET',
516
+ path: '/users/1',
517
+ headers: { Accept: 'application/json' },
518
+ })
519
+ .willRespondWith({
520
+ status: 500,
521
+ headers: { 'Content-Type': 'application/json' },
522
+ body: {
523
+ error: 'Internal server error',
524
+ code: 'INTERNAL_ERROR',
525
+ retryable: true,
526
+ },
527
+ })
528
+ .executeTest(async (mockServer) => {
529
+ // Consumer should retry on 500
530
+ try {
531
+ await getUserById(1, {
532
+ baseURL: mockServer.url,
533
+ retries: 3,
534
+ retryDelay: 100,
535
+ });
536
+ fail('Should have thrown error after retries');
537
+ } catch (error) {
538
+ expect(error).toBeInstanceOf(ApiError);
539
+ expect((error as ApiError).code).toBe('INTERNAL_ERROR');
540
+ expect((error as ApiError).retryable).toBe(true);
541
+ }
542
+ });
543
+ });
544
+
545
+ /**
546
+ * Test 429 rate limiting
547
+ * Verifies consumer respects rate limits
548
+ */
549
+ it('should handle 429 rate limit with backoff', async () => {
550
+ await provider
551
+ .given('rate limit exceeded for user')
552
+ .uponReceiving('a request that is rate limited')
553
+ .withRequest({
554
+ method: 'GET',
555
+ path: '/users/1',
556
+ })
557
+ .willRespondWith({
558
+ status: 429,
559
+ headers: {
560
+ 'Content-Type': 'application/json',
561
+ 'Retry-After': '60', // Retry after 60 seconds
562
+ },
563
+ body: {
564
+ error: 'Too many requests',
565
+ code: 'RATE_LIMIT_EXCEEDED',
566
+ },
567
+ })
568
+ .executeTest(async (mockServer) => {
569
+ try {
570
+ await getUserById(1, {
571
+ baseURL: mockServer.url,
572
+ respectRateLimit: true,
573
+ });
574
+ fail('Should have thrown rate limit error');
575
+ } catch (error) {
576
+ expect(error).toBeInstanceOf(ApiError);
577
+ expect((error as ApiError).code).toBe('RATE_LIMIT_EXCEEDED');
578
+ expect((error as ApiError).retryAfter).toBe(60);
579
+ }
580
+ });
581
+ });
582
+
583
+ /**
584
+ * Test timeout handling
585
+ * Verifies consumer has appropriate timeout configuration
586
+ */
587
+ it('should timeout after 10 seconds', async () => {
588
+ await provider
589
+ .given('server is slow to respond')
590
+ .uponReceiving('a request that times out')
591
+ .withRequest({
592
+ method: 'GET',
593
+ path: '/users/1',
594
+ })
595
+ .willRespondWith({
596
+ status: 200,
597
+ headers: { 'Content-Type': 'application/json' },
598
+ body: like({ id: 1, name: 'John' }),
599
+ })
600
+ .withDelay(15000) // Simulate 15 second delay
601
+ .executeTest(async (mockServer) => {
602
+ try {
603
+ await getUserById(1, {
604
+ baseURL: mockServer.url,
605
+ timeout: 10000, // 10 second timeout
606
+ });
607
+ fail('Should have timed out');
608
+ } catch (error) {
609
+ expect(error).toBeInstanceOf(ApiError);
610
+ expect((error as ApiError).code).toBe('TIMEOUT');
611
+ }
612
+ });
613
+ });
614
+
615
+ /**
616
+ * Test partial response (optional fields)
617
+ * Verifies consumer handles missing optional data
618
+ */
619
+ it('should handle response with missing optional fields', async () => {
620
+ await provider
621
+ .given('user exists with minimal data')
622
+ .uponReceiving('a request for user with partial data')
623
+ .withRequest({
624
+ method: 'GET',
625
+ path: '/users/1',
626
+ })
627
+ .willRespondWith({
628
+ status: 200,
629
+ headers: { 'Content-Type': 'application/json' },
630
+ body: {
631
+ id: integer(1),
632
+ name: string('John Doe'),
633
+ email: string('john@example.com'),
634
+ // role, createdAt, etc. omitted (optional fields)
635
+ },
636
+ })
637
+ .executeTest(async (mockServer) => {
638
+ const user = await getUserById(1, { baseURL: mockServer.url });
639
+
640
+ // Consumer handles missing optional fields gracefully
641
+ expect(user.id).toBe(1);
642
+ expect(user.name).toBe('John Doe');
643
+ expect(user.role).toBeUndefined(); // Optional field
644
+ expect(user.createdAt).toBeUndefined(); // Optional field
645
+ });
646
+ });
647
+ });
648
+ ```
649
+
650
+ **API client with retry logic**:
651
+
652
+ ```typescript
653
+ // src/api/user-service.ts
654
+ import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
655
+
656
+ export class ApiError extends Error {
657
+ constructor(
658
+ message: string,
659
+ public code: string,
660
+ public retryable: boolean = false,
661
+ public retryAfter?: number,
662
+ ) {
663
+ super(message);
664
+ }
665
+ }
666
+
667
+ /**
668
+ * User API client with retry and error handling
669
+ */
670
+ export async function getUserById(
671
+ id: number,
672
+ config?: AxiosRequestConfig & { retries?: number; retryDelay?: number; respectRateLimit?: boolean },
673
+ ): Promise<User> {
674
+ const { retries = 3, retryDelay = 1000, respectRateLimit = true, ...axiosConfig } = config || {};
675
+
676
+ let lastError: Error;
677
+
678
+ for (let attempt = 1; attempt <= retries; attempt++) {
679
+ try {
680
+ const response = await axios.get(`/users/${id}`, axiosConfig);
681
+ return response.data;
682
+ } catch (error: any) {
683
+ lastError = error;
684
+
685
+ // Handle rate limiting
686
+ if (error.response?.status === 429) {
687
+ const retryAfter = parseInt(error.response.headers['retry-after'] || '60');
688
+ throw new ApiError('Too many requests', 'RATE_LIMIT_EXCEEDED', false, retryAfter);
689
+ }
690
+
691
+ // Retry on 500 errors
692
+ if (error.response?.status === 500 && attempt < retries) {
693
+ await new Promise((resolve) => setTimeout(resolve, retryDelay * attempt));
694
+ continue;
695
+ }
696
+
697
+ // Handle 404
698
+ if (error.response?.status === 404) {
699
+ throw new ApiError('User not found', 'USER_NOT_FOUND', false);
700
+ }
701
+
702
+ // Handle timeout
703
+ if (error.code === 'ECONNABORTED') {
704
+ throw new ApiError('Request timeout', 'TIMEOUT', true);
705
+ }
706
+
707
+ break;
708
+ }
709
+ }
710
+
711
+ throw new ApiError('Request failed after retries', 'INTERNAL_ERROR', true);
712
+ }
713
+ ```
714
+
715
+ **Key Points**:
716
+
717
+ - **Resilience contracts**: Timeouts, retries, errors explicitly tested
718
+ - **State handlers**: Provider sets up each test scenario
719
+ - **Error handling**: Consumer validates graceful degradation
720
+ - **Retry logic**: Exponential backoff tested
721
+ - **Optional fields**: Consumer handles partial responses
722
+
723
+ ---
724
+
725
+ ### Example 4: Pact Broker Housekeeping & Lifecycle Management
726
+
727
+ **Context**: Automated broker maintenance to prevent contract sprawl and noise.
728
+
729
+ **Implementation**:
730
+
731
+ ```typescript
732
+ // scripts/pact-broker-housekeeping.ts
733
+ /**
734
+ * Pact Broker Housekeeping Script
735
+ * - Archive superseded contracts
736
+ * - Expire unused pacts
737
+ * - Tag releases for environment tracking
738
+ */
739
+
740
+ import { execSync } from 'child_process';
741
+
742
+ const PACT_BROKER_URL = process.env.PACT_BROKER_URL!;
743
+ const PACT_BROKER_TOKEN = process.env.PACT_BROKER_TOKEN!;
744
+ const PACTICIPANT = 'user-api-service';
745
+
746
+ /**
747
+ * Tag release with environment
748
+ */
749
+ function tagRelease(version: string, environment: 'staging' | 'production') {
750
+ console.log(`🏷️ Tagging ${PACTICIPANT} v${version} as ${environment}`);
751
+
752
+ execSync(
753
+ `npx pact-broker create-version-tag \
754
+ --pacticipant ${PACTICIPANT} \
755
+ --version ${version} \
756
+ --tag ${environment} \
757
+ --broker-base-url ${PACT_BROKER_URL} \
758
+ --broker-token ${PACT_BROKER_TOKEN}`,
759
+ { stdio: 'inherit' },
760
+ );
761
+ }
762
+
763
+ /**
764
+ * Record deployment to environment
765
+ */
766
+ function recordDeployment(version: string, environment: 'staging' | 'production') {
767
+ console.log(`📝 Recording deployment of ${PACTICIPANT} v${version} to ${environment}`);
768
+
769
+ execSync(
770
+ `npx pact-broker record-deployment \
771
+ --pacticipant ${PACTICIPANT} \
772
+ --version ${version} \
773
+ --environment ${environment} \
774
+ --broker-base-url ${PACT_BROKER_URL} \
775
+ --broker-token ${PACT_BROKER_TOKEN}`,
776
+ { stdio: 'inherit' },
777
+ );
778
+ }
779
+
780
+ /**
781
+ * Clean up old pact versions (retention policy)
782
+ * Keep: last 30 days, all production tags, latest from each branch
783
+ */
784
+ function cleanupOldPacts() {
785
+ console.log(`🧹 Cleaning up old pacts for ${PACTICIPANT}`);
786
+
787
+ execSync(
788
+ `npx pact-broker clean \
789
+ --pacticipant ${PACTICIPANT} \
790
+ --broker-base-url ${PACT_BROKER_URL} \
791
+ --broker-token ${PACT_BROKER_TOKEN} \
792
+ --keep-latest-for-branch 1 \
793
+ --keep-min-age 30`,
794
+ { stdio: 'inherit' },
795
+ );
796
+ }
797
+
798
+ /**
799
+ * Check deployment compatibility
800
+ */
801
+ function canIDeploy(version: string, toEnvironment: string): boolean {
802
+ console.log(`🔍 Checking if ${PACTICIPANT} v${version} can deploy to ${toEnvironment}`);
803
+
804
+ try {
805
+ execSync(
806
+ `npx pact-broker can-i-deploy \
807
+ --pacticipant ${PACTICIPANT} \
808
+ --version ${version} \
809
+ --to-environment ${toEnvironment} \
810
+ --broker-base-url ${PACT_BROKER_URL} \
811
+ --broker-token ${PACT_BROKER_TOKEN} \
812
+ --retry-while-unknown 6 \
813
+ --retry-interval 10`,
814
+ { stdio: 'inherit' },
815
+ );
816
+ return true;
817
+ } catch (error) {
818
+ console.error(`❌ Cannot deploy to ${toEnvironment}`);
819
+ return false;
820
+ }
821
+ }
822
+
823
+ /**
824
+ * Main housekeeping workflow
825
+ */
826
+ async function main() {
827
+ const command = process.argv[2];
828
+ const version = process.argv[3];
829
+ const environment = process.argv[4] as 'staging' | 'production';
830
+
831
+ switch (command) {
832
+ case 'tag-release':
833
+ tagRelease(version, environment);
834
+ break;
835
+
836
+ case 'record-deployment':
837
+ recordDeployment(version, environment);
838
+ break;
839
+
840
+ case 'can-i-deploy':
841
+ const canDeploy = canIDeploy(version, environment);
842
+ process.exit(canDeploy ? 0 : 1);
843
+
844
+ case 'cleanup':
845
+ cleanupOldPacts();
846
+ break;
847
+
848
+ default:
849
+ console.error('Unknown command. Use: tag-release | record-deployment | can-i-deploy | cleanup');
850
+ process.exit(1);
851
+ }
852
+ }
853
+
854
+ main();
855
+ ```
856
+
857
+ **package.json scripts**:
858
+
859
+ ```json
860
+ {
861
+ "scripts": {
862
+ "pact:tag": "ts-node scripts/pact-broker-housekeeping.ts tag-release",
863
+ "pact:record": "ts-node scripts/pact-broker-housekeeping.ts record-deployment",
864
+ "pact:can-deploy": "ts-node scripts/pact-broker-housekeeping.ts can-i-deploy",
865
+ "pact:cleanup": "ts-node scripts/pact-broker-housekeeping.ts cleanup"
866
+ }
867
+ }
868
+ ```
869
+
870
+ **Deployment workflow integration**:
871
+
872
+ ```yaml
873
+ # .github/workflows/deploy-production.yml
874
+ name: Deploy to Production
875
+ on:
876
+ push:
877
+ tags:
878
+ - 'v*'
879
+
880
+ jobs:
881
+ verify-contracts:
882
+ runs-on: ubuntu-latest
883
+ steps:
884
+ - uses: actions/checkout@v4
885
+
886
+ - name: Check pact compatibility
887
+ run: npm run pact:can-deploy ${{ github.ref_name }} production
888
+ env:
889
+ PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
890
+ PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
891
+
892
+ deploy:
893
+ needs: verify-contracts
894
+ runs-on: ubuntu-latest
895
+ steps:
896
+ - name: Deploy to production
897
+ run: ./scripts/deploy.sh production
898
+
899
+ - name: Record deployment in Pact Broker
900
+ run: npm run pact:record ${{ github.ref_name }} production
901
+ env:
902
+ PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
903
+ PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
904
+ ```
905
+
906
+ **Scheduled cleanup**:
907
+
908
+ ```yaml
909
+ # .github/workflows/pact-housekeeping.yml
910
+ name: Pact Broker Housekeeping
911
+ on:
912
+ schedule:
913
+ - cron: '0 2 * * 0' # Weekly on Sunday at 2 AM
914
+
915
+ jobs:
916
+ cleanup:
917
+ runs-on: ubuntu-latest
918
+ steps:
919
+ - uses: actions/checkout@v4
920
+
921
+ - name: Cleanup old pacts
922
+ run: npm run pact:cleanup
923
+ env:
924
+ PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
925
+ PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
926
+ ```
927
+
928
+ **Key Points**:
929
+
930
+ - **Automated tagging**: Releases tagged with environment
931
+ - **Deployment tracking**: Broker knows which version is where
932
+ - **Safety gate**: can-i-deploy blocks incompatible deployments
933
+ - **Retention policy**: Keep recent, production, and branch-latest pacts
934
+ - **Webhook triggers**: Provider verification runs on consumer changes
935
+
936
+ ---
937
+
938
+ ## Contract Testing Checklist
939
+
940
+ Before implementing contract testing, verify:
941
+
942
+ - [ ] **Pact Broker setup**: Hosted (Pactflow) or self-hosted broker configured
943
+ - [ ] **Consumer tests**: Generate pacts in CI, publish to broker on merge
944
+ - [ ] **Provider verification**: Runs on PR, verifies all consumer pacts
945
+ - [ ] **State handlers**: Provider implements all given() states
946
+ - [ ] **can-i-deploy**: Blocks deployment if contracts incompatible
947
+ - [ ] **Webhooks configured**: Consumer changes trigger provider verification
948
+ - [ ] **Retention policy**: Old pacts archived (keep 30 days, all production tags)
949
+ - [ ] **Resilience tested**: Timeouts, retries, error codes in contracts
950
+
951
+ ## Integration Points
952
+
953
+ - Used in workflows: `*automate` (integration test generation), `*ci` (contract CI setup)
954
+ - Related fragments: `test-levels-framework.md`, `ci-burn-in.md`
955
+ - Tools: Pact.js, Pact Broker (Pactflow or self-hosted), Pact CLI
956
+
957
+ _Source: Pact consumer/provider sample repos, Murat contract testing blog, Pact official documentation_