@storybook/types 7.0.0-beta.3 → 7.0.0-beta.31

package/dist/index.d.ts

@@ -1219,7 +1219,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
      * Used by addons for automatic prop table generation and display of other component metadata.
      */
     component?: (TRenderer & {
-        T: Args extends TArgs ? any : TArgs;
+        T: Record<string, unknown> extends Required<TArgs> ? any : TArgs;
     })['component'];
     /**
      * Auxiliary subcomponents that are part of the stories.
@@ -1478,15 +1478,6 @@ type StoryIndexEntry = BaseIndexEntry & {
 type DocsIndexEntry = BaseIndexEntry & {
     storiesImports: Path[];
     type: 'docs';
-    standalone: boolean;
-};
-/** A StandaloneDocsIndexExtry represents a file who's default export is directly renderable */
-type StandaloneDocsIndexEntry = DocsIndexEntry & {
-    standalone: true;
-};
-/** A TemplateDocsIndexEntry represents a stories file that gets rendered in "docs" mode */
-type TemplateDocsIndexEntry = DocsIndexEntry & {
-    standalone: false;
 };
 type IndexEntry = StoryIndexEntry | DocsIndexEntry;
 interface V2CompatIndexEntry extends Omit<StoryIndexEntry, 'type'> {
@@ -1533,6 +1524,14 @@ interface Addon_OptionsParameter extends Object {
     };
     [key: string]: any;
 }
+interface Addon_OptionsParameterV7 extends Object {
+    storySort?: Addon_StorySortParameterV7;
+    theme?: {
+        base: string;
+        brandTitle?: string;
+    };
+    [key: string]: any;
+}
 type Addon_StoryContext<TRenderer extends Renderer = Renderer> = StoryContext<TRenderer>;
 type Addon_StoryContextUpdate = Partial<Addon_StoryContext>;
 type Addon_ReturnTypeFramework<ReturnType> = {
@@ -1782,6 +1781,7 @@ type NormalizedStoryAnnotations<TRenderer extends Renderer = Renderer> = Omit<St
 type CSFFile<TRenderer extends Renderer = Renderer> = {
     meta: NormalizedComponentAnnotations<TRenderer>;
     stories: Record<StoryId, NormalizedStoryAnnotations<TRenderer>>;
+    moduleExports: ModuleExports;
 };
 type PreparedStory<TRenderer extends Renderer = Renderer> = StoryContextForEnhancers<TRenderer> & {
     moduleExport: ModuleExport;
@@ -1793,6 +1793,9 @@ type PreparedStory<TRenderer extends Renderer = Renderer> = StoryContextForEnhan
     }>;
     playFunction?: (context: StoryContext<TRenderer>) => Promise<void> | void;
 };
+type PreparedMeta<TRenderer extends Renderer = Renderer> = Omit<StoryContextForEnhancers<TRenderer>, 'name' | 'story'> & {
+    moduleExport: ModuleExport;
+};
 type BoundStory<TRenderer extends Renderer = Renderer> = PreparedStory<TRenderer> & {
     storyFn: PartialStoryFn<TRenderer>;
 };
