forjajs 1.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/.claude/agents/context-engineer.md +25 -0
- package/.claude/agents/governance.md +32 -0
- package/.claude/agents/marketing.md +24 -0
- package/.claude/agents/orchestrator.md +31 -0
- package/.claude/agents/product.md +26 -0
- package/.claude/agents/sdd-architect.md +34 -0
- package/.claude/settings.json +41 -0
- package/.gemini-instructions.md +87 -0
- package/.github/copilot-instructions.md +87 -0
- package/.memoryrc.json +104 -0
- package/.openai-instructions.md +87 -0
- package/AGENTS.md +132 -0
- package/CHANGELOG.md +106 -0
- package/CONTRIBUTING.md +32 -0
- package/DOC-MAP.md +65 -0
- package/LICENSE +21 -0
- package/README.md +260 -0
- package/bin/create-memory-nest-kit.js +125 -0
- package/bin/forja.mjs +143 -0
- package/bin/init-project.js +612 -0
- package/boilerplates/01-api-rest/README.md +336 -0
- package/boilerplates/01-api-rest/boilerplate.manifest.json +41 -0
- package/boilerplates/02-saas-starter/.env.example +25 -0
- package/boilerplates/02-saas-starter/CHECKLIST-CRIACAO.md +190 -0
- package/boilerplates/02-saas-starter/INFO.md +252 -0
- package/boilerplates/02-saas-starter/QUICK_START.md +194 -0
- package/boilerplates/02-saas-starter/README.md +305 -0
- package/boilerplates/02-saas-starter/START-HERE.md +259 -0
- package/boilerplates/02-saas-starter/backend/package.json +87 -0
- package/boilerplates/02-saas-starter/backend/src/app.module.ts +27 -0
- package/boilerplates/02-saas-starter/backend/src/common/decorators/roles.decorator.ts +3 -0
- package/boilerplates/02-saas-starter/backend/src/common/decorators/tenant.decorator.ts +6 -0
- package/boilerplates/02-saas-starter/backend/src/common/middleware/roles.guard.ts +23 -0
- package/boilerplates/02-saas-starter/backend/src/config/database.ts +26 -0
- package/boilerplates/02-saas-starter/backend/src/main.ts +26 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.controller.ts +46 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.module.ts +25 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.service.ts +145 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/dto/auth.dto.ts +30 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/jwt.strategy.ts +24 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/local.strategy.ts +19 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.controller.ts +42 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.service.ts +67 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/entities/invoice.entity.ts +52 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/entities/organization.entity.ts +36 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.controller.ts +16 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.service.ts +34 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/entities/subscription.entity.ts +40 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.controller.ts +36 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.service.ts +91 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/entities/user.entity.ts +42 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.controller.ts +14 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.service.ts +48 -0
- package/boilerplates/02-saas-starter/backend/tsconfig.json +28 -0
- package/boilerplates/02-saas-starter/boilerplate.manifest.json +42 -0
- package/boilerplates/02-saas-starter/docker-compose.yml +34 -0
- package/boilerplates/02-saas-starter/memory/00-global/agent-contract.md +227 -0
- package/boilerplates/02-saas-starter/memory/00-global/context-policy.md +141 -0
- package/boilerplates/02-saas-starter/memory/00-global/index.md +133 -0
- package/boilerplates/02-saas-starter/memory/00-global/mission.md +45 -0
- package/boilerplates/02-saas-starter/memory/00-global/patterns.md +223 -0
- package/boilerplates/02-saas-starter/memory/10-product/business-rules.md +240 -0
- package/boilerplates/02-saas-starter/memory/10-product/nfrs.md +239 -0
- package/boilerplates/02-saas-starter/memory/10-product/personas.md +195 -0
- package/boilerplates/02-saas-starter/memory/10-product/vision.md +63 -0
- package/boilerplates/02-saas-starter/memory/20-architecture/overview.md +232 -0
- package/boilerplates/02-saas-starter/memory/30-domains/auth/api.md +186 -0
- package/boilerplates/02-saas-starter/memory/30-domains/auth/context.md +85 -0
- package/boilerplates/02-saas-starter/memory/30-domains/billing/api.md +262 -0
- package/boilerplates/02-saas-starter/memory/30-domains/billing/context.md +137 -0
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/api.md +176 -0
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/context.md +100 -0
- package/boilerplates/02-saas-starter/memory/40-delivery/backlog.md +81 -0
- package/boilerplates/02-saas-starter/memory/40-delivery/roadmap.md +97 -0
- package/boilerplates/02-saas-starter/memory/40-delivery/sprint-atual.md +57 -0
- package/boilerplates/02-saas-starter/memory/50-orchestration/topology.md +90 -0
- package/boilerplates/02-saas-starter/memory/60-runs/index.md +54 -0
- package/boilerplates/02-saas-starter/memory/70-summaries/global.md +50 -0
- package/boilerplates/02-saas-starter/memory/80-data/schema.md +185 -0
- package/boilerplates/02-saas-starter/memory/90-decisions/adr-template.md +75 -0
- package/boilerplates/03-ecommerce-starter/FLOW_EXEMPLOS.md +599 -0
- package/boilerplates/03-ecommerce-starter/GUIA_RAPIDO.md +322 -0
- package/boilerplates/03-ecommerce-starter/MANIFEST.md +463 -0
- package/boilerplates/03-ecommerce-starter/README.md +465 -0
- package/boilerplates/03-ecommerce-starter/agents/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/backend/.env.example +121 -0
- package/boilerplates/03-ecommerce-starter/backend/Dockerfile +15 -0
- package/boilerplates/03-ecommerce-starter/backend/docker-compose.yml +56 -0
- package/boilerplates/03-ecommerce-starter/backend/jest.config.js +16 -0
- package/boilerplates/03-ecommerce-starter/backend/package.json +71 -0
- package/boilerplates/03-ecommerce-starter/backend/src/app.controller.ts +12 -0
- package/boilerplates/03-ecommerce-starter/backend/src/app.module.ts +48 -0
- package/boilerplates/03-ecommerce-starter/backend/src/app.service.ts +12 -0
- package/boilerplates/03-ecommerce-starter/backend/src/common/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/backend/src/main.ts +51 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/auth/auth.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/cart/cart.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/coupons/coupons.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/inventory/inventory.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/orders/orders.module.ts +10 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/payments/payments.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/dto/create-product.dto.ts +34 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/entities/category.entity.ts +47 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/entities/product.entity.ts +66 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/products.controller.ts +78 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/products.module.ts +14 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/products.service.ts +112 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/reviews/entities/review.entity.ts +32 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/reviews/reviews.module.ts +11 -0
- package/boilerplates/03-ecommerce-starter/backend/test/health.e2e-spec.ts +31 -0
- package/boilerplates/03-ecommerce-starter/backend/test/jest-e2e.json +12 -0
- package/boilerplates/03-ecommerce-starter/backend/tsconfig.json +23 -0
- package/boilerplates/03-ecommerce-starter/boilerplate.manifest.json +42 -0
- package/boilerplates/03-ecommerce-starter/boilerplate.md +128 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/agent-contract.md +53 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/context-index.md +55 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/context-policy.md +31 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/mission.md +25 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/standards.md +45 -0
- package/boilerplates/03-ecommerce-starter/memory/10-product/business-rules.md +62 -0
- package/boilerplates/03-ecommerce-starter/memory/10-product/nfrs.md +62 -0
- package/boilerplates/03-ecommerce-starter/memory/10-product/vision.md +124 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/backend.md +253 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/observability.md +319 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/overview.md +133 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/security.md +227 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/catalog/context.md +210 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/inventory/context.md +233 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/orders/context.md +210 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/payments/context.md +168 -0
- package/boilerplates/03-ecommerce-starter/memory/40-delivery/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/50-orchestration/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/60-runs/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/70-summaries/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/80-data/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/80-data/sqlite.md +260 -0
- package/boilerplates/03-ecommerce-starter/memory/90-decisions/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/90-decisions/ADR-TEMPLATE.md +223 -0
- package/boilerplates/03-ecommerce-starter/prompts/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/skills/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/.env.example +43 -0
- package/boilerplates/04-microservices-starter/API-EXAMPLES.md +609 -0
- package/boilerplates/04-microservices-starter/ARCHITECTURE.md +512 -0
- package/boilerplates/04-microservices-starter/GETTING-STARTED.md +246 -0
- package/boilerplates/04-microservices-starter/INDEX.md +377 -0
- package/boilerplates/04-microservices-starter/MANIFEST.md +456 -0
- package/boilerplates/04-microservices-starter/README.md +466 -0
- package/boilerplates/04-microservices-starter/SUMMARY.md +386 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/package.json +29 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/app.module.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/gateway.controller.ts +45 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/gateway.service.ts +114 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/package.json +42 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/app.module.ts +7 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/auth.controller.ts +130 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/auth.module.ts +21 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/auth.service.ts +159 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/jwt.strategy.ts +19 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/local.strategy.ts +18 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/notification/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/user/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/tsconfig.json +21 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/package.json +25 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/app.module.ts +7 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/auth/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/notification/notification.controller.ts +160 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/notification/notification.module.ts +10 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/notification/notification.service.ts +92 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/user/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/package.json +25 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/app.module.ts +7 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/auth/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/notification/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/user/user.controller.ts +122 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/user/user.module.ts +10 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/user/user.service.ts +161 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/backend/shared/package.json +15 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/constants/index.ts +84 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/decorators/index.ts +12 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/index.ts +4 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/interfaces/index.ts +152 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/types/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/utils/index.ts +54 -0
- package/boilerplates/04-microservices-starter/backend/shared/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/boilerplate.manifest.json +41 -0
- package/boilerplates/04-microservices-starter/docker-compose.yml +164 -0
- package/boilerplates/04-microservices-starter/memory/00-global/agent-contract.md +171 -0
- package/boilerplates/04-microservices-starter/memory/00-global/context-policy.md +89 -0
- package/boilerplates/04-microservices-starter/memory/00-global/index.md +102 -0
- package/boilerplates/04-microservices-starter/memory/00-global/mission.md +44 -0
- package/boilerplates/04-microservices-starter/memory/00-global/patterns.md +106 -0
- package/boilerplates/04-microservices-starter/memory/10-product/vision.md +76 -0
- package/boilerplates/04-microservices-starter/memory/20-architecture/overview.md +247 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/auth-service/api.md +293 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/auth-service/context.md +108 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/notification-service/api.md +333 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/notification-service/context.md +121 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/user-service/api.md +308 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/user-service/context.md +120 -0
- package/boilerplates/04-microservices-starter/memory/40-delivery/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/50-orchestration/topology.md +216 -0
- package/boilerplates/04-microservices-starter/memory/60-runs/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/70-summaries/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/80-data/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/90-decisions/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/package.json +21 -0
- package/boilerplates/05-monorepo-starter/.env.example +1 -0
- package/boilerplates/05-monorepo-starter/BOILERPLATE_SUMMARY.md +193 -0
- package/boilerplates/05-monorepo-starter/DEVELOPMENT.md +481 -0
- package/boilerplates/05-monorepo-starter/Dockerfile +35 -0
- package/boilerplates/05-monorepo-starter/README.md +318 -0
- package/boilerplates/05-monorepo-starter/boilerplate.manifest.json +43 -0
- package/boilerplates/05-monorepo-starter/docker-compose.yml +36 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/agent-contract.md +28 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/context-policy.md +21 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/index.md +44 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/mission.md +17 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/patterns.md +48 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/business-rules.md +24 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/nfrs.md +39 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/personas.md +25 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/vision.md +22 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/backend.md +85 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/data.md +66 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/frontend.md +58 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/overview.md +86 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/security.md +58 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/order/api.md +81 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/order/context.md +63 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/product/api.md +81 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/product/context.md +56 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/user/api.md +99 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/user/context.md +58 -0
- package/boilerplates/05-monorepo-starter/memory/40-delivery/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/50-orchestration/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/60-runs/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/70-summaries/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/80-data/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/90-decisions/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/package.json +30 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/.env.example +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/README.md +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/package.json +53 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/app.module.ts +40 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/exceptions/global.exception.ts +32 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/guards/jwt.guard.ts +5 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/guards/jwt.strategy.ts +11 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/guards/roles.guard.ts +17 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/health.controller.ts +13 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/main.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/dto/index.ts +23 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/entities/order.entity.ts +48 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/orders.controller.ts +51 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/orders.module.ts +13 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/orders.service.ts +123 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/dto/index.ts +35 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/entities/product.entity.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/products.controller.ts +49 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/products.module.ts +12 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/products.service.ts +79 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/dto/index.ts +24 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/entities/user.entity.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/users.controller.ts +29 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/users.module.ts +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/users.service.ts +78 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/tsconfig.json +25 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/.env.example +1 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/README.md +30 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/dashboard/page.tsx +39 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/layout.tsx +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/page.tsx +47 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/products/page.tsx +51 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/features/product-card.tsx +19 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/layout/footer.tsx +10 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/layout/header.tsx +24 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/layout/layout.tsx +13 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/api-client.ts +34 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/auth.ts +35 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/orders.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/products.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/next.config.js +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/package.json +31 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/postcss.config.js +3 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/styles/globals.css +7 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/tailwind.config.js +7 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/tsconfig.json +14 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/README.md +35 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/package.json +17 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/common.ts +18 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/order.ts +38 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/product.ts +33 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/user.ts +32 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/domain/index.ts +41 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/errors/index.ts +46 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/index.ts +7 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/tsconfig.json +8 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/README.md +30 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/package.json +17 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/constants/index.ts +45 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/index.ts +4 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/utils/index.ts +3 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/utils/math.ts +30 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/utils/string.ts +48 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/validators/index.ts +44 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/tsconfig.json +8 -0
- package/boilerplates/05-monorepo-starter/tsconfig.json +23 -0
- package/boilerplates/05-monorepo-starter/turbo.json +35 -0
- package/boilerplates/README.md +407 -0
- package/design-md/BRIEF-TEMPLATE.md +47 -0
- package/design-md/INDEX.md +35 -0
- package/design-md/MATRIX.md +24 -0
- package/design-md/PLAYBOOK.md +35 -0
- package/design-md/examples/agent-console-brief.md +48 -0
- package/docs/GUIA-ONBOARDING-EXECUTIVO.md +63 -0
- package/docs/GUIA-ONBOARDING-OPERACIONAL-PAPEIS.md +136 -0
- package/docs/GUIA-ONBOARDING-PROJETO.md +279 -0
- package/docs/agent-harnesses.md +122 -0
- package/docs/archive/CHECKLIST-FINAL.md +295 -0
- package/docs/archive/FASE2-SUMMARY.md +263 -0
- package/docs/archive/FASE3-PROGRESS.md +355 -0
- package/docs/archive/IMPLEMENTACAO-FASE1.md +476 -0
- package/docs/archive/INDICE-MASTER.md +282 -0
- package/docs/archive/PROJETO-COMPLETO.md +363 -0
- package/docs/archive/README-REFINAMENTO.md +293 -0
- package/docs/archive/REFERENCIA-RAPIDA.md +324 -0
- package/docs/archive/REFINAMENTO-v1.0.md +565 -0
- package/docs/archive/RELATORIO-TESTES-INTEGRACAO.md +223 -0
- package/docs/archive/START-HERE.md +319 -0
- package/docs/archive/SUMARIO-EXECUTIVO.md +268 -0
- package/docs/archive/examples/v1/AGENTS.md +10 -0
- package/docs/archive/examples/v1/README.md +36 -0
- package/docs/archive/examples/v1/backend/jest-e2e.json +9 -0
- package/docs/archive/examples/v1/backend/nest-cli.json +4 -0
- package/docs/archive/examples/v1/backend/package.json +42 -0
- package/docs/archive/examples/v1/backend/src/app.controller.ts +12 -0
- package/docs/archive/examples/v1/backend/src/app.module.ts +10 -0
- package/docs/archive/examples/v1/backend/src/app.service.ts +8 -0
- package/docs/archive/examples/v1/backend/src/main.ts +10 -0
- package/docs/archive/examples/v1/backend/test/app.e2e-spec.ts +24 -0
- package/docs/archive/examples/v1/backend/tsconfig.build.json +4 -0
- package/docs/archive/examples/v1/backend/tsconfig.json +17 -0
- package/docs/archive/examples/v1/docs/.gitkeep +0 -0
- package/docs/archive/examples/v1/memory/00-global/glossary.md +5 -0
- package/docs/archive/examples/v1/memory/00-global/mission.md +9 -0
- package/docs/archive/examples/v1/memory/00-global/standards.md +12 -0
- package/docs/archive/examples/v1/memory/00-global/tooling.md +10 -0
- package/docs/archive/examples/v1/memory/10-product/business-rules.md +3 -0
- package/docs/archive/examples/v1/memory/10-product/nfrs.md +6 -0
- package/docs/archive/examples/v1/memory/10-product/personas.md +3 -0
- package/docs/archive/examples/v1/memory/10-product/vision.md +3 -0
- package/docs/archive/examples/v1/memory/20-architecture/backend.md +10 -0
- package/docs/archive/examples/v1/memory/20-architecture/data.md +3 -0
- package/docs/archive/examples/v1/memory/20-architecture/frontend.md +3 -0
- package/docs/archive/examples/v1/memory/20-architecture/observability.md +5 -0
- package/docs/archive/examples/v1/memory/20-architecture/security.md +6 -0
- package/docs/archive/examples/v1/memory/20-architecture/system-overview.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/auth/api.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/auth/context.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/auth/rules.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/billing/api.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/billing/context.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/billing/rules.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/shared/.gitkeep +0 -0
- package/docs/archive/examples/v1/memory/40-delivery/backlog.md +3 -0
- package/docs/archive/examples/v1/memory/40-delivery/current-sprint.md +10 -0
- package/docs/archive/examples/v1/memory/40-delivery/roadmap.md +3 -0
- package/docs/archive/examples/v1/memory/90-decisions/ADR-0001-template.md +9 -0
- package/docs/archive/examples/v1/memory/90-decisions/archive/.gitkeep +0 -0
- package/docs/archive/examples/v1/prompts/project-prompt-base.md +19 -0
- package/docs/archive/examples/v1/scripts/.gitkeep +0 -0
- package/docs/archive/examples/v2/.memoryrc.json +8 -0
- package/docs/archive/examples/v2/AGENTS.md +16 -0
- package/docs/archive/examples/v2/README.md +35 -0
- package/docs/archive/examples/v2/agents/README.md +3 -0
- package/docs/archive/examples/v2/agents/backend-nest.md +9 -0
- package/docs/archive/examples/v2/agents/dba.md +4 -0
- package/docs/archive/examples/v2/agents/frontend.md +4 -0
- package/docs/archive/examples/v2/agents/orchestrator.md +9 -0
- package/docs/archive/examples/v2/agents/reviewer.md +6 -0
- package/docs/archive/examples/v2/agents/security.md +4 -0
- package/docs/archive/examples/v2/backend/jest-e2e.json +9 -0
- package/docs/archive/examples/v2/backend/nest-cli.json +4 -0
- package/docs/archive/examples/v2/backend/package.json +42 -0
- package/docs/archive/examples/v2/backend/src/app.controller.ts +12 -0
- package/docs/archive/examples/v2/backend/src/app.module.ts +10 -0
- package/docs/archive/examples/v2/backend/src/app.service.ts +8 -0
- package/docs/archive/examples/v2/backend/src/main.ts +10 -0
- package/docs/archive/examples/v2/backend/test/app.e2e-spec.ts +24 -0
- package/docs/archive/examples/v2/backend/tsconfig.build.json +4 -0
- package/docs/archive/examples/v2/backend/tsconfig.json +17 -0
- package/docs/archive/examples/v2/docs/.gitkeep +0 -0
- package/docs/archive/examples/v2/memory/00-global/agent-contract.md +15 -0
- package/docs/archive/examples/v2/memory/00-global/context-index.md +12 -0
- package/docs/archive/examples/v2/memory/00-global/context-policy.md +14 -0
- package/docs/archive/examples/v2/memory/00-global/mission.md +9 -0
- package/docs/archive/examples/v2/memory/00-global/standards.md +12 -0
- package/docs/archive/examples/v2/memory/10-product/business-rules.md +3 -0
- package/docs/archive/examples/v2/memory/10-product/nfrs.md +6 -0
- package/docs/archive/examples/v2/memory/10-product/personas.md +3 -0
- package/docs/archive/examples/v2/memory/10-product/vision.md +3 -0
- package/docs/archive/examples/v2/memory/20-architecture/backend.md +10 -0
- package/docs/archive/examples/v2/memory/20-architecture/data.md +3 -0
- package/docs/archive/examples/v2/memory/20-architecture/frontend.md +3 -0
- package/docs/archive/examples/v2/memory/20-architecture/observability.md +5 -0
- package/docs/archive/examples/v2/memory/20-architecture/security.md +6 -0
- package/docs/archive/examples/v2/memory/20-architecture/system-overview.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/auth/api.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/auth/context.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/auth/rules.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/billing/api.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/billing/context.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/billing/rules.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/shared/.gitkeep +0 -0
- package/docs/archive/examples/v2/memory/40-delivery/backlog.md +3 -0
- package/docs/archive/examples/v2/memory/40-delivery/current-sprint.md +10 -0
- package/docs/archive/examples/v2/memory/40-delivery/roadmap.md +3 -0
- package/docs/archive/examples/v2/memory/50-orchestration/handoff-protocol.md +8 -0
- package/docs/archive/examples/v2/memory/50-orchestration/handoffs/2026-04-18T18-40-10.517Z_orchestrator_para_backend-nest.md +19 -0
- package/docs/archive/examples/v2/memory/50-orchestration/handoffs/README.md +4 -0
- package/docs/archive/examples/v2/memory/50-orchestration/parallel-playbook.md +9 -0
- package/docs/archive/examples/v2/memory/50-orchestration/routing.md +10 -0
- package/docs/archive/examples/v2/memory/50-orchestration/topology.md +15 -0
- package/docs/archive/examples/v2/memory/60-runs/README.md +3 -0
- package/docs/archive/examples/v2/memory/70-summaries/domain-summary.md +3 -0
- package/docs/archive/examples/v2/memory/70-summaries/global-summary.md +6 -0
- package/docs/archive/examples/v2/memory/90-decisions/ADR-0001-template.md +9 -0
- package/docs/archive/examples/v2/memory/90-decisions/archive/.gitkeep +0 -0
- package/docs/archive/examples/v2/memory/README.md +8 -0
- package/docs/archive/examples/v2/prompts/multi-agent-orchestrator.md +12 -0
- package/docs/archive/examples/v2/prompts/project-prompt-base.md +21 -0
- package/docs/archive/examples/v2/prompts/worker-task-template.md +10 -0
- package/docs/archive/examples/v2/scripts/.gitkeep +0 -0
- package/docs/archive/examples/v2/scripts/append-handoff.mjs +25 -0
- package/docs/archive/examples/v2/scripts/build-context-pack.mjs +31 -0
- package/docs/archive/examples/v2/skills/context-compaction/SKILL.md +9 -0
- package/docs/archive/examples/v2/skills/handoff/SKILL.md +8 -0
- package/docs/archive/examples/v2/skills/nest-api/SKILL.md +7 -0
- package/docs/archive/examples/v2/skills/triage-task/SKILL.md +10 -0
- package/docs/archive/legacy-bin/create-memory-nest-kit-monolith.js +1486 -0
- package/docs/capacidades-externas.md +70 -0
- package/docs/cli-first-operacao.md +74 -0
- package/docs/dashboard.md +102 -0
- package/docs/dev-workflow.md +421 -0
- package/docs/examples.md +546 -0
- package/docs/fluxo.md +103 -0
- package/docs/glossary.md +453 -0
- package/docs/init-project.md +457 -0
- package/docs/manual-operacional-cli-sdd-gsd.md +1014 -0
- package/docs/personas/architect/README.md +333 -0
- package/docs/personas/developer/README.md +371 -0
- package/docs/personas/executive/README.md +172 -0
- package/docs/personas/qa/README.md +350 -0
- package/docs/processo-projeto.md +138 -0
- package/docs/publishing.md +377 -0
- package/docs/quick-reference.md +409 -0
- package/docs/structure.md +360 -0
- package/docs/token-optimization.md +494 -0
- package/lib/context-builder.js +257 -0
- package/lib/core/registry.mjs +284 -0
- package/lib/generators/memory-generator.js +844 -0
- package/lib/generators/nest-generator.js +496 -0
- package/lib/generators/readme-generator.js +213 -0
- package/lib/templates/harness/code-intel.mjs +119 -0
- package/lib/templates/harness/mcp.json +10 -0
- package/lib/utils/file-helpers.js +40 -0
- package/lib/validators/structure-validator.js +253 -0
- package/lib/workspace.mjs +213 -0
- package/memory/00-global/mission.md +15 -0
- package/memory/00-global/shared-knowledge.md +8 -0
- package/memory/00-global/standards.md +47 -0
- package/memory/10-product/personas.md +21 -0
- package/memory/10-product/vision.md +27 -0
- package/memory/30-projects/README.md +15 -0
- package/memory/40-delivery/backlog.md +15 -0
- package/memory/40-delivery/current-sprint.md +21 -0
- package/memory/50-orchestration/gsd-harness.md +55 -0
- package/memory/90-decisions/0001-memoria-hierarquica.md +38 -0
- package/memory/90-decisions/0002-sqlite-fts5-busca.md +25 -0
- package/memory/90-decisions/0003-smart-context-3-modos.md +31 -0
- package/memory/90-decisions/0004-validacao-obrigatoria-nest.md +27 -0
- package/memory/90-decisions/0005-handoff-7-campos.md +32 -0
- package/memory/90-decisions/0006-docs-por-persona.md +23 -0
- package/memory/90-decisions/0007-sdd-pipeline.md +33 -0
- package/memory/90-decisions/0008-sub-agents-claude-handoff-sqlite.md +36 -0
- package/memory/90-decisions/0009-claude-hooks-token-economy.md +43 -0
- package/memory/90-decisions/0010-banco-postgres.md +30 -0
- package/memory/90-decisions/0011-adrs-de-produto-realocadas.md +19 -0
- package/memory/90-decisions/0016-integracao-capacidades-externas.md +64 -0
- package/memory/90-decisions/0017-codegraph-no-harness-gsd.md +40 -0
- package/memory/90-decisions/0018-ferramentas-de-processo.md +46 -0
- package/memory/90-decisions/0019-workspace-separado.md +45 -0
- package/memory/90-decisions/0020-forja-core-cli-unica.md +45 -0
- package/memory/90-decisions/_template.md +28 -0
- package/package.json +107 -0
- package/prompts/context-engineer-agent.md +19 -0
- package/prompts/governance-agent.md +15 -0
- package/prompts/marketing-agent.md +13 -0
- package/prompts/orchestrator-agent.md +18 -0
- package/prompts/product-agent.md +13 -0
- package/prompts/sdd-architect-agent.md +20 -0
- package/scripts/agent-harness.mjs +578 -0
- package/scripts/agent-router.mjs +189 -0
- package/scripts/build-smart-context.js +87 -0
- package/scripts/check-standards.js +98 -0
- package/scripts/compress-memory.mjs +198 -0
- package/scripts/compress-project-memory.js +58 -0
- package/scripts/context-ops.mjs +463 -0
- package/scripts/dev.mjs +349 -0
- package/scripts/extract-global-knowledge.js +52 -0
- package/scripts/generate-dashboard.js +59 -0
- package/scripts/hook-session-start.mjs +70 -0
- package/scripts/hook-user-prompt.mjs +185 -0
- package/scripts/memory-schema.mjs +68 -0
- package/scripts/pre-commit.sh +102 -0
- package/scripts/query-universal-memory.js +50 -0
- package/scripts/spec-cli.mjs +193 -0
- package/scripts/sprint-manager.js +200 -0
- package/scripts/sync-universal-memory.js +278 -0
- package/scripts/token-benchmark.mjs +203 -0
- package/scripts/tools-doctor.mjs +77 -0
- package/specs/README.md +70 -0
- package/specs/_templates/plan.md +43 -0
- package/specs/_templates/spec.md +43 -0
- package/specs/_templates/tasks.md +32 -0
- package/specs/agent-dashboard/plan.md +165 -0
- package/specs/agent-dashboard/spec.md +89 -0
- package/specs/agent-dashboard/tasks.md +168 -0
- package/specs/cli-first-operacao/plan.md +53 -0
- package/specs/cli-first-operacao/spec.md +53 -0
- package/specs/cli-first-operacao/tasks.md +53 -0
- package/specs/dev-token-assets-db/plan.md +71 -0
- package/specs/dev-token-assets-db/spec.md +58 -0
- package/specs/dev-token-assets-db/tasks.md +58 -0
- package/specs/forja-core/spec.md +71 -0
- package/specs/harness-codegraph/spec.md +71 -0
- package/specs/pipeline-sdd-e-orquestracao/spec.md +61 -0
- package/specs/reestruturacao-forja-v2/plan.md +95 -0
- package/specs/reestruturacao-forja-v2/spec.md +70 -0
- package/specs/reestruturacao-forja-v2/tasks.md +113 -0
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Backend Architecture (NestJS)
|
|
2
|
+
|
|
3
|
+
## Directory Structure
|
|
4
|
+
```
|
|
5
|
+
apps/backend/
|
|
6
|
+
├── src/
|
|
7
|
+
│ ├── main.ts # Entry point
|
|
8
|
+
│ ├── app.module.ts # Root module
|
|
9
|
+
│ ├── common/
|
|
10
|
+
│ │ ├── guards/ # JWT, role guards
|
|
11
|
+
│ │ ├── interceptors/ # Response formatting
|
|
12
|
+
│ │ └── pipes/ # Validation pipes
|
|
13
|
+
│ ├── modules/
|
|
14
|
+
│ │ ├── users/
|
|
15
|
+
│ │ │ ├── users.controller.ts
|
|
16
|
+
│ │ │ ├── users.service.ts
|
|
17
|
+
│ │ │ ├── users.module.ts
|
|
18
|
+
│ │ │ ├── entities/user.entity.ts
|
|
19
|
+
│ │ │ └── dto/
|
|
20
|
+
│ │ ├── products/
|
|
21
|
+
│ │ │ └── (similar structure)
|
|
22
|
+
│ │ └── orders/
|
|
23
|
+
│ │ └── (similar structure)
|
|
24
|
+
│ ├── database/
|
|
25
|
+
│ │ ├── migrations/ # TypeORM migrations
|
|
26
|
+
│ │ └── config/ # Connection config
|
|
27
|
+
│ └── config/ # App configuration
|
|
28
|
+
├── test/
|
|
29
|
+
│ ├── unit/ # Unit tests
|
|
30
|
+
│ └── integration/ # Integration tests
|
|
31
|
+
├── .env.example
|
|
32
|
+
├── ormconfig.ts # TypeORM config
|
|
33
|
+
├── tsconfig.json
|
|
34
|
+
└── package.json
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Module Pattern
|
|
38
|
+
```typescript
|
|
39
|
+
// users.module.ts
|
|
40
|
+
@Module({
|
|
41
|
+
imports: [TypeOrmModule.forFeature([User])],
|
|
42
|
+
controllers: [UsersController],
|
|
43
|
+
providers: [UsersService],
|
|
44
|
+
})
|
|
45
|
+
export class UsersModule {}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Key Features
|
|
49
|
+
- **JWT Authentication**: Passport + JWT strategy
|
|
50
|
+
- **TypeORM**: Strongly-typed ORM
|
|
51
|
+
- **Validation**: class-validator DTOs
|
|
52
|
+
- **Error Handling**: Global exception filter
|
|
53
|
+
- **Logging**: Built-in NestJS logger
|
|
54
|
+
|
|
55
|
+
## API Endpoints
|
|
56
|
+
|
|
57
|
+
### Users
|
|
58
|
+
- `POST /api/users/register` — Create user
|
|
59
|
+
- `POST /api/users/login` — Login
|
|
60
|
+
- `GET /api/users/:id` — Get user profile
|
|
61
|
+
|
|
62
|
+
### Products
|
|
63
|
+
- `GET /api/products` — List products (paginated)
|
|
64
|
+
- `GET /api/products/:id` — Get product details
|
|
65
|
+
- `POST /api/products` — Create (admin only)
|
|
66
|
+
|
|
67
|
+
### Orders
|
|
68
|
+
- `POST /api/orders` — Create order
|
|
69
|
+
- `GET /api/orders/:id` — Get order details
|
|
70
|
+
- `GET /api/orders` — List user's orders
|
|
71
|
+
|
|
72
|
+
## Response Format
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"success": true,
|
|
76
|
+
"data": { ... },
|
|
77
|
+
"message": "Success"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Error Handling
|
|
82
|
+
```typescript
|
|
83
|
+
throw new NotFoundException('Product not found');
|
|
84
|
+
// Response: { statusCode: 404, message: 'Product not found' }
|
|
85
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Data Architecture
|
|
2
|
+
|
|
3
|
+
## Database Schema
|
|
4
|
+
|
|
5
|
+
### Users Table
|
|
6
|
+
```sql
|
|
7
|
+
CREATE TABLE users (
|
|
8
|
+
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
9
|
+
email VARCHAR(255) UNIQUE NOT NULL,
|
|
10
|
+
password_hash VARCHAR(255) NOT NULL,
|
|
11
|
+
first_name VARCHAR(100),
|
|
12
|
+
last_name VARCHAR(100),
|
|
13
|
+
role ENUM('user', 'admin') DEFAULT 'user',
|
|
14
|
+
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
|
15
|
+
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
|
16
|
+
);
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Products Table
|
|
20
|
+
```sql
|
|
21
|
+
CREATE TABLE products (
|
|
22
|
+
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
23
|
+
sku VARCHAR(50) UNIQUE NOT NULL,
|
|
24
|
+
name VARCHAR(255) NOT NULL,
|
|
25
|
+
description TEXT,
|
|
26
|
+
price DECIMAL(10, 2) NOT NULL,
|
|
27
|
+
stock_quantity INT DEFAULT 0,
|
|
28
|
+
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
|
29
|
+
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Orders Table
|
|
34
|
+
```sql
|
|
35
|
+
CREATE TABLE orders (
|
|
36
|
+
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
37
|
+
user_id UUID NOT NULL REFERENCES users(id),
|
|
38
|
+
status ENUM('pending', 'processing', 'shipped', 'delivered') DEFAULT 'pending',
|
|
39
|
+
total_amount DECIMAL(10, 2) NOT NULL,
|
|
40
|
+
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
|
41
|
+
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
|
42
|
+
);
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Order Items Table
|
|
46
|
+
```sql
|
|
47
|
+
CREATE TABLE order_items (
|
|
48
|
+
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
49
|
+
order_id UUID NOT NULL REFERENCES orders(id),
|
|
50
|
+
product_id UUID NOT NULL REFERENCES products(id),
|
|
51
|
+
quantity INT NOT NULL,
|
|
52
|
+
unit_price DECIMAL(10, 2) NOT NULL,
|
|
53
|
+
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
|
|
54
|
+
);
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Indexes
|
|
58
|
+
- `users.email` — UNIQUE (fast login)
|
|
59
|
+
- `products.sku` — UNIQUE (fast lookup)
|
|
60
|
+
- `orders.user_id` — (fast order history)
|
|
61
|
+
- `order_items.order_id` — (fast order details)
|
|
62
|
+
|
|
63
|
+
## Caching Strategy
|
|
64
|
+
- Redis TTL: 5 minutes for product catalog
|
|
65
|
+
- Cache invalidation: On product create/update
|
|
66
|
+
- Session tokens: Cached with expiry
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Frontend Architecture (Next.js)
|
|
2
|
+
|
|
3
|
+
## Directory Structure
|
|
4
|
+
```
|
|
5
|
+
apps/frontend/
|
|
6
|
+
├── app/ # Next.js 14 App Router
|
|
7
|
+
│ ├── layout.tsx # Root layout
|
|
8
|
+
│ ├── page.tsx # Home page
|
|
9
|
+
│ ├── products/ # Products page
|
|
10
|
+
│ └── dashboard/ # Admin dashboard
|
|
11
|
+
├── components/
|
|
12
|
+
│ ├── ui/ # Reusable UI components
|
|
13
|
+
│ ├── features/ # Feature-specific components
|
|
14
|
+
│ └── layout/ # Header, footer, sidebar
|
|
15
|
+
├── lib/
|
|
16
|
+
│ ├── api-client.ts # Axios instance
|
|
17
|
+
│ ├── hooks/ # Custom React hooks
|
|
18
|
+
│ └── utils/ # Helper functions
|
|
19
|
+
├── public/ # Static assets
|
|
20
|
+
├── styles/ # Global CSS
|
|
21
|
+
├── .env.local # Local environment variables
|
|
22
|
+
├── next.config.js # Next.js config
|
|
23
|
+
├── tsconfig.json # TypeScript config
|
|
24
|
+
└── package.json
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Key Features
|
|
28
|
+
- **Server Components**: Use by default for performance
|
|
29
|
+
- **API Routes**: Not used (Backend is separate NestJS)
|
|
30
|
+
- **Image Optimization**: Next.js Image component
|
|
31
|
+
- **Styling**: Tailwind CSS + CSS Modules
|
|
32
|
+
|
|
33
|
+
## API Communication
|
|
34
|
+
```typescript
|
|
35
|
+
// lib/api-client.ts
|
|
36
|
+
export const apiClient = axios.create({
|
|
37
|
+
baseURL: process.env.NEXT_PUBLIC_API_URL || 'http://localhost:3001/api',
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
// Auto-attach JWT token to requests
|
|
41
|
+
apiClient.interceptors.request.use((config) => {
|
|
42
|
+
const token = localStorage.getItem('jwt');
|
|
43
|
+
if (token) {
|
|
44
|
+
config.headers.Authorization = `Bearer ${token}`;
|
|
45
|
+
}
|
|
46
|
+
return config;
|
|
47
|
+
});
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Pages
|
|
51
|
+
1. **Home** (`/`) — Landing page with featured products
|
|
52
|
+
2. **Products** (`/products`) — Product catalog with filtering
|
|
53
|
+
3. **Dashboard** (`/dashboard`) — Admin analytics (admin-only)
|
|
54
|
+
|
|
55
|
+
## State Management
|
|
56
|
+
- React Context for auth state
|
|
57
|
+
- useQuery (React Query) for API data fetching
|
|
58
|
+
- localStorage for JWT token persistence
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# Architecture Overview
|
|
2
|
+
|
|
3
|
+
## Tech Stack
|
|
4
|
+
|
|
5
|
+
### Frontend
|
|
6
|
+
- **Framework**: Next.js 14+ (React 18+)
|
|
7
|
+
- **Language**: TypeScript
|
|
8
|
+
- **Styling**: Tailwind CSS
|
|
9
|
+
- **State**: React hooks + Context API
|
|
10
|
+
- **HTTP Client**: Axios
|
|
11
|
+
- **UI Components**: shadcn/ui
|
|
12
|
+
|
|
13
|
+
### Backend
|
|
14
|
+
- **Framework**: NestJS 10+
|
|
15
|
+
- **Language**: TypeScript
|
|
16
|
+
- **ORM**: TypeORM
|
|
17
|
+
- **Database**: PostgreSQL
|
|
18
|
+
- **Cache**: Redis
|
|
19
|
+
- **Auth**: JWT + Passport
|
|
20
|
+
|
|
21
|
+
### Shared
|
|
22
|
+
- **Shared Types**: TypeScript interfaces (no dependencies)
|
|
23
|
+
- **Shared Utils**: Helpers, validators, constants
|
|
24
|
+
|
|
25
|
+
### DevOps
|
|
26
|
+
- **Build System**: Turborepo
|
|
27
|
+
- **Containerization**: Docker
|
|
28
|
+
- **Orchestration**: Docker Compose
|
|
29
|
+
- **CI/CD**: GitHub Actions ready
|
|
30
|
+
|
|
31
|
+
## Architecture Diagram
|
|
32
|
+
```
|
|
33
|
+
┌─────────────────┐
|
|
34
|
+
│ Browser │
|
|
35
|
+
└────────┬────────┘
|
|
36
|
+
│ HTTP/HTTPS
|
|
37
|
+
┌────────▼────────────────────────┐
|
|
38
|
+
│ Next.js Frontend (Port 3000) │
|
|
39
|
+
├──────────────────────────────────┤
|
|
40
|
+
│ • Pages (App Router) │
|
|
41
|
+
│ • Components │
|
|
42
|
+
│ • API Client │
|
|
43
|
+
│ • Auth (JWT in localStorage) │
|
|
44
|
+
└────────┬────────────────────────┘
|
|
45
|
+
│ API calls
|
|
46
|
+
┌────────▼────────────────────────┐
|
|
47
|
+
│ NestJS Backend (Port 3001) │
|
|
48
|
+
├──────────────────────────────────┤
|
|
49
|
+
│ • Controllers │
|
|
50
|
+
│ • Services (business logic) │
|
|
51
|
+
│ • Guards (JWT validation) │
|
|
52
|
+
│ • TypeORM Entities │
|
|
53
|
+
└────────┬────────────────────────┘
|
|
54
|
+
│ SQL
|
|
55
|
+
┌────────▼────────────────────────┐
|
|
56
|
+
│ PostgreSQL (Port 5432) │
|
|
57
|
+
│ + Redis (Port 6379) │
|
|
58
|
+
└─────────────────────────────────┘
|
|
59
|
+
|
|
60
|
+
Shared:
|
|
61
|
+
┌─────────────────────────────────┐
|
|
62
|
+
│ shared-types (API contracts) │
|
|
63
|
+
│ shared-utils (utilities) │
|
|
64
|
+
└─────────────────────────────────┘
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Monorepo Structure
|
|
68
|
+
```
|
|
69
|
+
packages/
|
|
70
|
+
├── apps/
|
|
71
|
+
│ ├── frontend/ # Next.js 14
|
|
72
|
+
│ └── backend/ # NestJS 10
|
|
73
|
+
└── packages/
|
|
74
|
+
├── shared-types/ # DTOs, interfaces
|
|
75
|
+
└── shared-utils/ # Helpers, constants
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Build Pipeline
|
|
79
|
+
```
|
|
80
|
+
npm run build
|
|
81
|
+
├── shared-types (no dependencies)
|
|
82
|
+
├── shared-utils (depends on shared-types)
|
|
83
|
+
├── frontend (depends on shared-types, shared-utils)
|
|
84
|
+
└── backend (depends on shared-types, shared-utils)
|
|
85
|
+
```
|
|
86
|
+
Turborepo executes in parallel where possible.
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Security Architecture
|
|
2
|
+
|
|
3
|
+
## Authentication Flow
|
|
4
|
+
```
|
|
5
|
+
1. User enters credentials (frontend)
|
|
6
|
+
2. Frontend POST /api/users/login
|
|
7
|
+
3. Backend verifies password, generates JWT
|
|
8
|
+
4. Frontend stores JWT in localStorage
|
|
9
|
+
5. Frontend sends JWT in Authorization header (Bearer token)
|
|
10
|
+
6. Backend JwtGuard validates token in protected routes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## JWT Implementation
|
|
14
|
+
- Algorithm: HS256
|
|
15
|
+
- Expiry: 24 hours
|
|
16
|
+
- Refresh tokens: 7 days (stored in httpOnly cookie if SSR needed)
|
|
17
|
+
- Secret: From environment variable (never commit)
|
|
18
|
+
|
|
19
|
+
## Password Security
|
|
20
|
+
- Hashing: bcrypt with 10+ rounds
|
|
21
|
+
- Never store plaintext passwords
|
|
22
|
+
- Password reset via email token (5 min expiry)
|
|
23
|
+
|
|
24
|
+
## API Security
|
|
25
|
+
|
|
26
|
+
### CORS
|
|
27
|
+
```typescript
|
|
28
|
+
CorsModule.register({
|
|
29
|
+
origin: process.env.CORS_ORIGINS?.split(',') || ['http://localhost:3000'],
|
|
30
|
+
credentials: true,
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Rate Limiting
|
|
35
|
+
- 100 requests/minute per IP
|
|
36
|
+
- 10 login attempts/5 minutes
|
|
37
|
+
- Implemented via nestjs-throttler
|
|
38
|
+
|
|
39
|
+
### Input Validation
|
|
40
|
+
- All DTOs validated with class-validator
|
|
41
|
+
- SQL injection prevention via parameterized queries (TypeORM)
|
|
42
|
+
- XSS prevention: React auto-escapes, but sanitize user content
|
|
43
|
+
|
|
44
|
+
### HTTPS
|
|
45
|
+
- Enforced in production
|
|
46
|
+
- Redirect HTTP → HTTPS
|
|
47
|
+
- HSTS headers enabled
|
|
48
|
+
|
|
49
|
+
## Authorization
|
|
50
|
+
- Role-based access control (RBAC)
|
|
51
|
+
- JwtGuard → RolesGuard for protected endpoints
|
|
52
|
+
- Admin endpoints check role === 'admin'
|
|
53
|
+
|
|
54
|
+
## Secrets Management
|
|
55
|
+
- Never commit `.env` files
|
|
56
|
+
- Use `.env.example` for documentation
|
|
57
|
+
- Environment variables loaded at startup
|
|
58
|
+
- Secrets stored in CI/CD secrets (GitHub Actions)
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Order API Endpoints
|
|
2
|
+
|
|
3
|
+
## Protected Endpoints (Requires JWT)
|
|
4
|
+
|
|
5
|
+
### Create Order
|
|
6
|
+
```
|
|
7
|
+
POST /api/orders
|
|
8
|
+
Authorization: Bearer <token>
|
|
9
|
+
Content-Type: application/json
|
|
10
|
+
|
|
11
|
+
{
|
|
12
|
+
"items": [
|
|
13
|
+
{ "productId": "uuid1", "quantity": 2 },
|
|
14
|
+
{ "productId": "uuid2", "quantity": 1 }
|
|
15
|
+
],
|
|
16
|
+
"shippingAddress": "123 Main St, City, State 12345"
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
Response: 201 Created
|
|
20
|
+
{
|
|
21
|
+
"success": true,
|
|
22
|
+
"data": { ...OrderResponse }
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Get Order Details
|
|
27
|
+
```
|
|
28
|
+
GET /api/orders/:id
|
|
29
|
+
Authorization: Bearer <token>
|
|
30
|
+
|
|
31
|
+
Response: 200 OK
|
|
32
|
+
{
|
|
33
|
+
"success": true,
|
|
34
|
+
"data": { ...OrderResponse }
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### List User's Orders
|
|
39
|
+
```
|
|
40
|
+
GET /api/orders?page=1&limit=10
|
|
41
|
+
Authorization: Bearer <token>
|
|
42
|
+
|
|
43
|
+
Response: 200 OK
|
|
44
|
+
{
|
|
45
|
+
"success": true,
|
|
46
|
+
"data": {
|
|
47
|
+
"orders": [...OrderResponse[]],
|
|
48
|
+
"total": 5,
|
|
49
|
+
"page": 1
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Update Order Status (Admin)
|
|
55
|
+
```
|
|
56
|
+
PATCH /api/orders/:id/status
|
|
57
|
+
Authorization: Bearer <admin_token>
|
|
58
|
+
Content-Type: application/json
|
|
59
|
+
|
|
60
|
+
{
|
|
61
|
+
"status": "shipped"
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
Response: 200 OK
|
|
65
|
+
{
|
|
66
|
+
"success": true,
|
|
67
|
+
"data": { ...OrderResponse }
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Cancel Order
|
|
72
|
+
```
|
|
73
|
+
DELETE /api/orders/:id
|
|
74
|
+
Authorization: Bearer <token>
|
|
75
|
+
|
|
76
|
+
Response: 200 OK
|
|
77
|
+
{
|
|
78
|
+
"success": true,
|
|
79
|
+
"message": "Order cancelled"
|
|
80
|
+
}
|
|
81
|
+
```
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Order Domain
|
|
2
|
+
|
|
3
|
+
## Domain Models
|
|
4
|
+
- **Order Entity** — Represents a customer purchase
|
|
5
|
+
- Fields: id, userId, status, totalAmount
|
|
6
|
+
- Constraints: totalAmount > 0, status in enum
|
|
7
|
+
- **OrderItem Entity** — Line items in order
|
|
8
|
+
- Fields: id, orderId, productId, quantity, unitPrice
|
|
9
|
+
|
|
10
|
+
## API Contracts (shared-types)
|
|
11
|
+
|
|
12
|
+
### OrderItemRequest
|
|
13
|
+
```typescript
|
|
14
|
+
{
|
|
15
|
+
productId: string;
|
|
16
|
+
quantity: number;
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### CreateOrderRequest
|
|
21
|
+
```typescript
|
|
22
|
+
{
|
|
23
|
+
items: OrderItemRequest[];
|
|
24
|
+
shippingAddress: string;
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### OrderResponse
|
|
29
|
+
```typescript
|
|
30
|
+
{
|
|
31
|
+
id: string;
|
|
32
|
+
userId: string;
|
|
33
|
+
status: 'pending' | 'processing' | 'shipped' | 'delivered';
|
|
34
|
+
totalAmount: number;
|
|
35
|
+
items: OrderItemResponse[];
|
|
36
|
+
createdAt: Date;
|
|
37
|
+
updatedAt: Date;
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### OrderItemResponse
|
|
42
|
+
```typescript
|
|
43
|
+
{
|
|
44
|
+
id: string;
|
|
45
|
+
orderId: string;
|
|
46
|
+
productId: string;
|
|
47
|
+
quantity: number;
|
|
48
|
+
unitPrice: number;
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Business Logic
|
|
53
|
+
- Orders can only be created by authenticated users
|
|
54
|
+
- Each item quantity must be available in stock
|
|
55
|
+
- Order status starts as 'pending'
|
|
56
|
+
- Status transitions: pending → processing → shipped → delivered
|
|
57
|
+
- Refunds allowed within 30 days
|
|
58
|
+
|
|
59
|
+
## Error Codes
|
|
60
|
+
- `PRODUCT_OUT_OF_STOCK` — Insufficient inventory
|
|
61
|
+
- `ORDER_NOT_FOUND` — Order doesn't exist
|
|
62
|
+
- `INVALID_ORDER_STATUS` — Can't transition to that status
|
|
63
|
+
- `UNAUTHORIZED_ORDER_ACCESS` — Not order owner
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Product API Endpoints
|
|
2
|
+
|
|
3
|
+
## Public Endpoints
|
|
4
|
+
|
|
5
|
+
### List Products
|
|
6
|
+
```
|
|
7
|
+
GET /api/products?page=1&limit=20
|
|
8
|
+
Optional: ?search=term&category=cat
|
|
9
|
+
|
|
10
|
+
Response: 200 OK
|
|
11
|
+
{
|
|
12
|
+
"success": true,
|
|
13
|
+
"data": {
|
|
14
|
+
"products": [...ProductResponse[]],
|
|
15
|
+
"total": 150,
|
|
16
|
+
"page": 1,
|
|
17
|
+
"limit": 20
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Get Product Details
|
|
23
|
+
```
|
|
24
|
+
GET /api/products/:id
|
|
25
|
+
|
|
26
|
+
Response: 200 OK
|
|
27
|
+
{
|
|
28
|
+
"success": true,
|
|
29
|
+
"data": { ...ProductResponse }
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Admin-Only Endpoints
|
|
34
|
+
|
|
35
|
+
### Create Product
|
|
36
|
+
```
|
|
37
|
+
POST /api/products
|
|
38
|
+
Authorization: Bearer <admin_token>
|
|
39
|
+
Content-Type: application/json
|
|
40
|
+
|
|
41
|
+
{
|
|
42
|
+
"sku": "PROD-001",
|
|
43
|
+
"name": "Widget",
|
|
44
|
+
"description": "A useful widget",
|
|
45
|
+
"price": 29.99,
|
|
46
|
+
"stockQuantity": 100
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
Response: 201 Created
|
|
50
|
+
{
|
|
51
|
+
"success": true,
|
|
52
|
+
"data": { ...ProductResponse }
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Update Product
|
|
57
|
+
```
|
|
58
|
+
PUT /api/products/:id
|
|
59
|
+
Authorization: Bearer <admin_token>
|
|
60
|
+
Content-Type: application/json
|
|
61
|
+
|
|
62
|
+
{
|
|
63
|
+
"name": "Updated Widget",
|
|
64
|
+
"price": 34.99,
|
|
65
|
+
"stockQuantity": 95
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
Response: 200 OK
|
|
69
|
+
{
|
|
70
|
+
"success": true,
|
|
71
|
+
"data": { ...ProductResponse }
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Delete Product
|
|
76
|
+
```
|
|
77
|
+
DELETE /api/products/:id
|
|
78
|
+
Authorization: Bearer <admin_token>
|
|
79
|
+
|
|
80
|
+
Response: 204 No Content
|
|
81
|
+
```
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Product Domain
|
|
2
|
+
|
|
3
|
+
## Domain Models
|
|
4
|
+
- **Product Entity** — Represents a product in catalog
|
|
5
|
+
- Fields: id, sku, name, description, price, stockQuantity
|
|
6
|
+
- Constraints: sku unique, price > 0
|
|
7
|
+
|
|
8
|
+
## API Contracts (shared-types)
|
|
9
|
+
|
|
10
|
+
### CreateProductRequest (Admin)
|
|
11
|
+
```typescript
|
|
12
|
+
{
|
|
13
|
+
sku: string;
|
|
14
|
+
name: string;
|
|
15
|
+
description: string;
|
|
16
|
+
price: number;
|
|
17
|
+
stockQuantity: number;
|
|
18
|
+
}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### ProductResponse
|
|
22
|
+
```typescript
|
|
23
|
+
{
|
|
24
|
+
id: string;
|
|
25
|
+
sku: string;
|
|
26
|
+
name: string;
|
|
27
|
+
description: string;
|
|
28
|
+
price: number;
|
|
29
|
+
stockQuantity: number;
|
|
30
|
+
createdAt: Date;
|
|
31
|
+
updatedAt: Date;
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### UpdateProductRequest (Admin)
|
|
36
|
+
```typescript
|
|
37
|
+
{
|
|
38
|
+
name?: string;
|
|
39
|
+
description?: string;
|
|
40
|
+
price?: number;
|
|
41
|
+
stockQuantity?: number;
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Business Logic
|
|
46
|
+
- Products can only be created by admins
|
|
47
|
+
- SKU must be globally unique
|
|
48
|
+
- Price and stock are always >= 0
|
|
49
|
+
- Products are soft-deleted (not removed from DB)
|
|
50
|
+
- Stock decreases when order is created
|
|
51
|
+
|
|
52
|
+
## Error Codes
|
|
53
|
+
- `PRODUCT_NOT_FOUND` — Product doesn't exist
|
|
54
|
+
- `SKU_ALREADY_EXISTS` — SKU taken
|
|
55
|
+
- `INSUFFICIENT_STOCK` — Not enough inventory
|
|
56
|
+
- `INVALID_PRICE` — Price must be positive
|