@thednp/shorty 1.0.3 → 2.0.0-alpha10

package/src/{index.js → index.ts}

@@ -1,5 +1,3 @@
-/** @typedef {import('../types/index')} */
-
 // strings
 import ariaChecked from './strings/ariaChecked';
 import ariaDescription from './strings/ariaDescription';
@@ -22,6 +20,12 @@ import abortEvent from './strings/abortEvent';
 import blurEvent from './strings/blurEvent';
 import moveEvent from './strings/moveEvent';
 import changeEvent from './strings/changeEvent';
+import dragEvent from './strings/dragEvent';
+import dragstartEvent from './strings/dragstartEvent';
+import dragenterEvent from './strings/dragenterEvent';
+import dragleaveEvent from './strings/dragleaveEvent';
+import dragoverEvent from './strings/dragoverEvent';
+import dragendEvent from './strings/dragendEvent';
 import errorEvent from './strings/errorEvent';
 import resetEvent from './strings/resetEvent';
 import resizeEvent from './strings/resizeEvent';
@@ -102,21 +106,13 @@ import keySpace from './strings/keySpace';
 import keyTab from './strings/keyTab';
 
 import animationDuration from './strings/animationDuration';
-import animationDurationLegacy from './strings/animationDurationLegacy';
 import animationDelay from './strings/animationDelay';
-import animationDelayLegacy from './strings/animationDelayLegacy';
 import animationName from './strings/animationName';
-import animationNameLegacy from './strings/animationNameLegacy';
 import animationEndEvent from './strings/animationEndEvent';
-import animationEndEventLegacy from './strings/animationEndEventLegacy';
 import transitionDuration from './strings/transitionDuration';
-import transitionDurationLegacy from './strings/transitionDurationLegacy';
 import transitionDelay from './strings/transitionDelay';
-import transitionDelayLegacy from './strings/transitionDelayLegacy';
 import transitionEndEvent from './strings/transitionEndEvent';
-import transitionEndEventLegacy from './strings/transitionEndEventLegacy';
 import transitionProperty from './strings/transitionProperty';
-import transitionPropertyLegacy from './strings/transitionPropertyLegacy';
 
 import addEventListener from './strings/addEventListener';
 import removeEventListener from './strings/removeEventListener';
@@ -127,6 +123,7 @@ import offsetHeight from './strings/offsetHeight';
 import offsetWidth from './strings/offsetWidth';
 import scrollHeight from './strings/scrollHeight';
 import scrollWidth from './strings/scrollWidth';
+import tabindex from './strings/tabindex';
 
 import userAgentData from './strings/userAgentData';
 import userAgent from './strings/userAgent';
@@ -162,17 +159,21 @@ import on from './event/on';
 import off from './event/off';
 import one from './event/one';
 
+// blocks
+import documentBody from './blocks/documentBody';
+import documentElement from './blocks/documentElement';
+import documentHead from './blocks/documentHead';
+
 // misc
 import ArrayFrom from './misc/ArrayFrom';
-import Data, { getInstance } from './misc/data';
+import Data from './misc/data';
+import getInstance from './misc/getInstance';
 import createElement from './misc/createElement';
 import createElementNS from './misc/createElementNS';
 import dispatchEvent from './misc/dispatchEvent';
 import distinct from './misc/distinct';
 import emulateAnimationEnd from './misc/emulateAnimationEnd';
-import emulateAnimationEndLegacy from './misc/emulateAnimationEndLegacy';
 import emulateTransitionEnd from './misc/emulateTransitionEnd';
-import emulateTransitionEndLegacy from './misc/emulateTransitionEndLegacy';
 import Float32ArrayFrom from './misc/Float32ArrayFrom';
 import Float64ArrayFrom from './misc/Float64ArrayFrom';
 import focus from './misc/focus';
@@ -181,11 +182,11 @@ import normalizeOptions from './misc/normalizeOptions';
 import normalizeValue from './misc/normalizeValue';
 import ObjectAssign from './misc/ObjectAssign';
 import ObjectEntries from './misc/ObjectEntries';
+import ObjectHasOwn from './misc/ObjectHasOwn';
 import ObjectKeys from './misc/ObjectKeys';
 import ObjectValues from './misc/ObjectValues';
-import OriginalEvent from './misc/OriginalEvent';
+import createCustomEvent from './misc/createCustomEvent';
 import passiveHandler from './misc/passiveHandler';
