@orpc/standard-server 0.0.0-next.05ebcce

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 oRPC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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">
+    <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.d.mts

@@ -0,0 +1,79 @@
+export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
+
+interface EventMessage {
+    event: string | undefined;
+    id: string | undefined;
+    data: string | undefined;
+    /**
+     * The number of milliseconds to wait before retrying the event source if error occurs.
+     */
+    retry: number | undefined;
+    comments: string[];
+}
+
+declare function decodeEventMessage(encoded: string): EventMessage;
+interface EventDecoderOptions {
+    onEvent?: (event: EventMessage) => void;
+}
+declare class EventDecoder {
+    private options;
+    private incomplete;
+    constructor(options?: EventDecoderOptions);
+    feed(chunk: string): void;
+    end(): void;
+}
+declare class EventDecoderStream extends TransformStream<string, EventMessage> {
+    constructor();
+}
+
+declare function assertEventId(id: string): void;
+declare function assertEventName(event: string): void;
+declare function assertEventRetry(retry: number): void;
+declare function assertEventComment(comment: string): void;
+declare function encodeEventData(data: string | undefined): string;
+declare function encodeEventComments(comments: string[] | undefined): string;
+declare function encodeEventMessage(message: Partial<EventMessage>): string;
+
+declare class EventEncoderError extends TypeError {
+}
+declare class EventDecoderError extends TypeError {
+}
+interface ErrorEventOptions extends ErrorOptions {
+    message?: string;
+    data?: unknown;
+}
+declare class ErrorEvent extends Error {
+    data: unknown;
+    constructor(options?: ErrorEventOptions);
+}
+
+type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
+declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
+declare function getEventMeta(container: unknown): EventMeta | undefined;
+
+interface StandardHeaders {
+    [key: string]: string | string[] | undefined;
+}
+type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
+interface StandardRequest {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    method: string;
+    url: URL;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed base on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body: () => Promise<StandardBody>;
+    signal: AbortSignal | undefined;
+}
+interface StandardResponse {
+    status: number;
+    headers: StandardHeaders;
+    body: StandardBody;
+}
+
+export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
+
+interface EventMessage {
+    event: string | undefined;
+    id: string | undefined;
+    data: string | undefined;
+    /**
+     * The number of milliseconds to wait before retrying the event source if error occurs.
+     */
+    retry: number | undefined;
+    comments: string[];
+}
+
+declare function decodeEventMessage(encoded: string): EventMessage;
+interface EventDecoderOptions {
+    onEvent?: (event: EventMessage) => void;
+}
+declare class EventDecoder {
+    private options;
+    private incomplete;
+    constructor(options?: EventDecoderOptions);
+    feed(chunk: string): void;
+    end(): void;
+}
+declare class EventDecoderStream extends TransformStream<string, EventMessage> {
+    constructor();
+}
+
+declare function assertEventId(id: string): void;
+declare function assertEventName(event: string): void;
+declare function assertEventRetry(retry: number): void;
+declare function assertEventComment(comment: string): void;
+declare function encodeEventData(data: string | undefined): string;
+declare function encodeEventComments(comments: string[] | undefined): string;
+declare function encodeEventMessage(message: Partial<EventMessage>): string;
+
+declare class EventEncoderError extends TypeError {
+}
+declare class EventDecoderError extends TypeError {
+}
+interface ErrorEventOptions extends ErrorOptions {
+    message?: string;
+    data?: unknown;
+}
+declare class ErrorEvent extends Error {
+    data: unknown;
+    constructor(options?: ErrorEventOptions);
+}
+
+type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
+declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
+declare function getEventMeta(container: unknown): EventMeta | undefined;
+
+interface StandardHeaders {
+    [key: string]: string | string[] | undefined;
+}
+type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
+interface StandardRequest {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    method: string;
+    url: URL;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed base on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body: () => Promise<StandardBody>;
+    signal: AbortSignal | undefined;
+}
+interface StandardResponse {
+    status: number;
+    headers: StandardHeaders;
+    body: StandardBody;
+}
+
+export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };

package/dist/index.mjs

