storybook 9.0.0-alpha.2 → 9.0.0-alpha.4

package/dist/types/index.d.ts

@@ -1,250 +1,12 @@
-import { StoryId, StoryName, ComponentTitle, Tag as Tag$1, Parameters, Args, ArgTypes, ComponentId, StoryKind, Globals, GlobalTypes, InputType, StoryContext, PartialStoryFn, LegacyStoryFn, ArgsStoryFn, StoryFn, DecoratorFunction, LoaderFunction, Renderer as Renderer$1, ViewMode as ViewMode$1, StoryIdentifier, ProjectAnnotations as ProjectAnnotations$2, StrictArgTypes, StrictGlobalTypes, StepRunner, BeforeAll, ComponentAnnotations, StoryAnnotations, StoryContextForEnhancers, CleanupCallback, Canvas, StoryAnnotationsOrFn, AnnotatedStoryFn } from 'storybook/internal/csf';
+import { StoryId, StoryName, ComponentTitle, Tag as Tag$1, Parameters, Args, ArgTypes, ComponentId, StoryKind, Globals, GlobalTypes, InputType, StoryContext, PartialStoryFn, LegacyStoryFn, ArgsStoryFn, StoryFn, DecoratorFunction, LoaderFunction, Renderer as Renderer$1, ViewMode as ViewMode$1, StoryIdentifier, ProjectAnnotations as ProjectAnnotations$1, StrictArgTypes, StrictGlobalTypes, StepRunner, BeforeAll, ComponentAnnotations, StoryAnnotations, StoryContextForEnhancers, CleanupCallback, Canvas, StoryAnnotationsOrFn, AnnotatedStoryFn } from 'storybook/internal/csf';
 export { AfterEach, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, ProjectAnnotations as BaseProjectAnnotations, BeforeAll, BeforeEach, Canvas, CleanupCallback, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, DecoratorApplicator, DecoratorFunction, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoaderFunction, Parameters, PartialStoryFn, PlayFunction, PlayFunctionContext, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, StepFunction, StepLabel, StepRunner, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryKind, StoryName, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag } from 'storybook/internal/csf';
 import { ReactElement, FC, ReactNode, PropsWithChildren } from 'react';
-import { Addon_TestProviderType as Addon_TestProviderType$1, NormalizedProjectAnnotations as NormalizedProjectAnnotations$1, ProjectAnnotations as ProjectAnnotations$1, ComposedStoryFn as ComposedStoryFn$1 } from 'storybook/internal/types';
+import { Addon_TestProviderType as Addon_TestProviderType$1, NormalizedProjectAnnotations as NormalizedProjectAnnotations$1, ProjectAnnotations as ProjectAnnotations$2, ComposedStoryFn as ComposedStoryFn$1 } from 'storybook/internal/types';
 import { FileSystemCache } from 'storybook/internal/common';
 import { Server, IncomingMessage, ServerResponse } from 'http';
 import { Server as Server$1 } from 'net';
 import { Channel as Channel$1 } from 'storybook/internal/channels';
 
