@orpc/standard-server-fetch 0.0.0-next.b36125c → 0.0.0-next.b3afdeb

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
@@ -32,7 +32,7 @@
 - **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.
+- **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.
@@ -55,14 +55,26 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@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/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

@@ -0,0 +1,56 @@
+import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
+
+declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
+interface ToEventStreamOptions {
+    /**
+     * If true, a ping comment is sent periodically to keep the connection alive.
+     *
+     * @default true
+     */
+    eventIteratorKeepAliveEnabled?: boolean;
+    /**
+     * Interval (in milliseconds) between ping comments sent after the last event.
+     *
+     * @default 5000
+     */
+    eventIteratorKeepAliveInterval?: number;
+    /**
+     * The content of the ping comment. Must not include newline characters.
+     *
+     * @default ''
+     */
+    eventIteratorKeepAliveComment?: string;
+}
+declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
+
+declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
+interface ToFetchBodyOptions extends ToEventStreamOptions {
+}
+/**
+ * @param body
+ * @param headers - The headers can be changed by the function and effects on the original headers.
+ */
+declare function toFetchBody(body: StandardBody, headers: Headers, options?: ToFetchBodyOptions): string | Blob | FormData | URLSearchParams | undefined | ReadableStream<Uint8Array>;
+
+/**
+ * @param headers
+ * @param standardHeaders - The base headers can be changed by the function and effects on the original headers.
+ */
+declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardHeaders): StandardHeaders;
+/**
+ * @param headers
+ * @param fetchHeaders - The base headers can be changed by the function and effects on the original headers.
+ */
+declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
+
+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 ToFetchRequestOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
+
+declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
+interface ToEventStreamOptions {
+    /**
+     * If true, a ping comment is sent periodically to keep the connection alive.
+     *
+     * @default true
+     */
+    eventIteratorKeepAliveEnabled?: boolean;
+    /**
+     * Interval (in milliseconds) between ping comments sent after the last event.
+     *
+     * @default 5000
+     */
+    eventIteratorKeepAliveInterval?: number;
+    /**
+     * The content of the ping comment. Must not include newline characters.
+     *
+     * @default ''
+     */
+    eventIteratorKeepAliveComment?: string;
+}
+declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
+
+declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
+interface ToFetchBodyOptions extends ToEventStreamOptions {
+}
+/**
+ * @param body
+ * @param headers - The headers can be changed by the function and effects on the original headers.
+ */
+declare function toFetchBody(body: StandardBody, headers: Headers, options?: ToFetchBodyOptions): string | Blob | FormData | URLSearchParams | undefined | ReadableStream<Uint8Array>;
+
+/**
+ * @param headers
+ * @param standardHeaders - The base headers can be changed by the function and effects on the original headers.
+ */
+declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardHeaders): StandardHeaders;
+/**
+ * @param headers
+ * @param fetchHeaders - The base headers can be changed by the function and effects on the original headers.
+ */
+declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
+
+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 ToFetchRequestOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };

package/dist/{index.js → index.mjs}

@@ -1,16 +1,6 @@
-// src/body.ts
-import { isAsyncIteratorObject, parseEmptyableJSON as parseEmptyableJSON2, stringifyJSON as stringifyJSON2 } from "@orpc/shared";
-import { contentDisposition, parseContentDisposition } from "@orpc/standard-server";
+import { stringifyJSON, parseEmptyableJSON, isTypescriptObject, isAsyncIteratorObject, once } from '@orpc/shared';
+import { EventDecoderStream, encodeEventMessage, getEventMeta, ErrorEvent, withEventMeta, parseContentDisposition, contentDisposition } from '@orpc/standard-server';
 
-// src/event-source.ts
-import { isTypescriptObject, parseEmptyableJSON, stringifyJSON } from "@orpc/shared";
-import {
-  encodeEventMessage,
-  ErrorEvent,
-  EventDecoderStream,
-  getEventMeta,
-  withEventMeta
-} from "@orpc/standard-server";
 function toEventIterator(stream) {
   const eventStream = stream.pipeThrough(new TextDecoderStream()).pipeThrough(new EventDecoderStream());
   const reader = eventStream.getReader();
@@ -52,11 +42,23 @@ function toEventIterator(stream) {
   }
   return gen();
 }
