@orpc/standard-server-fetch 0.0.0-next.e7ee5a9 → 0.0.0-next.e8524dc

package/README.md

@@ -21,28 +21,24 @@
 
 <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), 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.
+- **⚙️ 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.
+- **⏱️ 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.
+- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -53,16 +49,28 @@ 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/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/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/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/).
 
 ## `@orpc/standard-server-fetch`
 
 [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) server adapter for oRPC.
 
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
+  </a>
+</p>
+
 ## License
 
 Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.d.mts

@@ -1,25 +1,26 @@
-import { StandardBody, StandardHeaders, StandardRequest, StandardResponse } from '@orpc/standard-server';
+import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
+import { AsyncIteratorClass } from '@orpc/shared';
 
-declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
+declare function toEventIterator(stream: ReadableStream<Uint8Array> | null): AsyncIteratorClass<unknown>;
 interface ToEventStreamOptions {
     /**
      * If true, a ping comment is sent periodically to keep the connection alive.
      *
      * @default true
      */
-    eventSourcePingEnabled?: boolean;
+    eventIteratorKeepAliveEnabled?: boolean;
     /**
      * Interval (in milliseconds) between ping comments sent after the last event.
      *
      * @default 5000
      */
-    eventSourcePingInterval?: number;
+    eventIteratorKeepAliveInterval?: number;
     /**
      * The content of the ping comment. Must not include newline characters.
      *
      * @default ''
      */
-    eventSourcePingContent?: string;
+    eventIteratorKeepAliveComment?: string;
 }
 declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
 
@@ -43,10 +44,15 @@ declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardH
  */
 declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
 
-declare function toStandardRequest(request: Request): StandardRequest;
+declare function toStandardLazyRequest(request: Request): StandardLazyRequest;
+interface ToFetchRequestOptions extends ToFetchBodyOptions {
+}
+declare function toFetchRequest(request: StandardRequest, options?: ToFetchRequestOptions): Request;
 
 interface ToFetchResponseOptions extends ToFetchBodyOptions {
 }
 declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
+declare function toStandardLazyResponse(response: Response): StandardLazyResponse;
 
-export { type ToEventStreamOptions, type ToFetchBodyOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchResponse, toStandardBody, toStandardHeaders, toStandardRequest };
+export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
+export type { ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions };

package/dist/index.d.ts

@@ -1,25 +1,26 @@
-import { StandardBody, StandardHeaders, StandardRequest, StandardResponse } from '@orpc/standard-server';
+import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
+import { AsyncIteratorClass } from '@orpc/shared';
 
-declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
+declare function toEventIterator(stream: ReadableStream<Uint8Array> | null): AsyncIteratorClass<unknown>;
 interface ToEventStreamOptions {
     /**
      * If true, a ping comment is sent periodically to keep the connection alive.
      *
      * @default true
      */
-    eventSourcePingEnabled?: boolean;
+    eventIteratorKeepAliveEnabled?: boolean;
     /**
      * Interval (in milliseconds) between ping comments sent after the last event.
      *
      * @default 5000
      */
-    eventSourcePingInterval?: number;
+    eventIteratorKeepAliveInterval?: number;
     /**
      * The content of the ping comment. Must not include newline characters.
      *
      * @default ''
      */
-    eventSourcePingContent?: string;
+    eventIteratorKeepAliveComment?: string;
 }
 declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
 
@@ -43,10 +44,15 @@ declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardH
  */
 declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
 
-declare function toStandardRequest(request: Request): StandardRequest;
+declare function toStandardLazyRequest(request: Request): StandardLazyRequest;
+interface ToFetchRequestOptions extends ToFetchBodyOptions {
+}
+declare function toFetchRequest(request: StandardRequest, options?: ToFetchRequestOptions): Request;
 
 interface ToFetchResponseOptions extends ToFetchBodyOptions {
 }
 declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
+declare function toStandardLazyResponse(response: Response): StandardLazyResponse;
 
-export { type ToEventStreamOptions, type ToFetchBodyOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchResponse, toStandardBody, toStandardHeaders, toStandardRequest };
+export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
+export type { ToEventStreamOptions, ToFetchBodyOptions, ToFetchRequestOptions, ToFetchResponseOptions };

package/dist/index.mjs

