@xstate/react 4.0.0-beta.4 → 4.0.0-beta.5

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

@@ -1,6 +1,6 @@
-export { useActor } from './useActor.ts';
-export { useActorRef } from './useActorRef.ts';
-export { useSelector } from './useSelector.ts';
-export { shallowEqual } from './shallowEqual.ts';
-export { createActorContext } from './createActorContext.ts';
-export { useMachine } from './useMachine.ts';
+export { useActor } from "./useActor.js";
+export { useActorRef } from "./useActorRef.js";
+export { useSelector } from "./useSelector.js";
+export { shallowEqual } from "./shallowEqual.js";
+export { createActorContext } from "./createActorContext.js";
+export { useMachine } from "./useMachine.js";

package/dist/{useConstant-720f1662.cjs.prod.js → useConstant-2ee82f84.cjs.js}

@@ -23,7 +23,7 @@ function _interopNamespace(e) {
 var React__namespace = /*#__PURE__*/_interopNamespace(React);
 
 function useConstant(fn) {
-  var ref = React__namespace.useRef();
+  const ref = React__namespace.useRef();
   if (!ref.current) {
     ref.current = {
       v: fn()

package/dist/useConstant-ae6dceac.development.cjs.js

@@ -0,0 +1,35 @@
+'use strict';
+
+var React = require('react');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+
+function useConstant(fn) {
+  const ref = React__namespace.useRef();
+  if (!ref.current) {
+    ref.current = {
+      v: fn()
+    };
+  }
+  return ref.current.v;
+}
+
+exports.useConstant = useConstant;

package/dist/useConstant-bac83df4.development.esm.js

@@ -0,0 +1,13 @@
+import * as React from 'react';
+
+function useConstant(fn) {
+  const ref = React.useRef();
+  if (!ref.current) {
+    ref.current = {
+      v: fn()
+    };
+  }
+  return ref.current.v;
+}
+
+export { useConstant as u };

package/dist/useConstant-c7ec0fdd.esm.js

@@ -0,0 +1,13 @@
+import * as React from 'react';
+
+function useConstant(fn) {
+  const ref = React.useRef();
+  if (!ref.current) {
+    ref.current = {
+      v: fn()
+    };
+  }
+  return ref.current.v;
+}
+
+export { useConstant as u };

package/dist/xstate-react.cjs.js

@@ -1,7 +1,181 @@
 'use strict';
 
-if (process.env.NODE_ENV === "production") {
-  module.exports = require("./xstate-react.cjs.prod.js");
-} else {
-  module.exports = require("./xstate-react.cjs.dev.js");
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var withSelector = require('use-sync-external-store/shim/with-selector');
+var xstate = require('xstate');
+var useConstant = require('./useConstant-2ee82f84.cjs.js');
+var useIsomorphicLayoutEffect = require('use-isomorphic-layout-effect');
+require('xstate/actors');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+var useIsomorphicLayoutEffect__default = /*#__PURE__*/_interopDefault(useIsomorphicLayoutEffect);
+
+function useIdleInterpreter(machine, options) {
+  const actorRef = useConstant.useConstant(() => {
+    return xstate.interpret(machine, options);
+  });
+
+  // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
+  useIsomorphicLayoutEffect__default["default"](() => {
+    actorRef.behavior.options = machine.options;
+  });
+  return actorRef;
+}
+function useActorRef(machine, ...[options = {}, observerOrListener]) {
+  const service = useIdleInterpreter(machine, options);
+  React.useEffect(() => {
+    if (!observerOrListener) {
+      return;
+    }
+    let sub = service.subscribe(xstate.toObserver(observerOrListener));
+    return () => {
+      sub.unsubscribe();
+    };
+  }, [observerOrListener]);
+  React.useEffect(() => {
+    service.start();
+    return () => {
+      service.stop();
+      service.status = xstate.InterpreterStatus.NotStarted;
+      service._initState();
+    };
+  }, []);
+  return service;
+}
+
+function identity(a) {
+  return a;
+}
+const isEqual = (prevState, nextState) => {
+  return prevState === nextState || nextState.changed === false;
+};
+function useActor(behavior, options = {}) {
+  const actorRef = useIdleInterpreter(behavior, options);
+  const getSnapshot = React.useCallback(() => {
+    return actorRef.getSnapshot();
+  }, [actorRef]);
+  const subscribe = React.useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actorRef.subscribe(handleStoreChange);
+    return unsubscribe;
+  }, [actorRef]);
+  const actorSnapshot = withSelector.useSyncExternalStoreWithSelector(subscribe, getSnapshot, getSnapshot, identity, isEqual);
+  React.useEffect(() => {
+    actorRef.start();
+    return () => {
+      actorRef.stop();
+      actorRef.status = xstate.InterpreterStatus.NotStarted;
+      actorRef._initState();
+    };
+  }, [actorRef]);
+  return [actorSnapshot, actorRef.send, actorRef];
 }
+
+function defaultCompare(a, b) {
+  return a === b;
+}
+function useSelector(actor, selector, compare = defaultCompare) {
+  const subscribe = React.useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actor.subscribe(handleStoreChange);
+    return unsubscribe;
+  }, [actor]);
+  const boundGetSnapshot = React.useCallback(() => actor.getSnapshot(), [actor]);
+  const selectedSnapshot = withSelector.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(machine, interpreterOptions, observerOrListener) {
+  const ReactContext = /*#__PURE__*/React__namespace.createContext(null);
+  const OriginalProvider = ReactContext.Provider;
+  function Provider({
+    children,
+    machine: providedMachine = machine
+  }) {
+    const actor = useActorRef(providedMachine, interpreterOptions, observerOrListener);
+    return /*#__PURE__*/React__namespace.createElement(OriginalProvider, {
+      value: actor,
+      children
+    });
+  }
+  Provider.displayName = `ActorProvider(${machine.id})`;
+  function useContext() {
+    const actor = React__namespace.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
+  };
+}
+
+/**
+ *
+ * @deprecated Use `useActor(...)` instead.
+ */
+function useMachine(machine, options = {}) {
+  return useActor(machine, options);
+}
+
+exports.createActorContext = createActorContext;
+exports.shallowEqual = shallowEqual;
+exports.useActor = useActor;
+exports.useActorRef = useActorRef;
+exports.useMachine = useMachine;
+exports.useSelector = useSelector;

package/dist/{xstate-react.cjs.prod.js → xstate-react.development.cjs.js}

@@ -5,9 +5,9 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var React = require('react');
 var withSelector = require('use-sync-external-store/shim/with-selector');
 var xstate = require('xstate');
-var useConstant = require('./useConstant-720f1662.cjs.prod.js');
+var useConstant = require('./useConstant-ae6dceac.development.cjs.js');
 var useIsomorphicLayoutEffect = require('use-isomorphic-layout-effect');
-require('xstate/actors');
+var actors = require('xstate/actors');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -33,36 +33,36 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var useIsomorphicLayoutEffect__default = /*#__PURE__*/_interopDefault(useIsomorphicLayoutEffect);
 
 function useIdleInterpreter(machine, options) {
-  var actorRef = useConstant.useConstant(function () {
+  {
+    const [initialMachine] = React.useState(machine);
+    if (machine.config !== initialMachine.config) {
+      console.warn(`Actor logic has changed between renders. This is not supported and may lead to invalid snapshots.`);
+    }
+  }
+  const actorRef = useConstant.useConstant(() => {
     return xstate.interpret(machine, options);
   });
 
   // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
-  useIsomorphicLayoutEffect__default["default"](function () {
+  useIsomorphicLayoutEffect__default["default"](() => {
     actorRef.behavior.options = machine.options;
   });
   return actorRef;
 }
-function useActorRef(machine) {
-  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(machine, options);
-  React.useEffect(function () {
+function useActorRef(machine, ...[options = {}, observerOrListener]) {
+  const service = useIdleInterpreter(machine, options);
+  React.useEffect(() => {
     if (!observerOrListener) {
       return;
     }
-    var sub = service.subscribe(xstate.toObserver(observerOrListener));
-    return function () {
+    let sub = service.subscribe(xstate.toObserver(observerOrListener));
+    return () => {
       sub.unsubscribe();
     };
   }, [observerOrListener]);
-  React.useEffect(function () {
+  React.useEffect(() => {
     service.start();
-    return function () {
+    return () => {
       service.stop();
       service.status = xstate.InterpreterStatus.NotStarted;
       service._initState();
@@ -74,24 +74,27 @@ function useActorRef(machine) {
 function identity(a) {
   return a;
 }
-var isEqual = function isEqual(prevState, nextState) {
+const isEqual = (prevState, nextState) => {
   return prevState === nextState || nextState.changed === false;
 };
-function useActor(behavior) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var actorRef = useIdleInterpreter(behavior, options);
-  var getSnapshot = React.useCallback(function () {
+function useActor(behavior, options = {}) {
+  if (actors.isActorRef(behavior)) {
+    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 = useIdleInterpreter(behavior, options);
+  const getSnapshot = React.useCallback(() => {
     return actorRef.getSnapshot();
   }, [actorRef]);
-  var subscribe = React.useCallback(function (handleStoreChange) {
-    var _actorRef$subscribe = actorRef.subscribe(handleStoreChange),
-      unsubscribe = _actorRef$subscribe.unsubscribe;
+  const subscribe = React.useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actorRef.subscribe(handleStoreChange);
     return unsubscribe;
   }, [actorRef]);
-  var actorSnapshot = withSelector.useSyncExternalStoreWithSelector(subscribe, getSnapshot, getSnapshot, identity, isEqual);
-  React.useEffect(function () {
+  const actorSnapshot = withSelector.useSyncExternalStoreWithSelector(subscribe, getSnapshot, getSnapshot, identity, isEqual);
+  React.useEffect(() => {
     actorRef.start();
-    return function () {
+    return () => {
       actorRef.stop();
       actorRef.status = xstate.InterpreterStatus.NotStarted;
       actorRef._initState();
@@ -103,30 +106,18 @@ function useActor(behavior) {
 function defaultCompare(a, b) {
   return a === b;
 }
-function useSelector(actor, selector) {
-  var compare = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : defaultCompare;
-  var subscribe = React.useCallback(function (handleStoreChange) {
-    var _actor$subscribe = actor.subscribe(handleStoreChange),
-      unsubscribe = _actor$subscribe.unsubscribe;
+function useSelector(actor, selector, compare = defaultCompare) {
+  const subscribe = React.useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actor.subscribe(handleStoreChange);
     return unsubscribe;
   }, [actor]);
-  var boundGetSnapshot = React.useCallback(function () {
-    return actor.getSnapshot();
-  }, [actor]);
-  var selectedSnapshot = withSelector.useSyncExternalStoreWithSelector(subscribe, boundGetSnapshot, boundGetSnapshot, selector, compare);
+  const boundGetSnapshot = React.useCallback(() => actor.getSnapshot(), [actor]);
+  const selectedSnapshot = withSelector.useSyncExternalStoreWithSelector(subscribe, boundGetSnapshot, boundGetSnapshot, selector, compare);
   return selectedSnapshot;
 }
 
-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) {
@@ -137,13 +128,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;
     }
@@ -152,28 +143,28 @@ function shallowEqual(objA, objB) {
 }
 
 function createActorContext(machine, interpreterOptions, observerOrListener) {
-  var ReactContext = /*#__PURE__*/React__namespace.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;
-    var actor = useActorRef(providedMachine, interpreterOptions, observerOrListener);
+  const ReactContext = /*#__PURE__*/React__namespace.createContext(null);
+  const OriginalProvider = ReactContext.Provider;
+  function Provider({
+    children,
+    machine: providedMachine = machine
+  }) {
+    const actor = useActorRef(providedMachine, interpreterOptions, observerOrListener);
     return /*#__PURE__*/React__namespace.createElement(OriginalProvider, {
       value: actor,
-      children: children
+      children
     });
   }
-  Provider.displayName = "ActorProvider(".concat(machine.id, ")");
+  Provider.displayName = `ActorProvider(${machine.id})`;
   function useContext() {
-    var actor = React__namespace.useContext(ReactContext);
+    const actor = React__namespace.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 useSelector$1(selector, compare) {
-    var actor = useContext();
+    const actor = useContext();
     return useSelector(actor, selector, compare);
   }
   return {
@@ -187,8 +178,7 @@ function createActorContext(machine, interpreterOptions, observerOrListener) {
  *
  * @deprecated Use `useActor(...)` instead.
  */
-function useMachine(machine) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+function useMachine(machine, options = {}) {
   return useActor(machine, options);
 }
 

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

@@ -0,0 +1,159 @@
+import * as React from 'react';
+import { useEffect, useState, useCallback } from 'react';
+import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
+import { toObserver, InterpreterStatus, interpret } from 'xstate';
+import { u as useConstant } from './useConstant-bac83df4.development.esm.js';
+import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect';
+import { isActorRef } from 'xstate/actors';
+
+function useIdleInterpreter(machine, options) {
+  {
+    const [initialMachine] = useState(machine);
+    if (machine.config !== initialMachine.config) {
+      console.warn(`Actor logic has changed between renders. This is not supported and may lead to invalid snapshots.`);
+    }
+  }
+  const actorRef = useConstant(() => {
+    return interpret(machine, options);
+  });
+
+  // TODO: consider using `useAsapEffect` that would do this in `useInsertionEffect` is that's available
+  useIsomorphicLayoutEffect(() => {
+    actorRef.behavior.options = machine.options;
+  });
+  return actorRef;
+}
+function useActorRef(machine, ...[options = {}, observerOrListener]) {
+  const service = useIdleInterpreter(machine, options);
+  useEffect(() => {
+    if (!observerOrListener) {
+      return;
+    }
+    let sub = service.subscribe(toObserver(observerOrListener));
+    return () => {
+      sub.unsubscribe();
+    };
+  }, [observerOrListener]);
+  useEffect(() => {
+    service.start();
+    return () => {
+      service.stop();
+      service.status = InterpreterStatus.NotStarted;
+      service._initState();
+    };
+  }, []);
+  return service;
+}
+
+function identity(a) {
+  return a;
+}
+const isEqual = (prevState, nextState) => {
+  return prevState === nextState || nextState.changed === false;
+};
+function useActor(behavior, options = {}) {
+  if (isActorRef(behavior)) {
+    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 = useIdleInterpreter(behavior, options);
+  const getSnapshot = useCallback(() => {
+    return actorRef.getSnapshot();
+  }, [actorRef]);
+  const subscribe = useCallback(handleStoreChange => {
+    const {
+      unsubscribe
+    } = actorRef.subscribe(handleStoreChange);
+    return unsubscribe;
+  }, [actorRef]);
+  const actorSnapshot = useSyncExternalStoreWithSelector(subscribe, getSnapshot, getSnapshot, identity, isEqual);
+  useEffect(() => {
+    actorRef.start();
+    return () => {
+      actorRef.stop();
+      actorRef.status = InterpreterStatus.NotStarted;
+      actorRef._initState();
+    };
+  }, [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(machine, interpreterOptions, observerOrListener) {
+  const ReactContext = /*#__PURE__*/React.createContext(null);
+  const OriginalProvider = ReactContext.Provider;
+  function Provider({
+    children,
+    machine: providedMachine = machine
+  }) {
+    const actor = useActorRef(providedMachine, interpreterOptions, observerOrListener);
+    return /*#__PURE__*/React.createElement(OriginalProvider, {
+      value: actor,
+      children
+    });
+  }
+  Provider.displayName = `ActorProvider(${machine.id})`;
+  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
+  };
+}
+
+/**
+ *
+ * @deprecated Use `useActor(...)` instead.
+ */
+function useMachine(machine, options = {}) {
+  return useActor(machine, options);
+}
+
+export { createActorContext, shallowEqual, useActor, useActorRef, useMachine, useSelector };