@storybook/react 6.5.0-alpha.9 → 6.5.0-beta.0

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;
+}

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

@@ -0,0 +1,181 @@
+import isPlainObject from 'lodash/isPlainObject';
+import isFunction from 'lodash/isFunction';
+import isString from 'lodash/isString'; // @ts-ignore
+
+import reactElementToJSXString from 'react-element-to-jsx-string';
+import { createSummaryValue, isTooLongForDefaultValueSummary } from '@storybook/docs-tools';
+import { inspectValue } from '../inspection';
+import { generateObject } from './generateObject';
+import { generateArray } from './generateArray';
+import { getPrettyElementIdentifier, getPrettyFuncIdentifier } from './prettyIdentifier';
+import { OBJECT_CAPTION, FUNCTION_CAPTION, ELEMENT_CAPTION } from '../captions';
+import { isHtmlTag } from '../isHtmlTag';
+
+function isReactElement(element) {
+  return element.$$typeof != null;
+}
+
+export function extractFunctionName(func, propName) {
+  const {
+    name
+  } = func; // Comparison with the prop name is to discard inferred function names.
+
+  if (name !== '' && name !== 'anonymous' && name !== propName) {
+    return name;
+  }
+
+  return null;
+}
+
+const stringResolver = rawDefaultProp => {
+  return createSummaryValue(JSON.stringify(rawDefaultProp));
+};
+
+function generateReactObject(rawDefaultProp) {
+  const {
+    type
+  } = rawDefaultProp;
+  const {
+    displayName
+  } = type;
+  const jsx = reactElementToJSXString(rawDefaultProp, {});
+
+  if (displayName != null) {
+    const prettyIdentifier = getPrettyElementIdentifier(displayName);
+    return createSummaryValue(prettyIdentifier, jsx);
+  }
+
+  if (isString(type)) {
+    // This is an HTML element.
+    if (isHtmlTag(type)) {
+      const jsxCompact = reactElementToJSXString(rawDefaultProp, {
+        tabStop: 0
+      });
+      const jsxSummary = jsxCompact.replace(/\r?\n|\r/g, '');
+
+      if (!isTooLongForDefaultValueSummary(jsxSummary)) {
+        return createSummaryValue(jsxSummary);
+      }
+    }
+  }
+
+  return createSummaryValue(ELEMENT_CAPTION, jsx);
+}
+
+const objectResolver = rawDefaultProp => {
+  if (isReactElement(rawDefaultProp) && rawDefaultProp.type != null) {
+    return generateReactObject(rawDefaultProp);
+  }
+
+  if (isPlainObject(rawDefaultProp)) {
+    const inspectionResult = inspectValue(JSON.stringify(rawDefaultProp));
+    return generateObject(inspectionResult);
+  }
+
+  if (Array.isArray(rawDefaultProp)) {
+    const inspectionResult = inspectValue(JSON.stringify(rawDefaultProp));
+    return generateArray(inspectionResult);
+  }
+
+  return createSummaryValue(OBJECT_CAPTION);
+};
+
+const functionResolver = (rawDefaultProp, propDef) => {
+  let isElement = false;
+  let inspectionResult; // Try to display the name of the component. The body of the component is omitted since the code has been transpiled.
+
+  if (isFunction(rawDefaultProp.render)) {
+    isElement = true;
+  } else if (rawDefaultProp.prototype != null && isFunction(rawDefaultProp.prototype.render)) {
+    isElement = true;
+  } else {
+    let innerElement;
+
+    try {
+      inspectionResult = inspectValue(rawDefaultProp.toString());
+      const {
+        hasParams,
+        params
+      } = inspectionResult.inferredType;
+
+      if (hasParams) {
+        // It might be a functional component accepting props.
+        if (params.length === 1 && params[0].type === 'ObjectPattern') {
+          innerElement = rawDefaultProp({});
+        }
+      } else {
+        innerElement = rawDefaultProp();
+      }
+
+      if (innerElement != null) {
+        if (isReactElement(innerElement)) {
+          isElement = true;
+        }
+      }
+    } catch (e) {// do nothing.
+    }
+  }
+
+  const funcName = extractFunctionName(rawDefaultProp, propDef.name);
+
+  if (funcName != null) {
+    if (isElement) {
+      return createSummaryValue(getPrettyElementIdentifier(funcName));
+    }
+
+    if (inspectionResult != null) {
+      inspectionResult = inspectValue(rawDefaultProp.toString());
+    }
+
+    const {
+      hasParams
+    } = inspectionResult.inferredType;
+    return createSummaryValue(getPrettyFuncIdentifier(funcName, hasParams));
+  }
+
+  return createSummaryValue(isElement ? ELEMENT_CAPTION : FUNCTION_CAPTION);
+};
+
+const defaultResolver = rawDefaultProp => {
+  return createSummaryValue(rawDefaultProp.toString());
+};
+
+const DEFAULT_TYPE_RESOLVERS = {
+  string: stringResolver,
+  object: objectResolver,
+  function: functionResolver,
+  default: defaultResolver
+};
+export function createTypeResolvers(customResolvers = {}) {
+  return Object.assign({}, DEFAULT_TYPE_RESOLVERS, customResolvers);
+} // When react-docgen cannot provide a defaultValue we take it from the raw defaultProp.
+// It works fine for types that are not transpiled. For the types that are transpiled, we can only provide partial support.
+// This means that:
+//   - The detail might not be available.
+//   - Identifiers might not be "prettified" for all the types.
+
+export function createDefaultValueFromRawDefaultProp(rawDefaultProp, propDef, typeResolvers = DEFAULT_TYPE_RESOLVERS) {
+  try {
+    // Keep the extra () otherwise it will fail for functions.
+    switch (typeof rawDefaultProp) {
+      case 'string':
+        return typeResolvers.string(rawDefaultProp, propDef);
+
+      case 'object':
+        return typeResolvers.object(rawDefaultProp, propDef);
+
+      case 'function':
+        {
+          return typeResolvers.function(rawDefaultProp, propDef);
+        }
+
+      default:
+        return typeResolvers.default(rawDefaultProp, propDef);
+    }
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.error(e);
+  }
+
+  return null;
+}

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

