@xstate/react 4.0.0-alpha.2 → 4.0.0-beta.11

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

@@ -0,0 +1,189 @@
+import * as React from 'react';
+import { useEffect, useState, useCallback } from 'react';
+import { useSyncExternalStore } from 'use-sync-external-store/shim';
+import { toObserver, createActor } from 'xstate';
+import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect';
+import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
+
+const forEachActor = (actorRef, callback) => {
+  callback(actorRef);
+  const children = actorRef.getSnapshot().children;
+  if (children) {
+    Object.values(children).forEach(child => {
+      forEachActor(child, callback);
+    });
+  }
+};
+function stopRootWithRehydration(actorRef) {
+  // persist state here in a custom way allows us to persist inline actors and to preserve actor references
+  // we do it to avoid setState in useEffect when the effect gets "reconnected"
+  // this currently only happens in Strict Effects but it simulates the Offscreen aka Activity API
+  // it also just allows us to end up with a somewhat more predictable behavior for the users
+  const persistedSnapshots = [];
+  forEachActor(actorRef, ref => {
+    persistedSnapshots.push([ref, ref.getSnapshot()]);
+    // muting observers allow us to avoid `useSelector` from being notified about the stopped state
+    // React reconnects its subscribers (from the useSyncExternalStore) on its own
+    // and userland subscibers should basically always do the same anyway
+    // as each subscription should have its own cleanup logic and that should be called each such reconnect
+    ref.observers = new Set();
+  });
+  actorRef.stop();
+  persistedSnapshots.forEach(([ref, snapshot]) => {
+    ref._processingStatus = 0;
+    ref._state = snapshot;
+  });
+}
+
+function useIdleActor(logic, options) {
+  let [[currentConfig, actorRef], setCurrent] = useState(() => {
+    const actorRef = createActor(logic, options);
+    return [logic.config, actorRef];
+  });
+  if (logic.config !== currentConfig) {
+    const newActorRef = createActor(logic, {
+      ...options,
+      state: actorRef.getPersistedState({
+        __unsafeAllowInlineActors: true
+      })
+    });
+    setCurrent([logic.config, newActorRef]);
+    actorRef = newActorRef;
+  }
+
+  // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
+  useIsomorphicLayoutEffect(() => {
+    actorRef.logic.implementations = logic.implementations;
+  });
+  return actorRef;
+}
+function useActorRef(machine, options = {}, observerOrListener) {
+  const actorRef = useIdleActor(machine, options);
+  useEffect(() => {
+    if (!observerOrListener) {
+      return;
+    }
+    let sub = actorRef.subscribe(toObserver(observerOrListener));
+    return () => {
+      sub.unsubscribe();
+    };
+  }, [observerOrListener]);
+  useEffect(() => {
+    actorRef.start();
+    return () => {
+      stopRootWithRehydration(actorRef);
+    };
+  }, [actorRef]);
+  return actorRef;
+}
+
+function useActor(logic, options = {}) {
+  if (!!logic && 'send' in logic && typeof logic.send === 'function') {
+    throw new Error(`useActor() expects actor logic (e.g. a machine), but received an ActorRef. Use the useSelector(actorRef, ...) hook instead to read the ActorRef's snapshot.`);
+  }
+  const actorRef = useIdleActor(logic, options);
+  const getSnapshot = useCallback(() => {
+    return actorRef.getSnapshot();
+  }, [actorRef]);
+  const subscribe = useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actorRef.subscribe(handleStoreChange);
+    return unsubscribe;
+  }, [actorRef]);
+  const actorSnapshot = useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+  useEffect(() => {
+    actorRef.start();
+    return () => {
+      stopRootWithRehydration(actorRef);
+    };
+  }, [actorRef]);
+  return [actorSnapshot, actorRef.send, actorRef];
+}
+
+function defaultCompare(a, b) {
+  return a === b;
+}
+function useSelector(actor, selector, compare = defaultCompare) {
+  const subscribe = useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actor.subscribe(handleStoreChange);
+    return unsubscribe;
+  }, [actor]);
+  const boundGetSnapshot = useCallback(() => actor.getSnapshot(), [actor]);
+  const selectedSnapshot = useSyncExternalStoreWithSelector(subscribe, boundGetSnapshot, boundGetSnapshot, selector, compare);
+  return selectedSnapshot;
+}
+
+// From https://github.com/reduxjs/react-redux/blob/720f0ba79236cdc3e1115f4ef9a7760a21784b48/src/utils/shallowEqual.ts
+function is(x, y) {
+  if (x === y) {
+    return x !== 0 || y !== 0 || 1 / x === 1 / y;
+  } else {
+    return x !== x && y !== y;
+  }
+}
+function shallowEqual(objA, objB) {
+  if (is(objA, objB)) return true;
+  if (typeof objA !== 'object' || objA === null || typeof objB !== 'object' || objB === null) {
+    return false;
+  }
+  const keysA = Object.keys(objA);
+  const keysB = Object.keys(objB);
+  if (keysA.length !== keysB.length) return false;
+  for (let i = 0; i < keysA.length; i++) {
+    if (!Object.prototype.hasOwnProperty.call(objB, keysA[i]) || !is(objA[keysA[i]], objB[keysA[i]])) {
+      return false;
+    }
+  }
+  return true;
+}
+
+function createActorContext(actorLogic, interpreterOptions) {
+  const ReactContext = /*#__PURE__*/React.createContext(null);
+  const OriginalProvider = ReactContext.Provider;
+  function Provider({
+    children,
+    logic: providedLogic = actorLogic,
+    machine,
+    options: providedOptions = interpreterOptions
+  }) {
+    if (machine) {
+      throw new Error(`The "machine" prop has been deprecated. Please use "logic" instead.`);
+    }
+    const actor = useActorRef(providedLogic, providedOptions);
+    return /*#__PURE__*/React.createElement(OriginalProvider, {
+      value: actor,
+      children
+    });
+  }
+
+  // TODO: add properties to actor ref to make more descriptive
+  Provider.displayName = `ActorProvider`;
+  function useContext() {
+    const actor = React.useContext(ReactContext);
+    if (!actor) {
+      throw new Error(`You used a hook from "${Provider.displayName}" but it's not inside a <${Provider.displayName}> component.`);
+    }
+    return actor;
+  }
+  function useSelector$1(selector, compare) {
+    const actor = useContext();
+    return useSelector(actor, selector, compare);
+  }
+  return {
+    Provider: Provider,
+    useActorRef: useContext,
+    useSelector: useSelector$1
+  };
+}
+
+/**
+ * @alias useActor
+ */
+function useMachine(machine, options = {}) {
+  return useActor(machine, options);
+}
+
+export { createActorContext, shallowEqual, useActor, useActorRef, useMachine, useSelector };

