@storybook/react 6.5.0-alpha.47 → 6.5.0-alpha.48

package/dist/esm/client/docs/react-argtypes.stories.js

@@ -0,0 +1,97 @@
+import "core-js/modules/es.object.assign.js";
+import "core-js/modules/es.array.map.js";
+import "core-js/modules/es.object.entries.js";
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.symbol.description.js";
+import "core-js/modules/es.symbol.iterator.js";
+import "core-js/modules/es.array.iterator.js";
+import "core-js/modules/es.string.iterator.js";
+import "core-js/modules/web.dom-collections.iterator.js";
+import "core-js/modules/es.array.slice.js";
+import "core-js/modules/es.function.name.js";
+import "core-js/modules/es.array.from.js";
+import "core-js/modules/es.regexp.exec.js";
+
+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; }
+
+import React, { useState } from 'react';
+import mapValues from 'lodash/mapValues';
+import { ArgsTable } from '@storybook/components';
+import { inferControls } from '@storybook/store';
+import { storiesOf } from '..';
+import { extractArgTypes } from './extractArgTypes'; // FIXME
+
+var argsTableProps = function argsTableProps(component) {
+  var argTypes = extractArgTypes(component);
+  var parameters = {
+    __isArgsStory: true
+  };
+  var rows = inferControls({
+    argTypes: argTypes,
+    parameters: parameters
+  });
+  return {
+    rows: rows
+  };
+};
+
+var ArgsStory = function ArgsStory(_ref) {
+  var component = _ref.component;
+
+  var _argsTableProps = argsTableProps(component),
+      rows = _argsTableProps.rows;
+
+  var initialArgs = mapValues(rows, function (argType) {
+    return argType.defaultValue;
+  });
+
+  var _useState = useState(initialArgs),
+      _useState2 = _slicedToArray(_useState, 2),
+      args = _useState2[0],
+      setArgs = _useState2[1];
+
+  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("p", null, /*#__PURE__*/React.createElement("b", null, "NOTE:"), " these stories are to help visualise the snapshot tests in", ' ', /*#__PURE__*/React.createElement("code", null, "./react-properties.test.js"), "."), /*#__PURE__*/React.createElement(ArgsTable, {
+    rows: rows,
+    args: args,
+    updateArgs: function updateArgs(val) {
+      return setArgs(Object.assign({}, args, val));
+    }
+  }), /*#__PURE__*/React.createElement("table", null, /*#__PURE__*/React.createElement("thead", null, /*#__PURE__*/React.createElement("tr", null, /*#__PURE__*/React.createElement("th", null, "arg name"), /*#__PURE__*/React.createElement("th", null, "argType"))), /*#__PURE__*/React.createElement("tbody", null, Object.entries(args).map(function (_ref2) {
+    var _ref3 = _slicedToArray(_ref2, 2),
+        key = _ref3[0],
+        val = _ref3[1];
+
+    return /*#__PURE__*/React.createElement("tr", {
+      key: key
+    }, /*#__PURE__*/React.createElement("td", null, /*#__PURE__*/React.createElement("code", null, key)), /*#__PURE__*/React.createElement("td", null, /*#__PURE__*/React.createElement("pre", null, JSON.stringify(rows[key]))));
+  }))));
+};
+
+var issuesFixtures = ['js-class-component', 'js-function-component', 'js-function-component-inline-defaults', 'js-function-component-inline-defaults-no-propTypes', 'ts-function-component', 'ts-function-component-inline-defaults', '9399-js-proptypes-shape', '8663-js-styled-components', '9626-js-default-values', '9668-js-proptypes-no-jsdoc', '8143-ts-react-fc-generics', '8143-ts-imported-types', '8279-js-styled-docgen', '8140-js-prop-types-oneof', '9023-js-hoc', '8740-ts-multi-props', '9556-ts-react-default-exports', '9592-ts-styled-props', '9591-ts-import-types', '9721-ts-deprecated-jsdoc', '9827-ts-default-values', '9586-js-react-memo', '9575-ts-camel-case', '9493-ts-display-name', '8894-9511-ts-forward-ref', '9465-ts-type-props', '8428-js-static-prop-types', '9764-ts-extend-props', '9922-ts-component-props'];
+var issuesStories = storiesOf('ArgTypes/Issues', module);
+issuesFixtures.forEach(function (fixture) {
+  // eslint-disable-next-line import/no-dynamic-require, global-require
+  var _require = require("./__testfixtures__/".concat(fixture, "/input")),
+      component = _require.component;
+
+  issuesStories.add(fixture, function () {
+    return /*#__PURE__*/React.createElement(ArgsStory, {
+      component: component
+    });
+  }, {
+    chromatic: {
+      disable: true
+    }
+  });
+});

