@thednp/shorty 1.0.3 → 2.0.0-alpha10

package/src/is/isNodeList.js

@@ -1,9 +0,0 @@
-/**
- * Checks if an object is a `NodeList`.
- * => equivalent to `object instanceof NodeList`
- *
- * @param {any} object the target object
- * @returns {boolean} the query result
- */
-const isNodeList = (object) => (object && object.constructor.name === 'NodeList') || false;
-export default isNodeList;

package/src/is/isNumber.js

@@ -1,8 +0,0 @@
-/**
- * Shortcut for `typeof SOMETHING === "number"`.
- *
- * @param  {any} num input value
- * @returns {boolean} the query result
- */
-const isNumber = (num) => typeof num === 'number';
-export default isNumber;

package/src/is/isObject.js

@@ -1,8 +0,0 @@
-/**
- * Checks if an object is an `Object`.
- *
- * @param {any} obj the target object
- * @returns {boolean} the query result
- */
-const isObject = (obj) => (typeof obj === 'object') || false;
-export default isObject;

package/src/is/isRTL.js

@@ -1,9 +0,0 @@
-import getDocumentElement from '../get/getDocumentElement';
-
-/**
- * Checks if a page is Right To Left.
- * @param {HTMLElement=} node the target
- * @returns {boolean} the query result
- */
-const isRTL = (node) => getDocumentElement(node).dir === 'rtl';
-export default isRTL;

package/src/is/isSVGElement.js

@@ -1,11 +0,0 @@
-import getWindow from '../get/getWindow';
-
-/**
- * Check if an element is an `<svg>` or any other SVG element.
- * @param {any} element the target element
- * @returns {boolean} the query result
- */
-const isSVGElement = (element) => (element && element instanceof getWindow(element).SVGElement)
-  || false;
-
-export default isSVGElement;

package/src/is/isShadowRoot.js

@@ -1,9 +0,0 @@
-/**
- * Check if target is a `ShadowRoot`.
- *
- * @param {any} element target
- * @returns {boolean} the query result
- */
-const isShadowRoot = (element) => (element && element.constructor.name === 'ShadowRoot')
-  || false;
-export default isShadowRoot;

package/src/is/isString.js

@@ -1,8 +0,0 @@
-/**
- * Shortcut for `typeof SOMETHING === "string"`.
- *
- * @param  {any} str input value
- * @returns {boolean} the query result
- */
-const isString = (str) => typeof str === 'string';
-export default isString;

package/src/is/isTableElement.js

@@ -1,11 +0,0 @@
-/**
- * Check if a target element is a `<table>`, `<td>` or `<th>`.
- * This specific check is important for determining
- * the `offsetParent` of a given element.
- *
- * @param {any} element the target element
- * @returns {boolean} the query result
- */
-const isTableElement = (element) => (element && ['TABLE', 'TD', 'TH'].includes(element.tagName))
-  || false;
-export default isTableElement;

package/src/is/isWindow.js

@@ -1,9 +0,0 @@
-/**
- * Check if a target object is `Window`.
- * => equivalent to `object instanceof Window`
- *
- * @param {any} object the target object
- * @returns {boolean} the query result
- */
-const isWindow = (object) => (object && object.constructor.name === 'Window') || false;
-export default isWindow;

package/src/misc/ArrayFrom.js

@@ -1,8 +0,0 @@
-/**
- * Shortcut for `Array.from()` static method.
- *
- * @param  {any[] | HTMLCollection | NodeList | Map<any, any>} arr array-like iterable object
- * @returns {Array<any>}
- */
-const ArrayFrom = (arr) => Array.from(arr);
-export default ArrayFrom;

package/src/misc/Float32ArrayFrom.js

@@ -1,7 +0,0 @@
-/**
- * Shortcut for `Float32Array.from()` static method.
- * @param  {any[] | HTMLCollection | NodeList} arr array-like iterable object
- * @returns {Float32Array}
- */
-const Float32ArrayFrom = (arr) => Float32Array.from(Array.from(arr));
-export default Float32ArrayFrom;

