@xstate/react 7.0.0-alpha.3 → 7.0.0-alpha.5

package/README.md

@@ -49,4 +49,4 @@ export const Toggler = () => {
 
 <!-- observer lifecycle from src/useActorRef.ts -->
 
-Pass a snapshot listener or observer as the third argument to `useActorRef(logic, options, observer)`. It subscribes before the actor starts. When changing the machine configuration replaces the actor, the observer follows the replacement, even when the callback identity stays the same. Unmounting unsubscribes the observer and stops the actor.
+Pass a snapshot listener or observer as the third argument to `useActorRef(logic, options, observer)`. It subscribes before the actor starts. When the hook replaces the actor (after an external stop, or a Fast Refresh that cannot keep it), the observer follows the replacement, even when the callback identity stays the same. Unmounting unsubscribes the observer and stops the actor.

package/dist/declarations/src/createActorContext.d.ts

@@ -6,8 +6,6 @@ export declare function createActorContext<TLogic extends AnyActorLogic>(actorLo
     Provider: (props: {
         children: React.ReactNode;
         options?: ActorOptions<TLogic>;
-        /** @deprecated Use `logic` instead. */
-        machine?: never;
         logic?: TLogic;
     }) => React.ReactElement<any, any>;
 };

package/dist/declarations/src/useActor.d.ts

@@ -1,6 +1,4 @@
-import { Actor, ActorOptions, AnyActorLogic, SnapshotFrom, type ConditionalRequired, type IsNotNever, type RequiredActorOptionsKeys } from 'xstate';
+import { Actor, ActorOptions, AnyActorLogic, SnapshotFrom, type ConditionalRequired, type IsNotNever, type RequiredActorOptionsKeys, type RequiredActorOptionsFor } from 'xstate';
 export declare function useActor<TLogic extends AnyActorLogic>(logic: TLogic, ...[options]: ConditionalRequired<[
-    options?: ActorOptions<TLogic> & {
-        [K in RequiredActorOptionsKeys<TLogic>]: unknown;
-    }
+    options?: ActorOptions<TLogic> & RequiredActorOptionsFor<TLogic>
 ], IsNotNever<RequiredActorOptionsKeys<TLogic>>>): [SnapshotFrom<TLogic>, Actor<TLogic>['send'], Actor<TLogic>];

package/dist/declarations/src/useActorRef.d.ts

@@ -1,14 +1,10 @@
-import { Actor, ActorOptions, AnyActorLogic, Observer, SnapshotFrom, type ConditionalRequired, type IsNotNever, type RequiredActorOptionsKeys } from 'xstate';
+import { Actor, ActorOptions, AnyActorLogic, Observer, SnapshotFrom, type ConditionalRequired, type IsNotNever, type RequiredActorOptionsKeys, type RequiredActorOptionsFor } from 'xstate';
 export declare function useIdleActorRef<TLogic extends AnyActorLogic>(logic: TLogic, ...[options]: ConditionalRequired<[
-    options?: ActorOptions<TLogic> & {
-        [K in RequiredActorOptionsKeys<TLogic>]: unknown;
-    }
+    options?: ActorOptions<TLogic> & RequiredActorOptionsFor<TLogic>
 ], IsNotNever<RequiredActorOptionsKeys<TLogic>>>): [Actor<TLogic>, (actorRef: Actor<TLogic>) => void];
 export declare function useActorLifecycle<TLogic extends AnyActorLogic>(actorRef: Actor<TLogic>, setActorRef: (actorRef: Actor<TLogic>) => void, createReplacement: () => Actor<TLogic>): void;
 export declare function useActorRef<TLogic extends AnyActorLogic>(machine: TLogic, ...[options, observerOrListener]: IsNotNever<RequiredActorOptionsKeys<TLogic>> extends true ? [
-    options: ActorOptions<TLogic> & {
-        [K in RequiredActorOptionsKeys<TLogic>]: unknown;
-    },
+    options: ActorOptions<TLogic> & RequiredActorOptionsFor<TLogic>,
     observerOrListener?: Observer<SnapshotFrom<TLogic>> | ((value: SnapshotFrom<TLogic>) => void)
 ] : [
     options?: ActorOptions<TLogic>,

package/dist/declarations/src/useMachine.d.ts

@@ -1,7 +1,5 @@
-import { Actor, ActorOptions, AnyStateMachine, StateFrom, type ConditionalRequired, type IsNotNever, type RequiredActorOptionsKeys } from 'xstate';
+import { Actor, ActorOptions, AnyStateMachine, StateFrom, type ConditionalRequired, type IsNotNever, type RequiredActorOptionsKeys, type RequiredActorOptionsFor } from 'xstate';
 /** @alias useActor */
 export declare function useMachine<TMachine extends AnyStateMachine>(machine: TMachine, ...[options]: ConditionalRequired<[
-    options?: ActorOptions<TMachine> & {
-        [K in RequiredActorOptionsKeys<TMachine>]: unknown;
-    }
+    options?: ActorOptions<TMachine> & RequiredActorOptionsFor<TMachine>
 ], IsNotNever<RequiredActorOptionsKeys<TMachine>>>): [StateFrom<TMachine>, Actor<TMachine>['send'], Actor<TMachine>];

package/dist/xstate-react.cjs.js

@@ -32,23 +32,28 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var useIsomorphicLayoutEffect__default = /*#__PURE__*/_interopDefault(useIsomorphicLayoutEffect);
 
 function useIdleActorRef(logic, ...[options]) {
-  let [actorRef, setActorRef] = React.useState(() => {
+  const [actorRef, setActorRef] = React.useState(() => {
     return xstate.createActor(logic, options);
   });
-  if (logic.config !== actorRef.logic.config) {
-    const newActorRef = xstate.createActor(logic, {
-      ...options,
-      snapshot: actorRef.getPersistedSnapshot({
-        __unsafeAllowInlineActors: true
-      })
-    });
-    setActorRef(newActorRef);
-    actorRef = newActorRef;
-  }
+  // An object whose identity changes only when React Fast Refresh re-renders
+  // this component. Fast Refresh ignores dependency lists while it applies an
+  // update, so a `useMemo` with no dependencies recomputes during a refresh
+  // and at no other time.
+  const refreshSignal = React.useMemo(() => ({}), []);
+  const refreshSignalRef = React.useRef(refreshSignal);
 
+  // The logic passed on the first render is used for the hook's lifetime.
+  // Later renders only contribute implementations provided with
+  // `machine.provide()` for the same machine config.
   // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
   useIsomorphicLayoutEffect__default["default"](() => {
-    actorRef.logic.sources = logic.sources;
+    const currentLogic = actorRef.logic;
+    refreshSignalRef.current !== refreshSignal;
+    refreshSignalRef.current = refreshSignal;
+    if (logic.config === currentLogic.config) {
+      currentLogic.sources = logic.sources;
+      return;
+    }
   });
   return [actorRef, setActorRef];
 }
@@ -92,12 +97,12 @@ function useActorRef(machine, ...[options, observerOrListener]) {
     if (!observerOrListener) {
       return;
     }
-    const sub = actorRef.subscribe(xstate.toObserver(observerOrListener));
+    const sub = actorRef.subscribe(xstate._toObserver(observerOrListener));
     return () => {
       sub.unsubscribe();
     };
   }, [actorRef, observerOrListener]);
-  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(machine, actorRef.options));
+  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(actorRef.logic, actorRef.options));
   return actorRef;
 }
 
@@ -134,12 +139,8 @@ function createActorContext(actorLogic, actorOptions) {
   function Provider({
     children,
     logic: providedLogic = actorLogic,
-    machine,
     options: providedOptions
   }) {
-    if (machine) {
-      throw new Error(`The "machine" prop has been deprecated. Please use "logic" instead.`);
-    }
     const actor = useActorRef(providedLogic, {
       ...actorOptions,
       ...providedOptions
@@ -213,7 +214,7 @@ function useActor(logic, ...[options]) {
   if (snapshotWithStatus?.status === 'error') {
     throw snapshotWithStatus.error;
   }
-  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(logic, options));
+  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(actorRef.logic, options));
   return [actorSnapshot, actorRef.send, actorRef];
 }
 

package/dist/xstate-react.development.cjs.js

@@ -32,23 +32,37 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var useIsomorphicLayoutEffect__default = /*#__PURE__*/_interopDefault(useIsomorphicLayoutEffect);
 
 function useIdleActorRef(logic, ...[options]) {
-  let [actorRef, setActorRef] = React.useState(() => {
+  const [actorRef, setActorRef] = React.useState(() => {
     return xstate.createActor(logic, options);
   });
-  if (logic.config !== actorRef.logic.config) {
-    const newActorRef = xstate.createActor(logic, {
-      ...options,
-      snapshot: actorRef.getPersistedSnapshot({
-        __unsafeAllowInlineActors: true
-      })
-    });
-    setActorRef(newActorRef);
-    actorRef = newActorRef;
-  }
+  // An object whose identity changes only when React Fast Refresh re-renders
+  // this component. Fast Refresh ignores dependency lists while it applies an
+  // update, so a `useMemo` with no dependencies recomputes during a refresh
+  // and at no other time.
+  const refreshSignal = React.useMemo(() => ({}), []);
+  const refreshSignalRef = React.useRef(refreshSignal);
 
+  // The logic passed on the first render is used for the hook's lifetime.
+  // Later renders only contribute implementations provided with
+  // `machine.provide()` for the same machine config.
   // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
   useIsomorphicLayoutEffect__default["default"](() => {
-    actorRef.logic.sources = logic.sources;
+    const currentLogic = actorRef.logic;
+    const refreshed = refreshSignalRef.current !== refreshSignal;
+    refreshSignalRef.current = refreshSignal;
+    if (logic.config === currentLogic.config) {
+      currentLogic.sources = logic.sources;
+      return;
+    }
+
+    // Development hot reloading: Fast Refresh re-evaluated the module that
+    // defines the machine. Keep the running actor and carry its live snapshot
+    // over to the new machine; start a fresh actor if it cannot be carried.
+    if (refreshed) {
+      if (!xstate._hotSwapActorLogic(actorRef, logic)) {
+        setActorRef(xstate.createActor(logic, options));
+      }
+    }
   });
   return [actorRef, setActorRef];
 }
@@ -92,12 +106,12 @@ function useActorRef(machine, ...[options, observerOrListener]) {
     if (!observerOrListener) {
       return;
     }
-    const sub = actorRef.subscribe(xstate.toObserver(observerOrListener));
+    const sub = actorRef.subscribe(xstate._toObserver(observerOrListener));
     return () => {
       sub.unsubscribe();
     };
   }, [actorRef, observerOrListener]);
-  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(machine, actorRef.options));
+  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(actorRef.logic, actorRef.options));
   return actorRef;
 }
 
@@ -134,12 +148,8 @@ function createActorContext(actorLogic, actorOptions) {
   function Provider({
     children,
     logic: providedLogic = actorLogic,
-    machine,
     options: providedOptions
   }) {
-    if (machine) {
-      throw new Error(`The "machine" prop has been deprecated. Please use "logic" instead.`);
-    }
     const actor = useActorRef(providedLogic, {
       ...actorOptions,
       ...providedOptions
@@ -216,7 +226,7 @@ function useActor(logic, ...[options]) {
   if (snapshotWithStatus?.status === 'error') {
     throw snapshotWithStatus.error;
   }
-  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(logic, options));
+  useActorLifecycle(actorRef, setActorRef, () => xstate.createActor(actorRef.logic, options));
   return [actorSnapshot, actorRef.send, actorRef];
 }
 

package/dist/xstate-react.development.esm.js

@@ -1,28 +1,42 @@
 import * as React from 'react';
-import { useEffect, useState, useRef, useCallback } from 'react';
+import { useEffect, useState, useMemo, useRef, useCallback } from 'react';
 import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect';
-import { toObserver, createActor } from 'xstate';
+import { _toObserver, createActor, _hotSwapActorLogic } from 'xstate';
 import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
 import { useSyncExternalStore } from 'use-sync-external-store/shim';
 
 function useIdleActorRef(logic, ...[options]) {
-  let [actorRef, setActorRef] = useState(() => {
+  const [actorRef, setActorRef] = useState(() => {
     return createActor(logic, options);
   });
-  if (logic.config !== actorRef.logic.config) {
-    const newActorRef = createActor(logic, {
-      ...options,
-      snapshot: actorRef.getPersistedSnapshot({
-        __unsafeAllowInlineActors: true
-      })
-    });
-    setActorRef(newActorRef);
-    actorRef = newActorRef;
-  }
+  // An object whose identity changes only when React Fast Refresh re-renders
+  // this component. Fast Refresh ignores dependency lists while it applies an
+  // update, so a `useMemo` with no dependencies recomputes during a refresh
+  // and at no other time.
+  const refreshSignal = useMemo(() => ({}), []);
+  const refreshSignalRef = useRef(refreshSignal);
 
+  // The logic passed on the first render is used for the hook's lifetime.
+  // Later renders only contribute implementations provided with
+  // `machine.provide()` for the same machine config.
   // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
   useIsomorphicLayoutEffect(() => {
-    actorRef.logic.sources = logic.sources;
+    const currentLogic = actorRef.logic;
+    const refreshed = refreshSignalRef.current !== refreshSignal;
+    refreshSignalRef.current = refreshSignal;
+    if (logic.config === currentLogic.config) {
+      currentLogic.sources = logic.sources;
+      return;
+    }
+
+    // Development hot reloading: Fast Refresh re-evaluated the module that
+    // defines the machine. Keep the running actor and carry its live snapshot
+    // over to the new machine; start a fresh actor if it cannot be carried.
+    if (refreshed) {
+      if (!_hotSwapActorLogic(actorRef, logic)) {
+        setActorRef(createActor(logic, options));
+      }
+    }
   });
   return [actorRef, setActorRef];
 }
@@ -66,12 +80,12 @@ function useActorRef(machine, ...[options, observerOrListener]) {
     if (!observerOrListener) {
       return;
     }
-    const sub = actorRef.subscribe(toObserver(observerOrListener));
+    const sub = actorRef.subscribe(_toObserver(observerOrListener));
     return () => {
       sub.unsubscribe();
     };
   }, [actorRef, observerOrListener]);
-  useActorLifecycle(actorRef, setActorRef, () => createActor(machine, actorRef.options));
+  useActorLifecycle(actorRef, setActorRef, () => createActor(actorRef.logic, actorRef.options));
   return actorRef;
 }
 
@@ -108,12 +122,8 @@ function createActorContext(actorLogic, actorOptions) {
   function Provider({
     children,
     logic: providedLogic = actorLogic,
-    machine,
     options: providedOptions
   }) {
-    if (machine) {
-      throw new Error(`The "machine" prop has been deprecated. Please use "logic" instead.`);
-    }
     const actor = useActorRef(providedLogic, {
       ...actorOptions,
       ...providedOptions
@@ -190,7 +200,7 @@ function useActor(logic, ...[options]) {
   if (snapshotWithStatus?.status === 'error') {
     throw snapshotWithStatus.error;
   }
-  useActorLifecycle(actorRef, setActorRef, () => createActor(logic, options));
+  useActorLifecycle(actorRef, setActorRef, () => createActor(actorRef.logic, options));
   return [actorSnapshot, actorRef.send, actorRef];
 }
 

package/dist/xstate-react.esm.js

@@ -1,28 +1,33 @@
 import * as React from 'react';
-import { useEffect, useState, useRef, useCallback } from 'react';
+import { useEffect, useState, useMemo, useRef, useCallback } from 'react';
 import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect';
-import { toObserver, createActor } from 'xstate';
+import { _toObserver, createActor } from 'xstate';
 import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
 import { useSyncExternalStore } from 'use-sync-external-store/shim';
 
 function useIdleActorRef(logic, ...[options]) {
-  let [actorRef, setActorRef] = useState(() => {
+  const [actorRef, setActorRef] = useState(() => {
     return createActor(logic, options);
   });
-  if (logic.config !== actorRef.logic.config) {
-    const newActorRef = createActor(logic, {
-      ...options,
-      snapshot: actorRef.getPersistedSnapshot({
-        __unsafeAllowInlineActors: true
-      })
-    });
-    setActorRef(newActorRef);
-    actorRef = newActorRef;
-  }
+  // An object whose identity changes only when React Fast Refresh re-renders
+  // this component. Fast Refresh ignores dependency lists while it applies an
+  // update, so a `useMemo` with no dependencies recomputes during a refresh
+  // and at no other time.
+  const refreshSignal = useMemo(() => ({}), []);
+  const refreshSignalRef = useRef(refreshSignal);
 
+  // The logic passed on the first render is used for the hook's lifetime.
+  // Later renders only contribute implementations provided with
+  // `machine.provide()` for the same machine config.
   // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
   useIsomorphicLayoutEffect(() => {
-    actorRef.logic.sources = logic.sources;
+    const currentLogic = actorRef.logic;
+    refreshSignalRef.current !== refreshSignal;
+    refreshSignalRef.current = refreshSignal;
+    if (logic.config === currentLogic.config) {
+      currentLogic.sources = logic.sources;
+      return;
+    }
   });
   return [actorRef, setActorRef];
 }
@@ -66,12 +71,12 @@ function useActorRef(machine, ...[options, observerOrListener]) {
     if (!observerOrListener) {
       return;
     }
-    const sub = actorRef.subscribe(toObserver(observerOrListener));
+    const sub = actorRef.subscribe(_toObserver(observerOrListener));
     return () => {
       sub.unsubscribe();
     };
   }, [actorRef, observerOrListener]);
-  useActorLifecycle(actorRef, setActorRef, () => createActor(machine, actorRef.options));
+  useActorLifecycle(actorRef, setActorRef, () => createActor(actorRef.logic, actorRef.options));
   return actorRef;
 }
 
@@ -108,12 +113,8 @@ function createActorContext(actorLogic, actorOptions) {
   function Provider({
     children,
     logic: providedLogic = actorLogic,
-    machine,
     options: providedOptions
   }) {
-    if (machine) {
-      throw new Error(`The "machine" prop has been deprecated. Please use "logic" instead.`);
-    }
     const actor = useActorRef(providedLogic, {
       ...actorOptions,
       ...providedOptions
@@ -187,7 +188,7 @@ function useActor(logic, ...[options]) {
   if (snapshotWithStatus?.status === 'error') {
     throw snapshotWithStatus.error;
   }
-  useActorLifecycle(actorRef, setActorRef, () => createActor(logic, options));
+  useActorLifecycle(actorRef, setActorRef, () => createActor(actorRef.logic, options));
   return [actorSnapshot, actorRef.send, actorRef];
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xstate/react",
-  "version": "7.0.0-alpha.3",
+  "version": "7.0.0-alpha.5",
   "description": "XState tools for React",
   "keywords": [
     "state",
@@ -54,7 +54,7 @@
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
-    "xstate": "^6.0.0-alpha.59"
+    "xstate": "^6.0.0-alpha.68"
   },
   "peerDependenciesMeta": {
     "xstate": {
@@ -74,7 +74,7 @@
     "react-dom": "^19.0.0",
     "rxjs": "^7.8.1",
     "zod": "^3.25.51",
-    "xstate": "^6.0.0-alpha.59"
+    "xstate": "^6.0.0-alpha.68"
   },
   "scripts": {}
 }