package/dist/esm/client/docs/typeScript/handleProp.js

@@ -0,0 +1,27 @@
+import "core-js/modules/es.array.map.js";
+import { createDefaultValue, createDefaultValueFromRawDefaultProp } from '../lib/defaultValues';
+export function enhanceTypeScriptProp(extractedProp, rawDefaultProp) {
+  var propDef = extractedProp.propDef;
+  var defaultValue = extractedProp.docgenInfo.defaultValue;
+
+  if (defaultValue != null && defaultValue.value != null) {
+    var newDefaultValue = createDefaultValue(defaultValue.value);
+
+    if (newDefaultValue != null) {
+      propDef.defaultValue = newDefaultValue;
+    }
+  } else if (rawDefaultProp != null) {
+    var _newDefaultValue = createDefaultValueFromRawDefaultProp(rawDefaultProp, propDef);
+
+    if (_newDefaultValue != null) {
+      propDef.defaultValue = _newDefaultValue;
+    }
+  }
+
+  return propDef;
+}
+export function enhanceTypeScriptProps(extractedProps) {
+  return extractedProps.map(function (prop) {
+    return enhanceTypeScriptProp(prop);
+  });
+}

package/dist/esm/server/{framework-preset-react-docgen.js → framework-preset-react-docs.js}

@@ -5,11 +5,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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; }
 
 import "core-js/modules/es.promise.js";
+import { findDistEsm } from '@storybook/core-common';
 import ReactDocgenTypescriptPlugin from '@storybook/react-docgen-typescript-plugin';
-export async function babel(config, {
-  presets: presets
-}) {
-  var typescriptOptions = await presets.apply('typescript', {});
+import { hasDocsOrControls } from '@storybook/docs-tools';
+export async function babel(config, options) {
+  if (!hasDocsOrControls(options)) return config;
+  var typescriptOptions = await options.presets.apply('typescript', {});
   var reactDocgen = typescriptOptions.reactDocgen;
 
   if (typeof reactDocgen !== 'string') {
@@ -25,10 +26,9 @@ export async function babel(config, {
     }]
   });
 }
-export async function webpackFinal(config, {
-  presets: presets
-}) {
-  var typescriptOptions = await presets.apply('typescript', {});
+export async function webpackFinal(config, options) {
+  if (!hasDocsOrControls(options)) return config;
+  var typescriptOptions = await options.presets.apply('typescript', {});
   var reactDocgen = typescriptOptions.reactDocgen,
       reactDocgenTypescriptOptions = typescriptOptions.reactDocgenTypescriptOptions;
 
@@ -42,4 +42,8 @@ export async function webpackFinal(config, {
       savePropValueAsString: true
     }))]
   });
-}
+}
+export var config = function (entry = [], options) {
+  if (!hasDocsOrControls(options)) return entry;
+  return [...entry, findDistEsm(__dirname, 'client/docs/config')];
+};

package/dist/esm/server/preset.js

@@ -2,4 +2,4 @@ import { findDistEsm } from '@storybook/core-common';
 export var config = function (entries = []) {
   return [...entries, findDistEsm(__dirname, 'client/preview/config')];
 };
