@storybook/preview-api 8.1.0-alpha.6 → 8.1.0-alpha.8

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { Channel } from '@storybook/channels';
 import * as _storybook_types from '@storybook/types';
 import { Renderer, Args, StoryContext, StoryId, DecoratorApplicator, Addon_StoryWrapper, StoryName, ComponentTitle, StoryIndex, IndexEntry, Path, PreparedStory, Globals, GlobalTypes, LegacyStoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, ProjectAnnotations, StepRunner, NamedOrDefaultProjectAnnotations, ComponentAnnotations, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, ModuleImportFn, StoryContextForLoaders, StoryContextForEnhancers, Parameters, StoryIndexV3, BoundStory, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, StoryRenderOptions, ViewMode, RenderToCanvas, RenderContextCallbacks, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType } from '@storybook/types';
+import { CleanupCallback } from '@storybook/csf';
+import { RequestData, ArgTypesRequestPayload } from '@storybook/core-events';
 import qs$1 from 'qs';
 
 declare class AddonStore {
@@ -315,7 +317,7 @@ declare function composeConfigs<TRenderer extends Renderer>(moduleExportList: Mo
 /**
  * Compose step runners to create a single step runner that applies each step runner in order.
  *
- * A step runner is a a function that takes a defined step: `step('label', () => { ... })`
+ * A step runner is a function that takes a defined step: `step('label', () => { ... })`
  * and runs it. The prototypical example is from `@storybook/addon-interactions` where the
  * step runner will decorate all instrumented code inside the step with information about the
  * label.
@@ -357,6 +359,7 @@ declare class StoryStore<TRenderer extends Renderer> {
     globals: GlobalsStore;
     args: ArgsStore;
     hooks: Record<StoryId, HooksContext<TRenderer>>;
+    cleanupCallbacks: Record<StoryId, CleanupCallback[] | undefined>;
     cachedCSFFiles?: Record<Path, CSFFile<TRenderer>>;
     processCSFFileWithCache: typeof processCSFFile;
     prepareMetaWithCache: typeof prepareMeta;
@@ -391,7 +394,8 @@ declare class StoryStore<TRenderer extends Renderer> {
     getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
         forceInitialArgs?: boolean | undefined;
     }): Omit<StoryContextForLoaders, 'viewMode'>;
-    cleanupStory(story: PreparedStory<TRenderer>): void;
+    addCleanupCallbacks(story: PreparedStory<TRenderer>, callbacks: CleanupCallback[]): void;
+    cleanupStory(story: PreparedStory<TRenderer>): Promise<void>;
     extract(options?: {
         includeDocsOnly?: boolean;
     }): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
@@ -459,7 +463,7 @@ interface Render<TRenderer extends Renderer> {
     renderToElement: (canvasElement: TRenderer['canvasElement'], renderStoryToElement?: any, options?: StoryRenderOptions) => Promise<void>;
 }
 
-type RenderPhase = 'preparing' | 'loading' | 'rendering' | 'playing' | 'played' | 'completed' | 'aborted' | 'errored';
+type RenderPhase = 'preparing' | 'loading' | 'beforeEach' | 'rendering' | 'playing' | 'played' | 'completed' | 'aborted' | 'errored';
 declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
     channel: Channel;
     store: StoryStore<TRenderer>;
@@ -474,6 +478,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
     private abortController?;
     private canvasElement?;
     private notYetRendered;
+    private rerenderEnqueued;
     disableKeyListeners: boolean;
     private teardownRender;
     torndown: boolean;
@@ -489,6 +494,13 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
         initial?: boolean;
         forceRemount?: boolean;
     }): Promise<void>;
+    /**
+     * Rerender the story.
+     * If the story is currently pending (loading/rendering), the rerender will be enqueued,
+     * and will be executed after the current render is completed.
+     * Rerendering while playing will not be enqueued, and will be executed immediately, to support
+     * rendering args changes while playing.
+     */
     rerender(): Promise<void>;
     remount(): Promise<void>;
     cancelRender(): void;
@@ -644,6 +656,7 @@ declare class Preview<TRenderer extends Renderer> {
         storyId: StoryId;
         updatedArgs: Args;
     }): Promise<void>;
+    onRequestArgTypesInfo({ id, payload }: RequestData<ArgTypesRequestPayload>): Promise<void>;
     onResetArgs({ storyId, argNames }: {
         storyId: string;
         argNames?: string[];