npm - mi-element - Versions diffs - 0.0.1 → 0.1.0 - Mend

mi-element 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2024-present, commenthol and contributors
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md CHANGED Viewed

@@ -1,2 +1,90 @@
 # mi-element
+> a lightweight alternative to write web components
+mi-element provides further features to build web applications through
+[Web Components][] like:
+- controllers to hook into the components lifecycle
+- ContextProvider, ContextConsumer for data provisioning from outside of a
+  component
+- Store for managing shared state across components
+# Usage
+In your project:
+```
+npm i mi-element
+```
+```js
+/** @file ./mi-counter.js */
+import { MiElement, define, refsById } from 'mi-element'
+// define your Component
+class MiCounter extends MiElement {
+  static template = `
+  <style>
+    :host { font-size: 1.25rem; }
+  </style>
+  <button id="decrement" aria-label="Decrement counter"> - </button>
+  <span id aria-label="Counter value">0</span>
+  <button id="increment" aria-label="Increment counter"> + </button>
+  `
+  // declare reactive attributes
+  static get attributes() {
+    return { count: 0 }
+  }
+  // called by connectedCallback()
+  render() {
+    // gather refs from template (here by id)
+    this.refs = refsById(this.renderRoot)
+    // apply event listeners
+    this.refs.button.decrement.addEventListener('click', () => this.count--)
+    this.refs.button.increment.addEventListener('click', () => this.count++)
+  }
+  // called on every change of an observed attributes via `this.requestUpdate()`
+  update() {
+    this.refs.span.textContent = this.count
+  }
+}
+// create the custom element
+define('mi-counter', MiCounter)
+```
+Now use in your HTML
+```html
+<body>
+  <mi-counter></mi-counter>
+  <mi-counter count="-3"></mi-counter>
+  <script type="module" src="./mi-counter.js"></script>
+</body>
+```
+In `./example` you'll find a working sample of a Todo App. Check it out with
+`npm run example`
+# Documentation
+- [lifecycle][docs-lifecycle] mi-element's lifecycle
+- [controller][docs-controller] adding controllers to mi-element to hook into the lifecycle
+- [context][docs-context] Implementation of the [Context Protocol][].
+- [store][docs-store] Manage shared state in an application
+# License
+MIT licensed
+[Context Protocol]: https://github.com/webcomponents-cg/community-protocols/blob/main/proposals/context.md
+[Web Components]: https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements#custom_element_lifecycle_callbacks
+[docs-lifecycle]: https://github.com/commenthol/mi-element/tree/main/packages/mi-element/docs/lifecycle.md
+[docs-controller]: https://github.com/commenthol/mi-element/tree/main/packages/mi-element/docs/controller.md
+[docs-context]: https://github.com/commenthol/mi-element/tree/main/packages/mi-element/docs/context.md
+[docs-store]: https://github.com/commenthol/mi-element/tree/main/packages/mi-element/docs/store.md

package/dist/context.js ADDED Viewed

@@ -0,0 +1,62 @@
+import { isSignalLike, createSignal } from './signal.js';
+class ContextProvider {
+  constructor(host, context, initialValue) {
+    this.host = host, this.context = context, this.state = isSignalLike(initialValue) ? initialValue : createSignal(initialValue),
+    this.host.addController?.(this);
+  }
+  hostConnected() {
+    this.host.addEventListener("context-request", this.onContextRequest);
+  }
+  hostDisconnected() {
+    this.host.removeEventListener("context-request", this.onContextRequest);
+  }
+  set value(newValue) {
+    this.state.value = newValue;
+  }
+  get value() {
+    return this.state.value;
+  }
+  notify() {
+    this.state.notify();
+  }
+  onContextRequest=ev => {
+    if (ev.context !== this.context) return;
+    ev.stopPropagation();
+    const unsubscribe = ev.subscribe ? this.state.subscribe(ev.callback) : void 0;
+    ev.callback(this.value, unsubscribe);
+  };
+}
+class ContextRequestEvent extends Event {
+  constructor(context, callback, subscribe) {
+    super("context-request", {
+      bubbles: !0,
+      composed: !0
+    }), this.context = context, this.callback = callback, this.subscribe = subscribe;
+  }
+}
+class ContextConsumer {
+  constructor(host, context, options) {
+    const {subscribe: subscribe = !1, validate: validate = () => !0} = options || {};
+    this.host = host, this.context = context, this.subscribe = !!subscribe, this.validate = validate,
+    this.value = void 0, this.unsubscribe = void 0, this.host.addController?.(this);
+  }
+  hostConnected() {
+    this.dispatchRequest();
+  }
+  hostDisconnected() {
+    this.unsubscribe && (this.unsubscribe(), this.unsubscribe = void 0);
+  }
+  dispatchRequest() {
+    this.host.dispatchEvent(new ContextRequestEvent(this.context, this._callback.bind(this), this.subscribe));
+  }
+  _callback(value, unsubscribe) {
+    unsubscribe && (this.subscribe ? this.unsubscribe && (this.unsubscribe !== unsubscribe && this.unsubscribe(),
+    this.unsubscribe = unsubscribe) : unsubscribe()), this.validate(value) && (this.value = value,
+    this.host.requestUpdate());
+  }
+}
+export { ContextConsumer, ContextProvider, ContextRequestEvent };