-export var addons = [require.resolve('./framework-preset-react'), require.resolve('./framework-preset-cra'), require.resolve('./framework-preset-react-docgen')];
+export var addons = [require.resolve('./framework-preset-react'), require.resolve('./framework-preset-cra'), require.resolve('./framework-preset-react-docs')];

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

@@ -0,0 +1,14 @@
+import { extractComponentDescription, enhanceArgTypes } from '@storybook/docs-tools';
+import { extractArgTypes } from './extractArgTypes';
+import { jsxDecorator } from './jsxDecorator';
+export const parameters = {
+  docs: {
+    inlineStories: true,
+    // NOTE: that the result is a react element. Hooks support is provided by the outer code.
+    prepareForInline: storyFn => storyFn(),
+    extractArgTypes,
+    extractComponentDescription
+  }
+};
+export const decorators = [jsxDecorator];
+export const argTypesEnhancers = [enhanceArgTypes];

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

@@ -0,0 +1,38 @@
+import "core-js/modules/es.array.reduce.js";
+import { extractProps } from './extractProps';
+export const extractArgTypes = component => {
+  if (component) {
+    const {
+      rows
+    } = extractProps(component);
+
+    if (rows) {
+      return rows.reduce((acc, row) => {
+        const {
+          name,
+          description,
+          type,
+          sbType,
+          defaultValue: defaultSummary,
+          jsDocTags,
+          required
+        } = row;
+        acc[name] = {
+          name,
+          description,
+          type: Object.assign({
+            required
+          }, sbType),
+          table: {
+            type,
+            jsDocTags,
+            defaultValue: defaultSummary
+          }
+        };
+        return acc;
+      }, {});
+    }
+  }
+
+  return null;
+};

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

@@ -0,0 +1,42 @@
+import PropTypes from 'prop-types';
+import { hasDocgen, extractComponentProps, TypeSystem } from '@storybook/docs-tools';
+import { enhancePropTypesProps } from './propTypes/handleProp';
+import { enhanceTypeScriptProps } from './typeScript/handleProp';
+import { isMemo } from './lib'; // FIXME
+
+const propTypesMap = new Map();
+Object.keys(PropTypes).forEach(typeName => {
+  // @ts-ignore
+  const type = PropTypes[typeName];
+  propTypesMap.set(type, typeName);
+  propTypesMap.set(type.isRequired, typeName);
+});
+
+function getPropDefs(component, section) {
+  let processedComponent = component; // eslint-disable-next-line react/forbid-foreign-prop-types
+
+  if (!hasDocgen(component) && !component.propTypes && isMemo(component)) {
+    processedComponent = component.type;
+  }
+
+  const extractedProps = extractComponentProps(processedComponent, section);
+
+  if (extractedProps.length === 0) {
+    return [];
+  }
+
+  switch (extractedProps[0].typeSystem) {
+    case TypeSystem.JAVASCRIPT:
+      return enhancePropTypesProps(extractedProps, component);
+
+    case TypeSystem.TYPESCRIPT:
+      return enhanceTypeScriptProps(extractedProps);
+
+    default:
+      return extractedProps.map(x => x.propDef);
+  }
+}
+
+export const extractProps = component => ({
+  rows: getPropDefs(component, 'props')
+});

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

