@orpc/server 0.41.1 → 0.41.2

package/README.md

@@ -0,0 +1,118 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/server">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fserver?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**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), 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
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@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 '@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 } }
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/{chunk-KPT6FDBK.js → chunk-47YYO5JS.js}

@@ -2,7 +2,7 @@ import {
   RPCCodec,
   RPCMatcher,
   StandardHandler
-} from "./chunk-LXOL226G.js";
+} from "./chunk-77FU7QSO.js";
 
 // src/adapters/fetch/rpc-handler.ts
 import { toFetchResponse, toStandardRequest } from "@orpc/server-standard-fetch";
@@ -29,4 +29,4 @@ var RPCHandler = class {
 export {
   RPCHandler
 };
-//# sourceMappingURL=chunk-KPT6FDBK.js.map
+//# sourceMappingURL=chunk-47YYO5JS.js.map

package/dist/{chunk-LXOL226G.js → chunk-77FU7QSO.js}

@@ -9,7 +9,7 @@ import {
 } from "./chunk-MHVECKBC.js";
 import {
   CompositePlugin
-} from "./chunk-XI6WGCB3.js";
+} from "./chunk-WQNNSBXW.js";
 
 // src/adapters/standard/handler.ts
 import { ORPCError, toORPCError } from "@orpc/client";