@@ -1,74 +1,83 @@
-import { stringifyJSON, parseEmptyableJSON, isTypescriptObject, isAsyncIteratorObject, once } from '@orpc/shared';
-import { EventDecoderStream, encodeEventMessage, getEventMeta, ErrorEvent, withEventMeta, parseContentDisposition, contentDisposition } from '@orpc/standard-server';
+import { AsyncIteratorClass, parseEmptyableJSON, isTypescriptObject, stringifyJSON, 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() {
-    try {
-      while (true) {
-        const { done, value } = await reader.read();
-        if (done) {
-          return;
-        }
-        switch (value.event) {
-          case "message": {
-            let message = parseEmptyableJSON(value.data);
-            if (isTypescriptObject(message)) {
-              message = withEventMeta(message, value);
-            }
-            yield message;
-            break;
-          }
-          case "error": {
-            let error = new ErrorEvent({
-              data: parseEmptyableJSON(value.data)
-            });
-            error = withEventMeta(error, value);
-            throw error;
+  const eventStream = stream?.pipeThrough(new TextDecoderStream()).pipeThrough(new EventDecoderStream());
+  const reader = eventStream?.getReader();
+  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);
           }
-          case "done": {
-            let done2 = parseEmptyableJSON(value.data);
-            if (isTypescriptObject(done2)) {
-              done2 = withEventMeta(done2, value);
-            }
-            return done2;
+          return { done: false, value: message };
+        }
+        case "error": {
+          let error = new ErrorEvent({
+            data: parseEmptyableJSON(value.data)
+          });
+          error = withEventMeta(error, value);
+          throw error;
+        }
+        case "done": {
+          let done2 = parseEmptyableJSON(value.data);
+          if (isTypescriptObject(done2)) {
+            done2 = withEventMeta(done2, value);
           }
+          return { done: true, value: done2 };
         }
       }
-    } finally {
-      await reader.cancel();
     }
-  }
-  return gen();
+  }, async () => {
+    await reader?.cancel();
+  });
 }
 function toEventStream(iterator, options = {}) {
-  const pingEnabled = options.eventSourcePingEnabled ?? true;
-  const pingInterval = options.eventSourcePingInterval ?? 5e3;
-  const pingContent = options.eventSourcePingContent ?? "";
+  const keepAliveEnabled = options.eventIteratorKeepAliveEnabled ?? true;
+  const keepAliveInterval = options.eventIteratorKeepAliveInterval ?? 5e3;
+  const keepAliveComment = options.eventIteratorKeepAliveComment ?? "";
+  let cancelled = false;
   let timeout;
   const stream = new ReadableStream({
     async pull(controller) {
       try {
-        if (pingEnabled) {
+        if (keepAliveEnabled) {
           timeout = setInterval(() => {
             controller.enqueue(encodeEventMessage({
-              comments: [pingContent]
+              comments: [keepAliveComment]
             }));
-          }, pingInterval);
+          }, keepAliveInterval);
         }
         const value = await 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) {
+          controller.enqueue(encodeEventMessage({
+            ...meta,
+            event: value.done ? "done" : "message",
+            data: stringifyJSON(value.value)
+          }));
+        }
         if (value.done) {
           controller.close();
         }
       } catch (err) {
         clearInterval(timeout);
+        if (cancelled) {
+          return;
+        }
         controller.enqueue(encodeEventMessage({
           ...getEventMeta(err),
           event: "error",
@@ -77,30 +86,23 @@ function toEventStream(iterator, options = {}) {
         controller.close();
       }
     },
-    async cancel(reason) {
-      if (reason) {
-        await iterator.throw?.(reason);
-      } else {
-        await iterator.return?.();
-      }
+    async cancel() {
+      cancelled = true;
+      clearInterval(timeout);
+      await iterator.return?.();
     }
   }).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
-      });
-    }
+  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")) {
@@ -126,6 +128,7 @@ async function toStandardBody(re) {
   });
 }
 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 +139,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 +151,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");
@@ -181,9 +182,8 @@ function toFetchHeaders(headers, fetchHeaders = new Headers()) {
   return fetchHeaders;
 }
 
-function toStandardRequest(request) {
+function toStandardLazyRequest(request) {
   return {
-    raw: { request },
     url: new URL(request.url),
     signal: request.signal,
     method: request.method,
@@ -198,11 +198,35 @@ function toStandardRequest(request) {
     }
   };
 }
+function toFetchRequest(request, options = {}) {
+  const headers = toFetchHeaders(request.headers);
+  const body = toFetchBody(request.body, headers, options);
+  return new Request(request.url, {
+    signal: request.signal,
+    method: request.method,
+    headers,
+    body
+  });
+}
 
 function toFetchResponse(response, options = {}) {
   const headers = toFetchHeaders(response.headers);
   const body = toFetchBody(response.body, headers, options);
   return new Response(body, { headers, status: response.status });
 }
+function toStandardLazyResponse(response) {
+  return {
+    body: once(() => toStandardBody(response)),
+    status: response.status,
+    get headers() {
+      const headers = toStandardHeaders(response.headers);
+      Object.defineProperty(this, "headers", { value: headers, writable: true });
+      return headers;
+    },
+    set headers(value) {
+      Object.defineProperty(this, "headers", { value, writable: true });
+    }
+  };
+}
 
-export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchResponse, toStandardBody, toStandardHeaders, toStandardRequest };
+export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };

package/package.json

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