@koine/dom 2.0.0-beta.1 → 2.0.0-beta.11

package/listenResizeDebounced.mjs

@@ -4,39 +4,31 @@ import listenResize from "./listenResize";
  * Listen element's (`window` by default) _resize_ event debouncing the callback
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
- */
-export var listenResizeDebounced = function (el) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return listenResize(debounce.apply(void 0, args), el);
-};
-export default listenResizeDebounced;
-// EXP: with too complex overload signature...
-// import debounce from "@koine/utils/debounce";
-// import isUndefined from "@koine/utils/isUndefined";
-// import listenResize from "./listenResize";
-// /**
-//  * Listen element's (`window` by default) _resize_ event debouncing the callback
-//  *
-//  * @returns An automatic unbinding function to run to deregister the listener upon call
-//  */
-// export function listenResizeDebounced(
-//   ...args: Parameters<typeof debounce>
-// ): ReturnType<typeof listenResize>;
-// export function listenResizeDebounced(
-//   el: Parameters<typeof listenResize>[1],
-//   ...args: Parameters<typeof debounce>
-// ): ReturnType<typeof listenResize>;
-// export function listenResizeDebounced(
-//   ...args:
-//     | [Parameters<typeof listenResize>[1], ...Parameters<typeof debounce>]
-//     | Parameters<typeof debounce>
-// ) {
-//   if (isUndefined(args[0])) {
-//     return listenResize(debounce(...args));
-//   }
-//   return listenResize(debounce(...args.slice(1)), args[0]);
-// }
-// export default listenResizeDebounced;
+ */ export const listenResizeDebounced = (el, ...args)=>listenResize(debounce(...args), el);
+export default listenResizeDebounced; // EXP: with too complex overload signature...
+ // import debounce from "@koine/utils/debounce";
+ // import isUndefined from "@koine/utils/isUndefined";
+ // import listenResize from "./listenResize";
+ // /**
+ //  * Listen element's (`window` by default) _resize_ event debouncing the callback
+ //  *
+ //  * @returns An automatic unbinding function to run to deregister the listener upon call
+ //  */
+ // export function listenResizeDebounced(
+ //   ...args: Parameters<typeof debounce>
+ // ): ReturnType<typeof listenResize>;
+ // export function listenResizeDebounced(
+ //   el: Parameters<typeof listenResize>[1],
+ //   ...args: Parameters<typeof debounce>
+ // ): ReturnType<typeof listenResize>;
+ // export function listenResizeDebounced(
+ //   ...args:
+ //     | [Parameters<typeof listenResize>[1], ...Parameters<typeof debounce>]
+ //     | Parameters<typeof debounce>
+ // ) {
+ //   if (isUndefined(args[0])) {
+ //     return listenResize(debounce(...args));
+ //   }
+ //   return listenResize(debounce(...args.slice(1)), args[0]);
+ // }
+ // export default listenResizeDebounced;

package/listenResizeThrottled.mjs

@@ -4,12 +4,5 @@ import { listenResize } from "./listenResize";
  * Listen element's (`window` by default) _resize_ event throttling the callback
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
- */
-export var listenResizeThrottled = function (el) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return listenResize(throttle.apply(void 0, args), el);
-};
+ */ export const listenResizeThrottled = (el, ...args)=>listenResize(throttle(...args), el);
 export default listenResizeThrottled;

package/listenScroll.mjs

