@storybook/addon-docs 6.5.0-alpha.47 → 6.5.0-alpha.48

package/dist/esm/frameworks/react/propTypes/createType.js

@@ -1,449 +0,0 @@
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.regexp.exec.js";
-import "core-js/modules/es.string.replace.js";
-import "core-js/modules/es.string.split.js";
-import "core-js/modules/es.array.join.js";
-import "core-js/modules/es.array.map.js";
-import "core-js/modules/es.object.keys.js";
-import "core-js/modules/es.array.concat.js";
-import "core-js/modules/es.object.to-string.js";
-import { createSummaryValue, isTooLongForTypeSummary } from '../../../lib';
-import { generateFuncSignature, generateShortFuncSignature, toMultilineSignature } from './generateFuncSignature';
-import { OBJECT_CAPTION, ARRAY_CAPTION, CLASS_CAPTION, FUNCTION_CAPTION, ELEMENT_CAPTION, CUSTOM_CAPTION, isHtmlTag, generateObjectCode, generateCode } from '../lib';
-import { InspectionType, inspectValue } from '../lib/inspection';
-var MAX_FUNC_LENGTH = 150;
-var PropTypesType;
-
-(function (PropTypesType) {
-  PropTypesType["CUSTOM"] = "custom";
-  PropTypesType["ANY"] = "any";
-  PropTypesType["FUNC"] = "func";
-  PropTypesType["SHAPE"] = "shape";
-  PropTypesType["OBJECT"] = "object";
-  PropTypesType["INSTANCEOF"] = "instanceOf";
-  PropTypesType["OBJECTOF"] = "objectOf";
-  PropTypesType["UNION"] = "union";
-  PropTypesType["ENUM"] = "enum";
-  PropTypesType["ARRAYOF"] = "arrayOf";
-  PropTypesType["ELEMENT"] = "element";
-  PropTypesType["ELEMENTTYPE"] = "elementType";
-  PropTypesType["NODE"] = "node";
-})(PropTypesType || (PropTypesType = {}));
-
-function createTypeDef(_ref) {
-  var name = _ref.name,
-      short = _ref.short,
-      compact = _ref.compact,
-      full = _ref.full,
-      inferredType = _ref.inferredType;
-  return {
-    name: name,
-    short: short,
-    compact: compact,
-    full: full != null ? full : short,
-    inferredType: inferredType
-  };
-}
-
-function cleanPropTypes(value) {
-  return value.replace(/PropTypes./g, '').replace(/.isRequired/g, '');
-}
-
-function splitIntoLines(value) {
-  return value.split(/\r?\n/);
-}
-
-function prettyObject(ast) {
-  var compact = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  return cleanPropTypes(generateObjectCode(ast, compact));
-}
-
-function prettyArray(ast) {
-  var compact = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  return cleanPropTypes(generateCode(ast, compact));
-}
-
-function getCaptionForInspectionType(type) {
-  switch (type) {
-    case InspectionType.OBJECT:
-      return OBJECT_CAPTION;
-
-    case InspectionType.ARRAY:
-      return ARRAY_CAPTION;
-
-    case InspectionType.CLASS:
-      return CLASS_CAPTION;
-
-    case InspectionType.FUNCTION:
-      return FUNCTION_CAPTION;
-
-    case InspectionType.ELEMENT:
-      return ELEMENT_CAPTION;
-
-    default:
-      return CUSTOM_CAPTION;
-  }
-}
-
-function generateTypeFromString(value, originalTypeName) {
-  var _inspectValue = inspectValue(value),
-      inferredType = _inspectValue.inferredType,
-      ast = _inspectValue.ast;
-
-  var type = inferredType.type;
-  var short;
-  var compact;
-  var full;
-
-  switch (type) {
-    case InspectionType.IDENTIFIER:
-    case InspectionType.LITERAL:
-      short = value;
-      compact = value;
-      break;
-
-    case InspectionType.OBJECT:
-      {
-        var _ref2 = inferredType,
-            depth = _ref2.depth;
-        short = OBJECT_CAPTION;
-        compact = depth === 1 ? prettyObject(ast, true) : null;
-        full = prettyObject(ast);
-        break;
-      }
-
-    case InspectionType.ELEMENT:
-      {
-        var _ref3 = inferredType,
-            identifier = _ref3.identifier;
-        short = identifier != null && !isHtmlTag(identifier) ? identifier : ELEMENT_CAPTION;
-        compact = splitIntoLines(value).length === 1 ? value : null;
-        full = value;
-        break;
-      }
-
-    case InspectionType.ARRAY:
-      {
-        var _ref4 = inferredType,
-            _depth = _ref4.depth;
-        short = ARRAY_CAPTION;
-        compact = _depth <= 2 ? prettyArray(ast, true) : null;
-        full = prettyArray(ast);
-        break;
-      }
-
-    default:
-      short = getCaptionForInspectionType(type);
-      compact = splitIntoLines(value).length === 1 ? value : null;
-      full = value;
-      break;
-  }
-
-  return createTypeDef({
-    name: originalTypeName,
-    short: short,
-    compact: compact,
-    full: full,
-    inferredType: type
-  });
-}
-
-function generateCustom(_ref5) {
-  var raw = _ref5.raw;
-
-  if (raw != null) {
-    return generateTypeFromString(raw, PropTypesType.CUSTOM);
-  }
-
-  return createTypeDef({
-    name: PropTypesType.CUSTOM,
-    short: CUSTOM_CAPTION,
-    compact: CUSTOM_CAPTION
-  });
-}
-
-function generateFunc(extractedProp) {
-  var jsDocTags = extractedProp.jsDocTags;
-
-  if (jsDocTags != null) {
-    if (jsDocTags.params != null || jsDocTags.returns != null) {
-      return createTypeDef({
-        name: PropTypesType.FUNC,
-        short: generateShortFuncSignature(jsDocTags.params, jsDocTags.returns),
-        compact: null,
-        full: generateFuncSignature(jsDocTags.params, jsDocTags.returns)
-      });
-    }
-  }
-
-  return createTypeDef({
-    name: PropTypesType.FUNC,
-    short: FUNCTION_CAPTION,
-    compact: FUNCTION_CAPTION
-  });
-}
-
-function generateShape(type, extractedProp) {
-  var fields = Object.keys(type.value).map(function (key) {
-    return "".concat(key, ": ").concat(generateType(type.value[key], extractedProp).full);
-  }).join(', ');
-
-  var _inspectValue2 = inspectValue("{ ".concat(fields, " }")),
-      inferredType = _inspectValue2.inferredType,
-      ast = _inspectValue2.ast;
-
-  var _ref6 = inferredType,
-      depth = _ref6.depth;
-  return createTypeDef({
-    name: PropTypesType.SHAPE,
-    short: OBJECT_CAPTION,
-    compact: depth === 1 && ast ? prettyObject(ast, true) : null,
-    full: ast ? prettyObject(ast) : null
-  });
-}
-
-function objectOf(of) {
-  return "objectOf(".concat(of, ")");
-}
-
-function generateObjectOf(type, extractedProp) {
-  var _generateType = generateType(type.value, extractedProp),
-      short = _generateType.short,
-      compact = _generateType.compact,
-      full = _generateType.full;
-
-  return createTypeDef({
-    name: PropTypesType.OBJECTOF,
-    short: objectOf(short),
-    compact: compact != null ? objectOf(compact) : null,
-    full: objectOf(full)
-  });
-}
-
-function generateUnion(type, extractedProp) {
-  if (Array.isArray(type.value)) {
-    var values = type.value.reduce(function (acc, v) {
-      var _generateType2 = generateType(v, extractedProp),
-          short = _generateType2.short,
-          compact = _generateType2.compact,
-          full = _generateType2.full;
-
-      acc.short.push(short);
-      acc.compact.push(compact);
-      acc.full.push(full);
-      return acc;
-    }, {
-      short: [],
-      compact: [],
-      full: []
-    });
-    return createTypeDef({
-      name: PropTypesType.UNION,
-      short: values.short.join(' | '),
-      compact: values.compact.every(function (x) {
-        return x != null;
-      }) ? values.compact.join(' | ') : null,
-      full: values.full.join(' | ')
-    });
-  }
-
-  return createTypeDef({
-    name: PropTypesType.UNION,
-    short: type.value,
-    compact: null
-  });
-}
-
-function generateEnumValue(_ref7) {
-  var value = _ref7.value,
-      computed = _ref7.computed;
-  return computed ? generateTypeFromString(value, 'enumvalue') : createTypeDef({
-    name: 'enumvalue',
-    short: value,
-    compact: value
-  });
-}
-
-function generateEnum(type) {
-  if (Array.isArray(type.value)) {
-    var values = type.value.reduce(function (acc, v) {
-      var _generateEnumValue = generateEnumValue(v),
-          short = _generateEnumValue.short,
-          compact = _generateEnumValue.compact,
-          full = _generateEnumValue.full;
-
-      acc.short.push(short);
-      acc.compact.push(compact);
-      acc.full.push(full);
-      return acc;
-    }, {
-      short: [],
-      compact: [],
-      full: []
-    });
-    return createTypeDef({
-      name: PropTypesType.ENUM,
-      short: values.short.join(' | '),
-      compact: values.compact.every(function (x) {
-        return x != null;
-      }) ? values.compact.join(' | ') : null,
-      full: values.full.join(' | ')
-    });
-  }
-
-  return createTypeDef({
-    name: PropTypesType.ENUM,
-    short: type.value,
-    compact: type.value
-  });
-}
-
-function braceAfter(of) {
-  return "".concat(of, "[]");
-}
-
-function braceAround(of) {
-  return "[".concat(of, "]");
-}
-
-function createArrayOfObjectTypeDef(short, compact, full) {
-  return createTypeDef({
-    name: PropTypesType.ARRAYOF,
-    short: braceAfter(short),
-    compact: compact != null ? braceAround(compact) : null,
-    full: braceAround(full)
-  });
-}
-
-function generateArray(type, extractedProp) {
-  var _generateType3 = generateType(type.value, extractedProp),
-      name = _generateType3.name,
-      short = _generateType3.short,
-      compact = _generateType3.compact,
-      full = _generateType3.full,
-      inferredType = _generateType3.inferredType;
-
-  if (name === PropTypesType.CUSTOM) {
-    if (inferredType === InspectionType.OBJECT) {
-      return createArrayOfObjectTypeDef(short, compact, full);
-    }
-  } else if (name === PropTypesType.SHAPE) {
-    return createArrayOfObjectTypeDef(short, compact, full);
-  }
-
-  return createTypeDef({
-    name: PropTypesType.ARRAYOF,
-    short: braceAfter(short),
-    compact: braceAfter(short)
-  });
-}
-
-function generateType(type, extractedProp) {
-  try {
-    switch (type.name) {
-      case PropTypesType.CUSTOM:
-        return generateCustom(type);
-
-      case PropTypesType.FUNC:
-        return generateFunc(extractedProp);
-
-      case PropTypesType.SHAPE:
-        return generateShape(type, extractedProp);
-
-      case PropTypesType.INSTANCEOF:
-        return createTypeDef({
-          name: PropTypesType.INSTANCEOF,
-          short: type.value,
-          compact: type.value
-        });
-
-      case PropTypesType.OBJECTOF:
-        return generateObjectOf(type, extractedProp);
-
-      case PropTypesType.UNION:
-        return generateUnion(type, extractedProp);
-
-      case PropTypesType.ENUM:
-        return generateEnum(type);
-
-      case PropTypesType.ARRAYOF:
-        return generateArray(type, extractedProp);
-
-      default:
-        return createTypeDef({
-          name: type.name,
-          short: type.name,
-          compact: type.name
-        });
-    }
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-  }
-
-  return createTypeDef({
-    name: 'unknown',
-    short: 'unknown',
-    compact: 'unknown'
-  });
-}
-
-export function createType(extractedProp) {
-  var type = extractedProp.docgenInfo.type; // A type could be null if a defaultProp has been provided without a type definition.
-
-  if (type == null) {
-    return null;
-  }
-
-  try {
-    switch (type.name) {
-      case PropTypesType.CUSTOM:
-      case PropTypesType.SHAPE:
-      case PropTypesType.INSTANCEOF:
-      case PropTypesType.OBJECTOF:
-      case PropTypesType.UNION:
-      case PropTypesType.ENUM:
-      case PropTypesType.ARRAYOF:
-        {
-          var _generateType4 = generateType(type, extractedProp),
-              short = _generateType4.short,
-              compact = _generateType4.compact,
-              full = _generateType4.full;
-
-          if (compact != null) {
-            if (!isTooLongForTypeSummary(compact)) {
-              return createSummaryValue(compact);
-            }
-          }
-
-          return createSummaryValue(short, full);
-        }
-
-      case PropTypesType.FUNC:
-        {
-          var _generateType5 = generateType(type, extractedProp),
-              _short = _generateType5.short,
-              _full = _generateType5.full;
-
-          var summary = _short;
-          var detail;
-
-          if (_full.length < MAX_FUNC_LENGTH) {
-            summary = _full;
-          } else {
-            detail = toMultilineSignature(_full);
-          }
-
-          return createSummaryValue(summary, detail);
-        }
-
-      default:
-        return null;
-    }
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-  }
-
-  return null;
-}

