pseudo-dom 0.12.0 → 0.15.0

package/dist/factories/generateDocument.js

@@ -1,70 +1,82 @@
-'use strict'
-
-const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
-  return mod && mod.__esModule
-    ? mod
-    : {
-        default: mod
-      }
-}
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-const EventTargetService_1 = __importDefault(require('../services/EventTargetService'))
-const NodeService_1 = require('../services/NodeService')
-const ElementService_1 = require('../services/ElementService')
-const HTMLElementService_1 = require('../services/HTMLElementService')
-const PseudoHTMLDocument_1 = __importDefault(require('../classes/PseudoHTMLDocument'))
-/**
- * Construct the Pseudo Dom to provide access to Dom objects which are otherwise not available outside the browser
- * context.
- * @function generateDocument
- * @param {Object} root
- * @param {Object} context
- * @returns {Window|PseudoEventTarget}
- */
-const generateDocument = (root, context = {}) => {
-  /**
-   *
-   * @type {Window|PseudoEventTarget}
-   */
-  const newWindow = typeof root.document === 'undefined' ? root : new EventTargetService_1.default()
-  /**
-   * @type {Node|PseudoNode}
-   */
-  const Node = root.Node || new NodeService_1.NodeService()
-  if (typeof newWindow.Node === 'undefined') {
-    newWindow.Node = Node
-  }
-  /**
-   *
-   * @type {Element|PseudoElement}
-   */
-  const Element = root.Element || new ElementService_1.ElementService()
-  if (typeof newWindow.Element === 'undefined') {
-    newWindow.Element = Element
-  }
-  /**
-   * Create an instance of HTMLElement if not available
-   * @type {HTMLElement|PseudoHTMLElement}
-   */
-  const HTMLElement = root.HTMLElement || new HTMLElementService_1.HTMLElementService()
-  if (typeof newWindow.HTMLElement === 'undefined') {
-    newWindow.HTMLElement = HTMLElement
-  }
-  /**
-   * Define document when not available
-   * @type {Document|PseudoHTMLDocument}
-   */
-  const document = root.document || new PseudoHTMLDocument_1.default()
-  if (typeof newWindow.document === 'undefined') {
-    newWindow.document = document
-  }
-  // When there was no real document, newWindow is root itself (see above), so every assignment above already
-  // mutated it directly. If context is also that same object (root and context given as one and the same, as
-  // installGlobal does) merging is already done - doing it again would be Object.assign(target, target), which
-  // throws on any getter-only own property target already has (globalThis.crypto, in Node).
-  const mergeInto = context || root
-  return newWindow === mergeInto ? newWindow : Object.assign(mergeInto, newWindow)
-}
-exports.default = generateDocument
+'use strict'
+
+const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule
+    ? mod
+    : {
+        default: mod
+      }
+}
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+const EventTargetService_1 = __importDefault(require('../services/EventTargetService'))
+const NodeService_1 = require('../services/NodeService')
+const ElementService_1 = require('../services/ElementService')
+const HTMLElementService_1 = require('../services/HTMLElementService')
+const PseudoHTMLDocument_1 = __importDefault(require('../classes/PseudoHTMLDocument'))
+/**
+ * Construct the Pseudo Dom to provide access to Dom objects which are otherwise not available outside the browser
+ * context.
+ * @function generateDocument
+ * @param {Object} root
+ * @param {Object} context
+ * @returns {Window|PseudoEventTarget}
+ */
+const generateDocument = (root, context = {}) => {
+  /**
+   *
+   * @type {Window|PseudoEventTarget}
+   */
+  const newWindow = typeof root.document === 'undefined' ? root : new EventTargetService_1.default()
+  /**
+   * The Node class itself (matching the DOM's window.Node), not an instance - the right-hand side of `instanceof`
+   * must be a constructor, so `x instanceof Node` needs this, not `new PseudoNode()`.
+   * @type {Function}
+   */
+  const Node = root.Node || NodeService_1.NodeService
+  if (typeof newWindow.Node === 'undefined') {
+    newWindow.Node = Node
+  }
+  /**
+   * The Element class itself, for the same reason as Node.
+   * @type {Function}
+   */
+  const Element = root.Element || ElementService_1.ElementService
+  if (typeof newWindow.Element === 'undefined') {
+    newWindow.Element = Element
+  }
+  /**
+   * The HTMLElement class itself, for the same reason as Node.
+   * @type {Function}
+   */
+  const HTMLElement = root.HTMLElement || HTMLElementService_1.HTMLElementService
+  if (typeof newWindow.HTMLElement === 'undefined') {
+    newWindow.HTMLElement = HTMLElement
+  }
+  /**
+   * The HTMLDocument class itself, for the same reason as Node (so `document instanceof HTMLDocument`, a common
+   * real-DOM-detection check, works).
+   * @type {Function}
+   */
+  const HTMLDocument = root.HTMLDocument || PseudoHTMLDocument_1.default
+  if (typeof newWindow.HTMLDocument === 'undefined') {
+    newWindow.HTMLDocument = HTMLDocument
+  }
+  /**
+   * Define document when not available - a real instance, unlike the classes above (window.document IS an object,
+   * not a constructor).
+   * @type {Document|PseudoHTMLDocument}
+   */
+  const document = root.document || new PseudoHTMLDocument_1.default()
+  if (typeof newWindow.document === 'undefined') {
+    newWindow.document = document
+  }
+  // When there was no real document, newWindow is root itself (see above), so every assignment above already
+  // mutated it directly. If context is also that same object (root and context given as one and the same, as
+  // installGlobal does) merging is already done - doing it again would be Object.assign(target, target), which
+  // throws on any getter-only own property target already has (globalThis.crypto, in Node).
+  const mergeInto = context || root
+  return newWindow === mergeInto ? newWindow : Object.assign(mergeInto, newWindow)
+}
+exports.default = generateDocument

