@storybook/addon-docs 6.5.0-alpha.5 → 6.5.0-alpha.52

package/dist/esm/lib/jsdocParser.js

@@ -1,207 +0,0 @@
-import "core-js/modules/es.array.includes.js";
-import "core-js/modules/es.string.includes.js";
-import "core-js/modules/es.symbol.js";
-import "core-js/modules/es.symbol.description.js";
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.string.replace.js";
-import "core-js/modules/es.regexp.exec.js";
-import "core-js/modules/es.array.map.js";
-import "core-js/modules/es.array.concat.js";
-import "core-js/modules/es.array.join.js";
-import doctrine from 'doctrine';
-
-function containsJsDoc(value) {
-  return value != null && value.includes('@');
-}
-
-function parse(content, tags) {
-  var ast;
-
-  try {
-    ast = doctrine.parse(content, {
-      tags: tags,
-      sloppy: true
-    });
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-    throw new Error('Cannot parse JSDoc tags.');
-  }
-
-  return ast;
-}
-
-var DEFAULT_OPTIONS = {
-  tags: ['param', 'arg', 'argument', 'returns', 'ignore']
-};
-export var parseJsDoc = function parseJsDoc(value) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_OPTIONS;
-
-  if (!containsJsDoc(value)) {
-    return {
-      includesJsDoc: false,
-      ignore: false
-    };
-  }
-
-  var jsDocAst = parse(value, options.tags);
-  var extractedTags = extractJsDocTags(jsDocAst);
-
-  if (extractedTags.ignore) {
-    // There is no point in doing other stuff since this prop will not be rendered.
-    return {
-      includesJsDoc: true,
-      ignore: true
-    };
-  }
-
-  return {
-    includesJsDoc: true,
-    ignore: false,
-    // Always use the parsed description to ensure JSDoc is removed from the description.
-    description: jsDocAst.description,
-    extractedTags: extractedTags
-  };
-};
-
-function extractJsDocTags(ast) {
-  var extractedTags = {
-    params: null,
-    returns: null,
-    ignore: false
-  };
-
-  for (var i = 0; i < ast.tags.length; i += 1) {
-    var tag = ast.tags[i];
-
-    if (tag.title === 'ignore') {
-      extractedTags.ignore = true; // Once we reach an @ignore tag, there is no point in parsing the other tags since we will not render the prop.
-
-      break;
-    } else {
-      switch (tag.title) {
-        // arg & argument are aliases for param.
-        case 'param':
-        case 'arg':
-        case 'argument':
-          {
-            var paramTag = extractParam(tag);
-
-            if (paramTag != null) {
-              if (extractedTags.params == null) {
-                extractedTags.params = [];
-              }
-
-              extractedTags.params.push(paramTag);
-            }
-
-            break;
-          }
-
-        case 'returns':
-          {
-            var returnsTag = extractReturns(tag);
-
-            if (returnsTag != null) {
-              extractedTags.returns = returnsTag;
-            }
-
-            break;
-          }
-
-        default:
-          break;
-      }
-    }
-  }
-
-  return extractedTags;
-}
-
-function extractParam(tag) {
-  var paramName = tag.name; // When the @param doesn't have a name but have a type and a description, "null-null" is returned.
-
-  if (paramName != null && paramName !== 'null-null') {
-    return {
-      name: tag.name,
-      type: tag.type,
-      description: tag.description,
-      getPrettyName: function getPrettyName() {
-        if (paramName.includes('null')) {
-          // There is a few cases in which the returned param name contains "null".
-          // - @param {SyntheticEvent} event- Original SyntheticEvent
-          // - @param {SyntheticEvent} event.\n@returns {string}
-          return paramName.replace('-null', '').replace('.null', '');
-        }
-
-        return tag.name;
-      },
-      getTypeName: function getTypeName() {
-        return tag.type != null ? extractTypeName(tag.type) : null;
-      }
-    };
-  }
-
-  return null;
-}
-
-function extractReturns(tag) {
-  if (tag.type != null) {
-    return {
-      type: tag.type,
-      description: tag.description,
-      getTypeName: function getTypeName() {
-        return extractTypeName(tag.type);
-      }
-    };
-  }
-
-  return null;
-}
-
-function extractTypeName(type) {
-  if (type.type === 'NameExpression') {
-    return type.name;
-  }
-
-  if (type.type === 'RecordType') {
-    var recordFields = type.fields.map(function (field) {
-      if (field.value != null) {
-        var valueTypeName = extractTypeName(field.value);
-        return "".concat(field.key, ": ").concat(valueTypeName);
-      }
-
-      return field.key;
-    });
-    return "({".concat(recordFields.join(', '), "})");
-  }
-
-  if (type.type === 'UnionType') {
-    var unionElements = type.elements.map(extractTypeName);
-    return "(".concat(unionElements.join('|'), ")");
-  } // Only support untyped array: []. Might add more support later if required.
-
-
-  if (type.type === 'ArrayType') {
-    return '[]';
-  }
-
-  if (type.type === 'TypeApplication') {
-    if (type.expression != null) {
-      if (type.expression.name === 'Array') {
-        var arrayType = extractTypeName(type.applications[0]);
-        return "".concat(arrayType, "[]");
-      }
-    }
-  }
-
-  if (type.type === 'NullableType' || type.type === 'NonNullableType' || type.type === 'OptionalType') {
-    return extractTypeName(type.expression);
-  }
-
-  if (type.type === 'AllLiteral') {
-    return 'any';
-  }
-
-  return null;
-}

