@muspellheim/shared 0.6.1 → 0.7.0

package/lib/vector.js

@@ -1,194 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * Calculate with vectors in a two-dimensional space.
- *
- * @module
- */
-
-/**
- * A vector in a two-dimensional space.
- */
-export class Vector2D {
-  /**
-   * Creates a vector from 2 points.
-   *
-   * @param {Vector2D} a The first point.
-   * @param {Vector2D} b The second point.
-   * @return {Vector2D} The vector from a to b.
-   */
-  static fromPoints(a, b) {
-    return new Vector2D(b.x - a.x, b.y - a.y);
-  }
-
-  /**
-   * Creates a new vector.
-   *
-   * Examples:
-   *
-   * ```java
-   * new Vector2D(1, 2)
-   * new Vector2D([1, 2])
-   * new Vector2D({ x: 1, y: 2 })
-   * ```
-   *
-   * @param {number|Array<number>|Vector2D} [x=0] The x coordinate or an array
-   *   or another vector.
-   * @param {number} [y=0] The y coordinate or undefined if x is an array or
-   *   another vector.
-   */
-  constructor(x = 0, y = 0) {
-    if (Array.isArray(x)) {
-      this.x = Number(x[0]);
-      this.y = Number(x[1]);
-    } else if (typeof x === 'object' && 'x' in x && 'y' in x) {
-      this.x = Number(x.x);
-      this.y = Number(x.y);
-    } else {
-      this.x = Number(x);
-      this.y = Number(y);
-    }
-  }
-
-  /**
-   * Returns the length of the vector.
-   *
-   * @return {number} The length of the vector.
-   */
-  length() {
-    return Math.hypot(this.x, this.y);
-  }
-
-  /**
-   * Adds another vector to this vector and return the new vector.
-   *
-   * @param {Vector2D} v The vector to add.
-   * @return {Vector2D} The new vector.
-   */
-  add(v) {
-    v = new Vector2D(v);
-    return new Vector2D(this.x + v.x, this.y + v.y);
-  }
-
-  /**
-   * Subtracts another vector from this vector and return the new vector.
-   *
-   * @param {Vector2D} v The vector to subtract.
-   * @return {Vector2D} The new vector.
-   */
-  subtract(v) {
-    v = new Vector2D(v);
-    return new Vector2D(this.x - v.x, this.y - v.y);
-  }
-
-  /**
-   * Multiplies the vector with a scalar and returns the new vector.
-   *
-   * @param {number} scalar The scalar to multiply with.
-   * @return {Vector2D} The new vector.
-   */
-  scale(scalar) {
-    return new Vector2D(this.x * scalar, this.y * scalar);
-  }
-
-  /**
-   * Multiplies the vector with another vector and returns the scalar.
-   *
-   * @param {Vector2D} v The vector to multiply with.
-   * @return {number} The scalar.
-   */
-  dot(v) {
-    v = new Vector2D(v);
-    return this.x * v.x + this.y * v.y;
-  }
-
-  /**
-   * Returns the distance between this vector and another vector.
-   *
-   * @param {Vector2D} v The other vector.
-   * @return {number} The distance.
-   */
-  distance(v) {
-    v = new Vector2D(v);
-    return Vector2D.fromPoints(this, v).length();
-  }
-
-  /**
-   * Returns the rotated vector by the given angle in radians.
-   *
-   * @param {number} angle The angle in radians.
-   * @return {Vector2D} The rotated vector.
-   */
-  rotate(angle) {
-    const cos = Math.cos(angle);
-    const sin = Math.sin(angle);
-    return new Vector2D(
-      this.x * cos - this.y * sin,
-      this.x * sin + this.y * cos,
-    );
-  }
-
-  /**
-   * Returns the unit vector of this vector.
-   *
-   * @return {Vector2D} The unit vector.
-   */
-  normalize() {
-    return this.scale(1 / this.length());
-  }
-}
-
-/**
- * A line in a two-dimensional space.
- */
-export class Line2D {
-  /**
-   * Creates a line from 2 points.
-   *
-   * @param {Vector2D} a The first point.
-   * @param {Vector2D} b The second point.
-   * @return {Line2D} The line from a to b.
-   */
-  static fromPoints(a, b) {
-    return new Line2D(a, Vector2D.fromPoints(a, b));
-  }
-
-  /**
-   * Creates a new line.
-   *
-   * @param {Vector2D} point A point on the line.
-   * @param {Vector2D} direction The direction of the line.
-   */
-  constructor(point, direction) {
-    this.point = new Vector2D(point);
-    this.direction = new Vector2D(direction);
-  }
-
-  /**
-   * Returns the perpendicular of a point on this line.
-   *
-   * @param {Vector2D} point A point.
-   * @return {{foot: Vector2D, scalar: number}} The `foot` and the `scalar`.
-   */
-  perpendicular(point) {
-    // dissolve after r: (line.position + r * line.direction - point) * line.direction = 0
-    const a = this.point.subtract(point);
-    const b = a.dot(this.direction);
-    const c = this.direction.dot(this.direction);
-    const r = b !== 0 ? -b / c : 0;
-
-    // solve with r: line.position + r * line.direction = foot
-    const foot = this.point.add(this.direction.scale(r));
-
-    let scalar;
-    if (this.direction.x !== 0.0) {
-      scalar = (foot.x - this.point.x) / this.direction.x;
-    } else if (this.direction.y !== 0.0) {
-      scalar = (foot.y - this.point.y) / this.direction.y;
-    } else {
-      scalar = Number.NaN;
-    }
-
-    return { foot, scalar };
-  }
-}