package/dist/factories/generateDocument.min.js

@@ -1 +1 @@
-"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const EventTargetService_1=__importDefault(require("../services/EventTargetService")),NodeService_1=require("../services/NodeService"),ElementService_1=require("../services/ElementService"),HTMLElementService_1=require("../services/HTMLElementService"),PseudoHTMLDocument_1=__importDefault(require("../classes/PseudoHTMLDocument")),generateDocument=(e,t={})=>{const r=void 0===e.document?e:new EventTargetService_1.default,n=e.Node||new NodeService_1.NodeService;void 0===r.Node&&(r.Node=n);const c=e.Element||new ElementService_1.ElementService;void 0===r.Element&&(r.Element=c);const o=e.HTMLElement||new HTMLElementService_1.HTMLElementService;void 0===r.HTMLElement&&(r.HTMLElement=o);const i=e.document||new PseudoHTMLDocument_1.default;void 0===r.document&&(r.document=i);const u=t||e;return r===u?r:Object.assign(u,r)};exports.default=generateDocument;
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const EventTargetService_1=__importDefault(require("../services/EventTargetService")),NodeService_1=require("../services/NodeService"),ElementService_1=require("../services/ElementService"),HTMLElementService_1=require("../services/HTMLElementService"),PseudoHTMLDocument_1=__importDefault(require("../classes/PseudoHTMLDocument")),generateDocument=(e,t={})=>{const n=void 0===e.document?e:new EventTargetService_1.default,r=e.Node||NodeService_1.NodeService;void 0===n.Node&&(n.Node=r);const o=e.Element||ElementService_1.ElementService;void 0===n.Element&&(n.Element=o);const c=e.HTMLElement||HTMLElementService_1.HTMLElementService;void 0===n.HTMLElement&&(n.HTMLElement=c);const i=e.HTMLDocument||PseudoHTMLDocument_1.default;void 0===n.HTMLDocument&&(n.HTMLDocument=i);const u=e.document||new PseudoHTMLDocument_1.default;void 0===n.document&&(n.document=u);const m=t||e;return n===m?n:Object.assign(m,n)};exports.default=generateDocument;

package/dist/factories/installGlobal.d.ts

@@ -1,14 +1,15 @@
-/**
- * When there is no real DOM already available (a real browser, or a jsdom-based test environment - isBrowser is
- * true for both, since jsdom's window has a document too, and a jsdom document should never be overwritten, real
- * DOM behaviour is always closer to the real thing), populate the given global-like target with document / Node /
- * Element / HTMLElement, generated by generateDocument, so code written against a real DOM's globals works as-is.
- * Does nothing when a real DOM is already there, matching generateDocument's own only-fill-what-is-missing
- * behaviour - calling this is always safe, in any environment.
- * @memberOf module:factories
- * @param {*} [target] The object to add document / Node / Element / HTMLElement onto - defaults to globalThis, so
- * bare `document`, `Node`, etc. resolve from anywhere once this has run
- * @returns {*} The same target, for convenience
- */
-declare const installGlobal: (target?: any) => any;
-export default installGlobal;
+/**
+ * When there is no real DOM already available (a real browser, or a jsdom-based test environment - isBrowser is
+ * true for both, since jsdom's window has a document too, and a jsdom document should never be overwritten, real
+ * DOM behaviour is always closer to the real thing), populate the given global-like target with document / Node /
+ * Element / HTMLElement / HTMLDocument, generated by generateDocument, plus window (a self-reference, matching a
+ * real browser's global scope - some code checks for a bare `window` before falling back to `global`), so code
+ * written against a real DOM's globals works as-is. Does nothing when a real DOM is already there, matching
+ * generateDocument's own only-fill-what-is-missing behaviour - calling this is always safe, in any environment.
+ * @memberOf module:factories
+ * @param {*} [target] The object to add document / Node / Element / HTMLElement / window onto - defaults to
+ * globalThis, so bare `document`, `Node`, `window`, etc. resolve from anywhere once this has run
+ * @returns {*} The same target, for convenience
+ */
+declare const installGlobal: (target?: any) => any;
+export default installGlobal;

