@orpc/server 2.0.0-beta.47 → 2.0.0-beta.48

package/dist/adapters/message-port/index.d.ts

@@ -1,77 +0,0 @@
-import { SupportedMessagePort } from '@orpc/client/message-port';
-import { Value, Promisable, MaybeOptionalOptions } from '@orpc/shared';
-import { ServerPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
-import { Context } from '../../index.js';
-import { StandardHandler, StandardHandlerOptions } from '../standard/index.js';
-import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
-import { Router } from '../../index.js';
-import { RPCHandlerCodecOptions } from '../standard/index.js';
-import '@orpc/client';
-import '@orpc/contract';
-import '@standard-server/core';
-
-type DecodedResponseMessage = ConstructorParameters<typeof ServerPeer>[0] extends (message: infer TMessage) => unknown ? TMessage : never;
-interface MessagePortHandlerOptions<_T extends Context> {
-    /**
-     * By default, oRPC encodes peer messages as strings or binary data before sending them over the message port.
-     * Use this option to bypass encoding and leverage the full capabilities of the
-     * [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
-     * such as transferring object ownership or supporting non-serializable objects like `OffscreenCanvas` or improving performance.
-     *
-     * @remarks
-     * **Note**: Returning `null` or `undefined` disables this feature.
-     * **Warning**: Ensure your message port implementation supports `transferable` objects before enabling this.
-     */
-    experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedResponseMessage, port: SupportedMessagePort]> | undefined;
-    /**
-     * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
-     */
-    encodePeerMessage?: EncodePeerMessageOptions | undefined;
-    /**
-     * Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
-     */
-    decodePeerMessage?: DecodePeerMessageOptions | undefined;
-}
-declare class MessagePortHandler<T extends Context> {
-    private readonly handler;
-    private readonly peers;
-    private readonly transfer;
-    private readonly encodePeerMessageOptions;
-    private readonly decodePeerMessageOptions;
-    constructor(handler: StandardHandler<T>, options?: NoInfer<MessagePortHandlerOptions<T>>);
-    /**
-     * Attaches message and close listeners to a message port.
-     *
-     * Prefer this over calling `.message()` and `.close()` manually.
-     */
-    upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
-    /**
-     * Handles a single message received from a message port.
-     *
-     * @param port The message port instance. Use the same instance for all messages.
-     */
-    message(port: SupportedMessagePort, data: unknown, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
-        matched: boolean;
-    }>;
-    /**
-     * Cleans up peer state for a closed message port.
-     *
-     * @param port The same message port instance passed to `.message()`.
-     */
-    close(port: SupportedMessagePort): Promise<void>;
-}
-
-interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, MessagePortHandlerOptions<T> {
-}
-/**
- * Serves an oRPC router over the RPC protocol on a message port,
- * such as browser extensions, Electron, or worker threads.
- *
- * @see {@link https://orpc.dev/docs/adapters/message-port | Message Port Adapter}
- */
-declare class RPCHandler<T extends Context> extends MessagePortHandler<T> {
-    constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
-}
-
-export { MessagePortHandler, RPCHandler };
-export type { MessagePortHandlerOptions, RPCHandlerOptions };

package/dist/adapters/node/index.d.ts