@@ -3,11 +3,8 @@ import { on } from "./on";
  * Listen element's (`window` by default) _scroll_ event
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
- */
-export var listenScroll = function (handler, el) {
-    return on(el || window, "scroll", handler, {
+ */ export const listenScroll = (handler, el)=>on(el || window, "scroll", handler, {
         capture: true,
-        passive: true,
+        passive: true
     });
-};
 export default listenScroll;

package/listenScrollDebounced.mjs

@@ -4,12 +4,5 @@ import { listenScroll } from "./listenScroll";
  * Listen element's (`window` by default) _scroll_ event debouncing the callback
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
- */
-export var listenScrollDebounced = function (el) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return listenScroll(debounce.apply(void 0, args), el);
-};
+ */ export const listenScrollDebounced = (el, ...args)=>listenScroll(debounce(...args), el);
 export default listenScrollDebounced;

package/listenScrollThrottled.mjs

@@ -4,12 +4,5 @@ import { listenScroll } from "./listenScroll";
  * Listen element's (`window` by default) _scroll_ event throttling the callback
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
- */
-export var listenScrollThrottled = function (el) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return listenScroll(throttle.apply(void 0, args), el);
-};
+ */ export const listenScrollThrottled = (el, ...args)=>listenScroll(throttle(...args), el);
 export default listenScrollThrottled;

package/off.d.ts

@@ -1,6 +1,6 @@
-import type { AnyDOMEventTargetLoose } from "./types";
+import type { AnyDOMEvent, AnyDOMEventTargetLoose, AnyDOMEventType } from "./types";
 /**
  * Shortcut for `removeEventListener`
  */
-export declare function off(el: AnyDOMEventTargetLoose, type: string, handler: EventListener, options?: EventListenerOptions | boolean): void;
+export declare function off<TType extends AnyDOMEventType>(el: AnyDOMEventTargetLoose, type: TType, handler: (event: AnyDOMEvent<TType>) => void, options?: EventListenerOptions | boolean): void;
 export default off;

package/off.mjs