package/dist/esm/frameworks/react/propTypes/generateFuncSignature.js

@@ -1,62 +0,0 @@
-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 "core-js/modules/es.regexp.exec.js";
-import "core-js/modules/es.string.replace.js";
-export function generateFuncSignature(params, returns) {
-  var hasParams = params != null;
-  var hasReturns = returns != null;
-
-  if (!hasParams && !hasReturns) {
-    return '';
-  }
-
-  var funcParts = [];
-
-  if (hasParams) {
-    var funcParams = params.map(function (x) {
-      var prettyName = x.getPrettyName();
-      var typeName = x.getTypeName();
-
-      if (typeName != null) {
-        return "".concat(prettyName, ": ").concat(typeName);
-      }
-
-      return prettyName;
-    });
-    funcParts.push("(".concat(funcParams.join(', '), ")"));
-  } else {
-    funcParts.push('()');
-  }
-
-  if (hasReturns) {
-    funcParts.push("=> ".concat(returns.getTypeName()));
-  }
-
-  return funcParts.join(' ');
-}
-export function generateShortFuncSignature(params, returns) {
-  var hasParams = params != null;
-  var hasReturns = returns != null;
-
-  if (!hasParams && !hasReturns) {
-    return '';
-  }
-
-  var funcParts = [];
-
-  if (hasParams) {
-    funcParts.push('( ... )');
-  } else {
-    funcParts.push('()');
-  }
-
-  if (hasReturns) {
-    funcParts.push("=> ".concat(returns.getTypeName()));
-  }
-
-  return funcParts.join(' ');
-}
-export function toMultilineSignature(signature) {
-  return signature.replace(/,/g, ',\r\n');
-}

