@thednp/shorty 2.0.0-alpha5 → 2.0.0-alpha7

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@thednp/shorty",
-  "version": "2.0.0alpha5",
+  "version": "2.0.0alpha7",
+  "type": "module",
   "description": "TypeScript shorties for the web",
   "source": "./src/index.ts",
   "main": "./dist/shorty.js",
@@ -20,14 +21,14 @@
   "scripts": {
     "pre-test": "npm run clean-coverage",
     "test": "npm run pre-test && npx cypress run",
-    "clean": "rimraf dist",
     "clean-coverage": "rimraf coverage .nyc_output",
     "cypress": "npm run pre-test && npx cypress open",
     "coverage:report": "nyc report --reporter=lcov --reporter=json --reporter=text --reporter=json-summary",
     "format": "prettier --write \"src/**/*.ts\"",
-    "lint:ts": "eslint -c .eslintrc.js --ext .ts src",
-    "fix:ts": "eslint -c .eslintrc.js --ext .ts src --fix",
-    "build": "npm run clean && tsc && vite build && dts-bundle-generator --config ./dts.config.ts"
+    "lint:ts": "eslint -c .eslintrc.cjs --ext .ts src",
+    "fix:ts": "eslint -c .eslintrc.cjs --ext .ts src --fix",
+    "build": "npm run lint:ts && vite build && npm run dts",
+    "dts": "dts-bundle-generator --config ./dts.config.ts"
   },
   "publishConfig": {
     "access": "public",
@@ -51,12 +52,12 @@
   "devDependencies": {
     "@bahmutov/cypress-esbuild-preprocessor": "^2.1.3",
     "@cypress/code-coverage": "^3.10.0",
-    "@testing-library/cypress": "^8.0.3",
+    "@rollup/plugin-json": "^5.0.2",
     "@types/istanbul-lib-instrument": "^1.7.4",
     "@typescript-eslint/eslint-plugin": "^5.35.1",
     "@typescript-eslint/parser": "^5.35.1",
-    "cypress": "^10.6.0",
-    "dts-bundle-generator": "^6.12.0",
+    "cypress": "^12.0.2",
+    "dts-bundle-generator": "^7.1.0",
     "esbuild": "^0.14.30",
     "eslint": "^8.23.0",
     "eslint-plugin-jsdoc": "^39.3.6",
@@ -69,7 +70,7 @@
     "nyc": "^15.1.0",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
-    "typescript": "^4.7.4",
+    "typescript": "^4.9.4",
     "vite": "^3.0.9"
   }
 }

package/src/boolean/isApple.ts

@@ -1,4 +1,4 @@
-import { NavigatorUABrand } from '../interface/navigatorUA';
+import type { NavigatorUABrand } from '../interface/navigatorUA';
 import userAgentData from '../strings/userAgentData';
 import userAgent from '../strings/userAgent';
 

package/src/event/one.ts

