yummies 7.10.0 → 7.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (154) hide show
  1. package/async.cjs +162 -48
  2. package/async.cjs.map +1 -1
  3. package/async.d.ts +112 -13
  4. package/async.js +163 -54
  5. package/async.js.map +1 -1
  6. package/chunk-CVq3Gv4J.cjs +50 -0
  7. package/chunk-YKewjYmz.js +37 -0
  8. package/common.cjs +48 -8
  9. package/common.cjs.map +1 -1
  10. package/common.d.ts +35 -2
  11. package/common.js +49 -11
  12. package/common.js.map +1 -1
  13. package/complex.cjs +275 -104
  14. package/complex.cjs.map +1 -1
  15. package/complex.d.ts +133 -13
  16. package/complex.js +275 -109
  17. package/complex.js.map +1 -1
  18. package/cookie.cjs +17 -7
  19. package/cookie.cjs.map +1 -1
  20. package/cookie.d.ts +8 -0
  21. package/cookie.js +18 -9
  22. package/cookie.js.map +1 -1
  23. package/css.cjs +147 -39
  24. package/css.cjs.map +1 -1
  25. package/css.d.ts +98 -6
  26. package/css.js +143 -41
  27. package/css.js.map +1 -1
  28. package/data.cjs +90 -55
  29. package/data.cjs.map +1 -1
  30. package/data.d.ts +32 -0
  31. package/data.js +91 -61
  32. package/data.js.map +1 -1
  33. package/date-time.cjs +578 -412
  34. package/date-time.cjs.map +1 -1
  35. package/date-time.d.ts +88 -0
  36. package/date-time.js +575 -421
  37. package/date-time.js.map +1 -1
  38. package/device.cjs +48 -23
  39. package/device.cjs.map +1 -1
  40. package/device.d.ts +32 -0
  41. package/device.js +49 -31
  42. package/device.js.map +1 -1
  43. package/encodings.cjs +275 -266
  44. package/encodings.cjs.map +1 -1
  45. package/encodings.d.ts +8 -0
  46. package/encodings.js +276 -268
  47. package/encodings.js.map +1 -1
  48. package/errors.cjs +20 -18
  49. package/errors.cjs.map +1 -1
  50. package/errors.js +19 -19
  51. package/errors.js.map +1 -1
  52. package/file.cjs +42 -24
  53. package/file.cjs.map +1 -1
  54. package/file.d.ts +16 -0
  55. package/file.js +43 -27
  56. package/file.js.map +1 -1
  57. package/format.cjs +125 -83
  58. package/format.cjs.map +1 -1
  59. package/format.d.ts +89 -4
  60. package/format.js +118 -82
  61. package/format.js.map +1 -1
  62. package/html.cjs +226 -137
  63. package/html.cjs.map +1 -1
  64. package/html.d.ts +67 -3
  65. package/html.js +223 -150
  66. package/html.js.map +1 -1
  67. package/id.cjs +74 -17
  68. package/id.cjs.map +1 -1
  69. package/id.d.ts +10 -10
  70. package/id.js +73 -24
  71. package/id.js.map +1 -1
  72. package/imports.cjs +41 -29
  73. package/imports.cjs.map +1 -1
  74. package/imports.d.ts +13 -4
  75. package/imports.js +40 -31
  76. package/imports.js.map +1 -1
  77. package/math.cjs +32 -6
  78. package/math.cjs.map +1 -1
  79. package/math.d.ts +17 -1
  80. package/math.js +33 -10
  81. package/math.js.map +1 -1
  82. package/media.cjs +275 -84
  83. package/media.cjs.map +1 -1
  84. package/media.d.ts +188 -2
  85. package/media.js +274 -93
  86. package/media.js.map +1 -1
  87. package/mobx.cjs +353 -193
  88. package/mobx.cjs.map +1 -1
  89. package/mobx.d.ts +172 -6
  90. package/mobx.js +351 -200
  91. package/mobx.js.map +1 -1
  92. package/ms.cjs +21 -10
  93. package/ms.cjs.map +1 -1
  94. package/ms.d.ts +1 -1
  95. package/ms.js +22 -13
  96. package/ms.js.map +1 -1
  97. package/number.cjs +13 -7
  98. package/number.cjs.map +1 -1
  99. package/number.js +14 -9
  100. package/number.js.map +1 -1
  101. package/package.json +13 -5
  102. package/parser.cjs +117 -64
  103. package/parser.cjs.map +1 -1
  104. package/parser.d.ts +63 -0
  105. package/parser.js +111 -64
  106. package/parser.js.map +1 -1
  107. package/price.cjs +24 -18
  108. package/price.cjs.map +1 -1
  109. package/price.d.ts +8 -0
  110. package/price.js +25 -20
  111. package/price.js.map +1 -1
  112. package/random.cjs +79 -13
  113. package/random.cjs.map +1 -1
  114. package/random.d.ts +64 -0
  115. package/random.js +80 -22
  116. package/random.js.map +1 -1
  117. package/react.cjs +673 -214
  118. package/react.cjs.map +1 -1
  119. package/react.d.ts +428 -9
  120. package/react.js +674 -239
  121. package/react.js.map +1 -1
  122. package/sound.cjs +14 -9
  123. package/sound.cjs.map +1 -1
  124. package/sound.d.ts +1 -1
  125. package/sound.js +15 -11
  126. package/sound.js.map +1 -1
  127. package/storage.cjs +49 -50
  128. package/storage.cjs.map +1 -1
  129. package/storage.d.ts +15 -6
  130. package/storage.js +50 -53
  131. package/storage.js.map +1 -1
  132. package/text.cjs +51 -34
  133. package/text.cjs.map +1 -1
  134. package/text.d.ts +5 -5
  135. package/text.js +52 -37
  136. package/text.js.map +1 -1
  137. package/type-guard.cjs +292 -72
  138. package/type-guard.cjs.map +1 -1
  139. package/type-guard.d.ts +199 -42
  140. package/type-guard.js +288 -73
  141. package/type-guard.js.map +1 -1
  142. package/types.cjs +0 -2
  143. package/types.global.cjs +0 -2
  144. package/types.global.js +0 -2
  145. package/types.js +0 -2
  146. package/vibrate.cjs +31 -6
  147. package/vibrate.cjs.map +1 -1
  148. package/vibrate.d.ts +23 -1
  149. package/vibrate.js +32 -8
  150. package/vibrate.js.map +1 -1
  151. package/types.cjs.map +0 -1
  152. package/types.global.cjs.map +0 -1
  153. package/types.global.js.map +0 -1
  154. package/types.js.map +0 -1
