@fprad0/skill-master-mcp 0.0.11 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (337) hide show
  1. package/CHANGELOG.md +96 -83
  2. package/README.md +472 -443
  3. package/VERSION.md +9 -9
  4. package/bin/lib/bootstrap-global-core.mjs +34 -0
  5. package/bin/lib/client-config.mjs +293 -268
  6. package/bin/lib/doctor-core.mjs +202 -0
  7. package/bin/lib/menu-core.mjs +1629 -1154
  8. package/bin/lib/operation-result.mjs +59 -0
  9. package/bin/lib/register-clients-core.mjs +247 -0
  10. package/bin/lib/skill-installation.mjs +215 -0
  11. package/bin/lib/update-cli-core.mjs +117 -0
  12. package/bin/skill-master-activation.mjs +163 -163
  13. package/bin/skill-master-bootstrap-global.mjs +61 -49
  14. package/bin/skill-master-configure-private-registry.mjs +3 -3
  15. package/bin/skill-master-doctor.mjs +239 -181
  16. package/bin/skill-master-eval-activation.mjs +32 -32
  17. package/bin/skill-master-install-global-skills.mjs +59 -97
  18. package/bin/skill-master-install-project-skills.mjs +97 -0
  19. package/bin/skill-master-menu.mjs +406 -320
  20. package/bin/skill-master-register-clients.mjs +232 -98
  21. package/bin/skill-master-success-skills.mjs +307 -307
  22. package/bin/skill-master-update.mjs +121 -72
  23. package/bin/skill-master.mjs +3 -3
  24. package/dist/activation.d.ts.map +1 -1
  25. package/dist/activation.js +12 -0
  26. package/dist/activation.js.map +1 -1
  27. package/dist/prompt-router.d.ts.map +1 -1
  28. package/dist/prompt-router.js +19 -0
  29. package/dist/prompt-router.js.map +1 -1
  30. package/dist/recommender.d.ts.map +1 -1
  31. package/dist/recommender.js +4 -1
  32. package/dist/recommender.js.map +1 -1
  33. package/docs/architecture/APRENDIZADO_DE_IMPLEMENTACOES_BEM_SUCEDIDAS.md +125 -125
  34. package/docs/architecture/ARQUITETURA_AUTO_UPDATE.md +9 -9
  35. package/docs/architecture/PLANO_MASTER_ACIONAMENTO_AUTOMATICO_E_APRENDIZADO.md +341 -341
  36. package/docs/architecture/REDE_SEGURA_DE_SKILLS.md +148 -148
  37. package/docs/operations/GUIA_MULTI_COMPUTADOR.md +262 -255
  38. package/docs/operations/GUIA_NPM_PRIVADO.md +294 -294
  39. package/docs/operations/GUIA_NPM_PUBLICO.md +147 -147
  40. package/docs/operations/MENU_VISUAL_EVIDENCE_2026-06-28.md +66 -0
  41. package/docs/operations/assets/menu-frame-compact.html +76 -0
  42. package/docs/operations/assets/menu-frame-compact.png +0 -0
  43. package/docs/operations/assets/menu-frame-large.html +84 -0
  44. package/docs/operations/assets/menu-frame-large.png +0 -0
  45. package/docs/operations/assets/menu-frame-running.html +80 -0
  46. package/docs/operations/assets/menu-frame-running.png +0 -0
  47. package/docs/operations/cross-platform-auth-transfer/ANALISE_COMPATIBILIDADE_MCP_2026-06-28.md +140 -0
  48. package/docs/operations/cross-platform-auth-transfer/README_TRANSFERENCIA.md +85 -0
  49. package/docs/operations/reborn-menu-cyberpunk-transfer/ANALISE_MENU_REBORN_CYBERPUNK_2026-06-28.md +174 -0
  50. package/docs/operations/reborn-menu-cyberpunk-transfer/HANDOFF_IMPLEMENTACAO_REBORN_CYBERPUNK_2026-06-28.md +119 -0
  51. package/docs/operations/reborn-menu-cyberpunk-transfer/ORDEM_DE_EXECUCAO_MENU_REBORN_CYBERPUNK.md +134 -0
  52. package/docs/operations/reborn-menu-cyberpunk-transfer/README_TRANSFERENCIA.md +84 -0
  53. package/docs/operations/reborn-menu-cyberpunk-transfer/README_TRANSFERENCIA_REBORN_PACKAGE.md +56 -0
  54. package/docs/operations/reborn-menu-cyberpunk-transfer/references/cyan-hud-frame-sheet.jpg +0 -0
  55. package/docs/operations/reborn-menu-cyberpunk-transfer/references/cyberpunk-pattern-sheet.jpg +0 -0
  56. package/docs/operations/reborn-menu-cyberpunk-transfer/references/fluid-workflow-windows.gif +0 -0
  57. package/docs/operations/token-economy-transfer/ANALISE_AVANCADA_ECONOMIA_TOKENS_2026-06-30.md +141 -0
  58. package/docs/operations/token-economy-transfer/PLANO_DEV_SENIOR_MASTER_TOKEN_ECONOMY_2026-06-30.md +171 -0
  59. package/docs/operations/token-economy-transfer/README_TRANSFERENCIA_TOKEN_ECONOMY.md +31 -0
  60. package/docs/planning/MENU_RUNTIME_CORRECTION_PLAN_2026-06-30.md +551 -0
  61. package/docs/planning/V0_0_9_APROVACAO_CRITICA_MENSAGENS_DE_VENDA.md +85 -85
  62. package/docs/planning/V0_0_9_FONTES_E_CRITERIOS_DE_AUTORIDADE.md +139 -139
  63. package/docs/planning/V0_0_9_MATRIZ_SKILLS_MULTIDISCIPLINARES.md +105 -105
  64. package/docs/planning/V0_0_9_POLITICA_MORAL_CATOLICA_PARA_IA.md +181 -181
  65. package/docs/planning/V0_0_9_PROMPTS_EXECUCAO.md +59 -59
  66. package/docs/planning/V0_0_9_ROADMAP_DISCERNIMENTO_E_CONHECIMENTO_AMPLO.md +181 -181
  67. package/docs/prompt-tasks/PROMPT_TASK_001_BOOTSTRAP_SKILL_MASTER_MCP.md +6 -0
  68. package/docs/prompt-tasks/PROMPT_TASK_002_AUTO_UPDATE_LAUNCHER.md +6 -0
  69. package/docs/prompt-tasks/PROMPT_TASK_003_REMOTE_MANIFEST_AND_RELEASES.md +6 -0
  70. package/docs/prompt-tasks/PROMPT_TASK_004_MULTI_USER_DISTRIBUTION.md +6 -0
  71. package/docs/prompt-tasks/PROMPT_TASK_005_SECURITY_AND_QUALITY_GATE.md +6 -0
  72. package/docs/prompt-tasks/PROMPT_TASK_006_MASTER_ACIONAMENTO_APRENDIZADO.md +83 -0
  73. package/docs/prompt-tasks/PROMPT_TASK_007_PERSONA_ORQUESTRADORA.md +88 -0
  74. package/docs/prompt-tasks/PROMPT_TASK_008_PROMPT_ROUTER_MODOS_ATIVACAO.md +156 -0
  75. package/docs/prompt-tasks/PROMPT_TASK_009_PIPELINE_APRENDIZADO_SUCESSO.md +105 -0
  76. package/docs/prompt-tasks/PROMPT_TASK_010_EVALS_GOVERNANCA_ATIVACAO.md +119 -0
  77. package/docs/prompt-tasks/PROMPT_TASK_011_MENU_NOTIFICACOES_NOTION.md +120 -0
  78. package/docs/prompt-tasks/PROMPT_TASK_012_MENU_CYBERPUNK_PIXEL_FRAME.md +123 -0
  79. package/docs/prompt-tasks/PROMPT_TASK_013_MENU_FLUID_DNA_ANIMATION.md +114 -0
  80. package/docs/prompt-tasks/PROMPT_TASK_014_MENU_FUNCTIONAL_PARITY_QA.md +157 -0
  81. package/docs/prompt-tasks/PROMPT_TASK_015_TRANSFER_RELEASE_HANDOFF.md +127 -0
  82. package/docs/prompt-tasks/PROMPT_TASK_016_CROSS_PLATFORM_MCP_AUTH_REGISTRATION.md +107 -0
  83. package/docs/prompt-tasks/PROMPT_TASK_018_NPM_PUBLISH_2FA_SETUP.md +80 -0
  84. package/docs/prompt-tasks/PROMPT_TASK_019_TOKEN_ECONOMY_GLOBAL_SKILLS.md +56 -0
  85. package/docs/prompt-tasks/PROMPT_TASK_MASTER_EXECUTOR.md +6 -0
  86. package/docs/skill-candidates/v0.0.10/cli-creator/LICENSE.txt +201 -201
  87. package/docs/skill-candidates/v0.0.10/cli-creator/SKILL.md +160 -160
  88. package/docs/skill-candidates/v0.0.10/cli-creator/agents/openai.yaml +4 -4
  89. package/docs/skill-candidates/v0.0.10/cli-creator/references/agent-cli-patterns.md +154 -154
  90. package/docs/skill-candidates/v0.0.10/developer-workstation-ops/SKILL.md +32 -32
  91. package/docs/skill-candidates/v0.0.10/figma/LICENSE.txt +1 -1
  92. package/docs/skill-candidates/v0.0.10/figma/SKILL.md +42 -42
  93. package/docs/skill-candidates/v0.0.10/figma/agents/openai.yaml +14 -14
  94. package/docs/skill-candidates/v0.0.10/figma/assets/figma-small.svg +3 -3
  95. package/docs/skill-candidates/v0.0.10/figma/assets/icon.svg +28 -28
  96. package/docs/skill-candidates/v0.0.10/figma/references/figma-mcp-config.md +35 -35
  97. package/docs/skill-candidates/v0.0.10/figma/references/figma-tools-and-prompts.md +34 -34
  98. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/LICENSE.TXT +1 -1
  99. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/SKILL.md +349 -349
  100. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/agents/openai.yaml +14 -14
  101. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/assets/figma-small.svg +3 -3
  102. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/assets/icon.svg +28 -28
  103. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/references/mapping-checklist.md +7 -7
  104. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/scripts/normalize_node_id.py +25 -25
  105. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/LICENSE.TXT +1 -1
  106. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/SKILL.md +537 -537
  107. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/agents/openai.yaml +14 -14
  108. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/assets/figma-small.svg +3 -3
  109. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/assets/icon.svg +28 -28
  110. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/references/rule-template.md +15 -15
  111. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/scripts/check_agents_md.sh +9 -9
  112. package/docs/skill-candidates/v0.0.10/figma-generate-design/LICENSE.TXT +1 -1
  113. package/docs/skill-candidates/v0.0.10/figma-generate-design/SKILL.md +341 -341
  114. package/docs/skill-candidates/v0.0.10/figma-generate-design/agents/openai.yaml +14 -14
  115. package/docs/skill-candidates/v0.0.10/figma-generate-design/assets/figma-small.svg +3 -3
  116. package/docs/skill-candidates/v0.0.10/figma-generate-design/assets/icon.svg +28 -28
  117. package/docs/skill-candidates/v0.0.10/figma-generate-design/maintainers.yml +1 -1
  118. package/docs/skill-candidates/v0.0.10/figma-generate-library/LICENSE.TXT +1 -1
  119. package/docs/skill-candidates/v0.0.10/figma-generate-library/SKILL.md +314 -314
  120. package/docs/skill-candidates/v0.0.10/figma-generate-library/agents/openai.yaml +14 -14
  121. package/docs/skill-candidates/v0.0.10/figma-generate-library/assets/figma-small.svg +3 -3
  122. package/docs/skill-candidates/v0.0.10/figma-generate-library/assets/icon.svg +28 -28
  123. package/docs/skill-candidates/v0.0.10/figma-generate-library/maintainers.yml +3 -3
  124. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/code-connect-setup.md +260 -260
  125. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/component-creation.md +1014 -1014
  126. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/discovery-phase.md +518 -518
  127. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/documentation-creation.md +834 -834
  128. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/error-recovery.md +540 -540
  129. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/naming-conventions.md +527 -527
  130. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/token-creation.md +962 -962
  131. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/bindVariablesToComponent.js +110 -110
  132. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/cleanupOrphans.js +127 -127
  133. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createComponentWithVariants.js +148 -148
  134. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createDocumentationPage.js +139 -139
  135. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createSemanticTokens.js +108 -108
  136. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createVariableCollection.js +49 -49
  137. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/inspectFileStructure.js +121 -121
  138. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/rehydrateState.js +92 -92
  139. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/validateCreation.js +83 -83
  140. package/docs/skill-candidates/v0.0.10/figma-implement-design/LICENSE.txt +1 -1
  141. package/docs/skill-candidates/v0.0.10/figma-implement-design/SKILL.md +258 -258
  142. package/docs/skill-candidates/v0.0.10/figma-implement-design/agents/openai.yaml +14 -14
  143. package/docs/skill-candidates/v0.0.10/figma-implement-design/assets/figma-small.svg +3 -3
  144. package/docs/skill-candidates/v0.0.10/figma-implement-design/assets/icon.svg +28 -28
  145. package/docs/skill-candidates/v0.0.10/figma-use/LICENSE.TXT +1 -1
  146. package/docs/skill-candidates/v0.0.10/figma-use/SKILL.md +233 -233
  147. package/docs/skill-candidates/v0.0.10/figma-use/agents/openai.yaml +14 -14
  148. package/docs/skill-candidates/v0.0.10/figma-use/assets/figma-small.svg +3 -3
  149. package/docs/skill-candidates/v0.0.10/figma-use/assets/icon.svg +28 -28
  150. package/docs/skill-candidates/v0.0.10/figma-use/maintainers.yml +1 -1
  151. package/docs/skill-candidates/v0.0.10/figma-use/references/api-reference.md +301 -301
  152. package/docs/skill-candidates/v0.0.10/figma-use/references/common-patterns.md +512 -512
  153. package/docs/skill-candidates/v0.0.10/figma-use/references/component-patterns.md +488 -488
  154. package/docs/skill-candidates/v0.0.10/figma-use/references/effect-style-patterns.md +123 -123
  155. package/docs/skill-candidates/v0.0.10/figma-use/references/gotchas.md +599 -599
  156. package/docs/skill-candidates/v0.0.10/figma-use/references/maintainers.yml +12 -12
  157. package/docs/skill-candidates/v0.0.10/figma-use/references/plugin-api-patterns.md +513 -513
  158. package/docs/skill-candidates/v0.0.10/figma-use/references/plugin-api-standalone.d.ts +11293 -11293
  159. package/docs/skill-candidates/v0.0.10/figma-use/references/plugin-api-standalone.index.md +441 -441
  160. package/docs/skill-candidates/v0.0.10/figma-use/references/text-style-patterns.md +203 -203
  161. package/docs/skill-candidates/v0.0.10/figma-use/references/validation-and-recovery.md +109 -109
  162. package/docs/skill-candidates/v0.0.10/figma-use/references/variable-patterns.md +354 -354
  163. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/maintainers.yml +9 -9
  164. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-components--creating.md +17 -17
  165. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-components--using.md +17 -17
  166. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-components.md +50 -50
  167. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-effect-styles.md +52 -52
  168. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-text-styles.md +90 -90
  169. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-variables--creating.md +13 -13
  170. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-variables--using.md +13 -13
  171. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-variables.md +64 -64
  172. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds.md +41 -41
  173. package/docs/skill-candidates/v0.0.10/frontend-design/LICENSE.txt +177 -177
  174. package/docs/skill-candidates/v0.0.10/frontend-design/SKILL.md +55 -55
  175. package/docs/skill-candidates/v0.0.10/frontend-ui-ux-systems/SKILL.md +32 -32
  176. package/docs/skill-candidates/v0.0.10/github/SKILL.md +74 -74
  177. package/docs/skill-candidates/v0.0.10/github/agents/openai.yaml +6 -6
  178. package/docs/skill-candidates/v0.0.10/github/assets/github-small.svg +3 -3
  179. package/docs/skill-candidates/v0.0.10/image-graphic-design-rendering/SKILL.md +28 -28
  180. package/docs/skill-candidates/v0.0.10/language-quality-pt-en-fr-it-ru/SKILL.md +28 -28
  181. package/docs/skill-candidates/v0.0.10/math-physics-reasoning/SKILL.md +28 -28
  182. package/docs/skill-candidates/v0.0.10/mcp-builder/LICENSE.txt +201 -201
  183. package/docs/skill-candidates/v0.0.10/mcp-builder/SKILL.md +236 -236
  184. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/evaluation.md +601 -601
  185. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/mcp_best_practices.md +249 -249
  186. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/node_mcp_server.md +969 -969
  187. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/python_mcp_server.md +718 -718
  188. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/connections.py +151 -151
  189. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/evaluation.py +373 -373
  190. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/example_evaluation.xml +22 -22
  191. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/requirements.txt +2 -2
  192. package/docs/skill-candidates/v0.0.10/mcp-client-readiness/SKILL.md +31 -31
  193. package/docs/skill-candidates/v0.0.10/openai-docs/LICENSE.txt +201 -201
  194. package/docs/skill-candidates/v0.0.10/openai-docs/SKILL.md +161 -161
  195. package/docs/skill-candidates/v0.0.10/openai-docs/agents/openai.yaml +14 -14
  196. package/docs/skill-candidates/v0.0.10/openai-docs/assets/openai-small.svg +3 -3
  197. package/docs/skill-candidates/v0.0.10/openai-docs/references/latest-model.md +37 -37
  198. package/docs/skill-candidates/v0.0.10/openai-docs/references/prompting-guide.md +244 -244
  199. package/docs/skill-candidates/v0.0.10/openai-docs/references/upgrade-guide.md +181 -181
  200. package/docs/skill-candidates/v0.0.10/openai-docs/scripts/fetch-codex-manual.mjs +598 -598
  201. package/docs/skill-candidates/v0.0.10/openai-docs/scripts/resolve-latest-model-info.js +147 -147
  202. package/docs/skill-candidates/v0.0.10/playwright/NOTICE.txt +14 -14
  203. package/docs/skill-candidates/v0.0.10/playwright/SKILL.md +147 -147
  204. package/docs/skill-candidates/v0.0.10/playwright/agents/openai.yaml +6 -6
  205. package/docs/skill-candidates/v0.0.10/playwright/assets/playwright-small.svg +3 -3
  206. package/docs/skill-candidates/v0.0.10/playwright/references/cli.md +116 -116
  207. package/docs/skill-candidates/v0.0.10/playwright/references/workflows.md +95 -95
  208. package/docs/skill-candidates/v0.0.10/playwright/scripts/playwright_cli.sh +25 -25
  209. package/docs/skill-candidates/v0.0.10/polyglot-backend-engineering/SKILL.md +32 -32
  210. package/docs/skill-candidates/v0.0.10/screenshot/LICENSE.txt +201 -201
  211. package/docs/skill-candidates/v0.0.10/screenshot/SKILL.md +267 -267
  212. package/docs/skill-candidates/v0.0.10/screenshot/agents/openai.yaml +6 -6
  213. package/docs/skill-candidates/v0.0.10/screenshot/assets/screenshot-small.svg +5 -5
  214. package/docs/skill-candidates/v0.0.10/screenshot/scripts/ensure_macos_permissions.sh +54 -54
  215. package/docs/skill-candidates/v0.0.10/screenshot/scripts/macos_display_info.swift +22 -22
  216. package/docs/skill-candidates/v0.0.10/screenshot/scripts/macos_permissions.swift +40 -40
  217. package/docs/skill-candidates/v0.0.10/screenshot/scripts/macos_window_info.swift +126 -126
  218. package/docs/skill-candidates/v0.0.10/screenshot/scripts/take_screenshot.ps1 +163 -163
  219. package/docs/skill-candidates/v0.0.10/screenshot/scripts/take_screenshot.py +585 -585
  220. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/SKILL.md +62 -62
  221. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/agents/openai.yaml +4 -4
  222. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/references/activation-policy.md +77 -77
  223. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/references/human-approval-policy.md +83 -83
  224. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/references/persona-dev-senior-master.md +46 -46
  225. package/docs/skill-candidates/v0.0.10/terminal-menu-operations/SKILL.md +30 -30
  226. package/docs/skill-candidates/v0.0.10/terminal-pixel-art-tui/SKILL.md +43 -43
  227. package/docs/skill-candidates/v0.0.10/webapp-testing/LICENSE.txt +201 -201
  228. package/docs/skill-candidates/v0.0.10/webapp-testing/SKILL.md +95 -95
  229. package/docs/skill-candidates/v0.0.10/webapp-testing/examples/console_logging.py +34 -34
  230. package/docs/skill-candidates/v0.0.10/webapp-testing/examples/element_discovery.py +39 -39
  231. package/docs/skill-candidates/v0.0.10/webapp-testing/examples/static_html_automation.py +32 -32
  232. package/docs/skill-candidates/v0.0.10/webapp-testing/scripts/with_server.py +105 -105
  233. package/docs/skill-candidates/v0.0.10/winui-app/LICENSE.txt +201 -201
  234. package/docs/skill-candidates/v0.0.10/winui-app/SKILL.md +94 -94
  235. package/docs/skill-candidates/v0.0.10/winui-app/agents/openai.yaml +5 -5
  236. package/docs/skill-candidates/v0.0.10/winui-app/config.yaml +50 -50
  237. package/docs/skill-candidates/v0.0.10/winui-app/references/_sections.md +96 -96
  238. package/docs/skill-candidates/v0.0.10/winui-app/references/accessibility-input-and-localization.md +51 -51
  239. package/docs/skill-candidates/v0.0.10/winui-app/references/build-run-and-launch-verification.md +72 -72
  240. package/docs/skill-candidates/v0.0.10/winui-app/references/community-toolkit-controls-and-helpers.md +57 -57
  241. package/docs/skill-candidates/v0.0.10/winui-app/references/controls-layout-and-adaptive-ui.md +84 -84
  242. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-environment-audit-and-remediation.md +82 -82
  243. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-setup-and-project-selection.md +67 -67
  244. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-template-first-recovery.md +62 -62
  245. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-winui-app-structure.md +62 -62
  246. package/docs/skill-candidates/v0.0.10/winui-app/references/motion-animations-and-polish.md +45 -45
  247. package/docs/skill-candidates/v0.0.10/winui-app/references/performance-diagnostics-and-responsiveness.md +46 -46
  248. package/docs/skill-candidates/v0.0.10/winui-app/references/sample-source-map.md +37 -37
  249. package/docs/skill-candidates/v0.0.10/winui-app/references/shell-navigation-and-windowing.md +67 -67
  250. package/docs/skill-candidates/v0.0.10/winui-app/references/styling-theming-materials-and-icons.md +71 -71
  251. package/docs/skill-candidates/v0.0.10/winui-app/references/testing-debugging-and-review-checklists.md +77 -77
  252. package/docs/skill-candidates/v0.0.10/winui-app/references/windows-app-sdk-lifecycle-notifications-and-deployment.md +52 -52
  253. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/SKILL.md +398 -398
  254. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/common-patterns.md +330 -330
  255. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/complete-examples.md +871 -871
  256. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/component-patterns.md +501 -501
  257. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/data-fetching.md +766 -766
  258. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/file-organization.md +501 -501
  259. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/loading-and-error-states.md +500 -500
  260. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/performance.md +405 -405
  261. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/routing-guide.md +363 -363
  262. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/styling-guide.md +427 -427
  263. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/typescript-standards.md +417 -417
  264. package/docs/skill-candidates/v0.0.11/git-version-control-ops/SKILL.md +34 -34
  265. package/docs/skill-candidates/v0.0.11/go-engineering/SKILL.md +34 -34
  266. package/docs/skill-candidates/v0.0.11/java-engineering/SKILL.md +34 -34
  267. package/docs/skill-candidates/v0.0.11/javascript-engineering/SKILL.md +34 -34
  268. package/docs/skill-candidates/v0.0.11/json-contract-design/SKILL.md +34 -34
  269. package/docs/skill-candidates/v0.0.11/multi-client-mcp-ops/SKILL.md +36 -36
  270. package/docs/skill-candidates/v0.0.11/nextjs/SKILL.md +745 -745
  271. package/docs/skill-candidates/v0.0.11/nextjs/agents/openai.yaml +3 -3
  272. package/docs/skill-candidates/v0.0.11/nextjs/references/app-router-files.md +94 -94
  273. package/docs/skill-candidates/v0.0.11/python-engineering/SKILL.md +34 -34
  274. package/docs/skill-candidates/v0.0.11/ruby-engineering/SKILL.md +34 -34
  275. package/docs/skill-candidates/v0.0.11/senior-fullstack/SKILL.md +209 -209
  276. package/docs/skill-candidates/v0.0.11/senior-fullstack/references/architecture_patterns.md +103 -103
  277. package/docs/skill-candidates/v0.0.11/senior-fullstack/references/development_workflows.md +103 -103
  278. package/docs/skill-candidates/v0.0.11/senior-fullstack/references/tech_stack_guide.md +103 -103
  279. package/docs/skill-candidates/v0.0.11/senior-fullstack/scripts/code_quality_analyzer.py +114 -114
  280. package/docs/skill-candidates/v0.0.11/senior-fullstack/scripts/fullstack_scaffolder.py +114 -114
  281. package/docs/skill-candidates/v0.0.11/senior-fullstack/scripts/project_scaffolder.py +114 -114
  282. package/docs/skill-candidates/v0.0.11/shadcn/SKILL.md +573 -573
  283. package/docs/skill-candidates/v0.0.11/shadcn/agents/openai.yaml +3 -3
  284. package/docs/skill-candidates/v0.0.11/sql-postgresql-engineering/SKILL.md +34 -34
  285. package/docs/skill-candidates/v0.0.11/terminal-shell-ops/SKILL.md +34 -34
  286. package/docs/skill-candidates/v0.0.11/typescript-expert/SKILL.md +429 -429
  287. package/docs/skill-candidates/v0.0.11/typescript-expert/references/tsconfig-strict.json +91 -91
  288. package/docs/skill-candidates/v0.0.11/typescript-expert/references/typescript-cheatsheet.md +383 -383
  289. package/docs/skill-candidates/v0.0.11/typescript-expert/references/utility-types.ts +335 -335
  290. package/docs/skill-candidates/v0.0.11/typescript-expert/scripts/ts_diagnostic.py +203 -203
  291. package/docs/skill-candidates/v0.0.11/ui-component-primitives/SKILL.md +34 -34
  292. package/docs/skill-candidates/v0.0.11/web-mobile-design-systems/SKILL.md +34 -34
  293. package/docs/skill-candidates/v0.0.11/windows-linux-platform-ops/SKILL.md +34 -34
  294. package/docs/skill-candidates/v0.0.12/context-compression-handoff/SKILL.md +47 -0
  295. package/docs/skill-candidates/v0.0.12/csharp-senior-master-engineering/SKILL.md +32 -0
  296. package/docs/skill-candidates/v0.0.12/css-senior-master-engineering/SKILL.md +32 -0
  297. package/docs/skill-candidates/v0.0.12/go-senior-master-engineering/SKILL.md +32 -0
  298. package/docs/skill-candidates/v0.0.12/html-senior-master-engineering/SKILL.md +32 -0
  299. package/docs/skill-candidates/v0.0.12/javascript-senior-master-engineering/SKILL.md +32 -0
  300. package/docs/skill-candidates/v0.0.12/json-senior-master-engineering/SKILL.md +32 -0
  301. package/docs/skill-candidates/v0.0.12/prompt-budget-gate/SKILL.md +46 -0
  302. package/docs/skill-candidates/v0.0.12/python-senior-master-engineering/SKILL.md +32 -0
  303. package/docs/skill-candidates/v0.0.12/react-senior-master-engineering/SKILL.md +32 -0
  304. package/docs/skill-candidates/v0.0.12/ruby-senior-master-engineering/SKILL.md +32 -0
  305. package/docs/skill-candidates/v0.0.12/senior-master-code-optimizer/SKILL.md +48 -0
  306. package/docs/skill-candidates/v0.0.12/sql-senior-master-engineering/SKILL.md +31 -0
  307. package/docs/skill-candidates/v0.0.12/token-economy-orchestrator/SKILL.md +38 -0
  308. package/docs/skill-candidates/v0.0.12/typescript-senior-master-engineering/SKILL.md +35 -0
  309. package/docs/skill-candidates/v0.0.9/ai-ethics-human-dignity/SKILL.md +32 -32
  310. package/docs/skill-candidates/v0.0.9/broad-domain-router/SKILL.md +41 -41
  311. package/docs/skill-candidates/v0.0.9/catholic-moral-discernment/SKILL.md +31 -31
  312. package/docs/skill-candidates/v0.0.9/engineering-systems-master/SKILL.md +31 -31
  313. package/docs/skill-candidates/v0.0.9/language-quality-pt-en-fr/SKILL.md +28 -28
  314. package/docs/skill-candidates/v0.0.9/math-science-reasoning/SKILL.md +29 -29
  315. package/docs/skill-candidates/v0.0.9/philosophy-sociology-discernment/SKILL.md +28 -28
  316. package/docs/skill-candidates/v0.0.9/professional-boundary-triage/SKILL.md +40 -40
  317. package/docs/skill-candidates/v0.0.9/release-ethics-gate/SKILL.md +32 -32
  318. package/docs/skill-candidates/v0.0.9/source-authority-reviewer/SKILL.md +31 -31
  319. package/examples/client-configs/claude-code.commands.md +21 -17
  320. package/examples/client-configs/claude-code.project.mcp.json +18 -18
  321. package/examples/client-configs/claude-desktop.macos.json +18 -18
  322. package/examples/client-configs/claude-desktop.windows.json +20 -20
  323. package/examples/client-configs/codex.windows.toml +11 -11
  324. package/examples/client-configs/gemini-code-assist.intellij.mcp.json +18 -18
  325. package/examples/client-configs/gemini.linux.settings.json +21 -21
  326. package/examples/client-configs/gemini.windows.settings.json +23 -23
  327. package/examples/client-configs/generic-stdio.json +16 -16
  328. package/manifests/channels/beta.json +26 -26
  329. package/manifests/channels/stable.json +27 -27
  330. package/network/approved-skills.json +54 -54
  331. package/network/unapproved-skill-candidates.json +110 -110
  332. package/package.json +87 -78
  333. package/scripts/configure-private-registry.mjs +208 -208
  334. package/scripts/lib/private-registry.mjs +97 -97
  335. package/scripts/render-menu-evidence.mjs +130 -0
  336. package/scripts/verify-menu-actions.mjs +117 -115
  337. package/sources.json +11 -11
