@storybook/preview-api 7.0.0-beta.8 → 7.0.0-rc.0

package/dist/preview-web.mjs

@@ -1 +1 @@
-import{DocsContext,Preview,PreviewWeb,PreviewWithSelection,simulateDOMContentLoaded,simulatePageLoad}from"./chunk-Z6DHZWDG.mjs";import{composeConfigs}from"./chunk-7WHOLHII.mjs";import"./chunk-QSH26RWA.mjs";export{DocsContext,Preview,PreviewWeb,PreviewWithSelection,composeConfigs,simulateDOMContentLoaded,simulatePageLoad};
+import{DocsContext,Preview,PreviewWeb,PreviewWithSelection,simulateDOMContentLoaded,simulatePageLoad}from"./chunk-R4BJAWK4.mjs";import{composeConfigs}from"./chunk-U6GFELHZ.mjs";import"./chunk-RTGEOU4B.mjs";export{DocsContext,Preview,PreviewWeb,PreviewWithSelection,composeConfigs,simulateDOMContentLoaded,simulatePageLoad};

package/dist/{DocsContext-b4bac20d.d.ts → simulate-pageload-7048af7a.d.ts}

@@ -1,7 +1,7 @@
 import * as _storybook_types from '@storybook/types';
-import { Renderer, StoryId, StoryRenderOptions, ViewMode, PreparedStory, RenderToCanvas, RenderContext, IndexEntry, DocsContextProps, StoryIndex, ModuleImportFn, ProjectAnnotations, Globals, Args, CSFFile, ModuleExports, ModuleExport, StoryName, StoryContextForLoaders } from '@storybook/types';
+import { Renderer, StoryId, StoryRenderOptions, ViewMode, PreparedStory, RenderToCanvas, RenderContextCallbacks, DocsContextProps, CSFFile, ModuleExports, ResolvedModuleExportType, ModuleExport, ResolvedModuleExportFromType, StoryName, StoryContextForLoaders, IndexEntry, StoryIndex, ModuleImportFn, ProjectAnnotations, Globals, Args } from '@storybook/types';
 import { Channel } from '@storybook/channels';
-import { S as StoryStore, a as StorySpecifier } from './StoryStore-e35dc2c4.js';
+import { S as StoryStore, b as StorySpecifier } from './StoryStore-8dcb90f9.js';
 
 type RenderType = 'story' | 'docs';
 /**
@@ -25,7 +25,6 @@ interface Render<TRenderer extends Renderer> {
 }
 
 type RenderPhase = 'preparing' | 'loading' | 'rendering' | 'playing' | 'played' | 'completed' | 'aborted' | 'errored';
-type RenderContextCallbacks<TRenderer extends Renderer> = Pick<RenderContext<TRenderer>, 'showMain' | 'showError' | 'showException'>;
 declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
     channel: Channel;
     store: StoryStore<TRenderer>;
@@ -61,22 +60,51 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
     teardown(): Promise<void>;
 }
 
+declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
+    channel: Channel;
+    protected store: StoryStore<TRenderer>;
+    renderStoryToElement: DocsContextProps['renderStoryToElement'];
+    private componentStoriesValue;
+    private storyIdToCSFFile;
+    private exportToStory;
+    private exportsToCSFFile;
+    private nameToStoryId;
+    private attachedCSFFile?;
+    private primaryStory?;
+    constructor(channel: Channel, store: StoryStore<TRenderer>, renderStoryToElement: DocsContextProps['renderStoryToElement'], 
+    /** The CSF files known (via the index) to be refererenced by this docs file */
+    csfFiles: CSFFile<TRenderer>[]);
+    referenceCSFFile(csfFile: CSFFile<TRenderer>): void;
+    attachCSFFile(csfFile: CSFFile<TRenderer>): void;
+    referenceMeta(metaExports: ModuleExports, attach: boolean): void;
+    get projectAnnotations(): _storybook_types.NormalizedProjectAnnotations<TRenderer>;
+    private resolveAttachedModuleExportType;
+    private resolveModuleExport;
+    resolveOf<TType extends ResolvedModuleExportType>(moduleExportOrType: ModuleExport | TType, validTypes?: TType[]): ResolvedModuleExportFromType<TType, TRenderer>;
+    storyIdByName: (storyName: StoryName) => string;
+    componentStories: () => PreparedStory<TRenderer>[];
+    storyById: (storyId?: StoryId) => PreparedStory<TRenderer>;
+    getStoryContext: (story: PreparedStory<TRenderer>) => StoryContextForLoaders<TRenderer, _storybook_types.Args>;
+    loadStory: (id: StoryId) => Promise<PreparedStory<TRenderer>>;
+}
+
 /**
- * A TemplateDocsRender is a render of a docs entry that is rendered with (an) attached CSF file(s).
+ * A CsfDocsRender is a render of a docs entry that is rendered based on a CSF file.
  *
  * The expectation is the primary CSF file which is the `importPath` for the entry will
  * define a story which may contain the actual rendered JSX code for the template in the
  * `docs.page` parameter.
  *
  * Use cases:
- *  - Docs Page, where there is no parameter, and we fall back to the globally defined template.
+ *  - Autodocs, where there is no story, and we fall back to the globally defined template.
  *  - *.stories.mdx files, where the MDX compiler produces a CSF file with a `.parameter.docs.page`
  *      parameter containing the compiled content of the MDX file.
  */
