@w3ux/hooks 2.2.2 → 2.3.0

package/mjs/useOutsideAlerter.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/useOutsideAlerter.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAkB,MAAM,OAAO,CAAA;AAGjD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAkC,EAClC,QAAoB,EACpB,SAAmB,EAAE,EACrB,EAAE;IACF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,kBAAkB,GAAG,CAAC,EAAc,EAAE,EAAE;YAC5C,IAAI,EAAE,EAAE,CAAC;gBACP,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAc,CAAC,EAAE,CAAC;oBAC5D,MAAM,MAAM,GAAG,EAAE,CAAC,MAAqB,CAAA;oBAGvC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;oBAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,WAAW,EAAE,KAAK,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAClE,CAAA;oBAED,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,QAAQ,EAAE,CAAA;oBACZ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAA;QACD,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;QAC1D,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,mBAAmB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;QAC/D,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;AACX,CAAC,CAAA","file":"useOutsideAlerter.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nimport { useEffect, type RefObject } from 'react'\n\n// A hook that alerts clicks outside of the passed ref.\nexport const useOutsideAlerter = (\n  ref: RefObject<HTMLElement | null>,\n  callback: () => void,\n  ignore: string[] = []\n) => {\n  useEffect(() => {\n    const handleClickOutside = (ev: MouseEvent) => {\n      if (ev) {\n        if (ref.current && !ref.current.contains(ev.target as Node)) {\n          const target = ev.target as HTMLElement\n          // Ignore tags with a name of `ignore`, or if there is a class of `ignore` in the parent\n          // tree.\n          const tagName = target.tagName.toLowerCase()\n          const ignored = ignore.some(\n            (i) =>\n              i.toLowerCase() === tagName || target.closest(`.${i}`) !== null\n          )\n\n          if (!ignored) {\n            callback()\n          }\n        }\n      }\n    }\n    document.addEventListener('mousedown', handleClickOutside)\n    return () => {\n      document.removeEventListener('mousedown', handleClickOutside)\n    }\n  }, [ref])\n}\n"]}

package/mjs/useSafeContext.d.ts

@@ -1,3 +0,0 @@
-import type { Context } from 'react';
-export declare const useSafeContext: <T>(ctx: T | null | undefined) => T;
-export declare const createSafeContext: <T>() => [Context<T | null>, () => T];

package/mjs/useSafeContext.js

@@ -1,16 +0,0 @@
-import { createContext, useContext } from 'react';
-export const useSafeContext = (ctx) => {
-    if (ctx === null || ctx === undefined) {
-        throw new Error('Context value is null or undefined. Please ensure the context Provider is used correctly.');
-    }
-    return ctx;
-};
-export const createSafeContext = () => {
-    const Context = createContext(null);
-    const useHook = () => useSafeContext(useContext(Context));
-    return [Context, useHook];
-};
-
-//# sourceMappingURL=useSafeContext.js.map
-
-//# sourceMappingURL=useSafeContext.js.map

package/mjs/useSafeContext.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/useSafeContext.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAEjD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAK,GAAyB,EAAK,EAAE;IACjE,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAqC,EAAE;IACtE,MAAM,OAAO,GAAG,aAAa,CAAW,IAAI,CAAC,CAAA;IAC7C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,cAAc,CAAI,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAC3B,CAAC,CAAA","file":"useSafeContext.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nimport type { Context } from 'react'\nimport { createContext, useContext } from 'react'\n\nexport const useSafeContext = <T,>(ctx: T | null | undefined): T => {\n  if (ctx === null || ctx === undefined) {\n    throw new Error(\n      'Context value is null or undefined. Please ensure the context Provider is used correctly.'\n    )\n  }\n  return ctx\n}\n\nexport const createSafeContext = <T,>(): [Context<T | null>, () => T] => {\n  const Context = createContext<T | null>(null)\n  const useHook = () => useSafeContext<T>(useContext(Context))\n  return [Context, useHook]\n}\n"]}

