pseudo-dom 0.5.1 → 0.7.0

package/dist/services/ElementService.d.ts

@@ -4,10 +4,11 @@
  * @version 1.0.0
  */
 import { PseudoNode } from '../interfaces/PseudoNode';
-import { NodeService } from './NodeService';
 import { PseudoElement } from '../interfaces/PseudoElement';
+import { NodeService } from './NodeService';
 import { PseudoNamedNodeMap } from '../interfaces/PseudoNamedNodeMap';
 import { PseudoDOMTokenList } from '../interfaces/PseudoDOMTokenList';
+import { PseudoHTMLCollection } from '../interfaces/PseudoHTMLCollection';
 type attribute = {
     name: string;
     value: any;
@@ -80,6 +81,81 @@ export declare class ElementService extends NodeService implements Partial<Pseud
      * Some elements have default behaviour, this registers it when the element is added.
      * @returns {Function}
      */
+    /**
+     * A live view of this element's element children (text, comments and the like are not included).
+     * @returns {PseudoHTMLCollection}
+     */
+    get children(): PseudoHTMLCollection;
+    /**
+     * How many element children this element has.
+     * @returns {number}
+     */
+    get childElementCount(): number;
+    /**
+     * The first child of this element which is an element, or null when there is none.
+     * @returns {PseudoElement|null}
+     */
+    get firstElementChild(): PseudoElement | null;
+    /**
+     * The last child of this element which is an element, or null when there is none.
+     * @returns {PseudoElement|null}
+     */
+    get lastElementChild(): PseudoElement | null;
+    /**
+     * The sibling after this one which is an element, or null when there is none.
+     * @returns {PseudoElement|null}
+     */
+    get nextElementSibling(): PseudoElement | null;
+    /**
+     * The sibling before this one which is an element, or null when there is none.
+     * @returns {PseudoElement|null}
+     */
+    get previousElementSibling(): PseudoElement | null;
+    /**
+     * Put an element at a position relative to this one: beforebegin (before this element, as its previous sibling),
+     * afterbegin (as this element's first child), beforeend (as this element's last child) or afterend (after this
+     * element, as its next sibling).
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {ElementService} element The element to insert
+     * @returns {ElementService|null} The inserted element, or null when the position needed a parent this element does not have
+     * @throws {Error} When the position is not one of the four above
+     */
+    insertAdjacentElement(position: string, element: PseudoElement): PseudoElement | null;
+    /**
+     * Put text at a position relative to this element, the same as insertAdjacentElement but the text becomes a text node.
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {string} text The text to insert
+     * @throws {Error} When the position is not one of the four above
+     */
+    insertAdjacentText(position: string, text: string): void;
+    /**
+     * Shared implementation for insertAdjacentElement / insertAdjacentText.
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {PseudoNode|string} node The node (or text) to insert
+     * @returns {PseudoNode|null} The inserted node, or null when the position needed a parent this element does not have
+     * @throws {Error} When the position is not one of the four above
+     */
+    private insertAdjacent;
+    /**
+     * Not implemented yet (HTML parsing is out of scope for now).
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {string} text The markup which would be parsed
+     * @throws {Error}
+     */
+    insertAdjacentHTML(position: string, text: string): void;
+    /**
+     * Whether this element itself (not its descendants) matches the given CSS selector.
+     * @param {string} selectors A CSS selector
+     * @returns {boolean}
+     */
+    matches(selectors: string): boolean;
+    /**
+     * The nearest ancestor of this element (starting with this element itself) which matches the CSS selector, or
+     * null when none of them do.
+     * @param {string} selectors A CSS selector
+     * @returns {PseudoElement|null}
+     */
+    closest(selectors: string): PseudoElement | null;
     applyDefaultEvent(): Function;
     /**
      * An element which is added as a child gets its default events (for example a submit button submits its form).

package/dist/services/ElementService.js

@@ -23,8 +23,10 @@ const AttrService_1 = require('./AttrService')
 const DOMTokenListService_1 = require('./DOMTokenListService')
 const NamedNodeMapService_1 = require('./NamedNodeMapService')
 const getParentNodesFromAttribute_1 = __importDefault(require('../functions/getParentNodesFromAttribute'))
+const HTMLCollectionService_1 = require('./HTMLCollectionService')
 const cloneObject_1 = __importDefault(require('si-funciona/dist/helpers/objects/cloneObject'))
 const isEqual_1 = __importDefault(require('si-funciona/dist/helpers/objects/isEqual'))
+const query_1 = require('../factories/query')
 /**
  * Simulate the behaviour of the Element Class when there is no DOM available.
  * @author Joshua Heagle <joshuaheagle@gmail.com>
@@ -184,6 +186,147 @@ class ElementService extends NodeService_1.NodeService {
    * Some elements have default behaviour, this registers it when the element is added.
    * @returns {Function}
    */
+  /**
+   * A live view of this element's element children (text, comments and the like are not included).
+   * @returns {PseudoHTMLCollection}
+   */
+  get children () {
+    return new HTMLCollectionService_1.HTMLCollectionService(this)
+  }
+
+  /**
+   * How many element children this element has.
+   * @returns {number}
+   */
+  get childElementCount () {
+    return this.children.length
+  }
+
+  /**
+   * The first child of this element which is an element, or null when there is none.
+   * @returns {PseudoElement|null}
+   */
+  get firstElementChild () {
+    return this.children.item(0)
+  }
+
+  /**
+   * The last child of this element which is an element, or null when there is none.
+   * @returns {PseudoElement|null}
+   */
+  get lastElementChild () {
+    const elementChildren = this.children
+    return elementChildren.item(elementChildren.length - 1)
+  }
+
+  /**
+   * The sibling after this one which is an element, or null when there is none.
+   * @returns {PseudoElement|null}
+   */
+  get nextElementSibling () {
+    let sibling = this.nextSibling
+    while (sibling && sibling.nodeType !== NodeService_1.NodeService.ELEMENT_NODE) {
+      sibling = sibling.nextSibling
+    }
+    return sibling
+  }
+
+  /**
+   * The sibling before this one which is an element, or null when there is none.
+   * @returns {PseudoElement|null}
+   */
+  get previousElementSibling () {
+    let sibling = this.previousSibling
+    while (sibling && sibling.nodeType !== NodeService_1.NodeService.ELEMENT_NODE) {
+      sibling = sibling.previousSibling
+    }
+    return sibling
+  }
+
+  /**
+   * Put an element at a position relative to this one: beforebegin (before this element, as its previous sibling),
+   * afterbegin (as this element's first child), beforeend (as this element's last child) or afterend (after this
+   * element, as its next sibling).
+   * @param {string} position beforebegin, afterbegin, beforeend or afterend
+   * @param {ElementService} element The element to insert
+   * @returns {ElementService|null} The inserted element, or null when the position needed a parent this element does not have
+   * @throws {Error} When the position is not one of the four above
+   */
+  insertAdjacentElement (position, element) {
+    return this.insertAdjacent(position, element)
+  }
+
+  /**
+   * Put text at a position relative to this element, the same as insertAdjacentElement but the text becomes a text node.
+   * @param {string} position beforebegin, afterbegin, beforeend or afterend
+   * @param {string} text The text to insert
+   * @throws {Error} When the position is not one of the four above
+   */
+  insertAdjacentText (position, text) {
+    this.insertAdjacent(position, text)
+  }
+
+  /**
+   * Shared implementation for insertAdjacentElement / insertAdjacentText.
+   * @param {string} position beforebegin, afterbegin, beforeend or afterend
+   * @param {PseudoNode|string} node The node (or text) to insert
+   * @returns {PseudoNode|null} The inserted node, or null when the position needed a parent this element does not have
+   * @throws {Error} When the position is not one of the four above
+   */
+  insertAdjacent (position, node) {
+    switch (position) {
+      case 'beforebegin':
+        if (!this.parentNode) {
+          return null
+        }
+        this.before(node)
+        return node
+      case 'afterbegin':
+        this.prepend(node)
+        return node
+      case 'beforeend':
+        this.append(node)
+        return node
+      case 'afterend':
+        if (!this.parentNode) {
+          return null
+        }
+        this.after(node)
+        return node
+      default:
+        throw new Error(`"${position}" is not one of beforebegin, afterbegin, beforeend or afterend.`)
+    }
+  }
+
+  /**
+   * Not implemented yet (HTML parsing is out of scope for now).
+   * @param {string} position beforebegin, afterbegin, beforeend or afterend
+   * @param {string} text The markup which would be parsed
+   * @throws {Error}
+   */
+  insertAdjacentHTML (position, text) {
+    throw new Error('ElementService.insertAdjacentHTML() is not implemented yet.')
+  }
+
+  /**
+   * Whether this element itself (not its descendants) matches the given CSS selector.
+   * @param {string} selectors A CSS selector
+   * @returns {boolean}
+   */
+  matches (selectors) {
+    return (0, query_1.matches)(this, selectors)
+  }
+
+  /**
+   * The nearest ancestor of this element (starting with this element itself) which matches the CSS selector, or
+   * null when none of them do.
+   * @param {string} selectors A CSS selector
+   * @returns {PseudoElement|null}
+   */
+  closest (selectors) {
+    return (0, query_1.closest)(this, selectors)
+  }
+
   applyDefaultEvent () {
     let callback = event => undefined
     if (this.defaultEventApplied) {

package/dist/services/ElementService.min.js

@@ -1 +1 @@
-"use strict";require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.every.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.for-each.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.some.js");var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ElementService=void 0;const createEvent_1=__importDefault(require("../factories/createEvent")),NodeService_1=require("./NodeService"),AttrService_1=require("./AttrService"),DOMTokenListService_1=require("./DOMTokenListService"),NamedNodeMapService_1=require("./NamedNodeMapService"),getParentNodesFromAttribute_1=__importDefault(require("../functions/getParentNodesFromAttribute")),cloneObject_1=__importDefault(require("si-funciona/dist/helpers/objects/cloneObject")),isEqual_1=__importDefault(require("si-funciona/dist/helpers/objects/isEqual"));class ElementService extends NodeService_1.NodeService{constructor({tagName:e="",attributes:t=[],parent:r=null,children:i=[]}={}){super(),this.defaultEventApplied=!1,this.tokenList=new DOMTokenListService_1.DOMTokenListService,this.tag=e,this.attributeList=t.concat([{name:"className",value:""},{name:"id",value:""},{name:"innerHTML",value:""}]),this.propertyAttributes=this.attributeList.map(({name:e})=>e),this.attributeList.forEach(({name:e,value:t})=>{this[e]=t}),i.forEach(e=>{if(!e||"number"!=typeof e.nodeType)throw new TypeError("The children of an element must be nodes.");this.appendChild(e)}),r&&r.appendChild(this)}currentAttributes(){return this.attributeList.map(({name:e,value:t})=>({name:e,value:this.propertyAttributes.indexOf(e)>=0?this[e]:t}))}get nodeName(){return this.tag}cloneShallow(){const e=new this.constructor({tagName:this.tag});return e.attributeList.length=0,this.currentAttributes().forEach(({name:t,value:r})=>{const i="object"==typeof r&&null!==r?(0,cloneObject_1.default)(r):r;e.attributeList.push({name:t,value:i}),e.propertyAttributes.indexOf(t)>=0&&(e[t]=i)}),e.ownerDocumentStore=this.ownerDocumentStore,e}equalsShallow(e){const t=this.currentAttributes(),r=e.currentAttributes();return this.nodeName===e.nodeName&&t.length===r.length&&t.every(({name:e,value:t})=>{const i=r.find(t=>t.name===e);return void 0!==i&&(0,isEqual_1.default)(t,i.value)})}get tagName(){return this.tag}get nodeType(){return NodeService_1.NodeService.ELEMENT_NODE}get attributes(){return new NamedNodeMapService_1.NamedNodeMapService(this.currentAttributes().map(({name:e,value:t})=>new AttrService_1.AttrService(e,String(t),this)))}get classList(){return this.tokenList}get className(){return this.tokenList.value}set className(e){this.tokenList.value=e}applyDefaultEvent(){let e=e=>{};if(this.defaultEventApplied)return e;switch(this.tagName){case"button":case"input":e=e=>{const t=String(this.getAttribute("type")||this.type||"").toLowerCase(),r="button"===this.tagName?"button"!==t&&"reset"!==t:/^(submit|image)$/.test(t),i=(0,getParentNodesFromAttribute_1.default)("tagName","form",this);r&&i.length&&!this.hasAttribute("disabled")&&i[i.length-1].dispatchEvent((0,createEvent_1.default)("submit",{},{browser:!0,trusted:e.isTrusted}))},super.setDefaultEvent("click",e),this.defaultEventApplied=!0}return e}childInserted(e){"function"==typeof e.applyDefaultEvent&&e.applyDefaultEvent()}hasAttribute(e){return this.attributeList.some(({name:t})=>t===e)}setAttribute(e,t){const r=this.attributeList.find(({name:t})=>t===e);r?r.value=t:this.attributeList.push({name:e,value:t}),this.propertyAttributes.indexOf(e)>=0&&(this[e]=t)}getAttribute(e){const t=this.currentAttributes().find(({name:t})=>t===e);return t?t.value:null}removeAttribute(e){const t=this.attributeList.findIndex(({name:t})=>t===e);t>=0&&this.attributeList.splice(t,1)}}exports.ElementService=ElementService;
+"use strict";require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.every.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.for-each.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.some.js");var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ElementService=void 0;const createEvent_1=__importDefault(require("../factories/createEvent")),NodeService_1=require("./NodeService"),AttrService_1=require("./AttrService"),DOMTokenListService_1=require("./DOMTokenListService"),NamedNodeMapService_1=require("./NamedNodeMapService"),getParentNodesFromAttribute_1=__importDefault(require("../functions/getParentNodesFromAttribute")),HTMLCollectionService_1=require("./HTMLCollectionService"),cloneObject_1=__importDefault(require("si-funciona/dist/helpers/objects/cloneObject")),isEqual_1=__importDefault(require("si-funciona/dist/helpers/objects/isEqual")),query_1=require("../factories/query");class ElementService extends NodeService_1.NodeService{constructor({tagName:e="",attributes:t=[],parent:r=null,children:i=[]}={}){super(),this.defaultEventApplied=!1,this.tokenList=new DOMTokenListService_1.DOMTokenListService,this.tag=e,this.attributeList=t.concat([{name:"className",value:""},{name:"id",value:""},{name:"innerHTML",value:""}]),this.propertyAttributes=this.attributeList.map(({name:e})=>e),this.attributeList.forEach(({name:e,value:t})=>{this[e]=t}),i.forEach(e=>{if(!e||"number"!=typeof e.nodeType)throw new TypeError("The children of an element must be nodes.");this.appendChild(e)}),r&&r.appendChild(this)}currentAttributes(){return this.attributeList.map(({name:e,value:t})=>({name:e,value:this.propertyAttributes.indexOf(e)>=0?this[e]:t}))}get nodeName(){return this.tag}cloneShallow(){const e=new this.constructor({tagName:this.tag});return e.attributeList.length=0,this.currentAttributes().forEach(({name:t,value:r})=>{const i="object"==typeof r&&null!==r?(0,cloneObject_1.default)(r):r;e.attributeList.push({name:t,value:i}),e.propertyAttributes.indexOf(t)>=0&&(e[t]=i)}),e.ownerDocumentStore=this.ownerDocumentStore,e}equalsShallow(e){const t=this.currentAttributes(),r=e.currentAttributes();return this.nodeName===e.nodeName&&t.length===r.length&&t.every(({name:e,value:t})=>{const i=r.find(t=>t.name===e);return void 0!==i&&(0,isEqual_1.default)(t,i.value)})}get tagName(){return this.tag}get nodeType(){return NodeService_1.NodeService.ELEMENT_NODE}get attributes(){return new NamedNodeMapService_1.NamedNodeMapService(this.currentAttributes().map(({name:e,value:t})=>new AttrService_1.AttrService(e,String(t),this)))}get classList(){return this.tokenList}get className(){return this.tokenList.value}set className(e){this.tokenList.value=e}get children(){return new HTMLCollectionService_1.HTMLCollectionService(this)}get childElementCount(){return this.children.length}get firstElementChild(){return this.children.item(0)}get lastElementChild(){const e=this.children;return e.item(e.length-1)}get nextElementSibling(){let e=this.nextSibling;for(;e&&e.nodeType!==NodeService_1.NodeService.ELEMENT_NODE;)e=e.nextSibling;return e}get previousElementSibling(){let e=this.previousSibling;for(;e&&e.nodeType!==NodeService_1.NodeService.ELEMENT_NODE;)e=e.previousSibling;return e}insertAdjacentElement(e,t){return this.insertAdjacent(e,t)}insertAdjacentText(e,t){this.insertAdjacent(e,t)}insertAdjacent(e,t){switch(e){case"beforebegin":return this.parentNode?(this.before(t),t):null;case"afterbegin":return this.prepend(t),t;case"beforeend":return this.append(t),t;case"afterend":return this.parentNode?(this.after(t),t):null;default:throw new Error(`"${e}" is not one of beforebegin, afterbegin, beforeend or afterend.`)}}insertAdjacentHTML(e,t){throw new Error("ElementService.insertAdjacentHTML() is not implemented yet.")}matches(e){return(0,query_1.matches)(this,e)}closest(e){return(0,query_1.closest)(this,e)}applyDefaultEvent(){let e=e=>{};if(this.defaultEventApplied)return e;switch(this.tagName){case"button":case"input":e=e=>{const t=String(this.getAttribute("type")||this.type||"").toLowerCase(),r="button"===this.tagName?"button"!==t&&"reset"!==t:/^(submit|image)$/.test(t),i=(0,getParentNodesFromAttribute_1.default)("tagName","form",this);r&&i.length&&!this.hasAttribute("disabled")&&i[i.length-1].dispatchEvent((0,createEvent_1.default)("submit",{},{browser:!0,trusted:e.isTrusted}))},super.setDefaultEvent("click",e),this.defaultEventApplied=!0}return e}childInserted(e){"function"==typeof e.applyDefaultEvent&&e.applyDefaultEvent()}hasAttribute(e){return this.attributeList.some(({name:t})=>t===e)}setAttribute(e,t){const r=this.attributeList.find(({name:t})=>t===e);r?r.value=t:this.attributeList.push({name:e,value:t}),this.propertyAttributes.indexOf(e)>=0&&(this[e]=t)}getAttribute(e){const t=this.currentAttributes().find(({name:t})=>t===e);return t?t.value:null}removeAttribute(e){const t=this.attributeList.findIndex(({name:t})=>t===e);t>=0&&this.attributeList.splice(t,1)}}exports.ElementService=ElementService;

package/dist/services/EventService.d.ts

@@ -1,120 +1,120 @@
-/**
- * @file Substitute for the DOM Event Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { PseudoEventTarget } from '../interfaces/PseudoEventTarget';
-import { PseudoEvent } from '../interfaces/PseudoEvent';
-/**
- * The parts of an event which the dispatching of it (EventTargetService) needs to change or read. Not part of the DOM's
- * Event, which is why they are kept apart from the event's own properties.
- */
-export type EventInner = {
-    currentTarget: PseudoEventTarget | null;
-    eventPhase: number;
-    target: PseudoEventTarget;
-    immediatePropagationStopped: boolean;
-    propagationStopped: boolean;
-    /** True for an event which the browser created for a user action, an event which a script created is not trusted. */
-    trusted: boolean;
-    /** True while the event is being dispatched. */
-    dispatching: boolean;
-    /** True while a passive listener is running, in which preventDefault does nothing. */
-    inPassiveListener: boolean;
-    /** The targets the event travels through, the target first and the root last, set while dispatching. */
-    path: Array<PseudoEventTarget>;
-    /** Finish the dispatch: no phase, no current target, no path and the stop flags are cleared so the event can be dispatched again. */
-    finishDispatch: () => void;
-};
-/**
- * Simulate the behaviour of the Event Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @property {number} NONE
- * @property {number} CAPTURING_PHASE
- * @property {number} AT_TARGET
- * @property {number} BUBBLING_PHASE
- * @property {boolean} bubbles - A Boolean indicating whether the event bubbles up through the Dom or not.
- * @property {boolean} cancelable - A Boolean indicating whether the event is cancelable.
- * @property {boolean} composed - A Boolean value indicating whether the event can bubble across the boundary
- * between the shadow Dom and the regular Dom.
- * @property {function|PseudoEventTarget} currentTarget - A reference to the currently registered target for the event. This
- * is the object to which the event is currently slated to be sent; it's possible this has been changed along the way
- * through re-targeting.
- * @property {boolean} defaultPrevented - Indicates whether event.preventDefault() has been called on the event.
- * @property {boolean} immediatePropagationStopped - Flag that no further propagation should occur, including on current
- * target.
- * @property {boolean} propagationStopped - Flag that no further propagation should occur.
- * @property {int} eventPhase - Indicates which phase of the event flow is being processed. Uses EventService constants.
- * @property {EventTarget|PseudoEventTarget} target - A reference to the target to which the event was originally
- * dispatched.
- * @property {int} timeStamp - The time at which the event was created (in milliseconds). By specification, this
- * value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this
- * to be a DomHighResTimeStamp instead.
- * @property {string} type - The name of the event (case-insensitive).
- * @property {boolean} isTrusted - Indicates whether the event was initiated by the browser (after a user
- * click for instance) or by a script (using an event creation method, like event.initEvent)
- */
-export declare class EventService implements PseudoEvent {
-    static readonly NONE = 0;
-    static readonly CAPTURING_PHASE = 1;
-    static readonly AT_TARGET = 2;
-    static readonly BUBBLING_PHASE = 3;
-    private properties;
-    /**
-     *
-     * @param {string} typeArg
-     * @param {Object} [eventOptions={}]
-     * @param {boolean} [eventOptions.bubbles=false]
-     * @param {boolean} [eventOptions.cancelable=false]
-     * @param {boolean} [eventOptions.composed=false]
-     * @constructor
-     */
-    constructor(typeArg?: string, { bubbles, cancelable, composed }?: {
-        bubbles?: boolean;
-        cancelable?: boolean;
-        composed?: boolean;
-    });
-    get bubbles(): boolean;
-    get cancelable(): boolean;
-    get composed(): boolean;
-    get currentTarget(): PseudoEventTarget;
-    get defaultPrevented(): boolean;
-    get eventPhase(): number;
-    get isTrusted(): boolean;
-    get target(): PseudoEventTarget;
-    get timeStamp(): number;
-    get type(): string;
-    /**
-     * Scope several accessors inside the inner object. These are only intended for usage by other DOM classes.
-     * @returns {EventInner}
-     */
-    get inner(): EventInner;
-    /**
-     * Return an array of targets that will have the event executed open them. The order is based on the eventPhase
-     * @method
-     * @returns {Array.<PseudoEventTarget>}
-     */
-    composedPath(): Array<PseudoEventTarget>;
-    /**
-     * Cancels the event (if it is cancelable).
-     * @method
-     * @returns {null}
-     */
-    preventDefault(): null;
-    /**
-     * For this particular event, no other listener will be called.
-     * Neither those attached on the same element, nor those attached on elements which will be traversed later (in
-     * capture phase, for instance)
-     * @method
-     * @returns {null}
-     */
-    stopImmediatePropagation(): null;
-    /**
-     * Stops the propagation of events further along in the Dom.
-     * @method
-     * @returns {null}
-     */
-    stopPropagation(): null;
-    private setReadOnlyProperties;
-}
+/**
+ * @file Substitute for the DOM Event Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { PseudoEventTarget } from '../interfaces/PseudoEventTarget';
+import { PseudoEvent } from '../interfaces/PseudoEvent';
+/**
+ * The parts of an event which the dispatching of it (EventTargetService) needs to change or read. Not part of the DOM's
+ * Event, which is why they are kept apart from the event's own properties.
+ */
+export type EventInner = {
+    currentTarget: PseudoEventTarget | null;
+    eventPhase: number;
+    target: PseudoEventTarget;
+    immediatePropagationStopped: boolean;
+    propagationStopped: boolean;
+    /** True for an event which the browser created for a user action, an event which a script created is not trusted. */
+    trusted: boolean;
+    /** True while the event is being dispatched. */
+    dispatching: boolean;
+    /** True while a passive listener is running, in which preventDefault does nothing. */
+    inPassiveListener: boolean;
+    /** The targets the event travels through, the target first and the root last, set while dispatching. */
+    path: Array<PseudoEventTarget>;
+    /** Finish the dispatch: no phase, no current target, no path and the stop flags are cleared so the event can be dispatched again. */
+    finishDispatch: () => void;
+};
+/**
+ * Simulate the behaviour of the Event Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @property {number} NONE
+ * @property {number} CAPTURING_PHASE
+ * @property {number} AT_TARGET
+ * @property {number} BUBBLING_PHASE
+ * @property {boolean} bubbles - A Boolean indicating whether the event bubbles up through the Dom or not.
+ * @property {boolean} cancelable - A Boolean indicating whether the event is cancelable.
+ * @property {boolean} composed - A Boolean value indicating whether the event can bubble across the boundary
+ * between the shadow Dom and the regular Dom.
+ * @property {function|PseudoEventTarget} currentTarget - A reference to the currently registered target for the event. This
+ * is the object to which the event is currently slated to be sent; it's possible this has been changed along the way
+ * through re-targeting.
+ * @property {boolean} defaultPrevented - Indicates whether event.preventDefault() has been called on the event.
+ * @property {boolean} immediatePropagationStopped - Flag that no further propagation should occur, including on current
+ * target.
+ * @property {boolean} propagationStopped - Flag that no further propagation should occur.
+ * @property {int} eventPhase - Indicates which phase of the event flow is being processed. Uses EventService constants.
+ * @property {EventTarget|PseudoEventTarget} target - A reference to the target to which the event was originally
+ * dispatched.
+ * @property {int} timeStamp - The time at which the event was created (in milliseconds). By specification, this
+ * value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this
+ * to be a DomHighResTimeStamp instead.
+ * @property {string} type - The name of the event (case-insensitive).
+ * @property {boolean} isTrusted - Indicates whether the event was initiated by the browser (after a user
+ * click for instance) or by a script (using an event creation method, like event.initEvent)
+ */
+export declare class EventService implements PseudoEvent {
+    static readonly NONE = 0;
+    static readonly CAPTURING_PHASE = 1;
+    static readonly AT_TARGET = 2;
+    static readonly BUBBLING_PHASE = 3;
+    private properties;
+    /**
+     *
+     * @param {string} typeArg
+     * @param {Object} [eventOptions={}]
+     * @param {boolean} [eventOptions.bubbles=false]
+     * @param {boolean} [eventOptions.cancelable=false]
+     * @param {boolean} [eventOptions.composed=false]
+     * @constructor
+     */
+    constructor(typeArg?: string, { bubbles, cancelable, composed }?: {
+        bubbles?: boolean;
+        cancelable?: boolean;
+        composed?: boolean;
+    });
+    get bubbles(): boolean;
+    get cancelable(): boolean;
+    get composed(): boolean;
+    get currentTarget(): PseudoEventTarget;
+    get defaultPrevented(): boolean;
+    get eventPhase(): number;
+    get isTrusted(): boolean;
+    get target(): PseudoEventTarget;
+    get timeStamp(): number;
+    get type(): string;
+    /**
+     * Scope several accessors inside the inner object. These are only intended for usage by other DOM classes.
+     * @returns {EventInner}
+     */
+    get inner(): EventInner;
+    /**
+     * Return an array of targets that will have the event executed open them. The order is based on the eventPhase
+     * @method
+     * @returns {Array.<PseudoEventTarget>}
+     */
+    composedPath(): Array<PseudoEventTarget>;
+    /**
+     * Cancels the event (if it is cancelable).
+     * @method
+     * @returns {null}
+     */
+    preventDefault(): null;
+    /**
+     * For this particular event, no other listener will be called.
+     * Neither those attached on the same element, nor those attached on elements which will be traversed later (in
+     * capture phase, for instance)
+     * @method
+     * @returns {null}
+     */
+    stopImmediatePropagation(): null;
+    /**
+     * Stops the propagation of events further along in the Dom.
+     * @method
+     * @returns {null}
+     */
+    stopPropagation(): null;
+    private setReadOnlyProperties;
+}