package/src/misc/Float64ArrayFrom.js

@@ -1,7 +0,0 @@
-/**
- * Shortcut for `Float64Array.from()` static method.
- * @param  {any[] | HTMLCollection | NodeList} arr array-like iterable object
- * @returns {Float64Array}
- */
-const Float64ArrayFrom = (arr) => Float64Array.from(Array.from(arr));
-export default Float64ArrayFrom;

package/src/misc/ObjectAssign.js

@@ -1,7 +0,0 @@
-/**
- * Shortcut for `Object.assign()` static method.
- * @param  {Record<string, any>} obj a target object
- * @param  {Record<string, any>} source a source object
- */
-const ObjectAssign = (obj, source) => Object.assign(obj, source);
-export default ObjectAssign;

package/src/misc/ObjectEntries.js

@@ -1,7 +0,0 @@
-/**
- * Shortcut for `Object.entries()` static method.
- * @param  {Record<string, any>} obj a target object
- * @returns {[string, any][]}
- */
-const ObjectEntries = (obj) => Object.entries(obj);
-export default ObjectEntries;

package/src/misc/ObjectKeys.js

@@ -1,7 +0,0 @@
-/**
- * Shortcut for `Object.keys()` static method.
- * @param  {Record<string, any>} obj a target object
- * @returns {string[]}
- */
-const ObjectKeys = (obj) => Object.keys(obj);
-export default ObjectKeys;

package/src/misc/ObjectValues.js

@@ -1,7 +0,0 @@
-/**
- * Shortcut for `Object.values()` static method.
- * @param  {Record<string, any>} obj a target object
- * @returns {any[]}
- */
-const ObjectValues = (obj) => Object.values(obj);
-export default ObjectValues;

package/src/misc/OriginalEvent.js

@@ -1,20 +0,0 @@
-import isObject from '../is/isObject';
-import ObjectAssign from './ObjectAssign';
-
-/**
- * Returns a namespaced `CustomEvent` specific to each component.
- * @param {string} EventType Event.type
- * @param {Record<string, any>=} config Event.options | Event.properties
- * @returns {SHORTY.OriginalEvent} a new namespaced event
- */
-export default function OriginalEvent(EventType, config) {
-  const OriginalCustomEvent = new CustomEvent(EventType, {
-    cancelable: true, bubbles: true,
-  });
-
-  /* istanbul ignore else */
-  if (isObject(config)) {
-    ObjectAssign(OriginalCustomEvent, config);
-  }
-  return OriginalCustomEvent;
-}

package/src/misc/createElement.js

@@ -1,27 +0,0 @@
-import getDocument from '../get/getDocument';
-import ObjectAssign from './ObjectAssign';
-
-/**
- * This is a 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:
- * `id`, `className`, `textContent`, `style`, etc.
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement
- *
- * @param {Record<string, string> | string} param `tagName` or object
- * @return {HTMLElement} a new `HTMLElement` or `Element`
- */
-export default function createElement(param) {
-  if (!param) return null;
-
-  if (typeof param === 'string') {
-    return getDocument().createElement(param);
-  }
-
-  const { tagName } = param;
-  const attr = { ...param };
-  const newElement = createElement(tagName);
-  delete attr.tagName;
-  ObjectAssign(newElement, attr);
-  return newElement;
-}

package/src/misc/createElementNS.js

