@orpc/standard-server-node 0.43.0 → 0.44.0

package/README.md

@@ -0,0 +1,68 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/standard-server-node">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fstandard-server-node?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </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.
+
+---
+
+## 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.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@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/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/standard-server-node`
+
+[Node.js](https://nodejs.org) server adapter for oRPC.
+
+## 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, StandardRequest, StandardResponse } from '@orpc/standard-server';
+import { Readable } from 'node:stream';
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
+
+declare function toEventIterator(stream: Readable): AsyncGenerator<unknown | void, unknown | void, void>;
+interface ToEventStreamOptions {
+    /**
+     * If true, a ping comment is sent periodically to keep the connection alive.
+     *
+     * @default true
+     */
+    eventSourcePingEnabled?: boolean;
+    /**
+     * Interval (in milliseconds) between ping comments sent after the last event.
+     *
+     * @default 5000
+     */
+    eventSourcePingInterval?: number;
+    /**
+     * The content of the ping comment. Must not include newline characters.
+     *
+     * @default ''
+     */
+    eventSourcePingContent?: string;
+}
+declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): Readable;
+
+type NodeHttpRequest = (IncomingMessage | Http2ServerRequest) & {
+    /**
+     * Replace `req.url` with `req.originalUrl` when `req.originalUrl` is available.
+     * This is useful for `express.js` middleware.
+     */
+    originalUrl?: string;
+};
+type NodeHttpResponse = ServerResponse | Http2ServerResponse;
+
+declare function toStandardBody(req: NodeHttpRequest): Promise<StandardBody>;
+interface ToNodeHttpBodyOptions extends ToEventStreamOptions {
+}
+/**
+ * @param body
+ * @param headers - WARNING: The headers can be changed by the function and effects on the original headers.
+ * @param options
+ */
+declare function toNodeHttpBody(body: StandardBody, headers: StandardHeaders, options?: ToNodeHttpBodyOptions): Readable | undefined | string;
+
+declare function toStandardRequest(req: NodeHttpRequest, res: NodeHttpResponse): StandardRequest;
+
+interface SendStandardResponseOptions extends ToNodeHttpBodyOptions {
+}
+declare function sendStandardResponse(res: NodeHttpResponse, standardResponse: StandardResponse, options?: SendStandardResponseOptions): Promise<void>;
+
+declare function toAbortSignal(res: NodeHttpResponse): AbortSignal;
+
+export { type NodeHttpRequest, type NodeHttpResponse, type SendStandardResponseOptions, type ToEventStreamOptions, type ToNodeHttpBodyOptions, sendStandardResponse, toAbortSignal, toEventIterator, toEventStream, toNodeHttpBody, toStandardBody, toStandardRequest };

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import { StandardBody, StandardHeaders, StandardRequest, StandardResponse } from '@orpc/standard-server';
+import { Readable } from 'node:stream';
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
+
+declare function toEventIterator(stream: Readable): AsyncGenerator<unknown | void, unknown | void, void>;
+interface ToEventStreamOptions {
+    /**
+     * If true, a ping comment is sent periodically to keep the connection alive.
+     *
+     * @default true
+     */
+    eventSourcePingEnabled?: boolean;
+    /**
+     * Interval (in milliseconds) between ping comments sent after the last event.
+     *
+     * @default 5000
+     */
+    eventSourcePingInterval?: number;
+    /**
+     * The content of the ping comment. Must not include newline characters.
+     *
+     * @default ''
+     */
+    eventSourcePingContent?: string;
+}
+declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): Readable;
+
+type NodeHttpRequest = (IncomingMessage | Http2ServerRequest) & {
+    /**
+     * Replace `req.url` with `req.originalUrl` when `req.originalUrl` is available.
+     * This is useful for `express.js` middleware.
+     */
+    originalUrl?: string;
+};
+type NodeHttpResponse = ServerResponse | Http2ServerResponse;
+
+declare function toStandardBody(req: NodeHttpRequest): Promise<StandardBody>;
+interface ToNodeHttpBodyOptions extends ToEventStreamOptions {
+}
+/**
+ * @param body
+ * @param headers - WARNING: The headers can be changed by the function and effects on the original headers.
+ * @param options
+ */
+declare function toNodeHttpBody(body: StandardBody, headers: StandardHeaders, options?: ToNodeHttpBodyOptions): Readable | undefined | string;
+
+declare function toStandardRequest(req: NodeHttpRequest, res: NodeHttpResponse): StandardRequest;
+
+interface SendStandardResponseOptions extends ToNodeHttpBodyOptions {
+}
+declare function sendStandardResponse(res: NodeHttpResponse, standardResponse: StandardResponse, options?: SendStandardResponseOptions): Promise<void>;
+
+declare function toAbortSignal(res: NodeHttpResponse): AbortSignal;
+
+export { type NodeHttpRequest, type NodeHttpResponse, type SendStandardResponseOptions, type ToEventStreamOptions, type ToNodeHttpBodyOptions, sendStandardResponse, toAbortSignal, toEventIterator, toEventStream, toNodeHttpBody, toStandardBody, toStandardRequest };

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