-import passiveHandlerLegacy from './misc/passiveHandlerLegacy';
 import reflow from './misc/reflow';
 import setElementStyle from './misc/setElementStyle';
 import Timer from './misc/timer';
@@ -199,14 +200,10 @@ import getDocumentBody from './get/getDocumentBody';
 import getDocumentElement from './get/getDocumentElement';
 import getDocumentHead from './get/getDocumentHead';
 import getElementAnimationDuration from './get/getElementAnimationDuration';
-import getElementAnimationDurationLegacy from './get/getElementAnimationDurationLegacy';
-import getElementAnimationDelayLegacy from './get/getElementAnimationDelayLegacy';
 import getElementAnimationDelay from './get/getElementAnimationDelay';
 import getElementStyle from './get/getElementStyle';
 import getElementTransitionDuration from './get/getElementTransitionDuration';
-import getElementTransitionDurationLegacy from './get/getElementTransitionDurationLegacy';
 import getElementTransitionDelay from './get/getElementTransitionDelay';
-import getElementTransitionDelayLegacy from './get/getElementTransitionDelayLegacy';
 import getNodeScroll from './get/getNodeScroll';
 import getParentNode from './get/getParentNode';
 import getRectRelativeToOffsetParent from './get/getRectRelativeToOffsetParent';
@@ -215,6 +212,7 @@ import getWindow from './get/getWindow';
 
 // is
 import isArray from './is/isArray';
+import isCanvas from './is/isCanvas';
 import isDocument from './is/isDocument';
 import isCustomElement from './is/isCustomElement';
 import isElement from './is/isElement';
@@ -226,6 +224,9 @@ import isObject from './is/isObject';
 import isHTMLCollection from './is/isHTMLCollection';
 import isHTMLElement from './is/isHTMLElement';
 import isHTMLImageElement from './is/isHTMLImageElement';
+import isJSON from './is/isJSON';
+import isMap from './is/isMap';
+import isWeakMap from './is/isWeakMap';
 import isMedia from './is/isMedia';
 import isNode from './is/isNode';
 import isNodeList from './is/isNodeList';
@@ -247,11 +248,8 @@ import querySelectorAll from './selectors/querySelectorAll';
 import getElementsByTagName from './selectors/getElementsByTagName';
 import getElementsByClassName from './selectors/getElementsByClassName';
 import matches from './selectors/matches';
-import matchesLegacy from './selectors/matchesLegacy';
 