package/dist/element.js ADDED Viewed

@@ -0,0 +1,109 @@
+class MiElement extends HTMLElement {
+  #attr={};
+  #attrLc=new Map;
+  #types=new Map;
+  #disposers=new Set;
+  #controllers=new Set;
+  #changedAttr={};
+  static shadowRootOptions={
+    mode: 'open'
+  };
+  constructor() {
+    super(), this.#attr = {
+      ...this.constructor.attributes
+    }, this.#observedAttributes();
+  }
+  #observedAttributes() {
+    for (const [name, val] of Object.entries(this.#attr)) this.#types.set(name, initialType(val)),
+    this.#attrLc.set(name.toLowerCase(), name), Object.defineProperty(this, name, {
+      enumerable: !0,
+      get() {
+        return this.#attr[name];
+      },
+      set(newValue) {
+        this.#attr[name] !== newValue && (this.#attr[name] = newValue, this.#changedAttr[name] = newValue,
+        this.requestUpdate());
+      }
+    });
+  }
+  #getName(name) {
+    return this.#attrLc.get(name) || name;
+  }
+  #getType(name) {
+    return this.#types.get(name);
+  }
+  connectedCallback() {
+    this.#controllers.forEach((controller => controller.hostConnected?.()));
+    const {shadowRootOptions: shadowRootOptions, template: template} = this.constructor;
+    this.renderRoot = shadowRootOptions ? this.shadowRoot ?? this.attachShadow(shadowRootOptions) : this,
+    this.addTemplate(template), this.render(), this.requestUpdate();
+  }
+  disconnectedCallback() {
+    this.#disposers.forEach((remover => remover())), this.#controllers.forEach((controller => controller.hostDisconnected?.()));
+  }
+  attributeChangedCallback(name, _oldValue, newValue) {
+    const attr = this.#getName(name), type = this.#getType(attr), _newValue = convertType(newValue, type);
+    this.#attr[attr] = this.#changedAttr[attr] = _newValue, 'Boolean' === type && 'false' === newValue && this.removeAttribute(name),
+    this.requestUpdate();
+  }
+  setAttribute(name, newValue) {
+    const attr = this.#getName(name);
+    if (!(attr in this.#attr)) return;
+    const type = this.#getType(attr);
+    this.#attr[attr] = this.#changedAttr[attr] = newValue, 'Boolean' === type ? !0 === newValue || '' === newValue ? super.setAttribute(name, '') : super.removeAttribute(name) : [ 'String', 'Number' ].includes(type) || !0 === newValue ? super.setAttribute(name, newValue) : this.requestUpdate();
+  }
+  requestUpdate() {
+    this.isConnected && requestAnimationFrame((() => {
+      this.shouldUpdate(this.#changedAttr) && this.update(this.#changedAttr), this.#changedAttr = {};
+    }));
+  }
+  addTemplate(template) {
+    template instanceof HTMLTemplateElement && this.renderRoot.appendChild(template.content.cloneNode(!0));
+  }
+  render() {}
+  shouldUpdate(_changedAttributes) {
+    return !0;
+  }
+  update(_changedAttributes) {}
+  on(eventName, listener, node = this) {
+    node.addEventListener(eventName, listener), this.#disposers.add((() => node.removeEventListener(eventName, listener)));
+  }
+  once(eventName, listener, node = this) {
+    node.addEventListener(eventName, listener, {
+      once: !0
+    });
+  }
+  dispose(listener) {
+    if ('function' != typeof listener) throw new TypeError('listener must be a function');
+    this.#disposers.add(listener);
+  }
+  addController(controller) {
+    this.#controllers.add(controller), this.isConnected && controller.hostConnected?.();
+  }
+  removeController(controller) {
+    this.#controllers.delete(controller);
+  }
+}
+const define = (name, element, options) => {
+  element.observedAttributes = (element.observedAttributes || Object.keys(element.attributes || [])).map((attr => attr.toLowerCase())),
+  renderTemplate(element), window.customElements.define(name, element, options);
+}, renderTemplate = element => {
+  if ('string' != typeof element.template) return;
+  const el = document.createElement('template');
+  el.innerHTML = element.template, element.template = el;
+}, initialType = value => toString.call(value).slice(8, -1), convertType = (any, type) => {
+  switch (type) {
+   case 'Number':
+    return (any => {
+      const n = Number(any);
+      return isNaN(n) ? any : n;
+    })(any);
+   case 'Boolean':
+    return 'false' !== any && ('' === any || !!any);
+  }
+  return any;
+};
+export { MiElement, convertType, define };

package/dist/escape.js ADDED Viewed

@@ -0,0 +1,9 @@
+const escMap = {
+  '&': '&amp;',
+  '<': '&lt;',
+  '>': '&gt;',
+  "'": '&#39;',
+  '"': '&quot;'
+}, escHtml = string => ('' + string).replace(/&amp;/g, '&').replace(/[&<>'"]/g, (tag => escMap[tag])), escAttr = string => ('' + string).replace(/['"]/g, (tag => escMap[tag])), esc = (strings, ...vars) => strings.map(((string, i) => string + escHtml(vars[i] ?? ''))).join('');
+export { esc, escAttr, escHtml };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,11 @@
+export { ContextConsumer, ContextProvider, ContextRequestEvent } from './context.js';
+export { MiElement, convertType, define } from './element.js';
+export { esc, escAttr, escHtml } from './escape.js';
+export { refsById, refsBySelector } from './refs.js';
+export { Signal, createSignal, isSignalLike } from './signal.js';
+export { Store, subscribeToStore } from './store.js';

package/dist/refs.js ADDED Viewed

@@ -0,0 +1,15 @@
+function refsById(container) {
+  const nodes = container.querySelectorAll?.('[id]') || [], found = {};
+  for (const node of nodes) found[kebabToCamelCase(node.getAttribute('id') || node.nodeName.toLowerCase())] = node;
+  return found;
+}
+const kebabToCamelCase = (str = "") => str.toLowerCase().replace(/[-_]\w/g, (m => m[1].toUpperCase()));
+function refsBySelector(container, selectors) {
+  const found = {};
+  for (const [name, selector] of Object.entries(selectors)) found[name] = container.querySelector?.(selector);
+  return found;
+}
+export { kebabToCamelCase, refsById, refsBySelector };

package/dist/signal.js ADDED Viewed

@@ -0,0 +1,24 @@
+class Signal {
+  _subscribers=new Set;
+  constructor(initialValue) {
+    this._value = initialValue;
+  }
+  get value() {
+    return this._value;
+  }
+  set value(newValue) {
+    this._value !== newValue && (this._value = newValue, this.notify());
+  }
+  notify() {
+    for (const callback of this._subscribers) callback(this._value);
+  }
+  subscribe(callback) {
+    return this._subscribers.add(callback), () => {
+      this._subscribers.delete(callback);
+    };
+  }
+}
+const createSignal = initialValue => new Signal(initialValue), isSignalLike = possibleSignal => 'function' == typeof possibleSignal?.subscribe && 'function' == typeof possibleSignal?.notify && 'value' in possibleSignal;
+export { Signal, createSignal, isSignalLike };

package/dist/store.js ADDED Viewed

@@ -0,0 +1,28 @@
+import { Signal, isSignalLike } from './signal.js';
+class Store extends Signal {
+  constructor(actions, initialValue) {
+    super(initialValue);
+    for (const [action, dispatcher] of Object.entries(actions)) this[action] = data => {
+      this.value = dispatcher(data)(this.value);
+    };
+  }
+}
+const subscribeToStore = (element, store, propOrSignal) => {
+  if (propOrSignal instanceof Signal || isSignalLike(propOrSignal)) return void element.dispose(store.subscribe((value => {
+    propOrSignal.value = value;
+  })));
+  const keys = Array.isArray(propOrSignal) ? propOrSignal : propOrSignal.split('.').filter(Boolean), last = keys.pop();
+  if (!last) throw TypeError('need prop');
+  let tmp = element;
+  for (const key of keys) {
+    if ('object' != typeof tmp[key]) throw new TypeError(`object expected for property "${key}"`);
+    tmp = tmp[key];
+  }
+  element.dispose(store.subscribe((value => {
+    tmp[last] = value, element.requestUpdate();
+  })));
+};
+export { Store, subscribeToStore };

package/package.json CHANGED Viewed

@@ -1,13 +1,96 @@
 {
   "name": "mi-element",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.1.0",
+  "description": "Build lightweight reactive micro web-components",
   "keywords": [],
+  "homepage": "https://github.com/commenthol/mi-element/tree/main/packages/mi-element#readme",
+  "bugs": {
+    "url": "https://github.com/commenthol/mi-element/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/commenthol/mi-element.git",
+    "directory": "packages/mi-element"
+  },
   "license": "MIT",
   "author": "commenthol <commenthol@gmail.com>",
+  "maintainers": [
+    "commenthol <commenthol@gmail.com>"
+  ],
   "type": "module",
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "development": "./src/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./element": {
+      "default": "./dist/element.js",
+      "development": "./src/element.js",
+      "types": "./types/element.d.ts"
+    },
+    "./context": {
+      "default": "./dist/context.js",
+      "development": "./src/context.js",
+      "types": "./types/context.d.ts"
+    },
+    "./escape": {
+      "default": "./dist/escape.js",
+      "development": "./src/escape.js",
+      "types": "./types/escape.d.ts"
+    },
+    "./refs": {
+      "default": "./dist/refs.js",
+      "development": "./src/refs.js",
+      "types": "./types/refs.d.ts"
+    },
+    "./signal": {
+      "default": "./dist/signal.js",
+      "development": "./src/signal.js",
+      "types": "./types/signal.d.ts"
+    },
+    "./store": {
+      "default": "./dist/store.js",
+      "development": "./src/store.js",
+      "types": "./types/store.d.ts"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    }
+  },
   "main": "src/index.js",
+  "files": [
+    "src",
+    "dist",
+    "types"
+  ],
+  "devDependencies": {
+    "@eslint/js": "^9.9.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@testing-library/dom": "^10.4.0",
+    "@types/node": "^22.5.0",
+    "@vitest/browser": "^2.0.5",
+    "@vitest/coverage-istanbul": "^2.0.5",
+    "eslint": "^9.9.1",
+    "globals": "^15.9.0",
+    "npm-run-all2": "^6.2.2",
+    "playwright": "^1.46.1",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.21.1",
+    "typescript": "^5.5.4",
+    "vite": "^5.4.2",
+    "vitest": "^2.0.5"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "all": "npm-run-all lint test build",
+    "build": "rimraf dist && rollup -c && gzip dist/index.min.js && ls -al dist && rimraf dist/index.min.*",
+    "example": "vite --open /example/",
+    "lint": "eslint",
+    "pretty": "prettier -w **/*.js",
+    "test": "vitest run --coverage",
+    "test:browser": "vitest --coverage",
+    "dev": "npm run test:browser",
+    "types": "tsc"
   }
-}
+}

package/src/context.js ADDED Viewed

@@ -0,0 +1,162 @@
+/**
+ * @see https://github.com/webcomponents-cg/community-protocols/blob/main/proposals/context.md
+ */
+import { createSignal, isSignalLike } from './signal.js'
+/**
+ * @typedef {import('./element.js').HostController} HostController
+ */
+/**
+ * @typedef {string|Symbol} Context
+ */
+const CONTEXT_REQUEST = 'context-request'
+/**
+ * @implements {HostController}
+ */
+export class ContextProvider {
+  /**
+   * @param {HTMLElement} host
+   * @param {Context} context
+   * @param {any} initialValue
+   */
+  constructor(host, context, initialValue) {
+    this.host = host
+    this.context = context
+    this.state = isSignalLike(initialValue)
+      ? initialValue
+      : createSignal(initialValue)
+    // @ts-expect-error
+    this.host.addController?.(this)
+  }
+  hostConnected() {
+    // @ts-expect-error
+    this.host.addEventListener(CONTEXT_REQUEST, this.onContextRequest)
+  }
+  hostDisconnected() {
+    // @ts-expect-error
+    this.host.removeEventListener(CONTEXT_REQUEST, this.onContextRequest)
+  }
+  /**
+   * @param {any} newValue
+   */
+  set value(newValue) {
+    this.state.value = newValue
+  }
+  /**
+   * @returns {any}
+   */
+  get value() {
+    return this.state.value
+  }
+  notify() {
+    this.state.notify()
+  }
+  /**
+   * @private
+   * @param {ContextRequestEvent} ev
+   */
+  onContextRequest = (ev) => {
+    if (ev.context !== this.context) {
+      // event has wrong context
+      return
+    }
+    ev.stopPropagation()
+    const unsubscribe = ev.subscribe
+      ? this.state.subscribe(ev.callback)
+      : undefined
+    ev.callback(this.value, unsubscribe)
+  }
+}
+export class ContextRequestEvent extends Event {
+  /**
+   * @param {Context} context
+   * @param {(value: any, unsubscribe?: () => void) => void} callback
+   * @param {boolean} [subscribe=false] subscribe to value changes
+   */
+  constructor(context, callback, subscribe) {
+    super(CONTEXT_REQUEST, { bubbles: true, composed: true })
+    this.context = context
+    this.callback = callback
+    this.subscribe = subscribe
+  }
+}
+/**
+ * @implements {HostController}
+ */
+export class ContextConsumer {
+  /**
+   * @param {HTMLElement} host
+   * @param {Context} context
+   * @param {object} [options]
+   * @param {boolean} [options.subscribe=false] subscribe to value changes
+   * @param {(any) => boolean} [options.validate] validation function
+   */
+  constructor(host, context, options) {
+    const { subscribe = false, validate = () => true } = options || {}
+    this.host = host
+    this.context = context
+    this.subscribe = !!subscribe
+    this.validate = validate
+    // initial value yet unknown
+    this.value = undefined
+    // unsubscribe function
+    this.unsubscribe = undefined
+    // add the controller in case of a MiElement otherwise call hostConnected()
+    // and hostDisconnected() from the host element
+    // @ts-expect-error
+    this.host.addController?.(this)
+  }
+  hostConnected() {
+    this.dispatchRequest()
+  }
+  hostDisconnected() {
+    if (this.unsubscribe) {
+      this.unsubscribe()
+      this.unsubscribe = undefined
+    }
+  }
+  dispatchRequest() {
+    this.host.dispatchEvent(
+      new ContextRequestEvent(
+        this.context,
+        this._callback.bind(this),
+        this.subscribe
+      )
+    )
+  }
+  _callback(value, unsubscribe) {
+    if (unsubscribe) {
+      if (!this.subscribe) {
+        // unsubscribe as we didn't ask for subscription
+        unsubscribe()
+      } else if (this.unsubscribe) {
+        if (this.unsubscribe !== unsubscribe) {
+          // looks there was a previous provider
+          this.unsubscribe()
+        }
+        this.unsubscribe = unsubscribe
+      }
+    }
+    if (!this.validate(value)) {
+      return
+    }
+    this.value = value
+    // @ts-expect-error
+    this.host.requestUpdate()
+  }
+}