schema-update

Update GraphQL Schema

Updates the SDK's GraphQL schema and related types from an API server instance.

Usage

/schema-update local    # Download from local server
/schema-update staging  # Download from staging server
/schema-update          # Will prompt for server choice

Checklist

You MUST use TodoWrite to create a todo for EACH step below. Mark each complete only after verification.

Download Schema

• Determine server source (from argument or ask user): local or staging
• Run schema download from packages/graphql:
  • Local: pnpm gql:download:local
  • Staging: pnpm gql:download:staging
• Run pnpm gql:generate:introspection to generate GraphQL documents

Update Documents

• Cross-reference packages/graphql/schema.graphql with existing GQL documents
• Add missing fields to existing fragments
• Introduce new fragments if necessary
• If new queries or mutations exist in schema, ask user if they should be added

Check for New Enums

• Search for new enum definitions in packages/graphql/schema.graphql
• For each new enum:
  • Add enum definition to packages/graphql/src/enums.ts with JSDoc comments
  • Import the enum type in packages/graphql/src/graphql.ts
  • Add scalar binding in graphql config (alphabetically ordered)
• Note: Do NOT create separate type exports for enums - the enum definition serves as both value and type

Export Input Types

• Check for new input types in schema
• Common types (used across multiple queries): export from packages/graphql/src/inputs.ts
• Query-specific types: colocate with corresponding query files (permits.ts, transactions.ts, swaps.ts, user.ts, reserve.ts, hub.ts, misc.ts)
• Use pattern: export type InputName = ReturnType<typeof graphql.scalar<'InputName'>>;
• Exclude fork-related input types unless explicitly needed
• Ensure scalar bindings exist in graphql.ts for all input types

Update URQL Cache Configuration