@anvilco/types

TypeScript types generated from the Anvil OpenAPI spec and GraphQL schema. Consumed internally by @anvilco/browser and @anvilco/react.

The one place for the Anvil SDK's TypeScript types:

• REST: paths, components and operations, generated from the OpenAPI spec, plus the fill-PDF request types (FillPdfPayload, FillPdfData, FillPdfOptions).
• Etch: CreateEtchPacketArgs, the createEtchPacket mutation's arguments with the ones the GraphQL schema calls JSON typed: signers (EtchSigner), signaturePageOptions (EtchSignaturePageOptions) and finishPageOptions (EtchFinishPageOptions). The OpenAPI spec publishes their shapes.
• GraphQL: the GraphQL namespace, generated from the schema.
• The SDK's own types: AnvilOptions, GraphQLResponse, RESTResponse, ResponseError, ResponseErrorField, RuntimeError and Abortable.

import type { GraphQL } from '@anvilco/types'

type Packet = GraphQL.Type<'EtchPacket'> // any type in the schema, by name
type WeldFile = GraphQL.Type<'WeldFile'> // input types too: nullable fields are optional
type Args = GraphQL.MutationArgs<'createEtchPacket'> // the arguments of any mutation
type PacketArgs = GraphQL.QueryArgs<'etchPacket'> // …or query

Object types describe the whole object as the schema defines it. A query returns only the fields it selects, so for data you fetched, use the type of your query's result instead.

Custom scalars are typed by GraphQL.Scalars: Date is an ISO 8601 string, JSON is unknown, and Upload is Blob | { data: string; mimetype: string; filename: string } | { url: string; filename?: string }.

GraphQL operations

To run queries and mutations, use @anvilco/core. Its graphql documents are typed against this schema.

The specs these types are generated from also ship with the package, for build tooling: the GraphQL schema at @anvilco/types/schema.graphql and the OpenAPI spec at @anvilco/types/openapi.json. The other Anvil API clients (python-anvil, dotnet-anvil) generate their types from them, so every client describes the same API. Importing @anvilco/types never loads them at runtime.

Regenerating

Types are regenerated from production after every Anvil production deploy (.github/workflows/sync-api-types.yml), which opens a PR when they change. To regenerate by hand:

• REST: yarn workspace @anvilco/types generate:rest refreshes schema/openapi.json from production and rebuilds src/rest.ts from it.
• GraphQL: ANVIL_API_KEY_PROD_BASE64=... yarn workspace @anvilco/types fetch:schema refreshes schema/anvil-schema.graphql from production, then yarn workspace @anvilco/types generate:graphql rebuilds src/graphql/generated/ from it. The second step needs no network access or key, which is what CI checks.