@oneplatformdev/hooks 0.0.1-beta.6 → 0.1.1-1

package/README.md

@@ -2,6 +2,6 @@
 
 This library was generated with [Nx](https://nx.dev).
 
-## Running unit tests
+## Building
 
-Run `nx test hooks` to execute the unit tests via [Vitest](https://vitest.dev/).
+Run `nx build hooks` to build the library.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oneplatformdev/hooks",
-  "version": "0.0.1-beta.6",
+  "version": "0.1.1-1",
   "description": "React hook library",
   "author": "One Platform Development Team",
   "keywords": [
@@ -11,42 +11,41 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/oneplatformdev/core.git",
+    "url": "git+https://github.com/oneplatformdev/core-web.git",
     "directory": "packages/hooks"
   },
   "bugs": {
-    "url": "https://github.com/oneplatformdev/core/issues"
+    "url": "https://github.com/oneplatformdev/core-web/issues"
   },
-  "homepage": "private package",
+  "license": "MIT",
   "type": "module",
-  "source": "./index.ts",
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts",
-  "sideEffects": false,
-  "publishConfig": {
-    "directory": "build",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "peerDependency": {
-    "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "@types/react": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "@types/lodash.debounce": "^4.0.9"
-  },
-  "peerDependenciesMeta": {
-    "@types/react": {
-      "optional": true
-    },
-    "@types/react-dom": {
-      "optional": true
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@oneplatformdev/workspace": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     },
-    "@types/lodash.debounce": {
-      "optional": true
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
     }
   },
+  "files": [
+    "dist",
+    "README.md",
+    "!**/*.tsbuildinfo"
+  ],
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
   "dependencies": {
-    "lodash.debounce": "^4.0.8"
+    "tslib": "^2.3.0"
   }
-}
+}

package/index.d.ts

@@ -1,35 +0,0 @@
-export * from './useBoolean';
-export * from './useClickAnyWhere';
-export * from './useCopyToClipboard';
-export * from './useCountdown';
-export * from './useCounter';
-export * from './useDarkMode';
-export * from './useDebounceCallback';
-export * from './useDebounceValue';
-export * from './useDocumentTitle';
-export * from './useEventCallback';
-export * from './useEventListener';
-export * from './useHover';
-export * from './useIntersectionObserver';
-export * from './useInterval';
-export * from './useIsClient';
-export * from './useIsMobile';
-export * from './useIsMounted';
-export * from './useIsomorphicLayoutEffect';
-export * from './useLocalStorage';
-export * from './useLockBody';
-export * from './useMap';
-export * from './useMediaQuery';
-export * from './useOnClickOutside';
-export * from './useReadLocalStorage';
-export * from './useResizeObserver';
-export * from './useScreen';
-export * from './useScript';
-export * from './useScrollLock';
-export * from './useSessionStorage';
-export * from './useStep';
-export * from './useTernaryDarkMode';
-export * from './useTimeout';
-export * from './useToggle';
-export * from './useUnmount';
-export * from './useWindowSize';

package/index.mjs

@@ -1,72 +0,0 @@
-import { useBoolean as r } from "./useBoolean/useBoolean.mjs";
-import { useClickAnyWhere as s } from "./useClickAnyWhere/useClickAnyWhere.mjs";
-import { useCopyToClipboard as p } from "./useCopyToClipboard/useCopyToClipboard.mjs";
-import { useCountdown as f } from "./useCountdown/useCountdown.mjs";
-import { useCounter as n } from "./useCounter/useCounter.mjs";
-import { useDarkMode as l } from "./useDarkMode/useDarkMode.mjs";
-import { useDebounceCallback as i } from "./useDebounceCallback/useDebounceCallback.mjs";
-import { useDebounceValue as C } from "./useDebounceValue/useDebounceValue.mjs";
-import { useDocumentTitle as b } from "./useDocumentTitle/useDocumentTitle.mjs";
-import { useEventCallback as v } from "./useEventCallback/useEventCallback.mjs";
-import { useEventListener as I } from "./useEventListener/useEventListener.mjs";
-import { useHover as M } from "./useHover/useHover.mjs";
-import { useIntersectionObserver as D } from "./useIntersectionObserver/useIntersectionObserver.mjs";
-import { useInterval as O } from "./useInterval/useInterval.mjs";
-import { useIsClient as h } from "./useIsClient/useIsClient.mjs";
-import { useIsMobile as z } from "./useIsMobile/useIsMobile.mjs";
-import { useIsMounted as R } from "./useIsMounted/useIsMounted.mjs";
-import { useIsomorphicLayoutEffect as A } from "./useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs";
-import { useLocalStorage as Q } from "./useLocalStorage/useLocalStorage.mjs";
-import { useLockBody as V } from "./useLockBody/useLockBody.mjs";
-import { useMap as q } from "./useMap/useMap.mjs";
-import { useMediaQuery as G } from "./useMediaQuery/useMediaQuery.mjs";
-import { useOnClickOutside as K } from "./useOnClickOutside/useOnClickOutside.mjs";
-import { useReadLocalStorage as P } from "./useReadLocalStorage/useReadLocalStorage.mjs";
-import { useResizeObserver as Y } from "./useResizeObserver/useResizeObserver.mjs";
-import { useScreen as _ } from "./useScreen/useScreen.mjs";
-import { useScript as ee } from "./useScript/useScript.mjs";
-import { useScrollLock as re } from "./useScrollLock/useScrollLock.mjs";
-import { useSessionStorage as se } from "./useSessionStorage/useSessionStorage.mjs";
-import { useStep as pe } from "./useStep/useStep.mjs";
-import { useTernaryDarkMode as fe } from "./useTernaryDarkMode/useTernaryDarkMode.mjs";
-import { useTimeout as ne } from "./useTimeout/useTimeout.mjs";
-import { useToggle as le } from "./useToggle/useToggle.mjs";
-import { useUnmount as ie } from "./useUnmount/useUnmount.mjs";
-import { useWindowSize as Ce } from "./useWindowSize/useWindowSize.mjs";
-export {
-  r as useBoolean,
-  s as useClickAnyWhere,
-  p as useCopyToClipboard,
-  f as useCountdown,
-  n as useCounter,
-  l as useDarkMode,
-  i as useDebounceCallback,
-  C as useDebounceValue,
-  b as useDocumentTitle,
-  v as useEventCallback,
-  I as useEventListener,
-  M as useHover,
-  D as useIntersectionObserver,
-  O as useInterval,
-  h as useIsClient,
-  z as useIsMobile,
-  R as useIsMounted,
-  A as useIsomorphicLayoutEffect,
-  Q as useLocalStorage,
-  V as useLockBody,
-  q as useMap,
-  G as useMediaQuery,
-  K as useOnClickOutside,
-  P as useReadLocalStorage,
-  Y as useResizeObserver,
-  _ as useScreen,
-  ee as useScript,
-  re as useScrollLock,
-  se as useSessionStorage,
-  pe as useStep,
-  fe as useTernaryDarkMode,
-  ne as useTimeout,
-  le as useToggle,
-  ie as useUnmount,
-  Ce as useWindowSize
-};

package/useBoolean/index.d.ts

@@ -1 +0,0 @@
-export * from './useBoolean';

package/useBoolean/index.mjs

@@ -1,4 +0,0 @@
-import { useBoolean as r } from "./useBoolean.mjs";
-export {
-  r as useBoolean
-};

package/useBoolean/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useBoolean/useBoolean.d.ts

@@ -1,29 +0,0 @@
-import { Dispatch, SetStateAction } from 'react';
-
-/** The useBoolean return type. */
-type UseBooleanReturn = {
-    /** The current boolean state value. */
-    value: boolean;
-    /** Function to set the boolean state directly. */
-    setValue: Dispatch<SetStateAction<boolean>>;
-    /** Function to set the boolean state to `true`. */
-    setTrue: () => void;
-    /** Function to set the boolean state to `false`. */
-    setFalse: () => void;
-    /** Function to toggle the boolean state. */
-    toggle: () => void;
-};
-/**
- * Custom hook that handles boolean state with useful utility functions.
- * @param {boolean} [defaultValue] - The initial value for the boolean state (default is `false`).
- * @returns {UseBooleanReturn} An object containing the boolean state value and utility functions to manipulate the state.
- * @throws Will throw an error if `defaultValue` is an invalid boolean value.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-boolean)
- * @example
- * ```tsx
- * const { value, setTrue, setFalse, toggle } = useBoolean(true);
- * ```
- */
-export declare function useBoolean(defaultValue?: boolean): UseBooleanReturn;
-export {};

package/useBoolean/useBoolean.mjs

@@ -1,16 +0,0 @@
-import { useState as n, useCallback as t } from "react";
-function c(o = !1) {
-  if (typeof o != "boolean")
-    throw new Error("defaultValue must be `true` or `false`");
-  const [s, e] = n(o), r = t(() => {
-    e(!0);
-  }, []), a = t(() => {
-    e(!1);
-  }, []), l = t(() => {
-    e((u) => !u);
-  }, []);
-  return { value: s, setValue: e, setTrue: r, setFalse: a, toggle: l };
-}
-export {
-  c as useBoolean
-};

package/useClickAnyWhere/index.d.ts

@@ -1 +0,0 @@
-export * from './useClickAnyWhere';

package/useClickAnyWhere/index.mjs

@@ -1,4 +0,0 @@
-import { useClickAnyWhere as o } from "./useClickAnyWhere.mjs";
-export {
-  o as useClickAnyWhere
-};

package/useClickAnyWhere/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useClickAnyWhere/useClickAnyWhere.d.ts

@@ -1,16 +0,0 @@
-/**
- * Custom hook that handles click events anywhere on the document.
- * @param {Function} handler - The function to be called when a click event is detected anywhere on the document.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-click-any-where)
- * @example
- * ```tsx
- * const handleClick = (event) => {
- *   console.log('Document clicked!', event);
- * };
- *
- * // Attach click event handler to document
- * useClickAnywhere(handleClick);
- * ```
- */
-export declare function useClickAnyWhere(handler: (event: MouseEvent) => void): void;

package/useClickAnyWhere/useClickAnyWhere.mjs

@@ -1,9 +0,0 @@
-import { useEventListener as n } from "../useEventListener/useEventListener.mjs";
-function t(e) {
-  n("click", (i) => {
-    e(i);
-  });
-}
-export {
-  t as useClickAnyWhere
-};

package/useCopyToClipboard/index.d.ts

@@ -1 +0,0 @@
-export * from './useCopyToClipboard';

package/useCopyToClipboard/index.mjs

@@ -1,4 +0,0 @@
-import { useCopyToClipboard as r } from "./useCopyToClipboard.mjs";
-export {
-  r as useCopyToClipboard
-};

package/useCopyToClipboard/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useCopyToClipboard/useCopyToClipboard.d.ts

@@ -1,33 +0,0 @@
-/**
- * The copied text as `string` or `null` if nothing has been copied yet.
- */
-type CopiedValue = string | null;
-/**
- * Function to copy text to the clipboard.
- * @param text - The text to copy to the clipboard.
- * @returns {Promise<boolean>} A promise that resolves to `true` if the text was copied successfully, or `false` otherwise.
- */
-type CopyFn = (text: string) => Promise<boolean>;
-/**
- * Custom hook that copies text to the clipboard using the [`Clipboard API`](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API).
- * @returns {[CopiedValue, CopyFn]} An tuple containing the copied text and a function to copy text to the clipboard.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-copy-to-clipboard)
- * @example
- * ```tsx
- * const [copiedText, copyToClipboard] = useCopyToClipboard();
- * const textToCopy = 'Hello, world!';
- *
- * // Attempt to copy text to the clipboard
- * copyToClipboard(textToCopy)
- *   .then(success => {
- *     if (success) {
- *       console.log(`Text "${textToCopy}" copied to clipboard successfully.`);
- *     } else {
- *       console.error('Failed to copy text to clipboard.');
- *     }
- *   });
- * ```
- */
-export declare function useCopyToClipboard(): [CopiedValue, CopyFn];
-export {};

package/useCopyToClipboard/useCopyToClipboard.mjs

@@ -1,16 +0,0 @@
-import { useState as n, useCallback as l } from "react";
-function c() {
-  const [e, r] = n(null), t = l(async (o) => {
-    if (!(navigator != null && navigator.clipboard))
-      return console.warn("Clipboard not supported"), !1;
-    try {
-      return await navigator.clipboard.writeText(o), r(o), !0;
-    } catch (a) {
-      return console.warn("Copy failed", a), r(null), !1;
-    }
-  }, []);
-  return [e, t];
-}
-export {
-  c as useCopyToClipboard
-};

package/useCountdown/index.d.ts

@@ -1 +0,0 @@
-export * from './useCountdown';

package/useCountdown/index.mjs

@@ -1,4 +0,0 @@
-import { useCountdown as n } from "./useCountdown.mjs";
-export {
-  n as useCountdown
-};

package/useCountdown/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useCountdown/useCountdown.d.ts

@@ -1,46 +0,0 @@
-/** The countdown's options. */
-type CountdownOptions = {
-    /** The countdown's starting number, initial value of the returned number. */
-    countStart: number;
-    /**
-     * The countdown's interval, in milliseconds.
-     * @default 1000
-     */
-    intervalMs?: number;
-    /**
-     * True if the countdown is increment.
-     * @default false
-     */
-    isIncrement?: boolean;
-    /**
-     * The countdown's stopping number. Pass `-Infinity` to decrease forever.
-     * @default 0
-     */
-    countStop?: number;
-};
-/** The countdown's controllers. */
-type CountdownControllers = {
-    /** Start the countdown. */
-    startCountdown: () => void;
-    /** Stop the countdown. */
-    stopCountdown: () => void;
-    /** Reset the countdown. */
-    resetCountdown: () => void;
-};
-/**
- * Custom hook that manages countdown.
- * @param {CountdownOptions} countdownOptions - The countdown's options.
- * @returns {[number, CountdownControllers]} An array containing the countdown's count and its controllers.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-countdown)
- * @example
- * ```tsx
- * const [counter, { start, stop, reset }] = useCountdown({
- *   countStart: 10,
- *   intervalMs: 1000,
- *   isIncrement: false,
- * });
- * ```
- */
-export declare function useCountdown({ countStart, countStop, intervalMs, isIncrement, }: CountdownOptions): [number, CountdownControllers];
-export {};

package/useCountdown/useCountdown.mjs

@@ -1,33 +0,0 @@
-import { useCallback as l } from "react";
-import { useBoolean as d } from "../useBoolean/useBoolean.mjs";
-import { useCounter as w } from "../useCounter/useCounter.mjs";
-import { useInterval as p } from "../useInterval/useInterval.mjs";
-function x({
-  countStart: a,
-  countStop: n = 0,
-  intervalMs: c = 1e3,
-  isIncrement: t = !1
-}) {
-  const {
-    count: o,
-    increment: r,
-    decrement: s,
-    reset: u
-  } = w(a), {
-    value: f,
-    setTrue: i,
-    setFalse: e
-  } = d(!1), m = l(() => {
-    e(), u();
-  }, [e, u]), C = l(() => {
-    if (o === n) {
-      e();
-      return;
-    }
-    t ? r() : s();
-  }, [o, n, s, r, t, e]);
-  return p(C, f ? c : null), [o, { startCountdown: i, stopCountdown: e, resetCountdown: m }];
-}
-export {
-  x as useCountdown
-};

package/useCounter/index.d.ts

@@ -1 +0,0 @@
-export * from './useCounter';

package/useCounter/index.mjs

@@ -1,4 +0,0 @@
-import { useCounter as r } from "./useCounter.mjs";
-export {
-  r as useCounter
-};

package/useCounter/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useCounter/useCounter.d.ts

@@ -1,28 +0,0 @@
-import { Dispatch, SetStateAction } from 'react';
-
-/** The hook return type. */
-type UseCounterReturn = {
-    /** The current count value. */
-    count: number;
-    /** Function to increment the counter by 1. */
-    increment: () => void;
-    /** Function to decrement the counter by 1. */
-    decrement: () => void;
-    /** Function to reset the counter to its initial value. */
-    reset: () => void;
-    /** Function to set a specific value to the counter. */
-    setCount: Dispatch<SetStateAction<number>>;
-};
-/**
- * Custom hook that manages a counter with increment, decrement, reset, and setCount functionalities.
- * @param {number} [initialValue] - The initial value for the counter.
- * @returns {UseCounterReturn} An object containing the current count and functions to interact with the counter.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-counter)
- * @example
- * ```tsx
- * const { count, increment, decrement, reset, setCount } = useCounter(5);
- * ```
- */
-export declare function useCounter(initialValue?: number): UseCounterReturn;
-export {};

package/useCounter/useCounter.mjs

@@ -1,20 +0,0 @@
-import { useState as m, useCallback as o } from "react";
-function f(e) {
-  const [c, t] = m(e ?? 0), r = o(() => {
-    t((n) => n + 1);
-  }, []), s = o(() => {
-    t((n) => n - 1);
-  }, []), u = o(() => {
-    t(e ?? 0);
-  }, [e]);
-  return {
-    count: c,
-    increment: r,
-    decrement: s,
-    reset: u,
-    setCount: t
-  };
-}
-export {
-  f as useCounter
-};

package/useDarkMode/index.d.ts

@@ -1 +0,0 @@
-export * from './useDarkMode';

package/useDarkMode/index.mjs

@@ -1,4 +0,0 @@
-import { useDarkMode as r } from "./useDarkMode.mjs";
-export {
-  r as useDarkMode
-};

package/useDarkMode/package.json

@@ -1,7 +0,0 @@
-{
-  "sideEffects": false,
-  "main": "./index.mjs",
-  "module": "./index.mjs",
-  "default": "./index.mjs",
-  "types": "./index.d.ts"
-}

package/useDarkMode/useDarkMode.d.ts

@@ -1,45 +0,0 @@
-/** The hook options. */
-type DarkModeOptions = {
-    /**
-     * The initial value of the dark mode.
-     * @default false
-     */
-    defaultValue?: boolean;
-    /**
-     * The key to use in the local storage.
-     * @default 'usehooks-ts-dark-mode'
-     */
-    localStorageKey?: string;
-    /**
-     * If `true` (default), the hook will initialize reading `localStorage`.
-     * In SSR, you should set it to `false`, returning the `defaultValue` or `false` initially.
-     * @default true
-     */
-    initializeWithValue?: boolean;
-};
-/** The hook return type. */
-type DarkModeReturn = {
-    /** The current state of the dark mode. */
-    isDarkMode: boolean;
-    /** Function to toggle the dark mode. */
-    toggle: () => void;
-    /** Function to enable the dark mode. */
-    enable: () => void;
-    /** Function to disable the dark mode. */
-    disable: () => void;
-    /** Function to set a specific value to the dark mode. */
-    set: (value: boolean) => void;
-};
-/**
- * Custom hook that returns the current state of the dark mode.
- * @param {?DarkModeOptions} [options] - The initial value of the dark mode, default `false`.
- * @returns {DarkModeReturn} An object containing the dark mode's state and its controllers.
- * @public
- * @see [Documentation](https://usehooks-ts.com/react-hook/use-dark-mode)
- * @example
- * ```tsx
- * const { isDarkMode, toggle, enable, disable, set } = useDarkMode({ defaultValue: true });
- * ```
- */
-export declare function useDarkMode(options?: DarkModeOptions): DarkModeReturn;
-export {};

package/useDarkMode/useDarkMode.mjs

@@ -1,38 +0,0 @@
-import { useIsomorphicLayoutEffect as l } from "../useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs";
-import { useLocalStorage as c } from "../useLocalStorage/useLocalStorage.mjs";
-import { useMediaQuery as f } from "../useMediaQuery/useMediaQuery.mjs";
-const n = "(prefers-color-scheme: dark)", d = "usehooks-ts-dark-mode";
-function E(i = {}) {
-  const {
-    defaultValue: t,
-    localStorageKey: u = d,
-    initializeWithValue: s = !0
-  } = i, o = f(n, {
-    initializeWithValue: s,
-    defaultValue: t
-  }), [a, e] = c(
-    u,
-    t ?? o ?? !1,
-    { initializeWithValue: s }
-  );
-  return l(() => {
-    o !== a && e(o);
-  }, [o]), {
-    isDarkMode: a,
-    toggle: () => {
-      e((r) => !r);
-    },
-    enable: () => {
-      e(!0);
-    },
-    disable: () => {
-      e(!1);
-    },
-    set: (r) => {
-      e(r);
-    }
-  };
-}
-export {
-  E as useDarkMode
-};

package/useDebounceCallback/index.d.ts

@@ -1,2 +0,0 @@
-export * from './useDebounceCallback';
-export { useDebounceCallback as default } from './useDebounceCallback';