pseudo-dom 0.7.0 → 0.9.0

package/dist/services/HTMLCollectionService.d.ts

@@ -1,54 +1,54 @@
-/**
- * @file Substitute for the DOM HTMLCollection Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { NodeService } from './NodeService';
-import { PseudoHTMLCollection } from '../interfaces/PseudoHTMLCollection';
-/**
- * Simulate the behaviour of the HTMLCollection Class when there is no DOM available: a live view of some of a node's
- * element descendants, recomputed each time it is used rather than kept in sync as they change.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- */
-export declare class HTMLCollectionService implements PseudoHTMLCollection {
-    private readonly owner;
-    private readonly predicate;
-    private readonly deep;
-    /**
-     * @param {NodeService} owner The node this is a live view of a part of
-     * @param {function(*): boolean} [predicate] Only elements which pass this are included (every element by default)
-     * @param {boolean} [deep=false] Include every matching descendant (true, like getElementsByTagName), not just the
-     * direct element children (false, like Element.children)
-     * @constructor
-     */
-    constructor(owner: NodeService, predicate?: (element: any) => boolean, deep?: boolean);
-    /**
-     * The current elements the collection holds, in tree order.
-     * @returns {Array<PseudoNode>}
-     */
-    private elements;
-    /**
-     * How many elements are in the collection right now.
-     * @returns {number}
-     */
-    get length(): number;
-    /**
-     * The element at the given index, or null when there is none.
-     * @param {number} index
-     * @returns {*}
-     */
-    item(index: number): any | null;
-    /**
-     * The element whose id, or (failing that) whose name attribute, is the given value, or null when there is none.
-     * @param {string} name
-     * @returns {*}
-     */
-    namedItem(name: string): any | null;
-    /**
-     * Iterate over the current elements.
-     * @returns {Iterator}
-     */
-    [Symbol.iterator](): Iterator<any>;
-}
-export default HTMLCollectionService;
+/**
+ * @file Substitute for the DOM HTMLCollection Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { NodeService } from './NodeService';
+import { PseudoHTMLCollection } from '../interfaces/PseudoHTMLCollection';
+/**
+ * Simulate the behaviour of the HTMLCollection Class when there is no DOM available: a live view of some of a node's
+ * element descendants, recomputed each time it is used rather than kept in sync as they change.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ */
+export declare class HTMLCollectionService implements PseudoHTMLCollection {
+    private readonly owner;
+    private readonly predicate;
+    private readonly deep;
+    /**
+     * @param {NodeService} owner The node this is a live view of a part of
+     * @param {function(*): boolean} [predicate] Only elements which pass this are included (every element by default)
+     * @param {boolean} [deep=false] Include every matching descendant (true, like getElementsByTagName), not just the
+     * direct element children (false, like Element.children)
+     * @constructor
+     */
+    constructor(owner: NodeService, predicate?: (element: any) => boolean, deep?: boolean);
+    /**
+     * The current elements the collection holds, in tree order.
+     * @returns {Array<PseudoNode>}
+     */
+    private elements;
+    /**
+     * How many elements are in the collection right now.
+     * @returns {number}
+     */
+    get length(): number;
+    /**
+     * The element at the given index, or null when there is none.
+     * @param {number} index
+     * @returns {*}
+     */
+    item(index: number): any | null;
+    /**
+     * The element whose id, or (failing that) whose name attribute, is the given value, or null when there is none.
+     * @param {string} name
+     * @returns {*}
+     */
+    namedItem(name: string): any | null;
+    /**
+     * Iterate over the current elements.
+     * @returns {Iterator}
+     */
+    [Symbol.iterator](): Iterator<any>;
+}
+export default HTMLCollectionService;

package/dist/services/HTMLCollectionService.js

