oRPC Router to Contract
Convert a router into a contract, export it safely, and prevent internal exposure.
SKILL.mdskills/orpc-router-to-contract/SKILL.md
GitHubRouter 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
- 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))
minifyContractRouterpreserves only metadata and routing info. All other data is stripped.
- 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
contracttotypeof routerfor type safety, since standard schema types cannot be serialized.