@thednp/shorty 2.0.7 → 2.0.9

package/src/is/isTableElement.ts

@@ -1,17 +0,0 @@
-import isNode from "./isNode";
-
-/**
- * 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 element the target element
- * @returns the query result
- */
-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,11 +0,0 @@
-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<WeakKey, unknown> =>
-  (isObject(obj) && obj.constructor.name === "WeakMap") || false;
-export default isWeakMap;

package/src/is/isWindow.ts

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

package/src/misc/ArrayFrom.ts

@@ -1,11 +0,0 @@
-/**
- * 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 = <T>(arr: ArrayLike<T> | Iterable<T>): T[] => Array.from(arr);
-
-export default ArrayFrom;

package/src/misc/Float32ArrayFrom.ts

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

package/src/misc/Float64ArrayFrom.ts

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

package/src/misc/ObjectAssign.ts

@@ -1,54 +0,0 @@
-/**
- * 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: unknown,
-  ...sources: unknown[]
-): unknown;
-
-/**
- * Shortcut for `Object.assign()` static method.
- *
- * @param obj a target object
- * @param source source object(s)
- * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
- */
-const ObjectAssign: typeof ObjectAssignTyped = <
-  A extends Record<string, unknown>,
-  B,
->(
-  obj: A,
-  ...source: B[]
-): B extends Record<string, unknown>[] ? unknown : A & B =>
-  Object.assign(obj, ...source);
-
-export default ObjectAssign;

package/src/misc/ObjectEntries.ts

@@ -1,11 +0,0 @@
-/**
- * Shortcut for `Object.entries()` static method.
- *
- * @param obj a target object
- * @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 = <O extends Record<keyof O, unknown>>(obj: O) =>
-  Object.entries(obj) as [keyof O, O[keyof O]][];
-
-export default ObjectEntries;

package/src/misc/ObjectFromEntries.ts

@@ -1,11 +0,0 @@
-/**
- * Shortcut for `Object.fromEntries()` static method.
- *
- * @param entries a target entries object
- * @returns a new Object created from the specified entries in array format [key, value][]
- * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
- */
-const ObjectFromEntries = <K extends string, V>(entries: [K, V][]) =>
-  Object.fromEntries(entries) as Record<K, V>;
-
-export default ObjectFromEntries;

package/src/misc/ObjectHasOwn.ts

@@ -1,18 +0,0 @@
-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,11 +0,0 @@
-/**
- * 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 = <O extends Record<keyof O, unknown>>(obj: O) =>
-  Object.keys(obj) as (keyof O)[];
-
-export default ObjectKeys;

package/src/misc/ObjectValues.ts

@@ -1,12 +0,0 @@
-/**
- * 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 = <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

@@ -1,31 +0,0 @@
-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 = <
-  O extends unknown & Record<string, unknown>,
-  T extends OriginalEvent,
->(
-  eventType: string,
-  config?: O,
-): T => {
-  const OriginalCustomEvent = new CustomEvent<O>(eventType, {
-    cancelable: true,
-    bubbles: true,
-  }) as T;
-
-  // istanbul ignore else @preserve
-  if (isObject(config)) {
-    ObjectAssign(OriginalCustomEvent, config);
-  }
-  return OriginalCustomEvent;
-};
-
-export default createCustomEvent;

package/src/misc/createElement.ts

@@ -1,36 +0,0 @@
-import isString from "../is/isString";
-import getDocument from "../get/getDocument";
-import ObjectAssign from "./ObjectAssign";
-
-/**
- * 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 with string values:
- * `id`, `className`, `textContent`, `style`, etc.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement
- *
- * @param param `tagName` or object
- * @return a new `HTMLElement`
- */
-const createElement = <T extends HTMLElement>(
-  param?: string | Partial<T>,
-): T | undefined => {
-  if (!param) return undefined;
-
-  if (isString(param)) {
-    return getDocument().createElement(param) as T;
-  }
-
-  const { tagName } = param;
-  const newElement = createElement(tagName as string);
-
-  if (!newElement) return undefined;
-
-  const attr = { ...(param as Record<string, unknown>) };
-  delete attr.tagName;
-
-  return ObjectAssign(newElement, attr) as unknown as T;
-};
-
-export default createElement;

package/src/misc/createElementNS.ts