@@ -1,14 +1,11 @@
 /**
  * Shortcut for `removeEventListener`
- */
-export function off(el, type, handler, options) {
-    if (options === void 0) { options = false; }
+ */ export function off(el, type, handler, options = false) {
     if (process.env["NODE_ENV"] !== "production") {
         if (!el) {
             console.warn("[@koine/dom:off] unexisting DOM element");
         }
     }
-    if (el)
-        el.removeEventListener(type, handler, options);
+    if (el) el.removeEventListener(type, handler, options);
 }
 export default off;

package/on.d.ts

@@ -1,8 +1,8 @@
-import type { AnyDOMEventTargetLoose } from "./types";
+import type { AnyDOMEvent, AnyDOMEventTargetLoose, AnyDOMEventType } from "./types";
 /**
  * Shortcut for `addEventListener`
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
  */
-export declare function on<THandler extends (event: any) => void>(el: AnyDOMEventTargetLoose, type: string, handler: THandler, options?: AddEventListenerOptions | boolean): () => void;
+export declare function on<TType extends AnyDOMEventType>(el: AnyDOMEventTargetLoose, type: TType, handler: (event: AnyDOMEvent<TType>) => void, options?: AddEventListenerOptions | boolean): () => void;
 export default on;

package/on.mjs

@@ -1,11 +1,11 @@
+// import noop from "@koine/utils/noop"; FIXME: build breaks with this import
 import off from "./off";
 /**
  * Shortcut for `addEventListener`
  *
  * @returns An automatic unbinding function to run to deregister the listener upon call
- */
-export function on(el, type, handler /* EventListener |  */ /* ((event: Event) => void) */, options) {
-    if (options === void 0) { options = false; }
+ */ export function on(el, type, handler, // handler: THandler /* EventListener |  */ /* ((event: Event) => void) */,
+options = false) {
     if (process.env["NODE_ENV"] !== "production") {
         if (!el) {
             console.warn("[@koine/dom:on] unexisting DOM element");
@@ -13,9 +13,9 @@ export function on(el, type, handler /* EventListener |  */ /* ((event: Event) =
     }
     if (el) {
         el.addEventListener(type, handler, options);
-        return function () { return off(el, type, handler); };
+        return ()=>off(el, type, handler);
     }
     // return noop;
-    return function () { return void 0; };
+    return ()=>void 0;
 }
 export default on;

package/onClickOutside.mjs

@@ -1,15 +1,13 @@
-import { on, off } from "./index";
-export function onClickOutside(element, callback, autoUnbind) {
-    if (autoUnbind === void 0) { autoUnbind = false; }
-    var bind = function (event) {
+import { off, on } from "./index";
+export function onClickOutside(element, callback, autoUnbind = false) {
+    const bind = (event)=>{
         // if (event.target.closest(element) === null) {
         if (!element.contains(event.target)) {
             callback(event);
-            if (autoUnbind)
-                unbind();
+            if (autoUnbind) unbind();
         }
     };
-    var unbind = function () {
+    const unbind = ()=>{
         off(document, "click", bind);
     };
     on(document, "click", bind);

package/once.mjs

@@ -1,12 +1,10 @@
-import on from "./on";
 import off from "./off";
+import on from "./on";
 /**
  * One shot listener, it `addEventListener` and removes it first time is called
  * with `removeEventListener`
- */
-export function once(el, type, handler, options) {
-    if (options === void 0) { options = false; }
-    var handlerWrapper = function (event) {
+ */ export function once(el, type, handler, options = false) {
+    const handlerWrapper = (event)=>{
         handler(event);
         off(el, type, handlerWrapper);
     };

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@koine/dom",
   "sideEffects": false,
-  "peerDependencies": {
-    "tslib": "2.5.3"
+  "dependencies": {
+    "@koine/utils": "2.0.0-beta.11"
   },
+  "module": "./index.mjs",
   "main": "./index.js",
   "types": "./index.d.ts",
-  "version": "2.0.0-beta.1",
-  "module": "./index.mjs"
-}
+  "peerDependencies": {
+    "type-fest": "^4.1.0"
+  },
+  "version": "2.0.0-beta.11"
+}

package/removeClass.mjs

@@ -1,15 +1,12 @@
 /**
  * Remove class shortcut
- */
-export function removeClass(el, className) {
-    if (className === void 0) { className = ""; }
+ */ export function removeClass(el, className = "") {
     if (process.env["NODE_ENV"] !== "production") {
         if (!el) {
-            ("[@koine/dom:removeClass] unexisting DOM element");
+            "[@koine/dom:removeClass] unexisting DOM element";
             return;
         }
     }
-    if (el)
-        el.classList.remove(className);
+    if (el) el.classList.remove(className);
 }
 export default removeClass;

package/scrollTo.mjs

@@ -1,5 +1,5 @@
-import { on } from "./on";
 import { off } from "./off";
+import { on } from "./on";
 /**
  * Native `scrollTo`, `"smooth"` and with callback
  *
@@ -9,24 +9,23 @@ import { off } from "./off";
  * @param callback - callback function
  * @param [fallbackTimeout] - this appears to be needed in some hard to reproduce scenario on safari, where the callback seem to be never called
  * @param [behavior="smooth"]
- */
-export function scrollTo(destination, callback, fallbackTimeout, behavior) {
-    var fixedDestination = destination.toFixed();
+ */ export function scrollTo(destination, callback, fallbackTimeout, behavior) {
+    const fixedDestination = destination.toFixed();
     if (callback) {
-        var callbackFired_1 = false;
-        var onScroll_1 = function () {
+        let callbackFired = false;
+        const onScroll = function() {
             if (window.pageYOffset.toFixed() === fixedDestination) {
-                off(window, "scroll", onScroll_1);
-                callbackFired_1 = true;
+                off(window, "scroll", onScroll);
+                callbackFired = true;
                 callback();
             }
         };
-        on(window, "scroll", onScroll_1);
-        onScroll_1();
+        on(window, "scroll", onScroll);
+        onScroll();
         if (fallbackTimeout) {
-            setTimeout(function () {
-                if (!callbackFired_1) {
-                    off(window, "scroll", onScroll_1);
+            setTimeout(()=>{
+                if (!callbackFired) {
+                    off(window, "scroll", onScroll);
                     callback();
                 }
             }, fallbackTimeout);
@@ -34,7 +33,7 @@ export function scrollTo(destination, callback, fallbackTimeout, behavior) {
     }
     window.scrollTo({
         top: destination,
-        behavior: behavior || "smooth",
+        behavior: behavior || "smooth"
     });
 }
 export default scrollTo;

package/setDataAttr.mjs

@@ -4,8 +4,7 @@
  * @param element
  * @param attribute The name of the `data-{attr}`
  * @param value The value to set, `null` or `undefined` will remove the attribute
- */
-export function setDataAttr(element, attribute, value) {
+ */ export function setDataAttr(element, attribute, value) {
     if (value === null || typeof value === "undefined") {
         // delete element.dataset[attribute];
         // return;

package/setVendorCSS.mjs

@@ -4,9 +4,8 @@
  * @param element A single HTMLElement
  * @param prop CSS rule proerty
  * @param value The CSS value to set, it will be automatically vendor prefixed
- */
-export function setVendorCSS(element, prop, value) {
-    var propUpper = prop.charAt(0).toUpperCase() + prop.slice(1);
+ */ export function setVendorCSS(element, prop, value) {
+    const propUpper = prop.charAt(0).toUpperCase() + prop.slice(1);
     // @ts-expect-error nevermind now...
     element.style["webkit" + propUpper] = value;
     // @ts-expect-error nevermind now...

package/siblings.mjs

@@ -2,12 +2,11 @@
  * Finds siblings nodes of the passed node.
  *
  * @borrows @glidejs/glide/src/utils/dom (source)
- */
-export function siblings(node) {
+ */ export function siblings(node) {
     if (node && node.parentNode) {
-        var n = node.parentNode.firstChild;
-        var matched = [];
-        for (; n; n = n.nextSibling) {
+        let n = node.parentNode.firstChild;
+        const matched = [];
+        for(; n; n = n.nextSibling){
             if (n.nodeType === 1 && n !== node) {
                 matched.push(n);
             }

package/toArray.mjs

@@ -2,8 +2,7 @@
  * Node list to array
  *
  * @param nodeList
- */
-export function toArray(nodeList) {
+ */ export function toArray(nodeList) {
     return Array.prototype.slice.call(nodeList);
 }
 export default toArray;

package/types.d.ts

@@ -1,3 +1,4 @@
+import { LiteralUnion } from "type-fest";
 import type { AnythingFalsy } from "@koine/utils/types";
 export type AnyDOMEventTarget = Window | Document | HTMLElement | Element;
 /**
@@ -5,3 +6,7 @@ export type AnyDOMEventTarget = Window | Document | HTMLElement | Element;
  * to `window` in case of _scroll_ or _resize_ events
  */
 export type AnyDOMEventTargetLoose = AnyDOMEventTarget | AnythingFalsy;
+type StandardDOMEventTypes = keyof GlobalEventHandlersEventMap;
+export type AnyDOMEventType = LiteralUnion<StandardDOMEventTypes | "storage" | "popstate", string>;
+export type AnyDOMEvent<TType extends AnyDOMEventType> = TType extends StandardDOMEventTypes ? GlobalEventHandlersEventMap[TType] : TType extends "storage" ? StorageEvent : TType extends "popstate" ? PopStateEvent : Event;
+export {};

package/types.mjs

@@ -1 +1 @@
-export {};
+export { };

package/unlisten.d.ts

@@ -1,4 +1,5 @@
 import { type EventCallback } from "./_listen-delegation";
+import type { AnyDOMEventTarget, AnyDOMEventType } from "./types";
 /**
  * Stop listening for an event
  *
@@ -8,5 +9,5 @@ import { type EventCallback } from "./_listen-delegation";
  * @param selector The selector to remove the event from
  * @param callback The function to remove
  */
-export declare function unlisten(types: string, selector: string, callback: EventCallback): void;
+export declare function unlisten<TTypes extends AnyDOMEventType, TTarget extends AnyDOMEventTarget = AnyDOMEventTarget>(types: TTypes, selector: string, callback: EventCallback<TTarget, TTypes>): void;
 export default unlisten;

package/unlisten.mjs

@@ -1,4 +1,4 @@
-import { activeEvents, getIndex, eventHandler, } from "./_listen-delegation";
+import { activeEvents, eventHandler, getIndex } from "./_listen-delegation";
 import { off } from "./off";
 /**
  * Stop listening for an event
@@ -8,15 +8,17 @@ import { off } from "./off";
  * @param types The event type or types (comma separated)
  * @param selector The selector to remove the event from
  * @param callback The function to remove
- */
-export function unlisten(types, selector, callback) {
+ */ export function unlisten(types, // | `${TTypes},${TTypes}`
+// | `${TTypes},${TTypes},${TTypes}`
+// | `${TTypes},${TTypes},${TTypes},${TTypes}`
+// | `${TTypes},${TTypes},${TTypes},${TTypes},${TTypes}`,
+selector, callback) {
     // Loop through each event type
-    types.split(",").forEach(function (type) {
+    types.split(",").forEach(function(type) {
         // Remove whitespace
         type = type.trim();
         // if event type doesn't exist, bail
-        if (!activeEvents[type])
-            return;
+        if (!activeEvents[type]) return;
         // If it's the last event of it's type, remove entirely
         if (activeEvents[type].length < 2 || !selector) {
             delete activeEvents[type];
@@ -24,9 +26,9 @@ export function unlisten(types, selector, callback) {
             return;
         }
         // Otherwise, remove event
-        var index = getIndex(activeEvents[type], selector, callback);
-        if (index < 0)
-            return;
+        // @ts-expect-error FIXME: type...
+        const index = getIndex(activeEvents[type], selector, callback);
+        if (index < 0) return;
         activeEvents[type].splice(index, 1);
     });
 }

package/$$.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.$$ = void 0;
-/**
- * Sizzle/jQuery like DOM nodes shortcut for `document.querySelectorAll`
- * To avoid an extra function call we inline the above `escape`
- *
- * @param string selector DOM selector
- * @param parent It falls back to `window.document`
- * @param avoidEscape Whether to avoid escaping `:` in the selector string
- */
-function $$(selector, parent, avoidEscape) {
-    return (parent ? parent : document).querySelectorAll(avoidEscape ? selector : selector.replace(/:/g, "\\:"));
-}
-exports.$$ = $$;
-exports.default = $$;

package/$.js

@@ -1,19 +0,0 @@
-"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) {
-    return (parent ? parent : document).querySelector(avoidEscape ? selector : selector.replace(/:/g, "\\:"));
-}
-exports.$ = $;
-exports.default = $;

package/$each.js

@@ -1,22 +0,0 @@
-"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);
-    for (var i = 0; i < nodes.length; i++) {
-        callback.call(scope, nodes[i], i);
-    }
-}
-exports.$each = $each;
-exports.default = $each;

package/_listen-delegation.js

@@ -1,90 +0,0 @@
-"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) {
-    for (var i = 0; i < arr.length; i++) {
-        if (arr[i].selector === selector &&
-            arr[i].callback.toString() === callback.toString())
-            return i;
-    }
-    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
-    if (["*", "window", window].includes(selector)) {
-        return window;
-    }
-    if ([
-        "document",
-        "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));
-    }
-    // @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;
-        }
-        return false;
-    }
-    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) {
-        var target = getRunTarget(event.target, listener.selector);
-        if (!target) {
-            return;
-        }
-        listener.callback(event, target);
-    });
-}
-exports.eventHandler = eventHandler;

package/addClass.js

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

package/calculateFixedOffset.js

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