Typesafe APIs Made Simple 🪄
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
---
## Highlights
- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
## Documentation
You can find the full documentation [here](https://orpc.unnoq.com).
## Packages
- [@rubenbupe/orpc-contract](https://www.npmjs.com/package/@rubenbupe/orpc-contract): Build your API contract.
- [@rubenbupe/orpc-server](https://www.npmjs.com/package/@rubenbupe/orpc-server): Build your API or implement API contract.
- [@rubenbupe/orpc-client](https://www.npmjs.com/package/@rubenbupe/orpc-client): Consume your API on the client with type-safety.
- [@rubenbupe/orpc-react](https://www.npmjs.com/package/@rubenbupe/orpc-react): Utilities for integrating oRPC with React and React Server Actions.
- [@rubenbupe/orpc-react-query](https://www.npmjs.com/package/@rubenbupe/orpc-react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
- [@rubenbupe/orpc-vue-query](https://www.npmjs.com/package/@rubenbupe/orpc-vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
- [@rubenbupe/orpc-solid-query](https://www.npmjs.com/package/@rubenbupe/orpc-solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
- [@rubenbupe/orpc-svelte-query](https://www.npmjs.com/package/@rubenbupe/orpc-svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
- [@rubenbupe/orpc-vue-colada](https://www.npmjs.com/package/@rubenbupe/orpc-vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
- [@rubenbupe/orpc-openapi](https://www.npmjs.com/package/@rubenbupe/orpc-openapi): Generate OpenAPI specs and handle OpenAPI requests.
- [@rubenbupe/orpc-zod](https://www.npmjs.com/package/@rubenbupe/orpc-zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
- [@rubenbupe/orpc-valibot](https://www.npmjs.com/package/@rubenbupe/orpc-valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
- [@rubenbupe/orpc-arktype](https://www.npmjs.com/package/@rubenbupe/orpc-arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
## `@rubenbupe/orpc-server`
Build your API or implement API contract. Read the [documentation](https://orpc.unnoq.com/docs/getting-started) for more information.
```ts
import type { IncomingHttpHeaders } from 'node:http'
import { ORPCError, os } from '@rubenbupe/orpc-server'
import { z } from 'zod'
const PlanetSchema = z.object({
id: z.number().int().min(1),
name: z.string(),
description: z.string().optional(),
})
export const listPlanet = os
.input(
z.object({
limit: z.number().int().min(1).max(100).optional(),
cursor: z.number().int().min(0).default(0),
}),
)
.handler(async ({ input }) => {
// your list code here
return [{ id: 1, name: 'name' }]
})
export const findPlanet = os
.input(PlanetSchema.pick({ id: true }))
.handler(async ({ input }) => {
// your find code here
return { id: 1, name: 'name' }
})
export const createPlanet = os
.$context<{ headers: IncomingHttpHeaders }>()
.use(({ context, next }) => {
const user = parseJWT(context.headers.authorization?.split(' ')[1])
if (user) {
return next({ context: { user } })
}
throw new ORPCError('UNAUTHORIZED')
})
.input(PlanetSchema.omit({ id: true }))
.handler(async ({ input, context }) => {
// your create code here
return { id: 1, name: 'name' }
})
export const router = { planet: { list: listPlanet, find: findPlanet, create: createPlanet } }
```
## Sponsors
## License
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