@@ -1,40 +0,0 @@
-import getDocument from "../get/getDocument";
-import ObjectAssign from "./ObjectAssign";
-import isString from "../is/isString";
-
-/**
- * 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 with string values:
- * `id`, `className`, `textContent`, `style`, etc.
- * Note: some elements resulted from this function call may not be compatible with
- * some attributes.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElementNS
- *
- * @param ns `namespaceURI` to associate with the new `HTMLElement`
- * @param param `tagName` or object
- * @return a new `HTMLElement`
- */
-const createElementNS = <T extends Element = HTMLElement>(
-  ns: string,
-  param?: string | Partial<T>,
-): T | undefined => {
-  if (!ns || !param) return undefined;
-
-  if (isString(param)) {
-    return getDocument().createElementNS(ns, param) as T;
-  }
-
-  const { tagName } = param;
-  const newElement = createElementNS(ns, tagName);
-
-  if (!newElement) return undefined;
-
-  const attr = { ...(param as Record<string, unknown>) };
-  delete attr.tagName;
-
-  return ObjectAssign(newElement, attr) as unknown as T;
-};
-
-export default createElementNS;

package/src/misc/data.ts

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

package/src/misc/dispatchEvent.ts

@@ -1,10 +0,0 @@
-/**
- * Shortcut for the `Element.dispatchEvent(Event)` method.
- *
- * @param element is the target
- * @param event is the `Event` object
- */
-const dispatchEvent = (element: EventTarget, event: Event): boolean =>
-  element.dispatchEvent(event);
-
-export default dispatchEvent;

package/src/misc/distinct.ts

@@ -1,19 +0,0 @@
-/**
- * JavaScript `Array` distinct.
- *
- * @see https://codeburst.io/javascript-array-distinct-5edc93501dc4
- *
- * @example
- * ```
- * [0,1,1,2].filter(distinct)
- * // => [0,1,2]
- * ```
- * @param value array item value
- * @param index array item index
- * @param arr a clone of the target array
- * @returns the query result
- */
-const distinct = <T>(value: T, index: number, arr: T[]): boolean =>
-  arr.indexOf(value) === index;
-
-export default distinct;

package/src/misc/emulateAnimationEnd.ts

@@ -1,43 +0,0 @@
-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
- * called when animation ends.
- *
- * @param element target
- * @param handler `animationend` callback
- */
-const emulateAnimationEnd = (
-  element: HTMLElement,
-  handler: EventListener,
-): void => {
-  let called = 0;
-  const endEvent = new Event(animationEndEvent);
-  const duration = getElementAnimationDuration(element);
-  const delay = getElementAnimationDelay(element);
-
-  if (duration) {
-    // Wrap the handler in on -> off callback
-    const animationEndWrapper = (e: Event): void => {
-      // istanbul ignore else @preserve
-      if (e.target === element) {
-        handler.apply(element, [e]);
-        element.removeEventListener(animationEndEvent, animationEndWrapper);
-        called = 1;
-      }
-    };
-    element.addEventListener(animationEndEvent, animationEndWrapper);
-    setTimeout(() => {
-      // istanbul ignore next @preserve
-      if (!called) dispatchEvent(element, endEvent);
-    }, duration + delay + 17);
-  } else {
-    // istanbul ignore next @preserve
-    handler.apply(element, [endEvent]);
-  }
-};
-
-export default emulateAnimationEnd;

package/src/misc/emulateTransitionEnd.ts

@@ -1,42 +0,0 @@
-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
- * called when transition ends.
- *
- * @param element event target
- * @param handler `transitionend` callback
- */
-const emulateTransitionEnd = (
-  element: HTMLElement,
-  handler: EventListener,
-): void => {
-  let called = 0;
-  const endEvent = new Event(transitionEndEvent);
-  const duration = getElementTransitionDuration(element);
-  const delay = getElementTransitionDelay(element);
-
-  if (duration) {
-    // Wrap the handler in on -> off callback
-    const transitionEndWrapper = (e: Event): void => {
-      // istanbul ignore else @preserve
-      if (e.target === element) {
-        handler.apply(element, [e]);
-        element.removeEventListener(transitionEndEvent, transitionEndWrapper);
-        called = 1;
-      }
-    };
-    element.addEventListener(transitionEndEvent, transitionEndWrapper);
-    setTimeout(() => {
-      // istanbul ignore next @preserve
-      if (!called) dispatchEvent(element, endEvent);
-    }, duration + delay + 17);
-  } else {
-    handler.apply(element, [endEvent]);
-  }
-};
-
-export default emulateTransitionEnd;

package/src/misc/focus.ts

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

package/src/misc/focusTrap.ts

