@splendidlabz/utils 1.8.1 → 1.9.0

package/dist/types/dom/events.d.cts

@@ -1,20 +1,92 @@
-declare function addListeners(listeners: any): void;
-declare function removeListeners(listeners: any): void;
-declare function dispatchEvent(node: any, eventName: any, detail: any, options?: {}): void;
-declare function updateEvent(event: any, updates: any): CustomEvent<any>;
-declare function createListeners(listeners: any): {
-    readonly list: any;
-    add({ node, event, handler }: {
-        node: any;
-        event: any;
-        handler: any;
-    }): void;
-    remove({ node, event, handler }: {
-        node: any;
-        event: any;
-        handler: any;
-    }): void;
-    clear(): void;
+/**
+ * @typedef {Object} EventListener
+ * @property {Element} node - The DOM element to attach the event listener to
+ * @property {string} event - The event type (e.g., 'click', 'keydown')
+ * @property {Function} handler - The event handler function
+ */
+/**
+ * @typedef {Object} ListenerManager
+ * @property {EventListener[]} list - Array of current event listeners
+ * @property {function(EventListener): void} add - Add a new event listener
+ * @property {function(EventListener): void} remove - Remove an event listener
+ * @property {function(): void} clear - Remove all event listeners
+ */
+/**
+ * @typedef {Object} CustomEventOptions
+ * @property {boolean} [bubbles=false] - Whether the event bubbles up through the DOM
+ * @property {boolean} [cancelable=false] - Whether the event can be canceled
+ * @property {boolean} [composed=false] - Whether the event will trigger listeners outside of a shadow root
+ */
+/**
+ * Adds multiple event listeners to their respective DOM elements
+ * @param {EventListener[]} listeners - Array of listener objects
+ */
+declare function addListeners(listeners: EventListener[]): void;
+/**
+ * Removes multiple event listeners from their respective DOM elements
+ * @param {EventListener[]} listeners - Array of listener objects
+ */
+declare function removeListeners(listeners: EventListener[]): void;
+/**
+ * Dispatches a custom event from a DOM node
+ * @param {Element} node - The DOM element to dispatch the event from
+ * @param {string} eventName - The name of the custom event
+ * @param {*} detail - The detail data to include with the event
+ * @param {CustomEventOptions} [options={}] - Additional event options
+ */
+declare function dispatchEvent(node: Element, eventName: string, detail: any, options?: CustomEventOptions): void;
+/**
+ * Creates a new CustomEvent with updated properties from an existing event
+ * @param {Event} event - The original event object
+ * @param {Object} updates - Properties to update in the new event
+ * @return {CustomEvent} A new CustomEvent with updated properties
+ */
+declare function updateEvent(event: Event, updates: any): CustomEvent;
+type EventListener = {
+    /**
+     * - The DOM element to attach the event listener to
+     */
+    node: Element;
+    /**
+     * - The event type (e.g., 'click', 'keydown')
+     */
+    event: string;
+    /**
+     * - The event handler function
+     */
+    handler: Function;
+};
+type ListenerManager = {
+    /**
+     * - Array of current event listeners
+     */
+    list: EventListener[];
+    /**
+     * - Add a new event listener
+     */
+    add: (arg0: EventListener) => void;
+    /**
+     * - Remove an event listener
+     */
+    remove: (arg0: EventListener) => void;
+    /**
+     * - Remove all event listeners
+     */
+    clear: () => void;
+};
+type CustomEventOptions = {
+    /**
+     * - Whether the event bubbles up through the DOM
+     */
+    bubbles?: boolean;
+    /**
+     * - Whether the event can be canceled
+     */
+    cancelable?: boolean;
+    /**
+     * - Whether the event will trigger listeners outside of a shadow root
+     */
+    composed?: boolean;
 };
 
-export { addListeners, createListeners, dispatchEvent, removeListeners, updateEvent };
+export { type CustomEventOptions, type EventListener, type ListenerManager, addListeners, dispatchEvent, removeListeners, updateEvent };

package/dist/types/dom/index.d.cts

@@ -6,7 +6,7 @@ export { boundingBox, boundingBoxRelativeToAncestor } from './bounding-box.cjs';
 export { copyRichText } from './clipboard.cjs';
 export { cookies, getCookie } from './cookie.cjs';
 export { getCSSValue, getCSSVar, setCSSValue, setCSSVar } from './css-vars.cjs';
-export { addListeners, createListeners, dispatchEvent, removeListeners, updateEvent } from './events.cjs';
+export { CustomEventOptions, EventListener, ListenerManager, addListeners, dispatchEvent, removeListeners, updateEvent } from './events.cjs';
 export { Focusable, Focusables, getFocusableElements } from './focusable.cjs';
 export { em, getUnit, lh, rem, toPx } from './font-size.cjs';
 export { getAncestorWithSiblings, getChildrenElements, getElement, getNodeType, getParentElement, getSelfIndex, getSiblingElements, isAncestor } from './get-element.cjs';
@@ -17,6 +17,7 @@ export { imagesLoaded, mediaLoaded, videosLoaded } from './media.cjs';
 export { intersectionObserver } from './observers/intersection-observer.cjs';
 export { mutationObserver } from './observers/mutation-observer.cjs';
 export { resizeObserver } from './observers/resize-observer.cjs';
+export { scrollObserver } from './observers/scroll-observer.cjs';
 export { PKCE } from './pkce.cjs';
 export { queryParams } from './query-params.cjs';
 export { randomString, uuid } from './random-string.cjs';

package/dist/types/dom/observers/index.d.cts

@@ -1,3 +1,4 @@
 export { intersectionObserver } from './intersection-observer.cjs';
 export { mutationObserver } from './mutation-observer.cjs';
 export { resizeObserver } from './resize-observer.cjs';
+export { scrollObserver } from './scroll-observer.cjs';

package/dist/types/dom/observers/scroll-observer.d.cts

@@ -0,0 +1,27 @@
+/**
+ * Scroll Observer - Optimized for performance
+ * @param {Element} node - The element to observe scroll events on
+ * @param {Object} options - Configuration options
+ * @param {Number} options.threshold - Float between 0 to 1. When to trigger callback (0.75 = 75% down page)
+ * @param {Number} options.tolerance - Float between 0 to 1. Tolerance zone around threshold
+ * @param {Number} options.throttle - Throttle interval in ms (default: 16ms for ~60fps)
+ * @param {Boolean} options.once - Only fire threshold callback once (default: false)
+ * @param {Function} options.callback - Called on every scroll with scrollPercent
+ * @param {Function} options.onScrollDown - Called when scrolling down
+ * @param {Function} options.onScrollUp - Called when scrolling up
+ * @param {Function} options.onEnterThreshold - Called when entering threshold zone
+ */
+declare function scrollObserver(node: Element, options?: {
+    threshold: number;
+    tolerance: number;
+    throttle: number;
+    once: boolean;
+    callback: Function;
+    onScrollDown: Function;
+    onScrollUp: Function;
+    onEnterThreshold: Function;
+}): {
+    destroy(): void;
+};
+
+export { scrollObserver };

package/dist/types/lib/functions/callback.d.cts

@@ -0,0 +1,8 @@
+/**
+ * Safely executes a callback function if it's a function
+ * @param {Function|*} fn - The potential callback function
+ * @param {...*} data - Data arguments to pass to the callback
+ */
+declare function runCallback(fn: Function | any, ...data: any[]): void;
+
+export { runCallback };

package/dist/types/lib/functions/functional.d.cts

@@ -1,6 +1,72 @@
-declare function curry(fn: any): (...args: any[]) => any;
-declare function compose(...fns: any[]): (value: any) => any;
-declare function pipe(...fns: any[]): (value: any) => any;
-declare function times(fn: any, n: any): any[];
+/**
+ * Creates a curried version of a function that can be called with partial arguments
+ * @param {Function} fn - The function to curry
+ * @return {Function} The curried function
+ * @property {any} return - The result of calling the original function when all arguments are provided
+ * @example
+ * const add = (a, b, c) => a + b + c
+ * const curriedAdd = curry(add)
+ * curriedAdd(1)(2)(3) // 6
+ * curriedAdd(1, 2)(3) // 6
+ * curriedAdd(1)(2, 3) // 6
+ */
+declare function curry(fn: Function): Function;
+/**
+ * Composes functions from right to left (synchronous)
+ * @param {...Function} fns - Functions to compose
+ * @return {Function} The composed function
+ * @property {any} return - The result of applying all functions in sequence
+ * @example
+ * const add1 = x => x + 1
+ * const multiply2 = x => x * 2
+ * const composed = compose(add1, multiply2)
+ * composed(3) // 7 (3 * 2 + 1)
+ */
+declare function compose(...fns: Function[]): Function;
+/**
+ * Composes functions from right to left (asynchronous)
+ * @param {...Function} fns - Functions to compose (can be sync or async)
+ * @return {Function} The composed async function
+ * @property {Promise<any>} return - A Promise that resolves to the result of applying all functions
+ * @example
+ * const add1 = x => x + 1
+ * const multiplyAsync = async x => x * 2
+ * await composeAsync(add1, multiplyAsync)(3) // 7 (3 * 2 + 1)
+ */
+declare function composeAsync(...fns: Function[]): Function;
+/**
+ * Pipes functions from left to right (synchronous)
+ * @param {...Function} fns - Functions to pipe
+ * @return {Function} The piped function
+ * @property {any} return - The result of applying all functions in sequence
+ * @example
+ * const add1 = x => x + 1
+ * const multiply2 = x => x * 2
+ * const piped = pipe(add1, multiply2)
+ * piped(3) // 8 (3 + 1) * 2
+ */
+declare function pipe(...fns: Function[]): Function;
+/**
+ * Pipes functions from left to right (asynchronous)
+ * @param {...Function} fns - Functions to pipe (can be sync or async)
+ * @return {Function} The piped async function
+ * @property {Promise<any>} return - A Promise that resolves to the result of applying all functions
+ * @example
+ * const add1 = x => x + 1
+ * const multiplyAsync = async x => x * 2
+ * await pipeAsync(add1, multiplyAsync)(3) // 8 ((3 + 1) * 2)
+ */
+declare function pipeAsync(...fns: Function[]): Function;
+/**
+ * Calls a function n times with the current index and returns an array of results
+ * @param {Function} fn - Function to call (receives index as argument)
+ * @param {number} n - Number of times to call the function
+ * @return {any[]} Array of results from calling the function
+ * @property {any[]} return - Array containing the results of each function call
+ * @example
+ * times(i => i * 2, 3) // [0, 2, 4]
+ * times(() => Math.random(), 2) // [0.123, 0.456] (random values)
+ */
+declare function times(fn: Function, n: number): any[];
 
-export { compose, curry, pipe, times };
+export { compose, composeAsync, curry, pipe, pipeAsync, times };

package/dist/types/lib/functions/index.d.cts

@@ -1,5 +1,5 @@
 export { debounce } from './debounce.cjs';
 export { getEnv } from './env.cjs';
-export { compose, curry, pipe, times } from './functional.cjs';
+export { compose, composeAsync, curry, pipe, pipeAsync, times } from './functional.cjs';
 export { throttle } from './throttle.cjs';
 export { delay, timeout, wait } from './timeout.cjs';

package/dist/types/lib/index.d.cts

@@ -13,7 +13,7 @@ export { flattenArrayFields, formDataToObject } from './form/form-data.cjs';
 export { SanitizeOptions, sanitize, sanitizeArray, sanitizeObject } from './form/sanitize.cjs';
 export { debounce } from './functions/debounce.cjs';
 export { getEnv } from './functions/env.cjs';
-export { compose, curry, pipe, times } from './functions/functional.cjs';
+export { compose, composeAsync, curry, pipe, pipeAsync, times } from './functions/functional.cjs';
 export { throttle } from './functions/throttle.cjs';
 export { delay, timeout, wait } from './functions/timeout.cjs';
 export { isHashedValue } from './hash.cjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splendidlabz/utils",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "",
   "type": "module",
   "sideEffects": false,

package/src/dom/events.js

@@ -1,26 +1,67 @@
+/**
+ * @typedef {Object} EventListener
+ * @property {Element} node - The DOM element to attach the event listener to
+ * @property {string} event - The event type (e.g., 'click', 'keydown')
+ * @property {Function} handler - The event handler function
+ */
+
+/**
+ * @typedef {Object} ListenerManager
+ * @property {EventListener[]} list - Array of current event listeners
+ * @property {function(EventListener): void} add - Add a new event listener
+ * @property {function(EventListener): void} remove - Remove an event listener
+ * @property {function(): void} clear - Remove all event listeners
+ */
+
+/**
+ * @typedef {Object} CustomEventOptions
+ * @property {boolean} [bubbles=false] - Whether the event bubbles up through the DOM
+ * @property {boolean} [cancelable=false] - Whether the event can be canceled
+ * @property {boolean} [composed=false] - Whether the event will trigger listeners outside of a shadow root
+ */
+
+/**
+ * Adds multiple event listeners to their respective DOM elements
+ * @param {EventListener[]} listeners - Array of listener objects
+ */
 export function addListeners(listeners) {
   listeners.forEach(({ node, event, handler }) => {
     node.addEventListener(event, handler)
   })
 }
 
+/**
+ * Removes multiple event listeners from their respective DOM elements
+ * @param {EventListener[]} listeners - Array of listener objects
+ */
 export function removeListeners(listeners) {
   listeners.forEach(({ node, event, handler }) => {
     node.removeEventListener(event, handler)
   })
 }
 
-// Dispatch a custom event from a Node.
+/**
+ * Dispatches a custom event from a DOM node
+ * @param {Element} node - The DOM element to dispatch the event from
+ * @param {string} eventName - The name of the custom event
+ * @param {*} detail - The detail data to include with the event
+ * @param {CustomEventOptions} [options={}] - Additional event options
+ */
 export function dispatchEvent(node, eventName, detail, options = {}) {
   node.dispatchEvent(
     new CustomEvent(eventName, {
       ...options,
       detail,
-    })
+    }),
   )
 }
 