package/dist/esm/frameworks/react/propTypes/handleProp.js

@@ -1,39 +0,0 @@
-import "core-js/modules/es.array.map.js";
-import "core-js/modules/es.function.name.js";
-import { createType } from './createType';
-import { createDefaultValue, createDefaultValueFromRawDefaultProp } from '../lib/defaultValues';
-import { keepOriginalDefinitionOrder } from './sortProps';
-import { rawDefaultPropTypeResolvers } from './rawDefaultPropResolvers';
-export function enhancePropTypesProp(extractedProp, rawDefaultProp) {
-  var propDef = extractedProp.propDef;
-  var newtype = createType(extractedProp);
-
-  if (newtype != null) {
-    propDef.type = newtype;
-  }
-
-  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, rawDefaultPropTypeResolvers);
-
-    if (_newDefaultValue != null) {
-      propDef.defaultValue = _newDefaultValue;
-    }
-  }
-
-  return propDef;
-}
-export function enhancePropTypesProps(extractedProps, component) {
-  var rawDefaultProps = component.defaultProps != null ? component.defaultProps : {};
-  var enhancedProps = extractedProps.map(function (x) {
-    return enhancePropTypesProp(x, rawDefaultProps[x.propDef.name]);
-  });
-  return keepOriginalDefinitionOrder(enhancedProps, component);
-}