package/mjs/useSize.d.ts

@@ -1,10 +0,0 @@
-import type { RefObject } from 'react';
-interface UseSizeOptions {
-    outerElement?: RefObject<HTMLElement | null>;
-    throttle?: number;
-}
-export declare const useSize: (element: RefObject<HTMLElement | null>, options?: UseSizeOptions) => {
-    width: number;
-    height: number;
-};
-export {};

package/mjs/useSize.js

@@ -1,31 +0,0 @@
-import { useEffect, useRef, useState } from 'react';
-export const useSize = (element, options = {}) => {
-    const { outerElement, throttle: throttleDuration = 100 } = options;
-    const getSize = (el = null) => {
-        const width = el?.offsetWidth || 0;
-        const height = el?.offsetHeight || 0;
-        return { width, height };
-    };
-    const lastExecutedRef = useRef(0);
-    const [size, setSize] = useState(getSize(element?.current));
-    const handleResize = () => {
-        const now = Date.now();
-        if (now - lastExecutedRef.current < throttleDuration) {
-            return;
-        }
-        lastExecutedRef.current = now;
-        setSize(getSize(element?.current));
-    };
-    useEffect(() => {
-        const listenFor = outerElement?.current || window;
-        listenFor.addEventListener('resize', handleResize);
-        return () => {
-            listenFor.removeEventListener('resize', handleResize);
-        };
-    }, [outerElement?.current]);
-    return size;
-};
-
-//# sourceMappingURL=useSize.js.map
-
-//# sourceMappingURL=useSize.js.map

package/mjs/useSize.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/useSize.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAUnD,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,OAAsC,EACtC,UAA0B,EAAE,EAC5B,EAAE;IACF,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,GAAG,EAAE,GAAG,OAAO,CAAA;IAIlE,MAAM,OAAO,GAAG,CAAC,KAAyB,IAAI,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,EAAE,EAAE,WAAW,IAAI,CAAC,CAAA;QAClC,MAAM,MAAM,GAAG,EAAE,EAAE,YAAY,IAAI,CAAC,CAAA;QACpC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAA;IAC1B,CAAC,CAAA;IAGD,MAAM,eAAe,GAAG,MAAM,CAAS,CAAC,CAAC,CAAA;IAGzC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAC9B,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAC1B,CAAA;IAGD,MAAM,YAAY,GAAG,GAAG,EAAE;QACxB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,GAAG,GAAG,eAAe,CAAC,OAAO,GAAG,gBAAgB,EAAE,CAAC;YACrD,OAAM;QACR,CAAC;QAED,eAAe,CAAC,OAAO,GAAG,GAAG,CAAA;QAE7B,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;IACpC,CAAC,CAAA;IAGD,SAAS,CAAC,GAAG,EAAE;QAGb,MAAM,SAAS,GAAG,YAAY,EAAE,OAAO,IAAI,MAAM,CAAA;QAEjD,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;QAGlD,OAAO,GAAG,EAAE;YACV,SAAS,CAAC,mBAAmB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;QACvD,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAA;IAG3B,OAAO,IAAI,CAAA;AACb,CAAC,CAAA","file":"useSize.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nimport type { RefObject } from 'react'\nimport { useEffect, useRef, useState } from 'react'\n\n// Define the type for the options parameter.\ninterface UseSizeOptions {\n  outerElement?: RefObject<HTMLElement | null>\n  throttle?: number\n}\n\n// Custom hook to get the width and height of a specified element. Updates the `size` state when the\n// specified \"outer element\" (or the window by default) resizes.\nexport const useSize = (\n  element: RefObject<HTMLElement | null>,\n  options: UseSizeOptions = {}\n) => {\n  const { outerElement, throttle: throttleDuration = 100 } = options\n\n  // Helper function to retrieve the width and height of an element\n  // If no element is found, default dimensions are set to 0.\n  const getSize = (el: HTMLElement | null = null) => {\n    const width = el?.offsetWidth || 0\n    const height = el?.offsetHeight || 0\n    return { width, height }\n  }\n\n  // Ref to store the last execution time of the `resizeThrottle` handler.\n  const lastExecutedRef = useRef<number>(0)\n\n  // State to store the current width and height of the specified element.\n  const [size, setSize] = useState<{ width: number; height: number }>(\n    getSize(element?.current)\n  )\n\n  // Throttle the resize event handler to limit how often size updates occur.\n  const handleResize = () => {\n    const now = Date.now()\n    if (now - lastExecutedRef.current < throttleDuration) {\n      return\n    } // Exit if `throttleDuration` has not passed.\n\n    lastExecutedRef.current = now // Update last execution time.\n\n    setSize(getSize(element?.current))\n  }\n\n  // Set up the resize event listener on mount and clean it up on unmount.\n  useEffect(() => {\n    // Determine the target for the resize event listener.\n    // If `outerElement` is provided, listen to its resize events; otherwise, listen to the window's.\n    const listenFor = outerElement?.current || window\n\n    listenFor.addEventListener('resize', handleResize)\n\n    // Clean up event listener when the component unmounts to avoid memory leaks.\n    return () => {\n      listenFor.removeEventListener('resize', handleResize)\n    }\n  }, [outerElement?.current])\n\n  // Return the current size of the element.\n  return size\n}\n"]}

