storybook 9.0.0-alpha.10 → 9.0.0-alpha.12

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

@@ -2,7 +2,7 @@ import React, { FC, ReactNode, ReactElement, Component } from 'react';
 import { Channel, Listener as Listener$1 } from 'storybook/internal/channels';
 export { Listener as ChannelListener } from 'storybook/internal/channels';
 import { RouterData, NavigateOptions } from 'storybook/internal/router';
-import { Addon_Types, Addon_TypesEnum, Addon_Collection, Addon_TypesMapping, Addon_BaseType, Addon_SidebarTopType, Addon_SidebarBottomType, Addon_TestProviderType, Addon_PageType, Addon_WrapperType, Addon_Config, API_ProviderData, API_StateMerger, API_Provider, StoryId, Globals, GlobalTypes, API_PanelPositions, API_Layout, API_UI, API_Notification, API_IframeRenderer, API_ComposedRef, API_SetRefData, API_ComposedRefUpdate, API_Refs, API_Settings, API_HashEntry, API_ViewMode, API_LeafEntry, API_PreparedStoryIndex, API_StoryEntry, Args, API_IndexHash, API_DocsEntry, API_FilterFunction, API_LoadedRefData, API_Version, API_Versions, API_UnknownEntries, NormalizedProjectAnnotations, ProjectAnnotations, ComposedStoryFn, API_OptionsData, Parameters, ArgTypes } from 'storybook/internal/types';
+import { Addon_Types, Addon_TypesEnum, Addon_Collection, Addon_TypesMapping, Addon_BaseType, Addon_TestProviderType, Addon_PageType, Addon_WrapperType, Addon_Config, API_ProviderData, API_StateMerger, API_Provider, StoryId, Globals, GlobalTypes, API_PanelPositions, API_Layout, API_UI, API_Notification, API_IframeRenderer, API_ComposedRef, API_SetRefData, API_ComposedRefUpdate, API_Refs, API_Settings, API_HashEntry, API_ViewMode, API_LeafEntry, API_PreparedStoryIndex, API_StoryEntry, Args, API_IndexHash, API_DocsEntry, API_FilterFunction, API_LoadedRefData, API_Version, API_Versions, API_UnknownEntries, API_OptionsData, Parameters, ArgTypes, NormalizedProjectAnnotations, ProjectAnnotations, ComposedStoryFn } from 'storybook/internal/types';
 export { Addon_Type as Addon, API_ComponentEntry as ComponentEntry, API_ComposedRef as ComposedRef, API_DocsEntry as DocsEntry, API_GroupEntry as GroupEntry, API_HashEntry as HashEntry, API_IndexHash as IndexHash, API_LeafEntry as LeafEntry, API_Refs as Refs, API_RootEntry as RootEntry, API_IndexHash as StoriesHash, API_StoryEntry as StoryEntry } from 'storybook/internal/types';
 import { TestProviderState as TestProviderState$1, TestProviderId as TestProviderId$1, TestProviders, WhatsNewData } from 'storybook/internal/core-events';
 import { ThemeVars } from 'storybook/theming';
