@su-record/vibe 2.7.12 → 2.7.13

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 (331) hide show
  1. package/.env.example +37 -37
  2. package/CLAUDE.md +126 -126
  3. package/LICENSE +21 -21
  4. package/README.md +449 -580
  5. package/agents/architect-low.md +41 -41
  6. package/agents/architect-medium.md +59 -59
  7. package/agents/architect.md +80 -80
  8. package/agents/build-error-resolver.md +115 -115
  9. package/agents/compounder.md +261 -261
  10. package/agents/diagrammer.md +178 -178
  11. package/agents/docs/api-documenter.md +99 -99
  12. package/agents/docs/changelog-writer.md +93 -93
  13. package/agents/e2e-tester.md +294 -266
  14. package/agents/explorer-low.md +42 -42
  15. package/agents/explorer-medium.md +59 -59
  16. package/agents/explorer.md +48 -48
  17. package/agents/implementer-low.md +43 -43
  18. package/agents/implementer-medium.md +52 -52
  19. package/agents/implementer.md +54 -54
  20. package/agents/junior-mentor.md +141 -141
  21. package/agents/planning/requirements-analyst.md +84 -84
  22. package/agents/planning/ux-advisor.md +83 -83
  23. package/agents/qa/acceptance-tester.md +86 -86
  24. package/agents/qa/edge-case-finder.md +93 -93
  25. package/agents/refactor-cleaner.md +143 -143
  26. package/agents/research/best-practices-agent.md +199 -199
  27. package/agents/research/codebase-patterns-agent.md +157 -157
  28. package/agents/research/framework-docs-agent.md +188 -188
  29. package/agents/research/security-advisory-agent.md +213 -213
  30. package/agents/review/architecture-reviewer.md +107 -107
  31. package/agents/review/complexity-reviewer.md +116 -116
  32. package/agents/review/data-integrity-reviewer.md +88 -88
  33. package/agents/review/git-history-reviewer.md +103 -103
  34. package/agents/review/performance-reviewer.md +86 -86
  35. package/agents/review/python-reviewer.md +150 -150
  36. package/agents/review/rails-reviewer.md +139 -139
  37. package/agents/review/react-reviewer.md +144 -144
  38. package/agents/review/security-reviewer.md +80 -80
  39. package/agents/review/simplicity-reviewer.md +140 -140
  40. package/agents/review/test-coverage-reviewer.md +116 -116
  41. package/agents/review/typescript-reviewer.md +127 -127
  42. package/agents/searcher.md +54 -54
  43. package/agents/simplifier.md +120 -120
  44. package/agents/tester.md +49 -49
  45. package/agents/ui/ui-a11y-auditor.md +93 -93
  46. package/agents/ui/ui-antipattern-detector.md +94 -94
  47. package/agents/ui/ui-dataviz-advisor.md +69 -69
  48. package/agents/ui/ui-design-system-gen.md +57 -57
  49. package/agents/ui/ui-industry-analyzer.md +49 -49
  50. package/agents/ui/ui-layout-architect.md +65 -65
  51. package/agents/ui/ui-stack-implementer.md +68 -68
  52. package/agents/ui/ux-compliance-reviewer.md +81 -81
  53. package/agents/ui-previewer.md +260 -260
  54. package/commands/vibe.analyze.md +8 -0
  55. package/commands/vibe.review.md +10 -3
  56. package/commands/vibe.run.md +2078 -2022
  57. package/commands/vibe.spec.md +10 -10
  58. package/commands/vibe.spec.review.md +565 -558
  59. package/commands/vibe.utils.md +413 -413
  60. package/commands/vibe.verify.md +45 -0
  61. package/dist/cli/auth.d.ts.map +1 -1
  62. package/dist/cli/auth.js +1 -7
  63. package/dist/cli/auth.js.map +1 -1
  64. package/dist/cli/collaborator.js +52 -52
  65. package/dist/cli/commands/evolution.js +12 -12
  66. package/dist/cli/commands/info.d.ts.map +1 -1
  67. package/dist/cli/commands/info.js +55 -70
  68. package/dist/cli/commands/info.js.map +1 -1
  69. package/dist/cli/commands/init.d.ts.map +1 -1
  70. package/dist/cli/commands/init.js +6 -7
  71. package/dist/cli/commands/init.js.map +1 -1
  72. package/dist/cli/commands/remove.js +14 -14
  73. package/dist/cli/commands/sentinel.js +27 -27
  74. package/dist/cli/commands/setup.js +1 -1
  75. package/dist/cli/commands/setup.js.map +1 -1
  76. package/dist/cli/commands/skills.js +5 -5
  77. package/dist/cli/commands/slack.js +10 -10
  78. package/dist/cli/commands/telegram.js +12 -12
  79. package/dist/cli/commands/update.d.ts.map +1 -1
  80. package/dist/cli/commands/update.js +3 -4
  81. package/dist/cli/commands/update.js.map +1 -1
  82. package/dist/cli/detect.js +32 -32
  83. package/dist/cli/index.js +51 -55
  84. package/dist/cli/index.js.map +1 -1
  85. package/dist/cli/llm/claude-commands.js +16 -16
  86. package/dist/cli/llm/config.js +19 -19
  87. package/dist/cli/llm/config.js.map +1 -1
  88. package/dist/cli/llm/gemini-commands.d.ts +4 -6
  89. package/dist/cli/llm/gemini-commands.d.ts.map +1 -1
  90. package/dist/cli/llm/gemini-commands.js +52 -322
  91. package/dist/cli/llm/gemini-commands.js.map +1 -1
  92. package/dist/cli/llm/gpt-commands.js +21 -21
  93. package/dist/cli/llm/gpt-commands.js.map +1 -1
  94. package/dist/cli/llm/help.js +21 -21
  95. package/dist/cli/postinstall/constants.js +1 -1
  96. package/dist/cli/postinstall/constants.js.map +1 -1
  97. package/dist/cli/postinstall/cursor-agents.js +32 -32
  98. package/dist/cli/postinstall/cursor-rules.js +83 -83
  99. package/dist/cli/postinstall/cursor-skills.js +743 -743
  100. package/dist/cli/postinstall/inline-skills.js +1 -1
  101. package/dist/cli/postinstall/inline-skills.js.map +1 -1
  102. package/dist/cli/setup/Provisioner.js +42 -42
  103. package/dist/cli/types.d.ts +2 -16
  104. package/dist/cli/types.d.ts.map +1 -1
  105. package/dist/cli/utils.d.ts +0 -9
  106. package/dist/cli/utils.d.ts.map +1 -1
  107. package/dist/cli/utils.js +0 -28
  108. package/dist/cli/utils.js.map +1 -1
  109. package/dist/infra/lib/DeepInit.js +24 -24
  110. package/dist/infra/lib/IterationTracker.js +11 -11
  111. package/dist/infra/lib/PythonParser.js +108 -108
  112. package/dist/infra/lib/ReviewRace.js +96 -96
  113. package/dist/infra/lib/SkillFrontmatter.js +28 -28
  114. package/dist/infra/lib/SkillQualityGate.js +9 -9
  115. package/dist/infra/lib/SkillRepository.js +159 -159
  116. package/dist/infra/lib/UltraQA.js +99 -99
  117. package/dist/infra/lib/autonomy/AuditStore.js +41 -41
  118. package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
  119. package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
  120. package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
  121. package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
  122. package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
  123. package/dist/infra/lib/config/GlobalConfigManager.d.ts +0 -2
  124. package/dist/infra/lib/config/GlobalConfigManager.d.ts.map +1 -1
  125. package/dist/infra/lib/config/GlobalConfigManager.js +0 -27
  126. package/dist/infra/lib/config/GlobalConfigManager.js.map +1 -1
  127. package/dist/infra/lib/embedding/VectorStore.js +22 -22
  128. package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
  129. package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
  130. package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
  131. package/dist/infra/lib/evolution/InsightStore.js +90 -90
  132. package/dist/infra/lib/evolution/RollbackManager.js +5 -5
  133. package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
  134. package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
  135. package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
  136. package/dist/infra/lib/evolution/UsageTracker.js +28 -28
  137. package/dist/infra/lib/gemini/auth.d.ts +4 -16
  138. package/dist/infra/lib/gemini/auth.d.ts.map +1 -1
  139. package/dist/infra/lib/gemini/auth.js +10 -405
  140. package/dist/infra/lib/gemini/auth.js.map +1 -1
  141. package/dist/infra/lib/gemini/capabilities.d.ts +4 -8
  142. package/dist/infra/lib/gemini/capabilities.d.ts.map +1 -1
  143. package/dist/infra/lib/gemini/capabilities.js +8 -166
  144. package/dist/infra/lib/gemini/capabilities.js.map +1 -1
  145. package/dist/infra/lib/gemini/chat.d.ts +4 -13
  146. package/dist/infra/lib/gemini/chat.d.ts.map +1 -1
  147. package/dist/infra/lib/gemini/chat.js +10 -323
  148. package/dist/infra/lib/gemini/chat.js.map +1 -1
  149. package/dist/infra/lib/gemini/completion.d.ts +5 -15
  150. package/dist/infra/lib/gemini/completion.d.ts.map +1 -1
  151. package/dist/infra/lib/gemini/completion.js +6 -97
  152. package/dist/infra/lib/gemini/completion.js.map +1 -1
  153. package/dist/infra/lib/gemini/constants.d.ts +2 -31
  154. package/dist/infra/lib/gemini/constants.d.ts.map +1 -1
  155. package/dist/infra/lib/gemini/constants.js +2 -77
  156. package/dist/infra/lib/gemini/constants.js.map +1 -1
  157. package/dist/infra/lib/gemini/index.d.ts +5 -8
  158. package/dist/infra/lib/gemini/index.d.ts.map +1 -1
  159. package/dist/infra/lib/gemini/index.js +4 -7
  160. package/dist/infra/lib/gemini/index.js.map +1 -1
  161. package/dist/infra/lib/gemini/models.d.ts +3 -4
  162. package/dist/infra/lib/gemini/models.d.ts.map +1 -1
  163. package/dist/infra/lib/gemini/models.js +8 -84
  164. package/dist/infra/lib/gemini/models.js.map +1 -1
  165. package/dist/infra/lib/gemini/orchestration.js +5 -5
  166. package/dist/infra/lib/gemini/types.d.ts +16 -44
  167. package/dist/infra/lib/gemini/types.d.ts.map +1 -1
  168. package/dist/infra/lib/gemini/types.js +1 -1
  169. package/dist/infra/lib/gpt/auth.d.ts +2 -5
  170. package/dist/infra/lib/gpt/auth.d.ts.map +1 -1
  171. package/dist/infra/lib/gpt/auth.js +8 -38
  172. package/dist/infra/lib/gpt/auth.js.map +1 -1
  173. package/dist/infra/lib/gpt/chat.d.ts +3 -3
  174. package/dist/infra/lib/gpt/chat.d.ts.map +1 -1
  175. package/dist/infra/lib/gpt/chat.js +37 -53
  176. package/dist/infra/lib/gpt/chat.js.map +1 -1
  177. package/dist/infra/lib/gpt/constants.d.ts +2 -5
  178. package/dist/infra/lib/gpt/constants.d.ts.map +1 -1
  179. package/dist/infra/lib/gpt/constants.js +4 -9
  180. package/dist/infra/lib/gpt/constants.js.map +1 -1
  181. package/dist/infra/lib/gpt/embedding.d.ts +1 -1
  182. package/dist/infra/lib/gpt/embedding.js +3 -3
  183. package/dist/infra/lib/gpt/embedding.js.map +1 -1
  184. package/dist/infra/lib/gpt/oauth.d.ts +6 -39
  185. package/dist/infra/lib/gpt/oauth.d.ts.map +1 -1
  186. package/dist/infra/lib/gpt/oauth.js +8 -340
  187. package/dist/infra/lib/gpt/oauth.js.map +1 -1
  188. package/dist/infra/lib/gpt/orchestration.js +5 -5
  189. package/dist/infra/lib/gpt/orchestration.js.map +1 -1
  190. package/dist/infra/lib/gpt/specializations.d.ts +2 -2
  191. package/dist/infra/lib/gpt/specializations.js +3 -3
  192. package/dist/infra/lib/gpt/specializations.js.map +1 -1
  193. package/dist/infra/lib/gpt/types.d.ts +1 -1
  194. package/dist/infra/lib/gpt/types.d.ts.map +1 -1
  195. package/dist/infra/lib/llm/auth/AuthProfileManager.d.ts +2 -2
  196. package/dist/infra/lib/llm/auth/AuthProfileManager.d.ts.map +1 -1
  197. package/dist/infra/lib/llm/auth/AuthProfileManager.js.map +1 -1
  198. package/dist/infra/lib/llm/auth/AuthProfileManager.test.js +1 -1
  199. package/dist/infra/lib/llm/auth/AuthProfileManager.test.js.map +1 -1
  200. package/dist/infra/lib/llm/auth/TokenRefresher.d.ts +1 -1
  201. package/dist/infra/lib/llm/auth/TokenRefresher.js +1 -1
  202. package/dist/infra/lib/llm/auth/index.d.ts +2 -12
  203. package/dist/infra/lib/llm/auth/index.d.ts.map +1 -1
  204. package/dist/infra/lib/llm/auth/index.js +5 -63
  205. package/dist/infra/lib/llm/auth/index.js.map +1 -1
  206. package/dist/infra/lib/llm/types.d.ts +1 -1
  207. package/dist/infra/lib/llm/types.d.ts.map +1 -1
  208. package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
  209. package/dist/infra/lib/memory/MemorySearch.js +57 -57
  210. package/dist/infra/lib/memory/MemoryStorage.js +181 -181
  211. package/dist/infra/lib/memory/ObservationStore.js +28 -28
  212. package/dist/infra/lib/memory/ReflectionStore.js +30 -30
  213. package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
  214. package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
  215. package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
  216. package/dist/infra/orchestrator/AgentManager.js +12 -12
  217. package/dist/infra/orchestrator/AgentRegistry.js +65 -65
  218. package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
  219. package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
  220. package/dist/infra/orchestrator/parallelResearch.js +24 -24
  221. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  222. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  223. package/dist/tools/memory/createMemoryTimeline.js +10 -10
  224. package/dist/tools/memory/getMemoryGraph.js +12 -12
  225. package/dist/tools/memory/getSessionContext.js +9 -9
  226. package/dist/tools/memory/linkMemories.js +14 -14
  227. package/dist/tools/memory/listMemories.js +4 -4
  228. package/dist/tools/memory/recallMemory.js +4 -4
  229. package/dist/tools/memory/saveMemory.js +4 -4
  230. package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
  231. package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
  232. package/dist/tools/semantic/astGrep.test.js +6 -6
  233. package/dist/tools/spec/prdParser.test.js +171 -171
  234. package/dist/tools/spec/specGenerator.js +169 -169
  235. package/dist/tools/spec/traceabilityMatrix.js +64 -64
  236. package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
  237. package/hooks/gemini-hooks.json +73 -73
  238. package/hooks/hooks.json +137 -137
  239. package/hooks/scripts/code-check.js +70 -70
  240. package/hooks/scripts/context-save.js +212 -212
  241. package/hooks/scripts/hud-status.js +291 -291
  242. package/hooks/scripts/keyword-detector.js +214 -214
  243. package/hooks/scripts/llm-orchestrate.js +475 -646
  244. package/hooks/scripts/post-edit.js +32 -32
  245. package/hooks/scripts/pre-tool-guard.js +125 -125
  246. package/hooks/scripts/prompt-dispatcher.js +185 -185
  247. package/hooks/scripts/sentinel-guard.js +104 -104
  248. package/hooks/scripts/session-start.js +106 -106
  249. package/hooks/scripts/stop-notify.js +209 -209
  250. package/hooks/scripts/utils.js +100 -100
  251. package/languages/csharp-unity.md +515 -515
  252. package/languages/gdscript-godot.md +470 -470
  253. package/languages/ruby-rails.md +489 -489
  254. package/languages/typescript-angular.md +433 -433
  255. package/languages/typescript-astro.md +416 -416
  256. package/languages/typescript-electron.md +406 -406
  257. package/languages/typescript-nestjs.md +524 -524
  258. package/languages/typescript-svelte.md +407 -407
  259. package/languages/typescript-tauri.md +365 -365
  260. package/package.json +121 -121
  261. package/skills/agents-md/SKILL.md +120 -120
  262. package/skills/arch-guard/SKILL.md +180 -180
  263. package/skills/brand-assets/SKILL.md +146 -146
  264. package/skills/capability-loop/SKILL.md +167 -167
  265. package/skills/characterization-test/SKILL.md +206 -206
  266. package/skills/commerce-patterns/SKILL.md +59 -59
  267. package/skills/commit-push-pr/SKILL.md +75 -75
  268. package/skills/context7-usage/SKILL.md +105 -105
  269. package/skills/core-capabilities/SKILL.md +48 -48
  270. package/skills/e2e-commerce/SKILL.md +57 -57
  271. package/skills/exec-plan/SKILL.md +147 -147
  272. package/skills/frontend-design/SKILL.md +73 -73
  273. package/skills/git-worktree/SKILL.md +72 -72
  274. package/skills/handoff/SKILL.md +109 -109
  275. package/skills/parallel-research/SKILL.md +87 -87
  276. package/skills/priority-todos/SKILL.md +63 -63
  277. package/skills/seo-checklist/SKILL.md +57 -57
  278. package/skills/techdebt/SKILL.md +122 -122
  279. package/skills/tool-fallback/SKILL.md +103 -103
  280. package/skills/typescript-advanced-types/SKILL.md +65 -65
  281. package/skills/ui-ux-pro-max/SKILL.md +206 -206
  282. package/skills/vercel-react-best-practices/SKILL.md +59 -59
  283. package/skills/video-production/SKILL.md +51 -51
  284. package/vibe/config.json +29 -29
  285. package/vibe/constitution.md +227 -227
  286. package/vibe/rules/principles/communication-guide.md +98 -98
  287. package/vibe/rules/principles/development-philosophy.md +52 -52
  288. package/vibe/rules/principles/quick-start.md +102 -102
  289. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  290. package/vibe/rules/quality/checklist.md +276 -276
  291. package/vibe/rules/quality/performance.md +236 -236
  292. package/vibe/rules/quality/testing-strategy.md +440 -440
  293. package/vibe/rules/standards/anti-patterns.md +541 -541
  294. package/vibe/rules/standards/code-structure.md +291 -291
  295. package/vibe/rules/standards/complexity-metrics.md +313 -313
  296. package/vibe/rules/standards/git-workflow.md +237 -237
  297. package/vibe/rules/standards/naming-conventions.md +198 -198
  298. package/vibe/rules/standards/security.md +305 -305
  299. package/vibe/rules/writing/document-style.md +74 -74
  300. package/vibe/setup.sh +31 -31
  301. package/vibe/templates/constitution-template.md +252 -252
  302. package/vibe/templates/contract-backend-template.md +526 -526
  303. package/vibe/templates/contract-frontend-template.md +599 -599
  304. package/vibe/templates/feature-template.md +96 -96
  305. package/vibe/templates/spec-template.md +221 -221
  306. package/vibe/ui-ux-data/charts.csv +26 -26
  307. package/vibe/ui-ux-data/colors.csv +97 -97
  308. package/vibe/ui-ux-data/icons.csv +101 -101
  309. package/vibe/ui-ux-data/landing.csv +31 -31
  310. package/vibe/ui-ux-data/products.csv +96 -96
  311. package/vibe/ui-ux-data/react-performance.csv +45 -45
  312. package/vibe/ui-ux-data/stacks/astro.csv +54 -54
  313. package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
  314. package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
  315. package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
  316. package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
  317. package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
  318. package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
  319. package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
  320. package/vibe/ui-ux-data/stacks/react.csv +54 -54
  321. package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
  322. package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
  323. package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
  324. package/vibe/ui-ux-data/stacks/vue.csv +50 -50
  325. package/vibe/ui-ux-data/styles.csv +68 -68
  326. package/vibe/ui-ux-data/typography.csv +57 -57
  327. package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
  328. package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
  329. package/vibe/ui-ux-data/version.json +31 -31
  330. package/vibe/ui-ux-data/web-interface.csv +31 -31
  331. package/commands/vibe.voice.md +0 -79
