@storybook/addon-docs 6.5.0-alpha.9 → 6.5.0-beta.2

package/dist/cjs/lib/convert/typescript/convert.js

@@ -1,82 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.convert = void 0;
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.object.assign.js");
-
-require("core-js/modules/es.array.map.js");
-
-/* eslint-disable no-case-declarations */
-var convertSig = function convertSig(type) {
-  switch (type.type) {
-    case 'function':
-      return {
-        name: 'function'
-      };
-
-    case 'object':
-      var values = {};
-      type.signature.properties.forEach(function (prop) {
-        values[prop.key] = convert(prop.value);
-      });
-      return {
-        name: 'object',
-        value: values
-      };
-
-    default:
-      throw new Error("Unknown: ".concat(type));
-  }
-};
-
-var convert = function convert(type) {
-  var name = type.name,
-      raw = type.raw;
-  var base = {};
-  if (typeof raw !== 'undefined') base.raw = raw;
-
-  switch (type.name) {
-    case 'string':
-    case 'number':
-    case 'symbol':
-    case 'boolean':
-      {
-        return Object.assign({}, base, {
-          name: name
-        });
-      }
-
-    case 'Array':
-      {
-        return Object.assign({}, base, {
-          name: 'array',
-          value: type.elements.map(convert)
-        });
-      }
-
-    case 'signature':
-      return Object.assign({}, base, convertSig(type));
-
-    case 'union':
-    case 'intersection':
-      return Object.assign({}, base, {
-        name: name,
-        value: type.elements.map(convert)
-      });
-
-    default:
-      return Object.assign({}, base, {
-        name: 'other',
-        value: name
-      });
-  }
-};
-
-exports.convert = convert;

package/dist/cjs/lib/convert/typescript/index.js

@@ -1,35 +0,0 @@
-"use strict";
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.object.keys.js");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _convert = require("./convert");
-
-Object.keys(_convert).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _convert[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _convert[key];
-    }
-  });
-});
-
-var _types = require("./types");
-
-Object.keys(_types).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _types[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _types[key];
-    }
-  });
-});

package/dist/cjs/lib/convert/typescript/types.js

@@ -1 +0,0 @@
-"use strict";

