@storybook/addon-docs 7.0.0-alpha.3 → 7.0.0-alpha.33

package/dist/esm/preset.js

@@ -45,6 +45,7 @@ export async function webpack(webpackConfig = {}, options) {
     transcludeMarkdown = false
   } = options;
   const mdxLoaderOptions = {
+    // whether to skip storybook files, useful for docs only mdx or md files
     skipCsf: true,
     remarkPlugins: [remarkSlug, remarkExternalLinks]
   };
@@ -91,7 +92,10 @@ export async function webpack(webpackConfig = {}, options) {
             configureJSX
           })
         }, {
-          loader: mdxLoader
+          loader: mdxLoader,
+          options: Object.assign({}, mdxLoaderOptions, {
+            skipCsf: false
+          })
         }]
       }, {
         test: /\.mdx$/,
@@ -114,7 +118,7 @@ export async function webpack(webpackConfig = {}, options) {
 }
 export const storyIndexers = async indexers => {
   const mdxIndexer = async (fileName, opts) => {
-    let code = (await fs.readFile(fileName, 'utf-8')).toString(); // @ts-ignore
+    let code = (await fs.readFile(fileName, 'utf-8')).toString(); // @ts-expect-error (Converted from ts-ignore)
 
     const {
       compile
@@ -127,6 +131,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/esm/preview.js

@@ -1,6 +1,10 @@
 export const parameters = {
   docs: {
-    getContainer: async () => (await import('./blocks')).DocsContainer,
-    getPage: async () => (await import('./blocks')).DocsPage
+    renderer: async () => {
+      const {
+        DocsRenderer
+      } = await import('./DocsRenderer');
+      return new DocsRenderer();
+    }
   }
 };

package/dist/types/DocsRenderer.d.ts

@@ -0,0 +1,8 @@
+import { AnyFramework } from '@storybook/csf';
+import { DocsRenderFunction } from '@storybook/preview-web';
+export declare const defaultComponents: Record<string, any>;
+export declare class DocsRenderer<TFramework extends AnyFramework> {
+    render: DocsRenderFunction<TFramework>;
+    unmount: (element: HTMLElement) => void;
+    constructor();
+}

package/dist/types/blocks/index.d.ts

@@ -1,24 +1 @@
-export { ColorPalette, ColorItem, IconGallery, IconItem, Typeset } from '@storybook/components';
-export * from './Anchor';
-export * from './ArgsTable';
-export * from './Canvas';
-export * from './Description';
-export * from './DocsContext';
-export * from './DocsPage';
-export * from './DocsContainer';
-export * from './DocsStory';
-export * from './Heading';
-export * from './Meta';
-export * from './Preview';
-export * from './Primary';
-export * from './Props';
-export * from './Source';
-export * from './SourceContainer';
-export * from './Stories';
-export * from './Story';
-export * from './Subheading';
-export * from './Subtitle';
-export * from './Title';
-export * from './Wrapper';
-export * from './types';
-export * from './mdx';
+export * from '@storybook/blocks';

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export * from './blocks';
+export { DocsRenderer } from './DocsRenderer';

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,11 @@ 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;
+    docsMode?: boolean;
+};
 export {};

package/dist/types/preview.d.ts

@@ -1,6 +1 @@
-export declare const parameters: {
-    docs: {
-        getContainer: () => Promise<import("react").FunctionComponent<import("./blocks").DocsContainerProps<import("@storybook/csf").AnyFramework>>>;
-        getPage: () => Promise<import("react").FC<{}>>;
-    };
-};
+export declare const parameters: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/addon-docs",
-  "version": "7.0.0-alpha.3",
+  "version": "7.0.0-alpha.33",
   "description": "Document component usage and properties in Markdown",
   "keywords": [
     "addon",
@@ -45,34 +45,34 @@
     "!__testfixtures__"
   ],
   "scripts": {
-    "prepare": "node ../../scripts/prepare.js"
+    "check": "tsc --noEmit",
+    "prep": "node ../../../scripts/prepare.js"
   },
   "dependencies": {
     "@babel/plugin-transform-react-jsx": "^7.12.12",
     "@babel/preset-env": "^7.12.11",
     "@jest/transform": "^26.6.2",
     "@mdx-js/react": "^1.6.22",
-    "@storybook/addons": "7.0.0-alpha.3",
-    "@storybook/api": "7.0.0-alpha.3",
-    "@storybook/components": "7.0.0-alpha.3",
-    "@storybook/core-common": "7.0.0-alpha.3",
-    "@storybook/core-events": "7.0.0-alpha.3",
-    "@storybook/csf": "0.0.2--canary.4566f4d.1",
-    "@storybook/csf-tools": "7.0.0-alpha.3",
-    "@storybook/docs-tools": "7.0.0-alpha.3",
-    "@storybook/mdx1-csf": "^0.0.1",
-    "@storybook/node-logger": "7.0.0-alpha.3",
-    "@storybook/postinstall": "7.0.0-alpha.3",
-    "@storybook/preview-web": "7.0.0-alpha.3",
-    "@storybook/source-loader": "7.0.0-alpha.3",
-    "@storybook/store": "7.0.0-alpha.3",
-    "@storybook/theming": "7.0.0-alpha.3",
+    "@storybook/addons": "7.0.0-alpha.33",
+    "@storybook/api": "7.0.0-alpha.33",
+    "@storybook/blocks": "7.0.0-alpha.33",
+    "@storybook/components": "7.0.0-alpha.33",
+    "@storybook/core-common": "7.0.0-alpha.33",
+    "@storybook/core-events": "7.0.0-alpha.33",
+    "@storybook/csf": "0.0.2--canary.0899bb7.0",
+    "@storybook/csf-tools": "7.0.0-alpha.33",
+    "@storybook/docs-tools": "7.0.0-alpha.33",
+    "@storybook/mdx1-csf": "0.0.5-canary.13.9ce928a.0",
+    "@storybook/node-logger": "7.0.0-alpha.33",
+    "@storybook/postinstall": "7.0.0-alpha.33",
+    "@storybook/preview-web": "7.0.0-alpha.33",
+    "@storybook/source-loader": "7.0.0-alpha.33",
+    "@storybook/store": "7.0.0-alpha.33",
+    "@storybook/theming": "7.0.0-alpha.33",
     "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",
-    "regenerator-runtime": "^0.13.7",
     "remark-external-links": "^8.0.0",
     "remark-slug": "^6.0.0",
     "ts-dedent": "^2.0.0",
@@ -80,11 +80,12 @@
   },
   "devDependencies": {
     "@babel/core": "^7.12.10",
-    "@storybook/mdx2-csf": "^0.0.3",
-    "@types/util-deprecate": "^1.0.0"
+    "@storybook/mdx2-csf": "0.0.4-canary.14.04ffbe8.0",
+    "@types/util-deprecate": "^1.0.0",
+    "typescript": "~4.6.3"
   },
   "peerDependencies": {
-    "@storybook/mdx2-csf": "^0.0.3",
+    "@storybook/mdx2-csf": "0.0.4-canary.14.04ffbe8.0",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
     "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
@@ -102,7 +103,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "629b056190993bcee6445471b8cb27208eb401a9",
+  "gitHead": "5da5b0fabd04cc5cd5771e8242a960f05d03234a",
   "storybook": {
     "displayName": "Docs",
     "icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",

package/web-components/README.md

@@ -39,6 +39,7 @@ Known analyzers that output `custom-elements.json` v1.0.0:
   - Supports Vanilla, LitElement, FASTElement, Stencil, Catalyst, Atomico
 
 Known analyzers that output older versions of `custom-elements.json`:
+
 - [web-component-analyzer](https://github.com/runem/web-component-analyzer)
   - Supports LitElement, Polymer, Vanilla, (Stencil)
 - [stenciljs](https://stenciljs.com/)

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Kadira Inc. <hello@kadira.io>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

package/dist/cjs/blocks/Anchor.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.anchorBlockIdFromId = exports.Anchor = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const anchorBlockIdFromId = storyId => `anchor--${storyId}`;
-
-exports.anchorBlockIdFromId = anchorBlockIdFromId;
-
-const Anchor = ({
-  storyId,
-  children
-}) => /*#__PURE__*/_react.default.createElement("div", {
-  id: anchorBlockIdFromId(storyId)
-}, children);
-
-exports.Anchor = Anchor;

package/dist/cjs/blocks/ArgsTable.js

@@ -1,329 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getComponent = exports.extractComponentArgTypes = exports.StoryTable = exports.ComponentsTable = exports.ArgsTable = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _mapValues = _interopRequireDefault(require("lodash/mapValues"));
-
-var _components = require("@storybook/components");
-
-var _addons = require("@storybook/addons");
-
-var _store = require("@storybook/store");
-
-var _coreEvents = _interopRequireDefault(require("@storybook/core-events"));
-
-var _DocsContext = require("./DocsContext");
-
-var _types = require("./types");
-
-var _utils = require("./utils");
-
-var _Story = require("./Story");
-
-var _useStory = require("./useStory");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-
-const getContext = (storyId, context) => {
-  const story = context.storyById(storyId);
-
-  if (!story) {
-    throw new Error(`Unknown story: ${storyId}`);
-  }
-
-  return context.getStoryContext(story);
-};
-
-const useArgs = (storyId, context) => {
-  const channel = _addons.addons.getChannel();
-
-  const storyContext = getContext(storyId, context);
-  const [args, setArgs] = (0, _react.useState)(storyContext.args);
-  (0, _react.useEffect)(() => {
-    const cb = changed => {
-      if (changed.storyId === storyId) {
-        setArgs(changed.args);
-      }
-    };
-
-    channel.on(_coreEvents.default.STORY_ARGS_UPDATED, cb);
-    return () => channel.off(_coreEvents.default.STORY_ARGS_UPDATED, cb);
-  }, [storyId]);
-  const updateArgs = (0, _react.useCallback)(updatedArgs => channel.emit(_coreEvents.default.UPDATE_STORY_ARGS, {
-    storyId,
-    updatedArgs
-  }), [storyId]);
-  const resetArgs = (0, _react.useCallback)(argNames => channel.emit(_coreEvents.default.RESET_STORY_ARGS, {
-    storyId,
-    argNames
-  }), [storyId]);
-  return [args, updateArgs, resetArgs];
-};
-
-const useGlobals = (storyId, context) => {
-  const channel = _addons.addons.getChannel();
-
-  const storyContext = getContext(storyId, context);
-  const [globals, setGlobals] = (0, _react.useState)(storyContext.globals);
-  (0, _react.useEffect)(() => {
-    const cb = changed => {
-      setGlobals(changed.globals);
-    };
-
-    channel.on(_coreEvents.default.GLOBALS_UPDATED, cb);
-    return () => channel.off(_coreEvents.default.GLOBALS_UPDATED, cb);
-  }, []);
-  return [globals];
-};
-
-const extractComponentArgTypes = (component, {
-  id,
-  storyById
-}, include, exclude) => {
-  const {
-    parameters
-  } = storyById(id);
-  const {
-    extractArgTypes
-  } = parameters.docs || {};
-
-  if (!extractArgTypes) {
-    throw new Error(_components.ArgsTableError.ARGS_UNSUPPORTED);
-  }
-
-  let argTypes = extractArgTypes(component);
-  argTypes = (0, _store.filterArgTypes)(argTypes, include, exclude);
-  return argTypes;
-};
-
-exports.extractComponentArgTypes = extractComponentArgTypes;
-
-const isShortcut = value => {
-  return value && [_types.CURRENT_SELECTION, _types.PRIMARY_STORY].includes(value);
-};
-
-const getComponent = (props = {}, {
-  id,
-  storyById
-}) => {
-  const {
-    of
-  } = props;
-  const {
-    story
-  } = props;
-  const {
-    component
-  } = storyById(id);
-
-  if (isShortcut(of) || isShortcut(story)) {
-    return component || null;
-  }
-
-  if (!of) {
-    throw new Error(_components.ArgsTableError.NO_COMPONENT);
-  }
-
-  return of;
-};
-
-exports.getComponent = getComponent;
-
-const addComponentTabs = (tabs, components, context, include, exclude, sort) => Object.assign({}, tabs, (0, _mapValues.default)(components, comp => ({
-  rows: extractComponentArgTypes(comp, context, include, exclude),
-  sort
-})));
-
-const StoryTable = props => {
-  const context = (0, _react.useContext)(_DocsContext.DocsContext);
-  const {
-    id: currentId,
-    componentStories
-  } = context;
-  const {
-    story: storyName,
-    component,
-    subcomponents,
-    showComponent,
-    include,
-    exclude,
-    sort
-  } = props;
-
-  try {
-    let storyId;
-
-    switch (storyName) {
-      case _types.CURRENT_SELECTION:
-        {
-          storyId = currentId;
-          break;
-        }
-
-      case _types.PRIMARY_STORY:
-        {
-          const primaryStory = componentStories()[0];
-          storyId = primaryStory.id;
-          break;
-        }
-
-      default:
-        {
-          storyId = (0, _Story.lookupStoryId)(storyName, context);
-        }
-    }
-
-    const story = (0, _useStory.useStory)(storyId, context); // eslint-disable-next-line prefer-const
-
-    let [args, updateArgs, resetArgs] = useArgs(storyId, context);
-    const [globals] = useGlobals(storyId, context);
-    if (!story) return /*#__PURE__*/_react.default.createElement(_components.ArgsTable, {
-      isLoading: true,
-      updateArgs: updateArgs,
-      resetArgs: resetArgs
-    });
-    const argTypes = (0, _store.filterArgTypes)(story.argTypes, include, exclude);
-    const mainLabel = (0, _utils.getComponentName)(component) || 'Story';
-    let tabs = {
-      [mainLabel]: {
-        rows: argTypes,
-        args,
-        globals,
-        updateArgs,
-        resetArgs
-      }
-    }; // Use the dynamically generated component tabs if there are no controls
-
-    const storyHasArgsWithControls = argTypes && Object.values(argTypes).find(v => !!(v !== null && v !== void 0 && v.control));
-
-    if (!storyHasArgsWithControls) {
-      updateArgs = null;
-      resetArgs = null;
-      tabs = {};
-    }
-
-    if (component && (!storyHasArgsWithControls || showComponent)) {
-      tabs = addComponentTabs(tabs, {
-        [mainLabel]: component
-      }, context, include, exclude);
-    }
-
-    if (subcomponents) {
-      if (Array.isArray(subcomponents)) {
-        throw new Error(`Unexpected subcomponents array. Expected an object whose keys are tab labels and whose values are components.`);
-      }
-
-      tabs = addComponentTabs(tabs, subcomponents, context, include, exclude);
-    }
-
-    return /*#__PURE__*/_react.default.createElement(_components.TabbedArgsTable, {
-      tabs: tabs,
-      sort: sort
-    });
-  } catch (err) {
-    return /*#__PURE__*/_react.default.createElement(_components.ArgsTable, {
-      error: err.message
-    });
-  }
-};
-
-exports.StoryTable = StoryTable;
-
-const ComponentsTable = props => {
-  const context = (0, _react.useContext)(_DocsContext.DocsContext);
-  const {
-    components,
-    include,
-    exclude,
-    sort
-  } = props;
-  const tabs = addComponentTabs({}, components, context, include, exclude);
-  return /*#__PURE__*/_react.default.createElement(_components.TabbedArgsTable, {
-    tabs: tabs,
-    sort: sort
-  });
-};
-
-exports.ComponentsTable = ComponentsTable;
-
-const ArgsTable = props => {
-  const context = (0, _react.useContext)(_DocsContext.DocsContext);
-  const {
-    id,
-    storyById
-  } = context;
-  const {
-    parameters: {
-      controls
-    },
-    subcomponents
-  } = storyById(id);
-  const {
-    include,
-    exclude,
-    components,
-    sort: sortProp
-  } = props;
-  const {
-    story: storyName
-  } = props;
-  const sort = sortProp || (controls === null || controls === void 0 ? void 0 : controls.sort);
-  const main = getComponent(props, context);
-
-  if (storyName) {
-    return /*#__PURE__*/_react.default.createElement(StoryTable, _extends({}, props, {
-      component: main,
-      subcomponents,
-      sort
-    }));
-  }
-
-  if (!components && !subcomponents) {
-    let mainProps;
-
-    try {
-      mainProps = {
-        rows: extractComponentArgTypes(main, context, include, exclude)
-      };
-    } catch (err) {
-      mainProps = {
-        error: err.message
-      };
-    }
-
-    return /*#__PURE__*/_react.default.createElement(_components.ArgsTable, _extends({}, mainProps, {
-      sort: sort
-    }));
-  }
-
-  if (components) {
-    return /*#__PURE__*/_react.default.createElement(ComponentsTable, _extends({}, props, {
-      components,
-      sort
-    }));
-  }
-
-  const mainLabel = (0, _utils.getComponentName)(main);
-  return /*#__PURE__*/_react.default.createElement(ComponentsTable, _extends({}, props, {
-    components: Object.assign({
-      [mainLabel]: main
-    }, subcomponents),
-    sort: sort
-  }));
-};
-
-exports.ArgsTable = ArgsTable;
-ArgsTable.defaultProps = {
-  of: _types.CURRENT_SELECTION
-};