forjajs 5.0.0 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/CHANGELOG.md +68 -2
  2. package/README.md +4 -2
  3. package/README.pt-BR.md +4 -1
  4. package/boilerplates/02-saas-starter/README.md +58 -293
  5. package/boilerplates/02-saas-starter/backend/.env.example +13 -0
  6. package/boilerplates/02-saas-starter/backend/.oxlintrc.json +8 -0
  7. package/boilerplates/02-saas-starter/backend/nest-cli.json +6 -0
  8. package/boilerplates/02-saas-starter/backend/package.json +32 -73
  9. package/boilerplates/02-saas-starter/backend/src/app.module.ts +16 -16
  10. package/boilerplates/02-saas-starter/backend/src/billing/adapters/http/billing.controller.ts +55 -0
  11. package/boilerplates/02-saas-starter/backend/src/billing/adapters/persistence/orm-entities.ts +28 -0
  12. package/boilerplates/02-saas-starter/backend/src/billing/adapters/persistence/typeorm-billing.repository.ts +46 -0
  13. package/boilerplates/02-saas-starter/backend/src/billing/application/billing.service.spec.ts +58 -0
  14. package/boilerplates/02-saas-starter/backend/src/billing/application/billing.service.ts +68 -0
  15. package/boilerplates/02-saas-starter/backend/src/billing/billing.module.ts +11 -0
  16. package/boilerplates/02-saas-starter/backend/src/billing/domain/plan.spec.ts +23 -0
  17. package/boilerplates/02-saas-starter/backend/src/billing/domain/plan.ts +36 -0
  18. package/boilerplates/02-saas-starter/backend/src/billing/domain/ports.ts +27 -0
  19. package/boilerplates/02-saas-starter/backend/src/billing/domain/subscription.spec.ts +28 -0
  20. package/boilerplates/02-saas-starter/backend/src/billing/domain/subscription.ts +47 -0
  21. package/boilerplates/02-saas-starter/backend/src/identity/adapters/http/auth.dto.ts +22 -0
  22. package/boilerplates/02-saas-starter/backend/src/identity/adapters/http/identity.controller.ts +59 -0
  23. package/boilerplates/02-saas-starter/backend/src/identity/adapters/persistence/orm-entities.ts +25 -0
  24. package/boilerplates/02-saas-starter/backend/src/identity/adapters/persistence/typeorm-identity.repository.ts +47 -0
  25. package/boilerplates/02-saas-starter/backend/src/identity/application/auth.service.spec.ts +72 -0
  26. package/boilerplates/02-saas-starter/backend/src/identity/application/auth.service.ts +63 -0
  27. package/boilerplates/02-saas-starter/backend/src/identity/domain/model.spec.ts +19 -0
  28. package/boilerplates/02-saas-starter/backend/src/identity/domain/model.ts +42 -0
  29. package/boilerplates/02-saas-starter/backend/src/identity/domain/password.spec.ts +17 -0
  30. package/boilerplates/02-saas-starter/backend/src/identity/domain/password.ts +26 -0
  31. package/boilerplates/02-saas-starter/backend/src/identity/identity.module.ts +12 -0
  32. package/boilerplates/02-saas-starter/backend/src/main.ts +19 -19
  33. package/boilerplates/02-saas-starter/backend/src/platform/auth/jwt-auth.guard.ts +17 -0
  34. package/boilerplates/02-saas-starter/backend/src/platform/auth/principal.ts +22 -0
  35. package/boilerplates/02-saas-starter/backend/src/platform/auth/roles.guard.spec.ts +23 -0
  36. package/boilerplates/02-saas-starter/backend/src/platform/auth/roles.guard.ts +20 -0
  37. package/boilerplates/02-saas-starter/backend/src/platform/auth/token.service.ts +54 -0
  38. package/boilerplates/02-saas-starter/backend/src/platform/config.spec.ts +18 -0
  39. package/boilerplates/02-saas-starter/backend/src/platform/config.ts +33 -0
  40. package/boilerplates/02-saas-starter/backend/src/platform/platform.module.ts +14 -0
  41. package/boilerplates/02-saas-starter/backend/tsconfig.build.json +6 -0
  42. package/boilerplates/02-saas-starter/backend/tsconfig.json +16 -21
  43. package/boilerplates/02-saas-starter/backend/vitest.config.ts +7 -0
  44. package/boilerplates/02-saas-starter/boilerplate.manifest.json +19 -14
  45. package/boilerplates/02-saas-starter/docker-compose.yml +10 -24
  46. package/boilerplates/02-saas-starter/memory/30-domains/billing/context.md +15 -132
  47. package/boilerplates/02-saas-starter/memory/30-domains/identity/context.md +20 -0
  48. package/boilerplates/README.md +9 -10
  49. package/dist/bin/create-memory-nest-kit.js +0 -0
  50. package/dist/bin/forja.js +0 -0
  51. package/dist/bin/init-project.js +1 -0
  52. package/dist/lib/core/journey.js +10 -0
  53. package/dist/lib/generators/memory-generator.d.ts +0 -11
  54. package/dist/lib/generators/memory-generator.js +5 -161
  55. package/dist/lib/generators/readme-generator.js +1 -1
  56. package/dist/lib/llm/json-output.d.ts +14 -0
  57. package/dist/lib/llm/json-output.js +77 -0
  58. package/dist/lib/project-upgrade.d.ts +0 -4
  59. package/dist/lib/project-upgrade.js +19 -1
  60. package/dist/lib/project-wiring.d.ts +8 -0
  61. package/dist/lib/project-wiring.js +74 -2
  62. package/dist/lib/validators/structure-validator.js +0 -1
  63. package/dist/packages/llm/src/index.js +12 -2
  64. package/dist/scripts/llm-fit.js +23 -1
  65. package/dist/scripts/project-upgrade.js +9 -6
  66. package/docs/init-project.md +1 -1
  67. package/docs/llm-fit-loop.md +16 -0
  68. package/memory/90-decisions/0086-projeto-conectado-e-jornada-como-gate.md +1 -1
  69. package/memory/90-decisions/0088-templates-validados.md +3 -0
  70. package/memory/90-decisions/0089-skills-do-projeto.md +51 -0
  71. package/memory/90-decisions/0090-adapters-de-agente-somente-leitura.md +47 -0
  72. package/package.json +2 -2
  73. package/specs/skills-do-projeto/plan.md +40 -0
  74. package/specs/skills-do-projeto/spec.md +63 -0
  75. package/specs/skills-do-projeto/tasks.md +27 -0
  76. package/templates/project/AGENTS.md +9 -0
  77. package/templates/project/agents/context-engineer.md +3 -0
  78. package/templates/project/agents/governance.md +3 -0
  79. package/templates/project/agents/marketing.md +3 -0
  80. package/templates/project/agents/orchestrator.md +3 -0
  81. package/templates/project/agents/product.md +3 -0
  82. package/templates/project/agents/sdd-architect.md +3 -0
  83. package/templates/project/skills/README.md +14 -0
  84. package/templates/project/skills/accessibility-review/SKILL.md +89 -0
  85. package/templates/project/skills/api-design/SKILL.md +77 -0
  86. package/templates/project/skills/architecture-decision-record/SKILL.md +92 -0
  87. package/templates/project/skills/backlog-slicing/SKILL.md +82 -0
  88. package/templates/project/skills/bounded-context-mapping/SKILL.md +88 -0
  89. package/templates/project/skills/ci-pipeline-review/SKILL.md +83 -0
  90. package/templates/project/skills/commit-message/SKILL.md +143 -0
  91. package/templates/project/skills/data-migrations/SKILL.md +88 -0
  92. package/templates/project/skills/dependency-upgrade/SKILL.md +75 -0
  93. package/templates/project/skills/docker-compose-review/SKILL.md +85 -0
  94. package/templates/project/skills/domain-modeling/SKILL.md +120 -0
  95. package/templates/project/skills/event-storming/SKILL.md +95 -0
  96. package/templates/project/skills/executive-writing/SKILL.md +99 -0
  97. package/templates/project/skills/frontend-architecture/SKILL.md +97 -0
  98. package/templates/project/skills/incident-postmortem/SKILL.md +93 -0
  99. package/templates/project/skills/lgpd-compliance/SKILL.md +108 -0
  100. package/templates/project/skills/llm-provider-routing/SKILL.md +18 -0
  101. package/templates/project/skills/observability/SKILL.md +93 -0
  102. package/templates/project/skills/product-evaluation/SKILL.md +130 -0
  103. package/templates/project/skills/prompt-spec/SKILL.md +83 -0
  104. package/templates/project/skills/pull-request/SKILL.md +101 -0
  105. package/templates/project/skills/query-performance/SKILL.md +83 -0
  106. package/templates/project/skills/release-checklist/SKILL.md +106 -0
  107. package/templates/project/skills/release-notes/SKILL.md +87 -0
  108. package/templates/project/skills/requirements-elicitation/SKILL.md +127 -0
  109. package/templates/project/skills/requirements-gathering/SKILL.md +134 -0
  110. package/templates/project/skills/technical-spike/SKILL.md +101 -0
  111. package/templates/project/skills/testing/SKILL.md +109 -0
  112. package/templates/project/skills/threat-modeling/SKILL.md +87 -0
  113. package/templates/project/skills/ts-async-patterns/SKILL.md +101 -0
  114. package/templates/project/skills/ts-code-review/SKILL.md +121 -0
  115. package/templates/project/skills/ts-module-layout/SKILL.md +104 -0
  116. package/templates/project/skills/ts-testing/SKILL.md +89 -0
  117. package/templates/project/skills/web-performance/SKILL.md +72 -0
  118. package/boilerplates/02-saas-starter/.env.example +0 -25
  119. package/boilerplates/02-saas-starter/CHECKLIST-CRIACAO.md +0 -190
  120. package/boilerplates/02-saas-starter/INFO.md +0 -252
  121. package/boilerplates/02-saas-starter/QUICK_START.md +0 -194
  122. package/boilerplates/02-saas-starter/START-HERE.md +0 -259
  123. package/boilerplates/02-saas-starter/backend/src/common/decorators/roles.decorator.ts +0 -3
  124. package/boilerplates/02-saas-starter/backend/src/common/decorators/tenant.decorator.ts +0 -6
  125. package/boilerplates/02-saas-starter/backend/src/common/middleware/roles.guard.ts +0 -23
  126. package/boilerplates/02-saas-starter/backend/src/config/database.ts +0 -26
  127. package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.controller.ts +0 -46
  128. package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.module.ts +0 -25
  129. package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.service.ts +0 -145
  130. package/boilerplates/02-saas-starter/backend/src/modules/auth/dto/auth.dto.ts +0 -30
  131. package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/jwt.strategy.ts +0 -24
  132. package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/local.strategy.ts +0 -19
  133. package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.controller.ts +0 -42
  134. package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.module.ts +0 -13
  135. package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.service.ts +0 -67
  136. package/boilerplates/02-saas-starter/backend/src/modules/billing/entities/invoice.entity.ts +0 -52
  137. package/boilerplates/02-saas-starter/backend/src/modules/organizations/entities/organization.entity.ts +0 -36
  138. package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.controller.ts +0 -16
  139. package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.module.ts +0 -13
  140. package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.service.ts +0 -34
  141. package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/entities/subscription.entity.ts +0 -40
  142. package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.controller.ts +0 -36
  143. package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.module.ts +0 -13
  144. package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.service.ts +0 -91
  145. package/boilerplates/02-saas-starter/backend/src/modules/users/entities/user.entity.ts +0 -42
  146. package/boilerplates/02-saas-starter/backend/src/modules/users/users.controller.ts +0 -14
  147. package/boilerplates/02-saas-starter/backend/src/modules/users/users.module.ts +0 -13
  148. package/boilerplates/02-saas-starter/backend/src/modules/users/users.service.ts +0 -48
  149. package/boilerplates/02-saas-starter/memory/00-global/agent-contract.md +0 -227
  150. package/boilerplates/02-saas-starter/memory/00-global/context-policy.md +0 -141
  151. package/boilerplates/02-saas-starter/memory/00-global/index.md +0 -133
  152. package/boilerplates/02-saas-starter/memory/00-global/mission.md +0 -45
  153. package/boilerplates/02-saas-starter/memory/00-global/patterns.md +0 -223
  154. package/boilerplates/02-saas-starter/memory/10-product/business-rules.md +0 -240
  155. package/boilerplates/02-saas-starter/memory/10-product/nfrs.md +0 -239
  156. package/boilerplates/02-saas-starter/memory/10-product/personas.md +0 -195
  157. package/boilerplates/02-saas-starter/memory/10-product/vision.md +0 -63
  158. package/boilerplates/02-saas-starter/memory/20-architecture/overview.md +0 -232
  159. package/boilerplates/02-saas-starter/memory/30-domains/auth/api.md +0 -186
  160. package/boilerplates/02-saas-starter/memory/30-domains/auth/context.md +0 -85
  161. package/boilerplates/02-saas-starter/memory/30-domains/billing/api.md +0 -262
  162. package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/api.md +0 -176
  163. package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/context.md +0 -100
  164. package/boilerplates/02-saas-starter/memory/40-delivery/backlog.md +0 -81
  165. package/boilerplates/02-saas-starter/memory/40-delivery/roadmap.md +0 -97
  166. package/boilerplates/02-saas-starter/memory/40-delivery/sprint-atual.md +0 -57
  167. package/boilerplates/02-saas-starter/memory/50-orchestration/topology.md +0 -90
  168. package/boilerplates/02-saas-starter/memory/60-runs/index.md +0 -54
  169. package/boilerplates/02-saas-starter/memory/70-summaries/global.md +0 -50
  170. package/boilerplates/02-saas-starter/memory/80-data/schema.md +0 -185
  171. package/boilerplates/02-saas-starter/memory/90-decisions/adr-template.md +0 -75
