v0.38.0

🚨 Breaking Changes 🚨

• The .key utility in @orpc/vue-query and @orpc/vue-colada no longer accepts refs as values, ensuring that it does not return a reactive value.
• ClientContext in @orpc/client now behaves like the context on the server:
  • It is optional when all fields are optional.
  • It must match the Record<string, any> condition.

🌟 .call Utility 🌟

The .call utility is now available in @orpc/react-query, @orpc/vue-query, and @orpc/vue-colada. It serves as an alias for the client, allowing you to call the client directly.

const client = createORPCClient<typeof router>()
const orpc = createORPCReactQueryUtils(client)

client.ping() === orpc.ping.call()

   🚨 Breaking Changes

• contract, client: Enforce stricter client context  -  by @unnoq in #141 (b4e6d)
• vue-query, vue-colada: Disallow using refs in .key  -  by @unnoq in #137 (a8ad3)

   🚀 Features

• query, colada: Add .call utility for direct client call  -  by @unnoq in #138 (b42ba)

    View changes on GitHub

v0.37.0

🚨 Breaking Changes 🚨

.infiniteOptions input now accepts a function

.infiniteOptions input now requires a function, giving you more control over where the cursor is placed and improves compatibility by removing the requirement for your input to match { cursor?: any }.

const listQuery = useInfiniteQuery(
  orpc.planet.list.infiniteOptions({
    input: cursor => ({ cursor }),
    getNextPageParam: lastPage => (lastPage.at(-1)?.id ?? -1) + 1,
    initialPageParam: 0,
  }),
)

🌟 .spec Helper 🌟

The .spec helper allows you to customize OpenAPI specs based on middlewares and error handling.

Example: Adding security via middleware

import { oo } from '@orpc/openapi'

const authMid = oo.spec(
  os.middleware(({ context, path, next }, input) => {
    // Authentication logic
    return next()
  }),
  {
    security: [{ bearerAuth: [] }],
  },
)

Example: Attaching OpenAPI metadata to errors

const base = os.errors({
  UNAUTHORIZED: oo.spec({}, {
    security: [{ bearerAuth: [] }],
  }),
})

Any procedure using authMid or derived from base will automatically include the security field in the OpenAPI spec.

   🚨 Breaking Changes

• query: Redesign pageParam input to use a function and refine internal types  -  by @unnoq in #126 (172fe)

   🚀 Features

• openapi: .spec for customizing openapi spec  -  by @unnoq in #131 (0787c)

   🏎 Performance

• server: Use empty body for undefined RPC input/output  -  by @unnoq in #128 (854b6)

    View changes on GitHub

v0.36.1

   🐞 Bug Fixes

• server, client: Replace Node.js-dependent modules for better compatibility  -  by @unnoq in #125 (56469)

    View changes on GitHub

v0.36.0

🚨 Breaking Changes 🚨

• The onError, onSuccess, and similar hooks have been completely removed from all APIs. Please use the new interceptors instead.
• The ZodCoercer has been removed. Use the new ZodAutoCoercePlugin instead.

🌟 ZodAutoCoercePlugin 🌟

The ZodAutoCoercePlugin fully replaces ZodCoercer for automatically coercing types based on your schema.

const openAPIHandler = new OpenAPIHandler(router, {
  interceptors: [
    onError((error) => {
      console.error(error)
    }),
  ],
  plugins: [
    new CORSPlugin({
      origin: 'http://localhost:3000',
    }),
    new ResponseHeadersPlugin(),
    new ZodAutoCoercePlugin(),
  ],
})

Note: Do not use ZodAutoCoercePlugin in RPCHandler as it is unnecessary and impacts performance.

   🚨 Breaking Changes

• server:
  • Migrate procedure hooks -> interceptors  -  by @unnoq in #122 (caefe)
  • Replace schema coercers with auto coerce plugins  -  by @unnoq in #123 (97230)

   🚀 Features

• server: Support Timing-Allow-Origin in CORSPlugin  -  by @unnoq and Alexander Niebuhr in #124 (b825e)

    View changes on GitHub

v0.35.1

   🐞 Bug Fixes

• server: Cors plugin not work with wildcard origin  -  by @unnoq in #121 (6acfc)

    View changes on GitHub

v0.35.0

🚨 Breaking Changes 🚨

• Handlers have been rewritten to use native APIs in both fetch and Node.js' HTTP server.
• The options onStart, onSuccess, onError, and onFinish have been removed—use the new interceptors (onStart, onError, etc.) instead.
• OpenAPIServerHandler and OpenAPIServerlessHandler has been removed now OpenAPIHandler optimized for both.

🌟 Plugins 🌟