-declare class TemplateDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
+declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
     protected channel: Channel;
     protected store: StoryStore<TRenderer>;
     entry: IndexEntry;
+    private callbacks;
     readonly type: RenderType;
     readonly id: StoryId;
     story?: PreparedStory<TRenderer>;
@@ -88,10 +116,11 @@ declare class TemplateDocsRender<TRenderer extends Renderer> implements Render<T
     readonly disableKeyListeners = false;
     preparing: boolean;
     private csfFiles?;
-    constructor(channel: Channel, store: StoryStore<TRenderer>, entry: IndexEntry);
+    constructor(channel: Channel, store: StoryStore<TRenderer>, entry: IndexEntry, callbacks: RenderContextCallbacks<TRenderer>);
     isPreparing(): boolean;
     prepare(): Promise<void>;
     isEqual(other: Render<TRenderer>): boolean;
+    docsContext(renderStoryToElement: DocsContextProps['renderStoryToElement']): DocsContext<TRenderer>;
     renderToElement(canvasElement: TRenderer['canvasElement'], renderStoryToElement: DocsContextProps['renderStoryToElement']): Promise<void>;
     teardown({ viewModeChanged }?: {
         viewModeChanged?: boolean;
@@ -99,17 +128,19 @@ declare class TemplateDocsRender<TRenderer extends Renderer> implements Render<T
 }
 
 /**
- * A StandaloneDocsRender is a render of a docs entry that doesn't directly come from a CSF file.
+ * A MdxDocsRender is a render of a docs entry that comes from a true MDX file,
+ * that is a `.mdx` file that doesn't get compiled to a CSF file.
  *
- * A standalone render can reference zero or more CSF files that contain stories.
+ * A MDX render can reference (import) zero or more CSF files that contain stories.
  *
  * Use cases:
  *  - *.mdx file that may or may not reference a specific CSF file with `<Meta of={} />`
  */
-declare class StandaloneDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
+declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
     protected channel: Channel;
     protected store: StoryStore<TRenderer>;
     entry: IndexEntry;
+    private callbacks;
     readonly type: RenderType;
     readonly id: StoryId;
     private exports?;
@@ -121,10 +152,11 @@ declare class StandaloneDocsRender<TRenderer extends Renderer> implements Render
     readonly disableKeyListeners = false;
     preparing: boolean;
     private csfFiles?;
-    constructor(channel: Channel, store: StoryStore<TRenderer>, entry: IndexEntry);
+    constructor(channel: Channel, store: StoryStore<TRenderer>, entry: IndexEntry, callbacks: RenderContextCallbacks<TRenderer>);
     isPreparing(): boolean;
     prepare(): Promise<void>;
     isEqual(other: Render<TRenderer>): boolean;
+    docsContext(renderStoryToElement: DocsContextProps['renderStoryToElement']): DocsContext<TRenderer>;
     renderToElement(canvasElement: TRenderer['canvasElement'], renderStoryToElement: DocsContextProps['renderStoryToElement']): Promise<void>;
     teardown({ viewModeChanged }?: {
         viewModeChanged?: boolean;
@@ -132,30 +164,30 @@ declare class StandaloneDocsRender<TRenderer extends Renderer> implements Render
 }
 
 type MaybePromise<T> = Promise<T> | T;
-declare class Preview<TFramework extends Renderer> {
+declare class Preview<TRenderer extends Renderer> {
     protected channel: Channel;
     serverChannel?: Channel;
-    storyStore: StoryStore<TFramework>;
+    storyStore: StoryStore<TRenderer>;
     getStoryIndex?: () => StoryIndex;
     importFn?: ModuleImportFn;
-    renderToCanvas?: RenderToCanvas<TFramework>;
-    storyRenders: StoryRender<TFramework>[];
+    renderToCanvas?: RenderToCanvas<TRenderer>;
+    storyRenders: StoryRender<TRenderer>[];
     previewEntryError?: Error;
     constructor(channel?: Channel);
     initialize({ getStoryIndex, importFn, getProjectAnnotations, }: {
         getStoryIndex?: () => StoryIndex;
         importFn: ModuleImportFn;
-        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>;
+        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     }): Promise<void>;
     setupListeners(): void;
-    getProjectAnnotationsOrRenderError(getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>): Promise<ProjectAnnotations<TFramework>>;
-    initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TFramework>): Promise<void>;
+    getProjectAnnotationsOrRenderError(getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>): Promise<ProjectAnnotations<TRenderer>>;
+    initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
     setInitialGlobals(): Promise<void>;
     emitGlobals(): void;
     getStoryIndexFromServer(): Promise<StoryIndex>;
     initializeWithStoryIndex(storyIndex: StoryIndex): PromiseLike<void>;
     onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
-        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>;
+        getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
     }): Promise<void>;
     onStoryIndexChanged(): Promise<void>;
     onStoriesChanged({ importFn, storyIndex, }: {
@@ -177,21 +209,13 @@ declare class Preview<TFramework extends Renderer> {
     onForceRemount({ storyId }: {
         storyId: StoryId;
     }): Promise<void>;
-    renderStoryToElement(story: PreparedStory<TFramework>, element: TFramework['canvasElement'], options: StoryRenderOptions): () => Promise<void>;
-    teardownRender(render: StoryRender<TFramework> | TemplateDocsRender<TFramework> | StandaloneDocsRender<TFramework>, { viewModeChanged }?: {
+    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;
     }): Promise<void>;
     extract(options?: {
         includeDocsOnly: boolean;
-    }): Promise<Record<string, _storybook_types.StoryContextForEnhancers<TFramework, Args>>>;
-    inlineStoryCallbacks(storyId: StoryId): {
-        showMain: () => void;
-        showError: (err: {
-            title: string;
-            description: string;
-        }) => void;
-        showException: (err: Error) => void;
-    };
+    }): Promise<Record<string, _storybook_types.StoryContextForEnhancers<TRenderer, Args>>>;
     renderPreviewEntryError(reason: string, err: Error): void;
 }
 
@@ -220,17 +244,19 @@ interface View<TStorybookRoot> {
         stack?: string;
     }): void;
     showNoPreview(): void;