@@ -1,67 +0,0 @@
-import ariaHidden from "../strings/ariaHidden";
-import focusableSelector from "../strings/focusableSelector";
-import querySelectorAll from "../selectors/querySelectorAll";
-import getAttribute from "../attr/getAttribute";
-import hasAttribute from "../attr/hasAttribute";
-import off from "../event/off";
-import on from "../event/on";
-import getDocument from "../get/getDocument";
-import { KeyboardEvent } from "../interface/event";
-
-const focusTrapMap = new Map<HTMLElement, boolean>();
-
-export type FocusableElement =
-  | HTMLAnchorElement
-  | HTMLButtonElement
-  | HTMLInputElement
-  | HTMLTextAreaElement
-  | HTMLDataListElement
-  | HTMLDetailsElement
-  | HTMLSelectElement;
-
-function handleKeyboardNavigation<T extends HTMLElement & EventTarget>(
-  this: T,
-  event: KeyboardEvent<T>,
-) {
-  const { shiftKey, code } = event;
-  const doc = getDocument(this);
-  const focusableElements = [
-    ...querySelectorAll<FocusableElement>(focusableSelector, this),
-  ].filter(
-    (el) => !hasAttribute(el, "disabled") && !getAttribute(el, ariaHidden),
-  );
-
-  if (!focusableElements.length) return;
-  const firstFocusable = focusableElements[0];
-  const lastFocusable = focusableElements[focusableElements.length - 1];
-
-  // istanbul ignore else @preserve
-  if (code === "Tab") {
-    if (shiftKey && doc.activeElement === firstFocusable) {
-      lastFocusable.focus();
-      event.preventDefault();
-    } else if (!shiftKey && doc.activeElement === lastFocusable) {
-      firstFocusable.focus();
-      event.preventDefault();
-    }
-  }
-}
-
-/**
- * Utility to check if a designated element is affected by focus trap;
- * @param target
- */
-export const hasFocusTrap = (target: HTMLElement) =>
-  focusTrapMap.has(target) === true;
-
-/**
- * Utility to toggle focus trap inside a designated target element;
- * @param target
- */
-export const toggleFocusTrap = (target: HTMLElement) => {
-  const isCurrentlyTrapped = hasFocusTrap(target);
-  const action = !isCurrentlyTrapped ? on : off;
-  action(target, "keydown", handleKeyboardNavigation);
-  if (isCurrentlyTrapped) focusTrapMap.delete(target);
-  else focusTrapMap.set(target, true);
-};

package/src/misc/getInstance.ts

@@ -1,9 +0,0 @@
-import Data from "./data";
-
-/**
- * An alias for `Data.get()`.
- */
-const getInstance = <T>(target: HTMLElement, component: string): T | null =>
-  Data.get(target, component);
-
-export default getInstance;

package/src/misc/noop.ts

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

package/src/misc/normalizeOptions.ts

@@ -1,58 +0,0 @@
-import getAttribute from "../attr/getAttribute";
-import normalizeValue from "./normalizeValue";
-import ObjectEntries from "./ObjectEntries";
-import toLowerCase from "./toLowerCase";
-// import { optionValues } from '../types';
-
-/**
- * Utility to normalize component options.
- *
- * @param element target
- * @param defaultOps component default options
- * @param inputOps component instance options
- * @param ns component namespace
- * @return normalized component options object
- */
-const normalizeOptions = <T extends { [key: string]: unknown }>(
-  element: HTMLElement,
-  defaultOps: T,
-  inputOps: Partial<T>,
-  ns?: string,
-): T => {
-  const INPUT = { ...inputOps } as T;
-  const data = { ...element.dataset };
-  const normalOps = { ...defaultOps };
-  const dataOps: Partial<T> = {};
-  const title = "title";
-
-  ObjectEntries(data).forEach(([k, v]) => {
-    const key: keyof T = ns && typeof k === "string" && k.includes(ns)
-      ? k.replace(ns, "").replace(
-        /[A-Z]/g,
-        (match: string) => toLowerCase(match),
-      )
-      : /* istanbul ignore next @preserve */ k;
-
-    dataOps[key] = normalizeValue(v) as T[keyof T];
-  });
-
-  ObjectEntries(INPUT).forEach(([k, v]) => {
-    INPUT[k] = normalizeValue(v) as T[keyof T];
-  });
-
-  ObjectEntries(defaultOps).forEach(([k, v]) => {
-    // istanbul ignore else @preserve
-    if (k in INPUT) {
-      normalOps[k] = INPUT[k] as T[keyof T];
-    } else if (k in dataOps) {
-      normalOps[k] = dataOps[k] as T[keyof T];
-    } else {
-      normalOps[k] =
-        (k === title ? getAttribute(element, title) : v) as T[keyof T];
-    }
-  });
-
-  return normalOps;
-};
-
-export default normalizeOptions;