package/dist/factories/installGlobal.js

@@ -1,40 +1,44 @@
-'use strict'
-
-const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
-  return mod && mod.__esModule
-    ? mod
-    : {
-        default: mod
-      }
-}
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-/**
- * @file Makes pseudo-dom a drop-in swap for a real DOM: code written against bare globals (document.createElement,
- * new Node(), ...) works unmodified, in the browser or in Node, without an if (typeof document === 'undefined')
- * check at every call site.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-const browser_or_node_1 = require('browser-or-node')
-const generateDocument_1 = __importDefault(require('./generateDocument'))
-/**
- * When there is no real DOM already available (a real browser, or a jsdom-based test environment - isBrowser is
- * true for both, since jsdom's window has a document too, and a jsdom document should never be overwritten, real
- * DOM behaviour is always closer to the real thing), populate the given global-like target with document / Node /
- * Element / HTMLElement, generated by generateDocument, so code written against a real DOM's globals works as-is.
- * Does nothing when a real DOM is already there, matching generateDocument's own only-fill-what-is-missing
- * behaviour - calling this is always safe, in any environment.
- * @memberOf module:factories
- * @param {*} [target] The object to add document / Node / Element / HTMLElement onto - defaults to globalThis, so
- * bare `document`, `Node`, etc. resolve from anywhere once this has run
- * @returns {*} The same target, for convenience
- */
-const installGlobal = (target = typeof globalThis !== 'undefined' ? globalThis : {}) => {
-  if (!browser_or_node_1.isBrowser) {
-    (0, generateDocument_1.default)(target, target)
-  }
-  return target
-}
-exports.default = installGlobal
+'use strict'
+
+const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule
+    ? mod
+    : {
+        default: mod
+      }
+}
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+/**
+ * @file Makes pseudo-dom a drop-in swap for a real DOM: code written against bare globals (document.createElement,
+ * new Node(), ...) works unmodified, in the browser or in Node, without an if (typeof document === 'undefined')
+ * check at every call site.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+const browser_or_node_1 = require('browser-or-node')
+const generateDocument_1 = __importDefault(require('./generateDocument'))
+/**
+ * When there is no real DOM already available (a real browser, or a jsdom-based test environment - isBrowser is
+ * true for both, since jsdom's window has a document too, and a jsdom document should never be overwritten, real
+ * DOM behaviour is always closer to the real thing), populate the given global-like target with document / Node /
+ * Element / HTMLElement / HTMLDocument, generated by generateDocument, plus window (a self-reference, matching a
+ * real browser's global scope - some code checks for a bare `window` before falling back to `global`), so code
+ * written against a real DOM's globals works as-is. Does nothing when a real DOM is already there, matching
+ * generateDocument's own only-fill-what-is-missing behaviour - calling this is always safe, in any environment.
+ * @memberOf module:factories
+ * @param {*} [target] The object to add document / Node / Element / HTMLElement / window onto - defaults to
+ * globalThis, so bare `document`, `Node`, `window`, etc. resolve from anywhere once this has run
+ * @returns {*} The same target, for convenience
+ */
+const installGlobal = (target = typeof globalThis !== 'undefined' ? globalThis : {}) => {
+  if (!browser_or_node_1.isBrowser) {
+    (0, generateDocument_1.default)(target, target)
+    if (typeof target.window === 'undefined') {
+      target.window = target
+    }
+  }
+  return target
+}
+exports.default = installGlobal

package/dist/factories/installGlobal.min.js