package/dist/esm/lib/utils.js

@@ -1,25 +0,0 @@
-import "core-js/modules/es.string.replace.js";
-import "core-js/modules/es.regexp.exec.js";
-export var MAX_TYPE_SUMMARY_LENGTH = 90;
-export var MAX_DEFAULT_VALUE_SUMMARY_LENGTH = 50;
-export function isTooLongForTypeSummary(value) {
-  return value.length > MAX_TYPE_SUMMARY_LENGTH;
-}
-export function isTooLongForDefaultValueSummary(value) {
-  return value.length > MAX_DEFAULT_VALUE_SUMMARY_LENGTH;
-}
-export function createSummaryValue(summary, detail) {
-  if (summary === detail) {
-    return {
-      summary: summary
-    };
-  }
-
-  return {
-    summary: summary,
-    detail: detail
-  };
-}
-export var normalizeNewlines = function normalizeNewlines(string) {
-  return string.replace(/\\r\\n/g, '\\n');
-};

package/dist/modern/frameworks/angular/compodoc.js

@@ -1,296 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-
-/* global window */
-import { logger } from '@storybook/client-logger';
-export const isMethod = methodOrProp => {
-  return methodOrProp.args !== undefined;
-};
-export const setCompodocJson = compodocJson => {
-  // @ts-ignore
-  window.__STORYBOOK_COMPODOC_JSON__ = compodocJson;
-}; // @ts-ignore
-
-export const getCompodocJson = () => window.__STORYBOOK_COMPODOC_JSON__;
-export const checkValidComponentOrDirective = component => {
-  if (!component.name) {
-    throw new Error(`Invalid component ${JSON.stringify(component)}`);
-  }
-};
-export const checkValidCompodocJson = compodocJson => {
-  if (!compodocJson || !compodocJson.components) {
-    throw new Error('Invalid compodoc JSON');
-  }
-};
-
-const hasDecorator = (item, decoratorName) => item.decorators && item.decorators.find(x => x.name === decoratorName);
-
-const mapPropertyToSection = item => {
-  if (hasDecorator(item, 'ViewChild')) {
-    return 'view child';
-  }
-
-  if (hasDecorator(item, 'ViewChildren')) {
-    return 'view children';
-  }
-
-  if (hasDecorator(item, 'ContentChild')) {
-    return 'content child';
-  }
-
-  if (hasDecorator(item, 'ContentChildren')) {
-    return 'content children';
-  }
-
-  return 'properties';
-};
-
-const mapItemToSection = (key, item) => {
-  switch (key) {
-    case 'methods':
-    case 'methodsClass':
-      return 'methods';
-
-    case 'inputsClass':
-      return 'inputs';
-
-    case 'outputsClass':
-      return 'outputs';
-
-    case 'properties':
-    case 'propertiesClass':
-      if (isMethod(item)) {
-        throw new Error("Cannot be of type Method if key === 'propertiesClass'");
-      }
-
-      return mapPropertyToSection(item);
-
-    default:
-      throw new Error(`Unknown key: ${key}`);
-  }
-};
-
-export const findComponentByName = (name, compodocJson) => compodocJson.components.find(c => c.name === name) || compodocJson.directives.find(c => c.name === name) || compodocJson.pipes.find(c => c.name === name) || compodocJson.injectables.find(c => c.name === name) || compodocJson.classes.find(c => c.name === name);
-
-const getComponentData = component => {
-  if (!component) {
-    return null;
-  }
-
-  checkValidComponentOrDirective(component);
-  const compodocJson = getCompodocJson();
-
-  if (!compodocJson) {
-    return null;
-  }
-
-  checkValidCompodocJson(compodocJson);
-  const {
-    name
-  } = component;
-  const metadata = findComponentByName(name, compodocJson);
-
-  if (!metadata) {
-    logger.warn(`Component not found in compodoc JSON: '${name}'`);
-  }
-
-  return metadata;
-};
-
-const displaySignature = item => {
-  const args = item.args.map(arg => `${arg.name}${arg.optional ? '?' : ''}: ${arg.type}`);
-  return `(${args.join(', ')}) => ${item.returnType}`;
-};
-
-const extractTypeFromValue = defaultValue => {
-  const valueType = typeof defaultValue;
-  return defaultValue || valueType === 'number' || valueType === 'boolean' || valueType === 'string' ? valueType : null;
-};
-
-const extractEnumValues = compodocType => {
-  var _compodocJson$miscell, _compodocJson$miscell2;
-
-  const compodocJson = getCompodocJson();
-  const enumType = compodocJson === null || compodocJson === void 0 ? void 0 : (_compodocJson$miscell = compodocJson.miscellaneous) === null || _compodocJson$miscell === void 0 ? void 0 : (_compodocJson$miscell2 = _compodocJson$miscell.enumerations) === null || _compodocJson$miscell2 === void 0 ? void 0 : _compodocJson$miscell2.find(x => x.name === compodocType);
-
-  if (enumType !== null && enumType !== void 0 && enumType.childs.every(x => x.value)) {
-    return enumType.childs.map(x => x.value);
-  }
-
-  if (typeof compodocType !== 'string' || compodocType.indexOf('|') === -1) {
-    return null;
-  }
-
-  try {
-    return compodocType.split('|').map(value => JSON.parse(value));
-  } catch (e) {
-    return null;
-  }
-};
-
-export const extractType = (property, defaultValue) => {
-  const compodocType = property.type || extractTypeFromValue(defaultValue);
-
-  switch (compodocType) {
-    case 'string':
-    case 'boolean':
-    case 'number':
-      return {
-        name: compodocType
-      };
-
-    case undefined:
-    case null:
-      return {
-        name: 'void'
-      };
-
-    default:
-      {
-        const resolvedType = resolveTypealias(compodocType);
-        const enumValues = extractEnumValues(resolvedType);
-        return enumValues ? {
-          name: 'enum',
-          value: enumValues
-        } : {
-          name: 'object'
-        };
-      }
-  }
-};
-
-const castDefaultValue = (property, defaultValue) => {
-  const compodocType = property.type; // All these checks are necessary as compodoc does not always set the type ie. @HostBinding have empty types.
-  // null and undefined also have 'any' type
-
-  if (['boolean', 'number', 'string', 'EventEmitter'].includes(compodocType)) {
-    switch (compodocType) {
-      case 'boolean':
-        return defaultValue === 'true';
-
-      case 'number':
-        return Number(defaultValue);
-
-      case 'EventEmitter':
-        return undefined;
-
-      default:
-        return defaultValue;
-    }
-  } else {
-    switch (defaultValue) {
-      case 'true':
-        return true;
-
-      case 'false':
-        return false;
-
-      case 'null':
-        return null;
-
-      case 'undefined':
-        return undefined;
-
-      default:
-        return defaultValue;
-    }
-  }
-};
-
-const extractDefaultValueFromComments = (property, value) => {
-  let commentValue = value;
-  property.jsdoctags.forEach(tag => {
-    if (['default', 'defaultvalue'].includes(tag.tagName.escapedText)) {
-      // @ts-ignore
-      const dom = new window.DOMParser().parseFromString(tag.comment, 'text/html');
-      commentValue = dom.body.textContent;
-    }
-  });
-  return commentValue;
-};
-
-const extractDefaultValue = property => {
-  try {
-    var _property$defaultValu, _property$jsdoctags;
-
-    let value = (_property$defaultValu = property.defaultValue) === null || _property$defaultValu === void 0 ? void 0 : _property$defaultValu.replace(/^'(.*)'$/, '$1');
-    value = castDefaultValue(property, value);
-
-    if (value == null && ((_property$jsdoctags = property.jsdoctags) === null || _property$jsdoctags === void 0 ? void 0 : _property$jsdoctags.length) > 0) {
-      value = extractDefaultValueFromComments(property, value);
-    }
-
-    return value;
-  } catch (err) {
-    logger.debug(`Error extracting ${property.name}: ${property.defaultValue}`);
-    return undefined;
-  }
-};
-
-const resolveTypealias = compodocType => {
-  var _compodocJson$miscell3, _compodocJson$miscell4;
-
-  const compodocJson = getCompodocJson();
-  const typeAlias = compodocJson === null || compodocJson === void 0 ? void 0 : (_compodocJson$miscell3 = compodocJson.miscellaneous) === null || _compodocJson$miscell3 === void 0 ? void 0 : (_compodocJson$miscell4 = _compodocJson$miscell3.typealiases) === null || _compodocJson$miscell4 === void 0 ? void 0 : _compodocJson$miscell4.find(x => x.name === compodocType);
-  return typeAlias ? resolveTypealias(typeAlias.rawtype) : compodocType;
-};
-
-export const extractArgTypesFromData = componentData => {
-  const sectionToItems = {};
-  const compodocClasses = ['component', 'directive'].includes(componentData.type) ? ['propertiesClass', 'methodsClass', 'inputsClass', 'outputsClass'] : ['properties', 'methods'];
-  compodocClasses.forEach(key => {
-    const data = componentData[key] || [];
-    data.forEach(item => {
-      const section = mapItemToSection(key, item);
-      const defaultValue = isMethod(item) ? undefined : extractDefaultValue(item);
-      const type = isMethod(item) || section !== 'inputs' && section !== 'properties' ? {
-        name: 'void'
-      } : extractType(item, defaultValue);
-      const action = section === 'outputs' ? {
-        action: item.name
-      } : {};
-      const argType = Object.assign({
-        name: item.name,
-        description: item.rawdescription || item.description,
-        defaultValue,
-        type
-      }, action, {
-        table: {
-          category: section,
-          type: {
-            summary: isMethod(item) ? displaySignature(item) : item.type,
-            required: isMethod(item) ? false : !item.optional
-          },
-          defaultValue: {
-            summary: defaultValue
-          }
-        }
-      });
-
-      if (!sectionToItems[section]) {
-        sectionToItems[section] = [];
-      }
-
-      sectionToItems[section].push(argType);
-    });
-  });
-  const SECTIONS = ['properties', 'inputs', 'outputs', 'methods', 'view child', 'view children', 'content child', 'content children'];
-  const argTypes = {};
-  SECTIONS.forEach(section => {
-    const items = sectionToItems[section];
-
-    if (items) {
-      items.forEach(argType => {
-        argTypes[argType.name] = argType;
-      });
-    }
-  });
-  return argTypes;
-};
-export const extractArgTypes = component => {
-  const componentData = getComponentData(component);
-  return componentData && extractArgTypesFromData(componentData);
-};
-export const extractComponentDescription = component => {
-  const componentData = getComponentData(component);
-  return componentData && (componentData.rawdescription || componentData.description);
-};

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