package/dist/esm/frameworks/react/propTypes/rawDefaultPropResolvers.js

@@ -1,32 +0,0 @@
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.object.to-string.js";
-import "core-js/modules/es.regexp.to-string.js";
-import { extractFunctionName, createTypeResolvers } from '../lib/defaultValues';
-import { createSummaryValue } from '../../../lib';
-import { FUNCTION_CAPTION, ELEMENT_CAPTION } from '../lib';
-import { getPrettyElementIdentifier, getPrettyFuncIdentifier } from '../lib/defaultValues/prettyIdentifier';
-import { inspectValue } from '../lib/inspection';
-
-var funcResolver = function funcResolver(rawDefaultProp, _ref) {
-  var name = _ref.name,
-      type = _ref.type;
-  var isElement = type.summary === 'element' || type.summary === 'elementType';
-  var funcName = extractFunctionName(rawDefaultProp, name);
-
-  if (funcName != null) {
-    // Try to display the name of the component. The body of the component is omitted since the code has been transpiled.
-    if (isElement) {
-      return createSummaryValue(getPrettyElementIdentifier(funcName));
-    }
-
-    var _ref2 = inspectValue(rawDefaultProp.toString()).inferredType,
-        hasParams = _ref2.hasParams;
-    return createSummaryValue(getPrettyFuncIdentifier(funcName, hasParams));
-  }
-
-  return createSummaryValue(isElement ? ELEMENT_CAPTION : FUNCTION_CAPTION);
-};
-
-export var rawDefaultPropTypeResolvers = createTypeResolvers({
-  function: funcResolver
-});

package/dist/esm/frameworks/react/propTypes/sortProps.js

@@ -1,24 +0,0 @@
-import "core-js/modules/es.array.filter.js";
-import "core-js/modules/es.object.to-string.js";
-import "core-js/modules/es.array.map.js";
-import "core-js/modules/es.object.keys.js";
-import "core-js/modules/es.array.find.js";
-import "core-js/modules/es.function.name.js";
-// react-docgen doesn't returned the props in the order they were defined in the "propTypes" object of the component.
-// This function re-order them by their original definition order.
-export function keepOriginalDefinitionOrder(extractedProps, component) {
-  // eslint-disable-next-line react/forbid-foreign-prop-types
-  var propTypes = component.propTypes;
-
-  if (propTypes != null) {
-    return Object.keys(propTypes).map(function (x) {
-      return extractedProps.find(function (y) {
-        return y.name === x;
-      });
-    }).filter(function (x) {
-      return x;
-    });
-  }
-
-  return extractedProps;
-}