@@ -1 +1 @@
-"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const browser_or_node_1=require("browser-or-node"),generateDocument_1=__importDefault(require("./generateDocument")),installGlobal=(e=("undefined"!=typeof globalThis?globalThis:{}))=>(browser_or_node_1.isBrowser||(0,generateDocument_1.default)(e,e),e);exports.default=installGlobal;
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const browser_or_node_1=require("browser-or-node"),generateDocument_1=__importDefault(require("./generateDocument")),installGlobal=(e=("undefined"!=typeof globalThis?globalThis:{}))=>(browser_or_node_1.isBrowser||((0,generateDocument_1.default)(e,e),void 0===e.window&&(e.window=e)),e);exports.default=installGlobal;

package/dist/factories/logElement.d.ts

@@ -1,9 +1,9 @@
-/**
- * Print a node's markup to the console, indented for readability (see prettyPrint).
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [label=''] A label printed above the markup, to identify this log call
- * @returns {undefined}
- */
-declare const logElement: (node: any, label?: string) => void;
-export default logElement;
+/**
+ * Print a node's markup to the console, indented for readability (see prettyPrint).
+ * @memberOf module:factories
+ * @param {*} node
+ * @param {string} [label=''] A label printed above the markup, to identify this log call
+ * @returns {undefined}
+ */
+declare const logElement: (node: any, label?: string) => void;
+export default logElement;

package/dist/factories/logElement.js

@@ -1,23 +1,23 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-/**
- * @file Prints an element (or any node) to the console, readably - the point of pseudo-dom running headlessly is
- * usually to watch what code does to a tree without a real browser to look at.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-const serializeHTML_1 = require('./serializeHTML')
-/**
- * Print a node's markup to the console, indented for readability (see prettyPrint).
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [label=''] A label printed above the markup, to identify this log call
- * @returns {undefined}
- */
-const logElement = (node, label = '') => {
-  console.log(`${label ? `${label}\n` : ''}${(0, serializeHTML_1.prettyPrint)(node)}`)
-}
-exports.default = logElement
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+/**
+ * @file Prints an element (or any node) to the console, readably - the point of pseudo-dom running headlessly is
+ * usually to watch what code does to a tree without a real browser to look at.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+const serializeHTML_1 = require('./serializeHTML')
+/**
+ * Print a node's markup to the console, indented for readability (see prettyPrint).
+ * @memberOf module:factories
+ * @param {*} node
+ * @param {string} [label=''] A label printed above the markup, to identify this log call
+ * @returns {undefined}
+ */
+const logElement = (node, label = '') => {
+  console.log(`${label ? `${label}\n` : ''}${(0, serializeHTML_1.prettyPrint)(node)}`)
+}
+exports.default = logElement

package/dist/factories/serializeHTML.d.ts

@@ -1,25 +1,25 @@
-/**
- * A node's children, serialized in order (this is what innerHTML returns).
- * @memberOf module:factories
- * @param {*} node
- * @returns {string}
- */
-declare const serializeChildren: (node: any) => string;
-/**
- * An element itself, serialized with its children (this is what outerHTML returns).
- * @memberOf module:factories
- * @param {*} element
- * @returns {string}
- */
-declare const serializeOuter: (element: any) => string;
-/**
- * A node's markup, indented one level per level of nesting - a real DOM's outerHTML / innerHTML has no line breaks
- * at all, which does not read well for a whole tree (a board full of cells, say). Useful for watching pseudo-dom-
- * driven code run headlessly, printed to a terminal - see also logElement, which does the printing too.
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [indent='  '] The indentation used per level of nesting
- * @returns {string}
- */
-declare const prettyPrint: (node: any, indent?: string) => string;
-export { serializeChildren, serializeOuter, prettyPrint };
+/**
+ * A node's children, serialized in order (this is what innerHTML returns).
+ * @memberOf module:factories
+ * @param {*} node
+ * @returns {string}
+ */
+declare const serializeChildren: (node: any) => string;
+/**
+ * An element itself, serialized with its children (this is what outerHTML returns).
+ * @memberOf module:factories
+ * @param {*} element
+ * @returns {string}
+ */
+declare const serializeOuter: (element: any) => string;
+/**
+ * A node's markup, indented one level per level of nesting - a real DOM's outerHTML / innerHTML has no line breaks
+ * at all, which does not read well for a whole tree (a board full of cells, say). Useful for watching pseudo-dom-
+ * driven code run headlessly, printed to a terminal - see also logElement, which does the printing too.
+ * @memberOf module:factories
+ * @param {*} node
+ * @param {string} [indent='  '] The indentation used per level of nesting
+ * @returns {string}
+ */
+declare const prettyPrint: (node: any, indent?: string) => string;
+export { serializeChildren, serializeOuter, prettyPrint };