@orpc/standard-server 0.0.0-next.fd6982a → 0.0.0-next.fdd2389

package/README.md

@@ -17,6 +17,9 @@
   <a href="https://discord.gg/TXEbwRBvQn">
     <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
   </a>
+  <a href="https://deepwiki.com/unnoq/orpc">
+    <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
+  </a>
 </div>
 
 <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
@@ -30,7 +33,8 @@
 - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
 - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
 - **📝 Contract-First Development**: Optionally define your API contract before implementation.
-- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
 - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
 - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
 - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -38,7 +42,6 @@
 - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
 - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
 - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
-- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -49,14 +52,14 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@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/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
-- [@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/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
-- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
+- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
 - [@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/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
 - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
 - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
 - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).

package/dist/batch/index.d.mts

@@ -1,4 +1,5 @@
-import { S as StandardHeaders, b as StandardRequest, d as StandardResponse } from '../shared/standard-server.R_NaHlxw.mjs';
+import { S as StandardHeaders, c as StandardRequest, e as StandardResponse } from '../shared/standard-server.BD8Sg1A5.mjs';
+import { Promisable } from '@orpc/shared';
 
 interface ToBatchRequestOptions {
     url: URL;
@@ -9,16 +10,21 @@ interface ToBatchRequestOptions {
 declare function toBatchRequest(options: ToBatchRequestOptions): StandardRequest;
 declare function parseBatchRequest(request: StandardRequest): StandardRequest[];
 
+type BatchResponseMode = 'streaming' | 'buffered';
 interface BatchResponseBodyItem extends StandardResponse {
     index: number;
 }
 interface ToBatchResponseOptions extends StandardResponse {
     body: AsyncIteratorObject<BatchResponseBodyItem>;
+    /**
+     * @default 'streaming'
+     */
+    mode?: BatchResponseMode;
 }
-declare function toBatchResponse(options: ToBatchResponseOptions): StandardResponse;
+declare function toBatchResponse(options: ToBatchResponseOptions): Promisable<StandardResponse>;
 declare function parseBatchResponse(response: StandardResponse): AsyncGenerator<BatchResponseBodyItem>;
 
 declare function toBatchAbortSignal(signals: readonly (AbortSignal | undefined)[]): AbortSignal | undefined;
 
 export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
-export type { BatchResponseBodyItem, ToBatchRequestOptions, ToBatchResponseOptions };
+export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };

package/dist/batch/index.d.ts

@@ -1,4 +1,5 @@
-import { S as StandardHeaders, b as StandardRequest, d as StandardResponse } from '../shared/standard-server.R_NaHlxw.js';
+import { S as StandardHeaders, c as StandardRequest, e as StandardResponse } from '../shared/standard-server.BD8Sg1A5.js';
+import { Promisable } from '@orpc/shared';
 
 interface ToBatchRequestOptions {
     url: URL;
@@ -9,16 +10,21 @@ interface ToBatchRequestOptions {
 declare function toBatchRequest(options: ToBatchRequestOptions): StandardRequest;
 declare function parseBatchRequest(request: StandardRequest): StandardRequest[];
 
+type BatchResponseMode = 'streaming' | 'buffered';
 interface BatchResponseBodyItem extends StandardResponse {
     index: number;
 }
 interface ToBatchResponseOptions extends StandardResponse {
     body: AsyncIteratorObject<BatchResponseBodyItem>;
+    /**
+     * @default 'streaming'
+     */
+    mode?: BatchResponseMode;
 }
-declare function toBatchResponse(options: ToBatchResponseOptions): StandardResponse;
+declare function toBatchResponse(options: ToBatchResponseOptions): Promisable<StandardResponse>;
 declare function parseBatchResponse(response: StandardResponse): AsyncGenerator<BatchResponseBodyItem>;
 
 declare function toBatchAbortSignal(signals: readonly (AbortSignal | undefined)[]): AbortSignal | undefined;
 
 export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
-export type { BatchResponseBodyItem, ToBatchRequestOptions, ToBatchResponseOptions };
+export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };

package/dist/batch/index.mjs

@@ -1,4 +1,4 @@
-import { stringifyJSON, parseEmptyableJSON, isAsyncIteratorObject, isObject } from '@orpc/shared';
+import { stringifyJSON, parseEmptyableJSON, AsyncIteratorClass, isAsyncIteratorObject, isObject } from '@orpc/shared';
 
 function toBatchAbortSignal(signals) {
   const realSignals = signals.filter((signal) => signal !== void 0);
@@ -62,33 +62,63 @@ function parseBatchRequest(request) {
 }
 
 function toBatchResponse(options) {
-  return {
-    ...options,
-    body: async function* () {
+  const mode = options.mode ?? "streaming";
+  const minifyResponseItem = (item) => {
+    return {
+      index: item.index,
+      status: item.status === options.status ? void 0 : item.status,
+      headers: Object.keys(item.headers).length ? item.headers : void 0,
+      body: item.body
+    };
+  };
+  if (mode === "buffered") {
+    return (async () => {
       try {
+        const body = [];
         for await (const item of options.body) {
-          yield {
-            index: item.index,
-            status: item.status === options.status ? void 0 : item.status,
-            headers: Object.keys(item.headers).length ? item.headers : void 0,
-            body: item.body
-          };
+          body.push(minifyResponseItem(item));
         }
+        return {
+          headers: options.headers,
+          status: options.status,
+          body
+        };
       } finally {
-        options.body.return?.();
+        await options.body.return?.();
       }
-    }()
+    })();
+  }
+  return {
+    headers: options.headers,
+    status: options.status,
+    body: new AsyncIteratorClass(
+      async () => {
+        const { done, value } = await options.body.next();
+        if (done) {
+          return { done, value };
+        }
+        return {
+          done,
+          value: {
+            index: value.index,
+            status: value.status === options.status ? void 0 : value.status,
+            headers: Object.keys(value.headers).length ? value.headers : void 0,
+            body: value.body
+          }
+        };
+      },
+      async (reason) => {
+        if (reason !== "next") {
+          await options.body.return?.();
+        }
+      }
+    )
   };
 }
 function parseBatchResponse(response) {
   const body = response.body;
-  if (!isAsyncIteratorObject(body)) {
-    throw new TypeError("Invalid batch response", {
-      cause: response
-    });
-  }
-  return async function* () {
-    try {
+  if (isAsyncIteratorObject(body) || Array.isArray(body)) {
+    const iterator = (async function* () {
       for await (const item of body) {
         if (!isObject(item) || !("index" in item) || typeof item.index !== "number") {
           throw new TypeError("Invalid batch response", {
@@ -102,10 +132,19 @@ function parseBatchResponse(response) {
           body: item.body
         };
       }
-    } finally {
-      await body.return?.();
-    }
-  }();
+    })();
+    return new AsyncIteratorClass(
+      () => iterator.next(),
+      async (reason) => {
+        if (reason !== "next" && isAsyncIteratorObject(body)) {
+          await body.return?.();
+        }
+      }
+    );
+  }
+  throw new TypeError("Invalid batch response", {
+    cause: response
+  });
 }
 
 export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { S as StandardHeaders } from './shared/standard-server.R_NaHlxw.mjs';
-export { a as StandardBody, c as StandardLazyRequest, e as StandardLazyResponse, b as StandardRequest, d as StandardResponse } from './shared/standard-server.R_NaHlxw.mjs';
+import { AsyncIteratorClass } from '@orpc/shared';
+import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.mjs';
+export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.mjs';
 
 interface EventMessage {
     event: string | undefined;
@@ -52,10 +53,23 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
 declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
 declare function getEventMeta(container: unknown): EventMeta | undefined;
 
+interface HibernationEventIteratorCallback {
+    (id: string): void;
+}
+declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
+    /**
+     * this property is not transferred to the client, so it should be optional for type safety
+     */
+    readonly hibernationCallback?: HibernationEventIteratorCallback;
+    constructor(hibernationCallback: HibernationEventIteratorCallback);
+}
+
 declare function generateContentDisposition(filename: string): string;
 declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
 declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
 declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
+declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
+declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
 
-export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, StandardHeaders, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
-export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta };
+export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
+export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta, HibernationEventIteratorCallback };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { S as StandardHeaders } from './shared/standard-server.R_NaHlxw.js';
-export { a as StandardBody, c as StandardLazyRequest, e as StandardLazyResponse, b as StandardRequest, d as StandardResponse } from './shared/standard-server.R_NaHlxw.js';
+import { AsyncIteratorClass } from '@orpc/shared';
+import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.js';
+export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.js';
 
 interface EventMessage {
     event: string | undefined;
@@ -52,10 +53,23 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
 declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
 declare function getEventMeta(container: unknown): EventMeta | undefined;
 
+interface HibernationEventIteratorCallback {
+    (id: string): void;
+}
+declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
+    /**
+     * this property is not transferred to the client, so it should be optional for type safety
+     */
+    readonly hibernationCallback?: HibernationEventIteratorCallback;
+    constructor(hibernationCallback: HibernationEventIteratorCallback);
+}
+
 declare function generateContentDisposition(filename: string): string;
 declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
 declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
 declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
+declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
+declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
 
-export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, StandardHeaders, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
-export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta };
+export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
+export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta, HibernationEventIteratorCallback };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { isTypescriptObject, toArray } from '@orpc/shared';
+import { isTypescriptObject, AsyncIteratorClass, tryDecodeURIComponent, toArray, once, isAsyncIteratorObject, replicateAsyncIterator } from '@orpc/shared';
 
 class EventEncoderError extends TypeError {
 }
@@ -158,6 +158,9 @@ function encodeEventMessage(message) {
 
 const EVENT_SOURCE_META_SYMBOL = Symbol("ORPC_EVENT_SOURCE_META");
 function withEventMeta(container, meta) {
+  if (meta.id === void 0 && meta.retry === void 0 && !meta.comments?.length) {
+    return container;
+  }
   if (meta.id !== void 0) {
     assertEventId(meta.id);
   }
@@ -182,6 +185,23 @@ function getEventMeta(container) {
   return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
 }
 
+class HibernationEventIterator extends AsyncIteratorClass {
+  /**
+   * this property is not transferred to the client, so it should be optional for type safety
+   */
+  hibernationCallback;
+  constructor(hibernationCallback) {
+    super(async () => {
+      throw new Error("Cannot iterate over hibernating iterator directly");
+    }, async (reason) => {
+      if (reason !== "next") {
+        throw new Error("Cannot cleanup hibernating iterator directly");
+      }
+    });
+    this.hibernationCallback = hibernationCallback;
+  }
+}
+
 function generateContentDisposition(filename) {
   const escapedFileName = filename.replace(/"/g, '\\"');
   const encodedFilenameStar = encodeURIComponent(filename).replace(/['()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`).replace(/%(7C|60|5E)/g, (str, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
@@ -190,7 +210,7 @@ function generateContentDisposition(filename) {
 function getFilenameFromContentDisposition(contentDisposition) {
   const encodedFilenameStarMatch = contentDisposition.match(/filename\*=(UTF-8'')?([^;]*)/i);
   if (encodedFilenameStarMatch && typeof encodedFilenameStarMatch[2] === "string") {
-    return decodeURIComponent(encodedFilenameStarMatch[2]);
+    return tryDecodeURIComponent(encodedFilenameStarMatch[2]);
   }
   const encodedFilenameMatch = contentDisposition.match(/filename="((?:\\"|[^"])*)"/i);
   if (encodedFilenameMatch && typeof encodedFilenameMatch[1] === "string") {
@@ -223,5 +243,27 @@ function flattenHeader(header) {
   }
   return header.join(", ");
 }
+function replicateStandardLazyResponse(response, count) {
+  const replicated = [];
+  let bodyPromise;
+  let replicatedAsyncIteratorObjects;
+  for (let i = 0; i < count; i++) {
+    replicated.push({
+      ...response,
+      body: once(async () => {
+        const body = await (bodyPromise ??= response.body());
+        if (!isAsyncIteratorObject(body)) {
+          return body;
+        }
+        replicatedAsyncIteratorObjects ??= replicateAsyncIterator(body, count);
+        return replicatedAsyncIteratorObjects.shift();
+      })
+    });
+  }
+  return replicated;
+}
+function isEventIteratorHeaders(headers) {
+  return Boolean(flattenHeader(headers["content-type"])?.startsWith("text/event-stream") && flattenHeader(headers["content-disposition"]) === void 0);
+}
 
-export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
+export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };

package/dist/shared/{standard-server.R_NaHlxw.d.mts → standard-server.BD8Sg1A5.d.mts}

@@ -35,4 +35,4 @@ interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
     body: () => Promise<StandardBody>;
 }
 
-export type { StandardHeaders as S, StandardBody as a, StandardRequest as b, StandardLazyRequest as c, StandardResponse as d, StandardLazyResponse as e };
+export type { StandardHeaders as S, StandardLazyResponse as a, StandardBody as b, StandardRequest as c, StandardLazyRequest as d, StandardResponse as e };

package/dist/shared/{standard-server.R_NaHlxw.d.ts → standard-server.BD8Sg1A5.d.ts}

@@ -35,4 +35,4 @@ interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
     body: () => Promise<StandardBody>;
 }
 
-export type { StandardHeaders as S, StandardBody as a, StandardRequest as b, StandardLazyRequest as c, StandardResponse as d, StandardLazyResponse as e };
+export type { StandardHeaders as S, StandardLazyResponse as a, StandardBody as b, StandardRequest as c, StandardLazyRequest as d, StandardResponse as e };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/standard-server",
   "type": "module",
-  "version": "0.0.0-next.fd6982a",
+  "version": "0.0.0-next.fdd2389",
   "license": "MIT",
   "homepage": "https://unnoq.com",
   "repository": {
@@ -28,7 +28,7 @@
     "dist"
   ],
   "dependencies": {
-    "@orpc/shared": "0.0.0-next.fd6982a"
+    "@orpc/shared": "0.0.0-next.fdd2389"
   },
   "scripts": {
     "build": "unbuild",