package/mjs/useTimeLeft/defaults.d.ts

@@ -1,3 +0,0 @@
-import type { TimeleftDuration } from '@w3ux/types';
-export declare const defaultDuration: TimeleftDuration;
-export declare const defaultRefreshInterval = 60;

package/mjs/useTimeLeft/defaults.js

@@ -1,12 +0,0 @@
-export const defaultDuration = {
-    days: 0,
-    hours: 0,
-    minutes: 0,
-    seconds: 0,
-    lastMinute: false,
-};
-export const defaultRefreshInterval = 60;
-
-//# sourceMappingURL=defaults.js.map
-
-//# sourceMappingURL=defaults.js.map

package/mjs/useTimeLeft/defaults.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/useTimeLeft/defaults.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,eAAe,GAAqB;IAC/C,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,KAAK;CAClB,CAAA;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAA","file":"defaults.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nimport type { TimeleftDuration } from '@w3ux/types'\n\nexport const defaultDuration: TimeleftDuration = {\n  days: 0,\n  hours: 0,\n  minutes: 0,\n  seconds: 0,\n  lastMinute: false,\n}\n\nexport const defaultRefreshInterval = 60\n"]}

package/mjs/useTimeLeft/index.d.ts

@@ -1,5 +0,0 @@
-import type { TimeLeftAll, UseTimeleftProps } from '@w3ux/types';
-export declare const useTimeLeft: (props?: UseTimeleftProps) => {
-    setFromNow: (dateFrom: Date, dateTo: Date) => void;
-    timeleft: TimeLeftAll;
-};

package/mjs/useTimeLeft/index.js

