@storybook/manager-api 8.0.0-alpha.9 → 8.0.0-beta.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode, FC, Component, ReactElement } from 'react';
-import { API_ProviderData, API_IframeRenderer, Addon_Types, Addon_TypesEnum, Addon_Collection, Addon_TypesMapping, API_Panels, API_StateMerger, API_Provider, API_Notification, StoryId, API_Settings, API_LoadedRefData, API_PreparedStoryIndex, API_ViewMode, API_StatusState, API_FilterFunction, API_HashEntry, API_LeafEntry, API_StoryEntry, Args, API_IndexHash, API_ComposedRef, API_StatusUpdate, API_DocsEntry, API_Refs, API_SetRefData, API_ComposedRefUpdate, API_Layout, API_UI, API_PanelPositions, API_Versions, API_UnknownEntries, API_Version, Globals, GlobalTypes, Addon_BaseType, Addon_SidebarTopType, Addon_SidebarBottomType, Addon_PageType, Addon_WrapperType, Addon_Config, API_OptionsData, Parameters, ArgTypes } from '@storybook/types';
+import { API_ProviderData, API_IframeRenderer, Addon_Types, Addon_TypesEnum, Addon_Collection, Addon_TypesMapping, API_StateMerger, API_Provider, API_Notification, StoryId, API_Settings, API_LoadedRefData, API_PreparedStoryIndex, API_ViewMode, API_StatusState, API_FilterFunction, API_HashEntry, API_LeafEntry, API_StoryEntry, Args, API_IndexHash, API_ComposedRef, API_StatusUpdate, API_DocsEntry, API_Refs, API_SetRefData, API_ComposedRefUpdate, API_Layout, API_UI, API_PanelPositions, API_Versions, API_UnknownEntries, API_Version, Globals, GlobalTypes, Addon_BaseType, Addon_SidebarTopType, Addon_SidebarBottomType, Addon_PageType, Addon_WrapperType, Addon_Config, API_OptionsData, Parameters, ArgTypes } from '@storybook/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/types';
 import { RouterData, NavigateOptions } from '@storybook/router';
 import { Listener, Channel } from '@storybook/channels';
@@ -53,24 +53,9 @@ interface SubAPI$b {
      * @protected This is used internally in storybook's manager.
      * @template T - The type of the elements in the collection.
      * @param {Addon_Types | Addon_TypesEnum.experimental_PAGE} type - The type of the elements to retrieve.
-     * @returns {API_Collection<T>} - A collection of elements of the specified type.
+     * @returns {Addon_Collection<T>} - A collection of elements of the specified type.
      */
     getElements: <T extends Addon_Types | Addon_TypesEnum.experimental_PAGE | Addon_TypesEnum.experimental_SIDEBAR_BOTTOM | Addon_TypesEnum.experimental_SIDEBAR_TOP = Addon_Types>(type: T) => Addon_Collection<Addon_TypesMapping[T]>;
-    /**
-     * Returns a collection of all panels.
-     * This is the same as calling getElements('panel')
-     * @protected This is used internally in storybook's manager.
-     * @deprecated please use getElements('panel') instead. This API will be removed in storybook 8.0.
-     * @returns {API_Panels} - A collection of all panels.
-     */
-    getPanels: () => API_Panels;
-    /**
-     * Returns a collection of panels currently enabled for the selected story.
-     * @protected This is used internally in storybook's manager.
-     * @deprecated please use getElements('panel') instead, and do the filtering manually. This API will be removed in storybook 8.0.
-     * @returns {API_Panels} - A collection of all panels.
-     */
-    getStoryPanels: () => API_Panels;
     /**
      * Returns the id of the currently selected panel.
      * @returns {string} - The ID of the currently selected panel.
@@ -641,6 +626,12 @@ interface SubAPI$3 {
      * @returns {void}
      */
     setQueryParams: (input: QueryParams) => void;
+    /**
+     * Set the query parameters for the current URL & navigates.
+     * @param {QueryParams} input - An object containing the query parameters to set.
+     * @returns {void}
+     */
+    applyQueryParams: (input: QueryParams) => void;
 }
 
 interface SubState$2 {
@@ -661,6 +652,16 @@ interface SubAPI$2 {
      * @returns {API_Version} The latest version of the Storybook Manager.
      */
     getLatestVersion: () => API_Version;
+    /**
+     * Returns the URL of the Storybook documentation for the current version.
+     *
+     * @returns {string} The URL of the Storybook Manager documentation.
+     */
+    getDocsUrl: (options: {
+        subpath?: string;
+        versioned?: boolean;
+        renderer?: boolean;
+    }) => string;
     /**
      * Checks if an update is available for the Storybook Manager.
      *
@@ -703,63 +704,26 @@ interface SubAPI {
 
 declare function mockChannel(): Channel;
 
-interface DeprecatedAddonWithId {
-    /**
-     * @deprecated will be removed in 8.0, when registering addons, please use the addon id as the first argument
-     */
-    id?: string;
-}
 declare class AddonStore {
     constructor();
     private loaders;
     private elements;
     private config;
     private channel;
-    /**
-     * @deprecated will be removed in 8.0
-     */
-    private serverChannel;
     private promise;
     private resolve;
     getChannel: () => Channel;
-    /**
-     * @deprecated will be removed in 8.0, 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;
     getElements<T extends Addon_Types | Addon_TypesEnum.experimental_PAGE | Addon_TypesEnum.experimental_SIDEBAR_BOTTOM | Addon_TypesEnum.experimental_SIDEBAR_TOP>(type: T): Addon_Collection<Addon_TypesMapping[T]> | any;
-    /**
-     * Adds a panel to the addon store.
-     * @param {string} id - The id of the panel.
-     * @param {Addon_Type} options - The options for the panel.
-     * @returns {void}
-     *
-     * @deprecated Use the 'add' method instead.
-     * @example
-     * addons.add('My Panel', {
-     *   title: 'My Title',
-     *   type: types.PANEL,
-     *   render: () => <div>My Content</div>,
-     * });
-     */
-    addPanel: (id: string, options: Omit<Addon_BaseType, 'type' | 'id'> & DeprecatedAddonWithId) => void;
     /**
      * Adds an addon to the addon store.
      * @param {string} id - The id of the addon.
      * @param {Addon_Type} addon - The addon to add.
      * @returns {void}
      */
-    add(id: string, addon: Addon_BaseType | (Omit<Addon_SidebarTopType, 'id'> & DeprecatedAddonWithId) | (Omit<Addon_SidebarBottomType, 'id'> & DeprecatedAddonWithId) | (Omit<Addon_PageType, 'id'> & DeprecatedAddonWithId) | (Omit<Addon_WrapperType, 'id'> & DeprecatedAddonWithId)): void;
+    add(id: string, addon: Addon_BaseType | Omit<Addon_SidebarTopType, 'id'> | Omit<Addon_SidebarBottomType, 'id'> | Omit<Addon_PageType, 'id'> | Omit<Addon_WrapperType, 'id'>): void;
     setConfig: (value: Addon_Config) => void;
     getConfig: () => Addon_Config;
     /**