@@ -22,7 +22,7 @@ declare class AddonStore {
     ready: () => Promise<Channel>;
     hasChannel: () => boolean;
     setChannel: (channel: Channel) => void;
-    getElements<T extends Addon_Types | Addon_TypesEnum.experimental_PAGE | Addon_TypesEnum.experimental_SIDEBAR_BOTTOM | Addon_TypesEnum.experimental_SIDEBAR_TOP | Addon_TypesEnum.experimental_TEST_PROVIDER>(type: T): Addon_Collection<Addon_TypesMapping[T]> | any;
+    getElements<T extends Addon_Types | Addon_TypesEnum.experimental_PAGE | Addon_TypesEnum.experimental_TEST_PROVIDER>(type: T): Addon_Collection<Addon_TypesMapping[T]> | any;
     /**
      * Adds an addon to the addon store.
      *
@@ -30,7 +30,7 @@ declare class AddonStore {
      * @param {Addon_Type} addon - The addon to add.
      * @returns {void}
      */
-    add(id: string, addon: Addon_BaseType | Omit<Addon_SidebarTopType, 'id'> | Omit<Addon_SidebarBottomType, 'id'> | Omit<Addon_TestProviderType, 'id'> | Omit<Addon_PageType, 'id'> | Omit<Addon_WrapperType, 'id'>): void;
+    add(id: string, addon: Addon_BaseType | Omit<Addon_TestProviderType, 'id'> | Omit<Addon_PageType, 'id'> | Omit<Addon_WrapperType, 'id'>): void;
     setConfig: (value: Addon_Config) => void;
     getConfig: () => Addon_Config;
     /**
@@ -91,7 +91,7 @@ interface SubAPI$d {
      * @returns {Addon_Collection<T>} - A collection of elements of the specified type.
      * @protected This is used internally in storybook's manager.
      */
-    getElements: <T extends Addon_Types | Addon_TypesEnum.experimental_PAGE | Addon_TypesEnum.experimental_SIDEBAR_BOTTOM | Addon_TypesEnum.experimental_TEST_PROVIDER | Addon_TypesEnum.experimental_SIDEBAR_TOP = Addon_Types>(type: T) => Addon_Collection<Addon_TypesMapping[T]>;
+    getElements: <T extends Addon_Types | Addon_TypesEnum.experimental_PAGE | Addon_TypesEnum.experimental_TEST_PROVIDER>(type: T) => Addon_Collection<Addon_TypesMapping[T]>;
     /**
      * Returns the id of the currently selected panel.
      *
@@ -391,7 +391,7 @@ interface SubState$5 {
 
 declare const isMacLike: () => boolean;
 declare const controlOrMetaSymbol: () => "⌘" | "ctrl";
-declare const controlOrMetaKey: () => "meta" | "control";
+declare const controlOrMetaKey: () => "control" | "meta";
 declare const optionOrAltSymbol: () => "⌥" | "alt";
 declare const isShortcutTaken: (arr1: string[], arr2: string[]) => boolean;
 type KeyboardEventLike = Pick<KeyboardEvent, 'altKey' | 'ctrlKey' | 'metaKey' | 'shiftKey' | 'key' | 'code' | 'keyCode' | 'preventDefault'>;
@@ -651,6 +651,14 @@ interface SubAPI$3 {
      * @returns {StoryId} The ID of the leaf story, or null if no leaf story was found.
      */
     findLeafStoryId(index: API_IndexHash, storyId: StoryId): StoryId;
+    /**
+     * Finds all the leaf story IDs for the given entry ID in the given index.
+     *
+     * @param {StoryId} entryId - The ID of the entry to find the leaf story IDs for.
+     * @returns {StoryId[]} The IDs of all the leaf stories, or an empty array if no leaf stories were
+     *   found.
+     */
+    findAllLeafStoryIds(entryId: string): StoryId[];
     /**
      * Finds the ID of the sibling story in the given direction for the given story ID in the given
      * story index.
@@ -818,6 +826,67 @@ declare const experimental_requestResponse: <RequestPayload, ResponsePayload = v
 
 declare const _default: <TObj = any>(a: TObj, ...b: Partial<TObj>[]) => TObj;
 
+declare const ActiveTabs: {
+    SIDEBAR: "sidebar";
+    CANVAS: "canvas";
+    ADDONS: "addons";
+};
+
+declare const ManagerContext: React.Context<{
+    api: API;
+    state: State;
+}>;
+type State = SubState$8 & SubState$3 & SubState$6 & SubState$7 & SubState$a & SubState$1 & SubState$2 & SubState$4 & SubState$5 & SubState$9 & SubState & RouterData & API_OptionsData & Other;
+type API = SubAPI$d & SubAPI$c & SubAPI$7 & SubAPI$3 & SubAPI$6 & SubAPI$a & SubAPI$9 & SubAPI$8 & SubAPI$b & SubAPI$4 & SubAPI$5 & SubAPI$1 & SubAPI$2 & SubAPI & Other;
+interface Other {
+    [key: string]: any;
+}
+interface Combo {
+    api: API;
+    state: State;
+}
+type ManagerProviderProps = RouterData & API_ProviderData<API> & {
+    children: ReactNode | FC<Combo>;
+};
+declare const combineParameters: (...parameterSets: Parameters[]) => {};
+declare class ManagerProvider extends Component<ManagerProviderProps, State> {
+    api: API;
+    modules: ReturnType<ModuleFn>[];
+    static displayName: string;
+    constructor(props: ManagerProviderProps);
+    static getDerivedStateFromProps(props: ManagerProviderProps, state: State): State;
+    shouldComponentUpdate(nextProps: ManagerProviderProps, nextState: State): boolean;
+    initModules: () => void;
+    render(): React.JSX.Element;
+}
+interface ManagerConsumerProps<P = unknown> {
+    filter?: (combo: Combo) => P;
+    children: FC<P> | ReactNode;
+}
+declare function ManagerConsumer<P = Combo>({ filter, children, }: ManagerConsumerProps<P>): ReactElement;
+declare function useStorybookState(): State;
+declare function useStorybookApi(): API;
+
+interface API_EventMap {
+    [eventId: string]: Listener$1;
+}
+declare const useChannel: (eventMap: API_EventMap, deps?: any[]) => (type: string, ...args: any[]) => void;
+declare function useStoryPrepared(storyId?: StoryId): boolean;
+declare function useParameter<S>(parameterKey: string, defaultValue?: S): S;
+declare function useSharedState<S>(stateId: string, defaultState?: S): [S, (newStateOrMerger: S | API_StateMerger<S>, options?: Options) => void];
+declare function useAddonState<S>(addonId: string, defaultState?: S): [S, (newStateOrMerger: S | API_StateMerger<S>, options?: Options) => void];
+declare function useArgs(): [Args, (newArgs: Args) => void, (argNames?: string[]) => void, Args];
+declare function useGlobals(): [
+    globals: Globals,
+    updateGlobals: (newGlobals: Globals) => void,
+    storyGlobals: Globals,
+    userGlobals: Globals
+];
+declare function useGlobalTypes(): ArgTypes;
+declare function useArgTypes(): ArgTypes;
+
+declare const typesX: typeof Addon_TypesEnum;
+
 type EnvironmentType = (typeof UniversalStore.Environment)[keyof typeof UniversalStore.Environment];
 type StatusType = (typeof UniversalStore.Status)[keyof typeof UniversalStore.Status];
 type StateUpdater<TState> = (prevState: TState) => TState;
@@ -1124,28 +1193,6 @@ declare class MockUniversalStore<State, CustomEvent extends {
     unsubscribeAll(): void;
 }
 
-declare global {
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
-
-declare global {
-    var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
-    var defaultProjectAnnotations: ProjectAnnotations<any>;
-}
-type WrappedStoryRef = {
-    __pw_type: 'jsx' | 'importRef';
-};
-type UnwrappedJSXStoryRef = {
-    __pw_type: 'jsx';
-    type: UnwrappedImportStoryRef;
-};
-type UnwrappedImportStoryRef = ComposedStoryFn;
-declare global {
-    function __pwUnwrapObject(storyRef: WrappedStoryRef): Promise<UnwrappedJSXStoryRef | UnwrappedImportStoryRef>;
-}
-
 type StatusValue = 'status-value:pending' | 'status-value:success' | 'status-value:error' | 'status-value:warning' | 'status-value:unknown';
 type StatusTypeId = string;
 type StatusByTypeId = Record<StatusTypeId, Status>;
@@ -1159,6 +1206,13 @@ interface Status {
     data?: any;
     sidebarContextMenu?: boolean;
 }
+declare const StatusStoreEventType: {
+    readonly SELECT: "select";
+};
+type StatusStoreEvent = {
+    type: typeof StatusStoreEventType.SELECT;
+    payload: Status[];
+};
 type StatusStore = {
     getAll: () => StatusesByStoryIdAndTypeId;
     set: (statuses: Status[]) => void;
@@ -1171,6 +1225,28 @@ type StatusStoreByTypeId = StatusStore & {
 };
 type UseStatusStore = <T = StatusesByStoryIdAndTypeId>(selector?: (statuses: StatusesByStoryIdAndTypeId) => T) => T;
 
+declare global {
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare global {
+    var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
+    var defaultProjectAnnotations: ProjectAnnotations<any>;
+}
+type WrappedStoryRef = {
+    __pw_type: 'jsx' | 'importRef';
+};
+type UnwrappedJSXStoryRef = {
+    __pw_type: 'jsx';
+    type: UnwrappedImportStoryRef;
+};
+type UnwrappedImportStoryRef = ComposedStoryFn;
+declare global {
+    function __pwUnwrapObject(storyRef: WrappedStoryRef): Promise<UnwrappedJSXStoryRef | UnwrappedImportStoryRef>;
+}
+
 type TestProviderState = 'test-provider-state:pending' | 'test-provider-state:running' | 'test-provider-state:succeeded' | 'test-provider-state:crashed';
 type TestProviderId = string;
 type TestProviderStateByProviderId = Record<TestProviderId, TestProviderState>;
@@ -1425,6 +1501,7 @@ declare const fullStatusStore: StatusStore & {
 };
 declare const getStatusStoreByTypeId: (typeId: StatusTypeId) => StatusStoreByTypeId;
 declare const useStatusStore: UseStatusStore;
+declare const universalStatusStore: UniversalStore<StatusesByStoryIdAndTypeId, StatusStoreEvent>;
 
 declare const fullTestProviderStore: {
     settingsChanged: () => void;
@@ -1439,74 +1516,6 @@ declare const fullTestProviderStore: {
 };
 declare const getTestProviderStoreById: (testProviderId: TestProviderId) => TestProviderStoreById;
 declare const useTestProviderStore: UseTestProviderStore;
+declare const universalTestProviderStore: UniversalStore<TestProviderStateByProviderId, TestProviderStoreEvent>;
 
-declare const ActiveTabs: {
-    SIDEBAR: "sidebar";
-    CANVAS: "canvas";
-    ADDONS: "addons";
-};
-
-declare const ManagerContext: React.Context<{
-    api: API;
-    state: State;
-}>;
-type State = SubState$8 & SubState$3 & SubState$6 & SubState$7 & SubState$a & SubState$1 & SubState$2 & SubState$4 & SubState$5 & SubState$9 & SubState & RouterData & API_OptionsData & DeprecatedState & Other;
-type API = SubAPI$d & SubAPI$c & SubAPI$7 & SubAPI$3 & SubAPI$6 & SubAPI$a & SubAPI$9 & SubAPI$8 & SubAPI$b & SubAPI$4 & SubAPI$5 & SubAPI$1 & SubAPI$2 & SubAPI & Other;
-interface DeprecatedState {
-    /** @deprecated Use index */
-    storiesHash: API_IndexHash;
-    /** @deprecated Use previewInitialized */
-    storiesConfigured: boolean;
-    /** @deprecated Use indexError */
-    storiesFailed?: Error;
-}
-interface Other {
-    [key: string]: any;
-}
-interface Combo {
-    api: API;
-    state: State;
-}
-type ManagerProviderProps = RouterData & API_ProviderData<API> & {
-    children: ReactNode | FC<Combo>;
-};
-declare const combineParameters: (...parameterSets: Parameters[]) => {};
-declare class ManagerProvider extends Component<ManagerProviderProps, State> {
-    api: API;
-    modules: ReturnType<ModuleFn>[];
-    static displayName: string;
-    constructor(props: ManagerProviderProps);
-    static getDerivedStateFromProps(props: ManagerProviderProps, state: State): State;
-    shouldComponentUpdate(nextProps: ManagerProviderProps, nextState: State): boolean;
-    initModules: () => void;
-    render(): React.JSX.Element;
-}
-interface ManagerConsumerProps<P = unknown> {
-    filter?: (combo: Combo) => P;
-    children: FC<P> | ReactNode;
-}
-declare function ManagerConsumer<P = Combo>({ filter, children, }: ManagerConsumerProps<P>): ReactElement;
-declare function useStorybookState(): State;
-declare function useStorybookApi(): API;
-
-interface API_EventMap {
-    [eventId: string]: Listener$1;
-}
-declare const useChannel: (eventMap: API_EventMap, deps?: any[]) => (type: string, ...args: any[]) => void;
-declare function useStoryPrepared(storyId?: StoryId): boolean;
-declare function useParameter<S>(parameterKey: string, defaultValue?: S): S;
-declare function useSharedState<S>(stateId: string, defaultState?: S): [S, (newStateOrMerger: S | API_StateMerger<S>, options?: Options) => void];
-declare function useAddonState<S>(addonId: string, defaultState?: S): [S, (newStateOrMerger: S | API_StateMerger<S>, options?: Options) => void];
-declare function useArgs(): [Args, (newArgs: Args) => void, (argNames?: string[]) => void, Args];
-declare function useGlobals(): [
-    globals: Globals,
-    updateGlobals: (newGlobals: Globals) => void,
-    storyGlobals: Globals,
-    userGlobals: Globals
-];
-declare function useGlobalTypes(): ArgTypes;
-declare function useArgTypes(): ArgTypes;
-
-declare const typesX: typeof Addon_TypesEnum;
-
-export { type API, type API_EventMap, ActiveTabs, AddonStore, type Combo, ManagerConsumer as Consumer, type KeyboardEventLike, ManagerContext, type ManagerProviderProps, ManagerProvider as Provider, RequestResponseError, type State, type Options as StoreOptions, addons, combineParameters, controlOrMetaKey, controlOrMetaSymbol, eventMatchesShortcut, eventToShortcut, MockUniversalStore as experimental_MockUniversalStore, UniversalStore as experimental_UniversalStore, getStatusStoreByTypeId as experimental_getStatusStore, getTestProviderStoreById as experimental_getTestProviderStore, experimental_requestResponse, useStatusStore as experimental_useStatusStore, useTestProviderStore as experimental_useTestProviderStore, useUniversalStore as experimental_useUniversalStore, fullStatusStore as internal_fullStatusStore, fullTestProviderStore as internal_fullTestProviderStore, isMacLike, isShortcutTaken, keyToSymbol, _default as merge, mockChannel, optionOrAltSymbol, shortcutMatchesShortcut, shortcutToHumanString, typesX as types, useAddonState, useArgTypes, useArgs, useChannel, useGlobalTypes, useGlobals, useParameter, useSharedState, useStoryPrepared, useStorybookApi, useStorybookState };
+export { type API, type API_EventMap, ActiveTabs, AddonStore, type Combo, ManagerConsumer as Consumer, type KeyboardEventLike, ManagerContext, type ManagerProviderProps, ManagerProvider as Provider, RequestResponseError, type State, type Options as StoreOptions, addons, combineParameters, controlOrMetaKey, controlOrMetaSymbol, eventMatchesShortcut, eventToShortcut, MockUniversalStore as experimental_MockUniversalStore, UniversalStore as experimental_UniversalStore, getStatusStoreByTypeId as experimental_getStatusStore, getTestProviderStoreById as experimental_getTestProviderStore, experimental_requestResponse, useStatusStore as experimental_useStatusStore, useTestProviderStore as experimental_useTestProviderStore, useUniversalStore as experimental_useUniversalStore, fullStatusStore as internal_fullStatusStore, fullTestProviderStore as internal_fullTestProviderStore, universalStatusStore as internal_universalStatusStore, universalTestProviderStore as internal_universalTestProviderStore, isMacLike, isShortcutTaken, keyToSymbol, _default as merge, mockChannel, optionOrAltSymbol, shortcutMatchesShortcut, shortcutToHumanString, typesX as types, useAddonState, useArgTypes, useArgs, useChannel, useGlobalTypes, useGlobals, useParameter, useSharedState, useStoryPrepared, useStorybookApi, useStorybookState };