@orpc/standard-server-fetch 0.0.0-next.d3b4900 → 0.0.0-next.d4f9056

package/README.md

@@ -17,32 +17,31 @@
   <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>
 
-**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
 
 ---
 
 ## Highlights
 
-- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
-- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
-- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
-- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
-- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
-- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
-- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
-- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
-- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
-- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
-- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
-- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
-- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
-- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
-- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
-- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+- **🔗 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.
+- **🔍 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.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 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.
 
 ## Documentation
 
@@ -53,12 +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/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/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/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.
 - [@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,6 +1,9 @@
 import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
+import { SetSpanErrorOptions, AsyncIteratorClass } from '@orpc/shared';
 
-declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
+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.
@@ -23,7 +26,9 @@ interface ToEventStreamOptions {
 }
 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 {
 }
 /**
@@ -51,6 +56,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 { type ToEventStreamOptions, type ToFetchBodyOptions, type ToFetchRequestOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
+export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
+export type { ToEventIteratorOptions, ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions, ToStandardBodyOptions, ToStandardLazyResponseOptions };

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
+import { SetSpanErrorOptions, AsyncIteratorClass } from '@orpc/shared';
 
-declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
+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.
@@ -23,7 +26,9 @@ interface ToEventStreamOptions {
 }
 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 {
 }
 /**
@@ -51,6 +56,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 { type ToEventStreamOptions, type ToFetchBodyOptions, type ToFetchRequestOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
+export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
+export type { ToEventIteratorOptions, ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions, ToStandardBodyOptions, ToStandardLazyResponseOptions };

package/dist/index.mjs

@@ -1,15 +1,24 @@
-import { stringifyJSON, parseEmptyableJSON, isTypescriptObject, isAsyncIteratorObject, once } from '@orpc/shared';
-import { EventDecoderStream, encodeEventMessage, getEventMeta, ErrorEvent, withEventMeta, parseContentDisposition, contentDisposition } from '@orpc/standard-server';
+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) {
-  const eventStream = stream.pipeThrough(new TextDecoderStream()).pipeThrough(new EventDecoderStream());
-  const reader = eventStream.getReader();
-  async function* gen() {
+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 () => {
+    span ??= startSpan("consume_event_iterator_stream");
     try {
       while (true) {
-        const { done, value } = await reader.read();
+        if (reader === void 0) {
+          return { done: true, value: void 0 };
+        }
+        const { done, value } = await runInSpanContext(span, () => reader.read());
         if (done) {
-          return;
+          if (isCancelled) {
+            throw new AbortError("Stream was cancelled");
+          }
+          return { done: true, value: void 0 };
         }
         switch (value.event) {
           case "message": {
@@ -17,14 +26,15 @@ function toEventIterator(stream) {
             if (isTypescriptObject(message)) {
               message = withEventMeta(message, value);
             }
-            yield message;
-            break;
+            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": {
@@ -32,22 +42,46 @@ function toEventIterator(stream) {
             if (isTypescriptObject(done2)) {
               done2 = withEventMeta(done2, value);
             }
-            return done2;
+            span?.addEvent("done");
+            return { done: true, value: done2 };
+          }
+          default: {
+            span?.addEvent("maybe_keepalive");
           }
         }
       }
+    } 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 {
-      await reader.cancel();
+      span?.end();
     }
-  }
-  return gen();
+  });
 }
 function toEventStream(iterator, options = {}) {
   const keepAliveEnabled = options.eventIteratorKeepAliveEnabled ?? true;
   const keepAliveInterval = options.eventIteratorKeepAliveInterval ?? 5e3;
   const keepAliveComment = options.eventIteratorKeepAliveComment ?? "";
+  let cancelled = false;
   let timeout;
+  let span;
   const stream = new ReadableStream({
+    start() {
+      span = startSpan("stream_event_iterator");
+    },
     async pull(controller) {
       try {
         if (keepAliveEnabled) {
@@ -55,77 +89,104 @@ 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);
-        controller.enqueue(encodeEventMessage({
-          ...getEventMeta(value.value),
-          event: value.done ? "done" : "message",
-          data: stringifyJSON(value.value)
-        }));
+        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,
+            data: stringifyJSON(value.value)
+          }));
+          span?.addEvent(event);
+        }
         if (value.done) {
           controller.close();
+          span?.end();
         }
       } catch (err) {
         clearInterval(timeout);
-        controller.enqueue(encodeEventMessage({
-          ...getEventMeta(err),
-          event: "error",
-          data: err instanceof ErrorEvent ? stringifyJSON(err.data) : void 0
-        }));
-        controller.close();
+        if (cancelled) {
+          return;
+        }
+        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(reason) {
-      if (reason) {
-        await iterator.throw?.(reason);
-      } else {
-        await iterator.return?.();
+    async cancel() {
+      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) {
-  if (!re.body) {
-    return void 0;
-  }
-  const contentDisposition2 = re.headers.get("content-disposition");
-  if (contentDisposition2) {
-    const fileName = parseContentDisposition(contentDisposition2).parameters.filename;
-    if (typeof fileName === "string") {
-      const blob2 = await re.blob();
-      return new File([blob2], fileName, {
-        type: blob2.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
       });
     }
-  }
-  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 toFetchBody(body, headers, options = {}) {
+  const currentContentDisposition = headers.get("content-disposition");
   headers.delete("content-type");
   headers.delete("content-disposition");
   if (body === void 0) {
@@ -136,7 +197,7 @@ function toFetchBody(body, headers, options = {}) {
     headers.set("content-length", body.size.toString());
     headers.set(
       "content-disposition",
-      contentDisposition(body instanceof File ? body.name : "blob", { type: "inline" })
+      currentContentDisposition ?? generateContentDisposition(body instanceof File ? body.name : "blob")
     );
     return body;
   }
@@ -148,8 +209,6 @@ function toFetchBody(body, headers, options = {}) {
   }
   if (isAsyncIteratorObject(body)) {
     headers.set("content-type", "text/event-stream");
-    headers.set("cache-control", "no-cache");
-    headers.set("connection", "keep-alive");
     return toEventStream(body, options);
   }
   headers.set("content-type", "application/json");
@@ -157,7 +216,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) {
@@ -165,7 +224,7 @@ function toStandardHeaders(headers, standardHeaders = {}) {
     } else {
       standardHeaders[key] = value;
     }
-  }
+  });
   return standardHeaders;
 }
 function toFetchHeaders(headers, fetchHeaders = new Headers()) {
@@ -182,15 +241,13 @@ function toFetchHeaders(headers, fetchHeaders = new Headers()) {
 }
 
 function toStandardLazyRequest(request) {
-  const raw = { adapter: "fetch", request };
   return {
-    raw,
     url: new URL(request.url),
     signal: request.signal,
     method: request.method,
-    body: once(() => toStandardBody(raw.request)),
+    body: once(() => toStandardBody(request, { signal: request.signal })),
     get headers() {
-      const headers = toStandardHeaders(raw.request.headers);
+      const headers = toStandardHeaders(request.headers);
       Object.defineProperty(this, "headers", { value: headers, writable: true });
       return headers;
     },
@@ -215,14 +272,12 @@ function toFetchResponse(response, options = {}) {
   const body = toFetchBody(response.body, headers, options);
   return new Response(body, { headers, status: response.status });
 }
-function toStandardLazyResponse(response) {
-  const raw = { adapter: "fetch", response };
+function toStandardLazyResponse(response, options = {}) {
   return {
-    raw,
-    body: once(() => toStandardBody(raw.response)),
+    body: once(() => toStandardBody(response, options)),
     status: response.status,
     get headers() {
-      const headers = toStandardHeaders(raw.response.headers);
+      const headers = toStandardHeaders(response.headers);
       Object.defineProperty(this, "headers", { value: headers, writable: true });
       return headers;
     },

package/package.json

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