@thednp/shorty 2.0.7 → 2.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thednp/shorty",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "description": "TypeScript shorties for the web",
   "source": "./src/index.ts",
   "main": "./dist/shorty.js",
@@ -32,15 +32,16 @@
   },
   "homepage": "https://github.com/thednp/shorty",
   "devDependencies": {
-    "@types/node": "^20.17.1",
-    "@vitest/browser": "^2.1.4",
-    "@vitest/coverage-istanbul": "^2.1.4",
-    "@vitest/ui": "^2.1.4",
-    "playwright": "^1.48.2",
+    "@types/node": "^20.17.6",
+    "@vitest/browser": "^2.1.5",
+    "@vitest/coverage-istanbul": "^2.1.5",
+    "@vitest/ui": "^2.1.5",
+    "playwright": "^1.49.0",
     "typescript": "^5.6.3",
-    "vite": "^5.4.10",
+    "vite": "^5.4.11",
     "vite-plugin-dts": "^4.3.0",
-    "vitest": "^2.1.4"
+    "vite-plugin-strip-comments": "^0.0.3",
+    "vitest": "^2.1.5"
   },
   "engines": {
     "node": ">=16",

package/.eslintrc.cjs

@@ -1,224 +0,0 @@
-module.exports = {
-    "env": {
-        "browser": true,
-        "es6": true
-    },
-    "extends": [
-        "plugin:@typescript-eslint/recommended",
-        "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "project": "tsconfig.json",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "eslint-plugin-jsdoc",
-        "eslint-plugin-prefer-arrow",
-        // "eslint-plugin-react",
-        "@typescript-eslint",
-        "prettier"
-    ],
-    "root": true,
-    "rules": {
-        "prettier/prettier": "error",
-        "@typescript-eslint/adjacent-overload-signatures": "error",
-        "@typescript-eslint/array-type": [
-            "error",
-            {
-                "default": "array"
-            }
-        ],
-        "@typescript-eslint/ban-types": [
-            "error",
-            {
-                "types": {
-                    "Object": {
-                        "message": "Avoid using the `Object` type. Did you mean `object`?"
-                    },
-                    "Function": {
-                        "message": "Avoid using the `Function` type. Prefer a specific function type, like `() => void`."
-                    },
-                    "Boolean": {
-                        "message": "Avoid using the `Boolean` type. Did you mean `boolean`?"
-                    },
-                    "Number": {
-                        "message": "Avoid using the `Number` type. Did you mean `number`?"
-                    },
-                    "String": {
-                        "message": "Avoid using the `String` type. Did you mean `string`?"
-                    },
-                    "Symbol": {
-                        "message": "Avoid using the `Symbol` type. Did you mean `symbol`?"
-                    }
-                }
-            }
-        ],
-        "@typescript-eslint/consistent-type-assertions": "error",
-        "@typescript-eslint/dot-notation": "error",
-        "@typescript-eslint/explicit-function-return-type": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off",
-        "@typescript-eslint/indent": "off",
-        "@typescript-eslint/member-delimiter-style": [
-            "off",
-            {
-                "multiline": {
-                    "delimiter": "none",
-                    "requireLast": true
-                },
-                "singleline": {
-                    "delimiter": "semi",
-                    "requireLast": false
-                }
-            }
-        ],
-        "@typescript-eslint/naming-convention": "off", // error
-        "@typescript-eslint/no-empty-function": "error",
-        "@typescript-eslint/no-empty-interface": "error",
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-misused-new": "error",
-        "@typescript-eslint/no-namespace": "error",
-        "@typescript-eslint/no-parameter-properties": "off",
-        "@typescript-eslint/no-shadow": [
-            "error",
-            {
-                "hoist": "all"
-            }
-        ],
-        "@typescript-eslint/no-unused-expressions": "error",
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/no-var-requires": "error",
-        "@typescript-eslint/prefer-for-of": "error",
-        "@typescript-eslint/prefer-function-type": "error",
-        "@typescript-eslint/prefer-namespace-keyword": "error",
-        "@typescript-eslint/quotes": "off",
-        "@typescript-eslint/semi": [
-            "off",
-            null
-        ],
-        "@typescript-eslint/triple-slash-reference": [
-            "error",
-            {
-                "path": "always",
-                "types": "prefer-import",
-                "lib": "always"
-            }
-        ],
-        "@typescript-eslint/type-annotation-spacing": "off",
-        "@typescript-eslint/typedef": "off",
-        "@typescript-eslint/unified-signatures": "error",
-        "arrow-parens": [
-            "off",
-            "always"
-        ],
-        "brace-style": [
-            "off",
-            "off"
-        ],
-        "comma-dangle": "off",
-        "complexity": "off",
-        "constructor-super": "error",
-        "dot-notation": "off",
-        "eol-last": "off",
-        "eqeqeq": [
-            "error",
-            "smart"
-        ],
-        "guard-for-in": "error",
-        "id-denylist": [
-            "error",
-            "any",
-            "Number",
-            "number",
-            "String",
-            "string",
-            "Boolean",
-            "boolean",
-            "Undefined",
-            "undefined"
-        ],
-        "id-match": "error",
-        "indent": "off",
-        "jsdoc/check-alignment": "error",
-        "jsdoc/check-indentation": "error",
-        // "jsdoc/newline-after-description": "error",
-        "linebreak-style": "off",
-        "max-classes-per-file": [
-            "error",
-            1
-        ],
-        "max-len": "off",
-        "new-parens": "off",
-        "newline-per-chained-call": "off",
-        "no-bitwise": "error",
-        "no-caller": "error",
-        "no-cond-assign": "error",
-        "no-console": "error",
-        "no-debugger": "error",
-        "no-empty": "error",
-        "no-empty-function": "off",
-        "no-eval": "error",
-        "no-extra-semi": "off",
-        "no-fallthrough": "off",
-        "no-invalid-this": "off",
-        "no-irregular-whitespace": "off",
-        "no-multiple-empty-lines": "off",
-        "no-new-wrappers": "error",
-        "no-shadow": "off",
-        "no-throw-literal": "error",
-        "no-trailing-spaces": "off",
-        "no-undef-init": "error",
-        "no-underscore-dangle": "off",
-        "no-unsafe-finally": "error",
-        "no-unused-expressions": "off",
-        "no-unused-labels": "error",
-        "no-use-before-define": "off",
-        "no-var": "error",
-        "object-shorthand": "error",
-        "one-var": [
-            "error",
-            "never"
-        ],
-        "padded-blocks": [
-            "off",
-            {
-                "blocks": "never"
-            },
-            {
-                "allowSingleLineBlocks": true
-            }
-        ],
-        "prefer-arrow/prefer-arrow-functions": "error",
-        "prefer-const": "error",
-        "quote-props": "off",
-        "quotes": "off",
-        "radix": "error",
-        // "react/jsx-curly-spacing": "off",
-        // "react/jsx-equals-spacing": "off",
-        // "react/jsx-tag-spacing": [
-        //     "off",
-        //     {
-        //         "afterOpening": "allow",
-        //         "closingSlash": "allow"
-        //     }
-        // ],
-        // "react/jsx-wrap-multilines": "off",
-        "semi": "off",
-        "space-before-function-paren": "off",
-        "space-in-parens": [
-            "off",
-            "never"
-        ],
-        "spaced-comment": [
-            "error",
-            "always",
-            {
-                "markers": [
-                    "/"
-                ]
-            }
-        ],
-        "use-isnan": "error",
-        "valid-typeof": "off"
-    }
-};

package/.lgtm.yml

@@ -1,8 +0,0 @@
-extraction:
-  typescript:
-    index:
-      exclude:
-        - coverage
-        - cypress
-        - experiments
-        - node_modules

package/.prettierrc.json

@@ -1,15 +0,0 @@
-{
-  "arrowParens": "avoid",
-  "bracketSpacing": true,
-  "endOfLine": "lf",
-  "bracketSameLine": false,
-  "jsxSingleQuote": false,
-  "printWidth": 100,
-  "proseWrap": "preserve",
-  "quoteProps": "as-needed",
-  "semi": true,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "useTabs": false
-}

package/src/attr/getAttribute.ts

@@ -1,11 +0,0 @@
-/**
- * Shortcut for `HTMLElement.getAttribute()` method.
- *
- * @param element target element
- * @param att attribute name
- * @returns attribute value
- */
-const getAttribute = (element: HTMLElement, att: string): string | null =>
-  element.getAttribute(att);
-
-export default getAttribute;

package/src/attr/getAttributeNS.ts

@@ -1,12 +0,0 @@
-/**
- * Shortcut for `HTMLElement.getAttributeNS()` method.
- *
- * @param ns attribute namespace
- * @param element target element
- * @param att attribute name
- * @returns attribute value
- */
-const getAttributeNS = (ns: string, element: HTMLElement, att: string) =>
-  element.getAttributeNS(ns, att);
-
-export default getAttributeNS;

package/src/attr/hasAttribute.ts

@@ -1,11 +0,0 @@
-/**
- * Shortcut for `HTMLElement.hasAttribute()` method.
- *
- * @param element target element
- * @param att attribute name
- * @returns the query result
- */
-const hasAttribute = (element: HTMLElement, att: string): boolean =>
-  element.hasAttribute(att);
-
-export default hasAttribute;

package/src/attr/hasAttributeNS.ts

@@ -1,15 +0,0 @@
-/**
- * Shortcut for `HTMLElement.hasAttributeNS()` method.
- *
- * @param ns attribute namespace
- * @param element target element
- * @param att attribute name
- * @returns the query result
- */
-const hasAttributeNS = (
-  ns: string,
-  element: HTMLElement,
-  att: string,
-): boolean => element.hasAttributeNS(ns, att);
-
-export default hasAttributeNS;

package/src/attr/removeAttribute.ts

@@ -1,10 +0,0 @@
-/**
- * Shortcut for `HTMLElement.removeAttribute()` method.
- *
- * @param element target element
- * @param att attribute name
- */
-const removeAttribute = (element: HTMLElement, att: string): void =>
-  element.removeAttribute(att);
-
-export default removeAttribute;

package/src/attr/removeAttributeNS.ts

@@ -1,14 +0,0 @@
-/**
- * Shortcut for `HTMLElement.removeAttributeNS()` method.
- *
- * @param ns attribute namespace
- * @param  element target element
- * @param att attribute name
- */
-const removeAttributeNS = (
-  ns: string,
-  element: HTMLElement,
-  att: string,
-): void => element.removeAttributeNS(ns, att);
-
-export default removeAttributeNS;

package/src/attr/setAttribute.ts

@@ -1,11 +0,0 @@
-/**
- * Shortcut for `HTMLElement.setAttribute()` method.
- *
- * @param element target element
- * @param att attribute name
- * @param value attribute value
- */
-const setAttribute = (element: HTMLElement, att: string, value: string) =>
-  element.setAttribute(att, value);
-
-export default setAttribute;

package/src/attr/setAttributeNS.ts

@@ -1,16 +0,0 @@
-/**
- * Shortcut for `SVGElement.setAttributeNS()` method.
- *
- * @param ns attribute namespace
- * @param element target element
- * @param att attribute name
- * @param value attribute value
- */
-const setAttributeNS = (
-  ns: string,
-  element: HTMLElement,
-  att: string,
-  value: string,
-): void => element.setAttributeNS(ns, att, value);
-
-export default setAttributeNS;

package/src/blocks/documentBody.ts

@@ -1,5 +0,0 @@
-/**
- * A global namespace for `document.body`.
- */
-const { body: documentBody } = document;
-export default documentBody;

package/src/blocks/documentElement.ts

@@ -1,5 +0,0 @@
-/**
- * A global namespace for `document.documentElement` or the `<HTML>`.
- */
-const { documentElement } = document;
-export default documentElement;

package/src/blocks/documentHead.ts

@@ -1,5 +0,0 @@
-/**
- * A global namespace for `document.head`.
- */
-const { head: documentHead } = document;
-export default documentHead;

package/src/boolean/isApple.ts

@@ -1,15 +0,0 @@
-import type { NavigatorUA } from "../interface/navigatorUA";
-
-/**
- * A global `boolean` getter for Apple browsers.
- */
-const isApple = () => {
-  const appleBrands = /(iPhone|iPod|iPad)/;
-  return (navigator as NavigatorUA)?.userAgentData?.brands.some((x) =>
-    appleBrands.test(x.brand)
-  ) || /* istanbul ignore next @preserve */
-    appleBrands.test(
-      navigator?.userAgent,
-    ) || false;
-};
-export default isApple;

package/src/boolean/isFirefox.ts

@@ -1,9 +0,0 @@
-/**
- * A global boolean for Gecko browsers. When writing this file,
- * Gecko was not supporting `userAgentData`.
- */
-const isFirefox = () =>
-  navigator?.userAgent?.includes("Firefox") ||
-  /* istanbul ignore next @preserve */ false;
-
-export default isFirefox;

package/src/boolean/isMobile.ts

@@ -1,14 +0,0 @@
-import type { NavigatorUA } from "../interface/navigatorUA";
-
-/**
- * A global `boolean` for mobile detection.
- */
-const isMobile = () => {
-  const mobileBrands = /iPhone|iPad|iPod|Android/i;
-
-  return (navigator as NavigatorUA)?.userAgentData?.brands.some((x) =>
-    mobileBrands.test(x.brand)
-  ) ||
-    mobileBrands.test(navigator?.userAgent) || false;
-};
-export default isMobile;

package/src/boolean/support3DTransform.ts

@@ -1,7 +0,0 @@
-/**
- * A global `boolean` for CSS3 3D transform support.
- */
-const support3DTransform = () =>
-  ["webkitPerspective", "perspective"].some((p) => p in document.head.style);
-
-export default support3DTransform;

package/src/boolean/supportAnimation.ts

@@ -1,7 +0,0 @@
-/**
- * A global `boolean` for CSS3 animation support.
- */
-const supportAnimation = () =>
-  ["webkitAnimation", "animation"].some((p) => p in document.head.style);
-
-export default supportAnimation;

package/src/boolean/supportPassive.ts

@@ -1,29 +0,0 @@
-import noop from "../misc/noop";
-import one from "../event/one";
-import DOMContentLoadedEvent from "../strings/DOMContentLoadedEvent";
-
-/**
- * A global `boolean` for passive events support,
- * in general event options are not suited for scroll prevention.
- *
- * @see https://github.com/WICG/EventListenerOptions/blob/gh-pages/explainer.md#feature-detection
- */
-const supportPassive = () => {
-  let result = false;
-  try {
-    const opts = Object.defineProperty({}, "passive", {
-      get: () => {
-        result = true;
-        return result;
-      },
-    });
-    // istanbul ignore next @preserve
-    one(document, DOMContentLoadedEvent, noop, opts);
-  } catch (_e) {
-    // throw Error('Passive events are not supported');
-  }
-
-  return result;
-};
-
-export default supportPassive;

package/src/boolean/supportTouch.ts

@@ -1,9 +0,0 @@
-/**
- * A global `boolean` for touch events support.
- */
-const supportTouch = () =>
-  "ontouchstart" in window ||
-  /* istanbul ignore next @preserve */
-  "msMaxTouchPoints" in navigator;
-
-export default supportTouch;

package/src/boolean/supportTransform.ts

@@ -1,7 +0,0 @@
-/**
- * A global `boolean` for CSS3 transform support.
- */
-const supportTransform = () =>
-  ["webkitTransform", "transform"].some((p) => p in document.head.style);
-
-export default supportTransform;

package/src/boolean/supportTransition.ts

@@ -1,7 +0,0 @@
-/**
- * A global `boolean` for CSS3 transition support.
- */
-const supportTransition = () =>
-  ["webkitTransition", "transition"].some((p) => p in document.head.style);
-
-export default supportTransition;

package/src/class/addClass.ts

@@ -1,11 +0,0 @@
-/**
- * Add one or more CSS classes to `HTMLElement.classList`.
- *
- * @param element target
- * @param classNAME to add
- */
-const addClass = (element: HTMLElement, ...classNAME: string[]): void => {
-  element.classList.add(...classNAME);
-};
-
-export default addClass;

package/src/class/hasClass.ts

@@ -1,11 +0,0 @@
-/**
- * Check class in `HTMLElement.classList`.
- *
- * @param element target
- * @param classNAME to check
- */
-const hasClass = (element: HTMLElement, classNAME: string): boolean => {
-  return element.classList.contains(classNAME);
-};
-
-export default hasClass;

package/src/class/removeClass.ts

@@ -1,11 +0,0 @@
-/**
- * Remove one or more classes from `HTMLElement.classList`.
- *
- * @param element target
- * @param classNAME to remove
- */
-const removeClass = (element: HTMLElement, ...classNAME: string[]): void => {
-  element.classList.remove(...classNAME);
-};
-
-export default removeClass;

package/src/event/off.ts

@@ -1,18 +0,0 @@
-/**
- * Remove eventListener from an `EventTarget` object.
- */
-const off = <T extends EventTarget, L = EventListener>(
-  element: T,
-  eventName: string,
-  listener: L,
-  options?: AddEventListenerOptions,
-) => {
-  const ops = options || false;
-  element.removeEventListener(
-    eventName,
-    listener as EventListenerOrEventListenerObject,
-    ops,
-  );
-};
-
-export default off;

package/src/event/on.ts

@@ -1,18 +0,0 @@
-/**
- * Add eventListener to an `EventTarget` object.
- */
-const on = <T extends EventTarget, L = EventListener>(
-  element: T,
-  eventName: string,
-  listener: L,
-  options?: AddEventListenerOptions,
-) => {
-  const ops = options || false;
-  element.addEventListener(
-    eventName,
-    listener as EventListenerOrEventListenerObject,
-    ops,
-  );
-};
-
-export default on;

package/src/event/one.ts

@@ -1,26 +0,0 @@
-import on from "./on";
-import off from "./off";
-import { NativeEventHandler } from "../interface/event";
-
-/**
- * Add an `eventListener` to an `EventTarget`
- * element and remove it once callback is called.
- */
-const one = <T extends EventTarget, L = EventListener>(
-  element: T,
-  eventName: string,
-  listener: L,
-  options?: AddEventListenerOptions,
-) => {
-  /** Wrap the listener for easy on -> off */
-  const handlerWrapper: NativeEventHandler<T> = (e) => {
-    // istanbul ignore else @preserve
-    if (e.target === element || e.currentTarget === element) {
-      (listener as NativeEventHandler<T>).apply(element, [e]);
-      off(element, eventName, handlerWrapper, options);
-    }
-  };
-  on(element, eventName, handlerWrapper, options);
-};
-
-export default one;