@punks/cli 0.1.16 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +10 -0
- package/README.md +64 -0
- package/dist/data/AGENTS.md +123 -0
- package/dist/data/catalog/lint.ts +349 -0
- package/dist/data/catalog/packs.ts +44 -0
- package/dist/data/catalog/skills.ts +47 -0
- package/dist/data/catalog/tools.ts +22 -0
- package/dist/data/hooks/format-edited-file.mjs +554 -0
- package/dist/data/hooks/format-edited-file.py +157 -0
- package/dist/data/hooks/format-edited-file.sh +37 -0
- package/dist/data/hooks/require-tests-for-pr.mjs +144 -0
- package/dist/data/scripts/sync-subagents.mjs +420 -0
- package/dist/data/subagents/manifest.mjs +253 -0
- package/dist/index.js +46415 -0
- package/dist/skills/agnostic/backend/backend-domain-structure/SKILL.md +50 -0
- package/dist/skills/agnostic/backend/backend-domain-structure/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/backend/backend-domain-structure/references/layout.md +167 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/SKILL.md +49 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/references/strategy-matrix.md +34 -0
- package/dist/skills/agnostic/backend/backend-recoverable-actions/references/test-matrix.md +34 -0
- package/dist/skills/agnostic/docs/docs-maintenance/SKILL.md +193 -0
- package/dist/skills/agnostic/docs/docs-maintenance/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/docs/docs-maintenance/references/concept-pages.md +48 -0
- package/dist/skills/agnostic/docs/docs-maintenance/references/flow-pages.md +41 -0
- package/dist/skills/agnostic/frontend/agent-browser/.clawdhub/origin.json +7 -0
- package/dist/skills/agnostic/frontend/agent-browser/SKILL.md +229 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/authentication.md +202 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/commands.md +259 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/proxy-support.md +188 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/session-management.md +193 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/snapshot-refs.md +194 -0
- package/dist/skills/agnostic/frontend/agent-browser/references/video-recording.md +173 -0
- package/dist/skills/agnostic/frontend/agent-browser/templates/authenticated-session.sh +97 -0
- package/dist/skills/agnostic/frontend/agent-browser/templates/capture-workflow.sh +69 -0
- package/dist/skills/agnostic/frontend/agent-browser/templates/form-automation.sh +62 -0
- package/dist/skills/agnostic/frontend/design-taste-frontend/SKILL.md +226 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/SKILL.md +55 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/references/react/structure.md +102 -0
- package/dist/skills/agnostic/frontend/frontend-domain-structure/references/structure.md +257 -0
- package/dist/skills/agnostic/frontend/gpt-taste/SKILL.md +74 -0
- package/dist/skills/agnostic/frontend/image-taste-frontend/SKILL.md +1102 -0
- package/dist/skills/agnostic/frontend/redesign-existing-projects/SKILL.md +178 -0
- package/dist/skills/agnostic/planning/create-plan/REFERENCE.md +37 -0
- package/dist/skills/agnostic/planning/create-plan/SKILL.md +69 -0
- package/dist/skills/agnostic/planning/create-plan/references/backlog-sync.md +44 -0
- package/dist/skills/agnostic/planning/create-plan/references/grill-phase.md +86 -0
- package/dist/skills/agnostic/planning/create-plan/references/plan-schema.md +66 -0
- package/dist/skills/agnostic/planning/create-plan/references/planner-phase.md +39 -0
- package/dist/skills/agnostic/planning/create-plan/references/stop-conditions.md +18 -0
- package/dist/skills/agnostic/planning/create-plan/references/tdd-phase.md +26 -0
- package/dist/skills/agnostic/planning/create-spec/SKILL.md +57 -0
- package/dist/skills/agnostic/planning/create-spec/assets/SPEC-TEMPLATE.md +91 -0
- package/dist/skills/agnostic/planning/create-spec/references/discovery.md +44 -0
- package/dist/skills/agnostic/planning/create-spec/references/folder-naming.md +27 -0
- package/dist/skills/agnostic/planning/create-spec/references/handoff.md +47 -0
- package/dist/skills/agnostic/planning/create-spec/references/questioning.md +41 -0
- package/dist/skills/agnostic/planning/create-spec/references/spec-quality-bar.md +58 -0
- package/dist/skills/agnostic/planning/create-spec/references/wiki-bookkeeping.md +26 -0
- package/dist/skills/agnostic/planning/grill-me/SKILL.md +28 -0
- package/dist/skills/agnostic/planning/implement-spec/SKILL.md +72 -0
- package/dist/skills/agnostic/planning/implement-spec/assets/IMPLEMENTATION-NOTES-TEMPLATE.md +47 -0
- package/dist/skills/agnostic/planning/implement-spec/references/lifecycle.md +149 -0
- package/dist/skills/agnostic/planning/implement-spec/references/parallel-orchestration.md +102 -0
- package/dist/skills/agnostic/planning/implement-spec/references/parallel-worker-brief.md +65 -0
- package/dist/skills/agnostic/planning/implement-spec/references/parallel.md +56 -0
- package/dist/skills/agnostic/planning/implement-spec/references/sequential.md +28 -0
- package/dist/skills/agnostic/planning/swarm-planner/SKILL.md +179 -0
- package/dist/skills/agnostic/quality/simplify/SKILL.md +14 -0
- package/dist/skills/agnostic/quality/tdd/SKILL.md +107 -0
- package/dist/skills/agnostic/quality/tdd/deep-modules.md +33 -0
- package/dist/skills/agnostic/quality/tdd/interface-design.md +31 -0
- package/dist/skills/agnostic/quality/tdd/mocking.md +59 -0
- package/dist/skills/agnostic/quality/tdd/refactoring.md +10 -0
- package/dist/skills/agnostic/quality/tdd/tests.md +61 -0
- package/dist/skills/agnostic/requirements/requirements-grill/SKILL.md +42 -0
- package/dist/skills/agnostic/requirements/requirements-grill/references/artifact-output.md +73 -0
- package/dist/skills/agnostic/requirements/requirements-grill/references/grilling-flow.md +57 -0
- package/dist/skills/agnostic/requirements/requirements-grill/references/wiki-output.md +94 -0
- package/dist/skills/agnostic/requirements/write-backlog/EXAMPLES.md +67 -0
- package/dist/skills/agnostic/requirements/write-backlog/REFERENCE.md +253 -0
- package/dist/skills/agnostic/requirements/write-backlog/SKILL.md +68 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/concepts/backlog-model.md +69 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/concepts/story-shape.md +66 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/providers/azure-devops-create-payload.md +63 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/providers/github-issues-create-payload.md +48 -0
- package/dist/skills/agnostic/requirements/write-backlog/assets/providers/linear-create-payload.md +76 -0
- package/dist/skills/agnostic/research/improve-codebase-architecture/REFERENCE.md +78 -0
- package/dist/skills/agnostic/research/improve-codebase-architecture/SKILL.md +76 -0
- package/dist/skills/agnostic/research/parallel-research/SKILL.md +68 -0
- package/dist/skills/agnostic/research/parallel-research/agents/openai.yaml +4 -0
- package/dist/skills/agnostic/subagents/swarm-planner/SKILL.md +179 -0
- package/dist/skills/agnostic/write-a-skill/SKILL.md +117 -0
- package/dist/skills/frameworks/better-auth/better-auth-best-practices/SKILL.md +166 -0
- package/dist/skills/frameworks/better-auth/better-auth-security-best-practices/SKILL.MD +432 -0
- package/dist/skills/frameworks/effect/effect-authoring/SKILL.md +116 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/branded-types.md +98 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/effect-atom-patterns.md +257 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/effect-primitives.md +144 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/error-patterns.md +156 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/otel-patterns.md +113 -0
- package/dist/skills/frameworks/effect/effect-authoring/references/test-patterns.md +146 -0
- package/dist/skills/frameworks/effect/effect-backend-structure/SKILL.md +96 -0
- package/dist/skills/frameworks/effect/effect-backend-structure/agents/openai.yaml +4 -0
- package/dist/skills/frameworks/effect/effect-backend-structure/references/layout.md +68 -0
- package/dist/skills/frameworks/effect/effect-best-practices/SKILL.md +517 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/anti-patterns.md +392 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/effect-atom-patterns.md +653 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/error-patterns.md +464 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/language-server.md +287 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/layer-patterns.md +495 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/observability-patterns.md +342 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/rpc-cluster-patterns.md +418 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/schema-patterns.md +353 -0
- package/dist/skills/frameworks/effect/effect-best-practices/references/service-patterns.md +299 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/SKILL.md +65 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/agents/openai.yaml +4 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/flow-examples.md +154 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/source-backed-primitives.md +104 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/strategy-matrix.md +34 -0
- package/dist/skills/frameworks/effect/effect-recoverable-actions/references/test-matrix.md +36 -0
- package/dist/skills/frameworks/elysia/elysiajs/SKILL.md +475 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/basic.ts +9 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/body-parser.ts +33 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/complex.ts +112 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/cookie.ts +45 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/error.ts +38 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/file.ts +10 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/guard.ts +34 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/map-response.ts +15 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/redirect.ts +6 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/rename.ts +32 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/schema.ts +61 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/state.ts +6 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/upload-file.ts +20 -0
- package/dist/skills/frameworks/elysia/elysiajs/examples/websocket.ts +25 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/ai-sdk.md +92 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/astro.md +59 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/better-auth.md +117 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/cloudflare-worker.md +95 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/deno.md +34 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/drizzle.md +258 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/expo.md +95 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/nextjs.md +103 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/nodejs.md +64 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/nuxt.md +67 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/prisma.md +93 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/react-email.md +134 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/sveltekit.md +53 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/tanstack-start.md +87 -0
- package/dist/skills/frameworks/elysia/elysiajs/integrations/vercel.md +55 -0
- package/dist/skills/frameworks/elysia/elysiajs/patterns/mvc.md +380 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/bearer.md +30 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/cors.md +141 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/cron.md +265 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/graphql-apollo.md +90 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/graphql-yoga.md +87 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/html.md +188 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/jwt.md +197 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/openapi.md +246 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/opentelemetry.md +167 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/server-timing.md +71 -0
- package/dist/skills/frameworks/elysia/elysiajs/plugins/static.md +84 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/bun-fullstack-dev-server.md +129 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/cookie.md +187 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/deployment.md +413 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/eden.md +158 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/lifecycle.md +198 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/macro.md +83 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/plugin.md +207 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/route.md +331 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/testing.md +385 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/validation.md +491 -0
- package/dist/skills/frameworks/elysia/elysiajs/references/websocket.md +250 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/.github/workflows/branch-protection.yml +24 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/.github/workflows/deploy.yml +61 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/AGENTS.md +5958 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/SKILL.md +130 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-use-dto-serialization.md +182 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-use-interceptors.md +202 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-use-pipes.md +205 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/api-versioning.md +191 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-avoid-circular-deps.md +80 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-feature-modules.md +82 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-module-sharing.md +141 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-single-responsibility.md +106 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-use-events.md +108 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/arch-use-repository-pattern.md +97 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/db-avoid-n-plus-one.md +139 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/db-use-migrations.md +129 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/db-use-transactions.md +140 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/devops-graceful-shutdown.md +222 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/devops-use-config-module.md +167 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/devops-use-logging.md +232 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-avoid-service-locator.md +104 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-interface-segregation.md +165 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-liskov-substitution.md +221 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-prefer-constructor-injection.md +86 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-scope-awareness.md +94 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/di-use-interfaces-tokens.md +101 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/error-handle-async-errors.md +125 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/error-throw-http-exceptions.md +114 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/error-use-exception-filters.md +140 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/micro-use-health-checks.md +226 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/micro-use-patterns.md +167 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/micro-use-queues.md +252 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-async-hooks.md +109 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-lazy-loading.md +121 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-optimize-database.md +131 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/perf-use-caching.md +128 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-auth-jwt.md +146 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-rate-limiting.md +125 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-sanitize-output.md +139 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-use-guards.md +135 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/security-validate-all-input.md +150 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/test-e2e-supertest.md +178 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/test-mock-external-services.md +179 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/rules/test-use-testing-module.md +153 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/build-agents.ts +299 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/build.sh +16 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/package-lock.json +237 -0
- package/dist/skills/frameworks/nestjs/nestjs-best-practices/scripts/package.json +15 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/SKILL.md +208 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/authentication.md +166 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/controllers-routing.md +111 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/dtos-validation.md +153 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/migration-from-express.md +1237 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/services-di.md +140 -0
- package/dist/skills/frameworks/nestjs/nestjs-expert/references/testing-patterns.md +186 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/SKILL.md +153 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/async-patterns.md +87 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/bundling.md +180 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/data-patterns.md +297 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/debug-tricks.md +105 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/directives.md +73 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/error-handling.md +227 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/file-conventions.md +140 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/font.md +245 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/functions.md +108 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/hydration-error.md +91 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/image.md +173 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/metadata.md +301 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/parallel-routes.md +287 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/route-handlers.md +146 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/rsc-boundaries.md +159 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/runtime-selection.md +39 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/scripts.md +141 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/self-hosting.md +371 -0
- package/dist/skills/frameworks/nextjs/next-best-practices/suspense-boundaries.md +67 -0
- package/dist/skills/frameworks/nextjs/next-cache-components/SKILL.md +360 -0
- package/dist/skills/frameworks/react/async-react-patterns/SKILL.md +78 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/AGENTS.md +946 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/SKILL.md +89 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/state-context-interface.md +191 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/dist/skills/frameworks/react/vercel-composition-patterns/rules/state-lift-state.md +125 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/AGENTS.md +3750 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/SKILL.md +148 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-effect-event-deps.md +56 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-api-routes.md +38 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-cheap-condition-before-await.md +37 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-defer-await.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-dependencies.md +51 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-parallel.md +28 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-barrel-imports.md +60 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/bundle-preload.md +50 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-early-exit.md +50 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-flatmap-filter.md +60 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-index-maps.md +37 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-request-idle-callback.md +105 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-activity.md +26 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-resource-hints.md +85 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-script-defer-async.md +68 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-memo.md +44 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-no-inline-components.md +82 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-split-combined-hooks.md +64 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-use-deferred-value.md +59 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-cache-react.md +76 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-hoist-static-io.md +149 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-no-shared-module-state.md +50 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-parallel-nested-fetching.md +34 -0
- package/dist/skills/frameworks/react/vercel-react-best-practices/rules/server-serialization.md +38 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/.claude-plugin/plugin.json +12 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/SKILL.md +1058 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/assets/example-template.txt +14 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/best-practices.md +304 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/common-patterns.md +271 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/example-reference.md +26 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/testing.md +282 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/top-errors.md +332 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/typescript-patterns.md +291 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/references/v4-to-v5-migration.md +231 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/rules/tanstack-query.md +126 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/scripts/example-script.sh +15 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/custom-hooks-pattern.tsx +281 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/devtools-setup.tsx +248 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/error-boundary.tsx +243 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/package.json +31 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/provider-setup.tsx +50 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/query-client-config.ts +72 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-infinite-query.tsx +214 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-mutation-basic.tsx +201 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-mutation-optimistic.tsx +234 -0
- package/dist/skills/frameworks/tanstack-query/tanstack-query/templates/use-query-basic.tsx +119 -0
- package/dist/skills/frameworks/trpc/tanstack-query/.claude-plugin/plugin.json +12 -0
- package/dist/skills/frameworks/trpc/tanstack-query/SKILL.md +1058 -0
- package/dist/skills/frameworks/trpc/tanstack-query/assets/example-template.txt +14 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/best-practices.md +304 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/common-patterns.md +271 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/example-reference.md +26 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/testing.md +282 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/top-errors.md +332 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/typescript-patterns.md +291 -0
- package/dist/skills/frameworks/trpc/tanstack-query/references/v4-to-v5-migration.md +231 -0
- package/dist/skills/frameworks/trpc/tanstack-query/rules/tanstack-query.md +126 -0
- package/dist/skills/frameworks/trpc/tanstack-query/scripts/example-script.sh +15 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/custom-hooks-pattern.tsx +281 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/devtools-setup.tsx +248 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/error-boundary.tsx +243 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/package.json +31 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/provider-setup.tsx +50 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/query-client-config.ts +72 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-infinite-query.tsx +214 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-mutation-basic.tsx +201 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-mutation-optimistic.tsx +234 -0
- package/dist/skills/frameworks/trpc/tanstack-query/templates/use-query-basic.tsx +119 -0
- package/dist/skills/frameworks/turborepo/turborepo/SKILL.md +914 -0
- package/dist/skills/frameworks/turborepo/turborepo/command/turborepo.md +70 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/RULE.md +241 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/dependencies.md +246 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/packages.md +335 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/best-practices/structure.md +270 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/boundaries/RULE.md +126 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/caching/RULE.md +107 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/caching/gotchas.md +169 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/caching/remote-cache.md +127 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/RULE.md +79 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/github-actions.md +162 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/patterns.md +145 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/ci/vercel.md +103 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/cli/RULE.md +100 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/cli/commands.md +297 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/RULE.md +211 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/global-options.md +187 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/gotchas.md +348 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/configuration/tasks.md +285 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/environment/RULE.md +96 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/environment/gotchas.md +141 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/environment/modes.md +101 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/filtering/RULE.md +148 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/filtering/patterns.md +152 -0
- package/dist/skills/frameworks/turborepo/turborepo/references/watch/RULE.md +99 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/docs/README.md +20 -0
- package/docs/reference/dp-requirements.md +210 -0
- package/docs/runbooks/dp-cli-scaffolding.md +187 -0
- package/package.json +24 -50
- package/.eslintignore +0 -4
- package/.eslintrc +0 -127
- package/.prettierignore +0 -4
- package/.prettierrc +0 -7
- package/bin/abstractions/builder.d.ts +0 -4
- package/bin/abstractions/builder.js +0 -7
- package/bin/builders/dotnet/base.d.ts +0 -18
- package/bin/builders/dotnet/base.js +0 -47
- package/bin/builders/dotnet/entity-configuration/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-configuration/index.js +0 -29
- package/bin/builders/dotnet/entity-converter/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-converter/index.js +0 -29
- package/bin/builders/dotnet/entity-model-create/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-create/index.js +0 -29
- package/bin/builders/dotnet/entity-model-dto/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-dto/index.js +0 -29
- package/bin/builders/dotnet/entity-model-list-item-dto/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-list-item-dto/index.js +0 -29
- package/bin/builders/dotnet/entity-model-update/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-model-update/index.js +0 -29
- package/bin/builders/dotnet/entity-search-parameters/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-search-parameters/index.js +0 -29
- package/bin/builders/dotnet/entity-search-query-builder/index.d.ts +0 -8
- package/bin/builders/dotnet/entity-search-query-builder/index.js +0 -29
- package/bin/builders/dotnet/firestore-connector/index.d.ts +0 -8
- package/bin/builders/dotnet/firestore-connector/index.js +0 -29
- package/bin/builders/dotnet/firestore-mapper/index.d.ts +0 -8
- package/bin/builders/dotnet/firestore-mapper/index.js +0 -29
- package/bin/builders/dotnet/types.d.ts +0 -10
- package/bin/builders/dotnet/types.js +0 -3
- package/bin/commands/entity-add/__test__/dotnet/common.d.ts +0 -2
- package/bin/commands/entity-add/__test__/dotnet/common.js +0 -11
- package/bin/commands/entity-add/__test__/dotnet/render.configuration.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.configuration.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.converter.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.converter.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-connector.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-connector.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-mapper.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.firestore-mapper.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-create.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-create.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-dto.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-dto.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-list-item-dto.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-list-item-dto.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.model-update.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.model-update.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.search-parameters.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.search-parameters.spec.js +0 -22
- package/bin/commands/entity-add/__test__/dotnet/render.search-query.spec.d.ts +0 -1
- package/bin/commands/entity-add/__test__/dotnet/render.search-query.spec.js +0 -22
- package/bin/commands/entity-add/index.d.ts +0 -26
- package/bin/commands/entity-add/index.js +0 -44
- package/bin/logging/index.d.ts +0 -8
- package/bin/logging/index.js +0 -28
- package/bin/providers/rendering/base.d.ts +0 -3
- package/bin/providers/rendering/base.js +0 -7
- package/bin/providers/rendering/factory.d.ts +0 -5
- package/bin/providers/rendering/factory.js +0 -16
- package/bin/providers/rendering/handlebars.d.ts +0 -4
- package/bin/providers/rendering/handlebars.js +0 -16
- package/bin/renderer/index.d.ts +0 -6
- package/bin/renderer/index.js +0 -27
- package/bin/run.d.ts +0 -2
- package/bin/run.js +0 -70
- package/bin/services/folders.d.ts +0 -1
- package/bin/services/folders.js +0 -31
- package/bin/types/commands.d.ts +0 -5
- package/bin/types/commands.js +0 -3
- package/bin/utils/collections.d.ts +0 -1
- package/bin/utils/collections.js +0 -6
- package/bin/utils/files.d.ts +0 -3
- package/bin/utils/files.js +0 -19
- package/bin/utils/strings.d.ts +0 -4
- package/bin/utils/strings.js +0 -22
- package/bin/utils/text.d.ts +0 -1
- package/bin/utils/text.js +0 -8
- package/em-cli +0 -0
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.configuration.spec.ts.snap +0 -49
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.converter.spec.ts.snap +0 -53
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.firestore-connector.spec.ts.snap +0 -20
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.firestore-mapper.spec.ts.snap +0 -29
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-create.spec.ts.snap +0 -10
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-dto.spec.ts.snap +0 -9
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-list-item-dto.spec.ts.snap +0 -11
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.model-update.spec.ts.snap +0 -11
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.search-parameters.spec.ts.snap +0 -29
- package/src/commands/entity-add/__test__/dotnet/__snapshots__/render.search-query.spec.ts.snap +0 -42
- package/templates/dotnet/NewEntity/Configuration/<PluralizedEntity>Configuration.cs.template +0 -48
- package/templates/dotnet/NewEntity/Connectors/<PluralizedEntity>FirestoreConnector.cs.template +0 -15
- package/templates/dotnet/NewEntity/Converters/<PluralizedEntity>Converter.cs.template +0 -48
- package/templates/dotnet/NewEntity/Mappers/<PluralizedEntity>FirestoreMapper.cs.template +0 -25
- package/templates/dotnet/NewEntity/Models/<Entity>CreateInput.cs.template +0 -6
- package/templates/dotnet/NewEntity/Models/<Entity>Dto.cs.template +0 -5
- package/templates/dotnet/NewEntity/Models/<Entity>ListItemDto.cs.template +0 -6
- package/templates/dotnet/NewEntity/Models/<Entity>UpdateInput.cs.template +0 -6
- package/templates/dotnet/NewEntity/Search/<PluralizedEntity>QueryBuilder.cs.template +0 -38
- package/templates/dotnet/NewEntity/Search/<PluralizedEntity>SearchParameters.cs.template +0 -24
- package/tsconfig.json +0 -25
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
# Drizzle Integration
|
|
2
|
+
Elysia + Drizzle integration guide
|
|
3
|
+
|
|
4
|
+
## What It Is
|
|
5
|
+
Headless TypeScript ORM. Convert Drizzle schema → Elysia validation models via `drizzle-typebox`.
|
|
6
|
+
|
|
7
|
+
## Flow
|
|
8
|
+
```
|
|
9
|
+
Drizzle → drizzle-typebox → Elysia validation → OpenAPI + Eden Treaty
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
```bash
|
|
14
|
+
bun add drizzle-orm drizzle-typebox
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Pin TypeBox Version
|
|
18
|
+
Prevent Symbol conflicts:
|
|
19
|
+
```bash
|
|
20
|
+
grep "@sinclair/typebox" node_modules/elysia/package.json
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Add to `package.json`:
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"overrides": {
|
|
27
|
+
"@sinclair/typebox": "0.32.4"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Drizzle Schema
|
|
33
|
+
```typescript
|
|
34
|
+
// src/database/schema.ts
|
|
35
|
+
import { pgTable, varchar, timestamp } from 'drizzle-orm/pg-core'
|
|
36
|
+
import { createId } from '@paralleldrive/cuid2'
|
|
37
|
+
|
|
38
|
+
export const user = pgTable('user', {
|
|
39
|
+
id: varchar('id').$defaultFn(() => createId()).primaryKey(),
|
|
40
|
+
username: varchar('username').notNull().unique(),
|
|
41
|
+
password: varchar('password').notNull(),
|
|
42
|
+
email: varchar('email').notNull().unique(),
|
|
43
|
+
salt: varchar('salt', { length: 64 }).notNull(),
|
|
44
|
+
createdAt: timestamp('created_at').defaultNow().notNull()
|
|
45
|
+
})
|
|
46
|
+
|
|
47
|
+
export const table = { user } as const
|
|
48
|
+
export type Table = typeof table
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## drizzle-typebox
|
|
52
|
+
```typescript
|
|
53
|
+
import { t } from 'elysia'
|
|
54
|
+
import { createInsertSchema } from 'drizzle-typebox'
|
|
55
|
+
import { table } from './database/schema'
|
|
56
|
+
|
|
57
|
+
const _createUser = createInsertSchema(table.user, {
|
|
58
|
+
email: t.String({ format: 'email' }) // Replace with Elysia type
|
|
59
|
+
})
|
|
60
|
+
|
|
61
|
+
new Elysia()
|
|
62
|
+
.post('/sign-up', ({ body }) => {}, {
|
|
63
|
+
body: t.Omit(_createUser, ['id', 'salt', 'createdAt'])
|
|
64
|
+
})
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Type Instantiation Error
|
|
68
|
+
**Error**: "Type instantiation is possibly infinite"
|
|
69
|
+
|
|
70
|
+
**Cause**: Circular reference when nesting drizzle-typebox into Elysia schema.
|
|
71
|
+
|
|
72
|
+
**Fix**: Explicitly define type between them:
|
|
73
|
+
```typescript
|
|
74
|
+
// ✅ Works
|
|
75
|
+
const _createUser = createInsertSchema(table.user, {
|
|
76
|
+
email: t.String({ format: 'email' })
|
|
77
|
+
})
|
|
78
|
+
const createUser = t.Omit(_createUser, ['id', 'salt', 'createdAt'])
|
|
79
|
+
|
|
80
|
+
// ❌ Infinite loop
|
|
81
|
+
const createUser = t.Omit(
|
|
82
|
+
createInsertSchema(table.user, { email: t.String({ format: 'email' }) }),
|
|
83
|
+
['id', 'salt', 'createdAt']
|
|
84
|
+
)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Always declare variable for drizzle-typebox then reference it.
|
|
88
|
+
|
|
89
|
+
## Utility Functions
|
|
90
|
+
Copy as-is for simplified usage:
|
|
91
|
+
```typescript
|
|
92
|
+
// src/database/utils.ts
|
|
93
|
+
/**
|
|
94
|
+
* @lastModified 2025-02-04
|
|
95
|
+
* @see https://elysiajs.com/recipe/drizzle.html#utility
|
|
96
|
+
*/
|
|
97
|
+
|
|
98
|
+
import { Kind, type TObject } from '@sinclair/typebox'
|
|
99
|
+
import {
|
|
100
|
+
createInsertSchema,
|
|
101
|
+
createSelectSchema,
|
|
102
|
+
BuildSchema,
|
|
103
|
+
} from 'drizzle-typebox'
|
|
104
|
+
|
|
105
|
+
import { table } from './schema'
|
|
106
|
+
import type { Table } from 'drizzle-orm'
|
|
107
|
+
|
|
108
|
+
type Spread<
|
|
109
|
+
T extends TObject | Table,
|
|
110
|
+
Mode extends 'select' | 'insert' | undefined,
|
|
111
|
+
> =
|
|
112
|
+
T extends TObject<infer Fields>
|
|
113
|
+
? {
|
|
114
|
+
[K in keyof Fields]: Fields[K]
|
|
115
|
+
}
|
|
116
|
+
: T extends Table
|
|
117
|
+
? Mode extends 'select'
|
|
118
|
+
? BuildSchema<
|
|
119
|
+
'select',
|
|
120
|
+
T['_']['columns'],
|
|
121
|
+
undefined
|
|
122
|
+
>['properties']
|
|
123
|
+
: Mode extends 'insert'
|
|
124
|
+
? BuildSchema<
|
|
125
|
+
'insert',
|
|
126
|
+
T['_']['columns'],
|
|
127
|
+
undefined
|
|
128
|
+
>['properties']
|
|
129
|
+
: {}
|
|
130
|
+
: {}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Spread a Drizzle schema into a plain object
|
|
134
|
+
*/
|
|
135
|
+
export const spread = <
|
|
136
|
+
T extends TObject | Table,
|
|
137
|
+
Mode extends 'select' | 'insert' | undefined,
|
|
138
|
+
>(
|
|
139
|
+
schema: T,
|
|
140
|
+
mode?: Mode,
|
|
141
|
+
): Spread<T, Mode> => {
|
|
142
|
+
const newSchema: Record<string, unknown> = {}
|
|
143
|
+
let table
|
|
144
|
+
|
|
145
|
+
switch (mode) {
|
|
146
|
+
case 'insert':
|
|
147
|
+
case 'select':
|
|
148
|
+
if (Kind in schema) {
|
|
149
|
+
table = schema
|
|
150
|
+
break
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
table =
|
|
154
|
+
mode === 'insert'
|
|
155
|
+
? createInsertSchema(schema)
|
|
156
|
+
: createSelectSchema(schema)
|
|
157
|
+
|
|
158
|
+
break
|
|
159
|
+
|
|
160
|
+
default:
|
|
161
|
+
if (!(Kind in schema)) throw new Error('Expect a schema')
|
|
162
|
+
table = schema
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
for (const key of Object.keys(table.properties))
|
|
166
|
+
newSchema[key] = table.properties[key]
|
|
167
|
+
|
|
168
|
+
return newSchema as any
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Spread a Drizzle Table into a plain object
|
|
173
|
+
*
|
|
174
|
+
* If `mode` is 'insert', the schema will be refined for insert
|
|
175
|
+
* If `mode` is 'select', the schema will be refined for select
|
|
176
|
+
* If `mode` is undefined, the schema will be spread as is, models will need to be refined manually
|
|
177
|
+
*/
|
|
178
|
+
export const spreads = <
|
|
179
|
+
T extends Record<string, TObject | Table>,
|
|
180
|
+
Mode extends 'select' | 'insert' | undefined,
|
|
181
|
+
>(
|
|
182
|
+
models: T,
|
|
183
|
+
mode?: Mode,
|
|
184
|
+
): {
|
|
185
|
+
[K in keyof T]: Spread<T[K], Mode>
|
|
186
|
+
} => {
|
|
187
|
+
const newSchema: Record<string, unknown> = {}
|
|
188
|
+
const keys = Object.keys(models)
|
|
189
|
+
|
|
190
|
+
for (const key of keys) newSchema[key] = spread(models[key], mode)
|
|
191
|
+
|
|
192
|
+
return newSchema as any
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Usage:
|
|
197
|
+
```typescript
|
|
198
|
+
// ✅ Using spread
|
|
199
|
+
const user = spread(table.user, 'insert')
|
|
200
|
+
const createUser = t.Object({
|
|
201
|
+
id: user.id,
|
|
202
|
+
username: user.username,
|
|
203
|
+
password: user.password
|
|
204
|
+
})
|
|
205
|
+
|
|
206
|
+
// ⚠️ Using t.Pick
|
|
207
|
+
const _createUser = createInsertSchema(table.user)
|
|
208
|
+
const createUser = t.Pick(_createUser, ['id', 'username', 'password'])
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
## Table Singleton Pattern
|
|
212
|
+
```typescript
|
|
213
|
+
// src/database/model.ts
|
|
214
|
+
import { table } from './schema'
|
|
215
|
+
import { spreads } from './utils'
|
|
216
|
+
|
|
217
|
+
export const db = {
|
|
218
|
+
insert: spreads({ user: table.user }, 'insert'),
|
|
219
|
+
select: spreads({ user: table.user }, 'select')
|
|
220
|
+
} as const
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
Usage:
|
|
224
|
+
```typescript
|
|
225
|
+
// src/index.ts
|
|
226
|
+
import { db } from './database/model'
|
|
227
|
+
const { user } = db.insert
|
|
228
|
+
|
|
229
|
+
new Elysia()
|
|
230
|
+
.post('/sign-up', ({ body }) => {}, {
|
|
231
|
+
body: t.Object({
|
|
232
|
+
id: user.username,
|
|
233
|
+
username: user.username,
|
|
234
|
+
password: user.password
|
|
235
|
+
})
|
|
236
|
+
})
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
## Refinement
|
|
240
|
+
```typescript
|
|
241
|
+
// src/database/model.ts
|
|
242
|
+
import { createInsertSchema, createSelectSchema } from 'drizzle-typebox'
|
|
243
|
+
|
|
244
|
+
export const db = {
|
|
245
|
+
insert: spreads({
|
|
246
|
+
user: createInsertSchema(table.user, {
|
|
247
|
+
email: t.String({ format: 'email' })
|
|
248
|
+
})
|
|
249
|
+
}, 'insert'),
|
|
250
|
+
select: spreads({
|
|
251
|
+
user: createSelectSchema(table.user, {
|
|
252
|
+
email: t.String({ format: 'email' })
|
|
253
|
+
})
|
|
254
|
+
}, 'select')
|
|
255
|
+
} as const
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
`spread` skips refined schemas.
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Expo Integration
|
|
2
|
+
Run Elysia on Expo (React Native)
|
|
3
|
+
|
|
4
|
+
## What It Is
|
|
5
|
+
Create API routes in Expo app (SDK 50+, App Router v3).
|
|
6
|
+
|
|
7
|
+
## Setup
|
|
8
|
+
1. Create `app/[...slugs]+api.ts`
|
|
9
|
+
2. Define Elysia server
|
|
10
|
+
3. Export `Elysia.fetch` as HTTP methods
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
// app/[...slugs]+api.ts
|
|
14
|
+
import { Elysia, t } from 'elysia'
|
|
15
|
+
|
|
16
|
+
const app = new Elysia()
|
|
17
|
+
.get('/', 'hello Expo')
|
|
18
|
+
.post('/', ({ body }) => body, {
|
|
19
|
+
body: t.Object({ name: t.String() })
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
export const GET = app.fetch
|
|
23
|
+
export const POST = app.fetch
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Prefix for Non-Root
|
|
27
|
+
If placed in `app/api/[...slugs]+api.ts`, set prefix:
|
|
28
|
+
```typescript
|
|
29
|
+
const app = new Elysia({ prefix: '/api' })
|
|
30
|
+
.get('/', 'Hello Expo')
|
|
31
|
+
|
|
32
|
+
export const GET = app.fetch
|
|
33
|
+
export const POST = app.fetch
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Ensures routing works in any location.
|
|
37
|
+
|
|
38
|
+
## Eden (End-to-End Type Safety)
|
|
39
|
+
1. Export type:
|
|
40
|
+
```typescript
|
|
41
|
+
// app/[...slugs]+api.ts
|
|
42
|
+
const app = new Elysia()
|
|
43
|
+
.get('/', 'Hello Nextjs')
|
|
44
|
+
.post('/user', ({ body }) => body, {
|
|
45
|
+
body: treaty.schema('User', { name: 'string' })
|
|
46
|
+
})
|
|
47
|
+
|
|
48
|
+
export type app = typeof app
|
|
49
|
+
|
|
50
|
+
export const GET = app.fetch
|
|
51
|
+
export const POST = app.fetch
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
2. Create client:
|
|
55
|
+
```typescript
|
|
56
|
+
// lib/eden.ts
|
|
57
|
+
import { treaty } from '@elysiajs/eden'
|
|
58
|
+
import type { app } from '../app/[...slugs]+api'
|
|
59
|
+
|
|
60
|
+
export const api = treaty<app>('localhost:3000/api')
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
3. Use in components:
|
|
64
|
+
```tsx
|
|
65
|
+
// app/page.tsx
|
|
66
|
+
import { api } from '../lib/eden'
|
|
67
|
+
|
|
68
|
+
export default async function Page() {
|
|
69
|
+
const message = await api.get()
|
|
70
|
+
return <h1>Hello, {message}</h1>
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Deployment
|
|
75
|
+
- Deploy as normal Elysia app OR
|
|
76
|
+
- Use experimental Expo server runtime
|
|
77
|
+
|
|
78
|
+
With Expo runtime:
|
|
79
|
+
```bash
|
|
80
|
+
expo export
|
|
81
|
+
# Creates dist/server/_expo/functions/[...slugs]+api.js
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Edge function, not normal server (no port allocation).
|
|
85
|
+
|
|
86
|
+
### Adapters
|
|
87
|
+
- Express
|
|
88
|
+
- Netlify
|
|
89
|
+
- Vercel
|
|
90
|
+
|
|
91
|
+
## pnpm
|
|
92
|
+
Manual install:
|
|
93
|
+
```bash
|
|
94
|
+
pnpm add @sinclair/typebox openapi-types
|
|
95
|
+
```
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
|
|
2
|
+
# Next.js Integration
|
|
3
|
+
|
|
4
|
+
## What It Is
|
|
5
|
+
Run Elysia on Next.js App Router.
|
|
6
|
+
|
|
7
|
+
## Setup
|
|
8
|
+
1. Create `app/api/[[...slugs]]/route.ts`
|
|
9
|
+
2. Define Elysia + export handlers:
|
|
10
|
+
```typescript
|
|
11
|
+
// app/api/[[...slugs]]/route.ts
|
|
12
|
+
import { Elysia, t } from 'elysia'
|
|
13
|
+
|
|
14
|
+
const app = new Elysia({ prefix: '/api' })
|
|
15
|
+
.get('/', 'Hello Nextjs')
|
|
16
|
+
.post('/', ({ body }) => body, {
|
|
17
|
+
body: t.Object({ name: t.String() })
|
|
18
|
+
})
|
|
19
|
+
|
|
20
|
+
export const GET = app.fetch
|
|
21
|
+
export const POST = app.fetch
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
WinterCG compliance - works as normal Next.js API route.
|
|
25
|
+
|
|
26
|
+
## Prefix for Non-Root
|
|
27
|
+
If placed in `app/user/[[...slugs]]/route.ts`, set prefix:
|
|
28
|
+
```typescript
|
|
29
|
+
const app = new Elysia({ prefix: '/user' })
|
|
30
|
+
.get('/', 'Hello Nextjs')
|
|
31
|
+
|
|
32
|
+
export const GET = app.fetch
|
|
33
|
+
export const POST = app.fetch
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Eden (End-to-End Type Safety)
|
|
37
|
+
Isomorphic fetch pattern:
|
|
38
|
+
- Server: Direct calls (no network)
|
|
39
|
+
- Client: Network calls
|
|
40
|
+
|
|
41
|
+
1. Export type:
|
|
42
|
+
```typescript
|
|
43
|
+
// app/api/[[...slugs]]/route.ts
|
|
44
|
+
export const app = new Elysia({ prefix: '/api' })
|
|
45
|
+
.get('/', 'Hello Nextjs')
|
|
46
|
+
.post('/user', ({ body }) => body, {
|
|
47
|
+
body: treaty.schema('User', { name: 'string' })
|
|
48
|
+
})
|
|
49
|
+
|
|
50
|
+
export type app = typeof app
|
|
51
|
+
|
|
52
|
+
export const GET = app.fetch
|
|
53
|
+
export const POST = app.fetch
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
2. Create client:
|
|
57
|
+
```typescript
|
|
58
|
+
// lib/eden.ts
|
|
59
|
+
import { treaty } from '@elysiajs/eden'
|
|
60
|
+
import type { app } from '../app/api/[[...slugs]]/route'
|
|
61
|
+
|
|
62
|
+
export const api =
|
|
63
|
+
typeof process !== 'undefined'
|
|
64
|
+
? treaty(app).api
|
|
65
|
+
: treaty<typeof app>('localhost:3000').api
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Use `typeof process` not `typeof window` (window undefined at build time → hydration error).
|
|
69
|
+
|
|
70
|
+
3. Use in components:
|
|
71
|
+
```tsx
|
|
72
|
+
// app/page.tsx
|
|
73
|
+
import { api } from '../lib/eden'
|
|
74
|
+
|
|
75
|
+
export default async function Page() {
|
|
76
|
+
const message = await api.get()
|
|
77
|
+
return <h1>Hello, {message}</h1>
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Works with server/client components + ISR.
|
|
82
|
+
|
|
83
|
+
## React Query
|
|
84
|
+
```tsx
|
|
85
|
+
import { useQuery } from '@tanstack/react-query'
|
|
86
|
+
|
|
87
|
+
function App() {
|
|
88
|
+
const { data: response } = useQuery({
|
|
89
|
+
queryKey: ['get'],
|
|
90
|
+
queryFn: () => getTreaty().get()
|
|
91
|
+
})
|
|
92
|
+
|
|
93
|
+
return response?.data
|
|
94
|
+
}
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Works with all React Query features.
|
|
98
|
+
|
|
99
|
+
## pnpm
|
|
100
|
+
Manual install:
|
|
101
|
+
```bash
|
|
102
|
+
pnpm add @sinclair/typebox openapi-types
|
|
103
|
+
```
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Node.js Integration
|
|
2
|
+
Run Elysia on Node.js
|
|
3
|
+
|
|
4
|
+
## What It Is
|
|
5
|
+
Runtime adapter to run Elysia on Node.js.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
```bash
|
|
9
|
+
bun add elysia @elysiajs/node
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
13
|
+
Apply node adapter:
|
|
14
|
+
```typescript
|
|
15
|
+
import { Elysia } from 'elysia'
|
|
16
|
+
import { node } from '@elysiajs/node'
|
|
17
|
+
|
|
18
|
+
const app = new Elysia({ adapter: node() })
|
|
19
|
+
.get('/', () => 'Hello Elysia')
|
|
20
|
+
.listen(3000)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Additional Setup (Recommended)
|
|
24
|
+
Install `tsx` for hot-reload:
|
|
25
|
+
```bash
|
|
26
|
+
bun add -d tsx @types/node typescript
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Scripts in `package.json`:
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"scripts": {
|
|
33
|
+
"dev": "tsx watch src/index.ts",
|
|
34
|
+
"build": "tsc src/index.ts --outDir dist",
|
|
35
|
+
"start": "NODE_ENV=production node dist/index.js"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- **dev**: Hot-reload dev mode
|
|
41
|
+
- **build**: Production build
|
|
42
|
+
- **start**: Production server
|
|
43
|
+
|
|
44
|
+
Create `tsconfig.json`:
|
|
45
|
+
```bash
|
|
46
|
+
tsc --init
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Update strict mode:
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"compilerOptions": {
|
|
53
|
+
"strict": true
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Provides hot-reload + JSX support similar to `bun dev`.
|
|
59
|
+
|
|
60
|
+
## pnpm
|
|
61
|
+
Manual install:
|
|
62
|
+
```bash
|
|
63
|
+
pnpm add @sinclair/typebox openapi-types
|
|
64
|
+
```
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Nuxt Integration
|
|
2
|
+
|
|
3
|
+
## What It Is
|
|
4
|
+
Community plugin `nuxt-elysia` for Nuxt API routes with Eden Treaty.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
```bash
|
|
8
|
+
bun add elysia @elysiajs/eden
|
|
9
|
+
bun add -d nuxt-elysia
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
13
|
+
1. Add to Nuxt config:
|
|
14
|
+
```typescript
|
|
15
|
+
export default defineNuxtConfig({
|
|
16
|
+
modules: ['nuxt-elysia']
|
|
17
|
+
})
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
2. Create `api.ts` at project root:
|
|
21
|
+
```typescript
|
|
22
|
+
// api.ts
|
|
23
|
+
export default () => new Elysia()
|
|
24
|
+
.get('/hello', () => ({ message: 'Hello world!' }))
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
3. Use Eden Treaty:
|
|
28
|
+
```vue
|
|
29
|
+
<template>
|
|
30
|
+
<div>
|
|
31
|
+
<p>{{ data.message }}</p>
|
|
32
|
+
</div>
|
|
33
|
+
</template>
|
|
34
|
+
<script setup lang="ts">
|
|
35
|
+
const { $api } = useNuxtApp()
|
|
36
|
+
|
|
37
|
+
const { data } = await useAsyncData(async () => {
|
|
38
|
+
const { data, error } = await $api.hello.get()
|
|
39
|
+
|
|
40
|
+
if (error) throw new Error('Failed to call API')
|
|
41
|
+
|
|
42
|
+
return data
|
|
43
|
+
})
|
|
44
|
+
</script>
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Auto-setup on Nuxt API route.
|
|
48
|
+
|
|
49
|
+
## Prefix
|
|
50
|
+
Default: `/_api`. Customize:
|
|
51
|
+
```typescript
|
|
52
|
+
export default defineNuxtConfig({
|
|
53
|
+
nuxtElysia: {
|
|
54
|
+
path: '/api'
|
|
55
|
+
}
|
|
56
|
+
})
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Mounts on `/api` instead of `/_api`.
|
|
60
|
+
|
|
61
|
+
See [nuxt-elysia](https://github.com/tkesgar/nuxt-elysia) for more config.
|
|
62
|
+
|
|
63
|
+
## pnpm
|
|
64
|
+
Manual install:
|
|
65
|
+
```bash
|
|
66
|
+
pnpm add @sinclair/typebox openapi-types
|
|
67
|
+
```
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
|
|
2
|
+
# Prisma Integration
|
|
3
|
+
Elysia + Prisma integration guide
|
|
4
|
+
|
|
5
|
+
## What It Is
|
|
6
|
+
Type-safe ORM. Generate Elysia validation models from Prisma schema via `prismabox`.
|
|
7
|
+
|
|
8
|
+
## Flow
|
|
9
|
+
```
|
|
10
|
+
Prisma → prismabox → Elysia validation → OpenAPI + Eden Treaty
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
```bash
|
|
15
|
+
bun add @prisma/client prismabox && \
|
|
16
|
+
bun add -d prisma
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Prisma Schema
|
|
20
|
+
Add `prismabox` generator:
|
|
21
|
+
```prisma
|
|
22
|
+
// prisma/schema.prisma
|
|
23
|
+
generator client {
|
|
24
|
+
provider = "prisma-client"
|
|
25
|
+
output = "../generated/prisma"
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
datasource db {
|
|
29
|
+
provider = "sqlite"
|
|
30
|
+
url = env("DATABASE_URL")
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
generator prismabox {
|
|
34
|
+
provider = "prismabox"
|
|
35
|
+
typeboxImportDependencyName = "elysia"
|
|
36
|
+
typeboxImportVariableName = "t"
|
|
37
|
+
inputModel = true
|
|
38
|
+
output = "../generated/prismabox"
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
model User {
|
|
42
|
+
id String @id @default(cuid())
|
|
43
|
+
email String @unique
|
|
44
|
+
name String?
|
|
45
|
+
posts Post[]
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
model Post {
|
|
49
|
+
id String @id @default(cuid())
|
|
50
|
+
title String
|
|
51
|
+
content String?
|
|
52
|
+
published Boolean @default(false)
|
|
53
|
+
author User @relation(fields: [authorId], references: [id])
|
|
54
|
+
authorId String
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Generates:
|
|
59
|
+
- `User` → `generated/prismabox/User.ts`
|
|
60
|
+
- `Post` → `generated/prismabox/Post.ts`
|
|
61
|
+
|
|
62
|
+
## Using Generated Models
|
|
63
|
+
```typescript
|
|
64
|
+
// src/index.ts
|
|
65
|
+
import { Elysia, t } from 'elysia'
|
|
66
|
+
import { PrismaClient } from '../generated/prisma'
|
|
67
|
+
import { UserPlain, UserPlainInputCreate } from '../generated/prismabox/User'
|
|
68
|
+
|
|
69
|
+
const prisma = new PrismaClient()
|
|
70
|
+
|
|
71
|
+
new Elysia()
|
|
72
|
+
.put('/', async ({ body }) =>
|
|
73
|
+
prisma.user.create({ data: body }), {
|
|
74
|
+
body: UserPlainInputCreate,
|
|
75
|
+
response: UserPlain
|
|
76
|
+
}
|
|
77
|
+
)
|
|
78
|
+
.get('/id/:id', async ({ params: { id }, status }) => {
|
|
79
|
+
const user = await prisma.user.findUnique({ where: { id } })
|
|
80
|
+
|
|
81
|
+
if (!user) return status(404, 'User not found')
|
|
82
|
+
|
|
83
|
+
return user
|
|
84
|
+
}, {
|
|
85
|
+
response: {
|
|
86
|
+
200: UserPlain,
|
|
87
|
+
404: t.String()
|
|
88
|
+
}
|
|
89
|
+
})
|
|
90
|
+
.listen(3000)
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Reuses DB schema in Elysia validation models.
|