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

package/dist/index.d.ts

@@ -1,35 +1,16 @@
 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, ComponentAnnotations, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, ModuleImportFn, StoryContextForLoaders, StoryContextForEnhancers, Parameters, StoryIndexV3, API_PreparedStoryIndex, BoundStory, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, StoryRenderOptions, ViewMode, RenderToCanvas, RenderContextCallbacks, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, ComponentId, LoaderFunction, ArgTypes, ArgsEnhancer, ArgsStoryFn } from '@storybook/types';
-import { SynchronousPromise } from 'synchronous-promise';
-import * as qs$1 from 'qs';
-import qs__default from 'qs';
+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;
 
@@ -355,25 +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: SynchronousPromise<void>;
-    resolveInitializationPromise: () => void;
-    constructor();
+    constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations<TRenderer>);
     setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
-    initialize({ storyIndex, importFn, cache, }: {
-        storyIndex?: StoryIndex;
-        importFn: ModuleImportFn;
-        cache?: boolean;
-    }): Promise<void>;
     onStoriesChanged({ importFn, storyIndex, }: {
         importFn?: ModuleImportFn;
         storyIndex?: StoryIndex;
@@ -416,7 +390,6 @@ declare class StoryStore<TRenderer extends Renderer> {
         stories: Record<string, StoryContextForEnhancers<TRenderer, _storybook_types.Args>>;
     };
     getStoriesJsonData: () => StoryIndexV3;
-    getSetIndexPayload(): API_PreparedStoryIndex;
     raw(): BoundStory<TRenderer>[];
     fromId(storyId: StoryId): BoundStory<TRenderer> | null;
 }
@@ -532,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>>;
@@ -616,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): PromiseLike<void>;
     onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
         getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     }): Promise<void>;
@@ -667,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>>>;
@@ -710,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): PromiseLike<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;
@@ -744,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: {
@@ -771,172 +752,13 @@ declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<
     }): void;
 }
 