-import Version from './misc/version';
-
-const SHORTY = {
+export {
   ariaChecked,
   ariaDescription,
   ariaDescribedBy,
@@ -272,6 +270,12 @@ const SHORTY = {
   blurEvent,
   moveEvent,
   changeEvent,
+  dragEvent,
+  dragstartEvent,
+  dragenterEvent,
+  dragoverEvent,
+  dragleaveEvent,
+  dragendEvent,
   errorEvent,
   resetEvent,
   resizeEvent,
@@ -323,21 +327,13 @@ const SHORTY = {
   gesturestartEvent,
   bezierEasings,
   animationDuration,
-  animationDurationLegacy,
   animationDelay,
-  animationDelayLegacy,
   animationName,
-  animationNameLegacy,
   animationEndEvent,
-  animationEndEventLegacy,
   transitionDuration,
-  transitionDurationLegacy,
   transitionDelay,
-  transitionDelayLegacy,
   transitionEndEvent,
-  transitionEndEventLegacy,
   transitionProperty,
-  transitionPropertyLegacy,
   isMobile,
   isApple,
   isFirefox,
@@ -377,45 +373,47 @@ const SHORTY = {
   scrollWidth,
   userAgentData,
   userAgent,
+  tabindex,
   addClass,
   removeClass,
   hasClass,
   on,
   off,
   one,
+  documentBody,
+  documentElement,
+  documentHead,
   dispatchEvent,
   distinct,
   Data,
   getInstance,
   createElement,
   createElementNS,
+  createCustomEvent,
   toUpperCase,
   toLowerCase,
   Timer,
   emulateAnimationEnd,
-  emulateAnimationEndLegacy,
   emulateTransitionEnd,
-  emulateTransitionEndLegacy,
   isElementInScrollRange,
   isElementInViewport,
   passiveHandler,
-  passiveHandlerLegacy,
   getElementAnimationDuration,
-  getElementAnimationDurationLegacy,
   getElementAnimationDelay,
-  getElementAnimationDelayLegacy,
   getElementTransitionDuration,
-  getElementTransitionDurationLegacy,
   getElementTransitionDelay,
-  getElementTransitionDelayLegacy,
   getNodeScroll,
   getParentNode,
   getRectRelativeToOffsetParent,
   getWindow,
   isArray,
+  isCanvas,
   isString,
   isCustomElement,
   isElement,
+  isJSON,
+  isMap,
+  isWeakMap,
   isNode,
   isNumber,
   isHTMLElement,
@@ -441,7 +439,6 @@ const SHORTY = {
   getElementsByClassName,
   getElementsByTagName,
   matches,
-  matchesLegacy,
   normalizeValue,
   normalizeOptions,
   reflow,
@@ -451,11 +448,11 @@ const SHORTY = {
   ArrayFrom,
   Float32ArrayFrom,
   Float64ArrayFrom,
+  ObjectHasOwn,
   ObjectAssign,
   ObjectEntries,
   ObjectKeys,
   ObjectValues,
-  OriginalEvent,
   getBoundingClientRect,
   getDocument,
   getDocumentBody,
@@ -471,7 +468,4 @@ const SHORTY = {
   setAttributeNS,
   removeAttribute,
   removeAttributeNS,
-  Version,
 };
-
-export default SHORTY;

package/src/interface/boundingClientRect.d.ts

@@ -0,0 +1,10 @@
+export declare interface BoundingClientRect {
+  width: number;
+  height: number;
+  top: number;
+  left: number;
+  right: number;
+  bottom: number;
+  x: number;
+  y: number;
+}

package/src/interface/css4Declaration.d.ts

@@ -0,0 +1,4 @@
+export declare interface CSS4Declaration
+  extends Exclude<() => string | symbol, CSSStyleDeclaration> {
+  [key: string]: string;
+}

package/src/interface/customElement.d.ts

@@ -0,0 +1,8 @@
+export declare interface CustomElement extends HTMLElement {
+  shadowRoot: ShadowRoot;
+  connectedCallback?: () => void;
+  disconnectedCallback?: () => void;
+  adoptedCallback?: () => void;
+  attributeChangedCallback?: () => void;
+  // [key: PropertyKey]: any;
+}

package/src/interface/navigatorUA.d.ts

@@ -0,0 +1,15 @@
+// https://github.com/lukewarlow/user-agent-data-types/blob/master/index.d.ts
+export declare interface NavigatorUABrand {
+  readonly brand: string;
+  readonly version: string;
+}
+
+export declare interface NavigatorUAData {
+  readonly brands: NavigatorUABrand[];
+  readonly mobile: boolean;
+  readonly platform: string;
+}
+
+export declare interface NavigatorUA extends Navigator {
+  readonly userAgentData: NavigatorUAData;
+}

package/src/interface/offsetRect.d.ts

@@ -0,0 +1,6 @@
+export declare interface OffsetRect {
+  width: number;
+  height: number;
+  x: number;
+  y: number;
+}

package/src/interface/originalEvent.d.ts

@@ -0,0 +1,4 @@
+export declare interface OriginalEvent extends CustomEvent<any> {
+  readonly type: string;
+  relatedTarget?: EventTarget;
+}

package/src/is/isArray.ts

@@ -0,0 +1,9 @@
+/**
+ * Shortie for the `Array.isArray()` static method.
+ *
+ * @param obj array-like iterable object
+ * @returns the query result
+ */
+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

@@ -0,0 +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 CustomElement>(element?: unknown): element is T =>
+  (isHTMLElement(element) && !!(element as T).shadowRoot) || false;
+
+export default isCustomElement;

package/src/is/isDocument.ts

@@ -0,0 +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?: unknown): obj is Document => (isNode(obj) && obj.nodeType === 9) || false;
+
+export default isDocument;

package/src/is/{isElement.js → 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 {any} element the target object
- * @returns {boolean} the query result
+ * ```
+ * @param element the target object
+ * @returns the query result
  */
-const isElement = (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.js → isElementInScrollRange.ts}

@@ -6,11 +6,11 @@ import isNode from './isNode';
  * Utility to determine if an `HTMLElement`
  * is partially visible in viewport.
  *
- * @param {HTMLElement} element target
- * @return {boolean} the query result
+ * @param element target
+ * @return the query result
  */
-const isElementInScrollRange = (element) => {
-  if (!element || !isNode(element)) return false;
+const isElementInScrollRange = (element?: HTMLElement): boolean => {
+  if (!isNode(element)) return false;
 
   const { top, bottom } = getBoundingClientRect(element);
   const { clientHeight } = getDocumentElement(element);

package/src/is/{isElementInViewport.js → isElementInViewport.ts}

@@ -6,21 +6,15 @@ import isNode from './isNode';
  * Utility to determine if an `HTMLElement`
  * is fully visible in the viewport.
  *
- * @param {HTMLElement} element target
- * @return {boolean} the query result
+ * @param element target
+ * @return the query result
  */
-const isElementInViewport = (element) => {
-  if (!element || !isNode(element)) return false;
+const isElementInViewport = (element?: HTMLElement): boolean => {
+  if (!isNode(element)) return false;
 
   const { clientWidth, clientHeight } = getDocumentElement(element);
-  const {
-    top, left, bottom, right,
-  } = getBoundingClientRect(element, true);
+  const { top, left, bottom, right } = getBoundingClientRect(element, true);
 
-  return (
-    top >= 0 && left >= 0
-    && bottom <= clientHeight
-    && right <= clientWidth
-  );
+  return top >= 0 && left >= 0 && bottom <= clientHeight && right <= clientWidth;
 };
 export default isElementInViewport;

package/src/is/isElementsArray.ts

@@ -0,0 +1,13 @@
+import isHTMLElement from './isHTMLElement';
+import isArray from './isArray';
+
+/**
+ * Checks if an object is an `Array` in which all items are `Element`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+const isElementsArray = (obj?: unknown): obj is HTMLElement[] =>
+  (isArray(obj) && obj.every(isHTMLElement)) || false;
+
+export default isElementsArray;

package/src/is/isFunction.ts

@@ -0,0 +1,10 @@
+/**
+ * Checks if an object is a `Function`.
+ *
+ * @param fn the target object
+ * @returns the query result
+ */
+const isFunction = (fn?: unknown): fn is (...arg0: any[]) => any =>
+  typeof fn === 'function' || false;
+
+export default isFunction;

package/src/is/isHTMLCollection.ts

@@ -0,0 +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?: unknown): obj is HTMLCollection =>
+  (isObject(obj) && obj.constructor.name === 'HTMLCollection') || false;
+
+export default isHTMLCollection;

package/src/is/isHTMLElement.ts

@@ -0,0 +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?: unknown): element is HTMLElement =>
+  (isNode(element) && element.nodeType === 1) || false;
+export default isHTMLElement;

package/src/is/isHTMLImageElement.ts

@@ -0,0 +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?: 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

@@ -0,0 +1,20 @@
+import isNode from './isNode';
+
+/**
+ * Checks if an element is an `<svg>` (or any type of SVG element),
+ * `<img>`, `<video>` or `<canvas>`.
+ *
+ * *Tooltip* / *Popover* works different with media elements.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+
+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

@@ -0,0 +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?: 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

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

package/src/is/isNumber.ts

@@ -0,0 +1,9 @@
+/**
+ * Shortie for `typeof SOMETHING === "number"`.
+ *
+ * @param num input value
+ * @returns the query result
+ */
+const isNumber = (num?: unknown): num is number => typeof num === 'number' || false;
+
+export default isNumber;

package/src/is/isObject.ts

@@ -0,0 +1,10 @@
+/**
+ * Checks if a value is an `Object`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+const isObject = (obj?: unknown): obj is object =>
+  (obj !== null && obj !== undefined && typeof obj === 'object') || false;
+
+export default isObject;

package/src/is/isRTL.ts

@@ -0,0 +1,11 @@
+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';
+
+export default isRTL;

package/src/is/isSVGElement.ts

@@ -0,0 +1,13 @@
+import isNode from './isNode';
+
+/**
+ * Check if an element is an `<svg>` or any other SVG element,
+ * an equivalent to `SOMETHING instanceof SVGElement`.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+const isSVGElement = (element?: unknown): element is SVGElement =>
+  (isNode(element) && element.constructor.name.includes('SVG')) || false;
+
+export default isSVGElement;

package/src/is/{isScaledElement.js → isScaledElement.ts}

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