package/react.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"react.cjs","sources":["../src/react/attach-refs.ts","../src/react/hooks/use-constant.ts","../src/react/hooks/use-abort-controller.ts","../src/react/hooks/use-abort-signal.ts","../src/react/hooks/use-sync-ref.ts","../src/react/hooks/use-event-listener.ts","../src/react/hooks/use-click-outside.ts","../src/react/hooks/use-define-ref.ts","../src/react/hooks/use-element-ref.ts","../src/react/hooks/use-event.ts","../src/react/hooks/use-flag.ts","../src/react/hooks/use-force-update.ts","../src/react/hooks/use-initial-height.ts","../src/react/hooks/use-instance.ts","../src/react/hooks/use-intersection-observer.ts","../src/react/hooks/use-last-defined-value.ts","../src/react/hooks/use-last-value-ref.ts","../src/react/hooks/use-life-cycle.ts","../src/react/hooks/use-resize-observer.ts","../src/react/hooks/use-toggle.ts","../src/react/hooks/use-value.ts","../src/react/hooks/use-visibility-state.ts"],"sourcesContent":["import type { LegacyRef, RefObject } from 'react';\nimport type { Maybe } from 'yummies/types';\n\nexport const attachRefs = <T>(\n value: T | null,\n ...refs: Maybe<RefObject<T> | RefObject<T | null> | LegacyRef<T>>[]\n) =>\n refs.forEach((ref) => {\n if (typeof ref === 'function') {\n ref(value);\n } else if (ref && typeof ref !== 'string') {\n // @ts-expect-error\n ref.current = value;\n }\n });\n","import { useRef } from 'react';\n\n/**\n * React hook for creating a value exactly once.\n * useMemo doesn't give this guarantee unfortunately -\n * https://reactjs.org/docs/hooks-faq.html#how-to-create-expensive-objects-lazily\n * https://reactjs.org/docs/hooks-reference.html#usememo\n * @param defineValue Function which returns defined value.\n */\nexport const useConstant = <T>(defineValue: () => T): T => {\n const ref = useRef<{ value: T }>();\n\n if (!ref.current) {\n ref.current = { value: defineValue() };\n }\n\n return ref.current.value;\n};\n","import { useEffect } from 'react';\n\nimport { useConstant } from './use-constant.js';\n\nexport const useAbortController = () => {\n const controller = useConstant(() => new AbortController());\n\n useEffect(() => {\n return () => {\n controller.abort();\n };\n }, []);\n\n return controller;\n};\n","import { useAbortController } from './use-abort-controller.js';\n\nexport const useAbortSignal = () => {\n return useAbortController().signal;\n};\n","import { useRef } from 'react';\n\nexport const useSyncRef = <T>(value: T) => {\n const ref = useRef(value);\n ref.current = value;\n return ref;\n};\n","/* eslint-disable @typescript-eslint/ban-ts-comment */\nimport { useEffect } from 'react';\nimport { useSyncRef } from './use-sync-ref.js';\n\nexport const useEventListener = <EventName extends keyof HTMLElementEventMap>({\n event,\n handler,\n options,\n deps = [],\n debounce,\n node = document,\n}: {\n event: EventName;\n handler: (e: HTMLElementEventMap[EventName]) => void;\n options?: boolean | AddEventListenerOptions;\n deps?: unknown[];\n debounce?: number;\n node?: HTMLElement | Document | Window;\n}) => {\n const handlerRef = useSyncRef(handler);\n\n useEffect(() => {\n let timerId: ReturnType<typeof setTimeout> | undefined;\n\n const handleEvent = (e: HTMLElementEventMap[EventName]) => {\n if (debounce == null) {\n handlerRef.current(e);\n } else {\n clearTimeout(timerId);\n timerId = setTimeout(() => {\n handlerRef.current(e);\n timerId = undefined;\n }, debounce);\n }\n };\n\n // @ts-expect-error\n node.addEventListener(event, handleEvent, options);\n return () => {\n // @ts-expect-error\n node.removeEventListener(event, handleEvent, options);\n clearTimeout(timerId);\n };\n }, deps);\n};\n","import type { MutableRefObject } from 'react';\nimport { useEventListener } from './use-event-listener.js';\n\ntype ClickOutsideInput = {\n contentRef: MutableRefObject<HTMLElement | null>;\n onClick: VoidFunction;\n options?: AddEventListenerOptions;\n};\n\nexport const useClickOutside = ({\n contentRef,\n onClick,\n options,\n}: ClickOutsideInput) => {\n useEventListener({\n event: 'mousedown',\n handler: (event) => {\n if (\n contentRef.current &&\n !contentRef.current.contains(event.target as Node)\n ) {\n onClick();\n }\n },\n options,\n });\n};\n","import { type MutableRefObject, useRef } from 'react';\n\n/**\n * React hook for creating a value exactly once.\n * useMemo doesn't give this guarantee unfortunately -\n * https://reactjs.org/docs/hooks-faq.html#how-to-create-expensive-objects-lazily\n * https://reactjs.org/docs/hooks-reference.html#usememo\n * @param defineFn Function which returns defined value.\n */\nexport const useDefineRef = <T>(defineFn: () => T): MutableRefObject<T> => {\n const ref = useRef<T>(void 0 as T);\n\n if (!ref.current) {\n ref.current = defineFn();\n }\n\n return ref;\n};\n","import { useLayoutEffect, useRef } from 'react';\n\nexport const useElementRef = <T extends HTMLElement>(selector: () => T) => {\n const ref = useRef<T>();\n\n useLayoutEffect(() => {\n ref.current = selector();\n }, []);\n\n return ref;\n};\n","/**\n * A Hook to define an event handler with an always-stable function identity.\n *\n * borrowed from @gaeron\n * https://github.com/reactjs/rfcs/blob/useevent/text/0000-useevent.md\n */\nimport { useCallback, useLayoutEffect, useRef } from 'react';\nimport type { AnyFunction } from 'yummies/types';\n\nexport const useEvent = <H extends AnyFunction>(handler: H): H => {\n const handlerRef = useRef<H>(handler);\n\n // In a real implementation, this would run before layout effects\n useLayoutEffect(() => {\n handlerRef.current = handler;\n });\n\n return useCallback((...args: unknown[]) => {\n // In a real implementation, this would throw if called during render\n const fn = handlerRef.current as AnyFunction;\n return fn(...args);\n }, []) as unknown as H;\n};\n","import { useCallback, useRef, useState } from 'react';\n\nexport interface FlagHook {\n enabled: boolean;\n toggle: VoidFunction;\n enable: VoidFunction;\n disable: VoidFunction;\n}\n\nexport const useFlag = (defaultValue = false): FlagHook => {\n const [enabled, setEnabled] = useState(defaultValue);\n\n const toggle = useCallback(() => setEnabled((value) => !value), []);\n const enable = useCallback(() => setEnabled(true), []);\n const disable = useCallback(() => setEnabled(false), []);\n\n const flagObjRef = useRef<FlagHook>({\n enabled,\n toggle,\n enable,\n disable,\n });\n\n flagObjRef.current.enabled = enabled;\n\n return flagObjRef.current;\n};\n","import { useCallback, useState } from 'react';\n\nexport const useForceUpdate = () => {\n const [, setState] = useState<unknown>(null);\n\n return useCallback(() => {\n setState({});\n }, []);\n};\n","import { useEffect, useRef, useState } from 'react';\n\nexport const useInitialHeight = <T extends HTMLElement>() => {\n const ref = useRef<T | null>(null);\n const [initialHeight, setInitialHeight] = useState<number | undefined>(\n undefined,\n );\n\n useEffect(() => {\n if (ref.current && !initialHeight) {\n setInitialHeight(ref.current.offsetHeight);\n }\n }, [initialHeight]);\n\n return { ref, initialHeight };\n};\n","import { useLayoutEffect } from 'react';\nimport { useAbortSignal } from './use-abort-signal.js';\nimport { useConstant } from './use-constant.js';\n\nexport type InstanceCreateConfig<TPayload, TExtension = {}> = TExtension & {\n abortSignal: AbortSignal;\n payload: TPayload;\n};\n\nexport const createUseInstanceHook =\n <TExtension = {}>(extension?: TExtension) =>\n <TInstance, TPayload>(\n factory: (\n config: InstanceCreateConfig<NoInfer<TPayload>, TExtension>,\n ) => TInstance,\n config?: {\n payload?: TPayload;\n onUpdate?: (payload: TPayload) => void;\n },\n ) => {\n const abortSignal = useAbortSignal();\n\n const instance = useConstant(() =>\n factory({\n ...(extension as TExtension),\n abortSignal,\n payload: config?.payload as any,\n }),\n );\n\n useLayoutEffect(() => {\n config?.onUpdate?.(config.payload!);\n }, [config?.payload]);\n\n return instance;\n };\n\n/**\n * The `useInstance` hook is used to create and manage an instance of an object\n * that requires access to the root store and an abort signal.\n *\n * You can create YOUR OWN CUSTOM `useInstance` hook using `createUseInstanceHook` if you need\n * to provide some specific data\n *\n * @param factory - A factory function that takes a configuration and returns an instance.\n * @param config - An optional configuration containing additional input parameters and an update function.\n * @returns An instance created by the factory function.\n */\nexport const useInstance = createUseInstanceHook();\n","import { useEffect, useState } from 'react';\n\nexport const useIntersectionObserver = (\n callback: IntersectionObserverCallback,\n options?: IntersectionObserverInit,\n) => {\n const [intersectionObserver] = useState(\n () => new IntersectionObserver(callback, options),\n );\n\n useEffect(() => {\n return () => {\n intersectionObserver.disconnect();\n };\n }, []);\n\n return intersectionObserver;\n};\n","import { useRef } from 'react';\n\nexport const useLastDefinedValue = <T>(value: T) => {\n const ref = useRef(value);\n if (value != null) {\n ref.current = value;\n }\n return ref.current;\n};\n","import { useRef } from 'react';\n\nexport const useLastValueRef = <T>(value: T | null | undefined) => {\n const ref = useRef(value);\n\n if (value != null) {\n ref.current = value;\n }\n\n return ref;\n};\n","import { useEffect } from 'react';\nimport { useSyncRef } from './use-sync-ref.js';\n\nexport const useLifeCycle = (\n fn: () => {\n mount?: VoidFunction;\n unmount?: VoidFunction;\n },\n) => {\n const fnRef = useSyncRef(fn);\n\n useEffect(() => {\n const fnOperation = fnRef.current();\n fnOperation.mount?.();\n return fnOperation.unmount?.();\n }, []);\n};\n","import { useLayoutEffect } from 'react';\nimport { useDefineRef } from './use-define-ref.js';\n\nexport const useResizeObserver = (callback: ResizeObserverCallback) => {\n const resizeObserverRef = useDefineRef(() => new ResizeObserver(callback));\n\n useLayoutEffect(() => {\n return () => {\n resizeObserverRef.current.disconnect();\n };\n }, []);\n\n return resizeObserverRef;\n};\n","import { useCallback, useState } from 'react';\n\nexport const useToggle = (initialState?: boolean) => {\n const [toggled, setToggled] = useState(!!initialState);\n\n const toggle = useCallback(() => setToggled((toggled) => !toggled), []);\n\n return [toggled, toggle, setToggled] as const;\n};\n","import { useState } from 'react';\n\nexport const useValue = <T>(defaults: T | (() => T)) => {\n const [value, setValue] = useState<T>(defaults);\n\n return {\n value,\n set: setValue,\n };\n};\n","import { useEffect, useState } from 'react';\n\nexport const useVisibilityState = () => {\n const [state, setState] = useState<DocumentVisibilityState>();\n\n useEffect(() => {\n const handleVisibilityChange = () => {\n setState(document.visibilityState);\n };\n\n document.addEventListener('visibilitychange', handleVisibilityChange);\n\n return () => {\n document.removeEventListener('visibilitychange', handleVisibilityChange);\n };\n }, []);\n\n return state;\n};\n"],"names":["useRef","useEffect","useLayoutEffect","useCallback","useState","toggled"],"mappings":";;;AAGO,MAAM,aAAa,CACxB,UACG,SAEH,KAAK,QAAQ,CAAC,QAAQ;AACpB,MAAI,OAAO,QAAQ,YAAY;AAC7B,QAAI,KAAK;AAAA,EACX,WAAW,OAAO,OAAO,QAAQ,UAAU;AAEzC,QAAI,UAAU;AAAA,EAChB;AACF,CAAC;ACLI,MAAM,cAAc,CAAI,gBAA4B;AACzD,QAAM,MAAMA,MAAAA,OAAA;AAEZ,MAAI,CAAC,IAAI,SAAS;AAChB,QAAI,UAAU,EAAE,OAAO,YAAA,EAAY;AAAA,EACrC;AAEA,SAAO,IAAI,QAAQ;AACrB;ACbO,MAAM,qBAAqB,MAAM;AACtC,QAAM,aAAa,YAAY,MAAM,IAAI,iBAAiB;AAE1DC,QAAAA,UAAU,MAAM;AACd,WAAO,MAAM;AACX,iBAAW,MAAA;AAAA,IACb;AAAA,EACF,GAAG,CAAA,CAAE;AAEL,SAAO;AACT;ACZO,MAAM,iBAAiB,MAAM;AAClC,SAAO,qBAAqB;AAC9B;ACFO,MAAM,aAAa,CAAI,UAAa;AACzC,QAAM,MAAMD,MAAAA,OAAO,KAAK;AACxB,MAAI,UAAU;AACd,SAAO;AACT;ACFO,MAAM,mBAAmB,CAA8C;AAAA,EAC5E;AAAA,EACA;AAAA,EACA;AAAA,EACA,OAAO,CAAA;AAAA,EACP;AAAA,EACA,OAAO;AACT,MAOM;AACJ,QAAM,aAAa,WAAW,OAAO;AAErCC,QAAAA,UAAU,MAAM;AACd,QAAI;AAEJ,UAAM,cAAc,CAAC,MAAsC;AACzD,UAAI,YAAY,MAAM;AACpB,mBAAW,QAAQ,CAAC;AAAA,MACtB,OAAO;AACL,qBAAa,OAAO;AACpB,kBAAU,WAAW,MAAM;AACzB,qBAAW,QAAQ,CAAC;AACpB,oBAAU;AAAA,QACZ,GAAG,QAAQ;AAAA,MACb;AAAA,IACF;AAGA,SAAK,iBAAiB,OAAO,aAAa,OAAO;AACjD,WAAO,MAAM;AAEX,WAAK,oBAAoB,OAAO,aAAa,OAAO;AACpD,mBAAa,OAAO;AAAA,IACtB;AAAA,EACF,GAAG,IAAI;AACT;ACnCO,MAAM,kBAAkB,CAAC;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AACF,MAAyB;AACvB,mBAAiB;AAAA,IACf,OAAO;AAAA,IACP,SAAS,CAAC,UAAU;AAClB,UACE,WAAW,WACX,CAAC,WAAW,QAAQ,SAAS,MAAM,MAAc,GACjD;AACA,gBAAA;AAAA,MACF;AAAA,IACF;AAAA,IACA;AAAA,EAAA,CACD;AACH;ACjBO,MAAM,eAAe,CAAI,aAA2C;AACzE,QAAM,MAAMD,MAAAA,OAAU,MAAW;AAEjC,MAAI,CAAC,IAAI,SAAS;AAChB,QAAI,UAAU,SAAA;AAAA,EAChB;AAEA,SAAO;AACT;ACfO,MAAM,gBAAgB,CAAwB,aAAsB;AACzE,QAAM,MAAMA,MAAAA,OAAA;AAEZE,QAAAA,gBAAgB,MAAM;AACpB,QAAI,UAAU,SAAA;AAAA,EAChB,GAAG,CAAA,CAAE;AAEL,SAAO;AACT;ACDO,MAAM,WAAW,CAAwB,YAAkB;AAChE,QAAM,aAAaF,MAAAA,OAAU,OAAO;AAGpCE,QAAAA,gBAAgB,MAAM;AACpB,eAAW,UAAU;AAAA,EACvB,CAAC;AAED,SAAOC,MAAAA,YAAY,IAAI,SAAoB;AAEzC,UAAM,KAAK,WAAW;AACtB,WAAO,GAAG,GAAG,IAAI;AAAA,EACnB,GAAG,CAAA,CAAE;AACP;ACbO,MAAM,UAAU,CAAC,eAAe,UAAoB;AACzD,QAAM,CAAC,SAAS,UAAU,IAAIC,MAAAA,SAAS,YAAY;AAEnD,QAAM,SAASD,MAAAA,YAAY,MAAM,WAAW,CAAC,UAAU,CAAC,KAAK,GAAG,EAAE;AAClE,QAAM,SAASA,MAAAA,YAAY,MAAM,WAAW,IAAI,GAAG,CAAA,CAAE;AACrD,QAAM,UAAUA,MAAAA,YAAY,MAAM,WAAW,KAAK,GAAG,CAAA,CAAE;AAEvD,QAAM,aAAaH,MAAAA,OAAiB;AAAA,IAClC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAED,aAAW,QAAQ,UAAU;AAE7B,SAAO,WAAW;AACpB;ACxBO,MAAM,iBAAiB,MAAM;AAClC,QAAM,GAAG,QAAQ,IAAII,MAAAA,SAAkB,IAAI;AAE3C,SAAOD,MAAAA,YAAY,MAAM;AACvB,aAAS,CAAA,CAAE;AAAA,EACb,GAAG,CAAA,CAAE;AACP;ACNO,MAAM,mBAAmB,MAA6B;AAC3D,QAAM,MAAMH,MAAAA,OAAiB,IAAI;AACjC,QAAM,CAAC,eAAe,gBAAgB,IAAII,MAAAA;AAAAA,IACxC;AAAA,EAAA;AAGFH,QAAAA,UAAU,MAAM;AACd,QAAI,IAAI,WAAW,CAAC,eAAe;AACjC,uBAAiB,IAAI,QAAQ,YAAY;AAAA,IAC3C;AAAA,EACF,GAAG,CAAC,aAAa,CAAC;AAElB,SAAO,EAAE,KAAK,cAAA;AAChB;ACNO,MAAM,wBACX,CAAkB,cAClB,CACE,SAGA,WAIG;AACH,QAAM,cAAc,eAAA;AAEpB,QAAM,WAAW;AAAA,IAAY,MAC3B,QAAQ;AAAA,MACN,GAAI;AAAA,MACJ;AAAA,MACA,SAAS,QAAQ;AAAA,IAAA,CAClB;AAAA,EAAA;AAGHC,QAAAA,gBAAgB,MAAM;AACpB,YAAQ,WAAW,OAAO,OAAQ;AAAA,EACpC,GAAG,CAAC,QAAQ,OAAO,CAAC;AAEpB,SAAO;AACT;AAaK,MAAM,cAAc,sBAAA;AC9CpB,MAAM,0BAA0B,CACrC,UACA,YACG;AACH,QAAM,CAAC,oBAAoB,IAAIE,MAAAA;AAAAA,IAC7B,MAAM,IAAI,qBAAqB,UAAU,OAAO;AAAA,EAAA;AAGlDH,QAAAA,UAAU,MAAM;AACd,WAAO,MAAM;AACX,2BAAqB,WAAA;AAAA,IACvB;AAAA,EACF,GAAG,CAAA,CAAE;AAEL,SAAO;AACT;ACfO,MAAM,sBAAsB,CAAI,UAAa;AAClD,QAAM,MAAMD,MAAAA,OAAO,KAAK;AACxB,MAAI,SAAS,MAAM;AACjB,QAAI,UAAU;AAAA,EAChB;AACA,SAAO,IAAI;AACb;ACNO,MAAM,kBAAkB,CAAI,UAAgC;AACjE,QAAM,MAAMA,MAAAA,OAAO,KAAK;AAExB,MAAI,SAAS,MAAM;AACjB,QAAI,UAAU;AAAA,EAChB;AAEA,SAAO;AACT;ACPO,MAAM,eAAe,CAC1B,OAIG;AACH,QAAM,QAAQ,WAAW,EAAE;AAE3BC,QAAAA,UAAU,MAAM;AACd,UAAM,cAAc,MAAM,QAAA;AAC1B,gBAAY,QAAA;AACZ,WAAO,YAAY,UAAA;AAAA,EACrB,GAAG,CAAA,CAAE;AACP;ACbO,MAAM,oBAAoB,CAAC,aAAqC;AACrE,QAAM,oBAAoB,aAAa,MAAM,IAAI,eAAe,QAAQ,CAAC;AAEzEC,QAAAA,gBAAgB,MAAM;AACpB,WAAO,MAAM;AACX,wBAAkB,QAAQ,WAAA;AAAA,IAC5B;AAAA,EACF,GAAG,CAAA,CAAE;AAEL,SAAO;AACT;ACXO,MAAM,YAAY,CAAC,iBAA2B;AACnD,QAAM,CAAC,SAAS,UAAU,IAAIE,MAAAA,SAAS,CAAC,CAAC,YAAY;AAErD,QAAM,SAASD,MAAAA,YAAY,MAAM,WAAW,CAACE,aAAY,CAACA,QAAO,GAAG,EAAE;AAEtE,SAAO,CAAC,SAAS,QAAQ,UAAU;AACrC;ACNO,MAAM,WAAW,CAAI,aAA4B;AACtD,QAAM,CAAC,OAAO,QAAQ,IAAID,MAAAA,SAAY,QAAQ;AAE9C,SAAO;AAAA,IACL;AAAA,IACA,KAAK;AAAA,EAAA;AAET;ACPO,MAAM,qBAAqB,MAAM;AACtC,QAAM,CAAC,OAAO,QAAQ,IAAIA,eAAA;AAE1BH,QAAAA,UAAU,MAAM;AACd,UAAM,yBAAyB,MAAM;AACnC,eAAS,SAAS,eAAe;AAAA,IACnC;AAEA,aAAS,iBAAiB,oBAAoB,sBAAsB;AAEpE,WAAO,MAAM;AACX,eAAS,oBAAoB,oBAAoB,sBAAsB;AAAA,IACzE;AAAA,EACF,GAAG,CAAA,CAAE;AAEL,SAAO;AACT;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"react.cjs","names":[],"sources":["../src/react/attach-refs.ts","../src/react/hooks/use-constant.ts","../src/react/hooks/use-abort-controller.ts","../src/react/hooks/use-abort-signal.ts","../src/react/hooks/use-sync-ref.ts","../src/react/hooks/use-event-listener.ts","../src/react/hooks/use-click-outside.ts","../src/react/hooks/use-define-ref.ts","../src/react/hooks/use-element-ref.ts","../src/react/hooks/use-event.ts","../src/react/hooks/use-flag.ts","../src/react/hooks/use-force-update.ts","../src/react/hooks/use-initial-height.ts","../src/react/hooks/use-instance.ts","../src/react/hooks/use-intersection-observer.ts","../src/react/hooks/use-last-defined-value.ts","../src/react/hooks/use-last-value-ref.ts","../src/react/hooks/use-life-cycle.ts","../src/react/hooks/use-resize-observer.ts","../src/react/hooks/use-toggle.ts","../src/react/hooks/use-value.ts","../src/react/hooks/use-visibility-state.ts"],"sourcesContent":["import type { LegacyRef, RefObject } from 'react';\nimport type { Maybe } from 'yummies/types';\n\n/**\n * Assigns the same value to multiple React refs, including callback refs.\n *\n * @template T Referenced value type.\n * @param value Value that should be written into every provided ref.\n * @param refs Target refs to update.\n *\n * @example\n * ```ts\n * attachRefs(node, localRef, forwardedRef);\n * ```\n *\n * @example\n * ```ts\n * attachRefs(null, inputRef, (value) => console.log(value));\n * ```\n */\nexport const attachRefs = <T>(\n value: T | null,\n ...refs: Maybe<RefObject<T> | RefObject<T | null> | LegacyRef<T>>[]\n) =>\n refs.forEach((ref) => {\n if (typeof ref === 'function') {\n ref(value);\n } else if (ref && typeof ref !== 'string') {\n // @ts-expect-error\n ref.current = value;\n }\n });\n","import { useRef } from 'react';\n\n/**\n * React hook for creating a value exactly once.\n *\n * Unlike `useMemo`, this guarantees that the initializer is executed only once\n * for the component lifetime.\n *\n * @template T Value type.\n * @param defineValue Function that lazily creates the value.\n * @returns Stable value created on the first render.\n *\n * @example\n * ```ts\n * const id = useConstant(() => crypto.randomUUID());\n * ```\n *\n * @example\n * ```ts\n * const formatter = useConstant(() => new Intl.NumberFormat('en-US'));\n * ```\n */\nexport const useConstant = <T>(defineValue: () => T): T => {\n const ref = useRef<{ value: T }>();\n\n if (!ref.current) {\n ref.current = { value: defineValue() };\n }\n\n return ref.current.value;\n};\n","import { useEffect } from 'react';\n\nimport { useConstant } from './use-constant.js';\n\n/**\n * Creates a single `AbortController` instance for the component lifetime.\n *\n * The controller is aborted automatically during unmount.\n *\n * @returns Stable abort controller instance.\n *\n * @example\n * ```ts\n * const controller = useAbortController();\n * fetch('/api', { signal: controller.signal });\n * ```\n *\n * @example\n * ```ts\n * const controller = useAbortController();\n * controller.abort();\n * ```\n */\nexport const useAbortController = () => {\n const controller = useConstant(() => new AbortController());\n\n useEffect(() => {\n return () => {\n controller.abort();\n };\n }, []);\n\n return controller;\n};\n","import { useAbortController } from './use-abort-controller.js';\n\n/**\n * Returns an `AbortSignal` tied to the component lifecycle.\n *\n * The signal is aborted automatically on unmount.\n *\n * @returns Lifecycle-bound abort signal.\n *\n * @example\n * ```ts\n * const signal = useAbortSignal();\n * fetch('/api/users', { signal });\n * ```\n *\n * @example\n * ```ts\n * const signal = useAbortSignal();\n * someAsyncTask({ signal });\n * ```\n */\nexport const useAbortSignal = () => {\n return useAbortController().signal;\n};\n","import { useRef } from 'react';\n\n/**\n * Returns a ref whose `current` value is synchronized with the latest input\n * on every render.\n *\n * @template T Value type.\n * @param value Current value to expose through the ref.\n * @returns Ref containing the latest value.\n *\n * @example\n * ```ts\n * const latestHandler = useSyncRef(onSubmit);\n * latestHandler.current();\n * ```\n *\n * @example\n * ```ts\n * const latestValue = useSyncRef(props.value);\n * latestValue.current;\n * ```\n */\nexport const useSyncRef = <T>(value: T) => {\n const ref = useRef(value);\n ref.current = value;\n return ref;\n};\n","/* eslint-disable @typescript-eslint/ban-ts-comment */\nimport { useEffect } from 'react';\nimport { useSyncRef } from './use-sync-ref.js';\n\n/**\n * Subscribes to a DOM event and keeps the latest handler without resubscribing\n * on every render.\n *\n * Supports optional debounce and custom effect dependencies.\n *\n * @template EventName DOM event name from `HTMLElementEventMap`.\n * @param config Event subscription configuration.\n *\n * @example\n * ```ts\n * useEventListener({\n * event: 'click',\n * handler: () => console.log('clicked'),\n * });\n * ```\n *\n * @example\n * ```ts\n * useEventListener({\n * event: 'scroll',\n * node: window,\n * debounce: 100,\n * handler: () => console.log('scroll'),\n * });\n * ```\n */\nexport const useEventListener = <EventName extends keyof HTMLElementEventMap>({\n event,\n handler,\n options,\n deps = [],\n debounce,\n node = document,\n}: {\n event: EventName;\n handler: (e: HTMLElementEventMap[EventName]) => void;\n options?: boolean | AddEventListenerOptions;\n deps?: unknown[];\n debounce?: number;\n node?: HTMLElement | Document | Window;\n}) => {\n const handlerRef = useSyncRef(handler);\n\n useEffect(() => {\n let timerId: ReturnType<typeof setTimeout> | undefined;\n\n const handleEvent = (e: HTMLElementEventMap[EventName]) => {\n if (debounce == null) {\n handlerRef.current(e);\n } else {\n clearTimeout(timerId);\n timerId = setTimeout(() => {\n handlerRef.current(e);\n timerId = undefined;\n }, debounce);\n }\n };\n\n // @ts-expect-error\n node.addEventListener(event, handleEvent, options);\n return () => {\n // @ts-expect-error\n node.removeEventListener(event, handleEvent, options);\n clearTimeout(timerId);\n };\n }, deps);\n};\n","import type { MutableRefObject } from 'react';\nimport { useEventListener } from './use-event-listener.js';\n\ntype ClickOutsideInput = {\n contentRef: MutableRefObject<HTMLElement | null>;\n onClick: VoidFunction;\n options?: AddEventListenerOptions;\n};\n\n/**\n * Calls a handler when a pointer interaction happens outside the referenced element.\n *\n * @param input Target element ref, callback and event listener options.\n *\n * @example\n * ```ts\n * useClickOutside({\n * contentRef: modalRef,\n * onClick: () => closeModal(),\n * });\n * ```\n *\n * @example\n * ```ts\n * useClickOutside({\n * contentRef: dropdownRef,\n * onClick: hideDropdown,\n * options: { capture: true },\n * });\n * ```\n */\nexport const useClickOutside = ({\n contentRef,\n onClick,\n options,\n}: ClickOutsideInput) => {\n useEventListener({\n event: 'mousedown',\n handler: (event) => {\n if (\n contentRef.current &&\n !contentRef.current.contains(event.target as Node)\n ) {\n onClick();\n }\n },\n options,\n });\n};\n","import { type MutableRefObject, useRef } from 'react';\n\n/**\n * Creates a mutable ref whose value is initialized exactly once.\n *\n * @template T Ref value type.\n * @param defineFn Function that lazily creates the initial ref value.\n * @returns Mutable ref with a stable initialized value.\n *\n * @example\n * ```ts\n * const cacheRef = useDefineRef(() => new Map());\n * ```\n *\n * @example\n * ```ts\n * const observerRef = useDefineRef(() => new ResizeObserver(() => {}));\n * ```\n */\nexport const useDefineRef = <T>(defineFn: () => T): MutableRefObject<T> => {\n const ref = useRef<T>(void 0 as T);\n\n if (!ref.current) {\n ref.current = defineFn();\n }\n\n return ref;\n};\n","import { useLayoutEffect, useRef } from 'react';\n\n/**\n * Resolves an element once after mount and stores it in a ref.\n *\n * @template T Element type.\n * @param selector Function returning the target element.\n * @returns Ref containing the selected element.\n *\n * @example\n * ```ts\n * const buttonRef = useElementRef(() => document.getElementById('save') as HTMLButtonElement);\n * ```\n *\n * @example\n * ```ts\n * const modalRef = useElementRef(() => document.querySelector('.modal') as HTMLDivElement);\n * ```\n */\nexport const useElementRef = <T extends HTMLElement>(selector: () => T) => {\n const ref = useRef<T>();\n\n useLayoutEffect(() => {\n ref.current = selector();\n }, []);\n\n return ref;\n};\n","import { useCallback, useLayoutEffect, useRef } from 'react';\nimport type { AnyFunction } from 'yummies/types';\n\n/**\n * Creates an event callback with a stable function identity and up-to-date logic.\n *\n * Borrowed from the `useEvent` RFC idea by React contributors.\n *\n * @template H Handler function type.\n * @param handler Latest callback implementation.\n * @returns Stable callback that always delegates to the latest handler.\n *\n * @example\n * ```ts\n * const onClick = useEvent(() => {\n * console.log('clicked');\n * });\n * ```\n *\n * @example\n * ```ts\n * const onSubmit = useEvent((value: string) => save(value));\n * ```\n */\nexport const useEvent = <H extends AnyFunction>(handler: H): H => {\n const handlerRef = useRef<H>(handler);\n\n // In a real implementation, this would run before layout effects\n useLayoutEffect(() => {\n handlerRef.current = handler;\n });\n\n return useCallback((...args: unknown[]) => {\n // In a real implementation, this would throw if called during render\n const fn = handlerRef.current as AnyFunction;\n return fn(...args);\n }, []) as unknown as H;\n};\n","import { useCallback, useRef, useState } from 'react';\n\nexport interface FlagHook {\n enabled: boolean;\n toggle: VoidFunction;\n enable: VoidFunction;\n disable: VoidFunction;\n}\n\n/**\n * Manages a reusable boolean flag object with stable helper methods.\n *\n * @param defaultValue Initial enabled state.\n * @returns Stable object exposing current state and mutators.\n *\n * @example\n * ```ts\n * const modal = useFlag();\n * modal.enable();\n * ```\n *\n * @example\n * ```ts\n * const loading = useFlag(true);\n * loading.disable();\n * ```\n */\nexport const useFlag = (defaultValue = false): FlagHook => {\n const [enabled, setEnabled] = useState(defaultValue);\n\n const toggle = useCallback(() => setEnabled((value) => !value), []);\n const enable = useCallback(() => setEnabled(true), []);\n const disable = useCallback(() => setEnabled(false), []);\n\n const flagObjRef = useRef<FlagHook>({\n enabled,\n toggle,\n enable,\n disable,\n });\n\n flagObjRef.current.enabled = enabled;\n\n return flagObjRef.current;\n};\n","import { useCallback, useState } from 'react';\n\n/**\n * Forces a component re-render by updating an internal dummy state.\n *\n * @returns Stable callback that triggers a re-render.\n *\n * @example\n * ```ts\n * const forceUpdate = useForceUpdate();\n * forceUpdate();\n * ```\n *\n * @example\n * ```ts\n * const rerender = useForceUpdate();\n * setTimeout(rerender, 1000);\n * ```\n */\nexport const useForceUpdate = () => {\n const [, setState] = useState<unknown>(null);\n\n return useCallback(() => {\n setState({});\n }, []);\n};\n","import { useEffect, useRef, useState } from 'react';\n\n/**\n * Captures an element's height the first time its ref becomes available.\n *\n * @template T Element type attached to the returned ref.\n * @returns Ref and the initial measured height.\n *\n * @example\n * ```ts\n * const { ref, initialHeight } = useInitialHeight<HTMLDivElement>();\n * ```\n *\n * @example\n * ```ts\n * const state = useInitialHeight<HTMLTextAreaElement>();\n * state.initialHeight;\n * ```\n */\nexport const useInitialHeight = <T extends HTMLElement>() => {\n const ref = useRef<T | null>(null);\n const [initialHeight, setInitialHeight] = useState<number | undefined>(\n undefined,\n );\n\n useEffect(() => {\n if (ref.current && !initialHeight) {\n setInitialHeight(ref.current.offsetHeight);\n }\n }, [initialHeight]);\n\n return { ref, initialHeight };\n};\n","import { useLayoutEffect } from 'react';\nimport { useAbortSignal } from './use-abort-signal.js';\nimport { useConstant } from './use-constant.js';\n\nexport type InstanceCreateConfig<TPayload, TExtension = {}> = TExtension & {\n abortSignal: AbortSignal;\n payload: TPayload;\n};\n\n/**\n * Builds a custom hook that creates an instance once and wires lifecycle helpers\n * such as an `AbortSignal` and optional extension data into the factory.\n *\n * @template TExtension Extra configuration injected into every factory call.\n * @param extension Optional static extension object merged into the factory config.\n * @returns Hook factory that creates stable instances from a supplied factory.\n *\n * @example\n * ```ts\n * const useStoreInstance = createUseInstanceHook({ api });\n * ```\n *\n * @example\n * ```ts\n * const useService = createUseInstanceHook({ logger });\n * const service = useService(({ logger, payload }) => new Service(logger, payload));\n * ```\n */\nexport const createUseInstanceHook =\n <TExtension = {}>(extension?: TExtension) =>\n <TInstance, TPayload>(\n factory: (\n config: InstanceCreateConfig<NoInfer<TPayload>, TExtension>,\n ) => TInstance,\n config?: {\n payload?: TPayload;\n onUpdate?: (payload: TPayload) => void;\n },\n ) => {\n const abortSignal = useAbortSignal();\n\n const instance = useConstant(() =>\n factory({\n ...(extension as TExtension),\n abortSignal,\n payload: config?.payload as any,\n }),\n );\n\n useLayoutEffect(() => {\n config?.onUpdate?.(config.payload!);\n }, [config?.payload]);\n\n return instance;\n };\n\n/**\n * The `useInstance` hook is used to create and manage an instance of an object\n * that requires access to the root store and an abort signal.\n *\n * You can create YOUR OWN CUSTOM `useInstance` hook using `createUseInstanceHook` if you need\n * to provide some specific data\n *\n * @param factory - A factory function that takes a configuration and returns an instance.\n * @param config - An optional configuration containing additional input parameters and an update function.\n * @returns An instance created by the factory function.\n *\n * @example\n * ```ts\n * const service = useInstance(({ abortSignal }) => new UsersService({ abortSignal }));\n * ```\n *\n * @example\n * ```ts\n * const store = useInstance(\n * ({ payload }) => new UserStore(payload),\n * { payload: userId, onUpdate: (nextId) => console.log(nextId) },\n * );\n * ```\n */\nexport const useInstance = createUseInstanceHook();\n","import { useEffect, useState } from 'react';\n\n/**\n * Creates a single `IntersectionObserver` instance and disposes it on unmount.\n *\n * @param callback Observer callback invoked for intersection changes.\n * @param options Optional observer configuration.\n * @returns Stable `IntersectionObserver` instance.\n *\n * @example\n * ```ts\n * const observer = useIntersectionObserver((entries) => {\n * console.log(entries[0]?.isIntersecting);\n * });\n * ```\n *\n * @example\n * ```ts\n * const observer = useIntersectionObserver(handleIntersect, { threshold: 0.5 });\n * observer.observe(element);\n * ```\n */\nexport const useIntersectionObserver = (\n callback: IntersectionObserverCallback,\n options?: IntersectionObserverInit,\n) => {\n const [intersectionObserver] = useState(\n () => new IntersectionObserver(callback, options),\n );\n\n useEffect(() => {\n return () => {\n intersectionObserver.disconnect();\n };\n }, []);\n\n return intersectionObserver;\n};\n","import { useRef } from 'react';\n\n/**\n * Remembers and returns the last non-nullish value passed to the hook.\n *\n * @template T Value type.\n * @param value Current value that may be `null` or `undefined`.\n * @returns Current value when defined, otherwise the previous defined value.\n *\n * @example\n * ```ts\n * const title = useLastDefinedValue(props.title);\n * ```\n *\n * @example\n * ```ts\n * const user = useLastDefinedValue<User | null>(selectedUser);\n * ```\n */\nexport const useLastDefinedValue = <T>(value: T) => {\n const ref = useRef(value);\n if (value != null) {\n ref.current = value;\n }\n return ref.current;\n};\n","import { useRef } from 'react';\n\n/**\n * Returns a ref that always points to the last non-nullish value.\n *\n * @template T Value type.\n * @param value Current value that may temporarily become `null` or `undefined`.\n * @returns Ref containing the last defined value.\n *\n * @example\n * ```ts\n * const latestUserRef = useLastValueRef(user);\n * latestUserRef.current;\n * ```\n *\n * @example\n * ```ts\n * const latestNodeRef = useLastValueRef<HTMLDivElement | null>(node);\n * ```\n */\nexport const useLastValueRef = <T>(value: T | null | undefined) => {\n const ref = useRef(value);\n\n if (value != null) {\n ref.current = value;\n }\n\n return ref;\n};\n","import { useEffect } from 'react';\nimport { useSyncRef } from './use-sync-ref.js';\n\n/**\n * Runs mount and unmount callbacks returned by a factory function.\n *\n * The latest factory is stored in a ref, while the effect itself is only\n * subscribed once.\n *\n * @param fn Factory returning optional `mount` and `unmount` handlers.\n *\n * @example\n * ```ts\n * useLifeCycle(() => ({\n * mount: () => console.log('mounted'),\n * unmount: () => console.log('unmounted'),\n * }));\n * ```\n *\n * @example\n * ```ts\n * useLifeCycle(() => ({\n * mount: subscribe,\n * unmount: unsubscribe,\n * }));\n * ```\n */\nexport const useLifeCycle = (\n fn: () => {\n mount?: VoidFunction;\n unmount?: VoidFunction;\n },\n) => {\n const fnRef = useSyncRef(fn);\n\n useEffect(() => {\n const fnOperation = fnRef.current();\n fnOperation.mount?.();\n return fnOperation.unmount?.();\n }, []);\n};\n","import { useLayoutEffect } from 'react';\nimport { useDefineRef } from './use-define-ref.js';\n\n/**\n * Creates a stable `ResizeObserver` instance and disconnects it on unmount.\n *\n * @param callback Resize observer callback.\n * @returns Ref containing the observer instance.\n *\n * @example\n * ```ts\n * const observerRef = useResizeObserver((entries) => {\n * console.log(entries[0]?.contentRect.width);\n * });\n * ```\n *\n * @example\n * ```ts\n * const resizeObserver = useResizeObserver(handleResize);\n * resizeObserver.current.observe(element);\n * ```\n */\nexport const useResizeObserver = (callback: ResizeObserverCallback) => {\n const resizeObserverRef = useDefineRef(() => new ResizeObserver(callback));\n\n useLayoutEffect(() => {\n return () => {\n resizeObserverRef.current.disconnect();\n };\n }, []);\n\n return resizeObserverRef;\n};\n","import { useCallback, useState } from 'react';\n\n/**\n * Manages a boolean state and returns helpers to toggle or set it directly.\n *\n * @param initialState Initial boolean value.\n * @returns Tuple with current state, toggle callback and raw setter.\n *\n * @example\n * ```ts\n * const [open, toggleOpen] = useToggle();\n * toggleOpen();\n * ```\n *\n * @example\n * ```ts\n * const [enabled, , setEnabled] = useToggle(true);\n * setEnabled(false);\n * ```\n */\nexport const useToggle = (initialState?: boolean) => {\n const [toggled, setToggled] = useState(!!initialState);\n\n const toggle = useCallback(() => setToggled((toggled) => !toggled), []);\n\n return [toggled, toggle, setToggled] as const;\n};\n","import { useState } from 'react';\n\n/**\n * Wraps `useState` and returns the state value as an object with a `set` method.\n *\n * @template T State value type.\n * @param defaults Initial state value or lazy initializer.\n * @returns Object containing the current value and setter.\n *\n * @example\n * ```ts\n * const counter = useValue(0);\n * counter.set(1);\n * ```\n *\n * @example\n * ```ts\n * const user = useValue(() => ({ name: 'Ann' }));\n * user.value.name;\n * ```\n */\nexport const useValue = <T>(defaults: T | (() => T)) => {\n const [value, setValue] = useState<T>(defaults);\n\n return {\n value,\n set: setValue,\n };\n};\n","import { useEffect, useState } from 'react';\n\n/**\n * Tracks `document.visibilityState` and updates when the page visibility changes.\n *\n * @returns Current document visibility state.\n *\n * @example\n * ```ts\n * const visibility = useVisibilityState();\n * ```\n *\n * @example\n * ```ts\n * const isHidden = useVisibilityState() === 'hidden';\n * ```\n */\nexport const useVisibilityState = () => {\n const [state, setState] = useState<DocumentVisibilityState>();\n\n useEffect(() => {\n const handleVisibilityChange = () => {\n setState(document.visibilityState);\n };\n\n document.addEventListener('visibilitychange', handleVisibilityChange);\n\n return () => {\n document.removeEventListener('visibilitychange', handleVisibilityChange);\n };\n }, []);\n\n return state;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAoBA,IAAa,cACX,OACA,GAAG,SAEH,KAAK,SAAS,QAAQ;AACpB,KAAI,OAAO,QAAQ,WACjB,KAAI,MAAM;UACD,OAAO,OAAO,QAAQ,SAE/B,KAAI,UAAU;EAEhB;;;;;;;;;;;;;;;;;;;;;;;ACTJ,IAAa,eAAkB,gBAA4B;CACzD,MAAM,OAAA,GAAA,MAAA,SAA4B;AAElC,KAAI,CAAC,IAAI,QACP,KAAI,UAAU,EAAE,OAAO,aAAa,EAAE;AAGxC,QAAO,IAAI,QAAQ;;;;;;;;;;;;;;;;;;;;;;;ACNrB,IAAa,2BAA2B;CACtC,MAAM,aAAa,kBAAkB,IAAI,iBAAiB,CAAC;AAE3D,EAAA,GAAA,MAAA,iBAAgB;AACd,eAAa;AACX,cAAW,OAAO;;IAEnB,EAAE,CAAC;AAEN,QAAO;;;;;;;;;;;;;;;;;;;;;;;ACXT,IAAa,uBAAuB;AAClC,QAAO,oBAAoB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;ACA9B,IAAa,cAAiB,UAAa;CACzC,MAAM,OAAA,GAAA,MAAA,QAAa,MAAM;AACzB,KAAI,UAAU;AACd,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACMT,IAAa,oBAAiE,EAC5E,OACA,SACA,SACA,OAAO,EAAE,EACT,UACA,OAAO,eAQH;CACJ,MAAM,aAAa,WAAW,QAAQ;AAEtC,EAAA,GAAA,MAAA,iBAAgB;EACd,IAAI;EAEJ,MAAM,eAAe,MAAsC;AACzD,OAAI,YAAY,KACd,YAAW,QAAQ,EAAE;QAChB;AACL,iBAAa,QAAQ;AACrB,cAAU,iBAAiB;AACzB,gBAAW,QAAQ,EAAE;AACrB,eAAU,KAAA;OACT,SAAS;;;AAKhB,OAAK,iBAAiB,OAAO,aAAa,QAAQ;AAClD,eAAa;AAEX,QAAK,oBAAoB,OAAO,aAAa,QAAQ;AACrD,gBAAa,QAAQ;;IAEtB,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;ACvCV,IAAa,mBAAmB,EAC9B,YACA,SACA,cACuB;AACvB,kBAAiB;EACf,OAAO;EACP,UAAU,UAAU;AAClB,OACE,WAAW,WACX,CAAC,WAAW,QAAQ,SAAS,MAAM,OAAe,CAElD,UAAS;;EAGb;EACD,CAAC;;;;;;;;;;;;;;;;;;;;;AC5BJ,IAAa,gBAAmB,aAA2C;CACzE,MAAM,OAAA,GAAA,MAAA,QAAgB,KAAK,EAAO;AAElC,KAAI,CAAC,IAAI,QACP,KAAI,UAAU,UAAU;AAG1B,QAAO;;;;;;;;;;;;;;;;;;;;;ACPT,IAAa,iBAAwC,aAAsB;CACzE,MAAM,OAAA,GAAA,MAAA,SAAiB;AAEvB,EAAA,GAAA,MAAA,uBAAsB;AACpB,MAAI,UAAU,UAAU;IACvB,EAAE,CAAC;AAEN,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;ACFT,IAAa,YAAmC,YAAkB;CAChE,MAAM,cAAA,GAAA,MAAA,QAAuB,QAAQ;AAGrC,EAAA,GAAA,MAAA,uBAAsB;AACpB,aAAW,UAAU;GACrB;AAEF,SAAA,GAAA,MAAA,cAAoB,GAAG,SAAoB;EAEzC,MAAM,KAAK,WAAW;AACtB,SAAO,GAAG,GAAG,KAAK;IACjB,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;ACTR,IAAa,WAAW,eAAe,UAAoB;CACzD,MAAM,CAAC,SAAS,eAAA,GAAA,MAAA,UAAuB,aAAa;CAMpD,MAAM,cAAA,GAAA,MAAA,QAA8B;EAClC;EACA,SAAA,GAAA,MAAA,mBAN+B,YAAY,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;EAOjE,SAAA,GAAA,MAAA,mBAN+B,WAAW,KAAK,EAAE,EAAE,CAAC;EAOpD,UAAA,GAAA,MAAA,mBANgC,WAAW,MAAM,EAAE,EAAE,CAAC;EAOvD,CAAC;AAEF,YAAW,QAAQ,UAAU;AAE7B,QAAO,WAAW;;;;;;;;;;;;;;;;;;;;;ACxBpB,IAAa,uBAAuB;CAClC,MAAM,GAAG,aAAA,GAAA,MAAA,UAA8B,KAAK;AAE5C,SAAA,GAAA,MAAA,mBAAyB;AACvB,WAAS,EAAE,CAAC;IACX,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;ACLR,IAAa,yBAAgD;CAC3D,MAAM,OAAA,GAAA,MAAA,QAAuB,KAAK;CAClC,MAAM,CAAC,eAAe,qBAAA,GAAA,MAAA,UACpB,KAAA,EACD;AAED,EAAA,GAAA,MAAA,iBAAgB;AACd,MAAI,IAAI,WAAW,CAAC,cAClB,kBAAiB,IAAI,QAAQ,aAAa;IAE3C,CAAC,cAAc,CAAC;AAEnB,QAAO;EAAE;EAAK;EAAe;;;;;;;;;;;;;;;;;;;;;;;ACH/B,IAAa,yBACO,eAEhB,SAGA,WAIG;CACH,MAAM,cAAc,gBAAgB;CAEpC,MAAM,WAAW,kBACf,QAAQ;EACN,GAAI;EACJ;EACA,SAAS,QAAQ;EAClB,CAAC,CACH;AAED,EAAA,GAAA,MAAA,uBAAsB;AACpB,UAAQ,WAAW,OAAO,QAAS;IAClC,CAAC,QAAQ,QAAQ,CAAC;AAErB,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BX,IAAa,cAAc,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;AC1DlD,IAAa,2BACX,UACA,YACG;CACH,MAAM,CAAC,yBAAA,GAAA,MAAA,gBACC,IAAI,qBAAqB,UAAU,QAAQ,CAClD;AAED,EAAA,GAAA,MAAA,iBAAgB;AACd,eAAa;AACX,wBAAqB,YAAY;;IAElC,EAAE,CAAC;AAEN,QAAO;;;;;;;;;;;;;;;;;;;;;ACjBT,IAAa,uBAA0B,UAAa;CAClD,MAAM,OAAA,GAAA,MAAA,QAAa,MAAM;AACzB,KAAI,SAAS,KACX,KAAI,UAAU;AAEhB,QAAO,IAAI;;;;;;;;;;;;;;;;;;;;;;ACJb,IAAa,mBAAsB,UAAgC;CACjE,MAAM,OAAA,GAAA,MAAA,QAAa,MAAM;AAEzB,KAAI,SAAS,KACX,KAAI,UAAU;AAGhB,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACAT,IAAa,gBACX,OAIG;CACH,MAAM,QAAQ,WAAW,GAAG;AAE5B,EAAA,GAAA,MAAA,iBAAgB;EACd,MAAM,cAAc,MAAM,SAAS;AACnC,cAAY,SAAS;AACrB,SAAO,YAAY,WAAW;IAC7B,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;ACjBR,IAAa,qBAAqB,aAAqC;CACrE,MAAM,oBAAoB,mBAAmB,IAAI,eAAe,SAAS,CAAC;AAE1E,EAAA,GAAA,MAAA,uBAAsB;AACpB,eAAa;AACX,qBAAkB,QAAQ,YAAY;;IAEvC,EAAE,CAAC;AAEN,QAAO;;;;;;;;;;;;;;;;;;;;;;ACXT,IAAa,aAAa,iBAA2B;CACnD,MAAM,CAAC,SAAS,eAAA,GAAA,MAAA,UAAuB,CAAC,CAAC,aAAa;AAItD,QAAO;EAAC;+BAFyB,YAAY,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;EAE9C;EAAW;;;;;;;;;;;;;;;;;;;;;;;ACJtC,IAAa,YAAe,aAA4B;CACtD,MAAM,CAAC,OAAO,aAAA,GAAA,MAAA,UAAwB,SAAS;AAE/C,QAAO;EACL;EACA,KAAK;EACN;;;;;;;;;;;;;;;;;;;ACVH,IAAa,2BAA2B;CACtC,MAAM,CAAC,OAAO,aAAA,GAAA,MAAA,WAA+C;AAE7D,EAAA,GAAA,MAAA,iBAAgB;EACd,MAAM,+BAA+B;AACnC,YAAS,SAAS,gBAAgB;;AAGpC,WAAS,iBAAiB,oBAAoB,uBAAuB;AAErE,eAAa;AACX,YAAS,oBAAoB,oBAAoB,uBAAuB;;IAEzE,EAAE,CAAC;AAEN,QAAO"}
package/react.d.ts CHANGED
@@ -2,10 +2,65 @@ import * as react from 'react';
2
2
  import { RefObject, LegacyRef, MutableRefObject } from 'react';
3
3
  import { Maybe, AnyFunction } from 'yummies/types';
4
4
 
5
+ /**
6
+ * Assigns the same value to multiple React refs, including callback refs.
7
+ *
8
+ * @template T Referenced value type.
9
+ * @param value Value that should be written into every provided ref.
10
+ * @param refs Target refs to update.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * attachRefs(node, localRef, forwardedRef);
15
+ * ```
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * attachRefs(null, inputRef, (value) => console.log(value));
20
+ * ```
21
+ */
5
22
  declare const attachRefs: <T>(value: T | null, ...refs: Maybe<RefObject<T> | RefObject<T | null> | LegacyRef<T>>[]) => void;
6
23
 
24
+ /**
25
+ * Creates a single `AbortController` instance for the component lifetime.
26
+ *
27
+ * The controller is aborted automatically during unmount.
28
+ *
29
+ * @returns Stable abort controller instance.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const controller = useAbortController();
34
+ * fetch('/api', { signal: controller.signal });
35
+ * ```
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * const controller = useAbortController();
40
+ * controller.abort();
41
+ * ```
42
+ */
7
43
  declare const useAbortController: () => AbortController;
8
44
 
45
+ /**
46
+ * Returns an `AbortSignal` tied to the component lifecycle.
47
+ *
48
+ * The signal is aborted automatically on unmount.
49
+ *
50
+ * @returns Lifecycle-bound abort signal.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const signal = useAbortSignal();
55
+ * fetch('/api/users', { signal });
56
+ * ```
57
+ *
58
+ * @example
59
+ * ```ts
60
+ * const signal = useAbortSignal();
61
+ * someAsyncTask({ signal });
62
+ * ```
63
+ */
9
64
  declare const useAbortSignal: () => AbortSignal;
10
65
 
11
66
  type ClickOutsideInput = {
@@ -13,30 +68,140 @@ type ClickOutsideInput = {
13
68
  onClick: VoidFunction;
14
69
  options?: AddEventListenerOptions;
15
70
  };
71
+ /**
72
+ * Calls a handler when a pointer interaction happens outside the referenced element.
73
+ *
74
+ * @param input Target element ref, callback and event listener options.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * useClickOutside({
79
+ * contentRef: modalRef,
80
+ * onClick: () => closeModal(),
81
+ * });
82
+ * ```
83
+ *
84
+ * @example
85
+ * ```ts
86
+ * useClickOutside({
87
+ * contentRef: dropdownRef,
88
+ * onClick: hideDropdown,
89
+ * options: { capture: true },
90
+ * });
91
+ * ```
92
+ */
16
93
  declare const useClickOutside: ({ contentRef, onClick, options, }: ClickOutsideInput) => void;
17
94
 
18
95
  /**
19
96
  * React hook for creating a value exactly once.
20
- * useMemo doesn't give this guarantee unfortunately -
21
- * https://reactjs.org/docs/hooks-faq.html#how-to-create-expensive-objects-lazily
22
- * https://reactjs.org/docs/hooks-reference.html#usememo
23
- * @param defineValue Function which returns defined value.
97
+ *
98
+ * Unlike `useMemo`, this guarantees that the initializer is executed only once
99
+ * for the component lifetime.
100
+ *
101
+ * @template T Value type.
102
+ * @param defineValue Function that lazily creates the value.
103
+ * @returns Stable value created on the first render.
104
+ *
105
+ * @example
106
+ * ```ts
107
+ * const id = useConstant(() => crypto.randomUUID());
108
+ * ```
109
+ *
110
+ * @example
111
+ * ```ts
112
+ * const formatter = useConstant(() => new Intl.NumberFormat('en-US'));
113
+ * ```
24
114
  */
25
115
  declare const useConstant: <T>(defineValue: () => T) => T;
26
116
 
27
117
  /**
28
- * React hook for creating a value exactly once.
29
- * useMemo doesn't give this guarantee unfortunately -
30
- * https://reactjs.org/docs/hooks-faq.html#how-to-create-expensive-objects-lazily
31
- * https://reactjs.org/docs/hooks-reference.html#usememo
32
- * @param defineFn Function which returns defined value.
118
+ * Creates a mutable ref whose value is initialized exactly once.
119
+ *
120
+ * @template T Ref value type.
121
+ * @param defineFn Function that lazily creates the initial ref value.
122
+ * @returns Mutable ref with a stable initialized value.
123
+ *
124
+ * @example
125
+ * ```ts
126
+ * const cacheRef = useDefineRef(() => new Map());
127
+ * ```
128
+ *
129
+ * @example
130
+ * ```ts
131
+ * const observerRef = useDefineRef(() => new ResizeObserver(() => {}));
132
+ * ```
33
133
  */
34
134
  declare const useDefineRef: <T>(defineFn: () => T) => MutableRefObject<T>;
35
135
 
136
+ /**
137
+ * Resolves an element once after mount and stores it in a ref.
138
+ *
139
+ * @template T Element type.
140
+ * @param selector Function returning the target element.
141
+ * @returns Ref containing the selected element.
142
+ *
143
+ * @example
144
+ * ```ts
145
+ * const buttonRef = useElementRef(() => document.getElementById('save') as HTMLButtonElement);
146
+ * ```
147
+ *
148
+ * @example
149
+ * ```ts
150
+ * const modalRef = useElementRef(() => document.querySelector('.modal') as HTMLDivElement);
151
+ * ```
152
+ */
36
153
  declare const useElementRef: <T extends HTMLElement>(selector: () => T) => react.MutableRefObject<T | undefined>;
37
154
 
155
+ /**
156
+ * Creates an event callback with a stable function identity and up-to-date logic.
157
+ *
158
+ * Borrowed from the `useEvent` RFC idea by React contributors.
159
+ *
160
+ * @template H Handler function type.
161
+ * @param handler Latest callback implementation.
162
+ * @returns Stable callback that always delegates to the latest handler.
163
+ *
164
+ * @example
165
+ * ```ts
166
+ * const onClick = useEvent(() => {
167
+ * console.log('clicked');
168
+ * });
169
+ * ```
170
+ *
171
+ * @example
172
+ * ```ts
173
+ * const onSubmit = useEvent((value: string) => save(value));
174
+ * ```
175
+ */
38
176
  declare const useEvent: <H extends AnyFunction>(handler: H) => H;
39
177
 
178
+ /**
179
+ * Subscribes to a DOM event and keeps the latest handler without resubscribing
180
+ * on every render.
181
+ *
182
+ * Supports optional debounce and custom effect dependencies.
183
+ *
184
+ * @template EventName DOM event name from `HTMLElementEventMap`.
185
+ * @param config Event subscription configuration.
186
+ *
187
+ * @example
188
+ * ```ts
189
+ * useEventListener({
190
+ * event: 'click',
191
+ * handler: () => console.log('clicked'),
192
+ * });
193
+ * ```
194
+ *
195
+ * @example
196
+ * ```ts
197
+ * useEventListener({
198
+ * event: 'scroll',
199
+ * node: window,
200
+ * debounce: 100,
201
+ * handler: () => console.log('scroll'),
202
+ * });
203
+ * ```
204
+ */
40
205
  declare const useEventListener: <EventName extends keyof HTMLElementEventMap>({ event, handler, options, deps, debounce, node, }: {
41
206
  event: EventName;
42
207
  handler: (e: HTMLElementEventMap[EventName]) => void;
@@ -52,10 +217,62 @@ interface FlagHook {
52
217
  enable: VoidFunction;
53
218
  disable: VoidFunction;
54
219
  }
220
+ /**
221
+ * Manages a reusable boolean flag object with stable helper methods.
222
+ *
223
+ * @param defaultValue Initial enabled state.
224
+ * @returns Stable object exposing current state and mutators.
225
+ *
226
+ * @example
227
+ * ```ts
228
+ * const modal = useFlag();
229
+ * modal.enable();
230
+ * ```
231
+ *
232
+ * @example
233
+ * ```ts
234
+ * const loading = useFlag(true);
235
+ * loading.disable();
236
+ * ```
237
+ */
55
238
  declare const useFlag: (defaultValue?: boolean) => FlagHook;
56
239
 
240
+ /**
241
+ * Forces a component re-render by updating an internal dummy state.
242
+ *
243
+ * @returns Stable callback that triggers a re-render.
244
+ *
245
+ * @example
246
+ * ```ts
247
+ * const forceUpdate = useForceUpdate();
248
+ * forceUpdate();
249
+ * ```
250
+ *
251
+ * @example
252
+ * ```ts
253
+ * const rerender = useForceUpdate();
254
+ * setTimeout(rerender, 1000);
255
+ * ```
256
+ */
57
257
  declare const useForceUpdate: () => () => void;
58
258
 
259
+ /**
260
+ * Captures an element's height the first time its ref becomes available.
261
+ *
262
+ * @template T Element type attached to the returned ref.
263
+ * @returns Ref and the initial measured height.
264
+ *
265
+ * @example
266
+ * ```ts
267
+ * const { ref, initialHeight } = useInitialHeight<HTMLDivElement>();
268
+ * ```
269
+ *
270
+ * @example
271
+ * ```ts
272
+ * const state = useInitialHeight<HTMLTextAreaElement>();
273
+ * state.initialHeight;
274
+ * ```
275
+ */
59
276
  declare const useInitialHeight: <T extends HTMLElement>() => {
60
277
  ref: react.MutableRefObject<T | null>;
61
278
  initialHeight: number | undefined;
@@ -65,6 +282,25 @@ type InstanceCreateConfig<TPayload, TExtension = {}> = TExtension & {
65
282
  abortSignal: AbortSignal;
66
283
  payload: TPayload;
67
284
  };
285
+ /**
286
+ * Builds a custom hook that creates an instance once and wires lifecycle helpers
287
+ * such as an `AbortSignal` and optional extension data into the factory.
288
+ *
289
+ * @template TExtension Extra configuration injected into every factory call.
290
+ * @param extension Optional static extension object merged into the factory config.
291
+ * @returns Hook factory that creates stable instances from a supplied factory.
292
+ *
293
+ * @example
294
+ * ```ts
295
+ * const useStoreInstance = createUseInstanceHook({ api });
296
+ * ```
297
+ *
298
+ * @example
299
+ * ```ts
300
+ * const useService = createUseInstanceHook({ logger });
301
+ * const service = useService(({ logger, payload }) => new Service(logger, payload));
302
+ * ```
303
+ */
68
304
  declare const createUseInstanceHook: <TExtension = {}>(extension?: TExtension) => <TInstance, TPayload>(factory: (config: InstanceCreateConfig<NoInfer<TPayload>, TExtension>) => TInstance, config?: {
69
305
  payload?: TPayload;
70
306
  onUpdate?: (payload: TPayload) => void;
@@ -79,6 +315,19 @@ declare const createUseInstanceHook: <TExtension = {}>(extension?: TExtension) =
79
315
  * @param factory - A factory function that takes a configuration and returns an instance.
80
316
  * @param config - An optional configuration containing additional input parameters and an update function.
81
317
  * @returns An instance created by the factory function.
318
+ *
319
+ * @example
320
+ * ```ts
321
+ * const service = useInstance(({ abortSignal }) => new UsersService({ abortSignal }));
322
+ * ```
323
+ *
324
+ * @example
325
+ * ```ts
326
+ * const store = useInstance(
327
+ * ({ payload }) => new UserStore(payload),
328
+ * { payload: userId, onUpdate: (nextId) => console.log(nextId) },
329
+ * );
330
+ * ```
82
331
  */
83
332
  declare const useInstance: <TInstance, TPayload>(factory: (config: {
84
333
  abortSignal: AbortSignal;
@@ -88,28 +337,198 @@ declare const useInstance: <TInstance, TPayload>(factory: (config: {
88
337
  onUpdate?: ((payload: TPayload) => void) | undefined;
89
338
  } | undefined) => TInstance;
90
339
 
340
+ /**
341
+ * Creates a single `IntersectionObserver` instance and disposes it on unmount.
342
+ *
343
+ * @param callback Observer callback invoked for intersection changes.
344
+ * @param options Optional observer configuration.
345
+ * @returns Stable `IntersectionObserver` instance.
346
+ *
347
+ * @example
348
+ * ```ts
349
+ * const observer = useIntersectionObserver((entries) => {
350
+ * console.log(entries[0]?.isIntersecting);
351
+ * });
352
+ * ```
353
+ *
354
+ * @example
355
+ * ```ts
356
+ * const observer = useIntersectionObserver(handleIntersect, { threshold: 0.5 });
357
+ * observer.observe(element);
358
+ * ```
359
+ */
91
360
  declare const useIntersectionObserver: (callback: IntersectionObserverCallback, options?: IntersectionObserverInit) => IntersectionObserver;
92
361
 
362
+ /**
363
+ * Remembers and returns the last non-nullish value passed to the hook.
364
+ *
365
+ * @template T Value type.
366
+ * @param value Current value that may be `null` or `undefined`.
367
+ * @returns Current value when defined, otherwise the previous defined value.
368
+ *
369
+ * @example
370
+ * ```ts
371
+ * const title = useLastDefinedValue(props.title);
372
+ * ```
373
+ *
374
+ * @example
375
+ * ```ts
376
+ * const user = useLastDefinedValue<User | null>(selectedUser);
377
+ * ```
378
+ */
93
379
  declare const useLastDefinedValue: <T>(value: T) => T;
94
380
 
381
+ /**
382
+ * Returns a ref that always points to the last non-nullish value.
383
+ *
384
+ * @template T Value type.
385
+ * @param value Current value that may temporarily become `null` or `undefined`.
386
+ * @returns Ref containing the last defined value.
387
+ *
388
+ * @example
389
+ * ```ts
390
+ * const latestUserRef = useLastValueRef(user);
391
+ * latestUserRef.current;
392
+ * ```
393
+ *
394
+ * @example
395
+ * ```ts
396
+ * const latestNodeRef = useLastValueRef<HTMLDivElement | null>(node);
397
+ * ```
398
+ */
95
399
  declare const useLastValueRef: <T>(value: T | null | undefined) => react.MutableRefObject<T | null | undefined>;
96
400
 
401
+ /**
402
+ * Runs mount and unmount callbacks returned by a factory function.
403
+ *
404
+ * The latest factory is stored in a ref, while the effect itself is only
405
+ * subscribed once.
406
+ *
407
+ * @param fn Factory returning optional `mount` and `unmount` handlers.
408
+ *
409
+ * @example
410
+ * ```ts
411
+ * useLifeCycle(() => ({
412
+ * mount: () => console.log('mounted'),
413
+ * unmount: () => console.log('unmounted'),
414
+ * }));
415
+ * ```
416
+ *
417
+ * @example
418
+ * ```ts
419
+ * useLifeCycle(() => ({
420
+ * mount: subscribe,
421
+ * unmount: unsubscribe,
422
+ * }));
423
+ * ```
424
+ */
97
425
  declare const useLifeCycle: (fn: () => {
98
426
  mount?: VoidFunction;
99
427
  unmount?: VoidFunction;
100
428
  }) => void;
101
429
 
430
+ /**
431
+ * Creates a stable `ResizeObserver` instance and disconnects it on unmount.
432
+ *
433
+ * @param callback Resize observer callback.
434
+ * @returns Ref containing the observer instance.
435
+ *
436
+ * @example
437
+ * ```ts
438
+ * const observerRef = useResizeObserver((entries) => {
439
+ * console.log(entries[0]?.contentRect.width);
440
+ * });
441
+ * ```
442
+ *
443
+ * @example
444
+ * ```ts
445
+ * const resizeObserver = useResizeObserver(handleResize);
446
+ * resizeObserver.current.observe(element);
447
+ * ```
448
+ */
102
449
  declare const useResizeObserver: (callback: ResizeObserverCallback) => react.MutableRefObject<ResizeObserver>;
103
450
 
451
+ /**
452
+ * Returns a ref whose `current` value is synchronized with the latest input
453
+ * on every render.
454
+ *
455
+ * @template T Value type.
456
+ * @param value Current value to expose through the ref.
457
+ * @returns Ref containing the latest value.
458
+ *
459
+ * @example
460
+ * ```ts
461
+ * const latestHandler = useSyncRef(onSubmit);
462
+ * latestHandler.current();
463
+ * ```
464
+ *
465
+ * @example
466
+ * ```ts
467
+ * const latestValue = useSyncRef(props.value);
468
+ * latestValue.current;
469
+ * ```
470
+ */
104
471
  declare const useSyncRef: <T>(value: T) => react.MutableRefObject<T>;
105
472
 
473
+ /**
474
+ * Manages a boolean state and returns helpers to toggle or set it directly.
475
+ *
476
+ * @param initialState Initial boolean value.
477
+ * @returns Tuple with current state, toggle callback and raw setter.
478
+ *
479
+ * @example
480
+ * ```ts
481
+ * const [open, toggleOpen] = useToggle();
482
+ * toggleOpen();
483
+ * ```
484
+ *
485
+ * @example
486
+ * ```ts
487
+ * const [enabled, , setEnabled] = useToggle(true);
488
+ * setEnabled(false);
489
+ * ```
490
+ */
106
491
  declare const useToggle: (initialState?: boolean) => readonly [boolean, () => void, react.Dispatch<react.SetStateAction<boolean>>];
107
492
 
493
+ /**
494
+ * Wraps `useState` and returns the state value as an object with a `set` method.
495
+ *
496
+ * @template T State value type.
497
+ * @param defaults Initial state value or lazy initializer.
498
+ * @returns Object containing the current value and setter.
499
+ *
500
+ * @example
501
+ * ```ts
502
+ * const counter = useValue(0);
503
+ * counter.set(1);
504
+ * ```
505
+ *
506
+ * @example
507
+ * ```ts
508
+ * const user = useValue(() => ({ name: 'Ann' }));
509
+ * user.value.name;
510
+ * ```
511
+ */
108
512
  declare const useValue: <T>(defaults: T | (() => T)) => {
109
513
  value: T;
110
514
  set: react.Dispatch<react.SetStateAction<T>>;
111
515
  };
112
516
 
517
+ /**
518
+ * Tracks `document.visibilityState` and updates when the page visibility changes.
519
+ *
520
+ * @returns Current document visibility state.
521
+ *
522
+ * @example
523
+ * ```ts
524
+ * const visibility = useVisibilityState();
525
+ * ```
526
+ *
527
+ * @example
528
+ * ```ts
529
+ * const isHidden = useVisibilityState() === 'hidden';
530
+ * ```
531
+ */
113
532
  declare const useVisibilityState: () => DocumentVisibilityState | undefined;
114
533
 
115
534
  export { attachRefs, createUseInstanceHook, useAbortController, useAbortSignal, useClickOutside, useConstant, useDefineRef, useElementRef, useEvent, useEventListener, useFlag, useForceUpdate, useInitialHeight, useInstance, useIntersectionObserver, useLastDefinedValue, useLastValueRef, useLifeCycle, useResizeObserver, useSyncRef, useToggle, useValue, useVisibilityState };