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

package/preset.js

@@ -1,16 +1 @@
-const getFrameworkPresets = (framework) => {
-  try {
-    return [require.resolve(`./dist/cjs/frameworks/${framework}/preset`)];
-  } catch (err) {
-    // there is no custom config for the user's framework, do nothing
-    return [];
-  }
-};
-
-module.exports = (storybookOptions, presetOptions) => {
-  return [
-    { name: require.resolve('./common-preset'), options: presetOptions },
-    { name: require.resolve('./dist/cjs/frameworks/common/preset'), options: presetOptions },
-    ...getFrameworkPresets(storybookOptions.framework),
-  ];
-};
+module.exports = require('./dist/cjs/preset');

package/preview.js

@@ -0,0 +1 @@
+export * from './dist/esm/preview';

package/register.js

@@ -1 +1,6 @@
-require('./dist/esm/register.js');
+import { once } from '@storybook/client-logger';
+import './manager';
+
+once.warn(
+  'register.js is deprecated see https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-registerjs'
+);

package/common-preset.js

@@ -1,19 +0,0 @@
-function managerEntries(entry = [], options) {
-  return [...entry, require.resolve('./dist/esm/register')];
-}
-
-function config(entry = [], options = {}) {
-  const { framework } = options;
-  const docsConfig = [require.resolve('./dist/esm/frameworks/common/config')];
-  try {
-    docsConfig.push(require.resolve(`./dist/esm/frameworks/${framework}/config`));
-  } catch (err) {
-    // there is no custom config for the user's framework, do nothing
-  }
-  return [...docsConfig, ...entry];
-}
-
-module.exports = {
-  managerEntries,
-  config,
-};

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

