@thednp/shorty 1.0.3 → 2.0.0-alpha10

package/src/misc/timer.ts

@@ -0,0 +1,84 @@
+import isMap from '../is/isMap';
+import isHTMLElement from '../is/isHTMLElement';
+import isNumber from '../is/isNumber';
+
+type KeyMap = Map<string, number>;
+type TimeMap = Map<HTMLElement, number | KeyMap>;
+
+const TimeCache: TimeMap = new Map() as TimeMap;
+/**
+ * An interface for one or more `TimerHandler`s per `Element`.
+ *
+ * @see https://github.com/thednp/navbar/
+ */
+const Timer = {
+  /**
+   * Sets a new timeout timer for an element, or element -> key association.
+   *
+   * @param element target element
+   * @param callback the callback
+   * @param delay the execution delay
+   * @param key a unique key
+   */
+  set: (element: HTMLElement, callback: TimerHandler, delay: number, key?: string): void => {
+    if (!isHTMLElement(element)) return;
+
+    /* istanbul ignore else */
+    if (key && key.length) {
+      /* istanbul ignore else */
+      if (!TimeCache.has(element)) {
+        TimeCache.set(element, new Map());
+      }
+      // eslint-disable-next-line @typescript-eslint/no-implied-eval
+      (TimeCache.get(element) as KeyMap).set(key, setTimeout(callback, delay));
+    } else {
+      // eslint-disable-next-line @typescript-eslint/no-implied-eval
+      TimeCache.set(element, setTimeout(callback, delay));
+    }
+  },
+
+  /**
+   * Returns the timer associated with the target.
+   *
+   * @param element target element
+   * @param key a unique
+   * @returns the timer
+   */
+  get: (element: HTMLElement, key?: string): number | null => {
+    if (!isHTMLElement(element)) return null;
+    const keyTimers = TimeCache.get(element);
+
+    if (key && keyTimers && isMap(keyTimers as KeyMap)) {
+      return (keyTimers as KeyMap).get(key) || /* istanbul ignore next */ null;
+    } else if (isNumber(keyTimers as number)) {
+      return keyTimers as number;
+    }
+    return null;
+  },
+
+  /**
+   * Clears the element's timer.
+   *
+   * @param element target element
+   * @param key a unique key
+   */
+  clear: (element: HTMLElement, key?: string): void => {
+    if (!isHTMLElement(element)) return;
+
+    const keyTimers = TimeCache.get(element);
+
+    if (key && key.length && isMap(keyTimers as KeyMap)) {
+      clearTimeout((keyTimers as KeyMap).get(key));
+      (keyTimers as KeyMap).delete(key);
+      /* istanbul ignore else */
+      if ((keyTimers as KeyMap).size === 0) {
+        TimeCache.delete(element);
+      }
+    } else {
+      clearTimeout(keyTimers as number);
+      TimeCache.delete(element);
+    }
+  },
+};
+
+export default Timer;

package/src/misc/toLowerCase.ts

@@ -0,0 +1,9 @@
+/**
+ * Shortcut for `String.toLowerCase()`.
+ *
+ * @param source input string
+ * @returns lowercase output string
+ */
+const toLowerCase = (source: string): string => source.toLowerCase();
+
+export default toLowerCase;

package/src/misc/toUpperCase.ts

@@ -0,0 +1,9 @@
+/**
+ * Shortcut for `String.toUpperCase()`.
+ *
+ * @param source input string
+ * @returns uppercase output string
+ */
+const toUpperCase = (source: string): string => source.toUpperCase();
+
+export default toUpperCase;

package/src/selectors/closest.ts

