pseudo-dom 0.3.0 → 0.4.0

package/dist/services/PointerEventService.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @file Substitute for the DOM PointerEvent Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { MouseEventInit, MouseEventService } from './MouseEventService';
+/**
+ * The options for creating a pointer event, on top of the ones every mouse event has.
+ * @typedef {Object} PointerEventInit
+ * @property {number} [pointerId=0]
+ * @property {number} [width=1]
+ * @property {number} [height=1]
+ * @property {number} [pressure=0]
+ * @property {string} [pointerType=''] mouse, pen or touch
+ * @property {boolean} [isPrimary=false]
+ */
+export type PointerEventInit = MouseEventInit & {
+    pointerId?: number;
+    width?: number;
+    height?: number;
+    pressure?: number;
+    pointerType?: string;
+    isPrimary?: boolean;
+};
+/**
+ * Simulate the behaviour of the PointerEvent Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments MouseEventService
+ * @property {number} pointerId
+ * @property {number} width
+ * @property {number} height
+ * @property {number} pressure
+ * @property {string} pointerType
+ * @property {boolean} isPrimary
+ */
+export declare class PointerEventService extends MouseEventService {
+    private readonly pointer;
+    /**
+     * @param {string} [typeArg=''] The type of the event
+     * @param {PointerEventInit} [init={}] The options for the event
+     * @constructor
+     */
+    constructor(typeArg?: string, init?: PointerEventInit);
+    get pointerId(): number;
+    get width(): number;
+    get height(): number;
+    get pressure(): number;
+    get pointerType(): string;
+    get isPrimary(): boolean;
+}

package/dist/services/PointerEventService.js

@@ -0,0 +1,67 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.PointerEventService = void 0
+/**
+ * @file Substitute for the DOM PointerEvent Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+const MouseEventService_1 = require('./MouseEventService')
+/**
+ * Simulate the behaviour of the PointerEvent Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments MouseEventService
+ * @property {number} pointerId
+ * @property {number} width
+ * @property {number} height
+ * @property {number} pressure
+ * @property {string} pointerType
+ * @property {boolean} isPrimary
+ */
+class PointerEventService extends MouseEventService_1.MouseEventService {
+  /**
+   * @param {string} [typeArg=''] The type of the event
+   * @param {PointerEventInit} [init={}] The options for the event
+   * @constructor
+   */
+  constructor (typeArg = '', init = {}) {
+    super(typeArg, init)
+    this.pointer = {
+      pointerId: init.pointerId || 0,
+      width: typeof init.width === 'number' ? init.width : 1,
+      height: typeof init.height === 'number' ? init.height : 1,
+      pressure: init.pressure || 0,
+      pointerType: init.pointerType || '',
+      isPrimary: !!init.isPrimary
+    }
+  }
+
+  get pointerId () {
+    return this.pointer.pointerId
+  }
+
+  get width () {
+    return this.pointer.width
+  }
+
+  get height () {
+    return this.pointer.height
+  }
+
+  get pressure () {
+    return this.pointer.pressure
+  }
+
+  get pointerType () {
+    return this.pointer.pointerType
+  }
+
+  get isPrimary () {
+    return this.pointer.isPrimary
+  }
+}
+exports.PointerEventService = PointerEventService

package/dist/services/PointerEventService.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PointerEventService=void 0;const MouseEventService_1=require("./MouseEventService");class PointerEventService extends MouseEventService_1.MouseEventService{constructor(e="",t={}){super(e,t),this.pointer={pointerId:t.pointerId||0,width:"number"==typeof t.width?t.width:1,height:"number"==typeof t.height?t.height:1,pressure:t.pressure||0,pointerType:t.pointerType||"",isPrimary:!!t.isPrimary}}get pointerId(){return this.pointer.pointerId}get width(){return this.pointer.width}get height(){return this.pointer.height}get pressure(){return this.pointer.pressure}get pointerType(){return this.pointer.pointerType}get isPrimary(){return this.pointer.isPrimary}}exports.PointerEventService=PointerEventService;