@@ -1,83 +0,0 @@
-import { setStateWithRef } from '@w3ux/utils';
-import { useEffect, useRef, useState } from 'react';
-import { getDuration } from '../util';
-export const useTimeLeft = (props) => {
-    const depsTimeleft = props?.depsTimeleft || [];
-    const depsFormat = props?.depsFormat || [];
-    const inLastHour = () => {
-        const { days, hours } = getDuration(toRef.current);
-        return !days && !hours;
-    };
-    const lastMinuteCountdown = () => {
-        const { seconds } = getDuration(toRef.current);
-        if (!inLastHour()) {
-            return 60;
-        }
-        return seconds;
-    };
-    const getTimeleft = (c) => {
-        const { days, hours, minutes, seconds } = c || getDuration(toRef.current);
-        const raw = {
-            days,
-            hours,
-            minutes,
-        };
-        if (!days && !hours) {
-            raw.seconds = seconds;
-        }
-        return {
-            raw,
-        };
-    };
-    const [to, setTo] = useState(null);
-    const toRef = useRef(to);
-    const [timeleft, setTimeleft] = useState(getTimeleft());
-    const [minInterval, setMinInterval] = useState(undefined);
-    const minIntervalRef = useRef(minInterval);
-    const [secInterval, setSecInterval] = useState(undefined);
-    const secIntervalRef = useRef(secInterval);
-    useEffect(() => {
-        setTimeleft(getTimeleft());
-        if (inLastHour()) {
-            if (!secIntervalRef.current) {
-                const interval = setInterval(() => {
-                    if (!inLastHour()) {
-                        clearInterval(secIntervalRef.current);
-                        setStateWithRef(undefined, setSecInterval, secIntervalRef);
-                    }
-                    setTimeleft(getTimeleft());
-                }, 1000);
-                setStateWithRef(interval, setSecInterval, secIntervalRef);
-            }
-        }
-        else if (!minIntervalRef.current) {
-            const interval = setInterval(() => {
-                if (inLastHour()) {
-                    clearInterval(minIntervalRef.current);
-                    setStateWithRef(undefined, setMinInterval, minIntervalRef);
-                }
-                setTimeleft(getTimeleft());
-            }, 60000);
-            setStateWithRef(interval, setMinInterval, minIntervalRef);
-        }
-    }, [to, inLastHour(), lastMinuteCountdown(), ...depsTimeleft]);
-    useEffect(() => {
-        setTimeleft(getTimeleft());
-    }, [...depsFormat]);
-    useEffect(() => () => {
-        clearInterval(minInterval);
-        clearInterval(secInterval);
-    }, []);
-    const setFromNow = (dateFrom, dateTo) => {
-        setTimeleft(getTimeleft(getDuration(dateFrom)));
-        setStateWithRef(dateTo, setTo, toRef);
-    };
-    return {
-        setFromNow,
-        timeleft,
-    };
-};
-
-//# sourceMappingURL=index.js.map
-
-//# sourceMappingURL=index.js.map

