@muspellheim/shared 0.6.0 → 0.7.0

package/lib/service-locator.js

@@ -1,44 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * A central place to register and resolve services.
- */
-export class ServiceLocator {
-  static #instance = new ServiceLocator();
-
-  /**
-   * Gets the default service locator.
-   *
-   * @return {ServiceLocator} The default service locator.
-   */
-  static getDefault() {
-    return ServiceLocator.#instance;
-  }
-
-  #services = new Map();
-
-  /**
-   * Registers a service with name.
-   *
-   * @param {string} name The name of the service.
-   * @param {object|Function} service The service object or constructor.
-   */
-  register(name, service) {
-    this.#services.set(name, service);
-  }
-
-  /**
-   * Resolves a service by name.
-   *
-   * @param {string} name The name of the service.
-   * @return {object} The service object.
-   */
-  resolve(name) {
-    const service = this.#services.get(name);
-    if (service == null) {
-      throw new Error(`Service not found: ${name}.`);
-    }
-
-    return typeof service === 'function' ? service() : service;
-  }
-}

package/lib/sse-client.js

@@ -1,163 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-import { MessageClient } from './message-client.js';
-
-/**
- * @ignore @typedef {typeof EventSource} EventSourceConstructor
- */
-
-/**
- * A client for the server-sent events protocol.
- *
- * @implements {MessageClient}
- */
-export class SseClient extends MessageClient {
-  /**
-   * Creates a SSE client.
-   *
-   * @return {SseClient} A new SSE client.
-   */
-  static create() {
-    return new SseClient(EventSource);
-  }
-
-  /**
-   * Creates a nulled SSE client.
-   *
-   * @return {SseClient} A new SSE client.
-   */
-  static createNull() {
-    return new SseClient(EventSourceStub);
-  }
-
-  #eventSourceConstructor;
-  /** @type {EventSource} */ #eventSource;
-
-  /**
-   * The constructor is for internal use. Use the factory methods instead.
-   *
-   * @param {EventSourceConstructor} eventSourceConstructor
-   * @see SseClient.create
-   * @see SseClient.createNull
-   */
-  constructor(eventSourceConstructor) {
-    super();
-    this.#eventSourceConstructor = eventSourceConstructor;
-  }
-
-  /**
-   * @override
-   */
-  get isConnected() {
-    return this.#eventSource?.readyState === this.#eventSourceConstructor.OPEN;
-  }
-
-  /**
-   * @override
-   */
-  get url() {
-    return this.#eventSource?.url;
-  }
-
-  /**
-   * Connects to the server.
-   * @param {URL | string} url The server URL to connect to.
-   * @param {string} [eventName] The optional event type to listen to.
-   * @override
-   */
-  async connect(url, eventName = 'message') {
-    await new Promise((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),
-        );
-        this.#eventSource.addEventListener('error', (e) =>
-          this.#handleError(e),
-        );
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-
-  /**
-   * @override
-   */
-  async close() {
-    await new Promise((resolve, reject) => {
-      if (!this.isConnected) {
-        resolve();
-        return;
-      }
-
-      try {
-        this.#eventSource.close();
-        resolve();
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-
-  /**
-   * Simulates a message event from the server.
-   *
-   * @param {string} message The message to receive.
-   * @param {string} [eventName=message] The optional event type.
-   * @param {string} [lastEventId] The optional last event ID.
-   */
-  simulateMessage(message, eventName = 'message', lastEventId = undefined) {
-    this.#handleMessage(
-      new MessageEvent(eventName, { data: message, lastEventId }),
-    );
-  }
-
-  /**
-   * Simulates an error event.
-   */
-  simulateError() {
-    this.#handleError(new Event('error'));
-  }
-
-  #handleOpen(event) {
-    this.dispatchEvent(new event.constructor(event.type, event));
-  }
-
-  #handleMessage(event) {
-    this.dispatchEvent(new event.constructor(event.type, event));
-  }
-
-  #handleError(event) {
-    this.dispatchEvent(new event.constructor(event.type, event));
-  }
-}
-
-class EventSourceStub extends EventTarget {
-  // The constants have to be defined here because JSDOM is missing EventSource.
-  static CONNECTING = 0;
-  static OPEN = 1;
-  static CLOSED = 2;
-
-  constructor(url) {
-    super();
-    this.url = url;
-    setTimeout(() => {
-      this.readyState = EventSourceStub.OPEN;
-      this.dispatchEvent(new Event('open'));
-    }, 0);
-  }
-
-  close() {
-    this.readyState = EventSourceStub.CLOSED;
-  }
-}

