storybook 9.0.0-alpha.6 → 9.0.0-alpha.7

package/dist/preview-api/index.d.ts

@@ -1,6 +1,7 @@
 import { Channel } from 'storybook/internal/channels';
 import * as storybook_internal_types from 'storybook/internal/types';
 import { ProjectAnnotations as ProjectAnnotations$1, Renderer as Renderer$1, Args, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, LegacyStoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations as NormalizedProjectAnnotations$1, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, Parameters, StoryContextForEnhancers, StoryIndexV3, BoundStory, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas as RenderToCanvas$1, ViewMode } from 'storybook/internal/types';
+import * as storybook_internal_csf from 'storybook/internal/csf';
 import { CleanupCallback, Canvas, Renderer as Renderer$2, ProjectAnnotations as ProjectAnnotations$2, StoryIdentifier, StoryContext as StoryContext$1, PartialStoryFn as PartialStoryFn$1, LegacyStoryFn as LegacyStoryFn$1, StrictArgTypes as StrictArgTypes$1, StrictGlobalTypes, DecoratorFunction as DecoratorFunction$1, LoaderFunction, StepRunner as StepRunner$1, BeforeAll } from 'storybook/internal/csf';
 import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
 
@@ -412,7 +413,7 @@ declare function createPlaywrightTest<TFixture extends {
 }>(baseTest: TFixture): TFixture;
 
 declare function getCsfFactoryAnnotations<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations$1<TRenderer>): {
-    story: storybook_internal_types.StoryAnnotations<Renderer$1, Args>;
+    story: storybook_internal_csf.StoryAnnotations<Renderer$1, Args>;
     meta: ComponentAnnotations<Renderer$1, Args>;
     preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer$1>;
 } | {
@@ -474,10 +475,10 @@ declare class StoryStore<TRenderer extends Renderer$1> {
     getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
         forceInitialArgs?: boolean | undefined;
     }): {
-        args: storybook_internal_types.Args;
-        initialGlobals: storybook_internal_types.Globals;
-        globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
-        userGlobals: storybook_internal_types.Globals;
+        args: storybook_internal_csf.Args;
+        initialGlobals: storybook_internal_csf.Globals;
+        globalTypes: (storybook_internal_csf.GlobalTypes & storybook_internal_csf.StrictGlobalTypes) | undefined;
+        userGlobals: storybook_internal_csf.Globals;
         reporting: ReporterAPI;
         globals: {
             [x: string]: any;
@@ -490,30 +491,30 @@ declare class StoryStore<TRenderer extends Renderer$1> {
             T: any;
         })["component"]> | undefined;
         parameters: Parameters;
-        initialArgs: storybook_internal_types.Args;
-        argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
-        componentId: storybook_internal_types.ComponentId;
+        initialArgs: storybook_internal_csf.Args;
+        argTypes: storybook_internal_csf.StrictArgTypes<storybook_internal_csf.Args>;
+        componentId: storybook_internal_csf.ComponentId;
         title: ComponentTitle;
         kind: ComponentTitle;
         id: StoryId;
-        name: storybook_internal_types.StoryName;
-        story: storybook_internal_types.StoryName;
-        tags: storybook_internal_types.Tag[];
+        name: storybook_internal_csf.StoryName;
+        story: storybook_internal_csf.StoryName;
+        tags: storybook_internal_csf.Tag[];
         moduleExport: storybook_internal_types.ModuleExport;
-        originalStoryFn: storybook_internal_types.StoryFn<TRenderer>;
-        undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
-        unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
-        applyLoaders: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
-        applyBeforeEach: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<CleanupCallback[]>;
-        applyAfterEach: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
-        playFunction?: ((context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
-        runStep: storybook_internal_types.StepRunner<TRenderer>;
-        mount: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<Canvas>;
+        originalStoryFn: storybook_internal_csf.StoryFn<TRenderer>;
+        undecoratedStoryFn: storybook_internal_csf.LegacyStoryFn<TRenderer>;
+        unboundStoryFn: storybook_internal_csf.LegacyStoryFn<TRenderer>;
+        applyLoaders: (context: StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<Record<string, any>>;
+        applyBeforeEach: (context: StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<CleanupCallback[]>;
+        applyAfterEach: (context: StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<void>;
+        playFunction?: ((context: StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<void> | void) | undefined;
+        runStep: storybook_internal_csf.StepRunner<TRenderer>;
+        mount: (context: StoryContext<TRenderer, storybook_internal_csf.Args>) => () => Promise<Canvas>;
         testingLibraryRender?: (...args: never[]) => unknown;
         renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
         usesMount: boolean;
-        storyGlobals: storybook_internal_types.Globals;
-    } & Pick<storybook_internal_types.StoryContextForLoaders<Renderer$1, storybook_internal_types.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
+        storyGlobals: storybook_internal_csf.Globals;
+    } & Pick<storybook_internal_csf.StoryContextForLoaders<Renderer$1, storybook_internal_csf.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
     addCleanupCallbacks(story: PreparedStory<TRenderer>, callbacks: CleanupCallback[]): void;
     cleanupStory(story: PreparedStory<TRenderer>): Promise<void>;
     extract(options?: {
@@ -521,10 +522,10 @@ declare class StoryStore<TRenderer extends Renderer$1> {
     }): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
     getSetStoriesPayload(): {
         v: number;
-        globals: storybook_internal_types.Globals;
+        globals: storybook_internal_csf.Globals;
         globalParameters: {};
         kindParameters: Parameters;
-        stories: Record<string, StoryContextForEnhancers<TRenderer, storybook_internal_types.Args>>;
+        stories: Record<string, StoryContextForEnhancers<TRenderer, storybook_internal_csf.Args>>;
     };
     getStoriesJsonData: () => StoryIndexV3;
     raw(): BoundStory<TRenderer>[];
@@ -539,7 +540,7 @@ declare class StoryStore<TRenderer extends Renderer$1> {
 declare const combineParameters: (...parameterSets: (Parameters | undefined)[]) => Parameters;
 
 type PropDescriptor = string[] | RegExp;
-declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_types.Args>>;
+declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_csf.Args>>;
 
 declare const inferControls: ArgTypesEnhancer<Renderer$1>;
 
@@ -589,10 +590,10 @@ declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextPr
     getStoryContext: (story: PreparedStory<TRenderer>) => {
         loaded: {};
         viewMode: string;
-        args: storybook_internal_types.Args;
-        initialGlobals: storybook_internal_types.Globals;
-        globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
-        userGlobals: storybook_internal_types.Globals;
+        args: storybook_internal_csf.Args;
+        initialGlobals: storybook_internal_csf.Globals;
+        globalTypes: (storybook_internal_csf.GlobalTypes & storybook_internal_csf.StrictGlobalTypes) | undefined;
+        userGlobals: storybook_internal_csf.Globals;
         reporting: ReporterAPI;
         globals: {
             [x: string]: any;
@@ -604,30 +605,30 @@ declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextPr
         subcomponents?: Record<string, (TRenderer & {
             T: any;
         })["component"]> | undefined;
-        parameters: storybook_internal_types.Parameters;
-        initialArgs: storybook_internal_types.Args;
-        argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
-        componentId: storybook_internal_types.ComponentId;
-        title: storybook_internal_types.ComponentTitle;
-        kind: storybook_internal_types.ComponentTitle;
+        parameters: storybook_internal_csf.Parameters;
+        initialArgs: storybook_internal_csf.Args;
+        argTypes: storybook_internal_csf.StrictArgTypes<storybook_internal_csf.Args>;
+        componentId: storybook_internal_csf.ComponentId;
+        title: storybook_internal_csf.ComponentTitle;
+        kind: storybook_internal_csf.ComponentTitle;
         id: StoryId;
         name: StoryName;
         story: StoryName;
-        tags: storybook_internal_types.Tag[];
+        tags: storybook_internal_csf.Tag[];
         moduleExport: ModuleExport;
-        originalStoryFn: storybook_internal_types.StoryFn<TRenderer>;
-        undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
-        unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
-        applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
-        applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<storybook_internal_types.CleanupCallback[]>;
-        applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
-        playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
-        runStep: storybook_internal_types.StepRunner<TRenderer>;
-        mount: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<storybook_internal_types.Canvas>;
+        originalStoryFn: storybook_internal_csf.StoryFn<TRenderer>;
+        undecoratedStoryFn: storybook_internal_csf.LegacyStoryFn<TRenderer>;
+        unboundStoryFn: storybook_internal_csf.LegacyStoryFn<TRenderer>;
+        applyLoaders: (context: storybook_internal_csf.StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<Record<string, any>>;
+        applyBeforeEach: (context: storybook_internal_csf.StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<storybook_internal_csf.CleanupCallback[]>;
+        applyAfterEach: (context: storybook_internal_csf.StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<void>;
+        playFunction?: ((context: storybook_internal_csf.StoryContext<TRenderer, storybook_internal_csf.Args>) => Promise<void> | void) | undefined;
+        runStep: storybook_internal_csf.StepRunner<TRenderer>;
+        mount: (context: storybook_internal_csf.StoryContext<TRenderer, storybook_internal_csf.Args>) => () => Promise<storybook_internal_csf.Canvas>;
         testingLibraryRender?: (...args: never[]) => unknown;
         renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
         usesMount: boolean;
-        storyGlobals: storybook_internal_types.Globals;
+        storyGlobals: storybook_internal_csf.Globals;
         allArgs: any;
         argsByTarget: any;
         unmappedArgs: any;
@@ -845,7 +846,7 @@ declare class Preview<TRenderer extends Renderer$1> {
     }): {
         args: Args;
         initialGlobals: Globals;
-        globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
+        globalTypes: (storybook_internal_csf.GlobalTypes & storybook_internal_csf.StrictGlobalTypes) | undefined;
         userGlobals: Globals;
         reporting: ReporterAPI;
         globals: {
@@ -858,34 +859,34 @@ declare class Preview<TRenderer extends Renderer$1> {
         subcomponents?: Record<string, (TRenderer & {
             T: any;
         })["component"]> | undefined;
-        parameters: storybook_internal_types.Parameters;
+        parameters: storybook_internal_csf.Parameters;
         initialArgs: Args;
-        argTypes: storybook_internal_types.StrictArgTypes<Args>;
-        componentId: storybook_internal_types.ComponentId;
-        title: storybook_internal_types.ComponentTitle;
-        kind: storybook_internal_types.ComponentTitle;
+        argTypes: storybook_internal_csf.StrictArgTypes<Args>;
+        componentId: storybook_internal_csf.ComponentId;
+        title: storybook_internal_csf.ComponentTitle;
+        kind: storybook_internal_csf.ComponentTitle;
         id: StoryId;
-        name: storybook_internal_types.StoryName;
-        story: storybook_internal_types.StoryName;
-        tags: storybook_internal_types.Tag[];
+        name: storybook_internal_csf.StoryName;
+        story: storybook_internal_csf.StoryName;
+        tags: storybook_internal_csf.Tag[];
         moduleExport: storybook_internal_types.ModuleExport;
-        originalStoryFn: storybook_internal_types.StoryFn<TRenderer>;
-        undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
-        unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
-        applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<Record<string, any>>;
-        applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<CleanupCallback[]>;
-        applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<void>;
-        playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<void> | void) | undefined;
-        runStep: storybook_internal_types.StepRunner<TRenderer>;
-        mount: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_types.Canvas>;
+        originalStoryFn: storybook_internal_csf.StoryFn<TRenderer>;
+        undecoratedStoryFn: storybook_internal_csf.LegacyStoryFn<TRenderer>;
+        unboundStoryFn: storybook_internal_csf.LegacyStoryFn<TRenderer>;
+        applyLoaders: (context: storybook_internal_csf.StoryContext<TRenderer, Args>) => Promise<Record<string, any>>;
+        applyBeforeEach: (context: storybook_internal_csf.StoryContext<TRenderer, Args>) => Promise<CleanupCallback[]>;
+        applyAfterEach: (context: storybook_internal_csf.StoryContext<TRenderer, Args>) => Promise<void>;
+        playFunction?: ((context: storybook_internal_csf.StoryContext<TRenderer, Args>) => Promise<void> | void) | undefined;
+        runStep: storybook_internal_csf.StepRunner<TRenderer>;
+        mount: (context: storybook_internal_csf.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_csf.Canvas>;
         testingLibraryRender?: (...args: never[]) => unknown;
         renderToCanvas?: RenderToCanvas$1<TRenderer> | undefined;
         usesMount: boolean;
         storyGlobals: Globals;
-    } & Pick<storybook_internal_types.StoryContextForLoaders<Renderer$1, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
+    } & Pick<storybook_internal_csf.StoryContextForLoaders<Renderer$1, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
     extract(options?: {
         includeDocsOnly: boolean;
-    }): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args>>>;
+    }): Promise<Record<string, storybook_internal_csf.StoryContextForEnhancers<TRenderer, Args>>>;
     renderPreviewEntryError(reason: string, err: Error): void;
 }