@@ -1,44 +0,0 @@
-export { R as BodyLimitPlugin } from '../../shared/server.CgBF3Vj1.js';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import { SendStandardResponseOptions, NodeHttpRequest, NodeHttpResponse } from '@standard-server/node';
-import { Context } from '../../index.js';
-import { StandardHandler, StandardHandlerOptions } from '../standard/index.js';
-import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
-import { Router } from '../../index.js';
-import { RPCHandlerCodecOptions } from '../standard/index.js';
-import '@orpc/client';
-import '@orpc/contract';
-import '@standard-server/core';
-
-type NodeHttpHandlerHandleResult = {
-    matched: true;
-} | {
-    matched: false;
-};
-interface NodeHttpHandlerOptions<_T extends Context> {
-    /**
-     * Custom options for `sendStandardResponse`, used to send a `Standard Response`
-     */
-    sendStandardResponse?: SendStandardResponseOptions | undefined;
-}
-declare class NodeHttpHandler<T extends Context> {
-    private readonly standardHandler;
-    private readonly sendStandardResponseOptions;
-    constructor(standardHandler: StandardHandler<T>, options?: NoInfer<NodeHttpHandlerOptions<T>>);
-    handle(request: NodeHttpRequest, response: NodeHttpResponse, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<NodeHttpHandlerHandleResult>;
-}
-
-interface RPCHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, StandardHandlerOptions<T>, RPCHandlerCodecOptions<T> {
-}
-/**
- * Serves an oRPC router over the RPC protocol using Node.js built-in
- * HTTP request/response objects.
- *
- * @see {@link https://orpc.dev/docs/adapters/node-http | Node HTTP Adapter}
- */
-declare class RPCHandler<T extends Context> extends NodeHttpHandler<T> {
-    constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
-}
-
-export { NodeHttpHandler, RPCHandler };
-export type { NodeHttpHandlerHandleResult, NodeHttpHandlerOptions, RPCHandlerOptions };

package/dist/adapters/standard/index.d.ts

@@ -1,95 +0,0 @@
-import { R as ResolvedStandardHandlerHandleOptions, f as StandardHandlerCodec, g as StandardHandlerCodecResolvedProcedure } from '../../shared/server.DOg7ke6y.js';
-export { S as StandardHandler, a as StandardHandlerHandleOptions, h as StandardHandlerHandleResult, i as StandardHandlerInterceptor, e as StandardHandlerInterceptorOptions, c as StandardHandlerOptions, b as StandardHandlerPlugin, j as StandardHandlerRoutingInterceptor, d as StandardHandlerRoutingInterceptorOptions } from '../../shared/server.DOg7ke6y.js';
-import { RPCSerializer, AnyORPCError } from '@orpc/client';
-import { Value, Public, Promisable } from '@orpc/shared';
-import { StandardMethod, StandardLazyRequest, StandardResponse } from '@standard-server/core';
-import { AnyProcedure, Context } from '../../index.js';
-import { AnyRouter } from '../../index.js';
-import { AnyProcedureContract } from '@orpc/contract';
-export { F as FriendlyStandardHandlerHandleOptions, r as resolveFriendlyStandardHandlerHandleOptions } from '../../shared/server.BSYGskId.js';
-
-/**
- * Methods that can invoke procedures by default. Browsers cannot trigger them
- * cross-site without a CORS preflight or an HTML form, unlike `GET`, which a plain
- * `<a>` click or redirect can trigger with `SameSite=Lax` cookies attached. Other
- * methods (`HEAD`, `OPTIONS`, `QUERY`, ...) have safe semantics that should not
- * invoke a procedure that can modify data.
- *
- * @see {@link https://orpc.dev/docs/rpc/handler#supported-http-methods | RPC Handler - Supported HTTP Methods}
- */
-declare const RPC_DEFAULT_ALLOW_METHODS: readonly StandardMethod[];
-interface RPCMatcherOptions {
-    /**
-     * Filter which procedures are exposed for matching. Return `false` to exclude.
-     *
-     * @default true
-     */
-    filter?: Value<boolean, [procedure: AnyProcedureContract | AnyProcedure, path: string[]]> | undefined;
-    /**
-     * Restricts which HTTP methods can invoke procedures, either with a list of allowed
-     * methods or decided per request via a function. Requests using a disallowed method
-     * are treated as unmatched. `GET` is excluded by default because it is exposed to
-     * Cross-Site Request Forgery (CSRF) attacks.
-     *
-     * @default RPC_DEFAULT_ALLOW_METHODS (['POST', 'PUT', 'PATCH', 'DELETE'])
-     * @see {@link https://orpc.dev/docs/rpc/handler#supported-http-methods | RPC Handler - Supported HTTP Methods}
-     */
-    allowMethods?: readonly StandardMethod[] | ((method: StandardMethod, procedure: AnyProcedure, path: string[]) => boolean) | undefined;
-}
-declare class RPCMatcher {
-    private readonly filter;
-    private readonly allowMethodsSet;
-    private readonly allowMethodsFn;
-    private readonly rootRouter;
-    private readonly tree;
-    private readonly pendingLazyRouters;
-    /** segment count of the deepest pending key, never lowered so it stays an upper bound */
-    private maxPendingLazyRouterDepth;
-    constructor(router: AnyRouter, options?: RPCMatcherOptions);
-    private index;
-    match(method: StandardMethod, pathname: `/${string}`, prefix: `/${string}` | undefined): Promise<{
-        path: string[];
-        procedure: AnyProcedure;
-    } | undefined>;
-    private resolvePendingLazyRouters;
-    private loadPendingLazyRouter;
-    private indexPendingLazyRouter;
-    private resolveProcedure;
-}
-
-interface RPCHandlerCodecOptions<T extends Context> extends RPCMatcherOptions {
-    /**
-     * Override the default RPC serializer.
-     */
-    serializer?: Public<RPCSerializer> | undefined;
-    /**
-     * Resolve HTTP status for encoded successful outputs.
-     *
-     * Value should be in the `2xx` range and must be less than `400`.
-     * Return `undefined` or `null` to fallback to default
-     *
-     * @default DEFAULT_SUCCESS_STATUS (200)
-     */
-    outputStatus?: Value<number | undefined | null, [output: unknown, procedure: AnyProcedure, path: string[], options: ResolvedStandardHandlerHandleOptions<T>]> | undefined;
-    /**
-     * Mapping ORPCError Code -> HTTP Status Code
-     * The status code should be in the `4xx` or `5xx` range (must be greater than or equal to `400`).
-     * Codes missing from the map fall back to `DEFAULT_ERROR_STATUS` (400).
-     *
-     * @default COMMON_ERROR_STATUS_MAP
-     */
-    errorStatusMap?: Record<string, number> | undefined;
-}
-declare class RPCHandlerCodec<T extends Context> implements StandardHandlerCodec<T> {
-    private readonly matcher;
-    private readonly serializer;
-    private readonly errorStatusMap;
-    private readonly outputStatus;
-    constructor(router: AnyRouter, options?: RPCHandlerCodecOptions<T>);
-    resolveProcedure(request: StandardLazyRequest, options: ResolvedStandardHandlerHandleOptions<T>): Promise<StandardHandlerCodecResolvedProcedure | undefined>;
-    encodeOutput(output: unknown, procedure: AnyProcedure, path: string[], options: ResolvedStandardHandlerHandleOptions<T>): Promisable<StandardResponse>;
-    encodeError(error: AnyORPCError, _procedure: AnyProcedure, _path: string[], _options: ResolvedStandardHandlerHandleOptions<T>): Promisable<StandardResponse>;
-}
-
-export { RPCHandlerCodec, RPCMatcher, RPC_DEFAULT_ALLOW_METHODS, ResolvedStandardHandlerHandleOptions, StandardHandlerCodec, StandardHandlerCodecResolvedProcedure };
-export type { RPCHandlerCodecOptions, RPCMatcherOptions };

package/dist/adapters/standard-peer/index.d.ts

@@ -1,11 +0,0 @@
-import { StandardLazyRequest, StandardResponse } from '@standard-server/core';
-import { Context } from '../../index.js';
-import { StandardHandler } from '../standard/index.js';
-import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
-import '@orpc/client';
-import '@orpc/contract';
-import '@orpc/shared';
-
-declare function createStandardPeerRequestHandler<T extends Context>(handler: StandardHandler<T>, options: FriendlyStandardHandlerHandleOptions<T>): (request: StandardLazyRequest) => Promise<StandardResponse>;
-
-export { createStandardPeerRequestHandler };

package/dist/adapters/websocket/index.d.ts

@@ -1,77 +0,0 @@
-import { Arrayable, MaybeOptionalOptions } from '@orpc/shared';
-import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
-import { Context } from '../../index.js';
-import { StandardHandler, StandardHandlerOptions } from '../standard/index.js';
-import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
-import { Router } from '../../index.js';
-import { RPCHandlerCodecOptions } from '../standard/index.js';
-import '@orpc/client';
-import '@orpc/contract';
-import '@standard-server/core';
-
-/**
- * Supports standard WebSocket instances, Bun ServerWebSocket, "ws" ServerWebSocket,
- * Cloudflare WebSocket Hibernation, and similar implementations.
- */
-type WebSocketLike = {
-    send: (data: string | Uint8Array<ArrayBuffer>) => unknown;
-};
-interface WebSocketHandlerOptions<_T extends Context> {
-    /**
-     * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
-     */
-    encodePeerMessage?: EncodePeerMessageOptions | undefined;
-    /**
-     * Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
-     */
-    decodePeerMessage?: DecodePeerMessageOptions | undefined;
-}
-declare class WebSocketHandler<T extends Context> {
-    private readonly handler;
-    private readonly peers;
-    private readonly encodePeerMessageOptions;
-    private readonly decodePeerMessageOptions;
-    constructor(handler: StandardHandler<T>, options?: NoInfer<WebSocketHandlerOptions<T>>);
-    /**
-     * Handles a single WebSocket message.
-     *
-     * Message order matters. Call this immediately after receiving a message,
-     * before any other async work, to preserve ordering.
-     *
-     * To avoid async Blob reads, configure `ws.binaryType` to return binary data
-     * directly (for example, `arraybuffer`).
-     *
-     * @param ws The WebSocket instance. Use the same instance for all messages.
-     * @param data The received message. Binary data should already be loaded (not a `Blob`).
-     */
-    message(ws: WebSocketLike, data: Arrayable<string | ArrayBuffer | Pick<Uint8Array<ArrayBuffer>, 'buffer' | 'byteOffset' | 'byteLength'>>, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
-        matched: boolean;
-    }>;
-    /**
-     * Cleans up peer state for a closed WebSocket.
-     *
-     * @param ws The same WebSocket instance passed to `.message()`.
-     */
-    close(ws: WebSocketLike): Promise<void>;
-    /**
-     * Attaches message, close, and error event listeners to a WebSocket.
-     *
-     * Prefer this over calling `.message()` and `.close()` manually.
-     */
-    upgrade(ws: Pick<WebSocket, 'send' | 'addEventListener' | 'removeEventListener'>, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
-}
-
-interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, WebSocketHandlerOptions<T> {
-}
-/**
- * Serves an oRPC router over the RPC protocol on a standard WebSocket
- * connection (Deno, Bun, Cloudflare Durable Objects, and more).
- *
- * @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
- */
-declare class RPCHandler<T extends Context> extends WebSocketHandler<T> {
-    constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
-}
-
-export { RPCHandler, WebSocketHandler };
-export type { RPCHandlerOptions, WebSocketHandlerOptions, WebSocketLike };

package/dist/extensions/callable.d.ts

@@ -1,10 +0,0 @@
-import { ClientContext } from '@orpc/client';
-import { AnySchema, ErrorMap } from '@orpc/contract';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import { Context, ProcedureClientOptions, Procedure, ProcedureClient } from '../index.js';
-
-declare module '@orpc/server' {
-    interface DecoratedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
-        callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<ProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TClientContext>>): Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
-    }
-}