package/mjs/useTimeLeft/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/useTimeLeft/index.tsx"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAwB,EAAE,EAAE;IACtD,MAAM,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,EAAE,CAAA;IAC9C,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,EAAE,CAAA;IAG1C,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAClD,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,CAAA;IACxB,CAAC,CAAA;IAGD,MAAM,mBAAmB,GAAG,GAAG,EAAE;QAC/B,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC9C,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YAClB,OAAO,EAAE,CAAA;QACX,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;IAGD,MAAM,WAAW,GAAG,CAAC,CAAoB,EAAe,EAAE;QACxD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACzE,MAAM,GAAG,GAAgB;YACvB,IAAI;YACJ,KAAK;YACL,OAAO;SACR,CAAA;QACD,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACpB,GAAG,CAAC,OAAO,GAAG,OAAO,CAAA;QACvB,CAAC;QACD,OAAO;YACL,GAAG;SACJ,CAAA;IACH,CAAC,CAAA;IAGD,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,QAAQ,CAAc,IAAI,CAAC,CAAA;IAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,CAAA;IAGxB,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAc,WAAW,EAAE,CAAC,CAAA;IAGpE,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAE5C,SAAS,CAAC,CAAA;IACZ,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;IAE1C,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAE5C,SAAS,CAAC,CAAA;IACZ,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;IAG1C,SAAS,CAAC,GAAG,EAAE;QACb,WAAW,CAAC,WAAW,EAAE,CAAC,CAAA;QAC1B,IAAI,UAAU,EAAE,EAAE,CAAC;YAEjB,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC5B,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;oBAChC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;wBAClB,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;wBACrC,eAAe,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC,CAAA;oBAC5D,CAAC;oBACD,WAAW,CAAC,WAAW,EAAE,CAAC,CAAA;gBAC5B,CAAC,EAAE,IAAI,CAAC,CAAA;gBAER,eAAe,CAAC,QAAQ,EAAE,cAAc,EAAE,cAAc,CAAC,CAAA;YAC3D,CAAC;QACH,CAAC;aAEI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;gBAChC,IAAI,UAAU,EAAE,EAAE,CAAC;oBACjB,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;oBACrC,eAAe,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC,CAAA;gBAC5D,CAAC;gBACD,WAAW,CAAC,WAAW,EAAE,CAAC,CAAA;YAC5B,CAAC,EAAE,KAAK,CAAC,CAAA;YACT,eAAe,CAAC,QAAQ,EAAE,cAAc,EAAE,cAAc,CAAC,CAAA;QAC3D,CAAC;IACH,CAAC,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,mBAAmB,EAAE,EAAE,GAAG,YAAY,CAAC,CAAC,CAAA;IAG9D,SAAS,CAAC,GAAG,EAAE;QACb,WAAW,CAAC,WAAW,EAAE,CAAC,CAAA;IAC5B,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAA;IAGnB,SAAS,CACP,GAAG,EAAE,CAAC,GAAG,EAAE;QACT,aAAa,CAAC,WAAW,CAAC,CAAA;QAC1B,aAAa,CAAC,WAAW,CAAC,CAAA;IAC5B,CAAC,EACD,EAAE,CACH,CAAA;IAGD,MAAM,UAAU,GAAG,CAAC,QAAc,EAAE,MAAY,EAAE,EAAE;QAClD,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC/C,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC,CAAA;IAED,OAAO;QACL,UAAU;QACV,QAAQ;KACT,CAAA;AACH,CAAC,CAAA","file":"index.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nimport type {\n  TimeLeftAll,\n  TimeLeftRaw,\n  TimeleftDuration,\n  UseTimeleftProps,\n} from '@w3ux/types'\nimport { setStateWithRef } from '@w3ux/utils'\nimport { useEffect, useRef, useState } from 'react'\nimport { getDuration } from '../util'\n\nexport const useTimeLeft = (props?: UseTimeleftProps) => {\n  const depsTimeleft = props?.depsTimeleft || []\n  const depsFormat = props?.depsFormat || []\n\n  // check whether timeleft is within a minute of finishing.\n  const inLastHour = () => {\n    const { days, hours } = getDuration(toRef.current)\n    return !days && !hours\n  }\n\n  // get the amount of seconds left if timeleft is in the last minute.\n  const lastMinuteCountdown = () => {\n    const { seconds } = getDuration(toRef.current)\n    if (!inLastHour()) {\n      return 60\n    }\n    return seconds\n  }\n\n  // calculate resulting timeleft object from latest duration.\n  const getTimeleft = (c?: TimeleftDuration): TimeLeftAll => {\n    const { days, hours, minutes, seconds } = c || getDuration(toRef.current)\n    const raw: TimeLeftRaw = {\n      days,\n      hours,\n      minutes,\n    }\n    if (!days && !hours) {\n      raw.seconds = seconds\n    }\n    return {\n      raw,\n    }\n  }\n\n  // the end time as a date.\n  const [to, setTo] = useState<Date | null>(null)\n  const toRef = useRef(to)\n\n  // resulting timeleft object to be returned.\n  const [timeleft, setTimeleft] = useState<TimeLeftAll>(getTimeleft())\n\n  // timeleft refresh intervals.\n  const [minInterval, setMinInterval] = useState<\n    ReturnType<typeof setInterval> | undefined\n  >(undefined)\n  const minIntervalRef = useRef(minInterval)\n\n  const [secInterval, setSecInterval] = useState<\n    ReturnType<typeof setInterval> | undefined\n  >(undefined)\n  const secIntervalRef = useRef(secInterval)\n\n  // refresh effects.\n  useEffect(() => {\n    setTimeleft(getTimeleft())\n    if (inLastHour()) {\n      // refresh timeleft every second.\n      if (!secIntervalRef.current) {\n        const interval = setInterval(() => {\n          if (!inLastHour()) {\n            clearInterval(secIntervalRef.current)\n            setStateWithRef(undefined, setSecInterval, secIntervalRef)\n          }\n          setTimeleft(getTimeleft())\n        }, 1000)\n\n        setStateWithRef(interval, setSecInterval, secIntervalRef)\n      }\n    }\n    // refresh timeleft every minute.\n    else if (!minIntervalRef.current) {\n      const interval = setInterval(() => {\n        if (inLastHour()) {\n          clearInterval(minIntervalRef.current)\n          setStateWithRef(undefined, setMinInterval, minIntervalRef)\n        }\n        setTimeleft(getTimeleft())\n      }, 60000)\n      setStateWithRef(interval, setMinInterval, minIntervalRef)\n    }\n  }, [to, inLastHour(), lastMinuteCountdown(), ...depsTimeleft])\n\n  // re-render the timeleft upon formatting changes.\n  useEffect(() => {\n    setTimeleft(getTimeleft())\n  }, [...depsFormat])\n\n  // clear intervals on unmount\n  useEffect(\n    () => () => {\n      clearInterval(minInterval)\n      clearInterval(secInterval)\n    },\n    []\n  )\n\n  // Set the end time and calculate timeleft.\n  const setFromNow = (dateFrom: Date, dateTo: Date) => {\n    setTimeleft(getTimeleft(getDuration(dateFrom)))\n    setStateWithRef(dateTo, setTo, toRef)\n  }\n\n  return {\n    setFromNow,\n    timeleft,\n  }\n}\n"]}