@@ -1,18 +0,0 @@
-import { SourceType } from '../../shared';
-import { extractArgTypes, extractComponentDescription } from './compodoc';
-import { sourceDecorator } from './sourceDecorator';
-import { prepareForInline } from './prepareForInline';
-export const parameters = {
-  docs: {
-    // probably set this to true by default once it's battle-tested
-    inlineStories: false,
-    prepareForInline,
-    extractArgTypes,
-    extractComponentDescription,
-    source: {
-      type: SourceType.DYNAMIC,
-      language: 'html'
-    }
-  }
-};
-export const decorators = [sourceDecorator];

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

@@ -1 +0,0 @@
-export * from './compodoc';

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

@@ -1,36 +0,0 @@
-import React from 'react';
-import pLimit from 'p-limit';
-import { nanoid } from 'nanoid';
-import { rendererFactory } from '@storybook/angular/renderer';
-const limit = pLimit(1);
-/**
- * Uses the angular renderer to generate a story. Uses p-limit to run synchronously
- */
-
-export const prepareForInline = (storyFn, {
-  id,
-  parameters,
-  component
-}) => {
-  const el = React.useRef();
-  React.useEffect(() => {
-    (async () => {
-      limit(async () => {
-        const renderer = await rendererFactory.getRendererInstance(`${id}-${nanoid(10)}`.toLowerCase(), el.current);
-
-        if (renderer) {
-          await renderer.render({
-            forced: false,
-            component,
-            parameters,
-            storyFnAngular: storyFn(),
-            targetDOMNode: el.current
-          });
-        }
-      });
-    })();
-  });
-  return /*#__PURE__*/React.createElement('div', {
-    ref: el
-  });
-};

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