-function toEventStream(iterator) {
+function toEventStream(iterator, options = {}) {
+  const keepAliveEnabled = options.eventIteratorKeepAliveEnabled ?? true;
+  const keepAliveInterval = options.eventIteratorKeepAliveInterval ?? 5e3;
+  const keepAliveComment = options.eventIteratorKeepAliveComment ?? "";
+  let timeout;
   const stream = new ReadableStream({
     async pull(controller) {
       try {
+        if (keepAliveEnabled) {
+          timeout = setInterval(() => {
+            controller.enqueue(encodeEventMessage({
+              comments: [keepAliveComment]
+            }));
+          }, keepAliveInterval);
+        }
         const value = await iterator.next();
+        clearInterval(timeout);
         controller.enqueue(encodeEventMessage({
           ...getEventMeta(value.value),
           event: value.done ? "done" : "message",
@@ -66,6 +68,7 @@ function toEventStream(iterator) {
           controller.close();
         }
       } catch (err) {
+        clearInterval(timeout);
         controller.enqueue(encodeEventMessage({
           ...getEventMeta(err),
           event: "error",
@@ -85,7 +88,6 @@ function toEventStream(iterator) {
   return stream;
 }
 
-// src/body.ts
 async function toStandardBody(re) {
   if (!re.body) {
     return void 0;
@@ -103,7 +105,7 @@ async function toStandardBody(re) {
   const contentType = re.headers.get("content-type");
   if (!contentType || contentType.startsWith("application/json")) {
     const text = await re.text();
-    return parseEmptyableJSON2(text);
+    return parseEmptyableJSON(text);
   }
   if (contentType.startsWith("multipart/form-data")) {
     return await re.formData();
@@ -123,7 +125,7 @@ async function toStandardBody(re) {
     type: blob.type
   });
 }
-function toFetchBody(body, headers) {
+function toFetchBody(body, headers, options = {}) {
   headers.delete("content-type");
   headers.delete("content-disposition");
   if (body === void 0) {
@@ -148,13 +150,12 @@ function toFetchBody(body, headers) {
     headers.set("content-type", "text/event-stream");
     headers.set("cache-control", "no-cache");
     headers.set("connection", "keep-alive");
-    return toEventStream(body);
+    return toEventStream(body, options);
   }
   headers.set("content-type", "application/json");
-  return stringifyJSON2(body);
+  return stringifyJSON(body);
 }
 
-// src/headers.ts
 function toStandardHeaders(headers, standardHeaders = {}) {
   for (const [key, value] of headers) {
     if (Array.isArray(standardHeaders[key])) {
@@ -180,9 +181,7 @@ function toFetchHeaders(headers, fetchHeaders = new Headers()) {
   return fetchHeaders;
 }
 
-// src/request.ts
-import { once } from "@orpc/shared";
-function toStandardRequest(request) {
+function toStandardLazyRequest(request) {
   return {
     raw: { request },
     url: new URL(request.url),
@@ -199,21 +198,36 @@ 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
+  });
+}
 
-// src/response.ts
-function toFetchResponse(response) {
+function toFetchResponse(response, options = {}) {
   const headers = toFetchHeaders(response.headers);
-  const body = toFetchBody(response.body, headers);
+  const body = toFetchBody(response.body, headers, options);
   return new Response(body, { headers, status: response.status });
 }
-export {
-  toEventIterator,
-  toEventStream,
-  toFetchBody,
-  toFetchHeaders,
-  toFetchResponse,
-  toStandardBody,
-  toStandardHeaders,
-  toStandardRequest
-};
-//# sourceMappingURL=index.js.map
+function toStandardLazyResponse(response) {
+  return {
+    raw: { response },
+    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, 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.b36125c",
+  "version": "0.0.0-next.b3afdeb",
   "license": "MIT",
   "homepage": "https://unnoq.com",
   "repository": {
@@ -14,28 +14,23 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    },
-    "./🔒/*": {
-      "types": "./dist/src/*.d.ts"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
     }
   },
   "files": [
-    "!**/*.map",
-    "!**/*.tsbuildinfo",
     "dist"
   ],
   "dependencies": {
-    "@orpc/shared": "0.0.0-next.b36125c",
-    "@orpc/standard-server": "0.0.0-next.b36125c"
+    "@orpc/shared": "0.0.0-next.b3afdeb",
+    "@orpc/standard-server": "0.0.0-next.b3afdeb"
   },
   "devDependencies": {
     "@hono/node-server": "^1.13.8"
   },
   "scripts": {
-    "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
+    "build": "unbuild",
     "build:watch": "pnpm run build --watch",
     "type:check": "tsc -b"
   }

package/dist/src/body.d.ts

@@ -1,8 +0,0 @@
-import type { StandardBody } from '@orpc/standard-server';
-export declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
-/**
- * @param body
- * @param headers - The headers can be changed by the function and effects on the original headers.
- */
-export declare function toFetchBody(body: StandardBody, headers: Headers): string | Blob | FormData | URLSearchParams | undefined | ReadableStream<Uint8Array>;
-//# sourceMappingURL=body.d.ts.map

package/dist/src/event-source.d.ts

@@ -1,3 +0,0 @@
-export declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
-export declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>): ReadableStream<Uint8Array>;
-//# sourceMappingURL=event-source.d.ts.map

package/dist/src/headers.d.ts

@@ -1,12 +0,0 @@
-import type { StandardHeaders } from '@orpc/standard-server';
-/**
- * @param headers
- * @param standardHeaders - The base headers can be changed by the function and effects on the original headers.
- */
-export declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardHeaders): StandardHeaders;
-/**
- * @param headers
- * @param fetchHeaders - The base headers can be changed by the function and effects on the original headers.
- */
-export declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
-//# sourceMappingURL=headers.d.ts.map

package/dist/src/index.d.ts

@@ -1,6 +0,0 @@
-export * from './body';
-export * from './event-source';
-export * from './headers';
-export * from './request';
-export * from './response';
-//# sourceMappingURL=index.d.ts.map

package/dist/src/request.d.ts

@@ -1,3 +0,0 @@
-import type { StandardRequest } from '@orpc/standard-server';
-export declare function toStandardRequest(request: Request): StandardRequest;
-//# sourceMappingURL=request.d.ts.map

package/dist/src/response.d.ts

@@ -1,3 +0,0 @@
-import type { StandardResponse } from '@orpc/standard-server';
-export declare function toFetchResponse(response: StandardResponse): Response;
-//# sourceMappingURL=response.d.ts.map