@@ -0,0 +1,20 @@
+/**
+ * Shortcut for `HTMLElement.closest` method which also works
+ * with children of `ShadowRoot`. The order of the parameters
+ * is intentional since they're both required.
+ *
+ * @see https://stackoverflow.com/q/54520554/803358
+ *
+ * @param element Element to look into
+ * @param selector the selector name
+ * @return the query result
+ */
+const closest = (element: HTMLElement, selector: string): HTMLElement | null => {
+  return element
+    ? element.closest(selector) ||
+        // break out of `ShadowRoot`
+        closest((element.getRootNode() as HTMLElement & { host: HTMLElement }).host, selector)
+    : null;
+};
+
+export default closest;

package/src/selectors/{getCustomElements.js → getCustomElements.ts}

@@ -1,16 +1,20 @@
 import isCustomElement from '../is/isCustomElement';
 import getElementsByTagName from './getElementsByTagName';
+import type { CustomElement } from '../interface/customElement';
 
 /**
  * Returns an `Array` of `Node` elements that are registered as
  * `CustomElement`.
+ *
  * @see https://stackoverflow.com/questions/27334365/how-to-get-list-of-registered-custom-elements
  *
- * @param {ParentNode=} parent parent to look into
- * @returns {Array<HTMLElement>} the query result
+ * @param parent parent to look into
+ * @returns the query result
  */
-export default function getCustomElements(parent) {
+const getCustomElements = (parent?: ParentNode): CustomElement[] => {
   const collection = getElementsByTagName('*', parent);
 
   return [...collection].filter(isCustomElement);
-}
+};
+
+export default getCustomElements;

package/src/selectors/getElementById.ts

@@ -0,0 +1,16 @@
+import getDocument from '../get/getDocument';
+
+/**
+ * Returns an `HTMLElement` that matches the id in the document.
+ * Within multiple <iframe> elements, a `parent` parameter
+ * would decisively locate the correct element.
+ *
+ * @param id the ID selector
+ * @param context an element in it's document or document
+ * @returns the requested element
+ */
+const getElementById = (id: string, context?: Node): HTMLElement | null => {
+  return getDocument(context).getElementById(id) || null;
+};
+
+export default getElementById;

package/src/selectors/getElementsByClassName.ts

@@ -0,0 +1,22 @@
+import getDocument from '../get/getDocument';
+import isNode from '../is/isNode';
+
+/**
+ * Shortcut for `HTMLElement.getElementsByClassName` method. Some `Node` elements
+ * like `ShadowRoot` do not support `getElementsByClassName`.
+ *
+ * @param selector the class name
+ * @param parent optional Element to look into
+ * @return the 'HTMLCollection'
+ */
+const getElementsByClassName = (
+  selector: string,
+  parent?: ParentNode,
+): HTMLCollectionOf<HTMLElement> => {
+  const lookUp = parent && isNode(parent) ? parent : getDocument();
+  return (lookUp as HTMLElement | Document).getElementsByClassName(
+    selector,
+  ) as HTMLCollectionOf<HTMLElement>;
+};
+
+export default getElementsByClassName;

package/src/selectors/getElementsByTagName.ts

@@ -0,0 +1,20 @@
+import getDocument from '../get/getDocument';
+import isNode from '../is/isNode';
+
+/**
+ * Shortcut for `HTMLElement.getElementsByTagName` method. Some `Node` elements
+ * like `ShadowRoot` do not support `getElementsByTagName`.
+ *
+ * @param selector the tag name
+ * @param parent optional Element to look into
+ * @return the 'HTMLCollection'
+ */
+const getElementsByTagName = (
+  selector: string,
+  parent?: ParentNode,
+): HTMLCollectionOf<HTMLElement> => {
+  const lookUp = isNode(parent) ? parent : getDocument();
+  return (lookUp as Document).getElementsByTagName(selector) as HTMLCollectionOf<HTMLElement>;
+};
+
+export default getElementsByTagName;

package/src/selectors/matches.ts

@@ -0,0 +1,10 @@
+/**
+ * Check if element matches a CSS selector.
+ *
+ * @param target the target element
+ * @param selector the selector to match
+ * @returns the query result
+ */
+const matches = (target: Element, selector: string): boolean => target.matches(selector);
+
+export default matches;