@@ -0,0 +1,21 @@
+import { createSummaryValue, isTooLongForDefaultValueSummary } from '@storybook/docs-tools';
+import { ARRAY_CAPTION } from '../captions';
+import { generateArrayCode } from '../generateCode';
+export function generateArray({
+  inferredType,
+  ast
+}) {
+  const {
+    depth
+  } = inferredType;
+
+  if (depth <= 2) {
+    const compactArray = generateArrayCode(ast, true);
+
+    if (!isTooLongForDefaultValueSummary(compactArray)) {
+      return createSummaryValue(compactArray);
+    }
+  }
+
+  return createSummaryValue(ARRAY_CAPTION, generateArrayCode(ast));
+}

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

@@ -0,0 +1,21 @@
+import { createSummaryValue, isTooLongForDefaultValueSummary } from '@storybook/docs-tools';
+import { OBJECT_CAPTION } from '../captions';
+import { generateObjectCode } from '../generateCode';
+export function generateObject({
+  inferredType,
+  ast
+}) {
+  const {
+    depth
+  } = inferredType;
+
+  if (depth === 1) {
+    const compactObject = generateObjectCode(ast, true);
+
+    if (!isTooLongForDefaultValueSummary(compactObject)) {
+      return createSummaryValue(compactObject);
+    }
+  }
+
+  return createSummaryValue(OBJECT_CAPTION, generateObjectCode(ast));
+}

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

@@ -0,0 +1,2 @@
+export * from './createDefaultValue';
+export * from './createFromRawDefaultProp';

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

@@ -0,0 +1,24 @@
+import { InspectionType } from '../inspection';
+export function getPrettyIdentifier(inferredType) {
+  const {
+    type,
+    identifier
+  } = inferredType;
+
+  switch (type) {
+    case InspectionType.FUNCTION:
+      return getPrettyFuncIdentifier(identifier, inferredType.hasParams);
+
+    case InspectionType.ELEMENT:
+      return getPrettyElementIdentifier(identifier);
+
+    default:
+      return identifier;
+  }
+}
+export function getPrettyFuncIdentifier(identifier, hasArguments) {
+  return hasArguments ? `${identifier}( ... )` : `${identifier}()`;
+}
+export function getPrettyElementIdentifier(identifier) {
+  return `<${identifier} />`;
+}

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

@@ -0,0 +1,59 @@
+import { generate } from 'escodegen';
+import dedent from 'ts-dedent';
+const BASIC_OPTIONS = {
+  format: {
+    indent: {
+      style: '  '
+    },
+    semicolons: false
+  }
+};
+const COMPACT_OPTIONS = Object.assign({}, BASIC_OPTIONS, {
+  format: {
+    newline: ''
+  }
+});
+const PRETTY_OPTIONS = Object.assign({}, BASIC_OPTIONS);
+export function generateCode(ast, compact = false) {
+  return generate(ast, compact ? COMPACT_OPTIONS : PRETTY_OPTIONS);
+}
+export function generateObjectCode(ast, compact = false) {
+  return !compact ? generateCode(ast) : generateCompactObjectCode(ast);
+}
+
+function generateCompactObjectCode(ast) {
+  let result = generateCode(ast, true); // Cannot get escodegen to add a space before the last } with the compact mode settings.
+  // Fix it until a better solution is found.
+
+  if (!result.endsWith(' }')) {
+    result = `${result.slice(0, -1)} }`;
+  }
+
+  return result;
+}
+
+export function generateArrayCode(ast, compact = false) {
+  return !compact ? generateMultilineArrayCode(ast) : generateCompactArrayCode(ast);
+}
+
+function generateMultilineArrayCode(ast) {
+  let result = generateCode(ast); // escodegen add extra spacing before the closing bracket of a multiple line array with a nested object.
+  // Fix it until a better solution is found.
+
+  if (result.endsWith('  }]')) {
+    result = dedent(result);
+  }
+
+  return result;
+}
+
+function generateCompactArrayCode(ast) {
+  let result = generateCode(ast, true); // escodegen add extra an extra before the opening bracket of a compact array that contains primitive values.
+  // Fix it until a better solution is found.
+
+  if (result.startsWith('[    ')) {
+    result = result.replace('[    ', '[');
+  }
+
+  return result;
+}

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

@@ -0,0 +1,4 @@
+export * from './captions';
+export * from './isHtmlTag';
+export * from './generateCode';
+export * from './componentTypes';