@@ -19,14 +19,14 @@ var StandardHandler = class {
     this.matcher = matcher;
     this.codec = codec;
     this.options = options;
-    this.plugin = new CompositePlugin(options?.plugins);
+    this.plugin = new CompositePlugin(options.plugins);
     this.plugin.init(this.options);
     this.matcher.init(router);
   }
   plugin;
   handle(request, ...[options]) {
     return intercept(
-      this.options.interceptorsRoot ?? [],
+      this.options.rootInterceptors ?? [],
       {
         request,
         ...options,
@@ -47,12 +47,11 @@ var StandardHandler = class {
               if (!match) {
                 return { matched: false, response: void 0 };
               }
-              const clientOptions = {
+              const client = createProcedureClient(match.procedure, {
                 context: interceptorOptions2.context,
-                path: match.path
-              };
-              this.plugin.beforeCreateProcedureClient(clientOptions, interceptorOptions2);
-              const client = createProcedureClient(match.procedure, clientOptions);
+                path: match.path,
+                interceptors: this.options.clientInterceptors
+              });
               isDecoding = true;
               const input = await this.codec.decode(request, match.params, match.procedure);
               isDecoding = false;
@@ -179,4 +178,4 @@ export {
   RPCCodec,
   RPCMatcher
 };
-//# sourceMappingURL=chunk-LXOL226G.js.map
+//# sourceMappingURL=chunk-77FU7QSO.js.map

package/dist/{chunk-XI6WGCB3.js → chunk-WQNNSBXW.js}

@@ -8,11 +8,6 @@ var CompositePlugin = class {
       plugin.init?.(options);
     }
   }
-  beforeCreateProcedureClient(clientOptions, interceptorOptions) {
-    for (const plugin of this.plugins) {
-      plugin.beforeCreateProcedureClient?.(clientOptions, interceptorOptions);
-    }
-  }
 };
 
 // src/plugins/cors.ts
@@ -30,8 +25,8 @@ var CORSPlugin = class {
     };
   }
   init(options) {
-    options.interceptorsRoot ??= [];
-    options.interceptorsRoot.unshift(async (interceptorOptions) => {
+    options.rootInterceptors ??= [];
+    options.rootInterceptors.unshift(async (interceptorOptions) => {
       if (interceptorOptions.request.method === "OPTIONS") {
         const resHeaders = {};
         if (this.options.maxAge !== void 0) {
@@ -57,7 +52,7 @@ var CORSPlugin = class {
       }
       return interceptorOptions.next();
     });
-    options.interceptorsRoot.unshift(async (interceptorOptions) => {
+    options.rootInterceptors.unshift(async (interceptorOptions) => {
       const result = await interceptorOptions.next();
       if (!result.matched) {
         return result;
@@ -94,8 +89,8 @@ var CORSPlugin = class {
 // src/plugins/response-headers.ts
 var ResponseHeadersPlugin = class {
   init(options) {
-    options.interceptorsRoot ??= [];
-    options.interceptorsRoot.push(async (interceptorOptions) => {
+    options.rootInterceptors ??= [];
+    options.rootInterceptors.push(async (interceptorOptions) => {
       const headers = new Headers();
       interceptorOptions.context.resHeaders = headers;
       const result = await interceptorOptions.next();
@@ -122,4 +117,4 @@ export {
   CORSPlugin,
   ResponseHeadersPlugin
 };
-//# sourceMappingURL=chunk-XI6WGCB3.js.map
+//# sourceMappingURL=chunk-WQNNSBXW.js.map

package/dist/fetch.js

@@ -1,9 +1,9 @@
 import {
   RPCHandler
-} from "./chunk-KPT6FDBK.js";
-import "./chunk-LXOL226G.js";
+} from "./chunk-47YYO5JS.js";
+import "./chunk-77FU7QSO.js";
 import "./chunk-MHVECKBC.js";
-import "./chunk-XI6WGCB3.js";
+import "./chunk-WQNNSBXW.js";
 export {
   RPCHandler
 };

package/dist/hono.js

@@ -1,9 +1,9 @@
 import {
   RPCHandler
-} from "./chunk-KPT6FDBK.js";
-import "./chunk-LXOL226G.js";
+} from "./chunk-47YYO5JS.js";
+import "./chunk-77FU7QSO.js";
 import "./chunk-MHVECKBC.js";
-import "./chunk-XI6WGCB3.js";
+import "./chunk-WQNNSBXW.js";
 
 // src/adapters/hono/middleware.ts
 import { value } from "@orpc/shared";

package/dist/next.js

@@ -1,9 +1,9 @@
 import {
   RPCHandler
-} from "./chunk-KPT6FDBK.js";
-import "./chunk-LXOL226G.js";
+} from "./chunk-47YYO5JS.js";
+import "./chunk-77FU7QSO.js";
 import "./chunk-MHVECKBC.js";
-import "./chunk-XI6WGCB3.js";
+import "./chunk-WQNNSBXW.js";
 
 // src/adapters/next/serve.ts
 import { value } from "@orpc/shared";

package/dist/node.js

@@ -2,9 +2,9 @@ import {
   RPCCodec,
   RPCMatcher,
   StandardHandler
-} from "./chunk-LXOL226G.js";
+} from "./chunk-77FU7QSO.js";
 import "./chunk-MHVECKBC.js";
-import "./chunk-XI6WGCB3.js";
+import "./chunk-WQNNSBXW.js";
 
 // src/adapters/node/rpc-handler.ts
 import { sendStandardResponse, toStandardRequest } from "@orpc/server-standard-node";

package/dist/plugins.js

@@ -2,7 +2,7 @@ import {
   CORSPlugin,
   CompositePlugin,
   ResponseHeadersPlugin
-} from "./chunk-XI6WGCB3.js";
+} from "./chunk-WQNNSBXW.js";
 export {
   CORSPlugin,
   CompositePlugin,

package/dist/src/adapters/standard/handler.d.ts

@@ -1,9 +1,9 @@
-import type { ErrorMap, HTTPPath, Meta, Schema } from '@orpc/contract';
+import type { ErrorFromErrorMap, HTTPPath, Meta, Schema, SchemaOutput } from '@orpc/contract';
 import type { StandardRequest, StandardResponse } from '@orpc/server-standard';
 import type { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
 import type { Context } from '../../context';
 import type { Plugin } from '../../plugins';
-import type { CreateProcedureClientOptions } from '../../procedure-client';
+import type { ProcedureClientInterceptorOptions } from '../../procedure-client';
 import type { Router } from '../../router';
 import type { StandardCodec, StandardMatcher } from './types';
 export type StandardHandleOptions<T extends Context> = {
@@ -26,9 +26,6 @@ export type StandardHandleResult = {
 export type StandardHandlerInterceptorOptions<TContext extends Context> = WellStandardHandleOptions<TContext> & {
     request: StandardRequest;
 };
-export type WellCreateProcedureClientOptions<TContext extends Context> = CreateProcedureClientOptions<TContext, Schema, Schema, unknown, ErrorMap, Meta, Record<never, never>> & {
-    context: TContext;
-};
 export interface StandardHandlerOptions<TContext extends Context> {
     plugins?: Plugin<TContext>[];
     /**
@@ -36,9 +33,14 @@ export interface StandardHandlerOptions<TContext extends Context> {
      */
     interceptors?: Interceptor<StandardHandlerInterceptorOptions<TContext>, StandardHandleResult, unknown>[];
     /**
-     * Interceptors at the root level, helpful when you want override the response
+     * Interceptors at the root level, helpful when you want override the request/response
+     */
+    rootInterceptors?: Interceptor<StandardHandlerInterceptorOptions<TContext>, StandardHandleResult, unknown>[];
+    /**
+     *
+     * Interceptors for procedure client.
      */
-    interceptorsRoot?: Interceptor<StandardHandlerInterceptorOptions<TContext>, StandardHandleResult, unknown>[];
+    clientInterceptors?: Interceptor<ProcedureClientInterceptorOptions<TContext, Schema, Record<never, never>, Meta>, SchemaOutput<Schema, unknown>, ErrorFromErrorMap<Record<never, never>>>[];
 }
 export declare class StandardHandler<T extends Context> {
     private readonly matcher;

package/dist/src/plugins/base.d.ts

@@ -1,13 +1,11 @@
-import type { StandardHandlerInterceptorOptions, StandardHandlerOptions, WellCreateProcedureClientOptions } from '../adapters/standard';
+import type { StandardHandlerOptions } from '../adapters/standard';
 import type { Context } from '../context';
 export interface Plugin<TContext extends Context> {
     init?(options: StandardHandlerOptions<TContext>): void;
-    beforeCreateProcedureClient?(clientOptions: WellCreateProcedureClientOptions<TContext>, interceptorOptions: StandardHandlerInterceptorOptions<TContext>): void;
 }
 export declare class CompositePlugin<TContext extends Context> implements Plugin<TContext> {
     private readonly plugins;
     constructor(plugins?: Plugin<TContext>[]);
     init(options: StandardHandlerOptions<TContext>): void;
-    beforeCreateProcedureClient(clientOptions: WellCreateProcedureClientOptions<TContext>, interceptorOptions: StandardHandlerInterceptorOptions<TContext>): void;
 }
 //# sourceMappingURL=base.d.ts.map

package/dist/standard.js

@@ -2,9 +2,9 @@ import {
   RPCCodec,
   RPCMatcher,
   StandardHandler
-} from "./chunk-LXOL226G.js";
+} from "./chunk-77FU7QSO.js";
 import "./chunk-MHVECKBC.js";
-import "./chunk-XI6WGCB3.js";
+import "./chunk-WQNNSBXW.js";
 export {
   RPCCodec,
   RPCMatcher,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/server",
   "type": "module",
-  "version": "0.41.1",
+  "version": "0.41.2",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -66,9 +66,9 @@
     "@orpc/server-standard": "^0.4.0",
     "@orpc/server-standard-fetch": "^0.4.0",
     "@orpc/server-standard-node": "^0.4.0",
-    "@orpc/client": "0.41.1",
-    "@orpc/shared": "0.41.1",
-    "@orpc/contract": "0.41.1"
+    "@orpc/contract": "0.41.2",
+    "@orpc/client": "0.41.2",
+    "@orpc/shared": "0.41.2"
   },
   "devDependencies": {
     "light-my-request": "^6.5.1"