@thednp/shorty 2.0.0-alpha1 → 2.0.0-alpha4

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

package/src/is/isFunction.ts

@@ -4,7 +4,6 @@
  * @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?: any): fn is (() => any) => (fn && fn.constructor.name === 'Function') || false;
 
 export default isFunction;

package/src/is/isHTMLCollection.ts

@@ -5,6 +5,6 @@
  * @returns the query result
  */
 const isHTMLCollection = (obj?: any): obj is HTMLCollection =>
-  (obj && obj.constructor.name === "HTMLCollection") || false;
+  (obj && obj.constructor.name === 'HTMLCollection') || false;
 
 export default isHTMLCollection;

package/src/is/isHTMLElement.ts

@@ -5,6 +5,5 @@
  * @param element the target object
  * @returns the query result
  */
-const isHTMLElement = (element?: any): element is HTMLElement =>
-  (element && element.nodeType === 1) || false;
+const isHTMLElement = (element?: any): element is HTMLElement => (element && element.nodeType === 1) || false;
 export default isHTMLElement;

package/src/is/isHTMLImageElement.ts

@@ -4,6 +4,6 @@
  * @returns the query result
  */
 const isHTMLImageElement = (element?: any): element is HTMLImageElement =>
-  (element && element.tagName === "IMG") || false;
+  (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?: any): 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,8 @@
+/**
+ * Checks if an element is a `Map`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+const isMap = (obj?: any): obj is Map<any, any> => (obj && obj.constructor.name === 'Map') || false;
+export default isMap;

package/src/is/isMedia.ts

@@ -1,16 +1,16 @@
 /**
  * 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 =>
+const isMedia = (element?: any): element is SVGElement | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement =>
   (element &&
     element.nodeType === 1 &&
-    ["SVG", "Image", "Video"].some((s) => element.constructor.name.includes(s))) ||
+    ['SVG', 'Image', 'Video', 'Canvas'].some((s) => element.constructor.name.includes(s))) ||
   false;
 
 export default isMedia;

package/src/is/isNodeList.ts

@@ -5,7 +5,6 @@
  * @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?: any): obj is NodeList => (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?: any): num is number => typeof num === 'number' || false;
 
 export default isNumber;

package/src/is/isObject.ts

@@ -1,9 +1,9 @@
 /**
- * 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?: any): obj is object => typeof obj === 'object' || false;
 
 export default isObject;

package/src/is/isRTL.ts

@@ -1,10 +1,10 @@
-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

@@ -6,6 +6,6 @@
  * @returns the query result
  */
 const isSVGElement = (element?: any): element is SVGElement =>
-  (element && element.constructor.name.includes("SVG")) || false;
+  (element && element.constructor.name.includes('SVG')) || false;
 
 export default isSVGElement;

package/src/is/isScaledElement.ts

@@ -1,5 +1,5 @@
-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.

package/src/is/isShadowRoot.ts

@@ -5,6 +5,6 @@
  * @returns the query result
  */
 const isShadowRoot = (element?: any): element is ShadowRoot =>
-  (element && element.constructor.name === "ShadowRoot") || false;
+  (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?: any): str is string => typeof str === 'string' || false;
 
 export default isString;

package/src/is/isTableElement.ts

@@ -7,6 +7,6 @@
  * @returns the query result
  */
 const isTableElement = (element?: any): element is HTMLTableElement | HTMLTableCellElement =>
-  (element && ["TABLE", "TD", "TH"].includes(element.tagName)) || false;
+  (element && ['TABLE', 'TD', 'TH'].includes(element.tagName)) || false;
 
 export default isTableElement;

package/src/is/isWeakMap.ts

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

package/src/is/isWindow.ts

