@storybook/preview-api 8.0.0-alpha.9 → 8.0.0-beta.0

package/dist/index.d.ts

@@ -1,32 +1,16 @@
 import { Channel } from '@storybook/channels';
 import * as _storybook_types from '@storybook/types';
-import { Renderer, Args, StoryContext, StoryId, DecoratorApplicator, Addon_StoryWrapper, StoryIndex, IndexEntry, Path, StoryName, ComponentTitle, PreparedStory, Globals, GlobalTypes, LegacyStoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, ProjectAnnotations, StepRunner, 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 { 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, 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';
 
 declare class AddonStore {
     constructor();
     private channel;
-    /**
-     * @deprecated will be removed in 8.0, please use channel instead
-     */
-    private serverChannel;
     private promise;
     private resolve;
     getChannel: () => Channel;
-    /**
-     * @deprecated will be removed in 8.0, please use getChannel instead
-     */
-    getServerChannel: () => Channel;
     ready: () => Promise<Channel>;
     hasChannel: () => boolean;
-    /**
-     * @deprecated will be removed in 8.0, please use the normal channel instead
-     */
-    hasServerChannel: () => boolean;
     setChannel: (channel: Channel) => void;
-    /**
-     * @deprecated will be removed in 8.0, please use the normal channel instead
-     */
-    setServerChannel: (channel: Channel) => void;
 }
 declare const addons: AddonStore;
 
@@ -352,24 +336,18 @@ declare function composeStory<TRenderer extends Renderer = Renderer, TArgs exten
 declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations<Renderer>, composeStoryFn: ComposeStoryFn): {};
 
 declare class StoryStore<TRenderer extends Renderer> {
-    storyIndex?: StoryIndexStore;
-    importFn?: ModuleImportFn;
-    projectAnnotations?: NormalizedProjectAnnotations<TRenderer>;
-    globals?: GlobalsStore;
+    importFn: ModuleImportFn;
+    storyIndex: StoryIndexStore;
+    projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
+    globals: GlobalsStore;
     args: ArgsStore;
     hooks: Record<StoryId, HooksContext<TRenderer>>;
     cachedCSFFiles?: Record<Path, CSFFile<TRenderer>>;
     processCSFFileWithCache: typeof processCSFFile;
     prepareMetaWithCache: typeof prepareMeta;
     prepareStoryWithCache: typeof prepareStory;
-    initializationPromise: Promise<void>;
-    resolveInitializationPromise: () => void;
-    constructor();
+    constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations<TRenderer>);
     setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
-    initialize({ storyIndex, importFn, }: {
-        storyIndex?: StoryIndex;
-        importFn: ModuleImportFn;
-    }): void;
     onStoriesChanged({ importFn, storyIndex, }: {
         importFn?: ModuleImportFn;
         storyIndex?: StoryIndex;
@@ -527,6 +505,7 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
     resolveOf<TType extends ResolvedModuleExportType>(moduleExportOrType: ModuleExport | TType, validTypes?: TType[]): ResolvedModuleExportFromType<TType, TRenderer>;
     storyIdByName: (storyName: StoryName) => string;
     componentStories: () => PreparedStory<TRenderer>[];
+    componentStoriesFromCSFFile: (csfFile: CSFFile<TRenderer>) => PreparedStory<TRenderer>[];
     storyById: (storyId?: StoryId) => PreparedStory<TRenderer>;
     getStoryContext: (story: PreparedStory<TRenderer>) => StoryContextForLoaders<TRenderer, _storybook_types.Args>;
     loadStory: (id: StoryId) => Promise<PreparedStory<TRenderer>>;
@@ -611,30 +590,32 @@ declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRende
 
 type MaybePromise<T> = Promise<T> | T;
 declare class Preview<TRenderer extends Renderer> {
+    importFn: ModuleImportFn;
+    getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     protected channel: Channel;
     /**
      * @deprecated will be removed in 8.0, please use channel instead
      */
     serverChannel?: Channel;
-    storyStore: StoryStore<TRenderer>;
-    getStoryIndex?: () => StoryIndex;
-    importFn?: ModuleImportFn;
+    protected storyStoreValue?: StoryStore<TRenderer>;
     renderToCanvas?: RenderToCanvas<TRenderer>;
     storyRenders: StoryRender<TRenderer>[];
     previewEntryError?: Error;
-    constructor(channel?: Channel);
-    initialize({ getStoryIndex, importFn, getProjectAnnotations, }: {
-        getStoryIndex?: () => StoryIndex;
-        importFn: ModuleImportFn;
-        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
-    }): Promise<void>;
+    private projectAnnotationsBeforeInitialization?;
+    protected storeInitializationPromise: Promise<void>;
+    protected resolveStoreInitializationPromise: () => void;
+    protected rejectStoreInitializationPromise: (err: Error) => void;
+    constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, channel?: Channel, shouldInitialize?: boolean);
+    get storyStore(): {};
+    protected initialize(): Promise<void>;
+    ready(): Promise<void>;
     setupListeners(): void;
-    getProjectAnnotationsOrRenderError(getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>): Promise<ProjectAnnotations<TRenderer>>;
+    getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations<TRenderer>>;
     initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
+    getStoryIndexFromServer(): Promise<StoryIndex>;
+    protected initializeWithStoryIndex(storyIndex: StoryIndex): void;
     setInitialGlobals(): Promise<void>;
     emitGlobals(): void;
-    getStoryIndexFromServer(): Promise<StoryIndex>;
-    initializeWithStoryIndex(storyIndex: StoryIndex): void;
     onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
         getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     }): Promise<void>;
@@ -662,6 +643,12 @@ declare class Preview<TRenderer extends Renderer> {
     teardownRender(render: StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>, { viewModeChanged }?: {
         viewModeChanged?: boolean;
     }): Promise<void>;
+    loadStory({ storyId }: {
+        storyId: StoryId;
+    }): Promise<PreparedStory<TRenderer>>;
+    getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
+        forceInitialArgs?: boolean | undefined;
+    }): Omit<_storybook_types.StoryContextForLoaders<Renderer, Args>, "viewMode">;
     extract(options?: {
         includeDocsOnly: boolean;
     }): Promise<Record<string, _storybook_types.StoryContextForEnhancers<TRenderer, Args>>>;
