@muspellheim/shared 0.17.0 → 0.18.1

package/dist/shared.d.ts

@@ -1,494 +0,0 @@
-/**
- * A clock provides access to the current timestamp.
- */
-export declare class Clock {
-    #private;
-    /**
-     * Create a clock using system the clock.
-     *
-     * @return A clock that uses the system clock.
-     */
-    static system(): Clock;
-    /**
-     * Create a clock using a fixed date.
-     *
-     * @param date The fixed date of the clock.
-     * @return A clock that always returns a fixed date.
-     */
-    static fixed(date: Date | string | number): Clock;
-    /**
-     * Create a clock that returns a fixed offset from the given clock.
-     *
-     * @param clock The clock to offset from.
-     * @param offsetMillis The offset in milliseconds.
-     * @return A clock that returns a fixed offset from the given clock.
-     */
-    static offset(clock: Clock, offsetMillis: number): Clock;
-    private constructor();
-    /**
-     * Return the current timestamp of the clock.
-     *
-     * @return The current timestamp.
-     */
-    date(): Date;
-    /**
-     * Return the current timestamp of the clock in milliseconds.
-     *
-     * @return The current timestamp in milliseconds.
-     */
-    millis(): number;
-}
-
-/**
- * Provides CQNS features.
- *
- * The Command Query Notification Separation principle is a software design
- * principle that separates the concerns of commands, queries, and
- * notifications.
- *
- * Message hierarchy:
- *
- * - Message
- *   - Incoming / outgoing
- *     - Request (outgoing) -> response (incoming)
- *       - Command -> command status
- *       - Query -> query result
- *     - Notification
- *       - Incoming: notification -> commands
- *       - Outgoing
- *   - Event (internal)
- *
- * @see https://ralfw.de/command-query-notification-separation-cqns/
- * @module
- */
-/**
- * The status returned by a command handler.
- */
-export declare type CommandStatus = Success | Failure;
-
-/**
- * Handle returning pre-configured responses.
- *
- * 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#configurable-responses).
- *
- * Example usage for stubbing `fetch` function:
- *
- * ```javascript
- * function createFetchStub(responses) {
- *   const configurableResponses = ConfigurableResponses.create(responses);
- *   return async function () {
- *     const response = configurableResponses.next();
- *     return {
- *       status: response.status,
- *       json: async () => response.body,
- *     };
- *   };
- * }
- * ```
- */
-export declare class ConfigurableResponses<T = unknown> {
-    #private;
-    /**
-     * Create a list of responses (by providing an array), or a single repeating
-     * response (by providing any other type). 'Name' is optional and used in
-     * error messages.
-     *
-     * @param responses A single response or an array of responses.
-     * @param name An optional name for the responses.
-     */
-    static create<T>(responses?: T | T[], name?: string): ConfigurableResponses<T>;
-    /**
-     * Convert all properties in an object into ConfigurableResponse instances.
-     * For example, { a: 1 } becomes { a: ConfigurableResponses.create(1) }.
-     * 'Name' is optional and used in error messages.
-     *
-     * @param responseObject An object with single response or an array of responses.
-     * @param name An optional name for the responses.
-     */
-    static mapObject<T extends Record<string, unknown>>(responseObject: T, name?: string): any;
-    /**
-     * Create a list of responses (by providing an array), or a single repeating
-     * response (by providing any other type). 'Name' is optional and used in
-     * error messages.
-     *
-     * @param responses A single response or an array of responses.
-     * @param name An optional name for the responses.
-     */
-    constructor(responses?: T | T[], name?: string);
-    /**
-     * Get the next configured response. Throws an error when configured with a list
-     * of responses and no more responses remain.
-     *
-     * @return The next response.
-     */
-    next(): T;
-}
-
-/**
- * Wraps the console interface and allow setting the log level.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Console_API
- */
-export declare class ConsoleLog extends EventTarget implements Log {
-    #private;
-    static create({ name }?: {
-        name?: string;
-    }): ConsoleLog;
-    static createNull({ name }?: {
-        name?: string;
-    }): ConsoleLog;
-    name?: string;
-    level: LogLevel;
-    private constructor();
-    log(...data: unknown[]): void;
-    error(...data: unknown[]): void;
-    warn(...data: unknown[]): void;
-    info(...data: unknown[]): void;
-    debug(...data: unknown[]): void;
-    trace(...data: unknown[]): void;
-    /**
-     * Track the console messages.
-     */
-    trackMessages(): OutputTracker<ConsoleMessage>;
-    isLoggable(level: LogLevel): boolean;
-}
-
-export declare interface ConsoleMessage {
-    level: LogLevel;
-    message: unknown[];
-}
-
-/**
- * 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 declare function createFetchStub(responses?: ResponseData | Error | (ResponseData | Error)[]): () => Promise<Response>;
-
-/**
- * Track events from an event target.
- *
- * Wait asynchronously for events. Useful in test code.
- */
-export declare class EventTracker<T extends Event> {
-    #private;
-    /**
-     * 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 extends Event>(eventTarget: EventTarget, ...event: string[]): EventTracker<T>;
-    /**
-     * 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[]);
-    /**
-     * Return the tracked events.
-     *
-     * @return The tracked events.
-     */
-    get events(): T[];
-    /**
-     * Clear the tracked events and return the cleared events.
-     *
-     * @return The cleared events.
-     */
-    clear(): T[];
-    /**
-     * Stop tracking.
-     */
-    stop(): void;
-    /**
-     * Wait asynchronously for a number of events.
-     *
-     * @param count number of events, default 1.
-     */
-    waitFor(count?: number): Promise<T[]>;
-}
-
-/**
- * A failed status.
- */
-export declare class Failure<T = string> {
-    readonly isSuccess = false;
-    readonly errorMessage: T;
-    /**
-     * Creates a failed status.
-     *
-     * @param errorMessage
-     */
-    constructor(errorMessage: T);
-}
-
-export declare const HEARTBEAT_TYPE = "heartbeat";
-
-/**
- * A simple logging facade.
- *
- * This is a subset of the `Console` interface.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Console_API
- */
-export declare interface Log {
-    log(...data: unknown[]): void;
-    error(...data: unknown[]): void;
-    warn(...data: unknown[]): void;
-    info(...data: unknown[]): void;
-    debug(...data: unknown[]): void;
-    trace(...data: unknown[]): void;
-}
-
-/** Defines level for setting a log level in a `Log` implementation. */
-export declare type LogLevel = "log" | "error" | "warn" | "info" | "debug" | "trace" | "off";
-
-/**
- * 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 declare 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>;
-}
-
-/**
- * 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 declare class OutputTracker<T = unknown> {
-    #private;
-    /**
-     * 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): OutputTracker<T>;
-    /**
-     * 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);
-    /**
-     * Return the tracked data.
-     *
-     * @return The tracked data.
-     */
-    get data(): T[];
-    /**
-     * Clear the tracked data and return the cleared data.
-     *
-     * @return The cleared data.
-     */
-    clear(): T[];
-    /**
-     * Stop tracking.
-     */
-    stop(): void;
-}
-
-/**
- * This data object configures the response of a fetch stub call.
- */
-export declare interface ResponseData {
-    /** The HTTP status code. */
-    status: number;
-    /** The HTTP status text. */
-    statusText: string;
-    /** The optional response body. */
-    body?: Blob | object | string | null;
-}
-
-/**
- * A client for the server-sent events protocol.
- */
-export declare class SseClient extends EventTarget implements MessageClient {
-    #private;
-    /**
-     * Create an SSE client.
-     *
-     * @return A new SSE client.
-     */
-    static create(): SseClient;
-    /**
-     * Create a nulled SSE client.
-     *
-     * @return A new SSE client.
-     */
-    static createNull(): SseClient;
-    private constructor();
-    get isConnected(): boolean;
-    get url(): string | undefined;
-    connect(url: string | URL, eventName?: string, ...otherEvents: string[]): Promise<void>;
-    send(_message: string, _type?: string): Promise<void>;
-    close(): Promise<void>;
-    /**
-     * 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?: string, lastEventId?: string): void;
-    /**
-     * Simulate an error event.
-     */
-    simulateError(): void;
-}
-
-/**
- * A successful status.
- */
-export declare class Success<T = unknown> {
-    readonly isSuccess = true;
-    readonly result?: T;
-    constructor(result?: T);
-}
-
-/**
- * A client for the WebSocket protocol.
- */
-export declare class WebSocketClient extends EventTarget implements MessageClient {
-    #private;
-    /**
-     * Create a WebSocket client.
-     *
-     * @param options The options for the WebSocket client.
-     * @return A new WebSocket client.
-     */
-    static create({ heartbeat, retry, }?: WebSocketOptions): WebSocketClient;
-    /**
-     * Create a nulled WebSocket client.
-     *
-     * @param options The options for the WebSocket client.
-     * @return A new nulled WebSocket client.
-     */
-    static createNull({ heartbeat, retry }?: WebSocketOptions): WebSocketClient;
-    private constructor();
-    get isConnected(): boolean;
-    get url(): string | undefined;
-    connect(url: string | URL): Promise<void>;
-    send(message: string | ArrayBuffer | Blob | ArrayBufferView): Promise<void>;
-    /**
-     * Return a tracker for messages sent.
-     *
-     * @return A new output tracker.
-     */
-    trackMessageSent(): OutputTracker<string>;
-    /**
-     * Close the connection.
-     *
-     * If a code is provided, also a reason should be provided.
-     *
-     * @param code An optional code.
-     * @param reason An optional reason.
-     */
-    close(code?: number, reason?: string): Promise<void>;
-    /**
-     * Simulate a message event from the server.
-     *
-     * @param message The message to receive.
-     */
-    simulateMessage(message: string | number | boolean | object | null | Blob | ArrayBuffer): void;
-    /**
-     * Simulate a heartbeat.
-     */
-    simulateHeartbeat(): void;
-    /**
-     * Simulate a close event.
-     *
-     * @param code An optional code.
-     * @param reason An optional reason.
-     */
-    simulateClose(code?: number, reason?: string): void;
-    /**
-     * Simulate an error event.
-     */
-    simulateError(): void;
-}
-
-/**
- * Options for the WebSocket client.
- */
-export declare 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;
-}
-
-export { }