@@ -1944,20 +1947,17 @@ interface CLIOptions {
     quiet?: boolean;
     versionUpdates?: boolean;
     releaseNotes?: boolean;
-    dll?: boolean;
     docs?: boolean;
-    docsDll?: boolean;
-    uiDll?: boolean;
     debugWebpack?: boolean;
     webpackStatsJson?: string | boolean;
     outputDir?: string;
 }
 interface BuilderOptions {
     configType?: 'DEVELOPMENT' | 'PRODUCTION';
-    ignorePreview: boolean;
-    cache: FileSystemCache;
+    ignorePreview?: boolean;
+    cache?: FileSystemCache;
     configDir: string;
-    docsMode: boolean;
+    docsMode?: boolean;
     features?: StorybookConfig['features'];
     versionCheck?: VersionCheck;
     releaseNotesData?: ReleaseNotesData;
@@ -2024,18 +2024,19 @@ type CoreCommon_StorybookRefs = Record<string, {
 }>;
 type DocsOptions = {
     /**
-     * Should we generate docs entries at all under any circumstances? (i.e. can they be rendered)
+     * Should we disable generate docs entries at all under any circumstances? (i.e. can they be rendered)
      */
-    enabled?: boolean;
+    disable?: boolean;
     /**
      * What should we call the generated docs entries?
      */
     defaultName?: string;
     /**
-     * Should we generate a docs entry per CSF file with the `docsPage` tag?
-     * Set to 'automatic' to generate an entry irrespective of tag.
+     * Should we generate a docs entry per CSF file?
+     * Set to 'tag' (the default) to generate an entry for every CSF file with the
+     * 'autodocs' tag.
      */
-    docsPage?: boolean | 'automatic';
+    autodocs?: boolean | 'tag';
     /**
      * Only show doc entries in the side bar (usually set with the `--docs` CLI flag)
      */
@@ -2325,12 +2326,12 @@ type API_Group = API_GroupEntry | API_ComponentEntry;
 /** @deprecated */
 type API_Story = API_LeafEntry;
 /**
- * The `StoriesHash` is our manager-side representation of the `StoryIndex`.
+ * The `IndexHash` is our manager-side representation of the `StoryIndex`.
  * We create entries in the hash not only for each story or docs entry, but
  * also for each "group" of the component (split on '/'), as that's how things
  * are manipulated in the manager (i.e. in the sidebar)
  */
-interface API_StoriesHash {
+interface API_IndexHash {
     [id: string]: API_HashEntry;
 }
 type API_PreparedIndexEntry = IndexEntry & {
@@ -2517,38 +2518,63 @@ type API_SetRefData = Partial<API_ComposedRef & {
     storyIndex: StoryIndex;
 }>;
 type API_StoryMapper = (ref: API_ComposedRef, story: SetStoriesStory) => SetStoriesStory;
-interface API_ComposedRef {
+interface API_LoadedRefData {
+    index?: API_IndexHash;
+    indexError?: Error;
+    previewInitialized: boolean;
+}
+interface API_ComposedRef extends API_LoadedRefData {
     id: string;
     title?: string;
     url: string;
     type?: 'auto-inject' | 'unknown' | 'lazy' | 'server-checked';
     expanded?: boolean;
-    stories: API_StoriesHash;
     versions?: API_Versions;
     loginUrl?: string;
     version?: string;
-    ready?: boolean;
-    error?: any;
 }
-type API_ComposedRefUpdate = Partial<Pick<API_ComposedRef, 'title' | 'type' | 'expanded' | 'stories' | 'versions' | 'loginUrl' | 'version' | 'ready' | 'error'>>;
+type API_ComposedRefUpdate = Partial<Pick<API_ComposedRef, 'title' | 'type' | 'expanded' | 'index' | 'versions' | 'loginUrl' | 'version' | 'indexError' | 'previewInitialized'>>;
 type API_Refs = Record<string, API_ComposedRef>;
 type API_RefId = string;
 type API_RefUrl = string;
 
 type StoryRenderOptions = {
     autoplay?: boolean;
+    forceInitialArgs?: boolean;
 };
+type ResolvedModuleExportType = 'component' | 'meta' | 'story';
+type ResolvedModuleExportFromType<TType extends ResolvedModuleExportType, TRenderer extends Renderer = Renderer> = TType extends 'component' ? {
+    type: 'component';
+    component: TRenderer['component'];
+} : TType extends 'meta' ? {
+    type: 'meta';
+    csfFile: CSFFile<TRenderer>;
+} : {
+    type: 'story';
+    story: PreparedStory<TRenderer>;
+};
+/**
+ * What do we know about an of={} call?
+ *
+ * Technically, the type names aren't super accurate:
+ *   - meta === `CSFFile`
+ *   - story === `PreparedStory`
+ * But these shorthands capture the idea of what is being talked about
+ */
+type ResolvedModuleExport<TRenderer extends Renderer = Renderer> = {
+    type: ResolvedModuleExportType;
+} & (ResolvedModuleExportFromType<'component', TRenderer> | ResolvedModuleExportFromType<'meta', TRenderer> | ResolvedModuleExportFromType<'story', TRenderer>);
 interface DocsContextProps<TRenderer extends Renderer = Renderer> {
     /**
-     * Register the CSF file that this docs entry represents.
-     * Used by the `<Meta of={} />` block.
+     * Register a CSF file that this docs entry uses.
+     * Used by the `<Meta of={} />` block to attach, and the `<Story meta={} />` bloc to reference
      */
-    setMeta: (metaExports: ModuleExports) => void;
+    referenceMeta: (metaExports: ModuleExports, attach: boolean) => void;
     /**
-     * Find a story's id from the direct export from the CSF file.
-     * This is primarily used by the `<Story of={} /> block.
+     * Find a component, meta or story object from the direct export(s) from the CSF file.
+     * This is the API that drives the `of={}` syntax.
      */
-    storyIdByModuleExport: (storyExport: ModuleExport, metaExports?: ModuleExports) => StoryId;
+    resolveOf<TType extends ResolvedModuleExportType>(moduleExportOrType: ModuleExport | TType, validTypes?: TType[]): ResolvedModuleExportFromType<TType, TRenderer>;
     /**
      * Find a story's id from the name of the story.
      * This is primarily used by the `<Story name={} /> block.
@@ -2580,6 +2606,10 @@ interface DocsContextProps<TRenderer extends Renderer = Renderer> {
      * Storybook channel -- use for low level event watching/emitting
      */
     channel: Channel$1;
+    /**
+     * Project annotations -- can be read to get the project's global annotations
+     */
+    projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
 }
 type DocsRenderFunction<TRenderer extends Renderer> = (docsContext: DocsContextProps<TRenderer>, docsParameters: Parameters, element: HTMLElement, callback: () => void) => void;
 
@@ -2613,4 +2643,4 @@ interface ComposeStoryFn<TRenderer extends Renderer = Renderer, TArgs extends Ar
     };
 }
 
-export { API_ActiveTabsType, API_Addon, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_Layout, API_LeafEntry, API_MatchOptions, API_Notification, API_OptionsData, API_PanelPositions, API_Panels, API_PreparedStoryIndex, API_Provider, API_ProviderData, API_RefId, API_RefUrl, API_Refs, API_ReleaseNotes, API_RenderOptions, API_Root, API_RootEntry, API_RouteOptions, API_SetRefData, API_Settings, API_SidebarOptions, API_StateMerger, API_StoriesHash, API_Story, API_StoryEntry, API_StoryMapper, API_UI, API_UIOptions, API_UnknownEntries, API_Version, API_Versions$1 as API_Versions, API_ViewMode, Addon_AddStoryArgs, Addon_Annotations, Addon_ArgType, Addon_ArgsStoryFn, Addon_BaseAnnotations, Addon_BaseDecorators, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_Elements, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_WrapperSettings, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseIndexEntry, BaseStory, BoundStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSFFile, ComponentAnnotations, ComponentId, ComponentTitle, ComposeStoryFn, ComposedStory, ComposedStoryPlayContext, ComposedStoryPlayFn, Conditional, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsContextProps, DocsIndexEntry, DocsOptions, DocsRenderFunction, Entry, GlobalTypes, Globals, IncludeExcludeOptions, IndexEntry, IndexEntryLegacy, IndexedCSFFile, IndexedStory, IndexerOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, LoadedPreset, LoaderFunction, ModuleExport, ModuleExports, ModuleImportFn, NormalizedComponentAnnotations, NormalizedProjectAnnotations, NormalizedStoriesSpecifier, NormalizedStoryAnnotations, Options, PackageJson, Parameters, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, PreparedStory, PreparedStoryFn, Preset, PresetConfig, PresetProperty, PresetPropertyFn, PresetValue, Presets, PreviewAnnotation, ProjectAnnotations, Ref, ReleaseNotesData, RenderContext, RenderToCanvas, Renderer, RendererName, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, SetGlobalsPayload, SetStoriesPayload, SetStoriesStory, SetStoriesStoryData, StandaloneDocsIndexEntry, Stats, StepFunction, StepLabel, StepRunner, Store_CSFExports, StoriesEntry, StoriesWithPartialProps, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryIndexEntry, StoryIndexV3, StoryIndexer, StoryKind, StoryName, StoryRenderOptions, StorybookConfig, StorybookConfigOptions, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag, TeardownRenderToCanvas, TemplateDocsIndexEntry, TypescriptOptions, V2CompatIndexEntry, VersionCheck, ViewMode, WebRenderer };
+export { API_ActiveTabsType, API_Addon, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexHash, API_Layout, API_LeafEntry, API_LoadedRefData, API_MatchOptions, API_Notification, API_OptionsData, API_PanelPositions, API_Panels, API_PreparedStoryIndex, API_Provider, API_ProviderData, API_RefId, API_RefUrl, API_Refs, API_ReleaseNotes, API_RenderOptions, API_Root, API_RootEntry, API_RouteOptions, API_SetRefData, API_Settings, API_SidebarOptions, API_StateMerger, API_Story, API_StoryEntry, API_StoryMapper, API_UI, API_UIOptions, API_UnknownEntries, API_Version, API_Versions$1 as API_Versions, API_ViewMode, Addon_AddStoryArgs, Addon_Annotations, Addon_ArgType, Addon_ArgsStoryFn, Addon_BaseAnnotations, Addon_BaseDecorators, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_Elements, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_OptionsParameterV7, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_WrapperSettings, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseIndexEntry, BaseStory, BoundStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSFFile, ComponentAnnotations, ComponentId, ComponentTitle, ComposeStoryFn, ComposedStory, ComposedStoryPlayContext, ComposedStoryPlayFn, Conditional, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsContextProps, DocsIndexEntry, DocsOptions, DocsRenderFunction, Entry, GlobalTypes, Globals, IncludeExcludeOptions, IndexEntry, IndexEntryLegacy, IndexedCSFFile, IndexedStory, IndexerOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, LoadedPreset, LoaderFunction, ModuleExport, ModuleExports, ModuleImportFn, NormalizedComponentAnnotations, NormalizedProjectAnnotations, NormalizedStoriesSpecifier, NormalizedStoryAnnotations, Options, PackageJson, Parameters, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, PreparedMeta, PreparedStory, PreparedStoryFn, Preset, PresetConfig, PresetProperty, PresetPropertyFn, PresetValue, Presets, PreviewAnnotation, ProjectAnnotations, Ref, ReleaseNotesData, RenderContext, RenderToCanvas, Renderer, RendererName, ResolvedModuleExport, ResolvedModuleExportFromType, ResolvedModuleExportType, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, SetGlobalsPayload, SetStoriesPayload, SetStoriesStory, SetStoriesStoryData, Stats, StepFunction, StepLabel, StepRunner, Store_CSFExports, StoriesEntry, StoriesWithPartialProps, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryIndexEntry, StoryIndexV3, StoryIndexer, StoryKind, StoryName, StoryRenderOptions, StorybookConfig, StorybookConfigOptions, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag, TeardownRenderToCanvas, TypescriptOptions, V2CompatIndexEntry, VersionCheck, ViewMode, WebRenderer };

package/dist/index.js

@@ -1 +1 @@
-var d=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var A=Object.getOwnPropertyNames;var s=Object.prototype.hasOwnProperty;var i=(e,r)=>{for(var n in r)d(e,n,{get:r[n],enumerable:!0})},S=(e,r,n,y)=>{if(r&&typeof r=="object"||typeof r=="function")for(let o of A(r))!s.call(e,o)&&o!==n&&d(e,o,{get:()=>r[o],enumerable:!(y=p(r,o))||y.enumerable});return e};var F=e=>S(d({},"__esModule",{value:!0}),e);var T={};i(T,{Addon_TypesEnum:()=>a});module.exports=F(T);var a=(t=>(t.TAB="tab",t.PANEL="panel",t.TOOL="tool",t.TOOLEXTRA="toolextra",t.PREVIEW="preview",t.NOTES_ELEMENT="notes-element",t))(a||{});0&&(module.exports={Addon_TypesEnum});
+var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __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};var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};__export(src_exports,{Addon_TypesEnum:()=>Addon_TypesEnum});module.exports=__toCommonJS(src_exports);var Addon_TypesEnum=(Addon_TypesEnum2=>(Addon_TypesEnum2.TAB="tab",Addon_TypesEnum2.PANEL="panel",Addon_TypesEnum2.TOOL="tool",Addon_TypesEnum2.TOOLEXTRA="toolextra",Addon_TypesEnum2.PREVIEW="preview",Addon_TypesEnum2.NOTES_ELEMENT="notes-element",Addon_TypesEnum2))(Addon_TypesEnum||{});0&&(module.exports={Addon_TypesEnum});

package/jest.config.js

@@ -0,0 +1,7 @@
+const path = require('path');
+const baseConfig = require('../../jest.config.node');
+
+module.exports = {
+  ...baseConfig,
+  displayName: __dirname.split(path.sep).slice(-2).join(path.posix.sep),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/types",
-  "version": "7.0.0-beta.3",
+  "version": "7.0.0-beta.31",
   "description": "Core Storybook Types",
   "keywords": [
     "storybook"
@@ -22,6 +22,7 @@
   "sideEffects": false,
   "exports": {
     ".": {
+      "node": "./dist/index.js",
       "require": "./dist/index.js",
       "import": "./dist/index.mjs",
       "types": "./dist/index.d.ts"
@@ -33,7 +34,9 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist/**/*",
-    "README.md"
+    "README.md",
+    "*.js",
+    "*.d.ts"
   ],
   "scripts": {
     "check": "../../../scripts/node_modules/.bin/tsc --noEmit",
@@ -41,7 +44,7 @@
   },
   "dependencies": {
     "@babel/core": "^7.12.10",
-    "@storybook/channels": "7.0.0-beta.3",
+    "@storybook/channels": "7.0.0-beta.31",
     "@types/babel__core": "^7.0.0",
     "@types/express": "^4.7.0",
     "express": "^4.17.3",
@@ -60,5 +63,5 @@
       "./src/index.ts"
     ]
   },
-  "gitHead": "9a57b4788c8b2817db516d799057d8295b187880"
+  "gitHead": "6d1ea7647fce605b2029077cbd02f655cafe1807"
 }