@koine/dom 2.0.0-beta.2 → 2.0.0-beta.21

package/$.d.ts

@@ -1,13 +1,2 @@
-/**
- * Sizzle/jQuery like DOM nodes shortcut for `document.querySelector`
- * To avoid an extra function call we inline the above `escape`
- *
- * @param selector DOM selector
- * @param parent It falls back to `window.document`
- * @param avoidEscape Whether to avoid escaping `:` in the selector string
- * @example <caption>Basic DOM selection</caption>
- * const $container = $(".my-section:");
- * const $el = $("[data-some-attr]", $container);
- */
-export declare function $<T extends Element = HTMLElement>(selector: string, parent?: HTMLElement | Document, avoidEscape?: boolean): T;
+export declare function $<T extends Element = HTMLElement>(selector: string, parent?: HTMLElement | Document | null, avoidEscape?: boolean): T;
 export default $;

package/$.js

@@ -1,19 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.$ = void 0;
-/**
- * Sizzle/jQuery like DOM nodes shortcut for `document.querySelector`
- * To avoid an extra function call we inline the above `escape`
- *
- * @param selector DOM selector
- * @param parent It falls back to `window.document`
- * @param avoidEscape Whether to avoid escaping `:` in the selector string
- * @example <caption>Basic DOM selection</caption>
- * const $container = $(".my-section:");
- * const $el = $("[data-some-attr]", $container);
- */
-function $(selector, parent, avoidEscape) {
+export function $(selector, parent, avoidEscape) {
     return (parent ? parent : document).querySelector(avoidEscape ? selector : selector.replace(/:/g, "\\:"));
 }
-exports.$ = $;
-exports.default = $;
+export default $;

package/$all.d.ts

@@ -0,0 +1,2 @@
+export declare function $all<T extends Element = HTMLElement>(selector: string, parent?: Element | HTMLElement | Document | null, avoidEscape?: boolean): NodeListOf<T>;
+export default $all;

package/$all.js

@@ -0,0 +1,4 @@
+export function $all(selector, parent, avoidEscape) {
+    return (parent ? parent : document).querySelectorAll(avoidEscape ? selector : selector.replace(/:/g, "\\:"));
+}
+export default $all;

package/$each.d.ts

@@ -1,11 +1,2 @@
-/**
- * Each shortcut, iterate through a NodeList of HTMLElements retrieved with the
- * given selector (and optionally a parent container passed as thrid arguement)
- *
- * @param selector DOM selector
- * @param callback
- * @param parent It falls back to `window.document`
- * @param scope
- */
 export declare function $each<T extends Element = HTMLElement>(selector: string, callback: ($element: T, index: number) => any, parent?: HTMLElement, scope?: object): void;
 export default $each;

package/$each.js

@@ -1,22 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.$each = void 0;
-var tslib_1 = require("tslib");
-var __1 = tslib_1.__importDefault(require("./$$"));
-/**
- * Each shortcut, iterate through a NodeList of HTMLElements retrieved with the
- * given selector (and optionally a parent container passed as thrid arguement)
- *
- * @param selector DOM selector
- * @param callback
- * @param parent It falls back to `window.document`
- * @param scope
- */
-function $each(selector, callback, parent, scope) {
-    var nodes = (0, __1.default)(selector, parent);
+import $all from "./$all.js";
+export function $each(selector, callback, parent, scope) {
+    var nodes = $all(selector, parent);
     for (var i = 0; i < nodes.length; i++) {
         callback.call(scope, nodes[i], i);
     }
 }
-exports.$each = $each;
-exports.default = $each;
+export default $each;

package/_listen-delegation.d.ts

@@ -1,38 +1,10 @@
-/**
- * @internal
- */
-export type EventCallback = (event: Event, desiredTarget: Window | Document | Element) => any;
-/**
- * @internal
- */
+import type { AnyDOMEvent, AnyDOMEventTarget, AnyDOMEventType } from "./types.js";
+export type EventCallback<TTarget extends AnyDOMEventTarget = AnyDOMEventTarget, TType extends AnyDOMEventType = AnyDOMEventType> = (event: AnyDOMEvent<TType>, desiredTarget: TTarget) => any;
 export type ListenEvent = {
     selector: string;
     callback: EventCallback;
 };
-/**
- * Active events
- *
- * @internal
- */
-export declare const activeEvents: Record<Event["type"], ListenEvent[]>;
-/**
- * Get the index for the listener
- *
- * @internal
- */
+export declare const activeEvents: Partial<Record<AnyDOMEventType, ListenEvent[]>>;
 export declare function getIndex(arr: ListenEvent[], selector: string, callback: EventCallback): number;
-/**
- * Check if the listener callback should run or not
- *
- * @internal
- * @param target The event.target
- * @param selector The selector/element to check the target against
- * @return If not false, run listener and pass the targeted element to use in the callback
- */
 export declare function getRunTarget(target: Element, selector: string | Window | Document | Element): false | Element | Document | Window | null;
-/**
- * Handle listeners after event fires
- *
- * @internal
- */
 export declare function eventHandler(event: Event): void;

package/_listen-delegation.js

@@ -1,30 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.eventHandler = exports.getRunTarget = exports.getIndex = exports.activeEvents = void 0;
-var tslib_1 = require("tslib");
-/**
- * Listen: events delegation system
- *
- * From:
- * https://github.com/cferdinandi/events
- * https://github.com/cferdinandi/events/blob/master/src/js/events/events.js
- *
- * @fileoverview
- */
-var isString_1 = tslib_1.__importDefault(require("@koine/utils/isString"));
-var escapeSelector_1 = tslib_1.__importDefault(require("./escapeSelector"));
-/**
- * Active events
- *
- * @internal
- */
-exports.activeEvents = {};
-/**
- * Get the index for the listener
- *
- * @internal
- */
-function getIndex(arr, selector, callback) {
+import { isString } from "@koine/utils";
+import escapeSelector from "./escapeSelector.js";
+export var activeEvents = {};
+export function getIndex(arr, selector, callback) {
     for (var i = 0; i < arr.length; i++) {
         if (arr[i].selector === selector &&
             arr[i].callback.toString() === callback.toString())
@@ -32,17 +9,7 @@ function getIndex(arr, selector, callback) {
     }
     return -1;
 }
-exports.getIndex = getIndex;
-/**
- * Check if the listener callback should run or not
- *
- * @internal
- * @param target The event.target
- * @param selector The selector/element to check the target against
- * @return If not false, run listener and pass the targeted element to use in the callback
- */
-function getRunTarget(target, selector) {
-    // @ts-expect-error FIXME: type
+export function getRunTarget(target, selector) {
     if (["*", "window", window].includes(selector)) {
         return window;
     }
@@ -51,18 +18,15 @@ function getRunTarget(target, selector) {
         "document.documentElement",
         document,
         document.documentElement,
-        // @ts-expect-error FIXME: type
     ].includes(selector))
         return document;
-    if ((0, isString_1.default)(selector)) {
-        return target.closest((0, escapeSelector_1.default)(selector));
+    if (isString(selector)) {
+        return target.closest(escapeSelector(selector));
     }
-    // @ts-expect-error FIXME: type
     if (typeof selector !== "string" && selector.contains) {
         if (selector === target) {
             return target;
         }
-        // @ts-expect-error FIXME: type
         if (selector.contains(target)) {
             return selector;
         }
@@ -70,16 +34,9 @@ function getRunTarget(target, selector) {
     }
     return false;
 }
-exports.getRunTarget = getRunTarget;
-/**
- * Handle listeners after event fires
- *
- * @internal
- */
-function eventHandler(event) {
-    if (!exports.activeEvents[event.type])
-        return;
-    exports.activeEvents[event.type].forEach(function (listener) {
+export function eventHandler(event) {
+    var _a;
+    (_a = activeEvents[event.type]) === null || _a === void 0 ? void 0 : _a.forEach(function (listener) {
         var target = getRunTarget(event.target, listener.selector);
         if (!target) {
             return;
@@ -87,4 +44,3 @@ function eventHandler(event) {
         listener.callback(event, target);
     });
 }
-exports.eventHandler = eventHandler;

package/addClass.d.ts

@@ -1,5 +1,2 @@
-/**
- * Add class shortcut
- */
 export declare function addClass<T extends Element = HTMLElement>(el?: T, className?: string): void;
 export default addClass;

package/addClass.js

@@ -1,12 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addClass = void 0;
-/**
- * Add class shortcut
- */
-function addClass(el, className) {
+export function addClass(el, className) {
     if (className === void 0) { className = ""; }
-    if (process.env["NODE_ENV"] !== "production") {
+    if (process.env["NODE_ENV"] === "development") {
         if (!el) {
             console.warn("[@koine/dom:addClass] unexisting DOM element");
             return;
@@ -15,5 +9,4 @@ function addClass(el, className) {
     if (el)
         el.classList.add(className);
 }
-exports.addClass = addClass;
-exports.default = addClass;
+export default addClass;

package/calculateFixedOffset.js

@@ -1,14 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateFixedOffset = void 0;
-var _each_1 = require("./$each");
-function calculateFixedOffset(selector) {
+import { $each } from "./$each.js";
+export function calculateFixedOffset(selector) {
     if (selector === void 0) { selector = "[data-fixed]"; }
     var fixedOffset = 0;
-    (0, _each_1.$each)(selector, function ($el) {
+    $each(selector, function ($el) {
         fixedOffset += $el.offsetHeight;
     });
     return fixedOffset;
 }
-exports.calculateFixedOffset = calculateFixedOffset;
-exports.default = calculateFixedOffset;
+export default calculateFixedOffset;

package/createElement.d.ts

@@ -1,9 +1,3 @@
-/**
- * Shortcut for `document.createElement`, allowing to to create an HTML element
- * with a given className directly (a very common use case)
- *
- * @param type
- * @param className
- */
-export declare function createElement(type: string, className?: string): HTMLElement;
+import { LiteralUnion } from "type-fest";
+export declare function createElement<TType extends LiteralUnion<keyof HTMLElementTagNameMap, string>, TElement extends HTMLElement = TType extends keyof HTMLElementTagNameMap ? HTMLElementTagNameMap[TType] : HTMLElement>(type: TType, className?: string): TElement;
 export default createElement;

package/createElement.js

@@ -1,21 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createElement = void 0;
-var tslib_1 = require("tslib");
-var addClass_1 = tslib_1.__importDefault(require("./addClass"));
-/**
- * Shortcut for `document.createElement`, allowing to to create an HTML element
- * with a given className directly (a very common use case)
- *
- * @param type
- * @param className
- */
-function createElement(type, className) {
+import addClass from "./addClass.js";
+export function createElement(type, className) {
     var el = document.createElement(type);
     if (className) {
-        (0, addClass_1.default)(el, className);
+        addClass(el, className);
     }
     return el;
 }
-exports.createElement = createElement;
-exports.default = createElement;
+export default createElement;

package/emitEvent.d.ts

@@ -1,5 +1,2 @@
-/**
- * Emit event (use only if the targeted browser supports `CustomEvent`s)
- */
 export declare function emitEvent(type?: string, detail?: {}): void;
 export default emitEvent;

package/emitEvent.js

@@ -1,10 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.emitEvent = void 0;
-/**
- * Emit event (use only if the targeted browser supports `CustomEvent`s)
- */
-function emitEvent(type, detail) {
+export function emitEvent(type, detail) {
     if (type === void 0) { type = "customEvent"; }
     if (detail === void 0) { detail = {}; }
     if (typeof window.CustomEvent !== "function")
@@ -14,5 +8,4 @@ function emitEvent(type, detail) {
         detail: detail,
     }));
 }
-exports.emitEvent = emitEvent;
-exports.default = emitEvent;
+export default emitEvent;

package/escapeSelector.d.ts

@@ -1,8 +1,2 @@
-/**
- * Escape colons to allow use class names as `.module:block__element`
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector#Escaping_special_characters
- *
- * @param selector
- */
 export declare function escapeSelector(selector: string): string;
 export default escapeSelector;

package/escapeSelector.js

@@ -1,14 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeSelector = void 0;
-/**
- * Escape colons to allow use class names as `.module:block__element`
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector#Escaping_special_characters
- *
- * @param selector
- */
-function escapeSelector(selector) {
+export function escapeSelector(selector) {
     return selector.replace(/:/g, "\\:");
 }
-exports.escapeSelector = escapeSelector;
-exports.default = escapeSelector;
+export default escapeSelector;

package/exists.d.ts

@@ -1,7 +1,2 @@
-/**
- * Checks if passed node exist and is a valid element.
- *
- * @borrows @glidejs/glide/src/utils/dom (source)
- */
 export declare function exists(node?: Element): boolean;
 export default exists;

package/exists.js

@@ -1,16 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exists = void 0;
-/**
- * Checks if passed node exist and is a valid element.
- *
- * @borrows @glidejs/glide/src/utils/dom (source)
- */
-function exists(node) {
+export function exists(node) {
     if (node && node instanceof window.HTMLElement) {
         return true;
     }
     return false;
 }
-exports.exists = exists;
-exports.default = exists;
+export default exists;

package/forEach.d.ts

@@ -1,9 +1,2 @@
-/**
- * For each, iterate through a NodeList of HTMLElements
- *
- * @param nodes DOM nodes collection
- * @param callback
- * @param scope
- */
-export declare function forEach<T extends Element = HTMLElement, TScope = object>(nodes: NodeList, callback: (this: TScope, $element: T, index: number) => any, scope?: TScope): void;
+export declare function forEach<T extends HTMLElement, TScope = object>(nodes: NodeListOf<T> | T[], callback: (this: TScope, $element: T, index: number) => any, scope?: TScope): void;
 export default forEach;

package/forEach.js

@@ -1,17 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.forEach = void 0;
-/**
- * For each, iterate through a NodeList of HTMLElements
- *
- * @param nodes DOM nodes collection
- * @param callback
- * @param scope
- */
-function forEach(nodes, callback, scope) {
+export function forEach(nodes, callback, scope) {
     for (var i = 0; i < nodes.length; i++) {
         callback.call(scope, nodes[i], i);
     }
 }
-exports.forEach = forEach;
-exports.default = forEach;
+export default forEach;

package/getDataAttr.d.ts

@@ -1,8 +1,2 @@
-/**
- * Get data attribute
- *
- * @param element
- * @param attribute The name of the `data-{attr}`
- */
 export declare function getDataAttr(element: HTMLElement, attribute: string): string | null;
 export default getDataAttr;

package/getDataAttr.js

@@ -1,17 +1,4 @@
-"use strict";
-// TODO: maybe move to `dataset` API but consider the comment about Safari here
-// https://stackoverflow.com/a/9201264/1938970
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDataAttr = void 0;
-/**
- * Get data attribute
- *
- * @param element
- * @param attribute The name of the `data-{attr}`
- */
-function getDataAttr(element, attribute) {
-    // return element.dataset[attribute];
+export function getDataAttr(element, attribute) {
     return element.getAttribute("data-" + attribute);
 }
-exports.getDataAttr = getDataAttr;
-exports.default = getDataAttr;
+export default getDataAttr;

package/getDocumentHeight.d.ts

@@ -1,7 +1,2 @@
-/**
- * Determine the document's height
- *
- * @see https://github.com/cferdinandi/smooth-scroll (credits)
- */
 export declare function getDocumentHeight(): number;
 export default getDocumentHeight;

package/getDocumentHeight.js

@@ -1,14 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDocumentHeight = void 0;
-/**
- * Determine the document's height
- *
- * @see https://github.com/cferdinandi/smooth-scroll (credits)
- */
-function getDocumentHeight() {
+export function getDocumentHeight() {
     var body = document.body, documentElement = document.documentElement;
     return Math.max(body.scrollHeight, documentElement.scrollHeight, body.offsetHeight, documentElement.offsetHeight, body.clientHeight, documentElement.clientHeight);
 }
-exports.getDocumentHeight = getDocumentHeight;
-exports.default = getDocumentHeight;
+export default getDocumentHeight;

package/getHeight.d.ts

@@ -1,5 +1,2 @@
-/**
- * Get element height
- */
 export declare function getHeight(element: HTMLElement): number;
 export default getHeight;

package/getHeight.js

@@ -1,11 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHeight = void 0;
-/**
- * Get element height
- */
-function getHeight(element) {
+export function getHeight(element) {
     return parseInt(window.getComputedStyle(element).height, 10);
 }
-exports.getHeight = getHeight;
-exports.default = getHeight;
+export default getHeight;

package/getListeners.d.ts

@@ -1,9 +1,2 @@
-/**
- * Get an immutable copy of all active event listeners
- *
- * @category listen-delegation
- *
- * @return Active event listeners
- */
-export declare function getListeners(): Record<string, import("./_listen-delegation").ListenEvent[]>;
+export declare function getListeners(): Partial<Record<import("./types").AnyDOMEventType, import("./_listen-delegation").ListenEvent[]>>;
 export default getListeners;

package/getListeners.js

@@ -1,22 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getListeners = void 0;
-var _listen_delegation_1 = require("./_listen-delegation");
-/**
- * Get an immutable copy of all active event listeners
- *
- * @category listen-delegation
- *
- * @return Active event listeners
- */
-function getListeners() {
+import { activeEvents } from "./_listen-delegation.js";
+export function getListeners() {
     var obj = {};
-    for (var type in _listen_delegation_1.activeEvents) {
-        // if (activeEvents.hasOwnProperty(type)) {
-        obj[type] = _listen_delegation_1.activeEvents[type];
-        // }
+    for (var type in activeEvents) {
+        obj[type] = activeEvents[type];
     }
     return obj;
 }
-exports.getListeners = getListeners;
-exports.default = getListeners;
+export default getListeners;

package/getOffset.d.ts

@@ -1,9 +1,3 @@
-/**
- * Get an element's distance from the top and left of the Document.
- *
- * @param elem The HTML node element
- * @return Distance from the top and left in pixels
- */
 export declare function getOffset(elem: HTMLElement): {
     top: number;
     left: number;

package/getOffset.js

@@ -1,22 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOffset = void 0;
-/**
- * Get an element's distance from the top and left of the Document.
- *
- * @param elem The HTML node element
- * @return Distance from the top and left in pixels
- */
-function getOffset(elem) {
+export function getOffset(elem) {
     var left = 0;
     var top = 0;
     while (elem && !isNaN(elem.offsetLeft) && !isNaN(elem.offsetTop)) {
         left += elem.offsetLeft - elem.scrollLeft;
         top += elem.offsetTop - elem.scrollTop;
-        // @ts-expect-error nevermind?
         elem = elem.offsetParent;
     }
     return { top: top, left: left };
 }
-exports.getOffset = getOffset;
-exports.default = getOffset;
+export default getOffset;

package/getOffsetTop.d.ts

@@ -1,10 +1,2 @@
-/**
- * Get an element's distance from the top of the Document.
- *
- * @see https://vanillajstoolkit.com/helpers/getoffsettop/
- *
- * @param elem The HTML node element
- * @return Distance from the top in pixels
- */
 export declare function getOffsetTop(elem: HTMLElement): number;
 export default getOffsetTop;

package/getOffsetTop.js

@@ -1,24 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOffsetTop = void 0;
-/**
- * Get an element's distance from the top of the Document.
- *
- * @see https://vanillajstoolkit.com/helpers/getoffsettop/
- *
- * @param elem The HTML node element
- * @return Distance from the top in pixels
- */
-function getOffsetTop(elem) {
+export function getOffsetTop(elem) {
     var location = 0;
     if (elem.offsetParent) {
         while (elem) {
             location += elem.offsetTop;
-            // @ts-expect-error nevermind?
             elem = elem.offsetParent;
         }
     }
     return location >= 0 ? location : 0;
 }
-exports.getOffsetTop = getOffsetTop;
-exports.default = getOffsetTop;
+export default getOffsetTop;

package/getOffsetTopSlim.d.ts

@@ -1,11 +1,2 @@
-/**
- * Get an element's distance from the top of the Document (using more modern/performant
- * technique compared to {@link ./getOffsetTop})
- *
- * @see https://stackoverflow.com/q/5598743/1938970
- *
- * @param elem The HTML node element
- * @return Distance from the top in pixels
- */
 export declare function getOffsetTopSlim(elem: HTMLElement): number;
 export default getOffsetTopSlim;