spoonfeeder 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (690) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +249 -0
  3. package/dist/generator/ai-context-assembler.d.ts +4 -0
  4. package/dist/generator/ai-context-assembler.js +52 -0
  5. package/dist/generator/ai-context-assembler.js.map +1 -0
  6. package/dist/generator/env-merger.d.ts +3 -0
  7. package/dist/generator/env-merger.js +16 -0
  8. package/dist/generator/env-merger.js.map +1 -0
  9. package/dist/generator/generator.d.ts +3 -0
  10. package/dist/generator/generator.js +253 -0
  11. package/dist/generator/generator.js.map +1 -0
  12. package/dist/generator/package-json-merger.d.ts +6 -0
  13. package/dist/generator/package-json-merger.js +29 -0
  14. package/dist/generator/package-json-merger.js.map +1 -0
  15. package/dist/generator/post-generate.d.ts +1 -0
  16. package/dist/generator/post-generate.js +28 -0
  17. package/dist/generator/post-generate.js.map +1 -0
  18. package/dist/generator/template-engine.d.ts +4 -0
  19. package/dist/generator/template-engine.js +20 -0
  20. package/dist/generator/template-engine.js.map +1 -0
  21. package/dist/generators/add-recipe/generator.d.ts +3 -0
  22. package/dist/generators/add-recipe/generator.js +153 -0
  23. package/dist/generators/add-recipe/generator.js.map +1 -0
  24. package/dist/generators/list-recipes/generator.d.ts +3 -0
  25. package/dist/generators/list-recipes/generator.js +58 -0
  26. package/dist/generators/list-recipes/generator.js.map +1 -0
  27. package/dist/generators/migrate-recipe/generator.d.ts +9 -0
  28. package/dist/generators/migrate-recipe/generator.js +90 -0
  29. package/dist/generators/migrate-recipe/generator.js.map +1 -0
  30. package/dist/generators/migrate-recipe/migration-guidance.d.ts +1 -0
  31. package/dist/generators/migrate-recipe/migration-guidance.js +159 -0
  32. package/dist/generators/migrate-recipe/migration-guidance.js.map +1 -0
  33. package/dist/generators/remove-recipe/generator.d.ts +3 -0
  34. package/dist/generators/remove-recipe/generator.js +176 -0
  35. package/dist/generators/remove-recipe/generator.js.map +1 -0
  36. package/dist/index.d.ts +2 -0
  37. package/dist/index.js +40 -0
  38. package/dist/index.js.map +1 -0
  39. package/dist/prompts/add-ons.d.ts +3 -0
  40. package/dist/prompts/add-ons.js +29 -0
  41. package/dist/prompts/add-ons.js.map +1 -0
  42. package/dist/prompts/ci-cd.d.ts +2 -0
  43. package/dist/prompts/ci-cd.js +19 -0
  44. package/dist/prompts/ci-cd.js.map +1 -0
  45. package/dist/prompts/cloud-provider.d.ts +2 -0
  46. package/dist/prompts/cloud-provider.js +18 -0
  47. package/dist/prompts/cloud-provider.js.map +1 -0
  48. package/dist/prompts/confirmation.d.ts +2 -0
  49. package/dist/prompts/confirmation.js +29 -0
  50. package/dist/prompts/confirmation.js.map +1 -0
  51. package/dist/prompts/deployment.d.ts +2 -0
  52. package/dist/prompts/deployment.js +20 -0
  53. package/dist/prompts/deployment.js.map +1 -0
  54. package/dist/prompts/frontend.d.ts +2 -0
  55. package/dist/prompts/frontend.js +18 -0
  56. package/dist/prompts/frontend.js.map +1 -0
  57. package/dist/prompts/project-name.d.ts +5 -0
  58. package/dist/prompts/project-name.js +34 -0
  59. package/dist/prompts/project-name.js.map +1 -0
  60. package/dist/prompts/project-type.d.ts +2 -0
  61. package/dist/prompts/project-type.js +22 -0
  62. package/dist/prompts/project-type.js.map +1 -0
  63. package/dist/prompts/run-all.d.ts +3 -0
  64. package/dist/prompts/run-all.js +83 -0
  65. package/dist/prompts/run-all.js.map +1 -0
  66. package/dist/prompts/transport.d.ts +2 -0
  67. package/dist/prompts/transport.js +22 -0
  68. package/dist/prompts/transport.js.map +1 -0
  69. package/dist/recipes/definitions.d.ts +2 -0
  70. package/dist/recipes/definitions.js +3647 -0
  71. package/dist/recipes/definitions.js.map +1 -0
  72. package/dist/recipes/recipe.interface.d.ts +8 -0
  73. package/dist/recipes/recipe.interface.js +2 -0
  74. package/dist/recipes/recipe.interface.js.map +1 -0
  75. package/dist/recipes/registry.d.ts +9 -0
  76. package/dist/recipes/registry.js +23 -0
  77. package/dist/recipes/registry.js.map +1 -0
  78. package/dist/types.d.ts +70 -0
  79. package/dist/types.js +152 -0
  80. package/dist/types.js.map +1 -0
  81. package/dist/utils/ai-context-updater.d.ts +6 -0
  82. package/dist/utils/ai-context-updater.js +50 -0
  83. package/dist/utils/ai-context-updater.js.map +1 -0
  84. package/dist/utils/dependency-checker.d.ts +14 -0
  85. package/dist/utils/dependency-checker.js +27 -0
  86. package/dist/utils/dependency-checker.js.map +1 -0
  87. package/dist/utils/env-updater.d.ts +7 -0
  88. package/dist/utils/env-updater.js +35 -0
  89. package/dist/utils/env-updater.js.map +1 -0
  90. package/dist/utils/main-ts-updater.d.ts +37 -0
  91. package/dist/utils/main-ts-updater.js +144 -0
  92. package/dist/utils/main-ts-updater.js.map +1 -0
  93. package/dist/utils/module-updater.d.ts +26 -0
  94. package/dist/utils/module-updater.js +167 -0
  95. package/dist/utils/module-updater.js.map +1 -0
  96. package/dist/utils/recipe-manifest.d.ts +24 -0
  97. package/dist/utils/recipe-manifest.js +45 -0
  98. package/dist/utils/recipe-manifest.js.map +1 -0
  99. package/dist/validation/config-validator.d.ts +13 -0
  100. package/dist/validation/config-validator.js +50 -0
  101. package/dist/validation/config-validator.js.map +1 -0
  102. package/dist/validation/conflict-detector.d.ts +7 -0
  103. package/dist/validation/conflict-detector.js +37 -0
  104. package/dist/validation/conflict-detector.js.map +1 -0
  105. package/generators.json +24 -0
  106. package/package.json +78 -0
  107. package/src/generators/add-recipe/schema.json +21 -0
  108. package/src/generators/list-recipes/schema.json +18 -0
  109. package/src/generators/migrate-recipe/schema.json +20 -0
  110. package/src/generators/remove-recipe/schema.json +21 -0
  111. package/templates/base/.env.example.ejs +3 -0
  112. package/templates/base/README.md.ejs +20 -0
  113. package/templates/base/SECURITY.md +36 -0
  114. package/templates/base/commitlint.config.js +15 -0
  115. package/templates/base/docs/adr/000-template.md +45 -0
  116. package/templates/base/docs/adr/001-framework-selection.md +54 -0
  117. package/templates/base/docs/adr/002-error-handling-strategy.md +36 -0
  118. package/templates/base/docs/adr/003-database-strategy.md +40 -0
  119. package/templates/base/docs/adr/004-authentication-architecture.md +44 -0
  120. package/templates/base/docs/adr/005-deployment-strategy.md +40 -0
  121. package/templates/base/docs/adr/006-testing-strategy.md +41 -0
  122. package/templates/base/docs/adr/007-scaffolder-architecture.md +64 -0
  123. package/templates/base/docs/adr/008-recipe-system.md +47 -0
  124. package/templates/base/docs/adr/009-standards-compliance.md +54 -0
  125. package/templates/base/docs/adr/010-ai-context-generation.md +44 -0
  126. package/templates/base/docs/adr/011-package-versioning.md +44 -0
  127. package/templates/base/docs/adr/012-monorepo-strategy.md +54 -0
  128. package/templates/base/docs/adr/013-http-adapter.md +63 -0
  129. package/templates/base/docs/adr/014-build-toolchain.md +61 -0
  130. package/templates/base/docs/adr/015-cloud-provider-strategy.md +49 -0
  131. package/templates/base/docs/adr/016-ci-cd-pipeline-strategy.md +52 -0
  132. package/templates/base/docs/adr/017-logging-strategy.md +63 -0
  133. package/templates/base/docs/adr/018-security-architecture.md +61 -0
  134. package/templates/base/docs/adr/019-project-type-design.md +61 -0
  135. package/templates/base/docs/adr/020-frontend-framework-support.md +57 -0
  136. package/templates/base/docs/adr/021-observability-strategy.md +68 -0
  137. package/templates/base/docs/adr/022-api-design-patterns.md +64 -0
  138. package/templates/base/docs/adr/023-error-hierarchy.md +54 -0
  139. package/templates/base/docs/adr/024-request-context-pattern.md +57 -0
  140. package/templates/base/docs/adr/025-data-patterns.md +58 -0
  141. package/templates/base/docs/adr/026-migration-strategy.md +57 -0
  142. package/templates/base/docs/adr/027-dependency-management.md +60 -0
  143. package/templates/base/docs/adr/028-code-quality-toolchain.md +60 -0
  144. package/templates/base/docs/adr/029-admin-panel.md +53 -0
  145. package/templates/base/docs/adr/030-performance-patterns.md +60 -0
  146. package/templates/base/docs/adr/031-nx-generators-roadmap.md +73 -0
  147. package/templates/base/docs/runbooks/000-template.md +78 -0
  148. package/templates/base/docs/sla-slo.md +36 -0
  149. package/templates/base/dot-editorconfig +12 -0
  150. package/templates/base/dot-github/ISSUE_TEMPLATE/bug_report.md +33 -0
  151. package/templates/base/dot-github/ISSUE_TEMPLATE/feature_request.md +21 -0
  152. package/templates/base/dot-github/pull_request_template.md +32 -0
  153. package/templates/base/dot-gitignore +28 -0
  154. package/templates/base/dot-husky/commit-msg +1 -0
  155. package/templates/base/dot-husky/pre-commit +1 -0
  156. package/templates/base/dot-husky/pre-push +2 -0
  157. package/templates/base/dot-npmrc +1 -0
  158. package/templates/base/dot-nvmrc +1 -0
  159. package/templates/base/dot-prettierrc +8 -0
  160. package/templates/base/eslint.config.mjs +35 -0
  161. package/templates/base/jest.config.ts +56 -0
  162. package/templates/base/nest-cli.json.ejs +10 -0
  163. package/templates/base/nx.json +3 -0
  164. package/templates/base/package.json.ejs +78 -0
  165. package/templates/base/src/app/modules/.gitkeep +0 -0
  166. package/templates/base/src/config/.gitkeep +0 -0
  167. package/templates/base/src/infrastructure/database/entities/.gitkeep +0 -0
  168. package/templates/base/src/infrastructure/database/migrations/.gitkeep +0 -0
  169. package/templates/base/src/infrastructure/database/repositories/.gitkeep +0 -0
  170. package/templates/base/src/infrastructure/http/.gitkeep +0 -0
  171. package/templates/base/src/infrastructure/notifications/.gitkeep +0 -0
  172. package/templates/base/src/infrastructure/queue/.gitkeep +0 -0
  173. package/templates/base/src/infrastructure/storage/.gitkeep +0 -0
  174. package/templates/base/src/shared/constants/error-codes.constant.ts +30 -0
  175. package/templates/base/src/shared/constants/http.constant.ts +134 -0
  176. package/templates/base/src/shared/constants/index.ts +2 -0
  177. package/templates/base/src/shared/decorators/.gitkeep +0 -0
  178. package/templates/base/src/shared/decorators/api-paginated-response.decorator.ts +10 -0
  179. package/templates/base/src/shared/errors/application.error.ts +21 -0
  180. package/templates/base/src/shared/errors/forbidden.error.ts +7 -0
  181. package/templates/base/src/shared/errors/index.ts +6 -0
  182. package/templates/base/src/shared/errors/invalid-request.error.ts +7 -0
  183. package/templates/base/src/shared/errors/not-found.error.ts +7 -0
  184. package/templates/base/src/shared/errors/requester.error.ts +7 -0
  185. package/templates/base/src/shared/errors/validation.error.ts +7 -0
  186. package/templates/base/src/shared/filters/http-exception.filter.ts +139 -0
  187. package/templates/base/src/shared/guards/.gitkeep +0 -0
  188. package/templates/base/src/shared/interceptors/interfaces/.gitkeep +0 -0
  189. package/templates/base/src/shared/interceptors/response.interceptor.ts +22 -0
  190. package/templates/base/src/shared/middleware/request-timeout.middleware.ts +32 -0
  191. package/templates/base/src/shared/pipes/parse-uuid.pipe.ts +13 -0
  192. package/templates/base/src/shared/utils/index.ts +2 -0
  193. package/templates/base/src/shared/utils/retry.util.ts +32 -0
  194. package/templates/base/src/shared/utils/sleep.util.ts +3 -0
  195. package/templates/base/tests/e2e/app.e2e-spec.ts.ejs +25 -0
  196. package/templates/base/tests/factories/.gitkeep +0 -0
  197. package/templates/base/tests/helpers/.gitkeep +0 -0
  198. package/templates/base/tests/integration/.gitkeep +0 -0
  199. package/templates/base/tests/unit/app.module.spec.ts +11 -0
  200. package/templates/base/tests/unit/shared/errors/error-hierarchy.spec.ts +69 -0
  201. package/templates/base/tests/unit/shared/filters/http-exception.filter.spec.ts +188 -0
  202. package/templates/base/tests/unit/shared/interceptors/response.interceptor.spec.ts +54 -0
  203. package/templates/base/tests/unit/shared/pipes/parse-uuid.pipe.spec.ts +14 -0
  204. package/templates/base/tsconfig.build.json +4 -0
  205. package/templates/base/tsconfig.json.ejs +26 -0
  206. package/templates/project-types/aws-lambda/package-fragment.json +8 -0
  207. package/templates/project-types/aws-lambda/src/app.module.ts.ejs +9 -0
  208. package/templates/project-types/aws-lambda/src/main.ts.ejs +32 -0
  209. package/templates/project-types/aws-lambda/tests/unit/handler.spec.ts +7 -0
  210. package/templates/project-types/cli-app/package-fragment.json +8 -0
  211. package/templates/project-types/cli-app/src/app.module.ts.ejs +11 -0
  212. package/templates/project-types/cli-app/src/commands/hello.command.ts.ejs +8 -0
  213. package/templates/project-types/cli-app/src/main.ts.ejs +8 -0
  214. package/templates/project-types/cli-app/tests/unit/commands/hello.command.spec.ts +17 -0
  215. package/templates/project-types/full-stack/apps/api/src/app.module.ts.ejs +9 -0
  216. package/templates/project-types/full-stack/apps/api/src/main.ts.ejs +32 -0
  217. package/templates/project-types/full-stack/frontend/nextjs/.cursor/rules/nextjs.mdc +12 -0
  218. package/templates/project-types/full-stack/frontend/nextjs/.github/copilot-instructions.md +23 -0
  219. package/templates/project-types/full-stack/frontend/nextjs/CLAUDE.md +25 -0
  220. package/templates/project-types/full-stack/frontend/nextjs/next.config.ts +9 -0
  221. package/templates/project-types/full-stack/frontend/nextjs/package.json +21 -0
  222. package/templates/project-types/full-stack/frontend/nextjs/src/app/layout.tsx +9 -0
  223. package/templates/project-types/full-stack/frontend/nextjs/src/app/page.tsx +8 -0
  224. package/templates/project-types/full-stack/frontend/nextjs/tsconfig.json +21 -0
  225. package/templates/project-types/full-stack/frontend/nuxt/.cursor/rules/nuxt.mdc +14 -0
  226. package/templates/project-types/full-stack/frontend/nuxt/.github/copilot-instructions.md +25 -0
  227. package/templates/project-types/full-stack/frontend/nuxt/CLAUDE.md +25 -0
  228. package/templates/project-types/full-stack/frontend/nuxt/app.vue +5 -0
  229. package/templates/project-types/full-stack/frontend/nuxt/nuxt.config.ts +6 -0
  230. package/templates/project-types/full-stack/frontend/nuxt/package.json +17 -0
  231. package/templates/project-types/full-stack/frontend/nuxt/pages/index.vue +3 -0
  232. package/templates/project-types/full-stack/frontend/nuxt/tsconfig.json +1 -0
  233. package/templates/project-types/full-stack/frontend/sveltekit/.cursor/rules/sveltekit.mdc +13 -0
  234. package/templates/project-types/full-stack/frontend/sveltekit/.github/copilot-instructions.md +24 -0
  235. package/templates/project-types/full-stack/frontend/sveltekit/CLAUDE.md +25 -0
  236. package/templates/project-types/full-stack/frontend/sveltekit/package.json +17 -0
  237. package/templates/project-types/full-stack/frontend/sveltekit/src/app.html +5 -0
  238. package/templates/project-types/full-stack/frontend/sveltekit/src/routes/+page.svelte +1 -0
  239. package/templates/project-types/full-stack/frontend/sveltekit/svelte.config.js +5 -0
  240. package/templates/project-types/full-stack/frontend/sveltekit/vite.config.ts +9 -0
  241. package/templates/project-types/full-stack/frontend/vite-react/.cursor/rules/react.mdc +12 -0
  242. package/templates/project-types/full-stack/frontend/vite-react/.github/copilot-instructions.md +23 -0
  243. package/templates/project-types/full-stack/frontend/vite-react/CLAUDE.md +24 -0
  244. package/templates/project-types/full-stack/frontend/vite-react/index.html +5 -0
  245. package/templates/project-types/full-stack/frontend/vite-react/package.json +22 -0
  246. package/templates/project-types/full-stack/frontend/vite-react/src/App.tsx +8 -0
  247. package/templates/project-types/full-stack/frontend/vite-react/src/main.tsx +9 -0
  248. package/templates/project-types/full-stack/frontend/vite-react/tsconfig.json +21 -0
  249. package/templates/project-types/full-stack/frontend/vite-react/vite.config.ts +9 -0
  250. package/templates/project-types/full-stack/libs/shared-types/package.json.ejs +6 -0
  251. package/templates/project-types/full-stack/libs/shared-types/src/index.ts.ejs +15 -0
  252. package/templates/project-types/full-stack/nx.json.ejs +20 -0
  253. package/templates/project-types/full-stack/package-fragment.json +14 -0
  254. package/templates/project-types/full-stack/pnpm-workspace.yaml +3 -0
  255. package/templates/project-types/full-stack/tsconfig.json.ejs +27 -0
  256. package/templates/project-types/http-api/src/app.module.ts.ejs +9 -0
  257. package/templates/project-types/http-api/src/main.ts.ejs +30 -0
  258. package/templates/project-types/http-api/tests/e2e/health.e2e-spec.ts +23 -0
  259. package/templates/project-types/microservice/package-fragment.json +5 -0
  260. package/templates/project-types/microservice/src/app.module.ts.ejs +9 -0
  261. package/templates/project-types/microservice/src/main.ts.ejs +15 -0
  262. package/templates/project-types/microservice/tests/unit/app.module.spec.ts +9 -0
  263. package/templates/project-types/monorepo/README.md.ejs +33 -0
  264. package/templates/project-types/monorepo/apps/api/src/app.module.ts.ejs +9 -0
  265. package/templates/project-types/monorepo/apps/api/src/main.ts.ejs +30 -0
  266. package/templates/project-types/monorepo/libs/common/package.json.ejs +6 -0
  267. package/templates/project-types/monorepo/libs/common/src/index.ts.ejs +17 -0
  268. package/templates/project-types/monorepo/nx.json.ejs +20 -0
  269. package/templates/project-types/monorepo/package-fragment.json +13 -0
  270. package/templates/project-types/monorepo/pnpm-workspace.yaml +3 -0
  271. package/templates/project-types/monorepo/tsconfig.json.ejs +27 -0
  272. package/templates/project-types/scheduled-worker/package-fragment.json +5 -0
  273. package/templates/project-types/scheduled-worker/src/app.module.ts.ejs +13 -0
  274. package/templates/project-types/scheduled-worker/src/jobs/example.job.ts.ejs +12 -0
  275. package/templates/project-types/scheduled-worker/src/main.ts.ejs +10 -0
  276. package/templates/project-types/scheduled-worker/tests/unit/jobs/example.job.spec.ts +17 -0
  277. package/templates/recipes/adminjs/README.md +145 -0
  278. package/templates/recipes/adminjs/src/app/modules/admin/admin.module.ts +59 -0
  279. package/templates/recipes/adminjs/tests/unit/app/modules/admin/admin.module.spec.ts +22 -0
  280. package/templates/recipes/ai-context/README.md +11 -0
  281. package/templates/recipes/ai-context/claude/base.md +73 -0
  282. package/templates/recipes/ai-context/claude/commands/add-command.md +48 -0
  283. package/templates/recipes/ai-context/claude/commands/add-consumer.md +58 -0
  284. package/templates/recipes/ai-context/claude/commands/add-endpoint.md +69 -0
  285. package/templates/recipes/ai-context/claude/commands/add-job.md +42 -0
  286. package/templates/recipes/ai-context/claude/commands/migrate.md +69 -0
  287. package/templates/recipes/ai-context/copilot/base.md +71 -0
  288. package/templates/recipes/ai-context/cursor/auth.mdc +44 -0
  289. package/templates/recipes/ai-context/cursor/base.mdc +44 -0
  290. package/templates/recipes/ai-context/cursor/prisma.mdc +43 -0
  291. package/templates/recipes/ai-context/cursor/swagger.mdc +48 -0
  292. package/templates/recipes/ai-context/cursor/testing.mdc +58 -0
  293. package/templates/recipes/ai-context/cursor/typeorm.mdc +49 -0
  294. package/templates/recipes/api-keys/README.md +44 -0
  295. package/templates/recipes/api-keys/src/shared/guards/api-key.guard.ts +32 -0
  296. package/templates/recipes/api-keys/tests/unit/shared/guards/api-key.guard.spec.ts +40 -0
  297. package/templates/recipes/api-versioning/README.md +63 -0
  298. package/templates/recipes/audit-trail/README.md +75 -0
  299. package/templates/recipes/audit-trail/src/shared/decorators/auditable.decorator.ts +4 -0
  300. package/templates/recipes/audit-trail/src/shared/interceptors/audit.interceptor.ts +46 -0
  301. package/templates/recipes/audit-trail/tests/unit/shared/interceptors/audit.interceptor.spec.ts +82 -0
  302. package/templates/recipes/auth-flows/README.md +91 -0
  303. package/templates/recipes/auth-flows/src/app/modules/auth/auth.controller.ts +44 -0
  304. package/templates/recipes/auth-flows/src/app/modules/auth/auth.module.ts +11 -0
  305. package/templates/recipes/auth-flows/src/app/modules/auth/auth.service.ts +194 -0
  306. package/templates/recipes/auth-flows/src/app/modules/auth/dto/forgot-password.dto.ts +6 -0
  307. package/templates/recipes/auth-flows/src/app/modules/auth/dto/login.dto.ts +9 -0
  308. package/templates/recipes/auth-flows/src/app/modules/auth/dto/reset-password.dto.ts +11 -0
  309. package/templates/recipes/auth-flows/src/app/modules/auth/dto/signup.dto.ts +16 -0
  310. package/templates/recipes/auth-flows/tests/unit/app/modules/auth/auth.service.spec.ts +13 -0
  311. package/templates/recipes/bullmq/README.md +54 -0
  312. package/templates/recipes/bullmq/src/infrastructure/queue/example.processor.ts +25 -0
  313. package/templates/recipes/bullmq/src/infrastructure/queue/queue.module.ts +26 -0
  314. package/templates/recipes/bullmq/tests/unit/infrastructure/queue/example.processor.spec.ts +17 -0
  315. package/templates/recipes/changelog/.changelogrc.json +18 -0
  316. package/templates/recipes/changelog/README.md +44 -0
  317. package/templates/recipes/ci-cd/README.md +14 -0
  318. package/templates/recipes/ci-cd/aws-codepipeline/README.md +30 -0
  319. package/templates/recipes/ci-cd/aws-codepipeline/buildspec.yml +41 -0
  320. package/templates/recipes/ci-cd/azure-devops/README.md +32 -0
  321. package/templates/recipes/ci-cd/azure-devops/azure-pipelines.yml +79 -0
  322. package/templates/recipes/ci-cd/gcp-cloudbuild/README.md +64 -0
  323. package/templates/recipes/ci-cd/gcp-cloudbuild/cloudbuild.yaml +53 -0
  324. package/templates/recipes/ci-cd/github-actions/.github/workflows/cd.yml +35 -0
  325. package/templates/recipes/ci-cd/github-actions/.github/workflows/ci.yml +62 -0
  326. package/templates/recipes/ci-cd/github-actions/README.md +29 -0
  327. package/templates/recipes/circuit-breaker/README.md +45 -0
  328. package/templates/recipes/circuit-breaker/src/shared/utils/circuit-breaker.ts +100 -0
  329. package/templates/recipes/circuit-breaker/tests/unit/shared/utils/circuit-breaker.spec.ts +28 -0
  330. package/templates/recipes/cloud-aws/README.md +20 -0
  331. package/templates/recipes/cloud-aws/cloudfront/README.md +50 -0
  332. package/templates/recipes/cloud-aws/cloudfront/src/infrastructure/aws/cloudfront.module.ts +8 -0
  333. package/templates/recipes/cloud-aws/cloudfront/src/infrastructure/aws/cloudfront.service.ts +29 -0
  334. package/templates/recipes/cloud-aws/cloudwatch/README.md +40 -0
  335. package/templates/recipes/cloud-aws/cloudwatch/src/infrastructure/aws/cloudwatch.module.ts +8 -0
  336. package/templates/recipes/cloud-aws/cloudwatch/src/infrastructure/aws/cloudwatch.service.ts +40 -0
  337. package/templates/recipes/cloud-aws/cognito/README.md +39 -0
  338. package/templates/recipes/cloud-aws/cognito/src/infrastructure/aws/cognito.module.ts +8 -0
  339. package/templates/recipes/cloud-aws/cognito/src/infrastructure/aws/cognito.service.ts +47 -0
  340. package/templates/recipes/cloud-aws/dynamodb/README.md +48 -0
  341. package/templates/recipes/cloud-aws/dynamodb/src/infrastructure/aws/dynamodb.module.ts +8 -0
  342. package/templates/recipes/cloud-aws/dynamodb/src/infrastructure/aws/dynamodb.service.ts +49 -0
  343. package/templates/recipes/cloud-aws/elasticache/README.md +45 -0
  344. package/templates/recipes/cloud-aws/elasticache/src/infrastructure/aws/redis.module.ts +8 -0
  345. package/templates/recipes/cloud-aws/elasticache/src/infrastructure/aws/redis.service.ts +47 -0
  346. package/templates/recipes/cloud-aws/eventbridge/README.md +46 -0
  347. package/templates/recipes/cloud-aws/eventbridge/src/infrastructure/aws/eventbridge.module.ts +8 -0
  348. package/templates/recipes/cloud-aws/eventbridge/src/infrastructure/aws/eventbridge.service.ts +48 -0
  349. package/templates/recipes/cloud-aws/rds/README.md +59 -0
  350. package/templates/recipes/cloud-aws/s3/README.md +44 -0
  351. package/templates/recipes/cloud-aws/s3/src/infrastructure/aws/s3.module.ts +8 -0
  352. package/templates/recipes/cloud-aws/s3/src/infrastructure/aws/s3.service.ts +42 -0
  353. package/templates/recipes/cloud-aws/secrets-manager/README.md +38 -0
  354. package/templates/recipes/cloud-aws/secrets-manager/src/infrastructure/aws/secrets.module.ts +8 -0
  355. package/templates/recipes/cloud-aws/secrets-manager/src/infrastructure/aws/secrets.service.ts +39 -0
  356. package/templates/recipes/cloud-aws/sns/README.md +43 -0
  357. package/templates/recipes/cloud-aws/sns/src/infrastructure/aws/sns.module.ts +8 -0
  358. package/templates/recipes/cloud-aws/sns/src/infrastructure/aws/sns.service.ts +48 -0
  359. package/templates/recipes/cloud-aws/sqs/README.md +47 -0
  360. package/templates/recipes/cloud-aws/sqs/src/infrastructure/aws/sqs.module.ts +8 -0
  361. package/templates/recipes/cloud-aws/sqs/src/infrastructure/aws/sqs.service.ts +58 -0
  362. package/templates/recipes/cloud-aws/ssm/README.md +41 -0
  363. package/templates/recipes/cloud-aws/ssm/src/infrastructure/aws/ssm.module.ts +8 -0
  364. package/templates/recipes/cloud-aws/ssm/src/infrastructure/aws/ssm.service.ts +54 -0
  365. package/templates/recipes/cloud-azure/README.md +18 -0
  366. package/templates/recipes/cloud-azure/app-insights/README.md +50 -0
  367. package/templates/recipes/cloud-azure/app-insights/src/infrastructure/azure/app-insights.module.ts +11 -0
  368. package/templates/recipes/cloud-azure/app-insights/src/infrastructure/azure/app-insights.service.ts +38 -0
  369. package/templates/recipes/cloud-azure/blob-storage/README.md +49 -0
  370. package/templates/recipes/cloud-azure/blob-storage/src/infrastructure/azure/blob-storage.module.ts +11 -0
  371. package/templates/recipes/cloud-azure/blob-storage/src/infrastructure/azure/blob-storage.service.ts +64 -0
  372. package/templates/recipes/cloud-azure/cache/README.md +47 -0
  373. package/templates/recipes/cloud-azure/cache/src/infrastructure/azure/redis.module.ts +11 -0
  374. package/templates/recipes/cloud-azure/cache/src/infrastructure/azure/redis.service.ts +41 -0
  375. package/templates/recipes/cloud-azure/cosmos-db/README.md +57 -0
  376. package/templates/recipes/cloud-azure/cosmos-db/src/infrastructure/azure/cosmos-db.module.ts +11 -0
  377. package/templates/recipes/cloud-azure/cosmos-db/src/infrastructure/azure/cosmos-db.service.ts +55 -0
  378. package/templates/recipes/cloud-azure/entra-id/README.md +42 -0
  379. package/templates/recipes/cloud-azure/entra-id/src/infrastructure/azure/entra-id.module.ts +11 -0
  380. package/templates/recipes/cloud-azure/entra-id/src/infrastructure/azure/entra-id.service.ts +55 -0
  381. package/templates/recipes/cloud-azure/front-door/README.md +48 -0
  382. package/templates/recipes/cloud-azure/functions/README.md +48 -0
  383. package/templates/recipes/cloud-azure/key-vault/README.md +42 -0
  384. package/templates/recipes/cloud-azure/key-vault/src/infrastructure/azure/key-vault.module.ts +11 -0
  385. package/templates/recipes/cloud-azure/key-vault/src/infrastructure/azure/key-vault.service.ts +27 -0
  386. package/templates/recipes/cloud-azure/service-bus/README.md +49 -0
  387. package/templates/recipes/cloud-azure/service-bus/src/infrastructure/azure/service-bus.module.ts +11 -0
  388. package/templates/recipes/cloud-azure/service-bus/src/infrastructure/azure/service-bus.service.ts +52 -0
  389. package/templates/recipes/cloud-azure/sql-database/README.md +54 -0
  390. package/templates/recipes/cloud-gcp/README.md +18 -0
  391. package/templates/recipes/cloud-gcp/cloud-cdn/README.md +40 -0
  392. package/templates/recipes/cloud-gcp/cloud-functions/README.md +42 -0
  393. package/templates/recipes/cloud-gcp/cloud-logging/README.md +42 -0
  394. package/templates/recipes/cloud-gcp/cloud-logging/src/infrastructure/gcp/logging.module.ts +10 -0
  395. package/templates/recipes/cloud-gcp/cloud-logging/src/infrastructure/gcp/logging.service.ts +50 -0
  396. package/templates/recipes/cloud-gcp/cloud-sql/README.md +53 -0
  397. package/templates/recipes/cloud-gcp/cloud-storage/README.md +43 -0
  398. package/templates/recipes/cloud-gcp/cloud-storage/src/infrastructure/gcp/storage.module.ts +10 -0
  399. package/templates/recipes/cloud-gcp/cloud-storage/src/infrastructure/gcp/storage.service.ts +51 -0
  400. package/templates/recipes/cloud-gcp/firebase-auth/README.md +38 -0
  401. package/templates/recipes/cloud-gcp/firebase-auth/src/infrastructure/gcp/firebase-auth.module.ts +10 -0
  402. package/templates/recipes/cloud-gcp/firebase-auth/src/infrastructure/gcp/firebase-auth.service.ts +41 -0
  403. package/templates/recipes/cloud-gcp/firestore/README.md +46 -0
  404. package/templates/recipes/cloud-gcp/firestore/src/infrastructure/gcp/firestore.module.ts +10 -0
  405. package/templates/recipes/cloud-gcp/firestore/src/infrastructure/gcp/firestore.service.ts +44 -0
  406. package/templates/recipes/cloud-gcp/memorystore/README.md +44 -0
  407. package/templates/recipes/cloud-gcp/memorystore/src/infrastructure/gcp/redis.module.ts +10 -0
  408. package/templates/recipes/cloud-gcp/memorystore/src/infrastructure/gcp/redis.service.ts +54 -0
  409. package/templates/recipes/cloud-gcp/pubsub/README.md +43 -0
  410. package/templates/recipes/cloud-gcp/pubsub/src/infrastructure/gcp/pubsub.module.ts +10 -0
  411. package/templates/recipes/cloud-gcp/pubsub/src/infrastructure/gcp/pubsub.service.ts +60 -0
  412. package/templates/recipes/cloud-gcp/secret-manager/README.md +40 -0
  413. package/templates/recipes/cloud-gcp/secret-manager/src/infrastructure/gcp/secrets.module.ts +10 -0
  414. package/templates/recipes/cloud-gcp/secret-manager/src/infrastructure/gcp/secrets.service.ts +41 -0
  415. package/templates/recipes/config-validation/README.md +61 -0
  416. package/templates/recipes/config-validation/src/config/env.validation.ts +28 -0
  417. package/templates/recipes/config-validation/tests/unit/config/env.validation.spec.ts +34 -0
  418. package/templates/recipes/content-digest/README.md +28 -0
  419. package/templates/recipes/content-digest/src/shared/guards/content-digest.guard.ts +30 -0
  420. package/templates/recipes/content-digest/src/shared/interceptors/content-digest.interceptor.ts +23 -0
  421. package/templates/recipes/content-digest/tests/unit/shared/guards/content-digest.guard.spec.ts +56 -0
  422. package/templates/recipes/content-digest/tests/unit/shared/interceptors/content-digest.interceptor.spec.ts +54 -0
  423. package/templates/recipes/correlation-id/README.md +44 -0
  424. package/templates/recipes/correlation-id/src/shared/middleware/correlation-id.middleware.ts +29 -0
  425. package/templates/recipes/correlation-id/tests/unit/shared/middleware/correlation-id.spec.ts +5 -0
  426. package/templates/recipes/cors/README.md +45 -0
  427. package/templates/recipes/cqrs/README.md +39 -0
  428. package/templates/recipes/cqrs/src/shared/cqrs/example.command.ts +29 -0
  429. package/templates/recipes/cqrs/tests/unit/shared/cqrs/example.command.spec.ts +38 -0
  430. package/templates/recipes/csrf/README.md +55 -0
  431. package/templates/recipes/data-masking/README.md +85 -0
  432. package/templates/recipes/data-masking/src/shared/decorators/sensitive.decorator.ts +12 -0
  433. package/templates/recipes/data-masking/src/shared/utils/mask.util.ts +26 -0
  434. package/templates/recipes/data-masking/tests/unit/shared/utils/mask.util.spec.ts +21 -0
  435. package/templates/recipes/database-factories/README.md +48 -0
  436. package/templates/recipes/database-factories/tests/factories/base.factory.ts +51 -0
  437. package/templates/recipes/database-seeding/README.md +40 -0
  438. package/templates/recipes/database-seeding/src/infrastructure/database/seed.ts +61 -0
  439. package/templates/recipes/database-seeding/tests/unit/infrastructure/database/seed.spec.ts +37 -0
  440. package/templates/recipes/dead-letter-queue/README.md +79 -0
  441. package/templates/recipes/dead-letter-queue/src/infrastructure/queue/dlq.service.ts +43 -0
  442. package/templates/recipes/dead-letter-queue/tests/unit/infrastructure/queue/dlq.service.spec.ts +46 -0
  443. package/templates/recipes/dependabot-renovate/.github/dependabot.yml +52 -0
  444. package/templates/recipes/dependabot-renovate/README.md +37 -0
  445. package/templates/recipes/dependabot-renovate/renovate.json +46 -0
  446. package/templates/recipes/deploy/README.md +13 -0
  447. package/templates/recipes/deploy/docker-compose/README.md +38 -0
  448. package/templates/recipes/deploy/docker-compose/docker-compose.yml +43 -0
  449. package/templates/recipes/deploy/dockerfile/Dockerfile +30 -0
  450. package/templates/recipes/deploy/dockerfile/README.md +30 -0
  451. package/templates/recipes/deploy/dockerfile/dot-dockerignore +9 -0
  452. package/templates/recipes/deploy/kubernetes/README.md +43 -0
  453. package/templates/recipes/deploy/kubernetes/k8s/configmap.yaml +7 -0
  454. package/templates/recipes/deploy/kubernetes/k8s/deployment.yaml +45 -0
  455. package/templates/recipes/deploy/kubernetes/k8s/hpa.yaml +18 -0
  456. package/templates/recipes/deploy/kubernetes/k8s/ingress.yaml +23 -0
  457. package/templates/recipes/deploy/kubernetes/k8s/service.yaml +12 -0
  458. package/templates/recipes/deploy/serverless-framework/README.md +39 -0
  459. package/templates/recipes/deploy/serverless-framework/serverless.yml.ejs +22 -0
  460. package/templates/recipes/deploy/terraform/README.md +99 -0
  461. package/templates/recipes/deploy/terraform/main.tf.ejs +13 -0
  462. package/templates/recipes/deploy/terraform/modules/app/alb.tf +34 -0
  463. package/templates/recipes/deploy/terraform/modules/app/iam.tf +30 -0
  464. package/templates/recipes/deploy/terraform/modules/app/main.tf +80 -0
  465. package/templates/recipes/deploy/terraform/modules/app/outputs.tf +11 -0
  466. package/templates/recipes/deploy/terraform/modules/app/security.tf +37 -0
  467. package/templates/recipes/deploy/terraform/modules/app/variables.tf +42 -0
  468. package/templates/recipes/deploy/terraform/outputs.tf +4 -0
  469. package/templates/recipes/deploy/terraform/variables.tf +11 -0
  470. package/templates/recipes/devcontainer/.devcontainer/Dockerfile +5 -0
  471. package/templates/recipes/devcontainer/.devcontainer/devcontainer.json +32 -0
  472. package/templates/recipes/devcontainer/.devcontainer/docker-compose.yml +62 -0
  473. package/templates/recipes/devcontainer/README.md +31 -0
  474. package/templates/recipes/distributed-tracing/README.md +45 -0
  475. package/templates/recipes/distributed-tracing/src/shared/middleware/trace-propagation.middleware.ts +68 -0
  476. package/templates/recipes/distributed-tracing/tests/unit/shared/middleware/trace-propagation.middleware.spec.ts +76 -0
  477. package/templates/recipes/docker-compose-dev/Dockerfile.dev +14 -0
  478. package/templates/recipes/docker-compose-dev/README.md +57 -0
  479. package/templates/recipes/docker-compose-dev/docker-compose.dev.yml.ejs +54 -0
  480. package/templates/recipes/docs-site/README.md +41 -0
  481. package/templates/recipes/docs-site/docs/.vitepress/config.ts.ejs +53 -0
  482. package/templates/recipes/dpop/README.md +37 -0
  483. package/templates/recipes/dpop/src/shared/guards/dpop.guard.ts +61 -0
  484. package/templates/recipes/dpop/tests/unit/shared/guards/dpop.guard.spec.ts +69 -0
  485. package/templates/recipes/drizzle-postgres/README.md +68 -0
  486. package/templates/recipes/drizzle-postgres/drizzle.config.ts +10 -0
  487. package/templates/recipes/drizzle-postgres/src/infrastructure/database/drizzle.module.ts +25 -0
  488. package/templates/recipes/drizzle-postgres/src/infrastructure/database/schema/example.ts +9 -0
  489. package/templates/recipes/drizzle-postgres/src/infrastructure/database/schema/index.ts +3 -0
  490. package/templates/recipes/drizzle-postgres/tests/unit/infrastructure/database/drizzle.module.spec.ts +35 -0
  491. package/templates/recipes/env-per-environment/.env.development +17 -0
  492. package/templates/recipes/env-per-environment/.env.production +20 -0
  493. package/templates/recipes/env-per-environment/.env.test +17 -0
  494. package/templates/recipes/env-per-environment/README.md +40 -0
  495. package/templates/recipes/feature-flags/README.md +45 -0
  496. package/templates/recipes/feature-flags/src/shared/services/feature-flag.service.ts +48 -0
  497. package/templates/recipes/feature-flags/tests/unit/shared/services/feature-flag.service.spec.ts +36 -0
  498. package/templates/recipes/file-upload/README.md +104 -0
  499. package/templates/recipes/file-upload/src/shared/interceptors/file-upload.interceptor.ts +33 -0
  500. package/templates/recipes/file-upload/src/shared/pipes/file-validation.pipe.ts +45 -0
  501. package/templates/recipes/file-upload/tests/unit/shared/pipes/file-validation.pipe.spec.ts +56 -0
  502. package/templates/recipes/filtering/README.md +43 -0
  503. package/templates/recipes/filtering/src/shared/dto/filter.dto.ts +49 -0
  504. package/templates/recipes/filtering/tests/unit/shared/dto/filter.dto.spec.ts +38 -0
  505. package/templates/recipes/graceful-shutdown/README.md +60 -0
  506. package/templates/recipes/graceful-shutdown/src/shared/lifecycle/shutdown.service.ts +52 -0
  507. package/templates/recipes/graceful-shutdown/tests/unit/shared/lifecycle/shutdown.service.spec.ts +52 -0
  508. package/templates/recipes/graphql-mercurius/README.md +37 -0
  509. package/templates/recipes/graphql-mercurius/src/infrastructure/graphql/graphql.module.ts +18 -0
  510. package/templates/recipes/graphql-mercurius/tests/unit/infrastructure/graphql/graphql.module.spec.ts +12 -0
  511. package/templates/recipes/health-checks/README.md +35 -0
  512. package/templates/recipes/health-checks/src/shared/health/health.controller.ts +26 -0
  513. package/templates/recipes/health-checks/src/shared/health/health.module.ts +9 -0
  514. package/templates/recipes/health-checks/tests/unit/shared/health/health.controller.spec.ts +8 -0
  515. package/templates/recipes/helmet/README.md +43 -0
  516. package/templates/recipes/http-caching/README.md +63 -0
  517. package/templates/recipes/http-caching/src/shared/decorators/cache-control.decorator.ts +18 -0
  518. package/templates/recipes/http-caching/src/shared/interceptors/cache-control.interceptor.ts +43 -0
  519. package/templates/recipes/http-caching/tests/unit/shared/interceptors/cache-control.interceptor.spec.ts +44 -0
  520. package/templates/recipes/i18n/README.md +45 -0
  521. package/templates/recipes/i18n/src/i18n/en/common.json +7 -0
  522. package/templates/recipes/i18n/src/i18n/nl/common.json +7 -0
  523. package/templates/recipes/i18n/src/shared/i18n/i18n.module.ts +17 -0
  524. package/templates/recipes/i18n/tests/unit/shared/i18n/i18n.module.spec.ts +18 -0
  525. package/templates/recipes/idempotency/README.md +63 -0
  526. package/templates/recipes/idempotency/src/shared/decorators/idempotent.decorator.ts +4 -0
  527. package/templates/recipes/idempotency/src/shared/middleware/idempotency.middleware.ts +63 -0
  528. package/templates/recipes/idempotency/tests/unit/shared/middleware/idempotency.middleware.spec.ts +56 -0
  529. package/templates/recipes/json-merge-patch/README.md +53 -0
  530. package/templates/recipes/json-merge-patch/src/shared/pipes/merge-patch.pipe.ts +11 -0
  531. package/templates/recipes/json-merge-patch/tests/unit/shared/pipes/merge-patch.pipe.spec.ts +30 -0
  532. package/templates/recipes/json-patch/README.md +54 -0
  533. package/templates/recipes/json-patch/src/shared/pipes/json-patch.pipe.ts +39 -0
  534. package/templates/recipes/json-patch/tests/unit/shared/pipes/json-patch.pipe.spec.ts +37 -0
  535. package/templates/recipes/jwt-auth/README.md +56 -0
  536. package/templates/recipes/jwt-auth/src/shared/decorators/current-user.decorator.ts +10 -0
  537. package/templates/recipes/jwt-auth/src/shared/decorators/public.decorator.ts +4 -0
  538. package/templates/recipes/jwt-auth/src/shared/guards/jwt-auth.guard.ts +24 -0
  539. package/templates/recipes/jwt-auth/tests/unit/shared/guards/jwt-auth.guard.spec.ts +9 -0
  540. package/templates/recipes/kysely/README.md +53 -0
  541. package/templates/recipes/kysely/src/infrastructure/database/database.module.ts +28 -0
  542. package/templates/recipes/kysely/src/infrastructure/database/types.ts +17 -0
  543. package/templates/recipes/kysely/tests/unit/infrastructure/database/database.module.spec.ts +35 -0
  544. package/templates/recipes/license/LICENSE.agpl3 +59 -0
  545. package/templates/recipes/license/LICENSE.apache +189 -0
  546. package/templates/recipes/license/LICENSE.bsd3 +28 -0
  547. package/templates/recipes/license/LICENSE.gpl3 +22 -0
  548. package/templates/recipes/license/LICENSE.isc +15 -0
  549. package/templates/recipes/license/LICENSE.mit +21 -0
  550. package/templates/recipes/license/LICENSE.mpl2 +24 -0
  551. package/templates/recipes/license/LICENSE.proprietary +76 -0
  552. package/templates/recipes/license/LICENSE.unlicensed +13 -0
  553. package/templates/recipes/license/README.md +53 -0
  554. package/templates/recipes/load-testing/README.md +77 -0
  555. package/templates/recipes/load-testing/k6/smoke.js +20 -0
  556. package/templates/recipes/load-testing/k6/stress.js +22 -0
  557. package/templates/recipes/mfa-totp/README.md +77 -0
  558. package/templates/recipes/mfa-totp/src/shared/auth/totp.service.ts +26 -0
  559. package/templates/recipes/mfa-totp/tests/unit/shared/auth/totp.service.spec.ts +65 -0
  560. package/templates/recipes/mikro-orm/README.md +22 -0
  561. package/templates/recipes/mikro-orm/src/infrastructure/database/database.module.ts +8 -0
  562. package/templates/recipes/mikro-orm/src/infrastructure/database/entities/.gitkeep +0 -0
  563. package/templates/recipes/mikro-orm/src/infrastructure/database/migrations/.gitkeep +0 -0
  564. package/templates/recipes/mikro-orm/src/infrastructure/database/mikro-orm.config.ts +20 -0
  565. package/templates/recipes/mikro-orm/tests/unit/infrastructure/database/mikro-orm.config.spec.ts +53 -0
  566. package/templates/recipes/mongoose/README.md +42 -0
  567. package/templates/recipes/mongoose/src/infrastructure/database/database.module.ts.ejs +17 -0
  568. package/templates/recipes/mongoose/tests/unit/infrastructure/database/database.module.spec.ts +25 -0
  569. package/templates/recipes/multi-tenancy/README.md +49 -0
  570. package/templates/recipes/multi-tenancy/src/shared/decorators/tenant.decorator.ts +14 -0
  571. package/templates/recipes/multi-tenancy/src/shared/middleware/tenant.middleware.ts +49 -0
  572. package/templates/recipes/multi-tenancy/tests/unit/shared/middleware/tenant.middleware.spec.ts +29 -0
  573. package/templates/recipes/nodemailer/README.md +55 -0
  574. package/templates/recipes/nodemailer/src/infrastructure/notifications/mail.module.ts +37 -0
  575. package/templates/recipes/nodemailer/tests/unit/infrastructure/notifications/mail.module.spec.ts +33 -0
  576. package/templates/recipes/oauth-apple/README.md +68 -0
  577. package/templates/recipes/oauth-apple/src/shared/auth/apple-auth.guard.ts +5 -0
  578. package/templates/recipes/oauth-apple/src/shared/auth/apple.strategy.ts +33 -0
  579. package/templates/recipes/oauth-apple/tests/unit/shared/auth/apple.strategy.spec.ts +65 -0
  580. package/templates/recipes/oauth-github/README.md +62 -0
  581. package/templates/recipes/oauth-github/src/shared/auth/github-auth.guard.ts +5 -0
  582. package/templates/recipes/oauth-github/src/shared/auth/github.strategy.ts +33 -0
  583. package/templates/recipes/oauth-github/tests/unit/shared/auth/github.strategy.spec.ts +72 -0
  584. package/templates/recipes/oauth-google/README.md +64 -0
  585. package/templates/recipes/oauth-google/src/shared/auth/google-auth.guard.ts +5 -0
  586. package/templates/recipes/oauth-google/src/shared/auth/google.strategy.ts +33 -0
  587. package/templates/recipes/oauth-google/tests/unit/shared/auth/google.strategy.spec.ts +72 -0
  588. package/templates/recipes/oauth2-introspection/README.md +62 -0
  589. package/templates/recipes/oauth2-introspection/src/shared/guards/token-introspection.guard.ts +77 -0
  590. package/templates/recipes/oauth2-introspection/tests/unit/shared/guards/token-introspection.guard.spec.ts +99 -0
  591. package/templates/recipes/opentelemetry/README.md +44 -0
  592. package/templates/recipes/opentelemetry/src/infrastructure/telemetry/tracing.ts +38 -0
  593. package/templates/recipes/opentelemetry/tests/unit/infrastructure/telemetry/tracing.spec.ts +23 -0
  594. package/templates/recipes/pagination/README.md +71 -0
  595. package/templates/recipes/pagination/src/shared/decorators/paginate.decorator.ts +25 -0
  596. package/templates/recipes/pagination/src/shared/dto/pagination.dto.ts +64 -0
  597. package/templates/recipes/pagination/src/shared/interceptors/pagination-link.interceptor.ts +31 -0
  598. package/templates/recipes/pagination/tests/unit/shared/dto/pagination.dto.spec.ts +56 -0
  599. package/templates/recipes/passport/README.md +41 -0
  600. package/templates/recipes/passport/src/shared/guards/local-auth.guard.ts +5 -0
  601. package/templates/recipes/passport/tests/unit/shared/guards/local-auth.guard.spec.ts +17 -0
  602. package/templates/recipes/pino/README.md +48 -0
  603. package/templates/recipes/pino/src/infrastructure/logging/logger.module.ts +39 -0
  604. package/templates/recipes/pino/tests/unit/infrastructure/logging/logger.module.spec.ts +6 -0
  605. package/templates/recipes/prefer-header/README.md +92 -0
  606. package/templates/recipes/prefer-header/src/shared/interceptors/prefer.interceptor.ts +60 -0
  607. package/templates/recipes/prefer-header/tests/unit/shared/interceptors/prefer.interceptor.spec.ts +44 -0
  608. package/templates/recipes/prisma/README.md +52 -0
  609. package/templates/recipes/prisma/prisma/schema.prisma.ejs +8 -0
  610. package/templates/recipes/prisma/src/infrastructure/database/prisma.service.ts +27 -0
  611. package/templates/recipes/prisma/tests/unit/infrastructure/database/prisma.service.spec.ts +21 -0
  612. package/templates/recipes/prometheus/README.md +54 -0
  613. package/templates/recipes/prometheus/src/infrastructure/metrics/metrics.controller.ts +15 -0
  614. package/templates/recipes/prometheus/src/infrastructure/metrics/metrics.module.ts +29 -0
  615. package/templates/recipes/prometheus/tests/unit/infrastructure/metrics/metrics.controller.spec.ts +22 -0
  616. package/templates/recipes/rabbitmq/README.md +53 -0
  617. package/templates/recipes/rabbitmq/src/infrastructure/queue/queue.module.ts.ejs +27 -0
  618. package/templates/recipes/rbac-casl/README.md +69 -0
  619. package/templates/recipes/rbac-casl/src/shared/auth/casl-ability.factory.ts +43 -0
  620. package/templates/recipes/rbac-casl/src/shared/decorators/roles.decorator.ts +5 -0
  621. package/templates/recipes/rbac-casl/src/shared/guards/policies.guard.ts +32 -0
  622. package/templates/recipes/rbac-casl/src/shared/guards/roles.guard.ts +21 -0
  623. package/templates/recipes/rbac-casl/tests/unit/shared/auth/casl-ability.factory.spec.ts +6 -0
  624. package/templates/recipes/redis-cache/README.md +55 -0
  625. package/templates/recipes/redis-cache/src/infrastructure/cache/cache.module.ts +26 -0
  626. package/templates/recipes/redis-cache/tests/unit/infrastructure/cache/cache.module.spec.ts +12 -0
  627. package/templates/recipes/request-context/README.md +57 -0
  628. package/templates/recipes/request-context/src/shared/context/request-context.module.ts +19 -0
  629. package/templates/recipes/request-context/tests/unit/shared/context/request-context.module.spec.ts +20 -0
  630. package/templates/recipes/request-logging/README.md +36 -0
  631. package/templates/recipes/request-logging/src/shared/middleware/request-logging.middleware.ts +40 -0
  632. package/templates/recipes/request-logging/tests/unit/shared/middleware/request-logging.middleware.spec.ts +64 -0
  633. package/templates/recipes/s3-minio/README.md +52 -0
  634. package/templates/recipes/s3-minio/src/infrastructure/storage/storage.module.ts +10 -0
  635. package/templates/recipes/s3-minio/src/infrastructure/storage/storage.service.ts +72 -0
  636. package/templates/recipes/s3-minio/tests/unit/infrastructure/storage/storage.service.spec.ts +23 -0
  637. package/templates/recipes/sdk-generation/README.md +40 -0
  638. package/templates/recipes/sdk-generation/openapitools.json +21 -0
  639. package/templates/recipes/sendgrid/README.md +45 -0
  640. package/templates/recipes/sendgrid/src/infrastructure/notifications/sendgrid.service.ts +60 -0
  641. package/templates/recipes/sendgrid/tests/unit/infrastructure/notifications/sendgrid.service.spec.ts +59 -0
  642. package/templates/recipes/sentry/README.md +49 -0
  643. package/templates/recipes/sentry/src/infrastructure/sentry/sentry.filter.ts +34 -0
  644. package/templates/recipes/sentry/src/infrastructure/sentry/sentry.module.ts +23 -0
  645. package/templates/recipes/sentry/tests/unit/infrastructure/sentry/sentry.filter.spec.ts +50 -0
  646. package/templates/recipes/seq2/README.md +41 -0
  647. package/templates/recipes/seq2/src/infrastructure/logging/seq.transport.ts +57 -0
  648. package/templates/recipes/seq2/tests/unit/infrastructure/logging/seq.transport.spec.ts +53 -0
  649. package/templates/recipes/serialization-groups/README.md +105 -0
  650. package/templates/recipes/serialization-groups/src/shared/interceptors/serialize.interceptor.ts +29 -0
  651. package/templates/recipes/serialization-groups/tests/unit/shared/interceptors/serialize.interceptor.spec.ts +48 -0
  652. package/templates/recipes/soft-delete/README.md +71 -0
  653. package/templates/recipes/soft-delete/src/shared/decorators/with-deleted.decorator.ts +4 -0
  654. package/templates/recipes/soft-delete/src/shared/entities/soft-deletable.entity.ts +20 -0
  655. package/templates/recipes/soft-delete/tests/unit/shared/entities/soft-deletable.entity.spec.ts +35 -0
  656. package/templates/recipes/sse/README.md +43 -0
  657. package/templates/recipes/sse/src/shared/gateways/events.sse.controller.ts +21 -0
  658. package/templates/recipes/sse/tests/unit/shared/gateways/events.sse.controller.spec.ts +32 -0
  659. package/templates/recipes/swagger/README.md +42 -0
  660. package/templates/recipes/swagger/src/main.swagger.ts.ejs +20 -0
  661. package/templates/recipes/swagger/tests/unit/main.swagger.spec.ts +5 -0
  662. package/templates/recipes/throttler/README.md +49 -0
  663. package/templates/recipes/throttler/src/shared/guards/throttle.config.ts +33 -0
  664. package/templates/recipes/throttler/tests/unit/shared/guards/throttle.spec.ts +5 -0
  665. package/templates/recipes/transactional-outbox/README.md +98 -0
  666. package/templates/recipes/transactional-outbox/src/infrastructure/outbox/outbox.entity.ts +30 -0
  667. package/templates/recipes/transactional-outbox/src/infrastructure/outbox/outbox.service.ts +21 -0
  668. package/templates/recipes/transactional-outbox/tests/unit/infrastructure/outbox/outbox.service.spec.ts +38 -0
  669. package/templates/recipes/typeorm-mysql/README.md +48 -0
  670. package/templates/recipes/typeorm-mysql/src/infrastructure/database/database.module.ts.ejs +24 -0
  671. package/templates/recipes/typeorm-postgres/README.md +101 -0
  672. package/templates/recipes/typeorm-postgres/src/infrastructure/database/data-source.ts.ejs +14 -0
  673. package/templates/recipes/typeorm-postgres/src/infrastructure/database/database.module.ts.ejs +24 -0
  674. package/templates/recipes/typeorm-postgres/src/infrastructure/database/entities/.gitkeep +0 -0
  675. package/templates/recipes/typeorm-postgres/src/infrastructure/database/entities/index.ts +7 -0
  676. package/templates/recipes/typeorm-postgres/src/infrastructure/database/migrations/.gitkeep +0 -0
  677. package/templates/recipes/typeorm-postgres/src/infrastructure/database/migrations/index.ts +10 -0
  678. package/templates/recipes/typeorm-postgres/tests/unit/infrastructure/database/database.module.spec.ts +11 -0
  679. package/templates/recipes/webhooks/README.md +76 -0
  680. package/templates/recipes/webhooks/src/infrastructure/webhooks/webhook.service.ts +53 -0
  681. package/templates/recipes/webhooks/tests/unit/infrastructure/webhooks/webhook.service.spec.ts +31 -0
  682. package/templates/recipes/websockets/README.md +44 -0
  683. package/templates/recipes/websockets/src/shared/gateways/events.gateway.ts +55 -0
  684. package/templates/recipes/websockets/tests/unit/shared/gateways/events.gateway.spec.ts +23 -0
  685. package/templates/recipes/winston/README.md +45 -0
  686. package/templates/recipes/winston/src/infrastructure/logging/logger.module.ts +34 -0
  687. package/templates/recipes/winston/tests/unit/infrastructure/logging/logger.module.spec.ts +12 -0
  688. package/templates/recipes/worker-threads/README.md +71 -0
  689. package/templates/recipes/worker-threads/src/shared/utils/worker-pool.ts +59 -0
  690. package/templates/recipes/worker-threads/tests/unit/shared/utils/worker-pool.spec.ts +36 -0
