forjajs 5.0.1 → 5.3.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/CHANGELOG.md +114 -2
- package/README.md +40 -5
- package/README.pt-BR.md +42 -4
- package/boilerplates/02-saas-starter/README.md +58 -293
- package/boilerplates/02-saas-starter/backend/.env.example +13 -0
- package/boilerplates/02-saas-starter/backend/.oxlintrc.json +8 -0
- package/boilerplates/02-saas-starter/backend/nest-cli.json +6 -0
- package/boilerplates/02-saas-starter/backend/package.json +32 -73
- package/boilerplates/02-saas-starter/backend/src/app.module.ts +16 -16
- package/boilerplates/02-saas-starter/backend/src/billing/adapters/http/billing.controller.ts +55 -0
- package/boilerplates/02-saas-starter/backend/src/billing/adapters/persistence/orm-entities.ts +28 -0
- package/boilerplates/02-saas-starter/backend/src/billing/adapters/persistence/typeorm-billing.repository.ts +46 -0
- package/boilerplates/02-saas-starter/backend/src/billing/application/billing.service.spec.ts +58 -0
- package/boilerplates/02-saas-starter/backend/src/billing/application/billing.service.ts +68 -0
- package/boilerplates/02-saas-starter/backend/src/billing/billing.module.ts +11 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/plan.spec.ts +23 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/plan.ts +36 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/ports.ts +27 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/subscription.spec.ts +28 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/subscription.ts +47 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/http/auth.dto.ts +22 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/http/identity.controller.ts +59 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/persistence/orm-entities.ts +25 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/persistence/typeorm-identity.repository.ts +47 -0
- package/boilerplates/02-saas-starter/backend/src/identity/application/auth.service.spec.ts +72 -0
- package/boilerplates/02-saas-starter/backend/src/identity/application/auth.service.ts +63 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/model.spec.ts +19 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/model.ts +42 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/password.spec.ts +17 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/password.ts +26 -0
- package/boilerplates/02-saas-starter/backend/src/identity/identity.module.ts +12 -0
- package/boilerplates/02-saas-starter/backend/src/main.ts +19 -19
- package/boilerplates/02-saas-starter/backend/src/platform/auth/jwt-auth.guard.ts +17 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/principal.ts +22 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/roles.guard.spec.ts +23 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/roles.guard.ts +20 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/token.service.ts +54 -0
- package/boilerplates/02-saas-starter/backend/src/platform/config.spec.ts +18 -0
- package/boilerplates/02-saas-starter/backend/src/platform/config.ts +33 -0
- package/boilerplates/02-saas-starter/backend/src/platform/platform.module.ts +14 -0
- package/boilerplates/02-saas-starter/backend/tsconfig.build.json +6 -0
- package/boilerplates/02-saas-starter/backend/tsconfig.json +16 -21
- package/boilerplates/02-saas-starter/backend/vitest.config.ts +7 -0
- package/boilerplates/02-saas-starter/boilerplate.manifest.json +19 -14
- package/boilerplates/02-saas-starter/docker-compose.yml +10 -24
- package/boilerplates/02-saas-starter/memory/30-domains/billing/context.md +15 -132
- package/boilerplates/02-saas-starter/memory/30-domains/identity/context.md +20 -0
- package/boilerplates/README.md +9 -10
- package/dist/apps/cli/src/index.d.ts +0 -1
- package/dist/apps/cli/src/index.js +43 -32
- package/dist/apps/dashboard/app/api/forja/[...path]/route.js +34 -1
- package/dist/apps/dashboard/app/api/forja/capabilities.d.ts +26 -0
- package/dist/apps/dashboard/app/api/forja/capabilities.js +39 -0
- package/dist/apps/dashboard/app/dashboard-client.jsx +607 -42
- package/dist/apps/server/src/forja-nest.module.d.ts +6 -0
- package/dist/apps/server/src/forja-nest.module.js +55 -0
- package/dist/apps/server/src/main.d.ts +21 -4
- package/dist/apps/server/src/main.js +79 -57
- package/dist/apps/server/src/task-planning-service.d.ts +29 -0
- package/dist/apps/server/src/task-planning-service.js +195 -0
- package/dist/apps/server/src/task-runtime-coordinator.d.ts +57 -0
- package/dist/apps/server/src/task-runtime-coordinator.js +229 -0
- package/dist/bin/forja.js +3 -2
- package/dist/bin/init-project.js +1 -0
- package/dist/lib/agent-evals.d.ts +138 -0
- package/dist/lib/agent-evals.js +349 -0
- package/dist/lib/cli-output.js +14 -2
- package/dist/lib/code-context.d.ts +33 -5
- package/dist/lib/code-context.js +70 -5
- package/dist/lib/context-builder.d.ts +49 -4
- package/dist/lib/context-builder.js +114 -47
- package/dist/lib/core/coverage-gate.d.ts +59 -0
- package/dist/lib/core/coverage-gate.js +58 -0
- package/dist/lib/core/doc-graph.d.ts +38 -0
- package/dist/lib/core/doc-graph.js +83 -0
- package/dist/lib/core/health.js +286 -5
- package/dist/lib/core/journey.js +36 -0
- package/dist/lib/core/registry.js +81 -6
- package/dist/lib/docs-reference.d.ts +35 -0
- package/dist/lib/docs-reference.js +57 -0
- package/dist/lib/generators/memory-generator.d.ts +0 -11
- package/dist/lib/generators/memory-generator.js +5 -161
- package/dist/lib/generators/readme-generator.js +1 -1
- package/dist/lib/llm/json-output.d.ts +14 -0
- package/dist/lib/llm/json-output.js +77 -0
- package/dist/lib/project-wiring.d.ts +8 -0
- package/dist/lib/project-wiring.js +79 -3
- package/dist/lib/session-memory.d.ts +38 -0
- package/dist/lib/session-memory.js +206 -0
- package/dist/lib/spec-trace.d.ts +46 -0
- package/dist/lib/spec-trace.js +184 -0
- package/dist/lib/validators/structure-validator.js +0 -1
- package/dist/packages/adapter-nest/src/index.d.ts +2 -1
- package/dist/packages/adapter-nest/src/index.js +59 -1
- package/dist/packages/adapter-sqlite/src/index.d.ts +15 -1
- package/dist/packages/adapter-sqlite/src/index.js +61 -1
- package/dist/packages/context/src/index.d.ts +2 -0
- package/dist/packages/context/src/index.js +36 -15
- package/dist/packages/contracts/src/index.d.ts +64 -0
- package/dist/packages/core/src/index.d.ts +9 -1
- package/dist/packages/core/src/index.js +28 -3
- package/dist/packages/graph/src/index.js +14 -5
- package/dist/packages/llm/src/index.js +12 -2
- package/dist/packages/mcp/src/index.d.ts +8 -0
- package/dist/packages/mcp/src/index.js +12 -1
- package/dist/packages/observability/src/index.d.ts +11 -0
- package/dist/packages/observability/src/index.js +3 -0
- package/dist/packages/orchestration/src/index.d.ts +15 -1
- package/dist/packages/orchestration/src/index.js +127 -21
- package/dist/packages/planner/src/index.d.ts +7 -1
- package/dist/packages/planner/src/index.js +67 -10
- package/dist/packages/planner/src/proposal-store.d.ts +30 -0
- package/dist/packages/planner/src/proposal-store.js +109 -0
- package/dist/packages/policy/src/index.d.ts +9 -16
- package/dist/packages/policy/src/index.js +114 -31
- package/dist/packages/runtime/src/index.d.ts +16 -2
- package/dist/packages/runtime/src/index.js +176 -61
- package/dist/scripts/build-smart-context.d.ts +2 -0
- package/dist/scripts/build-smart-context.js +12 -3
- package/dist/scripts/code-context.d.ts +3 -1
- package/dist/scripts/code-context.js +13 -3
- package/dist/scripts/coverage-gate.d.ts +2 -0
- package/dist/scripts/coverage-gate.js +101 -0
- package/dist/scripts/eval-agents.d.ts +11 -0
- package/dist/scripts/eval-agents.js +96 -0
- package/dist/scripts/gen-commands-doc.d.ts +2 -0
- package/dist/scripts/gen-commands-doc.js +18 -0
- package/dist/scripts/hook-session-memory.d.ts +9 -0
- package/dist/scripts/hook-session-memory.js +20 -0
- package/dist/scripts/hook-session-start.js +34 -0
- package/dist/scripts/llm-fit.js +23 -1
- package/dist/scripts/spec-trace.d.ts +10 -0
- package/dist/scripts/spec-trace.js +73 -0
- package/dist/scripts/sync-universal-memory.js +69 -4
- package/dist/scripts/token-benchmark.d.ts +33 -1
- package/dist/scripts/token-benchmark.js +179 -5
- package/dist/scripts/token-economy.js +3 -1
- package/dist/scripts/tools-doctor.d.ts +16 -1
- package/dist/scripts/tools-doctor.js +58 -17
- package/docs/commands.md +155 -0
- package/docs/fluxo.md +11 -7
- package/docs/init-project.md +3 -1
- package/docs/llm-fit-loop.md +36 -0
- package/docs/manual-operacional-cli-sdd-gsd.md +3 -2
- package/docs/produto/factsheet-marketing.md +7 -5
- package/docs/produto/roteiro-demo.md +14 -5
- package/docs/quick-reference.md +3 -3
- package/docs/token-optimization.md +10 -6
- package/memory/90-decisions/0088-templates-validados.md +3 -0
- package/memory/90-decisions/0089-skills-do-projeto.md +51 -0
- package/memory/90-decisions/0090-adapters-de-agente-somente-leitura.md +47 -0
- package/memory/90-decisions/0091-memoria-de-sessao-por-hooks.md +40 -0
- package/memory/90-decisions/0092-criterios-de-aceite-ligados-a-testes.md +37 -0
- package/memory/90-decisions/0093-avaliacoes-com-agentes-reais.md +40 -0
- package/package.json +4 -2
- package/specs/avaliacoes-de-agentes/spec.md +52 -0
- package/specs/criterios-ligados-a-testes/spec.md +42 -0
- package/specs/memoria-de-sessao/spec.md +48 -0
- package/specs/skills-do-projeto/plan.md +40 -0
- package/specs/skills-do-projeto/spec.md +63 -0
- package/specs/skills-do-projeto/tasks.md +27 -0
- package/specs/v6-agent-runtime-portable/spec.md +83 -0
- package/specs/v6-core-consolidation/spec.md +70 -0
- package/specs/v6-docs-drift/spec.md +85 -0
- package/specs/v6-quality-gates/spec.md +99 -0
- package/specs/v6-token-economy/spec.md +84 -0
- package/templates/evals/agents/adr.json +25 -0
- package/templates/evals/agents/memoria.json +32 -0
- package/templates/evals/agents/proxima-acao.json +29 -0
- package/templates/evals/agents/spec-nova.json +26 -0
- package/templates/evals/agents/teste-do-criterio.json +29 -0
- package/templates/project/AGENTS.md +16 -0
- package/templates/project/CLAUDE.md +3 -2
- package/templates/project/agents/context-engineer.md +3 -0
- package/templates/project/agents/governance.md +3 -0
- package/templates/project/agents/marketing.md +3 -0
- package/templates/project/agents/orchestrator.md +3 -0
- package/templates/project/agents/product.md +3 -0
- package/templates/project/agents/sdd-architect.md +3 -0
- package/templates/project/skills/README.md +14 -0
- package/templates/project/skills/accessibility-review/SKILL.md +89 -0
- package/templates/project/skills/api-design/SKILL.md +77 -0
- package/templates/project/skills/architecture-decision-record/SKILL.md +92 -0
- package/templates/project/skills/backlog-slicing/SKILL.md +82 -0
- package/templates/project/skills/bounded-context-mapping/SKILL.md +88 -0
- package/templates/project/skills/ci-pipeline-review/SKILL.md +83 -0
- package/templates/project/skills/commit-message/SKILL.md +143 -0
- package/templates/project/skills/data-migrations/SKILL.md +88 -0
- package/templates/project/skills/dependency-upgrade/SKILL.md +75 -0
- package/templates/project/skills/docker-compose-review/SKILL.md +85 -0
- package/templates/project/skills/domain-modeling/SKILL.md +120 -0
- package/templates/project/skills/event-storming/SKILL.md +95 -0
- package/templates/project/skills/executive-writing/SKILL.md +99 -0
- package/templates/project/skills/frontend-architecture/SKILL.md +97 -0
- package/templates/project/skills/incident-postmortem/SKILL.md +93 -0
- package/templates/project/skills/lgpd-compliance/SKILL.md +108 -0
- package/templates/project/skills/llm-provider-routing/SKILL.md +18 -0
- package/templates/project/skills/observability/SKILL.md +93 -0
- package/templates/project/skills/product-evaluation/SKILL.md +130 -0
- package/templates/project/skills/prompt-spec/SKILL.md +83 -0
- package/templates/project/skills/pull-request/SKILL.md +101 -0
- package/templates/project/skills/query-performance/SKILL.md +83 -0
- package/templates/project/skills/release-checklist/SKILL.md +106 -0
- package/templates/project/skills/release-notes/SKILL.md +87 -0
- package/templates/project/skills/requirements-elicitation/SKILL.md +127 -0
- package/templates/project/skills/requirements-gathering/SKILL.md +134 -0
- package/templates/project/skills/technical-spike/SKILL.md +101 -0
- package/templates/project/skills/testing/SKILL.md +109 -0
- package/templates/project/skills/threat-modeling/SKILL.md +87 -0
- package/templates/project/skills/ts-async-patterns/SKILL.md +101 -0
- package/templates/project/skills/ts-code-review/SKILL.md +121 -0
- package/templates/project/skills/ts-module-layout/SKILL.md +104 -0
- package/templates/project/skills/ts-testing/SKILL.md +89 -0
- package/templates/project/skills/web-performance/SKILL.md +72 -0
- package/boilerplates/02-saas-starter/.env.example +0 -25
- package/boilerplates/02-saas-starter/CHECKLIST-CRIACAO.md +0 -190
- package/boilerplates/02-saas-starter/INFO.md +0 -252
- package/boilerplates/02-saas-starter/QUICK_START.md +0 -194
- package/boilerplates/02-saas-starter/START-HERE.md +0 -259
- package/boilerplates/02-saas-starter/backend/src/common/decorators/roles.decorator.ts +0 -3
- package/boilerplates/02-saas-starter/backend/src/common/decorators/tenant.decorator.ts +0 -6
- package/boilerplates/02-saas-starter/backend/src/common/middleware/roles.guard.ts +0 -23
- package/boilerplates/02-saas-starter/backend/src/config/database.ts +0 -26
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.controller.ts +0 -46
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.module.ts +0 -25
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.service.ts +0 -145
- package/boilerplates/02-saas-starter/backend/src/modules/auth/dto/auth.dto.ts +0 -30
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/jwt.strategy.ts +0 -24
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/local.strategy.ts +0 -19
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.controller.ts +0 -42
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.service.ts +0 -67
- package/boilerplates/02-saas-starter/backend/src/modules/billing/entities/invoice.entity.ts +0 -52
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/entities/organization.entity.ts +0 -36
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.controller.ts +0 -16
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.service.ts +0 -34
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/entities/subscription.entity.ts +0 -40
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.controller.ts +0 -36
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.service.ts +0 -91
- package/boilerplates/02-saas-starter/backend/src/modules/users/entities/user.entity.ts +0 -42
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.controller.ts +0 -14
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.service.ts +0 -48
- package/boilerplates/02-saas-starter/memory/00-global/agent-contract.md +0 -227
- package/boilerplates/02-saas-starter/memory/00-global/context-policy.md +0 -141
- package/boilerplates/02-saas-starter/memory/00-global/index.md +0 -133
- package/boilerplates/02-saas-starter/memory/00-global/mission.md +0 -45
- package/boilerplates/02-saas-starter/memory/00-global/patterns.md +0 -223
- package/boilerplates/02-saas-starter/memory/10-product/business-rules.md +0 -240
- package/boilerplates/02-saas-starter/memory/10-product/nfrs.md +0 -239
- package/boilerplates/02-saas-starter/memory/10-product/personas.md +0 -195
- package/boilerplates/02-saas-starter/memory/10-product/vision.md +0 -63
- package/boilerplates/02-saas-starter/memory/20-architecture/overview.md +0 -232
- package/boilerplates/02-saas-starter/memory/30-domains/auth/api.md +0 -186
- package/boilerplates/02-saas-starter/memory/30-domains/auth/context.md +0 -85
- package/boilerplates/02-saas-starter/memory/30-domains/billing/api.md +0 -262
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/api.md +0 -176
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/context.md +0 -100
- package/boilerplates/02-saas-starter/memory/40-delivery/backlog.md +0 -81
- package/boilerplates/02-saas-starter/memory/40-delivery/roadmap.md +0 -97
- package/boilerplates/02-saas-starter/memory/40-delivery/sprint-atual.md +0 -57
- package/boilerplates/02-saas-starter/memory/50-orchestration/topology.md +0 -90
- package/boilerplates/02-saas-starter/memory/60-runs/index.md +0 -54
- package/boilerplates/02-saas-starter/memory/70-summaries/global.md +0 -50
- package/boilerplates/02-saas-starter/memory/80-data/schema.md +0 -185
- package/boilerplates/02-saas-starter/memory/90-decisions/adr-template.md +0 -75
|
@@ -1,305 +1,70 @@
|
|
|
1
|
-
# SaaS Starter -
|
|
1
|
+
# 02 — SaaS Starter multi-tenant
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
API NestJS 12 (ESM) para um SaaS B2B: **cada organização é um tenant**, com cadastro, login, papéis
|
|
4
|
+
e assinatura com faturamento mensal. O ponto de partida já vem com as decisões de segurança que
|
|
5
|
+
costumam ficar para depois — e com testes que as cobram.
|
|
4
6
|
|
|
5
|
-
##
|
|
7
|
+
## O que vem pronto
|
|
6
8
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
✅ **Type-Safe** — 100% TypeScript, strict mode, no `any`
|
|
13
|
-
✅ **Well-Documented** — 10-level memory structure, API specs, patterns
|
|
14
|
-
✅ **Agent-Ready** — Designed for multi-agent orchestration
|
|
15
|
-
✅ **Docker-Compose** — Local development in 1 command
|
|
16
|
-
✅ **E2E Tests** — Happy-path scenarios for critical flows
|
|
9
|
+
| Contexto | Faz | Garantias |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| `identity` | Cadastro (cria organização + dona), login, refresh, `me`, membros | Senha com scrypt e comparação em tempo constante; access (15 min) e refresh (7 dias) com segredos distintos e `typ` checado; login sem revelar se o e-mail existe |
|
|
12
|
+
| `billing` | Planos, assinatura, mudança de plano, fatura do mês | Preço vem da tabela de planos (nunca do cliente), em centavos inteiros; transições de plano validadas no domínio; uma fatura por tenant e período (idempotente) |
|
|
13
|
+
| `platform` | Configuração, JWT, papéis | A API não sobe sem `DATABASE_URL`, `JWT_SECRET` e `JWT_REFRESH_SECRET` (nada de segredo padrão); `RolesGuard` por rota |
|
|
17
14
|
|
|
18
|
-
|
|
15
|
+
O **tenant vem sempre do token**, nunca do corpo ou da URL: toda consulta filtra por `tenantId`, e
|
|
16
|
+
um recurso de outro tenant responde 404. O `ValidationPipe` rejeita campos fora do DTO (sem
|
|
17
|
+
atribuição em massa de `roles`, `tenantId`, `amount`).
|
|
19
18
|
|
|
20
|
-
|
|
21
|
-
# 1. Enter directory
|
|
22
|
-
cd boilerplates/02-saas-starter
|
|
23
|
-
|
|
24
|
-
# 2. Install dependencies
|
|
25
|
-
npm install
|
|
26
|
-
|
|
27
|
-
# 3. Start database & cache
|
|
28
|
-
docker-compose up -d
|
|
19
|
+
## Estrutura
|
|
29
20
|
|
|
30
|
-
# 4. Configure environment
|
|
31
|
-
cp .env.example .env.local
|
|
32
|
-
|
|
33
|
-
# 5. Run server
|
|
34
|
-
npm run start:dev
|
|
35
|
-
|
|
36
|
-
# 6. Open API docs
|
|
37
|
-
# http://localhost:3000/api/docs
|
|
38
21
|
```
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
"email": "founder@example.com",
|
|
51
|
-
"password": "SecureP@ss123",
|
|
52
|
-
"organizationName": "My SaaS"
|
|
53
|
-
}'
|
|
22
|
+
backend/src/
|
|
23
|
+
platform/ # config validada, TokenService, JwtAuthGuard, RolesGuard
|
|
24
|
+
identity/
|
|
25
|
+
domain/ # Organization, User, porta IdentityRepository, hash de senha
|
|
26
|
+
application/ # AuthService (casos de uso)
|
|
27
|
+
adapters/http|persistence
|
|
28
|
+
billing/
|
|
29
|
+
domain/ # planos e transições, agregado Subscription, porta BillingRepository
|
|
30
|
+
application/ # BillingService
|
|
31
|
+
adapters/http|persistence
|
|
32
|
+
memory/30-domains/ # contexto de cada domínio na linguagem ubíqua (leia antes do código)
|
|
54
33
|
```
|
|
55
34
|
|
|
56
|
-
|
|
35
|
+
Mesma regra de dependência do template `clean-arch`: domínio sem Nest nem ORM, adapters implementam
|
|
36
|
+
as portas, ligação no módulo.
|
|
57
37
|
|
|
58
|
-
|
|
59
|
-
curl -X POST http://localhost:3000/api/auth/login-email \
|
|
60
|
-
-H "Content-Type: application/json" \
|
|
61
|
-
-d '{ "email": "founder@example.com", "password": "SecureP@ss123" }'
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Get Current User
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
curl -X GET http://localhost:3000/api/auth/me \
|
|
68
|
-
-H "Authorization: Bearer {accessToken}"
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Upgrade Subscription
|
|
38
|
+
## Rodando
|
|
72
39
|
|
|
73
40
|
```bash
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
**Multi-Tenant**: Every table has `tenantId` column. All queries filtered by tenant.
|
|
106
|
-
**RBAC**: Roles stored in User entity, checked via RolesGuard decorator.
|
|
107
|
-
**JWT**: Stateless auth, 15min access token, 7day refresh token.
|
|
108
|
-
|
|
109
|
-
## Project Structure
|
|
110
|
-
|
|
111
|
-
```
|
|
112
|
-
backend/
|
|
113
|
-
├── src/
|
|
114
|
-
│ ├── modules/
|
|
115
|
-
│ │ ├── auth/ (JWT, login, signup)
|
|
116
|
-
│ │ ├── users/ (RBAC, user management)
|
|
117
|
-
│ │ ├── organizations/(Multi-tenant)
|
|
118
|
-
│ │ ├── subscriptions/(Plans, upgrades)
|
|
119
|
-
│ │ └── billing/ (Invoices, payments mock)
|
|
120
|
-
│ ├── common/
|
|
121
|
-
│ │ ├── decorators/ (Roles, TenantId)
|
|
122
|
-
│ │ ├── middleware/ (Guards, logging)
|
|
123
|
-
│ │ └── filters/ (Error handling)
|
|
124
|
-
│ ├── config/ (Database, JWT)
|
|
125
|
-
│ ├── app.module.ts
|
|
126
|
-
│ └── main.ts
|
|
127
|
-
├── test/ (E2E tests)
|
|
128
|
-
├── package.json
|
|
129
|
-
└── tsconfig.json
|
|
130
|
-
|
|
131
|
-
memory/ (Documentation)
|
|
132
|
-
├── 00-global/ (Mission, patterns, policies)
|
|
133
|
-
├── 10-product/ (Vision, personas, rules)
|
|
134
|
-
├── 20-architecture/ (Tech decisions, diagrams)
|
|
135
|
-
├── 30-domains/ (Auth, subscriptions, billing)
|
|
136
|
-
├── 40-delivery/ (Roadmap, sprints, backlog)
|
|
137
|
-
├── 50-orchestration/ (Agent topology, handoffs)
|
|
138
|
-
├── 60-runs/ (Execution logs)
|
|
139
|
-
├── 70-summaries/ (Executive summaries)
|
|
140
|
-
├── 80-data/ (Database schema)
|
|
141
|
-
└── 90-decisions/ (ADRs)
|
|
142
|
-
|
|
143
|
-
docker-compose.yml (PostgreSQL + Redis)
|
|
144
|
-
.env.example (Configuration template)
|
|
145
|
-
QUICK_START.md (5-minute setup guide)
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
## Database Schema
|
|
149
|
-
|
|
150
|
-
**Entities**:
|
|
151
|
-
- `User` — Email, roles, tenant isolation
|
|
152
|
-
- `Organization` — Plan, tenant ID, owner
|
|
153
|
-
- `Subscription` — Current plan, billing period
|
|
154
|
-
- `Invoice` — Charges, payment status
|
|
155
|
-
- `AuditLog` — User actions, compliance
|
|
156
|
-
|
|
157
|
-
See [memory/80-data/schema.md](./memory/80-data/schema.md).
|
|
158
|
-
|
|
159
|
-
## Authentication Flow
|
|
160
|
-
|
|
161
|
-
1. **Signup**: User + Org created, JWT tokens returned
|
|
162
|
-
2. **Login**: Email + password validated, tokens returned
|
|
163
|
-
3. **Protected routes**: JWT header validated, tenant extracted
|
|
164
|
-
4. **Logout**: Token cached in Redis for blacklist (future)
|
|
165
|
-
|
|
166
|
-
Strategies:
|
|
167
|
-
- **Local**: Username/password (Passport Local)
|
|
168
|
-
- **JWT**: Bearer token (Passport JWT)
|
|
169
|
-
|
|
170
|
-
## Subscription Plans
|
|
171
|
-
|
|
172
|
-
| Plan | Price | API Calls | Storage | Users |
|
|
173
|
-
|------|-------|-----------|---------|-------|
|
|
174
|
-
| Free | $0 | 1k/mo | 1GB | 1 |
|
|
175
|
-
| Pro | $99 | 100k/mo | 100GB | 5 (+$10 each) |
|
|
176
|
-
| Enterprise | Custom | ∞ | ∞ | ∞ |
|
|
177
|
-
|
|
178
|
-
Upgrade instantly, downgrade at period end. Pro-rata billing for mid-cycle changes.
|
|
179
|
-
|
|
180
|
-
## Payment (Mock)
|
|
181
|
-
|
|
182
|
-
90% success rate, 10% failure (for testing). Real Stripe integration in Q2.
|
|
183
|
-
|
|
184
|
-
```typescript
|
|
185
|
-
POST /api/billing/charge
|
|
186
|
-
{
|
|
187
|
-
"amount": 99.00,
|
|
188
|
-
"description": "Pro Plan Upgrade"
|
|
189
|
-
}
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
Returns invoice with mock transaction ID.
|
|
193
|
-
|
|
194
|
-
## Development
|
|
195
|
-
|
|
196
|
-
```bash
|
|
197
|
-
# Format + Lint
|
|
198
|
-
npm run format && npm run lint
|
|
199
|
-
|
|
200
|
-
# Tests
|
|
201
|
-
npm run test # Unit
|
|
202
|
-
npm run test:cov # Coverage
|
|
203
|
-
npm run test:e2e # E2E
|
|
204
|
-
|
|
205
|
-
# Build
|
|
206
|
-
npm run build
|
|
207
|
-
npm run start:prod
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
## Environment Variables
|
|
211
|
-
|
|
212
|
-
```env
|
|
213
|
-
NODE_ENV=development
|
|
214
|
-
PORT=3000
|
|
215
|
-
DB_HOST=localhost
|
|
216
|
-
DB_PORT=5432
|
|
217
|
-
DB_USER=postgres
|
|
218
|
-
DB_PASSWORD=postgres
|
|
219
|
-
DB_NAME=saas_starter
|
|
220
|
-
JWT_SECRET=dev-secret-key
|
|
221
|
-
JWT_REFRESH_SECRET=dev-refresh-secret
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
See [.env.example](./.env.example) for all options.
|
|
225
|
-
|
|
226
|
-
## Documentation
|
|
227
|
-
|
|
228
|
-
- **Quick Start**: [QUICK_START.md](./QUICK_START.md)
|
|
229
|
-
- **API Reference**: [memory/30-domains/](./memory/30-domains/)
|
|
230
|
-
- **Architecture**: [memory/20-architecture/overview.md](./memory/20-architecture/overview.md)
|
|
231
|
-
- **Patterns & Conventions**: [memory/00-global/patterns.md](./memory/00-global/patterns.md)
|
|
232
|
-
- **Business Rules**: [memory/10-product/business-rules.md](./memory/10-product/business-rules.md)
|
|
233
|
-
- **Database Schema**: [memory/80-data/schema.md](./memory/80-data/schema.md)
|
|
234
|
-
|
|
235
|
-
**Navigation**: See [memory/00-global/index.md](./memory/00-global/index.md) for full index.
|
|
236
|
-
|
|
237
|
-
## Roadmap
|
|
238
|
-
|
|
239
|
-
**Q1 2024** (Current): MVP with auth, subscriptions, billing mock ✅
|
|
240
|
-
**Q2 2024**: Real Stripe, webhooks, analytics
|
|
241
|
-
**Q3 2024**: Observability, compliance, performance
|
|
242
|
-
**Q4 2024**: Multi-currency, internationalization
|
|
243
|
-
|
|
244
|
-
See [memory/40-delivery/roadmap.md](./memory/40-delivery/roadmap.md).
|
|
245
|
-
|
|
246
|
-
## Extending
|
|
247
|
-
|
|
248
|
-
### Add a New Endpoint
|
|
249
|
-
|
|
250
|
-
1. Create DTO in `modules/{domain}/dto/`
|
|
251
|
-
2. Add method in `modules/{domain}/{domain}.service.ts`
|
|
252
|
-
3. Add route in `modules/{domain}/{domain}.controller.ts`
|
|
253
|
-
4. Add tests in `test/{domain}.e2e-spec.ts`
|
|
254
|
-
5. Document in `memory/30-domains/{domain}/api.md`
|
|
255
|
-
|
|
256
|
-
See [memory/00-global/patterns.md](./memory/00-global/patterns.md).
|
|
257
|
-
|
|
258
|
-
### Add a New Module
|
|
259
|
-
|
|
260
|
-
1. Create folder in `modules/`
|
|
261
|
-
2. Create `{module}.service.ts`, `{module}.controller.ts`, `{module}.module.ts`
|
|
262
|
-
3. Add module to `app.module.ts` imports
|
|
263
|
-
4. Create `entity.ts` and register in database config
|
|
264
|
-
5. Document in `memory/30-domains/{module}/`
|
|
265
|
-
|
|
266
|
-
## Security
|
|
267
|
-
|
|
268
|
-
- **Passwords**: Bcrypt cost=12
|
|
269
|
-
- **JWT**: HS256, secrets in env
|
|
270
|
-
- **Tenant Isolation**: Row-level filtering by tenantId
|
|
271
|
-
- **SQL Injection**: TypeORM parameterized queries
|
|
272
|
-
- **RBAC**: Roles decorator on controllers
|
|
273
|
-
- **PII**: No passwords/tokens in logs
|
|
274
|
-
|
|
275
|
-
See [memory/10-product/nfrs.md](./memory/10-product/nfrs.md) for security requirements.
|
|
276
|
-
|
|
277
|
-
## Troubleshooting
|
|
278
|
-
|
|
279
|
-
**Port 3000 in use?**
|
|
280
|
-
```bash
|
|
281
|
-
lsof -i :3000 && kill -9 {PID}
|
|
282
|
-
```
|
|
283
|
-
|
|
284
|
-
**Database connection failed?**
|
|
285
|
-
```bash
|
|
286
|
-
docker-compose ps
|
|
287
|
-
docker-compose logs postgres
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
**Module not found?**
|
|
291
|
-
```bash
|
|
292
|
-
rm -rf node_modules && npm install
|
|
293
|
-
```
|
|
294
|
-
|
|
295
|
-
## License
|
|
296
|
-
|
|
297
|
-
MIT
|
|
298
|
-
|
|
299
|
-
## Contributing
|
|
300
|
-
|
|
301
|
-
Patches welcome! See [memory/00-global/agent-contract.md](./memory/00-global/agent-contract.md) for agent onboarding.
|
|
302
|
-
|
|
303
|
-
---
|
|
304
|
-
|
|
305
|
-
**Ready to build?** See [QUICK_START.md](./QUICK_START.md) →
|
|
41
|
+
forja project:new minha-saas --template saas-starter
|
|
42
|
+
cd ~/forja-workspace/projects/minha-saas
|
|
43
|
+
docker compose up -d db # Postgres de desenvolvimento
|
|
44
|
+
cd backend && cp .env.example .env # preencha JWT_SECRET e JWT_REFRESH_SECRET (openssl rand -base64 48)
|
|
45
|
+
npm run start:dev # http://localhost:3000/api — Swagger em /api/docs fora de produção
|
|
46
|
+
npm test # Vitest: domínio e casos de uso, sem Postgres
|
|
47
|
+
npm run lint # oxlint com checagem de tipos
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
`synchronize` do TypeORM fica ligado só fora de produção. Antes do primeiro deploy, troque por
|
|
51
|
+
migrações (`typeorm migration:generate`).
|
|
52
|
+
|
|
53
|
+
## Rotas
|
|
54
|
+
|
|
55
|
+
| Método | Rota | Papel |
|
|
56
|
+
|---|---|---|
|
|
57
|
+
| POST | `/api/auth/signup` · `/api/auth/login` · `/api/auth/refresh` | público |
|
|
58
|
+
| GET | `/api/me` · `/api/organization` | autenticado |
|
|
59
|
+
| GET | `/api/users` | owner, admin |
|
|
60
|
+
| GET | `/api/billing/plans` · `/api/billing/subscription` · `/api/billing/invoices` · `/api/billing/invoices/:id` | autenticado (faturas: owner, admin) |
|
|
61
|
+
| PUT | `/api/billing/subscription/plan` | owner |
|
|
62
|
+
| POST | `/api/billing/invoices/current` | owner, admin |
|
|
63
|
+
|
|
64
|
+
## O que fica com você
|
|
65
|
+
|
|
66
|
+
- **Gateway de pagamento**: a fatura nasce `open`; integrar Stripe/Pagar.me/Asaas é um adapter novo
|
|
67
|
+
que marca `paid` por webhook (verifique a assinatura do webhook).
|
|
68
|
+
- **Convites de membros**, recuperação de senha e verificação de e-mail.
|
|
69
|
+
- **Revogação de refresh token** (lista de sessões) se precisar de logout em todos os aparelhos.
|
|
70
|
+
- **Rate limit** no login (`@nestjs/throttler`).
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Copie para .env (nesta pasta) e preencha. Sem JWT_SECRET/JWT_REFRESH_SECRET/DATABASE_URL a API não sobe.
|
|
2
|
+
NODE_ENV=development
|
|
3
|
+
PORT=3000
|
|
4
|
+
|
|
5
|
+
# PostgreSQL (docker compose up -d db)
|
|
6
|
+
DATABASE_URL=postgres://postgres:postgres@localhost:5432/saas_starter
|
|
7
|
+
|
|
8
|
+
# Segredos distintos, longos e aleatórios (ex.: openssl rand -base64 48)
|
|
9
|
+
JWT_SECRET=
|
|
10
|
+
JWT_REFRESH_SECRET=
|
|
11
|
+
|
|
12
|
+
# Moeda das faturas (ISO 4217)
|
|
13
|
+
BILLING_CURRENCY=BRL
|
|
@@ -1,87 +1,46 @@
|
|
|
1
1
|
{
|
|
2
|
-
"name": "
|
|
3
|
-
"version": "1.0
|
|
4
|
-
"description": "SaaS Starter NestJS Backend",
|
|
5
|
-
"author": "SaaS Starter",
|
|
2
|
+
"name": "saas-starter-api",
|
|
3
|
+
"version": "0.1.0",
|
|
6
4
|
"private": true,
|
|
7
|
-
"
|
|
5
|
+
"type": "module",
|
|
8
6
|
"scripts": {
|
|
9
|
-
"prebuild": "rimraf dist",
|
|
10
7
|
"build": "nest build",
|
|
11
|
-
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
|
|
12
8
|
"start": "nest start",
|
|
13
9
|
"start:dev": "nest start --watch",
|
|
14
|
-
"start:debug": "nest start --debug --watch",
|
|
15
10
|
"start:prod": "node dist/main",
|
|
16
|
-
"
|
|
17
|
-
"
|
|
18
|
-
"test
|
|
19
|
-
"test:
|
|
20
|
-
"test:
|
|
21
|
-
"test:e2e": "jest --config ./test/jest-e2e.json",
|
|
22
|
-
"typeorm": "typeorm-ts-node-esm",
|
|
23
|
-
"migration:create": "typeorm-ts-node-esm migration:create ./src/migrations",
|
|
24
|
-
"migration:run": "typeorm-ts-node-esm migration:run -d ./src/config/database.ts",
|
|
25
|
-
"migration:revert": "typeorm-ts-node-esm migration:revert -d ./src/config/database.ts",
|
|
26
|
-
"seed": "ts-node src/scripts/seed.ts"
|
|
11
|
+
"format": "prettier --write \"src/**/*.ts\"",
|
|
12
|
+
"lint": "oxlint --type-aware src/",
|
|
13
|
+
"test": "vitest run",
|
|
14
|
+
"test:watch": "vitest",
|
|
15
|
+
"test:cov": "vitest run --coverage"
|
|
27
16
|
},
|
|
28
17
|
"dependencies": {
|
|
29
|
-
"@nestjs/common": "^
|
|
30
|
-
"@nestjs/config": "^
|
|
31
|
-
"@nestjs/core": "^
|
|
32
|
-
"@nestjs/jwt": "^
|
|
33
|
-
"@nestjs/
|
|
34
|
-
"@nestjs/
|
|
35
|
-
"@nestjs/
|
|
36
|
-
"@nestjs/typeorm": "^9.0.0",
|
|
37
|
-
"bcrypt": "^5.1.1",
|
|
18
|
+
"@nestjs/common": "^12.1.2",
|
|
19
|
+
"@nestjs/config": "^12.0.1",
|
|
20
|
+
"@nestjs/core": "^12.1.2",
|
|
21
|
+
"@nestjs/jwt": "^12.0.3",
|
|
22
|
+
"@nestjs/platform-express": "^12.1.2",
|
|
23
|
+
"@nestjs/swagger": "^12.0.2",
|
|
24
|
+
"@nestjs/typeorm": "^12.0.2",
|
|
38
25
|
"class-transformer": "^0.5.1",
|
|
39
|
-
"class-validator": "^0.
|
|
40
|
-
"pg": "^8.
|
|
41
|
-
"
|
|
42
|
-
"
|
|
43
|
-
"
|
|
44
|
-
"redis": "^4.6.0",
|
|
45
|
-
"reflect-metadata": "^0.1.13",
|
|
46
|
-
"rxjs": "^7.8.1",
|
|
47
|
-
"swagger-ui-express": "^5.0.0",
|
|
48
|
-
"typeorm": "^0.3.17",
|
|
49
|
-
"uuid": "^9.0.1"
|
|
26
|
+
"class-validator": "^0.15.1",
|
|
27
|
+
"pg": "^8.23.1",
|
|
28
|
+
"reflect-metadata": "^0.2.2",
|
|
29
|
+
"rxjs": "^7.8.2",
|
|
30
|
+
"typeorm": "^1.1.2"
|
|
50
31
|
},
|
|
51
32
|
"devDependencies": {
|
|
52
|
-
"@nestjs/cli": "^
|
|
53
|
-
"@nestjs/schematics": "^
|
|
54
|
-
"@nestjs/testing": "^
|
|
55
|
-
"@types/
|
|
56
|
-
"@types/
|
|
57
|
-
"@
|
|
58
|
-
"
|
|
59
|
-
"
|
|
60
|
-
"
|
|
61
|
-
"
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
"eslint": "^8.42.0",
|
|
65
|
-
"jest": "^29.5.0",
|
|
66
|
-
"prettier": "^2.8.8",
|
|
67
|
-
"rimraf": "^5.0.1",
|
|
68
|
-
"supertest": "^6.3.3",
|
|
69
|
-
"ts-jest": "^29.1.0",
|
|
70
|
-
"ts-loader": "^9.4.3",
|
|
71
|
-
"ts-node": "^10.9.1",
|
|
72
|
-
"tsconfig-paths": "^4.2.0",
|
|
73
|
-
"typeorm-ts-node-esm": "^10.0.0",
|
|
74
|
-
"typescript": "^5.1.3"
|
|
75
|
-
},
|
|
76
|
-
"jest": {
|
|
77
|
-
"moduleFileExtensions": ["js", "json", "ts"],
|
|
78
|
-
"rootDir": "src",
|
|
79
|
-
"testRegex": ".*\\.spec\\.ts$",
|
|
80
|
-
"transform": {
|
|
81
|
-
"^.+\\.(t|j)s$": "ts-jest"
|
|
82
|
-
},
|
|
83
|
-
"collectCoverageFrom": ["**/*.(t|j)s"],
|
|
84
|
-
"coverageDirectory": "../coverage",
|
|
85
|
-
"testEnvironment": "node"
|
|
33
|
+
"@nestjs/cli": "^12.0.8",
|
|
34
|
+
"@nestjs/schematics": "^12.0.6",
|
|
35
|
+
"@nestjs/testing": "^12.1.2",
|
|
36
|
+
"@types/express": "^5.0.6",
|
|
37
|
+
"@types/node": "^26.6.4",
|
|
38
|
+
"@vitest/coverage-v8": "^5.0.3",
|
|
39
|
+
"oxlint": "^1.87.0",
|
|
40
|
+
"oxlint-tsgolint": "^7.0.2003",
|
|
41
|
+
"prettier": "^3.9.9",
|
|
42
|
+
"typescript": "^6.0.3",
|
|
43
|
+
"vite-tsconfig-paths": "^6.1.1",
|
|
44
|
+
"vitest": "^5.0.3"
|
|
86
45
|
}
|
|
87
46
|
}
|
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
import { Module } from '@nestjs/common';
|
|
2
|
-
import { ConfigModule } from '@nestjs/config';
|
|
3
2
|
import { TypeOrmModule } from '@nestjs/typeorm';
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
3
|
+
import { APP_CONFIG, type AppConfig } from './platform/config.js';
|
|
4
|
+
import { PlatformModule } from './platform/platform.module.js';
|
|
5
|
+
import { IdentityModule } from './identity/identity.module.js';
|
|
6
|
+
import { BillingModule } from './billing/billing.module.js';
|
|
7
|
+
import { OrganizationOrm, UserOrm } from './identity/adapters/persistence/orm-entities.js';
|
|
8
|
+
import { InvoiceOrm, SubscriptionOrm } from './billing/adapters/persistence/orm-entities.js';
|
|
10
9
|
|
|
11
10
|
@Module({
|
|
12
11
|
imports: [
|
|
13
|
-
|
|
14
|
-
isGlobal: true,
|
|
15
|
-
envFilePath: ['.env.local', '.env'],
|
|
16
|
-
}),
|
|
12
|
+
PlatformModule,
|
|
17
13
|
TypeOrmModule.forRootAsync({
|
|
18
|
-
|
|
14
|
+
inject: [APP_CONFIG],
|
|
15
|
+
useFactory: (config: AppConfig) => ({
|
|
16
|
+
type: 'postgres',
|
|
17
|
+
url: config.databaseUrl,
|
|
18
|
+
entities: [OrganizationOrm, UserOrm, SubscriptionOrm, InvoiceOrm],
|
|
19
|
+
// Em produção o esquema muda por migração (skill data-migrations), nunca por synchronize.
|
|
20
|
+
synchronize: !config.production,
|
|
21
|
+
}),
|
|
19
22
|
}),
|
|
20
|
-
|
|
21
|
-
UsersModule,
|
|
22
|
-
OrganizationsModule,
|
|
23
|
-
SubscriptionsModule,
|
|
23
|
+
IdentityModule,
|
|
24
24
|
BillingModule,
|
|
25
25
|
],
|
|
26
26
|
})
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { Body, Controller, Get, HttpCode, Param, ParseUUIDPipe, Post, Put, UseGuards } from '@nestjs/common';
|
|
2
|
+
import { ApiBearerAuth, ApiProperty, ApiTags } from '@nestjs/swagger';
|
|
3
|
+
import { IsIn } from 'class-validator';
|
|
4
|
+
import { CurrentPrincipal, type Principal } from '../../../platform/auth/principal.js';
|
|
5
|
+
import { JwtAuthGuard } from '../../../platform/auth/jwt-auth.guard.js';
|
|
6
|
+
import { RequireRoles, RolesGuard } from '../../../platform/auth/roles.guard.js';
|
|
7
|
+
import { BillingService } from '../../application/billing.service.js';
|
|
8
|
+
import { PLAN_IDS, PLANS } from '../../domain/plan.js';
|
|
9
|
+
|
|
10
|
+
class ChangePlanDto {
|
|
11
|
+
@ApiProperty({ enum: PLAN_IDS }) @IsIn([...PLAN_IDS]) plan: string;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
@ApiTags('billing')
|
|
15
|
+
@ApiBearerAuth()
|
|
16
|
+
@Controller('billing')
|
|
17
|
+
@UseGuards(JwtAuthGuard, RolesGuard)
|
|
18
|
+
export class BillingController {
|
|
19
|
+
constructor(private readonly billing: BillingService) {}
|
|
20
|
+
|
|
21
|
+
@Get('plans')
|
|
22
|
+
plans() {
|
|
23
|
+
return Object.values(PLANS);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
@Get('subscription')
|
|
27
|
+
subscription(@CurrentPrincipal() p: Principal) {
|
|
28
|
+
return this.billing.subscription(p.tenantId);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
@Put('subscription/plan')
|
|
32
|
+
@RequireRoles('owner')
|
|
33
|
+
changePlan(@CurrentPrincipal() p: Principal, @Body() dto: ChangePlanDto) {
|
|
34
|
+
return this.billing.changePlan(p.tenantId, dto.plan);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
@Post('invoices/current')
|
|
38
|
+
@HttpCode(200)
|
|
39
|
+
@RequireRoles('owner', 'admin')
|
|
40
|
+
issue(@CurrentPrincipal() p: Principal) {
|
|
41
|
+
return this.billing.issueCurrentInvoice(p.tenantId);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
@Get('invoices')
|
|
45
|
+
@RequireRoles('owner', 'admin')
|
|
46
|
+
invoices(@CurrentPrincipal() p: Principal) {
|
|
47
|
+
return this.billing.listInvoices(p.tenantId);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
@Get('invoices/:id')
|
|
51
|
+
@RequireRoles('owner', 'admin')
|
|
52
|
+
invoice(@CurrentPrincipal() p: Principal, @Param('id', new ParseUUIDPipe()) id: string) {
|
|
53
|
+
return this.billing.invoice(id, p.tenantId);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { Column, CreateDateColumn, Entity, Index, PrimaryColumn, UpdateDateColumn } from 'typeorm';
|
|
2
|
+
|
|
3
|
+
@Entity('subscriptions')
|
|
4
|
+
export class SubscriptionOrm {
|
|
5
|
+
@PrimaryColumn('uuid') id: string;
|
|
6
|
+
@Column('uuid', { unique: true }) tenantId: string;
|
|
7
|
+
@Column('varchar', { length: 20 }) plan: string;
|
|
8
|
+
@Column('timestamptz') periodStart: Date;
|
|
9
|
+
@Column('timestamptz') periodEnd: Date;
|
|
10
|
+
@CreateDateColumn({ type: 'timestamptz' }) createdAt: Date;
|
|
11
|
+
@UpdateDateColumn({ type: 'timestamptz' }) updatedAt: Date;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
@Entity('invoices')
|
|
15
|
+
@Index(['tenantId', 'periodStart'], { unique: true })
|
|
16
|
+
export class InvoiceOrm {
|
|
17
|
+
@PrimaryColumn('uuid') id: string;
|
|
18
|
+
@Column('uuid') tenantId: string;
|
|
19
|
+
@Column('varchar', { length: 40, unique: true }) number: string;
|
|
20
|
+
@Column('varchar', { length: 20 }) plan: string;
|
|
21
|
+
/** Centavos, inteiro. */
|
|
22
|
+
@Column('integer') amountCents: number;
|
|
23
|
+
@Column('char', { length: 3 }) currency: string;
|
|
24
|
+
@Column('timestamptz') periodStart: Date;
|
|
25
|
+
@Column('timestamptz') periodEnd: Date;
|
|
26
|
+
@Column('varchar', { length: 10 }) status: 'open' | 'paid' | 'void';
|
|
27
|
+
@Column('timestamptz') issuedAt: Date;
|
|
28
|
+
}
|