package/dist/services/UIEventService.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @file Substitute for the DOM UIEvent Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { EventService } from './EventService';
+/**
+ * The options for creating an event, on top of the ones every event has.
+ * @typedef {Object} UIEventInit
+ * @property {boolean} [bubbles=false]
+ * @property {boolean} [cancelable=false]
+ * @property {boolean} [composed=false]
+ * @property {number} [detail=0] Details about the event, such as how many times the mouse was clicked
+ * @property {*} [view=null] The window the event happened in
+ */
+export type UIEventInit = {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    composed?: boolean;
+    detail?: number;
+    view?: any;
+};
+/**
+ * Simulate the behaviour of the UIEvent Class when there is no DOM available: the events which come from a user
+ * interface (the mouse, the keyboard, focus and input).
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments EventService
+ * @property {number} detail
+ * @property {*} view
+ */
+export declare class UIEventService extends EventService {
+    private readonly uiDetail;
+    private readonly uiView;
+    /**
+     * @param {string} [typeArg=''] The type of the event
+     * @param {UIEventInit} [init={}] The options for the event
+     * @constructor
+     */
+    constructor(typeArg?: string, init?: UIEventInit);
+    get detail(): number;
+    get view(): any;
+}

package/dist/services/UIEventService.js

@@ -0,0 +1,42 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.UIEventService = void 0
+/**
+ * @file Substitute for the DOM UIEvent Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+const EventService_1 = require('./EventService')
+/**
+ * Simulate the behaviour of the UIEvent Class when there is no DOM available: the events which come from a user
+ * interface (the mouse, the keyboard, focus and input).
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments EventService
+ * @property {number} detail
+ * @property {*} view
+ */
+class UIEventService extends EventService_1.EventService {
+  /**
+   * @param {string} [typeArg=''] The type of the event
+   * @param {UIEventInit} [init={}] The options for the event
+   * @constructor
+   */
+  constructor (typeArg = '', init = {}) {
+    super(typeArg, init)
+    this.uiDetail = init.detail || 0
+    this.uiView = init.view || null
+  }
+
+  get detail () {
+    return this.uiDetail
+  }
+
+  get view () {
+    return this.uiView
+  }
+}
+exports.UIEventService = UIEventService

package/dist/services/UIEventService.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.UIEventService=void 0;const EventService_1=require("./EventService");class UIEventService extends EventService_1.EventService{constructor(e="",t={}){super(e,t),this.uiDetail=t.detail||0,this.uiView=t.view||null}get detail(){return this.uiDetail}get view(){return this.uiView}}exports.UIEventService=UIEventService;

package/dist/simulate.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Click an element the way a user does: pointerdown and mousedown, then the focus moves to the nearest element which
+ * can have it (or is taken away from the one which had it) unless mousedown was cancelled, then pointerup, mouseup
+ * and finally click. Every event is trusted and has the options the browser gives it. A disabled element gets nothing.
+ * @function click
+ * @param {*} element The element to click
+ * @param {Object} [init={}] Options for the events (for example clientX, clientY, shiftKey)
+ * @returns {boolean} False when the click was cancelled (or the element is disabled), so its default action did not happen
+ */
+export declare const click: (element: any, init?: {
+    [option: string]: any;
+}) => boolean;
+/**
+ * Press and release a key on an element (the element which has the focus, or one given): keydown and then keyup.
+ * @function keyPress
+ * @param {*} element The element which gets the key
+ * @param {string} key The value of the key, such as a or Enter
+ * @param {Object} [init={}] Options for the events (for example code, shiftKey)
+ * @returns {boolean} False when keydown was cancelled, so its default action did not happen
+ */
+export declare const keyPress: (element: any, key: string, init?: {
+    [option: string]: any;
+}) => boolean;
+declare const _default: {
+    click: (element: any, init?: {
+        [option: string]: any;
+    }) => boolean;
+    keyPress: (element: any, key: string, init?: {
+        [option: string]: any;
+    }) => boolean;
+};
+export default _default;

package/dist/simulate.js