package/mjs/util.d.ts

@@ -1,4 +0,0 @@
-import type { TimeleftDuration } from '@w3ux/types';
-export declare const getDuration: (toDate: Date | null) => TimeleftDuration;
-export declare const secondsFromNow: (seconds: number) => Date;
-export declare const getDurationFromNow: (toDate: Date | null) => TimeleftDuration;

package/mjs/util.js

@@ -1,63 +0,0 @@
-import { differenceInDays, getUnixTime, intervalToDuration } from 'date-fns';
-import { defaultDuration } from './useTimeLeft/defaults.js';
-export const getDuration = (toDate) => {
-    if (!toDate) {
-        return defaultDuration;
-    }
-    if (getUnixTime(toDate) <= getUnixTime(new Date())) {
-        return defaultDuration;
-    }
-    toDate.setSeconds(toDate.getSeconds());
-    const d = intervalToDuration({
-        start: Date.now(),
-        end: toDate,
-    });
-    const days = differenceInDays(toDate, Date.now());
-    const hours = d?.hours || 0;
-    const minutes = d?.minutes || 0;
-    const seconds = d?.seconds || 0;
-    const lastHour = days === 0 && hours === 0;
-    const lastMinute = lastHour && minutes === 0;
-    return {
-        days,
-        hours,
-        minutes,
-        seconds,
-        lastMinute,
-    };
-};
-export const secondsFromNow = (seconds) => {
-    const end = new Date();
-    end.setSeconds(end.getSeconds() + seconds);
-    return end;
-};
-export const getDurationFromNow = (toDate) => {
-    if (!toDate) {
-        return defaultDuration;
-    }
-    if (getUnixTime(toDate) <= getUnixTime(new Date())) {
-        return defaultDuration;
-    }
-    toDate.setSeconds(toDate.getSeconds());
-    const d = intervalToDuration({
-        start: Date.now(),
-        end: toDate,
-    });
-    const days = differenceInDays(toDate, Date.now());
-    const hours = d?.hours || 0;
-    const minutes = d?.minutes || 0;
-    const seconds = d?.seconds || 0;
-    const lastHour = days === 0 && hours === 0;
-    const lastMinute = lastHour && minutes === 0;
-    return {
-        days,
-        hours,
-        minutes,
-        seconds,
-        lastMinute,
-    };
-};
-
-//# sourceMappingURL=util.js.map
-
-//# sourceMappingURL=util.js.map

