@storybook/addon-docs 9.1.0-alpha.3 → 9.1.0-alpha.4

package/dist/index.d.ts

@@ -1,12 +1,6 @@
-import * as core_dist_types from 'storybook/internal/types';
+import * as storybook_internal_csf from 'storybook/internal/csf';
+import { ModuleExports, ModuleExport, Renderer, DocsRenderFunction } from 'storybook/internal/types';
 export * from '@storybook/addon-docs/blocks';
-import { Renderer, DocsRenderFunction, ModuleExports, ModuleExport } from 'storybook/internal/types';
-
-declare class DocsRenderer<TRenderer extends Renderer> {
-    render: DocsRenderFunction<TRenderer>;
-    unmount: (element: HTMLElement) => void;
-    constructor();
-}
 
 type StoryBlockParameters = {
     /** Whether a story's play function runs when shown in docs page */
@@ -145,7 +139,7 @@ interface DocsParameters {
          *
          * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas
          */
-        canvas?: CanvasBlockParameters;
+        canvas?: Partial<CanvasBlockParameters>;
         /**
          * Controls block configuration
          *
@@ -171,13 +165,13 @@ interface DocsParameters {
          *
          * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source
          */
-        source?: SourceBlockParameters;
+        source?: Partial<SourceBlockParameters>;
         /**
          * Story configuration
          *
          * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-story
          */
-        story?: StoryBlockParameters;
+        story?: Partial<StoryBlockParameters>;
         /**
          * The subtitle displayed when shown in docs page
          *
@@ -192,7 +186,16 @@ interface DocsParameters {
         title?: string;
     };
 }
+interface DocsTypes {
+    parameters: DocsParameters;
+}
+
+declare class DocsRenderer<TRenderer extends Renderer> {
+    render: DocsRenderFunction<TRenderer>;
+    unmount: (element: HTMLElement) => void;
+    constructor();
+}
 
-declare const _default: () => core_dist_types.ProjectAnnotations<core_dist_types.Renderer>;
+declare const _default: () => storybook_internal_csf.PreviewAddon<DocsTypes>;
 
-export { DocsParameters, DocsRenderer, _default as default };
+export { DocsRenderer, DocsTypes, _default as default };

package/dist/index.js

@@ -5,13 +5,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var React = require('react');
 var reactDomShim = require('@storybook/react-dom-shim');
 var blocks = require('@storybook/addon-docs/blocks');
-var previewApi = require('storybook/preview-api');
+var csf = require('storybook/internal/csf');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var React__default = /*#__PURE__*/_interopDefault(React);
 
-var __defProp=Object.defineProperty;var __getOwnPropNames=Object.getOwnPropertyNames;var __esm=(fn,res)=>function(){return fn&&(res=(0, fn[__getOwnPropNames(fn)[0]])(fn=0)),res};var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0});};var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>exports.DocsRenderer,defaultComponents:()=>defaultComponents});var defaultComponents,ErrorBoundary;exports.DocsRenderer = void 0;var init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){defaultComponents={code:blocks.CodeOrSourceMdx,a:blocks.AnchorMdx,...blocks.HeadersMdx},ErrorBoundary=class extends React.Component{constructor(){super(...arguments);this.state={hasError:!1};}static getDerivedStateFromError(){return {hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err);}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:React__default.default.createElement(React__default.default.Fragment,null,children)}},exports.DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter?.components},TDocs=blocks.Docs;return new Promise((resolve,reject)=>{import('@mdx-js/react').then(({MDXProvider})=>reactDomShim.renderElement(React__default.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},React__default.default.createElement(MDXProvider,{components},React__default.default.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve());})},this.unmount=element=>{reactDomShim.unmountElement(element);};}};}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});var excludeTags=Object.entries(globalThis.TAGS_OPTIONS??{}).reduce((acc,entry)=>{let[tag,option]=entry;return option.excludeFromDocsStories&&(acc[tag]=!0),acc},{}),parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2},stories:{filter:story=>(story.tags||[]).filter(tag=>excludeTags[tag]).length===0&&!story.parameters.docs?.disable}}};init_DocsRenderer();var index_default=()=>previewApi.definePreview(preview_exports);
+var __defProp=Object.defineProperty;var __getOwnPropNames=Object.getOwnPropertyNames;var __esm=(fn,res)=>function(){return fn&&(res=(0, fn[__getOwnPropNames(fn)[0]])(fn=0)),res};var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0});};var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>exports.DocsRenderer,defaultComponents:()=>defaultComponents});var defaultComponents,ErrorBoundary;exports.DocsRenderer = void 0;var init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){defaultComponents={code:blocks.CodeOrSourceMdx,a:blocks.AnchorMdx,...blocks.HeadersMdx},ErrorBoundary=class extends React.Component{constructor(){super(...arguments);this.state={hasError:!1};}static getDerivedStateFromError(){return {hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err);}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:React__default.default.createElement(React__default.default.Fragment,null,children)}},exports.DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter?.components},TDocs=blocks.Docs;return new Promise((resolve,reject)=>{import('@mdx-js/react').then(({MDXProvider})=>reactDomShim.renderElement(React__default.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},React__default.default.createElement(MDXProvider,{components},React__default.default.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve());})},this.unmount=element=>{reactDomShim.unmountElement(element);};}};}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});var excludeTags=Object.entries(globalThis.TAGS_OPTIONS??{}).reduce((acc,entry)=>{let[tag,option]=entry;return option.excludeFromDocsStories&&(acc[tag]=!0),acc},{}),parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2},stories:{filter:story=>(story.tags||[]).filter(tag=>excludeTags[tag]).length===0&&!story.parameters.docs?.disable}}};init_DocsRenderer();var index_default=()=>csf.definePreviewAddon(preview_exports);
 
 exports.default = index_default;
 Object.keys(blocks).forEach(function (k) {

package/dist/index.mjs

@@ -1,8 +1,8 @@
 export { DocsRenderer } from './chunk-GWJYCGSQ.mjs';
 import { __export } from './chunk-QUZPS4B6.mjs';
-import { definePreview } from 'storybook/preview-api';
+import { definePreviewAddon } from 'storybook/internal/csf';
 export * from '@storybook/addon-docs/blocks';
 
-var preview_exports={};__export(preview_exports,{parameters:()=>parameters});var excludeTags=Object.entries(globalThis.TAGS_OPTIONS??{}).reduce((acc,entry)=>{let[tag,option]=entry;return option.excludeFromDocsStories&&(acc[tag]=!0),acc},{}),parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await import('./DocsRenderer-3PZUHFFL.mjs');return new DocsRenderer2},stories:{filter:story=>(story.tags||[]).filter(tag=>excludeTags[tag]).length===0&&!story.parameters.docs?.disable}}};var index_default=()=>definePreview(preview_exports);
+var preview_exports={};__export(preview_exports,{parameters:()=>parameters});var excludeTags=Object.entries(globalThis.TAGS_OPTIONS??{}).reduce((acc,entry)=>{let[tag,option]=entry;return option.excludeFromDocsStories&&(acc[tag]=!0),acc},{}),parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await import('./DocsRenderer-3PZUHFFL.mjs');return new DocsRenderer2},stories:{filter:story=>(story.tags||[]).filter(tag=>excludeTags[tag]).length===0&&!story.parameters.docs?.disable}}};var index_default=()=>definePreviewAddon(preview_exports);
 
 export { index_default as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/addon-docs",
-  "version": "9.1.0-alpha.3",
+  "version": "9.1.0-alpha.4",
   "description": "Document component usage and properties in Markdown",
   "keywords": [
     "addon",
@@ -111,9 +111,9 @@
   },
   "dependencies": {
     "@mdx-js/react": "^3.0.0",
-    "@storybook/csf-plugin": "9.1.0-alpha.3",
+    "@storybook/csf-plugin": "9.1.0-alpha.4",
     "@storybook/icons": "^1.2.12",
-    "@storybook/react-dom-shim": "9.1.0-alpha.3",
+    "@storybook/react-dom-shim": "9.1.0-alpha.4",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
     "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
     "ts-dedent": "^2.0.0"
@@ -140,7 +140,7 @@
     "vite": "^6.2.5"
   },
   "peerDependencies": {
-    "storybook": "^9.1.0-alpha.3"
+    "storybook": "^9.1.0-alpha.4"
   },
   "publishConfig": {
     "access": "public"