@orpc/standard-server 0.0.0-next.cc4cb21 → 0.0.0-next.d0e429d

package/README.md

@@ -0,0 +1,68 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</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">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fstandard-server?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`
+
+This package is designed to be used as a base for other server implementations.
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.js

@@ -10,29 +10,25 @@ var ErrorEvent = class extends Error {
     this.data = options?.data;
   }
 };
-var UnknownEvent = class extends ErrorEvent {
-};
 
 // src/event-source/decoder.ts
 function decodeEventMessage(encoded) {
   const lines = encoded.replace(/\n+$/, "").split(/\n/);
   const message = {
-    data: "",
+    data: void 0,
     event: void 0,
     id: void 0,
-    retry: void 0
+    retry: void 0,
+    comments: []
   };
   for (const line of lines) {
-    const index = line.indexOf(": ");
-    if (index === -1) {
-      throw new EventDecoderError(`Invalid EventSource message line: ${line}`);
-    }
-    const key = line.slice(0, index);
-    const value = line.slice(index + 2);
-    if (key !== "data" && key in message && message[key] !== void 0) {
-      throw new EventDecoderError(`Duplicate EventSource message key: ${key}`);
-    }
-    if (key === "data") {
+    const index = line.indexOf(":");
+    const key = index === -1 ? line : line.slice(0, index);
+    const value = index === -1 ? "" : line.slice(index + 1).replace(/^\s/, "");
+    if (index === 0) {
+      message.comments.push(value);
+    } else if (key === "data") {
+      message.data ??= "";
       message.data += `${value}
 `;
     } else if (key === "event") {
@@ -41,15 +37,12 @@ function decodeEventMessage(encoded) {
       message.id = value;
     } else if (key === "retry") {
       const maybeInteger = Number.parseInt(value);
-      if (!Number.isInteger(maybeInteger) || maybeInteger < 0 || maybeInteger.toString() !== value) {
-        throw new EventDecoderError(`Invalid EventSource message retry value: ${value}`);
+      if (Number.isInteger(maybeInteger) && maybeInteger >= 0 && maybeInteger.toString() === value) {
+        message.retry = maybeInteger;
       }
-      message.retry = maybeInteger;
-    } else {
-      throw new EventDecoderError(`Unknown EventSource message key: ${key}`);
     }
   }
-  message.data = message.data.replace(/\n$/, "");
+  message.data = message.data?.replace(/\n$/, "");
   return message;
 }
 var EventDecoder = class {
@@ -63,12 +56,9 @@ var EventDecoder = class {
     if (lastCompleteIndex === -1) {
       return;
     }
-    const completes = this.incomplete.slice(0, lastCompleteIndex + 2).split(/\n{2,}/);
+    const completes = this.incomplete.slice(0, lastCompleteIndex).split(/\n\n/);
     this.incomplete = this.incomplete.slice(lastCompleteIndex + 2);
     for (const encoded of completes) {
-      if (!encoded) {
-        continue;
-      }
       const message = decodeEventMessage(`${encoded}
 
 `);
@@ -79,7 +69,9 @@ var EventDecoder = class {
     this.incomplete = "";
   }
   end() {
-    this.feed("\n\n");
+    if (this.incomplete) {
+      throw new EventDecoderError("EventSource ended before complete");
+    }
   }
 };
 var EventDecoderStream = class extends TransformStream {
@@ -119,8 +111,13 @@ function assertEventRetry(retry) {
     throw new EventEncoderError("Event-source retry must be a integer and >= 0");
   }
 }
+function assertEventComment(comment) {
+  if (comment.includes("\n")) {
+    throw new EventEncoderError("Event-source comment must not contain a newline character");
+  }
+}
 function encodeEventData(data) {
-  const lines = data ? data.split(/\n/) : [""];
+  const lines = data?.split(/\n/) ?? [];
   let output = "";
   for (const line of lines) {
     output += `data: ${line}
@@ -128,8 +125,18 @@ function encodeEventData(data) {
   }
   return output;
 }
+function encodeEventComments(comments) {
+  let output = "";
+  for (const comment of comments ?? []) {
+    assertEventComment(comment);
+    output += `: ${comment}
+`;
+  }
+  return output;
+}
 function encodeEventMessage(message) {
   let output = "";
+  output += encodeEventComments(message.comments);
   if (message.event !== void 0) {
     assertEventName(message.event);
     output += `event: ${message.event}
@@ -160,6 +167,11 @@ function withEventMeta(container, meta) {
   if (meta.retry !== void 0) {
     assertEventRetry(meta.retry);
   }
+  if (meta.comments !== void 0) {
+    for (const comment of meta.comments) {
+      assertEventComment(comment);
+    }
+  }
   return new Proxy(container, {
     get(target, prop, receiver) {
       if (prop === EVENT_SOURCE_META_SYMBOL) {
@@ -181,12 +193,13 @@ export {
   EventDecoderError,
   EventDecoderStream,
   EventEncoderError,
-  UnknownEvent,
+  assertEventComment,
   assertEventId,
   assertEventName,
   assertEventRetry,
   contentDisposition,
   decodeEventMessage,
+  encodeEventComments,
   encodeEventData,
   encodeEventMessage,
   getEventMeta,

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

@@ -2,6 +2,8 @@ import type { EventMessage } from './types';
 export declare function assertEventId(id: string): void;
 export declare function assertEventName(event: string): void;
 export declare function assertEventRetry(retry: number): void;
+export declare function assertEventComment(comment: string): void;
 export declare function encodeEventData(data: string | undefined): string;
+export declare function encodeEventComments(comments: string[] | undefined): string;
 export declare function encodeEventMessage(message: Partial<EventMessage>): string;
 //# sourceMappingURL=encoder.d.ts.map

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

@@ -10,6 +10,4 @@ export declare class ErrorEvent extends Error {
     data: unknown;
     constructor(options?: ErrorEventOptions);
 }
-export declare class UnknownEvent extends ErrorEvent {
-}
 //# sourceMappingURL=errors.d.ts.map

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

@@ -1,5 +1,5 @@
 import type { EventMessage } from './types';
-export type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id'>>;
+export type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
 export declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
 export declare function getEventMeta(container: unknown): EventMeta | undefined;
 //# sourceMappingURL=meta.d.ts.map

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

@@ -1,10 +1,11 @@
 export interface EventMessage {
     event: string | undefined;
     id: string | undefined;
-    data: string;
+    data: string | undefined;
     /**
      * The number of milliseconds to wait before retrying the event source if error occurs.
      */
     retry: number | undefined;
+    comments: string[];
 }
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/standard-server",
   "type": "module",
-  "version": "0.0.0-next.cc4cb21",
+  "version": "0.0.0-next.d0e429d",
   "license": "MIT",
   "homepage": "https://unnoq.com",
   "repository": {
@@ -29,7 +29,7 @@
   ],
   "dependencies": {
     "@tinyhttp/content-disposition": "^2.2.2",
-    "@orpc/shared": "0.0.0-next.cc4cb21"
+    "@orpc/shared": "0.0.0-next.d0e429d"
   },
   "scripts": {
     "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",