@@ -1,30 +0,0 @@
-import getDocument from '../get/getDocument';
-import ObjectEntries from './ObjectEntries';
-import setAttribute from '../attr/setAttribute';
-
-/**
- * This is a 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:
- * `id`, `className`, `textContent`, `style`, etc.
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElementNS
- *
- * @param {string} namespace `namespaceURI` to associate with the new `HTMLElement`
- * @param {Record<string, string> | string} param `tagName` or object
- * @return {HTMLElement} a new `HTMLElement` or `Element`
- */
-export default function createElementNS(namespace, param) {
-  if (!namespace && !param) return null;
-  if (typeof param === 'string') {
-    return getDocument().createElementNS(namespace, param);
-  }
-
-  const { tagName } = param;
-  const attr = { ...param };
-  const newElement = createElementNS(namespace, tagName);
-  delete attr.tagName;
-  ObjectEntries(attr).forEach(([key, value]) => {
-    setAttribute(newElement, key, value);
-  });
-  return newElement;
-}

package/src/misc/data.js

@@ -1,78 +0,0 @@
-import isHTMLElement from '../is/isHTMLElement';
-
-/** @type {Map<string, Map<HTMLElement, Record<string, any>>>} */
-const componentData = new Map();
-/**
- * An interface for web components background data.
- * @see https://github.com/thednp/bootstrap.native/blob/master/src/components/base-component.js
- */
-const Data = {
-  /**
-   * Sets web components data.
-   * @param {HTMLElement} element target element
-   * @param {string} component the component's name or a unique key
-   * @param {Record<string, any>} instance the component instance
-   */
-  set: (element, component, instance) => {
-    if (!isHTMLElement(element)) return;
-
-    /* istanbul ignore else */
-    if (!componentData.has(component)) {
-      componentData.set(component, new Map());
-    }
-
-    const instanceMap = componentData.get(component);
-    // not undefined, but defined right above
-    instanceMap.set(element, instance);
-  },
-
-  /**
-   * Returns all instances for specified component.
-   * @param {string} component the component's name or a unique key
-   * @returns {Map<HTMLElement, Record<string, any>>?} all the component instances
-   */
-  getAllFor: (component) => {
-    const instanceMap = componentData.get(component);
-
-    return instanceMap || null;
-  },
-
-  /**
-   * Returns the instance associated with the target.
-   * @param {HTMLElement} element target element
-   * @param {string} component the component's name or a unique key
-   * @returns {Record<string, any>?} the instance
-   */
-  get: (element, component) => {
-    if (!isHTMLElement(element) || !component) return null;
-    const allForC = Data.getAllFor(component);
-    const instance = element && allForC && allForC.get(element);
-
-    return instance || null;
-  },
-
-  /**
-   * Removes web components data.
-   * @param {HTMLElement} element target element
-   * @param {string} component the component's name or a unique key
-   */
-  remove: (element, component) => {
-    const instanceMap = componentData.get(component);
-    if (!instanceMap || !isHTMLElement(element)) return;
-
-    instanceMap.delete(element);
-
-    /* istanbul ignore else */
-    if (instanceMap.size === 0) {
-      componentData.delete(component);
-    }
-  },
-};
-
-/**
- * An alias for `Data.get()`.
- * @type {SHORTY.getInstance<any>}
- */
-export const getInstance = (target, component) => Data.get(target, component);
-
-export default Data;

package/src/misc/dispatchEvent.js

@@ -1,8 +0,0 @@
-/**
- * Shortcut for the `Element.dispatchEvent(Event)` method.
- *
- * @param {HTMLElement} element is the target
- * @param {Event} event is the `Event` object
- */
-const dispatchEvent = (element, event) => element.dispatchEvent(event);
-export default dispatchEvent;

package/src/misc/distinct.js

@@ -1,10 +0,0 @@
-/**
- * JavaScript `Array` distinct.
- * @see https://codeburst.io/javascript-array-distinct-5edc93501dc4
- * @param {any} value
- * @param {number} index
- * @param {any} self
- * @returns {boolean}
- */
-const distinct = (value, index, self) => self.indexOf(value) === index;
-export default distinct;

package/src/misc/emulateAnimationEndLegacy.js

