@storybook/addon-docs - npm Package Compare versions

Comparing version 0.0.0-pr-30197-sha-99c86eb2 to 0.0.0-pr-30197-sha-a3d613d5

dist/index.d.ts

@@ -0,5 +1,25 @@
+import * as core_dist_types from 'storybook/internal/types';
 export * from '@storybook/blocks';
-import { Renderer, DocsRenderFunction } from 'storybook/internal/types';
+import { Renderer as Renderer$1, DocsRenderFunction } from 'storybook/internal/types';
 
-declare class DocsRenderer<TRenderer extends Renderer> {
+declare global {
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+interface Renderer {
+    /** What is the type of the `component` annotation in this renderer? */
+    component: any;
+    /** What does the story function return in this renderer? */
+    storyResult: any;
+    /** What type of element does this renderer render to? */
+    canvasElement: any;
+    mount(): Promise<Canvas>;
+    T?: unknown;
+}
+interface Canvas {
+}
+
+declare class DocsRenderer<TRenderer extends Renderer$1> {
     render: DocsRenderFunction<TRenderer>;
@@ -10,2 +30,4 @@ unmount: (element: HTMLElement) => void;
 
-export { DocsRenderer };
+declare const _default: () => core_dist_types.ProjectAnnotations<Renderer>;
+
+export { DocsRenderer, _default as default };

dist/index.js

@@ -1,1 +0,1 @@
-"use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default")),__toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{DocsRenderer:()=>DocsRenderer});module.exports=__toCommonJS(src_exports);__reExport(src_exports,require("@storybook/blocks"),module.exports);var import_react=__toESM(require("react")),import_blocks=require("@storybook/blocks"),import_react_dom_shim=require("@storybook/react-dom-shim"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_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:import_react.default.createElement(import_react.default.Fragment,null,children)}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter?.components},TDocs=import_blocks.Docs;return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}};0&&(module.exports={DocsRenderer,...require("@storybook/blocks")});
+"use strict";var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;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})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to},__reExport=(target,mod,secondTarget)=>(__copyProps(target,mod,"default"),secondTarget&&__copyProps(secondTarget,mod,"default")),__toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>DocsRenderer,defaultComponents:()=>defaultComponents});var import_react,import_blocks,import_react_dom_shim,defaultComponents,ErrorBoundary,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){"use strict";import_react=__toESM(require("react")),import_blocks=require("@storybook/blocks"),import_react_dom_shim=require("@storybook/react-dom-shim"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_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:import_react.default.createElement(import_react.default.Fragment,null,children)}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter?.components},TDocs=import_blocks.Docs;return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(TDocs,{context,docsParameter}))),element)).then(()=>resolve())})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}}}});var src_exports={};__export(src_exports,{DocsRenderer:()=>DocsRenderer,default:()=>src_default});module.exports=__toCommonJS(src_exports);var import_preview_api=require("storybook/internal/preview-api");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}}};__reExport(src_exports,require("@storybook/blocks"),module.exports);init_DocsRenderer();var src_default=()=>(0,import_preview_api.definePreview)(preview_exports);0&&(module.exports={DocsRenderer,...require("@storybook/blocks")});

package.json

 {
   "name": "@storybook/addon-docs",
-  "version": "0.0.0-pr-30197-sha-99c86eb2",
+  "version": "0.0.0-pr-30197-sha-a3d613d5",
   "description": "Document component usage and properties in Markdown",
@@ -84,2 +84,12 @@ "keywords": [
   "types": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/index.d.ts"
+      ],
+      "preview": [
+        "dist/preview.d.ts"
+      ]
+    }
+  },
   "files": [
@@ -107,5 +117,5 @@ "dist/**/*",
     "@mdx-js/react": "^3.0.0",
-    "@storybook/blocks": "0.0.0-pr-30197-sha-99c86eb2",
-    "@storybook/csf-plugin": "0.0.0-pr-30197-sha-99c86eb2",
-    "@storybook/react-dom-shim": "0.0.0-pr-30197-sha-99c86eb2",
+    "@storybook/blocks": "0.0.0-pr-30197-sha-a3d613d5",
+    "@storybook/csf-plugin": "0.0.0-pr-30197-sha-a3d613d5",
+    "@storybook/react-dom-shim": "0.0.0-pr-30197-sha-a3d613d5",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
@@ -127,3 +137,3 @@ "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0",
   "peerDependencies": {
-    "storybook": "^0.0.0-pr-30197-sha-99c86eb2"
+    "storybook": "^0.0.0-pr-30197-sha-a3d613d5"
   },
@@ -130,0 +140,0 @@ "publishConfig": {

No alert changes

Improved metrics

Total package byte prevSize

2201024

increased by0.1%

Number of package files

40

increased by2.56%

Lines of code

12408

increased by0.24%

Dependency changes

• + Added@storybook/blocks@0.0.0-pr-30197-sha-a3d613d5(transitive)

• + Added@storybook/csf@0.1.14--canary.f3da709.0(transitive)

• + Added@storybook/csf-plugin@0.0.0-pr-30197-sha-a3d613d5(transitive)

• + Added@storybook/react-dom-shim@0.0.0-pr-30197-sha-a3d613d5(transitive)

• - Removed@storybook/blocks@0.0.0-pr-30197-sha-99c86eb2(transitive)

• - Removed@storybook/csf@0.1.12(transitive)

• - Removed@storybook/csf-plugin@0.0.0-pr-30197-sha-99c86eb2(transitive)

• - Removed@storybook/react-dom-shim@0.0.0-pr-30197-sha-99c86eb2(transitive)

• Updated@storybook/blocks@0.0.0-pr-30197-sha-a3d613d5

• Updated@storybook/csf-plugin@0.0.0-pr-30197-sha-a3d613d5

• Updated@storybook/react-dom-shim@0.0.0-pr-30197-sha-a3d613d5