@zenrick/zenkit 0.0.0-stage → 0.5.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.
- package/.claude-plugin/marketplace.json +19 -0
- package/.cursor-plugin/marketplace.json +22 -0
- package/INSTALL.md +73 -0
- package/LICENSE +202 -0
- package/NOTICE +5 -0
- package/README.md +69 -3
- package/TERMS.md +48 -0
- package/THIRD-PARTY-NOTICES.md +109 -0
- package/kit/agents/backend-specialist.md +263 -0
- package/kit/agents/code-archaeologist.md +106 -0
- package/kit/agents/database-architect.md +226 -0
- package/kit/agents/debugger.md +226 -0
- package/kit/agents/devops-engineer.md +242 -0
- package/kit/agents/documentation-writer.md +104 -0
- package/kit/agents/explorer-agent.md +73 -0
- package/kit/agents/frontend-specialist.md +593 -0
- package/kit/agents/game-developer.md +162 -0
- package/kit/agents/mobile-developer.md +377 -0
- package/kit/agents/orchestrator.md +489 -0
- package/kit/agents/penetration-tester.md +188 -0
- package/kit/agents/performance-optimizer.md +187 -0
- package/kit/agents/product-manager.md +112 -0
- package/kit/agents/product-owner.md +95 -0
- package/kit/agents/project-planner.md +409 -0
- package/kit/agents/qa-automation-engineer.md +103 -0
- package/kit/agents/security-auditor.md +170 -0
- package/kit/agents/seo-specialist.md +111 -0
- package/kit/agents/test-engineer.md +158 -0
- package/kit/bundles/agent-building.yaml +26 -0
- package/kit/bundles/backend-data.yaml +14 -0
- package/kit/bundles/base.yaml +10 -0
- package/kit/bundles/core.yaml +21 -0
- package/kit/bundles/kit-engenharia.yaml +8 -0
- package/kit/bundles/kit-lite.yaml +9 -0
- package/kit/bundles/security.yaml +11 -0
- package/kit/bundles/ship-run.yaml +16 -0
- package/kit/bundles/web-ui.yaml +18 -0
- package/kit/commands/docs.md +33 -0
- package/kit/commands/explain.md +41 -0
- package/kit/commands/fix.md +65 -0
- package/kit/commands/implement.md +35 -0
- package/kit/commands/refactor.md +59 -0
- package/kit/commands/review.md +55 -0
- package/kit/commands/test.md +63 -0
- package/kit/modules/bridge/rules/cross-ide-bridge.mdc +73 -0
- package/kit/modules/bridge/zenkit-layer.yaml +1 -0
- package/kit/modules/nexuscore/sections/convivencia.md +12 -0
- package/kit/modules/nexuscore/sections/memoria.md +9 -0
- package/kit/modules/nexuscore/skills/quadro-agentes/SKILL.md +186 -0
- package/kit/modules/nexuscore/zenkit-layer.yaml +1 -0
- package/kit/rules/ZENKIT.mdc +294 -0
- package/kit/rules/git.mdc +51 -0
- package/kit/rules/karpathy-guidelines.mdc +70 -0
- package/kit/rules/model-routing.mdc +89 -0
- package/kit/rules/security-headers.mdc +41 -0
- package/kit/rules/social-automation.mdc +69 -0
- package/kit/rules/toc.mdc +40 -0
- package/kit/skills/api-patterns/SKILL.md +95 -0
- package/kit/skills/api-patterns/api-style.md +42 -0
- package/kit/skills/api-patterns/auth.md +24 -0
- package/kit/skills/api-patterns/documentation.md +26 -0
- package/kit/skills/api-patterns/graphql.md +41 -0
- package/kit/skills/api-patterns/rate-limiting.md +31 -0
- package/kit/skills/api-patterns/references/backend/backend-api-design.md +495 -0
- package/kit/skills/api-patterns/references/backend/backend-architecture.md +454 -0
- package/kit/skills/api-patterns/references/backend/backend-authentication.md +338 -0
- package/kit/skills/api-patterns/references/backend/backend-code-quality.md +659 -0
- package/kit/skills/api-patterns/references/backend/backend-debugging.md +904 -0
- package/kit/skills/api-patterns/references/backend/backend-devops.md +494 -0
- package/kit/skills/api-patterns/references/backend/backend-mindset.md +387 -0
- package/kit/skills/api-patterns/references/backend/backend-performance.md +397 -0
- package/kit/skills/api-patterns/references/backend/backend-security.md +290 -0
- package/kit/skills/api-patterns/references/backend/backend-technologies.md +256 -0
- package/kit/skills/api-patterns/references/backend/backend-testing.md +429 -0
- package/kit/skills/api-patterns/response.md +37 -0
- package/kit/skills/api-patterns/rest.md +40 -0
- package/kit/skills/api-patterns/scripts/api_validator.py +211 -0
- package/kit/skills/api-patterns/security-testing.md +122 -0
- package/kit/skills/api-patterns/trpc.md +41 -0
- package/kit/skills/api-patterns/versioning.md +22 -0
- package/kit/skills/app-builder/SKILL.md +76 -0
- package/kit/skills/app-builder/agent-coordination.md +71 -0
- package/kit/skills/app-builder/feature-building.md +53 -0
- package/kit/skills/app-builder/project-detection.md +34 -0
- package/kit/skills/app-builder/scaffolding.md +118 -0
- package/kit/skills/app-builder/tech-stack.md +41 -0
- package/kit/skills/app-builder/templates/SKILL.md +39 -0
- package/kit/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/kit/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/kit/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/kit/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/kit/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/kit/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/kit/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/kit/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/kit/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/kit/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/kit/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/kit/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/kit/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/kit/skills/architecture/SKILL.md +56 -0
- package/kit/skills/architecture/context-discovery.md +43 -0
- package/kit/skills/architecture/examples.md +94 -0
- package/kit/skills/architecture/pattern-selection.md +68 -0
- package/kit/skills/architecture/patterns-reference.md +50 -0
- package/kit/skills/architecture/trade-off-analysis.md +77 -0
- package/kit/skills/bash-linux/SKILL.md +203 -0
- package/kit/skills/batch-operations/SKILL.md +112 -0
- package/kit/skills/behavioral-modes/SKILL.md +255 -0
- package/kit/skills/brainstorming/SKILL.md +189 -0
- package/kit/skills/brainstorming/dynamic-questioning.md +350 -0
- package/kit/skills/brainstorming/references/problem-solving/attribution.md +69 -0
- package/kit/skills/brainstorming/references/problem-solving/collision-zone-thinking.md +79 -0
- package/kit/skills/brainstorming/references/problem-solving/inversion-exercise.md +91 -0
- package/kit/skills/brainstorming/references/problem-solving/meta-pattern-recognition.md +87 -0
- package/kit/skills/brainstorming/references/problem-solving/scale-game.md +95 -0
- package/kit/skills/brainstorming/references/problem-solving/simplification-cascades.md +80 -0
- package/kit/skills/brainstorming/references/problem-solving/when-stuck.md +72 -0
- package/kit/skills/claude-exec/SKILL.md +185 -0
- package/kit/skills/clean-code/SKILL.md +210 -0
- package/kit/skills/code-review-checklist/SKILL.md +115 -0
- package/kit/skills/code-review-graph/SKILL.md +50 -0
- package/kit/skills/code-review-graph/references/alternatives-comparison.md +12 -0
- package/kit/skills/code-review-graph/references/best-practices.md +9 -0
- package/kit/skills/code-review-graph/references/configuration.md +43 -0
- package/kit/skills/code-review-graph/references/core-workflows.md +61 -0
- package/kit/skills/code-review-graph/references/how-it-works-4-layers.md +20 -0
- package/kit/skills/code-review-graph/references/installation.md +67 -0
- package/kit/skills/code-review-graph/references/integration-with-zenkit.md +23 -0
- package/kit/skills/code-review-graph/references/known-limitations.md +13 -0
- package/kit/skills/code-review-graph/references/when-to-use-vs-when-to-skip.md +21 -0
- package/kit/skills/codex-exec/SKILL.md +161 -0
- package/kit/skills/context-compression/SKILL.md +145 -0
- package/kit/skills/coordinator-mode/SKILL.md +215 -0
- package/kit/skills/cursor-exec/SKILL.md +152 -0
- package/kit/skills/database-design/SKILL.md +53 -0
- package/kit/skills/database-design/database-selection.md +43 -0
- package/kit/skills/database-design/indexing.md +39 -0
- package/kit/skills/database-design/migrations.md +48 -0
- package/kit/skills/database-design/optimization.md +36 -0
- package/kit/skills/database-design/orm-selection.md +30 -0
- package/kit/skills/database-design/schema-design.md +56 -0
- package/kit/skills/database-design/scripts/schema_validator.py +172 -0
- package/kit/skills/deployment-procedures/SKILL.md +242 -0
- package/kit/skills/deprecation-and-migration/SKILL.md +149 -0
- package/kit/skills/documentation-templates/SKILL.md +195 -0
- package/kit/skills/entrega-com-agentes/SKILL.md +177 -0
- package/kit/skills/frontend-design/NOTICE.md +6 -0
- package/kit/skills/frontend-design/SKILL.md +456 -0
- package/kit/skills/frontend-design/animation-guide.md +331 -0
- package/kit/skills/frontend-design/color-system.md +311 -0
- package/kit/skills/frontend-design/decision-trees.md +418 -0
- package/kit/skills/frontend-design/motion-graphics.md +306 -0
- package/kit/skills/frontend-design/references/aesthetic/design-guideline-template.md +163 -0
- package/kit/skills/frontend-design/references/aesthetic/design-principles.md +62 -0
- package/kit/skills/frontend-design/references/aesthetic/design-resources.md +75 -0
- package/kit/skills/frontend-design/references/aesthetic/design-story-template.md +135 -0
- package/kit/skills/frontend-design/references/aesthetic/micro-interactions.md +53 -0
- package/kit/skills/frontend-design/references/aesthetic/storytelling-design.md +50 -0
- package/kit/skills/frontend-design/scripts/accessibility_checker.py +183 -0
- package/kit/skills/frontend-design/scripts/ux_audit.py +722 -0
- package/kit/skills/frontend-design/typography-system.md +345 -0
- package/kit/skills/frontend-design/ux-psychology.md +1116 -0
- package/kit/skills/frontend-design/visual-effects.md +383 -0
- package/kit/skills/game-development/2d-games/SKILL.md +119 -0
- package/kit/skills/game-development/3d-games/SKILL.md +135 -0
- package/kit/skills/game-development/SKILL.md +168 -0
- package/kit/skills/game-development/game-art/SKILL.md +185 -0
- package/kit/skills/game-development/game-audio/SKILL.md +190 -0
- package/kit/skills/game-development/game-design/SKILL.md +129 -0
- package/kit/skills/game-development/mobile-games/SKILL.md +108 -0
- package/kit/skills/game-development/multiplayer/SKILL.md +132 -0
- package/kit/skills/game-development/pc-games/SKILL.md +144 -0
- package/kit/skills/game-development/vr-ar/SKILL.md +123 -0
- package/kit/skills/game-development/web-games/SKILL.md +150 -0
- package/kit/skills/gemini-exec/SKILL.md +80 -0
- package/kit/skills/geo-fundamentals/SKILL.md +157 -0
- package/kit/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/kit/skills/git-worktrees/SKILL.md +107 -0
- package/kit/skills/i18n-localization/SKILL.md +145 -0
- package/kit/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/kit/skills/intelligent-routing/SKILL.md +128 -0
- package/kit/skills/intelligent-routing/references/4-response-format.md +16 -0
- package/kit/skills/intelligent-routing/references/complexity-assessment.md +29 -0
- package/kit/skills/intelligent-routing/references/debug-intelligent-routing.md +9 -0
- package/kit/skills/intelligent-routing/references/debugging-agent-selection.md +7 -0
- package/kit/skills/intelligent-routing/references/domain-detection-rules.md +29 -0
- package/kit/skills/intelligent-routing/references/edge-cases.md +29 -0
- package/kit/skills/intelligent-routing/references/implementation-rules.md +35 -0
- package/kit/skills/intelligent-routing/references/integration-with-existing-workflows.md +21 -0
- package/kit/skills/intelligent-routing/references/performance-considerations.md +14 -0
- package/kit/skills/intelligent-routing/references/summary.md +16 -0
- package/kit/skills/intelligent-routing/references/testing-the-system.md +36 -0
- package/kit/skills/intelligent-routing/references/tier-0-automatic-analysis-always-active.md +27 -0
- package/kit/skills/intelligent-routing/references/user-education.md +12 -0
- package/kit/skills/karpathy-guidelines/SKILL.md +67 -0
- package/kit/skills/karpathy-guidelines/references/EXAMPLES.md +522 -0
- package/kit/skills/lint-and-validate/SKILL.md +46 -0
- package/kit/skills/lint-and-validate/scripts/lint_runner.py +184 -0
- package/kit/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/kit/skills/mcp-atuacao/SKILL.md +238 -0
- package/kit/skills/mcp-builder/NOTICE.md +6 -0
- package/kit/skills/mcp-builder/SKILL.md +259 -0
- package/kit/skills/memory-system/SKILL.md +181 -0
- package/kit/skills/mobile-design/SKILL.md +395 -0
- package/kit/skills/mobile-design/decision-trees.md +516 -0
- package/kit/skills/mobile-design/mobile-backend.md +491 -0
- package/kit/skills/mobile-design/mobile-color-system.md +420 -0
- package/kit/skills/mobile-design/mobile-debugging.md +122 -0
- package/kit/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/kit/skills/mobile-design/mobile-navigation.md +458 -0
- package/kit/skills/mobile-design/mobile-performance.md +767 -0
- package/kit/skills/mobile-design/mobile-testing.md +356 -0
- package/kit/skills/mobile-design/mobile-typography.md +433 -0
- package/kit/skills/mobile-design/platform-android.md +666 -0
- package/kit/skills/mobile-design/platform-ios.md +561 -0
- package/kit/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/kit/skills/mobile-design/touch-psychology.md +537 -0
- package/kit/skills/negocio-agente-conversa/SKILL.md +168 -0
- package/kit/skills/negocio-atendimento/SKILL.md +134 -0
- package/kit/skills/negocio-linguagem/SKILL.md +166 -0
- package/kit/skills/negocio-preco/SKILL.md +174 -0
- package/kit/skills/negocio-preco/scripts/preco.mjs +160 -0
- package/kit/skills/negocio-qualificacao/SKILL.md +140 -0
- package/kit/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +351 -0
- package/kit/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/kit/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/kit/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/kit/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/kit/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/kit/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/kit/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/kit/skills/nextjs-react-expert/9-cache-components.md +103 -0
- package/kit/skills/nextjs-react-expert/SKILL.md +308 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/common-patterns.md +331 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/complete-examples.md +872 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/component-patterns.md +502 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/data-fetching.md +767 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/file-organization.md +502 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/loading-and-error-states.md +501 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/performance.md +406 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/routing-guide.md +364 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/styling-guide.md +428 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/typescript-standards.md +418 -0
- package/kit/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/kit/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/kit/skills/nodejs-best-practices/SKILL.md +78 -0
- package/kit/skills/nodejs-best-practices/references/10-anti-patterns-to-avoid.md +21 -0
- package/kit/skills/nodejs-best-practices/references/11-decision-checklist.md +14 -0
- package/kit/skills/nodejs-best-practices/references/2-runtime-considerations-2025.md +36 -0
- package/kit/skills/nodejs-best-practices/references/3-architecture-principles.md +35 -0
- package/kit/skills/nodejs-best-practices/references/4-error-handling-principles.md +42 -0
- package/kit/skills/nodejs-best-practices/references/5-async-patterns-principles.md +35 -0
- package/kit/skills/nodejs-best-practices/references/6-validation-principles.md +29 -0
- package/kit/skills/nodejs-best-practices/references/7-security-principles.md +29 -0
- package/kit/skills/nodejs-best-practices/references/8-testing-principles.md +28 -0
- package/kit/skills/observability-and-instrumentation/SKILL.md +150 -0
- package/kit/skills/opencode-go-exec/SKILL.md +101 -0
- package/kit/skills/parallel-agents/SKILL.md +184 -0
- package/kit/skills/performance-profiling/SKILL.md +145 -0
- package/kit/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/kit/skills/plan-writing/SKILL.md +213 -0
- package/kit/skills/powershell-windows/SKILL.md +196 -0
- package/kit/skills/provider-orchestration/SKILL.md +269 -0
- package/kit/skills/python-patterns/SKILL.md +80 -0
- package/kit/skills/python-patterns/references/10-decision-checklist.md +14 -0
- package/kit/skills/python-patterns/references/11-anti-patterns-to-avoid.md +20 -0
- package/kit/skills/python-patterns/references/2-async-vs-sync-decision.md +44 -0
- package/kit/skills/python-patterns/references/3-type-hints-strategy.md +56 -0
- package/kit/skills/python-patterns/references/4-project-structure-principles.md +56 -0
- package/kit/skills/python-patterns/references/5-django-principles-2025.md +40 -0
- package/kit/skills/python-patterns/references/6-fastapi-principles.md +50 -0
- package/kit/skills/python-patterns/references/7-background-tasks.md +31 -0
- package/kit/skills/python-patterns/references/8-error-handling-principles.md +29 -0
- package/kit/skills/python-patterns/references/9-testing-principles.md +37 -0
- package/kit/skills/red-team-tactics/SKILL.md +201 -0
- package/kit/skills/research/SKILL.md +166 -0
- package/kit/skills/rust-pro/SKILL.md +177 -0
- package/kit/skills/seo-fundamentals/SKILL.md +130 -0
- package/kit/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/kit/skills/sequential-thinking/.env.example +8 -0
- package/kit/skills/sequential-thinking/README.md +183 -0
- package/kit/skills/sequential-thinking/SKILL.md +95 -0
- package/kit/skills/sequential-thinking/package.json +31 -0
- package/kit/skills/sequential-thinking/references/advanced-strategies.md +79 -0
- package/kit/skills/sequential-thinking/references/advanced-techniques.md +76 -0
- package/kit/skills/sequential-thinking/references/core-patterns.md +95 -0
- package/kit/skills/sequential-thinking/references/examples-api.md +88 -0
- package/kit/skills/sequential-thinking/references/examples-architecture.md +94 -0
- package/kit/skills/sequential-thinking/references/examples-debug.md +90 -0
- package/kit/skills/sequential-thinking/scripts/format-thought.js +159 -0
- package/kit/skills/sequential-thinking/scripts/process-thought.js +236 -0
- package/kit/skills/server-management/SKILL.md +162 -0
- package/kit/skills/simplify-code/SKILL.md +133 -0
- package/kit/skills/skillify/SKILL.md +116 -0
- package/kit/skills/system-design-interview/SKILL.md +268 -0
- package/kit/skills/systematic-debugging/SKILL.md +110 -0
- package/kit/skills/tailwind-patterns/SKILL.md +283 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/canvas-design-system.md +320 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/shadcn-accessibility.md +471 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/shadcn-components.md +424 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/shadcn-theming.md +373 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/tailwind-customization.md +483 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/tailwind-responsive.md +382 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/tailwind-utilities.md +455 -0
- package/kit/skills/tdd-workflow/SKILL.md +150 -0
- package/kit/skills/testing-patterns/SKILL.md +196 -0
- package/kit/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/kit/skills/ui-ux-pro-max/SKILL.md +135 -0
- package/kit/skills/verify-changes/SKILL.md +125 -0
- package/kit/skills/vulnerability-scanner/SKILL.md +278 -0
- package/kit/skills/vulnerability-scanner/checklists.md +121 -0
- package/kit/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/kit/skills/web-design-guidelines/SKILL.md +58 -0
- package/kit/skills/webapp-testing/NOTICE.md +6 -0
- package/kit/skills/webapp-testing/SKILL.md +188 -0
- package/kit/skills/webapp-testing/scripts/playwright_runner.py +173 -0
- package/kit/workflows/brainstorm.md +113 -0
- package/kit/workflows/coordinate.md +72 -0
- package/kit/workflows/create.md +59 -0
- package/kit/workflows/debug.md +103 -0
- package/kit/workflows/deploy.md +176 -0
- package/kit/workflows/enhance.md +63 -0
- package/kit/workflows/orchestrate.md +237 -0
- package/kit/workflows/plan.md +89 -0
- package/kit/workflows/preview.md +81 -0
- package/kit/workflows/remember.md +67 -0
- package/kit/workflows/status.md +86 -0
- package/kit/workflows/test.md +144 -0
- package/kit/workflows/ui-ux-pro-max.md +296 -0
- package/kit/workflows/verify.md +72 -0
- package/licenses/Apache-2.0.txt +202 -0
- package/package.json +60 -6
- package/scripts/avaliar-vigilancia-mandato.mjs +38 -0
- package/scripts/bundle.mjs +158 -0
- package/scripts/check-deps.mjs +178 -0
- package/scripts/check-models.mjs +150 -0
- package/scripts/cli.mjs +295 -0
- package/scripts/continuidade-mandato.mjs +47 -0
- package/scripts/discriminar-turno.mjs +191 -0
- package/scripts/doctor.mjs +615 -0
- package/scripts/generate.mjs +676 -0
- package/scripts/install.mjs +11 -0
- package/scripts/layer-remote.mjs +344 -0
- package/scripts/layers.mjs +208 -0
- package/scripts/marketplace.mjs +77 -0
- package/scripts/product.mjs +32 -0
- package/scripts/ruleset-core.mjs +68 -0
- package/scripts/social-hooks.mjs +293 -0
- package/scripts/social-pacer.mjs +219 -0
- package/scripts/validate-bundles.mjs +14 -0
- package/scripts/validate-skills.mjs +174 -0
- package/scripts/zenkit-daemon-task.cmd +3 -0
|
@@ -0,0 +1,495 @@
|
|
|
1
|
+
# Backend API Design
|
|
2
|
+
|
|
3
|
+
Comprehensive guide to designing RESTful, GraphQL, and gRPC APIs with best practices (2025).
|
|
4
|
+
|
|
5
|
+
## REST API Design
|
|
6
|
+
|
|
7
|
+
### Resource-Based URLs
|
|
8
|
+
|
|
9
|
+
**Good:**
|
|
10
|
+
```
|
|
11
|
+
GET /api/v1/users # List users
|
|
12
|
+
GET /api/v1/users/:id # Get specific user
|
|
13
|
+
POST /api/v1/users # Create user
|
|
14
|
+
PUT /api/v1/users/:id # Update user (full)
|
|
15
|
+
PATCH /api/v1/users/:id # Update user (partial)
|
|
16
|
+
DELETE /api/v1/users/:id # Delete user
|
|
17
|
+
|
|
18
|
+
GET /api/v1/users/:id/posts # Get user's posts
|
|
19
|
+
POST /api/v1/users/:id/posts # Create post for user
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Bad (Avoid):**
|
|
23
|
+
```
|
|
24
|
+
GET /api/v1/getUser?id=123 # RPC-style, not RESTful
|
|
25
|
+
POST /api/v1/createUser # Verb in URL
|
|
26
|
+
GET /api/v1/user-posts # Unclear relationship
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### HTTP Status Codes (Meaningful Responses)
|
|
30
|
+
|
|
31
|
+
**Success:**
|
|
32
|
+
- `200 OK` - Successful GET, PUT, PATCH
|
|
33
|
+
- `201 Created` - Successful POST (resource created)
|
|
34
|
+
- `204 No Content` - Successful DELETE
|
|
35
|
+
|
|
36
|
+
**Client Errors:**
|
|
37
|
+
- `400 Bad Request` - Invalid input/validation error
|
|
38
|
+
- `401 Unauthorized` - Missing or invalid authentication
|
|
39
|
+
- `403 Forbidden` - Authenticated but not authorized
|
|
40
|
+
- `404 Not Found` - Resource doesn't exist
|
|
41
|
+
- `409 Conflict` - Resource conflict (duplicate email)
|
|
42
|
+
- `422 Unprocessable Entity` - Validation error (detailed)
|
|
43
|
+
- `429 Too Many Requests` - Rate limit exceeded
|
|
44
|
+
|
|
45
|
+
**Server Errors:**
|
|
46
|
+
- `500 Internal Server Error` - Generic server error
|
|
47
|
+
- `502 Bad Gateway` - Upstream service error
|
|
48
|
+
- `503 Service Unavailable` - Temporary downtime
|
|
49
|
+
- `504 Gateway Timeout` - Upstream service timeout
|
|
50
|
+
|
|
51
|
+
### Request/Response Format
|
|
52
|
+
|
|
53
|
+
**Request:**
|
|
54
|
+
```typescript
|
|
55
|
+
POST /api/v1/users
|
|
56
|
+
Content-Type: application/json
|
|
57
|
+
|
|
58
|
+
{
|
|
59
|
+
"email": "user@example.com",
|
|
60
|
+
"name": "John Doe",
|
|
61
|
+
"age": 30
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**Success Response:**
|
|
66
|
+
```typescript
|
|
67
|
+
HTTP/1.1 201 Created
|
|
68
|
+
Content-Type: application/json
|
|
69
|
+
Location: /api/v1/users/123
|
|
70
|
+
|
|
71
|
+
{
|
|
72
|
+
"id": "123",
|
|
73
|
+
"email": "user@example.com",
|
|
74
|
+
"name": "John Doe",
|
|
75
|
+
"age": 30,
|
|
76
|
+
"createdAt": "2025-01-09T12:00:00Z",
|
|
77
|
+
"updatedAt": "2025-01-09T12:00:00Z"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**Error Response:**
|
|
82
|
+
```typescript
|
|
83
|
+
HTTP/1.1 400 Bad Request
|
|
84
|
+
Content-Type: application/json
|
|
85
|
+
|
|
86
|
+
{
|
|
87
|
+
"error": {
|
|
88
|
+
"code": "VALIDATION_ERROR",
|
|
89
|
+
"message": "Invalid input data",
|
|
90
|
+
"details": [
|
|
91
|
+
{
|
|
92
|
+
"field": "email",
|
|
93
|
+
"message": "Invalid email format",
|
|
94
|
+
"value": "invalid-email"
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"field": "age",
|
|
98
|
+
"message": "Age must be between 18 and 120",
|
|
99
|
+
"value": 15
|
|
100
|
+
}
|
|
101
|
+
],
|
|
102
|
+
"timestamp": "2025-01-09T12:00:00Z",
|
|
103
|
+
"path": "/api/v1/users"
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Pagination
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
// Request
|
|
112
|
+
GET /api/v1/users?page=2&limit=50
|
|
113
|
+
|
|
114
|
+
// Response
|
|
115
|
+
{
|
|
116
|
+
"data": [...],
|
|
117
|
+
"pagination": {
|
|
118
|
+
"page": 2,
|
|
119
|
+
"limit": 50,
|
|
120
|
+
"total": 1234,
|
|
121
|
+
"totalPages": 25,
|
|
122
|
+
"hasNext": true,
|
|
123
|
+
"hasPrev": true
|
|
124
|
+
},
|
|
125
|
+
"links": {
|
|
126
|
+
"first": "/api/v1/users?page=1&limit=50",
|
|
127
|
+
"prev": "/api/v1/users?page=1&limit=50",
|
|
128
|
+
"next": "/api/v1/users?page=3&limit=50",
|
|
129
|
+
"last": "/api/v1/users?page=25&limit=50"
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Filtering and Sorting
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
GET /api/v1/users?status=active&role=admin&sort=-createdAt,name&limit=20
|
|
138
|
+
|
|
139
|
+
# Filters: status=active AND role=admin
|
|
140
|
+
# Sort: createdAt DESC, name ASC
|
|
141
|
+
# Limit: 20 results
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### API Versioning Strategies
|
|
145
|
+
|
|
146
|
+
**URL Versioning (Most Common):**
|
|
147
|
+
```
|
|
148
|
+
/api/v1/users
|
|
149
|
+
/api/v2/users
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
**Header Versioning:**
|
|
153
|
+
```
|
|
154
|
+
GET /api/users
|
|
155
|
+
Accept: application/vnd.myapi.v2+json
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
**Query Parameter:**
|
|
159
|
+
```
|
|
160
|
+
/api/users?version=2
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
**Recommendation:** URL versioning for simplicity and discoverability
|
|
164
|
+
|
|
165
|
+
## GraphQL API Design
|
|
166
|
+
|
|
167
|
+
### Schema Definition
|
|
168
|
+
|
|
169
|
+
```graphql
|
|
170
|
+
type User {
|
|
171
|
+
id: ID!
|
|
172
|
+
email: String!
|
|
173
|
+
name: String!
|
|
174
|
+
posts: [Post!]!
|
|
175
|
+
createdAt: DateTime!
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
type Post {
|
|
179
|
+
id: ID!
|
|
180
|
+
title: String!
|
|
181
|
+
content: String!
|
|
182
|
+
author: User!
|
|
183
|
+
published: Boolean!
|
|
184
|
+
createdAt: DateTime!
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
type Query {
|
|
188
|
+
user(id: ID!): User
|
|
189
|
+
users(limit: Int = 50, offset: Int = 0): [User!]!
|
|
190
|
+
post(id: ID!): Post
|
|
191
|
+
posts(authorId: ID, published: Boolean): [Post!]!
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
type Mutation {
|
|
195
|
+
createUser(input: CreateUserInput!): User!
|
|
196
|
+
updateUser(id: ID!, input: UpdateUserInput!): User!
|
|
197
|
+
deleteUser(id: ID!): Boolean!
|
|
198
|
+
|
|
199
|
+
createPost(input: CreatePostInput!): Post!
|
|
200
|
+
publishPost(id: ID!): Post!
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
input CreateUserInput {
|
|
204
|
+
email: String!
|
|
205
|
+
name: String!
|
|
206
|
+
password: String!
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
input UpdateUserInput {
|
|
210
|
+
email: String
|
|
211
|
+
name: String
|
|
212
|
+
}
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Queries
|
|
216
|
+
|
|
217
|
+
```graphql
|
|
218
|
+
# Flexible data fetching - client specifies exactly what they need
|
|
219
|
+
query {
|
|
220
|
+
user(id: "123") {
|
|
221
|
+
id
|
|
222
|
+
name
|
|
223
|
+
email
|
|
224
|
+
posts {
|
|
225
|
+
id
|
|
226
|
+
title
|
|
227
|
+
published
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
# With variables
|
|
233
|
+
query GetUser($userId: ID!) {
|
|
234
|
+
user(id: $userId) {
|
|
235
|
+
id
|
|
236
|
+
name
|
|
237
|
+
posts(published: true) {
|
|
238
|
+
title
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Mutations
|
|
245
|
+
|
|
246
|
+
```graphql
|
|
247
|
+
mutation CreateUser($input: CreateUserInput!) {
|
|
248
|
+
createUser(input: $input) {
|
|
249
|
+
id
|
|
250
|
+
email
|
|
251
|
+
name
|
|
252
|
+
createdAt
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
# Variables
|
|
257
|
+
{
|
|
258
|
+
"input": {
|
|
259
|
+
"email": "user@example.com",
|
|
260
|
+
"name": "John Doe",
|
|
261
|
+
"password": "SecurePass123!"
|
|
262
|
+
}
|
|
263
|
+
}
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Resolvers (NestJS Example)
|
|
267
|
+
|
|
268
|
+
```typescript
|
|
269
|
+
@Resolver(() => User)
|
|
270
|
+
export class UserResolver {
|
|
271
|
+
constructor(
|
|
272
|
+
private userService: UserService,
|
|
273
|
+
private postService: PostService,
|
|
274
|
+
) {}
|
|
275
|
+
|
|
276
|
+
@Query(() => User, { nullable: true })
|
|
277
|
+
async user(@Args('id') id: string) {
|
|
278
|
+
return this.userService.findById(id);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
@Query(() => [User])
|
|
282
|
+
async users(
|
|
283
|
+
@Args('limit', { defaultValue: 50 }) limit: number,
|
|
284
|
+
@Args('offset', { defaultValue: 0 }) offset: number,
|
|
285
|
+
) {
|
|
286
|
+
return this.userService.findAll({ limit, offset });
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
@Mutation(() => User)
|
|
290
|
+
async createUser(@Args('input') input: CreateUserInput) {
|
|
291
|
+
return this.userService.create(input);
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
// Field resolver - lazy load posts
|
|
295
|
+
@ResolveField(() => [Post])
|
|
296
|
+
async posts(@Parent() user: User) {
|
|
297
|
+
return this.postService.findByAuthorId(user.id);
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
### GraphQL Best Practices
|
|
303
|
+
|
|
304
|
+
1. **Avoid N+1 Problem** - Use DataLoader
|
|
305
|
+
```typescript
|
|
306
|
+
import DataLoader from 'dataloader';
|
|
307
|
+
|
|
308
|
+
const postLoader = new DataLoader(async (authorIds: string[]) => {
|
|
309
|
+
const posts = await db.posts.findAll({ where: { authorId: authorIds } });
|
|
310
|
+
return authorIds.map(id => posts.filter(p => p.authorId === id));
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
// In resolver
|
|
314
|
+
@ResolveField(() => [Post])
|
|
315
|
+
async posts(@Parent() user: User) {
|
|
316
|
+
return this.postLoader.load(user.id);
|
|
317
|
+
}
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
2. **Pagination** - Relay-style cursor pagination
|
|
321
|
+
3. **Error Handling** - Return errors in response
|
|
322
|
+
4. **Depth Limiting** - Prevent deeply nested queries
|
|
323
|
+
5. **Query Complexity Analysis** - Limit expensive queries
|
|
324
|
+
|
|
325
|
+
## gRPC API Design
|
|
326
|
+
|
|
327
|
+
### Protocol Buffers Schema
|
|
328
|
+
|
|
329
|
+
```protobuf
|
|
330
|
+
syntax = "proto3";
|
|
331
|
+
|
|
332
|
+
package user;
|
|
333
|
+
|
|
334
|
+
service UserService {
|
|
335
|
+
rpc GetUser (GetUserRequest) returns (User);
|
|
336
|
+
rpc ListUsers (ListUsersRequest) returns (ListUsersResponse);
|
|
337
|
+
rpc CreateUser (CreateUserRequest) returns (User);
|
|
338
|
+
rpc UpdateUser (UpdateUserRequest) returns (User);
|
|
339
|
+
rpc DeleteUser (DeleteUserRequest) returns (DeleteUserResponse);
|
|
340
|
+
|
|
341
|
+
// Streaming
|
|
342
|
+
rpc StreamUsers (StreamUsersRequest) returns (stream User);
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
message User {
|
|
346
|
+
string id = 1;
|
|
347
|
+
string email = 2;
|
|
348
|
+
string name = 3;
|
|
349
|
+
int64 created_at = 4;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
message GetUserRequest {
|
|
353
|
+
string id = 1;
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
message ListUsersRequest {
|
|
357
|
+
int32 limit = 1;
|
|
358
|
+
int32 offset = 2;
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
message ListUsersResponse {
|
|
362
|
+
repeated User users = 1;
|
|
363
|
+
int32 total = 2;
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
message CreateUserRequest {
|
|
367
|
+
string email = 1;
|
|
368
|
+
string name = 2;
|
|
369
|
+
string password = 3;
|
|
370
|
+
}
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Implementation (Node.js)
|
|
374
|
+
|
|
375
|
+
```typescript
|
|
376
|
+
import * as grpc from '@grpc/grpc-js';
|
|
377
|
+
import * as protoLoader from '@grpc/proto-loader';
|
|
378
|
+
|
|
379
|
+
const packageDefinition = protoLoader.loadSync('user.proto');
|
|
380
|
+
const userProto = grpc.loadPackageDefinition(packageDefinition).user;
|
|
381
|
+
|
|
382
|
+
// Server implementation
|
|
383
|
+
const server = new grpc.Server();
|
|
384
|
+
|
|
385
|
+
server.addService(userProto.UserService.service, {
|
|
386
|
+
async getUser(call, callback) {
|
|
387
|
+
const user = await userService.findById(call.request.id);
|
|
388
|
+
callback(null, user);
|
|
389
|
+
},
|
|
390
|
+
|
|
391
|
+
async createUser(call, callback) {
|
|
392
|
+
const user = await userService.create(call.request);
|
|
393
|
+
callback(null, user);
|
|
394
|
+
},
|
|
395
|
+
|
|
396
|
+
async streamUsers(call) {
|
|
397
|
+
const users = await userService.findAll();
|
|
398
|
+
for (const user of users) {
|
|
399
|
+
call.write(user);
|
|
400
|
+
}
|
|
401
|
+
call.end();
|
|
402
|
+
},
|
|
403
|
+
});
|
|
404
|
+
|
|
405
|
+
server.bindAsync(
|
|
406
|
+
'0.0.0.0:50051',
|
|
407
|
+
grpc.ServerCredentials.createInsecure(),
|
|
408
|
+
() => server.start()
|
|
409
|
+
);
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
### gRPC Benefits
|
|
413
|
+
|
|
414
|
+
- **Performance:** 7-10x faster than REST (binary protocol)
|
|
415
|
+
- **Streaming:** Bi-directional streaming
|
|
416
|
+
- **Type Safety:** Strong typing via Protocol Buffers
|
|
417
|
+
- **Code Generation:** Auto-generate client/server code
|
|
418
|
+
- **Best For:** Internal microservices, high-performance systems
|
|
419
|
+
|
|
420
|
+
## API Design Decision Matrix
|
|
421
|
+
|
|
422
|
+
| Feature | REST | GraphQL | gRPC |
|
|
423
|
+
|---------|------|---------|------|
|
|
424
|
+
| **Use Case** | Public APIs, CRUD | Flexible data fetching | Microservices, performance |
|
|
425
|
+
| **Performance** | Moderate | Moderate | Fastest (7-10x REST) |
|
|
426
|
+
| **Caching** | HTTP caching built-in | Complex | No built-in caching |
|
|
427
|
+
| **Browser Support** | Native | Native | Requires gRPC-Web |
|
|
428
|
+
| **Learning Curve** | Easy | Moderate | Steep |
|
|
429
|
+
| **Streaming** | Limited (SSE) | Subscriptions | Bi-directional |
|
|
430
|
+
| **Tooling** | Excellent | Excellent | Good |
|
|
431
|
+
| **Documentation** | OpenAPI/Swagger | Schema introspection | Protobuf definition |
|
|
432
|
+
|
|
433
|
+
## API Security Checklist
|
|
434
|
+
|
|
435
|
+
- [ ] HTTPS/TLS only (no HTTP)
|
|
436
|
+
- [ ] Authentication (OAuth 2.1, JWT, API keys)
|
|
437
|
+
- [ ] Authorization (RBAC, check permissions)
|
|
438
|
+
- [ ] Rate limiting (prevent abuse)
|
|
439
|
+
- [ ] Input validation (all endpoints)
|
|
440
|
+
- [ ] CORS configured properly
|
|
441
|
+
- [ ] Security headers (CSP, HSTS, X-Frame-Options)
|
|
442
|
+
- [ ] API versioning implemented
|
|
443
|
+
- [ ] Error messages don't leak system info
|
|
444
|
+
- [ ] Audit logging (who did what, when)
|
|
445
|
+
|
|
446
|
+
## API Documentation
|
|
447
|
+
|
|
448
|
+
### OpenAPI/Swagger (REST)
|
|
449
|
+
|
|
450
|
+
```yaml
|
|
451
|
+
openapi: 3.0.0
|
|
452
|
+
info:
|
|
453
|
+
title: User API
|
|
454
|
+
version: 1.0.0
|
|
455
|
+
paths:
|
|
456
|
+
/api/v1/users:
|
|
457
|
+
get:
|
|
458
|
+
summary: List users
|
|
459
|
+
parameters:
|
|
460
|
+
- name: limit
|
|
461
|
+
in: query
|
|
462
|
+
schema:
|
|
463
|
+
type: integer
|
|
464
|
+
default: 50
|
|
465
|
+
responses:
|
|
466
|
+
'200':
|
|
467
|
+
description: Successful response
|
|
468
|
+
content:
|
|
469
|
+
application/json:
|
|
470
|
+
schema:
|
|
471
|
+
type: object
|
|
472
|
+
properties:
|
|
473
|
+
data:
|
|
474
|
+
type: array
|
|
475
|
+
items:
|
|
476
|
+
$ref: '#/components/schemas/User'
|
|
477
|
+
components:
|
|
478
|
+
schemas:
|
|
479
|
+
User:
|
|
480
|
+
type: object
|
|
481
|
+
properties:
|
|
482
|
+
id:
|
|
483
|
+
type: string
|
|
484
|
+
email:
|
|
485
|
+
type: string
|
|
486
|
+
name:
|
|
487
|
+
type: string
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
## Resources
|
|
491
|
+
|
|
492
|
+
- **REST Best Practices:** https://restfulapi.net/
|
|
493
|
+
- **GraphQL:** https://graphql.org/learn/
|
|
494
|
+
- **gRPC:** https://grpc.io/docs/
|
|
495
|
+
- **OpenAPI:** https://swagger.io/specification/
|