package/dist/cjs/lib/convert/utils.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.trimQuotes = void 0;
-
-require("core-js/modules/es.string.replace.js");
-
-require("core-js/modules/es.regexp.exec.js");
-
-var QUOTE_REGEX = /^['"]|['"]$/g;
-
-var trimQuotes = function trimQuotes(str) {
-  return str.replace(QUOTE_REGEX, '');
-};
-
-exports.trimQuotes = trimQuotes;

package/dist/cjs/lib/docgen/PropDef.js

@@ -1 +0,0 @@
-"use strict";

package/dist/cjs/lib/docgen/createPropDef.js

@@ -1,171 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPropDefFactory = exports.unknownFactory = exports.flowFactory = exports.tsFactory = exports.javaScriptFactory = void 0;
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-require("core-js/modules/es.array.map.js");
-
-var _types = require("./types");
-
-var _utils = require("../utils");
-
-var _createPropDef = require("./flow/createPropDef");
-
-var _defaultValue = require("./utils/defaultValue");
-
-var _createPropDef2 = require("./typeScript/createPropDef");
-
-var _convert = require("../convert");
-
-function createType(type) {
-  // A type could be null if a defaultProp has been provided without a type definition.
-  return type != null ? (0, _utils.createSummaryValue)(type.name) : null;
-} // A heuristic to tell if a defaultValue comes from RDT
-
-
-function isReactDocgenTypescript(defaultValue) {
-  var computed = defaultValue.computed,
-      func = defaultValue.func;
-  return typeof computed === 'undefined' && typeof func === 'undefined';
-}
-
-function isStringValued(type) {
-  if (!type) {
-    return false;
-  }
-
-  if (type.name === 'string') {
-    return true;
-  }
-
-  if (type.name === 'enum') {
-    return Array.isArray(type.value) && type.value.every(function (_ref) {
-      var tv = _ref.value;
-      return typeof tv === 'string' && tv[0] === '"' && tv[tv.length - 1] === '"';
-    });
-  }
-
-  return false;
-}
-
-function createDefaultValue(defaultValue, type) {
-  if (defaultValue != null) {
-    var value = defaultValue.value;
-
-    if (!(0, _defaultValue.isDefaultValueBlacklisted)(value)) {
-      // Work around a bug in `react-docgen-typescript-loader`, which returns 'string' for a string
-      // default, instead of "'string'" -- which is incorrect
-      if (isReactDocgenTypescript(defaultValue) && isStringValued(type)) {
-        return (0, _utils.createSummaryValue)(JSON.stringify(value));
-      }
-
-      return (0, _utils.createSummaryValue)(value);
-    }
-  }
-
-  return null;
-}
-
-function createBasicPropDef(name, type, docgenInfo) {
-  var description = docgenInfo.description,
-      required = docgenInfo.required,
-      defaultValue = docgenInfo.defaultValue;
-  return {
-    name: name,
-    type: createType(type),
-    required: required,
-    description: description,
-    defaultValue: createDefaultValue(defaultValue, type)
-  };
-}
-
-function applyJsDocResult(propDef, jsDocParsingResult) {
-  if (jsDocParsingResult.includesJsDoc) {
-    var description = jsDocParsingResult.description,
-        extractedTags = jsDocParsingResult.extractedTags;
-
-    if (description != null) {
-      // eslint-disable-next-line no-param-reassign
-      propDef.description = jsDocParsingResult.description;
-    }
-
-    var hasParams = extractedTags.params != null;
-    var hasReturns = extractedTags.returns != null && extractedTags.returns.type != null;
-
-    if (hasParams || hasReturns) {
-      // eslint-disable-next-line no-param-reassign
-      propDef.jsDocTags = {
-        params: hasParams && extractedTags.params.map(function (x) {
-          return {
-            name: x.getPrettyName(),
-            description: x.description
-          };
-        }),
-        returns: hasReturns && {
-          description: extractedTags.returns.description
-        }
-      };
-    }
-  }
-
-  return propDef;
-}
-
-var javaScriptFactory = function javaScriptFactory(propName, docgenInfo, jsDocParsingResult) {
-  var propDef = createBasicPropDef(propName, docgenInfo.type, docgenInfo);
-  propDef.sbType = (0, _convert.convert)(docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-
-exports.javaScriptFactory = javaScriptFactory;
-
-var tsFactory = function tsFactory(propName, docgenInfo, jsDocParsingResult) {
-  var propDef = (0, _createPropDef2.createTsPropDef)(propName, docgenInfo);
-  propDef.sbType = (0, _convert.convert)(docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-
-exports.tsFactory = tsFactory;
-
-var flowFactory = function flowFactory(propName, docgenInfo, jsDocParsingResult) {
-  var propDef = (0, _createPropDef.createFlowPropDef)(propName, docgenInfo);
-  propDef.sbType = (0, _convert.convert)(docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-
-exports.flowFactory = flowFactory;
-
-var unknownFactory = function unknownFactory(propName, docgenInfo, jsDocParsingResult) {
-  var propDef = createBasicPropDef(propName, {
-    name: 'unknown'
-  }, docgenInfo);
-  return applyJsDocResult(propDef, jsDocParsingResult);
-};
-
-exports.unknownFactory = unknownFactory;
-
-var getPropDefFactory = function getPropDefFactory(typeSystem) {
-  switch (typeSystem) {
-    case _types.TypeSystem.JAVASCRIPT:
-      return javaScriptFactory;
-
-    case _types.TypeSystem.TYPESCRIPT:
-      return tsFactory;
-
-    case _types.TypeSystem.FLOW:
-      return flowFactory;
-
-    default:
-      return unknownFactory;
-  }
-};
-
-exports.getPropDefFactory = getPropDefFactory;

package/dist/cjs/lib/docgen/extractDocgenProps.js

@@ -1,113 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractComponentDescription = extractComponentDescription;
-exports.extractComponentProps = exports.extractComponentSectionObject = exports.extractComponentSectionArray = void 0;
-
-require("core-js/modules/es.array.map.js");
-
-require("core-js/modules/es.object.assign.js");
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.object.keys.js");
-
-require("core-js/modules/es.array.filter.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-var _jsdocParser = require("../jsdocParser");
-
-var _types = require("./types");
-
-var _utils = require("./utils");
-
-var _createPropDef = require("./createPropDef");
-
-var getTypeSystem = function getTypeSystem(docgenInfo) {
-  if (docgenInfo.type != null) {
-    return _types.TypeSystem.JAVASCRIPT;
-  }
-
-  if (docgenInfo.flowType != null) {
-    return _types.TypeSystem.FLOW;
-  }
-
-  if (docgenInfo.tsType != null) {
-    return _types.TypeSystem.TYPESCRIPT;
-  }
-
-  return _types.TypeSystem.UNKNOWN;
-};
-
-var extractComponentSectionArray = function extractComponentSectionArray(docgenSection) {
-  var typeSystem = getTypeSystem(docgenSection[0]);
-  var createPropDef = (0, _createPropDef.getPropDefFactory)(typeSystem);
-  return docgenSection.map(function (item) {
-    var _item$type;
-
-    var sanitizedItem = item;
-
-    if ((_item$type = item.type) !== null && _item$type !== void 0 && _item$type.elements) {
-      sanitizedItem = Object.assign({}, item, {
-        type: Object.assign({}, item.type, {
-          value: item.type.elements
-        })
-      });
-    }
-
-    return extractProp(sanitizedItem.name, sanitizedItem, typeSystem, createPropDef);
-  });
-};
-
-exports.extractComponentSectionArray = extractComponentSectionArray;
-
-var extractComponentSectionObject = function extractComponentSectionObject(docgenSection) {
-  var docgenPropsKeys = Object.keys(docgenSection);
-  var typeSystem = getTypeSystem(docgenSection[docgenPropsKeys[0]]);
-  var createPropDef = (0, _createPropDef.getPropDefFactory)(typeSystem);
-  return docgenPropsKeys.map(function (propName) {
-    var docgenInfo = docgenSection[propName];
-    return docgenInfo != null ? extractProp(propName, docgenInfo, typeSystem, createPropDef) : null;
-  }).filter(Boolean);
-};
-
-exports.extractComponentSectionObject = extractComponentSectionObject;
-
-var extractComponentProps = function extractComponentProps(component, section) {
-  var docgenSection = (0, _utils.getDocgenSection)(component, section);
-
-  if (!(0, _utils.isValidDocgenSection)(docgenSection)) {
-    return [];
-  } // vue-docgen-api has diverged from react-docgen and returns an array
-
-
-  return Array.isArray(docgenSection) ? extractComponentSectionArray(docgenSection) : extractComponentSectionObject(docgenSection);
-};
-
-exports.extractComponentProps = extractComponentProps;
-
-function extractProp(propName, docgenInfo, typeSystem, createPropDef) {
-  var jsDocParsingResult = (0, _jsdocParser.parseJsDoc)(docgenInfo.description);
-  var isIgnored = jsDocParsingResult.includesJsDoc && jsDocParsingResult.ignore;
-
-  if (!isIgnored) {
-    var propDef = createPropDef(propName, docgenInfo, jsDocParsingResult);
-    return {
-      propDef: propDef,
-      jsDocTags: jsDocParsingResult.extractedTags,
-      docgenInfo: docgenInfo,
-      typeSystem: typeSystem
-    };
-  }
-
-  return null;
-}
-
-function extractComponentDescription(component) {
-  return component != null && (0, _utils.getDocgenDescription)(component);
-}

package/dist/cjs/lib/docgen/flow/createDefaultValue.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createDefaultValue = createDefaultValue;
-
-require("core-js/modules/es.function.name.js");
-
-var _utils = require("../../utils");
-
-var _defaultValue = require("../utils/defaultValue");
-
-function createDefaultValue(defaultValue, type) {
-  if (defaultValue != null) {
-    var value = defaultValue.value;
-
-    if (!(0, _defaultValue.isDefaultValueBlacklisted)(value)) {
-      return !(0, _utils.isTooLongForDefaultValueSummary)(value) ? (0, _utils.createSummaryValue)(value) : (0, _utils.createSummaryValue)(type.name, value);
-    }
-  }
-
-  return null;
-}

package/dist/cjs/lib/docgen/flow/createPropDef.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createFlowPropDef = void 0;
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-var _createType = require("./createType");
-
-var _createDefaultValue = require("./createDefaultValue");
-
-var createFlowPropDef = function createFlowPropDef(propName, docgenInfo) {
-  var flowType = docgenInfo.flowType,
-      description = docgenInfo.description,
-      required = docgenInfo.required,
-      defaultValue = docgenInfo.defaultValue;
-  return {
-    name: propName,
-    type: (0, _createType.createType)(flowType),
-    required: required,
-    description: description,
-    defaultValue: (0, _createDefaultValue.createDefaultValue)(defaultValue, flowType)
-  };
-};
-
-exports.createFlowPropDef = createFlowPropDef;

package/dist/cjs/lib/docgen/flow/createType.js

@@ -1,119 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createType = createType;
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.array.join.js");
-
-require("core-js/modules/es.array.map.js");
-
-require("core-js/modules/es.string.replace.js");
-
-require("core-js/modules/es.regexp.exec.js");
-
-var _utils = require("../../utils");
-
-var FlowTypesType;
-
-(function (FlowTypesType) {
-  FlowTypesType["UNION"] = "union";
-  FlowTypesType["SIGNATURE"] = "signature";
-})(FlowTypesType || (FlowTypesType = {}));
-
-function generateUnionElement(_ref) {
-  var name = _ref.name,
-      value = _ref.value,
-      elements = _ref.elements,
-      raw = _ref.raw;
-
-  if (value != null) {
-    return value;
-  }
-
-  if (elements != null) {
-    return elements.map(generateUnionElement).join(' | ');
-  }
-
-  if (raw != null) {
-    return raw;
-  }
-
-  return name;
-}
-
-function generateUnion(_ref2) {
-  var name = _ref2.name,
-      raw = _ref2.raw,
-      elements = _ref2.elements;
-
-  if (elements != null) {
-    return (0, _utils.createSummaryValue)(elements.map(generateUnionElement).join(' | '));
-  }
-
-  if (raw != null) {
-    // Flow Unions can be defined with or without a leading `|` character, so try to remove it.
-    return (0, _utils.createSummaryValue)(raw.replace(/^\|\s*/, ''));
-  }
-
-  return (0, _utils.createSummaryValue)(name);
-}
-
-function generateFuncSignature(_ref3) {
-  var type = _ref3.type,
-      raw = _ref3.raw;
-
-  if (raw != null) {
-    return (0, _utils.createSummaryValue)(raw);
-  }
-
-  return (0, _utils.createSummaryValue)(type);
-}
-
-function generateObjectSignature(_ref4) {
-  var type = _ref4.type,
-      raw = _ref4.raw;
-
-  if (raw != null) {
-    return !(0, _utils.isTooLongForTypeSummary)(raw) ? (0, _utils.createSummaryValue)(raw) : (0, _utils.createSummaryValue)(type, raw);
-  }
-
-  return (0, _utils.createSummaryValue)(type);
-}
-
-function generateSignature(flowType) {
-  var type = flowType.type;
-  return type === 'object' ? generateObjectSignature(flowType) : generateFuncSignature(flowType);
-}
-
-function generateDefault(_ref5) {
-  var name = _ref5.name,
-      raw = _ref5.raw;
-
-  if (raw != null) {
-    return !(0, _utils.isTooLongForTypeSummary)(raw) ? (0, _utils.createSummaryValue)(raw) : (0, _utils.createSummaryValue)(name, raw);
-  }
-
-  return (0, _utils.createSummaryValue)(name);
-}
-
-function createType(type) {
-  // A type could be null if a defaultProp has been provided without a type definition.
-  if (type == null) {
-    return null;
-  }
-
-  switch (type.name) {
-    case FlowTypesType.UNION:
-      return generateUnion(type);
-
-    case FlowTypesType.SIGNATURE:
-      return generateSignature(type);
-
-    default:
-      return generateDefault(type);
-  }
-}

package/dist/cjs/lib/docgen/index.js

@@ -1,48 +0,0 @@
-"use strict";
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.object.keys.js");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _types = require("./types");
-
-Object.keys(_types).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _types[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _types[key];
-    }
-  });
-});
-
-var _utils = require("./utils");
-
-Object.keys(_utils).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _utils[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _utils[key];
-    }
-  });
-});
-
-var _extractDocgenProps = require("./extractDocgenProps");
-
-Object.keys(_extractDocgenProps).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _extractDocgenProps[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _extractDocgenProps[key];
-    }
-  });
-});

package/dist/cjs/lib/docgen/typeScript/createDefaultValue.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createDefaultValue = createDefaultValue;
-
-var _utils = require("../../utils");
-
-var _defaultValue = require("../utils/defaultValue");
-
-function createDefaultValue(_ref) {
-  var defaultValue = _ref.defaultValue;
-
-  if (defaultValue != null) {
-    var value = defaultValue.value;
-
-    if (!(0, _defaultValue.isDefaultValueBlacklisted)(value)) {
-      return (0, _utils.createSummaryValue)(value);
-    }
-  }
-
-  return null;
-}