package/dist/helpers/index.d.ts

@@ -1,167 +0,0 @@
-import { ParseOptions, SetCookie, StringifyOptions } from 'cookie';
-
-/**
- * Encodes a Uint8Array to base64url format
- * Base64url is URL-safe and doesn't use padding
- *
- * @example
- * ```ts
- * const text = "Hello World"
- * const encoded = encodeBase64url(new TextEncoder().encode(text))
- * const decoded = decodeBase64url(encoded)
- * expect(new TextDecoder().decode(decoded)).toEqual(text)
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/base64url | Base64Url Helpers}
- */
-declare function encodeBase64url(data: Uint8Array): string;
-/**
- * Decodes a base64url string to Uint8Array
- * Only accepts canonical, unpadded base64url (the form produced by `encodeBase64url`),
- * returns undefined for anything else, including padded or standard base64 input
- *
- * @example
- * ```ts
- * const text = "Hello World"
- * const encoded = encodeBase64url(new TextEncoder().encode(text))
- * const decoded = decodeBase64url(encoded)
- * expect(new TextDecoder().decode(decoded)).toEqual(text)
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/base64url | Base64Url Helpers}
- */
-declare function decodeBase64url(base64url: string | undefined | null): Uint8Array<ArrayBuffer> | undefined;
-
-interface SetCookieOptions extends Omit<SetCookie, 'name' | 'value'>, StringifyOptions {
-    /**
-     * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
-     *
-     * @default '/'
-     */
-    path?: string;
-}
-/**
- * Sets a cookie in the response headers.
- *
- * Does nothing if `headers` is `undefined`.
- *
- * @example
- * ```ts
- * const headers = new Headers()
- *
- * setCookie(headers, 'sessionId', 'abc123', { httpOnly: true, maxAge: 3600 })
- *
- * expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; Max-Age=3600; Path=/; HttpOnly')
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
- */
-declare function setCookie(headers: Headers | undefined, name: string, value: string, options?: SetCookieOptions): void;
-interface GetCookieOptions extends ParseOptions {
-}
-/**
- * Gets a cookie value from request headers
- *
- * Returns `undefined` if the cookie is not found or headers are `undefined`.
- *
- * @example
- * ```ts
- * const headers = new Headers({ 'Cookie': 'sessionId=abc123; theme=dark' })
- *
- * const sessionId = getCookie(headers, 'sessionId')
- *
- * expect(sessionId).toEqual('abc123')
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
- */
-declare function getCookie(headers: Headers | undefined, name: string, options?: GetCookieOptions): string | undefined;
-/**
- * Deletes a cookie by marking it expired.
- *
- * @see {@link https://orpc.dev/docs/helpers/cookie | Cookie Helpers}
- */
-declare function deleteCookie(headers: Headers | undefined, name: string, options?: Omit<SetCookieOptions, 'maxAge'>): void;
-
-/**
- * Encrypts a string using AES-GCM with a secret key.
- * The output is base64url encoded to be URL-safe.
- *
- * @example
- * ```ts
- * const encrypted = await encrypt("Hello, World!", "test-secret-key")
- * const decrypted = await decrypt(encrypted, "test-secret-key")
- * expect(decrypted).toBe("Hello, World!")
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/encryption | Encryption Helpers}
- */
-declare function encrypt(value: string, secret: string): Promise<string>;
-/**
- * Decrypts a base64url encoded string using AES-GCM with a secret key.
- * Returns the original string if decryption is successful, or undefined if it fails.
- *
- * @example
- * ```ts
- * const encrypted = await encrypt("Hello, World!", "test-secret-key")
- * const decrypted = await decrypt(encrypted, "test-secret-key")
- * expect(decrypted).toBe("Hello, World!")
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/encryption | Encryption Helpers}
- */
-declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
-
-/**
- * Signs a string value using HMAC-SHA256 with a secret key.
- *
- * This function creates a cryptographic signature that can be used to verify
- * the integrity and authenticity of the data. The signature is appended to
- * the original value, separated by a dot, using base64url encoding (no padding).
- *
- * @example
- * ```ts
- * const signedValue = await sign("user123", "my-secret-key")
- * expect(signedValue).toEqual("user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA")
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
- */
-declare function sign(value: string, secret: string): Promise<string>;
-/**
- * Verifies and extracts the original value from a signed string.
- *
- * This function validates the signature of a previously signed value using the same
- * secret key. If the signature is valid, it returns the original value. If the
- * signature is invalid or the format is incorrect, it returns undefined.
- *
- * @example
- * ```ts
- * const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
- * const originalValue = await unsign(signedValue, "my-secret-key")
- * expect(originalValue).toEqual("user123")
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
- */
-declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
-/**
- * Extracts the value part from a signed string without verification.
- *
- * This function simply extracts the original value from a signed string
- * without performing any signature verification. It's useful when you need
- * to access the value quickly without the overhead of cryptographic verification.
- *
- * @example
- * ```ts
- * const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
- * const value = getSignedValue(signedValue)
- * expect(value).toEqual("user123")
- * ```
- *
- * @see {@link https://orpc.dev/docs/helpers/signing | Signing Helpers}
- */
-declare function getSignedValue(signedValue: string | undefined | null): string | undefined;
-
-export { decodeBase64url, decrypt, deleteCookie, encodeBase64url, encrypt, getCookie, getSignedValue, setCookie, sign, unsign };
-export type { GetCookieOptions, SetCookieOptions };