pseudo-dom 0.8.0 → 0.9.0

package/dist/services/DocumentService.js

@@ -1,95 +1,95 @@
-'use strict'
-
-const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
-  return mod && mod.__esModule
-    ? mod
-    : {
-        default: mod
-      }
-}
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.DocumentService = void 0
-const NodeService_1 = require('./NodeService')
-const HTMLElementService_1 = require('./HTMLElementService')
-const DocumentFragmentService_1 = require('./DocumentFragmentService')
-const getElementById_1 = __importDefault(require('../functions/getElementById'))
-/**
- * Simulate the behaviour of the Document Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
- */
-class DocumentService extends NodeService_1.NodeService {
-  get nodeName () {
-    return '#document'
-  }
-
-  get nodeType () {
-    return NodeService_1.NodeService.DOCUMENT_NODE
-  }
-
-  // A document has no text of its own, and setting it does nothing
-  get textContent () {
-    return null
-  }
-
-  set textContent (text) {}
-  /**
-   * The first element, in tree order, whose id matches the given value, or null when there is none.
-   * @param {string} id
-   * @returns {PseudoElement|null}
-   */
-  getElementById (id) {
-    return (0, getElementById_1.default)(this, id)
-  }
-
-  /**
-   * Make an element of the given type which belongs to this document but is not added anywhere until it is appended.
-   * @param {string} [tagName='div'] The type of element to create
-   * @returns {PseudoElement}
-   */
-  createElement (tagName = 'div') {
-    // Like the DOM, the new element is not added anywhere: it has no parent until it is appended
-    const element = new HTMLElementService_1.HTMLElementService({
-      tagName
-    })
-    element.ownerDocumentStore = this
-    return element
-  }
-
-  /**
-   * Make a text node which belongs to this document.
-   * @param {string} [data=''] The text
-   * @returns {TextService}
-   */
-  createTextNode (data = '') {
-    const text = new NodeService_1.TextService(data)
-    text.ownerDocumentStore = this
-    return text
-  }
-
-  /**
-   * Make a comment which belongs to this document.
-   * @param {string} [data=''] The comment
-   * @returns {CommentService}
-   */
-  createComment (data = '') {
-    const comment = new NodeService_1.CommentService(data)
-    comment.ownerDocumentStore = this
-    return comment
-  }
-
-  /**
-   * Make an empty document fragment which belongs to this document, a container for nodes which can be built up and
-   * then inserted in one go.
-   * @returns {DocumentFragmentService}
-   */
-  createDocumentFragment () {
-    const fragment = new DocumentFragmentService_1.DocumentFragmentService()
-    fragment.ownerDocumentStore = this
-    return fragment
-  }
-}
-exports.DocumentService = DocumentService
+'use strict'
+
+const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule
+    ? mod
+    : {
+        default: mod
+      }
+}
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.DocumentService = void 0
+const NodeService_1 = require('./NodeService')
+const HTMLElementService_1 = require('./HTMLElementService')
+const DocumentFragmentService_1 = require('./DocumentFragmentService')
+const getElementById_1 = __importDefault(require('../functions/getElementById'))
+/**
+ * Simulate the behaviour of the Document Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments NodeService
+ */
+class DocumentService extends NodeService_1.NodeService {
+  get nodeName () {
+    return '#document'
+  }
+
+  get nodeType () {
+    return NodeService_1.NodeService.DOCUMENT_NODE
+  }
+
+  // A document has no text of its own, and setting it does nothing
+  get textContent () {
+    return null
+  }
+
+  set textContent (text) {}
+  /**
+   * The first element, in tree order, whose id matches the given value, or null when there is none.
+   * @param {string} id
+   * @returns {PseudoElement|null}
+   */
+  getElementById (id) {
+    return (0, getElementById_1.default)(this, id)
+  }
+
+  /**
+   * Make an element of the given type which belongs to this document but is not added anywhere until it is appended.
+   * @param {string} [tagName='div'] The type of element to create
+   * @returns {PseudoElement}
+   */
+  createElement (tagName = 'div') {
+    // Like the DOM, the new element is not added anywhere: it has no parent until it is appended
+    const element = new HTMLElementService_1.HTMLElementService({
+      tagName
+    })
+    element.ownerDocumentStore = this
+    return element
+  }
+
+  /**
+   * Make a text node which belongs to this document.
+   * @param {string} [data=''] The text
+   * @returns {TextService}
+   */
+  createTextNode (data = '') {
+    const text = new NodeService_1.TextService(data)
+    text.ownerDocumentStore = this
+    return text
+  }
+
+  /**
+   * Make a comment which belongs to this document.
+   * @param {string} [data=''] The comment
+   * @returns {CommentService}
+   */
+  createComment (data = '') {
+    const comment = new NodeService_1.CommentService(data)
+    comment.ownerDocumentStore = this
+    return comment
+  }
+
+  /**
+   * Make an empty document fragment which belongs to this document, a container for nodes which can be built up and
+   * then inserted in one go.
+   * @returns {DocumentFragmentService}
+   */
+  createDocumentFragment () {
+    const fragment = new DocumentFragmentService_1.DocumentFragmentService()
+    fragment.ownerDocumentStore = this
+    return fragment
+  }
+}
+exports.DocumentService = DocumentService

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;
+}