@storybook/addon-docs 7.0.0-alpha.10 → 7.0.0-alpha.13

package/blocks.js

@@ -1,5 +1,5 @@
 import deprecate from 'util-deprecate';
-import dedent from 'ts-dedent';
+import { dedent } from 'ts-dedent';
 
 const warnBlocksImport = deprecate(
   () => {},

package/dist/cjs/preset.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.storyIndexers = void 0;
+exports.storyIndexers = exports.docs = void 0;
 exports.webpack = webpack;
 
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
@@ -29,7 +29,7 @@ function createBabelOptions({
   mdxBabelOptions,
   configureJSX
 }) {
-  const babelPlugins = mdxBabelOptions?.plugins || babelOptions?.plugins || [];
+  const babelPlugins = (mdxBabelOptions === null || mdxBabelOptions === void 0 ? void 0 : mdxBabelOptions.plugins) || (babelOptions === null || babelOptions === void 0 ? void 0 : babelOptions.plugins) || [];
   const jsxPlugin = [require.resolve('@babel/plugin-transform-react-jsx'), {
     pragma: 'React.createElement',
     pragmaFrag: 'React.Fragment'
@@ -45,6 +45,8 @@ function createBabelOptions({
 }
 
 async function webpack(webpackConfig = {}, options) {
+  var _global$FEATURES, _global$FEATURES2;
+
   const resolvedBabelLoader = require.resolve('babel-loader');
 
   const {
@@ -65,11 +67,11 @@ async function webpack(webpackConfig = {}, options) {
     skipCsf: true,
     remarkPlugins: [_remarkSlug.default, _remarkExternalLinks.default]
   };
-  const mdxVersion = _global.default.FEATURES?.previewMdx2 ? 'MDX2' : 'MDX1';
+  const mdxVersion = (_global$FEATURES = _global.default.FEATURES) !== null && _global$FEATURES !== void 0 && _global$FEATURES.previewMdx2 ? 'MDX2' : 'MDX1';
 
   _nodeLogger.logger.info(`Addon-docs: using ${mdxVersion}`);
 
-  const mdxLoader = _global.default.FEATURES?.previewMdx2 ? require.resolve('@storybook/mdx2-csf/loader') : require.resolve('@storybook/mdx1-csf/loader'); // set `sourceLoaderOptions` to `null` to disable for manual configuration
+  const mdxLoader = (_global$FEATURES2 = _global.default.FEATURES) !== null && _global$FEATURES2 !== void 0 && _global$FEATURES2.previewMdx2 ? require.resolve('@storybook/mdx2-csf/loader') : require.resolve('@storybook/mdx1-csf/loader'); // set `sourceLoaderOptions` to `null` to disable for manual configuration
 
   const sourceLoader = sourceLoaderOptions ? [{
     test: /\.(stories|story)\.[tj]sx?$/,
@@ -82,7 +84,11 @@ async function webpack(webpackConfig = {}, options) {
   let rules = module.rules || [];
 
   if (transcludeMarkdown) {
-    rules = [...rules.filter(rule => rule.test?.toString() !== '/\\.md$/'), {
+    rules = [...rules.filter(rule => {
+      var _rule$test;
+
+      return ((_rule$test = rule.test) === null || _rule$test === void 0 ? void 0 : _rule$test.toString()) !== '/\\.md$/';
+    }), {
       test: /\.md$/,
       use: [{
         loader: resolvedBabelLoader,
@@ -134,11 +140,13 @@ async function webpack(webpackConfig = {}, options) {
 
 const storyIndexers = async indexers => {
   const mdxIndexer = async (fileName, opts) => {
+    var _global$FEATURES3;
+
     let code = (await _fsExtra.default.readFile(fileName, 'utf-8')).toString(); // @ts-ignore
 
     const {
       compile
-    } = _global.default.FEATURES?.previewMdx2 ? await Promise.resolve().then(() => _interopRequireWildcard(require('@storybook/mdx2-csf'))) : await Promise.resolve().then(() => _interopRequireWildcard(require('@storybook/mdx1-csf')));
+    } = (_global$FEATURES3 = _global.default.FEATURES) !== null && _global$FEATURES3 !== void 0 && _global$FEATURES3.previewMdx2 ? await Promise.resolve().then(() => _interopRequireWildcard(require('@storybook/mdx2-csf'))) : await Promise.resolve().then(() => _interopRequireWildcard(require('@storybook/mdx1-csf')));
     code = await compile(code, {});
     return (0, _csfTools.loadCsf)(code, Object.assign({}, opts, {
       fileName
@@ -147,8 +155,19 @@ const storyIndexers = async indexers => {
 
   return [{
     test: /(stories|story)\.mdx$/,
-    indexer: mdxIndexer
+    indexer: mdxIndexer,
+    addDocsTemplate: true
   }, ...(indexers || [])];
 };
 
-exports.storyIndexers = storyIndexers;
+exports.storyIndexers = storyIndexers;
+
+const docs = docsOptions => {
+  return Object.assign({}, docsOptions, {
+    enabled: true,
+    defaultName: 'Docs',
+    docsPage: true
+  });
+};
+
+exports.docs = docs;

package/dist/esm/preset.js

@@ -127,6 +127,14 @@ export const storyIndexers = async indexers => {
 
   return [{
     test: /(stories|story)\.mdx$/,
-    indexer: mdxIndexer
+    indexer: mdxIndexer,
+    addDocsTemplate: true
   }, ...(indexers || [])];
+};
+export const docs = docsOptions => {
+  return Object.assign({}, docsOptions, {
+    enabled: true,
+    defaultName: 'Docs',
+    docsPage: true
+  });
 };

package/dist/types/preset.d.ts

@@ -1,4 +1,4 @@
-import type { Options, StoryIndexer } from '@storybook/core-common';
+import type { DocsOptions, Options, StoryIndexer } from '@storybook/core-common';
 declare type BabelParams = {
     babelOptions?: any;
     mdxBabelOptions?: any;
@@ -8,5 +8,10 @@ export declare function webpack(webpackConfig: any, options: Options & BabelPara
     sourceLoaderOptions: any;
     transcludeMarkdown: boolean;
 }): Promise<any>;
-export declare const storyIndexers: (indexers?: StoryIndexer[]) => Promise<StoryIndexer[]>;
+export declare const storyIndexers: (indexers: StoryIndexer[] | null) => Promise<StoryIndexer[]>;
+export declare const docs: (docsOptions: DocsOptions) => {
+    enabled: boolean;
+    defaultName: string;
+    docsPage: boolean;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/addon-docs",
-  "version": "7.0.0-alpha.10",
+  "version": "7.0.0-alpha.13",
   "description": "Document component usage and properties in Markdown",
   "keywords": [
     "addon",
@@ -45,6 +45,7 @@
     "!__testfixtures__"
   ],
   "scripts": {
+    "check": "tsc --noEmit",
     "prepare": "node ../../scripts/prepare.js"
   },
   "dependencies": {
@@ -52,25 +53,25 @@
     "@babel/preset-env": "^7.12.11",
     "@jest/transform": "^26.6.2",
     "@mdx-js/react": "^1.6.22",
-    "@storybook/addons": "7.0.0-alpha.10",
-    "@storybook/api": "7.0.0-alpha.10",
-    "@storybook/blocks": "7.0.0-alpha.10",
-    "@storybook/components": "7.0.0-alpha.10",
-    "@storybook/core-common": "7.0.0-alpha.10",
-    "@storybook/core-events": "7.0.0-alpha.10",
+    "@storybook/addons": "7.0.0-alpha.13",
+    "@storybook/api": "7.0.0-alpha.13",
+    "@storybook/blocks": "7.0.0-alpha.13",
+    "@storybook/components": "7.0.0-alpha.13",
+    "@storybook/core-common": "7.0.0-alpha.13",
+    "@storybook/core-events": "7.0.0-alpha.13",
     "@storybook/csf": "0.0.2--canary.4566f4d.1",
-    "@storybook/csf-tools": "7.0.0-alpha.10",
-    "@storybook/docs-tools": "7.0.0-alpha.10",
+    "@storybook/csf-tools": "7.0.0-alpha.13",
+    "@storybook/docs-tools": "7.0.0-alpha.13",
     "@storybook/mdx1-csf": "^0.0.1",
-    "@storybook/node-logger": "7.0.0-alpha.10",
-    "@storybook/postinstall": "7.0.0-alpha.10",
-    "@storybook/preview-web": "7.0.0-alpha.10",
-    "@storybook/source-loader": "7.0.0-alpha.10",
-    "@storybook/store": "7.0.0-alpha.10",
-    "@storybook/theming": "7.0.0-alpha.10",
+    "@storybook/node-logger": "7.0.0-alpha.13",
+    "@storybook/postinstall": "7.0.0-alpha.13",
+    "@storybook/preview-web": "7.0.0-alpha.13",
+    "@storybook/source-loader": "7.0.0-alpha.13",
+    "@storybook/store": "7.0.0-alpha.13",
+    "@storybook/theming": "7.0.0-alpha.13",
     "babel-loader": "^8.2.5",
     "core-js": "^3.8.2",
-    "fast-deep-equal": "^3.1.3",
+    "dequal": "^2.0.2",
     "global": "^4.4.0",
     "lodash": "^4.17.21",
     "remark-external-links": "^8.0.0",
@@ -81,7 +82,8 @@
   "devDependencies": {
     "@babel/core": "^7.12.10",
     "@storybook/mdx2-csf": "^0.0.3",
-    "@types/util-deprecate": "^1.0.0"
+    "@types/util-deprecate": "^1.0.0",
+    "typescript": "~4.6.3"
   },
   "peerDependencies": {
     "@storybook/mdx2-csf": "^0.0.3",
@@ -102,7 +104,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b13dd8fb52819d73d4983148af8ffc5d683e8b75",
+  "gitHead": "9ac4d2e0a05eb945713a0e6689abc3b12359e181",
   "storybook": {
     "displayName": "Docs",
     "icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",

package/dist/cjs/manager.js

@@ -1,20 +0,0 @@
-"use strict";
-
-var _addons = require("@storybook/addons");
-
-var _shared = require("./shared");
-
-_addons.addons.register(_shared.ADDON_ID, () => {
-  _addons.addons.add(_shared.PANEL_ID, {
-    type: _addons.types.TAB,
-    title: 'Docs',
-    route: ({
-      storyId,
-      refId
-    }) => refId ? `/docs/${refId}_${storyId}` : `/docs/${storyId}`,
-    match: ({
-      viewMode
-    }) => viewMode === 'docs',
-    render: () => null
-  });
-});

package/dist/esm/manager.js

@@ -1,16 +0,0 @@
-import { addons, types } from '@storybook/addons';
-import { ADDON_ID, PANEL_ID } from './shared';
-addons.register(ADDON_ID, () => {
-  addons.add(PANEL_ID, {
-    type: types.TAB,
-    title: 'Docs',
-    route: ({
-      storyId,
-      refId
-    }) => refId ? `/docs/${refId}_${storyId}` : `/docs/${storyId}`,
-    match: ({
-      viewMode
-    }) => viewMode === 'docs',
-    render: () => null
-  });
-});

package/dist/types/manager.d.ts

@@ -1 +0,0 @@
-export {};

package/manager.js

@@ -1 +0,0 @@
-import './dist/esm/manager';

package/register.js

@@ -1,6 +0,0 @@
-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'
-);