@thednp/shorty 2.0.0-alpha1 → 2.0.0-alpha11

package/src/is/isArray.ts

@@ -1,9 +1,9 @@
 /**
- * Shortcut for `Array.isArray()` static method.
+ * Shortie for the `Array.isArray()` static method.
  *
- * @param arr array-like iterable object
+ * @param obj array-like iterable object
  * @returns the query result
  */
-const isArray = (arr?: any): arr is any[] => Array.isArray(arr) || false;
+const isArray = (obj?: unknown): obj is any[] => Array.isArray(obj) || false;
 
 export default isArray;

package/src/is/isCanvas.ts

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

package/src/is/isCustomElement.ts

@@ -1,10 +1,13 @@
+import isHTMLElement from './isHTMLElement';
+import type { CustomElement } from '../interface/customElement';
+
 /**
  * Checks if an object is a `CustomElement`.
  *
  * @param element the target object
  * @returns the query result
  */
-const isCustomElement = <T extends HTMLElement & { shadowRoot: Node }>(
-  element?: any
-): element is T => (element && !!element.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,10 +1,13 @@
+import isNode from './isNode';
+
 /**
  * Checks if an object is a `Document`.
+ *
  * @see https://dom.spec.whatwg.org/#node
  *
  * @param obj the target object
  * @returns the query result
  */
-const isDocument = (obj?: any): 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,6 +1,11 @@
+import isNode from './isNode';
+
 /**
  * Checks if an object is an `Element`.
+ *
  * @see https://dom.spec.whatwg.org/#node
+ *
+ * ```
  * ELEMENT_NODE = 1;
  * ATTRIBUTE_NODE = 2;
  * TEXT_NODE = 3;
@@ -12,11 +17,11 @@
  * DOCUMENT_NODE = 9;
  * DOCUMENT_TYPE_NODE = 10;
  * DOCUMENT_FRAGMENT_NODE = 11;
- *
+ * ```
  * @param element the target object
  * @returns the query result
  */
-const isElement = (element?: any): 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/isElementInScrollRange.ts

@@ -1,6 +1,6 @@
-import getBoundingClientRect from "../get/getBoundingClientRect";
-import getDocumentElement from "../get/getDocumentElement";
-import isNode from "./isNode";
+import getBoundingClientRect from '../get/getBoundingClientRect';
+import getDocumentElement from '../get/getDocumentElement';
+import isNode from './isNode';
 
 /**
  * Utility to determine if an `HTMLElement`
@@ -10,7 +10,7 @@ import isNode from "./isNode";
  * @return the query result
  */
 const isElementInScrollRange = (element?: HTMLElement): boolean => {
-  if (!element || !isNode(element)) return false;
+  if (!isNode(element)) return false;
 
   const { top, bottom } = getBoundingClientRect(element);
   const { clientHeight } = getDocumentElement(element);

package/src/is/isElementInViewport.ts

@@ -1,6 +1,6 @@
-import getBoundingClientRect from "../get/getBoundingClientRect";
-import getDocumentElement from "../get/getDocumentElement";
-import isNode from "./isNode";
+import getBoundingClientRect from '../get/getBoundingClientRect';
+import getDocumentElement from '../get/getDocumentElement';
+import isNode from './isNode';
 
 /**
  * Utility to determine if an `HTMLElement`
@@ -10,7 +10,7 @@ import isNode from "./isNode";
  * @return the query result
  */
 const isElementInViewport = (element?: HTMLElement): boolean => {
-  if (!element || !isNode(element)) return false;
+  if (!isNode(element)) return false;
 
   const { clientWidth, clientHeight } = getDocumentElement(element);
   const { top, left, bottom, right } = getBoundingClientRect(element, true);

package/src/is/isElementsArray.ts

@@ -1,5 +1,5 @@
-import isHTMLElement from "./isHTMLElement";
-import isArray from "./isArray";
+import isHTMLElement from './isHTMLElement';
+import isArray from './isArray';
 
 /**
  * Checks if an object is an `Array` in which all items are `Element`.
@@ -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 = (fn?: any): fn is Function =>
-  (fn && fn.constructor.name === "Function") || false;
+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?: any): 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,10 +1,13 @@
+import isNode from './isNode';
+
 /**
  * Checks if an element is an `HTMLElement`.
+ *
  * @see https://dom.spec.whatwg.org/#node
  *
  * @param element the target object
  * @returns the query result
  */
-const isHTMLElement = (element?: any): 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,9 +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?: any): 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/isJSON.ts

@@ -0,0 +1,20 @@
+import isString from './isString';
+
+/**
+ * Checks if a string is a `JSON` string.
+ *
+ * @param str the target string
+ * @returns the query result
+ */
+const isJSON = (str?: string): boolean => {
+  if (!isString(str)) return false;
+
+  try {
+    JSON.parse(str);
+  } catch (e) {
+    return false;
+  }
+  return true;
+};
+
+export default isJSON;

package/src/is/isMap.ts

@@ -0,0 +1,11 @@
+import isObject from './isObject';
+
+/**
+ * Checks if an element is a `Map`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+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,16 +1,20 @@
+import isNode from './isNode';
+
 /**
  * Checks if an element is an `<svg>` (or any type of SVG element),
- * `<img>` or `<video>`.
+ * `<img>`, `<video>` or `<canvas>`.
  *
  * *Tooltip* / *Popover* works different with media elements.
+ *
  * @param element the target element
  * @returns the query result
  */
 
-const isMedia = (element?: any): element is SVGElement | HTMLImageElement | HTMLVideoElement =>
-  (element &&
-    element.nodeType === 1 &&
-    ["SVG", "Image", "Video"].some((s) => element.constructor.name.includes(s))) ||
+const isMedia = (
+  element?: unknown,
+): element is SVGElement | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement =>
+  (isNode(element) &&
+    ['SVG', 'Image', 'Video', 'Canvas'].some(s => element.constructor.name.includes(s))) ||
   false;
 
 export default isMedia;

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?: any): 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?: any): 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