@@ -1,41 +0,0 @@
-import supportAnimation from '../boolean/supportAnimation';
-import animationEndEventLegacy from '../strings/animationEndEventLegacy';
-import getElementAnimationDelay from '../get/getElementAnimationDelayLegacy';
-import getElementAnimationDuration from '../get/getElementAnimationDurationLegacy';
-import dispatchEvent from './dispatchEvent';
-
-/**
- * Utility to make sure callbacks are consistently
- * called when animation ends.
- *
- * @param {HTMLElement} element target
- * @param {EventListener} handler `animationend` callback
- */
-export default function emulateAnimationEnd(element, handler) {
-  let called = 0;
-  const endEvent = new Event(animationEndEventLegacy);
-  const duration = getElementAnimationDuration(element);
-  const delay = getElementAnimationDelay(element);
-
-  if (supportAnimation && duration) {
-    /**
-     * Wrap the handler in on -> off callback
-     * @param {Event} e Event object
-     */
-    const animationEndWrapper = (e) => {
-      /* istanbul ignore else */
-      if (e.target === element) {
-        handler.apply(element, [e]);
-        element.removeEventListener(animationEndEventLegacy, animationEndWrapper);
-        called = 1;
-      }
-    };
-    element.addEventListener(animationEndEventLegacy, animationEndWrapper);
-    setTimeout(() => {
-      /* istanbul ignore next */
-      if (!called) dispatchEvent(element, endEvent);
-    }, duration + delay + 17);
-  } else {
-    handler.apply(element, [endEvent]);
-  }
-}

package/src/misc/emulateTransitionEndLegacy.js

@@ -1,41 +0,0 @@
-import supportTransition from '../boolean/supportTransition';
-import transitionEndEventLegacy from '../strings/transitionEndEventLegacy';
-import getElementTransitionDelay from '../get/getElementTransitionDelayLegacy';
-import getElementTransitionDuration from '../get/getElementTransitionDurationLegacy';
-import dispatchEvent from './dispatchEvent';
-
-/**
- * Utility to make sure callbacks are consistently
- * called when transition ends.
- *
- * @param {HTMLElement} element target
- * @param {EventListener} handler `transitionend` callback
- */
-export default function emulateTransitionEnd(element, handler) {
-  let called = 0;
-  const endEvent = new Event(transitionEndEventLegacy);
-  const duration = getElementTransitionDuration(element);
-  const delay = getElementTransitionDelay(element);
-
-  if (supportTransition && duration) {
-    /**
-     * Wrap the handler in on -> off callback
-     * @param {Event} e Event object
-     */
-    const transitionEndWrapper = (e) => {
-      /* istanbul ignore else */
-      if (e.target === element) {
-        handler.apply(element, [e]);
-        element.removeEventListener(transitionEndEventLegacy, transitionEndWrapper);
-        called = 1;
-      }
-    };
-    element.addEventListener(transitionEndEventLegacy, transitionEndWrapper);
-    setTimeout(() => {
-      /* istanbul ignore next */
-      if (!called) dispatchEvent(element, endEvent);
-    }, duration + delay + 17);
-  } else {
-    handler.apply(element, [endEvent]);
-  }
-}

package/src/misc/focus.js

@@ -1,7 +0,0 @@
-/**
- * Utility to focus an `HTMLElement` target.
- *
- * @param {HTMLElement} element is the target
- */
-const focus = (element) => element.focus();
-export default focus;

package/src/misc/normalizeOptions.js