@@ -1,81 +0,0 @@
-import { addons, useEffect } from '@storybook/addons';
-import { computesTemplateSourceFromComponent } from '@storybook/angular/renderer';
-import { SNIPPET_RENDERED, SourceType } from '../../shared';
-export const 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; // 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
-
-
-  return (sourceParams === null || sourceParams === void 0 ? void 0 : sourceParams.code) || (sourceParams === null || sourceParams === void 0 ? void 0 : sourceParams.type) === SourceType.CODE;
-};
-let prettyUpInternal;
-
-const makePrettyUp = async () => {
-  if (prettyUpInternal) {
-    return prettyUpInternal;
-  }
-
-  const prettierHtml = await import('prettier/parser-html');
-  const prettier = await import('prettier/standalone');
-
-  prettyUpInternal = source => {
-    return prettier.format(source, {
-      parser: 'angular',
-      plugins: [prettierHtml],
-      htmlWhitespaceSensitivity: 'ignore'
-    });
-  };
-
-  return prettyUpInternal;
-};
-/**
- * Angular source decorator.
- * @param storyFn Fn
- * @param context  StoryContext
- */
-
-
-export const sourceDecorator = (storyFn, context) => {
-  const story = storyFn();
-
-  if (skipSourceRender(context)) {
-    return story;
-  }
-
-  const channel = addons.getChannel();
-  const {
-    props,
-    template,
-    userDefinedTemplate
-  } = story;
-  const {
-    component,
-    argTypes
-  } = context;
-  let toEmit;
-  const prettyUpPromise = makePrettyUp();
-  useEffect(() => {
-    prettyUpPromise.then(prettyUp => {
-      if (toEmit) channel.emit(SNIPPET_RENDERED, context.id, prettyUp(toEmit));
-    });
-  });
-  prettyUpPromise.then(prettyUp => {
-    if (component && !userDefinedTemplate) {
-      const source = computesTemplateSourceFromComponent(component, props, argTypes); // We might have a story with a Directive or Service defined as the component
-      // In these cases there might exist a template, even if we aren't able to create source from component
-
-      if (source || template) {
-        toEmit = prettyUp(source || template);
-      }
-    } else if (template) {
-      toEmit = prettyUp(template);
-    }
-  });
-  return story;
-};

package/dist/modern/frameworks/common/enhanceArgTypes.js

@@ -1,16 +0,0 @@
-import { combineParameters } from '@storybook/store';
-export const enhanceArgTypes = context => {
-  const {
-    component,
-    argTypes: userArgTypes,
-    parameters: {
-      docs = {}
-    }
-  } = context;
-  const {
-    extractArgTypes
-  } = docs;
-  const extractedArgTypes = extractArgTypes && component ? extractArgTypes(component) : {};
-  const withExtractedTypes = extractedArgTypes ? combineParameters(extractedArgTypes, userArgTypes) : userArgTypes;
-  return withExtractedTypes;
-};

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';