@@ -0,0 +1,115 @@
+'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.keyPress = exports.click = void 0
+/**
+ * @file Simulate what a user does, with the events the browser sends for it.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module pseudoDom/simulate
+ */
+const createEvent_1 = __importDefault(require('./factories/createEvent'))
+const activeElement_1 = require('./functions/activeElement')
+const send = (target, type, init) => target.dispatchEvent((0, createEvent_1.default)(type, init, {
+  browser: true,
+  trusted: true
+}))
+/**
+ * The nearest element (starting with the element itself) which can have the focus.
+ * @param {*} element Where to start
+ * @returns {*|null}
+ */
+const focusableFrom = element => {
+  let current = element
+  while (current) {
+    if (current.canFocus) {
+      return current
+    }
+    current = current.parentNode
+  }
+  return null
+}
+/**
+ * Click an element the way a user does: pointerdown and mousedown, then the focus moves to the nearest element which
+ * can have it (or is taken away from the one which had it) unless mousedown was cancelled, then pointerup, mouseup
+ * and finally click. Every event is trusted and has the options the browser gives it. A disabled element gets nothing.
+ * @function click
+ * @param {*} element The element to click
+ * @param {Object} [init={}] Options for the events (for example clientX, clientY, shiftKey)
+ * @returns {boolean} False when the click was cancelled (or the element is disabled), so its default action did not happen
+ */
+const click = (element, init = {}) => {
+  if (element.hasAttribute && element.hasAttribute('disabled')) {
+    return false
+  }
+  const pointer = Object.assign({
+    pointerId: 1,
+    pointerType: 'mouse',
+    isPrimary: true,
+    button: 0
+  }, init)
+  send(element, 'pointerdown', Object.assign({
+    buttons: 1
+  }, pointer))
+  if (send(element, 'mousedown', Object.assign({
+    buttons: 1,
+    detail: 1
+  }, init, {
+    button: 0
+  }))) {
+    const focusable = focusableFrom(element)
+    if (focusable) {
+      focusable.focus()
+    } else {
+      const active = (0, activeElement_1.getActiveElement)(element.getRootNode())
+      if (active) {
+        active.blur()
+      }
+    }
+  }
+  send(element, 'pointerup', Object.assign({
+    buttons: 0
+  }, pointer))
+  send(element, 'mouseup', Object.assign({
+    buttons: 0,
+    detail: 1
+  }, init, {
+    button: 0
+  }))
+  return send(element, 'click', Object.assign({
+    detail: 1
+  }, init, {
+    button: 0
+  }))
+}
+exports.click = click
+/**
+ * Press and release a key on an element (the element which has the focus, or one given): keydown and then keyup.
+ * @function keyPress
+ * @param {*} element The element which gets the key
+ * @param {string} key The value of the key, such as a or Enter
+ * @param {Object} [init={}] Options for the events (for example code, shiftKey)
+ * @returns {boolean} False when keydown was cancelled, so its default action did not happen
+ */
+const keyPress = (element, key, init = {}) => {
+  const options = Object.assign({
+    key
+  }, init)
+  const proceeded = send(element, 'keydown', options)
+  send(element, 'keyup', options)
+  return proceeded
+}
+exports.keyPress = keyPress
+exports.default = {
+  click: exports.click,
+  keyPress: exports.keyPress
+}

package/dist/simulate.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.keyPress=exports.click=void 0;const createEvent_1=__importDefault(require("./factories/createEvent")),activeElement_1=require("./functions/activeElement"),send=(e,t,s)=>e.dispatchEvent((0,createEvent_1.default)(t,s,{browser:!0,trusted:!0})),focusableFrom=e=>{let t=e;for(;t;){if(t.canFocus)return t;t=t.parentNode}return null},click=(e,t={})=>{if(e.hasAttribute&&e.hasAttribute("disabled"))return!1;const s=Object.assign({pointerId:1,pointerType:"mouse",isPrimary:!0,button:0},t);if(send(e,"pointerdown",Object.assign({buttons:1},s)),send(e,"mousedown",Object.assign({buttons:1,detail:1},t,{button:0}))){const t=focusableFrom(e);if(t)t.focus();else{const t=(0,activeElement_1.getActiveElement)(e.getRootNode());t&&t.blur()}}return send(e,"pointerup",Object.assign({buttons:0},s)),send(e,"mouseup",Object.assign({buttons:0,detail:1},t,{button:0})),send(e,"click",Object.assign({detail:1},t,{button:0}))};exports.click=click;const keyPress=(e,t,s={})=>{const n=Object.assign({key:t},s),r=send(e,"keydown",n);return send(e,"keyup",n),r};exports.keyPress=keyPress,exports.default={click:exports.click,keyPress:exports.keyPress};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pseudo-dom",
   "description": "Mock the DOM on the server side for managing state and testing",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
   "author": "Joshua Heagle",