package/src/selectors/querySelector.ts

@@ -0,0 +1,22 @@
+import getDocument from '../get/getDocument';
+import isNode from '../is/isNode';
+import isHTMLElement from '../is/isHTMLElement';
+
+/**
+ * Utility to check if target is typeof `HTMLElement`, `Element`, `Node`
+ * or find one that matches a selector.
+ *
+ * @param selector the input selector or target element
+ * @param parent optional node to look into
+ * @return the `HTMLElement` or `querySelector` result
+ */
+const querySelector = (selector: HTMLElement | string, parent?: ParentNode): HTMLElement | null => {
+  if (isHTMLElement(selector)) {
+    return selector;
+  }
+  const lookUp = isNode(parent) ? parent : getDocument();
+
+  return lookUp.querySelector(selector);
+};
+
+export default querySelector;

package/src/selectors/{querySelectorAll.js → querySelectorAll.ts}

@@ -4,11 +4,13 @@ import isNode from '../is/isNode';
 /**
  * A shortcut for `(document|Element).querySelectorAll`.
  *
- * @param {string} selector the input selector
- * @param {ParentNode=} parent optional node to look into
- * @return {NodeListOf<HTMLElement>} the query result
+ * @param selector the input selector
+ * @param parent optional node to look into
+ * @return the query result
  */
-export default function querySelectorAll(selector, parent) {
+const querySelectorAll = (selector: string, parent?: ParentNode): NodeListOf<HTMLElement> => {
   const lookUp = isNode(parent) ? parent : getDocument();
   return lookUp.querySelectorAll(selector);
-}
+};
+
+export default querySelectorAll;