@@ -1,19 +1,7 @@
-// src/body.ts
-import { Readable as Readable2 } from "node:stream";
-import { contentDisposition, isAsyncIteratorObject, parseContentDisposition, parseEmptyableJSON as parseEmptyableJSON2 } from "@orpc/standard-server";
+import { Readable } from 'node:stream';
+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 { Readable } from "node:stream";
-import {
-  encodeEventMessage,
-  ErrorEvent,
-  EventDecoderStream,
-  getEventMeta,
-  isEventMetaContainer,
-  parseEmptyableJSON,
-  UnknownEvent,
-  withEventMeta
-} from "@orpc/standard-server";
 function toEventIterator(stream) {
   const eventStream = Readable.toWeb(stream).pipeThrough(new TextDecoderStream()).pipeThrough(new EventDecoderStream());
   const reader = eventStream.getReader();
@@ -27,7 +15,7 @@ function toEventIterator(stream) {
         switch (value.event) {
           case "message": {
             let message = parseEmptyableJSON(value.data);
-            if (isEventMetaContainer(message)) {
+            if (isTypescriptObject(message)) {
               message = withEventMeta(message, value);
             }
             yield message;
@@ -42,19 +30,11 @@ function toEventIterator(stream) {
           }
           case "done": {
             let done2 = parseEmptyableJSON(value.data);
-            if (isEventMetaContainer(done2)) {
+            if (isTypescriptObject(done2)) {
               done2 = withEventMeta(done2, value);
             }
             return done2;
           }
-          default: {
-            let error = new UnknownEvent({
-              message: `Unknown event: ${value.event}`,
-              data: parseEmptyableJSON(value.data)
-            });
-            error = withEventMeta(error, value);
-            throw error;
-          }
         }
       }
     } finally {
@@ -63,24 +43,37 @@ function toEventIterator(stream) {
   }
   return gen();
 }
-function toEventStream(iterator) {
+function toEventStream(iterator, options = {}) {
+  const pingEnabled = options.eventSourcePingEnabled ?? true;
+  const pingInterval = options.eventSourcePingInterval ?? 5e3;
+  const pingContent = options.eventSourcePingContent ?? "";
+  let timeout;
   const stream = new ReadableStream({
     async pull(controller) {
       try {
+        if (pingEnabled) {
+          timeout = setInterval(() => {
+            controller.enqueue(encodeEventMessage({
+              comments: [pingContent]
+            }));
+          }, pingInterval);
+        }
         const value = await iterator.next();
+        clearInterval(timeout);
         controller.enqueue(encodeEventMessage({
           ...getEventMeta(value.value),
           event: value.done ? "done" : "message",
-          data: JSON.stringify(value.value)
+          data: stringifyJSON(value.value)
         }));
         if (value.done) {
           controller.close();
         }
       } catch (err) {
+        clearInterval(timeout);
         controller.enqueue(encodeEventMessage({
           ...getEventMeta(err),
           event: "error",
-          data: err instanceof ErrorEvent ? JSON.stringify(err.data) : void 0
+          data: err instanceof ErrorEvent ? stringifyJSON(err.data) : void 0
         }));
         controller.close();
       }
@@ -96,7 +89,6 @@ function toEventStream(iterator) {
   return Readable.fromWeb(stream);
 }
 
-// src/body.ts
 async function toStandardBody(req) {
   const method = req.method ?? "GET";
   if (method === "GET" || method === "HEAD") {
@@ -112,7 +104,7 @@ async function toStandardBody(req) {
   }
   if (!contentType || contentType.startsWith("application/json")) {
     const text = await _streamToString(req);
-    return parseEmptyableJSON2(text);
+    return parseEmptyableJSON(text);
   }
   if (contentType.startsWith("multipart/form-data")) {
     return _streamToFormData(req, contentType);
@@ -124,12 +116,12 @@ async function toStandardBody(req) {
   if (contentType.startsWith("text/event-stream")) {
     return toEventIterator(req);
   }
-  if (contentType.startsWith("text/")) {
+  if (contentType.startsWith("text/plain")) {
     return _streamToString(req);
   }
   return _streamToFile(req, "blob", contentType);
 }
-function toNodeHttpBody(body, headers) {
+function toNodeHttpBody(body, headers, options = {}) {
   delete headers["content-type"];
   delete headers["content-disposition"];
   if (body === void 0) {
@@ -142,12 +134,12 @@ function toNodeHttpBody(body, headers) {
       body instanceof File ? body.name : "blob",
       { type: "inline" }
     );
-    return Readable2.fromWeb(body.stream());
+    return Readable.fromWeb(body.stream());
   }
   if (body instanceof FormData) {
     const response = new Response(body);
     headers["content-type"] = response.headers.get("content-type");
-    return Readable2.fromWeb(response.body);
+    return Readable.fromWeb(response.body);
   }
   if (body instanceof URLSearchParams) {
     headers["content-type"] = "application/x-www-form-urlencoded";
@@ -157,10 +149,10 @@ function toNodeHttpBody(body, headers) {
     headers["content-type"] = "text/event-stream";
     headers["cache-control"] = "no-cache";
     headers.connection = "keep-alive";
-    return toEventStream(body);
+    return toEventStream(body, options);
   }
   headers["content-type"] = "application/json";
-  return JSON.stringify(body);
+  return stringifyJSON(body);
 }
 function _streamToFormData(stream, contentType) {
   const response = new Response(stream, {
@@ -185,10 +177,6 @@ async function _streamToFile(stream, fileName, contentType) {
   return new File(chunks, fileName, { type: contentType });
 }
 
-// src/request.ts
-import { once } from "@orpc/standard-server";
-
-// src/signal.ts
 function toAbortSignal(res) {
   const controller = new AbortController();
   res.on("close", () => {
@@ -203,7 +191,6 @@ function toAbortSignal(res) {
   return controller.signal;
 }
 
-// src/request.ts
 function toStandardRequest(req, res) {
   const method = req.method ?? "GET";
   const protocol = "encrypted" in req.socket && req.socket.encrypted ? "https:" : "http:";
@@ -219,13 +206,12 @@ function toStandardRequest(req, res) {
   };
 }
 
-// src/response.ts
-function sendStandardResponse(res, standardResponse) {
+function sendStandardResponse(res, standardResponse, options = {}) {
   return new Promise((resolve, reject) => {
     res.on("error", reject);
     res.on("finish", resolve);
     const resHeaders = standardResponse.headers;
-    const resBody = toNodeHttpBody(standardResponse.body, resHeaders);
+    const resBody = toNodeHttpBody(standardResponse.body, resHeaders, options);
     res.writeHead(standardResponse.status, resHeaders);
     if (resBody === void 0) {
       res.end(resBody);
@@ -241,13 +227,5 @@ function sendStandardResponse(res, standardResponse) {
     }
   });
 }
-export {
-  sendStandardResponse,
-  toAbortSignal,
-  toEventIterator,
-  toEventStream,
-  toNodeHttpBody,
-  toStandardBody,
-  toStandardRequest
-};
-//# sourceMappingURL=index.js.map
+
+export { sendStandardResponse, toAbortSignal, toEventIterator, toEventStream, toNodeHttpBody, toStandardBody, toStandardRequest };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/standard-server-node",
   "type": "module",
-  "version": "0.43.0",
+  "version": "0.44.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -14,21 +14,17 @@
   ],
   "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/standard-server": "0.43.0"
+    "@orpc/shared": "0.44.0",
+    "@orpc/standard-server": "0.44.0"
   },
   "devDependencies": {
     "@types/node": "^22.13.1",
@@ -36,7 +32,7 @@
     "supertest": "^7.0.0"
   },
   "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,10 +0,0 @@
-import type { StandardBody, StandardHeaders } from '@orpc/standard-server';
-import type { NodeHttpRequest } from './types';
-import { Readable } from 'node:stream';
-export declare function toStandardBody(req: NodeHttpRequest): Promise<StandardBody>;
-/**
- * @param body
- * @param headers - The headers can be changed by the function and effects on the original headers.
- */
-export declare function toNodeHttpBody(body: StandardBody, headers: StandardHeaders): Readable | undefined | string;
-//# sourceMappingURL=body.d.ts.map

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

@@ -1,5 +0,0 @@
-import type { JsonValue } from '@orpc/standard-server';
-import { Readable } from 'node:stream';
-export declare function toEventIterator(stream: Readable): AsyncGenerator<JsonValue | void, JsonValue | void, void>;
-export declare function toEventStream(iterator: AsyncIterator<JsonValue | void, JsonValue | void, void>): Readable;
-//# sourceMappingURL=event-source.d.ts.map

package/dist/src/index.d.ts

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

package/dist/src/request.d.ts

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

package/dist/src/response.d.ts

@@ -1,4 +0,0 @@
-import type { StandardResponse } from '@orpc/standard-server';
-import type { NodeHttpResponse } from './types';
-export declare function sendStandardResponse(res: NodeHttpResponse, standardResponse: StandardResponse): Promise<void>;
-//# sourceMappingURL=response.d.ts.map

package/dist/src/signal.d.ts

@@ -1,3 +0,0 @@
-import type { NodeHttpResponse } from './types';
-export declare function toAbortSignal(res: NodeHttpResponse): AbortSignal;
-//# sourceMappingURL=signal.d.ts.map

package/dist/src/types.d.ts

@@ -1,11 +0,0 @@
-import type { IncomingMessage, ServerResponse } from 'node:http';
-import type { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
-export type NodeHttpRequest = (IncomingMessage | Http2ServerRequest) & {
-    /**
-     * Replace `req.url` with `req.originalUrl` when `req.originalUrl` is available.
-     * This is useful for `express.js` middleware.
-     */
-    originalUrl?: string;
-};
-export type NodeHttpResponse = ServerResponse | Http2ServerResponse;
-//# sourceMappingURL=types.d.ts.map