@standardserver/core 0.0.19 → 0.0.21

package/README.md

@@ -200,7 +200,7 @@ Use Event-Stream Helpers when you need explicit SSE encoding, decoding, or metad
 
 The event-stream entry point exposes:
 
-- `EventStreamMessageMeta` for `id`, `retry`, and `comments`
+- `EventMeta` for `id`, `retry`, and `comments`
 - `EventStreamMessage` for complete SSE messages
 - `encodeEventStreamMessage()` and `decodeEventStreamMessage()` for single-message codec operations
 - `EventStreamDecoder` and `EventStreamDecoderStream` for chunked stream decoding
@@ -241,29 +241,29 @@ const messages = response.body!
 
 ### Iterator metadata helpers
 
-`StandardBody` uses async iterators for event-stream bodies. To attach SSE metadata to a yielded value without changing its visible shape, use `withEventIteratorEventMeta()`.
+`StandardBody` uses async iterators for event-stream bodies. To attach SSE metadata to a yielded value without changing its visible shape, use `withEventMeta()`.
 
 ```ts
 import type { StandardResponse } from '@standardserver/core'
-import {
-  unwrapEventIteratorEvent,
-  withEventIteratorEventMeta,
-} from '@standardserver/core'
+import { getEventMeta, unwrapEvent, withEventMeta } from '@standardserver/core'
 
-const eventValue = withEventIteratorEventMeta(
+const event = withEventMeta(
   { message: 'hello' },
   { id: '1', retry: 3000, comments: ['bootstrap'] },
 )
 
-const [data, meta] = unwrapEventIteratorEvent(eventValue)
+const [data, meta] = unwrapEvent(event)
 // data => { message: 'hello' }
 // meta => { id: '1', retry: 3000, comments: ['bootstrap'] }
 
+const extractedMeta = getEventMeta(event)
+// { id: '1', retry: 3000, comments: ['bootstrap'] }
+
 const response: StandardResponse = {
   status: 200,
   headers: {},
   async* body() {
-    yield eventValue
+    yield event
   },
 }
 ```
@@ -277,13 +277,13 @@ The subpath also exports:
 
 - `EventStreamEncoderError` for invalid outbound SSE messages
 - `EventStreamDecoderError` for incomplete or invalid inbound stream decoding
-- `EventIteratorErrorEvent` for wrapping structured event-stream error payloads in an `Error`
+- `ErrorEvent` for wrapping structured event-stream error payloads in an `Error`
 - `assertEventStreamMessageId()`, `assertEventStreamMessageName()`, `assertEventStreamMessageRetry()`, and `assertEventStreamMessageComment()` for low-level validation when building custom SSE tooling
 
 ```ts
-import { EventIteratorErrorEvent } from '@standardserver/core'
+import { ErrorEvent } from '@standardserver/core'
 
-const error = new EventIteratorErrorEvent(
+const error = new ErrorEvent(
   { code: 'E_STREAM', detail: 'Connection lost' },
   { message: 'stream error' },
 )

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-interface EventStreamMessageMeta {
+interface EventMeta {
     /**
      * Event identifier, sent back by the client as `lastEventId` for reconnection attempts.
      *
@@ -16,7 +16,7 @@ interface EventStreamMessageMeta {
      */
     comments?: string[] | undefined;
 }
-interface EventStreamMessage extends EventStreamMessageMeta {
+interface EventStreamMessage extends EventMeta {
     /**
      * Event name (e.g., `message`, `error`).
      */
@@ -52,28 +52,26 @@ declare class EventStreamEncoderError extends TypeError {
 }
 declare class EventStreamDecoderError extends TypeError {
 }
-interface EventIteratorErrorEventOptions extends ErrorOptions {
+interface ErrorEventOptions extends ErrorOptions {
     message?: string;
 }
-declare class EventIteratorErrorEvent extends Error {
-    readonly data: unknown;
-    constructor(data: unknown, options?: EventIteratorErrorEventOptions);
+declare class ErrorEvent extends Error {
+    data: unknown;
+    constructor(data: unknown, options?: ErrorEventOptions);
 }
 
-declare const EVENT_ITERATOR_EVENT_META_SYMBOL: unique symbol;
-declare const EVENT_ITERATOR_EVENT_SOURCE_SYMBOL: unique symbol;
 /**
  * Returns a new iterator *event value* with attached, validated metadata.
  */
-declare function withEventIteratorEventMeta<T extends object>(container: T, meta: EventStreamMessageMeta): T;
+declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
 /**
  * Unwraps an iterator event value and extracts its associated metadata.
  */
-declare function unwrapEventIteratorEvent<T>(container: T): [data: T, meta: EventStreamMessageMeta | undefined];
+declare function unwrapEvent<T>(container: T): [data: T, meta: EventMeta | undefined];
 /**
  * Retrieves metadata attached to a single iterator event value.
  */
-declare function getEventIteratorEventMeta(container: unknown): EventStreamMessageMeta | undefined;
+declare function getEventMeta(container: unknown): EventMeta | undefined;
 
 type StandardMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD' | (string & {});
 type StandardUrl = `/${string}` | `/${string}?${string}` | `/${string}#${string}` | `/${string}?${string}#${string}`;