package/lib/stop-watch.js

@@ -1,54 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-import { Clock } from './time.js';
-
-/**
- * A simple stop watch.
- */
-export class StopWatch {
-  #clock;
-  #startTime;
-  #stopTime;
-
-  /**
-   * Creates a new stop watch.
-   *
-   * @param {Clock} [clock=Clock.system()] The clock to use for time
-   *   measurement.
-   */
-  constructor(clock = Clock.system()) {
-    this.#clock = clock;
-  }
-
-  /**
-   * Starts an unnamed task.
-   */
-  start() {
-    this.#startTime = this.#clock.millis();
-  }
-
-  /**
-   * Stops the current task.
-   */
-  stop() {
-    this.#stopTime = this.#clock.millis();
-  }
-
-  /**
-   * Gets the total time in milliseconds.
-   *
-   * @return {number} The total time in milliseconds.
-   */
-  getTotalTimeMillis() {
-    return this.#stopTime - this.#startTime;
-  }
-
-  /**
-   * Gets the total time in seconds.
-   *
-   * @return {number} The total time in seconds.
-   */
-  getTotalTimeSeconds() {
-    return this.getTotalTimeMillis() / 1000;
-  }
-}

package/lib/store.js

@@ -1,129 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * Simple global state management with store and reducer.
- *
- * This implementation is compatible with [Redux](https://redux.js.org). It is
- * intended to replace it with Redux if necessary, for example if the
- * application grows.
- *
- * @module
- */
-
-/**
- * A reducer is a function that changes the state of the application based on an
- * action.
- *
- * @callback ReducerType
- * @param {StateType} state The current state of the application.
- * @param {ActionType} action The action to handle.
- * @return {StateType} The next state of the application or the initial state
- *   if the state parameter is `undefined`.
- */
-
-/**
- * The application state can be any object.
- *
- * @typedef {object} StateType
- */
-
-/**
- * An action describe an command or an event that changes the state of the
- * application.
- *
- * An action can have any properties, but it should have a `type` property.
- *
- * @typedef {object} ActionType
- * @property {string} type A string that identifies the action.
- */
-
-/**
- * A listener is a function that is called when the state of the store changes.
- *
- * @callback ListenerType
- */
-
-/**
- * An unsubscriber is a function that removes a listener from the store.
- *
- * @callback UnsubscriberType
- */
-
-/**
- * Creates a new store with the given reducer and optional preloaded state.
- *
- * @param {ReducerType} reducer The reducer function.
- * @param {StateType} [preloadedState] The optional initial state of the store.
- * @return {Store} The new store.
- */
-export function createStore(reducer, preloadedState) {
-  const initialState = preloadedState || reducer(undefined, { type: '@@INIT' });
-  return new Store(reducer, initialState);
-}
-
-/**
- * A simple store compatible with [Redux](https://redux.js.org/api/store).
- */
-export class Store {
-  #reducer;
-  #state;
-  #listeners = [];
-
-  /**
-   * Creates a new store with the given reducer and initial state.
-   *
-   * @param {ReducerType} reducer
-   * @param {StateType} initialState
-   */
-  constructor(reducer, initialState) {
-    this.#reducer = reducer;
-    this.#state = initialState;
-  }
-
-  /**
-   * Returns the current state of the store.
-   *
-   * @return {StateType} The current state of the store.
-   */
-  getState() {
-    return this.#state;
-  }
-
-  /**
-   * Updates the state of the store by dispatching an action to the reducer.
-   *
-   * @param {ActionType} action The action to dispatch.
-   */
-  dispatch(action) {
-    const oldState = this.#state;
-    this.#state = this.#reducer(this.#state, action);
-    if (oldState !== this.#state) {
-      this.#emitChange();
-    }
-  }
-
-  /**
-   * Subscribes a listener to store changes.
-   *
-   * @param {ListenerType} listener The listener to subscribe.
-   * @return {UnsubscriberType} A function that unsubscribes the listener.
-   */
-  subscribe(listener) {
-    this.#listeners.push(listener);
-    return () => this.#unsubscribe(listener);
-  }
-
-  #emitChange() {
-    this.#listeners.forEach((listener) => {
-      // Unsubscribe replace listeners array with a new array, so we must double
-      // check if listener is still subscribed.
-      if (this.#listeners.includes(listener)) {
-        listener();
-      }
-    });
-  }
-
-  #unsubscribe(listener) {
-    this.#listeners = this.#listeners.filter((l) => l !== listener);
-  }
-}