pseudo-dom 0.6.0 → 0.7.0

package/dist/interfaces/PseudoNode.d.ts

@@ -1,179 +1,179 @@
-/**
- * @file Substitute for the DOM Node Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { PseudoEventTarget } from './PseudoEventTarget';
-import { PseudoNodeList } from '../classes/PseudoNodeList';
-import { LinkedTreeList } from 'collect-your-stuff/dist/collections/linked-tree-list/LinkedTreeList';
-import { PseudoDocument } from './PseudoDocument';
-import { PseudoElement } from './PseudoElement';
-import { PseudoDocumentFragment } from './PseudoDocumentFragment';
-/**
- * Simulate the behaviour of the Node Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments PseudoEventTarget
- * @property {string} name
- * @property {function} appendChild
- * @property {function} removeChild
- */
-export interface PseudoNode extends PseudoEventTarget {
-    /**
-     * Returns a string representing the base URL of the document containing the Node.
-     */
-    get baseURI(): Location | string;
-    /**
-     * Returns a live NodeList containing all the children of this node (including elements, text and comments). NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.
-     */
-    get childNodes(): PseudoNodeList | LinkedTreeList;
-    /**
-     * Returns a Node representing the first direct child node of the node, or null if the node has no child.
-     */
-    get firstChild(): PseudoNode | null;
-    /**
-     * A boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.
-     */
-    get isConnected(): boolean;
-    /**
-     * Returns a Node representing the last direct child node of the node, or null if the node has no child.
-     */
-    get lastChild(): PseudoNode | null;
-    /**
-     * Returns a Node representing the next node in the tree, or null if there isn't such node.
-     */
-    get nextSibling(): PseudoNode | null;
-    /**
-     * Returns a string containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.
-     */
-    get nodeName(): string;
-    /**
-     *  Returns an unsigned short representing the type of the node. Possible values are:
-     *  ________________________________________
-     * |  Name                         | Value |
-     * |----------------------------------------
-     * |  ELEMENT_NODE                 |   1   |
-     * |  ATTRIBUTE_NODE               |   2   |
-     * |  TEXT_NODE                    |   3   |
-     * |  CDATA_SECTION_NODE           |   4   |
-     * |  PROCESSING_INSTRUCTION_NODE  |   7   |
-     * |  COMMENT_NODE                 |   8   |
-     * |  DOCUMENT_NODE                |   9   |
-     * |  DOCUMENT_TYPE_NODE           |  10   |
-     * |  DOCUMENT_FRAGMENT_NODE       |  11   |
-     */
-    get nodeType(): number;
-    /**
-     * Returns the value of the current node.
-     */
-    get nodeValue(): string | null;
-    /**
-     * Sets the value of the current node.
-     * @param value
-     */
-    set nodeValue(value: string | null);
-    /**
-     * Returns the Document that this node belongs to. If the node is itself a document, returns null.
-     */
-    get ownerDocument(): PseudoDocument | null;
-    /**
-     * Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.
-     */
-    get parentNode(): PseudoNode | null;
-    /**
-     * Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.
-     */
-    get parentElement(): PseudoElement | null;
-    /**
-     * Returns a Node representing the previous node in the tree, or null if there isn't such node.
-     */
-    get previousSibling(): PseudoNode | null;
-    /**
-     * Returns the textual content of an element and all its descendants.
-     */
-    get textContent(): string | null;
-    /**
-     * Sets the textual content of an element and all its descendants.
-     * @param text
-     */
-    set textContent(text: string | null);
-    /**
-     * Adds the specified childNode argument as the last child to the current node. If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.
-     * @param {PseudoNode} childNode
-     * @returns {PseudoNode}
-     */
-    appendChild(childNode: PseudoNode): PseudoNode;
-    /**
-     * Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.
-     * @param deep
-     */
-    cloneNode(deep: boolean): PseudoNode;
-    /**
-     * Compares the position of the current node against another node in any other document.
-     * @param otherNode
-     */
-    compareDocumentPosition(otherNode: PseudoNode): number;
-    /**
-     * Returns true or false value indicating whether or not a node is a descendant of the calling node.
-     * @param otherNode
-     */
-    contains(otherNode: PseudoNode): boolean;
-    /**
-     * Returns the context object's root which optionally includes the shadow root if it is available.
-     * @param options
-     */
-    getRootNode(options: {
-        composed: boolean;
-    }): PseudoNode;
-    /**
-     * Returns a boolean value indicating whether the element has any child nodes.
-     */
-    hasChildNodes(): boolean;
-    /**
-     * Inserts a Node before the reference node as a child of a specified parent node.
-     * @param newNode
-     * @param referenceNode
-     */
-    insertBefore(newNode: PseudoNode, referenceNode: PseudoNode | null): PseudoNode | PseudoDocumentFragment;
-    /**
-     * Accepts a namespace URI as an argument and returns a boolean value with a value of true if the namespace is the default namespace on the given node or false if not.
-     * @param namespaceURI
-     */
-    isDefaultNamespace(namespaceURI: string | null): boolean;
-    /**
-     * Returns a boolean value which indicates whether two nodes are of the same type and all their defining data points match.
-     * @param otherNode
-     */
-    isEqualNode(otherNode: PseudoNode): boolean;
-    /**
-     * Returns a boolean value indicating whether the two nodes are the same (that is, they reference the same object).
-     * @param otherNode
-     */
-    isSameNode(otherNode: PseudoNode): boolean;
-    /**
-     * Returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.
-     * @param namespace
-     */
-    lookupPrefix(namespace: string): string | null;
-    /**
-     * Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.
-     * @param prefix
-     */
-    lookupNamespaceURI(prefix: string): string | null;
-    /**
-     * Clean up all the text nodes under this element (merge adjacent, remove empty).
-     */
-    normalize(): void;
-    /**
-     * Removes a child node from the current element, which must be a child of the current node.
-     * @param {PseudoNode} child
-     * @returns {PseudoNode}
-     */
-    removeChild(child: PseudoNode): PseudoNode;
-    /**
-     * Replaces one child Node of the current one with the second one given in parameter.
-     * @param newChild
-     * @param oldChild
-     */
-    replaceChild(newChild: PseudoNode, oldChild: PseudoNode): PseudoNode;
-}
+/**
+ * @file Substitute for the DOM Node Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { PseudoEventTarget } from './PseudoEventTarget';
+import { PseudoNodeList } from '../classes/PseudoNodeList';
+import { LinkedTreeList } from 'collect-your-stuff/dist/collections/linked-tree-list/LinkedTreeList';
+import { PseudoDocument } from './PseudoDocument';
+import { PseudoElement } from './PseudoElement';
+import { PseudoDocumentFragment } from './PseudoDocumentFragment';
+/**
+ * Simulate the behaviour of the Node Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments PseudoEventTarget
+ * @property {string} name
+ * @property {function} appendChild
+ * @property {function} removeChild
+ */
+export interface PseudoNode extends PseudoEventTarget {
+    /**
+     * Returns a string representing the base URL of the document containing the Node.
+     */
+    get baseURI(): Location | string;
+    /**
+     * Returns a live NodeList containing all the children of this node (including elements, text and comments). NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.
+     */
+    get childNodes(): PseudoNodeList | LinkedTreeList;
+    /**
+     * Returns a Node representing the first direct child node of the node, or null if the node has no child.
+     */
+    get firstChild(): PseudoNode | null;
+    /**
+     * A boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.
+     */
+    get isConnected(): boolean;
+    /**
+     * Returns a Node representing the last direct child node of the node, or null if the node has no child.
+     */
+    get lastChild(): PseudoNode | null;
+    /**
+     * Returns a Node representing the next node in the tree, or null if there isn't such node.
+     */
+    get nextSibling(): PseudoNode | null;
+    /**
+     * Returns a string containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.
+     */
+    get nodeName(): string;
+    /**
+     *  Returns an unsigned short representing the type of the node. Possible values are:
+     *  ________________________________________
+     * |  Name                         | Value |
+     * |----------------------------------------
+     * |  ELEMENT_NODE                 |   1   |
+     * |  ATTRIBUTE_NODE               |   2   |
+     * |  TEXT_NODE                    |   3   |
+     * |  CDATA_SECTION_NODE           |   4   |
+     * |  PROCESSING_INSTRUCTION_NODE  |   7   |
+     * |  COMMENT_NODE                 |   8   |
+     * |  DOCUMENT_NODE                |   9   |
+     * |  DOCUMENT_TYPE_NODE           |  10   |
+     * |  DOCUMENT_FRAGMENT_NODE       |  11   |
+     */
+    get nodeType(): number;
+    /**
+     * Returns the value of the current node.
+     */
+    get nodeValue(): string | null;
+    /**
+     * Sets the value of the current node.
+     * @param value
+     */
+    set nodeValue(value: string | null);
+    /**
+     * Returns the Document that this node belongs to. If the node is itself a document, returns null.
+     */
+    get ownerDocument(): PseudoDocument | null;
+    /**
+     * Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.
+     */
+    get parentNode(): PseudoNode | null;
+    /**
+     * Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.
+     */
+    get parentElement(): PseudoElement | null;
+    /**
+     * Returns a Node representing the previous node in the tree, or null if there isn't such node.
+     */
+    get previousSibling(): PseudoNode | null;
+    /**
+     * Returns the textual content of an element and all its descendants.
+     */
+    get textContent(): string | null;
+    /**
+     * Sets the textual content of an element and all its descendants.
+     * @param text
+     */
+    set textContent(text: string | null);
+    /**
+     * Adds the specified childNode argument as the last child to the current node. If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.
+     * @param {PseudoNode} childNode
+     * @returns {PseudoNode}
+     */
+    appendChild(childNode: PseudoNode): PseudoNode;
+    /**
+     * Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.
+     * @param deep
+     */
+    cloneNode(deep: boolean): PseudoNode;
+    /**
+     * Compares the position of the current node against another node in any other document.
+     * @param otherNode
+     */
+    compareDocumentPosition(otherNode: PseudoNode): number;
+    /**
+     * Returns true or false value indicating whether or not a node is a descendant of the calling node.
+     * @param otherNode
+     */
+    contains(otherNode: PseudoNode): boolean;
+    /**
+     * Returns the context object's root which optionally includes the shadow root if it is available.
+     * @param options
+     */
+    getRootNode(options: {
+        composed: boolean;
+    }): PseudoNode;
+    /**
+     * Returns a boolean value indicating whether the element has any child nodes.
+     */
+    hasChildNodes(): boolean;
+    /**
+     * Inserts a Node before the reference node as a child of a specified parent node.
+     * @param newNode
+     * @param referenceNode
+     */
+    insertBefore(newNode: PseudoNode, referenceNode: PseudoNode | null): PseudoNode | PseudoDocumentFragment;
+    /**
+     * Accepts a namespace URI as an argument and returns a boolean value with a value of true if the namespace is the default namespace on the given node or false if not.
+     * @param namespaceURI
+     */
+    isDefaultNamespace(namespaceURI: string | null): boolean;
+    /**
+     * Returns a boolean value which indicates whether two nodes are of the same type and all their defining data points match.
+     * @param otherNode
+     */
+    isEqualNode(otherNode: PseudoNode): boolean;
+    /**
+     * Returns a boolean value indicating whether the two nodes are the same (that is, they reference the same object).
+     * @param otherNode
+     */
+    isSameNode(otherNode: PseudoNode): boolean;
+    /**
+     * Returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.
+     * @param namespace
+     */
+    lookupPrefix(namespace: string): string | null;
+    /**
+     * Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.
+     * @param prefix
+     */
+    lookupNamespaceURI(prefix: string): string | null;
+    /**
+     * Clean up all the text nodes under this element (merge adjacent, remove empty).
+     */
+    normalize(): void;
+    /**
+     * Removes a child node from the current element, which must be a child of the current node.
+     * @param {PseudoNode} child
+     * @returns {PseudoNode}
+     */
+    removeChild(child: PseudoNode): PseudoNode;
+    /**
+     * Replaces one child Node of the current one with the second one given in parameter.
+     * @param newChild
+     * @param oldChild
+     */
+    replaceChild(newChild: PseudoNode, oldChild: PseudoNode): PseudoNode;
+}

