@dxos/react-hooks 0.8.4-main.c1de068 → 0.8.4-main.e098934

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-hooks",
-  "version": "0.8.4-main.c1de068",
+  "version": "0.8.4-main.e098934",
   "description": "React hooks supporting DXOS React primitives.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,6 +10,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
@@ -27,8 +28,8 @@
     "@preact-signals/safe-react": "^0.9.0",
     "alea": "^1.0.1",
     "lodash.defaultsdeep": "^4.6.1",
-    "@dxos/async": "0.8.4-main.c1de068",
-    "@dxos/log": "0.8.4-main.c1de068"
+    "@dxos/async": "0.8.4-main.e098934",
+    "@dxos/log": "0.8.4-main.e098934"
   },
   "devDependencies": {
     "@types/lodash.defaultsdeep": "^4.6.6",

package/src/index.ts

@@ -5,7 +5,7 @@
 export * from './useAsyncEffect';
 export * from './useAsyncState';
 export * from './useControlledState';
-export * from './useDebugReactDeps';
+export * from './useDebugDeps';
 export * from './useDefaultValue';
 export * from './useDefaults';
 export * from './useDynamicRef';
@@ -17,6 +17,7 @@ export * from './useMediaQuery';
 export * from './useMulticastObservable';
 export * from './useRefCallback';
 export * from './useResize';
+export * from './useSignals';
 export * from './useTimeout';
 export * from './useTrackProps';
 export * from './useTransitions';

package/src/useAsyncEffect.stories.tsx

@@ -0,0 +1,34 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import '@dxos-theme';
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useState } from 'react';
+
+import { sleep } from '@dxos/async';
+
+import { useAsyncEffect } from './useAsyncEffect';
+
+const meta = {
+  title: 'ui/react-hooks/useAsyncEffect',
+} satisfies Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  render: () => {
+    const [value, setValue] = useState(0);
+    useAsyncEffect(async (controller) => {
+      await sleep(100);
+      if (!controller.signal.aborted) {
+        setValue((value) => value + 1);
+      }
+    }, []);
+
+    return <div>{value}</div>;
+  },
+};

package/src/useAsyncEffect.ts

@@ -2,61 +2,31 @@
 // Copyright 2022 DXOS.org
 //
 
-import { useEffect } from 'react';
-
-import { log } from '@dxos/log';
+import { type DependencyList, type EffectCallback, useEffect } from 'react';
 
 /**
- * Process async event with optional non-async destructor.
- * Inspired by: https://github.com/rauldeheer/use-async-effect/blob/master/index.js
- *
- * ```tsx
- * useAsyncEffect(async () => {
- *   await test();
- * }, []);
- * ```
- *
- * The callback may check of the component is still mounted before doing state updates.
- *
- * ```tsx
- * const [value, setValue] = useState<string>();
- * useAsyncEffect<string>(async (isMounted) => {
- *   const value = await test();
- *   if (!isMounted()) {
- *     setValue(value);
- *   }
- * }, () => console.log('Unmounted'), []);
- * ```
- *
- * @param callback Receives a getter function that determines if the component is still mounted.
- * @param destructor Receives the value returned from the callback.
- * @param deps
- *
- * NOTE: This effect does not cancel the async operation if the component is unmounted.
- *
- * @deprecated Use useTimeout.
+ * Async version of useEffect.
+ * The `AbortController` can be used to detect if the component has been unmounted and
+ * can be used to propagate abort signals to downstream async operations (e.g., `fetch`).
  */
-export const useAsyncEffect = <T>(
-  callback: (isMounted: () => boolean) => Promise<T> | undefined,
-  destructor?: ((value?: T) => void) | any[],
-  deps?: any[],
+export const useAsyncEffect = (
+  cb: (controller: AbortController) => Promise<EffectCallback | void>,
+  deps?: DependencyList,
 ) => {
-  const [effectDestructor, effectDeps] =
-    typeof destructor === 'function' ? [destructor, deps] : [undefined, destructor];
-
   useEffect(() => {
-    let mounted = true;
-    let value: T | undefined;
-    const asyncResult = callback(() => mounted);
-    void Promise.resolve(asyncResult)
-      .then((result) => {
-        value = result;
-      })
-      .catch(log.catch);
+    const controller = new AbortController();
+    let cleanup: EffectCallback | void;
+    // NOTE: Timeout enables us to immediately cancel. if the component is unmounted.
+    const t = setTimeout(async () => {
+      if (!controller.signal.aborted) {
+        cleanup = await cb(controller);
+      }
+    });
 
     return () => {
-      mounted = false;
-      effectDestructor?.(value);
+      clearTimeout(t);
+      controller.abort();
+      cleanup?.();
     };
-  }, effectDeps);
+  }, deps ?? []);
 };