@@ -14,7 +14,7 @@ const one = (
   /** Wrap the listener for easy on -> off */
   const handlerWrapper = (e: Event): void => {
     /* istanbul ignore else */
-    if (e.target === element) {
+    if (e.target === element || e.currentTarget === element) {
       listener.apply(element, [e]);
       off(element, eventName, handlerWrapper, options);
     }

package/src/get/getBoundingClientRect.ts

@@ -1,5 +1,5 @@
 import isHTMLElement from '../is/isHTMLElement';
-import { BoundingClientRect } from '../interface/boundingClientRect';
+import type { BoundingClientRect } from '../interface/boundingClientRect';
 
 /**
  * Returns the bounding client rect of a target `HTMLElement`.

package/src/get/getElementTransitionDelay.ts

@@ -14,7 +14,9 @@ const getElementTransitionDelay = (element: HTMLElement): number => {
   const delayValue = getElementStyle(element, transitionDelay);
   const delayScale = delayValue.includes('ms') ? /* istanbul ignore next */ 1 : 1000;
   const duration =
-    propertyValue && propertyValue !== 'none' ? parseFloat(delayValue) * delayScale : 0;
+    propertyValue && propertyValue !== 'none'
+      ? parseFloat(delayValue) * delayScale
+      : /* istanbul ignore next */ 0;
 
   return !Number.isNaN(duration) ? duration : /* istanbul ignore next */ 0;
 };

package/src/get/getElementTransitionDuration.ts

@@ -14,7 +14,9 @@ const getElementTransitionDuration = (element: HTMLElement): number => {
   const durationValue = getElementStyle(element, transitionDuration);
   const durationScale = durationValue.includes('ms') ? /* istanbul ignore next */ 1 : 1000;
   const duration =
-    propertyValue && propertyValue !== 'none' ? parseFloat(durationValue) * durationScale : 0;
+    propertyValue && propertyValue !== 'none'
+      ? parseFloat(durationValue) * durationScale
+      : /* istanbul ignore next */ 0;
 
   return !Number.isNaN(duration) ? duration : /* istanbul ignore next */ 0;
 };

package/src/get/getRectRelativeToOffsetParent.ts

@@ -1,4 +1,4 @@
-import { OffsetRect } from '../interface/offsetRect';
+import type { OffsetRect } from '../interface/offsetRect';
 import isScaledElement from '../is/isScaledElement';
 import isHTMLElement from '../is/isHTMLElement';
 import getBoundingClientRect from './getBoundingClientRect';

package/src/index.ts

@@ -160,7 +160,8 @@ import documentHead from './blocks/documentHead';
 
 // misc
 import ArrayFrom from './misc/ArrayFrom';
-import Data, { getInstance } from './misc/data';
+import Data from './misc/data';
+import getInstance from './misc/getInstance';
 import createElement from './misc/createElement';
 import createElementNS from './misc/createElementNS';
 import dispatchEvent from './misc/dispatchEvent';
@@ -175,6 +176,7 @@ import normalizeOptions from './misc/normalizeOptions';
 import normalizeValue from './misc/normalizeValue';
 import ObjectAssign from './misc/ObjectAssign';
 import ObjectEntries from './misc/ObjectEntries';
+import ObjectHasOwn from './misc/ObjectHasOwn';
 import ObjectKeys from './misc/ObjectKeys';
 import ObjectValues from './misc/ObjectValues';
 import createCustomEvent from './misc/createCustomEvent';
@@ -241,7 +243,7 @@ import getElementsByTagName from './selectors/getElementsByTagName';
 import getElementsByClassName from './selectors/getElementsByClassName';
 import matches from './selectors/matches';
 
-const SHORTY = {
+export {
   ariaChecked,
   ariaDescription,
   ariaDescribedBy,
@@ -434,6 +436,7 @@ const SHORTY = {
   ArrayFrom,
   Float32ArrayFrom,
   Float64ArrayFrom,
+  ObjectHasOwn,
   ObjectAssign,
   ObjectEntries,
   ObjectKeys,
@@ -454,5 +457,3 @@ const SHORTY = {
   removeAttribute,
   removeAttributeNS,
 };
-
-export default SHORTY;

package/src/interface/{boundingClientRect.ts → boundingClientRect.d.ts}

@@ -1,4 +1,4 @@
-export interface BoundingClientRect {
+export declare interface BoundingClientRect {
   width: number;
   height: number;
   top: number;

package/src/interface/css4Declaration.d.ts

@@ -0,0 +1,4 @@
+export declare interface CSS4Declaration
+  extends Exclude<() => string | symbol, CSSStyleDeclaration> {
+  [key: string]: string;
+}

package/src/interface/{customElement.ts → customElement.d.ts}

@@ -1,8 +1,8 @@
-export interface CustomElement extends HTMLElement {
+export declare interface CustomElement extends HTMLElement {
   shadowRoot: ShadowRoot;
   connectedCallback?: () => void;
   disconnectedCallback?: () => void;
   adoptedCallback?: () => void;
   attributeChangedCallback?: () => void;
-  [key: string]: any;
+  // [key: PropertyKey]: any;
 }

package/src/interface/{navigatorUA.ts → navigatorUA.d.ts}

@@ -1,15 +1,15 @@
 // https://github.com/lukewarlow/user-agent-data-types/blob/master/index.d.ts
-export interface NavigatorUABrand {
+export declare interface NavigatorUABrand {
   readonly brand: string;
   readonly version: string;
 }
 
-export interface NavigatorUAData {
+export declare interface NavigatorUAData {
   readonly brands: NavigatorUABrand[];
   readonly mobile: boolean;
   readonly platform: string;
 }
 
-export interface NavigatorUA extends Navigator {
+export declare interface NavigatorUA extends Navigator {
   readonly userAgentData: NavigatorUAData;
 }

package/src/interface/{offsetRect.ts → offsetRect.d.ts}

@@ -1,4 +1,4 @@
-export interface OffsetRect {
+export declare interface OffsetRect {
   width: number;
   height: number;
   x: number;

package/src/interface/originalEvent.d.ts

@@ -0,0 +1,4 @@
+export declare interface OriginalEvent extends CustomEvent<any> {
+  readonly type: string;
+  relatedTarget?: EventTarget;
+}

package/src/is/isArray.ts

@@ -4,6 +4,6 @@
  * @param obj array-like iterable object
  * @returns the query result
  */
-const isArray = (obj?: any): obj is any[] => Array.isArray(obj) || false;
+const isArray = (obj?: unknown): obj is any[] => Array.isArray(obj) || false;
 
 export default isArray;

package/src/is/isCanvas.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Checks if an element is an `HTMLCanvasElement` or `<canvas>`.
  *
@@ -5,7 +7,7 @@
  * @returns the query result
  */
 
-const isCanvas = (element?: Node): element is HTMLCanvasElement =>
-  (element && element.nodeName === 'CANVAS') || false;
+const isCanvas = (element?: unknown): element is HTMLCanvasElement =>
+  (isNode(element) && element.nodeName === 'CANVAS') || false;
 
 export default isCanvas;

package/src/is/isCustomElement.ts

@@ -1,4 +1,5 @@
-import { CustomElement } from '../interface/customElement';
+import isHTMLElement from './isHTMLElement';
+import type { CustomElement } from '../interface/customElement';
 
 /**
  * Checks if an object is a `CustomElement`.
@@ -6,7 +7,7 @@ import { CustomElement } from '../interface/customElement';
  * @param element the target object
  * @returns the query result
  */
-const isCustomElement = <T extends CustomElement>(element?: T | Node): element is T =>
-  (element && !!(element as CustomElement).shadowRoot) || false;
+const isCustomElement = <T extends CustomElement>(element?: unknown): element is T =>
+  (isHTMLElement(element) && !!(element as T).shadowRoot) || false;
 
 export default isCustomElement;

package/src/is/isDocument.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Checks if an object is a `Document`.
  *
@@ -6,6 +8,6 @@
  * @param obj the target object
  * @returns the query result
  */
-const isDocument = (obj?: Node | Document): obj is Document => (obj && obj.nodeType === 9) || false;
+const isDocument = (obj?: unknown): obj is Document => (isNode(obj) && obj.nodeType === 9) || false;
 
 export default isDocument;

package/src/is/isElement.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Checks if an object is an `Element`.
  *
@@ -19,7 +21,7 @@
  * @param element the target object
  * @returns the query result
  */
-const isElement = (element?: Element | Node): element is Element =>
-  (element && [1, 2, 3, 4, 5, 6, 7, 8].some(x => element.nodeType === x)) || false;
+const isElement = (element?: unknown): element is Element =>
+  (isNode(element) && [1, 2, 3, 4, 5, 6, 7, 8].some(x => element.nodeType === x)) || false;
 
 export default isElement;

package/src/is/isElementsArray.ts

@@ -7,7 +7,7 @@ import isArray from './isArray';
  * @param obj the target object
  * @returns the query result
  */
-const isElementsArray = (obj?: any): obj is HTMLElement[] =>
+const isElementsArray = (obj?: unknown): obj is HTMLElement[] =>
   (isArray(obj) && obj.every(isHTMLElement)) || false;
 
 export default isElementsArray;

package/src/is/isFunction.ts

@@ -4,7 +4,7 @@
  * @param fn the target object
  * @returns the query result
  */
-const isFunction = <T extends (...arg0: any[]) => any>(fn?: T): fn is T =>
+const isFunction = (fn?: unknown): fn is (...arg0: any[]) => any =>
   typeof fn === 'function' || false;
 
 export default isFunction;

package/src/is/isHTMLCollection.ts

@@ -1,10 +1,12 @@
+import isObject from './isObject';
+
 /**
  * Checks if an object is an `HTMLCollection`.
  *
  * @param obj the target object
  * @returns the query result
  */
-const isHTMLCollection = (obj?: HTMLCollection): obj is HTMLCollection =>
-  (obj && obj.constructor.name === 'HTMLCollection') || false;
+const isHTMLCollection = (obj?: unknown): obj is HTMLCollection =>
+  (isObject(obj) && obj.constructor.name === 'HTMLCollection') || false;
 
 export default isHTMLCollection;

package/src/is/isHTMLElement.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Checks if an element is an `HTMLElement`.
  *
@@ -6,6 +8,6 @@
  * @param element the target object
  * @returns the query result
  */
-const isHTMLElement = (element?: HTMLElement | Node): element is HTMLElement =>
-  (element && element.nodeType === 1) || false;
+const isHTMLElement = (element?: unknown): element is HTMLElement =>
+  (isNode(element) && element.nodeType === 1) || false;
 export default isHTMLElement;

package/src/is/isHTMLImageElement.ts

@@ -1,10 +1,12 @@
+import isHTMLElement from './isHTMLElement';
+
 /**
  * Check if a target element is an `<img>`.
  *
  * @param element the target element
  * @returns the query result
  */
-const isHTMLImageElement = (element?: HTMLImageElement): element is HTMLImageElement =>
-  (element && element.tagName === 'IMG') || false;
+const isHTMLImageElement = (element?: unknown): element is HTMLImageElement =>
+  (isHTMLElement(element) && element.tagName === 'IMG') || false;
 
 export default isHTMLImageElement;

package/src/is/isMap.ts

@@ -1,9 +1,11 @@
+import isObject from './isObject';
+
 /**
  * Checks if an element is a `Map`.
  *
  * @param obj the target object
  * @returns the query result
  */
-const isMap = <T extends Map<any, any>>(obj?: T): obj is T =>
-  (obj && obj.constructor.name === 'Map') || false;
+const isMap = (obj?: unknown): obj is Map<any, any> =>
+  (isObject(obj) && obj.constructor.name === 'Map') || false;
 export default isMap;

package/src/is/isMedia.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Checks if an element is an `<svg>` (or any type of SVG element),
  * `<img>`, `<video>` or `<canvas>`.
@@ -9,10 +11,9 @@
  */
 
 const isMedia = (
-  element?: SVGElement | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement,
+  element?: unknown,
 ): element is SVGElement | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement =>
-  (element &&
-    element.nodeType === 1 &&
+  (isNode(element) &&
     ['SVG', 'Image', 'Video', 'Canvas'].some(s => element.constructor.name.includes(s))) ||
   false;
 

package/src/is/isNode.ts

@@ -1,11 +1,17 @@
+import isObject from './isObject';
+
+type NodeObject = object & { nodeType: number };
+
 /**
  * Checks if an object is a `Node`.
  *
  * @param node the target object
  * @returns the query result
  */
-
-const isNode = (node?: Node): node is Node =>
-  (node && [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11].some(x => node.nodeType === x)) || false;
+const isNode = (node?: unknown): node is Node =>
+  (isObject(node) &&
+    typeof (node as NodeObject).nodeType === 'number' &&
+    [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11].some(x => (node as NodeObject).nodeType === x)) ||
+  false;
 
 export default isNode;

package/src/is/isNodeList.ts

@@ -1,3 +1,5 @@
+import isObject from './isObject';
+
 /**
  * Checks if an object is a `NodeList`.
  * => equivalent to `object instanceof NodeList`
@@ -5,7 +7,7 @@
  * @param obj the target object
  * @returns the query result
  */
-const isNodeList = (obj?: NodeList): obj is NodeList =>
-  (obj && obj.constructor.name === 'NodeList') || false;
+const isNodeList = (obj?: unknown): obj is NodeList =>
+  (isObject(obj) && obj.constructor.name === 'NodeList') || false;
 
 export default isNodeList;

package/src/is/isNumber.ts

@@ -4,6 +4,6 @@
  * @param num input value
  * @returns the query result
  */
-const isNumber = (num?: number): num is number => typeof num === 'number' || false;
+const isNumber = (num?: unknown): num is number => typeof num === 'number' || false;
 
 export default isNumber;

package/src/is/isObject.ts

@@ -4,6 +4,7 @@
  * @param obj the target object
  * @returns the query result
  */
-const isObject = (obj?: object): obj is object => typeof obj === 'object' || false;
+const isObject = (obj?: unknown): obj is object =>
+  (obj !== null && obj !== undefined && typeof obj === 'object') || false;
 
 export default isObject;

package/src/is/isSVGElement.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Check if an element is an `<svg>` or any other SVG element,
  * an equivalent to `SOMETHING instanceof SVGElement`.
@@ -5,7 +7,7 @@
  * @param element the target element
  * @returns the query result
  */
-const isSVGElement = (element?: SVGElement): element is SVGElement =>
-  (element && element.constructor.name.includes('SVG')) || false;
+const isSVGElement = (element?: unknown): element is SVGElement =>
+  (isNode(element) && element.constructor.name.includes('SVG')) || false;
 
 export default isSVGElement;

package/src/is/isShadowRoot.ts

@@ -1,10 +1,12 @@
+import isNode from './isNode';
+
 /**
  * Check if target is a `ShadowRoot`.
  *
  * @param element target
  * @returns the query result
  */
-const isShadowRoot = (element?: Node | ShadowRoot): element is ShadowRoot =>
-  (element && element.constructor.name === 'ShadowRoot') || false;
+const isShadowRoot = (element?: unknown): element is ShadowRoot =>
+  (isNode(element) && element.constructor.name === 'ShadowRoot') || false;
 
 export default isShadowRoot;

package/src/is/isString.ts

@@ -4,6 +4,6 @@
  * @param str input value
  * @returns the query result
  */
-const isString = (str?: string): str is string => typeof str === 'string' || false;
+const isString = (str?: unknown): str is string => typeof str === 'string' || false;
 
 export default isString;

package/src/is/isTableElement.ts

@@ -1,3 +1,5 @@
+import isNode from './isNode';
+
 /**
  * Check if a target element is a `<table>`, `<td>` or `<th>`.
  * This specific check is important for determining
@@ -6,9 +8,7 @@
  * @param element the target element
  * @returns the query result
  */
-const isTableElement = (
-  element?: HTMLTableElement | HTMLTableCellElement,
-): element is HTMLTableElement | HTMLTableCellElement =>
-  (element && ['TABLE', 'TD', 'TH'].includes(element.tagName)) || false;
+const isTableElement = (element?: unknown): element is HTMLTableElement | HTMLTableCellElement =>
+  (isNode(element) && ['TABLE', 'TD', 'TH'].includes(element.nodeName)) || false;
 
 export default isTableElement;

package/src/is/isWeakMap.ts

@@ -1,9 +1,11 @@
+import isObject from './isObject';
+
 /**
  * Checks if an element is a `WeakMap`.
  *
  * @param obj the target object
  * @returns the query result
  */
-const isWeakMap = <T extends WeakMap<any, unknown>>(obj?: T): obj is T =>
-  (obj && obj.constructor.name === 'WeakMap') || false;
+const isWeakMap = (obj?: unknown): obj is WeakMap<any, any> =>
+  (isObject(obj) && obj.constructor.name === 'WeakMap') || false;
 export default isWeakMap;

package/src/is/isWindow.ts

@@ -1,3 +1,5 @@
+import isObject from './isObject';
+
 /**
  * Check if a target object is `Window`.
  * => equivalent to `object instanceof Window`
@@ -5,7 +7,7 @@
  * @param obj the target object
  * @returns the query result
  */
-const isWindow = (obj?: Node | Window): obj is Window =>
-  (obj && obj.constructor.name === 'Window') || false;
+const isWindow = (obj?: unknown): obj is Window =>
+  (isObject(obj) && obj.constructor.name === 'Window') || false;
 
 export default isWindow;

package/src/misc/ObjectHasOwn.ts

@@ -0,0 +1,17 @@
+import isObject from '../is/isObject';
+
+/**
+ * A shortcut to `Object.hasOwn()` static method to work
+ * with regular `Object` elements.
+ *
+ * @see https://fettblog.eu/typescript-hasownproperty/
+ * @param obj the target object
+ * @param prop the property to check
+ * @returns the query result
+ */
+const ObjectHasOwn = <T extends object, K extends PropertyKey>(
+  obj: T,
+  prop: K,
+): obj is T & Record<K, unknown> => isObject(obj) && (Object.hasOwn(obj, prop) || prop in obj);
+
+export default ObjectHasOwn;

package/src/misc/createCustomEvent.ts

@@ -1,4 +1,4 @@
-import { OriginalEvent } from '../interface/originalEvent';
+import type { OriginalEvent } from '../interface/originalEvent';
 import isObject from '../is/isObject';
 import ObjectAssign from './ObjectAssign';
 

package/src/misc/createElement.ts

@@ -14,9 +14,7 @@ import ObjectEntries from './ObjectEntries';
  * @param param `tagName` or object
  * @return a new `HTMLElement`
  */
-const createElement = (
-  param?: string | Exclude<HTMLElement, ((...args: any[]) => any) | object>,
-): HTMLElement | undefined => {
+const createElement = (param?: string | Partial<HTMLElement>): HTMLElement | undefined => {
   if (!param) return undefined;
 
   if (isString(param)) {

package/src/misc/createElementNS.ts

@@ -17,7 +17,7 @@ import isString from '../is/isString';
  */
 const createElementNS = (
   ns: string,
-  param?: string | Exclude<HTMLElement, ((...args: any[]) => any) | object>,
+  param?: string | Partial<HTMLElement>,
 ): HTMLElement | undefined => {
   if (!ns || !param) return undefined;