@@ -1,9 +1,9 @@
 /**
- * Shortcut for `typeof SOMETHING === "number"`.
+ * Shortie for `typeof SOMETHING === "number"`.
  *
  * @param num input value
  * @returns the query result
  */
-const isNumber = (num?: any): 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

@@ -1,9 +1,10 @@
 /**
- * Checks if an object is an `Object`.
+ * Checks if a value is an `Object`.
  *
  * @param obj the target object
  * @returns the query result
  */
-const isObject = (obj?: any): 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/isRTL.ts

@@ -1,10 +1,11 @@
-import getDocumentElement from "../get/getDocumentElement";
+import getDocumentElement from '../get/getDocumentElement';
 
 /**
  * Checks if a page is Right To Left.
+ *
  * @param node the target
  * @returns the query result
  */
-const isRTL = (node?: Node): boolean => getDocumentElement(node).dir === "rtl";
+const isRTL = (node?: Node): boolean => getDocumentElement(node).dir === 'rtl';
 
 export default isRTL;

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?: any): 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/isScaledElement.ts

@@ -1,16 +1,19 @@
-import isHTMLElement from "./isHTMLElement";
-import getBoundingClientRect from "../get/getBoundingClientRect";
+import isHTMLElement from './isHTMLElement';
+import getBoundingClientRect from '../get/getBoundingClientRect';
 
 /**
  * Checks if a target `HTMLElement` is affected by scale.
+ *
  * @see https://github.com/floating-ui/floating-ui
  *
  * @param element target
  * @returns the query result
  */
-export default function isScaledElement(element?: HTMLElement): boolean {
+const isScaledElement = (element?: HTMLElement): boolean => {
   if (!isHTMLElement(element)) return false;
   const { width, height } = getBoundingClientRect(element);
   const { offsetWidth, offsetHeight } = element;
   return Math.round(width) !== offsetWidth || Math.round(height) !== offsetHeight;
-}
+};
+
+export default isScaledElement;

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?: any): 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

@@ -1,9 +1,9 @@
 /**
- * Shortcut for `typeof SOMETHING === "string"`.
+ * Shortie for `typeof SOMETHING === "string"`.
  *
  * @param str input value
  * @returns the query result
  */
-const isString = (str?: any): 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,7 +8,7 @@
  * @param element the target element
  * @returns the query result
  */
-const isTableElement = (element?: any): 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

@@ -0,0 +1,11 @@
+import isObject from './isObject';
+
+/**
+ * Checks if an element is a `WeakMap`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+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,6 +7,7 @@
  * @param obj the target object
  * @returns the query result
  */
-const isWindow = (obj?: any): 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/ArrayFrom.ts

@@ -1,9 +1,11 @@
 /**
- * Shortcut for `Array.from()` static method.
+ * Shortie for `Array.from()` static method.
+ * The utility should also work with any typed arrays
+ * like Float64Array or Int32Array.
  *
  * @param arr array-like iterable object
  * @returns a new array from iterable object
  */
-const ArrayFrom = (arr: Iterable<any>): any[] => Array.from(arr);
+const ArrayFrom = <T>(arr: ArrayLike<T> | Iterable<T>): T[] => Array.from(arr);
 
 export default ArrayFrom;

package/src/misc/Float32ArrayFrom.ts

@@ -1,9 +1,10 @@
 /**
  * Shortcut for `Float32Array.from()` static method.
+ *
  * @param arr array-like iterable object
  * @returns a new Float32Array
  */
-const Float32ArrayFrom = (arr: any[] | Map<any, any>): Float32Array =>
+const Float32ArrayFrom = (arr: ArrayLike<number> | Iterable<number>): Float32Array =>
   Float32Array.from(Array.from(arr));
 
 export default Float32ArrayFrom;