package/src/useControlledState.ts

@@ -6,6 +6,7 @@ import { type Dispatch, type SetStateAction, useEffect, useState } from 'react';
 
 /**
  * A stateful hook with a controlled value.
+ * NOTE: Be careful not to provide an inlinde default array.
  */
 export const useControlledState = <T>(
   controlledValue: T,

package/src/useDebugDeps.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type DependencyList, useEffect, useRef } from 'react';
+
+/**
+ * Util to log deps that have changed.
+ */
+export const useDebugDeps = (deps: DependencyList = []) => {
+  const lastDeps = useRef<DependencyList>([]);
+  useEffect(() => {
+    console.group('deps changed', { previous: lastDeps.current.length, current: deps.length });
+    for (let i = 0; i < Math.max(lastDeps.current.length ?? 0, deps.length ?? 0); i++) {
+      if (lastDeps.current[i] !== deps[i]) {
+        console.log('changed', {
+          index: i,
+          previous: lastDeps.current[i],
+          current: deps[i],
+        });
+      }
+    }
+    console.groupEnd();
+    lastDeps.current = deps;
+  }, deps);
+};

package/src/useDefaultValue.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { useEffect, useState, useMemo } from 'react';
+import { useEffect, useMemo, useState } from 'react';
 
 /**
  * A custom React hook that provides a stable default value for a potentially undefined reactive value.

package/src/useDynamicRef.ts

@@ -2,16 +2,38 @@
 // Copyright 2024 DXOS.org
 //
 
-import { useEffect, useRef } from 'react';
+import { useCallback } from '@preact-signals/safe-react/react';
+import { type Dispatch, type MutableRefObject, type SetStateAction, useEffect, useRef, useState } from 'react';
+
+/**
+ * Like `useState` but with an additional dynamic value.
+ */
+export const useStateWithRef = <T>(value$: T): [T, Dispatch<SetStateAction<T>>, MutableRefObject<T>] => {
+  const [value, setValue] = useState<T>(value$);
+  const valueRef = useRef<T>(value$);
+  const setter = useCallback<Dispatch<SetStateAction<T>>>((value) => {
+    if (typeof value === 'function') {
+      setValue((current) => {
+        valueRef.current = (value as Function)(current);
+        return valueRef.current;
+      });
+    } else {
+      valueRef.current = value;
+      setValue(value);
+    }
+  }, []);
+
+  return [value, setter, valueRef];
+};
 
 /**
  * Ref that is updated by a dependency.
  */