-    showPreparingStory(options: {
+    showPreparingStory(options?: {
+        immediate: boolean;
+    }): void;
+    showPreparingDocs(options?: {
         immediate: boolean;
     }): void;
-    showPreparingDocs(): void;
     showMain(): void;
     showDocs(): void;
     showStory(): void;
     showStoryDuringRender(): void;
 }
 
-type PossibleRender<TFramework extends Renderer> = StoryRender<TFramework> | TemplateDocsRender<TFramework> | StandaloneDocsRender<TFramework>;
+type PossibleRender<TFramework extends Renderer> = StoryRender<TFramework> | CsfDocsRender<TFramework> | MdxDocsRender<TFramework>;
 declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<TFramework> {
     selectionStore: SelectionStore;
     view: View<TFramework['canvasElement']>;
@@ -282,14 +308,6 @@ declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<
         }) => void;
         showException: (err: Error) => void;
     };
-    inlineStoryCallbacks(storyId: StoryId): {
-        showMain: () => void;
-        showError: (err: {
-            title: string;
-            description: string;
-        }) => void;
-        showException: (err: Error) => void;
-    };
     renderPreviewEntryError(reason: string, err: Error): void;
     renderMissingStory(): void;
     renderStoryLoadingException(storySpecifier: StorySpecifier, err: Error): void;
