aigroup-workflow 2.2.0 → 2.2.2

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 (645) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/AGENTS.md +2 -2
  21. package/CLAUDE.md +23 -1
  22. package/LICENSE +20 -20
  23. package/README.md +333 -333
  24. package/agents/a11y-architect.md +141 -141
  25. package/agents/architect.md +211 -211
  26. package/agents/build-error-resolver.md +114 -114
  27. package/agents/chief-of-staff.md +151 -151
  28. package/agents/code-architect.md +71 -71
  29. package/agents/code-explorer.md +69 -69
  30. package/agents/code-reviewer.md +237 -237
  31. package/agents/code-simplifier.md +47 -47
  32. package/agents/comment-analyzer.md +45 -45
  33. package/agents/conversation-analyzer.md +52 -52
  34. package/agents/cpp-build-resolver.md +90 -90
  35. package/agents/cpp-reviewer.md +72 -72
  36. package/agents/csharp-reviewer.md +101 -101
  37. package/agents/dart-build-resolver.md +201 -201
  38. package/agents/database-reviewer.md +91 -91
  39. package/agents/doc-updater.md +107 -107
  40. package/agents/docs-lookup.md +68 -68
  41. package/agents/e2e-runner.md +107 -107
  42. package/agents/flutter-reviewer.md +243 -243
  43. package/agents/gan-evaluator.md +209 -209
  44. package/agents/gan-generator.md +131 -131
  45. package/agents/gan-planner.md +99 -99
  46. package/agents/get-current-datetime.md +26 -26
  47. package/agents/go-build-resolver.md +94 -94
  48. package/agents/go-reviewer.md +76 -76
  49. package/agents/harness-optimizer.md +35 -35
  50. package/agents/healthcare-reviewer.md +83 -83
  51. package/agents/java-build-resolver.md +153 -153
  52. package/agents/java-reviewer.md +92 -92
  53. package/agents/kotlin-build-resolver.md +118 -118
  54. package/agents/kotlin-reviewer.md +159 -159
  55. package/agents/loop-operator.md +36 -36
  56. package/agents/opensource-forker.md +198 -198
  57. package/agents/opensource-packager.md +249 -249
  58. package/agents/opensource-sanitizer.md +188 -188
  59. package/agents/performance-optimizer.md +446 -446
  60. package/agents/planner.md +212 -212
  61. package/agents/pr-test-analyzer.md +45 -45
  62. package/agents/python-reviewer.md +98 -98
  63. package/agents/pytorch-build-resolver.md +120 -120
  64. package/agents/refactor-cleaner.md +85 -85
  65. package/agents/rust-build-resolver.md +148 -148
  66. package/agents/rust-reviewer.md +94 -94
  67. package/agents/security-reviewer.md +108 -108
  68. package/agents/seo-specialist.md +59 -59
  69. package/agents/silent-failure-hunter.md +50 -50
  70. package/agents/tdd-guide.md +91 -91
  71. package/agents/type-design-analyzer.md +41 -41
  72. package/agents/typescript-reviewer.md +112 -112
  73. package/cli/commands/update.mjs +1 -1
  74. package/cli/utils/scaffold.mjs +53 -0
  75. package/docs/rules/agents.md +166 -50
  76. package/docs/rules/cpp/coding-style.md +44 -44
  77. package/docs/rules/cpp/hooks.md +39 -39
  78. package/docs/rules/cpp/patterns.md +51 -51
  79. package/docs/rules/cpp/security.md +51 -51
  80. package/docs/rules/cpp/testing.md +44 -44
  81. package/docs/rules/csharp/coding-style.md +72 -72
  82. package/docs/rules/csharp/hooks.md +25 -25
  83. package/docs/rules/csharp/patterns.md +50 -50
  84. package/docs/rules/csharp/security.md +58 -58
  85. package/docs/rules/csharp/testing.md +46 -46
  86. package/docs/rules/dart/coding-style.md +159 -159
  87. package/docs/rules/dart/hooks.md +66 -66
  88. package/docs/rules/dart/patterns.md +261 -261
  89. package/docs/rules/dart/security.md +135 -135
  90. package/docs/rules/dart/testing.md +215 -215
  91. package/docs/rules/golang/coding-style.md +32 -32
  92. package/docs/rules/golang/hooks.md +17 -17
  93. package/docs/rules/golang/patterns.md +45 -45
  94. package/docs/rules/golang/security.md +34 -34
  95. package/docs/rules/golang/testing.md +31 -31
  96. package/docs/rules/java/coding-style.md +114 -114
  97. package/docs/rules/java/hooks.md +18 -18
  98. package/docs/rules/java/patterns.md +146 -146
  99. package/docs/rules/java/security.md +100 -100
  100. package/docs/rules/java/testing.md +131 -131
  101. package/docs/rules/kotlin/coding-style.md +86 -86
  102. package/docs/rules/kotlin/hooks.md +17 -17
  103. package/docs/rules/kotlin/patterns.md +146 -146
  104. package/docs/rules/kotlin/security.md +82 -82
  105. package/docs/rules/kotlin/testing.md +128 -128
  106. package/docs/rules/perl/coding-style.md +46 -46
  107. package/docs/rules/perl/hooks.md +22 -22
  108. package/docs/rules/perl/patterns.md +76 -76
  109. package/docs/rules/perl/security.md +69 -69
  110. package/docs/rules/perl/testing.md +54 -54
  111. package/docs/rules/php/coding-style.md +40 -40
  112. package/docs/rules/php/hooks.md +24 -24
  113. package/docs/rules/php/patterns.md +33 -33
  114. package/docs/rules/php/security.md +37 -37
  115. package/docs/rules/php/testing.md +39 -39
  116. package/docs/rules/python/coding-style.md +42 -42
  117. package/docs/rules/python/hooks.md +19 -19
  118. package/docs/rules/python/patterns.md +39 -39
  119. package/docs/rules/python/security.md +30 -30
  120. package/docs/rules/python/testing.md +38 -38
  121. package/docs/rules/rust/coding-style.md +151 -151
  122. package/docs/rules/rust/hooks.md +16 -16
  123. package/docs/rules/rust/patterns.md +168 -168
  124. package/docs/rules/rust/security.md +141 -141
  125. package/docs/rules/rust/testing.md +154 -154
  126. package/docs/rules/swift/coding-style.md +47 -47
  127. package/docs/rules/swift/hooks.md +20 -20
  128. package/docs/rules/swift/patterns.md +66 -66
  129. package/docs/rules/swift/security.md +33 -33
  130. package/docs/rules/swift/testing.md +45 -45
  131. package/docs/rules/typescript/coding-style.md +199 -199
  132. package/docs/rules/typescript/hooks.md +22 -22
  133. package/docs/rules/typescript/patterns.md +52 -52
  134. package/docs/rules/typescript/security.md +28 -28
  135. package/docs/rules/typescript/testing.md +18 -18
  136. package/docs/rules/web/coding-style.md +96 -96
  137. package/docs/rules/web/design-quality.md +62 -62
  138. package/docs/rules/web/hooks.md +120 -120
  139. package/docs/rules/web/patterns.md +79 -79
  140. package/docs/rules/web/performance.md +64 -64
  141. package/docs/rules/web/security.md +57 -57
  142. package/docs/rules/web/testing.md +55 -55
  143. package/docs/templates/README.md +36 -36
  144. package/docs/templates/ai-project-final.md +124 -124
  145. package/docs/templates/ai-project.md +105 -105
  146. package/docs/templates/api.md +157 -157
  147. package/docs/templates/bug.md +62 -62
  148. package/docs/templates/code-review.md +87 -87
  149. package/docs/templates/generic.md +116 -116
  150. package/docs/templates/implementation-plan.md +1 -1
  151. package/docs/templates/meeting.md +68 -68
  152. package/docs/templates/prd.md +98 -98
  153. package/docs/templates/ui.md +134 -134
  154. package/docs/workflow-pipeline.md +11 -10
  155. package/package.json +40 -39
  156. package/scripts/hooks/checks/orchestration-artifacts.cjs +28 -23
  157. package/scripts/hooks/checks/workflow-state.cjs +4 -5
  158. package/scripts/orchestration/lib/orchestrator.cjs +344 -117
  159. package/scripts/orchestration/lib/validate.cjs +145 -0
  160. package/scripts/orchestration/session.cjs +88 -44
  161. package/skills/SUPERPOWERS-LICENSE +21 -21
  162. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  163. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  164. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  165. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  166. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  167. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  168. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  169. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  170. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  171. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  172. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  173. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  174. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  175. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  176. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  177. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  178. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  179. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  180. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  181. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  182. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  183. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  184. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  185. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  186. package/skills/backend/api-designer/SKILL.md +217 -217
  187. package/skills/backend/api-designer/references/error-handling.md +541 -541
  188. package/skills/backend/api-designer/references/openapi.md +824 -824
  189. package/skills/backend/api-designer/references/pagination.md +494 -494
  190. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  191. package/skills/backend/api-designer/references/versioning.md +391 -391
  192. package/skills/backend/architecture-designer/SKILL.md +117 -117
  193. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  194. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  195. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  196. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  197. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  198. package/skills/backend/code-documenter/SKILL.md +147 -147
  199. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  200. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  201. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  202. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  203. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  204. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  205. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  206. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  207. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  208. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  209. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  210. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  211. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  212. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  213. package/skills/backend/feature-forge/SKILL.md +98 -98
  214. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  215. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  216. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  217. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  218. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  219. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  220. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  221. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  222. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  223. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  224. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  225. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  226. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  227. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  228. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  229. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  230. package/skills/backend/graphql-architect/SKILL.md +146 -146
  231. package/skills/backend/graphql-architect/references/federation.md +418 -418
  232. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  233. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  234. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  235. package/skills/backend/graphql-architect/references/security.md +569 -569
  236. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  237. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  238. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  239. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  240. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  241. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  242. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  243. package/skills/backend/microservices-architect/SKILL.md +164 -164
  244. package/skills/backend/microservices-architect/references/communication.md +499 -499
  245. package/skills/backend/microservices-architect/references/data.md +721 -721
  246. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  247. package/skills/backend/microservices-architect/references/observability.md +805 -805
  248. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  249. package/skills/database/database-optimizer/SKILL.md +147 -147
  250. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  251. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  252. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  253. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  254. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  255. package/skills/database/postgres-pro/SKILL.md +152 -152
  256. package/skills/database/postgres-pro/references/extensions.md +404 -404
  257. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  258. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  259. package/skills/database/postgres-pro/references/performance.md +265 -265
  260. package/skills/database/postgres-pro/references/replication.md +446 -446
  261. package/skills/database/sql-pro/SKILL.md +129 -129
  262. package/skills/database/sql-pro/references/database-design.md +402 -402
  263. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  264. package/skills/database/sql-pro/references/optimization.md +384 -384
  265. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  266. package/skills/database/sql-pro/references/window-functions.md +328 -328
  267. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  268. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  269. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  270. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  271. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  272. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  273. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  274. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  275. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  276. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  277. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  278. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  279. package/skills/frontend/angular-architect/SKILL.md +152 -152
  280. package/skills/frontend/angular-architect/references/components.md +297 -297
  281. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  282. package/skills/frontend/angular-architect/references/routing.md +361 -361
  283. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  284. package/skills/frontend/angular-architect/references/testing.md +405 -405
  285. package/skills/frontend/design-commands/design.md +91 -91
  286. package/skills/frontend/design-commands/handoff.md +97 -97
  287. package/skills/frontend/design-commands/prototype.md +120 -120
  288. package/skills/frontend/design-commands/spec.md +160 -160
  289. package/skills/frontend/design-commands/style.md +78 -78
  290. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  291. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  292. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  293. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  294. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  295. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  296. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  297. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  298. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  299. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  300. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  301. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  302. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  303. package/skills/frontend/react-expert/SKILL.md +149 -149
  304. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  305. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  306. package/skills/frontend/react-expert/references/performance.md +168 -168
  307. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  308. package/skills/frontend/react-expert/references/server-components.md +143 -143
  309. package/skills/frontend/react-expert/references/state-management.md +171 -171
  310. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  311. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  312. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  313. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  314. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  315. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  316. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  317. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  318. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  319. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  320. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  321. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  322. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  323. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  324. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  325. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  326. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  327. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  328. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  329. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  330. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  339. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  340. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  341. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  342. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  343. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  344. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  345. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  346. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  347. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  348. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  349. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  350. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  351. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  352. package/skills/frontend/vue-expert/SKILL.md +98 -98
  353. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  354. package/skills/frontend/vue-expert/references/components.md +448 -448
  355. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  356. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  357. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  358. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  359. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  360. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  361. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  362. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  363. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  364. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  365. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  366. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  367. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  368. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  369. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  370. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  371. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  372. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  373. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  374. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  375. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  376. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  377. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  378. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  379. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  380. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  381. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  382. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  383. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  384. package/skills/infra/cli-developer/SKILL.md +113 -113
  385. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  386. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  387. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  388. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  389. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  390. package/skills/infra/cloud-architect/SKILL.md +216 -216
  391. package/skills/infra/cloud-architect/references/aws.md +394 -394
  392. package/skills/infra/cloud-architect/references/azure.md +562 -562
  393. package/skills/infra/cloud-architect/references/cost.md +582 -582
  394. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  395. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  396. package/skills/infra/devops-engineer/SKILL.md +144 -144
  397. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  398. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  399. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  400. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  401. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  402. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  403. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  404. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  405. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  406. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  407. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  408. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  409. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  410. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  411. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  412. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  413. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  414. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  415. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  416. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  417. package/skills/infra/mcp-developer/SKILL.md +143 -143
  418. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  419. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  420. package/skills/infra/mcp-developer/references/resources.md +554 -554
  421. package/skills/infra/mcp-developer/references/tools.md +480 -480
  422. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  423. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  424. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  425. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  426. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  427. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  428. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  429. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  430. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  431. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  432. package/skills/infra/sre-engineer/SKILL.md +181 -181
  433. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  434. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  435. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  436. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  437. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  438. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  439. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  440. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  441. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  442. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  443. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  444. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  445. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  446. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  447. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  448. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  449. package/skills/infra/websocket-engineer/references/security.md +474 -474
  450. package/skills/java/java-architect/SKILL.md +132 -132
  451. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  452. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  453. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  454. package/skills/java/java-architect/references/spring-security.md +445 -445
  455. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  456. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  457. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  458. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  459. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  460. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  461. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  462. package/skills/java/spring-boot-engineer/SKILL.md +195 -195
  463. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  464. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  465. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  466. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  467. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  468. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  469. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  470. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  471. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  472. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  473. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  474. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  475. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  476. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  477. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  478. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  479. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  480. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  481. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  482. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  483. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  484. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  485. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  486. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  487. package/skills/php/laravel-specialist/SKILL.md +262 -262
  488. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  489. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  490. package/skills/php/laravel-specialist/references/queues.md +423 -423
  491. package/skills/php/laravel-specialist/references/routing.md +362 -362
  492. package/skills/php/laravel-specialist/references/testing.md +522 -522
  493. package/skills/php/php-pro/SKILL.md +206 -206
  494. package/skills/php/php-pro/references/async-patterns.md +412 -412
  495. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  496. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  497. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  498. package/skills/php/php-pro/references/testing-quality.md +466 -466
  499. package/skills/product/competitive-analysis/SKILL.md +257 -257
  500. package/skills/product/meeting-notes/SKILL.md +266 -266
  501. package/skills/product/prd-template/SKILL.md +150 -150
  502. package/skills/product/stakeholder-update/SKILL.md +225 -225
  503. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  504. package/skills/python/django-expert/SKILL.md +162 -162
  505. package/skills/python/django-expert/references/authentication.md +145 -145
  506. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  507. package/skills/python/django-expert/references/models-orm.md +151 -151
  508. package/skills/python/django-expert/references/testing-django.md +204 -204
  509. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  510. package/skills/python/fastapi-expert/SKILL.md +185 -185
  511. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  512. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  513. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  514. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  515. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  516. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  517. package/skills/python/pandas-pro/SKILL.md +178 -178
  518. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  519. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  520. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  521. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  522. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  523. package/skills/python/python-pro/SKILL.md +177 -177
  524. package/skills/python/python-pro/references/async-patterns.md +356 -356
  525. package/skills/python/python-pro/references/packaging.md +460 -460
  526. package/skills/python/python-pro/references/standard-library.md +378 -378
  527. package/skills/python/python-pro/references/testing.md +404 -404
  528. package/skills/python/python-pro/references/type-system.md +290 -290
  529. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  530. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  531. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  532. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  533. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  534. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  535. package/skills/quality/code-reviewer/SKILL.md +119 -119
  536. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  537. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  538. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  539. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  540. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  541. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  542. package/skills/quality/playwright-expert/SKILL.md +169 -169
  543. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  544. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  545. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  546. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  547. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  548. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  549. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  550. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  551. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  552. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  553. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  554. package/skills/quality/security-reviewer/SKILL.md +103 -103
  555. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  556. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  557. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  558. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  559. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  560. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  561. package/skills/quality/senior-qa/README.md +196 -196
  562. package/skills/quality/senior-qa/SKILL.md +399 -399
  563. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  564. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  565. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  566. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  567. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  568. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  569. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  570. package/skills/quality/tdd-guide/README.md +680 -680
  571. package/skills/quality/tdd-guide/SKILL.md +122 -122
  572. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  573. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  574. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  575. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  576. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  577. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  578. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  579. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  580. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  581. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  582. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  583. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  584. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  585. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  586. package/skills/quality/test-master/SKILL.md +94 -94
  587. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  588. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  589. package/skills/quality/test-master/references/integration-testing.md +120 -120
  590. package/skills/quality/test-master/references/performance-testing.md +118 -118
  591. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  592. package/skills/quality/test-master/references/security-testing.md +127 -127
  593. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  594. package/skills/quality/test-master/references/test-reports.md +104 -104
  595. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  596. package/skills/quality/test-master/references/unit-testing.md +113 -113
  597. package/skills/ruby/rails-expert/SKILL.md +154 -154
  598. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  599. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  600. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  601. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  602. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  603. package/skills/swift/swift-expert/SKILL.md +163 -163
  604. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  605. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  606. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  607. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  608. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  609. package/skills/workflow/brainstorming/SKILL.md +164 -164
  610. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  611. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  612. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  613. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  614. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  615. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  616. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  617. package/skills/workflow/documentation/SKILL.md +45 -45
  618. package/skills/workflow/entropy-management/SKILL.md +115 -115
  619. package/skills/workflow/executing-plans/SKILL.md +70 -70
  620. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  621. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  622. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  623. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  624. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  625. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  626. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  627. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  628. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  629. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  630. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  631. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  632. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  633. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  634. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  635. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  636. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  637. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  638. package/skills/workflow/writing-plans/SKILL.md +151 -151
  639. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  640. package/skills/workflow/writing-skills/SKILL.md +655 -655
  641. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  642. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  643. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  644. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  645. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,1141 +1,1141 @@