@@ -157,5 +155,5 @@ declare function isStandardHeaders(maybe: unknown): maybe is StandardHeaders;
 declare function isStandardRequest(maybe: unknown): maybe is StandardRequest;
 declare function isStandardResponse(maybe: unknown): maybe is StandardResponse;
 
-export { EVENT_ITERATOR_EVENT_META_SYMBOL, EVENT_ITERATOR_EVENT_SOURCE_SYMBOL, EventIteratorErrorEvent, EventStreamDecoder, EventStreamDecoderError, EventStreamDecoderStream, EventStreamEncoderError, assertEventStreamMessageComment, assertEventStreamMessageId, assertEventStreamMessageName, assertEventStreamMessageRetry, decodeEventStreamMessage, encodeEventStreamMessage, encodeEventStreamMessageComments, encodeEventStreamMessageData, flattenStandardHeader, generateContentDisposition, getEventIteratorEventMeta, getFilenameFromContentDisposition, isStandardHeaders, isStandardMethod, isStandardRequest, isStandardResponse, isStandardUrl, mergeStandardHeaders, parseStandardUrl, unwrapEventIteratorEvent, withEventIteratorEventMeta };
-export type { EventIteratorErrorEventOptions, EventStreamMessage, EventStreamMessageMeta, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl };
+export { ErrorEvent, EventStreamDecoder, EventStreamDecoderError, EventStreamDecoderStream, EventStreamEncoderError, assertEventStreamMessageComment, assertEventStreamMessageId, assertEventStreamMessageName, assertEventStreamMessageRetry, decodeEventStreamMessage, encodeEventStreamMessage, encodeEventStreamMessageComments, encodeEventStreamMessageData, flattenStandardHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isStandardHeaders, isStandardMethod, isStandardRequest, isStandardResponse, isStandardUrl, mergeStandardHeaders, parseStandardUrl, unwrapEvent, withEventMeta };
+export type { ErrorEventOptions, EventMeta, EventStreamMessage, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-interface EventStreamMessageMeta {
+interface EventMeta {
     /**
      * Event identifier, sent back by the client as `lastEventId` for reconnection attempts.
      *
@@ -16,7 +16,7 @@ interface EventStreamMessageMeta {
      */
     comments?: string[] | undefined;
 }
-interface EventStreamMessage extends EventStreamMessageMeta {
+interface EventStreamMessage extends EventMeta {
     /**
      * Event name (e.g., `message`, `error`).
      */
@@ -52,28 +52,26 @@ declare class EventStreamEncoderError extends TypeError {
 }
 declare class EventStreamDecoderError extends TypeError {
 }
-interface EventIteratorErrorEventOptions extends ErrorOptions {
+interface ErrorEventOptions extends ErrorOptions {
     message?: string;
 }
-declare class EventIteratorErrorEvent extends Error {
-    readonly data: unknown;
-    constructor(data: unknown, options?: EventIteratorErrorEventOptions);
+declare class ErrorEvent extends Error {
+    data: unknown;
+    constructor(data: unknown, options?: ErrorEventOptions);
 }
 
-declare const EVENT_ITERATOR_EVENT_META_SYMBOL: unique symbol;
-declare const EVENT_ITERATOR_EVENT_SOURCE_SYMBOL: unique symbol;
 /**
  * Returns a new iterator *event value* with attached, validated metadata.
  */
-declare function withEventIteratorEventMeta<T extends object>(container: T, meta: EventStreamMessageMeta): T;
+declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
 /**
  * Unwraps an iterator event value and extracts its associated metadata.
  */
-declare function unwrapEventIteratorEvent<T>(container: T): [data: T, meta: EventStreamMessageMeta | undefined];
+declare function unwrapEvent<T>(container: T): [data: T, meta: EventMeta | undefined];
 /**
  * Retrieves metadata attached to a single iterator event value.
  */
-declare function getEventIteratorEventMeta(container: unknown): EventStreamMessageMeta | undefined;
+declare function getEventMeta(container: unknown): EventMeta | undefined;
 
 type StandardMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD' | (string & {});
 type StandardUrl = `/${string}` | `/${string}?${string}` | `/${string}#${string}` | `/${string}?${string}#${string}`;
@@ -157,5 +155,5 @@ declare function isStandardHeaders(maybe: unknown): maybe is StandardHeaders;
 declare function isStandardRequest(maybe: unknown): maybe is StandardRequest;
 declare function isStandardResponse(maybe: unknown): maybe is StandardResponse;
 
-export { EVENT_ITERATOR_EVENT_META_SYMBOL, EVENT_ITERATOR_EVENT_SOURCE_SYMBOL, EventIteratorErrorEvent, EventStreamDecoder, EventStreamDecoderError, EventStreamDecoderStream, EventStreamEncoderError, assertEventStreamMessageComment, assertEventStreamMessageId, assertEventStreamMessageName, assertEventStreamMessageRetry, decodeEventStreamMessage, encodeEventStreamMessage, encodeEventStreamMessageComments, encodeEventStreamMessageData, flattenStandardHeader, generateContentDisposition, getEventIteratorEventMeta, getFilenameFromContentDisposition, isStandardHeaders, isStandardMethod, isStandardRequest, isStandardResponse, isStandardUrl, mergeStandardHeaders, parseStandardUrl, unwrapEventIteratorEvent, withEventIteratorEventMeta };
-export type { EventIteratorErrorEventOptions, EventStreamMessage, EventStreamMessageMeta, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl };
+export { ErrorEvent, EventStreamDecoder, EventStreamDecoderError, EventStreamDecoderStream, EventStreamEncoderError, assertEventStreamMessageComment, assertEventStreamMessageId, assertEventStreamMessageName, assertEventStreamMessageRetry, decodeEventStreamMessage, encodeEventStreamMessage, encodeEventStreamMessageComments, encodeEventStreamMessageData, flattenStandardHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isStandardHeaders, isStandardMethod, isStandardRequest, isStandardResponse, isStandardUrl, mergeStandardHeaders, parseStandardUrl, unwrapEvent, withEventMeta };
+export type { ErrorEventOptions, EventMeta, EventStreamMessage, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl };

package/dist/index.mjs

@@ -4,7 +4,7 @@ class EventStreamEncoderError extends TypeError {
 }
 class EventStreamDecoderError extends TypeError {
 }
-class EventIteratorErrorEvent extends Error {
+class ErrorEvent extends Error {
   constructor(data, options = {}) {
     super(options?.message ?? "Error Event", options);
     this.data = data;
@@ -155,9 +155,9 @@ function encodeEventStreamMessage(message) {
   return output;
 }
 
-const EVENT_ITERATOR_EVENT_META_SYMBOL = Symbol.for("STANDARDSERVER_EVENT_ITERATOR_EVENT_META");
-const EVENT_ITERATOR_EVENT_SOURCE_SYMBOL = Symbol.for("STANDARDSERVER_EVENT_ITERATOR_EVENT_SOURCE");
-function withEventIteratorEventMeta(container, meta) {
+const EVENT_META_SYMBOL = Symbol.for("STANDARDSERVER_EVENT_META");
+const EVENT_SOURCE_SYMBOL = Symbol.for("STANDARDSERVER_EVENT_SOURCE");
+function withEventMeta(container, meta) {
   let assertedMeta;
   if (meta.id !== void 0) {
     assertEventStreamMessageId(meta.id);
@@ -181,29 +181,29 @@ function withEventIteratorEventMeta(container, meta) {
   }
   return new Proxy(container, {
     get(target, prop, _receiver) {
-      if (prop === EVENT_ITERATOR_EVENT_SOURCE_SYMBOL) {
+      if (prop === EVENT_SOURCE_SYMBOL) {
         return target;
       }
-      if (prop === EVENT_ITERATOR_EVENT_META_SYMBOL) {
+      if (prop === EVENT_META_SYMBOL) {
         return assertedMeta;
       }
       return getOrBind(target, prop);
     }
   });
 }
-function unwrapEventIteratorEvent(container) {
+function unwrapEvent(container) {
   if (!isTypescriptObject(container)) {
     return [container, void 0];
   }
-  const meta = container[EVENT_ITERATOR_EVENT_META_SYMBOL];
-  const target = container[EVENT_ITERATOR_EVENT_SOURCE_SYMBOL] ?? container;
+  const meta = container[EVENT_META_SYMBOL];
+  const target = container[EVENT_SOURCE_SYMBOL] ?? container;
   return [target, meta];
 }
-function getEventIteratorEventMeta(container) {
+function getEventMeta(container) {
   if (!isTypescriptObject(container)) {
     return void 0;
   }
-  return container[EVENT_ITERATOR_EVENT_META_SYMBOL];
+  return container[EVENT_META_SYMBOL];
 }
 
 function generateContentDisposition(filename) {
@@ -292,4 +292,4 @@ function isStandardResponse(maybe) {
   return isStandardHeaders(maybe.headers);
 }
 
-export { EVENT_ITERATOR_EVENT_META_SYMBOL, EVENT_ITERATOR_EVENT_SOURCE_SYMBOL, EventIteratorErrorEvent, EventStreamDecoder, EventStreamDecoderError, EventStreamDecoderStream, EventStreamEncoderError, assertEventStreamMessageComment, assertEventStreamMessageId, assertEventStreamMessageName, assertEventStreamMessageRetry, decodeEventStreamMessage, encodeEventStreamMessage, encodeEventStreamMessageComments, encodeEventStreamMessageData, flattenStandardHeader, generateContentDisposition, getEventIteratorEventMeta, getFilenameFromContentDisposition, isStandardHeaders, isStandardMethod, isStandardRequest, isStandardResponse, isStandardUrl, mergeStandardHeaders, parseStandardUrl, unwrapEventIteratorEvent, withEventIteratorEventMeta };
+export { ErrorEvent, EventStreamDecoder, EventStreamDecoderError, EventStreamDecoderStream, EventStreamEncoderError, assertEventStreamMessageComment, assertEventStreamMessageId, assertEventStreamMessageName, assertEventStreamMessageRetry, decodeEventStreamMessage, encodeEventStreamMessage, encodeEventStreamMessageComments, encodeEventStreamMessageData, flattenStandardHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isStandardHeaders, isStandardMethod, isStandardRequest, isStandardResponse, isStandardUrl, mergeStandardHeaders, parseStandardUrl, unwrapEvent, withEventMeta };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@standardserver/core",
   "type": "module",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "license": "MIT",
   "homepage": "https://standardserver.dev",
   "repository": {
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "@standardserver/shared": "0.0.19"
+    "@standardserver/shared": "0.0.21"
   },
   "scripts": {
     "build": "unbuild",