@@ -0,0 +1,177 @@
+const _excluded = ["mdxType", "originalType", "children"];
+
+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; }
+
+import React, { createElement } from 'react';
+import reactElementToJSXString from 'react-element-to-jsx-string';
+import dedent from 'ts-dedent';
+import deprecate from 'util-deprecate';
+import { addons, useEffect } from '@storybook/addons';
+import { SourceType, SNIPPET_RENDERED, getDocgenSection } from '@storybook/docs-tools';
+import { logger } from '@storybook/client-logger';
+import { isMemo, isForwardRef } from './lib';
+
+/** Run the user supplied onBeforeRender function if it exists */
+const applyBeforeRender = (domString, options) => {
+  if (typeof options.onBeforeRender !== 'function') {
+    return domString;
+  }
+
+  const deprecatedOnBeforeRender = deprecate(options.onBeforeRender, dedent`
+      StoryFn.parameters.jsx.onBeforeRender was deprecated.
+      Prefer StoryFn.parameters.jsx.transformSource instead.
+      See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-onbeforerender for details.
+    `);
+  return deprecatedOnBeforeRender(domString);
+};
+/** Run the user supplied transformSource function if it exists */
+
+
+const 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 */
+
+
+export const renderJsx = (code, options) => {
+  if (typeof code === 'undefined') {
+    logger.warn('Too many skip or undefined component');
+    return null;
+  }
+
+  let renderedJSX = code;
+  const Type = renderedJSX.type;
+
+  for (let i = 0; i < options.skip; i += 1) {
+    if (typeof renderedJSX === 'undefined') {
+      logger.warn('Cannot skip undefined element');
+      return null;
+    }
+
+    if (React.Children.count(renderedJSX) > 1) {
+      logger.warn('Trying to skip an array of elements');
+      return null;
+    }
+
+    if (typeof renderedJSX.props.children === 'undefined') {
+      logger.warn('Not enough children to skip elements.');
+
+      if (typeof renderedJSX.type === 'function' && renderedJSX.type.name === '') {
+        renderedJSX = /*#__PURE__*/React.createElement(Type, renderedJSX.props);
+      }
+    } else if (typeof renderedJSX.props.children === 'function') {
+      renderedJSX = renderedJSX.props.children();
+    } else {
+      renderedJSX = renderedJSX.props.children;
+    }
+  }
+
+  const displayNameDefaults = typeof options.displayName === 'string' ? {
+    showFunctions: true,
+    displayName: () => options.displayName
+  } : {
+    // To get exotic component names resolving properly
+    displayName: el => el.type.displayName || getDocgenSection(el.type, 'displayName') || (el.type.name !== '_default' ? el.type.name : null) || (typeof el.type === 'function' ? 'No Display Name' : null) || (isForwardRef(el.type) ? el.type.render.name : null) || (isMemo(el.type) ? el.type.type.name : null) || el.type
+  };
+  const filterDefaults = {
+    filterProps: (value, key) => value !== undefined
+  };
+  const opts = Object.assign({}, displayNameDefaults, filterDefaults, options);
+  const result = React.Children.map(code, c => {
+    // @ts-ignore FIXME: workaround react-element-to-jsx-string
+    const child = typeof c === 'number' ? c.toString() : c;
+    let string = applyBeforeRender(reactElementToJSXString(child, opts), options);
+
+    if (string.indexOf('&quot;') > -1) {
+      const matches = string.match(/\S+=\\"([^"]*)\\"/g);
+
+      if (matches) {
+        matches.forEach(match => {
+          string = string.replace(match, match.replace(/&quot;/g, "'"));
+        });
+      }
+    }
+
+    return string;
+  }).join('\n');
+  return result.replace(/function\s+noRefCheck\(\)\s+\{\}/, '() => {}');
+};
+const defaultOpts = {
+  skip: 0,
+  showFunctions: false,
+  enableBeautify: true,
+  showDefaultProps: false
+};
+export const skipJsxRender = context => {
+  var _context$parameters$d;
+
+  const 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;
+  const 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) === 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) === SourceType.CODE;
+};
+
+const 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);
+};
+
+const mdxToJsx = node => {
+  if (!isMdx(node)) return node;
+
+  const _node$props2 = node.props,
+        {
+    originalType,
+    children
+  } = _node$props2,
+        rest = _objectWithoutPropertiesLoose(_node$props2, _excluded);
+
+  let jsxChildren = [];
+
+  if (children) {
+    const array = Array.isArray(children) ? children : [children];
+    jsxChildren = array.map(mdxToJsx);
+  }
+
+  return /*#__PURE__*/createElement(originalType, rest, ...jsxChildren);
+};
+
+export const jsxDecorator = (storyFn, context) => {
+  var _context$parameters$d2, _context$parameters$d3;
+
+  const channel = addons.getChannel();
+  const skip = skipJsxRender(context);
+  const story = storyFn();
+  let jsx = '';
+  useEffect(() => {
+    if (!skip) channel.emit(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;
+  }
+
+  const options = Object.assign({}, defaultOpts, (context === null || context === void 0 ? void 0 : context.parameters.jsx) || {}); // Exclude decorators from source code snippet by default
+
+  const 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;
+  const sourceJsx = mdxToJsx(storyJsx);
+  const rendered = renderJsx(sourceJsx, options);
+
+  if (rendered) {
+    jsx = applyTransformSource(rendered, options, context);
+  }
+
+  return story;
+};

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

@@ -0,0 +1,6 @@
+export const CUSTOM_CAPTION = 'custom';
+export const OBJECT_CAPTION = 'object';
+export const ARRAY_CAPTION = 'array';
+export const CLASS_CAPTION = 'class';
+export const FUNCTION_CAPTION = 'func';
+export const ELEMENT_CAPTION = 'element';

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

@@ -0,0 +1,2 @@
+export const isMemo = component => component.$$typeof === Symbol.for('react.memo');
+export const isForwardRef = component => component.$$typeof === Symbol.for('react.forward_ref');

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

@@ -0,0 +1,72 @@
+import { createSummaryValue, isTooLongForDefaultValueSummary } from '@storybook/docs-tools';
+import { FUNCTION_CAPTION, ELEMENT_CAPTION } from '../captions';
+import { InspectionType, inspectValue } from '../inspection';
+import { isHtmlTag } from '../isHtmlTag';
+import { generateCode } from '../generateCode';
+import { generateObject } from './generateObject';
+import { generateArray } from './generateArray';
+import { getPrettyIdentifier } from './prettyIdentifier';
+
+function generateFunc({
+  inferredType,
+  ast
+}) {
+  const {
+    identifier
+  } = inferredType;
+
+  if (identifier != null) {
+    return createSummaryValue(getPrettyIdentifier(inferredType), generateCode(ast));
+  }
+
+  const prettyCaption = generateCode(ast, true);
+  return !isTooLongForDefaultValueSummary(prettyCaption) ? createSummaryValue(prettyCaption) : createSummaryValue(FUNCTION_CAPTION, generateCode(ast));
+} // All elements are JSX elements.
+// JSX elements are not supported by escodegen.
+
+
+function generateElement(defaultValue, inspectionResult) {
+  const {
+    inferredType
+  } = inspectionResult;
+  const {
+    identifier
+  } = inferredType;
+
+  if (identifier != null) {
+    if (!isHtmlTag(identifier)) {
+      const prettyIdentifier = getPrettyIdentifier(inferredType);
+      return createSummaryValue(prettyIdentifier, defaultValue);
+    }
+  }
+
+  return !isTooLongForDefaultValueSummary(defaultValue) ? createSummaryValue(defaultValue) : createSummaryValue(ELEMENT_CAPTION, defaultValue);
+}
+
+export function createDefaultValue(defaultValue) {
+  try {
+    const inspectionResult = inspectValue(defaultValue);
+
+    switch (inspectionResult.inferredType.type) {
+      case InspectionType.OBJECT:
+        return generateObject(inspectionResult);
+
+      case InspectionType.FUNCTION:
+        return generateFunc(inspectionResult);
+
+      case InspectionType.ELEMENT:
+        return generateElement(defaultValue, inspectionResult);
+
+      case InspectionType.ARRAY:
+        return generateArray(inspectionResult);
+
+      default:
+        return null;
+    }
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.error(e);
+  }
+
+  return null;
+}