@@ -1,767 +1,767 @@
1
- # Data Fetching Patterns
2
-
3
- Modern data fetching using TanStack Query with Suspense boundaries, cache-first strategies, and centralized API services.
4
-
5
- ---
6
-
7
- ## PRIMARY PATTERN: useSuspenseQuery
8
-
9
- ### Why useSuspenseQuery?
10
-
11
- For **all new components**, use `useSuspenseQuery` instead of regular `useQuery`:
12
-
13
- **Benefits:**
14
- - No `isLoading` checks needed
15
- - Integrates with Suspense boundaries
16
- - Cleaner component code
17
- - Consistent loading UX
18
- - Better error handling with error boundaries
19
-
20
- ### Basic Pattern
21
-
22
- ```typescript
23
- import { useSuspenseQuery } from '@tanstack/react-query';
24
- import { myFeatureApi } from '../api/myFeatureApi';
25
-
26
- export const MyComponent: React.FC<Props> = ({ id }) => {
27
- // No isLoading - Suspense handles it!
28
- const { data } = useSuspenseQuery({
29
- queryKey: ['myEntity', id],
30
- queryFn: () => myFeatureApi.getEntity(id),
31
- });
32
-
33
- // data is ALWAYS defined here (not undefined | Data)
34
- return <div>{data.name}</div>;
35
- };
36
-
37
- // Wrap in Suspense boundary
38
- <SuspenseLoader>
39
- <MyComponent id={123} />
40
- </SuspenseLoader>
41
- ```
42
-
43
- ### useSuspenseQuery vs useQuery
44
-
45
- | Feature | useSuspenseQuery | useQuery |
46
- |---------|------------------|----------|
47
- | Loading state | Handled by Suspense | Manual `isLoading` check |
48
- | Data type | Always defined | `Data \| undefined` |
49
- | Use with | Suspense boundaries | Traditional components |
50
- | Recommended for | **NEW components** | Legacy code only |
51
- | Error handling | Error boundaries | Manual error state |
52
-
53
- **When to use regular useQuery:**
54
- - Maintaining legacy code
55
- - Very simple cases without Suspense
56
- - Polling with background updates
57
-
58
- **For new components: Always prefer useSuspenseQuery**
59
-
60
- ---
61
-
62
- ## Cache-First Strategy
63
-
64
- ### Cache-First Pattern Example
65
-
66
- **Smart caching** reduces API calls by checking React Query cache first:
67
-
68
- ```typescript
69
- import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
70
- import { postApi } from '../api/postApi';
71
-
72
- export function useSuspensePost(postId: number) {
73
- const queryClient = useQueryClient();
74
-
75
- return useSuspenseQuery({
76
- queryKey: ['post', postId],
77
- queryFn: async () => {
78
- // Strategy 1: Try to get from list cache first
79
- const cachedListData = queryClient.getQueryData<{ posts: Post[] }>([
80
- 'posts',
81
- 'list'
82
- ]);
83
-
84
- if (cachedListData?.posts) {
85
- const cachedPost = cachedListData.posts.find(
86
- (post) => post.id === postId
87
- );
88
-
89
- if (cachedPost) {
90
- return cachedPost; // Return from cache!
91
- }
92
- }
93
-
94
- // Strategy 2: Not in cache, fetch from API
95
- return postApi.getPost(postId);
96
- },
97
- staleTime: 5 * 60 * 1000, // Consider fresh for 5 minutes
98
- gcTime: 10 * 60 * 1000, // Keep in cache for 10 minutes
99
- refetchOnWindowFocus: false, // Don't refetch on focus
100
- });
101
- }
102
- ```
103
-
104
- **Key Points:**
105
- - Check grid/list cache before API call
106
- - Avoids redundant requests
107
- - `staleTime`: How long data is considered fresh
108
- - `gcTime`: How long unused data stays in cache
109
- - `refetchOnWindowFocus: false`: User preference
110
-
111
- ---
112
-
113
- ## Parallel Data Fetching
114
-
115
- ### useSuspenseQueries
116
-
117
- When fetching multiple independent resources:
118
-
119
- ```typescript
120
- import { useSuspenseQueries } from '@tanstack/react-query';
121
-
122
- export const MyComponent: React.FC = () => {
123
- const [userQuery, settingsQuery, preferencesQuery] = useSuspenseQueries({
124
- queries: [
125
- {
126
- queryKey: ['user'],
127
- queryFn: () => userApi.getCurrentUser(),
128
- },
129
- {
130
- queryKey: ['settings'],
131
- queryFn: () => settingsApi.getSettings(),
132
- },
133
- {
134
- queryKey: ['preferences'],
135
- queryFn: () => preferencesApi.getPreferences(),
136
- },
137
- ],
138
- });
139
-
140
- // All data available, Suspense handles loading
141
- const user = userQuery.data;
142
- const settings = settingsQuery.data;
143
- const preferences = preferencesQuery.data;
144
-
145
- return <Display user={user} settings={settings} prefs={preferences} />;
146
- };
147
- ```
148
-
149
- **Benefits:**
150
- - All queries in parallel
151
- - Single Suspense boundary
152
- - Type-safe results
153
-
154
- ---
155
-
156
- ## Query Keys Organization
157
-
158
- ### Naming Convention
159
-
160
- ```typescript
161
- // Entity list
162
- ['entities', blogId]
163
- ['entities', blogId, 'summary'] // With view mode
164
- ['entities', blogId, 'flat']
165
-
166
- // Single entity
167
- ['entity', blogId, entityId]
168
-
169
- // Related data
170
- ['entity', entityId, 'history']
171
- ['entity', entityId, 'comments']
172
-
173
- // User-specific
174
- ['user', userId, 'profile']
175
- ['user', userId, 'permissions']
176
- ```
177
-
178
- **Rules:**
179
- - Start with entity name (plural for lists, singular for one)
180
- - Include IDs for specificity
181
- - Add view mode / relationship at end
182
- - Consistent across app
183
-
184
- ### Query Key Examples
185
-
186
- ```typescript
187
- // From useSuspensePost.ts
188
- queryKey: ['post', blogId, postId]
189
- queryKey: ['posts-v2', blogId, 'summary']
190
-
191
- // Invalidation patterns
192
- queryClient.invalidateQueries({ queryKey: ['post', blogId] }); // All posts for form
193
- queryClient.invalidateQueries({ queryKey: ['post'] }); // All posts
194
- ```
195
-
196
- ---
197
-
198
- ## API Service Layer Pattern
199
-
200
- ### File Structure
201
-
202
- Create centralized API service per feature:
203
-
204
- ```
205
- features/
206
- my-feature/
207
- api/
208
- myFeatureApi.ts # Service layer
209
- ```
210
-
211
- ### Service Pattern (from postApi.ts)
212
-
213
- ```typescript
214
- /**
215
- * Centralized API service for my-feature operations
216
- * Uses apiClient for consistent error handling
217
- */
218
- import apiClient from '@/lib/apiClient';
219
- import type { MyEntity, UpdatePayload } from '../types';
220
-
221
- export const myFeatureApi = {
222
- /**
223
- * Fetch a single entity
224
- */
225
- getEntity: async (blogId: number, entityId: number): Promise<MyEntity> => {
226
- const { data } = await apiClient.get(
227
- `/blog/entities/${blogId}/${entityId}`
228
- );
229
- return data;
230
- },
231
-
232
- /**
233
- * Fetch all entities for a form
234
- */
235
- getEntities: async (blogId: number, view: 'summary' | 'flat'): Promise<MyEntity[]> => {
236
- const { data } = await apiClient.get(
237
- `/blog/entities/${blogId}`,
238
- { params: { view } }
239
- );
240
- return data.rows;
241
- },
242
-
243
- /**
244
- * Update entity
245
- */
246
- updateEntity: async (
247
- blogId: number,
248
- entityId: number,
249
- payload: UpdatePayload
250
- ): Promise<MyEntity> => {
251
- const { data } = await apiClient.put(
252
- `/blog/entities/${blogId}/${entityId}`,
253
- payload
254
- );
255
- return data;
256
- },
257
-
258
- /**
259
- * Delete entity
260
- */
261
- deleteEntity: async (blogId: number, entityId: number): Promise<void> => {
262
- await apiClient.delete(`/blog/entities/${blogId}/${entityId}`);
263
- },
264
- };
265
- ```
266
-
267
- **Key Points:**
268
- - Export single object with methods
269
- - Use `apiClient` (axios instance from `@/lib/apiClient`)
270
- - Type-safe parameters and returns
271
- - JSDoc comments for each method
272
- - Centralized error handling (apiClient handles it)
273
-
274
- ---
275
-
276
- ## Route Format Rules (IMPORTANT)
277
-
278
- ### Correct Format
279
-
280
- ```typescript
281
- // ✅ CORRECT - Direct service path
282
- await apiClient.get('/blog/posts/123');
283
- await apiClient.post('/projects/create', data);
284
- await apiClient.put('/users/update/456', updates);
285
- await apiClient.get('/email/templates');
286
-
287
- // ❌ WRONG - Do NOT add /api/ prefix
288
- await apiClient.get('/api/blog/posts/123'); // WRONG!
289
- await apiClient.post('/api/projects/create', data); // WRONG!
290
- ```
291
-
292
- **Microservice Routing:**
293
- - Form service: `/blog/*`
294
- - Projects service: `/projects/*`
295
- - Email service: `/email/*`
296
- - Users service: `/users/*`
297
-
298
- **Why:** API routing is handled by proxy configuration, no `/api/` prefix needed.
299
-
300
- ---
301
-
302
- ## Mutations
303
-
304
- ### Basic Mutation Pattern
305
-
306
- ```typescript
307
- import { useMutation, useQueryClient } from '@tanstack/react-query';
308
- import { myFeatureApi } from '../api/myFeatureApi';
309
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
310
-
311
- export const MyComponent: React.FC = () => {
312
- const queryClient = useQueryClient();
313
- const { showSuccess, showError } = useMuiSnackbar();
314
-
315
- const updateMutation = useMutation({
316
- mutationFn: (payload: UpdatePayload) =>
317
- myFeatureApi.updateEntity(blogId, entityId, payload),
318
-
319
- onSuccess: () => {
320
- // Invalidate and refetch
321
- queryClient.invalidateQueries({
322
- queryKey: ['entity', blogId, entityId]
323
- });
324
- showSuccess('Entity updated successfully');
325
- },
326
-
327
- onError: (error) => {
328
- showError('Failed to update entity');
329
- console.error('Update error:', error);
330
- },
331
- });
332
-
333
- const handleUpdate = () => {
334
- updateMutation.mutate({ name: 'New Name' });
335
- };
336
-
337
- return (
338
- <Button
339
- onClick={handleUpdate}
340
- disabled={updateMutation.isPending}
341
- >
342
- {updateMutation.isPending ? 'Updating...' : 'Update'}
343
- </Button>
344
- );
345
- };
346
- ```
347
-
348
- ### Optimistic Updates
349
-
350
- ```typescript
351
- const updateMutation = useMutation({
352
- mutationFn: (payload) => myFeatureApi.update(id, payload),
353
-
354
- // Optimistic update
355
- onMutate: async (newData) => {
356
- // Cancel outgoing refetches
357
- await queryClient.cancelQueries({ queryKey: ['entity', id] });
358
-
359
- // Snapshot current value
360
- const previousData = queryClient.getQueryData(['entity', id]);
361
-
362
- // Optimistically update
363
- queryClient.setQueryData(['entity', id], (old) => ({
364
- ...old,
365
- ...newData,
366
- }));
367
-
368
- // Return rollback function
369
- return { previousData };
370
- },
371
-
372
- // Rollback on error
373
- onError: (err, newData, context) => {
374
- queryClient.setQueryData(['entity', id], context.previousData);
375
- showError('Update failed');
376
- },
377
-
378
- // Refetch after success or error
379
- onSettled: () => {
380
- queryClient.invalidateQueries({ queryKey: ['entity', id] });
381
- },
382
- });
383
- ```
384
-
385
- ---
386
-
387
- ## Advanced Query Patterns
388
-
389
- ### Prefetching
390
-
391
- ```typescript
392
- export function usePrefetchEntity() {
393
- const queryClient = useQueryClient();
394
-
395
- return (blogId: number, entityId: number) => {
396
- return queryClient.prefetchQuery({
397
- queryKey: ['entity', blogId, entityId],
398
- queryFn: () => myFeatureApi.getEntity(blogId, entityId),
399
- staleTime: 5 * 60 * 1000,
400
- });
401
- };
402
- }
403
-
404
- // Usage: Prefetch on hover
405
- <div onMouseEnter={() => prefetch(blogId, id)}>
406
- <Link to={`/entity/${id}`}>View</Link>
407
- </div>
408
- ```
409
-
410
- ### Cache Access Without Fetching
411
-
412
- ```typescript
413
- export function useEntityFromCache(blogId: number, entityId: number) {
414
- const queryClient = useQueryClient();
415
-
416
- // Get from cache, don't fetch if missing
417
- const directCache = queryClient.getQueryData<MyEntity>(['entity', blogId, entityId]);
418
-
419
- if (directCache) return directCache;
420
-
421
- // Try grid cache
422
- const gridCache = queryClient.getQueryData<{ rows: MyEntity[] }>(['entities-v2', blogId]);
423
-
424
- return gridCache?.rows.find(row => row.id === entityId);
425
- }
426
- ```
427
-
428
- ### Dependent Queries
429
-
430
- ```typescript
431
- // Fetch user first, then user's settings
432
- const { data: user } = useSuspenseQuery({
433
- queryKey: ['user', userId],
434
- queryFn: () => userApi.getUser(userId),
435
- });
436
-
437
- const { data: settings } = useSuspenseQuery({
438
- queryKey: ['user', userId, 'settings'],
439
- queryFn: () => settingsApi.getUserSettings(user.id),
440
- // Automatically waits for user to load due to Suspense
441
- });
442
- ```
443
-
444
- ---
445
-
446
- ## API Client Configuration
447
-
448
- ### Using apiClient
449
-
450
- ```typescript
451
- import apiClient from '@/lib/apiClient';
452
-
453
- // apiClient is a configured axios instance
454
- // Automatically includes:
455
- // - Base URL configuration
456
- // - Cookie-based authentication
457
- // - Error interceptors
458
- // - Response transformers
459
- ```
460
-
461
- **Do NOT create new axios instances** - use apiClient for consistency.
462
-
463
- ---
464
-
465
- ## Error Handling in Queries
466
-
467
- ### onError Callback
468
-
469
- ```typescript
470
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
471
-
472
- const { showError } = useMuiSnackbar();
473
-
474
- const { data } = useSuspenseQuery({
475
- queryKey: ['entity', id],
476
- queryFn: () => myFeatureApi.getEntity(id),
477
-
478
- // Handle errors
479
- onError: (error) => {
480
- showError('Failed to load entity');
481
- console.error('Load error:', error);
482
- },
483
- });
484
- ```
485
-
486
- ### Error Boundaries
487
-
488
- Combine with Error Boundaries for comprehensive error handling:
489
-
490
- ```typescript
491
- import { ErrorBoundary } from 'react-error-boundary';
492
-
493
- <ErrorBoundary
494
- fallback={<ErrorDisplay />}
495
- onError={(error) => console.error(error)}
496
- >
497
- <SuspenseLoader>
498
- <ComponentWithSuspenseQuery />
499
- </SuspenseLoader>
500
- </ErrorBoundary>
501
- ```
502
-
503
- ---
504
-
505
- ## Complete Examples
506
-
507
- ### Example 1: Simple Entity Fetch
508
-
509
- ```typescript
510
- import React from 'react';
511
- import { useSuspenseQuery } from '@tanstack/react-query';
512
- import { Box, Typography } from '@mui/material';
513
- import { userApi } from '../api/userApi';
514
-
515
- interface UserProfileProps {
516
- userId: string;
517
- }
518
-
519
- export const UserProfile: React.FC<UserProfileProps> = ({ userId }) => {
520
- const { data: user } = useSuspenseQuery({
521
- queryKey: ['user', userId],
522
- queryFn: () => userApi.getUser(userId),
523
- staleTime: 5 * 60 * 1000,
524
- });
525
-
526
- return (
527
- <Box>
528
- <Typography variant='h5'>{user.name}</Typography>
529
- <Typography>{user.email}</Typography>
530
- </Box>
531
- );
532
- };
533
-
534
- // Usage with Suspense
535
- <SuspenseLoader>
536
- <UserProfile userId='123' />
537
- </SuspenseLoader>
538
- ```
539
-
540
- ### Example 2: Cache-First Strategy
541
-
542
- ```typescript
543
- import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
544
- import { postApi } from '../api/postApi';
545
- import type { Post } from '../types';
546
-
547
- /**
548
- * Hook with cache-first strategy
549
- * Checks grid cache before API call
550
- */
551
- export function useSuspensePost(blogId: number, postId: number) {
552
- const queryClient = useQueryClient();
553
-
554
- return useSuspenseQuery<Post, Error>({
555
- queryKey: ['post', blogId, postId],
556
- queryFn: async () => {
557
- // 1. Check grid cache first
558
- const gridCache = queryClient.getQueryData<{ rows: Post[] }>([
559
- 'posts-v2',
560
- blogId,
561
- 'summary'
562
- ]) || queryClient.getQueryData<{ rows: Post[] }>([
563
- 'posts-v2',
564
- blogId,
565
- 'flat'
566
- ]);
567
-
568
- if (gridCache?.rows) {
569
- const cached = gridCache.rows.find(row => row.S_ID === postId);
570
- if (cached) {
571
- return cached; // Reuse grid data
572
- }
573
- }
574
-
575
- // 2. Not in cache, fetch directly
576
- return postApi.getPost(blogId, postId);
577
- },
578
- staleTime: 5 * 60 * 1000,
579
- gcTime: 10 * 60 * 1000,
580
- refetchOnWindowFocus: false,
581
- });
582
- }
583
- ```
584
-
585
- **Benefits:**
586
- - Avoids duplicate API calls
587
- - Instant data if already loaded
588
- - Falls back to API if not cached
589
-
590
- ### Example 3: Parallel Fetching
591
-
592
- ```typescript
593
- import { useSuspenseQueries } from '@tanstack/react-query';
594
-
595
- export const Dashboard: React.FC = () => {
596
- const [statsQuery, projectsQuery, notificationsQuery] = useSuspenseQueries({
597
- queries: [
598
- {
599
- queryKey: ['stats'],
600
- queryFn: () => statsApi.getStats(),
601
- },
602
- {
603
- queryKey: ['projects', 'active'],
604
- queryFn: () => projectsApi.getActiveProjects(),
605
- },
606
- {
607
- queryKey: ['notifications', 'unread'],
608
- queryFn: () => notificationsApi.getUnread(),
609
- },
610
- ],
611
- });
612
-
613
- return (
614
- <Box>
615
- <StatsCard data={statsQuery.data} />
616
- <ProjectsList projects={projectsQuery.data} />
617
- <Notifications items={notificationsQuery.data} />
618
- </Box>
619
- );
620
- };
621
- ```
622
-
623
- ---
624
-
625
- ## Mutations with Cache Invalidation
626
-
627
- ### Update Mutation
628
-
629
- ```typescript
630
- import { useMutation, useQueryClient } from '@tanstack/react-query';
631
- import { postApi } from '../api/postApi';
632
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
633
-
634
- export const useUpdatePost = () => {
635
- const queryClient = useQueryClient();
636
- const { showSuccess, showError } = useMuiSnackbar();
637
-
638
- return useMutation({
639
- mutationFn: ({ blogId, postId, data }: UpdateParams) =>
640
- postApi.updatePost(blogId, postId, data),
641
-
642
- onSuccess: (data, variables) => {
643
- // Invalidate specific post
644
- queryClient.invalidateQueries({
645
- queryKey: ['post', variables.blogId, variables.postId]
646
- });
647
-
648
- // Invalidate list to refresh grid
649
- queryClient.invalidateQueries({
650
- queryKey: ['posts-v2', variables.blogId]
651
- });
652
-
653
- showSuccess('Post updated');
654
- },
655
-
656
- onError: (error) => {
657
- showError('Failed to update post');
658
- console.error('Update error:', error);
659
- },
660
- });
661
- };
662
-
663
- // Usage
664
- const updatePost = useUpdatePost();
665
-
666
- const handleSave = () => {
667
- updatePost.mutate({
668
- blogId: 123,
669
- postId: 456,
670
- data: { responses: { '101': 'value' } }
671
- });
672
- };
673
- ```
674
-
675
- ### Delete Mutation
676
-
677
- ```typescript
678
- export const useDeletePost = () => {
679
- const queryClient = useQueryClient();
680
- const { showSuccess, showError } = useMuiSnackbar();
681
-
682
- return useMutation({
683
- mutationFn: ({ blogId, postId }: DeleteParams) =>
684
- postApi.deletePost(blogId, postId),
685
-
686
- onSuccess: (data, variables) => {
687
- // Remove from cache manually (optimistic)
688
- queryClient.setQueryData<{ rows: Post[] }>(
689
- ['posts-v2', variables.blogId],
690
- (old) => ({
691
- ...old,
692
- rows: old?.rows.filter(row => row.S_ID !== variables.postId) || []
693
- })
694
- );
695
-
696
- showSuccess('Post deleted');
697
- },
698
-
699
- onError: (error, variables) => {
700
- // Rollback - refetch to get accurate state
701
- queryClient.invalidateQueries({
702
- queryKey: ['posts-v2', variables.blogId]
703
- });
704
- showError('Failed to delete post');
705
- },
706
- });
707
- };
708
- ```
709
-
710
- ---
711
-
712
- ## Query Configuration Best Practices
713
-
714
- ### Default Configuration
715
-
716
- ```typescript
717
- // In QueryClientProvider setup
718
- const queryClient = new QueryClient({
719
- defaultOptions: {
720
- queries: {
721
- staleTime: 1000 * 60 * 5, // 5 minutes
722
- gcTime: 1000 * 60 * 10, // 10 minutes (was cacheTime)
723
- refetchOnWindowFocus: false, // Don't refetch on focus
724
- refetchOnMount: false, // Don't refetch on mount if fresh
725
- retry: 1, // Retry failed queries once
726
- },
727
- },
728
- });
729
- ```
730
-
731
- ### Per-Query Overrides
732
-
733
- ```typescript
734
- // Frequently changing data - shorter staleTime
735
- useSuspenseQuery({
736
- queryKey: ['notifications', 'unread'],
737
- queryFn: () => notificationApi.getUnread(),
738
- staleTime: 30 * 1000, // 30 seconds
739
- });
740
-
741
- // Rarely changing data - longer staleTime
742
- useSuspenseQuery({
743
- queryKey: ['form', blogId, 'structure'],
744
- queryFn: () => formApi.getStructure(blogId),
745
- staleTime: 30 * 60 * 1000, // 30 minutes
746
- });
747
- ```
748
-
749
- ---
750
-
751
- ## Summary
752
-
753
- **Modern Data Fetching Recipe:**
754
-
755
- 1. **Create API Service**: `features/X/api/XApi.ts` using apiClient
756
- 2. **Use useSuspenseQuery**: In components wrapped by SuspenseLoader
757
- 3. **Cache-First**: Check grid cache before API call
758
- 4. **Query Keys**: Consistent naming ['entity', id]
759
- 5. **Route Format**: `/blog/route` NOT `/api/blog/route`
760
- 6. **Mutations**: invalidateQueries after success
761
- 7. **Error Handling**: onError + useMuiSnackbar
762
- 8. **Type Safety**: Type all parameters and returns
763
-
764
- **See Also:**
765
- - [component-patterns.md](component-patterns.md) - Suspense integration
766
- - [loading-and-error-states.md](loading-and-error-states.md) - SuspenseLoader usage
1
+ # Data Fetching Patterns
2
+
3
+ Modern data fetching using TanStack Query with Suspense boundaries, cache-first strategies, and centralized API services.
4
+
5
+ ---
6
+
7
+ ## PRIMARY PATTERN: useSuspenseQuery
8
+
9
+ ### Why useSuspenseQuery?
10
+
11
+ For **all new components**, use `useSuspenseQuery` instead of regular `useQuery`:
12
+
13
+ **Benefits:**
14
+ - No `isLoading` checks needed
15
+ - Integrates with Suspense boundaries
16
+ - Cleaner component code
17
+ - Consistent loading UX
18
+ - Better error handling with error boundaries
19
+
20
+ ### Basic Pattern
21
+
22
+ ```typescript
23
+ import { useSuspenseQuery } from '@tanstack/react-query';
24
+ import { myFeatureApi } from '../api/myFeatureApi';
25
+
26
+ export const MyComponent: React.FC<Props> = ({ id }) => {
27
+ // No isLoading - Suspense handles it!
28
+ const { data } = useSuspenseQuery({
29
+ queryKey: ['myEntity', id],
30
+ queryFn: () => myFeatureApi.getEntity(id),
31
+ });
32
+
33
+ // data is ALWAYS defined here (not undefined | Data)
34
+ return <div>{data.name}</div>;
35
+ };
36
+
37
+ // Wrap in Suspense boundary
38
+ <SuspenseLoader>
39
+ <MyComponent id={123} />
40
+ </SuspenseLoader>
41
+ ```
42
+
43
+ ### useSuspenseQuery vs useQuery
44
+
45
+ | Feature | useSuspenseQuery | useQuery |
46
+ |---------|------------------|----------|
47
+ | Loading state | Handled by Suspense | Manual `isLoading` check |
48
+ | Data type | Always defined | `Data \| undefined` |
49
+ | Use with | Suspense boundaries | Traditional components |
50
+ | Recommended for | **NEW components** | Legacy code only |
51
+ | Error handling | Error boundaries | Manual error state |
52
+
53
+ **When to use regular useQuery:**
54
+ - Maintaining legacy code
55
+ - Very simple cases without Suspense
56
+ - Polling with background updates
57
+
58
+ **For new components: Always prefer useSuspenseQuery**
59
+
60
+ ---
61
+
62
+ ## Cache-First Strategy
63
+
64
+ ### Cache-First Pattern Example
65
+
66
+ **Smart caching** reduces API calls by checking React Query cache first:
67
+
68
+ ```typescript
69
+ import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
70
+ import { postApi } from '../api/postApi';
71
+
72
+ export function useSuspensePost(postId: number) {
73
+ const queryClient = useQueryClient();
74
+
75
+ return useSuspenseQuery({
76
+ queryKey: ['post', postId],
77
+ queryFn: async () => {
78
+ // Strategy 1: Try to get from list cache first
79
+ const cachedListData = queryClient.getQueryData<{ posts: Post[] }>([
80
+ 'posts',
81
+ 'list'
82
+ ]);
83
+
84
+ if (cachedListData?.posts) {
85
+ const cachedPost = cachedListData.posts.find(
86
+ (post) => post.id === postId
87
+ );
88
+
89
+ if (cachedPost) {
90
+ return cachedPost; // Return from cache!
91
+ }
92
+ }
93
+
94
+ // Strategy 2: Not in cache, fetch from API
95
+ return postApi.getPost(postId);
96
+ },
97
+ staleTime: 5 * 60 * 1000, // Consider fresh for 5 minutes
98
+ gcTime: 10 * 60 * 1000, // Keep in cache for 10 minutes
99
+ refetchOnWindowFocus: false, // Don't refetch on focus
100
+ });
101
+ }
102
+ ```
103
+
104
+ **Key Points:**
105
+ - Check grid/list cache before API call
106
+ - Avoids redundant requests
107
+ - `staleTime`: How long data is considered fresh
108
+ - `gcTime`: How long unused data stays in cache
109
+ - `refetchOnWindowFocus: false`: User preference
110
+
111
+ ---
112
+
113
+ ## Parallel Data Fetching
114
+
115
+ ### useSuspenseQueries
116
+
117
+ When fetching multiple independent resources:
118
+
119
+ ```typescript
120
+ import { useSuspenseQueries } from '@tanstack/react-query';
121
+
122
+ export const MyComponent: React.FC = () => {
123
+ const [userQuery, settingsQuery, preferencesQuery] = useSuspenseQueries({
124
+ queries: [
125
+ {
126
+ queryKey: ['user'],
127
+ queryFn: () => userApi.getCurrentUser(),
128
+ },
129
+ {
130
+ queryKey: ['settings'],
131
+ queryFn: () => settingsApi.getSettings(),
132
+ },
133
+ {
134
+ queryKey: ['preferences'],
135
+ queryFn: () => preferencesApi.getPreferences(),
136
+ },
137
+ ],
138
+ });
139
+
140
+ // All data available, Suspense handles loading
141
+ const user = userQuery.data;
142
+ const settings = settingsQuery.data;
143
+ const preferences = preferencesQuery.data;
144
+
145
+ return <Display user={user} settings={settings} prefs={preferences} />;
146
+ };
147
+ ```
148
+
149
+ **Benefits:**
150
+ - All queries in parallel
151
+ - Single Suspense boundary
152
+ - Type-safe results
153
+
154
+ ---
155
+
156
+ ## Query Keys Organization
157
+
158
+ ### Naming Convention
159
+
160
+ ```typescript
161
+ // Entity list
162
+ ['entities', blogId]
163
+ ['entities', blogId, 'summary'] // With view mode
164
+ ['entities', blogId, 'flat']
165
+
166
+ // Single entity
167
+ ['entity', blogId, entityId]
168
+
169
+ // Related data
170
+ ['entity', entityId, 'history']
171
+ ['entity', entityId, 'comments']
172
+
173
+ // User-specific
174
+ ['user', userId, 'profile']
175
+ ['user', userId, 'permissions']
176
+ ```
177
+
178
+ **Rules:**
179
+ - Start with entity name (plural for lists, singular for one)
180
+ - Include IDs for specificity
181
+ - Add view mode / relationship at end
182
+ - Consistent across app
183
+
184
+ ### Query Key Examples
185
+
186
+ ```typescript
187
+ // From useSuspensePost.ts
188
+ queryKey: ['post', blogId, postId]
189
+ queryKey: ['posts-v2', blogId, 'summary']
190
+
191
+ // Invalidation patterns
192
+ queryClient.invalidateQueries({ queryKey: ['post', blogId] }); // All posts for form
193
+ queryClient.invalidateQueries({ queryKey: ['post'] }); // All posts
194
+ ```
195
+
196
+ ---
197
+
198
+ ## API Service Layer Pattern
199
+
200
+ ### File Structure
201
+
202
+ Create centralized API service per feature:
203
+
204
+ ```
205
+ features/
206
+ my-feature/
207
+ api/
208
+ myFeatureApi.ts # Service layer
209
+ ```
210
+
211
+ ### Service Pattern (from postApi.ts)
212
+
213
+ ```typescript
214
+ /**
215
+ * Centralized API service for my-feature operations
216
+ * Uses apiClient for consistent error handling
217
+ */
218
+ import apiClient from '@/lib/apiClient';
219
+ import type { MyEntity, UpdatePayload } from '../types';
220
+
221
+ export const myFeatureApi = {
222
+ /**
223
+ * Fetch a single entity
224
+ */
225
+ getEntity: async (blogId: number, entityId: number): Promise<MyEntity> => {
226
+ const { data } = await apiClient.get(
227
+ `/blog/entities/${blogId}/${entityId}`
228
+ );
229
+ return data;
230
+ },
231
+
232
+ /**
233
+ * Fetch all entities for a form
234
+ */
235
+ getEntities: async (blogId: number, view: 'summary' | 'flat'): Promise<MyEntity[]> => {
236
+ const { data } = await apiClient.get(
237
+ `/blog/entities/${blogId}`,
238
+ { params: { view } }
239
+ );
240
+ return data.rows;
241
+ },
242
+
243
+ /**
244
+ * Update entity
245
+ */
246
+ updateEntity: async (
247
+ blogId: number,
248
+ entityId: number,
249
+ payload: UpdatePayload
250
+ ): Promise<MyEntity> => {
251
+ const { data } = await apiClient.put(
252
+ `/blog/entities/${blogId}/${entityId}`,
253
+ payload
254
+ );
255
+ return data;
256
+ },
257
+
258
+ /**
259
+ * Delete entity
260
+ */
261
+ deleteEntity: async (blogId: number, entityId: number): Promise<void> => {
262
+ await apiClient.delete(`/blog/entities/${blogId}/${entityId}`);
263
+ },
264
+ };
265
+ ```
266
+
267
+ **Key Points:**
268
+ - Export single object with methods
269
+ - Use `apiClient` (axios instance from `@/lib/apiClient`)
270
+ - Type-safe parameters and returns
271
+ - JSDoc comments for each method
272
+ - Centralized error handling (apiClient handles it)
273
+
274
+ ---
275
+
276
+ ## Route Format Rules (IMPORTANT)
277
+
278
+ ### Correct Format
279
+
280
+ ```typescript
281
+ // ✅ CORRECT - Direct service path
282
+ await apiClient.get('/blog/posts/123');
283
+ await apiClient.post('/projects/create', data);
284
+ await apiClient.put('/users/update/456', updates);
285
+ await apiClient.get('/email/templates');
286
+
287
+ // ❌ WRONG - Do NOT add /api/ prefix
288
+ await apiClient.get('/api/blog/posts/123'); // WRONG!
289
+ await apiClient.post('/api/projects/create', data); // WRONG!
290
+ ```
291
+
292
+ **Microservice Routing:**
293
+ - Form service: `/blog/*`
294
+ - Projects service: `/projects/*`
295
+ - Email service: `/email/*`
296
+ - Users service: `/users/*`
297
+
298
+ **Why:** API routing is handled by proxy configuration, no `/api/` prefix needed.
299
+
300
+ ---
301
+
302
+ ## Mutations
303
+
304
+ ### Basic Mutation Pattern
305
+
306
+ ```typescript
307
+ import { useMutation, useQueryClient } from '@tanstack/react-query';
308
+ import { myFeatureApi } from '../api/myFeatureApi';
309
+ import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
310
+
311
+ export const MyComponent: React.FC = () => {
312
+ const queryClient = useQueryClient();
313
+ const { showSuccess, showError } = useMuiSnackbar();
314
+
315
+ const updateMutation = useMutation({
316
+ mutationFn: (payload: UpdatePayload) =>
317
+ myFeatureApi.updateEntity(blogId, entityId, payload),
318
+
319
+ onSuccess: () => {
320
+ // Invalidate and refetch
321
+ queryClient.invalidateQueries({
322
+ queryKey: ['entity', blogId, entityId]
323
+ });
324
+ showSuccess('Entity updated successfully');
325
+ },
326
+
327
+ onError: (error) => {
328
+ showError('Failed to update entity');
329
+ console.error('Update error:', error);
330
+ },
331
+ });
332
+
333
+ const handleUpdate = () => {
334
+ updateMutation.mutate({ name: 'New Name' });
335
+ };
336
+
337
+ return (
338
+ <Button
339
+ onClick={handleUpdate}
340
+ disabled={updateMutation.isPending}
341
+ >
342
+ {updateMutation.isPending ? 'Updating...' : 'Update'}
343
+ </Button>
344
+ );
345
+ };
346
+ ```
347
+
348
+ ### Optimistic Updates
349
+
350
+ ```typescript
351
+ const updateMutation = useMutation({
352
+ mutationFn: (payload) => myFeatureApi.update(id, payload),
353
+
354
+ // Optimistic update
355
+ onMutate: async (newData) => {
356
+ // Cancel outgoing refetches
357
+ await queryClient.cancelQueries({ queryKey: ['entity', id] });
358
+
359
+ // Snapshot current value
360
+ const previousData = queryClient.getQueryData(['entity', id]);
361
+
362
+ // Optimistically update
363
+ queryClient.setQueryData(['entity', id], (old) => ({
364
+ ...old,
365
+ ...newData,
366
+ }));
367
+
368
+ // Return rollback function
369
+ return { previousData };
370
+ },
371
+
372
+ // Rollback on error
373
+ onError: (err, newData, context) => {
374
+ queryClient.setQueryData(['entity', id], context.previousData);
375
+ showError('Update failed');
376
+ },
377
+
378
+ // Refetch after success or error
379
+ onSettled: () => {
380
+ queryClient.invalidateQueries({ queryKey: ['entity', id] });
381
+ },
382
+ });
383
+ ```
384
+
385
+ ---
386
+
387
+ ## Advanced Query Patterns
388
+
389
+ ### Prefetching
390
+
391
+ ```typescript
392
+ export function usePrefetchEntity() {
393
+ const queryClient = useQueryClient();
394
+
395
+ return (blogId: number, entityId: number) => {
396
+ return queryClient.prefetchQuery({
397
+ queryKey: ['entity', blogId, entityId],
398
+ queryFn: () => myFeatureApi.getEntity(blogId, entityId),
399
+ staleTime: 5 * 60 * 1000,
400
+ });
401
+ };
402
+ }
403
+
404
+ // Usage: Prefetch on hover
405
+ <div onMouseEnter={() => prefetch(blogId, id)}>
406
+ <Link to={`/entity/${id}`}>View</Link>
407
+ </div>
408
+ ```
409
+
410
+ ### Cache Access Without Fetching
411
+
412
+ ```typescript
413
+ export function useEntityFromCache(blogId: number, entityId: number) {
414
+ const queryClient = useQueryClient();
415
+
416
+ // Get from cache, don't fetch if missing
417
+ const directCache = queryClient.getQueryData<MyEntity>(['entity', blogId, entityId]);
418
+
419
+ if (directCache) return directCache;
420
+
421
+ // Try grid cache
422
+ const gridCache = queryClient.getQueryData<{ rows: MyEntity[] }>(['entities-v2', blogId]);
423
+
424
+ return gridCache?.rows.find(row => row.id === entityId);
425
+ }
426
+ ```
427
+
428
+ ### Dependent Queries
429
+
430
+ ```typescript
431
+ // Fetch user first, then user's settings
432
+ const { data: user } = useSuspenseQuery({
433
+ queryKey: ['user', userId],
434
+ queryFn: () => userApi.getUser(userId),
435
+ });
436
+
437
+ const { data: settings } = useSuspenseQuery({
438
+ queryKey: ['user', userId, 'settings'],
439
+ queryFn: () => settingsApi.getUserSettings(user.id),
440
+ // Automatically waits for user to load due to Suspense
441
+ });
442
+ ```
443
+
444
+ ---
445
+
446
+ ## API Client Configuration
447
+
448
+ ### Using apiClient
449
+
450
+ ```typescript
451
+ import apiClient from '@/lib/apiClient';
452
+
453
+ // apiClient is a configured axios instance
454
+ // Automatically includes:
455
+ // - Base URL configuration
456
+ // - Cookie-based authentication
457
+ // - Error interceptors
458
+ // - Response transformers
459
+ ```
460
+
461
+ **Do NOT create new axios instances** - use apiClient for consistency.
462
+
463
+ ---
464
+
465
+ ## Error Handling in Queries
466
+
467
+ ### onError Callback
468
+
469
+ ```typescript
470
+ import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
471
+
472
+ const { showError } = useMuiSnackbar();
473
+
474
+ const { data } = useSuspenseQuery({
475
+ queryKey: ['entity', id],
476
+ queryFn: () => myFeatureApi.getEntity(id),
477
+
478
+ // Handle errors
479
+ onError: (error) => {
480
+ showError('Failed to load entity');
481
+ console.error('Load error:', error);
482
+ },
483
+ });
484
+ ```
485
+
486
+ ### Error Boundaries
487
+
488
+ Combine with Error Boundaries for comprehensive error handling:
489
+
490
+ ```typescript
491
+ import { ErrorBoundary } from 'react-error-boundary';
492
+
493
+ <ErrorBoundary
494
+ fallback={<ErrorDisplay />}
495
+ onError={(error) => console.error(error)}
496
+ >
497
+ <SuspenseLoader>
498
+ <ComponentWithSuspenseQuery />
499
+ </SuspenseLoader>
500
+ </ErrorBoundary>
501
+ ```
502
+
503
+ ---
504
+
505
+ ## Complete Examples
506
+
507
+ ### Example 1: Simple Entity Fetch
508
+
509
+ ```typescript
510
+ import React from 'react';
511
+ import { useSuspenseQuery } from '@tanstack/react-query';
512
+ import { Box, Typography } from '@mui/material';
513
+ import { userApi } from '../api/userApi';
514
+
515
+ interface UserProfileProps {
516
+ userId: string;
517
+ }
518
+
519
+ export const UserProfile: React.FC<UserProfileProps> = ({ userId }) => {
520
+ const { data: user } = useSuspenseQuery({
521
+ queryKey: ['user', userId],
522
+ queryFn: () => userApi.getUser(userId),
523
+ staleTime: 5 * 60 * 1000,
524
+ });
525
+
526
+ return (
527
+ <Box>
528
+ <Typography variant='h5'>{user.name}</Typography>
529
+ <Typography>{user.email}</Typography>
530
+ </Box>
531
+ );
532
+ };
533
+
534
+ // Usage with Suspense
535
+ <SuspenseLoader>
536
+ <UserProfile userId='123' />
537
+ </SuspenseLoader>
538
+ ```
539
+
540
+ ### Example 2: Cache-First Strategy
541
+
542
+ ```typescript
543
+ import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
544
+ import { postApi } from '../api/postApi';
545
+ import type { Post } from '../types';
546
+
547
+ /**
548
+ * Hook with cache-first strategy
549
+ * Checks grid cache before API call
550
+ */
551
+ export function useSuspensePost(blogId: number, postId: number) {
552
+ const queryClient = useQueryClient();
553
+
554
+ return useSuspenseQuery<Post, Error>({
555
+ queryKey: ['post', blogId, postId],
556
+ queryFn: async () => {
557
+ // 1. Check grid cache first
558
+ const gridCache = queryClient.getQueryData<{ rows: Post[] }>([
559
+ 'posts-v2',
560
+ blogId,
561
+ 'summary'
562
+ ]) || queryClient.getQueryData<{ rows: Post[] }>([
563
+ 'posts-v2',
564
+ blogId,
565
+ 'flat'
566
+ ]);
567
+
568
+ if (gridCache?.rows) {
569
+ const cached = gridCache.rows.find(row => row.S_ID === postId);
570
+ if (cached) {
571
+ return cached; // Reuse grid data
572
+ }
573
+ }
574
+
575
+ // 2. Not in cache, fetch directly
576
+ return postApi.getPost(blogId, postId);
577
+ },
578
+ staleTime: 5 * 60 * 1000,
579
+ gcTime: 10 * 60 * 1000,
580
+ refetchOnWindowFocus: false,
581
+ });
582
+ }
583
+ ```
584
+
585
+ **Benefits:**
586
+ - Avoids duplicate API calls
587
+ - Instant data if already loaded
588
+ - Falls back to API if not cached
589
+
590
+ ### Example 3: Parallel Fetching
591
+
592
+ ```typescript
593
+ import { useSuspenseQueries } from '@tanstack/react-query';
594
+
595
+ export const Dashboard: React.FC = () => {
596
+ const [statsQuery, projectsQuery, notificationsQuery] = useSuspenseQueries({
597
+ queries: [
598
+ {
599
+ queryKey: ['stats'],
600
+ queryFn: () => statsApi.getStats(),
601
+ },
602
+ {
603
+ queryKey: ['projects', 'active'],
604
+ queryFn: () => projectsApi.getActiveProjects(),
605
+ },
606
+ {
607
+ queryKey: ['notifications', 'unread'],
608
+ queryFn: () => notificationsApi.getUnread(),
609
+ },
610
+ ],
611
+ });
612
+
613
+ return (
614
+ <Box>
615
+ <StatsCard data={statsQuery.data} />
616
+ <ProjectsList projects={projectsQuery.data} />
617
+ <Notifications items={notificationsQuery.data} />
618
+ </Box>
619
+ );
620
+ };
621
+ ```
622
+
623
+ ---
624
+
625
+ ## Mutations with Cache Invalidation
626
+
627
+ ### Update Mutation
628
+
629
+ ```typescript
630
+ import { useMutation, useQueryClient } from '@tanstack/react-query';
631
+ import { postApi } from '../api/postApi';
632
+ import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
633
+
634
+ export const useUpdatePost = () => {
635
+ const queryClient = useQueryClient();
636
+ const { showSuccess, showError } = useMuiSnackbar();
637
+
638
+ return useMutation({
639
+ mutationFn: ({ blogId, postId, data }: UpdateParams) =>
640
+ postApi.updatePost(blogId, postId, data),
641
+
642
+ onSuccess: (data, variables) => {
643
+ // Invalidate specific post
644
+ queryClient.invalidateQueries({
645
+ queryKey: ['post', variables.blogId, variables.postId]
646
+ });
647
+
648
+ // Invalidate list to refresh grid
649
+ queryClient.invalidateQueries({
650
+ queryKey: ['posts-v2', variables.blogId]
651
+ });
652
+
653
+ showSuccess('Post updated');
654
+ },
655
+
656
+ onError: (error) => {
657
+ showError('Failed to update post');
658
+ console.error('Update error:', error);
659
+ },
660
+ });
661
+ };
662
+
663
+ // Usage
664
+ const updatePost = useUpdatePost();
665
+
666
+ const handleSave = () => {
667
+ updatePost.mutate({
668
+ blogId: 123,
669
+ postId: 456,
670
+ data: { responses: { '101': 'value' } }
671
+ });
672
+ };
673
+ ```
674
+
675
+ ### Delete Mutation
676
+
677
+ ```typescript
678
+ export const useDeletePost = () => {
679
+ const queryClient = useQueryClient();
680
+ const { showSuccess, showError } = useMuiSnackbar();
681
+
682
+ return useMutation({
683
+ mutationFn: ({ blogId, postId }: DeleteParams) =>
684
+ postApi.deletePost(blogId, postId),
685
+
686
+ onSuccess: (data, variables) => {
687
+ // Remove from cache manually (optimistic)
688
+ queryClient.setQueryData<{ rows: Post[] }>(
689
+ ['posts-v2', variables.blogId],
690
+ (old) => ({
691
+ ...old,
692
+ rows: old?.rows.filter(row => row.S_ID !== variables.postId) || []
693
+ })
694
+ );
695
+
696
+ showSuccess('Post deleted');
697
+ },
698
+
699
+ onError: (error, variables) => {
700
+ // Rollback - refetch to get accurate state
701
+ queryClient.invalidateQueries({
702
+ queryKey: ['posts-v2', variables.blogId]
703
+ });
704
+ showError('Failed to delete post');
705
+ },
706
+ });
707
+ };
708
+ ```
709
+
710
+ ---
711
+
712
+ ## Query Configuration Best Practices
713
+
714
+ ### Default Configuration
715
+
716
+ ```typescript
717
+ // In QueryClientProvider setup
718
+ const queryClient = new QueryClient({
719
+ defaultOptions: {
720
+ queries: {
721
+ staleTime: 1000 * 60 * 5, // 5 minutes
722
+ gcTime: 1000 * 60 * 10, // 10 minutes (was cacheTime)
723
+ refetchOnWindowFocus: false, // Don't refetch on focus
724
+ refetchOnMount: false, // Don't refetch on mount if fresh
725
+ retry: 1, // Retry failed queries once
726
+ },
727
+ },
728
+ });
729
+ ```
730
+
731
+ ### Per-Query Overrides
732
+
733
+ ```typescript
734
+ // Frequently changing data - shorter staleTime
735
+ useSuspenseQuery({
736
+ queryKey: ['notifications', 'unread'],
737
+ queryFn: () => notificationApi.getUnread(),
738
+ staleTime: 30 * 1000, // 30 seconds
739
+ });
740
+
741
+ // Rarely changing data - longer staleTime
742
+ useSuspenseQuery({
743
+ queryKey: ['form', blogId, 'structure'],
744
+ queryFn: () => formApi.getStructure(blogId),
745
+ staleTime: 30 * 60 * 1000, // 30 minutes
746
+ });
747
+ ```
748
+
749
+ ---
750
+
751
+ ## Summary
752
+
753
+ **Modern Data Fetching Recipe:**
754
+
755
+ 1. **Create API Service**: `features/X/api/XApi.ts` using apiClient
756
+ 2. **Use useSuspenseQuery**: In components wrapped by SuspenseLoader
757
+ 3. **Cache-First**: Check grid cache before API call
758
+ 4. **Query Keys**: Consistent naming ['entity', id]
759
+ 5. **Route Format**: `/blog/route` NOT `/api/blog/route`
760
+ 6. **Mutations**: invalidateQueries after success
761
+ 7. **Error Handling**: onError + useMuiSnackbar
762
+ 8. **Type Safety**: Type all parameters and returns
763
+
764
+ **See Also:**
765
+ - [component-patterns.md](component-patterns.md) - Suspense integration
766
+ - [loading-and-error-states.md](loading-and-error-states.md) - SuspenseLoader usage
767
767
  - [complete-examples.md](complete-examples.md) - Full working examples