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.
- package/LICENSE +21 -0
- package/README.md +249 -0
- package/dist/generator/ai-context-assembler.d.ts +4 -0
- package/dist/generator/ai-context-assembler.js +52 -0
- package/dist/generator/ai-context-assembler.js.map +1 -0
- package/dist/generator/env-merger.d.ts +3 -0
- package/dist/generator/env-merger.js +16 -0
- package/dist/generator/env-merger.js.map +1 -0
- package/dist/generator/generator.d.ts +3 -0
- package/dist/generator/generator.js +253 -0
- package/dist/generator/generator.js.map +1 -0
- package/dist/generator/package-json-merger.d.ts +6 -0
- package/dist/generator/package-json-merger.js +29 -0
- package/dist/generator/package-json-merger.js.map +1 -0
- package/dist/generator/post-generate.d.ts +1 -0
- package/dist/generator/post-generate.js +28 -0
- package/dist/generator/post-generate.js.map +1 -0
- package/dist/generator/template-engine.d.ts +4 -0
- package/dist/generator/template-engine.js +20 -0
- package/dist/generator/template-engine.js.map +1 -0
- package/dist/generators/add-recipe/generator.d.ts +3 -0
- package/dist/generators/add-recipe/generator.js +153 -0
- package/dist/generators/add-recipe/generator.js.map +1 -0
- package/dist/generators/list-recipes/generator.d.ts +3 -0
- package/dist/generators/list-recipes/generator.js +58 -0
- package/dist/generators/list-recipes/generator.js.map +1 -0
- package/dist/generators/migrate-recipe/generator.d.ts +9 -0
- package/dist/generators/migrate-recipe/generator.js +90 -0
- package/dist/generators/migrate-recipe/generator.js.map +1 -0
- package/dist/generators/migrate-recipe/migration-guidance.d.ts +1 -0
- package/dist/generators/migrate-recipe/migration-guidance.js +159 -0
- package/dist/generators/migrate-recipe/migration-guidance.js.map +1 -0
- package/dist/generators/remove-recipe/generator.d.ts +3 -0
- package/dist/generators/remove-recipe/generator.js +176 -0
- package/dist/generators/remove-recipe/generator.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +40 -0
- package/dist/index.js.map +1 -0
- package/dist/prompts/add-ons.d.ts +3 -0
- package/dist/prompts/add-ons.js +29 -0
- package/dist/prompts/add-ons.js.map +1 -0
- package/dist/prompts/ci-cd.d.ts +2 -0
- package/dist/prompts/ci-cd.js +19 -0
- package/dist/prompts/ci-cd.js.map +1 -0
- package/dist/prompts/cloud-provider.d.ts +2 -0
- package/dist/prompts/cloud-provider.js +18 -0
- package/dist/prompts/cloud-provider.js.map +1 -0
- package/dist/prompts/confirmation.d.ts +2 -0
- package/dist/prompts/confirmation.js +29 -0
- package/dist/prompts/confirmation.js.map +1 -0
- package/dist/prompts/deployment.d.ts +2 -0
- package/dist/prompts/deployment.js +20 -0
- package/dist/prompts/deployment.js.map +1 -0
- package/dist/prompts/frontend.d.ts +2 -0
- package/dist/prompts/frontend.js +18 -0
- package/dist/prompts/frontend.js.map +1 -0
- package/dist/prompts/project-name.d.ts +5 -0
- package/dist/prompts/project-name.js +34 -0
- package/dist/prompts/project-name.js.map +1 -0
- package/dist/prompts/project-type.d.ts +2 -0
- package/dist/prompts/project-type.js +22 -0
- package/dist/prompts/project-type.js.map +1 -0
- package/dist/prompts/run-all.d.ts +3 -0
- package/dist/prompts/run-all.js +83 -0
- package/dist/prompts/run-all.js.map +1 -0
- package/dist/prompts/transport.d.ts +2 -0
- package/dist/prompts/transport.js +22 -0
- package/dist/prompts/transport.js.map +1 -0
- package/dist/recipes/definitions.d.ts +2 -0
- package/dist/recipes/definitions.js +3647 -0
- package/dist/recipes/definitions.js.map +1 -0
- package/dist/recipes/recipe.interface.d.ts +8 -0
- package/dist/recipes/recipe.interface.js +2 -0
- package/dist/recipes/recipe.interface.js.map +1 -0
- package/dist/recipes/registry.d.ts +9 -0
- package/dist/recipes/registry.js +23 -0
- package/dist/recipes/registry.js.map +1 -0
- package/dist/types.d.ts +70 -0
- package/dist/types.js +152 -0
- package/dist/types.js.map +1 -0
- package/dist/utils/ai-context-updater.d.ts +6 -0
- package/dist/utils/ai-context-updater.js +50 -0
- package/dist/utils/ai-context-updater.js.map +1 -0
- package/dist/utils/dependency-checker.d.ts +14 -0
- package/dist/utils/dependency-checker.js +27 -0
- package/dist/utils/dependency-checker.js.map +1 -0
- package/dist/utils/env-updater.d.ts +7 -0
- package/dist/utils/env-updater.js +35 -0
- package/dist/utils/env-updater.js.map +1 -0
- package/dist/utils/main-ts-updater.d.ts +37 -0
- package/dist/utils/main-ts-updater.js +144 -0
- package/dist/utils/main-ts-updater.js.map +1 -0
- package/dist/utils/module-updater.d.ts +26 -0
- package/dist/utils/module-updater.js +167 -0
- package/dist/utils/module-updater.js.map +1 -0
- package/dist/utils/recipe-manifest.d.ts +24 -0
- package/dist/utils/recipe-manifest.js +45 -0
- package/dist/utils/recipe-manifest.js.map +1 -0
- package/dist/validation/config-validator.d.ts +13 -0
- package/dist/validation/config-validator.js +50 -0
- package/dist/validation/config-validator.js.map +1 -0
- package/dist/validation/conflict-detector.d.ts +7 -0
- package/dist/validation/conflict-detector.js +37 -0
- package/dist/validation/conflict-detector.js.map +1 -0
- package/generators.json +24 -0
- package/package.json +78 -0
- package/src/generators/add-recipe/schema.json +21 -0
- package/src/generators/list-recipes/schema.json +18 -0
- package/src/generators/migrate-recipe/schema.json +20 -0
- package/src/generators/remove-recipe/schema.json +21 -0
- package/templates/base/.env.example.ejs +3 -0
- package/templates/base/README.md.ejs +20 -0
- package/templates/base/SECURITY.md +36 -0
- package/templates/base/commitlint.config.js +15 -0
- package/templates/base/docs/adr/000-template.md +45 -0
- package/templates/base/docs/adr/001-framework-selection.md +54 -0
- package/templates/base/docs/adr/002-error-handling-strategy.md +36 -0
- package/templates/base/docs/adr/003-database-strategy.md +40 -0
- package/templates/base/docs/adr/004-authentication-architecture.md +44 -0
- package/templates/base/docs/adr/005-deployment-strategy.md +40 -0
- package/templates/base/docs/adr/006-testing-strategy.md +41 -0
- package/templates/base/docs/adr/007-scaffolder-architecture.md +64 -0
- package/templates/base/docs/adr/008-recipe-system.md +47 -0
- package/templates/base/docs/adr/009-standards-compliance.md +54 -0
- package/templates/base/docs/adr/010-ai-context-generation.md +44 -0
- package/templates/base/docs/adr/011-package-versioning.md +44 -0
- package/templates/base/docs/adr/012-monorepo-strategy.md +54 -0
- package/templates/base/docs/adr/013-http-adapter.md +63 -0
- package/templates/base/docs/adr/014-build-toolchain.md +61 -0
- package/templates/base/docs/adr/015-cloud-provider-strategy.md +49 -0
- package/templates/base/docs/adr/016-ci-cd-pipeline-strategy.md +52 -0
- package/templates/base/docs/adr/017-logging-strategy.md +63 -0
- package/templates/base/docs/adr/018-security-architecture.md +61 -0
- package/templates/base/docs/adr/019-project-type-design.md +61 -0
- package/templates/base/docs/adr/020-frontend-framework-support.md +57 -0
- package/templates/base/docs/adr/021-observability-strategy.md +68 -0
- package/templates/base/docs/adr/022-api-design-patterns.md +64 -0
- package/templates/base/docs/adr/023-error-hierarchy.md +54 -0
- package/templates/base/docs/adr/024-request-context-pattern.md +57 -0
- package/templates/base/docs/adr/025-data-patterns.md +58 -0
- package/templates/base/docs/adr/026-migration-strategy.md +57 -0
- package/templates/base/docs/adr/027-dependency-management.md +60 -0
- package/templates/base/docs/adr/028-code-quality-toolchain.md +60 -0
- package/templates/base/docs/adr/029-admin-panel.md +53 -0
- package/templates/base/docs/adr/030-performance-patterns.md +60 -0
- package/templates/base/docs/adr/031-nx-generators-roadmap.md +73 -0
- package/templates/base/docs/runbooks/000-template.md +78 -0
- package/templates/base/docs/sla-slo.md +36 -0
- package/templates/base/dot-editorconfig +12 -0
- package/templates/base/dot-github/ISSUE_TEMPLATE/bug_report.md +33 -0
- package/templates/base/dot-github/ISSUE_TEMPLATE/feature_request.md +21 -0
- package/templates/base/dot-github/pull_request_template.md +32 -0
- package/templates/base/dot-gitignore +28 -0
- package/templates/base/dot-husky/commit-msg +1 -0
- package/templates/base/dot-husky/pre-commit +1 -0
- package/templates/base/dot-husky/pre-push +2 -0
- package/templates/base/dot-npmrc +1 -0
- package/templates/base/dot-nvmrc +1 -0
- package/templates/base/dot-prettierrc +8 -0
- package/templates/base/eslint.config.mjs +35 -0
- package/templates/base/jest.config.ts +56 -0
- package/templates/base/nest-cli.json.ejs +10 -0
- package/templates/base/nx.json +3 -0
- package/templates/base/package.json.ejs +78 -0
- package/templates/base/src/app/modules/.gitkeep +0 -0
- package/templates/base/src/config/.gitkeep +0 -0
- package/templates/base/src/infrastructure/database/entities/.gitkeep +0 -0
- package/templates/base/src/infrastructure/database/migrations/.gitkeep +0 -0
- package/templates/base/src/infrastructure/database/repositories/.gitkeep +0 -0
- package/templates/base/src/infrastructure/http/.gitkeep +0 -0
- package/templates/base/src/infrastructure/notifications/.gitkeep +0 -0
- package/templates/base/src/infrastructure/queue/.gitkeep +0 -0
- package/templates/base/src/infrastructure/storage/.gitkeep +0 -0
- package/templates/base/src/shared/constants/error-codes.constant.ts +30 -0
- package/templates/base/src/shared/constants/http.constant.ts +134 -0
- package/templates/base/src/shared/constants/index.ts +2 -0
- package/templates/base/src/shared/decorators/.gitkeep +0 -0
- package/templates/base/src/shared/decorators/api-paginated-response.decorator.ts +10 -0
- package/templates/base/src/shared/errors/application.error.ts +21 -0
- package/templates/base/src/shared/errors/forbidden.error.ts +7 -0
- package/templates/base/src/shared/errors/index.ts +6 -0
- package/templates/base/src/shared/errors/invalid-request.error.ts +7 -0
- package/templates/base/src/shared/errors/not-found.error.ts +7 -0
- package/templates/base/src/shared/errors/requester.error.ts +7 -0
- package/templates/base/src/shared/errors/validation.error.ts +7 -0
- package/templates/base/src/shared/filters/http-exception.filter.ts +139 -0
- package/templates/base/src/shared/guards/.gitkeep +0 -0
- package/templates/base/src/shared/interceptors/interfaces/.gitkeep +0 -0
- package/templates/base/src/shared/interceptors/response.interceptor.ts +22 -0
- package/templates/base/src/shared/middleware/request-timeout.middleware.ts +32 -0
- package/templates/base/src/shared/pipes/parse-uuid.pipe.ts +13 -0
- package/templates/base/src/shared/utils/index.ts +2 -0
- package/templates/base/src/shared/utils/retry.util.ts +32 -0
- package/templates/base/src/shared/utils/sleep.util.ts +3 -0
- package/templates/base/tests/e2e/app.e2e-spec.ts.ejs +25 -0
- package/templates/base/tests/factories/.gitkeep +0 -0
- package/templates/base/tests/helpers/.gitkeep +0 -0
- package/templates/base/tests/integration/.gitkeep +0 -0
- package/templates/base/tests/unit/app.module.spec.ts +11 -0
- package/templates/base/tests/unit/shared/errors/error-hierarchy.spec.ts +69 -0
- package/templates/base/tests/unit/shared/filters/http-exception.filter.spec.ts +188 -0
- package/templates/base/tests/unit/shared/interceptors/response.interceptor.spec.ts +54 -0
- package/templates/base/tests/unit/shared/pipes/parse-uuid.pipe.spec.ts +14 -0
- package/templates/base/tsconfig.build.json +4 -0
- package/templates/base/tsconfig.json.ejs +26 -0
- package/templates/project-types/aws-lambda/package-fragment.json +8 -0
- package/templates/project-types/aws-lambda/src/app.module.ts.ejs +9 -0
- package/templates/project-types/aws-lambda/src/main.ts.ejs +32 -0
- package/templates/project-types/aws-lambda/tests/unit/handler.spec.ts +7 -0
- package/templates/project-types/cli-app/package-fragment.json +8 -0
- package/templates/project-types/cli-app/src/app.module.ts.ejs +11 -0
- package/templates/project-types/cli-app/src/commands/hello.command.ts.ejs +8 -0
- package/templates/project-types/cli-app/src/main.ts.ejs +8 -0
- package/templates/project-types/cli-app/tests/unit/commands/hello.command.spec.ts +17 -0
- package/templates/project-types/full-stack/apps/api/src/app.module.ts.ejs +9 -0
- package/templates/project-types/full-stack/apps/api/src/main.ts.ejs +32 -0
- package/templates/project-types/full-stack/frontend/nextjs/.cursor/rules/nextjs.mdc +12 -0
- package/templates/project-types/full-stack/frontend/nextjs/.github/copilot-instructions.md +23 -0
- package/templates/project-types/full-stack/frontend/nextjs/CLAUDE.md +25 -0
- package/templates/project-types/full-stack/frontend/nextjs/next.config.ts +9 -0
- package/templates/project-types/full-stack/frontend/nextjs/package.json +21 -0
- package/templates/project-types/full-stack/frontend/nextjs/src/app/layout.tsx +9 -0
- package/templates/project-types/full-stack/frontend/nextjs/src/app/page.tsx +8 -0
- package/templates/project-types/full-stack/frontend/nextjs/tsconfig.json +21 -0
- package/templates/project-types/full-stack/frontend/nuxt/.cursor/rules/nuxt.mdc +14 -0
- package/templates/project-types/full-stack/frontend/nuxt/.github/copilot-instructions.md +25 -0
- package/templates/project-types/full-stack/frontend/nuxt/CLAUDE.md +25 -0
- package/templates/project-types/full-stack/frontend/nuxt/app.vue +5 -0
- package/templates/project-types/full-stack/frontend/nuxt/nuxt.config.ts +6 -0
- package/templates/project-types/full-stack/frontend/nuxt/package.json +17 -0
- package/templates/project-types/full-stack/frontend/nuxt/pages/index.vue +3 -0
- package/templates/project-types/full-stack/frontend/nuxt/tsconfig.json +1 -0
- package/templates/project-types/full-stack/frontend/sveltekit/.cursor/rules/sveltekit.mdc +13 -0
- package/templates/project-types/full-stack/frontend/sveltekit/.github/copilot-instructions.md +24 -0
- package/templates/project-types/full-stack/frontend/sveltekit/CLAUDE.md +25 -0
- package/templates/project-types/full-stack/frontend/sveltekit/package.json +17 -0
- package/templates/project-types/full-stack/frontend/sveltekit/src/app.html +5 -0
- package/templates/project-types/full-stack/frontend/sveltekit/src/routes/+page.svelte +1 -0
- package/templates/project-types/full-stack/frontend/sveltekit/svelte.config.js +5 -0
- package/templates/project-types/full-stack/frontend/sveltekit/vite.config.ts +9 -0
- package/templates/project-types/full-stack/frontend/vite-react/.cursor/rules/react.mdc +12 -0
- package/templates/project-types/full-stack/frontend/vite-react/.github/copilot-instructions.md +23 -0
- package/templates/project-types/full-stack/frontend/vite-react/CLAUDE.md +24 -0
- package/templates/project-types/full-stack/frontend/vite-react/index.html +5 -0
- package/templates/project-types/full-stack/frontend/vite-react/package.json +22 -0
- package/templates/project-types/full-stack/frontend/vite-react/src/App.tsx +8 -0
- package/templates/project-types/full-stack/frontend/vite-react/src/main.tsx +9 -0
- package/templates/project-types/full-stack/frontend/vite-react/tsconfig.json +21 -0
- package/templates/project-types/full-stack/frontend/vite-react/vite.config.ts +9 -0
- package/templates/project-types/full-stack/libs/shared-types/package.json.ejs +6 -0
- package/templates/project-types/full-stack/libs/shared-types/src/index.ts.ejs +15 -0
- package/templates/project-types/full-stack/nx.json.ejs +20 -0
- package/templates/project-types/full-stack/package-fragment.json +14 -0
- package/templates/project-types/full-stack/pnpm-workspace.yaml +3 -0
- package/templates/project-types/full-stack/tsconfig.json.ejs +27 -0
- package/templates/project-types/http-api/src/app.module.ts.ejs +9 -0
- package/templates/project-types/http-api/src/main.ts.ejs +30 -0
- package/templates/project-types/http-api/tests/e2e/health.e2e-spec.ts +23 -0
- package/templates/project-types/microservice/package-fragment.json +5 -0
- package/templates/project-types/microservice/src/app.module.ts.ejs +9 -0
- package/templates/project-types/microservice/src/main.ts.ejs +15 -0
- package/templates/project-types/microservice/tests/unit/app.module.spec.ts +9 -0
- package/templates/project-types/monorepo/README.md.ejs +33 -0
- package/templates/project-types/monorepo/apps/api/src/app.module.ts.ejs +9 -0
- package/templates/project-types/monorepo/apps/api/src/main.ts.ejs +30 -0
- package/templates/project-types/monorepo/libs/common/package.json.ejs +6 -0
- package/templates/project-types/monorepo/libs/common/src/index.ts.ejs +17 -0
- package/templates/project-types/monorepo/nx.json.ejs +20 -0
- package/templates/project-types/monorepo/package-fragment.json +13 -0
- package/templates/project-types/monorepo/pnpm-workspace.yaml +3 -0
- package/templates/project-types/monorepo/tsconfig.json.ejs +27 -0
- package/templates/project-types/scheduled-worker/package-fragment.json +5 -0
- package/templates/project-types/scheduled-worker/src/app.module.ts.ejs +13 -0
- package/templates/project-types/scheduled-worker/src/jobs/example.job.ts.ejs +12 -0
- package/templates/project-types/scheduled-worker/src/main.ts.ejs +10 -0
- package/templates/project-types/scheduled-worker/tests/unit/jobs/example.job.spec.ts +17 -0
- package/templates/recipes/adminjs/README.md +145 -0
- package/templates/recipes/adminjs/src/app/modules/admin/admin.module.ts +59 -0
- package/templates/recipes/adminjs/tests/unit/app/modules/admin/admin.module.spec.ts +22 -0
- package/templates/recipes/ai-context/README.md +11 -0
- package/templates/recipes/ai-context/claude/base.md +73 -0
- package/templates/recipes/ai-context/claude/commands/add-command.md +48 -0
- package/templates/recipes/ai-context/claude/commands/add-consumer.md +58 -0
- package/templates/recipes/ai-context/claude/commands/add-endpoint.md +69 -0
- package/templates/recipes/ai-context/claude/commands/add-job.md +42 -0
- package/templates/recipes/ai-context/claude/commands/migrate.md +69 -0
- package/templates/recipes/ai-context/copilot/base.md +71 -0
- package/templates/recipes/ai-context/cursor/auth.mdc +44 -0
- package/templates/recipes/ai-context/cursor/base.mdc +44 -0
- package/templates/recipes/ai-context/cursor/prisma.mdc +43 -0
- package/templates/recipes/ai-context/cursor/swagger.mdc +48 -0
- package/templates/recipes/ai-context/cursor/testing.mdc +58 -0
- package/templates/recipes/ai-context/cursor/typeorm.mdc +49 -0
- package/templates/recipes/api-keys/README.md +44 -0
- package/templates/recipes/api-keys/src/shared/guards/api-key.guard.ts +32 -0
- package/templates/recipes/api-keys/tests/unit/shared/guards/api-key.guard.spec.ts +40 -0
- package/templates/recipes/api-versioning/README.md +63 -0
- package/templates/recipes/audit-trail/README.md +75 -0
- package/templates/recipes/audit-trail/src/shared/decorators/auditable.decorator.ts +4 -0
- package/templates/recipes/audit-trail/src/shared/interceptors/audit.interceptor.ts +46 -0
- package/templates/recipes/audit-trail/tests/unit/shared/interceptors/audit.interceptor.spec.ts +82 -0
- package/templates/recipes/auth-flows/README.md +91 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/auth.controller.ts +44 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/auth.module.ts +11 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/auth.service.ts +194 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/dto/forgot-password.dto.ts +6 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/dto/login.dto.ts +9 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/dto/reset-password.dto.ts +11 -0
- package/templates/recipes/auth-flows/src/app/modules/auth/dto/signup.dto.ts +16 -0
- package/templates/recipes/auth-flows/tests/unit/app/modules/auth/auth.service.spec.ts +13 -0
- package/templates/recipes/bullmq/README.md +54 -0
- package/templates/recipes/bullmq/src/infrastructure/queue/example.processor.ts +25 -0
- package/templates/recipes/bullmq/src/infrastructure/queue/queue.module.ts +26 -0
- package/templates/recipes/bullmq/tests/unit/infrastructure/queue/example.processor.spec.ts +17 -0
- package/templates/recipes/changelog/.changelogrc.json +18 -0
- package/templates/recipes/changelog/README.md +44 -0
- package/templates/recipes/ci-cd/README.md +14 -0
- package/templates/recipes/ci-cd/aws-codepipeline/README.md +30 -0
- package/templates/recipes/ci-cd/aws-codepipeline/buildspec.yml +41 -0
- package/templates/recipes/ci-cd/azure-devops/README.md +32 -0
- package/templates/recipes/ci-cd/azure-devops/azure-pipelines.yml +79 -0
- package/templates/recipes/ci-cd/gcp-cloudbuild/README.md +64 -0
- package/templates/recipes/ci-cd/gcp-cloudbuild/cloudbuild.yaml +53 -0
- package/templates/recipes/ci-cd/github-actions/.github/workflows/cd.yml +35 -0
- package/templates/recipes/ci-cd/github-actions/.github/workflows/ci.yml +62 -0
- package/templates/recipes/ci-cd/github-actions/README.md +29 -0
- package/templates/recipes/circuit-breaker/README.md +45 -0
- package/templates/recipes/circuit-breaker/src/shared/utils/circuit-breaker.ts +100 -0
- package/templates/recipes/circuit-breaker/tests/unit/shared/utils/circuit-breaker.spec.ts +28 -0
- package/templates/recipes/cloud-aws/README.md +20 -0
- package/templates/recipes/cloud-aws/cloudfront/README.md +50 -0
- package/templates/recipes/cloud-aws/cloudfront/src/infrastructure/aws/cloudfront.module.ts +8 -0
- package/templates/recipes/cloud-aws/cloudfront/src/infrastructure/aws/cloudfront.service.ts +29 -0
- package/templates/recipes/cloud-aws/cloudwatch/README.md +40 -0
- package/templates/recipes/cloud-aws/cloudwatch/src/infrastructure/aws/cloudwatch.module.ts +8 -0
- package/templates/recipes/cloud-aws/cloudwatch/src/infrastructure/aws/cloudwatch.service.ts +40 -0
- package/templates/recipes/cloud-aws/cognito/README.md +39 -0
- package/templates/recipes/cloud-aws/cognito/src/infrastructure/aws/cognito.module.ts +8 -0
- package/templates/recipes/cloud-aws/cognito/src/infrastructure/aws/cognito.service.ts +47 -0
- package/templates/recipes/cloud-aws/dynamodb/README.md +48 -0
- package/templates/recipes/cloud-aws/dynamodb/src/infrastructure/aws/dynamodb.module.ts +8 -0
- package/templates/recipes/cloud-aws/dynamodb/src/infrastructure/aws/dynamodb.service.ts +49 -0
- package/templates/recipes/cloud-aws/elasticache/README.md +45 -0
- package/templates/recipes/cloud-aws/elasticache/src/infrastructure/aws/redis.module.ts +8 -0
- package/templates/recipes/cloud-aws/elasticache/src/infrastructure/aws/redis.service.ts +47 -0
- package/templates/recipes/cloud-aws/eventbridge/README.md +46 -0
- package/templates/recipes/cloud-aws/eventbridge/src/infrastructure/aws/eventbridge.module.ts +8 -0
- package/templates/recipes/cloud-aws/eventbridge/src/infrastructure/aws/eventbridge.service.ts +48 -0
- package/templates/recipes/cloud-aws/rds/README.md +59 -0
- package/templates/recipes/cloud-aws/s3/README.md +44 -0
- package/templates/recipes/cloud-aws/s3/src/infrastructure/aws/s3.module.ts +8 -0
- package/templates/recipes/cloud-aws/s3/src/infrastructure/aws/s3.service.ts +42 -0
- package/templates/recipes/cloud-aws/secrets-manager/README.md +38 -0
- package/templates/recipes/cloud-aws/secrets-manager/src/infrastructure/aws/secrets.module.ts +8 -0
- package/templates/recipes/cloud-aws/secrets-manager/src/infrastructure/aws/secrets.service.ts +39 -0
- package/templates/recipes/cloud-aws/sns/README.md +43 -0
- package/templates/recipes/cloud-aws/sns/src/infrastructure/aws/sns.module.ts +8 -0
- package/templates/recipes/cloud-aws/sns/src/infrastructure/aws/sns.service.ts +48 -0
- package/templates/recipes/cloud-aws/sqs/README.md +47 -0
- package/templates/recipes/cloud-aws/sqs/src/infrastructure/aws/sqs.module.ts +8 -0
- package/templates/recipes/cloud-aws/sqs/src/infrastructure/aws/sqs.service.ts +58 -0
- package/templates/recipes/cloud-aws/ssm/README.md +41 -0
- package/templates/recipes/cloud-aws/ssm/src/infrastructure/aws/ssm.module.ts +8 -0
- package/templates/recipes/cloud-aws/ssm/src/infrastructure/aws/ssm.service.ts +54 -0
- package/templates/recipes/cloud-azure/README.md +18 -0
- package/templates/recipes/cloud-azure/app-insights/README.md +50 -0
- package/templates/recipes/cloud-azure/app-insights/src/infrastructure/azure/app-insights.module.ts +11 -0
- package/templates/recipes/cloud-azure/app-insights/src/infrastructure/azure/app-insights.service.ts +38 -0
- package/templates/recipes/cloud-azure/blob-storage/README.md +49 -0
- package/templates/recipes/cloud-azure/blob-storage/src/infrastructure/azure/blob-storage.module.ts +11 -0
- package/templates/recipes/cloud-azure/blob-storage/src/infrastructure/azure/blob-storage.service.ts +64 -0
- package/templates/recipes/cloud-azure/cache/README.md +47 -0
- package/templates/recipes/cloud-azure/cache/src/infrastructure/azure/redis.module.ts +11 -0
- package/templates/recipes/cloud-azure/cache/src/infrastructure/azure/redis.service.ts +41 -0
- package/templates/recipes/cloud-azure/cosmos-db/README.md +57 -0
- package/templates/recipes/cloud-azure/cosmos-db/src/infrastructure/azure/cosmos-db.module.ts +11 -0
- package/templates/recipes/cloud-azure/cosmos-db/src/infrastructure/azure/cosmos-db.service.ts +55 -0
- package/templates/recipes/cloud-azure/entra-id/README.md +42 -0
- package/templates/recipes/cloud-azure/entra-id/src/infrastructure/azure/entra-id.module.ts +11 -0
- package/templates/recipes/cloud-azure/entra-id/src/infrastructure/azure/entra-id.service.ts +55 -0
- package/templates/recipes/cloud-azure/front-door/README.md +48 -0
- package/templates/recipes/cloud-azure/functions/README.md +48 -0
- package/templates/recipes/cloud-azure/key-vault/README.md +42 -0
- package/templates/recipes/cloud-azure/key-vault/src/infrastructure/azure/key-vault.module.ts +11 -0
- package/templates/recipes/cloud-azure/key-vault/src/infrastructure/azure/key-vault.service.ts +27 -0
- package/templates/recipes/cloud-azure/service-bus/README.md +49 -0
- package/templates/recipes/cloud-azure/service-bus/src/infrastructure/azure/service-bus.module.ts +11 -0
- package/templates/recipes/cloud-azure/service-bus/src/infrastructure/azure/service-bus.service.ts +52 -0
- package/templates/recipes/cloud-azure/sql-database/README.md +54 -0
- package/templates/recipes/cloud-gcp/README.md +18 -0
- package/templates/recipes/cloud-gcp/cloud-cdn/README.md +40 -0
- package/templates/recipes/cloud-gcp/cloud-functions/README.md +42 -0
- package/templates/recipes/cloud-gcp/cloud-logging/README.md +42 -0
- package/templates/recipes/cloud-gcp/cloud-logging/src/infrastructure/gcp/logging.module.ts +10 -0
- package/templates/recipes/cloud-gcp/cloud-logging/src/infrastructure/gcp/logging.service.ts +50 -0
- package/templates/recipes/cloud-gcp/cloud-sql/README.md +53 -0
- package/templates/recipes/cloud-gcp/cloud-storage/README.md +43 -0
- package/templates/recipes/cloud-gcp/cloud-storage/src/infrastructure/gcp/storage.module.ts +10 -0
- package/templates/recipes/cloud-gcp/cloud-storage/src/infrastructure/gcp/storage.service.ts +51 -0
- package/templates/recipes/cloud-gcp/firebase-auth/README.md +38 -0
- package/templates/recipes/cloud-gcp/firebase-auth/src/infrastructure/gcp/firebase-auth.module.ts +10 -0
- package/templates/recipes/cloud-gcp/firebase-auth/src/infrastructure/gcp/firebase-auth.service.ts +41 -0
- package/templates/recipes/cloud-gcp/firestore/README.md +46 -0
- package/templates/recipes/cloud-gcp/firestore/src/infrastructure/gcp/firestore.module.ts +10 -0
- package/templates/recipes/cloud-gcp/firestore/src/infrastructure/gcp/firestore.service.ts +44 -0
- package/templates/recipes/cloud-gcp/memorystore/README.md +44 -0
- package/templates/recipes/cloud-gcp/memorystore/src/infrastructure/gcp/redis.module.ts +10 -0
- package/templates/recipes/cloud-gcp/memorystore/src/infrastructure/gcp/redis.service.ts +54 -0
- package/templates/recipes/cloud-gcp/pubsub/README.md +43 -0
- package/templates/recipes/cloud-gcp/pubsub/src/infrastructure/gcp/pubsub.module.ts +10 -0
- package/templates/recipes/cloud-gcp/pubsub/src/infrastructure/gcp/pubsub.service.ts +60 -0
- package/templates/recipes/cloud-gcp/secret-manager/README.md +40 -0
- package/templates/recipes/cloud-gcp/secret-manager/src/infrastructure/gcp/secrets.module.ts +10 -0
- package/templates/recipes/cloud-gcp/secret-manager/src/infrastructure/gcp/secrets.service.ts +41 -0
- package/templates/recipes/config-validation/README.md +61 -0
- package/templates/recipes/config-validation/src/config/env.validation.ts +28 -0
- package/templates/recipes/config-validation/tests/unit/config/env.validation.spec.ts +34 -0
- package/templates/recipes/content-digest/README.md +28 -0
- package/templates/recipes/content-digest/src/shared/guards/content-digest.guard.ts +30 -0
- package/templates/recipes/content-digest/src/shared/interceptors/content-digest.interceptor.ts +23 -0
- package/templates/recipes/content-digest/tests/unit/shared/guards/content-digest.guard.spec.ts +56 -0
- package/templates/recipes/content-digest/tests/unit/shared/interceptors/content-digest.interceptor.spec.ts +54 -0
- package/templates/recipes/correlation-id/README.md +44 -0
- package/templates/recipes/correlation-id/src/shared/middleware/correlation-id.middleware.ts +29 -0
- package/templates/recipes/correlation-id/tests/unit/shared/middleware/correlation-id.spec.ts +5 -0
- package/templates/recipes/cors/README.md +45 -0
- package/templates/recipes/cqrs/README.md +39 -0
- package/templates/recipes/cqrs/src/shared/cqrs/example.command.ts +29 -0
- package/templates/recipes/cqrs/tests/unit/shared/cqrs/example.command.spec.ts +38 -0
- package/templates/recipes/csrf/README.md +55 -0
- package/templates/recipes/data-masking/README.md +85 -0
- package/templates/recipes/data-masking/src/shared/decorators/sensitive.decorator.ts +12 -0
- package/templates/recipes/data-masking/src/shared/utils/mask.util.ts +26 -0
- package/templates/recipes/data-masking/tests/unit/shared/utils/mask.util.spec.ts +21 -0
- package/templates/recipes/database-factories/README.md +48 -0
- package/templates/recipes/database-factories/tests/factories/base.factory.ts +51 -0
- package/templates/recipes/database-seeding/README.md +40 -0
- package/templates/recipes/database-seeding/src/infrastructure/database/seed.ts +61 -0
- package/templates/recipes/database-seeding/tests/unit/infrastructure/database/seed.spec.ts +37 -0
- package/templates/recipes/dead-letter-queue/README.md +79 -0
- package/templates/recipes/dead-letter-queue/src/infrastructure/queue/dlq.service.ts +43 -0
- package/templates/recipes/dead-letter-queue/tests/unit/infrastructure/queue/dlq.service.spec.ts +46 -0
- package/templates/recipes/dependabot-renovate/.github/dependabot.yml +52 -0
- package/templates/recipes/dependabot-renovate/README.md +37 -0
- package/templates/recipes/dependabot-renovate/renovate.json +46 -0
- package/templates/recipes/deploy/README.md +13 -0
- package/templates/recipes/deploy/docker-compose/README.md +38 -0
- package/templates/recipes/deploy/docker-compose/docker-compose.yml +43 -0
- package/templates/recipes/deploy/dockerfile/Dockerfile +30 -0
- package/templates/recipes/deploy/dockerfile/README.md +30 -0
- package/templates/recipes/deploy/dockerfile/dot-dockerignore +9 -0
- package/templates/recipes/deploy/kubernetes/README.md +43 -0
- package/templates/recipes/deploy/kubernetes/k8s/configmap.yaml +7 -0
- package/templates/recipes/deploy/kubernetes/k8s/deployment.yaml +45 -0
- package/templates/recipes/deploy/kubernetes/k8s/hpa.yaml +18 -0
- package/templates/recipes/deploy/kubernetes/k8s/ingress.yaml +23 -0
- package/templates/recipes/deploy/kubernetes/k8s/service.yaml +12 -0
- package/templates/recipes/deploy/serverless-framework/README.md +39 -0
- package/templates/recipes/deploy/serverless-framework/serverless.yml.ejs +22 -0
- package/templates/recipes/deploy/terraform/README.md +99 -0
- package/templates/recipes/deploy/terraform/main.tf.ejs +13 -0
- package/templates/recipes/deploy/terraform/modules/app/alb.tf +34 -0
- package/templates/recipes/deploy/terraform/modules/app/iam.tf +30 -0
- package/templates/recipes/deploy/terraform/modules/app/main.tf +80 -0
- package/templates/recipes/deploy/terraform/modules/app/outputs.tf +11 -0
- package/templates/recipes/deploy/terraform/modules/app/security.tf +37 -0
- package/templates/recipes/deploy/terraform/modules/app/variables.tf +42 -0
- package/templates/recipes/deploy/terraform/outputs.tf +4 -0
- package/templates/recipes/deploy/terraform/variables.tf +11 -0
- package/templates/recipes/devcontainer/.devcontainer/Dockerfile +5 -0
- package/templates/recipes/devcontainer/.devcontainer/devcontainer.json +32 -0
- package/templates/recipes/devcontainer/.devcontainer/docker-compose.yml +62 -0
- package/templates/recipes/devcontainer/README.md +31 -0
- package/templates/recipes/distributed-tracing/README.md +45 -0
- package/templates/recipes/distributed-tracing/src/shared/middleware/trace-propagation.middleware.ts +68 -0
- package/templates/recipes/distributed-tracing/tests/unit/shared/middleware/trace-propagation.middleware.spec.ts +76 -0
- package/templates/recipes/docker-compose-dev/Dockerfile.dev +14 -0
- package/templates/recipes/docker-compose-dev/README.md +57 -0
- package/templates/recipes/docker-compose-dev/docker-compose.dev.yml.ejs +54 -0
- package/templates/recipes/docs-site/README.md +41 -0
- package/templates/recipes/docs-site/docs/.vitepress/config.ts.ejs +53 -0
- package/templates/recipes/dpop/README.md +37 -0
- package/templates/recipes/dpop/src/shared/guards/dpop.guard.ts +61 -0
- package/templates/recipes/dpop/tests/unit/shared/guards/dpop.guard.spec.ts +69 -0
- package/templates/recipes/drizzle-postgres/README.md +68 -0
- package/templates/recipes/drizzle-postgres/drizzle.config.ts +10 -0
- package/templates/recipes/drizzle-postgres/src/infrastructure/database/drizzle.module.ts +25 -0
- package/templates/recipes/drizzle-postgres/src/infrastructure/database/schema/example.ts +9 -0
- package/templates/recipes/drizzle-postgres/src/infrastructure/database/schema/index.ts +3 -0
- package/templates/recipes/drizzle-postgres/tests/unit/infrastructure/database/drizzle.module.spec.ts +35 -0
- package/templates/recipes/env-per-environment/.env.development +17 -0
- package/templates/recipes/env-per-environment/.env.production +20 -0
- package/templates/recipes/env-per-environment/.env.test +17 -0
- package/templates/recipes/env-per-environment/README.md +40 -0
- package/templates/recipes/feature-flags/README.md +45 -0
- package/templates/recipes/feature-flags/src/shared/services/feature-flag.service.ts +48 -0
- package/templates/recipes/feature-flags/tests/unit/shared/services/feature-flag.service.spec.ts +36 -0
- package/templates/recipes/file-upload/README.md +104 -0
- package/templates/recipes/file-upload/src/shared/interceptors/file-upload.interceptor.ts +33 -0
- package/templates/recipes/file-upload/src/shared/pipes/file-validation.pipe.ts +45 -0
- package/templates/recipes/file-upload/tests/unit/shared/pipes/file-validation.pipe.spec.ts +56 -0
- package/templates/recipes/filtering/README.md +43 -0
- package/templates/recipes/filtering/src/shared/dto/filter.dto.ts +49 -0
- package/templates/recipes/filtering/tests/unit/shared/dto/filter.dto.spec.ts +38 -0
- package/templates/recipes/graceful-shutdown/README.md +60 -0
- package/templates/recipes/graceful-shutdown/src/shared/lifecycle/shutdown.service.ts +52 -0
- package/templates/recipes/graceful-shutdown/tests/unit/shared/lifecycle/shutdown.service.spec.ts +52 -0
- package/templates/recipes/graphql-mercurius/README.md +37 -0
- package/templates/recipes/graphql-mercurius/src/infrastructure/graphql/graphql.module.ts +18 -0
- package/templates/recipes/graphql-mercurius/tests/unit/infrastructure/graphql/graphql.module.spec.ts +12 -0
- package/templates/recipes/health-checks/README.md +35 -0
- package/templates/recipes/health-checks/src/shared/health/health.controller.ts +26 -0
- package/templates/recipes/health-checks/src/shared/health/health.module.ts +9 -0
- package/templates/recipes/health-checks/tests/unit/shared/health/health.controller.spec.ts +8 -0
- package/templates/recipes/helmet/README.md +43 -0
- package/templates/recipes/http-caching/README.md +63 -0
- package/templates/recipes/http-caching/src/shared/decorators/cache-control.decorator.ts +18 -0
- package/templates/recipes/http-caching/src/shared/interceptors/cache-control.interceptor.ts +43 -0
- package/templates/recipes/http-caching/tests/unit/shared/interceptors/cache-control.interceptor.spec.ts +44 -0
- package/templates/recipes/i18n/README.md +45 -0
- package/templates/recipes/i18n/src/i18n/en/common.json +7 -0
- package/templates/recipes/i18n/src/i18n/nl/common.json +7 -0
- package/templates/recipes/i18n/src/shared/i18n/i18n.module.ts +17 -0
- package/templates/recipes/i18n/tests/unit/shared/i18n/i18n.module.spec.ts +18 -0
- package/templates/recipes/idempotency/README.md +63 -0
- package/templates/recipes/idempotency/src/shared/decorators/idempotent.decorator.ts +4 -0
- package/templates/recipes/idempotency/src/shared/middleware/idempotency.middleware.ts +63 -0
- package/templates/recipes/idempotency/tests/unit/shared/middleware/idempotency.middleware.spec.ts +56 -0
- package/templates/recipes/json-merge-patch/README.md +53 -0
- package/templates/recipes/json-merge-patch/src/shared/pipes/merge-patch.pipe.ts +11 -0
- package/templates/recipes/json-merge-patch/tests/unit/shared/pipes/merge-patch.pipe.spec.ts +30 -0
- package/templates/recipes/json-patch/README.md +54 -0
- package/templates/recipes/json-patch/src/shared/pipes/json-patch.pipe.ts +39 -0
- package/templates/recipes/json-patch/tests/unit/shared/pipes/json-patch.pipe.spec.ts +37 -0
- package/templates/recipes/jwt-auth/README.md +56 -0
- package/templates/recipes/jwt-auth/src/shared/decorators/current-user.decorator.ts +10 -0
- package/templates/recipes/jwt-auth/src/shared/decorators/public.decorator.ts +4 -0
- package/templates/recipes/jwt-auth/src/shared/guards/jwt-auth.guard.ts +24 -0
- package/templates/recipes/jwt-auth/tests/unit/shared/guards/jwt-auth.guard.spec.ts +9 -0
- package/templates/recipes/kysely/README.md +53 -0
- package/templates/recipes/kysely/src/infrastructure/database/database.module.ts +28 -0
- package/templates/recipes/kysely/src/infrastructure/database/types.ts +17 -0
- package/templates/recipes/kysely/tests/unit/infrastructure/database/database.module.spec.ts +35 -0
- package/templates/recipes/license/LICENSE.agpl3 +59 -0
- package/templates/recipes/license/LICENSE.apache +189 -0
- package/templates/recipes/license/LICENSE.bsd3 +28 -0
- package/templates/recipes/license/LICENSE.gpl3 +22 -0
- package/templates/recipes/license/LICENSE.isc +15 -0
- package/templates/recipes/license/LICENSE.mit +21 -0
- package/templates/recipes/license/LICENSE.mpl2 +24 -0
- package/templates/recipes/license/LICENSE.proprietary +76 -0
- package/templates/recipes/license/LICENSE.unlicensed +13 -0
- package/templates/recipes/license/README.md +53 -0
- package/templates/recipes/load-testing/README.md +77 -0
- package/templates/recipes/load-testing/k6/smoke.js +20 -0
- package/templates/recipes/load-testing/k6/stress.js +22 -0
- package/templates/recipes/mfa-totp/README.md +77 -0
- package/templates/recipes/mfa-totp/src/shared/auth/totp.service.ts +26 -0
- package/templates/recipes/mfa-totp/tests/unit/shared/auth/totp.service.spec.ts +65 -0
- package/templates/recipes/mikro-orm/README.md +22 -0
- package/templates/recipes/mikro-orm/src/infrastructure/database/database.module.ts +8 -0
- package/templates/recipes/mikro-orm/src/infrastructure/database/entities/.gitkeep +0 -0
- package/templates/recipes/mikro-orm/src/infrastructure/database/migrations/.gitkeep +0 -0
- package/templates/recipes/mikro-orm/src/infrastructure/database/mikro-orm.config.ts +20 -0
- package/templates/recipes/mikro-orm/tests/unit/infrastructure/database/mikro-orm.config.spec.ts +53 -0
- package/templates/recipes/mongoose/README.md +42 -0
- package/templates/recipes/mongoose/src/infrastructure/database/database.module.ts.ejs +17 -0
- package/templates/recipes/mongoose/tests/unit/infrastructure/database/database.module.spec.ts +25 -0
- package/templates/recipes/multi-tenancy/README.md +49 -0
- package/templates/recipes/multi-tenancy/src/shared/decorators/tenant.decorator.ts +14 -0
- package/templates/recipes/multi-tenancy/src/shared/middleware/tenant.middleware.ts +49 -0
- package/templates/recipes/multi-tenancy/tests/unit/shared/middleware/tenant.middleware.spec.ts +29 -0
- package/templates/recipes/nodemailer/README.md +55 -0
- package/templates/recipes/nodemailer/src/infrastructure/notifications/mail.module.ts +37 -0
- package/templates/recipes/nodemailer/tests/unit/infrastructure/notifications/mail.module.spec.ts +33 -0
- package/templates/recipes/oauth-apple/README.md +68 -0
- package/templates/recipes/oauth-apple/src/shared/auth/apple-auth.guard.ts +5 -0
- package/templates/recipes/oauth-apple/src/shared/auth/apple.strategy.ts +33 -0
- package/templates/recipes/oauth-apple/tests/unit/shared/auth/apple.strategy.spec.ts +65 -0
- package/templates/recipes/oauth-github/README.md +62 -0
- package/templates/recipes/oauth-github/src/shared/auth/github-auth.guard.ts +5 -0
- package/templates/recipes/oauth-github/src/shared/auth/github.strategy.ts +33 -0
- package/templates/recipes/oauth-github/tests/unit/shared/auth/github.strategy.spec.ts +72 -0
- package/templates/recipes/oauth-google/README.md +64 -0
- package/templates/recipes/oauth-google/src/shared/auth/google-auth.guard.ts +5 -0
- package/templates/recipes/oauth-google/src/shared/auth/google.strategy.ts +33 -0
- package/templates/recipes/oauth-google/tests/unit/shared/auth/google.strategy.spec.ts +72 -0
- package/templates/recipes/oauth2-introspection/README.md +62 -0
- package/templates/recipes/oauth2-introspection/src/shared/guards/token-introspection.guard.ts +77 -0
- package/templates/recipes/oauth2-introspection/tests/unit/shared/guards/token-introspection.guard.spec.ts +99 -0
- package/templates/recipes/opentelemetry/README.md +44 -0
- package/templates/recipes/opentelemetry/src/infrastructure/telemetry/tracing.ts +38 -0
- package/templates/recipes/opentelemetry/tests/unit/infrastructure/telemetry/tracing.spec.ts +23 -0
- package/templates/recipes/pagination/README.md +71 -0
- package/templates/recipes/pagination/src/shared/decorators/paginate.decorator.ts +25 -0
- package/templates/recipes/pagination/src/shared/dto/pagination.dto.ts +64 -0
- package/templates/recipes/pagination/src/shared/interceptors/pagination-link.interceptor.ts +31 -0
- package/templates/recipes/pagination/tests/unit/shared/dto/pagination.dto.spec.ts +56 -0
- package/templates/recipes/passport/README.md +41 -0
- package/templates/recipes/passport/src/shared/guards/local-auth.guard.ts +5 -0
- package/templates/recipes/passport/tests/unit/shared/guards/local-auth.guard.spec.ts +17 -0
- package/templates/recipes/pino/README.md +48 -0
- package/templates/recipes/pino/src/infrastructure/logging/logger.module.ts +39 -0
- package/templates/recipes/pino/tests/unit/infrastructure/logging/logger.module.spec.ts +6 -0
- package/templates/recipes/prefer-header/README.md +92 -0
- package/templates/recipes/prefer-header/src/shared/interceptors/prefer.interceptor.ts +60 -0
- package/templates/recipes/prefer-header/tests/unit/shared/interceptors/prefer.interceptor.spec.ts +44 -0
- package/templates/recipes/prisma/README.md +52 -0
- package/templates/recipes/prisma/prisma/schema.prisma.ejs +8 -0
- package/templates/recipes/prisma/src/infrastructure/database/prisma.service.ts +27 -0
- package/templates/recipes/prisma/tests/unit/infrastructure/database/prisma.service.spec.ts +21 -0
- package/templates/recipes/prometheus/README.md +54 -0
- package/templates/recipes/prometheus/src/infrastructure/metrics/metrics.controller.ts +15 -0
- package/templates/recipes/prometheus/src/infrastructure/metrics/metrics.module.ts +29 -0
- package/templates/recipes/prometheus/tests/unit/infrastructure/metrics/metrics.controller.spec.ts +22 -0
- package/templates/recipes/rabbitmq/README.md +53 -0
- package/templates/recipes/rabbitmq/src/infrastructure/queue/queue.module.ts.ejs +27 -0
- package/templates/recipes/rbac-casl/README.md +69 -0
- package/templates/recipes/rbac-casl/src/shared/auth/casl-ability.factory.ts +43 -0
- package/templates/recipes/rbac-casl/src/shared/decorators/roles.decorator.ts +5 -0
- package/templates/recipes/rbac-casl/src/shared/guards/policies.guard.ts +32 -0
- package/templates/recipes/rbac-casl/src/shared/guards/roles.guard.ts +21 -0
- package/templates/recipes/rbac-casl/tests/unit/shared/auth/casl-ability.factory.spec.ts +6 -0
- package/templates/recipes/redis-cache/README.md +55 -0
- package/templates/recipes/redis-cache/src/infrastructure/cache/cache.module.ts +26 -0
- package/templates/recipes/redis-cache/tests/unit/infrastructure/cache/cache.module.spec.ts +12 -0
- package/templates/recipes/request-context/README.md +57 -0
- package/templates/recipes/request-context/src/shared/context/request-context.module.ts +19 -0
- package/templates/recipes/request-context/tests/unit/shared/context/request-context.module.spec.ts +20 -0
- package/templates/recipes/request-logging/README.md +36 -0
- package/templates/recipes/request-logging/src/shared/middleware/request-logging.middleware.ts +40 -0
- package/templates/recipes/request-logging/tests/unit/shared/middleware/request-logging.middleware.spec.ts +64 -0
- package/templates/recipes/s3-minio/README.md +52 -0
- package/templates/recipes/s3-minio/src/infrastructure/storage/storage.module.ts +10 -0
- package/templates/recipes/s3-minio/src/infrastructure/storage/storage.service.ts +72 -0
- package/templates/recipes/s3-minio/tests/unit/infrastructure/storage/storage.service.spec.ts +23 -0
- package/templates/recipes/sdk-generation/README.md +40 -0
- package/templates/recipes/sdk-generation/openapitools.json +21 -0
- package/templates/recipes/sendgrid/README.md +45 -0
- package/templates/recipes/sendgrid/src/infrastructure/notifications/sendgrid.service.ts +60 -0
- package/templates/recipes/sendgrid/tests/unit/infrastructure/notifications/sendgrid.service.spec.ts +59 -0
- package/templates/recipes/sentry/README.md +49 -0
- package/templates/recipes/sentry/src/infrastructure/sentry/sentry.filter.ts +34 -0
- package/templates/recipes/sentry/src/infrastructure/sentry/sentry.module.ts +23 -0
- package/templates/recipes/sentry/tests/unit/infrastructure/sentry/sentry.filter.spec.ts +50 -0
- package/templates/recipes/seq2/README.md +41 -0
- package/templates/recipes/seq2/src/infrastructure/logging/seq.transport.ts +57 -0
- package/templates/recipes/seq2/tests/unit/infrastructure/logging/seq.transport.spec.ts +53 -0
- package/templates/recipes/serialization-groups/README.md +105 -0
- package/templates/recipes/serialization-groups/src/shared/interceptors/serialize.interceptor.ts +29 -0
- package/templates/recipes/serialization-groups/tests/unit/shared/interceptors/serialize.interceptor.spec.ts +48 -0
- package/templates/recipes/soft-delete/README.md +71 -0
- package/templates/recipes/soft-delete/src/shared/decorators/with-deleted.decorator.ts +4 -0
- package/templates/recipes/soft-delete/src/shared/entities/soft-deletable.entity.ts +20 -0
- package/templates/recipes/soft-delete/tests/unit/shared/entities/soft-deletable.entity.spec.ts +35 -0
- package/templates/recipes/sse/README.md +43 -0
- package/templates/recipes/sse/src/shared/gateways/events.sse.controller.ts +21 -0
- package/templates/recipes/sse/tests/unit/shared/gateways/events.sse.controller.spec.ts +32 -0
- package/templates/recipes/swagger/README.md +42 -0
- package/templates/recipes/swagger/src/main.swagger.ts.ejs +20 -0
- package/templates/recipes/swagger/tests/unit/main.swagger.spec.ts +5 -0
- package/templates/recipes/throttler/README.md +49 -0
- package/templates/recipes/throttler/src/shared/guards/throttle.config.ts +33 -0
- package/templates/recipes/throttler/tests/unit/shared/guards/throttle.spec.ts +5 -0
- package/templates/recipes/transactional-outbox/README.md +98 -0
- package/templates/recipes/transactional-outbox/src/infrastructure/outbox/outbox.entity.ts +30 -0
- package/templates/recipes/transactional-outbox/src/infrastructure/outbox/outbox.service.ts +21 -0
- package/templates/recipes/transactional-outbox/tests/unit/infrastructure/outbox/outbox.service.spec.ts +38 -0
- package/templates/recipes/typeorm-mysql/README.md +48 -0
- package/templates/recipes/typeorm-mysql/src/infrastructure/database/database.module.ts.ejs +24 -0
- package/templates/recipes/typeorm-postgres/README.md +101 -0
- package/templates/recipes/typeorm-postgres/src/infrastructure/database/data-source.ts.ejs +14 -0
- package/templates/recipes/typeorm-postgres/src/infrastructure/database/database.module.ts.ejs +24 -0
- package/templates/recipes/typeorm-postgres/src/infrastructure/database/entities/.gitkeep +0 -0
- package/templates/recipes/typeorm-postgres/src/infrastructure/database/entities/index.ts +7 -0
- package/templates/recipes/typeorm-postgres/src/infrastructure/database/migrations/.gitkeep +0 -0
- package/templates/recipes/typeorm-postgres/src/infrastructure/database/migrations/index.ts +10 -0
- package/templates/recipes/typeorm-postgres/tests/unit/infrastructure/database/database.module.spec.ts +11 -0
- package/templates/recipes/webhooks/README.md +76 -0
- package/templates/recipes/webhooks/src/infrastructure/webhooks/webhook.service.ts +53 -0
- package/templates/recipes/webhooks/tests/unit/infrastructure/webhooks/webhook.service.spec.ts +31 -0
- package/templates/recipes/websockets/README.md +44 -0
- package/templates/recipes/websockets/src/shared/gateways/events.gateway.ts +55 -0
- package/templates/recipes/websockets/tests/unit/shared/gateways/events.gateway.spec.ts +23 -0
- package/templates/recipes/winston/README.md +45 -0
- package/templates/recipes/winston/src/infrastructure/logging/logger.module.ts +34 -0
- package/templates/recipes/winston/tests/unit/infrastructure/logging/logger.module.spec.ts +12 -0
- package/templates/recipes/worker-threads/README.md +71 -0
- package/templates/recipes/worker-threads/src/shared/utils/worker-pool.ts +59 -0
- package/templates/recipes/worker-threads/tests/unit/shared/utils/worker-pool.spec.ts +36 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Azure DevOps Pipelines
|
|
2
|
+
|
|
3
|
+
Stage-based CI/CD pipeline for Azure DevOps.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
- [Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/)
|
|
8
|
+
- [YAML schema reference](https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/)
|
|
9
|
+
|
|
10
|
+
## Generated Files
|
|
11
|
+
|
|
12
|
+
| File | Description |
|
|
13
|
+
| --------------------- | --------------------------- |
|
|
14
|
+
| `azure-pipelines.yml` | Multi-stage pipeline config |
|
|
15
|
+
|
|
16
|
+
## Pipeline Stages
|
|
17
|
+
|
|
18
|
+
### CI Stage
|
|
19
|
+
|
|
20
|
+
Runs on every push and pull request to `main`:
|
|
21
|
+
|
|
22
|
+
1. **Install** -- set up Node.js and pnpm, install frozen lockfile
|
|
23
|
+
2. **Lint** -- run ESLint
|
|
24
|
+
3. **Type check** -- `tsc --noEmit`
|
|
25
|
+
4. **Unit tests** -- `pnpm test:unit`
|
|
26
|
+
5. **Integration tests** -- `pnpm test:integration` with a Postgres service container
|
|
27
|
+
6. **Build** -- compile to `dist/`
|
|
28
|
+
7. **Security audit** -- `pnpm audit --audit-level=high`
|
|
29
|
+
|
|
30
|
+
### Deploy Stage
|
|
31
|
+
|
|
32
|
+
Runs after a successful CI stage on the `main` branch only. Uses an Azure DevOps deployment environment named `production` with a `runOnce` strategy. Add your deployment steps to the placeholder.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
trigger:
|
|
2
|
+
branches:
|
|
3
|
+
include:
|
|
4
|
+
- main
|
|
5
|
+
|
|
6
|
+
pr:
|
|
7
|
+
branches:
|
|
8
|
+
include:
|
|
9
|
+
- main
|
|
10
|
+
|
|
11
|
+
pool:
|
|
12
|
+
vmImage: 'ubuntu-latest'
|
|
13
|
+
|
|
14
|
+
variables:
|
|
15
|
+
PNPM_VERSION: '10'
|
|
16
|
+
NODE_VERSION: '22'
|
|
17
|
+
|
|
18
|
+
stages:
|
|
19
|
+
- stage: CI
|
|
20
|
+
displayName: 'CI'
|
|
21
|
+
jobs:
|
|
22
|
+
- job: Build
|
|
23
|
+
displayName: 'Build & Test'
|
|
24
|
+
services:
|
|
25
|
+
postgres:
|
|
26
|
+
image: postgres:16-alpine
|
|
27
|
+
ports:
|
|
28
|
+
- 5432:5432
|
|
29
|
+
env:
|
|
30
|
+
POSTGRES_USER: test
|
|
31
|
+
POSTGRES_PASSWORD: test
|
|
32
|
+
POSTGRES_DB: test_db
|
|
33
|
+
steps:
|
|
34
|
+
- task: UseNode@1
|
|
35
|
+
inputs:
|
|
36
|
+
version: $(NODE_VERSION)
|
|
37
|
+
displayName: 'Use Node.js'
|
|
38
|
+
|
|
39
|
+
- script: npm install -g pnpm@$(PNPM_VERSION)
|
|
40
|
+
displayName: 'Install pnpm'
|
|
41
|
+
|
|
42
|
+
- script: pnpm install --frozen-lockfile
|
|
43
|
+
displayName: 'Install dependencies'
|
|
44
|
+
|
|
45
|
+
- script: pnpm lint
|
|
46
|
+
displayName: 'Lint'
|
|
47
|
+
|
|
48
|
+
- script: pnpm exec tsc --noEmit
|
|
49
|
+
displayName: 'Type check'
|
|
50
|
+
|
|
51
|
+
- script: pnpm test:unit
|
|
52
|
+
displayName: 'Unit tests'
|
|
53
|
+
|
|
54
|
+
- script: pnpm test:integration
|
|
55
|
+
displayName: 'Integration tests'
|
|
56
|
+
env:
|
|
57
|
+
DATABASE_URL: postgres://test:test@localhost:5432/test_db
|
|
58
|
+
|
|
59
|
+
- script: pnpm build
|
|
60
|
+
displayName: 'Build'
|
|
61
|
+
|
|
62
|
+
- script: pnpm audit --audit-level=high
|
|
63
|
+
displayName: 'Security audit'
|
|
64
|
+
continueOnError: true
|
|
65
|
+
|
|
66
|
+
- stage: Deploy
|
|
67
|
+
displayName: 'Deploy'
|
|
68
|
+
dependsOn: CI
|
|
69
|
+
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
|
|
70
|
+
jobs:
|
|
71
|
+
- deployment: Production
|
|
72
|
+
displayName: 'Deploy to Production'
|
|
73
|
+
environment: 'production'
|
|
74
|
+
strategy:
|
|
75
|
+
runOnce:
|
|
76
|
+
deploy:
|
|
77
|
+
steps:
|
|
78
|
+
- script: echo "Add deployment steps here"
|
|
79
|
+
displayName: 'Deploy'
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# GCP Cloud Build
|
|
2
|
+
|
|
3
|
+
CI/CD pipeline configuration for Google Cloud Build.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
- [Cloud Build overview](https://cloud.google.com/build/docs)
|
|
8
|
+
- [Build configuration file schema](https://cloud.google.com/build/docs/build-config-file-schema)
|
|
9
|
+
- [Substitution variables](https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values)
|
|
10
|
+
|
|
11
|
+
## Generated Files
|
|
12
|
+
|
|
13
|
+
| File | Description |
|
|
14
|
+
| ----------------- | ---------------------------------- |
|
|
15
|
+
| `cloudbuild.yaml` | Cloud Build pipeline configuration |
|
|
16
|
+
|
|
17
|
+
## Pipeline Stages
|
|
18
|
+
|
|
19
|
+
1. **Install** -- install pnpm globally and run `pnpm install --frozen-lockfile`
|
|
20
|
+
2. **Lint** -- run ESLint via `pnpm lint`
|
|
21
|
+
3. **Type check** -- `pnpm exec tsc --noEmit`
|
|
22
|
+
4. **Unit tests** -- `pnpm test:unit`
|
|
23
|
+
5. **Build** -- compile to `dist/`
|
|
24
|
+
6. **Security audit** -- `pnpm audit --audit-level=high` (non-blocking)
|
|
25
|
+
7. **Docker build** -- build the container image
|
|
26
|
+
8. **Docker push** -- push to Artifact Registry
|
|
27
|
+
|
|
28
|
+
## Substitution Variables
|
|
29
|
+
|
|
30
|
+
| Variable | Default | Description |
|
|
31
|
+
| ------------- | -------------- | ----------------------------------------- |
|
|
32
|
+
| `_REGION` | `europe-west1` | GCP region for Artifact Registry |
|
|
33
|
+
| `_REPOSITORY` | `app` | Artifact Registry repository name |
|
|
34
|
+
| `_IMAGE` | `api` | Container image name |
|
|
35
|
+
| `PROJECT_ID` | _(built-in)_ | GCP project ID (provided automatically) |
|
|
36
|
+
| `SHORT_SHA` | _(built-in)_ | Short commit SHA (provided automatically) |
|
|
37
|
+
|
|
38
|
+
## Usage
|
|
39
|
+
|
|
40
|
+
### Connecting a repository
|
|
41
|
+
|
|
42
|
+
1. Go to **Cloud Build > Triggers** in the Google Cloud console.
|
|
43
|
+
2. Connect your GitHub or GitLab repository via the **Cloud Build GitHub App** or **GitLab host connection**.
|
|
44
|
+
3. Authorize access to the target repository.
|
|
45
|
+
|
|
46
|
+
### Creating a trigger
|
|
47
|
+
|
|
48
|
+
1. Click **Create Trigger**.
|
|
49
|
+
2. Set the event (e.g. push to `main`, pull request).
|
|
50
|
+
3. Under **Configuration**, select **Cloud Build configuration file** and point to `cloudbuild.yaml`.
|
|
51
|
+
4. Override substitution variables if needed (region, repository, image name).
|
|
52
|
+
5. Save and run the trigger manually to verify the pipeline.
|
|
53
|
+
|
|
54
|
+
### Prerequisites
|
|
55
|
+
|
|
56
|
+
- Enable the **Cloud Build API** and **Artifact Registry API** in your GCP project.
|
|
57
|
+
- Create an Artifact Registry Docker repository:
|
|
58
|
+
```bash
|
|
59
|
+
gcloud artifacts repositories create app \
|
|
60
|
+
--repository-format=docker \
|
|
61
|
+
--location=europe-west1 \
|
|
62
|
+
--description="Application container images"
|
|
63
|
+
```
|
|
64
|
+
- Grant the Cloud Build service account permission to push to Artifact Registry (the `roles/artifactregistry.writer` role).
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
steps:
|
|
2
|
+
- name: 'node:22-alpine'
|
|
3
|
+
entrypoint: 'sh'
|
|
4
|
+
args:
|
|
5
|
+
- '-c'
|
|
6
|
+
- |
|
|
7
|
+
npm install -g pnpm@10
|
|
8
|
+
pnpm install --frozen-lockfile
|
|
9
|
+
|
|
10
|
+
- name: 'node:22-alpine'
|
|
11
|
+
entrypoint: 'sh'
|
|
12
|
+
args: ['-c', 'pnpm lint']
|
|
13
|
+
|
|
14
|
+
- name: 'node:22-alpine'
|
|
15
|
+
entrypoint: 'sh'
|
|
16
|
+
args: ['-c', 'pnpm exec tsc --noEmit']
|
|
17
|
+
|
|
18
|
+
- name: 'node:22-alpine'
|
|
19
|
+
entrypoint: 'sh'
|
|
20
|
+
args: ['-c', 'pnpm test:unit']
|
|
21
|
+
|
|
22
|
+
- name: 'node:22-alpine'
|
|
23
|
+
entrypoint: 'sh'
|
|
24
|
+
args: ['-c', 'pnpm test:integration']
|
|
25
|
+
|
|
26
|
+
- name: 'node:22-alpine'
|
|
27
|
+
entrypoint: 'sh'
|
|
28
|
+
args: ['-c', 'pnpm build']
|
|
29
|
+
|
|
30
|
+
- name: 'node:22-alpine'
|
|
31
|
+
entrypoint: 'sh'
|
|
32
|
+
args: ['-c', 'pnpm audit --audit-level=high || true']
|
|
33
|
+
|
|
34
|
+
# Docker build and push to Artifact Registry
|
|
35
|
+
- name: 'gcr.io/cloud-builders/docker'
|
|
36
|
+
args:
|
|
37
|
+
- 'build'
|
|
38
|
+
- '-t'
|
|
39
|
+
- '${_REGION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE}:${SHORT_SHA}'
|
|
40
|
+
- '.'
|
|
41
|
+
|
|
42
|
+
- name: 'gcr.io/cloud-builders/docker'
|
|
43
|
+
args:
|
|
44
|
+
- 'push'
|
|
45
|
+
- '${_REGION}-docker.pkg.dev/${PROJECT_ID}/${_REPOSITORY}/${_IMAGE}:${SHORT_SHA}'
|
|
46
|
+
|
|
47
|
+
substitutions:
|
|
48
|
+
_REGION: 'europe-west1'
|
|
49
|
+
_REPOSITORY: 'app'
|
|
50
|
+
_IMAGE: 'api'
|
|
51
|
+
|
|
52
|
+
options:
|
|
53
|
+
logging: CLOUD_LOGGING_ONLY
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
name: CD
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
deploy:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
needs: []
|
|
11
|
+
environment: production
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
|
|
16
|
+
- uses: pnpm/action-setup@v4
|
|
17
|
+
with:
|
|
18
|
+
version: 10
|
|
19
|
+
|
|
20
|
+
- uses: actions/setup-node@v4
|
|
21
|
+
with:
|
|
22
|
+
node-version-file: '.nvmrc'
|
|
23
|
+
cache: 'pnpm'
|
|
24
|
+
|
|
25
|
+
- name: Install dependencies
|
|
26
|
+
run: pnpm install --frozen-lockfile
|
|
27
|
+
|
|
28
|
+
- name: Build
|
|
29
|
+
run: pnpm build
|
|
30
|
+
|
|
31
|
+
# Add deployment steps here based on your target:
|
|
32
|
+
# - Docker build & push to registry
|
|
33
|
+
# - Deploy to Kubernetes
|
|
34
|
+
# - Deploy to AWS Lambda
|
|
35
|
+
# - etc.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
ci:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
services:
|
|
14
|
+
postgres:
|
|
15
|
+
image: postgres:16-alpine
|
|
16
|
+
env:
|
|
17
|
+
POSTGRES_USER: test
|
|
18
|
+
POSTGRES_PASSWORD: test
|
|
19
|
+
POSTGRES_DB: test_db
|
|
20
|
+
ports:
|
|
21
|
+
- 5432:5432
|
|
22
|
+
options: >-
|
|
23
|
+
--health-cmd pg_isready
|
|
24
|
+
--health-interval 10s
|
|
25
|
+
--health-timeout 5s
|
|
26
|
+
--health-retries 5
|
|
27
|
+
|
|
28
|
+
steps:
|
|
29
|
+
- uses: actions/checkout@v4
|
|
30
|
+
|
|
31
|
+
- uses: pnpm/action-setup@v4
|
|
32
|
+
with:
|
|
33
|
+
version: 10
|
|
34
|
+
|
|
35
|
+
- uses: actions/setup-node@v4
|
|
36
|
+
with:
|
|
37
|
+
node-version-file: '.nvmrc'
|
|
38
|
+
cache: 'pnpm'
|
|
39
|
+
|
|
40
|
+
- name: Install dependencies
|
|
41
|
+
run: pnpm install --frozen-lockfile
|
|
42
|
+
|
|
43
|
+
- name: Lint
|
|
44
|
+
run: pnpm lint
|
|
45
|
+
|
|
46
|
+
- name: Type check
|
|
47
|
+
run: pnpm exec tsc --noEmit
|
|
48
|
+
|
|
49
|
+
- name: Unit tests
|
|
50
|
+
run: pnpm test:unit
|
|
51
|
+
|
|
52
|
+
- name: Integration tests
|
|
53
|
+
run: pnpm test:integration
|
|
54
|
+
env:
|
|
55
|
+
DATABASE_URL: postgres://test:test@localhost:5432/test_db
|
|
56
|
+
|
|
57
|
+
- name: Build
|
|
58
|
+
run: pnpm build
|
|
59
|
+
|
|
60
|
+
- name: Security audit
|
|
61
|
+
run: pnpm audit --audit-level=high
|
|
62
|
+
continue-on-error: true
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# GitHub Actions
|
|
2
|
+
|
|
3
|
+
CI/CD workflow files for GitHub Actions.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
- [GitHub Actions](https://docs.github.com/en/actions)
|
|
8
|
+
- [Workflow syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
|
|
9
|
+
|
|
10
|
+
## Generated Files
|
|
11
|
+
|
|
12
|
+
| File | Description |
|
|
13
|
+
| -------------------------- | ------------------------------- |
|
|
14
|
+
| `.github/workflows/ci.yml` | Continuous integration workflow |
|
|
15
|
+
| `.github/workflows/cd.yml` | Continuous deployment workflow |
|
|
16
|
+
|
|
17
|
+
## CI Pipeline Stages
|
|
18
|
+
|
|
19
|
+
1. **Install** -- checkout, set up pnpm and Node.js, install frozen lockfile
|
|
20
|
+
2. **Lint** -- run ESLint
|
|
21
|
+
3. **Type check** -- `tsc --noEmit`
|
|
22
|
+
4. **Unit tests** -- `pnpm test:unit`
|
|
23
|
+
5. **Integration tests** -- `pnpm test:integration` with a Postgres service container
|
|
24
|
+
6. **Build** -- compile to `dist/`
|
|
25
|
+
7. **Security audit** -- `pnpm audit --audit-level=high`
|
|
26
|
+
|
|
27
|
+
## CD Pipeline
|
|
28
|
+
|
|
29
|
+
Triggers on push to `main`. Installs dependencies, builds the project, then deploys to the configured production environment. Add your deployment steps (Docker push, Kubernetes deploy, Lambda deploy, etc.) to the placeholder in `cd.yml`.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Circuit Breaker
|
|
2
|
+
|
|
3
|
+
Fault tolerance pattern using Opossum to prevent cascading failures in distributed systems.
|
|
4
|
+
|
|
5
|
+
## Links
|
|
6
|
+
|
|
7
|
+
- [Opossum on npm](https://www.npmjs.com/package/opossum)
|
|
8
|
+
- [Opossum on GitHub](https://github.com/nodeshift/opossum)
|
|
9
|
+
- [Circuit Breaker Pattern (Martin Fowler)](https://martinfowler.com/bliki/CircuitBreaker.html)
|
|
10
|
+
|
|
11
|
+
## Dependencies
|
|
12
|
+
|
|
13
|
+
| Package | Version | Purpose |
|
|
14
|
+
| --------- | ------- | ------------------------------ |
|
|
15
|
+
| `opossum` | `8.1.4` | Circuit breaker implementation |
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { CircuitBreakerWrapper } from '@/shared/utils/circuit-breaker';
|
|
21
|
+
import { ConfigService } from '@nestjs/config';
|
|
22
|
+
|
|
23
|
+
// With ConfigService — reads CIRCUIT_BREAKER_TIMEOUT, CIRCUIT_BREAKER_THRESHOLD,
|
|
24
|
+
// and CIRCUIT_BREAKER_RESET_TIMEOUT from the environment:
|
|
25
|
+
const breaker = new CircuitBreakerWrapper(
|
|
26
|
+
() => httpService.get('https://external-api.com/data'),
|
|
27
|
+
{},
|
|
28
|
+
configService,
|
|
29
|
+
);
|
|
30
|
+
|
|
31
|
+
// With explicit overrides (take precedence over env vars):
|
|
32
|
+
const breaker = new CircuitBreakerWrapper(
|
|
33
|
+
() => httpService.get('https://external-api.com/data'),
|
|
34
|
+
{ timeout: 5000 },
|
|
35
|
+
configService,
|
|
36
|
+
);
|
|
37
|
+
|
|
38
|
+
const result = await breaker.fire();
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Generated Files
|
|
42
|
+
|
|
43
|
+
| File | Description |
|
|
44
|
+
| ------------------------------------- | -------------------------------------------- |
|
|
45
|
+
| `src/shared/utils/circuit-breaker.ts` | Opossum circuit breaker wrapper with logging |
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Logger } from '@nestjs/common';
|
|
2
|
+
import { ConfigService } from '@nestjs/config';
|
|
3
|
+
import CircuitBreaker from 'opossum';
|
|
4
|
+
|
|
5
|
+
export interface CircuitBreakerOptions {
|
|
6
|
+
/** Time in ms before a request is considered timed out */
|
|
7
|
+
timeout?: number;
|
|
8
|
+
/** Percentage of failures before opening the circuit */
|
|
9
|
+
errorThresholdPercentage?: number;
|
|
10
|
+
/** Time in ms to wait before attempting to close the circuit */
|
|
11
|
+
resetTimeout?: number;
|
|
12
|
+
/** Number of requests to allow in half-open state */
|
|
13
|
+
rollingCountBuckets?: number;
|
|
14
|
+
/** Time in ms for the rolling statistical window */
|
|
15
|
+
rollingCountTimeout?: number;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
const HARDCODED_DEFAULTS: CircuitBreakerOptions = {
|
|
19
|
+
timeout: 3000,
|
|
20
|
+
errorThresholdPercentage: 50,
|
|
21
|
+
resetTimeout: 30_000,
|
|
22
|
+
rollingCountBuckets: 10,
|
|
23
|
+
rollingCountTimeout: 10_000,
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Build default options by reading CIRCUIT_BREAKER_* env vars via ConfigService.
|
|
28
|
+
* Falls back to hardcoded defaults when the env vars are not set or no ConfigService is provided.
|
|
29
|
+
*/
|
|
30
|
+
function buildDefaults(configService?: ConfigService): CircuitBreakerOptions {
|
|
31
|
+
if (!configService) {
|
|
32
|
+
return { ...HARDCODED_DEFAULTS };
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return {
|
|
36
|
+
timeout: configService.get<number>('CIRCUIT_BREAKER_TIMEOUT', HARDCODED_DEFAULTS.timeout!),
|
|
37
|
+
errorThresholdPercentage: configService.get<number>(
|
|
38
|
+
'CIRCUIT_BREAKER_THRESHOLD',
|
|
39
|
+
HARDCODED_DEFAULTS.errorThresholdPercentage!,
|
|
40
|
+
),
|
|
41
|
+
resetTimeout: configService.get<number>(
|
|
42
|
+
'CIRCUIT_BREAKER_RESET_TIMEOUT',
|
|
43
|
+
HARDCODED_DEFAULTS.resetTimeout!,
|
|
44
|
+
),
|
|
45
|
+
rollingCountBuckets: HARDCODED_DEFAULTS.rollingCountBuckets,
|
|
46
|
+
rollingCountTimeout: HARDCODED_DEFAULTS.rollingCountTimeout,
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export class CircuitBreakerWrapper<TResult = unknown> {
|
|
51
|
+
private readonly logger = new Logger(CircuitBreakerWrapper.name);
|
|
52
|
+
private readonly breaker: CircuitBreaker<unknown[], TResult>;
|
|
53
|
+
|
|
54
|
+
constructor(
|
|
55
|
+
action: (...args: unknown[]) => Promise<TResult>,
|
|
56
|
+
options: CircuitBreakerOptions = {},
|
|
57
|
+
configService?: ConfigService,
|
|
58
|
+
) {
|
|
59
|
+
const mergedOptions = { ...buildDefaults(configService), ...options };
|
|
60
|
+
|
|
61
|
+
this.breaker = new CircuitBreaker(action, mergedOptions);
|
|
62
|
+
|
|
63
|
+
this.breaker.on('open', () => {
|
|
64
|
+
this.logger.warn('Circuit breaker opened — requests will be short-circuited');
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
this.breaker.on('halfOpen', () => {
|
|
68
|
+
this.logger.log('Circuit breaker half-open — testing with next request');
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
this.breaker.on('close', () => {
|
|
72
|
+
this.logger.log('Circuit breaker closed — normal operation resumed');
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
this.breaker.on('fallback', () => {
|
|
76
|
+
this.logger.debug('Circuit breaker fallback triggered');
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
this.breaker.on('timeout', () => {
|
|
80
|
+
this.logger.warn('Circuit breaker request timed out');
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
async fire(...args: unknown[]): Promise<TResult> {
|
|
85
|
+
return this.breaker.fire(...args);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
fallback(fn: (...args: unknown[]) => TResult): this {
|
|
89
|
+
this.breaker.fallback(fn);
|
|
90
|
+
return this;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
get isOpen(): boolean {
|
|
94
|
+
return !this.breaker.closed;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
get stats(): CircuitBreaker.Stats {
|
|
98
|
+
return this.breaker.stats;
|
|
99
|
+
}
|
|
100
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { CircuitBreakerWrapper } from '@/shared/utils/circuit-breaker';
|
|
2
|
+
|
|
3
|
+
describe('CircuitBreakerWrapper', () => {
|
|
4
|
+
it('should create an instance wrapping the provided action', () => {
|
|
5
|
+
const action = jest.fn().mockResolvedValue('ok');
|
|
6
|
+
const wrapper = new CircuitBreakerWrapper(action);
|
|
7
|
+
|
|
8
|
+
expect(wrapper).toBeDefined();
|
|
9
|
+
expect(wrapper.isOpen).toBe(false);
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
it('should delegate fire() to the underlying breaker and return the result', async () => {
|
|
13
|
+
const action = jest.fn().mockResolvedValue('result');
|
|
14
|
+
const wrapper = new CircuitBreakerWrapper(action);
|
|
15
|
+
|
|
16
|
+
const result = await wrapper.fire('arg1');
|
|
17
|
+
|
|
18
|
+
expect(result).toBe('result');
|
|
19
|
+
expect(action).toHaveBeenCalledWith('arg1');
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it('should return itself when registering a fallback', () => {
|
|
23
|
+
const wrapper = new CircuitBreakerWrapper(jest.fn().mockResolvedValue('ok'));
|
|
24
|
+
const result = wrapper.fallback(() => 'fallback');
|
|
25
|
+
|
|
26
|
+
expect(result).toBe(wrapper);
|
|
27
|
+
});
|
|
28
|
+
});
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AWS Cloud Recipes
|
|
2
|
+
|
|
3
|
+
Amazon Web Services integrations for NestJS applications.
|
|
4
|
+
|
|
5
|
+
## Recipes
|
|
6
|
+
|
|
7
|
+
| Recipe | Description |
|
|
8
|
+
| ------------------------------------- | ------------------------------------------------------------ |
|
|
9
|
+
| [CloudFront](./cloudfront/) | CDN integration with signed URLs |
|
|
10
|
+
| [CloudWatch](./cloudwatch/) | Ship application logs to CloudWatch Logs |
|
|
11
|
+
| [Cognito](./cognito/) | User pool authentication and authorization |
|
|
12
|
+
| [DynamoDB](./dynamodb/) | NoSQL database integration |
|
|
13
|
+
| [ElastiCache](./elasticache/) | Managed Redis caching service |
|
|
14
|
+
| [EventBridge](./eventbridge/) | Event-driven architecture with EventBridge |
|
|
15
|
+
| [RDS](./rds/) | Managed database connection with IAM authentication |
|
|
16
|
+
| [S3](./s3/) | Object storage for file uploads and downloads |
|
|
17
|
+
| [Secrets Manager](./secrets-manager/) | Retrieve and cache secrets |
|
|
18
|
+
| [SNS](./sns/) | Pub/sub messaging with Simple Notification Service |
|
|
19
|
+
| [SQS](./sqs/) | Reliable message queuing with Simple Queue Service |
|
|
20
|
+
| [SSM Parameter Store](./ssm/) | Configuration retrieval from Systems Manager Parameter Store |
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# AWS CloudFront
|
|
2
|
+
|
|
3
|
+
AWS CloudFront CDN integration with signed URLs for NestJS.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
- [AWS CloudFront Developer Guide](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/)
|
|
8
|
+
- [CloudFront Signed URLs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-signed-urls.html)
|
|
9
|
+
- [@aws-sdk/client-cloudfront on npm](https://www.npmjs.com/package/@aws-sdk/client-cloudfront)
|
|
10
|
+
|
|
11
|
+
## Dependencies
|
|
12
|
+
|
|
13
|
+
| Package | Version | Purpose |
|
|
14
|
+
| ---------------------------- | --------- | ---------------------------- |
|
|
15
|
+
| `@aws-sdk/client-cloudfront` | `3.712.0` | AWS SDK v3 CloudFront client |
|
|
16
|
+
|
|
17
|
+
## Environment Variables
|
|
18
|
+
|
|
19
|
+
| Variable | Default | Description |
|
|
20
|
+
| ---------------------------- | ----------- | ------------------------------ |
|
|
21
|
+
| `AWS_REGION` | `eu-west-1` | AWS region |
|
|
22
|
+
| `CLOUDFRONT_DISTRIBUTION_ID` | — | CloudFront distribution ID |
|
|
23
|
+
| `CLOUDFRONT_DOMAIN` | — | CloudFront distribution domain |
|
|
24
|
+
| `CLOUDFRONT_KEY_PAIR_ID` | — | Key pair ID for signed URLs |
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { CloudFrontService } from '@/aws/cloudfront.service';
|
|
30
|
+
|
|
31
|
+
@Injectable()
|
|
32
|
+
export class AssetService {
|
|
33
|
+
constructor(private readonly cdn: CloudFrontService) {}
|
|
34
|
+
|
|
35
|
+
getSignedUrl(objectKey: string, expiresInSeconds: number): string {
|
|
36
|
+
return this.cdn.createSignedUrl({
|
|
37
|
+
url: `https://${this.configService.get('CLOUDFRONT_DOMAIN')}/${objectKey}`,
|
|
38
|
+
keyPairId: this.configService.get('CLOUDFRONT_KEY_PAIR_ID'),
|
|
39
|
+
dateLessThan: new Date(Date.now() + expiresInSeconds * 1000).toISOString(),
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
async invalidateCache(paths: string[]): Promise<void> {
|
|
44
|
+
await this.cdn.createInvalidation({
|
|
45
|
+
distributionId: this.configService.get('CLOUDFRONT_DISTRIBUTION_ID'),
|
|
46
|
+
paths,
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { Injectable, Logger } from '@nestjs/common';
|
|
2
|
+
import { ConfigService } from '@nestjs/config';
|
|
3
|
+
import { getSignedUrl } from '@aws-sdk/cloudfront-signer';
|
|
4
|
+
|
|
5
|
+
@Injectable()
|
|
6
|
+
export class CloudFrontService {
|
|
7
|
+
private readonly keyPairId: string;
|
|
8
|
+
private readonly privateKey: string;
|
|
9
|
+
private readonly logger = new Logger(CloudFrontService.name);
|
|
10
|
+
|
|
11
|
+
constructor(private readonly configService: ConfigService) {
|
|
12
|
+
this.keyPairId = this.configService.getOrThrow<string>('CLOUDFRONT_KEY_PAIR_ID');
|
|
13
|
+
this.privateKey = this.configService.getOrThrow<string>('CLOUDFRONT_PRIVATE_KEY');
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
getSignedUrl(url: string, expiresInSeconds = 3600): string {
|
|
17
|
+
const dateLessThan = new Date(Date.now() + expiresInSeconds * 1000).toISOString();
|
|
18
|
+
|
|
19
|
+
const signedUrl = getSignedUrl({
|
|
20
|
+
url,
|
|
21
|
+
keyPairId: this.keyPairId,
|
|
22
|
+
privateKey: this.privateKey,
|
|
23
|
+
dateLessThan,
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
this.logger.debug(`Generated signed URL for ${url}`);
|
|
27
|
+
return signedUrl;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# AWS CloudWatch Logs
|
|
2
|
+
|
|
3
|
+
Ship application logs to AWS CloudWatch Logs from NestJS.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
- [AWS CloudWatch Logs User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/)
|
|
8
|
+
- [@aws-sdk/client-cloudwatch-logs on npm](https://www.npmjs.com/package/@aws-sdk/client-cloudwatch-logs)
|
|
9
|
+
- [NestJS Logger](https://docs.nestjs.com/techniques/logger)
|
|
10
|
+
|
|
11
|
+
## Dependencies
|
|
12
|
+
|
|
13
|
+
| Package | Version | Purpose |
|
|
14
|
+
| --------------------------------- | --------- | --------------------------------- |
|
|
15
|
+
| `@aws-sdk/client-cloudwatch-logs` | `3.712.0` | AWS SDK v3 CloudWatch Logs client |
|
|
16
|
+
|
|
17
|
+
## Environment Variables
|
|
18
|
+
|
|
19
|
+
| Variable | Default | Description |
|
|
20
|
+
| ---------------------- | ------------- | ------------------------- |
|
|
21
|
+
| `AWS_REGION` | `eu-west-1` | AWS region |
|
|
22
|
+
| `CLOUDWATCH_LOG_GROUP` | `/app/nestjs` | CloudWatch log group name |
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { CloudWatchLoggerService } from '@/aws/cloudwatch-logger.service';
|
|
28
|
+
|
|
29
|
+
@Injectable()
|
|
30
|
+
export class AppLogger {
|
|
31
|
+
constructor(private readonly cwLogger: CloudWatchLoggerService) {}
|
|
32
|
+
|
|
33
|
+
async info(message: string, context: Record<string, unknown>): Promise<void> {
|
|
34
|
+
await this.cwLogger.log({
|
|
35
|
+
logGroupName: this.configService.get('CLOUDWATCH_LOG_GROUP'),
|
|
36
|
+
message: JSON.stringify({ level: 'info', message, ...context }),
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
```
|