storybook 9.1.0-alpha.0 → 9.1.0-alpha.10

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

@@ -1,6 +1,6 @@
 import { Channel } from 'storybook/internal/channels';
 import * as storybook_internal_types from 'storybook/internal/types';
-import { ProjectAnnotations, Renderer, Args, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, StoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, LegacyStoryAnnotationsOrFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, StoryContextForEnhancers, Parameters, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas, ViewMode } from 'storybook/internal/types';
+import { Args, Renderer, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, StoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, ProjectAnnotations, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, LegacyStoryAnnotationsOrFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, StoryContextForEnhancers, Parameters, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas, ViewMode } from 'storybook/internal/types';
 import { CleanupCallback, StoryContext as StoryContext$1, Args as Args$1 } from 'storybook/internal/csf';
 import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
 
@@ -16,8 +16,6 @@ declare class AddonStore {
 }
 declare const addons: AddonStore;
 
-declare function definePreview(config: ProjectAnnotations<Renderer>): ProjectAnnotations<Renderer>;
-
 interface Hook {
     name: string;
     memoizedState?: any;
@@ -360,6 +358,8 @@ declare function prepareMeta<TRenderer extends Renderer>(componentAnnotations: N
 
 declare function normalizeProjectAnnotations<TRenderer extends Renderer>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, afterEach, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
 
+declare const normalizeArrays: <T>(array: T[] | T | undefined) => T[];
+
 declare function composeConfigs<TRenderer extends Renderer>(moduleExportList: ModuleExports[]): NormalizedProjectAnnotations<TRenderer>;
 
 /**
@@ -397,7 +397,10 @@ declare function setProjectAnnotations<TRenderer extends Renderer = Renderer>(pr
 declare function composeStory<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(storyAnnotations: LegacyStoryAnnotationsOrFn<TRenderer>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>, defaultConfig?: ProjectAnnotations<TRenderer>, exportsName?: string): ComposedStoryFn<TRenderer, Partial<TArgs>>;
 declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations<Renderer>, composeStoryFn?: ComposeStoryFn): {};
 type WrappedStoryRef = {
-    __pw_type: 'jsx' | 'importRef';
+    __pw_type: 'jsx';
+    props: Record<string, any>;
+} | {
+    __pw_type: 'importRef';
 };
 type UnwrappedJSXStoryRef = {
     __pw_type: 'jsx';
@@ -412,8 +415,8 @@ declare function createPlaywrightTest<TFixture extends {
 }>(baseTest: TFixture): TFixture;
 
 declare function getCsfFactoryAnnotations<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>): {
-    story: storybook_internal_types.StoryAnnotations<Renderer, Args>;
-    meta: ComponentAnnotations<Renderer, Args>;
+    story: storybook_internal_types.StoryAnnotations<Renderer, unknown>;
+    meta: ComponentAnnotations<Renderer, unknown>;
     preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer>;
 } | {
     story: LegacyStoryAnnotationsOrFn<TRenderer>;
@@ -736,7 +739,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
     type: RenderType;
     story?: PreparedStory<TRenderer>;
     phase?: RenderPhase;
-    private abortController?;
+    private abortController;
     private canvasElement?;
     private notYetRendered;
     private rerenderEnqueued;
@@ -767,6 +770,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
     rerender(): Promise<void>;
     remount(): Promise<void>;
     cancelRender(): void;
+    cancelPlayFunction(): void;
     teardown(): Promise<void>;
 }
 
@@ -821,6 +825,7 @@ declare class Preview<TRenderer extends Renderer> {
     onForceRemount({ storyId }: {
         storyId: StoryId;
     }): Promise<void>;
+    onStoryHotUpdated(): Promise<void>;
     renderStoryToElement(story: PreparedStory<TRenderer>, element: TRenderer['canvasElement'], callbacks: RenderContextCallbacks<TRenderer>, options: StoryRenderOptions): () => Promise<void>;
     teardownRender(render: StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>, { viewModeChanged }?: {
         viewModeChanged?: boolean;
@@ -1040,6 +1045,4 @@ declare function emitTransformCode(source: string | undefined, context: ReducedS
 declare function pauseAnimations(atEnd?: boolean): CleanupCallback;
 declare function waitForAnimations(signal?: AbortSignal): Promise<void>;
 
-declare function getCoreAnnotations(): any[];
-
-export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, definePreview, emitTransformCode, filterArgTypes, getCoreAnnotations, getCsfFactoryAnnotations, inferControls, makeDecorator, mockChannel, normalizeProjectAnnotations, normalizeStory, pauseAnimations, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setDefaultProjectAnnotations, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, useArgs, useCallback, useChannel, useEffect, useGlobals, useMemo, useParameter, useReducer, useRef, useState, useStoryContext, userOrAutoTitle, userOrAutoTitleFromSpecifier, waitForAnimations };
+export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, emitTransformCode, filterArgTypes, getCsfFactoryAnnotations, inferControls, makeDecorator, mockChannel, normalizeArrays, normalizeProjectAnnotations, normalizeStory, pauseAnimations, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setDefaultProjectAnnotations, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, useArgs, useCallback, useChannel, useEffect, useGlobals, useMemo, useParameter, useReducer, useRef, useState, useStoryContext, userOrAutoTitle, userOrAutoTitleFromSpecifier, waitForAnimations };