@dxos/react-hooks 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/README.md

@@ -3,4 +3,5 @@
 TypeScript types for DXOS UI and its themes.
 
 Ref
+
 - https://github.com/jaredLunde/react-hook

package/dist/lib/browser/index.mjs

@@ -1,18 +1,48 @@
+// src/index.ts
+import { useComposedRefs } from "@radix-ui/react-compose-refs";
+import { useSize, useScroller } from "mini-virtual-list";
+
 // src/useAsyncEffect.ts
 import { useEffect } from "react";
-var useAsyncEffect = (callback, deps) => {
+var useAsyncEffect = (cb, deps) => {
   useEffect(() => {
-    const t = setTimeout(() => {
-      void callback();
+    const controller = new AbortController();
+    let cleanup;
+    const t = setTimeout(async () => {
+      if (!controller.signal.aborted) {
+        cleanup = await cb(controller);
+      }
     });
-    return () => clearTimeout(t);
-  }, deps);
+    return () => {
+      clearTimeout(t);
+      controller.abort();
+      cleanup?.();
+    };
+  }, deps ?? []);
+};
+
+// src/useAtomState.ts
+import { Atom, useAtomSet, useAtomValue } from "@effect-atom/atom-react";
+import { useMemo, useState } from "react";
+var useAtomState = (initialValue) => {
+  const [atom] = useState(() => Atom.make(initialValue));
+  const value = useAtomValue(atom);
+  const set = useAtomSet(atom);
+  return useMemo(() => ({
+    atom,
+    value,
+    set
+  }), [
+    atom,
+    value,
+    set
+  ]);
 };
 
 // src/useAsyncState.ts
-import { useEffect as useEffect2, useState } from "react";
+import { useEffect as useEffect2, useState as useState2 } from "react";
 var useAsyncState = (cb, deps = []) => {
-  const [value, setValue] = useState();
+  const [value, setValue] = useState2();
   useEffect2(() => {
     let disposed = false;
     const t = setTimeout(async () => {
@@ -33,55 +63,101 @@ var useAsyncState = (cb, deps = []) => {
 };
 
 // src/useControlledState.ts
-import { useEffect as useEffect3, useState as useState2 } from "react";
-var useControlledState = (controlledValue, onChange, ...deps) => {
-  const [value, setValue] = useState2(controlledValue);
-  useEffect3(() => {
-    if (controlledValue !== void 0) {
-      setValue(controlledValue);
+import { useCallback as useCallback2, useEffect as useEffect4, useRef as useRef2, useState as useState4 } from "react";
+
+// src/useDynamicRef.ts
+import { useCallback, useEffect as useEffect3, useRef, useState as useState3 } from "react";
+var useStateWithRef = (valueProp) => {
+  const [value, setValue] = useState3(valueProp);
+  const valueRef = useRef(valueProp);
+  const setter = useCallback((value2) => {
+    if (typeof value2 === "function") {
+      setValue((current) => {
+        valueRef.current = value2(current);
+        return valueRef.current;
+      });
+    } else {
+      valueRef.current = value2;
+      setValue(value2);
     }
+  }, []);
+  return [
+    value,
+    setter,
+    valueRef
+  ];
+};
+var useDynamicRef = (value) => {
+  const valueRef = useRef(value);
+  useEffect3(() => {
+    valueRef.current = value;
   }, [
-    controlledValue,
-    ...deps
+    value
   ]);
-  useEffect3(() => {
-    onChange?.(value);
+  return valueRef;
+};
+
+// src/useControlledState.ts
+var useControlledState = (valueProp, onChange) => {
+  const [value, setControlledValue] = useState4(valueProp);
+  useEffect4(() => {
+    setControlledValue(valueProp);
   }, [
-    value,
-    onChange
+    valueProp
+  ]);
+  const onChangeRef = useRef2(onChange);
+  const valueRef = useDynamicRef(valueProp);
+  const setValue = useCallback2((nextValue) => {
+    const value2 = isFunction(nextValue) ? nextValue(valueRef.current) : nextValue;
+    setControlledValue(value2);
+    onChangeRef.current?.(value2);
+  }, [
+    valueRef,
+    onChangeRef
   ]);
   return [
     value,
     setValue
   ];
 };
+function isFunction(value) {
+  return typeof value === "function";
+}
 
-// src/useDebugReactDeps.ts
-import { useEffect as useEffect4, useRef } from "react";
-var useDebugReactDeps = (deps = []) => {
-  const lastDeps = useRef([]);
-  useEffect4(() => {
-    console.group("deps changed", {
-      old: lastDeps.current.length,
-      new: deps.length
-    });
+// src/useDebugDeps.ts
+import { useEffect as useEffect5, useRef as useRef3 } from "react";
+import { log } from "@dxos/log";
+var useDebugDeps = (deps = [], label = "useDebugDeps", active = true) => {
+  const lastDeps = useRef3([]);
+  useEffect5(() => {
+    if (!active) {
+      return;
+    }
+    const diff = {};
     for (let i = 0; i < Math.max(lastDeps.current.length ?? 0, deps.length ?? 0); i++) {
-      console.log(i, lastDeps.current[i] === deps[i] ? "SAME" : "CHANGED", {
-        previous: lastDeps.current[i],
-        current: deps[i]
-      });
+      if (lastDeps.current[i] !== deps[i] || i > lastDeps.current.length) {
+        diff[i] = {
+          previous: lastDeps.current[i],
+          current: deps[i]
+        };
+      }
+    }
+    if (Object.keys(diff).length > 0) {
+      log.warn(`Updated: ${label} [${lastDeps.current.length}/${deps.length}]`, diff);
     }
-    console.groupEnd();
     lastDeps.current = deps;
-  }, deps);
+  }, [
+    ...deps,
+    active
+  ]);
 };
 
 // src/useDefaultValue.ts
-import { useEffect as useEffect5, useMemo, useState as useState3 } from "react";
+import { useEffect as useEffect6, useMemo as useMemo2, useState as useState5 } from "react";
 var useDefaultValue = (reactiveValue, getDefaultValue) => {
-  const stableDefaultValue = useMemo(getDefaultValue, []);
-  const [value, setValue] = useState3(reactiveValue ?? stableDefaultValue);
-  useEffect5(() => {
+  const stableDefaultValue = useMemo2(getDefaultValue, []);
+  const [value, setValue] = useState5(reactiveValue ?? stableDefaultValue);
+  useEffect6(() => {
     setValue(reactiveValue ?? stableDefaultValue);
   }, [
     reactiveValue,
@@ -92,30 +168,18 @@ var useDefaultValue = (reactiveValue, getDefaultValue) => {
 
 // src/useDefaults.ts
 import defaultsDeep from "lodash.defaultsdeep";
-import { useMemo as useMemo2 } from "react";
+import { useMemo as useMemo3 } from "react";
 var useDefaults = (value, defaults) => {
-  return useMemo2(() => defaultsDeep({}, defaults, value), [
+  return useMemo3(() => defaultsDeep({}, defaults, value), [
     value,
     defaults
   ]);
 };
 
-// src/useDynamicRef.ts
-import { useEffect as useEffect6, useRef as useRef2 } from "react";
-var useDynamicRef = (value) => {
-  const ref = useRef2(value);
-  useEffect6(() => {
-    ref.current = value;
-  }, [
-    value
-  ]);
-  return ref;
-};
-
 // src/useFileDownload.ts
-import { useMemo as useMemo3 } from "react";
+import { useMemo as useMemo4 } from "react";
 var useFileDownload = () => {
-  return useMemo3(() => (data, filename) => {
+  return useMemo4(() => (data, filename) => {
     const url = typeof data === "string" ? data : URL.createObjectURL(data);
     const element = document.createElement("a");
     element.setAttribute("href", url);
@@ -126,38 +190,61 @@ var useFileDownload = () => {
 };
 
 // src/useForwardedRef.ts
-import { useEffect as useEffect7, useRef as useRef3 } from "react";
-var useForwardedRef = (ref) => {
-  const innerRef = useRef3(null);
+import { useEffect as useEffect7, useMemo as useMemo5, useRef as useRef4 } from "react";
+var useForwardedRef = (forwardedRef) => {
+  const localRef = useRef4(null);
   useEffect7(() => {
-    if (!ref) {
-      return;
-    }
-    if (typeof ref === "function") {
-      ref(innerRef.current);
-    } else {
-      ref.current = innerRef.current;
+    setRef(forwardedRef, localRef.current);
+  }, [
+    forwardedRef
+  ]);
+  return localRef;
+};
+function setRef(ref, value) {
+  if (typeof ref === "function") {
+    return ref(value);
+  } else if (ref) {
+    ref.current = value;
+  }
+}
+var mergeRefs = (refs) => {
+  return (value) => {
+    const cleanups = [];
+    for (const ref of refs) {
+      const cleanup = setRef(ref, value);
+      cleanups.push(typeof cleanup === "function" ? cleanup : () => setRef(ref, null));
     }
-  });
-  return innerRef;
+    return () => {
+      for (const cleanup of cleanups) {
+        cleanup();
+      }
+    };
+  };
+};
+var useMergeRefs = (refs) => {
+  return useMemo5(() => mergeRefs(refs), [
+    ...refs
+  ]);
 };
 
 // src/useId.ts
 import alea from "alea";
-import { useMemo as useMemo4 } from "react";
+import { useMemo as useMemo6 } from "react";
 var Alea = alea;
 var prng = new Alea("@dxos/react-hooks");
 var randomString = (n = 4) => prng().toString(16).slice(2, n + 2);
-var useId = (namespace, propsId, opts) => useMemo4(() => makeId(namespace, propsId, opts), [
-  propsId
-]);
+var useId = (namespace, propsId, opts) => {
+  return useMemo6(() => makeId(namespace, propsId, opts), [
+    propsId
+  ]);
+};
 var makeId = (namespace, propsId, opts) => propsId ?? `${namespace}-${randomString(opts?.n ?? 4)}`;
 
 // src/useIsFocused.ts
-import { useEffect as useEffect8, useRef as useRef4, useState as useState4 } from "react";
+import { useEffect as useEffect8, useRef as useRef5, useState as useState6 } from "react";
 var useIsFocused = (inputRef) => {
-  const [isFocused, setIsFocused] = useState4(void 0);
-  const isFocusedRef = useRef4(isFocused);
+  const [isFocused, setIsFocused] = useState6(void 0);
+  const isFocusedRef = useRef5(isFocused);
   isFocusedRef.current = isFocused;
   useEffect8(() => {
     const input = inputRef.current;
@@ -183,7 +270,7 @@ var useIsFocused = (inputRef) => {
 };
 
 // src/useMediaQuery.ts
-import { useEffect as useEffect9, useState as useState5 } from "react";
+import { useEffect as useEffect9, useState as useState7 } from "react";
 var breakpointMediaQueries = {
   sm: "(min-width: 640px)",
   md: "(min-width: 768px)",
@@ -192,7 +279,7 @@ var breakpointMediaQueries = {
   "2xl": "(min-width: 1536px)"
 };
 var useMediaQuery = (query, options = {}) => {
-  const { ssr = true, fallback } = options;
+  const { ssr = false, fallback } = options;
   const queries = (Array.isArray(query) ? query : [
     query
   ]).map((query2) => query2 in breakpointMediaQueries ? breakpointMediaQueries[query2] : query2);
@@ -200,7 +287,7 @@ var useMediaQuery = (query, options = {}) => {
     fallback
   ];
   fallbackValues = fallbackValues.filter((v) => v != null);
-  const [value, setValue] = useState5(() => {
+  const [value, setValue] = useState7(() => {
     return queries.map((query2, index) => ({
       media: query2,
       matches: ssr ? !!fallbackValues[index] : document.defaultView?.matchMedia(query2).matches
@@ -248,9 +335,9 @@ var useMediaQuery = (query, options = {}) => {
 };
 
 // src/useMulticastObservable.ts
-import { useMemo as useMemo5, useSyncExternalStore } from "react";
+import { useMemo as useMemo7, useSyncExternalStore } from "react";
 var useMulticastObservable = (observable) => {
-  const subscribeFn = useMemo5(() => (listener) => {
+  const subscribeFn = useMemo7(() => (listener) => {
     const subscription = observable.subscribe(listener);
     return () => subscription.unsubscribe();
   }, [
@@ -260,44 +347,62 @@ var useMulticastObservable = (observable) => {
 };
 
 // src/useRefCallback.ts
-import { useState as useState6 } from "react";
+import { useState as useState8 } from "react";
 var useRefCallback = () => {
-  const [value, setValue] = useState6(null);
+  const [value, setValue] = useState8(null);
   return {
     refCallback: (value2) => setValue(value2),
     value
   };
 };
 
-// src/useResize.ts
-import { useLayoutEffect, useMemo as useMemo6 } from "react";
-var useResize = (handler, deps = [], delay = 800) => {
-  const debouncedHandler = useMemo6(() => {
+// src/useViewportResize.ts
+import { useLayoutEffect, useMemo as useMemo8 } from "react";
+var useViewportResize = (cb, deps = [], delay = 800) => {
+  const { handler: debouncedHandler, cancel } = useMemo8(() => {
     let timeout;
-    return (event) => {
-      clearTimeout(timeout);
-      timeout = setTimeout(() => {
-        handler(event);
-      }, delay);
+    return {
+      handler: (event) => {
+        if (timeout !== void 0) {
+          clearTimeout(timeout);
+        }
+        timeout = setTimeout(() => {
+          timeout = void 0;
+          if (typeof document === "undefined" || typeof getComputedStyle === "undefined") {
+            return;
+          }
+          cb(event);
+        }, delay);
+      },
+      cancel: () => {
+        if (timeout !== void 0) {
+          clearTimeout(timeout);
+          timeout = void 0;
+        }
+      }
     };
   }, [
-    handler,
+    cb,
     delay
   ]);
   return useLayoutEffect(() => {
     window.visualViewport?.addEventListener("resize", debouncedHandler);
     debouncedHandler();
-    return () => window.visualViewport?.removeEventListener("resize", debouncedHandler);
+    return () => {
+      window.visualViewport?.removeEventListener("resize", debouncedHandler);
+      cancel();
+    };
   }, [
     debouncedHandler,
+    cancel,
     ...deps
   ]);
 };
 
 // src/useTimeout.ts
-import { useEffect as useEffect10, useRef as useRef5 } from "react";
+import { useEffect as useEffect10, useRef as useRef6 } from "react";
 var useTimeout = (callback, delay = 0, deps = []) => {
-  const callbackRef = useRef5(callback);
+  const callbackRef = useRef6(callback);
   useEffect10(() => {
     callbackRef.current = callback;
   }, [
@@ -307,57 +412,48 @@ var useTimeout = (callback, delay = 0, deps = []) => {
     if (delay == null) {
       return;
     }
-    const timeout = setTimeout(() => callbackRef.current?.(), delay);
-    return () => clearTimeout(timeout);
+    const t = setTimeout(() => callbackRef.current?.(), delay);
+    return () => clearTimeout(t);
   }, [
     delay,
     ...deps
   ]);
 };
-
-// src/useTrackProps.ts
-import { useEffect as useEffect11, useRef as useRef6 } from "react";
-import { log } from "@dxos/log";
-var __dxlog_file = "/__w/dxos/dxos/packages/ui/primitives/react-hooks/src/useTrackProps.ts";
-var useTrackProps = (props, componentName = "Component", active = true) => {
-  const prevProps = useRef6(props);
-  useEffect11(() => {
-    const changes = Object.entries(props).filter(([key]) => props[key] !== prevProps.current[key]);
-    if (changes.length > 0) {
-      if (active) {
-        log.info("props changed", {
-          componentName,
-          keys: changes.map(([key]) => key).join(","),
-          props: Object.fromEntries(changes.map(([key]) => [
-            key,
-            {
-              from: prevProps.current[key],
-              to: props[key]
-            }
-          ]))
-        }, {
-          F: __dxlog_file,
-          L: 22,
-          S: void 0,
-          C: (f, a) => f(...a)
-        });
-      }
+var useInterval = (callback, delay = 0, deps = []) => {
+  const callbackRef = useRef6(callback);
+  useEffect10(() => {
+    callbackRef.current = callback;
+  }, [
+    callback
+  ]);
+  useEffect10(() => {
+    if (delay == null) {
+      return;
     }
-    prevProps.current = props;
-  });
+    const i = setInterval(async () => {
+      const result = await callbackRef.current?.();
+      if (result === false) {
+        clearInterval(i);
+      }
+    }, delay);
+    return () => clearInterval(i);
+  }, [
+    delay,
+    ...deps
+  ]);
 };
 
 // src/useTransitions.ts
-import { useEffect as useEffect12, useRef as useRef7, useState as useState7 } from "react";
-var isFunction = (functionToCheck) => {
+import { useEffect as useEffect11, useRef as useRef7, useState as useState9 } from "react";
+var isFunction2 = (functionToCheck) => {
   return functionToCheck instanceof Function;
 };
 var useDidTransition = (currentValue, fromValue, toValue) => {
-  const [hasTransitioned, setHasTransitioned] = useState7(false);
+  const [hasTransitioned, setHasTransitioned] = useState9(false);
   const previousValue = useRef7(currentValue);
-  useEffect12(() => {
-    const toValueValid = isFunction(toValue) ? toValue(currentValue) : toValue === currentValue;
-    const fromValueValid = isFunction(fromValue) ? fromValue(previousValue.current) : fromValue === previousValue.current;
+  useEffect11(() => {
+    const toValueValid = isFunction2(toValue) ? toValue(currentValue) : toValue === currentValue;
+    const fromValueValid = isFunction2(fromValue) ? fromValue(previousValue.current) : fromValue === previousValue.current;
     if (fromValueValid && toValueValid && !hasTransitioned) {
       setHasTransitioned(true);
     } else if ((!fromValueValid || !toValueValid) && hasTransitioned) {
@@ -375,13 +471,13 @@ var useDidTransition = (currentValue, fromValue, toValue) => {
 var useOnTransition = (currentValue, fromValue, toValue, callback) => {
   const dirty = useRef7(false);
   const hasTransitioned = useDidTransition(currentValue, fromValue, toValue);
-  useEffect12(() => {
+  useEffect11(() => {
     dirty.current = false;
   }, [
     currentValue,
     dirty
   ]);
-  useEffect12(() => {
+  useEffect11(() => {
     if (hasTransitioned && !dirty.current) {
       callback();
       dirty.current = true;
@@ -394,11 +490,15 @@ var useOnTransition = (currentValue, fromValue, toValue, callback) => {
 };
 export {
   makeId,
+  mergeRefs,
   randomString,
+  setRef,
   useAsyncEffect,
   useAsyncState,
+  useAtomState,
+  useComposedRefs,
   useControlledState,
-  useDebugReactDeps,
+  useDebugDeps,
   useDefaultValue,
   useDefaults,
   useDidTransition,
@@ -406,13 +506,17 @@ export {
   useFileDownload,
   useForwardedRef,
   useId,
+  useInterval,
   useIsFocused,
   useMediaQuery,
+  useMergeRefs,
   useMulticastObservable,
   useOnTransition,
   useRefCallback,
-  useResize,
+  useScroller,
+  useSize,
+  useStateWithRef,
   useTimeout,
-  useTrackProps
+  useViewportResize
 };
 //# sourceMappingURL=index.mjs.map