@@ -0,0 +1,104 @@
1
+ ---
2
+ name: ts-module-layout
3
+ description: Use quando organizar ou reorganizar uma base de código TypeScript ou JavaScript (serviços Node, NestJS, bibliotecas, front-ends): avalia a árvore de pastas e o grafo de imports atuais e propõe uma estrutura alinhada aos contextos delimitados, sem ciclos de import, barrel files ou pastas genéricas, com regras de dependência verificáveis e um plano de movimentação incremental.
4
+ ---
5
+
6
+ # Estrutura de Módulos em TypeScript
7
+
8
+ Em TypeScript o arquivo é o módulo, e a pasta é só uma convenção. Nada impede um arquivo de domínio de importar o cliente do banco, a não ser regras que você escreve e verifica. Uma estrutura organizada por contexto de negócio mantém uma mudança num lugar só. Uma estrutura organizada por camada técnica (`models/`, `services/`, `controllers/`) espalha cada funcionalidade pela árvore inteira, e os barrel files (`index.ts` que reexportam tudo) a transformam numa teia de ciclos.
9
+
10
+ A saída padrão é uma **avaliação e uma estrutura alvo com um plano de movimentação**. Mova arquivos só quando o usuário pedir.
11
+
12
+ ## Convenções
13
+
14
+ - Entradas: contextos de `bounded-context-mapping` ou `domain-modeling`; a árvore atual; `package.json`, `tsconfig.json` e o framework em uso.
15
+ - As convenções existentes prevalecem quando funcionam. Proponha uma mudança só para um problema concreto (ciclos, acoplamento, propriedade confusa, builds lentos).
16
+ - A estrutura do framework é respeitada onde ela sustenta algo (módulos NestJS, roteamento `app/` do Next.js), e os contextos são organizados dentro dela.
17
+ - Programas pequenos ficam planos: alguns arquivos em `src/` estão bem até começar a doer.
18
+ - Projetos JavaScript seguem as mesmas regras; os tipos vêm de JSDoc com `checkJs` quando o projeto o usa.
19
+
20
+ ## Avalie primeiro
21
+
22
+ Somente leitura:
23
+
24
+ 1. `tsc --noEmit` (ou `tsc -b` com project references): o build é a linha de base.
25
+ 2. Ciclos: `npx madge --circular --extensions ts,tsx src` (ou `npx dpdm`). Em TS, ciclos compilam e falham em tempo de execução como imports `undefined` ou erros de zona morta temporal.
26
+ 3. Quem importa quem: `npx depcruise src --output-type text` ou `madge --image`. Procure arquivos de domínio importando infraestrutura (ORM, clientes HTTP, SDKs, `process.env`).
27
+ 4. Barrel files: arquivos `index.ts` que só reexportam. Eles escondem o grafo real de dependências e criam ciclos.
28
+ 5. Nomes de pastas: os genéricos (`utils`, `common`, `helpers`, `shared`, `lib`, `types`, `models`, `services`) são um mau sinal.
29
+ 6. Código morto e dependências sem uso: `npx knip`.
30
+ 7. Formato de módulo: `"type"` no `package.json`, `module`/`moduleResolution` no `tsconfig.json`. ESM e CommonJS misturados são um achado por si só.
31
+
32
+ ## Estrutura alvo
33
+
34
+ ```
35
+ src/
36
+ main.ts # raiz de composição: config, montagem, start. Sem lógica de negócio.
37
+ <contexto>/ # um por contexto delimitado, ex.: booking/, billing/
38
+ domain/ # entidades, objetos de valor, políticas, interfaces de repositório. TS puro.
39
+ application/ # casos de uso; depende só do domínio
40
+ adapters/
41
+ http/ # controllers/rotas deste contexto
42
+ persistence/ # implementa as interfaces de repositório do domínio
43
+ platform/ # infraestrutura transversal com comportamento real: db, logging, config
44
+ test/ # testes de integração e e2e (os unitários ficam junto do código)
45
+ ```
46
+
47
+ Com NestJS, cada contexto é um módulo Nest (`booking.module.ts`) que monta os próprios providers; `domain/` fica livre de decorators do Nest. Num front-end, a mesma ideia vale como pastas por funcionalidade (`features/<contexto>/`), com os componentes básicos de UI num pacote de design system, e não num `components/` guardando tudo.
48
+
49
+ Regras:
50
+
51
+ - **Organize por contexto, não por camada.** Divida um contexto em `domain/application/adapters` só quando ele crescer; um contexto pequeno pode ter três arquivos.
52
+ - **As dependências apontam para dentro.** `domain/` importa só a biblioteca padrão e o próprio contexto. `adapters/` importam o domínio, nunca o contrário. `process.env` é lido em `platform/config` e passado adiante.
53
+ - **As interfaces pertencem a quem as consome.** O domínio declara `interface BookingRepository`; o adaptador de persistência a implementa. A tipagem estrutural torna isso gratuito; não crie uma interface ao lado da sua única implementação "para testar".
54
+ - **Os contextos conversam por costuras explícitas:** o serviço de aplicação do outro contexto ou eventos publicados, nunca seus arquivos internos. Respeite as relações do mapa de contextos (uma Camada Anticorrupção é um módulo que traduz).
55
+ - **Sem barrel files** dentro da aplicação. Importe o arquivo que define a coisa. A API pública de um pacote é o campo `exports` do `package.json`, não um `index.ts` que reexporta o mundo.
56
+ - **Sem pastas genéricas.** Um utilitário vai para o módulo que o usa, ou para um módulo com o nome do que ele faz (`money.ts`, `clock.ts`).
57
+ - **Aliases de caminho são ergonomia, não fronteira.** `@booking/*` em `paths` do `tsconfig` não impede um import proibido; uma regra de dependência impede.
58
+ - **Verifique as regras no CI:** regras do `dependency-cruiser`, `eslint-plugin-boundaries` ou `no-restricted-imports` por pasta. Uma regra que não é verificada é uma sugestão.
59
+ - **Um pacote só**, a menos que partes sejam versionadas ou publicadas separadamente. Aí use workspaces (npm/pnpm) e project references do TypeScript, com cada pacote expondo sua API pelo `exports`.
60
+ - **Um formato de módulo só.** Código novo é ESM (`"type": "module"`, `module: "nodenext"`, imports relativos com extensão `.js`), a menos que o projeto seja CommonJS de propósito.
61
+
62
+ ## Plano de movimentação
63
+
64
+ Cada passo compila e passa nos testes sozinho, para poder ser um commit próprio:
65
+
66
+ 1. Quebre os ciclos primeiro (mova o tipo compartilhado para o módulo dono do conceito, ou inverta com uma interface do lado de quem consome).
67
+ 2. Remova os barrel files nos caminhos que você vai mover, apontando os imports para o arquivo que define.
68
+ 3. Crie a pasta do contexto e mova os arquivos de domínio.
69
+ 4. Mova os adaptadores para trás das interfaces do domínio.
70
+ 5. Atualize a raiz de composição (`main.ts` ou o módulo raiz do Nest).
71
+ 6. Adicione as regras de dependência ao CI para a estrutura não regredir.
72
+ 7. Apague as pastas genéricas que ficaram vazias.
73
+
74
+ Use a refatoração "mover arquivo" do editor (ela reescreve os imports), ou `ts-morph` para movimentações grandes. Rode `tsc --noEmit` e os testes depois de cada passo. Evite localizar-e-substituir manual nos caminhos de import.
75
+
76
+ ## Formato
77
+
78
+ ```
79
+ ## Estado atual
80
+ | Problema | Onde | Efeito |
81
+
82
+ ## Árvore alvo
83
+ <árvore>
84
+
85
+ ## Regras de dependência
86
+ <imports permitidos entre pastas, e a ferramenta/config que os verifica>
87
+
88
+ ## Plano de movimentação
89
+ | # | Passo | Arquivos afetados | Commit |
90
+ ```
91
+
92
+ ## Próximo
93
+
94
+ - `ts-code-review` verifica se o código novo respeita as regras de dependência.
95
+ - `commit-message`: um commit `refactor` por passo.
96
+
97
+ ## Evite
98
+
99
+ - `models/`, `services/`, `controllers/`, `utils/` no primeiro nível.
100
+ - Barrel files `index.ts` reexportando uma pasta inteira.
101
+ - Aliases de caminho do `tsconfig` usados como se fossem fronteiras.
102
+ - Arquivos de domínio importando o ORM, o framework HTTP ou `process.env`.
103
+ - Dividir em muitos pacotes de workspace antes de qualquer coisa ser publicada separadamente.
104
+ - Reorganizações de uma vez num commit só.
@@ -0,0 +1,89 @@
1
+ ---
2
+ name: ts-testing
3
+ description: Use quando escrever ou revisar código de teste em TypeScript ou JavaScript: casos parametrizados, o executor do projeto (Vitest, node:test, Jest), fakes escritos à mão, timers falsos e relógios injetados, asserções de erro, isolamento de HTTP e rede, testes baseados em propriedades, testes de tipos e isolamento dos testes de integração. Funciona em par com a skill `testing`, que decide o que testar.
4
+ ---
5
+
6
+ # Testes em TypeScript
7
+
8
+ Idiomas de TypeScript para código de teste. A skill `testing` decide **o que** testar e em qual camada; esta decide **como** isso é escrito em TypeScript ou JavaScript. Use as duas juntas: planeje com `testing`, escreva com `ts-testing`.
9
+
10
+ As convenções existentes no código prevalecem sobre esta skill.
11
+
12
+ ## Convenções
13
+
14
+ - Use o executor que o projeto já tem. Quando não houver nenhum: Vitest para projetos TypeScript, `node:test` para pacotes Node pequenos que querem zero dependências. Não adicione Jest a um projeto que tem Vitest, nem o contrário.
15
+ - Nenhuma biblioteca de asserção, mock ou matcher além do que o executor oferece, a menos que o projeto já a use.
16
+ - Testes unitários junto do código (`order.test.ts`); testes de integração e e2e em `test/`, com config ou padrão de nome próprios.
17
+ - Os testes passam pela checagem de tipos como o resto do código (`tsc --noEmit` os cobre). Um teste que só passa porque o executor remove os tipos não está passando.
18
+
19
+ ## Comandos
20
+
21
+ - Gate do CI: a suíte inteira mais a checagem de tipos, por exemplo `tsc --noEmit && vitest run` ou `node --test`.
22
+ - Localmente, rode só o que você está mexendo: `vitest run src/booking`, `vitest -t "<nome do caso>"`, `node --test --test-name-pattern "<nome>"`.
23
+ - A suíte rápida e a suíte de integração são comandos separados (`test` e `test:e2e`/`test:integration`).
24
+
25
+ ## Estrutura
26
+
27
+ - **Casos parametrizados**: `it.each` / `test.each` com um array de objetos nomeados, ou um `for … of` sobre os casos chamando `test(nome, …)`. Uma tabela por comportamento, não por função. Nomes dos casos na linguagem ubíqua.
28
+ - `describe` agrupa um comportamento; nada de aninhamento profundo.
29
+ - Caixa-preta por padrão: importe a API pública do módulo. Não exporte internos só para os testes alcançarem.
30
+ - Cada teste monta os próprios dados; `beforeEach` só para preparação que todos os casos de fato compartilham. Nenhum estado vazando entre testes.
31
+
32
+ ```ts
33
+ describe('Period.contains', () => {
34
+ const period = mustPeriod(start, end); // helper de teste: cria um Period válido ou falha o teste
35
+
36
+ it.each([
37
+ { name: 'no início', at: start, want: true },
38
+ { name: 'no fim', at: end, want: true },
39
+ { name: 'um milissegundo depois do fim', at: new Date(end.getTime() + 1), want: false },
40
+ ])('$name', ({ at, want }) => {
41
+ expect(period.contains(at)).toBe(want);
42
+ });
43
+ });
44
+ ```
45
+
46
+ ## Dependências
47
+
48
+ - **Fakes**: classes em memória escritas à mão implementando a interface do repositório (`class InMemoryBookingRepository implements BookingRepository`). Com tipagem estrutural, um objeto simples também serve; mantenha-o tipado.
49
+ - **Mocks**: `vi.fn()` / `mock.fn()` só para observar uma chamada que é o próprio comportamento (um evento publicado, um e-mail enviado). Não para substituir por padrão os colaboradores do sistema sob teste.
50
+ - **Mock de módulo** (`vi.mock`, `jest.mock`) é último recurso: acopla o teste a caminhos de arquivo e esconde costuras que faltam. Prefira passar a dependência.
51
+ - **Tempo**: o código de domínio recebe o tempo como parâmetro ou um relógio injetado (`() => Date`); nunca `new Date()` ou `Date.now()` dentro do domínio. Para código com timers, use timers falsos (`vi.useFakeTimers()`, `mock.timers.enable()` no `node:test`) e avance-os explicitamente. O mesmo vale para IDs e aleatoriedade.
52
+ - **Handlers HTTP**: a injeção em processo do framework (`app.inject()` no Fastify, `supertest` contra o app Nest/Express), não uma porta real.
53
+ - **HTTP de saída**: intercepte na camada de rede (`msw`, ou o `MockAgent` do `undici` para o `fetch` embutido). Falhe o teste em qualquer requisição não prevista.
54
+ - **Ambiente**: a configuração é passada; os testes nunca dependem do `.env` do desenvolvedor.
55
+
56
+ ## Erros e comparação
57
+
58
+ - Verifique o tipo ou o código do erro: `await expect(promise).rejects.toBeInstanceOf(InvalidPeriodError)`, ou um campo `code`. Nunca o texto da mensagem.
59
+ - Quando o código devolve resultados em vez de lançar (`Result`/`Either`), verifique a variante de erro, não uma exceção lançada.
60
+ - `toEqual` para comparar valores, `toStrictEqual` quando propriedades `undefined` e a identidade da classe importam. Use `expect.objectContaining` com parcimônia; asserções parciais escondem regressões.
61
+ - Sempre faça `await` ou `return` das asserções sobre promises. Um `await` faltando num `rejects` faz o teste passar sem verificar nada.
62
+
63
+ ## Dados
64
+
65
+ - Fixtures em `test/fixtures/`; builders (`aBooking({ … })`) para objetos de domínio com padrões razoáveis.
66
+ - Snapshots só para saídas grandes, estáveis e revisadas (documentos gerados, contratos serializados). Nunca para objetos que você poderia verificar campo a campo.
67
+ - **Testes baseados em propriedades** (`fast-check`) para parsers e construtores de objetos de valor que aceitam entrada externa (CPF/CNPJ, e-mails, documentos). Use os casos da tabela como semente.
68
+ - **Testes de tipos** para tipos públicos de bibliotecas: `expectTypeOf` (Vitest) ou `tsd`, rodando no CI.
69
+
70
+ ## Testes de integração
71
+
72
+ - Comando e config separados, para a suíte rápida continuar rápida.
73
+ - Dependências reais (PostgreSQL num container via Testcontainers ou um serviço do compose). Cada teste é dono dos seus dados: uma transação revertida no fim, ou um schema/banco dedicado.
74
+ - Nenhum teste depende da ordem de execução de outro.
75
+
76
+ ## Benchmarks
77
+
78
+ `vitest bench` (ou `node:test` com `performance.now()` num script dedicado) só quando desempenho é um requisito declarado. Benchmarks não rodam na suíte rápida.
79
+
80
+ ## Evite
81
+
82
+ - Um segundo framework de teste ou biblioteca de asserção.
83
+ - `new Date()`, `Math.random()`, `crypto.randomUUID()` ou estado global dentro do código sob teste.
84
+ - Verificar o texto das mensagens de erro.
85
+ - Esperas reais com `setTimeout` ou polling sem prazo.
86
+ - `vi.mock` dos seus próprios módulos como forma padrão de isolar.
87
+ - `expect(...).rejects` / `resolves` sem `await`.
88
+ - `any` nos testes para calar a checagem de tipos.
89
+ - Exportar identificadores só para os testes alcançarem.
@@ -0,0 +1,72 @@
1
+ ---
2
+ name: web-performance
3
+ description: Use quando uma aplicação web está lenta ou precisa cumprir metas de Core Web Vitals: separa dados de campo e de laboratório, diagnostica LCP, INP e CLS, revisa bundle, imagens, fontes e cache, e propõe correções ordenadas pelo efeito esperado, com verificação antes e depois.
4
+ ---
5
+
6
+ # Desempenho Web
7
+
8
+ O que importa é o que os usuários reais experimentam, no aparelho e na rede deles. Uma nota 100 no Lighthouse da sua máquina não diz nada sobre um celular intermediário em 4G. Meça no campo, diagnostique no laboratório, corrija o que a medição apontar.
9
+
10
+ A saída padrão é um **diagnóstico e correções ordenadas**. Altere código só quando o usuário pedir.
11
+
12
+ ## Convenções
13
+
14
+ - Metas: os limites "bons" das Core Web Vitals no percentil 75 dos usuários: **LCP ≤ 2,5 s**, **INP ≤ 200 ms**, **CLS ≤ 0,1**. Metas do projeto vêm de `requirements-gathering` (`RNF-NN`).
15
+ - Entradas: dados de campo (CrUX, o RUM do projeto, a biblioteca `web-vitals`), dados de laboratório (Lighthouse, DevTools Performance, WebPageTest), o build e o framework.
16
+ - Não otimize sem medição. Cada correção nomeia a métrica que melhora.
17
+
18
+ ## Meça
19
+
20
+ 1. **Campo primeiro**: o percentil 75 por página e por tipo de aparelho. Sem dados de campo, instrumente com `web-vitals` e mande para o backend de métricas (`observability`).
21
+ 2. **Laboratório** para encontrar a causa: Lighthouse e o painel Performance do DevTools com limitação de CPU (4×) e rede (4G lento), num build de produção.
22
+ 3. **Bundle**: o analisador do bundler (`next build` mostra o tamanho por rota; `vite-bundle-visualizer`, `source-map-explorer`).
23
+
24
+ ## Diagnostique
25
+
26
+ | Métrica | Causas comuns | Correções típicas |
27
+ |---|---|---|
28
+ | **LCP** (maior conteúdo visível) | Servidor lento (TTFB), imagem principal grande ou carregada tarde, CSS/JS bloqueando a renderização, conteúdo renderizado só no cliente | Cache/CDN e renderização no servidor, `fetchpriority="high"` e dimensões certas na imagem LCP, formatos modernos (AVIF/WebP), CSS crítico, remover JS que bloqueia |
29
+ | **INP** (resposta à interação) | Tarefas longas no thread principal, hidratação pesada, handlers que fazem trabalho demais, re-renderizações em cascata | Dividir tarefas longas, adiar o que não é urgente, mover trabalho para Web Workers, reduzir JS do cliente (Server Components), memoização onde a medição mostra re-renderização cara |
30
+ | **CLS** (estabilidade visual) | Imagens e iframes sem dimensões, anúncios/embeds injetados, fontes que trocam e mudam o tamanho, conteúdo inserido acima do existente | `width`/`height` ou `aspect-ratio`, espaço reservado, `font-display` com fallback de métricas ajustadas, inserir conteúdo abaixo da dobra ou em resposta a uma interação |
31
+
32
+ **Também verifique**
33
+ - **JavaScript**: o tamanho por rota, divisão de código por rota e por interação (`import()` dinâmico), dependências grandes trocáveis, polyfills desnecessários.
34
+ - **Imagens**: tamanhos responsivos (`srcset`/`sizes` ou o componente de imagem do framework), lazy loading abaixo da dobra e nunca na imagem LCP.
35
+ - **Fontes**: poucas famílias e pesos, `woff2`, pré-carregamento só da fonte usada acima da dobra.
36
+ - **Cache**: arquivos com hash e `Cache-Control: immutable`; HTML com revalidação; compressão Brotli.
37
+ - **Terceiros**: cada script de terceiro (analytics, chat, anúncios) tem um custo medido e é carregado depois do conteúdo.
38
+ - **Dados**: cascatas de requisições (uma depende da outra), respostas grandes demais, ausência de paginação (`api-design`).
39
+
40
+ ## Verifique
41
+
42
+ Repita a mesma medição de laboratório depois da mudança, no mesmo perfil, e compare. Confirme no campo depois do deploy (a janela do CrUX é de 28 dias; o RUM próprio mostra antes). Defina um orçamento de desempenho no CI (tamanho de bundle por rota, Lighthouse CI) para não regredir.
43
+
44
+ ## Formato
45
+
46
+ ```
47
+ ## Medição
48
+ | Página | Aparelho | LCP p75 | INP p75 | CLS p75 | Fonte (campo/lab) |
49
+
50
+ ## Diagnóstico
51
+ | Métrica | Causa | Evidência (trace, waterfall, bundle) |
52
+
53
+ ## Correções (ordenadas por efeito esperado / custo)
54
+ | # | Correção | Métrica | Efeito esperado | Custo |
55
+
56
+ ## Verificação e orçamento
57
+ <antes → depois; orçamento proposto para o CI>
58
+ ```
59
+
60
+ ## Próximo
61
+
62
+ - `frontend-architecture` quando a causa é estrutural (estado global, `'use client'` demais).
63
+ - `observability`: Core Web Vitals de campo como SLIs.
64
+ - `ci-pipeline-review` para o orçamento de desempenho no CI.
65
+
66
+ ## Evite
67
+
68
+ - Otimizar pela nota do Lighthouse em vez das métricas de campo.
69
+ - Medir em modo de desenvolvimento ou numa máquina potente sem limitação.
70
+ - Lazy loading na imagem do LCP.
71
+ - Memoizar tudo "por precaução".
72
+ - Afirmar uma melhora sem números de antes e depois.
@@ -1,25 +0,0 @@
1
- # Environment Variables for SaaS Starter
2
-
3
- ## Server
4
- NODE_ENV=development
5
- PORT=3000
6
-
7
- ## Database
8
- DB_HOST=localhost
9
- DB_PORT=5432
10
- DB_USER=postgres
11
- DB_PASSWORD=postgres
12
- DB_NAME=saas_starter
13
- DB_LOGGING=false
14
-
15
- ## JWT
16
- JWT_SECRET=your-secret-key-here-change-in-production
17
- JWT_REFRESH_SECRET=your-refresh-secret-key-here-change-in-production
18
-
19
- ## Redis
20
- REDIS_HOST=localhost
21
- REDIS_PORT=6379
22
-
23
- ## Stripe (Future)
24
- STRIPE_API_KEY=sk_test_your_key_here
25
- STRIPE_WEBHOOK_SECRET=whsec_your_secret_here
@@ -1,190 +0,0 @@
1
- # SaaS Starter - Checklist de Criação ✅
2
-
3
- Data: 2024-01-15
4
- Status: **COMPLETO** 🚀
5
-
6
- ## Memory Structure (10 Níveis) ✅
7
-
8
- ### 00-Global (Políticas & Princípios)
9
- - ✅ mission.md — Visão, objetivos, papéis de agentes
10
- - ✅ patterns.md — Code patterns, conventions, testing
11
- - ✅ context-policy.md — Gestão de níveis, freshness, limpeza
12
- - ✅ agent-contract.md — Ciclo de vida, responsabilidades, handoffs
13
- - ✅ index.md — Índice completo com navegação
14
-
15
- ### 10-Product (Visão & Regras)
16
- - ✅ vision.md — Proposição de valor, diferencial, 12-month vision
17
- - ✅ personas.md — Buyer personas, user journeys, feature prioritization
18
- - ✅ business-rules.md — Planos, billing, RBAC, compliance, cancellation
19
- - ✅ nfrs.md — Performance, scalability, security, compliance requirements
20
-
21
- ### 20-Architecture (Decisões Técnicas)
22
- - ✅ overview.md — Diagrama, stack, fluxos, padrões, fases
23
-
24
- ### 30-Domains (Domínios de Negócio)
25
- - ✅ auth/context.md — O que é auth, fluxos, regras, status
26
- - ✅ auth/api.md — 5 endpoints (signup, login, refresh, logout, me) + examples
27
- - ✅ subscriptions/context.md — Planos, fluxos, regras, métricas
28
- - ✅ subscriptions/api.md — 5 endpoints (get, create, upgrade, cancel, usage)
29
- - ✅ billing/context.md — Pagamentos, gateway mock, invoices, regras
30
- - ✅ billing/api.md — 8 endpoints (charge, invoices, refunds, payment methods)
31
-
32
- ### 40-Delivery (Roadmap & Sprints)
33
- - ✅ roadmap.md — 12 meses, Q1-Q4 goals, risks, metrics
34
- - ✅ sprint-atual.md — Sprint 1 tasks, blockers, velocity
35
- - ✅ backlog.md — P0-P3 itens, dependencies, capacity planning
36
-
37
- ### 50-Orchestration (Topologia de Agents)
38
- - ✅ topology.md — Sequência, parallelização, timeline, success criteria
39
- - ✅ handoffs/ — Diretório preparado para handoff documents
40
-
41
- ### 60-Runs (Logs de Execução)
42
- - ✅ index.md — Índice com template de run document
43
-
44
- ### 70-Summaries (Sínteses Executivas)
45
- - ✅ global.md — Status geral, funcionalidades, metrics, bloqueadores
46
-
47
- ### 80-Data (Schemas & Migrations)
48
- - ✅ schema.md — 7 entidades (User, Org, Subscription, Invoice, Transaction, AuditLog, APIKey)
49
- - ✅ Relacionamentos, constraints, indexes documentados
50
-
51
- ### 90-Decisions (ADRs)
52
- - ✅ adr-template.md — Template + exemplo (PostgreSQL choice)
53
-
54
- ## Backend NestJS ✅
55
-
56
- ### Entities (5 criadas)
57
- - ✅ User — Email, roles, tenant isolation
58
- - ✅ Organization — Plan, tenantId, owner
59
- - ✅ Subscription — Plan, status, billing period
60
- - ✅ Invoice — Charges, payment status, items
61
- - ✅ Imports no database.ts
62
-
63
- ### Modules (5 completos)
64
-
65
- #### Auth Module
66
- - ✅ auth.service.ts — Signup, login, validateUser, token generation
67
- - ✅ auth.controller.ts — 5 endpoints (signup, login, refresh, logout, me)
68
- - ✅ jwt.strategy.ts — JWT validation
69
- - ✅ local.strategy.ts — Email/password validation
70
- - ✅ auth.dto.ts — SignupDto, LoginDto, RefreshTokenDto
71
- - ✅ auth.module.ts — Module definition com imports
72
-
73
- #### Organizations Module
74
- - ✅ organizations.service.ts — findByTenantId, create, updatePlan
75
- - ✅ organizations.controller.ts — GET /organizations
76
- - ✅ organizations.module.ts — Module definition
77
- - ✅ organization.entity.ts — Entity com indexes
78
-
79
- #### Users Module
80
- - ✅ users.service.ts — findById, findByEmail, create, updateRoles, list
81
- - ✅ users.controller.ts — GET /users
82
- - ✅ users.module.ts — Module definition
83
- - ✅ user.entity.ts — Entity com RBAC roles
84
-
85
- #### Subscriptions Module
86
- - ✅ subscriptions.service.ts — getOrCreate, upgrade, getUsage (planos + validação)
87
- - ✅ subscriptions.controller.ts — GET, POST /subscriptions/{id}/upgrade, usage
88
- - ✅ subscriptions.module.ts — Module definition
89
- - ✅ subscription.entity.ts — Entity com status
90
-
91
- #### Billing Module
92
- - ✅ billing.service.ts — charge (mock 90% success), getInvoices, createInvoice
93
- - ✅ billing.controller.ts — POST charge, GET invoices
94
- - ✅ billing.module.ts — Module definition
95
- - ✅ invoice.entity.ts — Entity com items JSONB
96
-
97
- ### Common (Decorators & Guards)
98
- - ✅ roles.decorator.ts — @Roles decorator para RBAC
99
- - ✅ tenant.decorator.ts — @TenantId param decorator
100
- - ✅ roles.guard.ts — RolesGuard para validação
101
-
102
- ### Configuration
103
- - ✅ database.ts — TypeOrmConfigService com env vars
104
- - ✅ app.module.ts — Global imports, TypeORM setup
105
- - ✅ main.ts — Bootstrap, ValidationPipe, Swagger docs
106
-
107
- ### Package & Config
108
- - ✅ package.json — 30+ dependencies, scripts, jest config
109
- - ✅ tsconfig.json — Strict mode, path aliases
110
-
111
- ## Docker & Environment ✅
112
-
113
- - ✅ docker-compose.yml — PostgreSQL + Redis com health checks
114
- - ✅ .env.example — Todas as variáveis documentadas
115
- - ✅ .gitignore — Node_modules, dist, logs, env files
116
-
117
- ## Documentation ✅
118
-
119
- - ✅ README.md — 8KB, features, quick start, examples, architecture
120
- - ✅ QUICK_START.md — 5-minute setup, curl examples, troubleshooting
121
- - ✅ 50+ páginas de documentação em memory/
122
-
123
- ## Totais
124
-
125
- | Item | Quantidade |
126
- |------|-----------|
127
- | Arquivos TypeScript | 25 |
128
- | Documentos Markdown | 30 |
129
- | Entidades | 5 |
130
- | Modules | 5 |
131
- | Endpoints implementados | 18 |
132
- | Decorators & Guards | 3 |
133
- | Estratégias de Auth | 2 |
134
- | Linhas de Código | ~5,000 |
135
- | Linhas de Docs | ~20,000 |
136
-
137
- ## Pré-Requisitos Atendidos
138
-
139
- - ✅ Estrutura OBRIGATÓRIA (copy-paste 01-api-rest adaptado para SaaS)
140
- - ✅ Memory/ 10 níveis, SaaS-focado
141
- - ✅ Backend NestJS com módulos SaaS specifics
142
- - ✅ TypeScript, siga padrões NestJS
143
- - ✅ Tudo criado, nada vazio
144
- - ✅ README.md (SaaS-focado)
145
- - ✅ .env.example
146
- - ✅ QUICK_START.md
147
- - ✅ Conteúdo Específico SaaS (auth, subscriptions, billing, multi-tenant, RBAC)
148
-
149
- ## Como Usar
150
-
151
- ### Próximo Passo: Setup Agent
152
- ```bash
153
- cd boilerplates/02-saas-starter
154
- npm install
155
- docker-compose up -d
156
- cp .env.example .env.local
157
- npm run start:dev
158
- ```
159
-
160
- ### Testar API
161
- ```bash
162
- # Signup
163
- curl -X POST http://localhost:3000/api/auth/signup ...
164
-
165
- # Login
166
- curl -X POST http://localhost:3000/api/auth/login-email ...
167
-
168
- # Upgrade
169
- curl -X POST http://localhost:3000/api/subscriptions/{id}/upgrade ...
170
- ```
171
-
172
- ### Estender
173
- 1. Leia patterns em memory/00-global/patterns.md
174
- 2. Siga convenções (services/controllers/entities)
175
- 3. Documente em memory/30-domains/
176
- 4. Implemente testes
177
-
178
- ## Status Final
179
-
180
- **🚀 PRONTO PARA DESENVOLVIMENTO**
181
-
182
- Todos os componentes criados, documentados e funcionais.
183
- Próxima fase: Agentes implementarem funcionalidades.
184
-
185
- ---
186
-
187
- **Criado em**: 2024-01-15
188
- **Tempo de Criação**: ~2 horas
189
- **Qualidade**: Production-ready
190
- **Testado**: ✅ Estrutura validada