package/mjs/util.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/util.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAG3D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAmB,EAAoB,EAAE;IACnE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,eAAe,CAAA;IACxB,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;QACnD,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,GAAG,kBAAkB,CAAC;QAC3B,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE;QACjB,GAAG,EAAE,MAAM;KACZ,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;IACjD,MAAM,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAA;IAC3B,MAAM,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,CAAC,CAAA;IAC/B,MAAM,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,CAAC,CAAA;IAC/B,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;IAC1C,MAAM,UAAU,GAAG,QAAQ,IAAI,OAAO,KAAK,CAAC,CAAA;IAE5C,OAAO;QACL,IAAI;QACJ,KAAK;QACL,OAAO;QACP,OAAO;QACP,UAAU;KACX,CAAA;AACH,CAAC,CAAA;AAGD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAe,EAAQ,EAAE;IACtD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;IACtB,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,CAAA;IAC1C,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAGD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAmB,EAAoB,EAAE;IAC1E,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,eAAe,CAAA;IACxB,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;QACnD,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAA;IACtC,MAAM,CAAC,GAAG,kBAAkB,CAAC;QAC3B,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE;QACjB,GAAG,EAAE,MAAM;KACZ,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;IACjD,MAAM,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAA;IAC3B,MAAM,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,CAAC,CAAA;IAC/B,MAAM,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,CAAC,CAAA;IAC/B,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;IAC1C,MAAM,UAAU,GAAG,QAAQ,IAAI,OAAO,KAAK,CAAC,CAAA;IAE5C,OAAO;QACL,IAAI;QACJ,KAAK;QACL,OAAO;QACP,OAAO;QACP,UAAU;KACX,CAAA;AACH,CAAC,CAAA","file":"util.js","sourcesContent":["/* @license Copyright 2024 w3ux authors & contributors\nSPDX-License-Identifier: GPL-3.0-only */\n\nimport type { TimeleftDuration } from '@w3ux/types'\nimport { differenceInDays, getUnixTime, intervalToDuration } from 'date-fns'\nimport { defaultDuration } from './useTimeLeft/defaults.js'\n\n// calculates the current timeleft duration.\nexport const getDuration = (toDate: Date | null): TimeleftDuration => {\n  if (!toDate) {\n    return defaultDuration\n  }\n  if (getUnixTime(toDate) <= getUnixTime(new Date())) {\n    return defaultDuration\n  }\n\n  toDate.setSeconds(toDate.getSeconds())\n  const d = intervalToDuration({\n    start: Date.now(),\n    end: toDate,\n  })\n\n  const days = differenceInDays(toDate, Date.now())\n  const hours = d?.hours || 0\n  const minutes = d?.minutes || 0\n  const seconds = d?.seconds || 0\n  const lastHour = days === 0 && hours === 0\n  const lastMinute = lastHour && minutes === 0\n\n  return {\n    days,\n    hours,\n    minutes,\n    seconds,\n    lastMinute,\n  }\n}\n\n// Helper: Adds `seconds` to the current time and returns the resulting date.\nexport const secondsFromNow = (seconds: number): Date => {\n  const end = new Date()\n  end.setSeconds(end.getSeconds() + seconds)\n  return end\n}\n\n// Helper: Calculates the duration between the current time and the provided date.\nexport const getDurationFromNow = (toDate: Date | null): TimeleftDuration => {\n  if (!toDate) {\n    return defaultDuration\n  }\n  if (getUnixTime(toDate) <= getUnixTime(new Date())) {\n    return defaultDuration\n  }\n\n  toDate.setSeconds(toDate.getSeconds())\n  const d = intervalToDuration({\n    start: Date.now(),\n    end: toDate,\n  })\n\n  const days = differenceInDays(toDate, Date.now())\n  const hours = d?.hours || 0\n  const minutes = d?.minutes || 0\n  const seconds = d?.seconds || 0\n  const lastHour = days === 0 && hours === 0\n  const lastMinute = lastHour && minutes === 0\n\n  return {\n    days,\n    hours,\n    minutes,\n    seconds,\n    lastMinute,\n  }\n}\n"]}