@orpc/standard-server 0.0.0-next.b36125c → 0.0.0-next.bf49833

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>

package/dist/index.d.mts

@@ -0,0 +1,99 @@
+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 iterator 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 {
+    method: string;
+    url: URL;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed based on the content-type header.
+     */
+    body: StandardBody;
+    signal: AbortSignal | undefined;
+}
+interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    /**
+     * The body has been parsed based on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body: () => Promise<StandardBody>;
+}
+interface StandardResponse {
+    status: number;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed based on the content-type header.
+     */
+    body: StandardBody;
+}
+interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    /**
+     * The body has been parsed based on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body: () => Promise<StandardBody>;
+}
+
+export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardLazyRequest, type StandardLazyResponse, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };

package/dist/index.d.ts

@@ -0,0 +1,99 @@
+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 iterator 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 {
+    method: string;
+    url: URL;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed based on the content-type header.
+     */
+    body: StandardBody;
+    signal: AbortSignal | undefined;
+}
+interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    /**
+     * The body has been parsed based on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body: () => Promise<StandardBody>;
+}
+interface StandardResponse {
+    status: number;
+    headers: StandardHeaders;
+    /**
+     * The body has been parsed based on the content-type header.
+     */
+    body: StandardBody;
+}
+interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
+    /**
+     * Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
+     */
+    raw: Record<string, unknown>;
+    /**
+     * The body has been parsed based on the content-type header.
+     * This method can safely call multiple times (cached).
+     */
+    body: () => Promise<StandardBody>;
+}
+
+export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardLazyRequest, type StandardLazyResponse, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };

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

@@ -1,17 +1,18 @@
-// src/event-source/errors.ts
-var EventEncoderError = class extends TypeError {
-};
-var EventDecoderError = class extends TypeError {
-};
-var ErrorEvent = class extends Error {
+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;
   }
-};
+}
 
-// src/event-source/decoder.ts
 function decodeEventMessage(encoded) {
   const lines = encoded.replace(/\n+$/, "").split(/\n/);
   const message = {
@@ -45,7 +46,7 @@ function decodeEventMessage(encoded) {
   message.data = message.data?.replace(/\n$/, "");
   return message;
 }
-var EventDecoder = class {
+class EventDecoder {
   constructor(options = {}) {
     this.options = options;
   }
@@ -70,11 +71,11 @@ var EventDecoder = class {
   }
   end() {
     if (this.incomplete) {
-      throw new EventDecoderError("EventSource ended before complete");
+      throw new EventDecoderError("Event Iterator ended before complete");
     }
   }
-};
-var EventDecoderStream = class extends TransformStream {
+}
+class EventDecoderStream extends TransformStream {
   constructor() {
     let decoder;
     super({
@@ -93,22 +94,26 @@ var EventDecoderStream = class extends TransformStream {
       }
     });
   }
-};
+}
 
-// src/event-source/encoder.ts
 function assertEventId(id) {
   if (id.includes("\n")) {
-    throw new EventEncoderError("Event-source id must not contain a newline character");
+    throw new EventEncoderError("Event's 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");
+    throw new EventEncoderError("Event's 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");
+    throw new EventEncoderError("Event's retry must be a integer and >= 0");
+  }
+}
+function assertEventComment(comment) {
+  if (comment.includes("\n")) {
+    throw new EventEncoderError("Event's comment must not contain a newline character");
   }
 }
 function encodeEventData(data) {
@@ -120,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}
@@ -142,9 +157,7 @@ function encodeEventMessage(message) {
   return output;
 }
 
-// src/event-source/meta.ts
-import { isTypescriptObject } from "@orpc/shared";
-var EVENT_SOURCE_META_SYMBOL = Symbol("ORPC_EVENT_SOURCE_META");
+const EVENT_SOURCE_META_SYMBOL = Symbol("ORPC_EVENT_SOURCE_META");
 function withEventMeta(container, meta) {
   if (meta.id !== void 0) {
     assertEventId(meta.id);
@@ -152,6 +165,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) {
@@ -165,23 +183,4 @@ function getEventMeta(container) {
   return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
 }
 
-// src/utils.ts
-import { contentDisposition, parse } from "@tinyhttp/content-disposition";
-export {
-  ErrorEvent,
-  EventDecoder,
-  EventDecoderError,
-  EventDecoderStream,
-  EventEncoderError,
-  assertEventId,
-  assertEventName,
-  assertEventRetry,
-  contentDisposition,
-  decodeEventMessage,
-  encodeEventData,
-  encodeEventMessage,
-  getEventMeta,
-  parse as parseContentDisposition,
-  withEventMeta
-};
-//# sourceMappingURL=index.js.map
+export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/standard-server",
   "type": "module",
-  "version": "0.0.0-next.b36125c",
+  "version": "0.0.0-next.bf49833",
   "license": "MIT",
   "homepage": "https://unnoq.com",
   "repository": {
@@ -14,25 +14,20 @@
   ],
   "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": {
     "@tinyhttp/content-disposition": "^2.2.2",
-    "@orpc/shared": "0.0.0-next.b36125c"
+    "@orpc/shared": "0.0.0-next.bf49833"
   },
   "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/event-source/decoder.d.ts

@@ -1,16 +0,0 @@
-import type { EventMessage } from './types';
-export declare function decodeEventMessage(encoded: string): EventMessage;
-export interface EventDecoderOptions {
-    onEvent?: (event: EventMessage) => void;
-}
-export declare class EventDecoder {
-    private options;
-    private incomplete;
-    constructor(options?: EventDecoderOptions);
-    feed(chunk: string): void;
-    end(): void;
-}
-export declare class EventDecoderStream extends TransformStream<string, EventMessage> {
-    constructor();
-}
-//# sourceMappingURL=decoder.d.ts.map

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

@@ -1,7 +0,0 @@
-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 encodeEventData(data: string | undefined): string;
-export declare function encodeEventMessage(message: Partial<EventMessage>): string;
-//# sourceMappingURL=encoder.d.ts.map

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

@@ -1,13 +0,0 @@
-export declare class EventEncoderError extends TypeError {
-}
-export declare class EventDecoderError extends TypeError {
-}
-export interface ErrorEventOptions extends ErrorOptions {
-    message?: string;
-    data?: unknown;
-}
-export declare class ErrorEvent extends Error {
-    data: unknown;
-    constructor(options?: ErrorEventOptions);
-}
-//# sourceMappingURL=errors.d.ts.map

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

@@ -1,6 +0,0 @@
-export * from './decoder';
-export * from './encoder';
-export * from './errors';
-export * from './meta';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1,5 +0,0 @@
-import type { EventMessage } from './types';
-export type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id'>>;
-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,11 +0,0 @@
-export 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[];
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/src/index.d.ts

@@ -1,4 +0,0 @@
-export * from './event-source';
-export * from './types';
-export * from './utils';
-//# sourceMappingURL=index.d.ts.map

package/dist/src/types.d.ts

@@ -1,25 +0,0 @@
-export interface StandardHeaders {
-    [key: string]: string | string[] | undefined;
-}
-export type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
-export 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;
-}
-export interface StandardResponse {
-    status: number;
-    headers: StandardHeaders;
-    body: StandardBody;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/src/utils.d.ts

@@ -1,2 +0,0 @@
-export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
-//# sourceMappingURL=utils.d.ts.map