oRPC Router to Contract

Convert a router into a contract, export it safely, and prevent internal exposure.

SKILL.md

GitHub

Router to Contract

A normal router works as a contract router as long as it doesn't include a lazy router.

Unlazy the Router

import { unlazyRouter } from '@orpc/server'

const resolvedRouter = await unlazyRouter(router)

Minify & Export the Contract Router for the Client

  1. Minify and Export to JSON:
import fs from 'node:fs'
import { minifyContractRouter } from '@orpc/contract'

const minifiedRouter = minifyContractRouter(router)

fs.writeFileSync('./contract.json', JSON.stringify(minifiedRouter))

minifyContractRouter preserves only metadata and routing info. All other data is stripped.

  1. Import the Contract JSON on the Client:
import contract from './contract.json'

const link = new OpenAPILink(contract as typeof router, {
  url: 'http://localhost:3000/api',
})

Cast contract to typeof router for type safety, since standard schema types cannot be serialized.