@fprad0/skill-master-mcp 0.0.12 → 1.0.1

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 (353) hide show
  1. package/CHANGELOG.md +100 -88
  2. package/README.md +472 -472
  3. package/VERSION.md +9 -9
  4. package/bin/lib/bootstrap-global-core.mjs +34 -0
  5. package/bin/lib/client-config.mjs +287 -285
  6. package/bin/lib/doctor-core.mjs +202 -0
  7. package/bin/lib/menu-core.mjs +1792 -1514
  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 -215
  11. package/bin/lib/update-cli-core.mjs +117 -0
  12. package/bin/skill-master-activation.mjs +165 -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 -228
  16. package/bin/skill-master-eval-activation.mjs +32 -32
  17. package/bin/skill-master-install-global-skills.mjs +59 -59
  18. package/bin/skill-master-install-project-skills.mjs +97 -97
  19. package/bin/skill-master-menu.mjs +489 -378
  20. package/bin/skill-master-register-clients.mjs +232 -153
  21. package/bin/skill-master-success-skills.mjs +357 -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 -262
  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 -66
  41. package/docs/operations/assets/menu-frame-compact.html +36 -33
  42. package/docs/operations/assets/menu-frame-dna-hero.html +87 -0
  43. package/docs/operations/assets/menu-frame-fine-helix.html +89 -0
  44. package/docs/operations/assets/menu-frame-large.html +44 -41
  45. package/docs/operations/assets/menu-frame-running.html +41 -38
  46. package/docs/operations/assets/menu-frame-score-10-contact-sheet.html +184 -0
  47. package/docs/operations/cross-platform-auth-transfer/ANALISE_COMPATIBILIDADE_MCP_2026-06-28.md +140 -140
  48. package/docs/operations/cross-platform-auth-transfer/README_TRANSFERENCIA.md +85 -85
  49. package/docs/operations/reborn-menu-cyberpunk-transfer/ANALISE_MENU_REBORN_CYBERPUNK_2026-06-28.md +174 -174
  50. package/docs/operations/reborn-menu-cyberpunk-transfer/HANDOFF_IMPLEMENTACAO_REBORN_CYBERPUNK_2026-06-28.md +119 -119
  51. package/docs/operations/reborn-menu-cyberpunk-transfer/ORDEM_DE_EXECUCAO_MENU_REBORN_CYBERPUNK.md +134 -134
  52. package/docs/operations/reborn-menu-cyberpunk-transfer/README_TRANSFERENCIA.md +84 -84
  53. package/docs/operations/reborn-menu-cyberpunk-transfer/README_TRANSFERENCIA_REBORN_PACKAGE.md +56 -56
  54. package/docs/operations/token-economy-transfer/ANALISE_AVANCADA_ECONOMIA_TOKENS_2026-06-30.md +141 -0
  55. package/docs/operations/token-economy-transfer/PLANO_DEV_SENIOR_MASTER_TOKEN_ECONOMY_2026-06-30.md +171 -0
  56. package/docs/operations/token-economy-transfer/README_TRANSFERENCIA_TOKEN_ECONOMY.md +31 -0
  57. package/docs/planning/MENU_RUNTIME_CORRECTION_PLAN_2026-06-30.md +551 -0
  58. package/docs/planning/V0_0_9_APROVACAO_CRITICA_MENSAGENS_DE_VENDA.md +85 -85
  59. package/docs/planning/V0_0_9_FONTES_E_CRITERIOS_DE_AUTORIDADE.md +139 -139
  60. package/docs/planning/V0_0_9_MATRIZ_SKILLS_MULTIDISCIPLINARES.md +105 -105
  61. package/docs/planning/V0_0_9_POLITICA_MORAL_CATOLICA_PARA_IA.md +181 -181
  62. package/docs/planning/V0_0_9_PROMPTS_EXECUCAO.md +59 -59
  63. package/docs/planning/V0_0_9_ROADMAP_DISCERNIMENTO_E_CONHECIMENTO_AMPLO.md +181 -181
  64. package/docs/planning/mcp-1.0.0/00_RESUMO_EXECUTIVO_AUDITORIA_MENU.md +118 -0
  65. package/docs/planning/mcp-1.0.0/01_MATRIZ_TESTES_MENU_E_RESULTADOS.md +250 -0
  66. package/docs/planning/mcp-1.0.0/02_PLANO_CORRECAO_ATIVAR_SKILL_APRENDIDA.md +200 -0
  67. package/docs/planning/mcp-1.0.0/03_PLANO_COMPATIBILIDADE_WINDOWS_LINUX_MACOS.md +167 -0
  68. package/docs/planning/mcp-1.0.0/04_PLANO_UI_CYBERPUNK_PIXEL_ART_E_PERFORMANCE.md +165 -0
  69. package/docs/planning/mcp-1.0.0/05_PROMPT_TASK_EXECUCAO_CORRECOES.md +151 -0
  70. package/docs/planning/mcp-1.0.0/06_CHECKLIST_REGRESSAO_PRE_RELEASE.md +159 -0
  71. package/docs/planning/mcp-1.0.0/07_RELATORIO_APLICACAO_CORRECOES_MENU_SKILL_MASTER.md +136 -0
  72. package/docs/planning/mcp-1.0.0/08_AUDITORIA_CRITICA_MENU_NOTA_E_DNA_REFINADO.md +184 -0
  73. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/00_PROMPT_TASK_MASTER_NOTA_10_10.md +103 -0
  74. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/01_PROMPT_TASK_FINE_HELIX_DNA.md +116 -0
  75. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/02_PROMPT_TASK_DNA_HERO_BOOT_AND_MOTION.md +109 -0
  76. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/03_PROMPT_TASK_MENU_UX_HELP_ERROR_COPY.md +99 -0
  77. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/04_PROMPT_TASK_EVIDENCE_RENDERER_1_0_0.md +97 -0
  78. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/05_PROMPT_TASK_CROSS_PLATFORM_UTF8_MOJIBAKE.md +99 -0
  79. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/06_PROMPT_TASK_VISUAL_REGRESSION_QA.md +105 -0
  80. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/07_PROMPT_TASK_PRE_RELEASE_SCORE_GATE_10_10.md +104 -0
  81. package/docs/planning/mcp-1.0.0/prompt-tasks-nota-10-10/README_ORDEM_EXECUCAO_NOTA_10_10.md +77 -0
  82. package/docs/prompt-tasks/PROMPT_TASK_001_BOOTSTRAP_SKILL_MASTER_MCP.md +6 -6
  83. package/docs/prompt-tasks/PROMPT_TASK_002_AUTO_UPDATE_LAUNCHER.md +6 -6
  84. package/docs/prompt-tasks/PROMPT_TASK_003_REMOTE_MANIFEST_AND_RELEASES.md +6 -6
  85. package/docs/prompt-tasks/PROMPT_TASK_004_MULTI_USER_DISTRIBUTION.md +6 -6
  86. package/docs/prompt-tasks/PROMPT_TASK_005_SECURITY_AND_QUALITY_GATE.md +6 -6
  87. package/docs/prompt-tasks/PROMPT_TASK_006_MASTER_ACIONAMENTO_APRENDIZADO.md +83 -83
  88. package/docs/prompt-tasks/PROMPT_TASK_007_PERSONA_ORQUESTRADORA.md +88 -88
  89. package/docs/prompt-tasks/PROMPT_TASK_008_PROMPT_ROUTER_MODOS_ATIVACAO.md +156 -156
  90. package/docs/prompt-tasks/PROMPT_TASK_009_PIPELINE_APRENDIZADO_SUCESSO.md +105 -105
  91. package/docs/prompt-tasks/PROMPT_TASK_010_EVALS_GOVERNANCA_ATIVACAO.md +119 -119
  92. package/docs/prompt-tasks/PROMPT_TASK_011_MENU_NOTIFICACOES_NOTION.md +120 -120
  93. package/docs/prompt-tasks/PROMPT_TASK_012_MENU_CYBERPUNK_PIXEL_FRAME.md +123 -123
  94. package/docs/prompt-tasks/PROMPT_TASK_013_MENU_FLUID_DNA_ANIMATION.md +114 -114
  95. package/docs/prompt-tasks/PROMPT_TASK_014_MENU_FUNCTIONAL_PARITY_QA.md +157 -157
  96. package/docs/prompt-tasks/PROMPT_TASK_015_TRANSFER_RELEASE_HANDOFF.md +127 -127
  97. package/docs/prompt-tasks/PROMPT_TASK_016_CROSS_PLATFORM_MCP_AUTH_REGISTRATION.md +107 -107
  98. package/docs/prompt-tasks/PROMPT_TASK_018_NPM_PUBLISH_2FA_SETUP.md +80 -80
  99. package/docs/prompt-tasks/PROMPT_TASK_019_TOKEN_ECONOMY_GLOBAL_SKILLS.md +56 -0
  100. package/docs/prompt-tasks/PROMPT_TASK_MASTER_EXECUTOR.md +6 -6
  101. package/docs/skill-candidates/v0.0.10/cli-creator/LICENSE.txt +201 -201
  102. package/docs/skill-candidates/v0.0.10/cli-creator/SKILL.md +160 -160
  103. package/docs/skill-candidates/v0.0.10/cli-creator/agents/openai.yaml +4 -4
  104. package/docs/skill-candidates/v0.0.10/cli-creator/references/agent-cli-patterns.md +154 -154
  105. package/docs/skill-candidates/v0.0.10/developer-workstation-ops/SKILL.md +32 -32
  106. package/docs/skill-candidates/v0.0.10/figma/LICENSE.txt +1 -1
  107. package/docs/skill-candidates/v0.0.10/figma/SKILL.md +42 -42
  108. package/docs/skill-candidates/v0.0.10/figma/agents/openai.yaml +14 -14
  109. package/docs/skill-candidates/v0.0.10/figma/assets/figma-small.svg +3 -3
  110. package/docs/skill-candidates/v0.0.10/figma/assets/icon.svg +28 -28
  111. package/docs/skill-candidates/v0.0.10/figma/references/figma-mcp-config.md +35 -35
  112. package/docs/skill-candidates/v0.0.10/figma/references/figma-tools-and-prompts.md +34 -34
  113. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/LICENSE.TXT +1 -1
  114. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/SKILL.md +349 -349
  115. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/agents/openai.yaml +14 -14
  116. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/assets/figma-small.svg +3 -3
  117. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/assets/icon.svg +28 -28
  118. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/references/mapping-checklist.md +7 -7
  119. package/docs/skill-candidates/v0.0.10/figma-code-connect-components/scripts/normalize_node_id.py +25 -25
  120. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/LICENSE.TXT +1 -1
  121. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/SKILL.md +537 -537
  122. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/agents/openai.yaml +14 -14
  123. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/assets/figma-small.svg +3 -3
  124. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/assets/icon.svg +28 -28
  125. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/references/rule-template.md +15 -15
  126. package/docs/skill-candidates/v0.0.10/figma-create-design-system-rules/scripts/check_agents_md.sh +9 -9
  127. package/docs/skill-candidates/v0.0.10/figma-generate-design/LICENSE.TXT +1 -1
  128. package/docs/skill-candidates/v0.0.10/figma-generate-design/SKILL.md +341 -341
  129. package/docs/skill-candidates/v0.0.10/figma-generate-design/agents/openai.yaml +14 -14
  130. package/docs/skill-candidates/v0.0.10/figma-generate-design/assets/figma-small.svg +3 -3
  131. package/docs/skill-candidates/v0.0.10/figma-generate-design/assets/icon.svg +28 -28
  132. package/docs/skill-candidates/v0.0.10/figma-generate-design/maintainers.yml +1 -1
  133. package/docs/skill-candidates/v0.0.10/figma-generate-library/LICENSE.TXT +1 -1
  134. package/docs/skill-candidates/v0.0.10/figma-generate-library/SKILL.md +314 -314
  135. package/docs/skill-candidates/v0.0.10/figma-generate-library/agents/openai.yaml +14 -14
  136. package/docs/skill-candidates/v0.0.10/figma-generate-library/assets/figma-small.svg +3 -3
  137. package/docs/skill-candidates/v0.0.10/figma-generate-library/assets/icon.svg +28 -28
  138. package/docs/skill-candidates/v0.0.10/figma-generate-library/maintainers.yml +3 -3
  139. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/code-connect-setup.md +260 -260
  140. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/component-creation.md +1014 -1014
  141. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/discovery-phase.md +518 -518
  142. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/documentation-creation.md +834 -834
  143. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/error-recovery.md +540 -540
  144. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/naming-conventions.md +527 -527
  145. package/docs/skill-candidates/v0.0.10/figma-generate-library/references/token-creation.md +962 -962
  146. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/bindVariablesToComponent.js +110 -110
  147. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/cleanupOrphans.js +127 -127
  148. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createComponentWithVariants.js +148 -148
  149. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createDocumentationPage.js +139 -139
  150. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createSemanticTokens.js +108 -108
  151. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/createVariableCollection.js +49 -49
  152. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/inspectFileStructure.js +121 -121
  153. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/rehydrateState.js +92 -92
  154. package/docs/skill-candidates/v0.0.10/figma-generate-library/scripts/validateCreation.js +83 -83
  155. package/docs/skill-candidates/v0.0.10/figma-implement-design/LICENSE.txt +1 -1
  156. package/docs/skill-candidates/v0.0.10/figma-implement-design/SKILL.md +258 -258
  157. package/docs/skill-candidates/v0.0.10/figma-implement-design/agents/openai.yaml +14 -14
  158. package/docs/skill-candidates/v0.0.10/figma-implement-design/assets/figma-small.svg +3 -3
  159. package/docs/skill-candidates/v0.0.10/figma-implement-design/assets/icon.svg +28 -28
  160. package/docs/skill-candidates/v0.0.10/figma-use/LICENSE.TXT +1 -1
  161. package/docs/skill-candidates/v0.0.10/figma-use/SKILL.md +233 -233
  162. package/docs/skill-candidates/v0.0.10/figma-use/agents/openai.yaml +14 -14
  163. package/docs/skill-candidates/v0.0.10/figma-use/assets/figma-small.svg +3 -3
  164. package/docs/skill-candidates/v0.0.10/figma-use/assets/icon.svg +28 -28
  165. package/docs/skill-candidates/v0.0.10/figma-use/maintainers.yml +1 -1
  166. package/docs/skill-candidates/v0.0.10/figma-use/references/api-reference.md +301 -301
  167. package/docs/skill-candidates/v0.0.10/figma-use/references/common-patterns.md +512 -512
  168. package/docs/skill-candidates/v0.0.10/figma-use/references/component-patterns.md +488 -488
  169. package/docs/skill-candidates/v0.0.10/figma-use/references/effect-style-patterns.md +123 -123
  170. package/docs/skill-candidates/v0.0.10/figma-use/references/gotchas.md +599 -599
  171. package/docs/skill-candidates/v0.0.10/figma-use/references/maintainers.yml +12 -12
  172. package/docs/skill-candidates/v0.0.10/figma-use/references/plugin-api-patterns.md +513 -513
  173. package/docs/skill-candidates/v0.0.10/figma-use/references/plugin-api-standalone.d.ts +11293 -11293
  174. package/docs/skill-candidates/v0.0.10/figma-use/references/plugin-api-standalone.index.md +441 -441
  175. package/docs/skill-candidates/v0.0.10/figma-use/references/text-style-patterns.md +203 -203
  176. package/docs/skill-candidates/v0.0.10/figma-use/references/validation-and-recovery.md +109 -109
  177. package/docs/skill-candidates/v0.0.10/figma-use/references/variable-patterns.md +354 -354
  178. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/maintainers.yml +9 -9
  179. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-components--creating.md +17 -17
  180. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-components--using.md +17 -17
  181. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-components.md +50 -50
  182. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-effect-styles.md +52 -52
  183. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-text-styles.md +90 -90
  184. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-variables--creating.md +13 -13
  185. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-variables--using.md +13 -13
  186. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds-variables.md +64 -64
  187. package/docs/skill-candidates/v0.0.10/figma-use/references/working-with-design-systems/wwds.md +41 -41
  188. package/docs/skill-candidates/v0.0.10/frontend-design/LICENSE.txt +177 -177
  189. package/docs/skill-candidates/v0.0.10/frontend-design/SKILL.md +55 -55
  190. package/docs/skill-candidates/v0.0.10/frontend-ui-ux-systems/SKILL.md +32 -32
  191. package/docs/skill-candidates/v0.0.10/github/SKILL.md +74 -74
  192. package/docs/skill-candidates/v0.0.10/github/agents/openai.yaml +6 -6
  193. package/docs/skill-candidates/v0.0.10/github/assets/github-small.svg +3 -3
  194. package/docs/skill-candidates/v0.0.10/image-graphic-design-rendering/SKILL.md +28 -28
  195. package/docs/skill-candidates/v0.0.10/language-quality-pt-en-fr-it-ru/SKILL.md +28 -28
  196. package/docs/skill-candidates/v0.0.10/math-physics-reasoning/SKILL.md +28 -28
  197. package/docs/skill-candidates/v0.0.10/mcp-builder/LICENSE.txt +201 -201
  198. package/docs/skill-candidates/v0.0.10/mcp-builder/SKILL.md +236 -236
  199. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/evaluation.md +601 -601
  200. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/mcp_best_practices.md +249 -249
  201. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/node_mcp_server.md +969 -969
  202. package/docs/skill-candidates/v0.0.10/mcp-builder/reference/python_mcp_server.md +718 -718
  203. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/connections.py +151 -151
  204. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/evaluation.py +373 -373
  205. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/example_evaluation.xml +22 -22
  206. package/docs/skill-candidates/v0.0.10/mcp-builder/scripts/requirements.txt +2 -2
  207. package/docs/skill-candidates/v0.0.10/mcp-client-readiness/SKILL.md +31 -31
  208. package/docs/skill-candidates/v0.0.10/openai-docs/LICENSE.txt +201 -201
  209. package/docs/skill-candidates/v0.0.10/openai-docs/SKILL.md +161 -161
  210. package/docs/skill-candidates/v0.0.10/openai-docs/agents/openai.yaml +14 -14
  211. package/docs/skill-candidates/v0.0.10/openai-docs/assets/openai-small.svg +3 -3
  212. package/docs/skill-candidates/v0.0.10/openai-docs/references/latest-model.md +37 -37
  213. package/docs/skill-candidates/v0.0.10/openai-docs/references/prompting-guide.md +244 -244
  214. package/docs/skill-candidates/v0.0.10/openai-docs/references/upgrade-guide.md +181 -181
  215. package/docs/skill-candidates/v0.0.10/openai-docs/scripts/fetch-codex-manual.mjs +598 -598
  216. package/docs/skill-candidates/v0.0.10/openai-docs/scripts/resolve-latest-model-info.js +147 -147
  217. package/docs/skill-candidates/v0.0.10/playwright/NOTICE.txt +14 -14
  218. package/docs/skill-candidates/v0.0.10/playwright/SKILL.md +147 -147
  219. package/docs/skill-candidates/v0.0.10/playwright/agents/openai.yaml +6 -6
  220. package/docs/skill-candidates/v0.0.10/playwright/assets/playwright-small.svg +3 -3
  221. package/docs/skill-candidates/v0.0.10/playwright/references/cli.md +116 -116
  222. package/docs/skill-candidates/v0.0.10/playwright/references/workflows.md +95 -95
  223. package/docs/skill-candidates/v0.0.10/playwright/scripts/playwright_cli.sh +25 -25
  224. package/docs/skill-candidates/v0.0.10/polyglot-backend-engineering/SKILL.md +32 -32
  225. package/docs/skill-candidates/v0.0.10/screenshot/LICENSE.txt +201 -201
  226. package/docs/skill-candidates/v0.0.10/screenshot/SKILL.md +267 -267
  227. package/docs/skill-candidates/v0.0.10/screenshot/agents/openai.yaml +6 -6
  228. package/docs/skill-candidates/v0.0.10/screenshot/assets/screenshot-small.svg +5 -5
  229. package/docs/skill-candidates/v0.0.10/screenshot/scripts/ensure_macos_permissions.sh +54 -54
  230. package/docs/skill-candidates/v0.0.10/screenshot/scripts/macos_display_info.swift +22 -22
  231. package/docs/skill-candidates/v0.0.10/screenshot/scripts/macos_permissions.swift +40 -40
  232. package/docs/skill-candidates/v0.0.10/screenshot/scripts/macos_window_info.swift +126 -126
  233. package/docs/skill-candidates/v0.0.10/screenshot/scripts/take_screenshot.ps1 +163 -163
  234. package/docs/skill-candidates/v0.0.10/screenshot/scripts/take_screenshot.py +585 -585
  235. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/SKILL.md +62 -62
  236. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/agents/openai.yaml +4 -4
  237. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/references/activation-policy.md +77 -77
  238. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/references/human-approval-policy.md +83 -83
  239. package/docs/skill-candidates/v0.0.10/skill-master-orchestrator/references/persona-dev-senior-master.md +46 -46
  240. package/docs/skill-candidates/v0.0.10/terminal-menu-operations/SKILL.md +30 -30
  241. package/docs/skill-candidates/v0.0.10/terminal-pixel-art-tui/SKILL.md +43 -43
  242. package/docs/skill-candidates/v0.0.10/webapp-testing/LICENSE.txt +201 -201
  243. package/docs/skill-candidates/v0.0.10/webapp-testing/SKILL.md +95 -95
  244. package/docs/skill-candidates/v0.0.10/webapp-testing/examples/console_logging.py +34 -34
  245. package/docs/skill-candidates/v0.0.10/webapp-testing/examples/element_discovery.py +39 -39
  246. package/docs/skill-candidates/v0.0.10/webapp-testing/examples/static_html_automation.py +32 -32
  247. package/docs/skill-candidates/v0.0.10/webapp-testing/scripts/with_server.py +105 -105
  248. package/docs/skill-candidates/v0.0.10/winui-app/LICENSE.txt +201 -201
  249. package/docs/skill-candidates/v0.0.10/winui-app/SKILL.md +94 -94
  250. package/docs/skill-candidates/v0.0.10/winui-app/agents/openai.yaml +5 -5
  251. package/docs/skill-candidates/v0.0.10/winui-app/config.yaml +50 -50
  252. package/docs/skill-candidates/v0.0.10/winui-app/references/_sections.md +96 -96
  253. package/docs/skill-candidates/v0.0.10/winui-app/references/accessibility-input-and-localization.md +51 -51
  254. package/docs/skill-candidates/v0.0.10/winui-app/references/build-run-and-launch-verification.md +72 -72
  255. package/docs/skill-candidates/v0.0.10/winui-app/references/community-toolkit-controls-and-helpers.md +57 -57
  256. package/docs/skill-candidates/v0.0.10/winui-app/references/controls-layout-and-adaptive-ui.md +84 -84
  257. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-environment-audit-and-remediation.md +82 -82
  258. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-setup-and-project-selection.md +67 -67
  259. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-template-first-recovery.md +62 -62
  260. package/docs/skill-candidates/v0.0.10/winui-app/references/foundation-winui-app-structure.md +62 -62
  261. package/docs/skill-candidates/v0.0.10/winui-app/references/motion-animations-and-polish.md +45 -45
  262. package/docs/skill-candidates/v0.0.10/winui-app/references/performance-diagnostics-and-responsiveness.md +46 -46
  263. package/docs/skill-candidates/v0.0.10/winui-app/references/sample-source-map.md +37 -37
  264. package/docs/skill-candidates/v0.0.10/winui-app/references/shell-navigation-and-windowing.md +67 -67
  265. package/docs/skill-candidates/v0.0.10/winui-app/references/styling-theming-materials-and-icons.md +71 -71
  266. package/docs/skill-candidates/v0.0.10/winui-app/references/testing-debugging-and-review-checklists.md +77 -77
  267. package/docs/skill-candidates/v0.0.10/winui-app/references/windows-app-sdk-lifecycle-notifications-and-deployment.md +52 -52
  268. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/SKILL.md +398 -398
  269. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/common-patterns.md +330 -330
  270. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/complete-examples.md +871 -871
  271. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/component-patterns.md +501 -501
  272. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/data-fetching.md +766 -766
  273. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/file-organization.md +501 -501
  274. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/loading-and-error-states.md +500 -500
  275. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/performance.md +405 -405
  276. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/routing-guide.md +363 -363
  277. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/styling-guide.md +427 -427
  278. package/docs/skill-candidates/v0.0.11/frontend-dev-guidelines/resources/typescript-standards.md +417 -417
  279. package/docs/skill-candidates/v0.0.11/git-version-control-ops/SKILL.md +34 -34
  280. package/docs/skill-candidates/v0.0.11/go-engineering/SKILL.md +34 -34
  281. package/docs/skill-candidates/v0.0.11/java-engineering/SKILL.md +34 -34
  282. package/docs/skill-candidates/v0.0.11/javascript-engineering/SKILL.md +34 -34
  283. package/docs/skill-candidates/v0.0.11/json-contract-design/SKILL.md +34 -34
  284. package/docs/skill-candidates/v0.0.11/multi-client-mcp-ops/SKILL.md +36 -36
  285. package/docs/skill-candidates/v0.0.11/nextjs/SKILL.md +745 -745
  286. package/docs/skill-candidates/v0.0.11/nextjs/agents/openai.yaml +3 -3
  287. package/docs/skill-candidates/v0.0.11/nextjs/references/app-router-files.md +94 -94
  288. package/docs/skill-candidates/v0.0.11/python-engineering/SKILL.md +34 -34
  289. package/docs/skill-candidates/v0.0.11/ruby-engineering/SKILL.md +34 -34
  290. package/docs/skill-candidates/v0.0.11/senior-fullstack/SKILL.md +209 -209
  291. package/docs/skill-candidates/v0.0.11/senior-fullstack/references/architecture_patterns.md +103 -103
  292. package/docs/skill-candidates/v0.0.11/senior-fullstack/references/development_workflows.md +103 -103
  293. package/docs/skill-candidates/v0.0.11/senior-fullstack/references/tech_stack_guide.md +103 -103
  294. package/docs/skill-candidates/v0.0.11/senior-fullstack/scripts/code_quality_analyzer.py +114 -114
  295. package/docs/skill-candidates/v0.0.11/senior-fullstack/scripts/fullstack_scaffolder.py +114 -114
  296. package/docs/skill-candidates/v0.0.11/senior-fullstack/scripts/project_scaffolder.py +114 -114
  297. package/docs/skill-candidates/v0.0.11/shadcn/SKILL.md +573 -573
  298. package/docs/skill-candidates/v0.0.11/shadcn/agents/openai.yaml +3 -3
  299. package/docs/skill-candidates/v0.0.11/sql-postgresql-engineering/SKILL.md +34 -34
  300. package/docs/skill-candidates/v0.0.11/terminal-shell-ops/SKILL.md +34 -34
  301. package/docs/skill-candidates/v0.0.11/typescript-expert/SKILL.md +429 -429
  302. package/docs/skill-candidates/v0.0.11/typescript-expert/references/tsconfig-strict.json +91 -91
  303. package/docs/skill-candidates/v0.0.11/typescript-expert/references/typescript-cheatsheet.md +383 -383
  304. package/docs/skill-candidates/v0.0.11/typescript-expert/references/utility-types.ts +335 -335
  305. package/docs/skill-candidates/v0.0.11/typescript-expert/scripts/ts_diagnostic.py +203 -203
  306. package/docs/skill-candidates/v0.0.11/ui-component-primitives/SKILL.md +34 -34
  307. package/docs/skill-candidates/v0.0.11/web-mobile-design-systems/SKILL.md +34 -34
  308. package/docs/skill-candidates/v0.0.11/windows-linux-platform-ops/SKILL.md +34 -34
  309. package/docs/skill-candidates/v0.0.12/context-compression-handoff/SKILL.md +47 -0
  310. package/docs/skill-candidates/v0.0.12/csharp-senior-master-engineering/SKILL.md +32 -32
  311. package/docs/skill-candidates/v0.0.12/css-senior-master-engineering/SKILL.md +32 -32
  312. package/docs/skill-candidates/v0.0.12/go-senior-master-engineering/SKILL.md +32 -32
  313. package/docs/skill-candidates/v0.0.12/html-senior-master-engineering/SKILL.md +32 -32
  314. package/docs/skill-candidates/v0.0.12/javascript-senior-master-engineering/SKILL.md +32 -32
  315. package/docs/skill-candidates/v0.0.12/json-senior-master-engineering/SKILL.md +32 -32
  316. package/docs/skill-candidates/v0.0.12/prompt-budget-gate/SKILL.md +46 -0
  317. package/docs/skill-candidates/v0.0.12/python-senior-master-engineering/SKILL.md +32 -32
  318. package/docs/skill-candidates/v0.0.12/react-senior-master-engineering/SKILL.md +32 -32
  319. package/docs/skill-candidates/v0.0.12/ruby-senior-master-engineering/SKILL.md +32 -32
  320. package/docs/skill-candidates/v0.0.12/senior-master-code-optimizer/SKILL.md +48 -48
  321. package/docs/skill-candidates/v0.0.12/sql-senior-master-engineering/SKILL.md +31 -31
  322. package/docs/skill-candidates/v0.0.12/token-economy-orchestrator/SKILL.md +38 -0
  323. package/docs/skill-candidates/v0.0.12/typescript-senior-master-engineering/SKILL.md +35 -35
  324. package/docs/skill-candidates/v0.0.9/ai-ethics-human-dignity/SKILL.md +32 -32
  325. package/docs/skill-candidates/v0.0.9/broad-domain-router/SKILL.md +41 -41
  326. package/docs/skill-candidates/v0.0.9/catholic-moral-discernment/SKILL.md +31 -31
  327. package/docs/skill-candidates/v0.0.9/engineering-systems-master/SKILL.md +31 -31
  328. package/docs/skill-candidates/v0.0.9/language-quality-pt-en-fr/SKILL.md +28 -28
  329. package/docs/skill-candidates/v0.0.9/math-science-reasoning/SKILL.md +29 -29
  330. package/docs/skill-candidates/v0.0.9/philosophy-sociology-discernment/SKILL.md +28 -28
  331. package/docs/skill-candidates/v0.0.9/professional-boundary-triage/SKILL.md +40 -40
  332. package/docs/skill-candidates/v0.0.9/release-ethics-gate/SKILL.md +32 -32
  333. package/docs/skill-candidates/v0.0.9/source-authority-reviewer/SKILL.md +31 -31
  334. package/examples/client-configs/claude-code.commands.md +21 -21
  335. package/examples/client-configs/claude-code.project.mcp.json +18 -18
  336. package/examples/client-configs/claude-desktop.macos.json +18 -18
  337. package/examples/client-configs/claude-desktop.windows.json +20 -20
  338. package/examples/client-configs/codex.windows.toml +11 -11
  339. package/examples/client-configs/gemini-code-assist.intellij.mcp.json +18 -18
  340. package/examples/client-configs/gemini.linux.settings.json +21 -21
  341. package/examples/client-configs/gemini.windows.settings.json +23 -23
  342. package/examples/client-configs/generic-stdio.json +16 -16
  343. package/manifests/channels/beta.json +24 -24
  344. package/manifests/channels/stable.json +25 -25
  345. package/network/approved-skills.json +54 -54
  346. package/network/unapproved-skill-candidates.json +110 -110
  347. package/package.json +89 -86
  348. package/scripts/configure-private-registry.mjs +208 -208
  349. package/scripts/lib/private-registry.mjs +97 -97
  350. package/scripts/render-menu-evidence.mjs +196 -130
  351. package/scripts/verify-menu-actions.mjs +112 -107
  352. package/scripts/verify-menu-visual.mjs +90 -0
  353. package/sources.json +11 -11