@@ -0,0 +1,22 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+ Preamble
9
+
10
+ The GNU General Public License is a free, copyleft license for
11
+ software and other kinds of works.
12
+
13
+ The licenses for most software and other practical works are designed
14
+ to take away your freedom to share and change the works. By contrast,
15
+ the GNU General Public License is intended to guarantee your freedom to
16
+ share and change all versions of a program--to make sure it remains free
17
+ software for all its users. We, the Free Software Foundation, use the
18
+ GNU General Public License for most of our software; it applies also to
19
+ any other work released this way by its authors. You can apply it to
20
+ your programs, too.
21
+
22
+ For the full license text, see: https://www.gnu.org/licenses/gpl-3.0.txt
@@ -0,0 +1,15 @@
1
+ ISC License
2
+
3
+ Copyright (c) [year] [fullname]
4
+
5
+ Permission to use, copy, modify, and/or distribute this software for any
6
+ purpose with or without fee is hereby granted, provided that the above
7
+ copyright notice and this permission notice appear in all copies.
8
+
9
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10
+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11
+ AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12
+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13
+ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
14
+ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15
+ PERFORMANCE OF THIS SOFTWARE.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) [year] [fullname]
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,24 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ For the full license text, see: https://www.mozilla.org/en-US/MPL/2.0/
@@ -0,0 +1,76 @@
1
+ BBJ Systems Holding Proprietary License
2
+ Version 1.0
3
+
4
+ Copyright (c) [year] BBJ Systems Holding. All rights reserved.
5
+
6
+ 1. DEFINITIONS
7
+
8
+ "Software" means the source code, object code, documentation, and any
9
+ associated materials provided under this license.
10
+
11
+ "Licensee" means the individual or entity that has been granted a license
12
+ to use the Software by BBJ Systems Holding.
13
+
14
+ "Authorized Purpose" means internal business use by the Licensee, including
15
+ development, testing, and deployment of applications built using the Software.
16
+
17
+ 2. GRANT OF LICENSE
18
+
19
+ Subject to the terms of this license, BBJ Systems Holding grants the Licensee a
20
+ non-exclusive, non-transferable, revocable license to use the Software solely
21
+ for the Authorized Purpose.
22
+
23
+ 3. RESTRICTIONS
24
+
25
+ The Licensee SHALL NOT:
26
+
27
+ a) Redistribute, sublicense, sell, lease, or otherwise transfer the Software
28
+ or any portion thereof to any third party.
29
+
30
+ b) Modify, adapt, translate, reverse engineer, decompile, or disassemble the
31
+ Software, except to the extent expressly permitted by applicable law.
32
+
33
+ c) Remove, alter, or obscure any proprietary notices, labels, or marks on
34
+ the Software.
35
+
36
+ d) Use the Software to create a competing product or service.
37
+
38
+ e) Use the Software in any manner that violates applicable laws or regulations.
39
+
40
+ 4. INTELLECTUAL PROPERTY
41
+
42
+ The Software and all copies thereof are proprietary to BBJ Systems Holding and
43
+ title thereto remains in BBJ Systems Holding. All applicable rights to patents,
44
+ copyrights, trademarks, and trade secrets in the Software are and shall
45
+ remain in BBJ Systems Holding.
46
+
47
+ 5. CONFIDENTIALITY
48
+
49
+ The Licensee agrees to maintain the confidentiality of the Software and not
50
+ to disclose the Software to any third party without the prior written consent
51
+ of BBJ Systems Holding.
52
+
53
+ 6. WARRANTY DISCLAIMER
54
+
55
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
56
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
57
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
58
+ BBJ SYSTEMS HOLDING BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
59
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
60
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
61
+
62
+ 7. TERMINATION
63
+
64
+ This license is effective until terminated. BBJ Systems Holding may terminate
65
+ this license at any time if the Licensee breaches any provision hereof.
66
+ Upon termination, the Licensee must destroy all copies of the Software in
67
+ their possession.
68
+
69
+ 8. GOVERNING LAW
70
+
71
+ This license shall be governed by and construed in accordance with the laws
72
+ of the Netherlands, without regard to its conflict of laws principles.
73
+
74
+ 9. CONTACT
75
+
76
+ For licensing inquiries: licensing@example.com
@@ -0,0 +1,13 @@
1
+ UNLICENSED
2
+
3
+ Copyright (c) [year] [fullname]
4
+
5
+ All rights reserved.
6
+
7
+ This software and associated documentation files (the "Software") may not be
8
+ used, copied, modified, merged, published, distributed, sublicensed, or sold
9
+ without the express written permission of the copyright holder.
10
+
11
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
@@ -0,0 +1,53 @@
1
+ # License Templates
2
+
3
+ License file templates for generated projects. The CLI prompts for license selection during scaffolding.
4
+
5
+ ## Links
6
+
7
+ - [Choose a License](https://choosealicense.com/)
8
+ - [SPDX License List](https://spdx.org/licenses/)
9
+ - [Open Source Initiative](https://opensource.org/licenses)
10
+ - [GNU Licenses](https://www.gnu.org/licenses/)
11
+
12
+ ## Available Licenses
13
+
14
+ | License | File | SPDX ID | Type |
15
+ | -------------------------------- | -------------------- | ----------------------- | ---------------- |
16
+ | MIT | `LICENSE.mit` | `MIT` | Permissive |
17
+ | Apache 2.0 | `LICENSE.apache` | `Apache-2.0` | Permissive |
18
+ | ISC | `LICENSE.isc` | `ISC` | Permissive |
19
+ | BSD 3-Clause | `LICENSE.bsd3` | `BSD-3-Clause` | Permissive |
20
+ | Mozilla Public License 2.0 | `LICENSE.mpl2` | `MPL-2.0` | Weak copyleft |
21
+ | GNU GPL v3 | `LICENSE.gpl3` | `GPL-3.0-only` | Strong copyleft |
22
+ | GNU AGPL v3 | `LICENSE.agpl3` | `AGPL-3.0-only` | Network copyleft |
23
+ | Proprietary | `LICENSE.proprietary` | `LicenseRef-Proprietary` | Proprietary |
24
+ | Unlicensed (All Rights Reserved) | `LICENSE.unlicensed` | `UNLICENSED` | Proprietary |
25
+
26
+ ## Usage
27
+
28
+ The selected license is copied to your project root as `LICENSE`:
29
+
30
+ ```bash
31
+ # Example: MIT
32
+ cp LICENSE.mit LICENSE
33
+ ```
34
+
35
+ Replace `[year]` and `[fullname]` placeholders with your values.
36
+
37
+ ## When to Use Each
38
+
39
+ | Use Case | Recommended License |
40
+ | ------------------------------------------ | ---------------------- |
41
+ | Open source library (max adoption) | MIT or ISC |
42
+ | Open source with patent protection | Apache 2.0 |
43
+ | Open source, file-level copyleft | MPL 2.0 |
44
+ | Open source, full copyleft | GPL v3 |
45
+ | SaaS/network service, force source sharing | AGPL v3 |
46
+ | Internal proprietary projects | Proprietary |
47
+ | Client projects (no open source) | Unlicensed |
48
+
49
+ ## Generated Files
50
+
51
+ | File | Description |
52
+ | --------- | ------------------------- |
53
+ | `LICENSE` | The selected license text |
@@ -0,0 +1,77 @@
1
+ # Load Testing (k6)
2
+
3
+ Performance and load testing with Grafana k6.
4
+
5
+ ## Links
6
+
7
+ - [k6 Documentation](https://grafana.com/docs/k6/)
8
+ - [k6 Installation](https://grafana.com/docs/k6/latest/set-up/install-k6/)
9
+ - [k6 on GitHub](https://github.com/grafana/k6)
10
+
11
+ ## Installation
12
+
13
+ k6 is a standalone Go binary. It is not an npm dependency.
14
+
15
+ ```bash
16
+ # macOS
17
+ brew install k6
18
+
19
+ # Debian / Ubuntu
20
+ sudo gpg -k
21
+ sudo gpg --no-default-keyring --keyring /usr/share/keyrings/k6-archive-keyring.gpg \
22
+ --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys C5AD17C747E3415A3642D57D77C6C491D6AC1D69
23
+ echo "deb [signed-by=/usr/share/keyrings/k6-archive-keyring.gpg] https://dl.k6.io/deb stable main" \
24
+ | sudo tee /etc/apt/sources.list.d/k6.list
25
+ sudo apt-get update && sudo apt-get install k6
26
+
27
+ # Docker
28
+ docker run --rm -i grafana/k6 run - <k6/smoke.js
29
+ ```
30
+
31
+ ## Usage
32
+
33
+ ### Smoke Test
34
+
35
+ Verifies the system works under minimal load (1 virtual user, 10 seconds).
36
+
37
+ ```bash
38
+ k6 run k6/smoke.js
39
+ ```
40
+
41
+ ### Stress Test
42
+
43
+ Ramps load from 50 to 100 virtual users over 9 minutes to find breaking points.
44
+
45
+ ```bash
46
+ k6 run k6/stress.js
47
+ ```
48
+
49
+ ### Spike Test
50
+
51
+ To create a spike test, copy an existing script and configure a sharp ramp:
52
+
53
+ ```javascript
54
+ export const options = {
55
+ stages: [
56
+ { duration: '10s', target: 200 },
57
+ { duration: '1m', target: 200 },
58
+ { duration: '10s', target: 0 },
59
+ ],
60
+ };
61
+ ```
62
+
63
+ ## Thresholds
64
+
65
+ Each test defines thresholds that cause k6 to exit with a non-zero code if they are breached:
66
+
67
+ | Metric | Smoke | Stress |
68
+ | ------------------- | ----------- | ------------ |
69
+ | `http_req_duration` | p95 < 500ms | p95 < 1000ms |
70
+ | `http_req_failed` | < 1% | < 5% |
71
+
72
+ ## Generated Files
73
+
74
+ | File | Description |
75
+ | -------------- | -------------------------------------------- |
76
+ | `k6/smoke.js` | Smoke test — minimal load, strict thresholds |
77
+ | `k6/stress.js` | Stress test — ramp to 100 VUs over 9 minutes |
@@ -0,0 +1,20 @@
1
+ import http from 'k6/http';
2
+ import { check, sleep } from 'k6';
3
+
4
+ export const options = {
5
+ vus: 1,
6
+ duration: '10s',
7
+ thresholds: {
8
+ http_req_duration: ['p(95)<500'],
9
+ http_req_failed: ['rate<0.01'],
10
+ },
11
+ };
12
+
13
+ export default function () {
14
+ const res = http.get('http://localhost:3000/health');
15
+ check(res, {
16
+ 'status is 200': (r) => r.status === 200,
17
+ 'response time < 200ms': (r) => r.timings.duration < 200,
18
+ });
19
+ sleep(1);
20
+ }
@@ -0,0 +1,22 @@
1
+ import http from 'k6/http';
2
+ import { check, sleep } from 'k6';
3
+
4
+ export const options = {
5
+ stages: [
6
+ { duration: '1m', target: 50 },
7
+ { duration: '3m', target: 50 },
8
+ { duration: '1m', target: 100 },
9
+ { duration: '3m', target: 100 },
10
+ { duration: '1m', target: 0 },
11
+ ],
12
+ thresholds: {
13
+ http_req_duration: ['p(95)<1000'],
14
+ http_req_failed: ['rate<0.05'],
15
+ },
16
+ };
17
+
18
+ export default function () {
19
+ const res = http.get('http://localhost:3000/health');
20
+ check(res, { 'status is 200': (r) => r.status === 200 });
21
+ sleep(0.5);
22
+ }
@@ -0,0 +1,77 @@
1
+ # Two-Factor Authentication (TOTP)
2
+
3
+ TOTP-based two-factor authentication with QR code setup and backup codes.
4
+
5
+ ## Links
6
+
7
+ - [otplib on npm](https://www.npmjs.com/package/otplib)
8
+ - [otplib on GitHub](https://github.com/yeojz/otplib)
9
+ - [qrcode on npm](https://www.npmjs.com/package/qrcode)
10
+ - [RFC 6238 — TOTP Algorithm](https://datatracker.ietf.org/doc/html/rfc6238)
11
+ - [RFC 4226 — HOTP Algorithm](https://datatracker.ietf.org/doc/html/rfc4226)
12
+
13
+ ## Dependencies
14
+
15
+ | Package | Version | Purpose |
16
+ | --------------- | -------- | --------------------------------- |
17
+ | `otplib` | `12.0.1` | TOTP/HOTP token generation |
18
+ | `qrcode` | `1.5.4` | QR code generation for OTP URIs |
19
+ | `@types/qrcode` | `1.5.5` | TypeScript definitions for qrcode |
20
+
21
+ ## Usage
22
+
23
+ ### Setup flow
24
+
25
+ ```typescript
26
+ @Controller('auth/2fa')
27
+ export class TwoFactorController {
28
+ constructor(private readonly totpService: TotpService) {}
29
+
30
+ @Post('enable')
31
+ async enable(@CurrentUser() user: User) {
32
+ const secret = this.totpService.generateSecret();
33
+ // Store the secret (encrypted) in the user record
34
+ const qrCode = await this.totpService.generateQrCode(user.email, secret, 'MyApp');
35
+ const backupCodes = this.totpService.generateBackupCodes();
36
+ // Hash and store backup codes
37
+ return { qrCode, backupCodes };
38
+ }
39
+
40
+ @Post('verify')
41
+ async verify(@CurrentUser() user: User, @Body('token') token: string) {
42
+ const isValid = this.totpService.verify(token, user.totpSecret);
43
+ if (!isValid) throw new UnauthorizedException('Invalid 2FA token');
44
+ // Mark 2FA as verified for this session
45
+ return { verified: true };
46
+ }
47
+ }
48
+ ```
49
+
50
+ ### QR code setup
51
+
52
+ 1. Call `generateSecret()` and store the secret (encrypted) with the user
53
+ 2. Call `generateQrCode(email, secret, issuer)` to get a data URI
54
+ 3. Display the QR code to the user for scanning with an authenticator app
55
+ 4. Verify a token from the app with `verify(token, secret)` before activating 2FA
56
+
57
+ ### Backup codes
58
+
59
+ - Generate with `generateBackupCodes()` during 2FA setup
60
+ - Display to the user once and instruct them to store securely
61
+ - Hash each code (e.g., with bcrypt) before persisting to the database
62
+ - Each code is single-use: mark as consumed after successful verification
63
+ - Provide a way to regenerate codes (which invalidates old ones)
64
+
65
+ ### Security considerations
66
+
67
+ - Store TOTP secrets encrypted at rest, not in plain text
68
+ - Hash backup codes before persisting (same as passwords)
69
+ - Rate-limit verification attempts to prevent brute force
70
+ - Consider a time window tolerance (otplib defaults to 1 step = 30 seconds)
71
+ - Require re-authentication before enabling or disabling 2FA
72
+
73
+ ## Generated Files
74
+
75
+ | File | Description |
76
+ | --------------------------------- | -------------------------------------------------------- |
77
+ | `src/shared/auth/totp.service.ts` | TOTP service for secret generation, QR codes, and verify |
@@ -0,0 +1,26 @@
1
+ import { Injectable } from '@nestjs/common';
2
+ import { randomBytes } from 'node:crypto';
3
+ import { authenticator } from 'otplib';
4
+ import * as QRCode from 'qrcode';
5
+
6
+ @Injectable()
7
+ export class TotpService {
8
+ generateSecret(): string {
9
+ return authenticator.generateSecret();
10
+ }
11
+
12
+ async generateQrCode(email: string, secret: string, issuer: string = 'App'): Promise<string> {
13
+ const otpauthUrl = authenticator.keyuri(email, issuer, secret);
14
+ return QRCode.toDataURL(otpauthUrl);
15
+ }
16
+
17
+ verify(token: string, secret: string): boolean {
18
+ return authenticator.verify({ token, secret });
19
+ }
20
+
21
+ generateBackupCodes(count: number = 10): string[] {
22
+ return Array.from({ length: count }, () =>
23
+ randomBytes(4).toString('hex').toUpperCase().slice(0, 6),
24
+ );
25
+ }
26
+ }
@@ -0,0 +1,65 @@
1
+ import { Test } from '@nestjs/testing';
2
+ import { TotpService } from '@/shared/auth/totp.service';
3
+
4
+ describe('TotpService', () => {
5
+ let service: TotpService;
6
+
7
+ beforeEach(async () => {
8
+ const module = await Test.createTestingModule({
9
+ providers: [TotpService],
10
+ }).compile();
11
+
12
+ service = module.get(TotpService);
13
+ });
14
+
15
+ it('should be defined', () => {
16
+ expect(service).toBeDefined();
17
+ });
18
+
19
+ describe('generateSecret', () => {
20
+ it('should return a non-empty base32-encoded string', () => {
21
+ const secret = service.generateSecret();
22
+ expect(secret).toBeDefined();
23
+ expect(secret.length).toBeGreaterThan(0);
24
+ expect(secret).toMatch(/^[A-Z2-7]+=*$/);
25
+ });
26
+
27
+ it('should generate unique secrets on each call', () => {
28
+ const secretA = service.generateSecret();
29
+ const secretB = service.generateSecret();
30
+ expect(secretA).not.toEqual(secretB);
31
+ });
32
+ });
33
+
34
+ describe('verify', () => {
35
+ it('should return false for an incorrect token', () => {
36
+ const secret = service.generateSecret();
37
+ const result = service.verify('000000', secret);
38
+ // While there is a tiny chance this is the current TOTP, it is
39
+ // statistically negligible and acceptable for a unit test.
40
+ expect(typeof result).toBe('boolean');
41
+ });
42
+
43
+ it('should return a boolean result', () => {
44
+ const secret = service.generateSecret();
45
+ const result = service.verify('123456', secret);
46
+ expect(result).toBe(true || false); // boolean guard
47
+ expect([true, false]).toContain(result);
48
+ });
49
+ });
50
+
51
+ describe('generateBackupCodes', () => {
52
+ it('should generate the default count of 10 backup codes', () => {
53
+ const codes = service.generateBackupCodes();
54
+ expect(codes).toHaveLength(10);
55
+ codes.forEach((code) => {
56
+ expect(code).toMatch(/^[A-Z0-9]{6}$/);
57
+ });
58
+ });
59
+
60
+ it('should generate the specified number of backup codes', () => {
61
+ const codes = service.generateBackupCodes(5);
62
+ expect(codes).toHaveLength(5);
63
+ });
64
+ });
65
+ });
@@ -0,0 +1,22 @@
1
+ # MikroORM + PostgreSQL
2
+
3
+ Data Mapper ORM with Unit of Work and Identity Map, ideal for Domain-Driven Design.
4
+
5
+ ## Resources
6
+
7
+ - [NestJS MikroORM recipe](https://docs.nestjs.com/recipes/mikroorm)
8
+ - [MikroORM documentation](https://mikro-orm.io/docs/)
9
+ - [@mikro-orm/core on npm](https://www.npmjs.com/package/@mikro-orm/core)
10
+
11
+ ## Package.json scripts
12
+
13
+ Add the following scripts to your `package.json`:
14
+
15
+ ```json
16
+ {
17
+ "mikro-orm": "mikro-orm",
18
+ "migration:create": "mikro-orm migration:create",
19
+ "migration:up": "mikro-orm migration:up",
20
+ "migration:down": "mikro-orm migration:down"
21
+ }
22
+ ```
@@ -0,0 +1,8 @@
1
+ import { Module } from '@nestjs/common';
2
+ import { MikroOrmModule } from '@mikro-orm/nestjs';
3
+ import config from './mikro-orm.config';
4
+
5
+ @Module({
6
+ imports: [MikroOrmModule.forRoot(config)],
7
+ })
8
+ export class DatabaseModule {}
@@ -0,0 +1,20 @@
1
+ import { Options } from '@mikro-orm/core';
2
+ import { PostgreSqlDriver } from '@mikro-orm/postgresql';
3
+ import { Migrator } from '@mikro-orm/migrations';
4
+
5
+ const config: Options<PostgreSqlDriver> = {
6
+ driver: PostgreSqlDriver,
7
+ host: process.env.DB_HOST ?? 'localhost',
8
+ port: Number(process.env.DB_PORT ?? 5432),
9
+ dbName: process.env.DB_NAME ?? 'app',
10
+ user: process.env.DB_USERNAME ?? 'postgres',
11
+ password: process.env.DB_PASSWORD ?? (() => { throw new Error('DB_PASSWORD environment variable is required'); })(),
12
+ entities: ['./dist/infrastructure/database/entities/*.js'],
13
+ entitiesTs: ['./src/infrastructure/database/entities/*.ts'],
14
+ extensions: [Migrator],
15
+ migrations: {
16
+ path: './src/infrastructure/database/migrations',
17
+ },
18
+ };
19
+
20
+ export default config;
@@ -0,0 +1,53 @@
1
+ describe('MikroORM config', () => {
2
+ const originalEnv = process.env;
3
+
4
+ beforeEach(() => {
5
+ jest.resetModules();
6
+ process.env = { ...originalEnv };
7
+ });
8
+
9
+ afterAll(() => {
10
+ process.env = originalEnv;
11
+ });
12
+
13
+ it('should use default values when environment variables are not set', () => {
14
+ delete process.env.DB_HOST;
15
+ delete process.env.DB_PORT;
16
+ delete process.env.DB_NAME;
17
+ delete process.env.DB_USERNAME;
18
+ delete process.env.DB_PASSWORD;
19
+
20
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
21
+ const config = require('../../../../src/infrastructure/database/mikro-orm.config').default;
22
+
23
+ expect(config.host).toBe('localhost');
24
+ expect(config.port).toBe(5432);
25
+ expect(config.dbName).toBe('app');
26
+ expect(config.user).toBe('postgres');
27
+ expect(config.password).toBe('postgres');
28
+ });
29
+
30
+ it('should pick up custom environment variables', () => {
31
+ process.env.DB_HOST = '10.0.0.1';
32
+ process.env.DB_PORT = '5433';
33
+ process.env.DB_NAME = 'mydb';
34
+ process.env.DB_USERNAME = 'admin';
35
+ process.env.DB_PASSWORD = 's3cret';
36
+
37
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
38
+ const config = require('../../../../src/infrastructure/database/mikro-orm.config').default;
39
+
40
+ expect(config.host).toBe('10.0.0.1');
41
+ expect(config.port).toBe(5433);
42
+ expect(config.dbName).toBe('mydb');
43
+ expect(config.user).toBe('admin');
44
+ expect(config.password).toBe('s3cret');
45
+ });
46
+
47
+ it('should include the Migrator extension', () => {
48
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
49
+ const config = require('../../../../src/infrastructure/database/mikro-orm.config').default;
50
+ expect(config.extensions).toBeDefined();
51
+ expect(config.extensions.length).toBeGreaterThanOrEqual(1);
52
+ });
53
+ });