nexakit 0.0.0-stage → 0.2.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 +28 -0
- package/LICENSE +26 -0
- package/README.md +79 -2
- package/agents/claude/docs-researcher.md +9 -0
- package/agents/claude/implementation-tutor.md +9 -0
- package/agents/claude/project-explorer.md +9 -0
- package/agents/claude/quality-reviewer.md +9 -0
- package/agents/claude/requirements-analyst.md +9 -0
- package/agents/claude/solution-architect.md +9 -0
- package/agents/codex/docs-researcher.toml +10 -0
- package/agents/codex/implementation-tutor.toml +10 -0
- package/agents/codex/project-explorer.toml +10 -0
- package/agents/codex/quality-reviewer.toml +10 -0
- package/agents/codex/requirements-analyst.toml +11 -0
- package/agents/codex/solution-architect.toml +10 -0
- package/assets/brand/README.md +38 -0
- package/assets/brand/agent-toolkit-mark.png +0 -0
- package/assets/brand/agent-toolkit-mark.svg +13 -0
- package/assets/brand/agent-toolkit-tui-hero.png +0 -0
- package/assets/brand/nexakit-readme-hero.png +0 -0
- package/assets/brand/nexakit-readme-hero.svg +21 -0
- package/assets/runtime/package-lock.json +1425 -0
- package/bin/agent-task.js +14 -0
- package/bin/agent-toolkit-gemini.js +13 -0
- package/bin/agent-toolkit-inbox.js +14 -0
- package/bin/agent-toolkit-mcp.js +17 -0
- package/bin/agent-toolkit.js +13 -0
- package/bin/nexakit.js +13 -0
- package/bin/project-memory-mcp.js +22 -0
- package/bin/project-memory.js +7 -0
- package/catalogs/skills/api-design-principles/LICENSE.txt +21 -0
- package/catalogs/skills/api-design-principles/SKILL.md +110 -0
- package/catalogs/skills/api-design-principles/assets/api-design-checklist.md +155 -0
- package/catalogs/skills/api-design-principles/assets/rest-api-template.py +185 -0
- package/catalogs/skills/api-design-principles/references/details.md +413 -0
- package/catalogs/skills/api-design-principles/references/graphql-schema-design.md +589 -0
- package/catalogs/skills/api-design-principles/references/rest-best-practices.md +408 -0
- package/catalogs/skills/nodejs-backend-patterns/LICENSE.txt +21 -0
- package/catalogs/skills/nodejs-backend-patterns/SKILL.md +45 -0
- package/catalogs/skills/nodejs-backend-patterns/references/advanced-patterns.md +430 -0
- package/catalogs/skills/nodejs-backend-patterns/references/details.md +599 -0
- package/catalogs/skills/supabase-postgres-best-practices/CHANGELOG.md +73 -0
- package/catalogs/skills/supabase-postgres-best-practices/LICENSE.txt +21 -0
- package/catalogs/skills/supabase-postgres-best-practices/SKILL.md +64 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/_contributing.md +170 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/_sections.md +39 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/_template.md +34 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/advanced-full-text-search.md +55 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/advanced-jsonb-indexing.md +49 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/conn-idle-timeout.md +46 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/conn-limits.md +44 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/conn-pooling.md +41 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/conn-prepared-statements.md +46 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/data-batch-inserts.md +54 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/data-n-plus-one.md +53 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/data-pagination.md +50 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/data-upsert.md +50 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/lock-advisory.md +56 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/lock-deadlock-prevention.md +68 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/lock-short-transactions.md +50 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/lock-skip-locked.md +54 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/monitor-explain-analyze.md +45 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/monitor-pg-stat-statements.md +55 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/monitor-vacuum-analyze.md +55 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/query-composite-indexes.md +44 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/query-covering-indexes.md +40 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/query-index-types.md +48 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/query-missing-indexes.md +43 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/query-partial-indexes.md +45 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/schema-constraints.md +80 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/schema-data-types.md +46 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/schema-foreign-key-indexes.md +59 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/schema-lowercase-identifiers.md +55 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/schema-partitioning.md +55 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/schema-primary-keys.md +61 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/security-privileges.md +54 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/security-rls-basics.md +50 -0
- package/catalogs/skills/supabase-postgres-best-practices/references/security-rls-performance.md +63 -0
- package/catalogs/skills/vercel-composition-patterns/AGENTS.md +946 -0
- package/catalogs/skills/vercel-composition-patterns/LICENSE.txt +27 -0
- package/catalogs/skills/vercel-composition-patterns/README.md +60 -0
- package/catalogs/skills/vercel-composition-patterns/SKILL.md +89 -0
- package/catalogs/skills/vercel-composition-patterns/metadata.json +11 -0
- package/catalogs/skills/vercel-composition-patterns/rules/_sections.md +29 -0
- package/catalogs/skills/vercel-composition-patterns/rules/_template.md +24 -0
- package/catalogs/skills/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/catalogs/skills/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
- package/catalogs/skills/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/catalogs/skills/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/catalogs/skills/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/catalogs/skills/vercel-composition-patterns/rules/state-context-interface.md +191 -0
- package/catalogs/skills/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/catalogs/skills/vercel-composition-patterns/rules/state-lift-state.md +125 -0
- package/catalogs/skills/vercel-react-best-practices/AGENTS.md +3810 -0
- package/catalogs/skills/vercel-react-best-practices/LICENSE.txt +27 -0
- package/catalogs/skills/vercel-react-best-practices/README.md +123 -0
- package/catalogs/skills/vercel-react-best-practices/SKILL.md +149 -0
- package/catalogs/skills/vercel-react-best-practices/metadata.json +15 -0
- package/catalogs/skills/vercel-react-best-practices/rules/_sections.md +46 -0
- package/catalogs/skills/vercel-react-best-practices/rules/_template.md +28 -0
- package/catalogs/skills/vercel-react-best-practices/rules/advanced-effect-event-deps.md +56 -0
- package/catalogs/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/catalogs/skills/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
- package/catalogs/skills/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
- package/catalogs/skills/vercel-react-best-practices/rules/async-api-routes.md +38 -0
- package/catalogs/skills/vercel-react-best-practices/rules/async-cheap-condition-before-await.md +37 -0
- package/catalogs/skills/vercel-react-best-practices/rules/async-defer-await.md +82 -0
- package/catalogs/skills/vercel-react-best-practices/rules/async-dependencies.md +51 -0
- package/catalogs/skills/vercel-react-best-practices/rules/async-parallel.md +28 -0
- package/catalogs/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/catalogs/skills/vercel-react-best-practices/rules/bundle-analyzable-paths.md +63 -0
- package/catalogs/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +60 -0
- package/catalogs/skills/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
- package/catalogs/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/catalogs/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/catalogs/skills/vercel-react-best-practices/rules/bundle-preload.md +50 -0
- package/catalogs/skills/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
- package/catalogs/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/catalogs/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/catalogs/skills/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-early-exit.md +50 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-flatmap-filter.md +60 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-index-maps.md +37 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-request-idle-callback.md +105 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/catalogs/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-activity.md +26 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-resource-hints.md +85 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-script-defer-async.md +68 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-memo.md +44 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-no-inline-components.md +82 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-split-combined-hooks.md +64 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-use-deferred-value.md +59 -0
- package/catalogs/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-cache-react.md +76 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-hoist-static-io.md +149 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-no-shared-module-state.md +50 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-parallel-nested-fetching.md +34 -0
- package/catalogs/skills/vercel-react-best-practices/rules/server-serialization.md +38 -0
- package/catalogs/skills/webapp-testing/LICENSE.txt +202 -0
- package/catalogs/skills/webapp-testing/SKILL.md +96 -0
- package/catalogs/skills/webapp-testing/examples/console_logging.py +35 -0
- package/catalogs/skills/webapp-testing/examples/element_discovery.py +40 -0
- package/catalogs/skills/webapp-testing/examples/static_html_automation.py +33 -0
- package/catalogs/skills/webapp-testing/scripts/with_server.py +106 -0
- package/catalogs/skills.json +1115 -0
- package/docs/skills/evidencias/2026-10-28-evaluacion-inicial-mcp-seguridad.md +118 -0
- package/docs/skills/evidencias/2026-10-28-incorporacion-mcp-seguridad.json +152 -0
- package/docs/skills/evidencias/2026-10-28-recomendador-preparacion.md +50 -0
- package/package.json +73 -4
- package/plugins/nexakit-modelo/.claude-plugin/plugin.json +1 -0
- package/plugins/nexakit-modelo/hooks/hooks.json +1 -0
- package/plugins/nexakit-modelo/hooks/register.js +48 -0
- package/plugins/nexakit-modelo/hooks/status.js +8 -0
- package/plugins/nexakit-modelo/tests/register.test.ts +21 -0
- package/plugins/nexakit-panel/.claude-plugin/plugin.json +1 -0
- package/plugins/nexakit-panel/README.md +20 -0
- package/plugins/nexakit-panel/hooks/hooks.json +1 -0
- package/plugins/nexakit-panel/hooks/lienzo.js +382 -0
- package/plugins/nexakit-panel/hooks/panel.js +279 -0
- package/plugins/nexakit-panel/hooks/register.tsx +248 -0
- package/plugins/nexakit-panel/tests/lienzo.test.ts +142 -0
- package/plugins/nexakit-panel/tests/panel.test.ts +240 -0
- package/plugins/nexakit-panel/tests/register.test.ts +167 -0
- package/plugins/nexakit-panel/types/index.d.ts +41 -0
- package/plugins/nexakit-sesion/.claude-plugin/plugin.json +1 -0
- package/plugins/nexakit-sesion/README.md +12 -0
- package/plugins/nexakit-sesion/hooks/aviso.js +38 -0
- package/plugins/nexakit-sesion/hooks/hooks.json +1 -0
- package/plugins/nexakit-sesion/hooks/register.js +28 -0
- package/plugins/nexakit-sesion/tests/register.test.ts +96 -0
- package/plugins/niveles/.claude-plugin/plugin.json +5 -0
- package/plugins/niveles/agents/nivel-alto.md +13 -0
- package/plugins/niveles/agents/nivel-exigente.md +13 -0
- package/plugins/niveles/agents/nivel-ligero.md +13 -0
- package/plugins/niveles/agents/nivel-normal.md +13 -0
- package/schemas/agent-client-adapter.schema.json +786 -0
- package/schemas/agent-client-auth-diagnostic.schema.json +801 -0
- package/schemas/agent-client-isolated-variant.schema.json +105 -0
- package/schemas/agent-client-isolated-verification.schema.json +99 -0
- package/schemas/agent-client-managed-preferences-invocation.schema.json +67 -0
- package/schemas/agent-client-managed-preferences.schema.json +63 -0
- package/schemas/agent-client-native-diagnostics.schema.json +85 -0
- package/schemas/agent-client-native-evaluation.schema.json +171 -0
- package/schemas/agent-client-native-preflight.schema.json +90 -0
- package/schemas/agent-client-output.schema.json +551 -0
- package/schemas/agent-client-runtime-fixture.schema.json +90 -0
- package/schemas/agent-client-runtime-local.schema.json +95 -0
- package/schemas/agent-client-runtime.schema.json +1288 -0
- package/schemas/agent-client-selective-config.schema.json +77 -0
- package/schemas/agent-client-supervised-local.schema.json +135 -0
- package/schemas/agent-client-supervised.schema.json +186 -0
- package/schemas/agent-model-preference.schema.json +573 -0
- package/schemas/agent-model-selection.schema.json +311 -0
- package/schemas/agent-task-approvals.schema.json +362 -0
- package/schemas/agent-task-prepare.schema.json +1324 -0
- package/schemas/agent-task-verify.schema.json +198 -0
- package/schemas/project-memory-update.schema.json +33 -0
- package/schemas/project-memory.schema.json +298 -0
- package/schemas/skill-catalog.schema.json +246 -0
- package/schemas/task-workflow-plan-output.schema.json +35 -0
- package/scripts/prepare-package.js +6 -0
- package/scripts/validate-skill-catalog.js +41 -0
- package/skills/cerrar-avisens/SKILL.md +12 -0
- package/skills/cerrar-memoria/SKILL.md +96 -0
- package/skills/cerrar-memoria/references/cierre.md +76 -0
- package/skills/decision-records/SKILL.md +27 -0
- package/skills/decision-records/agents/openai.yaml +7 -0
- package/skills/decision-records/references/adr-template.md +35 -0
- package/skills/differential-review/LICENSE.txt +427 -0
- package/skills/differential-review/SKILL.md +225 -0
- package/skills/differential-review/adversarial.md +203 -0
- package/skills/differential-review/agents/openai.yaml +6 -0
- package/skills/differential-review/assets/trail-of-bits-mark.svg +1 -0
- package/skills/differential-review/methodology.md +234 -0
- package/skills/differential-review/patterns.md +300 -0
- package/skills/differential-review/reporting.md +369 -0
- package/skills/elegir-modelo/SKILL.md +68 -0
- package/skills/elegir-modelo/modelos.mjs +108 -0
- package/skills/frontend-design/LICENSE.txt +177 -0
- package/skills/frontend-design/SKILL.md +71 -0
- package/skills/gemini/SKILL.md +52 -0
- package/skills/imagen/SKILL.md +12 -0
- package/skills/investigar/SKILL.md +11 -0
- package/skills/mcp-builder/LICENSE.txt +202 -0
- package/skills/mcp-builder/SKILL.md +236 -0
- package/skills/mcp-builder/reference/evaluation.md +602 -0
- package/skills/mcp-builder/reference/mcp_best_practices.md +249 -0
- package/skills/mcp-builder/reference/node_mcp_server.md +970 -0
- package/skills/mcp-builder/reference/python_mcp_server.md +719 -0
- package/skills/mcp-builder/scripts/connections.py +151 -0
- package/skills/mcp-builder/scripts/evaluation.py +373 -0
- package/skills/mcp-builder/scripts/example_evaluation.xml +22 -0
- package/skills/mcp-builder/scripts/requirements.txt +2 -0
- package/skills/ordenar-proyecto/SKILL.md +56 -0
- package/skills/project-handoff/SKILL.md +53 -0
- package/skills/project-handoff/agents/openai.yaml +7 -0
- package/skills/project-handoff/references/handoff-template.md +35 -0
- package/skills/quality-gate/LICENSE.txt +26 -0
- package/skills/quality-gate/SKILL.md +44 -0
- package/skills/quality-gate/agents/openai.yaml +7 -0
- package/skills/quality-gate/references/review-checklist.md +42 -0
- package/skills/revisar/SKILL.md +11 -0
- package/skills/revisar-skill/LICENSE-find-skills.txt +26 -0
- package/skills/revisar-skill/SKILL.md +94 -0
- package/skills/revision-cruzada/SKILL.md +59 -0
- package/skills/web-design-guidelines/AGENTS.md +156 -0
- package/skills/web-design-guidelines/LICENSE.txt +21 -0
- package/skills/web-design-guidelines/SKILL.md +29 -0
- package/src/agent-models.js +131 -0
- package/src/brand.js +117 -0
- package/src/claude-code-runner.js +642 -0
- package/src/cli-executable.js +88 -0
- package/src/cli.js +778 -0
- package/src/client-adapter-plan.js +271 -0
- package/src/client-auth-diagnostic-parser.js +211 -0
- package/src/client-auth-diagnostic.js +257 -0
- package/src/client-isolated-variant.js +106 -0
- package/src/client-isolated-verification.js +130 -0
- package/src/client-local-platform.js +14 -0
- package/src/client-managed-preferences-invocation.js +209 -0
- package/src/client-managed-preferences.js +78 -0
- package/src/client-native-access.js +134 -0
- package/src/client-native-diagnostics.js +253 -0
- package/src/client-native-evaluation.js +106 -0
- package/src/client-native-preflight-files.js +68 -0
- package/src/client-native-preflight.js +95 -0
- package/src/client-output-json.js +118 -0
- package/src/client-output-parser.js +278 -0
- package/src/client-runtime-admission.js +80 -0
- package/src/client-runtime-coordinator.js +70 -0
- package/src/client-runtime-core.js +92 -0
- package/src/client-runtime-fixture-permit.js +20 -0
- package/src/client-runtime-fixture-protocol.js +39 -0
- package/src/client-runtime-state.js +67 -0
- package/src/client-runtime-store-files.js +91 -0
- package/src/client-runtime-store.js +239 -0
- package/src/client-runtime-supervisor.js +146 -0
- package/src/client-selective-config.js +195 -0
- package/src/client-selective-files.js +126 -0
- package/src/client-supervised-codes.js +32 -0
- package/src/client-supervised-contract.js +52 -0
- package/src/client-supervised-coordinator.js +36 -0
- package/src/client-supervised-permit.js +20 -0
- package/src/client-supervised-protocol.js +37 -0
- package/src/client-supervised-store.js +167 -0
- package/src/client-supervised-supervisor.js +167 -0
- package/src/client-supervised.js +160 -0
- package/src/codex-cli-runner.js +358 -0
- package/src/codex-delivery.js +101 -0
- package/src/connect.js +703 -0
- package/src/doctor.js +795 -0
- package/src/gemini-cli.js +76 -0
- package/src/gemini-files.js +45 -0
- package/src/gemini-tools.js +249 -0
- package/src/init.js +473 -0
- package/src/install-lock.js +127 -0
- package/src/install-registry.js +61 -0
- package/src/legacy-repair.js +71 -0
- package/src/level-agents.js +111 -0
- package/src/link-states.js +172 -0
- package/src/memory-connection-artifacts.js +192 -0
- package/src/memory-connection-descriptor.js +158 -0
- package/src/memory-connection-diagnostic.js +177 -0
- package/src/memory-connection-files.js +191 -0
- package/src/memory-connection-manifest.js +118 -0
- package/src/memory-connection-package.js +176 -0
- package/src/memory-connection-plan.js +211 -0
- package/src/memory-connection-skill.js +211 -0
- package/src/memory-connection-toml.js +153 -0
- package/src/memory-locator.js +118 -0
- package/src/memory-mcp-policy.js +181 -0
- package/src/memory-mcp-server.js +166 -0
- package/src/memory-mcp-transport.js +59 -0
- package/src/missing-dependencies.js +21 -0
- package/src/model-command.js +147 -0
- package/src/model-preference.js +235 -0
- package/src/model-selection.js +368 -0
- package/src/native/managed-preferences.c +100 -0
- package/src/native/managed-preferences.h +17 -0
- package/src/package-lock-path.js +13 -0
- package/src/panel-cli.js +182 -0
- package/src/peer-handoff.js +27 -0
- package/src/peer-inbox-cli.js +211 -0
- package/src/peer-review-mcp.js +210 -0
- package/src/peer-review-store.js +532 -0
- package/src/platform.js +24 -0
- package/src/project-root.js +41 -0
- package/src/project-signals.js +339 -0
- package/src/recommend-report.js +77 -0
- package/src/review-instructions.js +211 -0
- package/src/review-policy.js +35 -0
- package/src/revision-adapters.js +157 -0
- package/src/revision-context.js +86 -0
- package/src/revision-isolation.js +222 -0
- package/src/revision-process.js +103 -0
- package/src/revision-provenance.js +89 -0
- package/src/revision-snapshot.js +120 -0
- package/src/revision.js +242 -0
- package/src/runtime-fixtures/runtime-supervisor/child.cjs +3 -0
- package/src/runtime-fixtures/runtime-supervisor/fixture.cjs +49 -0
- package/src/runtime-fixtures/supervised/child.cjs +3 -0
- package/src/runtime-fixtures/supervised/fixture.cjs +47 -0
- package/src/sensitive-data.js +21 -0
- package/src/setup-apply.js +231 -0
- package/src/setup-plan.js +231 -0
- package/src/setup-state.js +277 -0
- package/src/setup-tui.js +555 -0
- package/src/skill-catalog-add.js +91 -0
- package/src/skill-catalog-audit.js +68 -0
- package/src/skill-catalog.js +170 -0
- package/src/skill-files.js +39 -0
- package/src/skill-recommendations.js +1673 -0
- package/src/skill-scan-report.js +14 -0
- package/src/skill-scan.js +178 -0
- package/src/stable-command.js +53 -0
- package/src/stable-install.js +222 -0
- package/src/status.js +200 -0
- package/src/superpowers.js +133 -0
- package/src/sync-apply.js +227 -0
- package/src/sync-files.js +109 -0
- package/src/sync-inspect.js +394 -0
- package/src/sync-ledger.js +94 -0
- package/src/sync-markdown.js +151 -0
- package/src/sync-proposal.js +84 -0
- package/src/sync-record.js +459 -0
- package/src/sync.js +360 -0
- package/src/task-approvals.js +367 -0
- package/src/task-cli.js +79 -0
- package/src/task-external-verifier.js +584 -0
- package/src/task-prepare-files.js +115 -0
- package/src/task-prepare.js +180 -0
- package/src/task-verify-cli.js +67 -0
- package/src/task-verify-files.js +188 -0
- package/src/task-verify.js +118 -0
- package/src/task-workflow-mcp.js +544 -0
- package/src/task-workflow-store.js +254 -0
- package/src/terminal-text.js +68 -0
- package/src/toolkit-cli.js +543 -0
- package/src/toolkit-commands-guide.js +107 -0
- package/src/toolkit-setup.js +614 -0
- package/src/usage-metrics.js +43 -0
- package/templates/agent-team/01-encargo.md +158 -0
- package/templates/agent-team/02-propuesta.md +132 -0
- package/templates/agent-team/03-revision.md +150 -0
- package/templates/agent-team/README.md +213 -0
- package/templates/model-inventory/01-inventario.md +154 -0
- package/templates/model-inventory/README.md +115 -0
- package/templates/project-memory/README.md +67 -0
- package/templates/project-memory/project-memory.example.json +53 -0
- package/templates/project-memory/skill/project-id/SKILL.md +37 -0
- package/templates/project-memory/skill/project-id/references/project-profile.md +44 -0
- package/templates/project-memory/vault/00-INICIO/Estado actual.md +44 -0
- package/templates/project-memory/vault/00-INICIO/Fuentes de verdad.md +30 -0
- package/templates/project-memory/vault/00-INICIO/Inicio del proyecto.md +44 -0
- package/templates/project-memory/vault/00-INICIO/Mantenimiento de la memoria.md +26 -0
- package/templates/project-memory/vault/00-INICIO/Mapa de la memoria.md +33 -0
- package/templates/project-memory/vault/00-INICIO/Registro de sincronizaci/303/263n.md" +28 -0
- package/templates/project-memory/vault/01-PRODUCTO/Producto.md +16 -0
- package/templates/project-memory/vault/02-ARQUITECTURA/Arquitectura.md +16 -0
- package/templates/project-memory/vault/03-IMPLEMENTACION/Implementaci/303/263n.md +15 -0
- package/templates/project-memory/vault/04-DECISIONES/Decisiones.md +19 -0
- package/templates/project-memory/vault/05-ENTREGAS/Entregas.md +12 -0
- package/templates/project-memory/vault/06-OPERACION/Operaci/303/263n.md +15 -0
- package/templates/project-memory/vault/07-AGENTES/Protocolo de agentes.md +33 -0
- package/templates/project-memory/vault/08-RECURSOS/Recursos.md +12 -0
- package/templates/project-memory/vault/09-ARCHIVO/README.md +5 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { loadWithDependencyCheck } from "../src/missing-dependencies.js";
|
|
3
|
+
|
|
4
|
+
const cli = await loadWithDependencyCheck(() => import("../src/task-cli.js"));
|
|
5
|
+
if (cli) {
|
|
6
|
+
const write = (stream, text) => new Promise((resolve, reject) => stream.write(text, error => error ? reject(error) : resolve()));
|
|
7
|
+
// Catch stream errors such as EPIPE without a raw stack or a retry.
|
|
8
|
+
process.stdout.on("error", () => {});
|
|
9
|
+
process.stderr.on("error", () => {});
|
|
10
|
+
process.exitCode = await cli.runTaskCli(process.argv.slice(2), {
|
|
11
|
+
out: text => write(process.stdout, text),
|
|
12
|
+
err: text => write(process.stderr, text)
|
|
13
|
+
});
|
|
14
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { loadWithDependencyCheck } from "../src/missing-dependencies.js";
|
|
3
|
+
|
|
4
|
+
const cli = await loadWithDependencyCheck(() => import("../src/gemini-cli.js"));
|
|
5
|
+
if (cli) {
|
|
6
|
+
const write = (stream, text) => new Promise((resolve, reject) => stream.write(text, error => error ? reject(error) : resolve()));
|
|
7
|
+
process.stdout.on("error", () => {});
|
|
8
|
+
process.stderr.on("error", () => {});
|
|
9
|
+
process.exitCode = await cli.runGeminiCli(process.argv.slice(2), {
|
|
10
|
+
out: text => write(process.stdout, text),
|
|
11
|
+
err: text => write(process.stderr, text)
|
|
12
|
+
});
|
|
13
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { loadWithDependencyCheck } from "../src/missing-dependencies.js";
|
|
3
|
+
|
|
4
|
+
const cli = await loadWithDependencyCheck(() => import("../src/peer-inbox-cli.js"));
|
|
5
|
+
if (cli) {
|
|
6
|
+
const write = (stream, text) => new Promise((resolve, reject) => stream.write(text, error => error ? reject(error) : resolve()));
|
|
7
|
+
// Catch stream errors such as EPIPE without a raw stack or a retry.
|
|
8
|
+
process.stdout.on("error", () => {});
|
|
9
|
+
process.stderr.on("error", () => {});
|
|
10
|
+
process.exitCode = await cli.runPeerInboxCli(process.argv.slice(2), {
|
|
11
|
+
out: text => write(process.stdout, text),
|
|
12
|
+
err: text => write(process.stderr, text)
|
|
13
|
+
});
|
|
14
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { loadWithDependencyCheck } from "../src/missing-dependencies.js";
|
|
3
|
+
|
|
4
|
+
const modules = await loadWithDependencyCheck(async () => {
|
|
5
|
+
const [{ serveStdio }, { createTaskWorkflowMcp }] = await Promise.all([
|
|
6
|
+
import("@modelcontextprotocol/server/stdio"),
|
|
7
|
+
import("../src/task-workflow-mcp.js")
|
|
8
|
+
]);
|
|
9
|
+
return { serveStdio, createTaskWorkflowMcp };
|
|
10
|
+
});
|
|
11
|
+
if (modules) {
|
|
12
|
+
modules.serveStdio(() => modules.createTaskWorkflowMcp(), {
|
|
13
|
+
onerror() {
|
|
14
|
+
process.stderr.write("agent-toolkit-mcp: error de conexión MCP\n");
|
|
15
|
+
}
|
|
16
|
+
});
|
|
17
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { loadWithDependencyCheck } from '../src/missing-dependencies.js';
|
|
3
|
+
const cli = await loadWithDependencyCheck(() => import('../src/toolkit-cli.js'));
|
|
4
|
+
if (cli) {
|
|
5
|
+
process.stdout.on('error', () => {});
|
|
6
|
+
process.stderr.on('error', () => {});
|
|
7
|
+
process.exitCode = await cli.runToolkitCli(process.argv.slice(2), {
|
|
8
|
+
out: t => process.stdout.write(t),
|
|
9
|
+
err: t => process.stderr.write(t),
|
|
10
|
+
input: process.stdin,
|
|
11
|
+
output: process.stdout
|
|
12
|
+
});
|
|
13
|
+
}
|
package/bin/nexakit.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { loadWithDependencyCheck } from '../src/missing-dependencies.js';
|
|
3
|
+
const cli = await loadWithDependencyCheck(() => import('../src/toolkit-cli.js'));
|
|
4
|
+
if (cli) {
|
|
5
|
+
process.stdout.on('error', () => {});
|
|
6
|
+
process.stderr.on('error', () => {});
|
|
7
|
+
process.exitCode = await cli.runToolkitCli(process.argv.slice(2), {
|
|
8
|
+
out: t => process.stdout.write(t),
|
|
9
|
+
err: t => process.stderr.write(t),
|
|
10
|
+
input: process.stdin,
|
|
11
|
+
output: process.stdout
|
|
12
|
+
});
|
|
13
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { loadWithDependencyCheck } from "../src/missing-dependencies.js";
|
|
4
|
+
|
|
5
|
+
const args = process.argv.slice(2);
|
|
6
|
+
if (args.length === 1 && ["--help", "-h"].includes(args[0])) {
|
|
7
|
+
process.stdout.write("project-memory-mcp --manifest <ruta-absoluta>\nMCP STDIO de lectura con raíz fija. No configura clientes ni ejecuta IA.\n");
|
|
8
|
+
} else if (args.length !== 2 || args[0] !== "--manifest" || !path.isAbsolute(args[1])) {
|
|
9
|
+
process.stderr.write("project-memory-mcp: RG_INPUT_INVALID\n"); process.exitCode = 2;
|
|
10
|
+
} else {
|
|
11
|
+
const mcp = await loadWithDependencyCheck(() => import("../src/memory-mcp-server.js"));
|
|
12
|
+
if (mcp) {
|
|
13
|
+
const controller = new AbortController(), stop = () => controller.abort();
|
|
14
|
+
process.once("SIGTERM", stop); process.once("SIGINT", stop);
|
|
15
|
+
try {
|
|
16
|
+
await mcp.runMemoryMcp(args[1], { signal: controller.signal });
|
|
17
|
+
} catch (error) {
|
|
18
|
+
const code = /^RG_[A-Z_]+$/.test(error?.code ?? "") ? error.code : "RG_START_FAILED";
|
|
19
|
+
process.stderr.write(`project-memory-mcp: ${code}\n`); process.exitCode = 2;
|
|
20
|
+
} finally { process.off("SIGTERM", stop); process.off("SIGINT", stop); }
|
|
21
|
+
}
|
|
22
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Seth Hobson
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: api-design-principles
|
|
3
|
+
description: Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# API Design Principles
|
|
7
|
+
|
|
8
|
+
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
|
|
9
|
+
|
|
10
|
+
## When to Use This Skill
|
|
11
|
+
|
|
12
|
+
- Designing new REST or GraphQL APIs
|
|
13
|
+
- Refactoring existing APIs for better usability
|
|
14
|
+
- Establishing API design standards for your team
|
|
15
|
+
- Reviewing API specifications before implementation
|
|
16
|
+
- Migrating between API paradigms (REST to GraphQL, etc.)
|
|
17
|
+
- Creating developer-friendly API documentation
|
|
18
|
+
- Optimizing APIs for specific use cases (mobile, third-party integrations)
|
|
19
|
+
|
|
20
|
+
## Core Concepts
|
|
21
|
+
|
|
22
|
+
### 1. RESTful Design Principles
|
|
23
|
+
|
|
24
|
+
**Resource-Oriented Architecture**
|
|
25
|
+
|
|
26
|
+
- Resources are nouns (users, orders, products), not verbs
|
|
27
|
+
- Use HTTP methods for actions (GET, POST, PUT, PATCH, DELETE)
|
|
28
|
+
- URLs represent resource hierarchies
|
|
29
|
+
- Consistent naming conventions
|
|
30
|
+
|
|
31
|
+
**HTTP Methods Semantics:**
|
|
32
|
+
|
|
33
|
+
- `GET`: Retrieve resources (idempotent, safe)
|
|
34
|
+
- `POST`: Create new resources
|
|
35
|
+
- `PUT`: Replace entire resource (idempotent)
|
|
36
|
+
- `PATCH`: Partial resource updates
|
|
37
|
+
- `DELETE`: Remove resources (idempotent)
|
|
38
|
+
|
|
39
|
+
### 2. GraphQL Design Principles
|
|
40
|
+
|
|
41
|
+
**Schema-First Development**
|
|
42
|
+
|
|
43
|
+
- Types define your domain model
|
|
44
|
+
- Queries for reading data
|
|
45
|
+
- Mutations for modifying data
|
|
46
|
+
- Subscriptions for real-time updates
|
|
47
|
+
|
|
48
|
+
**Query Structure:**
|
|
49
|
+
|
|
50
|
+
- Clients request exactly what they need
|
|
51
|
+
- Single endpoint, multiple operations
|
|
52
|
+
- Strongly typed schema
|
|
53
|
+
- Introspection built-in
|
|
54
|
+
|
|
55
|
+
### 3. API Versioning Strategies
|
|
56
|
+
|
|
57
|
+
**URL Versioning:**
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
/api/v1/users
|
|
61
|
+
/api/v2/users
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Header Versioning:**
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
Accept: application/vnd.api+json; version=1
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
**Query Parameter Versioning:**
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
/api/users?version=1
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Detailed patterns and worked examples
|
|
77
|
+
|
|
78
|
+
Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.
|
|
79
|
+
|
|
80
|
+
## Best Practices
|
|
81
|
+
|
|
82
|
+
### REST APIs
|
|
83
|
+
|
|
84
|
+
1. **Consistent Naming**: Use plural nouns for collections (`/users`, not `/user`)
|
|
85
|
+
2. **Stateless**: Each request contains all necessary information
|
|
86
|
+
3. **Use HTTP Status Codes Correctly**: 2xx success, 4xx client errors, 5xx server errors
|
|
87
|
+
4. **Version Your API**: Plan for breaking changes from day one
|
|
88
|
+
5. **Pagination**: Always paginate large collections
|
|
89
|
+
6. **Rate Limiting**: Protect your API with rate limits
|
|
90
|
+
7. **Documentation**: Use OpenAPI/Swagger for interactive docs
|
|
91
|
+
|
|
92
|
+
### GraphQL APIs
|
|
93
|
+
|
|
94
|
+
1. **Schema First**: Design schema before writing resolvers
|
|
95
|
+
2. **Avoid N+1**: Use DataLoaders for efficient data fetching
|
|
96
|
+
3. **Input Validation**: Validate at schema and resolver levels
|
|
97
|
+
4. **Error Handling**: Return structured errors in mutation payloads
|
|
98
|
+
5. **Pagination**: Use cursor-based pagination (Relay spec)
|
|
99
|
+
6. **Deprecation**: Use `@deprecated` directive for gradual migration
|
|
100
|
+
7. **Monitoring**: Track query complexity and execution time
|
|
101
|
+
|
|
102
|
+
## Common Pitfalls
|
|
103
|
+
|
|
104
|
+
- **Over-fetching/Under-fetching (REST)**: Fixed in GraphQL but requires DataLoaders
|
|
105
|
+
- **Breaking Changes**: Version APIs or use deprecation strategies
|
|
106
|
+
- **Inconsistent Error Formats**: Standardize error responses
|
|
107
|
+
- **Missing Rate Limits**: APIs without limits are vulnerable to abuse
|
|
108
|
+
- **Poor Documentation**: Undocumented APIs frustrate developers
|
|
109
|
+
- **Ignoring HTTP Semantics**: POST for idempotent operations breaks expectations
|
|
110
|
+
- **Tight Coupling**: API structure shouldn't mirror database schema
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# API Design Checklist
|
|
2
|
+
|
|
3
|
+
## Pre-Implementation Review
|
|
4
|
+
|
|
5
|
+
### Resource Design
|
|
6
|
+
|
|
7
|
+
- [ ] Resources are nouns, not verbs
|
|
8
|
+
- [ ] Plural names for collections
|
|
9
|
+
- [ ] Consistent naming across all endpoints
|
|
10
|
+
- [ ] Clear resource hierarchy (avoid deep nesting >2 levels)
|
|
11
|
+
- [ ] All CRUD operations properly mapped to HTTP methods
|
|
12
|
+
|
|
13
|
+
### HTTP Methods
|
|
14
|
+
|
|
15
|
+
- [ ] GET for retrieval (safe, idempotent)
|
|
16
|
+
- [ ] POST for creation
|
|
17
|
+
- [ ] PUT for full replacement (idempotent)
|
|
18
|
+
- [ ] PATCH for partial updates
|
|
19
|
+
- [ ] DELETE for removal (idempotent)
|
|
20
|
+
|
|
21
|
+
### Status Codes
|
|
22
|
+
|
|
23
|
+
- [ ] 200 OK for successful GET/PATCH/PUT
|
|
24
|
+
- [ ] 201 Created for POST
|
|
25
|
+
- [ ] 204 No Content for DELETE
|
|
26
|
+
- [ ] 400 Bad Request for malformed requests
|
|
27
|
+
- [ ] 401 Unauthorized for missing auth
|
|
28
|
+
- [ ] 403 Forbidden for insufficient permissions
|
|
29
|
+
- [ ] 404 Not Found for missing resources
|
|
30
|
+
- [ ] 422 Unprocessable Entity for validation errors
|
|
31
|
+
- [ ] 429 Too Many Requests for rate limiting
|
|
32
|
+
- [ ] 500 Internal Server Error for server issues
|
|
33
|
+
|
|
34
|
+
### Pagination
|
|
35
|
+
|
|
36
|
+
- [ ] All collection endpoints paginated
|
|
37
|
+
- [ ] Default page size defined (e.g., 20)
|
|
38
|
+
- [ ] Maximum page size enforced (e.g., 100)
|
|
39
|
+
- [ ] Pagination metadata included (total, pages, etc.)
|
|
40
|
+
- [ ] Cursor-based or offset-based pattern chosen
|
|
41
|
+
|
|
42
|
+
### Filtering & Sorting
|
|
43
|
+
|
|
44
|
+
- [ ] Query parameters for filtering
|
|
45
|
+
- [ ] Sort parameter supported
|
|
46
|
+
- [ ] Search parameter for full-text search
|
|
47
|
+
- [ ] Field selection supported (sparse fieldsets)
|
|
48
|
+
|
|
49
|
+
### Versioning
|
|
50
|
+
|
|
51
|
+
- [ ] Versioning strategy defined (URL/header/query)
|
|
52
|
+
- [ ] Version included in all endpoints
|
|
53
|
+
- [ ] Deprecation policy documented
|
|
54
|
+
|
|
55
|
+
### Error Handling
|
|
56
|
+
|
|
57
|
+
- [ ] Consistent error response format
|
|
58
|
+
- [ ] Detailed error messages
|
|
59
|
+
- [ ] Field-level validation errors
|
|
60
|
+
- [ ] Error codes for client handling
|
|
61
|
+
- [ ] Timestamps in error responses
|
|
62
|
+
|
|
63
|
+
### Authentication & Authorization
|
|
64
|
+
|
|
65
|
+
- [ ] Authentication method defined (Bearer token, API key)
|
|
66
|
+
- [ ] Authorization checks on all endpoints
|
|
67
|
+
- [ ] 401 vs 403 used correctly
|
|
68
|
+
- [ ] Token expiration handled
|
|
69
|
+
|
|
70
|
+
### Rate Limiting
|
|
71
|
+
|
|
72
|
+
- [ ] Rate limits defined per endpoint/user
|
|
73
|
+
- [ ] Rate limit headers included
|
|
74
|
+
- [ ] 429 status code for exceeded limits
|
|
75
|
+
- [ ] Retry-After header provided
|
|
76
|
+
|
|
77
|
+
### Documentation
|
|
78
|
+
|
|
79
|
+
- [ ] OpenAPI/Swagger spec generated
|
|
80
|
+
- [ ] All endpoints documented
|
|
81
|
+
- [ ] Request/response examples provided
|
|
82
|
+
- [ ] Error responses documented
|
|
83
|
+
- [ ] Authentication flow documented
|
|
84
|
+
|
|
85
|
+
### Testing
|
|
86
|
+
|
|
87
|
+
- [ ] Unit tests for business logic
|
|
88
|
+
- [ ] Integration tests for endpoints
|
|
89
|
+
- [ ] Error scenarios tested
|
|
90
|
+
- [ ] Edge cases covered
|
|
91
|
+
- [ ] Performance tests for heavy endpoints
|
|
92
|
+
|
|
93
|
+
### Security
|
|
94
|
+
|
|
95
|
+
- [ ] Input validation on all fields
|
|
96
|
+
- [ ] SQL injection prevention
|
|
97
|
+
- [ ] XSS prevention
|
|
98
|
+
- [ ] CORS configured correctly
|
|
99
|
+
- [ ] HTTPS enforced
|
|
100
|
+
- [ ] Sensitive data not in URLs
|
|
101
|
+
- [ ] No secrets in responses
|
|
102
|
+
|
|
103
|
+
### Performance
|
|
104
|
+
|
|
105
|
+
- [ ] Database queries optimized
|
|
106
|
+
- [ ] N+1 queries prevented
|
|
107
|
+
- [ ] Caching strategy defined
|
|
108
|
+
- [ ] Cache headers set appropriately
|
|
109
|
+
- [ ] Large responses paginated
|
|
110
|
+
|
|
111
|
+
### Monitoring
|
|
112
|
+
|
|
113
|
+
- [ ] Logging implemented
|
|
114
|
+
- [ ] Error tracking configured
|
|
115
|
+
- [ ] Performance metrics collected
|
|
116
|
+
- [ ] Health check endpoint available
|
|
117
|
+
- [ ] Alerts configured for errors
|
|
118
|
+
|
|
119
|
+
## GraphQL-Specific Checks
|
|
120
|
+
|
|
121
|
+
### Schema Design
|
|
122
|
+
|
|
123
|
+
- [ ] Schema-first approach used
|
|
124
|
+
- [ ] Types properly defined
|
|
125
|
+
- [ ] Non-null vs nullable decided
|
|
126
|
+
- [ ] Interfaces/unions used appropriately
|
|
127
|
+
- [ ] Custom scalars defined
|
|
128
|
+
|
|
129
|
+
### Queries
|
|
130
|
+
|
|
131
|
+
- [ ] Query depth limiting
|
|
132
|
+
- [ ] Query complexity analysis
|
|
133
|
+
- [ ] DataLoaders prevent N+1
|
|
134
|
+
- [ ] Pagination pattern chosen (Relay/offset)
|
|
135
|
+
|
|
136
|
+
### Mutations
|
|
137
|
+
|
|
138
|
+
- [ ] Input types defined
|
|
139
|
+
- [ ] Payload types with errors
|
|
140
|
+
- [ ] Optimistic response support
|
|
141
|
+
- [ ] Idempotency considered
|
|
142
|
+
|
|
143
|
+
### Performance
|
|
144
|
+
|
|
145
|
+
- [ ] DataLoader for all relationships
|
|
146
|
+
- [ ] Query batching enabled
|
|
147
|
+
- [ ] Persisted queries considered
|
|
148
|
+
- [ ] Response caching implemented
|
|
149
|
+
|
|
150
|
+
### Documentation
|
|
151
|
+
|
|
152
|
+
- [ ] All fields documented
|
|
153
|
+
- [ ] Deprecations marked
|
|
154
|
+
- [ ] Examples provided
|
|
155
|
+
- [ ] Schema introspection enabled
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Production-ready REST API template using FastAPI.
|
|
3
|
+
Includes pagination, filtering, error handling, and best practices.
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
from fastapi import FastAPI, HTTPException, Query, Path, Depends, status
|
|
7
|
+
from fastapi.middleware.cors import CORSMiddleware
|
|
8
|
+
from fastapi.middleware.trustedhost import TrustedHostMiddleware
|
|
9
|
+
from fastapi.responses import JSONResponse
|
|
10
|
+
from pydantic import BaseModel, Field, EmailStr, ConfigDict
|
|
11
|
+
from typing import Optional, List, Any
|
|
12
|
+
from datetime import datetime
|
|
13
|
+
from enum import Enum
|
|
14
|
+
|
|
15
|
+
app = FastAPI(
|
|
16
|
+
title="API Template",
|
|
17
|
+
version="1.0.0",
|
|
18
|
+
docs_url="/api/docs"
|
|
19
|
+
)
|
|
20
|
+
|
|
21
|
+
# Security Middleware
|
|
22
|
+
# Trusted Host: Prevents HTTP Host Header attacks
|
|
23
|
+
app.add_middleware(
|
|
24
|
+
TrustedHostMiddleware,
|
|
25
|
+
allowed_hosts=["*"] # TODO: Configure this in production, e.g. ["api.example.com"]
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
# CORS: Configures Cross-Origin Resource Sharing
|
|
29
|
+
app.add_middleware(
|
|
30
|
+
CORSMiddleware,
|
|
31
|
+
allow_origins=["*"], # TODO: Update this with specific origins in production
|
|
32
|
+
allow_credentials=False, # TODO: Set to True if you need cookies/auth headers, but restrict origins
|
|
33
|
+
allow_methods=["*"],
|
|
34
|
+
allow_headers=["*"],
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
# Models
|
|
38
|
+
class UserStatus(str, Enum):
|
|
39
|
+
ACTIVE = "active"
|
|
40
|
+
INACTIVE = "inactive"
|
|
41
|
+
SUSPENDED = "suspended"
|
|
42
|
+
|
|
43
|
+
class UserBase(BaseModel):
|
|
44
|
+
email: EmailStr
|
|
45
|
+
name: str = Field(..., min_length=1, max_length=100)
|
|
46
|
+
status: UserStatus = UserStatus.ACTIVE
|
|
47
|
+
|
|
48
|
+
class UserCreate(UserBase):
|
|
49
|
+
password: str = Field(..., min_length=8)
|
|
50
|
+
|
|
51
|
+
class UserUpdate(BaseModel):
|
|
52
|
+
email: Optional[EmailStr] = None
|
|
53
|
+
name: Optional[str] = Field(None, min_length=1, max_length=100)
|
|
54
|
+
status: Optional[UserStatus] = None
|
|
55
|
+
|
|
56
|
+
class User(UserBase):
|
|
57
|
+
id: str
|
|
58
|
+
created_at: datetime
|
|
59
|
+
updated_at: datetime
|
|
60
|
+
|
|
61
|
+
model_config = ConfigDict(from_attributes=True)
|
|
62
|
+
|
|
63
|
+
# Pagination
|
|
64
|
+
class PaginationParams(BaseModel):
|
|
65
|
+
page: int = Field(1, ge=1)
|
|
66
|
+
page_size: int = Field(20, ge=1, le=100)
|
|
67
|
+
|
|
68
|
+
class PaginatedResponse(BaseModel):
|
|
69
|
+
items: List[Any]
|
|
70
|
+
total: int
|
|
71
|
+
page: int
|
|
72
|
+
page_size: int
|
|
73
|
+
pages: int
|
|
74
|
+
|
|
75
|
+
# Error handling
|
|
76
|
+
class ErrorDetail(BaseModel):
|
|
77
|
+
field: Optional[str] = None
|
|
78
|
+
message: str
|
|
79
|
+
code: str
|
|
80
|
+
|
|
81
|
+
class ErrorResponse(BaseModel):
|
|
82
|
+
error: str
|
|
83
|
+
message: str
|
|
84
|
+
details: Optional[List[ErrorDetail]] = None
|
|
85
|
+
|
|
86
|
+
@app.exception_handler(HTTPException)
|
|
87
|
+
async def http_exception_handler(request, exc):
|
|
88
|
+
return JSONResponse(
|
|
89
|
+
status_code=exc.status_code,
|
|
90
|
+
content=ErrorResponse(
|
|
91
|
+
error=exc.__class__.__name__,
|
|
92
|
+
message=exc.detail if isinstance(exc.detail, str) else exc.detail.get("message", "Error"),
|
|
93
|
+
details=exc.detail.get("details") if isinstance(exc.detail, dict) else None
|
|
94
|
+
).model_dump()
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
# Endpoints
|
|
98
|
+
@app.get("/api/users", response_model=PaginatedResponse, tags=["Users"])
|
|
99
|
+
async def list_users(
|
|
100
|
+
page: int = Query(1, ge=1),
|
|
101
|
+
page_size: int = Query(20, ge=1, le=100),
|
|
102
|
+
status: Optional[UserStatus] = Query(None),
|
|
103
|
+
search: Optional[str] = Query(None)
|
|
104
|
+
):
|
|
105
|
+
"""List users with pagination and filtering."""
|
|
106
|
+
# Mock implementation
|
|
107
|
+
total = 100
|
|
108
|
+
items = [
|
|
109
|
+
User(
|
|
110
|
+
id=str(i),
|
|
111
|
+
email=f"user{i}@example.com",
|
|
112
|
+
name=f"User {i}",
|
|
113
|
+
status=UserStatus.ACTIVE,
|
|
114
|
+
created_at=datetime.now(),
|
|
115
|
+
updated_at=datetime.now()
|
|
116
|
+
).model_dump()
|
|
117
|
+
for i in range((page-1)*page_size, min(page*page_size, total))
|
|
118
|
+
]
|
|
119
|
+
|
|
120
|
+
return PaginatedResponse(
|
|
121
|
+
items=items,
|
|
122
|
+
total=total,
|
|
123
|
+
page=page,
|
|
124
|
+
page_size=page_size,
|
|
125
|
+
pages=(total + page_size - 1) // page_size
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
@app.post("/api/users", response_model=User, status_code=status.HTTP_201_CREATED, tags=["Users"])
|
|
129
|
+
async def create_user(user: UserCreate):
|
|
130
|
+
"""Create a new user."""
|
|
131
|
+
# Mock implementation
|
|
132
|
+
return User(
|
|
133
|
+
id="123",
|
|
134
|
+
email=user.email,
|
|
135
|
+
name=user.name,
|
|
136
|
+
status=user.status,
|
|
137
|
+
created_at=datetime.now(),
|
|
138
|
+
updated_at=datetime.now()
|
|
139
|
+
)
|
|
140
|
+
|
|
141
|
+
@app.get("/api/users/{user_id}", response_model=User, tags=["Users"])
|
|
142
|
+
async def get_user(user_id: str = Path(..., description="User ID")):
|
|
143
|
+
"""Get user by ID."""
|
|
144
|
+
# Mock: Check if exists
|
|
145
|
+
if user_id == "999":
|
|
146
|
+
raise HTTPException(
|
|
147
|
+
status_code=status.HTTP_404_NOT_FOUND,
|
|
148
|
+
detail={
|
|
149
|
+
"message": "User not found",
|
|
150
|
+
"details": [{"field": "user_id", "message": f"No user with ID {user_id}", "code": "not_found"}],
|
|
151
|
+
}
|
|
152
|
+
)
|
|
153
|
+
|
|
154
|
+
return User(
|
|
155
|
+
id=user_id,
|
|
156
|
+
email="user@example.com",
|
|
157
|
+
name="User Name",
|
|
158
|
+
status=UserStatus.ACTIVE,
|
|
159
|
+
created_at=datetime.now(),
|
|
160
|
+
updated_at=datetime.now()
|
|
161
|
+
)
|
|
162
|
+
|
|
163
|
+
@app.patch("/api/users/{user_id}", response_model=User, tags=["Users"])
|
|
164
|
+
async def update_user(user_id: str, update: UserUpdate):
|
|
165
|
+
"""Partially update user."""
|
|
166
|
+
# Validate user exists
|
|
167
|
+
existing = await get_user(user_id)
|
|
168
|
+
|
|
169
|
+
# Apply updates
|
|
170
|
+
update_data = update.model_dump(exclude_unset=True)
|
|
171
|
+
for field, value in update_data.items():
|
|
172
|
+
setattr(existing, field, value)
|
|
173
|
+
|
|
174
|
+
existing.updated_at = datetime.now()
|
|
175
|
+
return existing
|
|
176
|
+
|
|
177
|
+
@app.delete("/api/users/{user_id}", status_code=status.HTTP_204_NO_CONTENT, tags=["Users"])
|
|
178
|
+
async def delete_user(user_id: str):
|
|
179
|
+
"""Delete user."""
|
|
180
|
+
await get_user(user_id) # Verify exists
|
|
181
|
+
return None
|
|
182
|
+
|
|
183
|
+
if __name__ == "__main__":
|
|
184
|
+
import uvicorn
|
|
185
|
+
uvicorn.run(app, host="0.0.0.0", port=8000)
|