@storybook/types 7.0.0-alpha.53 → 7.0.0-alpha.54

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { FileSystemCache } from 'file-system-cache';
 import { TransformOptions } from '@babel/core';
 import { Router } from 'express';
 import { Server } from 'http';
+import { Channel as Channel$1 } from '@storybook/channels';
 
 /**
 Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
@@ -1360,6 +1361,17 @@ interface Location extends Path$1 {
      * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.key
      */
     key: Key;
+}
+/**
+ * Describes a location that is the destination of some navigation, either via
+ * `history.push` or `history.replace`. May be either a URL or the pieces of a
+ * URL path.
+ */
+declare type To = string | Partial<Path$1>;
+
+interface NavigateOptions$1 {
+    replace?: boolean;
+    state?: any;
 }
 
 interface StoryData {
@@ -1372,12 +1384,15 @@ interface Other extends StoryData {
     path: string;
     singleStory?: boolean;
 }
+type NavigateOptions = NavigateOptions$1 & {
+    plain?: boolean;
+};
+type NavigateFunction = (to: To | number, options?: NavigateOptions) => void;
 type RouterData = {
     location: Partial<Location>;
-    navigate: ReturnType<typeof useNavigate>;
+    navigate: NavigateFunction;
 } & Other;
 type RenderData = Pick<RouterData, 'location'> & Other;
-declare const useNavigate: () => (to: string | number, { plain, ...options }?: any) => void;
 
 interface ThemeVars {
     base: 'light' | 'dark';
@@ -2867,4 +2882,52 @@ type API_Refs = Record<string, API_ComposedRef>;
 type API_RefId = string;
 type API_RefUrl = string;
 
-export { API_ActiveTabsType, API_Addon, API_ArgType, API_ArgTypes, API_Args, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_DocsIndexEntry, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexEntry, 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_SetGlobalsPayload, API_SetRefData, API_SetStoriesPayload, API_SetStoriesStory, API_SetStoriesStoryData, API_Settings, API_SidebarOptions, API_StateMerger, API_StoriesHash, API_Story, API_StoryEntry, API_StoryIndex, API_StoryIndexEntry, API_StoryIndexV3, API_StoryKey, 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_BaseIndexEntry, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_DocsIndexEntry, Addon_Elements, Addon_IndexEntry, Addon_IndexEntryLegacy, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_StandaloneDocsIndexEntry, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StoryIndexEntry, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_TemplateDocsIndexEntry, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_WrapperSettings, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSF_Meta, CSF_Story, ClientAPI_AddStoryArgs, ClientAPI_ArgTypesEnhancer, ClientAPI_ArgsEnhancer, ClientAPI_ClientApiAddon, ClientAPI_ClientApiAddons, ClientAPI_ClientApiReturnFn, ClientAPI_ErrorLike, ClientAPI_GetStorybookKind, ClientAPI_GetStorybookStory, ClientAPI_RenderContextWithoutStoryContext, ClientAPI_StoreSelection, ClientAPI_StoreSelectionSpecifier, ClientAPI_StoryMetadata, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, CoreClient_LoaderFunction, CoreClient_PreviewError, CoreClient_RenderStoryFunction, CoreClient_RequireContext, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_IndexedStory, CoreCommon_IndexerOptions, CoreCommon_NormalizedStoriesSpecifier, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StoriesEntry, CoreCommon_StoryIndex, CoreCommon_StoryIndexer, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsOptions, Entry, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, Loadable, LoadedPreset, LoaderFunction, Options, PackageJson, Parameters, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, Preset, PresetConfig, PresetProperty, PresetPropertyFn, Presets, PreviewAnnotation, ProjectAnnotations, Ref, ReleaseNotesData, Store_RenderContext as RenderContext, RenderToCanvas, Renderer, RendererName, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, Stats, StepFunction, StepLabel, StepRunner, Store_BoundStory, Store_CSFExports, Store_CSFFile, Store_ComposeStory, Store_ComposedStory, Store_ComposedStoryPlayContext, Store_ComposedStoryPlayFn, Store_ContextStore, Store_ControlsMatchers, Store_DecoratorApplicator, Store_ExtractOptions, Store_ModuleExport, Store_ModuleExports, Store_ModuleImportFn, Store_NormalizedComponentAnnotations, Store_NormalizedProjectAnnotations, Store_NormalizedStoriesSpecifier, Store_NormalizedStoriesSpecifierEntry, Store_NormalizedStoryAnnotations, Store_PromiseLike, Store_PropDescriptor, Store_RenderContext, Store_Selection, Store_SelectionSpecifier, Store_StoriesSpecifier, Store_StoriesWithPartialProps, Store_Story, Store_StoryFn, Store_StoryIndex, Store_StoryIndexV3, Store_StorySpecifier, Store_V2CompatIndexEntry, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryKind, StoryName, StorybookConfig, StorybookConfigOptions, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag, TeardownRenderToCanvas, TypescriptOptions, VersionCheck, ViewMode, WebRenderer };
+type StoryRenderOptions = {
+    autoplay?: boolean;
+};
+interface DocsContextProps<TRenderer extends Renderer = Renderer> {
+    /**
+     * Register the CSF file that this docs entry represents.
+     * Used by the `<Meta of={} />` block.
+     */
+    setMeta: (metaExports: Store_ModuleExports) => void;
+    /**
+     * Find a story's id from the direct export from the CSF file.
+     * This is primarily used by the `<Story of={} /> block.
+     */
+    storyIdByModuleExport: (storyExport: Store_ModuleExport, metaExports?: Store_ModuleExports) => StoryId;
+    /**
+     * Find a story's id from the name of the story.
+     * This is primarily used by the `<Story name={} /> block.
+     * Note that the story must be part of the primary CSF file of the docs entry.
+     */
+    storyIdByName: (storyName: StoryName) => StoryId;
+    /**
+     * Syncronously find a story by id (if the id is not provided, this will look up the primary
+     * story in the CSF file, if such a file exists).
+     */
+    storyById: (id?: StoryId) => Store_Story<TRenderer>;
+    /**
+     * Syncronously find all stories of the component referenced by the CSF file.
+     */
+    componentStories: () => Store_Story<TRenderer>[];
+    /**
+     * Get the story context of the referenced story.
+     */
+    getStoryContext: (story: Store_Story<TRenderer>) => StoryContextForLoaders<TRenderer>;
+    /**
+     * Asyncronously load an arbitrary story by id.
+     */
+    loadStory: (id: StoryId) => Promise<Store_Story<TRenderer>>;
+    /**
+     * Render a story to a given HTML element and keep it up to date across context changes
+     */
+    renderStoryToElement: (story: Store_Story<TRenderer>, element: HTMLElement, options: StoryRenderOptions) => () => Promise<void>;
+    /**
+     * Storybook channel -- use for low level event watching/emitting
+     */
+    channel: Channel$1;
+}
+type DocsRenderFunction<TRenderer extends Renderer> = (docsContext: DocsContextProps<TRenderer>, docsParameters: Parameters, element: HTMLElement, callback: () => void) => void;
+
+export { API_ActiveTabsType, API_Addon, API_ArgType, API_ArgTypes, API_Args, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_DocsIndexEntry, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexEntry, 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_SetGlobalsPayload, API_SetRefData, API_SetStoriesPayload, API_SetStoriesStory, API_SetStoriesStoryData, API_Settings, API_SidebarOptions, API_StateMerger, API_StoriesHash, API_Story, API_StoryEntry, API_StoryIndex, API_StoryIndexEntry, API_StoryIndexV3, API_StoryKey, 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_BaseIndexEntry, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_DocsIndexEntry, Addon_Elements, Addon_IndexEntry, Addon_IndexEntryLegacy, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_StandaloneDocsIndexEntry, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StoryIndexEntry, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_TemplateDocsIndexEntry, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_WrapperSettings, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSF_Meta, CSF_Story, ClientAPI_AddStoryArgs, ClientAPI_ArgTypesEnhancer, ClientAPI_ArgsEnhancer, ClientAPI_ClientApiAddon, ClientAPI_ClientApiAddons, ClientAPI_ClientApiReturnFn, ClientAPI_ErrorLike, ClientAPI_GetStorybookKind, ClientAPI_GetStorybookStory, ClientAPI_RenderContextWithoutStoryContext, ClientAPI_StoreSelection, ClientAPI_StoreSelectionSpecifier, ClientAPI_StoryMetadata, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, CoreClient_LoaderFunction, CoreClient_PreviewError, CoreClient_RenderStoryFunction, CoreClient_RequireContext, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_IndexedStory, CoreCommon_IndexerOptions, CoreCommon_NormalizedStoriesSpecifier, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StoriesEntry, CoreCommon_StoryIndex, CoreCommon_StoryIndexer, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsContextProps, DocsOptions, DocsRenderFunction, Entry, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, Loadable, LoadedPreset, LoaderFunction, Options, PackageJson, Parameters, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, Preset, PresetConfig, PresetProperty, PresetPropertyFn, Presets, PreviewAnnotation, ProjectAnnotations, Ref, ReleaseNotesData, Store_RenderContext as RenderContext, RenderToCanvas, Renderer, RendererName, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, Stats, StepFunction, StepLabel, StepRunner, Store_BoundStory, Store_CSFExports, Store_CSFFile, Store_ComposeStory, Store_ComposedStory, Store_ComposedStoryPlayContext, Store_ComposedStoryPlayFn, Store_ContextStore, Store_ControlsMatchers, Store_DecoratorApplicator, Store_ExtractOptions, Store_ModuleExport, Store_ModuleExports, Store_ModuleImportFn, Store_NormalizedComponentAnnotations, Store_NormalizedProjectAnnotations, Store_NormalizedStoriesSpecifier, Store_NormalizedStoriesSpecifierEntry, Store_NormalizedStoryAnnotations, Store_PromiseLike, Store_PropDescriptor, Store_RenderContext, Store_Selection, Store_SelectionSpecifier, Store_StoriesSpecifier, Store_StoriesWithPartialProps, Store_Story, Store_StoryFn, Store_StoryIndex, Store_StoryIndexV3, Store_StorySpecifier, Store_V2CompatIndexEntry, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryKind, StoryName, StoryRenderOptions, StorybookConfig, StorybookConfigOptions, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag, TeardownRenderToCanvas, TypescriptOptions, VersionCheck, ViewMode, WebRenderer };

package/dist/index.mjs

@@ -1 +1 @@
-var r=(e=>(e.TAB="tab",e.PANEL="panel",e.TOOL="tool",e.TOOLEXTRA="toolextra",e.PREVIEW="preview",e.NOTES_ELEMENT="notes-element",e))(r||{});export{r as Addon_TypesEnum};
+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||{});export{Addon_TypesEnum};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/types",
-  "version": "7.0.0-alpha.53",
+  "version": "7.0.0-alpha.54",
   "description": "Core Storybook Types",
   "keywords": [
     "storybook"
@@ -40,8 +40,9 @@
     "prep": "../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@babel/core": "^7.20.2",
-    "@types/babel__core": "^7.1.20",
+    "@babel/core": "^7.12.10",
+    "@storybook/channels": "7.0.0-alpha.54",
+    "@types/babel__core": "^7.0.0",
     "@types/express": "^4.7.0",
     "express": "^4.17.1",
     "file-system-cache": "^2.0.0"
@@ -60,5 +61,5 @@
       "./src/index.ts"
     ]
   },
-  "gitHead": "fd1cf81615a5ddac3369e7bb567a1a43081fdc23"
+  "gitHead": "91177d4e27daec556a24ae6223c3cbe17a998d9b"
 }