@@ -705,19 +692,21 @@ interface View<TStorybookRoot> {
     showStoryDuringRender(): void;
 }
 
-type PossibleRender<TFramework extends Renderer> = StoryRender<TFramework> | CsfDocsRender<TFramework> | MdxDocsRender<TFramework>;
-declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<TFramework> {
+type PossibleRender<TRenderer extends Renderer> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
+declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<TRenderer> {
+    importFn: ModuleImportFn;
+    getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     selectionStore: SelectionStore;
-    view: View<TFramework['canvasElement']>;
+    view: View<TRenderer['canvasElement']>;
     currentSelection?: Selection;
-    currentRender?: PossibleRender<TFramework>;
-    constructor(selectionStore: SelectionStore, view: View<TFramework['canvasElement']>);
+    currentRender?: PossibleRender<TRenderer>;
+    constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
     setupListeners(): void;
     setInitialGlobals(): Promise<void>;
     initializeWithStoryIndex(storyIndex: StoryIndex): Promise<void>;
     selectSpecifiedStory(): Promise<void>;
     onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
-        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>;
+        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     }): Promise<void>;
     onStoriesChanged({ importFn, storyIndex, }: {
         importFn?: ModuleImportFn;
@@ -739,15 +728,12 @@ declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<
     onPreloadStories({ ids }: {
         ids: string[];
     }): Promise<void>;
-    renderSelection({ persistedArgs }?: {
+    protected renderSelection({ persistedArgs }?: {
         persistedArgs?: Args;
     }): Promise<void>;
-    teardownRender(render: PossibleRender<TFramework>, { viewModeChanged }?: {
+    teardownRender(render: PossibleRender<TRenderer>, { viewModeChanged }?: {
         viewModeChanged?: boolean;
     }): Promise<void>;
-    extract(options?: {
-        includeDocsOnly: boolean;
-    }): Promise<Record<string, _storybook_types.StoryContextForEnhancers<TFramework, Args>>>;
     mainStoryCallbacks(storyId: StoryId): {
         showMain: () => void;
         showError: (err: {
@@ -766,11 +752,13 @@ declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<
     }): void;
 }
 
-declare class PreviewWeb<TFramework extends Renderer> extends PreviewWithSelection<TFramework> {
-    constructor();
+declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
+    importFn: ModuleImportFn;
+    getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
+    constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
 }
 
 declare function simulateDOMContentLoaded(): void;
 declare function simulatePageLoad($container: any): void;
 
-export { DocsContext, HooksContext, Preview, PreviewWeb, PropDescriptor, StoryStore, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, decorateStory, defaultDecorateStory, filterArgTypes, inferControls, makeDecorator, mockChannel, normalizeStory, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, useArgs, useCallback, useChannel, useEffect, useGlobals, useMemo, useParameter, useReducer, useRef, useState, useStoryContext, userOrAutoTitle, userOrAutoTitleFromSpecifier };
+export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, PropDescriptor, StoryStore, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, decorateStory, defaultDecorateStory, filterArgTypes, inferControls, makeDecorator, mockChannel, normalizeStory, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, useArgs, useCallback, useChannel, useEffect, useGlobals, useMemo, useParameter, useReducer, useRef, useState, useStoryContext, userOrAutoTitle, userOrAutoTitleFromSpecifier };