package/lib/vitest/equality-testers.js

@@ -1,19 +0,0 @@
-import { expect } from 'vitest';
-
-function isEquatable(a) {
-  return a != null && typeof a.equals === 'function';
-}
-
-function testEquatable(a, b) {
-  const isAEquatable = isEquatable(a);
-  const isBEquatable = isEquatable(b);
-  if (isAEquatable && isBEquatable) {
-    return a.equals(b);
-  } else if (isAEquatable === isBEquatable) {
-    return undefined;
-  } else {
-    return false;
-  }
-}
-
-expect.addEqualityTesters([testEquatable]);

package/lib/vitest/index.js

@@ -1 +0,0 @@
-export * from './equality-testers.js';

package/lib/web-socket-client.js

@@ -1,262 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-import { MessageClient } from './message-client.js';
-import { OutputTracker } from './output-tracker.js';
-import { Timer, TimerTask } from './util.js';
-
-/**
- * @ignore @typedef {typeof WebSocket} WebSocketConstructor
- */
-
-export const HEARTBEAT_TYPE = 'heartbeat';
-
-const MESSAGE_SENT_EVENT = 'message-sent';
-
-/**
- * A client for the WebSocket protocol.
- *
- * Emits the following events:
- *
- * - open, {@link Event}
- * - message, {@link MessageEvent}
- * - error, {@link Event}
- * - close, {@link CloseEvent}
- *
- * @implements {MessageClient}
- */
-export class WebSocketClient extends MessageClient {
-  // TODO Recover connection with timeout after an error event.
-
-  /**
-   * Creates a WebSocket client.
-   *
-   * @param {object} options
-   * @param {number} [options.heartbeat=30000] The heartbeat interval i
-   *   milliseconds. A value <= 0 disables the heartbeat.
-   * @return {WebSocketClient} A new WebSocket client.
-   */
-  static create({ heartbeat = 30000 } = {}) {
-    return new WebSocketClient(heartbeat, Timer.create(), WebSocket);
-  }
-
-  /**
-   * Creates a nulled WebSocket client.
-   *
-   * @param {object} options
-   * @param {number} [options.heartbeat=-1] The heartbeat interval in
-   *   milliseconds. A value <= 0 disables the heartbeat.
-   * @return {WebSocketClient} A new nulled WebSocket client.
-   */
-  static createNull({ heartbeat = -1 } = {}) {
-    return new WebSocketClient(heartbeat, Timer.createNull(), WebSocketStub);
-  }
-
-  #heartbeat;
-  #timer;
-  #webSocketConstructor;
-  /** @type {WebSocket} */ #webSocket;
-
-  /**
-   * The constructor is for internal use. Use the factory methods instead.
-   *
-   * @see WebSocketClient.create
-   * @see WebSocketClient.createNull
-   */
-  constructor(
-    /** @type {number} */ heartbeat,
-    /** @type {Timer} */ timer,
-    /** @type {WebSocketConstructor} */ webSocketConstructor,
-  ) {
-    super();
-    this.#heartbeat = heartbeat;
-    this.#timer = timer;
-    this.#webSocketConstructor = webSocketConstructor;
-  }
-
-  /**
-   * @override
-   */
-  get isConnected() {
-    return this.#webSocket?.readyState === WebSocket.OPEN;
-  }
-
-  /**
-   * @override
-   */
-  get url() {
-    return this.#webSocket?.url;
-  }
-
-  /**
-   * @override
-   */
-  async connect(/** @type {string | URL} */ url) {
-    await new Promise((resolve, reject) => {
-      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);
-      }
-    });
-  }
-
-  /**
-   * Sends a message to the server.
-   * @param {string} message The message to send.
-   * @override
-   */
-  async send(message) {
-    this.#webSocket.send(message);
-    this.dispatchEvent(
-      new CustomEvent(MESSAGE_SENT_EVENT, { detail: message }),
-    );
-    await Promise.resolve();
-  }
-
-  /**
-   * Returns a tracker for messages sent.
-   *
-   * @return {OutputTracker} A new output tracker.
-   */
-  trackMessageSent() {
-    return OutputTracker.create(this, MESSAGE_SENT_EVENT);
-  }
-
-  /**
-   * Closes the connection.
-   *
-   * If a code is provided, also a reason should be provided.
-   * @param {number} [code] An optional code.
-   * @param {string} [reason] An optional reason.
-   * @override
-   */
-  async close(code, reason) {
-    await new Promise((resolve) => {
-      if (!this.isConnected) {
-        resolve();
-        return;
-      }
-
-      this.#webSocket.addEventListener('close', () => resolve());
-      this.#webSocket.close(code, reason);
-    });
-  }
-
-  /**
-   * Simulates a message event from the server.
-   *
-   * @param {string} message The message to receive.
-   */
-  simulateMessage(message) {
-    this.#handleMessage(new MessageEvent('message', { data: message }));
-  }
-
-  /**
-   * Simulates a heartbeat.
-   */
-  simulateHeartbeat() {
-    this.#timer.simulateTaskExecution({ ticks: this.#heartbeat });
-  }
-
-  /**
-   * Simulates a close event.
-   *
-   * @param {number} code An optional code.
-   * @param {string} reason An optional reason.
-   */
-  simulateClose(code, reason) {
-    this.#handleClose(new CloseEvent('close', { code, reason }));
-  }
-
-  /**
-   * Simulates an error event.
-   */
-  simulateError() {
-    this.#handleError(new Event('error'));
-  }
-
-  #handleOpen(event) {
-    this.dispatchEvent(new event.constructor(event.type, event));
-    this.#startHeartbeat();
-  }
-
-  #handleMessage(event) {
-    this.dispatchEvent(new event.constructor(event.type, event));
-  }
-
-  #handleClose(event) {
-    this.#stopHeartbeat();
-    this.dispatchEvent(new event.constructor(event.type, event));
-  }
-
-  #handleError(event) {
-    this.dispatchEvent(new event.constructor(event.type, event));
-  }
-
-  #startHeartbeat() {
-    if (this.#heartbeat <= 0) {
-      return;
-    }
-
-    this.#timer.scheduleAtFixedRate(
-      new HeartbeatTask(this),
-      this.#heartbeat,
-      this.#heartbeat,
-    );
-  }
-
-  #stopHeartbeat() {
-    this.#timer.cancel();
-  }
-}
-
-class HeartbeatTask extends TimerTask {
-  #client;
-
-  constructor(/** @type {WebSocketClient} */ client) {
-    super();
-    this.#client = client;
-  }
-
-  /**
-   * @override
-   */
-  run() {
-    this.#client.send(HEARTBEAT_TYPE);
-  }
-}
-
-class WebSocketStub extends EventTarget {
-  /** @type {number} */
-  readyState = WebSocket.CONNECTING;
-
-  constructor(url) {
-    super();
-    this.url = url;
-    setTimeout(() => {
-      this.readyState = WebSocket.OPEN;
-      this.dispatchEvent(new Event('open'));
-    }, 0);
-  }
-
-  send() {}
-
-  close() {
-    this.readyState = WebSocket.CLOSED;
-    this.dispatchEvent(new Event('close'));
-  }
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "nodenext",
-    "lib": ["es2022", "dom"],
-    "allowJs": true,
-    "checkJs": false,
-    "noImplicitAny": false,
-    "strictNullChecks": false
-  },
-  "exclude": ["coverage", "dist", "node_modules"]
-}