-declare class PreviewWeb<TFramework extends Renderer> extends PreviewWithSelection<TFramework> {
-    constructor();
-}
-
-declare class UrlStore implements SelectionStore {
-    selectionSpecifier: SelectionSpecifier | null;
-    selection?: Selection;
-    constructor();
-    setSelection(selection: Selection): void;
-    setQueryParams(queryParams: qs__default.ParsedQs): void;
-}
-
-declare enum Mode {
-    'MAIN' = "MAIN",
-    'NOPREVIEW' = "NOPREVIEW",
-    'PREPARING_STORY' = "PREPARING_STORY",
-    'PREPARING_DOCS' = "PREPARING_DOCS",
-    'ERROR' = "ERROR"
-}
-declare const layoutClassMap: {
-    readonly centered: "sb-main-centered";
-    readonly fullscreen: "sb-main-fullscreen";
-    readonly padded: "sb-main-padded";
-};
-type Layout = keyof typeof layoutClassMap | 'none';
-declare class WebView implements View<HTMLElement> {
-    private currentLayoutClass?;
-    private testing;
-    private preparingTimeout?;
-    constructor();
-    prepareForStory(story: PreparedStory<any>): HTMLElement;
-    storyRoot(): HTMLElement;
-    prepareForDocs(): HTMLElement;
-    docsRoot(): HTMLElement;
-    applyLayout(layout?: Layout): void;
-    checkIfLayoutExists(layout: keyof typeof layoutClassMap): void;
-    showMode(mode: Mode): void;
-    showErrorDisplay({ message, stack }: {
-        message?: string | undefined;
-        stack?: string | undefined;
-    }): void;
-    showNoPreview(): void;
-    showPreparingStory({ immediate }?: {
-        immediate?: boolean | undefined;
-    }): void;
-    showPreparingDocs({ immediate }?: {
-        immediate?: boolean | undefined;
-    }): void;
-    showMain(): void;
-    showDocs(): void;
-    showStory(): void;
-    showStoryDuringRender(): void;
+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;
 
-declare class StoryStoreFacade<TRenderer extends Renderer> {
-    projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
-    entries: Record<StoryId, IndexEntry & {
-        componentId?: ComponentId;
-    }>;
-    csfExports: Record<Path, ModuleExports>;
-    constructor();
-    importFn(path: Path): Promise<ModuleExports>;
-    getStoryIndex(store: StoryStore<TRenderer>): {
-        v: number;
-        entries: Record<string, IndexEntry>;
-    };
-    clearFilenameExports(fileName: Path): void;
-    addStoriesFromExports(fileName: Path, fileExports: ModuleExports): void;
-}
-
-declare const addDecorator: (decorator: DecoratorFunction<Renderer>) => void;
-declare const addParameters: (parameters: Parameters) => void;
-declare const addLoader: (loader: LoaderFunction<Renderer>) => void;
-declare const addArgs: (args: Args) => void;
-declare const addArgTypes: (argTypes: ArgTypes) => void;
-declare const addArgsEnhancer: (enhancer: ArgsEnhancer<Renderer>) => void;
-declare const addArgTypesEnhancer: (enhancer: ArgTypesEnhancer<Renderer>) => void;
-declare const addStepRunner: (stepRunner: StepRunner) => void;
-declare const setGlobalRender: (render: StoryStoreFacade<any>['projectAnnotations']['render']) => void;
-declare class ClientApi<TRenderer extends Renderer> {
-    facade: StoryStoreFacade<TRenderer>;
-    storyStore?: StoryStore<TRenderer>;
-    onImportFnChanged?: ({ importFn }: {
-        importFn: ModuleImportFn;
-    }) => void;
-    constructor({ storyStore }?: {
-        storyStore?: StoryStore<TRenderer>;
-    });
-    importFn(path: Path): Promise<ModuleExports>;
-    getStoryIndex(): {
-        v: number;
-        entries: Record<string, _storybook_types.IndexEntry>;
-    };
-    addDecorator: (decorator: DecoratorFunction<TRenderer>) => void;
-    addParameters: ({ globals, globalTypes, ...parameters }: Parameters & {
-        globals?: Globals | undefined;
-        globalTypes?: GlobalTypes | undefined;
-    }) => void;
-    addStepRunner: (stepRunner: StepRunner<TRenderer>) => void;
-    addLoader: (loader: LoaderFunction<TRenderer>) => void;
-    addArgs: (args: Args) => void;
-    addArgTypes: (argTypes: ArgTypes) => void;
-    addArgsEnhancer: (enhancer: ArgsEnhancer<TRenderer>) => void;
-    addArgTypesEnhancer: (enhancer: ArgTypesEnhancer<TRenderer>) => void;
-    _addedExports: Record<string, ModuleExports>;
-    _loadAddedExports(): void;
-    raw: () => _storybook_types.BoundStory<TRenderer>[] | undefined;
-    get _storyStore(): StoryStore<TRenderer> | undefined;
-}
-
-declare const getQueryParams: () => qs$1.ParsedQs;
-declare const getQueryParam: (key: string) => string | string[] | qs$1.ParsedQs | qs$1.ParsedQs[] | undefined;
-
-interface CoreClient_RendererImplementation<TRenderer extends Renderer> {
-    /**
-     * A function that applies decorators to a story.
-     * @template TRenderer The type of renderer used by the Storybook client API.
-     * @type {ProjectAnnotations<TRenderer>['applyDecorators']}
-     */
-    decorateStory?: ProjectAnnotations<TRenderer>['applyDecorators'];
-    /**
-     * A function that renders a story with args.
-     * @template TRenderer The type of renderer used by the Storybook client API.
-     * @type {ArgsStoryFn<TRenderer>}
-     */
-    render?: ArgsStoryFn<TRenderer>;
-}
-interface CoreClient_ClientAPIFacade {
-    /**
-     * The old way of retrieving the list of stories at runtime.
-     * @deprecated This method is deprecated and will be removed in a future version.
-     */
-    raw: (...args: any[]) => never;
-}
-interface CoreClient_StartReturnValue<TRenderer extends Renderer> {
-    /**
-     * Forces a re-render of all stories in the Storybook preview.
-     * This function emits the `FORCE_RE_RENDER` event to the Storybook channel.
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * @returns {void}
-     */
-    forceReRender: () => void;
-    /**
-     * The old way of setting up storybook with runtime configuration.
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * @returns {void}
-     */
-    configure: any;
-    /**
-     * @deprecated This property is deprecated and will be removed in a future version.
-     * @type {ClientApi<TRenderer> | CoreClient_ClientAPIFacade}
-     */
-    clientApi: ClientApi<TRenderer> | CoreClient_ClientAPIFacade;
-}
-/**
- * Initializes the Storybook preview API.
- * @template TRenderer The type of renderer used by the Storybook client API.
- * @param {ProjectAnnotations<TRenderer>['renderToCanvas']} renderToCanvas A function that renders a story to a canvas.
- * @param {CoreClient_RendererImplementation<TRenderer>} [options] Optional configuration options for the renderer implementation.
- * @param {ProjectAnnotations<TRenderer>['applyDecorators']} [options.decorateStory] A function that applies decorators to a story.
- * @param {ArgsStoryFn<TRenderer>} [options.render] A function that renders a story with arguments.
- * @returns {CoreClient_StartReturnValue<TRenderer>} An object containing functions and objects related to the Storybook preview API.
- */
-declare function start<TRenderer extends Renderer>(renderToCanvas: ProjectAnnotations<TRenderer>['renderToCanvas'], { decorateStory, render }?: CoreClient_RendererImplementation<TRenderer>): CoreClient_StartReturnValue<TRenderer>;
-
-export { ClientApi, DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, PropDescriptor, SelectionStore, StoryStore, UrlStore, View, WebView, addArgTypes, addArgTypesEnhancer, addArgs, addArgsEnhancer, addDecorator, addLoader, addParameters, addStepRunner, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, decorateStory, defaultDecorateStory, filterArgTypes, getQueryParam, getQueryParams, inferControls, makeDecorator, mockChannel, normalizeStory, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setGlobalRender, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, start, 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 };