package/src/misc/Float64ArrayFrom.ts

@@ -1,9 +1,10 @@
 /**
  * Shortcut for `Float64Array.from()` static method.
+ *
  * @param arr array-like iterable object
  * @returns a new Float64Array
  */
-const Float64ArrayFrom = (arr: any[] | Map<any, any>): Float64Array =>
+const Float64ArrayFrom = (arr: ArrayLike<number> | Iterable<number>): Float64Array =>
   Float64Array.from(Array.from(arr));
 
 export default Float64ArrayFrom;

package/src/misc/ObjectAssign.ts

@@ -1,8 +1,43 @@
+/**
+ * Overloads for Object.assign.
+ *
+ * @see https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/object-assign/index.d.ts
+ */
+declare function ObjectAssignTyped<T, U>(target: T, source: U): T & U;
+declare function ObjectAssignTyped<T, U, V>(target: T, source1: U, source2: V): T & U & V;
+declare function ObjectAssignTyped<T, U, V, W>(
+  target: T,
+  source1: U,
+  source2: V,
+  source3: W,
+): T & U & V & W;
+declare function ObjectAssignTyped<T, U, V, W, Q>(
+  target: T,
+  source1: U,
+  source2: V,
+  source3: W,
+  source4: Q,
+): T & U & V & W & Q;
+declare function ObjectAssignTyped<T, U, V, W, Q, R>(
+  target: T,
+  source1: U,
+  source2: V,
+  source3: W,
+  source4: Q,
+  source5: R,
+): T & U & V & W & Q & R;
+declare function ObjectAssignTyped(target: any, ...sources: any[]): any;
+
 /**
  * Shortcut for `Object.assign()` static method.
+ *
  * @param obj a target object
- * @param source a source object
+ * @param source source object(s)
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
  */
-const ObjectAssign = (obj: Record<string, any>, source: Record<string, any>) =>
-  Object.assign(obj, source);
+const ObjectAssign: typeof ObjectAssignTyped = <A extends Record<string, any>, B>(
+  obj: A,
+  ...source: B[]
+): B extends Record<string, any>[] ? any : A & B => Object.assign(obj, ...source);
+
 export default ObjectAssign;

package/src/misc/ObjectEntries.ts

@@ -1,8 +1,11 @@
 /**
  * Shortcut for `Object.entries()` static method.
+ *
  * @param obj a target object
- * @returns the entries of an object in an array format
+ * @returns the entries of an object in an array format [key, value][]
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
  */
-const ObjectEntries = (obj: Record<string, any>): [string, any][] => Object.entries(obj);
+const ObjectEntries = <O extends Record<string, any>>(obj: O) =>
+  Object.entries(obj) as [keyof O, O[keyof O]][];
 
 export default ObjectEntries;

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/ObjectKeys.ts

@@ -1,8 +1,10 @@
 /**
  * Shortcut for `Object.keys()` static method.
+ *
  * @param obj a target object
  * @returns an array with object keys
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
  */
-const ObjectKeys = (obj: Record<string, any>): string[] => Object.keys(obj);
+const ObjectKeys = <O extends Record<string, any>>(obj: O) => Object.keys(obj) as (keyof O)[];
 
 export default ObjectKeys;

package/src/misc/ObjectValues.ts

@@ -1,8 +1,11 @@
 /**
  * Shortcut for `Object.values()` static method.
+ *
  * @param obj a target object
  * @returns an array with the object values
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
  */
-const ObjectValues = (obj: Record<string, any>): any[] => Object.values(obj);
+const ObjectValues = <O extends Record<string, unknown>>(obj: O): O[keyof O][] =>
+  Object.values(obj) as O[keyof O][];
 
 export default ObjectValues;

package/src/misc/createCustomEvent.ts

@@ -0,0 +1,28 @@
+import type { OriginalEvent } from '../interface/originalEvent';
+import isObject from '../is/isObject';
+import ObjectAssign from './ObjectAssign';
+
+/**
+ * Returns a namespaced `CustomEvent` specific to each component.
+ *
+ * @param eventType Event.type
+ * @param config Event.options | Event.properties
+ * @returns a new namespaced event
+ */
+const createCustomEvent = <T extends OriginalEvent>(
+  eventType: string,
+  config?: CustomEventInit<any>,
+): T => {
+  const OriginalCustomEvent = new CustomEvent<any>(eventType, {
+    cancelable: true,
+    bubbles: true,
+  } as CustomEventInit<any>) as T;
+
+  /* istanbul ignore else */
+  if (isObject(config)) {
+    ObjectAssign(OriginalCustomEvent, config);
+  }
+  return OriginalCustomEvent;
+};
+
+export default createCustomEvent;