@orpc/standard-server-peer 0.0.0-next.e385fb7 → 0.0.0-next.e5e2613

package/README.md

@@ -30,7 +30,7 @@
 - **🔗 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.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), 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.
@@ -49,14 +49,12 @@ 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/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/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/index.d.mts

@@ -1,7 +1,7 @@
-import { Promisable, AsyncIdQueueCloseOptions as AsyncIdQueueCloseOptions$1, CreateAsyncIteratorObjectCleanupFn } from '@orpc/shared';
-import { StandardRequest, StandardResponse, EventMeta, StandardHeaders } from '@orpc/standard-server';
+import { Promisable, AsyncIdQueueCloseOptions as AsyncIdQueueCloseOptions$1, AsyncIteratorClassCleanupFn, AsyncIteratorClass } from '@orpc/shared';
+import { StandardRequest, StandardResponse, EventMeta } from '@orpc/standard-server';
 
-type EncodedMessage = string | ArrayBufferLike | Blob;
+type EncodedMessage = string | ArrayBufferLike | Uint8Array;
 interface EncodedMessageSendFn {
     (message: EncodedMessage): Promisable<void>;
 }
@@ -22,7 +22,7 @@ declare class ClientPeer {
     private readonly send;
     constructor(send: EncodedMessageSendFn);
     get length(): number;
-    open(id: number): AbortController;
+    open(id: string): AbortController;
     request(request: StandardRequest): Promise<StandardResponse>;
     message(raw: EncodedMessage): Promise<void>;
     close(options?: AsyncIdQueueCloseOptions$1): void;
@@ -51,34 +51,33 @@ interface ResponseMessageMap {
     [MessageType.ABORT_SIGNAL]: void;
 }
 type DecodedMessageUnion<TMap extends RequestMessageMap | ResponseMessageMap> = {
-    [K in keyof TMap]: [id: number, type: K, payload: TMap[K]];
+    [K in keyof TMap]: [id: string, type: K, payload: TMap[K]];
 }[keyof TMap];
 type DecodedRequestMessage = DecodedMessageUnion<RequestMessageMap>;
 type DecodedResponseMessage = DecodedMessageUnion<ResponseMessageMap>;
-declare function encodeRequestMessage<T extends keyof RequestMessageMap>(id: number, type: T, payload: RequestMessageMap[T]): Promise<EncodedMessage>;
+declare function encodeRequestMessage<T extends keyof RequestMessageMap>(id: string, type: T, payload: RequestMessageMap[T]): Promise<EncodedMessage>;
 declare function decodeRequestMessage(raw: EncodedMessage): Promise<DecodedRequestMessage>;
-declare function encodeResponseMessage<T extends keyof ResponseMessageMap>(id: number, type: T, payload: ResponseMessageMap[T]): Promise<EncodedMessage>;
+declare function encodeResponseMessage<T extends keyof ResponseMessageMap>(id: string, type: T, payload: ResponseMessageMap[T]): Promise<EncodedMessage>;
 declare function decodeResponseMessage(raw: EncodedMessage): Promise<DecodedResponseMessage>;
-declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
 
 interface AsyncIdQueueCloseOptions {
-    id?: number;
-    reason?: Error;
+    id?: string;
+    reason?: unknown;
 }
 declare class AsyncIdQueue<T> {
     private readonly openIds;
     private readonly items;
     private readonly pendingPulls;
     get length(): number;
-    open(id: number): void;
-    isOpen(id: number): boolean;
-    push(id: number, item: T): void;
-    pull(id: number): Promise<T>;
+    open(id: string): void;
+    isOpen(id: string): boolean;
+    push(id: string, item: T): void;
+    pull(id: string): Promise<T>;
     close({ id, reason }?: AsyncIdQueueCloseOptions): void;
-    assertOpen(id: number): void;
+    assertOpen(id: string): void;
 }
 
-declare function toEventIterator(queue: AsyncIdQueue<EventIteratorPayload>, id: number, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncGenerator;
+declare function toEventIterator(queue: AsyncIdQueue<EventIteratorPayload>, id: string, cleanup: AsyncIteratorClassCleanupFn): AsyncIteratorClass<unknown>;
 declare function resolveEventIterator(iterator: AsyncIterator<any>, callback: (payload: EventIteratorPayload) => Promise<'next' | 'abort'>): Promise<void>;
 
 interface ServerPeerCloseOptions extends AsyncIdQueueCloseOptions$1 {
@@ -95,11 +94,11 @@ declare class ServerPeer {
     private readonly send;
     constructor(send: EncodedMessageSendFn);
     get length(): number;
-    open(id: number): AbortController;
-    message(raw: EncodedMessage): Promise<[id: number, StandardRequest | undefined]>;
-    response(id: number, response: StandardResponse): Promise<void>;
+    open(id: string): AbortController;
+    message(raw: EncodedMessage): Promise<[id: string, StandardRequest | undefined]>;
+    response(id: string, response: StandardResponse): Promise<void>;
     close({ abort, ...options }?: ServerPeerCloseOptions): void;
 }
 
-export { ClientPeer, MessageType, ServerPeer, decodeRequestMessage, decodeResponseMessage, encodeRequestMessage, encodeResponseMessage, isEventIteratorHeaders, resolveEventIterator, toEventIterator };
+export { ClientPeer, MessageType, ServerPeer, decodeRequestMessage, decodeResponseMessage, encodeRequestMessage, encodeResponseMessage, resolveEventIterator, toEventIterator };
 export type { ClientPeerCloseOptions, DecodedRequestMessage, DecodedResponseMessage, EncodedMessage, EncodedMessageSendFn, EventIteratorEvent, EventIteratorPayload, RequestMessageMap, ResponseMessageMap, ServerPeerCloseOptions };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { Promisable, AsyncIdQueueCloseOptions as AsyncIdQueueCloseOptions$1, CreateAsyncIteratorObjectCleanupFn } from '@orpc/shared';
-import { StandardRequest, StandardResponse, EventMeta, StandardHeaders } from '@orpc/standard-server';
+import { Promisable, AsyncIdQueueCloseOptions as AsyncIdQueueCloseOptions$1, AsyncIteratorClassCleanupFn, AsyncIteratorClass } from '@orpc/shared';
+import { StandardRequest, StandardResponse, EventMeta } from '@orpc/standard-server';
 
-type EncodedMessage = string | ArrayBufferLike | Blob;
+type EncodedMessage = string | ArrayBufferLike | Uint8Array;
 interface EncodedMessageSendFn {
     (message: EncodedMessage): Promisable<void>;
 }
@@ -22,7 +22,7 @@ declare class ClientPeer {
     private readonly send;
     constructor(send: EncodedMessageSendFn);
     get length(): number;
-    open(id: number): AbortController;
+    open(id: string): AbortController;
     request(request: StandardRequest): Promise<StandardResponse>;
     message(raw: EncodedMessage): Promise<void>;
     close(options?: AsyncIdQueueCloseOptions$1): void;
@@ -51,34 +51,33 @@ interface ResponseMessageMap {
     [MessageType.ABORT_SIGNAL]: void;
 }
 type DecodedMessageUnion<TMap extends RequestMessageMap | ResponseMessageMap> = {
-    [K in keyof TMap]: [id: number, type: K, payload: TMap[K]];
+    [K in keyof TMap]: [id: string, type: K, payload: TMap[K]];
 }[keyof TMap];
 type DecodedRequestMessage = DecodedMessageUnion<RequestMessageMap>;
 type DecodedResponseMessage = DecodedMessageUnion<ResponseMessageMap>;
-declare function encodeRequestMessage<T extends keyof RequestMessageMap>(id: number, type: T, payload: RequestMessageMap[T]): Promise<EncodedMessage>;
+declare function encodeRequestMessage<T extends keyof RequestMessageMap>(id: string, type: T, payload: RequestMessageMap[T]): Promise<EncodedMessage>;
 declare function decodeRequestMessage(raw: EncodedMessage): Promise<DecodedRequestMessage>;
-declare function encodeResponseMessage<T extends keyof ResponseMessageMap>(id: number, type: T, payload: ResponseMessageMap[T]): Promise<EncodedMessage>;
+declare function encodeResponseMessage<T extends keyof ResponseMessageMap>(id: string, type: T, payload: ResponseMessageMap[T]): Promise<EncodedMessage>;
 declare function decodeResponseMessage(raw: EncodedMessage): Promise<DecodedResponseMessage>;
-declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
 
 interface AsyncIdQueueCloseOptions {
-    id?: number;
-    reason?: Error;
+    id?: string;
+    reason?: unknown;
 }
 declare class AsyncIdQueue<T> {
     private readonly openIds;
     private readonly items;
     private readonly pendingPulls;
     get length(): number;
-    open(id: number): void;
-    isOpen(id: number): boolean;
-    push(id: number, item: T): void;
-    pull(id: number): Promise<T>;
+    open(id: string): void;
+    isOpen(id: string): boolean;
+    push(id: string, item: T): void;
+    pull(id: string): Promise<T>;
     close({ id, reason }?: AsyncIdQueueCloseOptions): void;
-    assertOpen(id: number): void;
+    assertOpen(id: string): void;
 }
 
-declare function toEventIterator(queue: AsyncIdQueue<EventIteratorPayload>, id: number, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncGenerator;
+declare function toEventIterator(queue: AsyncIdQueue<EventIteratorPayload>, id: string, cleanup: AsyncIteratorClassCleanupFn): AsyncIteratorClass<unknown>;
 declare function resolveEventIterator(iterator: AsyncIterator<any>, callback: (payload: EventIteratorPayload) => Promise<'next' | 'abort'>): Promise<void>;
 
 interface ServerPeerCloseOptions extends AsyncIdQueueCloseOptions$1 {
@@ -95,11 +94,11 @@ declare class ServerPeer {
     private readonly send;
     constructor(send: EncodedMessageSendFn);
     get length(): number;
-    open(id: number): AbortController;
-    message(raw: EncodedMessage): Promise<[id: number, StandardRequest | undefined]>;
-    response(id: number, response: StandardResponse): Promise<void>;
+    open(id: string): AbortController;
+    message(raw: EncodedMessage): Promise<[id: string, StandardRequest | undefined]>;
+    response(id: string, response: StandardResponse): Promise<void>;
     close({ abort, ...options }?: ServerPeerCloseOptions): void;
 }
 
-export { ClientPeer, MessageType, ServerPeer, decodeRequestMessage, decodeResponseMessage, encodeRequestMessage, encodeResponseMessage, isEventIteratorHeaders, resolveEventIterator, toEventIterator };
+export { ClientPeer, MessageType, ServerPeer, decodeRequestMessage, decodeResponseMessage, encodeRequestMessage, encodeResponseMessage, resolveEventIterator, toEventIterator };
 export type { ClientPeerCloseOptions, DecodedRequestMessage, DecodedResponseMessage, EncodedMessage, EncodedMessageSendFn, EventIteratorEvent, EventIteratorPayload, RequestMessageMap, ResponseMessageMap, ServerPeerCloseOptions };

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { isAsyncIteratorObject, stringifyJSON, createAsyncIteratorObject, isTypescriptObject, SequentialIdGenerator, AsyncIdQueue } from '@orpc/shared';
-import { flattenHeader, getFilenameFromContentDisposition, generateContentDisposition, withEventMeta, ErrorEvent, getEventMeta } from '@orpc/standard-server';
+import { isAsyncIteratorObject, stringifyJSON, readAsBuffer, AsyncIteratorClass, isTypescriptObject, SequentialIdGenerator, AsyncIdQueue } from '@orpc/shared';
+import { generateContentDisposition, flattenHeader, getFilenameFromContentDisposition, withEventMeta, ErrorEvent, getEventMeta, isEventIteratorHeaders, experimental_HibernationEventIterator } from '@orpc/standard-server';
 
 var MessageType = /* @__PURE__ */ ((MessageType2) => {
   MessageType2[MessageType2["REQUEST"] = 1] = "REQUEST";
@@ -22,7 +22,7 @@ async function encodeRequestMessage(id, type, payload) {
     return encodeRawMessage({ i: id, t: type, p: payload });
   }
   const request = payload;
-  const { body: processedBody, headers: processedHeaders } = await prepareBodyAndHeadersForSerialization(
+  const { body: processedBody, headers: processedHeaders } = await serializeBodyAndHeaders(
     request.body,
     request.headers
   );
@@ -42,7 +42,7 @@ async function encodeRequestMessage(id, type, payload) {
   return encodeRawMessage(baseMessage);
 }
 async function decodeRequestMessage(raw) {
-  const { json: message, blobData } = await decodeRawMessage(raw);
+  const { json: message, buffer } = await decodeRawMessage(raw);
   const id = message.i;
   const type = message.t;
   if (type === 3 /* EVENT_ITERATOR */) {
@@ -54,20 +54,7 @@ async function decodeRequestMessage(raw) {
   }
   const payload = message.p;
   const headers = payload.h ?? {};
-  let body = payload.b;
-  const contentType = flattenHeader(headers["content-type"]);
-  if (blobData) {
-    const contentDisposition = flattenHeader(headers["content-disposition"]);
-    if (contentDisposition === void 0 && contentType?.startsWith("multipart/form-data")) {
-      const tempRes = new Response(blobData, { headers: { "content-type": contentType } });
-      body = await tempRes.formData();
-    } else {
-      const filename = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
-      body = new File([blobData], filename, { type: contentType });
-    }
-  } else if (contentType?.startsWith("application/x-www-form-urlencoded") && typeof body === "string") {
-    body = new URLSearchParams(body);
-  }
+  const body = await deserializeBody(headers, payload.b, buffer);
   return [id, 1 /* REQUEST */, { url: new URL(payload.u, "orpc:/"), headers, method: payload.m ?? "POST", body }];
 }
 async function encodeResponseMessage(id, type, payload) {
@@ -84,7 +71,7 @@ async function encodeResponseMessage(id, type, payload) {
     return encodeRawMessage({ i: id, t: type, p: void 0 });
   }
   const response = payload;
-  const { body: processedBody, headers: processedHeaders } = await prepareBodyAndHeadersForSerialization(
+  const { body: processedBody, headers: processedHeaders } = await serializeBodyAndHeaders(
     response.body,
     response.headers
   );
@@ -103,7 +90,7 @@ async function encodeResponseMessage(id, type, payload) {
   return encodeRawMessage(baseMessage);
 }
 async function decodeResponseMessage(raw) {
-  const { json: message, blobData } = await decodeRawMessage(raw);
+  const { json: message, buffer } = await decodeRawMessage(raw);
   const id = message.i;
   const type = message.t;
   if (type === 3 /* EVENT_ITERATOR */) {
@@ -115,23 +102,10 @@ async function decodeResponseMessage(raw) {
   }
   const payload = message.p;
   const headers = payload.h ?? {};
-  let body = payload.b;
-  const contentType = flattenHeader(headers["content-type"]);
-  if (blobData) {
-    const contentDisposition = flattenHeader(headers["content-disposition"]);
-    if (contentDisposition === void 0 && contentType?.startsWith("multipart/form-data")) {
-      const tempRes = new Response(blobData, { headers: { "content-type": contentType } });
-      body = await tempRes.formData();
-    } else {
-      const filename = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
-      body = new File([blobData], filename, { type: contentType });
-    }
-  } else if (contentType?.startsWith("application/x-www-form-urlencoded") && typeof body === "string") {
-    body = new URLSearchParams(body);
-  }
+  const body = await deserializeBody(headers, payload.b, buffer);
   return [id, 2 /* RESPONSE */, { status: payload.s ?? 200, headers, body }];
 }
-async function prepareBodyAndHeadersForSerialization(body, originalHeaders) {
+async function serializeBodyAndHeaders(body, originalHeaders) {
   const headers = { ...originalHeaders };
   const originalContentDisposition = headers["content-disposition"];
   delete headers["content-type"];
@@ -159,41 +133,54 @@ async function prepareBodyAndHeadersForSerialization(body, originalHeaders) {
   }
   return { body, headers };
 }
-function isEventIteratorHeaders(headers) {
-  return Boolean(flattenHeader(headers["content-type"])?.startsWith("text/event-stream") && headers["content-disposition"] === void 0);
+async function deserializeBody(headers, body, buffer) {
+  const contentType = flattenHeader(headers["content-type"]);
+  const contentDisposition = flattenHeader(headers["content-disposition"]);
+  if (typeof contentDisposition === "string") {
+    const filename = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
+    return new File(buffer === void 0 ? [] : [buffer], filename, { type: contentType });
+  }
+  if (contentType?.startsWith("multipart/form-data")) {
+    const tempRes = new Response(buffer, { headers: { "content-type": contentType } });
+    return tempRes.formData();
+  }
+  if (contentType?.startsWith("application/x-www-form-urlencoded") && typeof body === "string") {
+    return new URLSearchParams(body);
+  }
+  return body;
 }
 const JSON_AND_BINARY_DELIMITER = 255;
-async function encodeRawMessage(data, blobData) {
+async function encodeRawMessage(data, blob) {
   const json = stringifyJSON(data);
-  if (blobData === void 0) {
+  if (blob === void 0 || blob.size === 0) {
     return json;
   }
-  return new Blob([
+  return readAsBuffer(new Blob([
     new TextEncoder().encode(json),
     new Uint8Array([JSON_AND_BINARY_DELIMITER]),
-    blobData
-  ]);
+    blob
+  ]));
 }
 async function decodeRawMessage(raw) {
   if (typeof raw === "string") {
     return { json: JSON.parse(raw) };
   }
-  const buffer = new Uint8Array(raw instanceof Blob ? await raw.arrayBuffer() : raw);
+  const buffer = raw instanceof Uint8Array ? raw : new Uint8Array(raw);
   const delimiterIndex = buffer.indexOf(JSON_AND_BINARY_DELIMITER);
   if (delimiterIndex === -1) {
     const jsonPart2 = new TextDecoder().decode(buffer);
     return { json: JSON.parse(jsonPart2) };
   }
-  const jsonPart = new TextDecoder().decode(buffer.slice(0, delimiterIndex));
-  const blobData = buffer.slice(delimiterIndex + 1);
+  const jsonPart = new TextDecoder().decode(buffer.subarray(0, delimiterIndex));
+  const bufferPart = buffer.subarray(delimiterIndex + 1);
   return {
     json: JSON.parse(jsonPart),
-    blobData: blobData.buffer
+    buffer: bufferPart
   };
 }
 
 function toEventIterator(queue, id, cleanup) {
-  return createAsyncIteratorObject(async () => {
+  return new AsyncIteratorClass(async () => {
     const item = await queue.pull(id);
     switch (item.event) {
       case "message": {
@@ -415,13 +402,17 @@ class ServerPeer {
     }
     await this.send(id, MessageType.RESPONSE, response).then(async () => {
       if (!signal.aborted && isAsyncIteratorObject(response.body)) {
-        await resolveEventIterator(response.body, async (payload) => {
-          if (signal.aborted) {
-            return "abort";
-          }
-          await this.send(id, MessageType.EVENT_ITERATOR, payload);
-          return "next";
-        });
+        if (response.body instanceof experimental_HibernationEventIterator) {
+          response.body.hibernationCallback?.(id);
+        } else {
+          await resolveEventIterator(response.body, async (payload) => {
+            if (signal.aborted) {
+              return "abort";
+            }
+            await this.send(id, MessageType.EVENT_ITERATOR, payload);
+            return "next";
+          });
+        }
       }
       this.close({ id, abort: false });
     }).catch((reason) => {
@@ -445,4 +436,4 @@ class ServerPeer {
   }
 }
 
-export { ClientPeer, MessageType, ServerPeer, decodeRequestMessage, decodeResponseMessage, encodeRequestMessage, encodeResponseMessage, isEventIteratorHeaders, resolveEventIterator, toEventIterator };
+export { ClientPeer, MessageType, ServerPeer, decodeRequestMessage, decodeResponseMessage, encodeRequestMessage, encodeResponseMessage, resolveEventIterator, toEventIterator };

package/package.json

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