@splendidlabz/utils 1.8.1 → 1.8.2

package/dist/esm/dom/observers/index.js

@@ -121,8 +121,97 @@ function resizeObserver(target, options) {
     destroy: (_) => observer.disconnect()
   };
 }
+
+// src/dom/observers/scroll-observer.js
+var defaultOptions2 = {
+  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
+};
+function scrollObserver(node, options = {}) {
+  const { callback, onScrollDown, onScrollUp, onEnterThreshold, ...userOpts } = options;
+  const opts = { ...defaultOptions2, ...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;
+  const isDocumentScroll = node === document || node === window;
+  const scrollElement = isDocumentScroll ? document.documentElement : node;
+  let cachedScrollHeight = 0;
+  let cachedClientHeight = 0;
+  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;
+    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));
+    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;
+    }
+    const callbackData = {
+      scrollTop,
+      scrollDirection,
+      scrollPercent,
+      directionChanged: scrollDirection !== prevScrollDirection,
+      hasEnteredThreshold,
+      isInThreshold
+    };
+    if (typeof callback === "function") {
+      callback(callbackData);
+    }
+    if (scrollDirection !== prevScrollDirection) {
+      if (scrollDirection === "down" && typeof onScrollDown === "function") {
+        onScrollDown(callbackData);
+      }
+      if (scrollDirection === "up" && typeof onScrollUp === "function") {
+        onScrollUp(callbackData);
+      }
+    }
+    if (hasEnteredThreshold && typeof onEnterThreshold === "function") {
+      onEnterThreshold(callbackData);
+    }
+    prevScrollTop = scrollTop;
+    prevScrollPercent = scrollPercent;
+  }
+  return {
+    destroy() {
+      node.removeEventListener("scroll", throttledObserve);
+      if (rafId) cancelAnimationFrame(rafId);
+      cacheObserver.destroy();
+    }
+  };
+}
 export {
   intersectionObserver,
   mutationObserver,
-  resizeObserver
+  resizeObserver,
+  scrollObserver
 };

package/dist/esm/dom/observers/scroll-observer.js

@@ -0,0 +1,144 @@
+// src/dom/events.js
+function dispatchEvent(node, eventName, detail, options = {}) {
+  node.dispatchEvent(
+    new CustomEvent(eventName, {
+      ...options,
+      detail
+    })
+  );
+}
+
+// src/dom/get-element.js
+function getNodeType(node) {
+  if (node instanceof Element) return "element";
+  if (node instanceof NodeList) return "nodelist";
+  if (Array.isArray(node)) return "array";
+}
+
+// src/dom/observers/observer.js
+function useObserverMethodOnTarget(target, observer, method = "observe", options = void 0) {
+  const targetType = getNodeType(target);
+  if (targetType === "element") observer[method](target, options);
+  if (targetType === "nodelist") {
+    const elements = Array.from(target);
+    elements.forEach((element) => observer[method](element, options));
+  }
+  if (targetType === "array") {
+    target.forEach((element) => observer[method](element, options));
+  }
+}
+
+// src/dom/observers/resize-observer.js
+function resizeObserver(target, options) {
+  const { callback, ...opts } = options;
+  const observer = new ResizeObserver(observerFn);
+  if (target === window) target = document.body;
+  useObserverMethodOnTarget(target, observer, "observe", opts);
+  function observerFn(entries) {
+    for (const entry of entries) {
+      if (callback) callback({ entry, entries, observer });
+      else dispatchEvent(target, "resize-obs", { entry, entries, observer });
+    }
+  }
+  return {
+    observe(target2) {
+      useObserverMethodOnTarget(target2, observer, "observe", options);
+    },
+    unobserve(target2) {
+      useObserverMethodOnTarget(target2, observer, "unobserve");
+    },
+    disconnect: (_) => observer.disconnect(),
+    destroy: (_) => observer.disconnect()
+  };
+}
+
+// src/dom/observers/scroll-observer.js
+var 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
+};
+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;
+  const isDocumentScroll = node === document || node === window;
+  const scrollElement = isDocumentScroll ? document.documentElement : node;
+  let cachedScrollHeight = 0;
+  let cachedClientHeight = 0;
+  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;
+    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));
+    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;
+    }
+    const callbackData = {
+      scrollTop,
+      scrollDirection,
+      scrollPercent,
+      directionChanged: scrollDirection !== prevScrollDirection,
+      hasEnteredThreshold,
+      isInThreshold
+    };
+    if (typeof callback === "function") {
+      callback(callbackData);
+    }
+    if (scrollDirection !== prevScrollDirection) {
+      if (scrollDirection === "down" && typeof onScrollDown === "function") {
+        onScrollDown(callbackData);
+      }
+      if (scrollDirection === "up" && typeof onScrollUp === "function") {
+        onScrollUp(callbackData);
+      }
+    }
+    if (hasEnteredThreshold && typeof onEnterThreshold === "function") {
+      onEnterThreshold(callbackData);
+    }
+    prevScrollTop = scrollTop;
+    prevScrollPercent = scrollPercent;
+  }
+  return {
+    destroy() {
+      node.removeEventListener("scroll", throttledObserve);
+      if (rafId) cancelAnimationFrame(rafId);
+      cacheObserver.destroy();
+    }
+  };
+}
+export {
+  scrollObserver
+};