package/src/strings/{DOMContentLoadedEvent.js → DOMContentLoadedEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `DOMContentLoaded` event.
- * @type {string}
  */
 const DOMContentLoadedEvent = 'DOMContentLoaded';
 export default DOMContentLoadedEvent;

package/src/strings/{DOMMouseScrollEvent.js → DOMMouseScrollEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `DOMMouseScroll` event.
- * @type {string}
  */
 const DOMMouseScrollEvent = 'DOMMouseScroll';
 export default DOMMouseScrollEvent;

package/src/strings/{abortEvent.js → abortEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `abort` event.
- * @type {string}
  */
 const abortEvent = 'abort';
 export default abortEvent;

package/src/strings/{addEventListener.js → addEventListener.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for 'addEventListener' string.
- * @type {string}
  */
 const addEventListener = 'addEventListener';
 export default addEventListener;

package/src/strings/{animationDelay.js → animationDelay.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for 'animationDelay' string.
- * @type {string}
  */
 const animationDelay = 'animationDelay';
 export default animationDelay;

package/src/strings/{animationDuration.js → animationDuration.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for 'animationDuration' string.
- * @type {string}
  */
 const animationDuration = 'animationDuration';
 export default animationDuration;

package/src/strings/{animationEndEvent.js → animationEndEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for 'animationend' string.
- * @type {string}
  */
 const animationEndEvent = 'animationend';
 export default animationEndEvent;

package/src/strings/{animationName.js → animationName.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for 'animationName' string.
- * @type {string}
  */
 const animationName = 'animationName';
 export default animationName;

package/src/strings/{ariaChecked.js → ariaChecked.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-checked.
- * @type {string}
  */
 const ariaChecked = 'aria-checked';
 export default ariaChecked;

package/src/strings/{ariaDescribedBy.js → ariaDescribedBy.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-describedby.
- * @type {string}
  */
 const ariaDescribedBy = 'aria-describedby';
 export default ariaDescribedBy;

package/src/strings/{ariaDescription.js → ariaDescription.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-description.
- * @type {string}
  */
 const ariaDescription = 'aria-description';
 export default ariaDescription;

package/src/strings/{ariaExpanded.js → ariaExpanded.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-expanded.
- * @type {string}
  */
 const ariaExpanded = 'aria-expanded';
 export default ariaExpanded;

package/src/strings/{ariaHasPopup.js → ariaHasPopup.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-haspopup.
- * @type {string}
  */
 const ariaHasPopup = 'aria-haspopup';
 export default ariaHasPopup;

package/src/strings/{ariaHidden.js → ariaHidden.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-hidden.
- * @type {string}
  */
 const ariaHidden = 'aria-hidden';
 export default ariaHidden;

package/src/strings/{ariaLabel.js → ariaLabel.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-label.
- * @type {string}
  */
 const ariaLabel = 'aria-label';
 export default ariaLabel;

package/src/strings/{ariaLabelledBy.js → ariaLabelledBy.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-labelledby.
- * @type {string}
  */
 const ariaLabelledBy = 'aria-labelledby';
 export default ariaLabelledBy;

package/src/strings/{ariaModal.js → ariaModal.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-modal.
- * @type {string}
  */
 const ariaModal = 'aria-modal';
 export default ariaModal;

package/src/strings/{ariaPressed.js → ariaPressed.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-pressed.
- * @type {string}
  */
 const ariaPressed = 'aria-pressed';
 export default ariaPressed;

package/src/strings/{ariaSelected.js → ariaSelected.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-selected.
- * @type {string}
  */
 const ariaSelected = 'aria-selected';
 export default ariaSelected;

package/src/strings/{ariaValueMax.js → ariaValueMax.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-valuemax.
- * @type {string}
  */
 const ariaValueMax = 'aria-valuemax';
 export default ariaValueMax;

package/src/strings/{ariaValueMin.js → ariaValueMin.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-valuemin.
- * @type {string}
  */
 const ariaValueMin = 'aria-valuemin';
 export default ariaValueMin;

package/src/strings/{ariaValueNow.js → ariaValueNow.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-valuenow.
- * @type {string}
  */
 const ariaValueNow = 'aria-valuenow';
 export default ariaValueNow;

package/src/strings/{ariaValueText.js → ariaValueText.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for aria-valuetext.
- * @type {string}
  */
 const ariaValueText = 'aria-valuetext';
 export default ariaValueText;

package/src/strings/{beforeunloadEvent.js → beforeunloadEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `beforeunload` event.
- * @type {string}
  */
 const beforeunloadEvent = 'beforeunload';
 export default beforeunloadEvent;

package/src/strings/{bezierEasings.js → bezierEasings.ts}

@@ -1,7 +1,6 @@
 /**
  * A global namespace for predefined
  * CSS3 'cubic-bezier()' easing functions.
- * @type {Record<string, string>}
  */
 const bezierEasings = {
   linear: 'linear',

package/src/strings/{blurEvent.js → blurEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `blur` event.
- * @type {string}
  */
 const blurEvent = 'blur';
 export default blurEvent;

package/src/strings/{changeEvent.js → changeEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `change` event.
- * @type {string}
  */
 const changeEvent = 'change';
 export default changeEvent;

package/src/strings/{contextmenuEvent.js → contextmenuEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `contextmenu` event.
- * @type {string}
  */
 const contextmenuEvent = 'contextmenu';
 export default contextmenuEvent;

package/src/strings/dragEvent.ts

@@ -0,0 +1,5 @@
+/**
+ * A global namespace for `drag` event.
+ */
+const dragEvent = 'drag';
+export default dragEvent;

package/src/strings/dragendEvent.ts

@@ -0,0 +1,5 @@
+/**
+ * A global namespace for `dragend` event.
+ */
+const dragendEvent = 'dragend';
+export default dragendEvent;

package/src/strings/dragenterEvent.ts

@@ -0,0 +1,5 @@
+/**
+ * A global namespace for `dragenter` event.
+ */
+const dragenterEvent = 'dragenter';
+export default dragenterEvent;

package/src/strings/dragleaveEvent.ts

@@ -0,0 +1,5 @@
+/**
+ * A global namespace for `dragleave` event.
+ */
+const dragleaveEvent = 'dragleave';
+export default dragleaveEvent;

package/src/strings/dragoverEvent.ts

@@ -0,0 +1,5 @@
+/**
+ * A global namespace for `dragover` event.
+ */
+const dragoverEvent = 'dragover';
+export default dragoverEvent;

package/src/strings/dragstartEvent.ts

@@ -0,0 +1,5 @@
+/**
+ * A global namespace for `dragstart` event.
+ */
+const dragstartEvent = 'dragstart';
+export default dragstartEvent;

package/src/strings/{errorEvent.js → errorEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `error` event.
- * @type {string}
  */
 const errorEvent = 'error';
 export default errorEvent;

package/src/strings/{focusEvent.js → focusEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `focus` event.
- * @type {string}
  */
 const focusEvent = 'focus';
 export default focusEvent;

package/src/strings/{focusEvents.js → focusEvents.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for focus event names.
- * @type {{in: string, out: string}}
  */
 const focusEvents = { in: 'focusin', out: 'focusout' };
 export default focusEvents;

package/src/strings/{focusinEvent.js → focusinEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `focusin` event.
- * @type {string}
  */
 const focusinEvent = 'focusin';
 export default focusinEvent;

package/src/strings/{focusoutEvent.js → focusoutEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `focusout` event.
- * @type {string}
  */
 const focusoutEvent = 'focusout';
 export default focusoutEvent;

package/src/strings/{gesturechangeEvent.js → gesturechangeEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `gesturechange` event.
- * @type {string}
  */
 const gesturechangeEvent = 'gesturechange';
 export default gesturechangeEvent;

package/src/strings/{gestureendEvent.js → gestureendEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `gestureend` event.
- * @type {string}
  */
 const gestureendEvent = 'gestureend';
 export default gestureendEvent;

package/src/strings/{gesturestartEvent.js → gesturestartEvent.ts}

@@ -1,6 +1,5 @@
 /**
  * A global namespace for `gesturestart` event.
- * @type {string}
  */
 const gesturestartEvent = 'gesturestart';
 export default gesturestartEvent;

package/src/strings/{keyAlt.js → keyAlt.ts}

@@ -1,6 +1,6 @@
 /**
  * A global namespace for `Alt` key.
- * @type {string} e.which = 18
+ * e.which = 18
  */
 const keyAlt = 'Alt';
 

package/src/strings/{keyArrowDown.js → keyArrowDown.ts}

@@ -1,6 +1,6 @@
 /**
  * A global namespace for `ArrowDown` key.
- * @type {string} e.which = 40 equivalent
+ * e.which = 40 equivalent
  */
 const keyArrowDown = 'ArrowDown';
 

package/src/strings/{keyArrowLeft.js → keyArrowLeft.ts}

@@ -1,6 +1,6 @@
 /**
  * A global namespace for `ArrowLeft` key.
- * @type {string} e.which = 37 equivalent
+ * e.which = 37 equivalent
  */
 const keyArrowLeft = 'ArrowLeft';
 

package/src/strings/{keyArrowRight.js → keyArrowRight.ts}

@@ -1,6 +1,6 @@
 /**
  * A global namespace for `ArrowRight` key.
- * @type {string} e.which = 39 equivalent
+ * e.which = 39 equivalent
  */
 const keyArrowRight = 'ArrowRight';
 

package/src/strings/{keyArrowUp.js → keyArrowUp.ts}

@@ -1,6 +1,6 @@
 /**
  * A global namespace for `ArrowUp` key.
- * @type {string} e.which = 38 equivalent
+ * e.which = 38 equivalent
  */
 const keyArrowUp = 'ArrowUp';