We're introducing two plugins: CORSPlugin and ResponseHeadersPlugin.

const openAPIHandler = new OpenAPIHandler(router, {
  schemaCoercers: [new ZodCoercer()],
  interceptors: [
    onError((error) => {
      console.error(error);
    }),
  ],
  plugins: [
    new CORSPlugin({ origin: 'http://localhost:3000' }),
    new ResponseHeadersPlugin(),
  ],
});

export interface ORPCContext extends ResponseHeadersPluginContext {
  // ResponseHeadersPluginContext is injected
  user?: z.infer<typeof UserSchema>;
  db?: any;
}

const pub = os
  .$context<ORPCContext>()
  .use(({ context, next }) => {
    context.resHeaders?.set('x-custom-header', 'custom-value');
    return next();
  });

   🚨 Breaking Changes

• server, openapi: Rewrite handlers  -  by @unnoq in #113 (ccd4e)

   🚀 Features

• server:
  • Improve hono compatibility  -  by @unnoq in #119 (c3068)
  • Plugins  -  by @unnoq in #120 (31590)

   🐞 Bug Fixes

• server: Hono helpers not work on hono middleware  -  by @unnoq in #118 (ad070)

    View changes on GitHub

v0.34.0

   🐞 Bug Fixes

• client: Not fallback to return type when output is not defined  -  by @unnoq in #115 (9fe2a)
• server: Implementer exceeds the maximum length...  -  by @unnoq in #112 (c099c)
• zod: Include array items schema in JSON schema output  -  by @HamishWHC in #104 (bc564)

    View changes on GitHub

v0.33.0

🚨 Breaking Changes in Builder 🚨

The builder has been rewritten with breaking changes. Please review the following updates:

• .config has been removed. Use .$route, .$meta, and .$config instead.
• .context has been renamed to .$context.
• .contract has been removed. Use the new implement function instead.
• New .$route: Help you config initial route
• New .$config: Help you config validation behavior (docs later)
• New .meta and .$meta: Similar to .route, but for customizable metadata.
• Builders now have a smaller bundle size.

🌟 Introducing the New Implementer 🌟

The new implement function fully replaces the old .contract. It is designed exclusively for Contract-First development, preventing accidental access to APIs that are not contract-compliant.

Example Usage

const os = implement(contract); // Fully replaces `os` export from @orpc/server

os.router({
  ping: os.ping.handler(() => 'pong'),
});

This update ensures stricter contract adherence while improving maintainability and performance.

   🚨 Breaking Changes

• contract:
  • Stricter implementation for contracts  -  by @unnoq in #97 (ed152)
  • Improve client error type naming  -  by @unnoq (8f101)
• contract, server:
  • Rewrite builders  -  by @unnoq in #110 (32cb7)
• server:
  • Improve context  -  by @unnoq in #96 (43889)

   🚀 Features

• server: Reexport ValidationError from @orpc/contract  -  by @unnoq (f56d2)

    View changes on GitHub

v0.32.0

🚨 configGlobal function replaced with .config method in builders

The configGlobal function has been deprecated and replaced with the .config method for configuring default settings in builders. You can now customize the configuration more easily.

const pub = os
    .context<{user?: {id: string}}>()
    .config({ // Optional configuration to override defaults
        initialRoute: {
            method: 'DELETE', // Set the default HTTP method to DELETE
            inputStructure: 'detailed', // Set the default input structure to 'detailed'
            outputStructure: 'detailed' // Set the default output structure to 'detailed'
        }
    })

   🚀 Features

• contract, server: Replace configGlobal fn with .config in builders  -  by @unnoq in #95 (4e274)

    View changes on GitHub

v0.31.0

🌟 1. Improved Chaining Flow

The chaining flow has been enhanced to reduce confusion and enable more flexible middleware usage.

• You can now insert middleware between .input and .output for more granular control.
• TypeScript will now catch invalid chaining patterns, such as calling .middleware after .use, or chaining .input after another .input. This ensures developers are guided toward the correct sequence at compile time.

🚀 2. Custom Schemas with type

The type utility allows you to create custom schemas:

export const getting = oc.input(type<{ id: string }>());

This simplifies validation and reduces bundle size, especially in scenarios where heavy validation logic is unnecessary.

   🚀 Features

• contract:
  • ContractBuilder can use as a ContractProcedure  -  by @unnoq in #90 (c4a59)
  • New type util for custom schema  -  by @unnoq in #94 (44bdf)
• server:
  • Strict .callable/.actionable cannot chainable after call  -  by @unnoq in #88 (f22c7)
  • Strict builders & allow use middleware between .input/output  -  by @unnoq in #93 (43c0c)

    View changes on GitHub