@storybook/addon-interactions 7.0.0-alpha.1 → 7.0.0-alpha.12

package/README.md

@@ -41,22 +41,25 @@ Interactions relies on "instrumented" versions of Jest and Testing Library, that
 `@storybook/testing-library` instead of their original package. You can then use these libraries in your `play` function.
 
 ```js
+import { Button } from './Button';
 import { expect } from '@storybook/jest';
 import { within, userEvent } from '@storybook/testing-library';
 
 export default {
   title: 'Button',
+  component: Button,
   argTypes: {
     onClick: { action: true },
   },
 };
 
-export const Demo = {
-  play: async ({ args, canvasElement }) => {
-    const canvas = within(canvasElement);
-    await userEvent.click(canvas.getByRole('button'));
-    await expect(args.onClick).toHaveBeenCalled();
-  },
+const Template = (args) => <Button {...args} />;
+
+export const Demo = Template.bind({});
+Demo.play = async ({ args, canvasElement }) => {
+  const canvas = within(canvasElement);
+  await userEvent.click(canvas.getByRole('button'));
+  await expect(args.onClick).toHaveBeenCalled();
 };
 ```
 

package/dist/cjs/Panel.js

@@ -1,102 +1,37 @@
 "use strict";
 
-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); }
-
-require("core-js/modules/es.object.keys.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-require("core-js/modules/es.symbol.iterator.js");
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.array.from.js");
-
-require("core-js/modules/es.weak-map.js");
-
-require("core-js/modules/es.object.get-own-property-descriptor.js");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Panel = exports.AddonPanelPure = void 0;
-
-require("core-js/modules/es.array.map.js");
-
-require("core-js/modules/es.array.iterator.js");
-
-require("core-js/modules/es.map.js");
-
-require("core-js/modules/es.object.to-string.js");
-
-require("core-js/modules/es.string.iterator.js");
-
-require("core-js/modules/web.dom-collections.iterator.js");
-
-require("core-js/modules/es.object.assign.js");
-
-require("core-js/modules/es.array.slice.js");
-
-require("core-js/modules/es.regexp.exec.js");
-
-require("core-js/modules/es.string.split.js");
-
-require("core-js/modules/es.regexp.to-string.js");
+exports.getInteractions = exports.Panel = void 0;
 
 var _global = _interopRequireDefault(require("global"));
 
 var React = _interopRequireWildcard(require("react"));
 
-var _reactDom = _interopRequireDefault(require("react-dom"));
-
 var _api = require("@storybook/api");
 
 var _coreEvents = require("@storybook/core-events");
 
-var _components = require("@storybook/components");
-
 var _instrumenter = require("@storybook/instrumenter");
 
-var _theming = require("@storybook/theming");
-
-var _StatusIcon = require("./components/StatusIcon/StatusIcon");
-
-var _Subnav = require("./components/Subnav/Subnav");
+var _InteractionsPanel = require("./components/InteractionsPanel");
 
-var _Interaction = require("./components/Interaction/Interaction");
+var _TabStatus = require("./components/TabStatus");
 
-var _excluded = ["calls", "controls", "controlStates", "interactions", "fileName", "hasException", "isPlaying", "onScrollToEnd", "endRef", "isRerunAnimating", "setIsRerunAnimating"],
-    _excluded2 = ["status"];
+const _excluded = ["status"];
 
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-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]; } } return target; }
-
 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; }
 