package/dist/interfaces/PseudoNode.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoShadowRoot.d.ts

@@ -1,3 +1,3 @@
-import { PseudoDocumentFragment } from './PseudoDocumentFragment';
-export interface PseudoShadowRoot extends PseudoDocumentFragment {
-}
+import { PseudoDocumentFragment } from './PseudoDocumentFragment';
+export interface PseudoShadowRoot extends PseudoDocumentFragment {
+}

package/dist/interfaces/PseudoShadowRoot.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/main.d.ts

@@ -1,63 +1,63 @@
-/**
- * @file All of the Pseudo Dom Helper Objects functions for simulating parts of the DOM when running scripts in NodeJs.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { EventService as PseudoEvent } from './services/EventService';
-import PseudoEventTarget from './services/EventTargetService';
-import { NodeService as PseudoNode } from './services/NodeService';
-import { ElementService as PseudoElement } from './services/ElementService';
-import { HTMLElementService as PseudoHTMLElement } from './services/HTMLElementService';
-import PseudoHTMLDocument from './classes/PseudoHTMLDocument';
-import generateDocument from './factories/generateDocument';
-import createEvent from './factories/createEvent';
-import eventDefaults from './factories/eventDefaults';
-import { UIEventService as PseudoUIEvent } from './services/UIEventService';
-import { MouseEventService as PseudoMouseEvent } from './services/MouseEventService';
-import { PointerEventService as PseudoPointerEvent } from './services/PointerEventService';
-import { KeyboardEventService as PseudoKeyboardEvent } from './services/KeyboardEventService';
-import { FocusEventService as PseudoFocusEvent } from './services/FocusEventService';
-import { InputEventService as PseudoInputEvent } from './services/InputEventService';
-import { CustomEventService as PseudoCustomEvent } from './services/CustomEventService';
-import simulate from './simulate';
-import { TextService as PseudoText, CommentService as PseudoComment } from './services/NodeService';
-/**
- * All methods exported from this module are encapsulated within pseudoDom.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @typedef {Object} pseudoDom
- * @module pseudoDom/objects
- */
-declare const pseudoDom: {
-    generateDocument: (root: Window | any, context?: object) => Window | PseudoEventTarget;
-    createEvent: (type: string, init?: {
-        [option: string]: any;
-    }, { browser, trusted }?: import("./factories/createEvent").CreateEventOptions) => PseudoEvent;
-    eventDefaults: {
-        [type: string]: import("./factories/eventDefaults").EventDefinition;
-    };
-    simulate: {
-        click: (element: any, init?: {
-            [option: string]: any;
-        }) => boolean;
-        keyPress: (element: any, key: string, init?: {
-            [option: string]: any;
-        }) => boolean;
-    };
-    PseudoEvent: typeof PseudoEvent;
-    PseudoUIEvent: typeof PseudoUIEvent;
-    PseudoMouseEvent: typeof PseudoMouseEvent;
-    PseudoPointerEvent: typeof PseudoPointerEvent;
-    PseudoKeyboardEvent: typeof PseudoKeyboardEvent;
-    PseudoFocusEvent: typeof PseudoFocusEvent;
-    PseudoInputEvent: typeof PseudoInputEvent;
-    PseudoCustomEvent: typeof PseudoCustomEvent;
-    PseudoEventTarget: typeof PseudoEventTarget;
-    PseudoNode: typeof PseudoNode;
-    PseudoText: typeof PseudoText;
-    PseudoComment: typeof PseudoComment;
-    PseudoElement: typeof PseudoElement;
-    PseudoHTMLElement: typeof PseudoHTMLElement;
-    PseudoHTMLDocument: typeof PseudoHTMLDocument;
-};
-export { generateDocument, createEvent, eventDefaults, simulate, PseudoEvent, PseudoUIEvent, PseudoMouseEvent, PseudoPointerEvent, PseudoKeyboardEvent, PseudoFocusEvent, PseudoInputEvent, PseudoCustomEvent, PseudoEventTarget, PseudoNode, PseudoText, PseudoComment, PseudoElement, PseudoHTMLElement, PseudoHTMLDocument };
-export default pseudoDom;
+/**
+ * @file All of the Pseudo Dom Helper Objects functions for simulating parts of the DOM when running scripts in NodeJs.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { EventService as PseudoEvent } from './services/EventService';
+import PseudoEventTarget from './services/EventTargetService';
+import { NodeService as PseudoNode } from './services/NodeService';
+import { ElementService as PseudoElement } from './services/ElementService';
+import { HTMLElementService as PseudoHTMLElement } from './services/HTMLElementService';
+import PseudoHTMLDocument from './classes/PseudoHTMLDocument';
+import generateDocument from './factories/generateDocument';
+import createEvent from './factories/createEvent';
+import eventDefaults from './factories/eventDefaults';
+import { UIEventService as PseudoUIEvent } from './services/UIEventService';
+import { MouseEventService as PseudoMouseEvent } from './services/MouseEventService';
+import { PointerEventService as PseudoPointerEvent } from './services/PointerEventService';
+import { KeyboardEventService as PseudoKeyboardEvent } from './services/KeyboardEventService';
+import { FocusEventService as PseudoFocusEvent } from './services/FocusEventService';
+import { InputEventService as PseudoInputEvent } from './services/InputEventService';
+import { CustomEventService as PseudoCustomEvent } from './services/CustomEventService';
+import simulate from './simulate';
+import { TextService as PseudoText, CommentService as PseudoComment } from './services/NodeService';
+/**
+ * All methods exported from this module are encapsulated within pseudoDom.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @typedef {Object} pseudoDom
+ * @module pseudoDom/objects
+ */
+declare const pseudoDom: {
+    generateDocument: (root: Window | any, context?: object) => Window | PseudoEventTarget;
+    createEvent: (type: string, init?: {
+        [option: string]: any;
+    }, { browser, trusted }?: import("./factories/createEvent").CreateEventOptions) => PseudoEvent;
+    eventDefaults: {
+        [type: string]: import("./factories/eventDefaults").EventDefinition;
+    };
+    simulate: {
+        click: (element: any, init?: {
+            [option: string]: any;
+        }) => boolean;
+        keyPress: (element: any, key: string, init?: {
+            [option: string]: any;
+        }) => boolean;
+    };
+    PseudoEvent: typeof PseudoEvent;
+    PseudoUIEvent: typeof PseudoUIEvent;
+    PseudoMouseEvent: typeof PseudoMouseEvent;
+    PseudoPointerEvent: typeof PseudoPointerEvent;
+    PseudoKeyboardEvent: typeof PseudoKeyboardEvent;
+    PseudoFocusEvent: typeof PseudoFocusEvent;
+    PseudoInputEvent: typeof PseudoInputEvent;
+    PseudoCustomEvent: typeof PseudoCustomEvent;
+    PseudoEventTarget: typeof PseudoEventTarget;
+    PseudoNode: typeof PseudoNode;
+    PseudoText: typeof PseudoText;
+    PseudoComment: typeof PseudoComment;
+    PseudoElement: typeof PseudoElement;
+    PseudoHTMLElement: typeof PseudoHTMLElement;
+    PseudoHTMLDocument: typeof PseudoHTMLDocument;
+};
+export { generateDocument, createEvent, eventDefaults, simulate, PseudoEvent, PseudoUIEvent, PseudoMouseEvent, PseudoPointerEvent, PseudoKeyboardEvent, PseudoFocusEvent, PseudoInputEvent, PseudoCustomEvent, PseudoEventTarget, PseudoNode, PseudoText, PseudoComment, PseudoElement, PseudoHTMLElement, PseudoHTMLDocument };
+export default pseudoDom;