@@ -5,6 +5,6 @@
  * @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?: any): obj is Window => (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

@@ -3,7 +3,7 @@
  * @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

@@ -3,7 +3,7 @@
  * @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,11 @@
 /**
  * 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 = <A extends {}, B>(obj: A, ...source: B[]): B extends any[] ? any : A & B =>
+  Object.assign(obj, ...source);
+
 export default ObjectAssign;

package/src/misc/ObjectEntries.ts

@@ -1,8 +1,9 @@
 /**
  * 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 {}>(obj: O) => Object.entries(obj) as [keyof O, O[keyof O]][];
 
 export default ObjectEntries;

package/src/misc/ObjectKeys.ts

@@ -2,7 +2,8 @@
  * 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 {}>(obj: O) => Object.keys(obj) as (keyof O)[];
 
 export default ObjectKeys;

package/src/misc/ObjectValues.ts

@@ -2,7 +2,8 @@
  * 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 {}>(obj: O) => Object.values(obj) as (O[keyof O])[];
 
 export default ObjectValues;

package/src/misc/OriginalEvent.ts

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

package/src/misc/createElement.ts

@@ -1,11 +1,12 @@
-import setAttribute from "../attr/setAttribute";
-import getDocument from "../get/getDocument";
-import ObjectEntries from "./ObjectEntries";
+import isString from '../is/isString';
+import setAttribute from '../attr/setAttribute';
+import getDocument from '../get/getDocument';
+import ObjectEntries from './ObjectEntries';
 
 /**
- * This is a shortie for `document.createElement` method
+ * Shortie for `document.createElement` method
  * which allows you to create a new `HTMLElement` for a given `tagName`
- * or based on an object with specific non-readonly attributes:
+ * or based on an object with specific non-readonly attributes with string values:
  * `id`, `className`, `textContent`, `style`, etc.
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement
  *
@@ -15,7 +16,7 @@ import ObjectEntries from "./ObjectEntries";
 const createElement = (param?: string | Partial<HTMLElement>): HTMLElement | undefined => {
   if (!param) return undefined;
 
-  if (typeof param === "string") {
+  if (typeof param === 'string') {
     return getDocument().createElement(param);
   }
 
@@ -28,7 +29,9 @@ const createElement = (param?: string | Partial<HTMLElement>): HTMLElement | und
   delete attr.tagName;
 
   ObjectEntries(attr).forEach(([key, value]) => {
-    setAttribute(newElement, key, value);
+    if (isString(value)) {
+      setAttribute(newElement, key, value);
+    }
   });
   return newElement;
 };

package/src/misc/createElementNS.ts

@@ -1,11 +1,12 @@
-import getDocument from "../get/getDocument";
-import ObjectEntries from "./ObjectEntries";
-import setAttribute from "../attr/setAttribute";
+import getDocument from '../get/getDocument';
+import ObjectEntries from './ObjectEntries';
+import setAttribute from '../attr/setAttribute';
+import isString from '../is/isString';
 
 /**
- * This is a shortie for `document.createElementNS` method
+ * Shortie for `document.createElementNS` method
  * which allows you to create a new `HTMLElement` for a given `tagName`
- * or based on an object with specific non-readonly attributes:
+ * or based on an object with specific non-readonly attributes with string values:
  * `id`, `className`, `textContent`, `style`, etc.
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElementNS
  *
@@ -13,18 +14,15 @@ import setAttribute from "../attr/setAttribute";
  * @param param `tagName` or object
  * @return a new `HTMLElement`
  */
-const createElementNS = (
-  ns?: string,
-  param?: string | Partial<HTMLElement>
-): HTMLElement | undefined => {
-  if (!ns && !param) return undefined;
+const createElementNS = (ns: string, param?: string | Partial<HTMLElement>): HTMLElement | undefined => {
+  if (!ns || !param) return undefined;
 
-  if (typeof param === "string") {
+  if (typeof param === 'string') {
     return getDocument().createElementNS(ns, param) as HTMLElement;
   }
 
   const { tagName } = param;
-  const newElement = createElementNS(ns, tagName as string);
+  const newElement = createElementNS(ns, tagName);
 
   if (!newElement) return undefined;
 
@@ -32,7 +30,9 @@ const createElementNS = (
   delete attr.tagName;
 
   ObjectEntries(attr).forEach(([key, value]) => {
-    setAttribute(newElement, key, value);
+    if (isString(value)) {
+      setAttribute(newElement, key, value);
+    }
   });
 
   return newElement;

package/src/misc/data.ts

@@ -1,6 +1,8 @@
-import isHTMLElement from "../is/isHTMLElement";
+import isHTMLElement from '../is/isHTMLElement';
 
-type ComponentDataMap = Map<string, Map<HTMLElement, Record<string, any>>>;
+type ComponentData = Record<string, any>;
+type ElementComponentMap = Map<HTMLElement, ComponentData>;
+type ComponentDataMap = Map<string, ElementComponentMap>;
 
 const componentData: ComponentDataMap = new Map();
 
@@ -15,7 +17,7 @@ const Data = {
    * @param component the component's name or a unique key
    * @param instance the component instance
    */
-  set: (element: HTMLElement, component: string, instance: Record<string, any>): void => {
+  set: <T>(element: HTMLElement, component: string, instance: T): void => {
     if (!isHTMLElement(element)) return;
 
     /* istanbul ignore else */
@@ -25,15 +27,15 @@ const Data = {
 
     const instanceMap = componentData.get(component);
     // not undefined, but defined right above
-    instanceMap.set(element, instance);
+    (instanceMap as ElementComponentMap).set(element, instance);
   },
 
   /**
    * Returns all instances for specified component.
    * @param component the component's name or a unique key
-   * @returns {} all the component instances
+   * @returns all the component instances
    */
-  getAllFor: (component: string): Map<HTMLElement, Record<string, any>> | null => {
+  getAllFor: (component: string): ElementComponentMap | null => {
     const instanceMap = componentData.get(component);
 
     return instanceMap || null;
@@ -45,12 +47,12 @@ const Data = {
    * @param component the component's name or a unique key
    * @returns the instance
    */
-  get: (element: HTMLElement, component: string): Record<string, any> | null => {
+  get: <T>(element: HTMLElement, component: string): T | null => {
     if (!isHTMLElement(element) || !component) return null;
-    const allForC = Data.getAllFor(component);
-    const instance = element && allForC && allForC.get(element);
+    const instanceMap = Data.getAllFor(component);
+    const instance = element && instanceMap && instanceMap.get(element);
 
-    return instance || null;
+    return (instance as T) || null;
   },
 
   /**
@@ -59,7 +61,7 @@ const Data = {
    * @param component the component's name or a unique key
    */
   remove: (element: HTMLElement, component: string): void => {
-    const instanceMap = componentData.get(component);
+    const instanceMap = Data.getAllFor(component);
     if (!instanceMap || !isHTMLElement(element)) return;
 
     instanceMap.delete(element);
@@ -74,6 +76,6 @@ const Data = {
 /**
  * An alias for `Data.get()`.
  */
-export const getInstance = (target: HTMLElement, component: string) => Data.get(target, component);
+export const getInstance = <T>(target: HTMLElement, component: string): T | null => Data.get<T>(target, component);
 
 export default Data;

package/src/misc/dispatchEvent.ts

@@ -4,6 +4,6 @@
  * @param element is the target
  * @param event is the `Event` object
  */
-const dispatchEvent = (element: HTMLElement, event: Event): boolean => element.dispatchEvent(event);
+const dispatchEvent = (element: EventTarget, event: Event): boolean => element.dispatchEvent(event);
 
 export default dispatchEvent;

package/src/misc/distinct.ts

@@ -7,11 +7,11 @@
  * [0,1,1,2].filter(distinct)
  * // => [0,1,2]
  * ```
- * @param value aray item value
+ * @param value array item value
  * @param index array item index
- * @param self the array
+ * @param arr a clone of the target array
  * @returns the query result
  */
-const distinct = (value: any, index: number, self: any[]): boolean => self.indexOf(value) === index;
+const distinct = <T>(value: T, index: number, arr: T[]): boolean => arr.indexOf(value) === index;
 
 export default distinct;

package/src/misc/emulateAnimationEnd.ts

@@ -1,7 +1,7 @@
-import animationEndEvent from "../strings/animationEndEvent";
-import getElementAnimationDelay from "../get/getElementAnimationDelay";
-import getElementAnimationDuration from "../get/getElementAnimationDuration";
-import dispatchEvent from "./dispatchEvent";
+import animationEndEvent from '../strings/animationEndEvent';
+import getElementAnimationDelay from '../get/getElementAnimationDelay';
+import getElementAnimationDuration from '../get/getElementAnimationDuration';
+import dispatchEvent from './dispatchEvent';
 
 /**
  * Utility to make sure callbacks are consistently
@@ -17,9 +17,7 @@ const emulateAnimationEnd = (element: HTMLElement, handler: EventListener): void
   const delay = getElementAnimationDelay(element);
 
   if (duration) {
-    /**
-     * Wrap the handler in on -> off callback
-     */
+    /** Wrap the handler in on -> off callback */
     const animationEndWrapper = (e: Event): void => {
       /* istanbul ignore else */
       if (e.target === element) {

package/src/misc/emulateTransitionEnd.ts

@@ -1,7 +1,7 @@
-import transitionEndEvent from "../strings/transitionEndEvent";
-import getElementTransitionDelay from "../get/getElementTransitionDelay";
-import getElementTransitionDuration from "../get/getElementTransitionDuration";
-import dispatchEvent from "./dispatchEvent";
+import transitionEndEvent from '../strings/transitionEndEvent';
+import getElementTransitionDelay from '../get/getElementTransitionDelay';
+import getElementTransitionDuration from '../get/getElementTransitionDuration';
+import dispatchEvent from './dispatchEvent';
 
 /**
  * Utility to make sure callbacks are consistently
@@ -17,10 +17,8 @@ const emulateTransitionEnd = (element: HTMLElement, handler: EventListener): voi
   const delay = getElementTransitionDelay(element);
 
   if (duration) {
-    /**
-     * Wrap the handler in on -> off callback
-     */
-    const transitionEndWrapper = (e: Event) => {
+    /** Wrap the handler in on -> off callback */
+    const transitionEndWrapper = (e: Event): void => {
       /* istanbul ignore else */
       if (e.target === element) {
         handler.apply(element, [e]);

package/src/misc/focus.ts

@@ -1,8 +1,9 @@
 /**
- * Utility to focus an `HTMLElement` target.
+ * Shortie for `HTMLElement.focus()` method.
  *
  * @param element is the target
+ * @param options allows to pass additional options such as `preventScroll: boolean`
  */
-const focus = (element: HTMLElement) => element.focus();
+const focus = (element: HTMLOrSVGElement, options?: FocusOptions): void => element.focus(options);
 
 export default focus;

package/src/misc/noop.ts

@@ -1,4 +1,6 @@
 /** A generic function with empty body. */
-const noop = () => {};
+const noop = () => {
+  // this is a noop
+};
 
 export default noop;