@orpc/standard-server-fetch 0.0.0-next.fc23c8d → 0.0.0-next.fc2dc8f

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+  <image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
@@ -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, Angular), 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,11 +42,10 @@
 - **📡 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
 
-You can find the full documentation [here](https://orpc.unnoq.com).
+You can find the full documentation [here](https://orpc.dev).
 
 ## Packages
 
@@ -50,9 +53,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@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/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/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/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.

package/dist/index.d.mts

@@ -1,7 +1,9 @@
 import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
-import { AsyncIteratorClass } from '@orpc/shared';
+import { SetSpanErrorOptions, AsyncIteratorClass } from '@orpc/shared';
 
-declare function toEventIterator(stream: ReadableStream<Uint8Array> | null): AsyncIteratorClass<unknown>;
+interface ToEventIteratorOptions extends SetSpanErrorOptions {
+}
+declare function toEventIterator(stream: ReadableStream<Uint8Array> | null, options?: ToEventIteratorOptions): AsyncIteratorClass<unknown>;
 interface ToEventStreamOptions {
     /**
      * If true, a ping comment is sent periodically to keep the connection alive.
@@ -21,10 +23,25 @@ interface ToEventStreamOptions {
      * @default ''
      */
     eventIteratorKeepAliveComment?: string;
+    /**
+     * If true, an initial comment is sent immediately upon stream start to flush headers.
+     * This allows the receiving side to establish the connection without waiting for the first event.
+     *
+     * @default true
+     */
+    eventIteratorInitialCommentEnabled?: boolean;
+    /**
+     * The content of the initial comment sent upon stream start. Must not include newline characters.
+     *
+     * @default ''
+     */
+    eventIteratorInitialComment?: string;
 }
 declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
 
-declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
+interface ToStandardBodyOptions extends ToEventIteratorOptions {
+}
+declare function toStandardBody(re: Request | Response, options?: ToStandardBodyOptions): Promise<StandardBody>;
 interface ToFetchBodyOptions extends ToEventStreamOptions {
 }
 /**
@@ -52,7 +69,9 @@ declare function toFetchRequest(request: StandardRequest, options?: ToFetchReque
 interface ToFetchResponseOptions extends ToFetchBodyOptions {
 }
 declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
-declare function toStandardLazyResponse(response: Response): StandardLazyResponse;
+interface ToStandardLazyResponseOptions extends ToStandardBodyOptions {
+}
+declare function toStandardLazyResponse(response: Response, options?: ToStandardLazyResponseOptions): StandardLazyResponse;
 
 export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
-export type { ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions };
+export type { ToEventIteratorOptions, ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions, ToStandardBodyOptions, ToStandardLazyResponseOptions };

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
-import { AsyncIteratorClass } from '@orpc/shared';
+import { SetSpanErrorOptions, AsyncIteratorClass } from '@orpc/shared';
 
-declare function toEventIterator(stream: ReadableStream<Uint8Array> | null): AsyncIteratorClass<unknown>;
+interface ToEventIteratorOptions extends SetSpanErrorOptions {
+}
+declare function toEventIterator(stream: ReadableStream<Uint8Array> | null, options?: ToEventIteratorOptions): AsyncIteratorClass<unknown>;
 interface ToEventStreamOptions {
     /**
      * If true, a ping comment is sent periodically to keep the connection alive.
@@ -21,10 +23,25 @@ interface ToEventStreamOptions {
      * @default ''
      */
     eventIteratorKeepAliveComment?: string;
+    /**
+     * If true, an initial comment is sent immediately upon stream start to flush headers.
+     * This allows the receiving side to establish the connection without waiting for the first event.
+     *
+     * @default true
+     */
+    eventIteratorInitialCommentEnabled?: boolean;
+    /**
+     * The content of the initial comment sent upon stream start. Must not include newline characters.
+     *
+     * @default ''
+     */
+    eventIteratorInitialComment?: string;
 }
 declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
 
-declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
+interface ToStandardBodyOptions extends ToEventIteratorOptions {
+}
+declare function toStandardBody(re: Request | Response, options?: ToStandardBodyOptions): Promise<StandardBody>;
 interface ToFetchBodyOptions extends ToEventStreamOptions {
 }
 /**
@@ -52,7 +69,9 @@ declare function toFetchRequest(request: StandardRequest, options?: ToFetchReque
 interface ToFetchResponseOptions extends ToFetchBodyOptions {
 }
 declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
-declare function toStandardLazyResponse(response: Response): StandardLazyResponse;
+interface ToStandardLazyResponseOptions extends ToStandardBodyOptions {
+}
+declare function toStandardLazyResponse(response: Response, options?: ToStandardLazyResponseOptions): StandardLazyResponse;
 
 export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
-export type { ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions };
+export type { ToEventIteratorOptions, ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions, ToStandardBodyOptions, ToStandardLazyResponseOptions };

package/dist/index.mjs

@@ -1,53 +1,94 @@
-import { AsyncIteratorClass, parseEmptyableJSON, isTypescriptObject, stringifyJSON, isAsyncIteratorObject, once } from '@orpc/shared';
+import { AsyncIteratorClass, startSpan, runInSpanContext, AbortError, parseEmptyableJSON, isTypescriptObject, setSpanError, stringifyJSON, runWithSpan, isAsyncIteratorObject, once } from '@orpc/shared';
 import { EventDecoderStream, withEventMeta, ErrorEvent, encodeEventMessage, getEventMeta, getFilenameFromContentDisposition, generateContentDisposition } from '@orpc/standard-server';
 
-function toEventIterator(stream) {
+function toEventIterator(stream, options = {}) {
   const eventStream = stream?.pipeThrough(new TextDecoderStream()).pipeThrough(new EventDecoderStream());
   const reader = eventStream?.getReader();
+  let span;
+  let isCancelled = false;
   return new AsyncIteratorClass(async () => {
-    while (true) {
-      if (reader === void 0) {
-        return { done: true, value: void 0 };
-      }
-      const { done, value } = await reader.read();
-      if (done) {
-        return { done: true, value: void 0 };
-      }
-      switch (value.event) {
-        case "message": {
-          let message = parseEmptyableJSON(value.data);
-          if (isTypescriptObject(message)) {
-            message = withEventMeta(message, value);
-          }
-          return { done: false, value: message };
+    span ??= startSpan("consume_event_iterator_stream");
+    try {
+      while (true) {
+        if (reader === void 0) {
+          return { done: true, value: void 0 };
         }
-        case "error": {
-          let error = new ErrorEvent({
-            data: parseEmptyableJSON(value.data)
-          });
-          error = withEventMeta(error, value);
-          throw error;
+        const { done, value } = await runInSpanContext(span, () => reader.read());
+        if (done) {
+          if (isCancelled) {
+            throw new AbortError("Stream was cancelled");
+          }
+          return { done: true, value: void 0 };
         }
-        case "done": {
-          let done2 = parseEmptyableJSON(value.data);
-          if (isTypescriptObject(done2)) {
-            done2 = withEventMeta(done2, value);
+        switch (value.event) {
+          case "message": {
+            let message = parseEmptyableJSON(value.data);
+            if (isTypescriptObject(message)) {
+              message = withEventMeta(message, value);
+            }
+            span?.addEvent("message");
+            return { done: false, value: message };
+          }
+          case "error": {
+            let error = new ErrorEvent({
+              data: parseEmptyableJSON(value.data)
+            });
+            error = withEventMeta(error, value);
+            span?.addEvent("error");
+            throw error;
+          }
+          case "done": {
+            let done2 = parseEmptyableJSON(value.data);
+            if (isTypescriptObject(done2)) {
+              done2 = withEventMeta(done2, value);
+            }
+            span?.addEvent("done");
+            return { done: true, value: done2 };
+          }
+          default: {
+            span?.addEvent("maybe_keepalive");
           }
-          return { done: true, value: done2 };
         }
       }
+    } catch (e) {
+      if (!(e instanceof ErrorEvent)) {
+        setSpanError(span, e, options);
+      }
+      throw e;
+    }
+  }, async (reason) => {
+    try {
+      if (reason !== "next") {
+        isCancelled = true;
+        span?.addEvent("cancelled");
+      }
+      await runInSpanContext(span, () => reader?.cancel());
+    } catch (e) {
+      setSpanError(span, e, options);
+      throw e;
+    } finally {
+      span?.end();
     }
-  }, async () => {
-    await reader?.cancel();
   });
 }
 function toEventStream(iterator, options = {}) {
   const keepAliveEnabled = options.eventIteratorKeepAliveEnabled ?? true;
   const keepAliveInterval = options.eventIteratorKeepAliveInterval ?? 5e3;
   const keepAliveComment = options.eventIteratorKeepAliveComment ?? "";
+  const initialCommentEnabled = options.eventIteratorInitialCommentEnabled ?? true;
+  const initialComment = options.eventIteratorInitialComment ?? "";
   let cancelled = false;
   let timeout;
+  let span;
   const stream = new ReadableStream({
+    start(controller) {
+      span = startSpan("stream_event_iterator");
+      if (initialCommentEnabled) {
+        controller.enqueue(encodeEventMessage({
+          comments: [initialComment]
+        }));
+      }
+    },
     async pull(controller) {
       try {
         if (keepAliveEnabled) {
@@ -55,77 +96,101 @@ function toEventStream(iterator, options = {}) {
             controller.enqueue(encodeEventMessage({
               comments: [keepAliveComment]
             }));
+            span?.addEvent("keepalive");
           }, keepAliveInterval);
         }
-        const value = await iterator.next();
+        const value = await runInSpanContext(span, () => iterator.next());
         clearInterval(timeout);
         if (cancelled) {
           return;
         }
         const meta = getEventMeta(value.value);
         if (!value.done || value.value !== void 0 || meta !== void 0) {
+          const event = value.done ? "done" : "message";
           controller.enqueue(encodeEventMessage({
             ...meta,
-            event: value.done ? "done" : "message",
+            event,
             data: stringifyJSON(value.value)
           }));
+          span?.addEvent(event);
         }
         if (value.done) {
           controller.close();
+          span?.end();
         }
       } catch (err) {
         clearInterval(timeout);
         if (cancelled) {
           return;
         }
-        controller.enqueue(encodeEventMessage({
-          ...getEventMeta(err),
-          event: "error",
-          data: err instanceof ErrorEvent ? stringifyJSON(err.data) : void 0
-        }));
-        controller.close();
+        if (err instanceof ErrorEvent) {
+          controller.enqueue(encodeEventMessage({
+            ...getEventMeta(err),
+            event: "error",
+            data: stringifyJSON(err.data)
+          }));
+          span?.addEvent("error");
+          controller.close();
+        } else {
+          setSpanError(span, err);
+          controller.error(err);
+        }
+        span?.end();
       }
     },
     async cancel() {
-      cancelled = true;
-      clearInterval(timeout);
-      await iterator.return?.();
+      try {
+        cancelled = true;
+        clearInterval(timeout);
+        span?.addEvent("cancelled");
+        await runInSpanContext(span, () => iterator.return?.());
+      } catch (e) {
+        setSpanError(span, e);
+        throw e;
+      } finally {
+        span?.end();
+      }
     }
   }).pipeThrough(new TextEncoderStream());
   return stream;
 }
 
-async function toStandardBody(re) {
-  const contentDisposition = re.headers.get("content-disposition");
-  if (typeof contentDisposition === "string") {
-    const fileName = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
-    const blob2 = await re.blob();
-    return new File([blob2], fileName, {
-      type: blob2.type
-    });
-  }
-  const contentType = re.headers.get("content-type");
-  if (!contentType || contentType.startsWith("application/json")) {
-    const text = await re.text();
-    return parseEmptyableJSON(text);
-  }
-  if (contentType.startsWith("multipart/form-data")) {
-    return await re.formData();
-  }
-  if (contentType.startsWith("application/x-www-form-urlencoded")) {
-    const text = await re.text();
-    return new URLSearchParams(text);
-  }
-  if (contentType.startsWith("text/event-stream")) {
-    return toEventIterator(re.body);
-  }
-  if (contentType.startsWith("text/plain")) {
-    return await re.text();
-  }
-  const blob = await re.blob();
-  return new File([blob], "blob", {
-    type: blob.type
-  });
+function toStandardBody(re, options = {}) {
+  return runWithSpan(
+    { name: "parse_standard_body", signal: options.signal },
+    async () => {
+      const contentDisposition = re.headers.get("content-disposition");
+      if (typeof contentDisposition === "string") {
+        const fileName = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
+        const blob2 = await re.blob();
+        return new File([blob2], fileName, {
+          type: blob2.type
+        });
+      }
+      const contentType = re.headers.get("content-type");
+      if (!contentType || contentType.startsWith("application/json")) {
+        const text = await re.text();
+        return parseEmptyableJSON(text);
+      }
+      if (contentType.startsWith("multipart/form-data")) {
+        return await re.formData();
+      }
+      if (contentType.startsWith("application/x-www-form-urlencoded")) {
+        const text = await re.text();
+        return new URLSearchParams(text);
+      }
+      if (contentType.startsWith("text/event-stream")) {
+        return toEventIterator(re.body, options);
+      }
+      if (contentType.startsWith("text/plain")) {
+        return await re.text();
+      }
+      const blob = await re.blob();
+      return new File([blob], "blob", {
+        type: blob.type
+      });
+    }
+  );
 }
 function toFetchBody(body, headers, options = {}) {
   const currentContentDisposition = headers.get("content-disposition");
@@ -158,7 +223,7 @@ function toFetchBody(body, headers, options = {}) {
 }
 
 function toStandardHeaders(headers, standardHeaders = {}) {
-  for (const [key, value] of headers) {
+  headers.forEach((value, key) => {
     if (Array.isArray(standardHeaders[key])) {
       standardHeaders[key].push(value);
     } else if (standardHeaders[key] !== void 0) {
@@ -166,7 +231,7 @@ function toStandardHeaders(headers, standardHeaders = {}) {
     } else {
       standardHeaders[key] = value;
     }
-  }
+  });
   return standardHeaders;
 }
 function toFetchHeaders(headers, fetchHeaders = new Headers()) {
@@ -187,7 +252,7 @@ function toStandardLazyRequest(request) {
     url: new URL(request.url),
     signal: request.signal,
     method: request.method,
-    body: once(() => toStandardBody(request)),
+    body: once(() => toStandardBody(request, { signal: request.signal })),
     get headers() {
       const headers = toStandardHeaders(request.headers);
       Object.defineProperty(this, "headers", { value: headers, writable: true });
@@ -214,9 +279,9 @@ function toFetchResponse(response, options = {}) {
   const body = toFetchBody(response.body, headers, options);
   return new Response(body, { headers, status: response.status });
 }
-function toStandardLazyResponse(response) {
+function toStandardLazyResponse(response, options = {}) {
   return {
-    body: once(() => toStandardBody(response)),
+    body: once(() => toStandardBody(response, options)),
     status: response.status,
     get headers() {
       const headers = toStandardHeaders(response.headers);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/standard-server-fetch",
   "type": "module",
-  "version": "0.0.0-next.fc23c8d",
+  "version": "0.0.0-next.fc2dc8f",
   "license": "MIT",
   "homepage": "https://unnoq.com",
   "repository": {
@@ -23,11 +23,11 @@
     "dist"
   ],
   "dependencies": {
-    "@orpc/shared": "0.0.0-next.fc23c8d",
-    "@orpc/standard-server": "0.0.0-next.fc23c8d"
+    "@orpc/shared": "0.0.0-next.fc2dc8f",
+    "@orpc/standard-server": "0.0.0-next.fc2dc8f"
   },
   "devDependencies": {
-    "@hono/node-server": "^1.14.4"
+    "@hono/node-server": "^1.19.7"
   },
   "scripts": {
     "build": "unbuild",