@muspellheim/shared 0.6.0 → 0.7.0

package/eslint.config.js

@@ -1,23 +0,0 @@
-import js from '@eslint/js';
-import globals from 'globals';
-
-/** @type { import("eslint").Linter.FlatConfig[] } */
-export default [
-  js.configs.recommended,
-  {
-    languageOptions: {
-      ecmaVersion: 2022,
-      globals: {
-        ...globals.es2021,
-        ...globals.node,
-        ...globals.browser,
-        //...globals.serviceworker,
-        //...globals['shared-node-browser'],
-      },
-    },
-    ignores: ['coverage/**', 'docs/**'],
-    rules: {
-      'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-    },
-  },
-];

package/lib/assert.js

@@ -1,15 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * Assert that an object is not `null`.
- *
- * @param {*} object The object to check.
- * @param {string|Function} message The message to throw or a function that
- *   returns the message.
- */
-export function assertNotNull(object, message) {
-  if (object == null) {
-    const m = typeof message === 'function' ? message() : message;
-    throw new ReferenceError(m);
-  }
-}

package/lib/browser/components.js

@@ -1,165 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * Contains a pattern to implement custom elements with
- * [lit-html](https://lit.dev/docs/libraries/standalone-templates/).
- *
- * @module
- */
-
-/**
- * @import { StateType, Store } from '../store.js'
- * @import { TemplateResult } from 'lit-html'
- */
-
-import { html, render } from 'lit-html';
-
-/**
- * Base class for a custom element rendered with `lit-html`.
- */
-export class Component extends HTMLElement {
-  /**
-   * Updates the view after this component is inserted into the DOM.
-   *
-   * Called when this component is inserted into the DOM. Override this method
-   * to register event listeners. Don't forget to call the super method.
-   */
-  connectedCallback() {
-    this.updateView();
-  }
-
-  /**
-   * Currently does nothing.
-   *
-   * Called when this component is removed from the DOM. Override this method to
-   * remove event listeners. Don't forget to call the super method.
-   */
-  disconnectedCallback() {}
-
-  /**
-   * Updates this component.
-   *
-   * Renders the view into the target element.
-   *
-   * @see module:browser/components.Component#getView
-   * @see module:browser/components.Component#getRenderTarget
-   */
-  updateView() {
-    if (!this.isConnected) {
-      // Skip rendering, e.g. when setting properties before inserting into DOM.
-      return;
-    }
-
-    render(this.getView(), this.getRenderTarget());
-  }
-
-  /**
-   * Returns the view to render when this component is updated.
-   *
-   * The view is a template created with `html` from lit-html. Override this
-   * method to return the view. The default is an empty view.
-   *
-   * @return {TemplateResult} The view.
-   */
-  getView() {
-    return html``;
-  }
-
-  /**
-   * Returns the target element of this component to render the view into.
-   *
-   * The default is `this`.
-   *
-   * @return {HTMLElement|DocumentFragment} The target element.
-   */
-  getRenderTarget() {
-    return this;
-  }
-}
-
-/**
- * Base class for custom elements that use a store.
- *
- * @extends {Component}
- * @see Store
- */
-export class Container extends Component {
-  /** @type {Store} */ static #store;
-
-  /**
-   * Initializes the store for all containers.
-   *
-   * Must be call before any container is inserted into the DOM.
-   *
-   * @param {Store} store The store to use.
-   */
-  static initStore(store) {
-    Container.#store = store;
-  }
-
-  /** @type {function(): void} */ #unsubscribeStore;
-
-  /**
-   * Initializes this container with an empty state `{}`.
-   */
-  constructor() {
-    super();
-    this.state = {};
-  }
-
-  /**
-   * Returns the store.
-   *
-   * @type {Store}
-   */
-  get store() {
-    return Container.#store;
-  }
-
-  /**
-   * Subscribes to the store and update the view when the state changes.
-   *
-   * Don't forget to call the super method when overriding this method.
-   *
-   * @override
-   */
-  connectedCallback() {
-    this.#unsubscribeStore = this.store.subscribe(() => this.updateView());
-    super.connectedCallback();
-  }
-
-  /**
-   * Unsubscribes from the store.
-   *
-   * Don't forget to call the super method when overriding this method.
-   *
-   * @override
-   */
-  disconnectedCallback() {
-    this.#unsubscribeStore();
-    super.disconnectedCallback();
-  }
-
-  /**
-   * Updates this container with the current state from the store before
-   * updating the view.
-   *
-   * @override
-   */
-  updateView() {
-    this.state = this.extractState(this.store.getState());
-    super.updateView();
-  }
-
-  /**
-   * Extracts a subset of the state for this container.
-   *
-   * Default is the entire state.
-   *
-   * @param {StateType} state The state of the store.
-   * @return {StateType} The state for the container.
-   */
-  extractState(state) {
-    return state;
-  }
-}

package/lib/browser/index.js

@@ -1,3 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-export * from './components.js';

package/lib/color.js

@@ -1,137 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-const FACTOR = 0.7;
-
-/**
- * The Color class represents a color in the RGB color space.
- */
-export class Color {
-  /**
-   * The RGB value of the color.
-   *
-   * @type {number}
-   */
-  rgb;
-
-  /**
-   * Creates a color instance from RGB values.
-   *
-   * @param {number|string} [red] The red component or the RGB value.
-   * @param {number} [green] The green component.
-   * @param {number} [blue] The blue component.
-   */
-  constructor(red, green, blue) {
-    if (typeof red === 'string') {
-      this.rgb = parseInt(red, 16);
-    } else if (
-      typeof red === 'number' &&
-      typeof green === 'number' &&
-      typeof blue === 'number'
-    ) {
-      this.rgb =
-        ((red & 0xff) << 16) | ((green & 0xff) << 8) | ((blue & 0xff) << 0);
-    } else if (typeof red === 'number') {
-      this.rgb = red;
-    } else {
-      this.rgb = NaN;
-    }
-  }
-
-  /**
-   * The red component of the color.
-   *
-   * @type {number}
-   */
-  get red() {
-    return (this.rgb >> 16) & 0xff;
-  }
-
-  /**
-   * The green component of the color.
-   *
-   * @type {number}
-   */
-  get green() {
-    return (this.rgb >> 8) & 0xff;
-  }
-
-  /**
-   * The blue component of the color.
-   *
-   * @type {number}
-   */
-  get blue() {
-    return (this.rgb >> 0) & 0xff;
-  }
-
-  /**
-   * Creates a new color that is brighter than this color.
-   *
-   * @param {number} [factor] The optional factor to brighten the color.
-   * @return {Color} The brighter color.
-   */
-  brighter(factor = FACTOR) {
-    if (Number.isNaN(this.rgb)) {
-      return new Color();
-    }
-
-    let red = this.red;
-    let green = this.green;
-    let blue = this.blue;
-
-    const inverse = Math.floor(1 / (1 - factor));
-    if (red === 0 && green === 0 && blue === 0) {
-      return new Color(inverse, inverse, inverse);
-    }
-
-    if (red > 0 && red < inverse) red = inverse;
-    if (green > 0 && green < inverse) green = inverse;
-    if (blue > 0 && blue < inverse) blue = inverse;
-
-    return new Color(
-      Math.min(Math.floor(red / FACTOR), 255),
-      Math.min(Math.floor(green / FACTOR), 255),
-      Math.min(Math.floor(blue / FACTOR), 255),
-    );
-  }
-
-  /**
-   * Creates a new color that is darker than this color.
-   *
-   * @param {number} [factor] The optional factor to darken the color.
-   * @return {Color} The darker color.
-   */
-  darker(factor = FACTOR) {
-    if (Number.isNaN(this.rgb)) {
-      return new Color();
-    }
-
-    return new Color(
-      Math.max(Math.floor(this.red * factor), 0),
-      Math.max(Math.floor(this.green * factor), 0),
-      Math.max(Math.floor(this.blue * factor), 0),
-    );
-  }
-
-  /**
-   * Returns the RGB value of the color.
-   *
-   * @return {number} The RGB value of the color.
-   */
-  valueOf() {
-    return this.rgb;
-  }
-
-  /**
-   * Returns the hexadecimal representation of the color.
-   *
-   * @return {string} The hexadecimal representation of the color.
-   */
-  toString() {
-    if (Number.isNaN(this.rgb)) {
-      return 'Invalid Color';
-    }
-
-    return this.rgb.toString(16).padStart(6, '0');
-  }
-}

package/lib/configurable-responses.js

@@ -1,69 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * Handle returning a 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 class ConfigurableResponses {
-  /**
-   * Creates a configurable responses instance from a single response or an
-   * array of responses with an optional response name.
-   *
-   * @param {*|Array} responses A single response or an array of responses.
-   * @param {string} [name] An optional name for the responses.
-   */
-  static create(responses, name) {
-    return new ConfigurableResponses(responses, name);
-  }
-
-  #description;
-  #responses;
-
-  /**
-   * Creates a configurable responses instance from a single response or an
-   * array of responses with an optional response name.
-   *
-   * @param {*|Array} responses A single response or an array of responses.
-   * @param {string} [name] An optional name for the responses.
-   */
-  constructor(/** @type {*|Array} */ responses, /** @type {?string} */ name) {
-    this.#description = name == null ? '' : ` in ${name}`;
-    this.#responses = Array.isArray(responses) ? [...responses] : responses;
-  }
-
-  /**
-   * Returns the next response.
-   *
-   * If there are no more responses, an error is thrown. If a single response is
-   * configured, it is always returned.
-   *
-   * @return {*} The next response.
-   */
-  next() {
-    const response = Array.isArray(this.#responses)
-      ? this.#responses.shift()
-      : this.#responses;
-    if (response === undefined) {
-      throw new Error(`No more responses configured${this.#description}.`);
-    }
-
-    return response;
-  }
-}

package/lib/feature-toggle.js

@@ -1,9 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-export class FeatureToggle {
-  /*
-  static isFoobarEnabled() {
-    return true;
-  }
-  */
-}