@@ -307,26 +325,4 @@ declare class PreviewWeb<TFramework extends Renderer> extends PreviewWithSelecti
 declare function simulateDOMContentLoaded(): void;
 declare function simulatePageLoad($container: any): void;
 
-declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
-    channel: Channel;
-    protected store: StoryStore<TRenderer>;
-    renderStoryToElement: DocsContextProps['renderStoryToElement'];
-    private componentStoriesValue;
-    private storyIdToCSFFile;
-    private exportToStoryId;
-    private nameToStoryId;
-    private primaryStory?;
-    constructor(channel: Channel, store: StoryStore<TRenderer>, renderStoryToElement: DocsContextProps['renderStoryToElement'], 
-    /** The CSF files known (via the index) to be refererenced by this docs file */
-    csfFiles: CSFFile<TRenderer>[], componentStoriesFromAllCsfFiles?: boolean);
-    referenceCSFFile(csfFile: CSFFile<TRenderer>, addToComponentStories: boolean): void;
-    setMeta(metaExports: ModuleExports): void;
-    storyIdByModuleExport(storyExport: ModuleExport, metaExports?: ModuleExports): string;
-    storyIdByName: (storyName: StoryName) => string;
-    componentStories: () => PreparedStory<TRenderer>[];
-    storyById: (storyId?: StoryId) => PreparedStory<TRenderer>;
-    getStoryContext: (story: PreparedStory<TRenderer>) => StoryContextForLoaders<TRenderer, _storybook_types.Args>;
-    loadStory: (id: StoryId) => Promise<PreparedStory<TRenderer>>;
-}
-
 export { DocsContext as D, Preview as P, simulateDOMContentLoaded as a, PreviewWeb as b, PreviewWithSelection as c, simulatePageLoad as s };

package/dist/{sortStories-a93f5af2.d.ts → sortStories-bcf0764a.d.ts}

@@ -62,7 +62,7 @@ declare const combineArgs: (value: any, update: any) => Args;
 declare const validateOptions: (args: Args, argTypes: ArgTypes) => Args;
 declare const DEEPLY_EQUAL: unique symbol;
 declare const deepDiff: (value: any, update: any) => any;
-declare const NO_TARGET_NAME = "";
+declare const UNTARGETED = "UNTARGETED";
 declare function groupArgsByTarget<TArgs extends Args = Args>({ args, argTypes, }: StoryContext<Renderer, TArgs>): Record<string, Partial<TArgs>>;
 declare function noTargetArgs<TArgs extends Args = Args>(context: StoryContext<Renderer, TArgs>): Partial<TArgs>;
 
@@ -72,4 +72,4 @@ declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStor
 declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
 declare const sortStoriesV6: (stories: [string, PreparedStory, Parameters, Parameters][], storySortParameter: Addon_StorySortParameter, fileNameOrder: Path[]) => IndexEntry[];
 