-type DateNow = number;
-type TestProviderConfig = Addon_TestProviderType$1;
-type TestingModuleProgressReportProgress = {
-    startedAt: DateNow;
-    finishedAt?: DateNow;
-    numTotalTests?: number;
-    numPassedTests?: number;
-    numFailedTests?: number;
-    numPendingTests?: number;
-    percentageCompleted?: number;
-};
-
-declare global {
-    var globalProjectAnnotations: NormalizedProjectAnnotations$1<any>;
-    var defaultProjectAnnotations: ProjectAnnotations$1<any>;
-}
-type WrappedStoryRef = {
-    __pw_type: 'jsx' | 'importRef';
-};
-type UnwrappedJSXStoryRef = {
-    __pw_type: 'jsx';
-    type: UnwrappedImportStoryRef;
-};
-type UnwrappedImportStoryRef = ComposedStoryFn$1;
-declare global {
-    function __pwUnwrapObject(storyRef: WrappedStoryRef): Promise<UnwrappedJSXStoryRef | UnwrappedImportStoryRef>;
-}
-
-interface Report<T = unknown> {
-    type: string;
-    version?: number;
-    result: T;
-    status: 'failed' | 'passed' | 'warning';
-}
-declare class ReporterAPI {
-    reports: Report[];
-    addReport(report: Report): Promise<void>;
-}
-
-/**
- * A URL pathname, beginning with a /.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.pathname
- */
-declare type Pathname = string;
-/**
- * A URL search string, beginning with a ?.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.search
- */
-declare type Search = string;
-/**
- * A URL fragment identifier, beginning with a #.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.hash
- */
-declare type Hash = string;
-/**
- * A unique string associated with a location. May be used to safely store
- * and retrieve data in some other storage API, like `localStorage`.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.key
- */
-declare type Key = string;
-/**
- * The pathname, search, and hash values of a URL.
- */
-interface Path$1 {
-    /**
-     * A URL pathname, beginning with a /.
-     *
-     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.pathname
-     */
-    pathname: Pathname;
-    /**
-     * A URL search string, beginning with a ?.
-     *
-     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.search
-     */
-    search: Search;
-    /**
-     * A URL fragment identifier, beginning with a #.
-     *
-     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.hash
-     */
-    hash: Hash;
-}
-/**
- * An entry in a history stack. A location contains information about the
- * URL path, as well as possibly some arbitrary state and a key.
- *
- * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location
- */
-interface Location extends Path$1 {
-    /**
-     * A value of arbitrary data associated with this location.
-     *
-     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.state
-     */
-    state: unknown;
-    /**
-     * A unique string associated with this location. May be used to safely store
-     * and retrieve data in some other storage API, like `localStorage`.
-     *
-     * Note: This value is always "default" on the initial location.
-     *
-     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.key
-     */
-    key: Key;
-}
-/**
- * Describes a location that is the destination of some navigation, either via
- * `history.push` or `history.replace`. May be either a URL or the pieces of a
- * URL path.
- */
-declare type To = string | Partial<Path$1>;
-
-interface NavigateOptions$1 {
-    replace?: boolean;
-    state?: any;
-}
-
-interface StoryData {
-    viewMode?: string;
-    storyId?: string;
-    refId?: string;
-}
-
-interface Other extends StoryData {
-    path: string;
-    singleStory?: boolean;
-}
-type NavigateOptions = NavigateOptions$1 & {
-    plain?: boolean;
-};
-type NavigateFunction = (to: To | number, options?: NavigateOptions) => void;
-type RouterData = {
-    location: Partial<Location>;
-    navigate: NavigateFunction;
-} & Other;
-type RenderData = Pick<RouterData, 'location'> & Other;
-
-interface ThemeVars extends ThemeVarsBase, ThemeVarsColors {
-}
-interface ThemeVarsBase {
-    base: 'light' | 'dark';
-}
-interface ThemeVarsColors {
-    colorPrimary: string;
-    colorSecondary: string;
-    appBg: string;
-    appContentBg: string;
-    appPreviewBg: string;
-    appBorderColor: string;
-    appBorderRadius: number;
-    fontBase: string;
-    fontCode: string;
-    textColor: string;
-    textInverseColor: string;
-    textMutedColor: string;
-    barTextColor: string;
-    barHoverColor: string;
-    barSelectedColor: string;
-    barBg: string;
-    buttonBg: string;
-    buttonBorder: string;
-    booleanBg: string;
-    booleanSelectedBg: string;
-    inputBg: string;
-    inputBorder: string;
-    inputTextColor: string;
-    inputBorderRadius: number;
-    brandTitle?: string;
-    brandUrl?: string;
-    brandImage?: string;
-    brandTarget?: string;
-    gridCellSize?: number;
-}
-
-type ChannelHandler = (event: ChannelEvent) => void;
-interface ChannelTransport {
-    send(event: ChannelEvent, options?: any): void;
-    setHandler(handler: ChannelHandler): void;
-}
-interface ChannelEvent {
-    type: string;
-    from: string;
-    args: any[];
-}
-interface Listener {
-    (...args: any[]): void;
-}
-interface ChannelArgsSingle {
-    transport?: ChannelTransport;
-    async?: boolean;
-}
-interface ChannelArgsMulti {
-    transports: ChannelTransport[];
-    async?: boolean;
-}
-
-declare class Channel {
-    readonly isAsync: boolean;
-    private sender;
-    private events;
-    private data;
-    private readonly transports;
-    constructor(input: ChannelArgsMulti);
-    constructor(input: ChannelArgsSingle);
-    get hasTransport(): boolean;
-    addListener(eventName: string, listener: Listener): void;
-    emit(eventName: string, ...args: any): void;
-    last(eventName: string): any;
-    eventNames(): string[];
-    listenerCount(eventName: string): number;
-    listeners(eventName: string): Listener[] | undefined;
-    once(eventName: string, listener: Listener): void;
-    removeAllListeners(eventName?: string): void;
-    removeListener(eventName: string, listener: Listener): void;
-    on(eventName: string, listener: Listener): void;
-    off(eventName: string, listener: Listener): void;
-    private handleEvent;
-    private onceListener;
-}
-
-interface Options$1 {
-    allowRegExp: boolean;
-    allowFunction: boolean;
-    allowSymbol: boolean;
-    allowDate: boolean;
-    allowUndefined: boolean;
-    allowClass: boolean;
-    allowError: boolean;
-    maxDepth: number;
-    space: number | undefined;
-    lazyEval: boolean;
-}
-
 /**
 Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
 
@@ -961,6 +723,217 @@ PackageJson$1.TypeScriptConfiguration &
 PackageJson$1.YarnConfiguration &
 PackageJson$1.JSPMConfiguration;
 
+type DateNow = number;
+type TestProviderConfig = Addon_TestProviderType$1;
+type TestingModuleProgressReportProgress = {
+    startedAt: DateNow;
+    finishedAt?: DateNow;
+    numTotalTests?: number;
+    numPassedTests?: number;
+    numFailedTests?: number;
+    numPendingTests?: number;
+    percentageCompleted?: number;
+};
+
+/**
+ * A URL pathname, beginning with a /.
+ *
+ * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.pathname
+ */
+declare type Pathname = string;
+/**
+ * A URL search string, beginning with a ?.
+ *
+ * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.search
+ */
+declare type Search = string;
+/**
+ * A URL fragment identifier, beginning with a #.
+ *
+ * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.hash
+ */
+declare type Hash = string;
+/**
+ * A unique string associated with a location. May be used to safely store
+ * and retrieve data in some other storage API, like `localStorage`.
+ *
+ * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.key
+ */
+declare type Key = string;
+/**
+ * The pathname, search, and hash values of a URL.
+ */
+interface Path$1 {
+    /**
+     * A URL pathname, beginning with a /.
+     *
+     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.pathname
+     */
+    pathname: Pathname;
+    /**
+     * A URL search string, beginning with a ?.
+     *
+     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.search
+     */
+    search: Search;
+    /**
+     * A URL fragment identifier, beginning with a #.
+     *
+     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.hash
+     */
+    hash: Hash;
+}
+/**
+ * An entry in a history stack. A location contains information about the
+ * URL path, as well as possibly some arbitrary state and a key.
+ *
+ * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location
+ */
+interface Location extends Path$1 {
+    /**
+     * A value of arbitrary data associated with this location.
+     *
+     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.state
+     */
+    state: unknown;
+    /**
+     * A unique string associated with this location. May be used to safely store
+     * and retrieve data in some other storage API, like `localStorage`.
+     *
+     * Note: This value is always "default" on the initial location.
+     *
+     * @see https://github.com/remix-run/history/tree/main/docs/api-reference.md#location.key
+     */
+    key: Key;
+}
+/**
+ * Describes a location that is the destination of some navigation, either via
+ * `history.push` or `history.replace`. May be either a URL or the pieces of a
+ * URL path.
+ */
+declare type To = string | Partial<Path$1>;
+
+interface NavigateOptions$1 {
+    replace?: boolean;
+    state?: any;
+}
+
+interface StoryData {
+    viewMode?: string;
+    storyId?: string;
+    refId?: string;
+}
+
+interface Other extends StoryData {
+    path: string;
+    singleStory?: boolean;
+}
+type NavigateOptions = NavigateOptions$1 & {
+    plain?: boolean;
+};
+type NavigateFunction = (to: To | number, options?: NavigateOptions) => void;
+type RouterData = {
+    location: Partial<Location>;
+    navigate: NavigateFunction;
+} & Other;
+type RenderData = Pick<RouterData, 'location'> & Other;
+
+interface ThemeVars extends ThemeVarsBase, ThemeVarsColors {
+}
+interface ThemeVarsBase {
+    base: 'light' | 'dark';
+}
+interface ThemeVarsColors {
+    colorPrimary: string;
+    colorSecondary: string;
+    appBg: string;
+    appContentBg: string;
+    appPreviewBg: string;
+    appBorderColor: string;
+    appBorderRadius: number;
+    fontBase: string;
+    fontCode: string;
+    textColor: string;
+    textInverseColor: string;
+    textMutedColor: string;
+    barTextColor: string;
+    barHoverColor: string;
+    barSelectedColor: string;
+    barBg: string;
+    buttonBg: string;
+    buttonBorder: string;
+    booleanBg: string;
+    booleanSelectedBg: string;
+    inputBg: string;
+    inputBorder: string;
+    inputTextColor: string;
+    inputBorderRadius: number;
+    brandTitle?: string;
+    brandUrl?: string;
+    brandImage?: string;
+    brandTarget?: string;
+    gridCellSize?: number;
+}
+
+type ChannelHandler = (event: ChannelEvent) => void;
+interface ChannelTransport {
+    send(event: ChannelEvent, options?: any): void;
+    setHandler(handler: ChannelHandler): void;
+}
+interface ChannelEvent {
+    type: string;
+    from: string;
+    args: any[];
+}
+interface Listener {
+    (...args: any[]): void;
+}
+interface ChannelArgsSingle {
+    transport?: ChannelTransport;
+    async?: boolean;
+}
+interface ChannelArgsMulti {
+    transports: ChannelTransport[];
+    async?: boolean;
+}
+
+declare class Channel {
+    readonly isAsync: boolean;
+    private sender;
+    private events;
+    private data;
+    private readonly transports;
+    constructor(input: ChannelArgsMulti);
+    constructor(input: ChannelArgsSingle);
+    get hasTransport(): boolean;
+    addListener(eventName: string, listener: Listener): void;
+    emit(eventName: string, ...args: any): void;
+    last(eventName: string): any;
+    eventNames(): string[];
+    listenerCount(eventName: string): number;
+    listeners(eventName: string): Listener[] | undefined;
+    once(eventName: string, listener: Listener): void;
+    removeAllListeners(eventName?: string): void;
+    removeListener(eventName: string, listener: Listener): void;
+    on(eventName: string, listener: Listener): void;
+    off(eventName: string, listener: Listener): void;
+    private handleEvent;
+    private onceListener;
+}
+
+interface Options$1 {
+    allowRegExp: boolean;
+    allowFunction: boolean;
+    allowSymbol: boolean;
+    allowDate: boolean;
+    allowUndefined: boolean;
+    allowClass: boolean;
+    allowError: boolean;
+    maxDepth: number;
+    space: number | undefined;
+    lazyEval: boolean;
+}
+
 type ExportName = string;
 type MetaId = string;
 interface StoriesSpecifier {
@@ -2340,7 +2313,7 @@ type ModuleImportFn = (path: Path) => Promise<ModuleExports>;
 type MaybePromise<T> = Promise<T> | T;
 type TeardownRenderToCanvas = () => MaybePromise<void>;
 type RenderToCanvas<TRenderer extends Renderer> = (context: RenderContext<TRenderer>, element: TRenderer['canvasElement']) => MaybePromise<void | TeardownRenderToCanvas>;
-interface ProjectAnnotations<TRenderer extends Renderer> extends ProjectAnnotations$2<TRenderer> {
+interface ProjectAnnotations<TRenderer extends Renderer> extends ProjectAnnotations$1<TRenderer> {
     addons?: ProjectAnnotations<TRenderer>[];
     testingLibraryRender?: (...args: never[]) => {
         unmount: () => void;
@@ -2493,6 +2466,33 @@ interface DocsContextProps<TRenderer extends Renderer = Renderer> {
 }
 type DocsRenderFunction<TRenderer extends Renderer> = (docsContext: DocsContextProps<TRenderer>, docsParameters: Parameters, element: HTMLElement) => Promise<void>;
 
+declare global {
+    var globalProjectAnnotations: NormalizedProjectAnnotations$1<any>;
+    var defaultProjectAnnotations: ProjectAnnotations$2<any>;
+}
+type WrappedStoryRef = {
+    __pw_type: 'jsx' | 'importRef';
+};
+type UnwrappedJSXStoryRef = {
+    __pw_type: 'jsx';
+    type: UnwrappedImportStoryRef;
+};
+type UnwrappedImportStoryRef = ComposedStoryFn$1;
+declare global {
+    function __pwUnwrapObject(storyRef: WrappedStoryRef): Promise<UnwrappedJSXStoryRef | UnwrappedImportStoryRef>;
+}
+
+interface Report<T = unknown> {
+    type: string;
+    version?: number;
+    result: T;
+    status: 'failed' | 'passed' | 'warning';
+}
+declare class ReporterAPI {
+    reports: Report[];
+    addReport(report: Report): Promise<void>;
+}
+
 type Store_CSFExports<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args = Args> = {
     default: ComponentAnnotations<TRenderer, TArgs>;
     __esModule?: boolean;
@@ -2531,7 +2531,7 @@ type StoriesWithPartialProps<TRenderer extends Renderer$1, TModule> = {
  * function
  */
 interface ComposeStoryFn<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args = Args> {
-    (storyAnnotations: AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations: ProjectAnnotations$2<TRenderer>, exportsName?: string): ComposedStoryFn;
+    (storyAnnotations: AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations: ProjectAnnotations$1<TRenderer>, exportsName?: string): ComposedStoryFn;
 }
 
 type SupportedFrameworks = 'angular' | 'ember' | 'experimental-nextjs-vite' | 'html-vite' | 'html-webpack5' | 'nextjs' | 'preact-vite' | 'preact-webpack5' | 'react-native-web-vite' | 'react-vite' | 'react-webpack5' | 'server-webpack5' | 'svelte-vite' | 'svelte-webpack5' | 'sveltekit' | 'vue3-vite' | 'vue3-webpack5' | 'web-components-vite' | 'web-components-webpack5' | 'qwik' | 'solid' | 'nuxt' | 'react-rsbuild' | 'vue3-rsbuild';