@@ -1,397 +0,0 @@
-"use strict";
-
-require("core-js/modules/es.object.to-string.js");
-
-require("core-js/modules/es.symbol.iterator.js");
-
-require("core-js/modules/es.string.iterator.js");
-
-require("core-js/modules/es.array.iterator.js");
-
-require("core-js/modules/web.dom-collections.iterator.js");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractComponentDescription = exports.extractArgTypes = exports.extractArgTypesFromData = exports.extractType = exports.findComponentByName = exports.checkValidCompodocJson = exports.checkValidComponentOrDirective = exports.getCompodocJson = exports.setCompodocJson = exports.isMethod = void 0;
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.array.find.js");
-
-require("core-js/modules/es.array.map.js");
-
-require("core-js/modules/es.array.concat.js");
-
-require("core-js/modules/es.array.join.js");
-
-require("core-js/modules/es.string.split.js");
-
-require("core-js/modules/es.regexp.exec.js");
-
-require("core-js/modules/es.array.includes.js");
-
-require("core-js/modules/es.number.constructor.js");
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.string.replace.js");
-
-require("core-js/modules/es.object.assign.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-var _clientLogger = require("@storybook/client-logger");
-
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
-var isMethod = function isMethod(methodOrProp) {
-  return methodOrProp.args !== undefined;
-};
-
-exports.isMethod = isMethod;
-
-var setCompodocJson = function setCompodocJson(compodocJson) {
-  // @ts-ignore
-  window.__STORYBOOK_COMPODOC_JSON__ = compodocJson;
-}; // @ts-ignore
-
-
-exports.setCompodocJson = setCompodocJson;
-
-var getCompodocJson = function getCompodocJson() {
-  return window.__STORYBOOK_COMPODOC_JSON__;
-};
-
-exports.getCompodocJson = getCompodocJson;
-
-var checkValidComponentOrDirective = function checkValidComponentOrDirective(component) {
-  if (!component.name) {
-    throw new Error("Invalid component ".concat(JSON.stringify(component)));
-  }
-};
-
-exports.checkValidComponentOrDirective = checkValidComponentOrDirective;
-
-var checkValidCompodocJson = function checkValidCompodocJson(compodocJson) {
-  if (!compodocJson || !compodocJson.components) {
-    throw new Error('Invalid compodoc JSON');
-  }
-};
-
-exports.checkValidCompodocJson = checkValidCompodocJson;
-
-var hasDecorator = function hasDecorator(item, decoratorName) {
-  return item.decorators && item.decorators.find(function (x) {
-    return x.name === decoratorName;
-  });
-};
-
-var mapPropertyToSection = function 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';
-};
-
-var mapItemToSection = function 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: ".concat(key));
-  }
-};
-
-var findComponentByName = function findComponentByName(name, compodocJson) {
-  return compodocJson.components.find(function (c) {
-    return c.name === name;
-  }) || compodocJson.directives.find(function (c) {
-    return c.name === name;
-  }) || compodocJson.pipes.find(function (c) {
-    return c.name === name;
-  }) || compodocJson.injectables.find(function (c) {
-    return c.name === name;
-  }) || compodocJson.classes.find(function (c) {
-    return c.name === name;
-  });
-};
-
-exports.findComponentByName = findComponentByName;
-
-var getComponentData = function getComponentData(component) {
-  if (!component) {
-    return null;
-  }
-
-  checkValidComponentOrDirective(component);
-  var compodocJson = getCompodocJson();
-
-  if (!compodocJson) {
-    return null;
-  }
-
-  checkValidCompodocJson(compodocJson);
-  var name = component.name;
-  var metadata = findComponentByName(name, compodocJson);
-
-  if (!metadata) {
-    _clientLogger.logger.warn("Component not found in compodoc JSON: '".concat(name, "'"));
-  }
-
-  return metadata;
-};
-
-var displaySignature = function displaySignature(item) {
-  var args = item.args.map(function (arg) {
-    return "".concat(arg.name).concat(arg.optional ? '?' : '', ": ").concat(arg.type);
-  });
-  return "(".concat(args.join(', '), ") => ").concat(item.returnType);
-};
-
-var extractTypeFromValue = function extractTypeFromValue(defaultValue) {
-  var valueType = _typeof(defaultValue);
-
-  return defaultValue || valueType === 'number' || valueType === 'boolean' || valueType === 'string' ? valueType : null;
-};
-
-var extractEnumValues = function extractEnumValues(compodocType) {
-  var _compodocJson$miscell, _compodocJson$miscell2;
-
-  var compodocJson = getCompodocJson();
-  var 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(function (x) {
-    return x.name === compodocType;
-  });
-
-  if (enumType !== null && enumType !== void 0 && enumType.childs.every(function (x) {
-    return x.value;
-  })) {
-    return enumType.childs.map(function (x) {
-      return x.value;
-    });
-  }
-
-  if (typeof compodocType !== 'string' || compodocType.indexOf('|') === -1) {
-    return null;
-  }
-
-  try {
-    return compodocType.split('|').map(function (value) {
-      return JSON.parse(value);
-    });
-  } catch (e) {
-    return null;
-  }
-};
-
-var extractType = function extractType(property, defaultValue) {
-  var compodocType = property.type || extractTypeFromValue(defaultValue);
-
-  switch (compodocType) {
-    case 'string':
-    case 'boolean':
-    case 'number':
-      return {
-        name: compodocType
-      };
-
-    case undefined:
-    case null:
-      return {
-        name: 'void'
-      };
-
-    default:
-      {
-        var resolvedType = resolveTypealias(compodocType);
-        var enumValues = extractEnumValues(resolvedType);
-        return enumValues ? {
-          name: 'enum',
-          value: enumValues
-        } : {
-          name: 'object'
-        };
-      }
-  }
-};
-
-exports.extractType = extractType;
-
-var castDefaultValue = function castDefaultValue(property, defaultValue) {
-  var 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;
-    }
-  }
-};
-
-var extractDefaultValueFromComments = function extractDefaultValueFromComments(property, value) {
-  var commentValue = value;
-  property.jsdoctags.forEach(function (tag) {
-    if (['default', 'defaultvalue'].includes(tag.tagName.escapedText)) {
-      // @ts-ignore
-      var dom = new window.DOMParser().parseFromString(tag.comment, 'text/html');
-      commentValue = dom.body.textContent;
-    }
-  });
-  return commentValue;
-};
-
-var extractDefaultValue = function extractDefaultValue(property) {
-  try {
-    var _property$defaultValu, _property$jsdoctags;
-
-    var 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) {
-    _clientLogger.logger.debug("Error extracting ".concat(property.name, ": ").concat(property.defaultValue));
-
-    return undefined;
-  }
-};
-
-var resolveTypealias = function resolveTypealias(compodocType) {
-  var _compodocJson$miscell3, _compodocJson$miscell4;
-
-  var compodocJson = getCompodocJson();
-  var 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(function (x) {
-    return x.name === compodocType;
-  });
-  return typeAlias ? resolveTypealias(typeAlias.rawtype) : compodocType;
-};
-
-var extractArgTypesFromData = function extractArgTypesFromData(componentData) {
-  var sectionToItems = {};
-  var compodocClasses = ['component', 'directive'].includes(componentData.type) ? ['propertiesClass', 'methodsClass', 'inputsClass', 'outputsClass'] : ['properties', 'methods'];
-  compodocClasses.forEach(function (key) {
-    var data = componentData[key] || [];
-    data.forEach(function (item) {
-      var section = mapItemToSection(key, item);
-      var defaultValue = isMethod(item) ? undefined : extractDefaultValue(item);
-      var type = isMethod(item) || section !== 'inputs' && section !== 'properties' ? {
-        name: 'void'
-      } : extractType(item, defaultValue);
-      var action = section === 'outputs' ? {
-        action: item.name
-      } : {};
-      var argType = Object.assign({
-        name: item.name,
-        description: item.rawdescription || item.description,
-        defaultValue: defaultValue,
-        type: 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);
-    });
-  });
-  var SECTIONS = ['properties', 'inputs', 'outputs', 'methods', 'view child', 'view children', 'content child', 'content children'];
-  var argTypes = {};
-  SECTIONS.forEach(function (section) {
-    var items = sectionToItems[section];
-
-    if (items) {
-      items.forEach(function (argType) {
-        argTypes[argType.name] = argType;
-      });
-    }
-  });
-  return argTypes;
-};
-
-exports.extractArgTypesFromData = extractArgTypesFromData;
-
-var extractArgTypes = function extractArgTypes(component) {
-  var componentData = getComponentData(component);
-  return componentData && extractArgTypesFromData(componentData);
-};
-
-exports.extractArgTypes = extractArgTypes;
-
-var extractComponentDescription = function extractComponentDescription(component) {
-  var componentData = getComponentData(component);
-  return componentData && (componentData.rawdescription || componentData.description);
-};
-
-exports.extractComponentDescription = extractComponentDescription;

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

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.decorators = exports.parameters = void 0;
-
-var _shared = require("../../shared");
-
-var _compodoc = require("./compodoc");
-
-var _sourceDecorator = require("./sourceDecorator");
-
-var _prepareForInline = require("./prepareForInline");
-
-var parameters = {
-  docs: {
-    // probably set this to true by default once it's battle-tested
-    inlineStories: false,
-    prepareForInline: _prepareForInline.prepareForInline,
-    extractArgTypes: _compodoc.extractArgTypes,
-    extractComponentDescription: _compodoc.extractComponentDescription,
-    source: {
-      type: _shared.SourceType.DYNAMIC,
-      language: 'html'
-    }
-  }
-};
-exports.parameters = parameters;
-var decorators = [_sourceDecorator.sourceDecorator];
-exports.decorators = decorators;

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

@@ -1,22 +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 _compodoc = require("./compodoc");
-
-Object.keys(_compodoc).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _compodoc[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _compodoc[key];
-    }
-  });
-});

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