@@ -1,524 +1,524 @@
1
- # 🐱 TypeScript + NestJS Quality Rules
2
-
3
- ## Core Principles (inherited from core)
4
-
5
- ```markdown
6
- ✅ Single Responsibility (SRP)
7
- ✅ Don't Repeat Yourself (DRY)
8
- ✅ Reusability
9
- ✅ Low Complexity
10
- ✅ Functions ≤ 30 lines
11
- ✅ Nesting ≤ 3 levels
12
- ✅ Cyclomatic complexity ≤ 10
13
- ```
14
-
15
- ## NestJS Architecture
16
-
17
- ```
18
- ┌─────────────────────────────────────────────┐
19
- │ Controller (HTTP Request Handling) │
20
- │ - Routing, request validation, response │
21
- ├─────────────────────────────────────────────┤
22
- │ Service (Business Logic) │
23
- │ - Domain logic, data processing │
24
- ├─────────────────────────────────────────────┤
25
- │ Repository (Data Access) │
26
- │ - DB queries, ORM operations │
27
- └─────────────────────────────────────────────┘
28
- ```
29
-
30
- ## TypeScript/NestJS Patterns
31
-
32
- ### 1. Module Structure
33
-
34
- ```typescript
35
- // ✅ Feature Module
36
- @Module({
37
- imports: [
38
- TypeOrmModule.forFeature([User]),
39
- CommonModule,
40
- ],
41
- controllers: [UserController],
42
- providers: [UserService, UserRepository],
43
- exports: [UserService],
44
- })
45
- export class UserModule {}
46
-
47
- // ✅ Module folder structure
48
- // src/
49
- // ├── user/
50
- // │ ├── user.module.ts
51
- // │ ├── user.controller.ts
52
- // │ ├── user.service.ts
53
- // │ ├── user.repository.ts
54
- // │ ├── dto/
55
- // │ │ ├── create-user.dto.ts
56
- // │ │ └── update-user.dto.ts
57
- // │ └── entities/
58
- // │ └── user.entity.ts
59
- ```
60
-
61
- ### 2. Controller Pattern
62
-
63
- ```typescript
64
- // ✅ Controller
65
- @Controller('users')
66
- @ApiTags('users')
67
- export class UserController {
68
- constructor(private readonly userService: UserService) {}
69
-
70
- @Get()
71
- @ApiOperation({ summary: 'Get all users' })
72
- @ApiResponse({ status: 200, type: [UserResponseDto] })
73
- async findAll(@Query() query: FindUsersQueryDto): Promise<UserResponseDto[]> {
74
- return this.userService.findAll(query);
75
- }
76
-
77
- @Get(':id')
78
- @ApiOperation({ summary: 'Get user by ID' })
79
- @ApiResponse({ status: 200, type: UserResponseDto })
80
- @ApiResponse({ status: 404, description: 'User not found' })
81
- async findOne(@Param('id', ParseUUIDPipe) id: string): Promise<UserResponseDto> {
82
- return this.userService.findOne(id);
83
- }
84
-
85
- @Post()
86
- @ApiOperation({ summary: 'Create user' })
87
- @ApiResponse({ status: 201, type: UserResponseDto })
88
- async create(@Body() createUserDto: CreateUserDto): Promise<UserResponseDto> {
89
- return this.userService.create(createUserDto);
90
- }
91
-
92
- @Patch(':id')
93
- async update(
94
- @Param('id', ParseUUIDPipe) id: string,
95
- @Body() updateUserDto: UpdateUserDto,
96
- ): Promise<UserResponseDto> {
97
- return this.userService.update(id, updateUserDto);
98
- }
99
-
100
- @Delete(':id')
101
- @HttpCode(HttpStatus.NO_CONTENT)
102
- async remove(@Param('id', ParseUUIDPipe) id: string): Promise<void> {
103
- await this.userService.remove(id);
104
- }
105
- }
106
- ```
107
-
108
- ### 3. Service Pattern
109
-
110
- ```typescript
111
- // ✅ Service
112
- @Injectable()
113
- export class UserService {
114
- constructor(
115
- private readonly userRepository: UserRepository,
116
- private readonly eventEmitter: EventEmitter2,
117
- ) {}
118
-
119
- async findAll(query: FindUsersQueryDto): Promise<User[]> {
120
- return this.userRepository.findWithPagination(query);
121
- }
122
-
123
- async findOne(id: string): Promise<User> {
124
- const user = await this.userRepository.findById(id);
125
- if (!user) {
126
- throw new NotFoundException(`User with ID ${id} not found`);
127
- }
128
- return user;
129
- }
130
-
131
- async create(dto: CreateUserDto): Promise<User> {
132
- const existingUser = await this.userRepository.findByEmail(dto.email);
133
- if (existingUser) {
134
- throw new ConflictException('Email already exists');
135
- }
136
-
137
- const user = await this.userRepository.create(dto);
138
- this.eventEmitter.emit('user.created', new UserCreatedEvent(user));
139
- return user;
140
- }
141
-
142
- async update(id: string, dto: UpdateUserDto): Promise<User> {
143
- const user = await this.findOne(id);
144
- return this.userRepository.update(user.id, dto);
145
- }
146
-
147
- async remove(id: string): Promise<void> {
148
- const user = await this.findOne(id);
149
- await this.userRepository.softDelete(user.id);
150
- this.eventEmitter.emit('user.deleted', new UserDeletedEvent(user));
151
- }
152
- }
153
- ```
154
-
155
- ### 4. DTO + Validation
156
-
157
- ```typescript
158
- // ✅ Request DTO
159
- export class CreateUserDto {
160
- @ApiProperty({ example: 'john@example.com' })
161
- @IsEmail()
162
- @IsNotEmpty()
163
- email: string;
164
-
165
- @ApiProperty({ example: 'John Doe' })
166
- @IsString()
167
- @MinLength(2)
168
- @MaxLength(100)
169
- name: string;
170
-
171
- @ApiProperty({ example: 'password123' })
172
- @IsString()
173
- @MinLength(8)
174
- @Matches(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)/, {
175
- message: 'Password must contain uppercase, lowercase, and number',
176
- })
177
- password: string;
178
- }
179
-
180
- // ✅ Response DTO (only Expose fields are visible)
181
- @Exclude()
182
- export class UserResponseDto {
183
- @Expose()
184
- @ApiProperty()
185
- id: string;
186
-
187
- @Expose()
188
- @ApiProperty()
189
- email: string;
190
-
191
- @Expose()
192
- @ApiProperty()
193
- name: string;
194
-
195
- @Expose()
196
- @ApiProperty()
197
- createdAt: Date;
198
-
199
- // password is excluded
200
- }
201
-
202
- // ✅ Query DTO
203
- export class FindUsersQueryDto {
204
- @ApiPropertyOptional()
205
- @IsOptional()
206
- @IsString()
207
- search?: string;
208
-
209
- @ApiPropertyOptional({ default: 1 })
210
- @IsOptional()
211
- @Type(() => Number)
212
- @IsInt()
213
- @Min(1)
214
- page?: number = 1;
215
-
216
- @ApiPropertyOptional({ default: 10 })
217
- @IsOptional()
218
- @Type(() => Number)
219
- @IsInt()
220
- @Min(1)
221
- @Max(100)
222
- limit?: number = 10;
223
- }
224
- ```
225
-
226
- ### 5. Exception Handling
227
-
228
- ```typescript
229
- // ✅ Custom Exception Filter
230
- @Catch()
231
- export class AllExceptionsFilter implements ExceptionFilter {
232
- constructor(private readonly logger: Logger) {}
233
-
234
- catch(exception: unknown, host: ArgumentsHost): void {
235
- const ctx = host.switchToHttp();
236
- const response = ctx.getResponse<Response>();
237
- const request = ctx.getRequest<Request>();
238
-
239
- const { status, message } = this.getErrorDetails(exception);
240
-
241
- const errorResponse = {
242
- statusCode: status,
243
- timestamp: new Date().toISOString(),
244
- path: request.url,
245
- message,
246
- };
247
-
248
- this.logger.error(
249
- `${request.method} ${request.url} - ${status}`,
250
- exception instanceof Error ? exception.stack : undefined,
251
- );
252
-
253
- response.status(status).json(errorResponse);
254
- }
255
-
256
- private getErrorDetails(exception: unknown): { status: number; message: string } {
257
- if (exception instanceof HttpException) {
258
- return {
259
- status: exception.getStatus(),
260
- message: exception.message,
261
- };
262
- }
263
-
264
- return {
265
- status: HttpStatus.INTERNAL_SERVER_ERROR,
266
- message: 'Internal server error',
267
- };
268
- }
269
- }
270
-
271
- // ✅ Business Exception
272
- export class UserNotFoundException extends NotFoundException {
273
- constructor(userId: string) {
274
- super(`User with ID ${userId} not found`);
275
- }
276
- }
277
- ```
278
-
279
- ### 6. Guard & Interceptor
280
-
281
- ```typescript
282
- // ✅ Auth Guard
283
- @Injectable()
284
- export class JwtAuthGuard extends AuthGuard('jwt') {
285
- canActivate(context: ExecutionContext) {
286
- return super.canActivate(context);
287
- }
288
-
289
- handleRequest<T>(err: Error, user: T): T {
290
- if (err || !user) {
291
- throw err || new UnauthorizedException();
292
- }
293
- return user;
294
- }
295
- }
296
-
297
- // ✅ Role Guard
298
- @Injectable()
299
- export class RolesGuard implements CanActivate {
300
- constructor(private reflector: Reflector) {}
301
-
302
- canActivate(context: ExecutionContext): boolean {
303
- const requiredRoles = this.reflector.getAllAndOverride<Role[]>(
304
- ROLES_KEY,
305
- [context.getHandler(), context.getClass()],
306
- );
307
- if (!requiredRoles) {
308
- return true;
309
- }
310
- const { user } = context.switchToHttp().getRequest();
311
- return requiredRoles.some((role) => user.roles?.includes(role));
312
- }
313
- }
314
-
315
- // ✅ Transform Interceptor
316
- @Injectable()
317
- export class TransformInterceptor<T> implements NestInterceptor<T, Response<T>> {
318
- intercept(context: ExecutionContext, next: CallHandler): Observable<Response<T>> {
319
- return next.handle().pipe(
320
- map((data) => ({
321
- success: true,
322
- data,
323
- timestamp: new Date().toISOString(),
324
- })),
325
- );
326
- }
327
- }
328
- ```
329
-
330
- ### 7. Repository Pattern (TypeORM)
331
-
332
- ```typescript
333
- // ✅ Custom Repository
334
- @Injectable()
335
- export class UserRepository {
336
- constructor(
337
- @InjectRepository(User)
338
- private readonly repo: Repository<User>,
339
- ) {}
340
-
341
- async findById(id: string): Promise<User | null> {
342
- return this.repo.findOne({ where: { id } });
343
- }
344
-
345
- async findByEmail(email: string): Promise<User | null> {
346
- return this.repo.findOne({ where: { email } });
347
- }
348
-
349
- async findWithPagination(query: FindUsersQueryDto): Promise<User[]> {
350
- const { search, page, limit } = query;
351
- const qb = this.repo.createQueryBuilder('user');
352
-
353
- if (search) {
354
- qb.where('user.name ILIKE :search OR user.email ILIKE :search', {
355
- search: `%${search}%`,
356
- });
357
- }
358
-
359
- return qb
360
- .skip((page - 1) * limit)
361
- .take(limit)
362
- .orderBy('user.createdAt', 'DESC')
363
- .getMany();
364
- }
365
-
366
- async create(dto: CreateUserDto): Promise<User> {
367
- const user = this.repo.create(dto);
368
- return this.repo.save(user);
369
- }
370
-
371
- async update(id: string, dto: UpdateUserDto): Promise<User> {
372
- await this.repo.update(id, dto);
373
- return this.findById(id);
374
- }
375
-
376
- async softDelete(id: string): Promise<void> {
377
- await this.repo.softDelete(id);
378
- }
379
- }
380
- ```
381
-
382
- ### 8. Configuration
383
-
384
- ```typescript
385
- // ✅ Config Module
386
- @Module({
387
- imports: [
388
- ConfigModule.forRoot({
389
- isGlobal: true,
390
- validationSchema: Joi.object({
391
- NODE_ENV: Joi.string().valid('development', 'production', 'test').required(),
392
- PORT: Joi.number().default(3000),
393
- DATABASE_URL: Joi.string().required(),
394
- JWT_SECRET: Joi.string().required(),
395
- JWT_EXPIRES_IN: Joi.string().default('1d'),
396
- }),
397
- }),
398
- ],
399
- })
400
- export class AppConfigModule {}
401
-
402
- // ✅ Typed Config Service
403
- @Injectable()
404
- export class AppConfigService {
405
- constructor(private configService: ConfigService) {}
406
-
407
- get port(): number {
408
- return this.configService.get<number>('PORT', 3000);
409
- }
410
-
411
- get databaseUrl(): string {
412
- return this.configService.getOrThrow<string>('DATABASE_URL');
413
- }
414
-
415
- get jwtSecret(): string {
416
- return this.configService.getOrThrow<string>('JWT_SECRET');
417
- }
418
-
419
- get isProduction(): boolean {
420
- return this.configService.get('NODE_ENV') === 'production';
421
- }
422
- }
423
- ```
424
-
425
- ## Recommended Folder Structure
426
-
427
- ```
428
- src/
429
- ├── main.ts
430
- ├── app.module.ts
431
- ├── common/ # Shared module
432
- │ ├── decorators/
433
- │ ├── filters/
434
- │ ├── guards/
435
- │ ├── interceptors/
436
- │ ├── pipes/
437
- │ └── common.module.ts
438
- ├── config/ # Configuration
439
- │ ├── app.config.ts
440
- │ └── database.config.ts
441
- ├── user/ # Feature module
442
- │ ├── dto/
443
- │ ├── entities/
444
- │ ├── user.controller.ts
445
- │ ├── user.service.ts
446
- │ ├── user.repository.ts
447
- │ └── user.module.ts
448
- └── auth/
449
- ├── strategies/
450
- ├── guards/
451
- └── auth.module.ts
452
- ```
453
-
454
- ## Testing
455
-
456
- ```typescript
457
- // ✅ Unit Test
458
- describe('UserService', () => {
459
- let service: UserService;
460
- let repository: MockType<UserRepository>;
461
-
462
- beforeEach(async () => {
463
- const module = await Test.createTestingModule({
464
- providers: [
465
- UserService,
466
- {
467
- provide: UserRepository,
468
- useFactory: () => ({
469
- findById: jest.fn(),
470
- create: jest.fn(),
471
- }),
472
- },
473
- ],
474
- }).compile();
475
-
476
- service = module.get(UserService);
477
- repository = module.get(UserRepository);
478
- });
479
-
480
- it('should create a user', async () => {
481
- const dto = { email: 'test@test.com', name: 'Test' };
482
- repository.create.mockResolvedValue({ id: '1', ...dto });
483
-
484
- const result = await service.create(dto);
485
- expect(result.email).toBe(dto.email);
486
- });
487
- });
488
-
489
- // ✅ E2E Test
490
- describe('UserController (e2e)', () => {
491
- let app: INestApplication;
492
-
493
- beforeAll(async () => {
494
- const module = await Test.createTestingModule({
495
- imports: [AppModule],
496
- }).compile();
497
-
498
- app = module.createNestApplication();
499
- await app.init();
500
- });
501
-
502
- it('/users (GET)', () => {
503
- return request(app.getHttpServer())
504
- .get('/users')
505
- .expect(200)
506
- .expect((res) => {
507
- expect(Array.isArray(res.body)).toBe(true);
508
- });
509
- });
510
- });
511
- ```
512
-
513
- ## Checklist
514
-
515
- - [ ] Separate request/response types with DTOs
516
- - [ ] Validate with class-validator
517
- - [ ] Serialize with class-transformer
518
- - [ ] Use custom Exceptions
519
- - [ ] Apply Repository pattern
520
- - [ ] Handle auth/authorization with Guards
521
- - [ ] Transform responses with Interceptors
522
- - [ ] Validate environment variables with ConfigModule
523
- - [ ] Document API with Swagger
524
- - [ ] Write Unit + E2E tests
1
+ # 🐱 TypeScript + NestJS Quality Rules
2
+
3
+ ## Core Principles (inherited from core)
4
+
5
+ ```markdown
6
+ ✅ Single Responsibility (SRP)
7
+ ✅ Don't Repeat Yourself (DRY)
8
+ ✅ Reusability
9
+ ✅ Low Complexity
10
+ ✅ Functions ≤ 30 lines
11
+ ✅ Nesting ≤ 3 levels
12
+ ✅ Cyclomatic complexity ≤ 10
13
+ ```
14
+
15
+ ## NestJS Architecture
16
+
17
+ ```
18
+ ┌─────────────────────────────────────────────┐
19
+ │ Controller (HTTP Request Handling) │
20
+ │ - Routing, request validation, response │
21
+ ├─────────────────────────────────────────────┤
22
+ │ Service (Business Logic) │
23
+ │ - Domain logic, data processing │
24
+ ├─────────────────────────────────────────────┤
25
+ │ Repository (Data Access) │
26
+ │ - DB queries, ORM operations │
27
+ └─────────────────────────────────────────────┘
28
+ ```
29
+
30
+ ## TypeScript/NestJS Patterns
31
+
32
+ ### 1. Module Structure
33
+
34
+ ```typescript
35
+ // ✅ Feature Module
36
+ @Module({
37
+ imports: [
38
+ TypeOrmModule.forFeature([User]),
39
+ CommonModule,
40
+ ],
41
+ controllers: [UserController],
42
+ providers: [UserService, UserRepository],
43
+ exports: [UserService],
44
+ })
45
+ export class UserModule {}
46
+
47
+ // ✅ Module folder structure
48
+ // src/
49
+ // ├── user/
50
+ // │ ├── user.module.ts
51
+ // │ ├── user.controller.ts
52
+ // │ ├── user.service.ts
53
+ // │ ├── user.repository.ts
54
+ // │ ├── dto/
55
+ // │ │ ├── create-user.dto.ts
56
+ // │ │ └── update-user.dto.ts
57
+ // │ └── entities/
58
+ // │ └── user.entity.ts
59
+ ```
60
+
61
+ ### 2. Controller Pattern
62
+
63
+ ```typescript
64
+ // ✅ Controller
65
+ @Controller('users')
66
+ @ApiTags('users')
67
+ export class UserController {
68
+ constructor(private readonly userService: UserService) {}
69
+
70
+ @Get()
71
+ @ApiOperation({ summary: 'Get all users' })
72
+ @ApiResponse({ status: 200, type: [UserResponseDto] })
73
+ async findAll(@Query() query: FindUsersQueryDto): Promise<UserResponseDto[]> {
74
+ return this.userService.findAll(query);
75
+ }
76
+
77
+ @Get(':id')
78
+ @ApiOperation({ summary: 'Get user by ID' })
79
+ @ApiResponse({ status: 200, type: UserResponseDto })
80
+ @ApiResponse({ status: 404, description: 'User not found' })
81
+ async findOne(@Param('id', ParseUUIDPipe) id: string): Promise<UserResponseDto> {
82
+ return this.userService.findOne(id);
83
+ }
84
+
85
+ @Post()
86
+ @ApiOperation({ summary: 'Create user' })
87
+ @ApiResponse({ status: 201, type: UserResponseDto })
88
+ async create(@Body() createUserDto: CreateUserDto): Promise<UserResponseDto> {
89
+ return this.userService.create(createUserDto);
90
+ }
91
+
92
+ @Patch(':id')
93
+ async update(
94
+ @Param('id', ParseUUIDPipe) id: string,
95
+ @Body() updateUserDto: UpdateUserDto,
96
+ ): Promise<UserResponseDto> {
97
+ return this.userService.update(id, updateUserDto);
98
+ }
99
+
100
+ @Delete(':id')
101
+ @HttpCode(HttpStatus.NO_CONTENT)
102
+ async remove(@Param('id', ParseUUIDPipe) id: string): Promise<void> {
103
+ await this.userService.remove(id);
104
+ }
105
+ }
106
+ ```
107
+
108
+ ### 3. Service Pattern
109
+
110
+ ```typescript
111
+ // ✅ Service
112
+ @Injectable()
113
+ export class UserService {
114
+ constructor(
115
+ private readonly userRepository: UserRepository,
116
+ private readonly eventEmitter: EventEmitter2,
117
+ ) {}
118
+
119
+ async findAll(query: FindUsersQueryDto): Promise<User[]> {
120
+ return this.userRepository.findWithPagination(query);
121
+ }
122
+
123
+ async findOne(id: string): Promise<User> {
124
+ const user = await this.userRepository.findById(id);
125
+ if (!user) {
126
+ throw new NotFoundException(`User with ID ${id} not found`);
127
+ }
128
+ return user;
129
+ }
130
+
131
+ async create(dto: CreateUserDto): Promise<User> {
132
+ const existingUser = await this.userRepository.findByEmail(dto.email);
133
+ if (existingUser) {
134
+ throw new ConflictException('Email already exists');
135
+ }
136
+
137
+ const user = await this.userRepository.create(dto);
138
+ this.eventEmitter.emit('user.created', new UserCreatedEvent(user));
139
+ return user;
140
+ }
141
+
142
+ async update(id: string, dto: UpdateUserDto): Promise<User> {
143
+ const user = await this.findOne(id);
144
+ return this.userRepository.update(user.id, dto);
145
+ }
146
+
147
+ async remove(id: string): Promise<void> {
148
+ const user = await this.findOne(id);
149
+ await this.userRepository.softDelete(user.id);
150
+ this.eventEmitter.emit('user.deleted', new UserDeletedEvent(user));
151
+ }
152
+ }
153
+ ```
154
+
155
+ ### 4. DTO + Validation
156
+
157
+ ```typescript
158
+ // ✅ Request DTO
159
+ export class CreateUserDto {
160
+ @ApiProperty({ example: 'john@example.com' })
161
+ @IsEmail()
162
+ @IsNotEmpty()
163
+ email: string;
164
+
165
+ @ApiProperty({ example: 'John Doe' })
166
+ @IsString()
167
+ @MinLength(2)
168
+ @MaxLength(100)
169
+ name: string;
170
+
171
+ @ApiProperty({ example: 'password123' })
172
+ @IsString()
173
+ @MinLength(8)
174
+ @Matches(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)/, {
175
+ message: 'Password must contain uppercase, lowercase, and number',
176
+ })
177
+ password: string;
178
+ }
179
+
180
+ // ✅ Response DTO (only Expose fields are visible)
181
+ @Exclude()
182
+ export class UserResponseDto {
183
+ @Expose()
184
+ @ApiProperty()
185
+ id: string;
186
+
187
+ @Expose()
188
+ @ApiProperty()
189
+ email: string;
190
+
191
+ @Expose()
192
+ @ApiProperty()
193
+ name: string;
194
+
195
+ @Expose()
196
+ @ApiProperty()
197
+ createdAt: Date;
198
+
199
+ // password is excluded
200
+ }
201
+
202
+ // ✅ Query DTO
203
+ export class FindUsersQueryDto {
204
+ @ApiPropertyOptional()
205
+ @IsOptional()
206
+ @IsString()
207
+ search?: string;
208
+
209
+ @ApiPropertyOptional({ default: 1 })
210
+ @IsOptional()
211
+ @Type(() => Number)
212
+ @IsInt()
213
+ @Min(1)
214
+ page?: number = 1;
215
+
216
+ @ApiPropertyOptional({ default: 10 })
217
+ @IsOptional()
218
+ @Type(() => Number)
219
+ @IsInt()
220
+ @Min(1)
221
+ @Max(100)
222
+ limit?: number = 10;
223
+ }
224
+ ```
225
+
226
+ ### 5. Exception Handling
227
+
228
+ ```typescript
229
+ // ✅ Custom Exception Filter
230
+ @Catch()
231
+ export class AllExceptionsFilter implements ExceptionFilter {
232
+ constructor(private readonly logger: Logger) {}
233
+
234
+ catch(exception: unknown, host: ArgumentsHost): void {
235
+ const ctx = host.switchToHttp();
236
+ const response = ctx.getResponse<Response>();
237
+ const request = ctx.getRequest<Request>();
238
+
239
+ const { status, message } = this.getErrorDetails(exception);
240
+
241
+ const errorResponse = {
242
+ statusCode: status,
243
+ timestamp: new Date().toISOString(),
244
+ path: request.url,
245
+ message,
246
+ };
247
+
248
+ this.logger.error(
249
+ `${request.method} ${request.url} - ${status}`,
250
+ exception instanceof Error ? exception.stack : undefined,
251
+ );
252
+
253
+ response.status(status).json(errorResponse);
254
+ }
255
+
256
+ private getErrorDetails(exception: unknown): { status: number; message: string } {
257
+ if (exception instanceof HttpException) {
258
+ return {
259
+ status: exception.getStatus(),
260
+ message: exception.message,
261
+ };
262
+ }
263
+
264
+ return {
265
+ status: HttpStatus.INTERNAL_SERVER_ERROR,
266
+ message: 'Internal server error',
267
+ };
268
+ }
269
+ }
270
+
271
+ // ✅ Business Exception
272
+ export class UserNotFoundException extends NotFoundException {
273
+ constructor(userId: string) {
274
+ super(`User with ID ${userId} not found`);
275
+ }
276
+ }
277
+ ```
278
+
279
+ ### 6. Guard & Interceptor
280
+
281
+ ```typescript
282
+ // ✅ Auth Guard
283
+ @Injectable()
284
+ export class JwtAuthGuard extends AuthGuard('jwt') {
285
+ canActivate(context: ExecutionContext) {
286
+ return super.canActivate(context);
287
+ }
288
+
289
+ handleRequest<T>(err: Error, user: T): T {
290
+ if (err || !user) {
291
+ throw err || new UnauthorizedException();
292
+ }
293
+ return user;
294
+ }
295
+ }
296
+
297
+ // ✅ Role Guard
298
+ @Injectable()
299
+ export class RolesGuard implements CanActivate {
300
+ constructor(private reflector: Reflector) {}
301
+
302
+ canActivate(context: ExecutionContext): boolean {
303
+ const requiredRoles = this.reflector.getAllAndOverride<Role[]>(
304
+ ROLES_KEY,
305
+ [context.getHandler(), context.getClass()],
306
+ );
307
+ if (!requiredRoles) {
308
+ return true;
309
+ }
310
+ const { user } = context.switchToHttp().getRequest();
311
+ return requiredRoles.some((role) => user.roles?.includes(role));
312
+ }
313
+ }
314
+
315
+ // ✅ Transform Interceptor
316
+ @Injectable()
317
+ export class TransformInterceptor<T> implements NestInterceptor<T, Response<T>> {
318
+ intercept(context: ExecutionContext, next: CallHandler): Observable<Response<T>> {
319
+ return next.handle().pipe(
320
+ map((data) => ({
321
+ success: true,
322
+ data,
323
+ timestamp: new Date().toISOString(),
324
+ })),
325
+ );
326
+ }
327
+ }
328
+ ```
329
+
330
+ ### 7. Repository Pattern (TypeORM)
331
+
332
+ ```typescript
333
+ // ✅ Custom Repository
334
+ @Injectable()
335
+ export class UserRepository {
336
+ constructor(
337
+ @InjectRepository(User)
338
+ private readonly repo: Repository<User>,
339
+ ) {}
340
+
341
+ async findById(id: string): Promise<User | null> {
342
+ return this.repo.findOne({ where: { id } });
343
+ }
344
+
345
+ async findByEmail(email: string): Promise<User | null> {
346
+ return this.repo.findOne({ where: { email } });
347
+ }
348
+
349
+ async findWithPagination(query: FindUsersQueryDto): Promise<User[]> {
350
+ const { search, page, limit } = query;
351
+ const qb = this.repo.createQueryBuilder('user');
352
+
353
+ if (search) {
354
+ qb.where('user.name ILIKE :search OR user.email ILIKE :search', {
355
+ search: `%${search}%`,
356
+ });
357
+ }
358
+
359
+ return qb
360
+ .skip((page - 1) * limit)
361
+ .take(limit)
362
+ .orderBy('user.createdAt', 'DESC')
363
+ .getMany();
364
+ }
365
+
366
+ async create(dto: CreateUserDto): Promise<User> {
367
+ const user = this.repo.create(dto);
368
+ return this.repo.save(user);
369
+ }
370
+
371
+ async update(id: string, dto: UpdateUserDto): Promise<User> {
372
+ await this.repo.update(id, dto);
373
+ return this.findById(id);
374
+ }
375
+
376
+ async softDelete(id: string): Promise<void> {
377
+ await this.repo.softDelete(id);
378
+ }
379
+ }
380
+ ```
381
+
382
+ ### 8. Configuration
383
+
384
+ ```typescript
385
+ // ✅ Config Module
386
+ @Module({
387
+ imports: [
388
+ ConfigModule.forRoot({
389
+ isGlobal: true,
390
+ validationSchema: Joi.object({
391
+ NODE_ENV: Joi.string().valid('development', 'production', 'test').required(),
392
+ PORT: Joi.number().default(3000),
393
+ DATABASE_URL: Joi.string().required(),
394
+ JWT_SECRET: Joi.string().required(),
395
+ JWT_EXPIRES_IN: Joi.string().default('1d'),
396
+ }),
397
+ }),
398
+ ],
399
+ })
400
+ export class AppConfigModule {}
401
+
402
+ // ✅ Typed Config Service
403
+ @Injectable()
404
+ export class AppConfigService {
405
+ constructor(private configService: ConfigService) {}
406
+
407
+ get port(): number {
408
+ return this.configService.get<number>('PORT', 3000);
409
+ }
410
+
411
+ get databaseUrl(): string {
412
+ return this.configService.getOrThrow<string>('DATABASE_URL');
413
+ }
414
+
415
+ get jwtSecret(): string {
416
+ return this.configService.getOrThrow<string>('JWT_SECRET');
417
+ }
418
+
419
+ get isProduction(): boolean {
420
+ return this.configService.get('NODE_ENV') === 'production';
421
+ }
422
+ }
423
+ ```
424
+
425
+ ## Recommended Folder Structure
426
+
427
+ ```
428
+ src/
429
+ ├── main.ts
430
+ ├── app.module.ts
431
+ ├── common/ # Shared module
432
+ │ ├── decorators/
433
+ │ ├── filters/
434
+ │ ├── guards/
435
+ │ ├── interceptors/
436
+ │ ├── pipes/
437
+ │ └── common.module.ts
438
+ ├── config/ # Configuration
439
+ │ ├── app.config.ts
440
+ │ └── database.config.ts
441
+ ├── user/ # Feature module
442
+ │ ├── dto/
443
+ │ ├── entities/
444
+ │ ├── user.controller.ts
445
+ │ ├── user.service.ts
446
+ │ ├── user.repository.ts
447
+ │ └── user.module.ts
448
+ └── auth/
449
+ ├── strategies/
450
+ ├── guards/
451
+ └── auth.module.ts
452
+ ```
453
+
454
+ ## Testing
455
+
456
+ ```typescript
457
+ // ✅ Unit Test
458
+ describe('UserService', () => {
459
+ let service: UserService;
460
+ let repository: MockType<UserRepository>;
461
+
462
+ beforeEach(async () => {
463
+ const module = await Test.createTestingModule({
464
+ providers: [
465
+ UserService,
466
+ {
467
+ provide: UserRepository,
468
+ useFactory: () => ({
469
+ findById: jest.fn(),
470
+ create: jest.fn(),
471
+ }),
472
+ },
473
+ ],
474
+ }).compile();
475
+
476
+ service = module.get(UserService);
477
+ repository = module.get(UserRepository);
478
+ });
479
+
480
+ it('should create a user', async () => {
481
+ const dto = { email: 'test@test.com', name: 'Test' };
482
+ repository.create.mockResolvedValue({ id: '1', ...dto });
483
+
484
+ const result = await service.create(dto);
485
+ expect(result.email).toBe(dto.email);
486
+ });
487
+ });
488
+
489
+ // ✅ E2E Test
490
+ describe('UserController (e2e)', () => {
491
+ let app: INestApplication;
492
+
493
+ beforeAll(async () => {
494
+ const module = await Test.createTestingModule({
495
+ imports: [AppModule],
496
+ }).compile();
497
+
498
+ app = module.createNestApplication();
499
+ await app.init();
500
+ });
501
+
502
+ it('/users (GET)', () => {
503
+ return request(app.getHttpServer())
504
+ .get('/users')
505
+ .expect(200)
506
+ .expect((res) => {
507
+ expect(Array.isArray(res.body)).toBe(true);
508
+ });
509
+ });
510
+ });
511
+ ```
512
+
513
+ ## Checklist
514
+
515
+ - [ ] Separate request/response types with DTOs
516
+ - [ ] Validate with class-validator
517
+ - [ ] Serialize with class-transformer
518
+ - [ ] Use custom Exceptions
519
+ - [ ] Apply Repository pattern
520
+ - [ ] Handle auth/authorization with Guards
521
+ - [ ] Transform responses with Interceptors
522
+ - [ ] Validate environment variables with ConfigModule
523
+ - [ ] Document API with Swagger
524
+ - [ ] Write Unit + E2E tests