package/dist/xstate-react.esm.js

@@ -1,208 +1,118 @@
-import { u as useConstant, _ as _slicedToArray } from './useConstant-0013a606.esm.js';
-import { useEffect, useState, useCallback, createContext, createElement, useContext } from 'react';
+import * as React from 'react';
+import { useEffect, useState, useCallback } from 'react';
+import { useSyncExternalStore } from 'use-sync-external-store/shim';
+import { toObserver, createActor } from 'xstate';
 import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect';
 import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
-import { toObserver, InterpreterStatus, interpret } from 'xstate';
-import { useSyncExternalStore } from 'use-sync-external-store/shim';
-
-function _objectWithoutPropertiesLoose(source, excluded) {
-  if (source == null) return {};
-  var target = {};
-  var sourceKeys = Object.keys(source);
-  var key, i;
-  for (i = 0; i < sourceKeys.length; i++) {
-    key = sourceKeys[i];
-    if (excluded.indexOf(key) >= 0) continue;
-    target[key] = source[key];
-  }
-  return target;
-}
 
-function _objectWithoutProperties(source, excluded) {
-  if (source == null) return {};
-  var target = _objectWithoutPropertiesLoose(source, excluded);
-  var key, i;
-  if (Object.getOwnPropertySymbols) {
-    var sourceSymbolKeys = Object.getOwnPropertySymbols(source);
-    for (i = 0; i < sourceSymbolKeys.length; i++) {
-      key = sourceSymbolKeys[i];
-      if (excluded.indexOf(key) >= 0) continue;
-      if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue;
-      target[key] = source[key];
-    }
+const forEachActor = (actorRef, callback) => {
+  callback(actorRef);
+  const children = actorRef.getSnapshot().children;
+  if (children) {
+    Object.values(children).forEach(child => {
+      forEachActor(child, callback);
+    });
   }
-  return target;
+};
+function stopRootWithRehydration(actorRef) {
+  // persist state here in a custom way allows us to persist inline actors and to preserve actor references
+  // we do it to avoid setState in useEffect when the effect gets "reconnected"
+  // this currently only happens in Strict Effects but it simulates the Offscreen aka Activity API
+  // it also just allows us to end up with a somewhat more predictable behavior for the users
+  const persistedSnapshots = [];
+  forEachActor(actorRef, ref => {
+    persistedSnapshots.push([ref, ref.getSnapshot()]);
+    // muting observers allow us to avoid `useSelector` from being notified about the stopped state
+    // React reconnects its subscribers (from the useSyncExternalStore) on its own
+    // and userland subscibers should basically always do the same anyway
+    // as each subscription should have its own cleanup logic and that should be called each such reconnect
+    ref.observers = new Set();
+  });
+  actorRef.stop();
+  persistedSnapshots.forEach(([ref, snapshot]) => {
+    ref._processingStatus = 0;
+    ref._state = snapshot;
+  });
 }
 
-var _excluded = ["actors", "guards", "actions", "delays"];
-function useIdleInterpreter(getMachine, options) {
-  var machine = useConstant(function () {
-    return typeof getMachine === 'function' ? getMachine() : getMachine;
+function useIdleActor(logic, options) {
+  let [[currentConfig, actorRef], setCurrent] = useState(() => {
+    const actorRef = createActor(logic, options);
+    return [logic.config, actorRef];
   });
-  if (process.env.NODE_ENV !== 'production' && typeof getMachine !== 'function') {
-    var _useState = useState(machine),
-      _useState2 = _slicedToArray(_useState, 1),
-      initialMachine = _useState2[0];
-    if (getMachine !== initialMachine) {
-      console.warn('Machine given to `useMachine` has changed between renders. This is not supported and might lead to unexpected results.\n' + 'Please make sure that you pass the same Machine as argument each time.');
-    }
+  if (logic.config !== currentConfig) {
+    const newActorRef = createActor(logic, {
+      ...options,
+      state: actorRef.getPersistedState({
+        __unsafeAllowInlineActors: true
+      })
+    });
+    setCurrent([logic.config, newActorRef]);
+    actorRef = newActorRef;
   }
-  var actors = options.actors,
-    guards = options.guards,
-    actions = options.actions,
-    delays = options.delays,
-    interpreterOptions = _objectWithoutProperties(options, _excluded);
-  var service = useConstant(function () {
-    var machineConfig = {
-      guards: guards,
-      actions: actions,
-      actors: actors,
-      delays: delays
-    };
-    var machineWithConfig = machine.provide(machineConfig);
-    return interpret(machineWithConfig, interpreterOptions);
-  });
 
-  // Make sure options are kept updated when they change.
-  // This mutation assignment is safe because the service instance is only used
-  // in one place -- this hook's caller.
-  useIsomorphicLayoutEffect(function () {
-    Object.assign(service.behavior.options.actions, actions);
-    Object.assign(service.behavior.options.guards, guards);
-    Object.assign(service.behavior.options.actors, actors);
-    Object.assign(service.behavior.options.delays, delays);
-  }, [actions, guards, actors, delays]);
-  return service;
+  // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
+  useIsomorphicLayoutEffect(() => {
+    actorRef.logic.implementations = logic.implementations;
+  });
+  return actorRef;
 }
-function useInterpret(getMachine) {
-  for (var _len = arguments.length, _ref = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-    _ref[_key - 1] = arguments[_key];
-  }
-  var _ref$ = _ref[0],
-    options = _ref$ === void 0 ? {} : _ref$,
-    observerOrListener = _ref[1];
-  var service = useIdleInterpreter(getMachine, options);
-  useEffect(function () {
+function useActorRef(machine, options = {}, observerOrListener) {
+  const actorRef = useIdleActor(machine, options);
+  useEffect(() => {
     if (!observerOrListener) {
       return;
     }
-    var sub = service.subscribe(toObserver(observerOrListener));
-    return function () {
+    let sub = actorRef.subscribe(toObserver(observerOrListener));
+    return () => {
       sub.unsubscribe();
     };
   }, [observerOrListener]);
-  useEffect(function () {
-    service.start();
-    return function () {
-      service.stop();
-      service.status = InterpreterStatus.NotStarted;
-      service._initState();
+  useEffect(() => {
+    actorRef.start();
+    return () => {
+      stopRootWithRehydration(actorRef);
     };
-  }, []);
-  return service;
-}
-
-function identity(a) {
-  return a;
-}
-var isEqual = function isEqual(prevState, nextState) {
-  return prevState === nextState || nextState.changed === false;
-};
-function useMachine(getMachine) {
-  for (var _len = arguments.length, _ref = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-    _ref[_key - 1] = arguments[_key];
-  }
-  var _ref$ = _ref[0],
-    options = _ref$ === void 0 ? {} : _ref$;
-  // using `useIdleInterpreter` allows us to subscribe to the service *before* we start it
-  // so we don't miss any notifications
-  var service = useIdleInterpreter(getMachine, options);
-  var getSnapshot = useCallback(function () {
-    return service.getSnapshot();
-  }, [service]);
-  var subscribe = useCallback(function (handleStoreChange) {
-    var _service$subscribe = service.subscribe(handleStoreChange),
-      unsubscribe = _service$subscribe.unsubscribe;
-    return unsubscribe;
-  }, [service]);
-  var storeSnapshot = useSyncExternalStoreWithSelector(subscribe, getSnapshot, getSnapshot, identity, isEqual);
-  useEffect(function () {
-    service.start();
-    return function () {
-      service.stop();
-      service.status = InterpreterStatus.NotStarted;
-      service._initState();
-    };
-  }, []);
-  return [storeSnapshot, service.send, service];
+  }, [actorRef]);
+  return actorRef;
 }
 
-function useActor(actorRef) {
-  var subscribe = useCallback(function (handleStoreChange) {
-    var _actorRef$subscribe = actorRef.subscribe(handleStoreChange),
-      unsubscribe = _actorRef$subscribe.unsubscribe;
-    return unsubscribe;
-  }, [actorRef]);
-  var boundGetSnapshot = useCallback(function () {
+function useActor(logic, options = {}) {
+  const actorRef = useIdleActor(logic, options);
+  const getSnapshot = useCallback(() => {
     return actorRef.getSnapshot();
   }, [actorRef]);
-  var storeSnapshot = useSyncExternalStore(subscribe, boundGetSnapshot, boundGetSnapshot);
-  var boundSend = useCallback(function (event) {
-    return actorRef.send(event);
+  const subscribe = useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actorRef.subscribe(handleStoreChange);
+    return unsubscribe;
+  }, [actorRef]);
+  const actorSnapshot = useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+  useEffect(() => {
+    actorRef.start();
+    return () => {
+      stopRootWithRehydration(actorRef);
+    };
   }, [actorRef]);
-  return [storeSnapshot, boundSend];
+  return [actorSnapshot, actorRef.send, actorRef];
 }
 
 function defaultCompare(a, b) {
   return a === b;
 }
-function useSelector(actor, selector) {
-  var compare = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : defaultCompare;
-  var subscribe = useCallback(function (handleStoreChange) {
-    var _actor$subscribe = actor.subscribe(handleStoreChange),
-      unsubscribe = _actor$subscribe.unsubscribe;
+function useSelector(actor, selector, compare = defaultCompare) {
+  const subscribe = useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actor.subscribe(handleStoreChange);
     return unsubscribe;
   }, [actor]);
-  var boundGetSnapshot = useCallback(function () {
-    return actor.getSnapshot();
-  }, [actor]);
-  var selectedSnapshot = useSyncExternalStoreWithSelector(subscribe, boundGetSnapshot, boundGetSnapshot, selector, compare);
+  const boundGetSnapshot = useCallback(() => actor.getSnapshot(), [actor]);
+  const selectedSnapshot = useSyncExternalStoreWithSelector(subscribe, boundGetSnapshot, boundGetSnapshot, selector, compare);
   return selectedSnapshot;
 }
 
-/**
- * React hook that spawns an `ActorRef` with the specified `behavior`.
- * The returned `ActorRef` can be used with the `useActor(actorRef)` hook.
- *
- * @param behavior The actor behavior to spawn
- * @returns An ActorRef with the specified `behavior`
- */
-function useSpawn(behavior) {
-  var actorRef = useConstant(function () {
-    // TODO: figure out what to do about the name argument
-    return interpret(behavior);
-  });
-  useEffect(function () {
-    var _actorRef$start;
-    (_actorRef$start = actorRef.start) === null || _actorRef$start === void 0 ? void 0 : _actorRef$start.call(actorRef);
-    return function () {
-      var _stop, _ref;
-      (_stop = (_ref = actorRef).stop) === null || _stop === void 0 ? void 0 : _stop.call(_ref);
-    };
-  }, []);
-  return actorRef;
-}
-
-function _typeof(obj) {
-  "@babel/helpers - typeof";
-
-  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
-    return typeof obj;
-  } : function (obj) {
-    return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
-  }, _typeof(obj);
-}
-
 // From https://github.com/reduxjs/react-redux/blob/720f0ba79236cdc3e1115f4ef9a7760a21784b48/src/utils/shallowEqual.ts
 function is(x, y) {
   if (x === y) {
@@ -213,13 +123,13 @@ function is(x, y) {
 }
 function shallowEqual(objA, objB) {
   if (is(objA, objB)) return true;
-  if (_typeof(objA) !== 'object' || objA === null || _typeof(objB) !== 'object' || objB === null) {
+  if (typeof objA !== 'object' || objA === null || typeof objB !== 'object' || objB === null) {
     return false;
   }
-  var keysA = Object.keys(objA);
-  var keysB = Object.keys(objB);
+  const keysA = Object.keys(objA);
+  const keysB = Object.keys(objB);
   if (keysA.length !== keysB.length) return false;
-  for (var i = 0; i < keysA.length; i++) {
+  for (let i = 0; i < keysA.length; i++) {
     if (!Object.prototype.hasOwnProperty.call(objB, keysA[i]) || !is(objA[keysA[i]], objB[keysA[i]])) {
       return false;
     }
@@ -227,95 +137,50 @@ function shallowEqual(objA, objB) {
   return true;
 }
 
-function _toPrimitive(input, hint) {
-  if (typeof input !== "object" || input === null) return input;
-  var prim = input[Symbol.toPrimitive];
-  if (prim !== undefined) {
-    var res = prim.call(input, hint || "default");
-    if (typeof res !== "object") return res;
-    throw new TypeError("@@toPrimitive must return a primitive value.");
-  }
-  return (hint === "string" ? String : Number)(input);
-}
-
-function _toPropertyKey(arg) {
-  var key = _toPrimitive(arg, "string");
-  return typeof key === "symbol" ? key : String(key);
-}
-
-function _defineProperty(obj, key, value) {
-  key = _toPropertyKey(key);
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value: value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-  return obj;
-}
-
-function ownKeys(object, enumerableOnly) {
-  var keys = Object.keys(object);
-  if (Object.getOwnPropertySymbols) {
-    var symbols = Object.getOwnPropertySymbols(object);
-    enumerableOnly && (symbols = symbols.filter(function (sym) {
-      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-    })), keys.push.apply(keys, symbols);
-  }
-  return keys;
-}
-function _objectSpread2(target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = null != arguments[i] ? arguments[i] : {};
-    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
-      _defineProperty(target, key, source[key]);
-    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
-      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-    });
-  }
-  return target;
-}
-
-function createActorContext(machine, interpreterOptions, observerOrListener) {
-  var ReactContext = /*#__PURE__*/createContext(null);
-  var OriginalProvider = ReactContext.Provider;
-  function Provider(_ref) {
-    var children = _ref.children,
-      _ref$machine = _ref.machine,
-      providedMachine = _ref$machine === void 0 ? machine : _ref$machine,
-      options = _ref.options;
-    var actor = useInterpret(providedMachine, _objectSpread2(_objectSpread2({}, interpreterOptions), options), observerOrListener);
-    return /*#__PURE__*/createElement(OriginalProvider, {
+function createActorContext(actorLogic, interpreterOptions) {
+  const ReactContext = /*#__PURE__*/React.createContext(null);
+  const OriginalProvider = ReactContext.Provider;
+  function Provider({
+    children,
+    logic: providedLogic = actorLogic,
+    machine,
+    options: providedOptions = interpreterOptions
+  }) {
+    if (machine) {
+      throw new Error(`The "machine" prop has been deprecated. Please use "logic" instead.`);
+    }
+    const actor = useActorRef(providedLogic, providedOptions);
+    return /*#__PURE__*/React.createElement(OriginalProvider, {
       value: actor,
-      children: children
+      children
     });
   }
-  Provider.displayName = "ActorProvider(".concat(machine.id, ")");
-  function useContext$1() {
-    var actor = useContext(ReactContext);
+
+  // TODO: add properties to actor ref to make more descriptive
+  Provider.displayName = `ActorProvider`;
+  function useContext() {
+    const actor = React.useContext(ReactContext);
     if (!actor) {
-      throw new Error("You used a hook from \"".concat(Provider.displayName, "\" but it's not inside a <").concat(Provider.displayName, "> component."));
+      throw new Error(`You used a hook from "${Provider.displayName}" but it's not inside a <${Provider.displayName}> component.`);
     }
     return actor;
   }
-  function useActor$1() {
-    var actor = useContext$1();
-    return useActor(actor);
-  }
   function useSelector$1(selector, compare) {
-    var actor = useContext$1();
+    const actor = useContext();
     return useSelector(actor, selector, compare);
   }
   return {
     Provider: Provider,
-    useActorRef: useContext$1,
-    useActor: useActor$1,
+    useActorRef: useContext,
     useSelector: useSelector$1
   };
 }
 
-export { createActorContext, shallowEqual, useActor, useInterpret, useMachine, useSelector, useSpawn };
+/**
+ * @alias useActor
+ */
+function useMachine(machine, options = {}) {
+  return useActor(machine, options);
+}
+
+export { createActorContext, shallowEqual, useActor, useActorRef, useMachine, useSelector };