@@ -1,92 +1,92 @@
-'use strict'
-
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.find.js')
-require('core-js/modules/esnext.iterator.for-each.js')
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.HTMLCollectionService = void 0
-/**
- * @file Substitute for the DOM HTMLCollection Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-const NodeService_1 = require('./NodeService')
-/**
- * Simulate the behaviour of the HTMLCollection Class when there is no DOM available: a live view of some of a node's
- * element descendants, recomputed each time it is used rather than kept in sync as they change.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- */
-class HTMLCollectionService {
-  /**
-   * @param {NodeService} owner The node this is a live view of a part of
-   * @param {function(*): boolean} [predicate] Only elements which pass this are included (every element by default)
-   * @param {boolean} [deep=false] Include every matching descendant (true, like getElementsByTagName), not just the
-   * direct element children (false, like Element.children)
-   * @constructor
-   */
-  constructor (owner, predicate = () => true, deep = false) {
-    this.owner = owner
-    this.predicate = predicate
-    this.deep = deep
-  }
-
-  /**
-   * The current elements the collection holds, in tree order.
-   * @returns {Array<PseudoNode>}
-   */
-  elements () {
-    const results = []
-    const visit = node => {
-      Array.from(node.childNodes).forEach(child => {
-        if (child.nodeType === NodeService_1.NodeService.ELEMENT_NODE && this.predicate(child)) {
-          results.push(child)
-        }
-        if (this.deep && child.nodeType === NodeService_1.NodeService.ELEMENT_NODE) {
-          visit(child)
-        }
-      })
-    }
-    visit(this.owner)
-    return results
-  }
-
-  /**
-   * How many elements are in the collection right now.
-   * @returns {number}
-   */
-  get length () {
-    return this.elements().length
-  }
-
-  /**
-   * The element at the given index, or null when there is none.
-   * @param {number} index
-   * @returns {*}
-   */
-  item (index) {
-    return this.elements()[index] || null
-  }
-
-  /**
-   * The element whose id, or (failing that) whose name attribute, is the given value, or null when there is none.
-   * @param {string} name
-   * @returns {*}
-   */
-  namedItem (name) {
-    const elements = this.elements()
-    return elements.find(element => element.id === name) || elements.find(element => element.getAttribute('name') === name) || null
-  }
-
-  /**
-   * Iterate over the current elements.
-   * @returns {Iterator}
-   */
-  [Symbol.iterator] () {
-    return this.elements()[Symbol.iterator]()
-  }
-}
-exports.HTMLCollectionService = HTMLCollectionService
-exports.default = HTMLCollectionService
+'use strict'
+
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.find.js')
+require('core-js/modules/esnext.iterator.for-each.js')
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.HTMLCollectionService = void 0
+/**
+ * @file Substitute for the DOM HTMLCollection Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+const NodeService_1 = require('./NodeService')
+/**
+ * Simulate the behaviour of the HTMLCollection Class when there is no DOM available: a live view of some of a node's
+ * element descendants, recomputed each time it is used rather than kept in sync as they change.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ */
+class HTMLCollectionService {
+  /**
+   * @param {NodeService} owner The node this is a live view of a part of
+   * @param {function(*): boolean} [predicate] Only elements which pass this are included (every element by default)
+   * @param {boolean} [deep=false] Include every matching descendant (true, like getElementsByTagName), not just the
+   * direct element children (false, like Element.children)
+   * @constructor
+   */
+  constructor (owner, predicate = () => true, deep = false) {
+    this.owner = owner
+    this.predicate = predicate
+    this.deep = deep
+  }
+
+  /**
+   * The current elements the collection holds, in tree order.
+   * @returns {Array<PseudoNode>}
+   */
+  elements () {
+    const results = []
+    const visit = node => {
+      Array.from(node.childNodes).forEach(child => {
+        if (child.nodeType === NodeService_1.NodeService.ELEMENT_NODE && this.predicate(child)) {
+          results.push(child)
+        }
+        if (this.deep && child.nodeType === NodeService_1.NodeService.ELEMENT_NODE) {
+          visit(child)
+        }
+      })
+    }
+    visit(this.owner)
+    return results
+  }
+
+  /**
+   * How many elements are in the collection right now.
+   * @returns {number}
+   */
+  get length () {
+    return this.elements().length
+  }
+
+  /**
+   * The element at the given index, or null when there is none.
+   * @param {number} index
+   * @returns {*}
+   */
+  item (index) {
+    return this.elements()[index] || null
+  }
+
+  /**
+   * The element whose id, or (failing that) whose name attribute, is the given value, or null when there is none.
+   * @param {string} name
+   * @returns {*}
+   */
+  namedItem (name) {
+    const elements = this.elements()
+    return elements.find(element => element.id === name) || elements.find(element => element.getAttribute('name') === name) || null
+  }
+
+  /**
+   * Iterate over the current elements.
+   * @returns {Iterator}
+   */
+  [Symbol.iterator] () {
+    return this.elements()[Symbol.iterator]()
+  }
+}
+exports.HTMLCollectionService = HTMLCollectionService
+exports.default = HTMLCollectionService

package/dist/services/HTMLElementService.d.ts

