القائمة
Add or change a Zod schema in the @goodparty_org/contracts package and rebuild it so gp-webapp and other consumers see the new types. Use when a shape crosses a service boundary.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Add a new HTTP endpoint to a feature module following the controller/services/schemas convention, PrismaBase pattern, and Zod response validation. Use when adding any new route to gp-api.
Run vitest tests in gp-api efficiently — single file, by name, integration with useTestService, or the full verify gate. Use whenever you need to check your work.
Create a new Prisma migration safely against the modular schema. Use when adding/changing a column, table, index, or enum in gp-api. Never edit applied migration SQL.
| name | update-contract |
| description | Add or change a Zod schema in the @goodparty_org/contracts package and rebuild it so gp-webapp and other consumers see the new types. Use when a shape crosses a service boundary. |
contracts/ is an npm workspace package (@goodparty_org/contracts) that holds the Zod schemas + inferred types shared across gp-api and gp-webapp. Reference: docs/contracts.md, ADR docs/adr/0005-contracts-package.md.
Yes if any of:
No (keep in the feature module's schemas/) if:
contracts/src/
├── campaigns/
├── ecanvasser/
├── shared/
├── users/
├── generated/ # do not edit by hand — Prisma-derived types
└── index.ts # public surface — re-export new schema here
Add/edit the schema in the topical folder, then export from index.ts.
npm run build:contracts
This is the source of truth for what consumers see. It runs as part of npm run build and npm run start:dev, so a missed rebuild is usually caught — but run it explicitly when iterating.
Import from @goodparty_org/contracts:
import { CampaignDetailsSchema } from '@goodparty_org/contracts'
@Get(':id')
@ResponseSchema(CampaignDetailsSchema)
get(@Param('id') id: string) { ... }
Cross-repo PR. The consumer pulls the new contracts via its own npm install after this PR merges and the contracts package version bumps (or via workspace symlink in dev).
Coordinate the merge order with the consumer PR — usually contracts/gp-api ships first, consumer ships second.
gp-api/src/... a schema that already lives in contracts/. The contracts package is the canonical source.contracts/src/generated/. Regenerate via the appropriate codegen step instead.