@storybook/react 6.5.0-alpha.7 → 6.5.0-beta.1

package/README.md

@@ -19,8 +19,8 @@ For more information visit: [storybook.js.org](https://storybook.js.org)
 
 ---
 
-Storybook also comes with a lot of [addons](https://storybook.js.org/docs/react/configure/storybook-addons) and a great API to customize as you wish.
-You can also build a [static version](https://storybook.js.org/docs/react/workflows/publish-storybook) of your storybook and deploy it anywhere you want.
+Storybook also comes with a lot of [addons](https://storybook.js.org/addons) and a great API to customize as you wish.
+You can also build a [static version](https://storybook.js.org/docs/react/sharing/publish-storybook) of your Storybook and deploy it anywhere you want.
 
 Here are some featured storybooks that you can reference to see how Storybook works:
 

package/dist/cjs/client/docs/config.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parameters = exports.decorators = exports.argTypesEnhancers = void 0;
+
+var _docsTools = require("@storybook/docs-tools");
+
+var _extractArgTypes = require("./extractArgTypes");
+
+var _jsxDecorator = require("./jsxDecorator");
+
+var parameters = {
+  docs: {
+    inlineStories: true,
+    // NOTE: that the result is a react element. Hooks support is provided by the outer code.
+    prepareForInline: function prepareForInline(storyFn) {
+      return storyFn();
+    },
+    extractArgTypes: _extractArgTypes.extractArgTypes,
+    extractComponentDescription: _docsTools.extractComponentDescription
+  }
+};
+exports.parameters = parameters;
+var decorators = [_jsxDecorator.jsxDecorator];
+exports.decorators = decorators;
+var argTypesEnhancers = [_docsTools.enhanceArgTypes];
+exports.argTypesEnhancers = argTypesEnhancers;

package/dist/cjs/client/docs/extractArgTypes.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractArgTypes = void 0;
+
+require("core-js/modules/es.object.to-string.js");
+
+require("core-js/modules/es.function.name.js");
+
+require("core-js/modules/es.symbol.js");
+
+require("core-js/modules/es.symbol.description.js");
+
+require("core-js/modules/es.object.assign.js");
+
+var _extractProps2 = require("./extractProps");
+
+var extractArgTypes = function extractArgTypes(component) {
+  if (component) {
+    var _extractProps = (0, _extractProps2.extractProps)(component),
+        rows = _extractProps.rows;
+
+    if (rows) {
+      return rows.reduce(function (acc, row) {
+        var name = row.name,
+            description = row.description,
+            type = row.type,
+            sbType = row.sbType,
+            defaultSummary = row.defaultValue,
+            jsDocTags = row.jsDocTags,
+            required = row.required;
+        acc[name] = {
+          name: name,
+          description: description,
+          type: Object.assign({
+            required: required
+          }, sbType),
+          table: {
+            type: type,
+            jsDocTags: jsDocTags,
+            defaultValue: defaultSummary
+          }
+        };
+        return acc;
+      }, {});
+    }
+  }
+
+  return null;
+};
+
+exports.extractArgTypes = extractArgTypes;

package/dist/cjs/client/docs/extractProps.js

@@ -0,0 +1,77 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractProps = void 0;
+
+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/web.dom-collections.for-each.js");
+
+require("core-js/modules/es.object.keys.js");
+
+require("core-js/modules/es.array.map.js");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _docsTools = require("@storybook/docs-tools");
+
+var _handleProp = require("./propTypes/handleProp");
+
+var _handleProp2 = require("./typeScript/handleProp");
+
+var _lib = require("./lib");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var propTypesMap = new Map();
+Object.keys(_propTypes.default).forEach(function (typeName) {
+  // @ts-ignore
+  var type = _propTypes.default[typeName];
+  propTypesMap.set(type, typeName);
+  propTypesMap.set(type.isRequired, typeName);
+});
+
+function getPropDefs(component, section) {
+  var processedComponent = component; // eslint-disable-next-line react/forbid-foreign-prop-types
+
+  if (!(0, _docsTools.hasDocgen)(component) && !component.propTypes && (0, _lib.isMemo)(component)) {
+    processedComponent = component.type;
+  }
+
+  var extractedProps = (0, _docsTools.extractComponentProps)(processedComponent, section);
+
+  if (extractedProps.length === 0) {
+    return [];
+  }
+
+  switch (extractedProps[0].typeSystem) {
+    case _docsTools.TypeSystem.JAVASCRIPT:
+      return (0, _handleProp.enhancePropTypesProps)(extractedProps, component);
+
+    case _docsTools.TypeSystem.TYPESCRIPT:
+      return (0, _handleProp2.enhanceTypeScriptProps)(extractedProps);
+
+    default:
+      return extractedProps.map(function (x) {
+        return x.propDef;
+      });
+  }
+}
+
+var extractProps = function extractProps(component) {
+  return {
+    rows: getPropDefs(component, 'props')
+  };
+};
+
+exports.extractProps = extractProps;

package/dist/cjs/client/docs/jsxDecorator.js

@@ -0,0 +1,277 @@
+"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.array.slice.js");
+
+require("core-js/modules/es.object.freeze.js");
+
+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.array.iterator.js");
+
+require("core-js/modules/es.string.iterator.js");
+
+require("core-js/modules/web.dom-collections.iterator.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.skipJsxRender = exports.renderJsx = exports.jsxDecorator = void 0;
+
+require("core-js/modules/es.function.name.js");
+
+require("core-js/modules/es.object.assign.js");
+
+require("core-js/modules/es.array.join.js");
+
+require("core-js/modules/es.array.map.js");
+
+require("core-js/modules/es.object.to-string.js");
+
+require("core-js/modules/es.regexp.to-string.js");
+
+require("core-js/modules/es.regexp.exec.js");
+
+require("core-js/modules/es.string.match.js");
+
+require("core-js/modules/web.dom-collections.for-each.js");
+
+require("core-js/modules/es.string.replace.js");
+
+require("core-js/modules/es.array.concat.js");
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _reactElementToJsxString = _interopRequireDefault(require("react-element-to-jsx-string"));
+
+var _tsDedent = _interopRequireDefault(require("ts-dedent"));
+
+var _utilDeprecate = _interopRequireDefault(require("util-deprecate"));
+
+var _addons = require("@storybook/addons");
+
+var _docsTools = require("@storybook/docs-tools");
+
+var _clientLogger = require("@storybook/client-logger");
+
+var _lib = require("./lib");
+
+var _excluded = ["mdxType", "originalType", "children"];
+
+var _templateObject;
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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 _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 _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread 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 _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+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 _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; }
+
+function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
+
+/** Run the user supplied onBeforeRender function if it exists */
+var applyBeforeRender = function applyBeforeRender(domString, options) {
+  if (typeof options.onBeforeRender !== 'function') {
+    return domString;
+  }
+
+  var deprecatedOnBeforeRender = (0, _utilDeprecate.default)(options.onBeforeRender, (0, _tsDedent.default)(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n      StoryFn.parameters.jsx.onBeforeRender was deprecated.\n      Prefer StoryFn.parameters.jsx.transformSource instead.\n      See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-onbeforerender for details.\n    "]))));
+  return deprecatedOnBeforeRender(domString);
+};
+/** Run the user supplied transformSource function if it exists */
+
+
+var applyTransformSource = function applyTransformSource(domString, options, context) {
+  if (typeof options.transformSource !== 'function') {
+    return domString;
+  }
+
+  return options.transformSource(domString, context);
+};
+/** Apply the users parameters and render the jsx for a story */
+
+
+var renderJsx = function renderJsx(code, options) {
+  if (typeof code === 'undefined') {
+    _clientLogger.logger.warn('Too many skip or undefined component');
+
+    return null;
+  }
+
+  var renderedJSX = code;
+  var Type = renderedJSX.type;
+
+  for (var i = 0; i < options.skip; i += 1) {
+    if (typeof renderedJSX === 'undefined') {
+      _clientLogger.logger.warn('Cannot skip undefined element');
+
+      return null;
+    }
+
+    if (_react.default.Children.count(renderedJSX) > 1) {
+      _clientLogger.logger.warn('Trying to skip an array of elements');
+
+      return null;
+    }
+
+    if (typeof renderedJSX.props.children === 'undefined') {
+      _clientLogger.logger.warn('Not enough children to skip elements.');
+
+      if (typeof renderedJSX.type === 'function' && renderedJSX.type.name === '') {
+        renderedJSX = /*#__PURE__*/_react.default.createElement(Type, renderedJSX.props);
+      }
+    } else if (typeof renderedJSX.props.children === 'function') {
+      renderedJSX = renderedJSX.props.children();
+    } else {
+      renderedJSX = renderedJSX.props.children;
+    }
+  }
+
+  var displayNameDefaults = typeof options.displayName === 'string' ? {
+    showFunctions: true,
+    displayName: function displayName() {
+      return options.displayName;
+    }
+  } : {
+    // To get exotic component names resolving properly
+    displayName: function displayName(el) {
+      return el.type.displayName || (0, _docsTools.getDocgenSection)(el.type, 'displayName') || (el.type.name !== '_default' ? el.type.name : null) || (typeof el.type === 'function' ? 'No Display Name' : null) || ((0, _lib.isForwardRef)(el.type) ? el.type.render.name : null) || ((0, _lib.isMemo)(el.type) ? el.type.type.name : null) || el.type;
+    }
+  };
+  var filterDefaults = {
+    filterProps: function filterProps(value, key) {
+      return value !== undefined;
+    }
+  };
+  var opts = Object.assign({}, displayNameDefaults, filterDefaults, options);
+
+  var result = _react.default.Children.map(code, function (c) {
+    // @ts-ignore FIXME: workaround react-element-to-jsx-string
+    var child = typeof c === 'number' ? c.toString() : c;
+    var string = applyBeforeRender((0, _reactElementToJsxString.default)(child, opts), options);
+
+    if (string.indexOf('&quot;') > -1) {
+      var matches = string.match(/\S+=\\"([^"]*)\\"/g);
+
+      if (matches) {
+        matches.forEach(function (match) {
+          string = string.replace(match, match.replace(/&quot;/g, "'"));
+        });
+      }
+    }
+
+    return string;
+  }).join('\n');
+
+  return result.replace(/function\s+noRefCheck\(\)\s+\{\}/, '() => {}');
+};
+
+exports.renderJsx = renderJsx;
+var defaultOpts = {
+  skip: 0,
+  showFunctions: false,
+  enableBeautify: true,
+  showDefaultProps: false
+};
+
+var skipJsxRender = function skipJsxRender(context) {
+  var _context$parameters$d;
+
+  var sourceParams = context === null || context === void 0 ? void 0 : (_context$parameters$d = context.parameters.docs) === null || _context$parameters$d === void 0 ? void 0 : _context$parameters$d.source;
+  var isArgsStory = context === null || context === void 0 ? void 0 : context.parameters.__isArgsStory; // always render if the user forces it
+
+  if ((sourceParams === null || sourceParams === void 0 ? void 0 : sourceParams.type) === _docsTools.SourceType.DYNAMIC) {
+    return false;
+  } // never render if the user is forcing the block to render code, or
+  // if the user provides code, or if it's not an args story.
+
+
+  return !isArgsStory || (sourceParams === null || sourceParams === void 0 ? void 0 : sourceParams.code) || (sourceParams === null || sourceParams === void 0 ? void 0 : sourceParams.type) === _docsTools.SourceType.CODE;
+};
+
+exports.skipJsxRender = skipJsxRender;
+
+var isMdx = function isMdx(node) {
+  var _node$type, _node$props;
+
+  return ((_node$type = node.type) === null || _node$type === void 0 ? void 0 : _node$type.displayName) === 'MDXCreateElement' && !!((_node$props = node.props) !== null && _node$props !== void 0 && _node$props.mdxType);
+};
+
+var mdxToJsx = function mdxToJsx(node) {
+  if (!isMdx(node)) return node;
+
+  var _node$props2 = node.props,
+      mdxType = _node$props2.mdxType,
+      originalType = _node$props2.originalType,
+      children = _node$props2.children,
+      rest = _objectWithoutProperties(_node$props2, _excluded);
+
+  var jsxChildren = [];
+
+  if (children) {
+    var array = Array.isArray(children) ? children : [children];
+    jsxChildren = array.map(mdxToJsx);
+  }
+
+  return /*#__PURE__*/_react.createElement.apply(void 0, [originalType, rest].concat(_toConsumableArray(jsxChildren)));
+};
+
+var jsxDecorator = function jsxDecorator(storyFn, context) {
+  var _context$parameters$d2, _context$parameters$d3;
+
+  var channel = _addons.addons.getChannel();
+
+  var skip = skipJsxRender(context);
+  var story = storyFn();
+  var jsx = '';
+  (0, _addons.useEffect)(function () {
+    if (!skip) channel.emit(_docsTools.SNIPPET_RENDERED, (context || {}).id, jsx);
+  }); // We only need to render JSX if the source block is actually going to
+  // consume it. Otherwise it's just slowing us down.
+
+  if (skip) {
+    return story;
+  }
+
+  var options = Object.assign({}, defaultOpts, (context === null || context === void 0 ? void 0 : context.parameters.jsx) || {}); // Exclude decorators from source code snippet by default
+
+  var storyJsx = context !== null && context !== void 0 && (_context$parameters$d2 = context.parameters.docs) !== null && _context$parameters$d2 !== void 0 && (_context$parameters$d3 = _context$parameters$d2.source) !== null && _context$parameters$d3 !== void 0 && _context$parameters$d3.excludeDecorators ? context.originalStoryFn(context.args, context) : story;
+  var sourceJsx = mdxToJsx(storyJsx);
+  var rendered = renderJsx(sourceJsx, options);
+
+  if (rendered) {
+    jsx = applyTransformSource(rendered, options, context);
+  }
+
+  return story;
+};
+
+exports.jsxDecorator = jsxDecorator;

package/dist/cjs/client/docs/lib/captions.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.OBJECT_CAPTION = exports.FUNCTION_CAPTION = exports.ELEMENT_CAPTION = exports.CUSTOM_CAPTION = exports.CLASS_CAPTION = exports.ARRAY_CAPTION = void 0;
+var CUSTOM_CAPTION = 'custom';
+exports.CUSTOM_CAPTION = CUSTOM_CAPTION;
+var OBJECT_CAPTION = 'object';
+exports.OBJECT_CAPTION = OBJECT_CAPTION;
+var ARRAY_CAPTION = 'array';
+exports.ARRAY_CAPTION = ARRAY_CAPTION;
+var CLASS_CAPTION = 'class';
+exports.CLASS_CAPTION = CLASS_CAPTION;
+var FUNCTION_CAPTION = 'func';
+exports.FUNCTION_CAPTION = FUNCTION_CAPTION;
+var ELEMENT_CAPTION = 'element';
+exports.ELEMENT_CAPTION = ELEMENT_CAPTION;

package/dist/cjs/client/docs/lib/componentTypes.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isMemo = exports.isForwardRef = void 0;
+
+require("core-js/modules/es.symbol.js");
+
+require("core-js/modules/es.symbol.description.js");
+
+require("core-js/modules/es.object.to-string.js");
+
+var isMemo = function isMemo(component) {
+  return component.$$typeof === Symbol.for('react.memo');
+};
+
+exports.isMemo = isMemo;
+
+var isForwardRef = function isForwardRef(component) {
+  return component.$$typeof === Symbol.for('react.forward_ref');
+};
+
+exports.isForwardRef = isForwardRef;

package/dist/cjs/client/docs/lib/defaultValues/createDefaultValue.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDefaultValue = createDefaultValue;
+
+var _docsTools = require("@storybook/docs-tools");
+
+var _captions = require("../captions");
+
+var _inspection = require("../inspection");
+
+var _isHtmlTag = require("../isHtmlTag");
+
+var _generateCode = require("../generateCode");
+
+var _generateObject = require("./generateObject");
+
+var _generateArray = require("./generateArray");
+
+var _prettyIdentifier = require("./prettyIdentifier");
+
+function generateFunc(_ref) {
+  var inferredType = _ref.inferredType,
+      ast = _ref.ast;
+  var _ref2 = inferredType,
+      identifier = _ref2.identifier;
+
+  if (identifier != null) {
+    return (0, _docsTools.createSummaryValue)((0, _prettyIdentifier.getPrettyIdentifier)(inferredType), (0, _generateCode.generateCode)(ast));
+  }
+
+  var prettyCaption = (0, _generateCode.generateCode)(ast, true);
+  return !(0, _docsTools.isTooLongForDefaultValueSummary)(prettyCaption) ? (0, _docsTools.createSummaryValue)(prettyCaption) : (0, _docsTools.createSummaryValue)(_captions.FUNCTION_CAPTION, (0, _generateCode.generateCode)(ast));
+} // All elements are JSX elements.
+// JSX elements are not supported by escodegen.
+
+
+function generateElement(defaultValue, inspectionResult) {
+  var inferredType = inspectionResult.inferredType;
+  var _ref3 = inferredType,
+      identifier = _ref3.identifier;
+
+  if (identifier != null) {
+    if (!(0, _isHtmlTag.isHtmlTag)(identifier)) {
+      var prettyIdentifier = (0, _prettyIdentifier.getPrettyIdentifier)(inferredType);
+      return (0, _docsTools.createSummaryValue)(prettyIdentifier, defaultValue);
+    }
+  }
+
+  return !(0, _docsTools.isTooLongForDefaultValueSummary)(defaultValue) ? (0, _docsTools.createSummaryValue)(defaultValue) : (0, _docsTools.createSummaryValue)(_captions.ELEMENT_CAPTION, defaultValue);
+}
+
+function createDefaultValue(defaultValue) {
+  try {
+    var inspectionResult = (0, _inspection.inspectValue)(defaultValue);
+
+    switch (inspectionResult.inferredType.type) {
+      case _inspection.InspectionType.OBJECT:
+        return (0, _generateObject.generateObject)(inspectionResult);
+
+      case _inspection.InspectionType.FUNCTION:
+        return generateFunc(inspectionResult);
+
+      case _inspection.InspectionType.ELEMENT:
+        return generateElement(defaultValue, inspectionResult);
+
+      case _inspection.InspectionType.ARRAY:
+        return (0, _generateArray.generateArray)(inspectionResult);
+
+      default:
+        return null;
+    }
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.error(e);
+  }
+
+  return null;
+}