@@ -1,872 +1,872 @@
1
- # Complete Examples
2
-
3
- Full working examples combining all modern patterns: React.FC, lazy loading, Suspense, useSuspenseQuery, styling, routing, and error handling.
4
-
5
- ---
6
-
7
- ## Example 1: Complete Modern Component
8
-
9
- Combines: React.FC, useSuspenseQuery, cache-first, useCallback, styling, error handling
10
-
11
- ```typescript
12
- /**
13
- * User profile display component
14
- * Demonstrates modern patterns with Suspense and TanStack Query
15
- */
16
- import React, { useState, useCallback, useMemo } from 'react';
17
- import { Box, Paper, Typography, Button, Avatar } from '@mui/material';
18
- import type { SxProps, Theme } from '@mui/material';
19
- import { useSuspenseQuery, useMutation, useQueryClient } from '@tanstack/react-query';
20
- import { userApi } from '../api/userApi';
21
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
22
- import type { User } from '~types/user';
23
-
24
- // Styles object
25
- const componentStyles: Record<string, SxProps<Theme>> = {
26
- container: {
27
- p: 3,
28
- maxWidth: 600,
29
- margin: '0 auto',
30
- },
31
- header: {
32
- display: 'flex',
33
- alignItems: 'center',
34
- gap: 2,
35
- mb: 3,
36
- },
37
- content: {
38
- display: 'flex',
39
- flexDirection: 'column',
40
- gap: 2,
41
- },
42
- actions: {
43
- display: 'flex',
44
- gap: 1,
45
- mt: 2,
46
- },
47
- };
48
-
49
- interface UserProfileProps {
50
- userId: string;
51
- onUpdate?: () => void;
52
- }
53
-
54
- export const UserProfile: React.FC<UserProfileProps> = ({ userId, onUpdate }) => {
55
- const queryClient = useQueryClient();
56
- const { showSuccess, showError } = useMuiSnackbar();
57
- const [isEditing, setIsEditing] = useState(false);
58
-
59
- // Suspense query - no isLoading needed!
60
- const { data: user } = useSuspenseQuery({
61
- queryKey: ['user', userId],
62
- queryFn: () => userApi.getUser(userId),
63
- staleTime: 5 * 60 * 1000,
64
- });
65
-
66
- // Update mutation
67
- const updateMutation = useMutation({
68
- mutationFn: (updates: Partial<User>) =>
69
- userApi.updateUser(userId, updates),
70
-
71
- onSuccess: () => {
72
- queryClient.invalidateQueries({ queryKey: ['user', userId] });
73
- showSuccess('Profile updated');
74
- setIsEditing(false);
75
- onUpdate?.();
76
- },
77
-
78
- onError: () => {
79
- showError('Failed to update profile');
80
- },
81
- });
82
-
83
- // Memoized computed value
84
- const fullName = useMemo(() => {
85
- return `${user.firstName} ${user.lastName}`;
86
- }, [user.firstName, user.lastName]);
87
-
88
- // Event handlers with useCallback
89
- const handleEdit = useCallback(() => {
90
- setIsEditing(true);
91
- }, []);
92
-
93
- const handleSave = useCallback(() => {
94
- updateMutation.mutate({
95
- firstName: user.firstName,
96
- lastName: user.lastName,
97
- });
98
- }, [user, updateMutation]);
99
-
100
- const handleCancel = useCallback(() => {
101
- setIsEditing(false);
102
- }, []);
103
-
104
- return (
105
- <Paper sx={componentStyles.container}>
106
- <Box sx={componentStyles.header}>
107
- <Avatar sx={{ width: 64, height: 64 }}>
108
- {user.firstName[0]}{user.lastName[0]}
109
- </Avatar>
110
- <Box>
111
- <Typography variant='h5'>{fullName}</Typography>
112
- <Typography color='text.secondary'>{user.email}</Typography>
113
- </Box>
114
- </Box>
115
-
116
- <Box sx={componentStyles.content}>
117
- <Typography>Username: {user.username}</Typography>
118
- <Typography>Roles: {user.roles.join(', ')}</Typography>
119
- </Box>
120
-
121
- <Box sx={componentStyles.actions}>
122
- {!isEditing ? (
123
- <Button variant='contained' onClick={handleEdit}>
124
- Edit Profile
125
- </Button>
126
- ) : (
127
- <>
128
- <Button
129
- variant='contained'
130
- onClick={handleSave}
131
- disabled={updateMutation.isPending}
132
- >
133
- {updateMutation.isPending ? 'Saving...' : 'Save'}
134
- </Button>
135
- <Button onClick={handleCancel}>
136
- Cancel
137
- </Button>
138
- </>
139
- )}
140
- </Box>
141
- </Paper>
142
- );
143
- };
144
-
145
- export default UserProfile;
146
- ```
147
-
148
- **Usage:**
149
- ```typescript
150
- <SuspenseLoader>
151
- <UserProfile userId='123' onUpdate={() => console.log('Updated')} />
152
- </SuspenseLoader>
153
- ```
154
-
155
- ---
156
-
157
- ## Example 2: Complete Feature Structure
158
-
159
- Real example based on `features/posts/`:
160
-
161
- ```
162
- features/
163
- users/
164
- api/
165
- userApi.ts # API service layer
166
- components/
167
- UserProfile.tsx # Main component (from Example 1)
168
- UserList.tsx # List component
169
- UserBlog.tsx # Blog component
170
- modals/
171
- DeleteUserModal.tsx # Modal component
172
- hooks/
173
- useSuspenseUser.ts # Suspense query hook
174
- useUserMutations.ts # Mutation hooks
175
- useUserPermissions.ts # Feature-specific hook
176
- helpers/
177
- userHelpers.ts # Utility functions
178
- validation.ts # Validation logic
179
- types/
180
- index.ts # TypeScript interfaces
181
- index.ts # Public API exports
182
- ```
183
-
184
- ### API Service (userApi.ts)
185
-
186
- ```typescript
187
- import apiClient from '@/lib/apiClient';
188
- import type { User, CreateUserPayload, UpdateUserPayload } from '../types';
189
-
190
- export const userApi = {
191
- getUser: async (userId: string): Promise<User> => {
192
- const { data } = await apiClient.get(`/users/${userId}`);
193
- return data;
194
- },
195
-
196
- getUsers: async (): Promise<User[]> => {
197
- const { data } = await apiClient.get('/users');
198
- return data;
199
- },
200
-
201
- createUser: async (payload: CreateUserPayload): Promise<User> => {
202
- const { data } = await apiClient.post('/users', payload);
203
- return data;
204
- },
205
-
206
- updateUser: async (userId: string, payload: UpdateUserPayload): Promise<User> => {
207
- const { data } = await apiClient.put(`/users/${userId}`, payload);
208
- return data;
209
- },
210
-
211
- deleteUser: async (userId: string): Promise<void> => {
212
- await apiClient.delete(`/users/${userId}`);
213
- },
214
- };
215
- ```
216
-
217
- ### Suspense Hook (useSuspenseUser.ts)
218
-
219
- ```typescript
220
- import { useSuspenseQuery } from '@tanstack/react-query';
221
- import { userApi } from '../api/userApi';
222
- import type { User } from '../types';
223
-
224
- export function useSuspenseUser(userId: string) {
225
- return useSuspenseQuery<User, Error>({
226
- queryKey: ['user', userId],
227
- queryFn: () => userApi.getUser(userId),
228
- staleTime: 5 * 60 * 1000,
229
- gcTime: 10 * 60 * 1000,
230
- });
231
- }
232
-
233
- export function useSuspenseUsers() {
234
- return useSuspenseQuery<User[], Error>({
235
- queryKey: ['users'],
236
- queryFn: () => userApi.getUsers(),
237
- staleTime: 1 * 60 * 1000, // Shorter for list
238
- });
239
- }
240
- ```
241
-
242
- ### Types (types/index.ts)
243
-
244
- ```typescript
245
- export interface User {
246
- id: string;
247
- username: string;
248
- email: string;
249
- firstName: string;
250
- lastName: string;
251
- roles: string[];
252
- createdAt: string;
253
- updatedAt: string;
254
- }
255
-
256
- export interface CreateUserPayload {
257
- username: string;
258
- email: string;
259
- firstName: string;
260
- lastName: string;
261
- password: string;
262
- }
263
-
264
- export type UpdateUserPayload = Partial<Omit<User, 'id' | 'createdAt' | 'updatedAt'>>;
265
- ```
266
-
267
- ### Public Exports (index.ts)
268
-
269
- ```typescript
270
- // Export components
271
- export { UserProfile } from './components/UserProfile';
272
- export { UserList } from './components/UserList';
273
-
274
- // Export hooks
275
- export { useSuspenseUser, useSuspenseUsers } from './hooks/useSuspenseUser';
276
- export { useUserMutations } from './hooks/useUserMutations';
277
-
278
- // Export API
279
- export { userApi } from './api/userApi';
280
-
281
- // Export types
282
- export type { User, CreateUserPayload, UpdateUserPayload } from './types';
283
- ```
284
-
285
- ---
286
-
287
- ## Example 3: Complete Route with Lazy Loading
288
-
289
- ```typescript
290
- /**
291
- * User profile route
292
- * Path: /users/:userId
293
- */
294
-
295
- import { createFileRoute } from '@tanstack/react-router';
296
- import { lazy } from 'react';
297
- import { SuspenseLoader } from '~components/SuspenseLoader';
298
-
299
- // Lazy load the UserProfile component
300
- const UserProfile = lazy(() =>
301
- import('@/features/users/components/UserProfile').then(
302
- (module) => ({ default: module.UserProfile })
303
- )
304
- );
305
-
306
- export const Route = createFileRoute('/users/$userId')({
307
- component: UserProfilePage,
308
- loader: ({ params }) => ({
309
- crumb: `User ${params.userId}`,
310
- }),
311
- });
312
-
313
- function UserProfilePage() {
314
- const { userId } = Route.useParams();
315
-
316
- return (
317
- <SuspenseLoader>
318
- <UserProfile
319
- userId={userId}
320
- onUpdate={() => console.log('Profile updated')}
321
- />
322
- </SuspenseLoader>
323
- );
324
- }
325
-
326
- export default UserProfilePage;
327
- ```
328
-
329
- ---
330
-
331
- ## Example 4: List with Search and Filtering
332
-
333
- ```typescript
334
- import React, { useState, useMemo } from 'react';
335
- import { Box, TextField, List, ListItem } from '@mui/material';
336
- import { useDebounce } from 'use-debounce';
337
- import { useSuspenseQuery } from '@tanstack/react-query';
338
- import { userApi } from '../api/userApi';
339
-
340
- export const UserList: React.FC = () => {
341
- const [searchTerm, setSearchTerm] = useState('');
342
- const [debouncedSearch] = useDebounce(searchTerm, 300);
343
-
344
- const { data: users } = useSuspenseQuery({
345
- queryKey: ['users'],
346
- queryFn: () => userApi.getUsers(),
347
- });
348
-
349
- // Memoized filtering
350
- const filteredUsers = useMemo(() => {
351
- if (!debouncedSearch) return users;
352
-
353
- return users.filter(user =>
354
- user.name.toLowerCase().includes(debouncedSearch.toLowerCase()) ||
355
- user.email.toLowerCase().includes(debouncedSearch.toLowerCase())
356
- );
357
- }, [users, debouncedSearch]);
358
-
359
- return (
360
- <Box>
361
- <TextField
362
- value={searchTerm}
363
- onChange={(e) => setSearchTerm(e.target.value)}
364
- placeholder='Search users...'
365
- fullWidth
366
- sx={{ mb: 2 }}
367
- />
368
-
369
- <List>
370
- {filteredUsers.map(user => (
371
- <ListItem key={user.id}>
372
- {user.name} - {user.email}
373
- </ListItem>
374
- ))}
375
- </List>
376
- </Box>
377
- );
378
- };
379
- ```
380
-
381
- ---
382
-
383
- ## Example 5: Blog with Validation
384
-
385
- ```typescript
386
- import React from 'react';
387
- import { Box, TextField, Button, Paper } from '@mui/material';
388
- import { useBlog } from 'react-hook-blog';
389
- import { zodResolver } from '@hookblog/resolvers/zod';
390
- import { z } from 'zod';
391
- import { useMutation, useQueryClient } from '@tanstack/react-query';
392
- import { userApi } from '../api/userApi';
393
- import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
394
-
395
- const userSchema = z.object({
396
- username: z.string().min(3).max(50),
397
- email: z.string().email(),
398
- firstName: z.string().min(1),
399
- lastName: z.string().min(1),
400
- });
401
-
402
- type UserBlogData = z.infer<typeof userSchema>;
403
-
404
- interface CreateUserBlogProps {
405
- onSuccess?: () => void;
406
- }
407
-
408
- export const CreateUserBlog: React.FC<CreateUserBlogProps> = ({ onSuccess }) => {
409
- const queryClient = useQueryClient();
410
- const { showSuccess, showError } = useMuiSnackbar();
411
-
412
- const { register, handleSubmit, blogState: { errors }, reset } = useBlog<UserBlogData>({
413
- resolver: zodResolver(userSchema),
414
- defaultValues: {
415
- username: '',
416
- email: '',
417
- firstName: '',
418
- lastName: '',
419
- },
420
- });
421
-
422
- const createMutation = useMutation({
423
- mutationFn: (data: UserBlogData) => userApi.createUser(data),
424
-
425
- onSuccess: () => {
426
- queryClient.invalidateQueries({ queryKey: ['users'] });
427
- showSuccess('User created successfully');
428
- reset();
429
- onSuccess?.();
430
- },
431
-
432
- onError: () => {
433
- showError('Failed to create user');
434
- },
435
- });
436
-
437
- const onSubmit = (data: UserBlogData) => {
438
- createMutation.mutate(data);
439
- };
440
-
441
- return (
442
- <Paper sx={{ p: 3, maxWidth: 500 }}>
443
- <blog onSubmit={handleSubmit(onSubmit)}>
444
- <Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
445
- <TextField
446
- {...register('username')}
447
- label='Username'
448
- error={!!errors.username}
449
- helperText={errors.username?.message}
450
- fullWidth
451
- />
452
-
453
- <TextField
454
- {...register('email')}
455
- label='Email'
456
- type='email'
457
- error={!!errors.email}
458
- helperText={errors.email?.message}
459
- fullWidth
460
- />
461
-
462
- <TextField
463
- {...register('firstName')}
464
- label='First Name'
465
- error={!!errors.firstName}
466
- helperText={errors.firstName?.message}
467
- fullWidth
468
- />
469
-
470
- <TextField
471
- {...register('lastName')}
472
- label='Last Name'
473
- error={!!errors.lastName}
474
- helperText={errors.lastName?.message}
475
- fullWidth
476
- />
477
-
478
- <Button
479
- type='submit'
480
- variant='contained'
481
- disabled={createMutation.isPending}
482
- >
483
- {createMutation.isPending ? 'Creating...' : 'Create User'}
484
- </Button>
485
- </Box>
486
- </blog>
487
- </Paper>
488
- );
489
- };
490
-
491
- export default CreateUserBlog;
492
- ```
493
-
494
- ---
495
-
496
- ## Example 2: Parent Container with Lazy Loading
497
-
498
- ```typescript
499
- import React from 'react';
500
- import { Box } from '@mui/material';
501
- import { SuspenseLoader } from '~components/SuspenseLoader';
502
-
503
- // Lazy load heavy components
504
- const UserList = React.lazy(() => import('./UserList'));
505
- const UserStats = React.lazy(() => import('./UserStats'));
506
- const ActivityFeed = React.lazy(() => import('./ActivityFeed'));
507
-
508
- export const UserDashboard: React.FC = () => {
509
- return (
510
- <Box sx={{ p: 2 }}>
511
- <SuspenseLoader>
512
- <UserStats />
513
- </SuspenseLoader>
514
-
515
- <Box sx={{ display: 'flex', gap: 2, mt: 2 }}>
516
- <Box sx={{ flex: 2 }}>
517
- <SuspenseLoader>
518
- <UserList />
519
- </SuspenseLoader>
520
- </Box>
521
-
522
- <Box sx={{ flex: 1 }}>
523
- <SuspenseLoader>
524
- <ActivityFeed />
525
- </SuspenseLoader>
526
- </Box>
527
- </Box>
528
- </Box>
529
- );
530
- };
531
-
532
- export default UserDashboard;
533
- ```
534
-
535
- **Benefits:**
536
- - Each section loads independently
537
- - User sees partial content sooner
538
- - Better perceived perblogance
539
-
540
- ---
541
-
542
- ## Example 3: Cache-First Strategy Implementation
543
-
544
- Complete example based on useSuspensePost.ts:
545
-
546
- ```typescript
547
- import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
548
- import { postApi } from '../api/postApi';
549
- import type { Post } from '../types';
550
-
551
- /**
552
- * Smart post hook with cache-first strategy
553
- * Reuses data from grid cache when available
554
- */
555
- export function useSuspensePost(blogId: number, postId: number) {
556
- const queryClient = useQueryClient();
557
-
558
- return useSuspenseQuery<Post, Error>({
559
- queryKey: ['post', blogId, postId],
560
- queryFn: async () => {
561
- // Strategy 1: Check grid cache first (avoids API call)
562
- const gridCache = queryClient.getQueryData<{ rows: Post[] }>([
563
- 'posts-v2',
564
- blogId,
565
- 'summary'
566
- ]) || queryClient.getQueryData<{ rows: Post[] }>([
567
- 'posts-v2',
568
- blogId,
569
- 'flat'
570
- ]);
571
-
572
- if (gridCache?.rows) {
573
- const cached = gridCache.rows.find(
574
- (row) => row.S_ID === postId
575
- );
576
-
577
- if (cached) {
578
- return cached; // Return from cache - no API call!
579
- }
580
- }
581
-
582
- // Strategy 2: Not in cache, fetch from API
583
- return postApi.getPost(blogId, postId);
584
- },
585
- staleTime: 5 * 60 * 1000, // Fresh for 5 minutes
586
- gcTime: 10 * 60 * 1000, // Cache for 10 minutes
587
- refetchOnWindowFocus: false, // Don't refetch on focus
588
- });
589
- }
590
- ```
591
-
592
- **Why this pattern:**
593
- - Checks grid cache before API
594
- - Instant data if user came from grid
595
- - Falls back to API if not cached
596
- - Configurable cache times
597
-
598
- ---
599
-
600
- ## Example 4: Complete Route File
601
-
602
- ```typescript
603
- /**
604
- * Project catalog route
605
- * Path: /project-catalog
606
- */
607
-
608
- import { createFileRoute } from '@tanstack/react-router';
609
- import { lazy } from 'react';
610
-
611
- // Lazy load the PostTable component
612
- const PostTable = lazy(() =>
613
- import('@/features/posts/components/PostTable').then(
614
- (module) => ({ default: module.PostTable })
615
- )
616
- );
617
-
618
- // Route constants
619
- const PROJECT_CATALOG_FORM_ID = 744;
620
- const PROJECT_CATALOG_PROJECT_ID = 225;
621
-
622
- export const Route = createFileRoute('/project-catalog/')({
623
- component: ProjectCatalogPage,
624
- loader: () => ({
625
- crumb: 'Projects', // Breadcrumb title
626
- }),
627
- });
628
-
629
- function ProjectCatalogPage() {
630
- return (
631
- <PostTable
632
- blogId={PROJECT_CATALOG_FORM_ID}
633
- projectId={PROJECT_CATALOG_PROJECT_ID}
634
- tableType='active_projects'
635
- title='Blog Dashboard'
636
- />
637
- );
638
- }
639
-
640
- export default ProjectCatalogPage;
641
- ```
642
-
643
- ---
644
-
645
- ## Example 5: Dialog with Blog
646
-
647
- ```typescript
648
- import React from 'react';
649
- import {
650
- Dialog,
651
- DialogTitle,
652
- DialogContent,
653
- DialogActions,
654
- Button,
655
- TextField,
656
- Box,
657
- IconButton,
658
- } from '@mui/material';
659
- import { Close, PersonAdd } from '@mui/icons-material';
660
- import { useBlog } from 'react-hook-blog';
661
- import { zodResolver } from '@hookblog/resolvers/zod';
662
- import { z } from 'zod';
663
-
664
- const blogSchema = z.object({
665
- name: z.string().min(1),
666
- email: z.string().email(),
667
- });
668
-
669
- type BlogData = z.infer<typeof blogSchema>;
670
-
671
- interface AddUserDialogProps {
672
- open: boolean;
673
- onClose: () => void;
674
- onSubmit: (data: BlogData) => Promise<void>;
675
- }
676
-
677
- export const AddUserDialog: React.FC<AddUserDialogProps> = ({
678
- open,
679
- onClose,
680
- onSubmit,
681
- }) => {
682
- const { register, handleSubmit, blogState: { errors }, reset } = useBlog<BlogData>({
683
- resolver: zodResolver(blogSchema),
684
- });
685
-
686
- const handleClose = () => {
687
- reset();
688
- onClose();
689
- };
690
-
691
- const handleBlogSubmit = async (data: BlogData) => {
692
- await onSubmit(data);
693
- handleClose();
694
- };
695
-
696
- return (
697
- <Dialog open={open} onClose={handleClose} maxWidth='sm' fullWidth>
698
- <DialogTitle>
699
- <Box sx={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between' }}>
700
- <Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
701
- <PersonAdd color='primary' />
702
- Add User
703
- </Box>
704
- <IconButton onClick={handleClose} size='small'>
705
- <Close />
706
- </IconButton>
707
- </Box>
708
- </DialogTitle>
709
-
710
- <blog onSubmit={handleSubmit(handleBlogSubmit)}>
711
- <DialogContent>
712
- <Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
713
- <TextField
714
- {...register('name')}
715
- label='Name'
716
- error={!!errors.name}
717
- helperText={errors.name?.message}
718
- fullWidth
719
- autoFocus
720
- />
721
-
722
- <TextField
723
- {...register('email')}
724
- label='Email'
725
- type='email'
726
- error={!!errors.email}
727
- helperText={errors.email?.message}
728
- fullWidth
729
- />
730
- </Box>
731
- </DialogContent>
732
-
733
- <DialogActions>
734
- <Button onClick={handleClose}>Cancel</Button>
735
- <Button type='submit' variant='contained'>
736
- Add User
737
- </Button>
738
- </DialogActions>
739
- </blog>
740
- </Dialog>
741
- );
742
- };
743
- ```
744
-
745
- ---
746
-
747
- ## Example 6: Parallel Data Fetching
748
-
749
- ```typescript
750
- import React from 'react';
751
- import { Box, Grid, Paper } from '@mui/material';
752
- import { useSuspenseQueries } from '@tanstack/react-query';
753
- import { userApi } from '../api/userApi';
754
- import { statsApi } from '../api/statsApi';
755
- import { activityApi } from '../api/activityApi';
756
-
757
- export const Dashboard: React.FC = () => {
758
- // Fetch all data in parallel with Suspense
759
- const [statsQuery, usersQuery, activityQuery] = useSuspenseQueries({
760
- queries: [
761
- {
762
- queryKey: ['stats'],
763
- queryFn: () => statsApi.getStats(),
764
- },
765
- {
766
- queryKey: ['users', 'active'],
767
- queryFn: () => userApi.getActiveUsers(),
768
- },
769
- {
770
- queryKey: ['activity', 'recent'],
771
- queryFn: () => activityApi.getRecent(),
772
- },
773
- ],
774
- });
775
-
776
- return (
777
- <Box sx={{ p: 2 }}>
778
- <Grid container spacing={2}>
779
- <Grid size={{ xs: 12, md: 4 }}>
780
- <Paper sx={{ p: 2 }}>
781
- <h3>Stats</h3>
782
- <p>Total: {statsQuery.data.total}</p>
783
- </Paper>
784
- </Grid>
785
-
786
- <Grid size={{ xs: 12, md: 4 }}>
787
- <Paper sx={{ p: 2 }}>
788
- <h3>Active Users</h3>
789
- <p>Count: {usersQuery.data.length}</p>
790
- </Paper>
791
- </Grid>
792
-
793
- <Grid size={{ xs: 12, md: 4 }}>
794
- <Paper sx={{ p: 2 }}>
795
- <h3>Recent Activity</h3>
796
- <p>Events: {activityQuery.data.length}</p>
797
- </Paper>
798
- </Grid>
799
- </Grid>
800
- </Box>
801
- );
802
- };
803
-
804
- // Usage with Suspense
805
- <SuspenseLoader>
806
- <Dashboard />
807
- </SuspenseLoader>
808
- ```
809
-
810
- ---
811
-
812
- ## Example 7: Optimistic Update
813
-
814
- ```typescript
815
- import { useMutation, useQueryClient } from '@tanstack/react-query';
816
- import type { User } from '../types';
817
-
818
- export const useToggleUserStatus = () => {
819
- const queryClient = useQueryClient();
820
-
821
- return useMutation({
822
- mutationFn: (userId: string) => userApi.toggleStatus(userId),
823
-
824
- // Optimistic update
825
- onMutate: async (userId) => {
826
- // Cancel outgoing refetches
827
- await queryClient.cancelQueries({ queryKey: ['users'] });
828
-
829
- // Snapshot previous value
830
- const previousUsers = queryClient.getQueryData<User[]>(['users']);
831
-
832
- // Optimistically update UI
833
- queryClient.setQueryData<User[]>(['users'], (old) => {
834
- return old?.map(user =>
835
- user.id === userId
836
- ? { ...user, active: !user.active }
837
- : user
838
- ) || [];
839
- });
840
-
841
- return { previousUsers };
842
- },
843
-
844
- // Rollback on error
845
- onError: (err, userId, context) => {
846
- queryClient.setQueryData(['users'], context?.previousUsers);
847
- },
848
-
849
- // Refetch after mutation
850
- onSettled: () => {
851
- queryClient.invalidateQueries({ queryKey: ['users'] });
852
- },
853
- });
854
- };
855
- ```
856
-
857
- ---
858
-
859
- ## Summary
860
-
861
- **Key Takeaways:**
862
-
863
- 1. **Component Pattern**: React.FC + lazy + Suspense + useSuspenseQuery
864
- 2. **Feature Structure**: Organized subdirectories (api/, components/, hooks/, etc.)
865
- 3. **Routing**: Folder-based with lazy loading
866
- 4. **Data Fetching**: useSuspenseQuery with cache-first strategy
867
- 5. **Blogs**: React Hook Blog + Zod validation
868
- 6. **Error Handling**: useMuiSnackbar + onError callbacks
869
- 7. **Perblogance**: useMemo, useCallback, React.memo, debouncing
870
- 8. **Styling**: Inline <100 lines, sx prop, MUI v7 syntax
871
-
1
+ # Complete Examples
2
+
3
+ Full working examples combining all modern patterns: React.FC, lazy loading, Suspense, useSuspenseQuery, styling, routing, and error handling.
4
+
5
+ ---
6
+
7
+ ## Example 1: Complete Modern Component
8
+
9
+ Combines: React.FC, useSuspenseQuery, cache-first, useCallback, styling, error handling
10
+
11
+ ```typescript
12
+ /**
13
+ * User profile display component
14
+ * Demonstrates modern patterns with Suspense and TanStack Query
15
+ */
16
+ import React, { useState, useCallback, useMemo } from 'react';
17
+ import { Box, Paper, Typography, Button, Avatar } from '@mui/material';
18
+ import type { SxProps, Theme } from '@mui/material';
19
+ import { useSuspenseQuery, useMutation, useQueryClient } from '@tanstack/react-query';
20
+ import { userApi } from '../api/userApi';
21
+ import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
22
+ import type { User } from '~types/user';
23
+
24
+ // Styles object
25
+ const componentStyles: Record<string, SxProps<Theme>> = {
26
+ container: {
27
+ p: 3,
28
+ maxWidth: 600,
29
+ margin: '0 auto',
30
+ },
31
+ header: {
32
+ display: 'flex',
33
+ alignItems: 'center',
34
+ gap: 2,
35
+ mb: 3,
36
+ },
37
+ content: {
38
+ display: 'flex',
39
+ flexDirection: 'column',
40
+ gap: 2,
41
+ },
42
+ actions: {
43
+ display: 'flex',
44
+ gap: 1,
45
+ mt: 2,
46
+ },
47
+ };
48
+
49
+ interface UserProfileProps {
50
+ userId: string;
51
+ onUpdate?: () => void;
52
+ }
53
+
54
+ export const UserProfile: React.FC<UserProfileProps> = ({ userId, onUpdate }) => {
55
+ const queryClient = useQueryClient();
56
+ const { showSuccess, showError } = useMuiSnackbar();
57
+ const [isEditing, setIsEditing] = useState(false);
58
+
59
+ // Suspense query - no isLoading needed!
60
+ const { data: user } = useSuspenseQuery({
61
+ queryKey: ['user', userId],
62
+ queryFn: () => userApi.getUser(userId),
63
+ staleTime: 5 * 60 * 1000,
64
+ });
65
+
66
+ // Update mutation
67
+ const updateMutation = useMutation({
68
+ mutationFn: (updates: Partial<User>) =>
69
+ userApi.updateUser(userId, updates),
70
+
71
+ onSuccess: () => {
72
+ queryClient.invalidateQueries({ queryKey: ['user', userId] });
73
+ showSuccess('Profile updated');
74
+ setIsEditing(false);
75
+ onUpdate?.();
76
+ },
77
+
78
+ onError: () => {
79
+ showError('Failed to update profile');
80
+ },
81
+ });
82
+
83
+ // Memoized computed value
84
+ const fullName = useMemo(() => {
85
+ return `${user.firstName} ${user.lastName}`;
86
+ }, [user.firstName, user.lastName]);
87
+
88
+ // Event handlers with useCallback
89
+ const handleEdit = useCallback(() => {
90
+ setIsEditing(true);
91
+ }, []);
92
+
93
+ const handleSave = useCallback(() => {
94
+ updateMutation.mutate({
95
+ firstName: user.firstName,
96
+ lastName: user.lastName,
97
+ });
98
+ }, [user, updateMutation]);
99
+
100
+ const handleCancel = useCallback(() => {
101
+ setIsEditing(false);
102
+ }, []);
103
+
104
+ return (
105
+ <Paper sx={componentStyles.container}>
106
+ <Box sx={componentStyles.header}>
107
+ <Avatar sx={{ width: 64, height: 64 }}>
108
+ {user.firstName[0]}{user.lastName[0]}
109
+ </Avatar>
110
+ <Box>
111
+ <Typography variant='h5'>{fullName}</Typography>
112
+ <Typography color='text.secondary'>{user.email}</Typography>
113
+ </Box>
114
+ </Box>
115
+
116
+ <Box sx={componentStyles.content}>
117
+ <Typography>Username: {user.username}</Typography>
118
+ <Typography>Roles: {user.roles.join(', ')}</Typography>
119
+ </Box>
120
+
121
+ <Box sx={componentStyles.actions}>
122
+ {!isEditing ? (
123
+ <Button variant='contained' onClick={handleEdit}>
124
+ Edit Profile
125
+ </Button>
126
+ ) : (
127
+ <>
128
+ <Button
129
+ variant='contained'
130
+ onClick={handleSave}
131
+ disabled={updateMutation.isPending}
132
+ >
133
+ {updateMutation.isPending ? 'Saving...' : 'Save'}
134
+ </Button>
135
+ <Button onClick={handleCancel}>
136
+ Cancel
137
+ </Button>
138
+ </>
139
+ )}
140
+ </Box>
141
+ </Paper>
142
+ );
143
+ };
144
+
145
+ export default UserProfile;
146
+ ```
147
+
148
+ **Usage:**
149
+ ```typescript
150
+ <SuspenseLoader>
151
+ <UserProfile userId='123' onUpdate={() => console.log('Updated')} />
152
+ </SuspenseLoader>
153
+ ```
154
+
155
+ ---
156
+
157
+ ## Example 2: Complete Feature Structure
158
+
159
+ Real example based on `features/posts/`:
160
+
161
+ ```
162
+ features/
163
+ users/
164
+ api/
165
+ userApi.ts # API service layer
166
+ components/
167
+ UserProfile.tsx # Main component (from Example 1)
168
+ UserList.tsx # List component
169
+ UserBlog.tsx # Blog component
170
+ modals/
171
+ DeleteUserModal.tsx # Modal component
172
+ hooks/
173
+ useSuspenseUser.ts # Suspense query hook
174
+ useUserMutations.ts # Mutation hooks
175
+ useUserPermissions.ts # Feature-specific hook
176
+ helpers/
177
+ userHelpers.ts # Utility functions
178
+ validation.ts # Validation logic
179
+ types/
180
+ index.ts # TypeScript interfaces
181
+ index.ts # Public API exports
182
+ ```
183
+
184
+ ### API Service (userApi.ts)
185
+
186
+ ```typescript
187
+ import apiClient from '@/lib/apiClient';
188
+ import type { User, CreateUserPayload, UpdateUserPayload } from '../types';
189
+
190
+ export const userApi = {
191
+ getUser: async (userId: string): Promise<User> => {
192
+ const { data } = await apiClient.get(`/users/${userId}`);
193
+ return data;
194
+ },
195
+
196
+ getUsers: async (): Promise<User[]> => {
197
+ const { data } = await apiClient.get('/users');
198
+ return data;
199
+ },
200
+
201
+ createUser: async (payload: CreateUserPayload): Promise<User> => {
202
+ const { data } = await apiClient.post('/users', payload);
203
+ return data;
204
+ },
205
+
206
+ updateUser: async (userId: string, payload: UpdateUserPayload): Promise<User> => {
207
+ const { data } = await apiClient.put(`/users/${userId}`, payload);
208
+ return data;
209
+ },
210
+
211
+ deleteUser: async (userId: string): Promise<void> => {
212
+ await apiClient.delete(`/users/${userId}`);
213
+ },
214
+ };
215
+ ```
216
+
217
+ ### Suspense Hook (useSuspenseUser.ts)
218
+
219
+ ```typescript
220
+ import { useSuspenseQuery } from '@tanstack/react-query';
221
+ import { userApi } from '../api/userApi';
222
+ import type { User } from '../types';
223
+
224
+ export function useSuspenseUser(userId: string) {
225
+ return useSuspenseQuery<User, Error>({
226
+ queryKey: ['user', userId],
227
+ queryFn: () => userApi.getUser(userId),
228
+ staleTime: 5 * 60 * 1000,
229
+ gcTime: 10 * 60 * 1000,
230
+ });
231
+ }
232
+
233
+ export function useSuspenseUsers() {
234
+ return useSuspenseQuery<User[], Error>({
235
+ queryKey: ['users'],
236
+ queryFn: () => userApi.getUsers(),
237
+ staleTime: 1 * 60 * 1000, // Shorter for list
238
+ });
239
+ }
240
+ ```
241
+
242
+ ### Types (types/index.ts)
243
+
244
+ ```typescript
245
+ export interface User {
246
+ id: string;
247
+ username: string;
248
+ email: string;
249
+ firstName: string;
250
+ lastName: string;
251
+ roles: string[];
252
+ createdAt: string;
253
+ updatedAt: string;
254
+ }
255
+
256
+ export interface CreateUserPayload {
257
+ username: string;
258
+ email: string;
259
+ firstName: string;
260
+ lastName: string;
261
+ password: string;
262
+ }
263
+
264
+ export type UpdateUserPayload = Partial<Omit<User, 'id' | 'createdAt' | 'updatedAt'>>;
265
+ ```
266
+
267
+ ### Public Exports (index.ts)
268
+
269
+ ```typescript
270
+ // Export components
271
+ export { UserProfile } from './components/UserProfile';
272
+ export { UserList } from './components/UserList';
273
+
274
+ // Export hooks
275
+ export { useSuspenseUser, useSuspenseUsers } from './hooks/useSuspenseUser';
276
+ export { useUserMutations } from './hooks/useUserMutations';
277
+
278
+ // Export API
279
+ export { userApi } from './api/userApi';
280
+
281
+ // Export types
282
+ export type { User, CreateUserPayload, UpdateUserPayload } from './types';
283
+ ```
284
+
285
+ ---
286
+
287
+ ## Example 3: Complete Route with Lazy Loading
288
+
289
+ ```typescript
290
+ /**
291
+ * User profile route
292
+ * Path: /users/:userId
293
+ */
294
+
295
+ import { createFileRoute } from '@tanstack/react-router';
296
+ import { lazy } from 'react';
297
+ import { SuspenseLoader } from '~components/SuspenseLoader';
298
+
299
+ // Lazy load the UserProfile component
300
+ const UserProfile = lazy(() =>
301
+ import('@/features/users/components/UserProfile').then(
302
+ (module) => ({ default: module.UserProfile })
303
+ )
304
+ );
305
+
306
+ export const Route = createFileRoute('/users/$userId')({
307
+ component: UserProfilePage,
308
+ loader: ({ params }) => ({
309
+ crumb: `User ${params.userId}`,
310
+ }),
311
+ });
312
+
313
+ function UserProfilePage() {
314
+ const { userId } = Route.useParams();
315
+
316
+ return (
317
+ <SuspenseLoader>
318
+ <UserProfile
319
+ userId={userId}
320
+ onUpdate={() => console.log('Profile updated')}
321
+ />
322
+ </SuspenseLoader>
323
+ );
324
+ }
325
+
326
+ export default UserProfilePage;
327
+ ```
328
+
329
+ ---
330
+
331
+ ## Example 4: List with Search and Filtering
332
+
333
+ ```typescript
334
+ import React, { useState, useMemo } from 'react';
335
+ import { Box, TextField, List, ListItem } from '@mui/material';
336
+ import { useDebounce } from 'use-debounce';
337
+ import { useSuspenseQuery } from '@tanstack/react-query';
338
+ import { userApi } from '../api/userApi';
339
+
340
+ export const UserList: React.FC = () => {
341
+ const [searchTerm, setSearchTerm] = useState('');
342
+ const [debouncedSearch] = useDebounce(searchTerm, 300);
343
+
344
+ const { data: users } = useSuspenseQuery({
345
+ queryKey: ['users'],
346
+ queryFn: () => userApi.getUsers(),
347
+ });
348
+
349
+ // Memoized filtering
350
+ const filteredUsers = useMemo(() => {
351
+ if (!debouncedSearch) return users;
352
+
353
+ return users.filter(user =>
354
+ user.name.toLowerCase().includes(debouncedSearch.toLowerCase()) ||
355
+ user.email.toLowerCase().includes(debouncedSearch.toLowerCase())
356
+ );
357
+ }, [users, debouncedSearch]);
358
+
359
+ return (
360
+ <Box>
361
+ <TextField
362
+ value={searchTerm}
363
+ onChange={(e) => setSearchTerm(e.target.value)}
364
+ placeholder='Search users...'
365
+ fullWidth
366
+ sx={{ mb: 2 }}
367
+ />
368
+
369
+ <List>
370
+ {filteredUsers.map(user => (
371
+ <ListItem key={user.id}>
372
+ {user.name} - {user.email}
373
+ </ListItem>
374
+ ))}
375
+ </List>
376
+ </Box>
377
+ );
378
+ };
379
+ ```
380
+
381
+ ---
382
+
383
+ ## Example 5: Blog with Validation
384
+
385
+ ```typescript
386
+ import React from 'react';
387
+ import { Box, TextField, Button, Paper } from '@mui/material';
388
+ import { useBlog } from 'react-hook-blog';
389
+ import { zodResolver } from '@hookblog/resolvers/zod';
390
+ import { z } from 'zod';
391
+ import { useMutation, useQueryClient } from '@tanstack/react-query';
392
+ import { userApi } from '../api/userApi';
393
+ import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
394
+
395
+ const userSchema = z.object({
396
+ username: z.string().min(3).max(50),
397
+ email: z.string().email(),
398
+ firstName: z.string().min(1),
399
+ lastName: z.string().min(1),
400
+ });
401
+
402
+ type UserBlogData = z.infer<typeof userSchema>;
403
+
404
+ interface CreateUserBlogProps {
405
+ onSuccess?: () => void;
406
+ }
407
+
408
+ export const CreateUserBlog: React.FC<CreateUserBlogProps> = ({ onSuccess }) => {
409
+ const queryClient = useQueryClient();
410
+ const { showSuccess, showError } = useMuiSnackbar();
411
+
412
+ const { register, handleSubmit, blogState: { errors }, reset } = useBlog<UserBlogData>({
413
+ resolver: zodResolver(userSchema),
414
+ defaultValues: {
415
+ username: '',
416
+ email: '',
417
+ firstName: '',
418
+ lastName: '',
419
+ },
420
+ });
421
+
422
+ const createMutation = useMutation({
423
+ mutationFn: (data: UserBlogData) => userApi.createUser(data),
424
+
425
+ onSuccess: () => {
426
+ queryClient.invalidateQueries({ queryKey: ['users'] });
427
+ showSuccess('User created successfully');
428
+ reset();
429
+ onSuccess?.();
430
+ },
431
+
432
+ onError: () => {
433
+ showError('Failed to create user');
434
+ },
435
+ });
436
+
437
+ const onSubmit = (data: UserBlogData) => {
438
+ createMutation.mutate(data);
439
+ };
440
+
441
+ return (
442
+ <Paper sx={{ p: 3, maxWidth: 500 }}>
443
+ <blog onSubmit={handleSubmit(onSubmit)}>
444
+ <Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
445
+ <TextField
446
+ {...register('username')}
447
+ label='Username'
448
+ error={!!errors.username}
449
+ helperText={errors.username?.message}
450
+ fullWidth
451
+ />
452
+
453
+ <TextField
454
+ {...register('email')}
455
+ label='Email'
456
+ type='email'
457
+ error={!!errors.email}
458
+ helperText={errors.email?.message}
459
+ fullWidth
460
+ />
461
+
462
+ <TextField
463
+ {...register('firstName')}
464
+ label='First Name'
465
+ error={!!errors.firstName}
466
+ helperText={errors.firstName?.message}
467
+ fullWidth
468
+ />
469
+
470
+ <TextField
471
+ {...register('lastName')}
472
+ label='Last Name'
473
+ error={!!errors.lastName}
474
+ helperText={errors.lastName?.message}
475
+ fullWidth
476
+ />
477
+
478
+ <Button
479
+ type='submit'
480
+ variant='contained'
481
+ disabled={createMutation.isPending}
482
+ >
483
+ {createMutation.isPending ? 'Creating...' : 'Create User'}
484
+ </Button>
485
+ </Box>
486
+ </blog>
487
+ </Paper>
488
+ );
489
+ };
490
+
491
+ export default CreateUserBlog;
492
+ ```
493
+
494
+ ---
495
+
496
+ ## Example 2: Parent Container with Lazy Loading
497
+
498
+ ```typescript
499
+ import React from 'react';
500
+ import { Box } from '@mui/material';
501
+ import { SuspenseLoader } from '~components/SuspenseLoader';
502
+
503
+ // Lazy load heavy components
504
+ const UserList = React.lazy(() => import('./UserList'));
505
+ const UserStats = React.lazy(() => import('./UserStats'));
506
+ const ActivityFeed = React.lazy(() => import('./ActivityFeed'));
507
+
508
+ export const UserDashboard: React.FC = () => {
509
+ return (
510
+ <Box sx={{ p: 2 }}>
511
+ <SuspenseLoader>
512
+ <UserStats />
513
+ </SuspenseLoader>
514
+
515
+ <Box sx={{ display: 'flex', gap: 2, mt: 2 }}>
516
+ <Box sx={{ flex: 2 }}>
517
+ <SuspenseLoader>
518
+ <UserList />
519
+ </SuspenseLoader>
520
+ </Box>
521
+
522
+ <Box sx={{ flex: 1 }}>
523
+ <SuspenseLoader>
524
+ <ActivityFeed />
525
+ </SuspenseLoader>
526
+ </Box>
527
+ </Box>
528
+ </Box>
529
+ );
530
+ };
531
+
532
+ export default UserDashboard;
533
+ ```
534
+
535
+ **Benefits:**
536
+ - Each section loads independently
537
+ - User sees partial content sooner
538
+ - Better perceived perblogance
539
+
540
+ ---
541
+
542
+ ## Example 3: Cache-First Strategy Implementation
543
+
544
+ Complete example based on useSuspensePost.ts:
545
+
546
+ ```typescript
547
+ import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
548
+ import { postApi } from '../api/postApi';
549
+ import type { Post } from '../types';
550
+
551
+ /**
552
+ * Smart post hook with cache-first strategy
553
+ * Reuses data from grid cache when available
554
+ */
555
+ export function useSuspensePost(blogId: number, postId: number) {
556
+ const queryClient = useQueryClient();
557
+
558
+ return useSuspenseQuery<Post, Error>({
559
+ queryKey: ['post', blogId, postId],
560
+ queryFn: async () => {
561
+ // Strategy 1: Check grid cache first (avoids API call)
562
+ const gridCache = queryClient.getQueryData<{ rows: Post[] }>([
563
+ 'posts-v2',
564
+ blogId,
565
+ 'summary'
566
+ ]) || queryClient.getQueryData<{ rows: Post[] }>([
567
+ 'posts-v2',
568
+ blogId,
569
+ 'flat'
570
+ ]);
571
+
572
+ if (gridCache?.rows) {
573
+ const cached = gridCache.rows.find(
574
+ (row) => row.S_ID === postId
575
+ );
576
+
577
+ if (cached) {
578
+ return cached; // Return from cache - no API call!
579
+ }
580
+ }
581
+
582
+ // Strategy 2: Not in cache, fetch from API
583
+ return postApi.getPost(blogId, postId);
584
+ },
585
+ staleTime: 5 * 60 * 1000, // Fresh for 5 minutes
586
+ gcTime: 10 * 60 * 1000, // Cache for 10 minutes
587
+ refetchOnWindowFocus: false, // Don't refetch on focus
588
+ });
589
+ }
590
+ ```
591
+
592
+ **Why this pattern:**
593
+ - Checks grid cache before API
594
+ - Instant data if user came from grid
595
+ - Falls back to API if not cached
596
+ - Configurable cache times
597
+
598
+ ---
599
+
600
+ ## Example 4: Complete Route File
601
+
602
+ ```typescript
603
+ /**
604
+ * Project catalog route
605
+ * Path: /project-catalog
606
+ */
607
+
608
+ import { createFileRoute } from '@tanstack/react-router';
609
+ import { lazy } from 'react';
610
+
611
+ // Lazy load the PostTable component
612
+ const PostTable = lazy(() =>
613
+ import('@/features/posts/components/PostTable').then(
614
+ (module) => ({ default: module.PostTable })
615
+ )
616
+ );
617
+
618
+ // Route constants
619
+ const PROJECT_CATALOG_FORM_ID = 744;
620
+ const PROJECT_CATALOG_PROJECT_ID = 225;
621
+
622
+ export const Route = createFileRoute('/project-catalog/')({
623
+ component: ProjectCatalogPage,
624
+ loader: () => ({
625
+ crumb: 'Projects', // Breadcrumb title
626
+ }),
627
+ });
628
+
629
+ function ProjectCatalogPage() {
630
+ return (
631
+ <PostTable
632
+ blogId={PROJECT_CATALOG_FORM_ID}
633
+ projectId={PROJECT_CATALOG_PROJECT_ID}
634
+ tableType='active_projects'
635
+ title='Blog Dashboard'
636
+ />
637
+ );
638
+ }
639
+
640
+ export default ProjectCatalogPage;
641
+ ```
642
+
643
+ ---
644
+
645
+ ## Example 5: Dialog with Blog
646
+
647
+ ```typescript
648
+ import React from 'react';
649
+ import {
650
+ Dialog,
651
+ DialogTitle,
652
+ DialogContent,
653
+ DialogActions,
654
+ Button,
655
+ TextField,
656
+ Box,
657
+ IconButton,
658
+ } from '@mui/material';
659
+ import { Close, PersonAdd } from '@mui/icons-material';
660
+ import { useBlog } from 'react-hook-blog';
661
+ import { zodResolver } from '@hookblog/resolvers/zod';
662
+ import { z } from 'zod';
663
+
664
+ const blogSchema = z.object({
665
+ name: z.string().min(1),
666
+ email: z.string().email(),
667
+ });
668
+
669
+ type BlogData = z.infer<typeof blogSchema>;
670
+
671
+ interface AddUserDialogProps {
672
+ open: boolean;
673
+ onClose: () => void;
674
+ onSubmit: (data: BlogData) => Promise<void>;
675
+ }
676
+
677
+ export const AddUserDialog: React.FC<AddUserDialogProps> = ({
678
+ open,
679
+ onClose,
680
+ onSubmit,
681
+ }) => {
682
+ const { register, handleSubmit, blogState: { errors }, reset } = useBlog<BlogData>({
683
+ resolver: zodResolver(blogSchema),
684
+ });
685
+
686
+ const handleClose = () => {
687
+ reset();
688
+ onClose();
689
+ };
690
+
691
+ const handleBlogSubmit = async (data: BlogData) => {
692
+ await onSubmit(data);
693
+ handleClose();
694
+ };
695
+
696
+ return (
697
+ <Dialog open={open} onClose={handleClose} maxWidth='sm' fullWidth>
698
+ <DialogTitle>
699
+ <Box sx={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between' }}>
700
+ <Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
701
+ <PersonAdd color='primary' />
702
+ Add User
703
+ </Box>
704
+ <IconButton onClick={handleClose} size='small'>
705
+ <Close />
706
+ </IconButton>
707
+ </Box>
708
+ </DialogTitle>
709
+
710
+ <blog onSubmit={handleSubmit(handleBlogSubmit)}>
711
+ <DialogContent>
712
+ <Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
713
+ <TextField
714
+ {...register('name')}
715
+ label='Name'
716
+ error={!!errors.name}
717
+ helperText={errors.name?.message}
718
+ fullWidth
719
+ autoFocus
720
+ />
721
+
722
+ <TextField
723
+ {...register('email')}
724
+ label='Email'
725
+ type='email'
726
+ error={!!errors.email}
727
+ helperText={errors.email?.message}
728
+ fullWidth
729
+ />
730
+ </Box>
731
+ </DialogContent>
732
+
733
+ <DialogActions>
734
+ <Button onClick={handleClose}>Cancel</Button>
735
+ <Button type='submit' variant='contained'>
736
+ Add User
737
+ </Button>
738
+ </DialogActions>
739
+ </blog>
740
+ </Dialog>
741
+ );
742
+ };
743
+ ```
744
+
745
+ ---
746
+
747
+ ## Example 6: Parallel Data Fetching
748
+
749
+ ```typescript
750
+ import React from 'react';
751
+ import { Box, Grid, Paper } from '@mui/material';
752
+ import { useSuspenseQueries } from '@tanstack/react-query';
753
+ import { userApi } from '../api/userApi';
754
+ import { statsApi } from '../api/statsApi';
755
+ import { activityApi } from '../api/activityApi';
756
+
757
+ export const Dashboard: React.FC = () => {
758
+ // Fetch all data in parallel with Suspense
759
+ const [statsQuery, usersQuery, activityQuery] = useSuspenseQueries({
760
+ queries: [
761
+ {
762
+ queryKey: ['stats'],
763
+ queryFn: () => statsApi.getStats(),
764
+ },
765
+ {
766
+ queryKey: ['users', 'active'],
767
+ queryFn: () => userApi.getActiveUsers(),
768
+ },
769
+ {
770
+ queryKey: ['activity', 'recent'],
771
+ queryFn: () => activityApi.getRecent(),
772
+ },
773
+ ],
774
+ });
775
+
776
+ return (
777
+ <Box sx={{ p: 2 }}>
778
+ <Grid container spacing={2}>
779
+ <Grid size={{ xs: 12, md: 4 }}>
780
+ <Paper sx={{ p: 2 }}>
781
+ <h3>Stats</h3>
782
+ <p>Total: {statsQuery.data.total}</p>
783
+ </Paper>
784
+ </Grid>
785
+
786
+ <Grid size={{ xs: 12, md: 4 }}>
787
+ <Paper sx={{ p: 2 }}>
788
+ <h3>Active Users</h3>
789
+ <p>Count: {usersQuery.data.length}</p>
790
+ </Paper>
791
+ </Grid>
792
+
793
+ <Grid size={{ xs: 12, md: 4 }}>
794
+ <Paper sx={{ p: 2 }}>
795
+ <h3>Recent Activity</h3>
796
+ <p>Events: {activityQuery.data.length}</p>
797
+ </Paper>
798
+ </Grid>
799
+ </Grid>
800
+ </Box>
801
+ );
802
+ };
803
+
804
+ // Usage with Suspense
805
+ <SuspenseLoader>
806
+ <Dashboard />
807
+ </SuspenseLoader>
808
+ ```
809
+
810
+ ---
811
+
812
+ ## Example 7: Optimistic Update
813
+
814
+ ```typescript
815
+ import { useMutation, useQueryClient } from '@tanstack/react-query';
816
+ import type { User } from '../types';
817
+
818
+ export const useToggleUserStatus = () => {
819
+ const queryClient = useQueryClient();
820
+
821
+ return useMutation({
822
+ mutationFn: (userId: string) => userApi.toggleStatus(userId),
823
+
824
+ // Optimistic update
825
+ onMutate: async (userId) => {
826
+ // Cancel outgoing refetches
827
+ await queryClient.cancelQueries({ queryKey: ['users'] });
828
+
829
+ // Snapshot previous value
830
+ const previousUsers = queryClient.getQueryData<User[]>(['users']);
831
+
832
+ // Optimistically update UI
833
+ queryClient.setQueryData<User[]>(['users'], (old) => {
834
+ return old?.map(user =>
835
+ user.id === userId
836
+ ? { ...user, active: !user.active }
837
+ : user
838
+ ) || [];
839
+ });
840
+
841
+ return { previousUsers };
842
+ },
843
+
844
+ // Rollback on error
845
+ onError: (err, userId, context) => {
846
+ queryClient.setQueryData(['users'], context?.previousUsers);
847
+ },
848
+
849
+ // Refetch after mutation
850
+ onSettled: () => {
851
+ queryClient.invalidateQueries({ queryKey: ['users'] });
852
+ },
853
+ });
854
+ };
855
+ ```
856
+
857
+ ---
858
+
859
+ ## Summary
860
+
861
+ **Key Takeaways:**
862
+
863
+ 1. **Component Pattern**: React.FC + lazy + Suspense + useSuspenseQuery
864
+ 2. **Feature Structure**: Organized subdirectories (api/, components/, hooks/, etc.)
865
+ 3. **Routing**: Folder-based with lazy loading
866
+ 4. **Data Fetching**: useSuspenseQuery with cache-first strategy
867
+ 5. **Blogs**: React Hook Blog + Zod validation
868
+ 6. **Error Handling**: useMuiSnackbar + onError callbacks
869
+ 7. **Perblogance**: useMemo, useCallback, React.memo, debouncing
870
+ 8. **Styling**: Inline <100 lines, sx prop, MUI v7 syntax
871
+
872
872
  **See other resources for detailed explanations of each pattern.**