@muspellheim/shared 0.17.0 → 0.18.1

package/src/infrastructure/fetch_stub.ts

@@ -1,89 +0,0 @@
-// Copyright (c) 2025 Falko Schumann. All rights reserved. MIT license.
-
-import { ConfigurableResponses } from "./configurable_responses";
-
-/**
- * This data object configures the response of a fetch stub call.
- */
-export interface ResponseData {
-  /** The HTTP status code. */
-  status: number;
-
-  /** The HTTP status text. */
-  statusText: string;
-
-  /** The optional response body. */
-  body?: Blob | object | string | null;
-}
-
-/**
- * Create a fetch stub.
- *
- * The stub returns a response from the provided response data or throws an provided error.
- *
- * @param responses A single response or an array of responses.
- * @returns The fetch stub.
- */
-export function createFetchStub(
-  responses?: ResponseData | Error | (ResponseData | Error)[],
-): () => Promise<Response> {
-  const configurableResponses = ConfigurableResponses.create(responses);
-  return async function () {
-    const response = configurableResponses.next();
-    if (response instanceof Error) {
-      throw response;
-    }
-
-    return new ResponseStub(response) as unknown as Response;
-  };
-}
-
-class ResponseStub {
-  #status: number;
-  #statusText: string;
-  #body?: Blob | object | string | null;
-
-  constructor({ status, statusText, body = null }: ResponseData) {
-    this.#status = status;
-    this.#statusText = statusText;
-    this.#body = body;
-  }
-
-  get ok() {
-    return this.status >= 200 && this.status < 300;
-  }
-
-  get status() {
-    return this.#status;
-  }
-
-  get statusText() {
-    return this.#statusText;
-  }
-
-  async blob() {
-    if (this.#body == null) {
-      return null;
-    }
-
-    if (this.#body instanceof Blob) {
-      return this.#body;
-    }
-
-    throw new TypeError("Body is not a Blob.");
-  }
-
-  async json() {
-    const json =
-      typeof this.#body === "string" ? this.#body : JSON.stringify(this.#body);
-    return Promise.resolve(JSON.parse(json));
-  }
-
-  async text() {
-    if (this.#body == null) {
-      return "";
-    }
-
-    return String(this.#body);
-  }
-}

package/src/infrastructure/message_client.ts

@@ -1,50 +0,0 @@
-// Copyright (c) 2025 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * An interface for a streaming message client.
- *
- * Emits the following events:
- *
- * - open, {@link Event}
- * - message, {@link MessageEvent}
- * - error, {@link Event}
- * - close, optional {@link CloseEvent}
- *
- * It is used for wrappers around {@link EventSource} and {@link WebSocket}.
- *
- * @see {@link SseClient}
- * @see {@link WebSocketClient}
- */
-export interface MessageClient extends EventTarget {
-  /**
-   * Return whether the client is connected.
-   */
-  get isConnected(): boolean;
-
-  /**
-   * Return the server URL.
-   */
-  get url(): string | undefined;
-
-  /**
-   * Connect to the server.
-   *
-   * @param url The server URL to connect to.
-   */
-  connect(url: string | URL): Promise<void>;
-
-  /**
-   * Send a message to the server.
-   *
-   * This is an optional method for streams with bidirectional communication.
-   *
-   * @param message The message to send.
-   * @param type The optional message type.
-   */
-  send(message: string, type?: string): Promise<void>;
-
-  /**
-   * Close the connection.
-   */
-  close(): Promise<void>;
-}

package/src/infrastructure/output_tracker.ts

@@ -1,89 +0,0 @@
-// Copyright (c) 2025 Falko Schumann. All rights reserved. MIT license.
-// Copyright 2020-2022 Titanium I.T. LLC. MIT License.
-
-/**
- * Track output events.
- *
- * This is one of the nullability patterns from James Shore's article on
- * [testing without mocks](https://www.jamesshore.com/v2/projects/nullables/testing-without-mocks#output-tracking).
- *
- * Example implementation of an event store:
- *
- * ```javascript
- * async record(event) {
- *   // ...
- *   this.dispatchEvent(new CustomEvent("eventRecorded", { detail: event }));
- * }
- *
- * trackEventsRecorded() {
- *   return new OutputTracker(this, "eventRecorded");
- * }
- * ```
- *
- * Example usage:
- *
- * ```javascript
- * const eventsRecorded = eventStore.trackEventsRecorded();
- * // ...
- * const data = eventsRecorded.data(); // [event1, event2, ...]
- * ```
- */
-export class OutputTracker<T = unknown> {
-  /**
-   * Create a tracker for a specific event of an event target.
-   *
-   * @param eventTarget The target to track.
-   * @param event The event name to track.
-   */
-  static create<T>(eventTarget: EventTarget, event: string) {
-    return new OutputTracker<T>(eventTarget, event);
-  }
-
-  readonly #eventTarget;
-  readonly #event;
-  readonly #data: T[];
-  readonly #tracker;
-
-  /**
-   * Create a tracker for a specific event of an event target.
-   *
-   * @param eventTarget The target to track.
-   * @param event The event name to track.
-   */
-  constructor(eventTarget: EventTarget, event: string) {
-    this.#eventTarget = eventTarget;
-    this.#event = event;
-    this.#data = [];
-    this.#tracker = (event: Event) =>
-      this.#data.push((event as CustomEvent<T>).detail);
-
-    this.#eventTarget.addEventListener(this.#event, this.#tracker);
-  }
-
-  /**
-   * Return the tracked data.
-   *
-   * @return The tracked data.
-   */
-  get data(): T[] {
-    return this.#data;
-  }
-
-  /**
-   * Clear the tracked data and return the cleared data.
-   *
-   * @return The cleared data.
-   */
-  clear(): T[] {
-    const result = [...this.#data];
-    this.#data.length = 0;
-    return result;
-  }
-
-  /**
-   * Stop tracking.
-   */
-  stop() {
-    this.#eventTarget.removeEventListener(this.#event, this.#tracker);
-  }
-}

package/src/infrastructure/sse_client.ts

@@ -1,162 +0,0 @@
-// Copyright (c) 2025 Falko Schumann. All rights reserved. MIT license.
-
-import type { MessageClient } from "./message_client";
-
-/**
- * A client for the server-sent events protocol.
- */
-export class SseClient extends EventTarget implements MessageClient {
-  /**
-   * Create an SSE client.
-   *
-   * @return A new SSE client.
-   */
-  static create(): SseClient {
-    return new SseClient(EventSource);
-  }
-
-  /**
-   * Create a nulled SSE client.
-   *
-   * @return A new SSE client.
-   */
-  static createNull(): SseClient {
-    return new SseClient(EventSourceStub as typeof EventSource);
-  }
-
-  readonly #eventSourceConstructor: typeof EventSource;
-
-  #eventSource?: EventSource;
-
-  private constructor(eventSourceConstructor: typeof EventSource) {
-    super();
-    this.#eventSourceConstructor = eventSourceConstructor;
-  }
-
-  get isConnected(): boolean {
-    return this.#eventSource?.readyState === this.#eventSourceConstructor.OPEN;
-  }
-
-  get url(): string | undefined {
-    return this.#eventSource?.url;
-  }
-
-  async connect(
-    url: string | URL,
-    eventName = "message",
-    ...otherEvents: string[]
-  ): Promise<void> {
-    await new Promise<void>((resolve, reject) => {
-      if (this.isConnected) {
-        reject(new Error("Already connected."));
-        return;
-      }
-
-      try {
-        this.#eventSource = new this.#eventSourceConstructor(url);
-        this.#eventSource.addEventListener("open", (e) => {
-          this.#handleOpen(e);
-          resolve();
-        });
-        this.#eventSource.addEventListener(eventName, (e) =>
-          this.#handleMessage(e),
-        );
-        for (const otherEvent of otherEvents) {
-          this.#eventSource.addEventListener(otherEvent, (e) =>
-            this.#handleMessage(e),
-          );
-        }
-        this.#eventSource.addEventListener("error", (e) =>
-          this.#handleError(e),
-        );
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-
-  send(_message: string, _type?: string): Promise<void> {
-    throw new Error("Method not implemented.");
-  }
-
-  async close(): Promise<void> {
-    await new Promise<void>((resolve, reject) => {
-      if (!this.isConnected) {
-        resolve();
-        return;
-      }
-
-      try {
-        this.#eventSource!.close();
-        resolve();
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-
-  /**
-   * Simulate a message event from the server.
-   *
-   * @param message The message to receive.
-   * @param eventName The optional event type.
-   * @param lastEventId The optional last event ID.
-   */
-  simulateMessage(
-    message: string | number | boolean | object | null,
-    eventName = "message",
-    lastEventId?: string,
-  ) {
-    if (typeof message !== "string") {
-      message = JSON.stringify(message);
-    }
-    this.#handleMessage(
-      new MessageEvent(eventName, { data: message, lastEventId }),
-    );
-  }
-
-  /**
-   * Simulate an error event.
-   */
-  simulateError() {
-    this.#handleError(new Event("error"));
-  }
-
-  #handleOpen(event: Event) {
-    this.dispatchEvent(new Event(event.type, event));
-  }
-
-  #handleMessage(event: MessageEvent) {
-    this.dispatchEvent(
-      new MessageEvent(event.type, event as unknown as MessageEventInit),
-    );
-  }
-
-  #handleError(event: Event) {
-    this.dispatchEvent(new Event(event.type, event));
-  }
-}
-
-class EventSourceStub extends EventTarget {
-  // The constants have to be defined here because Node.js support is currently
-  // experimental only.
-  static CONNECTING = 0;
-  static OPEN = 1;
-  static CLOSED = 2;
-
-  url: string;
-  readyState = EventSourceStub.CONNECTING;
-
-  constructor(url: string | URL) {
-    super();
-    this.url = url.toString();
-    setTimeout(() => {
-      this.readyState = EventSourceStub.OPEN;
-      this.dispatchEvent(new Event("open"));
-    }, 0);
-  }
-
-  close() {
-    this.readyState = EventSourceStub.CLOSED;
-  }
-}

package/src/infrastructure/web_socket_client.ts

@@ -1,279 +0,0 @@
-// Copyright (c) 2025 Falko Schumann. All rights reserved. MIT license.
-
-import { OutputTracker } from "./output_tracker";
-import type { MessageClient } from "./message_client";
-
-export const HEARTBEAT_TYPE = "heartbeat";
-
-const MESSAGE_SENT_EVENT = "message-sent";
-
-/**
- * Options for the WebSocket client.
- */
-export interface WebSocketOptions {
-  /**
-   * The heartbeat interval in milliseconds. A value <= 0 disables the
-   * heartbeat.
-   */
-  heartbeat?: number;
-
-  /**
-   * The time in milliseconds to wait before retrying a connection after an
-   * error. A value <= 0 disables automatic retries.
-   */
-  retry?: number;
-}
-
-/**
- * A client for the WebSocket protocol.
- */
-export class WebSocketClient extends EventTarget implements MessageClient {
-  /**
-   * Create a WebSocket client.
-   *
-   * @param options The options for the WebSocket client.
-   * @return A new WebSocket client.
-   */
-  static create({
-    heartbeat = 30000,
-    retry = 1000,
-  }: WebSocketOptions = {}): WebSocketClient {
-    return new WebSocketClient(heartbeat, retry, WebSocket);
-  }
-
-  /**
-   * Create a nulled WebSocket client.
-   *
-   * @param options The options for the WebSocket client.
-   * @return A new nulled WebSocket client.
-   */
-  static createNull({ heartbeat = 0, retry = 0 }: WebSocketOptions = {}) {
-    return new WebSocketClient(
-      heartbeat,
-      retry,
-      WebSocketStub as unknown as typeof WebSocket,
-    );
-  }
-
-  readonly #heartbeat: number;
-  readonly #retry: number;
-  readonly #webSocketConstructor: typeof WebSocket;
-
-  #webSocket?: WebSocket;
-  #heartbeatId?: ReturnType<typeof setTimeout>;
-  #retryId?: ReturnType<typeof setTimeout>;
-
-  private constructor(
-    heartbeat: number,
-    retry: number,
-    webSocketConstructor: typeof WebSocket,
-  ) {
-    super();
-    this.#heartbeat = heartbeat;
-    this.#retry = retry;
-    this.#webSocketConstructor = webSocketConstructor;
-  }
-
-  get isConnected(): boolean {
-    return this.#webSocket?.readyState === WebSocket.OPEN;
-  }
-
-  get url(): string | undefined {
-    return this.#webSocket?.url;
-  }
-
-  async connect(url: string | URL): Promise<void> {
-    await new Promise<void>((resolve, reject) => {
-      this.#stopRetry();
-
-      if (this.isConnected) {
-        reject(new Error("Already connected."));
-        return;
-      }
-
-      try {
-        this.#webSocket = new this.#webSocketConstructor(url);
-        this.#webSocket.addEventListener("open", (e) => {
-          this.#handleOpen(e);
-          resolve();
-        });
-        this.#webSocket.addEventListener("message", (e) =>
-          this.#handleMessage(e),
-        );
-        this.#webSocket.addEventListener("close", (e) => this.#handleClose(e));
-        this.#webSocket.addEventListener("error", (e) => this.#handleError(e));
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-
-  async send(
-    message: string | ArrayBuffer | Blob | ArrayBufferView,
-  ): Promise<void> {
-    if (!this.isConnected) {
-      throw new Error("Not connected.");
-    }
-
-    this.#webSocket!.send(message);
-    this.dispatchEvent(
-      new CustomEvent(MESSAGE_SENT_EVENT, { detail: message }),
-    );
-    await Promise.resolve();
-  }
-
-  /**
-   * Return a tracker for messages sent.
-   *
-   * @return A new output tracker.
-   */
-  trackMessageSent(): OutputTracker<string> {
-    return OutputTracker.create(this, MESSAGE_SENT_EVENT);
-  }
-
-  /**
-   * Close the connection.
-   *
-   * If a code is provided, also a reason should be provided.
-   *
-   * @param code An optional code.
-   * @param reason An optional reason.
-   */
-  async close(code?: number, reason?: string): Promise<void> {
-    await new Promise<void>((resolve) => {
-      this.#stopRetry();
-
-      if (!this.isConnected) {
-        resolve();
-        return;
-      }
-
-      this.#webSocket!.addEventListener("close", () => resolve());
-      this.#webSocket!.close(code, reason);
-    });
-  }
-
-  /**
-   * Simulate a message event from the server.
-   *
-   * @param message The message to receive.
-   */
-  simulateMessage(
-    message: string | number | boolean | object | null | Blob | ArrayBuffer,
-  ) {
-    if (
-      typeof message !== "string" &&
-      !(message instanceof Blob) &&
-      !(message instanceof ArrayBuffer)
-    ) {
-      message = JSON.stringify(message);
-    }
-    this.#handleMessage(new MessageEvent("message", { data: message }));
-  }
-
-  /**
-   * Simulate a heartbeat.
-   */
-  simulateHeartbeat() {
-    this.#sendHeartbeat();
-  }
-
-  /**
-   * Simulate a close event.
-   *
-   * @param code An optional code.
-   * @param reason An optional reason.
-   */
-  simulateClose(code?: number, reason?: string) {
-    this.#handleClose(new CloseEvent("close", { code, reason }));
-  }
-
-  /**
-   * Simulate an error event.
-   */
-  simulateError() {
-    this.#webSocket?.close();
-    this.#handleError(new Event("error"));
-  }
-
-  #handleOpen(event: Event) {
-    this.dispatchEvent(new Event(event.type, event));
-    this.#startHeartbeat();
-  }
-
-  #handleMessage(event: MessageEvent) {
-    this.dispatchEvent(
-      new MessageEvent(event.type, event as unknown as MessageEventInit),
-    );
-  }
-
-  #handleClose(event: CloseEvent) {
-    this.#stopHeartbeat();
-    this.dispatchEvent(new CloseEvent(event.type, event));
-  }
-
-  #handleError(event: Event) {
-    this.dispatchEvent(new Event(event.type, event));
-    this.#startRetry();
-  }
-
-  #startRetry() {
-    if (this.#retry <= 0) {
-      return;
-    }
-    this.#retryId = setInterval(
-      () => this.connect(this.#webSocket!.url),
-      this.#retry,
-    );
-  }
-
-  #stopRetry() {
-    clearInterval(this.#retryId);
-    this.#retryId = undefined;
-  }
-
-  #startHeartbeat() {
-    if (this.#heartbeat <= 0) {
-      return;
-    }
-
-    this.#heartbeatId = setInterval(
-      () => this.#sendHeartbeat(),
-      this.#heartbeat,
-    );
-  }
-
-  #stopHeartbeat() {
-    clearInterval(this.#heartbeatId);
-    this.#heartbeatId = undefined;
-  }
-
-  #sendHeartbeat() {
-    if (this.#heartbeatId == null) {
-      return;
-    }
-
-    void this.send(HEARTBEAT_TYPE);
-  }
-}
-
-class WebSocketStub extends EventTarget {
-  url: string;
-  readyState: number = WebSocket.CONNECTING;
-
-  constructor(url: string | URL) {
-    super();
-    this.url = url.toString();
-    setTimeout(() => {
-      this.readyState = WebSocket.OPEN;
-      this.dispatchEvent(new Event("open"));
-    }, 0);
-  }
-
-  send() {}
-
-  close() {
-    this.readyState = WebSocket.CLOSED;
-    this.dispatchEvent(new Event("close"));
-  }
-}

package/src/vite-env.d.ts

@@ -1,3 +0,0 @@
-// Copyright (c) 2025 Falko Schumann. All rights reserved. MIT license.
-
-/// <reference types="vite/client" />