-export const useDynamicRef = <T>(value: T) => {
-  const ref = useRef<T>(value);
+export const useDynamicRef = <T>(value: T): MutableRefObject<T> => {
+  const valueRef = useRef<T>(value);
   useEffect(() => {
-    ref.current = value;
+    valueRef.current = value;
   }, [value]);
 
-  return ref;
+  return valueRef;
 };

package/src/useForwardedRef.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { type ForwardedRef, useRef, useEffect } from 'react';
+import { type ForwardedRef, useEffect, useRef } from 'react';
 
 /**
  * Combines a possibly undefined forwarded ref with a locally defined ref.

package/src/useIsFocused.ts

@@ -5,7 +5,7 @@
 // Based upon the useIsFocused hook which is part of the `rci` project:
 /// https://github.com/leonardodino/rci/blob/main/packages/use-is-focused
 
-import { useEffect, useRef, useState, type RefObject } from 'react';
+import { type RefObject, useEffect, useRef, useState } from 'react';
 
 export const useIsFocused = (inputRef: RefObject<HTMLInputElement>) => {
   const [isFocused, setIsFocused] = useState<boolean | undefined>(undefined);

package/src/useSignals.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { computed, effect } from '@preact-signals/safe-react';
+import { useRef } from '@preact-signals/safe-react/react';
+import { type DependencyList, useEffect, useMemo } from 'react';
+
+/**
+ * Like `useEffect` but also tracks signals inside of the callback.
+ */
+export const useSignalsEffect = (cb: () => void | (() => void), deps?: DependencyList) => {
+  const callback = useRef(cb);
+  callback.current = cb;
+  useEffect(() => {
+    return effect(() => {
+      return callback.current();
+    });
+  }, deps ?? []);
+};
+
+/**
+ * Like `useMemo` but also tracks signals inside of the callback.
+ */
+export const useSignalsMemo = <T>(cb: () => T, deps?: DependencyList) => {
+  return useMemo(() => computed(cb), deps ?? []).value;
+};

package/src/useTimeout.ts

@@ -4,7 +4,7 @@
 
 import { useEffect, useRef } from 'react';
 
-export const useTimeout = (callback: (() => Promise<void>) | undefined, delay = 0, deps: any[] = []) => {
+export const useTimeout = (callback?: () => Promise<void>, delay = 0, deps: any[] = []) => {
   const callbackRef = useRef(callback);
   useEffect(() => {
     callbackRef.current = callback;
@@ -15,7 +15,32 @@ export const useTimeout = (callback: (() => Promise<void>) | undefined, delay =
       return;
     }
 
-    const timeout = setTimeout(() => callbackRef.current?.(), delay);
-    return () => clearTimeout(timeout);
+    const t = setTimeout(() => callbackRef.current?.(), delay);
+    return () => clearTimeout(t);
+  }, [delay, ...deps]);
+};
+
+export const useInterval = (
+  callback?: (() => Promise<void | boolean>) | (() => void | boolean),
+  delay = 0,
+  deps: any[] = [],
+) => {
+  const callbackRef = useRef(callback);
+  useEffect(() => {
+    callbackRef.current = callback;
+  }, [callback]);
+
+  useEffect(() => {
+    if (delay == null) {
+      return;
+    }
+
+    const i = setInterval(async () => {
+      const result = await callbackRef.current?.();
+      if (result === false) {
+        clearInterval(i);
+      }
+    }, delay);
+    return () => clearInterval(i);
   }, [delay, ...deps]);
 };

package/src/useTrackProps.ts

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useRef, useEffect } from 'react';
+import { useEffect, useRef } from 'react';
 
 import { log } from '@dxos/log';
 

package/src/useTransitions.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { useRef, useEffect, useState } from 'react';
+import { useEffect, useRef, useState } from 'react';
 
 const isFunction = <T>(functionToCheck: any): functionToCheck is (value: T) => boolean => {
   return functionToCheck instanceof Function;

package/dist/types/src/useAsyncEffect.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=useAsyncEffect.test.d.ts.map

package/dist/types/src/useAsyncEffect.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAsyncEffect.test.d.ts","sourceRoot":"","sources":["../../../src/useAsyncEffect.test.tsx"],"names":[],"mappings":""}

package/dist/types/src/useDebugReactDeps.d.ts

@@ -1,6 +0,0 @@
-import { type DependencyList } from 'react';
-/**
- * Util to log deps that have changed.
- */
-export declare const useDebugReactDeps: (deps?: DependencyList) => void;
-//# sourceMappingURL=useDebugReactDeps.d.ts.map

package/dist/types/src/useDebugReactDeps.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useDebugReactDeps.d.ts","sourceRoot":"","sources":["../../../src/useDebugReactDeps.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,cAAc,EAAqB,MAAM,OAAO,CAAC;AAE/D;;GAEG;AAEH,eAAO,MAAM,iBAAiB,GAAI,OAAM,cAAmB,SAc1D,CAAC"}

package/src/useAsyncEffect.test.tsx

@@ -1,51 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import React, { useState } from 'react';
-import { createRoot } from 'react-dom/client';
-import { act } from 'react-dom/test-utils';
-import { afterEach, beforeEach, describe, expect, test } from 'vitest';
-
-import { useAsyncEffect } from './useAsyncEffect';
-
-const doAsync = async <T,>(value: T) =>
-  await new Promise<T>((resolve) => {
-    resolve(value);
-  });
-
-const Test = () => {
-  const [value, setValue] = useState<string>();
-  useAsyncEffect(async (isMounted) => {
-    const value = await doAsync('DXOS');
-    if (isMounted()) {
-      void act(() => {
-        setValue(value);
-      });
-    }
-  }, []);
-
-  return <h1>{value}</h1>;
-};
-
-let rootContainer: HTMLElement;
-
-describe('useAsyncEffect', () => {
-  beforeEach(() => {
-    rootContainer = document.createElement('div');
-    document.body.appendChild(rootContainer);
-  });
-
-  afterEach(() => {
-    document.body.removeChild(rootContainer!);
-  });
-
-  test('gets async value.', async () => {
-    await act(() => {
-      createRoot(rootContainer).render(<Test />);
-    });
-
-    const h1 = rootContainer.querySelector('h1');
-    expect(h1?.textContent).toEqual('DXOS');
-  });
-});

package/src/useDebugReactDeps.ts

@@ -1,27 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-/* eslint-disable no-console */
-
-import { type DependencyList, useEffect, useRef } from 'react';
-
-/**
- * Util to log deps that have changed.
- */
-// TODO(burdon): Move to react-hooks.
-export const useDebugReactDeps = (deps: DependencyList = []) => {
-  const lastDeps = useRef<DependencyList>([]);
-  useEffect(() => {
-    console.group('deps changed', { old: lastDeps.current.length, new: deps.length });
-    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],
-      });
-    }
-
-    console.groupEnd();
-    lastDeps.current = deps;
-  }, deps);
-};