@@ -1,57 +1,87 @@
-/**
- * @file Substitute for the DOM HTMLElement Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { PseudoHTMLElement } from '../interfaces/PseudoHTMLElement';
-import { PseudoNode } from '../interfaces/PseudoNode';
-import { ElementService } from './ElementService';
-/**
- * Simulate the behaviour of the HTMLElement Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments PseudoElement
- * @property {boolean} hidden - State of whether element is visible
- * @property {number} offsetHeight - The height of the element as offset by the parent element
- * @property {number} offsetLeft - The position of the left side of the element based on the parent element
- * @property {PseudoHTMLElement} offsetParent - A reference to the closest positioned parent element
- * @property {number} offsetTop - The position of the top side of the element based on the parent element
- * @property {number} offsetWidth - The width of the element as offset by the parent element
- * @property {Object} style - A container to define all applied inline-styles
- * @property {string} title - The title attribute which affects the text visible on hover
- */
-export declare class HTMLElementService extends ElementService implements Partial<PseudoHTMLElement> {
-    /**
-     * Simulate the HTMLElement object when the Dom is not available
-     * @param {Object} [elementOptions={}]
-     * @param {string} [elementOptions.tagName='']
-     * @param {PseudoNode|Object} [elementOptions.parent={}]
-     * @param {Array} [elementOptions.children=[]]
-     * @constructor
-     */
-    constructor({ tagName, parent, children }?: {
-        tagName?: string;
-        parent?: PseudoNode | null;
-        children?: Array<any>;
-    });
-    /**
-     * Whether this element can have the focus: form controls and links which are not disabled, and anything with a tabindex.
-     * @returns {boolean}
-     */
-    get canFocus(): boolean;
-    /**
-     * Click the element: a click event is sent to it, which bubbles and can be cancelled, like one from a user but a
-     * script made it (so it is not trusted). A disabled element does nothing.
-     */
-    click(): void;
-    /**
-     * Give the element the focus. The element which had it gets blur then focusout, and this one gets focus then
-     * focusin (blur and focus do not bubble, focusin and focusout do). Nothing happens when the element cannot have the
-     * focus or already has it.
-     */
-    focus(): void;
-    /**
-     * Take the focus away from the element, when it has it: it gets blur then focusout.
-     */
-    blur(): void;
-}
+/**
+ * @file Substitute for the DOM HTMLElement Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { PseudoHTMLElement } from '../interfaces/PseudoHTMLElement';
+import { PseudoNode } from '../interfaces/PseudoNode';
+import { NodeService } from './NodeService';
+import { ElementService } from './ElementService';
+import { CSSStyleDeclarationService } from './CSSStyleDeclarationService';
+/**
+ * Simulate the behaviour of the HTMLElement Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments PseudoElement
+ * @property {boolean} hidden - State of whether element is visible
+ * @property {number} offsetHeight - The height of the element as offset by the parent element
+ * @property {number} offsetLeft - The position of the left side of the element based on the parent element
+ * @property {PseudoHTMLElement} offsetParent - A reference to the closest positioned parent element
+ * @property {number} offsetTop - The position of the top side of the element based on the parent element
+ * @property {number} offsetWidth - The width of the element as offset by the parent element
+ * @property {CSSStyleDeclarationService} style - The element's inline styles, live and settable per property
+ * @property {Object.<string, string>} dataset - The element's data-* attributes, live, under their camelCase names
+ * @property {string} title - The title attribute which affects the text visible on hover
+ */
+export declare class HTMLElementService extends ElementService implements Partial<PseudoHTMLElement> {
+    private readonly styleDeclaration;
+    private readonly datasetProxy;
+    /**
+     * Simulate the HTMLElement object when the Dom is not available
+     * @param {Object} [elementOptions={}]
+     * @param {string} [elementOptions.tagName='']
+     * @param {PseudoNode|Object} [elementOptions.parent={}]
+     * @param {Array} [elementOptions.children=[]]
+     * @constructor
+     */
+    constructor({ tagName, parent, children }?: {
+        tagName?: string;
+        parent?: PseudoNode | null;
+        children?: Array<any>;
+    });
+    /**
+     * The element's inline styles: a live CSSStyleDeclaration-like object, so both style.setProperty('color', 'red')
+     * and style.color = 'red' work.
+     * @returns {CSSStyleDeclarationService}
+     */
+    get style(): CSSStyleDeclarationService;
+    /**
+     * The element's data-* attributes, live, under their camelCase names (data-foo-bar <-> dataset.fooBar). Backed
+     * directly by getAttribute / setAttribute, so it is never out of sync with the attributes themselves.
+     * @returns {Object.<string, string>}
+     */
+    get dataset(): {
+        [key: string]: string;
+    };
+    /**
+     * Style is not attribute-backed like most properties (see the constructor), so cloneNode needs its own copy of it.
+     * @returns {NodeService}
+     */
+    protected cloneShallow(): NodeService;
+    /**
+     * Style is not attribute-backed like most properties, so isEqualNode needs to compare it separately too.
+     * @param {NodeService} other The node to compare with
+     * @returns {boolean}
+     */
+    protected equalsShallow(other: NodeService): boolean;
+    /**
+     * Whether this element can have the focus: form controls and links which are not disabled, and anything with a tabindex.
+     * @returns {boolean}
+     */
+    get canFocus(): boolean;
+    /**
+     * Click the element: a click event is sent to it, which bubbles and can be cancelled, like one from a user but a
+     * script made it (so it is not trusted). A disabled element does nothing.
+     */
+    click(): void;
+    /**
+     * Give the element the focus. The element which had it gets blur then focusout, and this one gets focus then
+     * focusin (blur and focus do not bubble, focusin and focusout do). Nothing happens when the element cannot have the
+     * focus or already has it.
+     */
+    focus(): void;
+    /**
+     * Take the focus away from the element, when it has it: it gets blur then focusout.
+     */
+    blur(): void;
+}