@storybook/addon-docs 6.5.0-alpha.6 → 6.5.0-alpha.62

package/dist/modern/frameworks/ember/config.js

@@ -1,8 +0,0 @@
-import { extractArgTypes, extractComponentDescription } from './jsondoc';
-export const parameters = {
-  docs: {
-    iframeHeight: 80,
-    extractArgTypes,
-    extractComponentDescription
-  }
-};

package/dist/modern/frameworks/ember/index.js

@@ -1 +0,0 @@
-export { setJSONDoc } from './jsondoc';

package/dist/modern/frameworks/ember/jsondoc.js

@@ -1,57 +0,0 @@
-import "core-js/modules/es.array.reduce.js";
-
-/* eslint-disable no-underscore-dangle */
-
-/* global window */
-export const setJSONDoc = jsondoc => {
-  window.__EMBER_GENERATED_DOC_JSON__ = jsondoc;
-};
-export const getJSONDoc = () => {
-  return window.__EMBER_GENERATED_DOC_JSON__;
-};
-export const extractArgTypes = componentName => {
-  const json = getJSONDoc();
-
-  if (!(json && json.included)) {
-    return null;
-  }
-
-  const componentDoc = json.included.find(doc => doc.attributes.name === componentName);
-
-  if (!componentDoc) {
-    return null;
-  }
-
-  return componentDoc.attributes.arguments.reduce((acc, prop) => {
-    acc[prop.name] = {
-      name: prop.name,
-      defaultValue: prop.defaultValue,
-      description: prop.description,
-      table: {
-        defaultValue: {
-          summary: prop.defaultValue
-        },
-        type: {
-          summary: prop.type,
-          required: prop.tags.length ? prop.tags.some(tag => tag.name === 'required') : false
-        }
-      }
-    };
-    return acc;
-  }, {});
-};
-export const extractComponentDescription = componentName => {
-  const json = getJSONDoc();
-
-  if (!(json && json.included)) {
-    return null;
-  }
-
-  const componentDoc = json.included.find(doc => doc.attributes.name === componentName);
-
-  if (!componentDoc) {
-    return null;
-  }
-
-  return componentDoc.attributes.description;
-};

package/dist/modern/frameworks/html/config.js

@@ -1,14 +0,0 @@
-import { sourceDecorator } from './sourceDecorator';
-import { prepareForInline } from './prepareForInline';
-import { SourceType } from '../../shared';
-export const decorators = [sourceDecorator];
-export const parameters = {
-  docs: {
-    inlineStories: true,
-    prepareForInline,
-    source: {
-      type: SourceType.DYNAMIC,
-      language: 'html'
-    }
-  }
-};

package/dist/modern/frameworks/html/prepareForInline.js

@@ -1,17 +0,0 @@
-import React from 'react';
-export function prepareForInline(storyFn) {
-  const html = storyFn();
-
-  if (typeof html === 'string') {
-    // eslint-disable-next-line react/no-danger
-    return /*#__PURE__*/React.createElement("div", {
-      dangerouslySetInnerHTML: {
-        __html: html
-      }
-    });
-  }
-
-  return /*#__PURE__*/React.createElement("div", {
-    ref: node => node ? node.appendChild(html) : null
-  });
-}

package/dist/modern/frameworks/html/sourceDecorator.js

@@ -1,56 +0,0 @@
-/* global window */
-import { addons, useEffect } from '@storybook/addons';
-import dedent from 'ts-dedent';
-import { SNIPPET_RENDERED, SourceType } from '../../shared';
-
-function skipSourceRender(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;
-} // By default, just remove indentation
-
-
-function defaultTransformSource(source) {
-  // Have to wrap dedent so it doesn't serialize the context
-  return dedent(source);
-}
-
-function applyTransformSource(source, context) {
-  var _context$parameters$d2, _docs$transformSource;
-
-  const docs = (_context$parameters$d2 = context.parameters.docs) !== null && _context$parameters$d2 !== void 0 ? _context$parameters$d2 : {};
-  const transformSource = (_docs$transformSource = docs.transformSource) !== null && _docs$transformSource !== void 0 ? _docs$transformSource : defaultTransformSource;
-  return transformSource(source, context);
-}
-
-export function sourceDecorator(storyFn, context) {
-  var _context$parameters$d3, _context$parameters$d4;
-
-  const story = context !== null && context !== void 0 && (_context$parameters$d3 = context.parameters.docs) !== null && _context$parameters$d3 !== void 0 && (_context$parameters$d4 = _context$parameters$d3.source) !== null && _context$parameters$d4 !== void 0 && _context$parameters$d4.excludeDecorators ? context.originalStoryFn(context.args, context) : storyFn();
-  let source;
-
-  if (!skipSourceRender(context)) {
-    if (typeof story === 'string') {
-      source = story;
-    } // eslint-disable-next-line no-undef
-    else if (story instanceof Element) {
-        source = story.outerHTML;
-      }
-
-    if (source) source = applyTransformSource(source, context);
-  }
-
-  useEffect(() => {
-    if (source) addons.getChannel().emit(SNIPPET_RENDERED, context.id, source);
-  });
-  return story;
-}

package/dist/modern/frameworks/react/config.js

@@ -1,13 +0,0 @@
-import { extractArgTypes } from './extractArgTypes';
-import { extractComponentDescription } from '../../lib/docgen';
-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];

package/dist/modern/frameworks/react/extractArgTypes.js

@@ -1,38 +0,0 @@
-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/frameworks/react/extractProps.js

@@ -1,41 +0,0 @@
-import PropTypes from 'prop-types';
-import { hasDocgen, extractComponentProps, TypeSystem } from '../../lib/docgen';
-import { enhancePropTypesProps } from './propTypes/handleProp';
-import { enhanceTypeScriptProps } from './typeScript/handleProp';
-import { isMemo } from './lib';
-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/frameworks/react/jsxDecorator.js

@@ -1,176 +0,0 @@
-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 { logger } from '@storybook/client-logger';
-import { SourceType, SNIPPET_RENDERED } from '../../shared';
-import { getDocgenSection } from '../../lib/docgen';
-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, ["mdxType", "originalType", "children"]);
-
-  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/frameworks/react/lib/captions.js

@@ -1,6 +0,0 @@
-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/frameworks/react/lib/componentTypes.js

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

package/dist/modern/frameworks/react/lib/defaultValues/createDefaultValue.js

@@ -1,72 +0,0 @@
-import { FUNCTION_CAPTION, ELEMENT_CAPTION } from '../captions';
-import { InspectionType, inspectValue } from '../inspection';
-import { isHtmlTag } from '../isHtmlTag';
-import { createSummaryValue, isTooLongForDefaultValueSummary } from '../../../../lib';
-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;
-}