-// Updates an event with new properties
+/**
+ * Creates a new CustomEvent with updated properties from an existing event
+ * @param {Event} event - The original event object
+ * @param {Object} updates - Properties to update in the new event
+ * @return {CustomEvent} A new CustomEvent with updated properties
+ */
 export function updateEvent(event, updates) {
   const { type, ...rest } = event
   return new CustomEvent(event.type, {
@@ -28,50 +69,3 @@ export function updateEvent(event, updates) {
     ...updates,
   })
 }
-
-// Doesn't seem to be used anywhere now.
-// Switch to addListeners and removeListeners instead
-export function createListeners(listeners) {
-  listeners = listeners || []
-
-  listeners.forEach(listener => {
-    const { node, event, handler } = listener
-    node.addEventListener(event, handler)
-  })
-
-  return {
-    get list() {
-      return listeners
-    },
-
-    add({ node, event, handler }) {
-      listeners.push({ node, event, handler })
-      node.addEventListener(event, handler)
-    },
-
-    remove({ node, event, handler }) {
-      const index = listeners.findIndex(listener => {
-        if (
-          listener.node === node &&
-          listener.event === event &&
-          listener.handler === handler
-        ) {
-          return true
-        }
-        return false
-      })
-
-      if (index !== -1) {
-        listeners.splice(index, 1)
-        node.removeEventListener(event, handler)
-      }
-    },
-
-    clear() {
-      listeners.forEach(({ node, event, handler }) => {
-        listeners = []
-        node.removeEventListener(event, handler)
-      })
-    },
-  }
-}

package/src/dom/observers/index.js

@@ -1,3 +1,4 @@
 export * from './intersection-observer.js'
 export * from './mutation-observer.js'
 export * from './resize-observer.js'
+export * from './scroll-observer.js'

package/src/dom/observers/resize-observer.js

@@ -4,8 +4,8 @@ import { useObserverMethodOnTarget } from './observer.js'
 
 /**
  * Creates and manages a ResizeObserver instance to monitor size changes of a target element.
- * 
- * @param {Element|Window|NodeList|Element[]} target - The element(s) to observe. 
+ *
+ * @param {Element|Window|NodeList|Element[]} target - The element(s) to observe.
  *   - If window is provided, document.body will be observed instead.
  *   - If NodeList or Array of elements is provided, all elements will be observed.
  * @param {Object} options - Configuration options for the resize observer
@@ -13,13 +13,13 @@ import { useObserverMethodOnTarget } from './observer.js'
  * @param {Function} [options.callback] - Optional callback function that will be called when resize changes are detected.
  *                                          If not provided, a 'resize-obs' event will be dispatched on the target.
  * @param {Object} [options.observerOptions] - Additional options to pass to ResizeObserver.observe()
- * 
+ *
  * @returns {Object} An object with methods to control the observer:
  *   - observe(target, options): Start observing a new target element
  *   - unobserve(target): Stop observing a target element
  *   - disconnect(): Disconnect the observer and stop all observations
  *   - destroy(): Alias for disconnect()
- * 
+ *
  * @example
  * // Basic usage with callback
  * resizeObserver(element, {
@@ -27,7 +27,7 @@ import { useObserverMethodOnTarget } from './observer.js'
  *     console.log('Element resized:', entry.contentRect);
  *   }
  * });
- * 
+ *
  * @example
  * // Usage with event listener
  * resizeObserver(element);

package/src/dom/observers/scroll-observer.js

@@ -0,0 +1,132 @@
+/* eslint-env browser */
+import { resizeObserver } from './resize-observer.js'
+
+const defaultOptions = {
+  threshold: 0, // Float between 0 to 1.
+  tolerance: 0.1, // Float between 0 to 1. Tolerance for event firing
+  throttle: 16, // Throttle interval in ms (default: ~60fps)
+  once: false, // Only fire threshold callback once
+}
+
+// TODO: Move to Utils/Dom
+/**
+ * Scroll Observer - Optimized for performance
+ * @param {Element} node - The element to observe scroll events on
+ * @param {Object} options - Configuration options
+ * @param {Number} options.threshold - Float between 0 to 1. When to trigger callback (0.75 = 75% down page)
+ * @param {Number} options.tolerance - Float between 0 to 1. Tolerance zone around threshold
+ * @param {Number} options.throttle - Throttle interval in ms (default: 16ms for ~60fps)
+ * @param {Boolean} options.once - Only fire threshold callback once (default: false)
+ * @param {Function} options.callback - Called on every scroll with scrollPercent
+ * @param {Function} options.onScrollDown - Called when scrolling down
+ * @param {Function} options.onScrollUp - Called when scrolling up
+ * @param {Function} options.onEnterThreshold - Called when entering threshold zone
+ */
+export function scrollObserver(node, options = {}) {
+  const { callback, onScrollDown, onScrollUp, onEnterThreshold, ...userOpts } =
+    options
+  const opts = { ...defaultOptions, ...userOpts }
+  const { threshold, tolerance, throttle, once } = opts
+
+  const prevScrollDirection = null
+  let prevScrollTop = 0
+  let prevScrollPercent = 0
+  let lastThrottleTime = 0
+  let thresholdFired = false
+  let rafId = null
+
+  // Determine scroll context once at initialization
+  const isDocumentScroll = node === document || node === window
+  const scrollElement = isDocumentScroll ? document.documentElement : node
+
+  // Cache DOM references and expensive calculations
+  let cachedScrollHeight = 0
+  let cachedClientHeight = 0
+
+  // Initialize cache and start observing for changes
+  updateCache()
+  const cacheObserver = resizeObserver(scrollElement, {
+    callback: updateCache,
+  })
+
+  node.addEventListener('scroll', throttledObserve, { passive: true })
+
+  function updateCache() {
+    cachedScrollHeight = scrollElement.scrollHeight
+    cachedClientHeight = scrollElement.clientHeight
+  }
+
+  function throttledObserve() {
+    const now = Date.now()
+    if (now - lastThrottleTime < throttle) return
+
+    lastThrottleTime = now
+    rafId = requestAnimationFrame(observe)
+  }
+
+  function observe() {
+    const scrollTop = scrollElement.scrollTop
+
+    // Skip if scroll position hasn't changed meaningfully
+    if (Math.abs(scrollTop - prevScrollTop) < 1) return
+
+    const scrollDirection = scrollTop > prevScrollTop ? 'down' : 'up'
+    const maxScroll = Math.max(1, cachedScrollHeight - cachedClientHeight)
+    const scrollPercent = Math.min(1, Math.max(0, scrollTop / maxScroll))
+
+    // Check threshold crossing (e.g., 75% ± tolerance)
+    const thresholdMin = threshold - tolerance / 2
+    const thresholdMax = threshold + tolerance / 2
+    const wasInThreshold =
+      prevScrollPercent >= thresholdMin && prevScrollPercent <= thresholdMax
+    const isInThreshold =
+      scrollPercent >= thresholdMin && scrollPercent <= thresholdMax
+    const hasEnteredThreshold =
+      !wasInThreshold && isInThreshold && (!once || !thresholdFired)
+
+    if (hasEnteredThreshold && once) {
+      thresholdFired = true
+    }
+
+    // Prepare common data for all callbacks
+    const callbackData = {
+      scrollTop,
+      scrollDirection,
+      scrollPercent,
+      directionChanged: scrollDirection !== prevScrollDirection,
+      hasEnteredThreshold,
+      isInThreshold,
+    }
+
+    // Call specific callbacks
+    if (typeof callback === 'function') {
+      callback(callbackData)
+    }
+
+    // Only fire direction callbacks when direction actually changes
+    if (scrollDirection !== prevScrollDirection) {
+      if (scrollDirection === 'down' && typeof onScrollDown === 'function') {
+        onScrollDown(callbackData)
+      }
+      if (scrollDirection === 'up' && typeof onScrollUp === 'function') {
+        onScrollUp(callbackData)
+      }
+    }
+
+    // Fire threshold callback when entering threshold zone
+    if (hasEnteredThreshold && typeof onEnterThreshold === 'function') {
+      onEnterThreshold(callbackData)
+    }
+
+    prevScrollTop = scrollTop
+    prevScrollPercent = scrollPercent
+  }
+
+  return {
+    destroy() {
+      node.removeEventListener('scroll', throttledObserve)
+      if (rafId) cancelAnimationFrame(rafId)
+      cacheObserver.destroy()
+    },
+  }
+}

package/src/lib/functions/callback.js

@@ -0,0 +1,8 @@
+/**
+ * Safely executes a callback function if it's a function
+ * @param {Function|*} fn - The potential callback function
+ * @param {...*} data - Data arguments to pass to the callback
+ */
+export function runCallback(fn, ...data) {
+  if (typeof fn === 'function') fn(data)
+}