@@ -1,49 +0,0 @@
-import getAttribute from '../attr/getAttribute';
-import normalizeValue from './normalizeValue';
-import ObjectKeys from './ObjectKeys';
-import toLowerCase from './toLowerCase';
-
-/**
- * Utility to normalize component options.
- *
- * @param {HTMLElement} element target
- * @param {Record<string, any>} defaultOps component default options
- * @param {Record<string, any>} inputOps component instance options
- * @param {string=} ns component namespace
- * @return {Record<string, any>} normalized component options object
- */
-export default function normalizeOptions(element, defaultOps, inputOps, ns) {
-  const data = { ...element.dataset };
-  /** @type {Record<string, any>} */
-  const normalOps = {};
-  /** @type {Record<string, any>} */
-  const dataOps = {};
-  const title = 'title';
-
-  ObjectKeys(data).forEach((k) => {
-    const key = ns && k.includes(ns)
-      ? k.replace(ns, '').replace(/[A-Z]/, (match) => toLowerCase(match))
-      : k;
-
-    dataOps[key] = normalizeValue(data[k]);
-  });
-
-  ObjectKeys(inputOps).forEach((k) => {
-    inputOps[k] = normalizeValue(inputOps[k]);
-  });
-
-  ObjectKeys(defaultOps).forEach((k) => {
-    /* istanbul ignore else */
-    if (k in inputOps) {
-      normalOps[k] = inputOps[k];
-    } else if (k in dataOps) {
-      normalOps[k] = dataOps[k];
-    } else {
-      normalOps[k] = k === title
-        ? getAttribute(element, title)
-        : defaultOps[k];
-    }
-  });
-
-  return normalOps;
-}

package/src/misc/normalizeValue.js

@@ -1,34 +0,0 @@
-/**
- * The raw value or a given component option.
- *
- * @typedef {string | HTMLElement | Function | number | boolean | null} niceValue
- */
-
-/**
- * Utility to normalize component options
- *
- * @param {any} value the input value
- * @return {niceValue} the normalized value
- */
-export default function normalizeValue(value) {
-  if (['true', true].includes(value)) { // boolean
-  // if ('true' === value) { // boolean
-    return true;
-  }
-
-  if (['false', false].includes(value)) { // boolean
-  // if ('false' === value) { // boolean
-    return false;
-  }
-
-  if (value === '' || value === 'null') { // null
-    return null;
-  }
-
-  if (value !== '' && !Number.isNaN(+value)) { // number
-    return +value;
-  }
-
-  // string / function / HTMLElement / object
-  return value;
-}

package/src/misc/passiveHandlerLegacy.js

@@ -1,10 +0,0 @@
-import supportPassive from '../boolean/supportPassive';
-
-/**
- * A global namespace for most scroll event listeners in legacy browsers.
- * @type {Partial<AddEventListenerOptions> | boolean}
- */
-const passiveHandler = supportPassive ? { passive: true }
-  : /* istanbul ignore next */false;
-
-export default passiveHandler;

package/src/misc/reflow.js

@@ -1,8 +0,0 @@
-/**
- * Utility to force re-paint of an `HTMLElement` target.
- *
- * @param {HTMLElement} element is the target
- * @return {number} the `Element.offsetHeight` value
- */
-const reflow = (element) => element.offsetHeight;
-export default reflow;

package/src/misc/setElementStyle.js

@@ -1,19 +0,0 @@
-import ObjectAssign from './ObjectAssign';
-import ObjectEntries from './ObjectEntries';
-
-/**
- * Shortcut for multiple uses of `HTMLElement.style.propertyName` method.
- * @param  {HTMLElement} element target element
- * @param  {Partial<CSSStyleDeclaration>} styles attribute value
- */
-const setElementStyle = (element, styles) => {
-  ObjectEntries(styles).forEach(([key, value]) => {
-    if (key.includes('--')) {
-      element.style.setProperty(key, value);
-    } else {
-      const propObject = {}; propObject[key] = value;
-      ObjectAssign(element.style, propObject);
-    }
-  });
-};
-export default setElementStyle;

package/src/misc/timer.js

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

package/src/misc/toLowerCase.js

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

package/src/misc/toUpperCase.js

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

package/src/misc/version.js

@@ -1,8 +0,0 @@
-import { version } from '../../package.json';
-
-/**
- * A global namespace for library version.
- * @type {string}
- */
-const Version = version;
-export default Version;