-export { DEEPLY_EQUAL as D, NO_TARGET_NAME as N, PropDescriptor as P, combineParameters as a, composeStepRunners as b, combineArgs as c, composeStories as d, composeStory as e, decorateStory as f, defaultDecorateStory as g, filterArgTypes as h, setProjectAnnotations as i, inferControls as j, sortStoriesV7 as k, deepDiff as l, mapArgsToTypes as m, normalizeStory as n, groupArgsByTarget as o, noTargetArgs as p, userOrAutoTitle as q, sortStoriesV6 as r, sanitizeStoryContextUpdate as s, userOrAutoTitleFromSpecifier as u, validateOptions as v };
+export { DEEPLY_EQUAL as D, PropDescriptor as P, UNTARGETED as U, combineParameters as a, composeStepRunners as b, combineArgs as c, composeStories as d, composeStory as e, decorateStory as f, defaultDecorateStory as g, filterArgTypes as h, setProjectAnnotations as i, inferControls as j, userOrAutoTitle as k, sortStoriesV7 as l, mapArgsToTypes as m, normalizeStory as n, deepDiff as o, groupArgsByTarget as p, noTargetArgs as q, sortStoriesV6 as r, sanitizeStoryContextUpdate as s, userOrAutoTitleFromSpecifier as u, validateOptions as v };

package/dist/{start-e15b4487.d.ts → start-62db31b6.d.ts}

@@ -1,5 +1,5 @@
 import { Renderer, ProjectAnnotations, ArgsStoryFn } from '@storybook/types';
-import { C as ClientApi } from './ClientApi-c264b450.js';
+import { C as ClientApi } from './ClientApi-4bc526c1.js';
 
 interface CoreClient_RendererImplementation<TRenderer extends Renderer> {
     decorateStory?: ProjectAnnotations<TRenderer>['applyDecorators'];

package/dist/store.d.ts

@@ -1,7 +1,7 @@
-export { S as StoryStore, p as prepareStory, b as processCSFFile } from './StoryStore-e35dc2c4.js';
-export { D as DEEPLY_EQUAL, N as NO_TARGET_NAME, P as PropDescriptor, c as combineArgs, a as combineParameters, b as composeStepRunners, d as composeStories, e as composeStory, f as decorateStory, l as deepDiff, g as defaultDecorateStory, h as filterArgTypes, o as groupArgsByTarget, j as inferControls, m as mapArgsToTypes, p as noTargetArgs, n as normalizeStory, s as sanitizeStoryContextUpdate, i as setProjectAnnotations, r as sortStoriesV6, k as sortStoriesV7, q as userOrAutoTitle, u as userOrAutoTitleFromSpecifier, v as validateOptions } from './sortStories-a93f5af2.js';
+export { S as StoryStore, a as prepareMeta, p as prepareStory, c as processCSFFile } from './StoryStore-8dcb90f9.js';
+export { D as DEEPLY_EQUAL, P as PropDescriptor, U as UNTARGETED, c as combineArgs, a as combineParameters, b as composeStepRunners, d as composeStories, e as composeStory, f as decorateStory, o as deepDiff, g as defaultDecorateStory, h as filterArgTypes, p as groupArgsByTarget, j as inferControls, m as mapArgsToTypes, q as noTargetArgs, n as normalizeStory, s as sanitizeStoryContextUpdate, i as setProjectAnnotations, r as sortStoriesV6, l as sortStoriesV7, k as userOrAutoTitle, u as userOrAutoTitleFromSpecifier, v as validateOptions } from './sortStories-bcf0764a.js';
 export { g as getValuesFromArgTypes, b as normalizeComponentAnnotations, n as normalizeInputType, a as normalizeInputTypes, c as normalizeProjectAnnotations, d as useAddonState, u as useSharedState } from './hooks-0a0ec0e3.js';
-export { c as composeConfigs, a as getArrayField, g as getField, b as getObjectField, d as getSingletonField } from './composeConfigs-7f62ebf7.js';
-export { H as HooksContext, k as applyHooks, u as useArgs, a as useCallback, b as useChannel, c as useEffect, d as useGlobals, e as useMemo, f as useParameter, g as useReducer, h as useRef, i as useState, j as useStoryContext } from './hooks-dd6bc7a8.js';
+export { c as composeConfigs, a as getArrayField, g as getField, b as getObjectField, d as getSingletonField } from './composeConfigs-62a04721.js';
+export { H as HooksContext, k as applyHooks, u as useArgs, a as useCallback, b as useChannel, c as useEffect, d as useGlobals, e as useMemo, f as useParameter, g as useReducer, h as useRef, i as useState, j as useStoryContext } from './hooks-55c56a89.js';
 import '@storybook/types';
 import 'synchronous-promise';