-var INITIAL_CONTROL_STATES = {
+const INITIAL_CONTROL_STATES = {
   debugger: false,
   start: false,
   back: false,
@@ -104,203 +39,175 @@ var INITIAL_CONTROL_STATES = {
   next: false,
   end: false
 };
-var TabIcon = (0, _theming.styled)(_StatusIcon.StatusIcon)({
-  marginLeft: 5
-});
-
-var TabStatus = function TabStatus(_ref) {
-  var children = _ref.children;
-
-  var container = _global.default.document.getElementById('tabbutton-interactions');
-
-  return container && /*#__PURE__*/_reactDom.default.createPortal(children, container);
-};
 
-var AddonPanelPure = /*#__PURE__*/React.memo(function (_ref2) {
-  var calls = _ref2.calls,
-      controls = _ref2.controls,
-      controlStates = _ref2.controlStates,
-      interactions = _ref2.interactions,
-      fileName = _ref2.fileName,
-      hasException = _ref2.hasException,
-      isPlaying = _ref2.isPlaying,
-      onScrollToEnd = _ref2.onScrollToEnd,
-      endRef = _ref2.endRef,
-      isRerunAnimating = _ref2.isRerunAnimating,
-      setIsRerunAnimating = _ref2.setIsRerunAnimating,
-      panelProps = _objectWithoutProperties(_ref2, _excluded);
-
-  return /*#__PURE__*/React.createElement(_components.AddonPanel, panelProps, controlStates.debugger && interactions.length > 0 && /*#__PURE__*/React.createElement(_Subnav.Subnav, {
-    controls: controls,
-    controlStates: controlStates,
-    status: // eslint-disable-next-line no-nested-ternary
-    isPlaying ? _instrumenter.CallStates.ACTIVE : hasException ? _instrumenter.CallStates.ERROR : _instrumenter.CallStates.DONE,
-    storyFileName: fileName,
-    onScrollToEnd: onScrollToEnd,
-    isRerunAnimating: isRerunAnimating,
-    setIsRerunAnimating: setIsRerunAnimating
-  }), interactions.map(function (call) {
-    return /*#__PURE__*/React.createElement(_Interaction.Interaction, {
-      key: call.id,
-      call: call,
-      callsById: calls,
-      controls: controls,
-      controlStates: controlStates
+const getInteractions = ({
+  log,
+  calls,
+  collapsed,
+  setCollapsed
+}) => {
+  const callsById = new Map();
+  const childCallMap = new Map();
+  return log.filter(({
+    callId,
+    parentId
+  }) => {
+    if (!parentId) return true;
+    childCallMap.set(parentId, (childCallMap.get(parentId) || []).concat(callId));
+    return !collapsed.has(parentId);
+  }).map(({
+    callId,
+    status
+  }) => Object.assign({}, calls.get(callId), {
+    status
+  })).map(call => {
+    var _callsById$get;
+
+    const status = call.status === _instrumenter.CallStates.ERROR && ((_callsById$get = callsById.get(call.parentId)) === null || _callsById$get === void 0 ? void 0 : _callsById$get.status) === _instrumenter.CallStates.ACTIVE ? _instrumenter.CallStates.ACTIVE : call.status;
+    callsById.set(call.id, Object.assign({}, call, {
+      status
+    }));
+    return Object.assign({}, call, {
+      status,
+      childCallIds: childCallMap.get(call.id),
+      isCollapsed: collapsed.has(call.id),
+      toggleCollapsed: () => setCollapsed(ids => {
+        if (ids.has(call.id)) ids.delete(call.id);else ids.add(call.id);
+        return new Set(ids);
+      })
     });
-  }), /*#__PURE__*/React.createElement("div", {
-    ref: endRef
-  }), !isPlaying && interactions.length === 0 && /*#__PURE__*/React.createElement(_components.Placeholder, null, "No interactions found", /*#__PURE__*/React.createElement(_components.Link, {
-    href: "https://github.com/storybookjs/storybook/blob/next/addons/interactions/README.md",
-    target: "_blank",
-    withArrow: true
-  }, "Learn how to add interactions to your story")));
-});
-exports.AddonPanelPure = AddonPanelPure;
-
-var Panel = function Panel(props) {
-  var _useChannel;
-
-  var _React$useState = React.useState(),
-      _React$useState2 = _slicedToArray(_React$useState, 2),
-      storyId = _React$useState2[0],
-      setStoryId = _React$useState2[1];
-
-  var _React$useState3 = React.useState(INITIAL_CONTROL_STATES),
-      _React$useState4 = _slicedToArray(_React$useState3, 2),
-      controlStates = _React$useState4[0],
-      setControlStates = _React$useState4[1];
-
-  var _React$useState5 = React.useState(false),
-      _React$useState6 = _slicedToArray(_React$useState5, 2),
-      isPlaying = _React$useState6[0],
-      setPlaying = _React$useState6[1];
-
-  var _React$useState7 = React.useState(false),
-      _React$useState8 = _slicedToArray(_React$useState7, 2),
-      isRerunAnimating = _React$useState8[0],
-      setIsRerunAnimating = _React$useState8[1];
+  });
+};
 
-  var _React$useState9 = React.useState(),
-      _React$useState10 = _slicedToArray(_React$useState9, 2),
-      scrollTarget = _React$useState10[0],
-      setScrollTarget = _React$useState10[1]; // Calls are tracked in a ref so we don't needlessly rerender.
+exports.getInteractions = getInteractions;
 
+const Panel = props => {
+  const [storyId, setStoryId] = React.useState();
+  const [controlStates, setControlStates] = React.useState(INITIAL_CONTROL_STATES);
+  const [pausedAt, setPausedAt] = React.useState();
+  const [isErrored, setErrored] = React.useState(false);
+  const [isPlaying, setPlaying] = React.useState(false);
+  const [isRerunAnimating, setIsRerunAnimating] = React.useState(false);
+  const [scrollTarget, setScrollTarget] = React.useState();
+  const [collapsed, setCollapsed] = React.useState(new Set());
+  const [caughtException, setCaughtException] = React.useState();
+  const [interactions, setInteractions] = React.useState([]);
+  const [interactionsCount, setInteractionsCount] = React.useState(); // Calls are tracked in a ref so we don't needlessly rerender.
 
-  var calls = React.useRef(new Map());
+  const calls = React.useRef(new Map());
 
-  var setCall = function setCall(_ref3) {
-    var status = _ref3.status,
-        call = _objectWithoutProperties(_ref3, _excluded2);
+  const setCall = _ref => {
+    let call = _objectWithoutPropertiesLoose(_ref, _excluded);
 
     return calls.current.set(call.id, call);
   };
 
-  var _React$useState11 = React.useState([]),
-      _React$useState12 = _slicedToArray(_React$useState11, 2),
-      log = _React$useState12[0],
-      setLog = _React$useState12[1];
-
-  var interactions = log.map(function (_ref4) {
-    var callId = _ref4.callId,
-        status = _ref4.status;
-    return Object.assign({}, calls.current.get(callId), {
-      status: status
-    });
-  });
-  var endRef = React.useRef();
-  React.useEffect(function () {
-    var observer;
+  const endRef = React.useRef();
+  React.useEffect(() => {
+    let observer;
 
     if (_global.default.window.IntersectionObserver) {
-      observer = new _global.default.window.IntersectionObserver(function (_ref5) {
-        var _ref6 = _slicedToArray(_ref5, 1),
-            end = _ref6[0];
-
-        return setScrollTarget(end.isIntersecting ? undefined : end.target);
-      }, {
+      observer = new _global.default.window.IntersectionObserver(([end]) => setScrollTarget(end.isIntersecting ? undefined : end.target), {
         root: _global.default.window.document.querySelector('#panel-tab-content')
       });
       if (endRef.current) observer.observe(endRef.current);
     }
 
-    return function () {
+    return () => {
       var _observer;
 
       return (_observer = observer) === null || _observer === void 0 ? void 0 : _observer.disconnect();
     };
   }, []);
-  var emit = (0, _api.useChannel)((_useChannel = {}, _defineProperty(_useChannel, _instrumenter.EVENTS.CALL, setCall), _defineProperty(_useChannel, _instrumenter.EVENTS.SYNC, function (payload) {
-    setControlStates(payload.controlStates);
-    setLog(payload.logItems);
-  }), _defineProperty(_useChannel, _coreEvents.STORY_RENDER_PHASE_CHANGED, function (event) {
-    setStoryId(event.storyId);
-    setPlaying(event.newPhase === 'playing');
-  }), _useChannel), []);
-  var controls = React.useMemo(function () {
-    return {
-      start: function start() {
-        return emit(_instrumenter.EVENTS.START, {
-          storyId: storyId
-        });
-      },
-      back: function back() {
-        return emit(_instrumenter.EVENTS.BACK, {
-          storyId: storyId
-        });
-      },
-      goto: function goto(callId) {
-        return emit(_instrumenter.EVENTS.GOTO, {
-          storyId: storyId,
-          callId: callId
-        });
-      },
-      next: function next() {
-        return emit(_instrumenter.EVENTS.NEXT, {
-          storyId: storyId
-        });
-      },
-      end: function end() {
-        return emit(_instrumenter.EVENTS.END, {
-          storyId: storyId
-        });
-      },
-      rerun: function rerun() {
-        setIsRerunAnimating(true);
-        emit(_coreEvents.FORCE_REMOUNT, {
-          storyId: storyId
-        });
+  const emit = (0, _api.useChannel)({
+    [_instrumenter.EVENTS.CALL]: setCall,
+    [_instrumenter.EVENTS.SYNC]: payload => {
+      setControlStates(payload.controlStates);
+      setPausedAt(payload.pausedAt);
+      setInteractions(getInteractions({
+        log: payload.logItems,
+        calls: calls.current,
+        collapsed,
+        setCollapsed
+      }));
+    },
+    [_coreEvents.STORY_RENDER_PHASE_CHANGED]: event => {
+      setStoryId(event.storyId);
+      setPlaying(event.newPhase === 'playing');
+      setPausedAt(undefined);
+
+      if (event.newPhase === 'rendering') {
+        setErrored(false);
+        setCaughtException(undefined);
       }
-    };
-  }, [storyId]);
-  var storyFilePath = (0, _api.useParameter)('fileName', '');
+    },
+    [_coreEvents.STORY_THREW_EXCEPTION]: () => {
+      setErrored(true);
+    },
+    [_coreEvents.PLAY_FUNCTION_THREW_EXCEPTION]: e => {
+      console.log('PLAY_FUNCTION_THREW_EXCEPTION');
+      if ((e === null || e === void 0 ? void 0 : e.message) !== _coreEvents.IGNORED_EXCEPTION.message) setCaughtException(e);else setCaughtException(undefined);
+    }
+  }, [collapsed]);
+  React.useEffect(() => {
+    if (isPlaying || isRerunAnimating) return;
+    setInteractionsCount(interactions.length);
+  }, [interactions, isPlaying, isRerunAnimating]);
+  const controls = React.useMemo(() => ({
+    start: () => emit(_instrumenter.EVENTS.START, {
+      storyId
+    }),
+    back: () => emit(_instrumenter.EVENTS.BACK, {
+      storyId
+    }),
+    goto: callId => emit(_instrumenter.EVENTS.GOTO, {
+      storyId,
+      callId
+    }),
+    next: () => emit(_instrumenter.EVENTS.NEXT, {
+      storyId
+    }),
+    end: () => emit(_instrumenter.EVENTS.END, {
+      storyId
+    }),
+    rerun: () => {
+      setIsRerunAnimating(true);
+      emit(_coreEvents.FORCE_REMOUNT, {
+        storyId
+      });
+    }
+  }), [storyId]);
+  const storyFilePath = (0, _api.useParameter)('fileName', '');
+  const [fileName] = storyFilePath.toString().split('/').slice(-1);
 
-  var _storyFilePath$toStri = storyFilePath.toString().split('/').slice(-1),
-      _storyFilePath$toStri2 = _slicedToArray(_storyFilePath$toStri, 1),
-      fileName = _storyFilePath$toStri2[0];
+  const scrollToTarget = () => scrollTarget === null || scrollTarget === void 0 ? void 0 : scrollTarget.scrollIntoView({
+    behavior: 'smooth',
+    block: 'end'
+  });
 
-  var scrollToTarget = function scrollToTarget() {
-    return scrollTarget === null || scrollTarget === void 0 ? void 0 : scrollTarget.scrollIntoView({
-      behavior: 'smooth',
-      block: 'end'
+  const showStatus = interactionsCount > 0 || !!caughtException || isRerunAnimating;
+  const hasException = !!caughtException || interactions.some(v => v.status === _instrumenter.CallStates.ERROR);
+
+  if (isErrored) {
+    return /*#__PURE__*/React.createElement(React.Fragment, {
+      key: "interactions"
     });
-  };
+  }
 
-  var showStatus = log.length > 0 && !isPlaying;
-  var hasException = log.some(function (item) {
-    return item.status === _instrumenter.CallStates.ERROR;
-  });
   return /*#__PURE__*/React.createElement(React.Fragment, {
     key: "interactions"
-  }, /*#__PURE__*/React.createElement(TabStatus, null, showStatus && (hasException ? /*#__PURE__*/React.createElement(TabIcon, {
+  }, /*#__PURE__*/React.createElement(_TabStatus.TabStatus, null, showStatus && (hasException ? /*#__PURE__*/React.createElement(_TabStatus.TabIcon, {
     status: _instrumenter.CallStates.ERROR
-  }) : " (".concat(interactions.length, ")"))), /*#__PURE__*/React.createElement(AddonPanelPure, _extends({
+  }) : ` (${interactionsCount})`)), /*#__PURE__*/React.createElement(_InteractionsPanel.InteractionsPanel, _extends({
     calls: calls.current,
     controls: controls,
     controlStates: controlStates,
     interactions: interactions,
     fileName: fileName,
     hasException: hasException,
+    caughtException: caughtException,
     isPlaying: isPlaying,
+    pausedAt: pausedAt,
     endRef: endRef,
     onScrollToEnd: scrollTarget && scrollToTarget,
     isRerunAnimating: isRerunAnimating,