package/dist/esm/lib/functions/functional.js

@@ -15,11 +15,27 @@ function compose(...fns) {
     return fns.reduceRight((acc, fn) => fn(acc), value);
   };
 }
+function composeAsync(...fns) {
+  return async function(value) {
+    return fns.reduceRight(async (acc, fn) => {
+      const result = await acc;
+      return await fn(result);
+    }, value);
+  };
+}
 function pipe(...fns) {
   return function(value) {
     return fns.reduce((acc, fn) => fn(acc), value);
   };
 }
+function pipeAsync(...fns) {
+  return async function(value) {
+    return fns.reduce(async (acc, fn) => {
+      const result = await acc;
+      return await fn(result);
+    }, value);
+  };
+}
 function times(fn, n) {
   const result = [];
   for (let i = 0; i < n; i++) {
@@ -29,7 +45,9 @@ function times(fn, n) {
 }
 export {
   compose,
+  composeAsync,
   curry,
   pipe,
+  pipeAsync,
   times
 };

package/dist/esm/lib/functions/index.js

@@ -38,11 +38,27 @@ function compose(...fns) {
     return fns.reduceRight((acc, fn) => fn(acc), value);
   };
 }
+function composeAsync(...fns) {
+  return async function(value) {
+    return fns.reduceRight(async (acc, fn) => {
+      const result = await acc;
+      return await fn(result);
+    }, value);
+  };
+}
 function pipe(...fns) {
   return function(value) {
     return fns.reduce((acc, fn) => fn(acc), value);
   };
 }
+function pipeAsync(...fns) {
+  return async function(value) {
+    return fns.reduce(async (acc, fn) => {
+      const result = await acc;
+      return await fn(result);
+    }, value);
+  };
+}
 function times(fn, n) {
   const result = [];
   for (let i = 0; i < n; i++) {
@@ -75,11 +91,13 @@ function wait(ms) {
 }
 export {
   compose,
+  composeAsync,
   curry,
   debounce,
   delay,
   getEnv,
   pipe,
+  pipeAsync,
   throttle,
   timeout,
   times,

package/dist/esm/lib/index.js

@@ -450,11 +450,27 @@ function compose(...fns) {
     return fns.reduceRight((acc, fn) => fn(acc), value);
   };
 }
+function composeAsync(...fns) {
+  return async function(value) {
+    return fns.reduceRight(async (acc, fn) => {
+      const result = await acc;
+      return await fn(result);
+    }, value);
+  };
+}
 function pipe(...fns) {
   return function(value) {
     return fns.reduce((acc, fn) => fn(acc), value);
   };
 }
+function pipeAsync(...fns) {
+  return async function(value) {
+    return fns.reduce(async (acc, fn) => {
+      const result = await acc;
+      return await fn(result);
+    }, value);
+  };
+}
 function times(fn, n) {
   const result = [];
   for (let i = 0; i < n; i++) {
@@ -946,6 +962,7 @@ export {
   RouteManager,
   camelCaseKeys,
   compose,
+  composeAsync,
   concatMix,
   createMix,
   createSSE,
@@ -987,6 +1004,7 @@ export {
   parseJSON,
   parseSSE,
   pipe,
+  pipeAsync,
   plural,
   pluralize,
   reject,

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

@@ -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/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.8.2",
   "description": "",
   "type": "module",
   "sideEffects": false,

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);