@taybart/corvid 0.1.31 → 0.2.2

package/dist/dom.d.ts

@@ -1,3 +1,4 @@
+import * as style from './style';
 import { logger } from './utils';
 /****************
  *     DOM      *
@@ -7,6 +8,8 @@ import { logger } from './utils';
  * onDomContentLoaded callback
  */
 export declare function ready(cb: () => void): void;
+export declare function onFocus(cb: () => void): void;
+export declare function onBlur(cb: () => void): void;
 export declare function on(event: string, cb: (ev: Event) => void): () => void;
 export declare function onKey(key: string, cb: (ev: {
     ctrl: boolean;
@@ -15,50 +18,129 @@ export declare function onKey(key: string, cb: (ev: {
     shift: boolean;
 }) => void, verbose?: boolean): () => void;
 export declare function els(query: string, verbose?: boolean): el[];
+/**
+ * Define a custom element. Defining the same name with the same class again is a
+ * no-op rather than a `NotSupportedError`, so a double import or an HMR reload
+ * does not blow up; a *different* class on a taken name is still an error.
+ */
+export declare function registerElement(name: string, ctor: CustomElementConstructor): void;
 /*** element ***/
-type elOpts = {
+export type elOpts = {
     element?: HTMLElement;
     query?: string;
-    type?: string;
+    tag?: string;
     content?: any;
     class?: string | string[];
     style?: Object;
     id?: string;
-    parent?: HTMLElement | el;
+    parent?: string | HTMLElement | el;
     attrs?: Object;
 };
 export declare class el {
     el: HTMLElement | null;
     query: string;
     log: logger;
-    listeners: Record<string, Array<(ev: Event) => void>>;
+    listeners: Record<string, Array<{
+        cb: (ev: Event) => void;
+        options?: AddEventListenerOptions | boolean;
+    }>>;
     constructor(opts: HTMLElement | string | elOpts, verbose?: boolean);
     static query(query: string, verbose?: boolean): el;
     /*** dom manipulation ***/
-    value(update?: string): string | el;
+    value(update?: string): string | this;
     parent(parent: HTMLElement | el): this;
+    append(ch: HTMLElement | el | string): this;
     appendChild(ch: HTMLElement | el): this;
-    child(ch: HTMLElement | el): this;
-    prependChild(ch: HTMLElement | el): this;
+    child(ch: HTMLElement | el | string): this;
+    prepend(ch: HTMLElement | el | string): this;
+    prependChild(ch: HTMLElement | el | string): this;
     empty(): this;
     content(content: any, { text }?: {
         text?: boolean;
     }): this;
+    html(content: string): this;
     src(url: string): this;
+    attrs(attrs: Object): this;
+    attr(key: string, val: string): this;
+    removeAttr(key: string): this;
     /*** Style ***/
-    style(update: Object | string, stringify?: boolean): this | undefined;
+    style(update: Object | string, stringify?: boolean): this;
     hasClass(className: string): boolean;
     addClass(className: string | string[]): this;
     removeClass(className: string | string[]): this;
-    /*** Templates ***/
-    html(content: string): void;
-    render(vars?: {}): string;
-    appendTemplate(template: el, vars: any): void;
     /*** Events ***/
-    on(event: string, cb: (ev: Event) => void): this;
-    listen(event: string, cb: (ev: Event) => void): this;
+    on(event: string, cb: (ev: Event) => void, options?: AddEventListenerOptions | boolean): this;
+    listen(event: string, cb: (ev: Event) => void, options?: AddEventListenerOptions | boolean): this;
     removeListeners(event: string): this;
 }
+/**
+ * Create an element and return the node itself, not an `el` wrapper. Takes the
+ * same options as `el`, so a custom element comes back ready to talk to:
+ *
+ *   const form = create({ tag: 'x-search-form', parent: '#query-form' })
+ *   form.onSubmit(...)   // its own methods, no `.el` hop
+ *
+ * Wrap it later with `new el(node)` if you want the chainable helpers.
+ */
+export declare function create<T extends HTMLElement = HTMLElement>(opts: elOpts, verbose?: boolean): T;
+/*** component ***/
+/**
+ * Base class for custom elements. It handles registration, the component's
+ * stylesheet, and a mount hook
+ *   class SearchForm extends component {
+ *     static tag = 'x-search-form'
+ *     static styles = { input: { border: 'none' } }
+ *     input = create({ tag: 'input' })
+ *     mount() {
+ *       this.input.addEventListener('keydown', (e) => ...)
+ *       this.append(this.input)
+ *     }
+ *   }
+ *   SearchForm.register()
+ */
+export declare class component extends HTMLElement {
+    #private;
+    /** the name to register as; must contain a hyphen */
+    static tag: string;
+    /**
+     * Injected once at `register()`, scoped to the tag. Written *relative* to the
+     * component — no tag selector of its own — so it always matches whatever name
+     * the class actually registered under.
+     */
+    static styles: style.declarations | null;
+    /**
+     * Inject this component's styles and define it. Idempotent, so calling it
+     * twice (or after an HMR reload) is harmless.
+     * @param tag - overrides `static tag`
+     */
+    static register(tag?: string): void;
+    /**
+     * Called once, the first time the element is connected. Build the subtree and
+     * wire listeners here — a custom element cannot give itself children before
+     * it is connected, and `connectedCallback` runs again on every re-insertion.
+     */
+    mount(): void;
+    /**
+     * Called every time the element is disconnected. Listeners on this element
+     * and on children it owns go away with it; undo document/window listeners
+     * here, using the removers `on()` and `onKey()` hand back.
+     */
+    unmount(): void;
+    /**
+     * Called for every change to an attribute named in `static observedAttributes`,
+     * and never before `mount()` — changes that arrive earlier (anything set at
+     * creation or parse time, which the platform reports *before*
+     * `connectedCallback`) are held and delivered in order right after mount.
+     *
+     * Attributes are strings. For structured data use a property with a setter
+     * that re-renders; an object put through `setAttribute` becomes
+     * "[object Object]".
+     */
+    onAttr(_name: string, _value: string | null, _prev: string | null): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, prev: string | null, value: string | null): void;
+}
 /**
  * Get a template from a string
  * https://stackoverflow.com/a/41015840
@@ -70,6 +152,9 @@ export declare function interpolate(str: string, params: Object): string;
 declare const _default: {
     el: typeof el;
     els: typeof els;
+    create: typeof create;
+    component: typeof component;
+    registerElement: typeof registerElement;
     ready: typeof ready;
     on: typeof on;
     onKey: typeof onKey;

package/dist/dom.js

@@ -6,6 +6,97 @@ function render(style) {
     Object.entries(style).forEach(([k, v])=>s += `${toKebab(k)}:${v};`);
     return s;
 }
+function splitSelectors(selector) {
+    const out = [];
+    let depth = 0;
+    let quote = '';
+    let current = '';
+    for (const ch of selector){
+        if (quote) {
+            if (ch === quote) quote = '';
+        } else if ('"' === ch || "'" === ch) quote = ch;
+        else if ('(' === ch || '[' === ch) depth++;
+        else if (')' === ch || ']' === ch) depth--;
+        else if (',' === ch && 0 === depth) {
+            if (current.trim()) out.push(current.trim());
+            current = '';
+            continue;
+        }
+        current += ch;
+    }
+    if (current.trim()) out.push(current.trim());
+    return out;
+}
+function resolve(parents, selector) {
+    const out = [];
+    for (const parent of parents)for (const part of splitSelectors(selector))out.push(part.includes('&') ? part.replaceAll('&', parent) : `${parent} ${part}`);
+    return out;
+}
+function compile(parents, decls, indent = '') {
+    const blocks = [];
+    const props = [];
+    const nested = [];
+    for (const [k, v] of Object.entries(decls))if (null !== v && 'object' == typeof v) nested.push([
+        k,
+        v
+    ]);
+    else props.push(`${indent}  ${toKebab(k)}: ${v};`);
+    if (props.length) blocks.push(`${indent}${parents.join(', ')} {\n${props.join('\n')}\n${indent}}`);
+    for (const [selector, block] of nested){
+        if (selector.startsWith('@')) {
+            const inner = selector.startsWith('@keyframes') ? Object.entries(block).flatMap(([step, d])=>null !== d && 'object' == typeof d ? compile([
+                    step
+                ], d, `${indent}  `) : []) : compile(parents, block, `${indent}  `);
+            if (inner.length) blocks.push(`${indent}${selector} {\n${inner.join('\n')}\n${indent}}`);
+            continue;
+        }
+        blocks.push(...compile(resolve(parents, selector), block, indent));
+    }
+    return blocks;
+}
+function css(selector, style) {
+    return compile(splitSelectors(selector), style).join('\n');
+}
+function registry() {
+    const doc = document;
+    if (!doc.__corvidSheets) doc.__corvidSheets = new Map();
+    return doc.__corvidSheets;
+}
+function adoptable() {
+    return 'undefined' != typeof CSSStyleSheet && 'replaceSync' in CSSStyleSheet.prototype && 'undefined' != typeof Document && 'adoptedStyleSheets' in Document.prototype;
+}
+function styleTag(key) {
+    const tagged = Array.from(document.head.querySelectorAll('style[data-corvid]'));
+    for (const node of tagged)if (node.dataset.corvid === key) return node;
+    const node = document.createElement('style');
+    node.dataset.corvid = key;
+    document.head.appendChild(node);
+    return node;
+}
+function inject(selector, style, { key = selector } = {}) {
+    const rules = css(selector, style);
+    const sheets = registry();
+    const existing = sheets.get(key);
+    if (existing) {
+        if ('replaceSync' in existing) existing.replaceSync(rules);
+        else existing.textContent = rules;
+        return rules;
+    }
+    if (adoptable()) {
+        const sheet = new CSSStyleSheet();
+        sheet.replaceSync(rules);
+        document.adoptedStyleSheets = [
+            ...document.adoptedStyleSheets,
+            sheet
+        ];
+        sheets.set(key, sheet);
+        return rules;
+    }
+    const node = styleTag(key);
+    node.textContent = rules;
+    sheets.set(key, node);
+    return rules;
+}
 function _define_property(obj, key, value) {
     if (key in obj) Object.defineProperty(obj, key, {
         value: value,
@@ -61,6 +152,37 @@ class logger {
         });
     }
 }
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) throw new TypeError("Cannot initialize the same private elements twice on an object");
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) return descriptor.get.call(receiver);
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) descriptor.set.call(receiver, value);
+    else {
+        if (!descriptor.writable) throw new TypeError("attempted to set read only private field");
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) throw new TypeError("attempted to " + action + " private field on non-instance");
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
 function dom_define_property(obj, key, value) {
     if (key in obj) Object.defineProperty(obj, key, {
         value: value,
@@ -74,6 +196,16 @@ function dom_define_property(obj, key, value) {
 function ready(cb) {
     window.addEventListener('DOMContentLoaded', cb);
 }
+function onFocus(cb) {
+    window.addEventListener('focus', ()=>{
+        cb();
+    });
+}
+function onBlur(cb) {
+    window.addEventListener('blur', ()=>{
+        cb();
+    });
+}
 function on(event, cb) {
     document.addEventListener(event, cb);
     return ()=>{
@@ -100,6 +232,14 @@ function onKey(key, cb, verbose = false) {
 function els(query, verbose = false) {
     return Array.from(document.querySelectorAll(query)).map((n)=>new dom_el(n, verbose));
 }
+function registerElement(name, ctor) {
+    const existing = customElements.get(name);
+    if (existing) {
+        if (existing !== ctor) throw new Error(`custom element ${name} is already registered by ${existing.name}`);
+        return;
+    }
+    customElements.define(name, ctor);
+}
 class dom_el {
     static query(query, verbose = false) {
         return new dom_el(query, verbose);
@@ -122,21 +262,29 @@ class dom_el {
         parent.appendChild(this.el);
         return this;
     }
+    append(ch) {
+        return this.child(ch);
+    }
     appendChild(ch) {
         return this.child(ch);
     }
     child(ch) {
         if (!this.el) throw new Error(`no element from query: ${this.query}`);
-        if (ch instanceof dom_el) this.el.appendChild(ch.el);
+        if ('string' == typeof ch) this.el.append(ch);
+        else if (ch instanceof dom_el) this.el.appendChild(ch.el);
         else this.el.appendChild(ch);
         return this;
     }
-    prependChild(ch) {
+    prepend(ch) {
         if (!this.el) throw new Error(`no element from query: ${this.query}`);
-        if (ch instanceof dom_el) this.el.prepend(ch.el);
+        if ('string' == typeof ch) this.el.prepend(ch);
+        else if (ch instanceof dom_el) this.el.prepend(ch.el);
         else this.el.prepend(ch);
         return this;
     }
+    prependChild(ch) {
+        return this.prepend(ch);
+    }
     empty() {
         if (this.el) this.el.innerHTML = '';
         return this;
@@ -147,17 +295,37 @@ class dom_el {
         else this.el.innerHTML = content;
         return this;
     }
+    html(content) {
+        if (!this.el) throw new Error(`no element from query: ${this.query}`);
+        this.el.innerHTML = content;
+        return this;
+    }
     src(url) {
         if (this.el && 'src' in this.el) this.el.src = url;
         return this;
     }
+    attrs(attrs) {
+        if (!this.el) throw new Error(`no element from query: ${this.query}`);
+        for (const [k, v] of Object.entries(attrs))this.el.setAttribute(k, v);
+        return this;
+    }
+    attr(key, val) {
+        if (!this.el) throw new Error(`no element from query: ${this.query}`);
+        this.el.setAttribute(key, val);
+        return this;
+    }
+    removeAttr(key) {
+        if (!this.el) throw new Error(`no element from query: ${this.query}`);
+        this.el.removeAttribute(key);
+        return this;
+    }
     style(update, stringify = false) {
         if (this.el) {
             if ('string' == typeof update) this.el.style = update;
             else if ('object' == typeof update) {
                 if (!stringify) {
                     for (const [k, v] of Object.entries(update))this.el.style[k] = v;
-                    return;
+                    return this;
                 }
                 const s = render(update);
                 this.log.debug(`set style: ${this.el.style} -> ${s}`);
@@ -182,38 +350,23 @@ class dom_el {
         else for (const sc of className)this.el.classList.remove(sc);
         return this;
     }
-    html(content) {
-        if (!this.el) throw new Error(`no element from query: ${this.query}`);
-        this.el.innerHTML = content;
-    }
-    render(vars = {}) {
-        if (!this.el) throw new Error(`no element from query: ${this.query}`);
-        try {
-            return interpolate(this.el.innerHTML, vars);
-        } catch (e) {
-            throw new Error(`could not render template ${this.query}: ${e}`);
-        }
-    }
-    appendTemplate(template, vars) {
-        if (!this.el) throw new Error(`no element from query: ${this.query}`);
-        if (!template.el) throw new Error("template does not contain element");
-        const tmpl = template.render(vars);
-        this.el.insertAdjacentHTML('beforeend', tmpl);
-    }
-    on(event, cb) {
+    on(event, cb, options) {
         if (!this.el) throw new Error(`no element from query: ${this.query}`);
         if (!this.listeners[event]) this.listeners[event] = [];
-        this.listeners[event].push(cb);
-        this.el.addEventListener(event, cb);
+        this.listeners[event].push({
+            cb,
+            options
+        });
+        this.el.addEventListener(event, cb, options);
         return this;
     }
-    listen(event, cb) {
-        return this.on(event, cb);
+    listen(event, cb, options) {
+        return this.on(event, cb, options);
     }
     removeListeners(event) {
         if (!this.el) throw new Error(`no element from query: ${this.query}`);
         if (!this.listeners[event]) return this;
-        for (const cb of this.listeners[event])this.el.removeEventListener(event, cb);
+        for (const { cb, options } of this.listeners[event])this.el.removeEventListener(event, cb, options);
         this.listeners[event] = [];
         return this;
     }
@@ -233,7 +386,7 @@ class dom_el {
             this.el = opts;
             return;
         }
-        const { query, element, type, class: styleClass, style, id, content, parent, attrs } = opts;
+        const { query, element, tag, class: styleClass, style, id, content, parent, attrs } = opts;
         if (query) {
             this.log.debug(`using query: ${query}`);
             this.query = query;
@@ -242,11 +395,11 @@ class dom_el {
         } else if (element) {
             this.log.debug(`using existing element: ${element}`);
             this.el = element;
-        } else if (type) {
-            this.query = type;
-            this.log.debug(`creating element: ${type}`);
-            this.el = document.createElement(type);
-        } else throw new Error('no query or type provided');
+        } else if (tag) {
+            this.query = tag;
+            this.log.debug(`creating element: ${tag}`);
+            this.el = document.createElement(tag);
+        } else throw new Error('no query or tag provided');
         if (this.el) {
             if (id) {
                 this.log.debug(`setting id: ${id}`);
@@ -261,7 +414,12 @@ class dom_el {
             }
             if (parent) {
                 this.log.debug("adding to parent");
-                parent.appendChild(this.el);
+                let p = parent;
+                if ('string' == typeof parent) {
+                    this.log.debug(`parent query: ${parent}`);
+                    p = document.querySelector(parent);
+                }
+                p.appendChild(this.el);
             }
         }
         if (attrs) for (const [key, val] of Object.entries(attrs)){
@@ -270,6 +428,56 @@ class dom_el {
         }
     }
 }
+function create(opts, verbose = false) {
+    const node = new dom_el(opts, verbose).el;
+    if (!node) throw new Error(`could not create element: ${opts.tag ?? opts.query ?? '?'}`);
+    return node;
+}
+var _mounted = /*#__PURE__*/ new WeakMap(), _pendingAttrs = /*#__PURE__*/ new WeakMap();
+class component extends HTMLElement {
+    static register(tag) {
+        const name = tag ?? this.tag;
+        if (!name) throw new Error(`${this.name}: nothing to register as, set \`static tag = 'x-...'\``);
+        if (!name.includes('-')) throw new Error(`${this.name}: '${name}' is not a valid custom element name, it needs a hyphen`);
+        if (this.styles) inject(name, this.styles);
+        registerElement(name, this);
+    }
+    mount() {}
+    unmount() {}
+    onAttr(_name, _value, _prev) {}
+    connectedCallback() {
+        if (!_class_private_field_get(this, _mounted)) {
+            _class_private_field_set(this, _mounted, true);
+            this.mount();
+            const queued = _class_private_field_get(this, _pendingAttrs);
+            _class_private_field_set(this, _pendingAttrs, []);
+            for (const [name, value, prev] of queued)this.onAttr(name, value, prev);
+        }
+    }
+    disconnectedCallback() {
+        this.unmount();
+    }
+    attributeChangedCallback(name, prev, value) {
+        if (prev === value) return;
+        if (!_class_private_field_get(this, _mounted)) return void _class_private_field_get(this, _pendingAttrs).push([
+            name,
+            value,
+            prev
+        ]);
+        this.onAttr(name, value, prev);
+    }
+    constructor(...args){
+        super(...args), _class_private_field_init(this, _mounted, {
+            writable: true,
+            value: false
+        }), _class_private_field_init(this, _pendingAttrs, {
+            writable: true,
+            value: []
+        });
+    }
+}
+dom_define_property(component, "tag", '');
+dom_define_property(component, "styles", null);
 function interpolate(str, params) {
     let names = Object.keys(params).map((k)=>`_${k}`);
     let vals = Object.values(params);
@@ -278,8 +486,11 @@ function interpolate(str, params) {
 const dom = {
     el: dom_el,
     els,
+    create,
+    component,
+    registerElement,
     ready,
     on,
     onKey
 };
-export { dom as default, dom_el as el, els, interpolate, on, onKey, ready };
+export { component, create, dom as default, dom_el as el, els, interpolate, on, onBlur, onFocus, onKey, ready, registerElement };