@@ -1,96 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.prepareForInline = void 0;
-
-require("regenerator-runtime/runtime.js");
-
-require("core-js/modules/es.array.concat.js");
-
-require("core-js/modules/es.promise.js");
-
-require("core-js/modules/es.object.to-string.js");
-
-var _react = _interopRequireDefault(require("react"));
-
-var _pLimit = _interopRequireDefault(require("p-limit"));
-
-var _nanoid = require("nanoid");
-
-var _renderer = require("@storybook/angular/renderer");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
-var limit = (0, _pLimit.default)(1);
-/**
- * Uses the angular renderer to generate a story. Uses p-limit to run synchronously
- */
-
-var prepareForInline = function prepareForInline(storyFn, _ref) {
-  var id = _ref.id,
-      parameters = _ref.parameters,
-      component = _ref.component;
-
-  var el = _react.default.useRef();
-
-  _react.default.useEffect(function () {
-    _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
-      return regeneratorRuntime.wrap(function _callee2$(_context2) {
-        while (1) {
-          switch (_context2.prev = _context2.next) {
-            case 0:
-              limit( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
-                var renderer;
-                return regeneratorRuntime.wrap(function _callee$(_context) {
-                  while (1) {
-                    switch (_context.prev = _context.next) {
-                      case 0:
-                        _context.next = 2;
-                        return _renderer.rendererFactory.getRendererInstance("".concat(id, "-").concat((0, _nanoid.nanoid)(10)).toLowerCase(), el.current);
-
-                      case 2:
-                        renderer = _context.sent;
-
-                        if (!renderer) {
-                          _context.next = 6;
-                          break;
-                        }
-
-                        _context.next = 6;
-                        return renderer.render({
-                          forced: false,
-                          component: component,
-                          parameters: parameters,
-                          storyFnAngular: storyFn(),
-                          targetDOMNode: el.current
-                        });
-
-                      case 6:
-                      case "end":
-                        return _context.stop();
-                    }
-                  }
-                }, _callee);
-              })));
-
-            case 1:
-            case "end":
-              return _context2.stop();
-          }
-        }
-      }, _callee2);
-    }))();
-  });
-
-  return /*#__PURE__*/_react.default.createElement('div', {
-    ref: el
-  });
-};
-
-exports.prepareForInline = prepareForInline;