1
- # REST to GraphQL Migration Guide
2
-
3
- ---
4
-
5
- ## When to Use This Guide
6
-
7
- **Migrate to GraphQL when:**
8
- - Multiple round-trips required for complex UI views
9
- - Over-fetching or under-fetching data is problematic
10
- - Supporting diverse client needs (mobile, web, desktop)
11
- - Team boundaries require federated API architecture
12
- - Real-time subscriptions are core requirements
13
- - Type safety across client-server boundary needed
14
- - API versioning complexity is growing
15
-
16
- **Success indicators:**
17
- - Client applications make many sequential REST calls
18
- - Different clients need different data shapes
19
- - Mobile apps suffer from bandwidth constraints
20
- - Frontend teams wait on backend API changes
21
- - Multiple REST versions exist concurrently
22
-
23
- ## When NOT to Use GraphQL
24
-
25
- **Stick with REST when:**
26
- - Simple CRUD operations with stable clients
27
- - File upload/download is primary use case
28
- - HTTP caching is critical (CDN, browser cache)
29
- - Team lacks GraphQL expertise and training budget
30
- - Existing REST API is well-designed and sufficient
31
- - Third-party integrations require REST endpoints
32
- - Query complexity would create security risks
33
-
34
- **Warning signs:**
35
- - Team of 1-2 developers (operational overhead)
36
- - Primarily server-to-server communication
37
- - Static content delivery is the main requirement
38
- - No complex data relationship navigation needed
39
-
40
- ---
41
-
42
- ## Concept Mapping: REST to GraphQL
43
-
44
- | REST Concept | GraphQL Equivalent | Notes |
45
- |--------------|-------------------|-------|
46
- | GET /users | Query users | Read operations |
47
- | GET /users/:id | Query user(id: ID!) | Single entity fetch |
48
- | POST /users | Mutation createUser | Create operations |
49
- | PUT /users/:id | Mutation updateUser | Update operations |
50
- | DELETE /users/:id | Mutation deleteUser | Delete operations |
51
- | PATCH /users/:id | Mutation updateUserPartial | Partial updates |
52
- | Query params (?filter=...) | Field arguments | Filtering/sorting |
53
- | URL path segments | Nested field selection | Data relationships |
54
- | Multiple endpoints | Single query | Eliminate round-trips |
55
- | Webhook callbacks | Subscriptions | Real-time updates |
56
- | HTTP status codes | Errors array + data | Partial success model |
57
- | API versioning | Schema evolution | Deprecation over versions |
58
- | /users?include=posts | users { posts } | Eager loading control |
59
- | Offset pagination | Cursor-based connections | Relay specification |
60
- | Accept header | Operation selection | Content negotiation |
61
- | OAuth/JWT tokens | Context authentication | Same auth patterns |
62
-
63
- ---
64
-
65
- ## Pattern 1: GET Endpoints to Queries
66
-
67
- ### REST Endpoint
68
-
69
- ```typescript
70
- // GET /api/users/:id
71
- interface UserResponse {
72
- id: string;
73
- name: string;
74
- email: string;
75
- created_at: string;
76
- posts: Array<{
77
- id: string;
78
- title: string;
79
- published: boolean;
80
- }>;
81
- }
82
-
83
- app.get('/api/users/:id', async (req, res) => {
84
- const user = await db.users.findById(req.params.id);
85
- const posts = await db.posts.findByUserId(user.id); // N+1 risk
86
-
87
- res.json({
88
- id: user.id,
89
- name: user.name,
90
- email: user.email,
91
- created_at: user.createdAt.toISOString(),
92
- posts: posts.map(p => ({
93
- id: p.id,
94
- title: p.title,
95
- published: p.published
96
- }))
97
- });
98
- });
99
- ```
100
-
101
- ### GraphQL Schema
102
-
103
- ```graphql
104
- type User {
105
- id: ID!
106
- name: String!
107
- email: String!
108
- createdAt: DateTime!
109
- posts: [Post!]!
110
- }
111
-
112
- type Post {
113
- id: ID!
114
- title: String!
115
- published: Boolean!
116
- author: User!
117
- }
118
-
119
- type Query {
120
- user(id: ID!): User
121
- users(filter: UserFilter, limit: Int = 20): [User!]!
122
- }
123
-
124
- input UserFilter {
125
- nameContains: String
126
- createdAfter: DateTime
127
- }
128
-
129
- scalar DateTime
130
- ```
131
-
132
- ### GraphQL Resolver with DataLoader
133
-
134
- ```typescript
135
- import DataLoader from 'dataloader';
136
- import { IResolvers } from '@graphql-tools/utils';
137
-
138
- // Batch loading to prevent N+1 queries
139
- const createPostsByUserIdLoader = (db: Database) =>
140
- new DataLoader<string, Post[]>(async (userIds) => {
141
- const posts = await db.posts.findByUserIds([...userIds]);
142
-
143
- // Group posts by userId
144
- const postsByUserId = userIds.map(id =>
145
- posts.filter(post => post.userId === id)
146
- );
147
-
148
- return postsByUserId;
149
- });
150
-
151
- const createUserByIdLoader = (db: Database) =>
152
- new DataLoader<string, User>(async (ids) => {
153
- const users = await db.users.findByIds([...ids]);
154
-
155
- // Maintain order matching input ids
156
- return ids.map(id => users.find(user => user.id === id));
157
- });
158
-
159
- interface Context {
160
- db: Database;
161
- loaders: {
162
- userById: DataLoader<string, User>;
163
- postsByUserId: DataLoader<string, Post[]>;
164
- };
165
- }
166
-
167
- const resolvers: IResolvers<any, Context> = {
168
- Query: {
169
- user: async (_, { id }, { loaders }) => {
170
- return loaders.userById.load(id);
171
- },
172
-
173
- users: async (_, { filter, limit }, { db }) => {
174
- return db.users.find(filter, { limit });
175
- },
176
- },
177
-
178
- User: {
179
- posts: async (user, _, { loaders }) => {
180
- // DataLoader batches and caches these calls
181
- return loaders.postsByUserId.load(user.id);
182
- },
183
- },
184
-
185
- Post: {
186
- author: async (post, _, { loaders }) => {
187
- return loaders.userById.load(post.userId);
188
- },
189
- },
190
- };
191
-
192
- // Apollo Server setup
193
- import { ApolloServer } from '@apollo/server';
194
- import { startStandaloneServer } from '@apollo/server/standalone';
195
-
196
- const server = new ApolloServer<Context>({
197
- typeDefs,
198
- resolvers,
199
- });
200
-
201
- const { url } = await startStandaloneServer(server, {
202
- context: async ({ req }) => {
203
- const db = createDatabaseConnection();
204
-
205
- return {
206
- db,
207
- loaders: {
208
- userById: createUserByIdLoader(db),
209
- postsByUserId: createPostsByUserIdLoader(db),
210
- },
211
- };
212
- },
213
- });
214
- ```
215
-
216
- ### Client Query Examples
217
-
218
- ```typescript
219
- // Flexible field selection - client controls response shape
220
- const MINIMAL_USER = gql`
221
- query GetUser($id: ID!) {
222
- user(id: $id) {
223
- id
224
- name
225
- }
226
- }
227
- `;
228
-
229
- const DETAILED_USER = gql`
230
- query GetUserWithPosts($id: ID!) {
231
- user(id: $id) {
232
- id
233
- name
234
- email
235
- createdAt
236
- posts {
237
- id
238
- title
239
- published
240
- }
241
- }
242
- }
243
- `;
244
-
245
- // Single query replacing multiple REST calls
246
- const DASHBOARD_DATA = gql`
247
- query Dashboard($userId: ID!) {
248
- user(id: $userId) {
249
- name
250
- posts {
251
- id
252
- title
253
- }
254
- }
255
-
256
- # Would require separate REST endpoint
257
- users(filter: { createdAfter: "2025-01-01" }, limit: 5) {
258
- id
259
- name
260
- }
261
- }
262
- `;
263
- ```
264
-
265
- ---
266
-
267
- ## Pattern 2: POST/PUT/DELETE to Mutations
268
-
269
- ### REST Endpoints
270
-
271
- ```typescript
272
- // POST /api/users
273
- app.post('/api/users', async (req, res) => {
274
- const { name, email, password } = req.body;
275
-
276
- if (!name || !email) {
277
- return res.status(400).json({ error: 'Missing required fields' });
278
- }
279
-
280
- const user = await db.users.create({ name, email, password });
281
- res.status(201).json(user);
282
- });
283
-
284
- // PUT /api/users/:id
285
- app.put('/api/users/:id', async (req, res) => {
286
- const user = await db.users.update(req.params.id, req.body);
287
- res.json(user);
288
- });
289
-
290
- // DELETE /api/users/:id
291
- app.delete('/api/users/:id', async (req, res) => {
292
- await db.users.delete(req.params.id);
293
- res.status(204).send();
294
- });
295
- ```
296
-
297
- ### GraphQL Schema
298
-
299
- ```graphql
300
- type Mutation {
301
- createUser(input: CreateUserInput!): CreateUserPayload!
302
- updateUser(input: UpdateUserInput!): UpdateUserPayload!
303
- deleteUser(id: ID!): DeleteUserPayload!
304
- }
305
-
306
- input CreateUserInput {
307
- name: String!
308
- email: String!
309
- password: String!
310
- }
311
-
312
- type CreateUserPayload {
313
- user: User
314
- errors: [UserError!]!
315
- }
316
-
317
- input UpdateUserInput {
318
- id: ID!
319
- name: String
320
- email: String
321
- }
322
-
323
- type UpdateUserPayload {
324
- user: User
325
- errors: [UserError!]!
326
- }
327
-
328
- type DeleteUserPayload {
329
- deletedId: ID
330
- errors: [UserError!]!
331
- }
332
-
333
- type UserError {
334
- field: String
335
- message: String!
336
- code: ErrorCode!
337
- }
338
-
339
- enum ErrorCode {
340
- VALIDATION_ERROR
341
- NOT_FOUND
342
- UNAUTHORIZED
343
- INTERNAL_ERROR
344
- }
345
- ```
346
-
347
- ### GraphQL Mutation Resolvers
348
-
349
- ```typescript
350
- const resolvers: IResolvers<any, Context> = {
351
- Mutation: {
352
- createUser: async (_, { input }, { db, user }) => {
353
- try {
354
- // Validation
355
- if (!isValidEmail(input.email)) {
356
- return {
357
- user: null,
358
- errors: [{
359
- field: 'email',
360
- message: 'Invalid email format',
361
- code: 'VALIDATION_ERROR',
362
- }],
363
- };
364
- }
365
-
366
- // Check for duplicate
367
- const existing = await db.users.findByEmail(input.email);
368
- if (existing) {
369
- return {
370
- user: null,
371
- errors: [{
372
- field: 'email',
373
- message: 'Email already registered',
374
- code: 'VALIDATION_ERROR',
375
- }],
376
- };
377
- }
378
-
379
- const hashedPassword = await bcrypt.hash(input.password, 10);
380
- const newUser = await db.users.create({
381
- name: input.name,
382
- email: input.email,
383
- password: hashedPassword,
384
- });
385
-
386
- return {
387
- user: newUser,
388
- errors: [],
389
- };
390
- } catch (error) {
391
- return {
392
- user: null,
393
- errors: [{
394
- message: 'Failed to create user',
395
- code: 'INTERNAL_ERROR',
396
- }],
397
- };
398
- }
399
- },
400
-
401
- updateUser: async (_, { input }, { db, user }) => {
402
- if (!user || user.id !== input.id) {
403
- return {
404
- user: null,
405
- errors: [{
406
- message: 'Unauthorized',
407
- code: 'UNAUTHORIZED',
408
- }],
409
- };
410
- }
411
-
412
- const updated = await db.users.update(input.id, {
413
- ...(input.name && { name: input.name }),
414
- ...(input.email && { email: input.email }),
415
- });
416
-
417
- return {
418
- user: updated,
419
- errors: [],
420
- };
421
- },
422
-
423
- deleteUser: async (_, { id }, { db, user }) => {
424
- if (!user || user.id !== id) {
425
- return {
426
- deletedId: null,
427
- errors: [{ message: 'Unauthorized', code: 'UNAUTHORIZED' }],
428
- };
429
- }
430
-
431
- await db.users.delete(id);
432
-
433
- return {
434
- deletedId: id,
435
- errors: [],
436
- };
437
- },
438
- },
439
- };
440
- ```
441
-
442
- ### Client Mutation Examples
443
-
444
- ```typescript
445
- const CREATE_USER = gql`
446
- mutation CreateUser($input: CreateUserInput!) {
447
- createUser(input: $input) {
448
- user {
449
- id
450
- name
451
- email
452
- createdAt
453
- }
454
- errors {
455
- field
456
- message
457
- code
458
- }
459
- }
460
- }
461
- `;
462
-
463
- // Usage with error handling
464
- const [createUser] = useMutation(CREATE_USER);
465
-
466
- const handleSubmit = async (formData) => {
467
- const { data } = await createUser({
468
- variables: {
469
- input: formData,
470
- },
471
- });
472
-
473
- if (data.createUser.errors.length > 0) {
474
- // Handle validation errors
475
- data.createUser.errors.forEach(error => {
476
- setFieldError(error.field, error.message);
477
- });
478
- } else {
479
- // Success - use the returned user
480
- navigate(`/users/${data.createUser.user.id}`);
481
- }
482
- };
483
- ```
484
-
485
- ---
486
-
487
- ## Pattern 3: Pagination Migration
488
-
489
- ### REST Offset Pagination
490
-
491
- ```typescript
492
- // GET /api/posts?page=2&limit=20
493
- app.get('/api/posts', async (req, res) => {
494
- const page = parseInt(req.query.page) || 1;
495
- const limit = parseInt(req.query.limit) || 20;
496
- const offset = (page - 1) * limit;
497
-
498
- const posts = await db.posts.find({
499
- limit,
500
- offset,
501
- });
502
-
503
- const total = await db.posts.count();
504
-
505
- res.json({
506
- data: posts,
507
- pagination: {
508
- page,
509
- limit,
510
- total,
511
- totalPages: Math.ceil(total / limit),
512
- },
513
- });
514
- });
515
- ```
516
-
517
- ### GraphQL Cursor-Based Pagination (Relay Connections)
518
-
519
- ```graphql
520
- type Query {
521
- posts(
522
- first: Int
523
- after: String
524
- last: Int
525
- before: String
526
- filter: PostFilter
527
- ): PostConnection!
528
- }
529
-
530
- type PostConnection {
531
- edges: [PostEdge!]!
532
- pageInfo: PageInfo!
533
- totalCount: Int!
534
- }
535
-
536
- type PostEdge {
537
- node: Post!
538
- cursor: String!
539
- }
540
-
541
- type PageInfo {
542
- hasNextPage: Boolean!
543
- hasPreviousPage: Boolean!
544
- startCursor: String
545
- endCursor: String
546
- }
547
-
548
- input PostFilter {
549
- published: Boolean
550
- authorId: ID
551
- titleContains: String
552
- }
553
- ```
554
-
555
- ### Cursor Pagination Resolver
556
-
557
- ```typescript
558
- import { encodeCursor, decodeCursor } from './cursor-utils';
559
-
560
- const resolvers: IResolvers = {
561
- Query: {
562
- posts: async (_, args, { db }) => {
563
- const { first, after, last, before, filter } = args;
564
-
565
- // Validate pagination args
566
- if (first && last) {
567
- throw new Error('Cannot specify both first and last');
568
- }
569
-
570
- const limit = first || last || 20;
571
- const isForward = !!first || !last;
572
-
573
- // Decode cursor to get offset
574
- let offset = 0;
575
- if (after) {
576
- offset = decodeCursor(after) + 1;
577
- } else if (before) {
578
- offset = Math.max(0, decodeCursor(before) - limit);
579
- }
580
-
581
- // Fetch one extra to determine hasNextPage
582
- const posts = await db.posts.find({
583
- filter,
584
- limit: limit + 1,
585
- offset,
586
- orderBy: { createdAt: isForward ? 'DESC' : 'ASC' },
587
- });
588
-
589
- const hasMore = posts.length > limit;
590
- const nodes = hasMore ? posts.slice(0, limit) : posts;
591
-
592
- if (!isForward) {
593
- nodes.reverse();
594
- }
595
-
596
- const edges = nodes.map((post, index) => ({
597
- node: post,
598
- cursor: encodeCursor(offset + index),
599
- }));
600
-
601
- const totalCount = await db.posts.count(filter);
602
-
603
- return {
604
- edges,
605
- pageInfo: {
606
- hasNextPage: isForward ? hasMore : offset > 0,
607
- hasPreviousPage: !isForward ? hasMore : offset > 0,
608
- startCursor: edges[0]?.cursor,
609
- endCursor: edges[edges.length - 1]?.cursor,
610
- },
611
- totalCount,
612
- };
613
- },
614
- },
615
- };
616
-
617
- // cursor-utils.ts
618
- export const encodeCursor = (offset: number): string => {
619
- return Buffer.from(`cursor:${offset}`).toString('base64');
620
- };
621
-
622
- export const decodeCursor = (cursor: string): number => {
623
- const decoded = Buffer.from(cursor, 'base64').toString('utf-8');
624
- return parseInt(decoded.replace('cursor:', ''));
625
- };
626
- ```
627
-
628
- ### Client Pagination Query
629
-
630
- ```typescript
631
- const POSTS_QUERY = gql`
632
- query Posts($first: Int!, $after: String, $filter: PostFilter) {
633
- posts(first: $first, after: $after, filter: $filter) {
634
- edges {
635
- node {
636
- id
637
- title
638
- published
639
- author {
640
- name
641
- }
642
- }
643
- cursor
644
- }
645
- pageInfo {
646
- hasNextPage
647
- endCursor
648
- }
649
- totalCount
650
- }
651
- }
652
- `;
653
-
654
- // Infinite scroll implementation
655
- const PostList = () => {
656
- const { data, loading, fetchMore } = useQuery(POSTS_QUERY, {
657
- variables: { first: 20 },
658
- });
659
-
660
- const loadMore = () => {
661
- fetchMore({
662
- variables: {
663
- after: data.posts.pageInfo.endCursor,
664
- },
665
- updateQuery: (prev, { fetchMoreResult }) => {
666
- if (!fetchMoreResult) return prev;
667
-
668
- return {
669
- posts: {
670
- ...fetchMoreResult.posts,
671
- edges: [
672
- ...prev.posts.edges,
673
- ...fetchMoreResult.posts.edges,
674
- ],
675
- },
676
- };
677
- },
678
- });
679
- };
680
-
681
- return (
682
- <div>
683
- {data?.posts.edges.map(({ node }) => (
684
- <PostCard key={node.id} post={node} />
685
- ))}
686
-
687
- {data?.posts.pageInfo.hasNextPage && (
688
- <button onClick={loadMore}>Load More</button>
689
- )}
690
- </div>
691
- );
692
- };
693
- ```
694
-
695
- ---
696
-
697
- ## Pattern 4: Authentication Translation
698
-
699
- ### REST Authentication
700
-
701
- ```typescript
702
- // REST middleware
703
- app.use(async (req, res, next) => {
704
- const token = req.headers.authorization?.replace('Bearer ', '');
705
-
706
- if (token) {
707
- try {
708
- const payload = jwt.verify(token, process.env.JWT_SECRET);
709
- req.user = await db.users.findById(payload.userId);
710
- } catch (error) {
711
- return res.status(401).json({ error: 'Invalid token' });
712
- }
713
- }
714
-
715
- next();
716
- });
717
- ```
718
-
719
- ### GraphQL Authentication Context
720
-
721
- ```typescript
722
- import { ApolloServer } from '@apollo/server';
723
- import { GraphQLError } from 'graphql';
724
-
725
- interface AuthContext {
726
- user: User | null;
727
- requireAuth: () => User;
728
- }
729
-
730
- const server = new ApolloServer<AuthContext>({
731
- typeDefs,
732
- resolvers,
733
- });
734
-
735
- await startStandaloneServer(server, {
736
- context: async ({ req }) => {
737
- const token = req.headers.authorization?.replace('Bearer ', '');
738
- let user: User | null = null;
739
-
740
- if (token) {
741
- try {
742
- const payload = jwt.verify(token, process.env.JWT_SECRET);
743
- user = await db.users.findById(payload.userId);
744
- } catch (error) {
745
- // Token invalid - continue with user = null
746
- }
747
- }
748
-
749
- return {
750
- user,
751
- db,
752
- loaders: createLoaders(db),
753
-
754
- // Helper to enforce authentication
755
- requireAuth: (): User => {
756
- if (!user) {
757
- throw new GraphQLError('Authentication required', {
758
- extensions: { code: 'UNAUTHENTICATED' },
759
- });
760
- }
761
- return user;
762
- },
763
- };
764
- },
765
- });
766
- ```
767
-
768
- ### Field-Level Authorization
769
-
770
- ```typescript
771
- import { GraphQLFieldResolver } from 'graphql';
772
-
773
- // Authorization directive
774
- const resolvers: IResolvers = {
775
- Query: {
776
- me: (_, __, { requireAuth }) => {
777
- const user = requireAuth();
778
- return user;
779
- },
780
-
781
- users: (_, __, { user }) => {
782
- // Optional auth - different data based on auth state
783
- if (user?.role === 'ADMIN') {
784
- return db.users.findAll();
785
- }
786
-
787
- // Public view - limited fields
788
- return db.users.findPublic();
789
- },
790
- },
791
-
792
- User: {
793
- email: (user, _, { user: currentUser }) => {
794
- // Field-level privacy
795
- if (currentUser?.id === user.id || currentUser?.role === 'ADMIN') {
796
- return user.email;
797
- }
798
- return null;
799
- },
800
- },
801
- };
802
- ```
803
-
804
- ---
805
-
806
- ## BFF (Backend for Frontend) Architecture
807
-
808
- ### Multi-Client GraphQL Gateway
809
-
810
- ```typescript
811
- // Schema stitching for different clients
812
- import { stitchSchemas } from '@graphql-tools/stitch';
813
-
814
- // Mobile-optimized schema
815
- const mobileSchema = makeExecutableSchema({
816
- typeDefs: `
817
- type Query {
818
- # Denormalized for fewer round-trips
819
- dashboard: MobileDashboard!
820
- }
821
-
822
- type MobileDashboard {
823
- user: User!
824
- recentPosts: [Post!]!
825
- notifications: [Notification!]!
826
- # All data needed for mobile home screen
827
- }
828
- `,
829
- resolvers: mobileResolvers,
830
- });
831
-
832
- // Web-optimized schema
833
- const webSchema = makeExecutableSchema({
834
- typeDefs: `
835
- type Query {
836
- # Granular for efficient caching
837
- user(id: ID!): User
838
- posts(filter: PostFilter): PostConnection!
839
- notifications(unreadOnly: Boolean): [Notification!]!
840
- }
841
- `,
842
- resolvers: webResolvers,
843
- });
844
-
845
- // Client-specific servers
846
- const mobileServer = new ApolloServer({
847
- schema: mobileSchema,
848
- introspection: true,
849
- });
850
-
851
- const webServer = new ApolloServer({
852
- schema: webSchema,
853
- introspection: true,
854
- });
855
-
856
- // Route based on client header
857
- app.use('/graphql', (req, res) => {
858
- const client = req.headers['x-client-type'];
859
-
860
- if (client === 'mobile') {
861
- return mobileServer.handleRequest(req, res);
862
- }
863
-
864
- return webServer.handleRequest(req, res);
865
- });
866
- ```
867
-
868
- ---
869
-
870
- ## Incremental Migration Strategy
871
-
872
- ### Phase 1: GraphQL Wrapper (Weeks 1-2)
873
-
874
- ```typescript
875
- // Wrap existing REST endpoints with GraphQL
876
- const resolvers: IResolvers = {
877
- Query: {
878
- user: async (_, { id }) => {
879
- // Call existing REST API internally
880
- const response = await fetch(`http://localhost:3000/api/users/${id}`);
881
- return response.json();
882
- },
883
- },
884
- };
885
-
886
- // Allows GraphQL adoption without backend rewrites
887
- // Clients can start using GraphQL immediately
888
- ```
889
-
890
- ### Phase 2: Parallel Implementation (Weeks 3-6)
891
-
892
- ```typescript
893
- // Implement GraphQL resolvers with direct DB access
894
- // Keep REST endpoints running
895
- const resolvers: IResolvers = {
896
- Query: {
897
- user: async (_, { id }, { db }) => {
898
- // New implementation - direct database
899
- return db.users.findById(id);
900
- },
901
- },
902
- };
903
-
904
- // Feature flag to route traffic
905
- const USE_GRAPHQL = process.env.GRAPHQL_ENABLED === 'true';
906
-
907
- app.get('/api/users/:id', async (req, res) => {
908
- if (USE_GRAPHQL) {
909
- // Forward to GraphQL
910
- const result = await graphqlServer.executeOperation({
911
- query: `query GetUser($id: ID!) { user(id: $id) { ... } }`,
912
- variables: { id: req.params.id },
913
- });
914
- return res.json(result.data?.user);
915
- }
916
-
917
- // Legacy REST implementation
918
- const user = await db.users.findById(req.params.id);
919
- res.json(user);
920
- });
921
- ```
922
-
923
- ### Phase 3: Client Migration (Weeks 7-12)
924
-
925
- ```typescript
926
- // Gradual client migration with monitoring
927
- import { setContext } from '@apollo/client/link/context';
928
-
929
- const migrationLink = setContext((_, { headers }) => {
930
- return {
931
- headers: {
932
- ...headers,
933
- 'x-graphql-migration': 'phase-3',
934
- },
935
- };
936
- });
937
-
938
- // A/B test GraphQL vs REST in production
939
- // Monitor performance, errors, client satisfaction
940
- ```
941
-
942
- ### Phase 4: REST Deprecation (Week 13+)
943
-
944
- ```typescript
945
- // Deprecate REST endpoints gradually
946
- app.get('/api/users/:id', (req, res) => {
947
- res.status(410).json({
948
- error: 'This endpoint is deprecated',
949
- message: 'Please use GraphQL endpoint at /graphql',
950
- migrationGuide: 'https://docs.example.com/graphql-migration',
951
- sunsetDate: '2025-06-01',
952
- });
953
- });
954
-
955
- // Eventually remove REST entirely
956
- ```
957
-
958
- ---
959
-
960
- ## Common Pitfalls
961
-
962
- ### Pitfall 1: N+1 Query Problem
963
-
964
- ```typescript
965
- // BAD - Causes N+1 queries
966
- const resolvers = {
967
- User: {
968
- posts: async (user, _, { db }) => {
969
- // Called once per user - N queries if you fetch N users
970
- return db.posts.findByUserId(user.id);
971
- },
972
- },
973
- };
974
-
975
- // GOOD - Use DataLoader
976
- const resolvers = {
977
- User: {
978
- posts: async (user, _, { loaders }) => {
979
- // Batched and cached
980
- return loaders.postsByUserId.load(user.id);
981
- },
982
- },
983
- };
984
- ```
985
-
986
- ### Pitfall 2: Exposing Database Schema Directly
987
-
988
- ```typescript
989
- // BAD - Tightly coupled to database
990
- type User {
991
- user_id: Int! # Database column name
992
- first_name: String # Database structure leaks
993
- last_name: String
994
- created_at: String # Raw DB type
995
- }
996
-
997
- // GOOD - API-first design
998
- type User {
999
- id: ID! # Abstract identifier
1000
- name: String! # Computed from first + last
1001
- createdAt: DateTime! # Proper type
1002
- }
1003
- ```
1004
-
1005
- ### Pitfall 3: Missing Error Handling
1006
-
1007
- ```typescript
1008
- // BAD - Errors kill entire response
1009
- const resolvers = {
1010
- Query: {
1011
- dashboard: async () => {
1012
- const user = await fetchUser(); // Throws on error
1013
- const posts = await fetchPosts(); // Never reached if user fails
1014
- return { user, posts };
1015
- },
1016
- },
1017
- };
1018
-
1019
- // GOOD - Partial success model
1020
- const resolvers = {
1021
- Query: {
1022
- dashboard: async () => {
1023
- return {}; // Return empty object
1024
- },
1025
- },
1026
-
1027
- Dashboard: {
1028
- user: async (_, __, context) => {
1029
- try {
1030
- return await fetchUser();
1031
- } catch (error) {
1032
- return null; // Client still gets posts
1033
- }
1034
- },
1035
-
1036
- posts: async () => {
1037
- try {
1038
- return await fetchPosts();
1039
- } catch (error) {
1040
- return []; // Graceful degradation
1041
- }
1042
- },
1043
- },
1044
- };
1045
- ```
1046
-
1047
- ### Pitfall 4: Ignoring Query Complexity
1048
-
1049
- ```typescript
1050
- // BAD - No limits on query depth/complexity
1051
- // Client can write expensive queries that DOS the server
1052
-
1053
- // GOOD - Implement complexity limits
1054
- import { createComplexityLimitRule } from 'graphql-validation-complexity';
1055
-
1056
- const server = new ApolloServer({
1057
- typeDefs,
1058
- resolvers,
1059
- validationRules: [
1060
- createComplexityLimitRule(1000, {
1061
- onCost: (cost) => {
1062
- console.log('Query cost:', cost);
1063
- },
1064
- }),
1065
- ],
1066
- });
1067
-
1068
- // Assign costs to fields
1069
- const typeDefs = `
1070
- type Query {
1071
- users: [User!]! @cost(complexity: 10)
1072
- user(id: ID!): User @cost(complexity: 1)
1073
- }
1074
-
1075
- type User {
1076
- posts: [Post!]! @cost(complexity: 5, multipliers: ["first"])
1077
- }
1078
- `;
1079
- ```
1080
-
1081
- ### Pitfall 5: Over-Normalization
1082
-
1083
- ```typescript
1084
- // BAD - Too granular, requires many queries
1085
- type Query {
1086
- userName(id: ID!): String
1087
- userEmail(id: ID!): String
1088
- userPosts(userId: ID!): [Post!]!
1089
- }
1090
-
1091
- // GOOD - Logical grouping
1092
- type Query {
1093
- user(id: ID!): User
1094
- }
1095
-
1096
- type User {
1097
- name: String!
1098
- email: String!
1099
- posts: [Post!]!
1100
- }
1101
- ```
1102
-
1103
- ---
1104
-
1105
- ## Cross-References
1106
-
1107
- **Related Skills:**
1108
- - **graphql-architect/references/schema-design.md** - Type system patterns and schema structure
1109
- - **graphql-architect/references/federation-guide.md** - Multi-service GraphQL architecture
1110
- - **backend-developer** - REST API implementation patterns
1111
- - **api-designer** - API design principles and consistency
1112
-
1113
- **When to Escalate:**
1114
- - Federation across microservices → See federation-guide.md
1115
- - Schema design questions → See schema-design.md
1116
- - Complex subscription requirements → Consult graphql-architect
1117
- - Performance optimization → Partner with performance-engineer
1118
-
1119
- ---
1120
-
1121
- ## Migration Checklist
1122
-
1123
- - [ ] Identify most-used REST endpoints
1124
- - [ ] Map REST resources to GraphQL types
1125
- - [ ] Design schema following best practices
1126
- - [ ] Implement DataLoaders for all relations
1127
- - [ ] Add authentication/authorization
1128
- - [ ] Implement pagination (cursor-based)
1129
- - [ ] Set up query complexity limits
1130
- - [ ] Create client migration plan
1131
- - [ ] Monitor performance metrics
1132
- - [ ] Document GraphQL queries for clients
1133
- - [ ] Train team on GraphQL patterns
1134
- - [ ] Plan REST endpoint sunset timeline
1135
-
1136
- **Migration complete when:**
1137
- - All critical paths use GraphQL
1138
- - REST endpoints deprecated with sunset dates
1139
- - Client applications fully migrated
1140
- - Performance metrics meet or exceed REST baseline
1141
- - Team confident in GraphQL maintenance
1
+ # REST to GraphQL Migration Guide
2
+
3
+ ---
4
+
5
+ ## When to Use This Guide
6
+
7
+ **Migrate to GraphQL when:**
8
+ - Multiple round-trips required for complex UI views
9
+ - Over-fetching or under-fetching data is problematic
10
+ - Supporting diverse client needs (mobile, web, desktop)
11
+ - Team boundaries require federated API architecture
12
+ - Real-time subscriptions are core requirements
13
+ - Type safety across client-server boundary needed
14
+ - API versioning complexity is growing
15
+
16
+ **Success indicators:**
17
+ - Client applications make many sequential REST calls
18
+ - Different clients need different data shapes
19
+ - Mobile apps suffer from bandwidth constraints
20
+ - Frontend teams wait on backend API changes
21
+ - Multiple REST versions exist concurrently
22
+
23
+ ## When NOT to Use GraphQL
24
+
25
+ **Stick with REST when:**
26
+ - Simple CRUD operations with stable clients
27
+ - File upload/download is primary use case
28
+ - HTTP caching is critical (CDN, browser cache)
29
+ - Team lacks GraphQL expertise and training budget
30
+ - Existing REST API is well-designed and sufficient
31
+ - Third-party integrations require REST endpoints
32
+ - Query complexity would create security risks
33
+
34
+ **Warning signs:**
35
+ - Team of 1-2 developers (operational overhead)
36
+ - Primarily server-to-server communication
37
+ - Static content delivery is the main requirement
38
+ - No complex data relationship navigation needed
39
+
40
+ ---
41
+
42
+ ## Concept Mapping: REST to GraphQL
43
+
44
+ | REST Concept | GraphQL Equivalent | Notes |
45
+ |--------------|-------------------|-------|
46
+ | GET /users | Query users | Read operations |
47
+ | GET /users/:id | Query user(id: ID!) | Single entity fetch |
48
+ | POST /users | Mutation createUser | Create operations |
49
+ | PUT /users/:id | Mutation updateUser | Update operations |
50
+ | DELETE /users/:id | Mutation deleteUser | Delete operations |
51
+ | PATCH /users/:id | Mutation updateUserPartial | Partial updates |
52
+ | Query params (?filter=...) | Field arguments | Filtering/sorting |
53
+ | URL path segments | Nested field selection | Data relationships |
54
+ | Multiple endpoints | Single query | Eliminate round-trips |
55
+ | Webhook callbacks | Subscriptions | Real-time updates |
56
+ | HTTP status codes | Errors array + data | Partial success model |
57
+ | API versioning | Schema evolution | Deprecation over versions |
58
+ | /users?include=posts | users { posts } | Eager loading control |
59
+ | Offset pagination | Cursor-based connections | Relay specification |
60
+ | Accept header | Operation selection | Content negotiation |
61
+ | OAuth/JWT tokens | Context authentication | Same auth patterns |
62
+
63
+ ---
64
+
65
+ ## Pattern 1: GET Endpoints to Queries
66
+
67
+ ### REST Endpoint
68
+
69
+ ```typescript
70
+ // GET /api/users/:id
71
+ interface UserResponse {
72
+ id: string;
73
+ name: string;
74
+ email: string;
75
+ created_at: string;
76
+ posts: Array<{
77
+ id: string;
78
+ title: string;
79
+ published: boolean;
80
+ }>;
81
+ }
82
+
83
+ app.get('/api/users/:id', async (req, res) => {
84
+ const user = await db.users.findById(req.params.id);
85
+ const posts = await db.posts.findByUserId(user.id); // N+1 risk
86
+
87
+ res.json({
88
+ id: user.id,
89
+ name: user.name,
90
+ email: user.email,
91
+ created_at: user.createdAt.toISOString(),
92
+ posts: posts.map(p => ({
93
+ id: p.id,
94
+ title: p.title,
95
+ published: p.published
96
+ }))
97
+ });
98
+ });
99
+ ```
100
+
101
+ ### GraphQL Schema
102
+
103
+ ```graphql
104
+ type User {
105
+ id: ID!
106
+ name: String!
107
+ email: String!
108
+ createdAt: DateTime!
109
+ posts: [Post!]!
110
+ }
111
+
112
+ type Post {
113
+ id: ID!
114
+ title: String!
115
+ published: Boolean!
116
+ author: User!
117
+ }
118
+
119
+ type Query {
120
+ user(id: ID!): User
121
+ users(filter: UserFilter, limit: Int = 20): [User!]!
122
+ }
123
+
124
+ input UserFilter {
125
+ nameContains: String
126
+ createdAfter: DateTime
127
+ }
128
+
129
+ scalar DateTime
130
+ ```
131
+
132
+ ### GraphQL Resolver with DataLoader
133
+
134
+ ```typescript
135
+ import DataLoader from 'dataloader';
136
+ import { IResolvers } from '@graphql-tools/utils';
137
+
138
+ // Batch loading to prevent N+1 queries
139
+ const createPostsByUserIdLoader = (db: Database) =>
140
+ new DataLoader<string, Post[]>(async (userIds) => {
141
+ const posts = await db.posts.findByUserIds([...userIds]);
142
+
143
+ // Group posts by userId
144
+ const postsByUserId = userIds.map(id =>
145
+ posts.filter(post => post.userId === id)
146
+ );
147
+
148
+ return postsByUserId;
149
+ });
150
+
151
+ const createUserByIdLoader = (db: Database) =>
152
+ new DataLoader<string, User>(async (ids) => {
153
+ const users = await db.users.findByIds([...ids]);
154
+
155
+ // Maintain order matching input ids
156
+ return ids.map(id => users.find(user => user.id === id));
157
+ });
158
+
159
+ interface Context {
160
+ db: Database;
161
+ loaders: {
162
+ userById: DataLoader<string, User>;
163
+ postsByUserId: DataLoader<string, Post[]>;
164
+ };
165
+ }
166
+
167
+ const resolvers: IResolvers<any, Context> = {
168
+ Query: {
169
+ user: async (_, { id }, { loaders }) => {
170
+ return loaders.userById.load(id);
171
+ },
172
+
173
+ users: async (_, { filter, limit }, { db }) => {
174
+ return db.users.find(filter, { limit });
175
+ },
176
+ },
177
+
178
+ User: {
179
+ posts: async (user, _, { loaders }) => {
180
+ // DataLoader batches and caches these calls
181
+ return loaders.postsByUserId.load(user.id);
182
+ },
183
+ },
184
+
185
+ Post: {
186
+ author: async (post, _, { loaders }) => {
187
+ return loaders.userById.load(post.userId);
188
+ },
189
+ },
190
+ };
191
+
192
+ // Apollo Server setup
193
+ import { ApolloServer } from '@apollo/server';
194
+ import { startStandaloneServer } from '@apollo/server/standalone';
195
+
196
+ const server = new ApolloServer<Context>({
197
+ typeDefs,
198
+ resolvers,
199
+ });
200
+
201
+ const { url } = await startStandaloneServer(server, {
202
+ context: async ({ req }) => {
203
+ const db = createDatabaseConnection();
204
+
205
+ return {
206
+ db,
207
+ loaders: {
208
+ userById: createUserByIdLoader(db),
209
+ postsByUserId: createPostsByUserIdLoader(db),
210
+ },
211
+ };
212
+ },
213
+ });
214
+ ```
215
+
216
+ ### Client Query Examples
217
+
218
+ ```typescript
219
+ // Flexible field selection - client controls response shape
220
+ const MINIMAL_USER = gql`
221
+ query GetUser($id: ID!) {
222
+ user(id: $id) {
223
+ id
224
+ name
225
+ }
226
+ }
227
+ `;
228
+
229
+ const DETAILED_USER = gql`
230
+ query GetUserWithPosts($id: ID!) {
231
+ user(id: $id) {
232
+ id
233
+ name
234
+ email
235
+ createdAt
236
+ posts {
237
+ id
238
+ title
239
+ published
240
+ }
241
+ }
242
+ }
243
+ `;
244
+
245
+ // Single query replacing multiple REST calls
246
+ const DASHBOARD_DATA = gql`
247
+ query Dashboard($userId: ID!) {
248
+ user(id: $userId) {
249
+ name
250
+ posts {
251
+ id
252
+ title
253
+ }
254
+ }
255
+
256
+ # Would require separate REST endpoint
257
+ users(filter: { createdAfter: "2025-01-01" }, limit: 5) {
258
+ id
259
+ name
260
+ }
261
+ }
262
+ `;
263
+ ```
264
+
265
+ ---
266
+
267
+ ## Pattern 2: POST/PUT/DELETE to Mutations
268
+
269
+ ### REST Endpoints
270
+
271
+ ```typescript
272
+ // POST /api/users
273
+ app.post('/api/users', async (req, res) => {
274
+ const { name, email, password } = req.body;
275
+
276
+ if (!name || !email) {
277
+ return res.status(400).json({ error: 'Missing required fields' });
278
+ }
279
+
280
+ const user = await db.users.create({ name, email, password });
281
+ res.status(201).json(user);
282
+ });
283
+
284
+ // PUT /api/users/:id
285
+ app.put('/api/users/:id', async (req, res) => {
286
+ const user = await db.users.update(req.params.id, req.body);
287
+ res.json(user);
288
+ });
289
+
290
+ // DELETE /api/users/:id
291
+ app.delete('/api/users/:id', async (req, res) => {
292
+ await db.users.delete(req.params.id);
293
+ res.status(204).send();
294
+ });
295
+ ```
296
+
297
+ ### GraphQL Schema
298
+
299
+ ```graphql
300
+ type Mutation {
301
+ createUser(input: CreateUserInput!): CreateUserPayload!
302
+ updateUser(input: UpdateUserInput!): UpdateUserPayload!
303
+ deleteUser(id: ID!): DeleteUserPayload!
304
+ }
305
+
306
+ input CreateUserInput {
307
+ name: String!
308
+ email: String!
309
+ password: String!
310
+ }
311
+
312
+ type CreateUserPayload {
313
+ user: User
314
+ errors: [UserError!]!
315
+ }
316
+
317
+ input UpdateUserInput {
318
+ id: ID!
319
+ name: String
320
+ email: String
321
+ }
322
+
323
+ type UpdateUserPayload {
324
+ user: User
325
+ errors: [UserError!]!
326
+ }
327
+
328
+ type DeleteUserPayload {
329
+ deletedId: ID
330
+ errors: [UserError!]!
331
+ }
332
+
333
+ type UserError {
334
+ field: String
335
+ message: String!
336
+ code: ErrorCode!
337
+ }
338
+
339
+ enum ErrorCode {
340
+ VALIDATION_ERROR
341
+ NOT_FOUND
342
+ UNAUTHORIZED
343
+ INTERNAL_ERROR
344
+ }
345
+ ```
346
+
347
+ ### GraphQL Mutation Resolvers
348
+
349
+ ```typescript
350
+ const resolvers: IResolvers<any, Context> = {
351
+ Mutation: {
352
+ createUser: async (_, { input }, { db, user }) => {
353
+ try {
354
+ // Validation
355
+ if (!isValidEmail(input.email)) {
356
+ return {
357
+ user: null,
358
+ errors: [{
359
+ field: 'email',
360
+ message: 'Invalid email format',
361
+ code: 'VALIDATION_ERROR',
362
+ }],
363
+ };
364
+ }
365
+
366
+ // Check for duplicate
367
+ const existing = await db.users.findByEmail(input.email);
368
+ if (existing) {
369
+ return {
370
+ user: null,
371
+ errors: [{
372
+ field: 'email',
373
+ message: 'Email already registered',
374
+ code: 'VALIDATION_ERROR',
375
+ }],
376
+ };
377
+ }
378
+
379
+ const hashedPassword = await bcrypt.hash(input.password, 10);
380
+ const newUser = await db.users.create({
381
+ name: input.name,
382
+ email: input.email,
383
+ password: hashedPassword,
384
+ });
385
+
386
+ return {
387
+ user: newUser,
388
+ errors: [],
389
+ };
390
+ } catch (error) {
391
+ return {
392
+ user: null,
393
+ errors: [{
394
+ message: 'Failed to create user',
395
+ code: 'INTERNAL_ERROR',
396
+ }],
397
+ };
398
+ }
399
+ },
400
+
401
+ updateUser: async (_, { input }, { db, user }) => {
402
+ if (!user || user.id !== input.id) {
403
+ return {
404
+ user: null,
405
+ errors: [{
406
+ message: 'Unauthorized',
407
+ code: 'UNAUTHORIZED',
408
+ }],
409
+ };
410
+ }
411
+
412
+ const updated = await db.users.update(input.id, {
413
+ ...(input.name && { name: input.name }),
414
+ ...(input.email && { email: input.email }),
415
+ });
416
+
417
+ return {
418
+ user: updated,
419
+ errors: [],
420
+ };
421
+ },
422
+
423
+ deleteUser: async (_, { id }, { db, user }) => {
424
+ if (!user || user.id !== id) {
425
+ return {
426
+ deletedId: null,
427
+ errors: [{ message: 'Unauthorized', code: 'UNAUTHORIZED' }],
428
+ };
429
+ }
430
+
431
+ await db.users.delete(id);
432
+
433
+ return {
434
+ deletedId: id,
435
+ errors: [],
436
+ };
437
+ },
438
+ },
439
+ };
440
+ ```
441
+
442
+ ### Client Mutation Examples
443
+
444
+ ```typescript
445
+ const CREATE_USER = gql`
446
+ mutation CreateUser($input: CreateUserInput!) {
447
+ createUser(input: $input) {
448
+ user {
449
+ id
450
+ name
451
+ email
452
+ createdAt
453
+ }
454
+ errors {
455
+ field
456
+ message
457
+ code
458
+ }
459
+ }
460
+ }
461
+ `;
462
+
463
+ // Usage with error handling
464
+ const [createUser] = useMutation(CREATE_USER);
465
+
466
+ const handleSubmit = async (formData) => {
467
+ const { data } = await createUser({
468
+ variables: {
469
+ input: formData,
470
+ },
471
+ });
472
+
473
+ if (data.createUser.errors.length > 0) {
474
+ // Handle validation errors
475
+ data.createUser.errors.forEach(error => {
476
+ setFieldError(error.field, error.message);
477
+ });
478
+ } else {
479
+ // Success - use the returned user
480
+ navigate(`/users/${data.createUser.user.id}`);
481
+ }
482
+ };
483
+ ```
484
+
485
+ ---
486
+
487
+ ## Pattern 3: Pagination Migration
488
+
489
+ ### REST Offset Pagination
490
+
491
+ ```typescript
492
+ // GET /api/posts?page=2&limit=20
493
+ app.get('/api/posts', async (req, res) => {
494
+ const page = parseInt(req.query.page) || 1;
495
+ const limit = parseInt(req.query.limit) || 20;
496
+ const offset = (page - 1) * limit;
497
+
498
+ const posts = await db.posts.find({
499
+ limit,
500
+ offset,
501
+ });
502
+
503
+ const total = await db.posts.count();
504
+
505
+ res.json({
506
+ data: posts,
507
+ pagination: {
508
+ page,
509
+ limit,
510
+ total,
511
+ totalPages: Math.ceil(total / limit),
512
+ },
513
+ });
514
+ });
515
+ ```
516
+
517
+ ### GraphQL Cursor-Based Pagination (Relay Connections)
518
+
519
+ ```graphql
520
+ type Query {
521
+ posts(
522
+ first: Int
523
+ after: String
524
+ last: Int
525
+ before: String
526
+ filter: PostFilter
527
+ ): PostConnection!
528
+ }
529
+
530
+ type PostConnection {
531
+ edges: [PostEdge!]!
532
+ pageInfo: PageInfo!
533
+ totalCount: Int!
534
+ }
535
+
536
+ type PostEdge {
537
+ node: Post!
538
+ cursor: String!
539
+ }
540
+
541
+ type PageInfo {
542
+ hasNextPage: Boolean!
543
+ hasPreviousPage: Boolean!
544
+ startCursor: String
545
+ endCursor: String
546
+ }
547
+
548
+ input PostFilter {
549
+ published: Boolean
550
+ authorId: ID
551
+ titleContains: String
552
+ }
553
+ ```
554
+
555
+ ### Cursor Pagination Resolver
556
+
557
+ ```typescript
558
+ import { encodeCursor, decodeCursor } from './cursor-utils';
559
+
560
+ const resolvers: IResolvers = {
561
+ Query: {
562
+ posts: async (_, args, { db }) => {
563
+ const { first, after, last, before, filter } = args;
564
+
565
+ // Validate pagination args
566
+ if (first && last) {
567
+ throw new Error('Cannot specify both first and last');
568
+ }
569
+
570
+ const limit = first || last || 20;
571
+ const isForward = !!first || !last;
572
+
573
+ // Decode cursor to get offset
574
+ let offset = 0;
575
+ if (after) {
576
+ offset = decodeCursor(after) + 1;
577
+ } else if (before) {
578
+ offset = Math.max(0, decodeCursor(before) - limit);
579
+ }
580
+
581
+ // Fetch one extra to determine hasNextPage
582
+ const posts = await db.posts.find({
583
+ filter,
584
+ limit: limit + 1,
585
+ offset,
586
+ orderBy: { createdAt: isForward ? 'DESC' : 'ASC' },
587
+ });
588
+
589
+ const hasMore = posts.length > limit;
590
+ const nodes = hasMore ? posts.slice(0, limit) : posts;
591
+
592
+ if (!isForward) {
593
+ nodes.reverse();
594
+ }
595
+
596
+ const edges = nodes.map((post, index) => ({
597
+ node: post,
598
+ cursor: encodeCursor(offset + index),
599
+ }));
600
+
601
+ const totalCount = await db.posts.count(filter);
602
+
603
+ return {
604
+ edges,
605
+ pageInfo: {
606
+ hasNextPage: isForward ? hasMore : offset > 0,
607
+ hasPreviousPage: !isForward ? hasMore : offset > 0,
608
+ startCursor: edges[0]?.cursor,
609
+ endCursor: edges[edges.length - 1]?.cursor,
610
+ },
611
+ totalCount,
612
+ };
613
+ },
614
+ },
615
+ };
616
+
617
+ // cursor-utils.ts
618
+ export const encodeCursor = (offset: number): string => {
619
+ return Buffer.from(`cursor:${offset}`).toString('base64');
620
+ };
621
+
622
+ export const decodeCursor = (cursor: string): number => {
623
+ const decoded = Buffer.from(cursor, 'base64').toString('utf-8');
624
+ return parseInt(decoded.replace('cursor:', ''));
625
+ };
626
+ ```
627
+
628
+ ### Client Pagination Query
629
+
630
+ ```typescript
631
+ const POSTS_QUERY = gql`
632
+ query Posts($first: Int!, $after: String, $filter: PostFilter) {
633
+ posts(first: $first, after: $after, filter: $filter) {
634
+ edges {
635
+ node {
636
+ id
637
+ title
638
+ published
639
+ author {
640
+ name
641
+ }
642
+ }
643
+ cursor
644
+ }
645
+ pageInfo {
646
+ hasNextPage
647
+ endCursor
648
+ }
649
+ totalCount
650
+ }
651
+ }
652
+ `;
653
+
654
+ // Infinite scroll implementation
655
+ const PostList = () => {
656
+ const { data, loading, fetchMore } = useQuery(POSTS_QUERY, {
657
+ variables: { first: 20 },
658
+ });
659
+
660
+ const loadMore = () => {
661
+ fetchMore({
662
+ variables: {
663
+ after: data.posts.pageInfo.endCursor,
664
+ },
665
+ updateQuery: (prev, { fetchMoreResult }) => {
666
+ if (!fetchMoreResult) return prev;
667
+
668
+ return {
669
+ posts: {
670
+ ...fetchMoreResult.posts,
671
+ edges: [
672
+ ...prev.posts.edges,
673
+ ...fetchMoreResult.posts.edges,
674
+ ],
675
+ },
676
+ };
677
+ },
678
+ });
679
+ };
680
+
681
+ return (
682
+ <div>
683
+ {data?.posts.edges.map(({ node }) => (
684
+ <PostCard key={node.id} post={node} />
685
+ ))}
686
+
687
+ {data?.posts.pageInfo.hasNextPage && (
688
+ <button onClick={loadMore}>Load More</button>
689
+ )}
690
+ </div>
691
+ );
692
+ };
693
+ ```
694
+
695
+ ---
696
+
697
+ ## Pattern 4: Authentication Translation
698
+
699
+ ### REST Authentication
700
+
701
+ ```typescript
702
+ // REST middleware
703
+ app.use(async (req, res, next) => {
704
+ const token = req.headers.authorization?.replace('Bearer ', '');
705
+
706
+ if (token) {
707
+ try {
708
+ const payload = jwt.verify(token, process.env.JWT_SECRET);
709
+ req.user = await db.users.findById(payload.userId);
710
+ } catch (error) {
711
+ return res.status(401).json({ error: 'Invalid token' });
712
+ }
713
+ }
714
+
715
+ next();
716
+ });
717
+ ```
718
+
719
+ ### GraphQL Authentication Context
720
+
721
+ ```typescript
722
+ import { ApolloServer } from '@apollo/server';
723
+ import { GraphQLError } from 'graphql';
724
+
725
+ interface AuthContext {
726
+ user: User | null;
727
+ requireAuth: () => User;
728
+ }
729
+
730
+ const server = new ApolloServer<AuthContext>({
731
+ typeDefs,
732
+ resolvers,
733
+ });
734
+
735
+ await startStandaloneServer(server, {
736
+ context: async ({ req }) => {
737
+ const token = req.headers.authorization?.replace('Bearer ', '');
738
+ let user: User | null = null;
739
+
740
+ if (token) {
741
+ try {
742
+ const payload = jwt.verify(token, process.env.JWT_SECRET);
743
+ user = await db.users.findById(payload.userId);
744
+ } catch (error) {
745
+ // Token invalid - continue with user = null
746
+ }
747
+ }
748
+
749
+ return {
750
+ user,
751
+ db,
752
+ loaders: createLoaders(db),
753
+
754
+ // Helper to enforce authentication
755
+ requireAuth: (): User => {
756
+ if (!user) {
757
+ throw new GraphQLError('Authentication required', {
758
+ extensions: { code: 'UNAUTHENTICATED' },
759
+ });
760
+ }
761
+ return user;
762
+ },
763
+ };
764
+ },
765
+ });
766
+ ```
767
+
768
+ ### Field-Level Authorization
769
+
770
+ ```typescript
771
+ import { GraphQLFieldResolver } from 'graphql';
772
+
773
+ // Authorization directive
774
+ const resolvers: IResolvers = {
775
+ Query: {
776
+ me: (_, __, { requireAuth }) => {
777
+ const user = requireAuth();
778
+ return user;
779
+ },
780
+
781
+ users: (_, __, { user }) => {
782
+ // Optional auth - different data based on auth state
783
+ if (user?.role === 'ADMIN') {
784
+ return db.users.findAll();
785
+ }
786
+
787
+ // Public view - limited fields
788
+ return db.users.findPublic();
789
+ },
790
+ },
791
+
792
+ User: {
793
+ email: (user, _, { user: currentUser }) => {
794
+ // Field-level privacy
795
+ if (currentUser?.id === user.id || currentUser?.role === 'ADMIN') {
796
+ return user.email;
797
+ }
798
+ return null;
799
+ },
800
+ },
801
+ };
802
+ ```
803
+
804
+ ---
805
+
806
+ ## BFF (Backend for Frontend) Architecture
807
+
808
+ ### Multi-Client GraphQL Gateway
809
+
810
+ ```typescript
811
+ // Schema stitching for different clients
812
+ import { stitchSchemas } from '@graphql-tools/stitch';
813
+
814
+ // Mobile-optimized schema
815
+ const mobileSchema = makeExecutableSchema({
816
+ typeDefs: `
817
+ type Query {
818
+ # Denormalized for fewer round-trips
819
+ dashboard: MobileDashboard!
820
+ }
821
+
822
+ type MobileDashboard {
823
+ user: User!
824
+ recentPosts: [Post!]!
825
+ notifications: [Notification!]!
826
+ # All data needed for mobile home screen
827
+ }
828
+ `,
829
+ resolvers: mobileResolvers,
830
+ });
831
+
832
+ // Web-optimized schema
833
+ const webSchema = makeExecutableSchema({
834
+ typeDefs: `
835
+ type Query {
836
+ # Granular for efficient caching
837
+ user(id: ID!): User
838
+ posts(filter: PostFilter): PostConnection!
839
+ notifications(unreadOnly: Boolean): [Notification!]!
840
+ }
841
+ `,
842
+ resolvers: webResolvers,
843
+ });
844
+
845
+ // Client-specific servers
846
+ const mobileServer = new ApolloServer({
847
+ schema: mobileSchema,
848
+ introspection: true,
849
+ });
850
+
851
+ const webServer = new ApolloServer({
852
+ schema: webSchema,
853
+ introspection: true,
854
+ });
855
+
856
+ // Route based on client header
857
+ app.use('/graphql', (req, res) => {
858
+ const client = req.headers['x-client-type'];
859
+
860
+ if (client === 'mobile') {
861
+ return mobileServer.handleRequest(req, res);
862
+ }
863
+
864
+ return webServer.handleRequest(req, res);
865
+ });
866
+ ```
867
+
868
+ ---
869
+
870
+ ## Incremental Migration Strategy
871
+
872
+ ### Phase 1: GraphQL Wrapper (Weeks 1-2)
873
+
874
+ ```typescript
875
+ // Wrap existing REST endpoints with GraphQL
876
+ const resolvers: IResolvers = {
877
+ Query: {
878
+ user: async (_, { id }) => {
879
+ // Call existing REST API internally
880
+ const response = await fetch(`http://localhost:3000/api/users/${id}`);
881
+ return response.json();
882
+ },
883
+ },
884
+ };
885
+
886
+ // Allows GraphQL adoption without backend rewrites
887
+ // Clients can start using GraphQL immediately
888
+ ```
889
+
890
+ ### Phase 2: Parallel Implementation (Weeks 3-6)
891
+
892
+ ```typescript
893
+ // Implement GraphQL resolvers with direct DB access
894
+ // Keep REST endpoints running
895
+ const resolvers: IResolvers = {
896
+ Query: {
897
+ user: async (_, { id }, { db }) => {
898
+ // New implementation - direct database
899
+ return db.users.findById(id);
900
+ },
901
+ },
902
+ };
903
+
904
+ // Feature flag to route traffic
905
+ const USE_GRAPHQL = process.env.GRAPHQL_ENABLED === 'true';
906
+
907
+ app.get('/api/users/:id', async (req, res) => {
908
+ if (USE_GRAPHQL) {
909
+ // Forward to GraphQL
910
+ const result = await graphqlServer.executeOperation({
911
+ query: `query GetUser($id: ID!) { user(id: $id) { ... } }`,
912
+ variables: { id: req.params.id },
913
+ });
914
+ return res.json(result.data?.user);
915
+ }
916
+
917
+ // Legacy REST implementation
918
+ const user = await db.users.findById(req.params.id);
919
+ res.json(user);
920
+ });
921
+ ```
922
+
923
+ ### Phase 3: Client Migration (Weeks 7-12)
924
+
925
+ ```typescript
926
+ // Gradual client migration with monitoring
927
+ import { setContext } from '@apollo/client/link/context';
928
+
929
+ const migrationLink = setContext((_, { headers }) => {
930
+ return {
931
+ headers: {
932
+ ...headers,
933
+ 'x-graphql-migration': 'phase-3',
934
+ },
935
+ };
936
+ });
937
+
938
+ // A/B test GraphQL vs REST in production
939
+ // Monitor performance, errors, client satisfaction
940
+ ```
941
+
942
+ ### Phase 4: REST Deprecation (Week 13+)
943
+
944
+ ```typescript
945
+ // Deprecate REST endpoints gradually
946
+ app.get('/api/users/:id', (req, res) => {
947
+ res.status(410).json({
948
+ error: 'This endpoint is deprecated',
949
+ message: 'Please use GraphQL endpoint at /graphql',
950
+ migrationGuide: 'https://docs.example.com/graphql-migration',
951
+ sunsetDate: '2025-06-01',
952
+ });
953
+ });
954
+
955
+ // Eventually remove REST entirely
956
+ ```
957
+
958
+ ---
959
+
960
+ ## Common Pitfalls
961
+
962
+ ### Pitfall 1: N+1 Query Problem
963
+
964
+ ```typescript
965
+ // BAD - Causes N+1 queries
966
+ const resolvers = {
967
+ User: {
968
+ posts: async (user, _, { db }) => {
969
+ // Called once per user - N queries if you fetch N users
970
+ return db.posts.findByUserId(user.id);
971
+ },
972
+ },
973
+ };
974
+
975
+ // GOOD - Use DataLoader
976
+ const resolvers = {
977
+ User: {
978
+ posts: async (user, _, { loaders }) => {
979
+ // Batched and cached
980
+ return loaders.postsByUserId.load(user.id);
981
+ },
982
+ },
983
+ };
984
+ ```
985
+
986
+ ### Pitfall 2: Exposing Database Schema Directly
987
+
988
+ ```typescript
989
+ // BAD - Tightly coupled to database
990
+ type User {
991
+ user_id: Int! # Database column name
992
+ first_name: String # Database structure leaks
993
+ last_name: String
994
+ created_at: String # Raw DB type
995
+ }
996
+
997
+ // GOOD - API-first design
998
+ type User {
999
+ id: ID! # Abstract identifier
1000
+ name: String! # Computed from first + last
1001
+ createdAt: DateTime! # Proper type
1002
+ }
1003
+ ```
1004
+
1005
+ ### Pitfall 3: Missing Error Handling
1006
+
1007
+ ```typescript
1008
+ // BAD - Errors kill entire response
1009
+ const resolvers = {
1010
+ Query: {
1011
+ dashboard: async () => {
1012
+ const user = await fetchUser(); // Throws on error
1013
+ const posts = await fetchPosts(); // Never reached if user fails
1014
+ return { user, posts };
1015
+ },
1016
+ },
1017
+ };
1018
+
1019
+ // GOOD - Partial success model
1020
+ const resolvers = {
1021
+ Query: {
1022
+ dashboard: async () => {
1023
+ return {}; // Return empty object
1024
+ },
1025
+ },
1026
+
1027
+ Dashboard: {
1028
+ user: async (_, __, context) => {
1029
+ try {
1030
+ return await fetchUser();
1031
+ } catch (error) {
1032
+ return null; // Client still gets posts
1033
+ }
1034
+ },
1035
+
1036
+ posts: async () => {
1037
+ try {
1038
+ return await fetchPosts();
1039
+ } catch (error) {
1040
+ return []; // Graceful degradation
1041
+ }
1042
+ },
1043
+ },
1044
+ };
1045
+ ```
1046
+
1047
+ ### Pitfall 4: Ignoring Query Complexity
1048
+
1049
+ ```typescript
1050
+ // BAD - No limits on query depth/complexity
1051
+ // Client can write expensive queries that DOS the server
1052
+
1053
+ // GOOD - Implement complexity limits
1054
+ import { createComplexityLimitRule } from 'graphql-validation-complexity';
1055
+
1056
+ const server = new ApolloServer({
1057
+ typeDefs,
1058
+ resolvers,
1059
+ validationRules: [
1060
+ createComplexityLimitRule(1000, {
1061
+ onCost: (cost) => {
1062
+ console.log('Query cost:', cost);
1063
+ },
1064
+ }),
1065
+ ],
1066
+ });
1067
+
1068
+ // Assign costs to fields
1069
+ const typeDefs = `
1070
+ type Query {
1071
+ users: [User!]! @cost(complexity: 10)
1072
+ user(id: ID!): User @cost(complexity: 1)
1073
+ }
1074
+
1075
+ type User {
1076
+ posts: [Post!]! @cost(complexity: 5, multipliers: ["first"])
1077
+ }
1078
+ `;
1079
+ ```
1080
+
1081
+ ### Pitfall 5: Over-Normalization
1082
+
1083
+ ```typescript
1084
+ // BAD - Too granular, requires many queries
1085
+ type Query {
1086
+ userName(id: ID!): String
1087
+ userEmail(id: ID!): String
1088
+ userPosts(userId: ID!): [Post!]!
1089
+ }
1090
+
1091
+ // GOOD - Logical grouping
1092
+ type Query {
1093
+ user(id: ID!): User
1094
+ }
1095
+
1096
+ type User {
1097
+ name: String!
1098
+ email: String!
1099
+ posts: [Post!]!
1100
+ }
1101
+ ```
1102
+
1103
+ ---
1104
+
1105
+ ## Cross-References
1106
+
1107
+ **Related Skills:**
1108
+ - **graphql-architect/references/schema-design.md** - Type system patterns and schema structure
1109
+ - **graphql-architect/references/federation-guide.md** - Multi-service GraphQL architecture
1110
+ - **backend-developer** - REST API implementation patterns
1111
+ - **api-designer** - API design principles and consistency
1112
+
1113
+ **When to Escalate:**
1114
+ - Federation across microservices → See federation-guide.md
1115
+ - Schema design questions → See schema-design.md
1116
+ - Complex subscription requirements → Consult graphql-architect
1117
+ - Performance optimization → Partner with performance-engineer
1118
+
1119
+ ---
1120
+
1121
+ ## Migration Checklist
1122
+
1123
+ - [ ] Identify most-used REST endpoints
1124
+ - [ ] Map REST resources to GraphQL types
1125
+ - [ ] Design schema following best practices
1126
+ - [ ] Implement DataLoaders for all relations
1127
+ - [ ] Add authentication/authorization
1128
+ - [ ] Implement pagination (cursor-based)
1129
+ - [ ] Set up query complexity limits
1130
+ - [ ] Create client migration plan
1131
+ - [ ] Monitor performance metrics
1132
+ - [ ] Document GraphQL queries for clients
1133
+ - [ ] Train team on GraphQL patterns
1134
+ - [ ] Plan REST endpoint sunset timeline
1135
+
1136
+ **Migration complete when:**
1137
+ - All critical paths use GraphQL
1138
+ - REST endpoints deprecated with sunset dates
1139
+ - Client applications fully migrated
1140
+ - Performance metrics meet or exceed REST baseline
1141
+ - Team confident in GraphQL maintenance