@orpc/server 0.34.0 → 0.35.1

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

@@ -0,0 +1,44 @@
+import type { AbortSignal, HTTPPath, ORPCError } from '@orpc/contract';
+import type { JsonValue } from '@orpc/shared';
+import type { AnyProcedure } from '../../procedure';
+import type { AnyRouter } from '../../router';
+export interface StandardHeaders {
+    [key: string]: string | string[] | undefined;
+}
+export type StandardBody = undefined | JsonValue | Blob | URLSearchParams | FormData;
+export interface StandardRequest {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    method: string;
+    url: URL;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed base on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body(): Promise<StandardBody>;
+    signal?: AbortSignal;
+}
+export interface StandardResponse {
+    status: number;
+    headers: StandardHeaders;
+    body: StandardBody;
+}
+export type StandardParams = Record<string, string>;
+export type StandardMatchResult = {
+    path: string[];
+    procedure: AnyProcedure;
+    params?: StandardParams;
+} | undefined;
+export interface StandardMatcher {
+    init(router: AnyRouter): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+export interface StandardCodec {
+    encode(output: unknown, procedure: AnyProcedure): StandardResponse;
+    encodeError(error: ORPCError<any, any>): StandardResponse;
+    decode(request: StandardRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/index.d.ts

@@ -17,5 +17,7 @@ export * from './procedure-utils';
 export * from './router';
 export * from './router-accessible-lazy';
 export * from './router-client';
+export * from './utils';
 export { isDefinedError, ORPCError, safe, type, ValidationError } from '@orpc/contract';
+export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 //# sourceMappingURL=index.d.ts.map

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

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

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

@@ -0,0 +1,18 @@
+import type { StandardHandlerInterceptorOptions, StandardHandlerOptions } from '../adapters/standard';
+import type { Context } from '../context';
+import type { Plugin } from './base';
+import { type Value } from '@orpc/shared';
+export interface CORSOptions<TContext extends Context> {
+    origin: Value<string | string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<TContext>]>;
+    allowMethods?: string[];
+    allowHeaders?: string[];
+    maxAge?: number;
+    credentials?: boolean;
+    exposeHeaders?: string[];
+}
+export declare class CORSPlugin<TContext extends Context> implements Plugin<TContext> {
+    private readonly options;
+    constructor(options?: Partial<CORSOptions<TContext>>);
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+//# sourceMappingURL=cors.d.ts.map

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

@@ -0,0 +1,4 @@
+export * from './base';
+export * from './cors';
+export * from './response-headers';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/plugins/response-headers.d.ts

@@ -0,0 +1,10 @@
+import type { StandardHandlerOptions } from '../adapters/standard';
+import type { Context } from '../context';
+import type { Plugin } from './base';
+export interface ResponseHeadersPluginContext {
+    resHeaders?: Headers;
+}
+export declare class ResponseHeadersPlugin<TContext extends ResponseHeadersPluginContext & Context> implements Plugin<TContext> {
+    init(options: StandardHandlerOptions<TContext>): void;
+}
+//# sourceMappingURL=response-headers.d.ts.map

package/dist/src/utils.d.ts

@@ -0,0 +1,24 @@
+import type { AnyContractProcedure, AnyContractRouter, HTTPPath } from '@orpc/contract';
+import type { Lazy } from './lazy';
+import type { AnyProcedure } from './procedure';
+import type { AnyRouter } from './router';
+export interface EachContractProcedureOptions {
+    router: AnyRouter | AnyContractRouter;
+    path: string[];
+}
+export interface EachContractProcedureCallbackOptions {
+    contract: AnyContractProcedure;
+    path: string[];
+}
+export interface EachContractProcedureLaziedOptions {
+    lazied: Lazy<AnyProcedure> | Lazy<Record<string, AnyRouter> | AnyProcedure>;
+    path: string[];
+}
+export declare function eachContractProcedure(options: EachContractProcedureOptions, callback: (options: EachContractProcedureCallbackOptions) => void, laziedOptions?: EachContractProcedureLaziedOptions[]): EachContractProcedureLaziedOptions[];
+export declare function eachAllContractProcedure(options: EachContractProcedureOptions, callback: (options: EachContractProcedureCallbackOptions) => void): Promise<void>;
+export declare function convertPathToHttpPath(path: string[]): HTTPPath;
+/**
+ * Create a new procedure that ensure the contract is applied to the procedure.
+ */
+export declare function createContractedProcedure(contract: AnyContractProcedure, procedure: AnyProcedure): AnyProcedure;
+//# sourceMappingURL=utils.d.ts.map

package/dist/standard.js

@@ -0,0 +1,17 @@
+import {
+  RPCCodec,
+  RPCMatcher,
+  RPCSerializer,
+  StandardHandler,
+  serializeRPCJson
+} from "./chunk-SUGWQSMQ.js";
+import "./chunk-NOA3GBJQ.js";
+import "./chunk-OWMUECGT.js";
+export {
+  RPCCodec,
+  RPCMatcher,
+  RPCSerializer,
+  StandardHandler,
+  serializeRPCJson
+};
+//# sourceMappingURL=standard.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/server",
   "type": "module",
-  "version": "0.34.0",
+  "version": "0.35.1",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -19,6 +19,16 @@
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     },
+    "./plugins": {
+      "types": "./dist/src/plugins/index.d.ts",
+      "import": "./dist/plugins.js",
+      "default": "./dist/plugins.js"
+    },
+    "./standard": {
+      "types": "./dist/src/adapters/standard/index.d.ts",
+      "import": "./dist/standard.js",
+      "default": "./dist/standard.js"
+    },
     "./fetch": {
       "types": "./dist/src/adapters/fetch/index.d.ts",
       "import": "./dist/fetch.js",
@@ -53,8 +63,12 @@
     "next": ">=14.0.0"
   },
   "dependencies": {
-    "@orpc/contract": "0.34.0",
-    "@orpc/shared": "0.34.0"
+    "content-disposition": "^0.5.4",
+    "@orpc/contract": "0.35.1",
+    "@orpc/shared": "0.35.1"
+  },
+  "devDependencies": {
+    "light-my-request": "^6.5.1"
   },
   "scripts": {
     "build": "tsup --onSuccess='tsc -b --noCheck'",

package/dist/chunk-ESTRJAOX.js

@@ -1,299 +0,0 @@
-import {
-  __export,
-  createProcedureClient,
-  getRouterChild,
-  isProcedure,
-  unlazy
-} from "./chunk-KK4SDLC7.js";
-
-// src/adapters/fetch/super-json.ts
-var super_json_exports = {};
-__export(super_json_exports, {
-  deserialize: () => deserialize,
-  serialize: () => serialize
-});
-
-// ../../node_modules/.pnpm/is-what@5.0.2/node_modules/is-what/dist/getType.js
-function getType(payload) {
-  return Object.prototype.toString.call(payload).slice(8, -1);
-}
-
-// ../../node_modules/.pnpm/is-what@5.0.2/node_modules/is-what/dist/isPlainObject.js
-function isPlainObject(payload) {
-  if (getType(payload) !== "Object")
-    return false;
-  const prototype = Object.getPrototypeOf(payload);
-  return !!prototype && prototype.constructor === Object && prototype === Object.prototype;
-}
-
-// src/adapters/fetch/super-json.ts
-function serialize(value, segments = [], meta = []) {
-  if (typeof value === "bigint") {
-    meta.push(["bigint", segments]);
-    return { data: value.toString(), meta };
-  }
-  if (value instanceof Date) {
-    meta.push(["date", segments]);
-    const data = Number.isNaN(value.getTime()) ? "Invalid Date" : value.toISOString();
-    return { data, meta };
-  }
-  if (Number.isNaN(value)) {
-    meta.push(["nan", segments]);
-    return { data: "NaN", meta };
-  }
-  if (value instanceof RegExp) {
-    meta.push(["regexp", segments]);
-    return { data: value.toString(), meta };
-  }
-  if (value instanceof URL) {
-    meta.push(["url", segments]);
-    return { data: value.toString(), meta };
-  }
-  if (isPlainObject(value)) {
-    const data = {};
-    for (const k in value) {
-      data[k] = serialize(value[k], [...segments, k], meta).data;
-    }
-    return { data, meta };
-  }
-  if (Array.isArray(value)) {
-    const data = value.map((v, i) => {
-      if (v === void 0) {
-        meta.push(["undefined", [...segments, i]]);
-        return null;
-      }
-      return serialize(v, [...segments, i], meta).data;
-    });
-    return { data, meta };
-  }
-  if (value instanceof Set) {
-    const result = serialize(Array.from(value), segments, meta);
-    meta.push(["set", segments]);
-    return result;
-  }
-  if (value instanceof Map) {
-    const result = serialize(Array.from(value.entries()), segments, meta);
-    meta.push(["map", segments]);
-    return result;
-  }
-  return { data: value, meta };
-}
-function deserialize({
-  data,
-  meta
-}) {
-  if (meta.length === 0) {
-    return data;
-  }
-  const ref = { data };
-  for (const [type, segments] of meta) {
-    let currentRef = ref;
-    let preSegment = "data";
-    for (let i = 0; i < segments.length; i++) {
-      currentRef = currentRef[preSegment];
-      preSegment = segments[i];
-    }
-    switch (type) {
-      case "nan":
-        currentRef[preSegment] = Number.NaN;
-        break;
-      case "bigint":
-        currentRef[preSegment] = BigInt(currentRef[preSegment]);
-        break;
-      case "date":
-        currentRef[preSegment] = new Date(currentRef[preSegment]);
-        break;
-      case "regexp": {
-        const [, pattern, flags] = currentRef[preSegment].match(/^\/(.*)\/([a-z]*)$/);
-        currentRef[preSegment] = new RegExp(pattern, flags);
-        break;
-      }
-      case "url":
-        currentRef[preSegment] = new URL(currentRef[preSegment]);
-        break;
-      case "undefined":
-        currentRef[preSegment] = void 0;
-        break;
-      case "map":
-        currentRef[preSegment] = new Map(currentRef[preSegment]);
-        break;
-      case "set":
-        currentRef[preSegment] = new Set(currentRef[preSegment]);
-        break;
-      /* v8 ignore next 3 */
-      default: {
-        const _expected = type;
-      }
-    }
-  }
-  return ref.data;
-}
-
-// src/adapters/fetch/orpc-payload-codec.ts
-import { ORPCError } from "@orpc/contract";
-import { findDeepMatches, set } from "@orpc/shared";
-var ORPCPayloadCodec = class {
-  /**
-   * If method is GET, the payload will be encoded as query string.
-   * If method is GET and payload contain file, the method will be fallback to fallbackMethod. (fallbackMethod = GET will force to use GET method)
-   */
-  encode(payload, method = "POST", fallbackMethod = "POST") {
-    const { data, meta } = serialize(payload);
-    const { maps, values } = findDeepMatches((v) => v instanceof Blob, data);
-    if (method === "GET" && (values.length === 0 || fallbackMethod === "GET")) {
-      const query = new URLSearchParams({
-        data: JSON.stringify(data),
-        meta: JSON.stringify(meta)
-      });
-      return {
-        query,
-        method: "GET"
-      };
-    }
-    const nonGETMethod = method === "GET" ? fallbackMethod : method;
-    if (values.length > 0) {
-      const form = new FormData();
-      if (data !== void 0) {
-        form.append("data", JSON.stringify(data));
-      }
-      form.append("meta", JSON.stringify(meta));
-      form.append("maps", JSON.stringify(maps));
-      for (const i in values) {
-        const value = values[i];
-        form.append(i, value);
-      }
-      return {
-        body: form,
-        method: nonGETMethod
-      };
-    }
-    return {
-      body: JSON.stringify({ data, meta }),
-      headers: new Headers({
-        "content-type": "application/json"
-      }),
-      method: nonGETMethod
-    };
-  }
-  async decode(re) {
-    try {
-      if ("method" in re && re.method === "GET") {
-        const url = new URL(re.url);
-        const query = url.searchParams;
-        const data = JSON.parse(query.getAll("data").at(-1));
-        const meta = JSON.parse(query.getAll("meta").at(-1));
-        return deserialize({
-          data,
-          meta
-        });
-      }
-      if (re.headers.get("content-type")?.startsWith("multipart/form-data")) {
-        const form = await re.formData();
-        const rawData = form.get("data");
-        const rawMeta = form.get("meta");
-        const rawMaps = form.get("maps");
-        let data = JSON.parse(rawData);
-        const meta = JSON.parse(rawMeta);
-        const maps = JSON.parse(rawMaps);
-        for (const i in maps) {
-          data = set(data, maps[i], form.get(i));
-        }
-        return deserialize({
-          data,
-          meta
-        });
-      }
-      const json = await re.json();
-      return deserialize(json);
-    } catch (e) {
-      throw new ORPCError("BAD_REQUEST", {
-        message: "Cannot parse request/response. Please check the request/response body and Content-Type header.",
-        cause: e
-      });
-    }
-  }
-};
-
-// src/adapters/fetch/orpc-procedure-matcher.ts
-import { trim } from "@orpc/shared";
-var ORPCProcedureMatcher = class {
-  constructor(router) {
-    this.router = router;
-  }
-  async match(pathname) {
-    const path = trim(pathname, "/").split("/").map(decodeURIComponent);
-    const match = getRouterChild(this.router, ...path);
-    const { default: maybeProcedure } = await unlazy(match);
-    if (!isProcedure(maybeProcedure)) {
-      return void 0;
-    }
-    return {
-      procedure: maybeProcedure,
-      path
-    };
-  }
-};
-
-// src/adapters/fetch/orpc-handler.ts
-import { ORPCError as ORPCError2 } from "@orpc/contract";
-import { executeWithHooks, trim as trim2 } from "@orpc/shared";
-var RPCHandler = class {
-  constructor(router, options) {
-    this.options = options;
-    this.procedureMatcher = options?.procedureMatcher ?? new ORPCProcedureMatcher(router);
-    this.payloadCodec = options?.payloadCodec ?? new ORPCPayloadCodec();
-  }
-  procedureMatcher;
-  payloadCodec;
-  async handle(request, ...[options]) {
-    const context = options?.context ?? {};
-    const execute = async () => {
-      const url = new URL(request.url);
-      const pathname = `/${trim2(url.pathname.replace(options?.prefix ?? "", ""), "/")}`;
-      const match = await this.procedureMatcher.match(pathname);
-      if (!match) {
-        return { matched: false, response: void 0 };
-      }
-      const input = await this.payloadCodec.decode(request);
-      const client = createProcedureClient(match.procedure, {
-        context,
-        path: match.path
-      });
-      const output = await client(input, { signal: request.signal });
-      const { body, headers } = this.payloadCodec.encode(output);
-      const response = new Response(body, { headers });
-      return { matched: true, response };
-    };
-    try {
-      const result = await executeWithHooks({
-        context,
-        execute,
-        input: request,
-        hooks: this.options,
-        meta: {
-          signal: request.signal
-        }
-      });
-      return result;
-    } catch (e) {
-      const error = e instanceof ORPCError2 ? e : new ORPCError2("INTERNAL_SERVER_ERROR", {
-        message: "Internal server error",
-        cause: e
-      });
-      const { body, headers } = this.payloadCodec.encode(error.toJSON());
-      const response = new Response(body, {
-        headers,
-        status: error.status
-      });
-      return { matched: true, response };
-    }
-  }
-};
-
-export {
-  super_json_exports,
-  ORPCPayloadCodec,
-  ORPCProcedureMatcher,
-  RPCHandler
-};
-//# sourceMappingURL=chunk-ESTRJAOX.js.map

package/dist/chunk-WUOGVGWG.js

@@ -1 +0,0 @@
-//# sourceMappingURL=chunk-WUOGVGWG.js.map

package/dist/src/adapters/fetch/orpc-handler.d.ts

@@ -1,20 +0,0 @@
-import type { Hooks } from '@orpc/shared';
-import type { Context } from '../../context';
-import type { Router } from '../../router';
-import type { FetchHandler, FetchHandleRest, FetchHandleResult } from './types';
-import { type PublicORPCPayloadCodec } from './orpc-payload-codec';
-import { type PublicORPCProcedureMatcher } from './orpc-procedure-matcher';
-export type RPCHandlerOptions<T extends Context> = Hooks<Request, FetchHandleResult, T, {
-    signal?: AbortSignal;
-}> & {
-    procedureMatcher?: PublicORPCProcedureMatcher;
-    payloadCodec?: PublicORPCPayloadCodec;
-};
-export declare class RPCHandler<T extends Context> implements FetchHandler<T> {
-    private readonly options?;
-    private readonly procedureMatcher;
-    private readonly payloadCodec;
-    constructor(router: Router<T, any>, options?: NoInfer<RPCHandlerOptions<T>> | undefined);
-    handle(request: Request, ...[options]: FetchHandleRest<T>): Promise<FetchHandleResult>;
-}
-//# sourceMappingURL=orpc-handler.d.ts.map

package/dist/src/adapters/fetch/orpc-payload-codec.d.ts

@@ -1,16 +0,0 @@
-import { type HTTPMethod } from '@orpc/contract';
-export declare class ORPCPayloadCodec {
-    /**
-     * If method is GET, the payload will be encoded as query string.
-     * If method is GET and payload contain file, the method will be fallback to fallbackMethod. (fallbackMethod = GET will force to use GET method)
-     */
-    encode(payload: unknown, method?: HTTPMethod, fallbackMethod?: HTTPMethod): {
-        query?: URLSearchParams;
-        body?: FormData | string;
-        headers?: Headers;
-        method: HTTPMethod;
-    };
-    decode(re: Request | Response): Promise<unknown>;
-}
-export type PublicORPCPayloadCodec = Pick<ORPCPayloadCodec, keyof ORPCPayloadCodec>;
-//# sourceMappingURL=orpc-payload-codec.d.ts.map

package/dist/src/adapters/fetch/orpc-procedure-matcher.d.ts

@@ -1,12 +0,0 @@
-import type { AnyProcedure } from '../../procedure';
-import type { AnyRouter } from '../../router';
-export declare class ORPCProcedureMatcher {
-    private readonly router;
-    constructor(router: AnyRouter);
-    match(pathname: string): Promise<{
-        path: string[];
-        procedure: AnyProcedure;
-    } | undefined>;
-}
-export type PublicORPCProcedureMatcher = Pick<ORPCProcedureMatcher, keyof ORPCProcedureMatcher>;
-//# sourceMappingURL=orpc-procedure-matcher.d.ts.map

package/dist/src/adapters/fetch/super-json.d.ts

@@ -1,12 +0,0 @@
-import type { Segment } from '@orpc/shared';
-export type JSONExtraType = 'bigint' | 'date' | 'nan' | 'undefined' | 'set' | 'map' | 'regexp' | 'url';
-export type JSONMeta = [JSONExtraType, Segment[]][];
-export declare function serialize(value: unknown, segments?: Segment[], meta?: JSONMeta): {
-    data: unknown;
-    meta: JSONMeta;
-};
-export declare function deserialize({ data, meta, }: {
-    data: unknown;
-    meta: JSONMeta;
-}): unknown;
-//# sourceMappingURL=super-json.d.ts.map

package/dist/src/adapters/node/orpc-handler.d.ts

@@ -1,12 +0,0 @@
-import type { ServerResponse } from 'node:http';
-import type { Context } from '../../context';
-import type { Router } from '../../router';
-import type { RPCHandlerOptions } from '../fetch/orpc-handler';
-import type { RequestHandler, RequestHandleRest, RequestHandleResult } from './types';
-import { type ExpressableIncomingMessage } from './request-listener';
-export declare class RPCHandler<T extends Context> implements RequestHandler<T> {
-    private readonly orpcFetchHandler;
-    constructor(router: Router<T, any>, options?: NoInfer<RPCHandlerOptions<T>>);
-    handle(req: ExpressableIncomingMessage, res: ServerResponse, ...rest: RequestHandleRest<T>): Promise<RequestHandleResult>;
-}
-//# sourceMappingURL=orpc-handler.d.ts.map

package/dist/src/adapters/node/request-listener.d.ts

@@ -1,28 +0,0 @@
-import type { IncomingMessage, ServerResponse } from 'node:http';
-export interface ExpressableIncomingMessage extends IncomingMessage {
-    originalUrl?: string;
-}
-/**
- * Creates a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) object from a Node.js
- * [`IncomingMessage`](https://nodejs.org/api/http.html#class-httpincomingmessage) and
- * [`http.ServerResponse`](https://nodejs.org/api/http.html#class-httpserverresponse) pair.
- *
- */
-export declare function createRequest(req: ExpressableIncomingMessage, res: ServerResponse): Request;
-/**
- * Creates a [`Headers`](https://developer.mozilla.org/en-US/docs/Web/API/Headers) object from the headers
- * in a Node.js [`IncomingMessage`](https://nodejs.org/api/http.html#class-httpincomingmessage).
- *
- * @param req The incoming request object.
- * @returns A headers object.
- */
-export declare function createHeaders(req: IncomingMessage): Headers;
-/**
- * Sends a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) to the client using the
- * Node.js [`http.ServerResponse`](https://nodejs.org/api/http.html#class-httpserverresponse) object.
- *
- * @param res The server response object.
- * @param response The response to send.
- */
-export declare function sendResponse(res: ServerResponse, response: Response): Promise<void>;
-//# sourceMappingURL=request-listener.d.ts.map