@@ -0,0 +1,186 @@
+import { isTypescriptObject } from '@orpc/shared';
+export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
+
+class EventEncoderError extends TypeError {
+}
+class EventDecoderError extends TypeError {
+}
+class ErrorEvent extends Error {
+  data;
+  constructor(options) {
+    super(options?.message ?? "An error event was received", options);
+    this.data = options?.data;
+  }
+}
+
+function decodeEventMessage(encoded) {
+  const lines = encoded.replace(/\n+$/, "").split(/\n/);
+  const message = {
+    data: void 0,
+    event: void 0,
+    id: void 0,
+    retry: void 0,
+    comments: []
+  };
+  for (const line of lines) {
+    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") {
+      message.event = value;
+    } else if (key === "id") {
+      message.id = value;
+    } else if (key === "retry") {
+      const maybeInteger = Number.parseInt(value);
+      if (Number.isInteger(maybeInteger) && maybeInteger >= 0 && maybeInteger.toString() === value) {
+        message.retry = maybeInteger;
+      }
+    }
+  }
+  message.data = message.data?.replace(/\n$/, "");
+  return message;
+}
+class EventDecoder {
+  constructor(options = {}) {
+    this.options = options;
+  }
+  incomplete = "";
+  feed(chunk) {
+    this.incomplete += chunk;
+    const lastCompleteIndex = this.incomplete.lastIndexOf("\n\n");
+    if (lastCompleteIndex === -1) {
+      return;
+    }
+    const completes = this.incomplete.slice(0, lastCompleteIndex).split(/\n\n/);
+    this.incomplete = this.incomplete.slice(lastCompleteIndex + 2);
+    for (const encoded of completes) {
+      const message = decodeEventMessage(`${encoded}
+
+`);
+      if (this.options.onEvent) {
+        this.options.onEvent(message);
+      }
+    }
+    this.incomplete = "";
+  }
+  end() {
+    if (this.incomplete) {
+      throw new EventDecoderError("EventSource ended before complete");
+    }
+  }
+}
+class EventDecoderStream extends TransformStream {
+  constructor() {
+    let decoder;
+    super({
+      start(controller) {
+        decoder = new EventDecoder({
+          onEvent: (event) => {
+            controller.enqueue(event);
+          }
+        });
+      },
+      transform(chunk) {
+        decoder.feed(chunk);
+      },
+      flush() {
+        decoder.end();
+      }
+    });
+  }
+}
+
+function assertEventId(id) {
+  if (id.includes("\n")) {
+    throw new EventEncoderError("Event-source id must not contain a newline character");
+  }
+}
+function assertEventName(event) {
+  if (event.includes("\n")) {
+    throw new EventEncoderError("Event-source event must not contain a newline character");
+  }
+}
+function assertEventRetry(retry) {
+  if (!Number.isInteger(retry) || retry < 0) {
+    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?.split(/\n/) ?? [];
+  let output = "";
+  for (const line of lines) {
+    output += `data: ${line}
+`;
+  }
+  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}
+`;
+  }
+  if (message.retry !== void 0) {
+    assertEventRetry(message.retry);
+    output += `retry: ${message.retry}
+`;
+  }
+  if (message.id !== void 0) {
+    assertEventId(message.id);
+    output += `id: ${message.id}
+`;
+  }
+  output += encodeEventData(message.data);
+  output += "\n";
+  return output;
+}
+
+const EVENT_SOURCE_META_SYMBOL = Symbol("ORPC_EVENT_SOURCE_META");
+function withEventMeta(container, meta) {
+  if (meta.id !== void 0) {
+    assertEventId(meta.id);
+  }
+  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) {
+        return meta;
+      }
+      return Reflect.get(target, prop, receiver);
+    }
+  });
+}
+function getEventMeta(container) {
+  return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
+}
+
+export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@orpc/standard-server",
+  "type": "module",
+  "version": "0.0.0-next.05ebcce",
+  "license": "MIT",
+  "homepage": "https://unnoq.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unnoq/orpc.git",
+    "directory": "packages/standard-server"
+  },
+  "keywords": [
+    "orpc"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tinyhttp/content-disposition": "^2.2.2",
+    "@orpc/shared": "0.0.0-next.05ebcce"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "build:watch": "pnpm run build --watch",
+    "type:check": "tsc -b"
+  }
+}