@storybook/types 8.0.0-alpha.9 → 8.0.0-beta.0

package/dist/index.d.ts

@@ -1009,7 +1009,7 @@ type ComponentTitle = string;
 type StoryName = string;
 /** @deprecated */
 type StoryKind = ComponentTitle;
-type Tag = string;
+type Tag$1 = string;
 interface StoryIdentifier {
     componentId: ComponentId;
     title: ComponentTitle;
@@ -1019,7 +1019,7 @@ interface StoryIdentifier {
     name: StoryName;
     /** @deprecated */
     story: StoryName;
-    tags: Tag[];
+    tags: Tag$1[];
 }
 interface Parameters {
     [name: string]: any;
@@ -1244,7 +1244,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
     /**
      * Named tags for a story, used to filter stories in different contexts.
      */
-    tags?: Tag[];
+    tags?: Tag$1[];
 }
 type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequiredArgs = Partial<TArgs>> = BaseAnnotations<TRenderer, TArgs> & {
     /**
@@ -1262,7 +1262,7 @@ type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequ
     /**
      * Named tags for a story, used to filter stories in different contexts.
      */
-    tags?: Tag[];
+    tags?: Tag$1[];
     /** @deprecated */
     story?: Omit<StoryAnnotations<TRenderer, TArgs>, 'story'>;
 } & ({} extends TRequiredArgs ? {
@@ -1518,14 +1518,14 @@ interface IndexerOptions {
 interface IndexedStory {
     id: string;
     name: string;
-    tags?: Tag[];
+    tags?: Tag$1[];
     parameters?: Parameters;
 }
 interface IndexedCSFFile {
     meta: {
         id?: string;
         title?: string;
-        tags?: Tag[];
+        tags?: Tag$1[];
     };
     stories: IndexedStory[];
 }
@@ -1555,7 +1555,7 @@ interface BaseIndexEntry {
     id: StoryId;
     name: StoryName;
     title: ComponentTitle;
-    tags?: Tag[];
+    tags?: Tag$1[];
     importPath: Path;
 }
 type StoryIndexEntry = BaseIndexEntry & {
@@ -1585,7 +1585,9 @@ type BaseIndexInput = {
      */
     metaId?: MetaId;
     /** Tags for filtering entries in Storybook and its tools. */
-    tags?: Tag[];
+    tags?: Tag$1[];
+    /** Tags from the meta for filtering entries in Storybook and its tools. */
+    metaTags?: Tag$1[];
     /**
      * The id of the entry, auto-generated from {@link title}/{@link metaId} and {@link exportName} if unspecified.
      * If specified, the story in the CSF file _must_ have a matching id set at `parameters.__id`, to be correctly matched.
@@ -1885,6 +1887,12 @@ interface TestBuildFlags {
 interface TestBuildConfig {
     test?: TestBuildFlags;
 }
+type Tag = string;
+interface TagOptions {
+    excludeFromSidebar: boolean;
+    excludeFromDocsStories: boolean;
+}
+type TagsOptions = Record<Tag, Partial<TagOptions>>;
 /**
  * The interface for Storybook configuration used internally in presets
  * The difference is that these values are the raw values, AKA, not wrapped with `PresetValue<>`
@@ -1919,9 +1927,9 @@ interface StorybookConfigRaw {
          */
         disallowImplicitActionsInRenderV8?: boolean;
         /**
-         * Enable asynchronous component rendering in NextJS framework
+         * Enable asynchronous component rendering in React renderer
          */
-        experimentalNextRSC?: boolean;
+        experimentalRSC?: boolean;
     };
     build?: TestBuildConfig;
     stories: StoriesEntry[];
@@ -1932,7 +1940,6 @@ interface StorybookConfigRaw {
     swc?: any;
     env?: Record<string, string>;
     babelDefault?: any;
-    config?: Entry[];
     previewAnnotations?: Entry[];
     experimental_indexers?: Indexer[];
     docs?: DocsOptions;
@@ -1940,6 +1947,7 @@ interface StorybookConfigRaw {
     previewBody?: string;
     previewMainTemplate?: string;
     managerHead?: string;
+    tags?: TagsOptions;
 }
 /**
  * The interface for Storybook configuration in `main.ts` files.
@@ -1997,12 +2005,6 @@ interface StorybookConfig {
      * Modify or return babel config.
      */
     babelDefault?: PresetValue<StorybookConfigRaw['babelDefault']>;
-    /**
-     * Add additional scripts to run in the preview a la `.storybook/preview.js`
-     *
-     * @deprecated use `previewAnnotations` or `/preview.js` file instead
-     */
-    config?: PresetValue<StorybookConfigRaw['config']>;
     /**
      * Add additional scripts to run in the preview a la `.storybook/preview.js`
      */
@@ -2036,6 +2038,10 @@ interface StorybookConfig {
      * which is the existing head content, and return a modified string.
      */
     managerHead?: PresetValue<StorybookConfigRaw['managerHead']>;
+    /**
+     * Configure non-standard tag behaviors
+     */
+    tags?: PresetValue<StorybookConfigRaw['tags']>;
 }
 type PresetValue<T> = T | ((config: T, options: Options) => T | Promise<T>);
 type PresetProperty<K, TStorybookConfig = StorybookConfigRaw> = TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | PresetPropertyFn<K, TStorybookConfig>;
@@ -2084,73 +2090,39 @@ interface API_BaseEntry {
     name: string;
     refId?: string;
     renderLabel?: (item: API_BaseEntry) => any;
-    /** @deprecated */
-    isRoot: boolean;
-    /** @deprecated */
-    isComponent: boolean;
-    /** @deprecated */
-    isLeaf: boolean;
 }
 interface API_RootEntry extends API_BaseEntry {
     type: 'root';
     startCollapsed?: boolean;
     children: StoryId[];
-    /** @deprecated */
-    isRoot: true;
-    /** @deprecated */
-    isComponent: false;
-    /** @deprecated */
-    isLeaf: false;
 }
 interface API_GroupEntry extends API_BaseEntry {
     type: 'group';
     parent?: StoryId;
     children: StoryId[];
-    /** @deprecated */
-    isRoot: false;
-    /** @deprecated */
-    isComponent: false;
-    /** @deprecated */
-    isLeaf: false;
 }
 interface API_ComponentEntry extends API_BaseEntry {
     type: 'component';
     parent?: StoryId;
     children: StoryId[];
-    /** @deprecated */
-    isRoot: false;
-    /** @deprecated */
-    isComponent: true;
-    /** @deprecated */
-    isLeaf: false;
 }
 interface API_DocsEntry extends API_BaseEntry {
     type: 'docs';
     parent: StoryId;
     title: ComponentTitle;
-    /** @deprecated */
-    kind: ComponentTitle;
     importPath: Path;
-    tags: Tag[];
+    tags: Tag$1[];
     prepared: boolean;
     parameters?: {
         [parameterName: string]: any;
     };
-    /** @deprecated */
-    isRoot: false;
-    /** @deprecated */
-    isComponent: false;
-    /** @deprecated */
-    isLeaf: true;
 }
 interface API_StoryEntry extends API_BaseEntry {
     type: 'story';
     parent: StoryId;
     title: ComponentTitle;
-    /** @deprecated */
-    kind: ComponentTitle;
     importPath: Path;
-    tags: Tag[];
+    tags: Tag$1[];
     prepared: boolean;
     parameters?: {
         [parameterName: string]: any;
@@ -2158,21 +2130,9 @@ interface API_StoryEntry extends API_BaseEntry {
     args?: Args;
     argTypes?: ArgTypes;
     initialArgs?: Args;
-    /** @deprecated */
-    isRoot: false;
-    /** @deprecated */
-    isComponent: false;
-    /** @deprecated */
-    isLeaf: true;
 }
 type API_LeafEntry = API_DocsEntry | API_StoryEntry;
 type API_HashEntry = API_RootEntry | API_GroupEntry | API_ComponentEntry | API_DocsEntry | API_StoryEntry;
-/** @deprecated */
-type API_Root = API_RootEntry;
-/** @deprecated */
-type API_Group = API_GroupEntry | API_ComponentEntry;
-/** @deprecated */
-type API_Story = API_LeafEntry;
 /**
  * The `IndexHash` is our manager-side representation of the `StoryIndex`.
  * We create entries in the hash not only for each story or docs entry, but
@@ -2299,18 +2259,6 @@ interface API_MatchOptions {
     location: RenderData['location'];
     path: string;
 }
-/**
- * @deprecated this is synonymous with `Addon_Type`. This interface will be removed in 8.0
- */
-type API_Addon = Addon_Type;
-/**
- * @deprecated this is synonymous with `Addon_Collection`. This interface will be removed in 8.0
- */
-type API_Collection<T = Addon_Type> = Addon_Collection<T>;
-/**
- * @deprecated This interface will be removed in 8.0
- */
-type API_Panels = Addon_Collection<Addon_BaseType>;
 type API_StateMerger<S> = (input: S) => S;
 interface API_ProviderData<API> {
     provider: API_Provider<API>;
@@ -2662,7 +2610,9 @@ interface Addon_BaseType {
     /**
      * This will determine the value of `active` prop of your render function.
      */
-    match?: (matchOptions: RenderData) => boolean;
+    match?: (matchOptions: RenderData & {
+        tabId?: string;
+    }) => boolean;
     /**
      * The actual contents of your addon.
      *
@@ -2731,7 +2681,6 @@ interface Addon_WrapperType {
         children: ReactNode;
         id: string;
         storyId: StoryId;
-        active: boolean;
     }>>;
 }
 interface Addon_SidebarBottomType {
@@ -2975,6 +2924,10 @@ interface DocsContextProps<TRenderer extends Renderer = Renderer> {
      * Syncronously find all stories of the component referenced by the CSF file.
      */
     componentStories: () => PreparedStory<TRenderer>[];
+    /**
+     * Syncronously find all stories by CSF file.
+     */
+    componentStoriesFromCSFFile: (csfFile: CSFFile<TRenderer>) => PreparedStory<TRenderer>[];
     /**
      * Get the story context of the referenced story.
      */
@@ -3045,4 +2998,4 @@ interface ComposeStoryFn<TRenderer extends Renderer = Renderer, TArgs extends Ar
     (storyAnnotations: AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations: ProjectAnnotations<TRenderer>, exportsName?: string): ComposedStoryFn;
 }
 
-export { API_ActiveTabsType, API_Addon, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_FilterFunction, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexHash, API_Layout, API_LeafEntry, API_LoadedRefData, API_MatchOptions, API_Notification, API_OptionsData, API_PanelPositions, API_Panels, API_PreparedIndexEntry, API_PreparedStoryIndex, API_Provider, API_ProviderData, API_RefId, API_RefUrl, API_Refs, API_ReleaseNotes, API_RenderOptions, API_Root, API_RootEntry, API_RouteOptions, API_SetRefData, API_Settings, API_SidebarOptions, API_StateMerger, API_StatusObject, API_StatusState, API_StatusUpdate, API_StatusValue, API_Story, API_StoryEntry, API_StoryMapper, API_UI, API_UIOptions, API_UnknownEntries, API_Version, API_Versions$1 as API_Versions, API_ViewMode, Addon_AddStoryArgs, Addon_Annotations, Addon_ArgType, Addon_ArgsStoryFn, Addon_BaseAnnotations, Addon_BaseDecorators, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_BaseType, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_Elements, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_OptionsParameterV7, Addon_PageType, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_SidebarBottomType, Addon_SidebarTopType, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_TypesMapping, Addon_WrapperSettings, Addon_WrapperType, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseIndexEntry, BaseIndexInput, BaseStory, BoundStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSFFile, ComponentAnnotations, ComponentId, ComponentTitle, ComposeStoryFn, ComposedStoryFn, ComposedStoryPlayContext, ComposedStoryPlayFn, Conditional, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsContextProps, DocsIndexEntry, DocsIndexInput, DocsOptions, DocsPreparedPayload, DocsRenderFunction, Entry, GlobalTypes, Globals, IncludeExcludeOptions, IndexEntry, IndexEntryLegacy, IndexInput, IndexedCSFFile, IndexedStory, Indexer, IndexerOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, LoadedPreset, LoaderFunction, ModuleExport, ModuleExports, ModuleImportFn, NormalizedComponentAnnotations, NormalizedProjectAnnotations, NormalizedStoriesSpecifier, NormalizedStoryAnnotations, Options, PackageJson, Parameters, PartialArgsStoryFn, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, PreparedMeta, PreparedStory, Preset, PresetConfig, PresetProperty, PresetPropertyFn, PresetValue, Presets, PreviewAnnotation, ProjectAnnotations, Ref, RenderContext, RenderContextCallbacks, RenderToCanvas, Renderer, RendererName, ResolvedModuleExport, ResolvedModuleExportFromType, ResolvedModuleExportType, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, SetGlobalsPayload, SetStoriesPayload, SetStoriesStory, SetStoriesStoryData, Stats, StepFunction, StepLabel, StepRunner, Store_CSFExports, StoriesEntry, StoriesWithPartialProps, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryIndexEntry, StoryIndexInput, StoryIndexV2, StoryIndexV3, StoryKind, StoryName, StoryPreparedPayload, StoryRenderOptions, StorybookConfig, StorybookConfigOptions, StorybookConfigRaw, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag, TeardownRenderToCanvas, TestBuildConfig, TestBuildFlags, TypescriptOptions, V3CompatIndexEntry, VersionCheck, ViewMode, WebRenderer };
+export { API_ActiveTabsType, API_BaseEntry, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_FilterFunction, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexHash, API_Layout, API_LeafEntry, API_LoadedRefData, API_MatchOptions, API_Notification, API_OptionsData, API_PanelPositions, API_PreparedIndexEntry, API_PreparedStoryIndex, API_Provider, API_ProviderData, API_RefId, API_RefUrl, API_Refs, API_ReleaseNotes, API_RenderOptions, API_RootEntry, API_RouteOptions, API_SetRefData, API_Settings, API_SidebarOptions, API_StateMerger, API_StatusObject, API_StatusState, API_StatusUpdate, API_StatusValue, API_StoryEntry, API_StoryMapper, API_UI, API_UIOptions, API_UnknownEntries, API_Version, API_Versions$1 as API_Versions, API_ViewMode, Addon_AddStoryArgs, Addon_Annotations, Addon_ArgType, Addon_ArgsStoryFn, Addon_BaseAnnotations, Addon_BaseDecorators, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_BaseType, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_Elements, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_OptionsParameterV7, Addon_PageType, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_SidebarBottomType, Addon_SidebarTopType, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_TypesMapping, Addon_WrapperSettings, Addon_WrapperType, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseIndexEntry, BaseIndexInput, BaseStory, BoundStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSFFile, ComponentAnnotations, ComponentId, ComponentTitle, ComposeStoryFn, ComposedStoryFn, ComposedStoryPlayContext, ComposedStoryPlayFn, Conditional, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsContextProps, DocsIndexEntry, DocsIndexInput, DocsOptions, DocsPreparedPayload, DocsRenderFunction, Entry, GlobalTypes, Globals, IncludeExcludeOptions, IndexEntry, IndexEntryLegacy, IndexInput, IndexedCSFFile, IndexedStory, Indexer, IndexerOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, LoadedPreset, LoaderFunction, ModuleExport, ModuleExports, ModuleImportFn, NormalizedComponentAnnotations, NormalizedProjectAnnotations, NormalizedStoriesSpecifier, NormalizedStoryAnnotations, Options, PackageJson, Parameters, PartialArgsStoryFn, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, PreparedMeta, PreparedStory, Preset, PresetConfig, PresetProperty, PresetPropertyFn, PresetValue, Presets, PreviewAnnotation, ProjectAnnotations, Ref, RenderContext, RenderContextCallbacks, RenderToCanvas, Renderer, RendererName, ResolvedModuleExport, ResolvedModuleExportFromType, ResolvedModuleExportType, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, SetGlobalsPayload, SetStoriesPayload, SetStoriesStory, SetStoriesStoryData, Stats, StepFunction, StepLabel, StepRunner, Store_CSFExports, StoriesEntry, StoriesWithPartialProps, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryIndexEntry, StoryIndexInput, StoryIndexV2, StoryIndexV3, StoryKind, StoryName, StoryPreparedPayload, StoryRenderOptions, StorybookConfig, StorybookConfigOptions, StorybookConfigRaw, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag$1 as Tag, TagOptions, TagsOptions, TeardownRenderToCanvas, TestBuildConfig, TestBuildFlags, TypescriptOptions, V3CompatIndexEntry, VersionCheck, ViewMode, WebRenderer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/types",
-  "version": "8.0.0-alpha.9",
+  "version": "8.0.0-beta.0",
   "description": "Core Storybook TS Types",
   "keywords": [
     "storybook"
@@ -44,7 +44,7 @@
     "prep": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@storybook/channels": "8.0.0-alpha.9",
+    "@storybook/channels": "8.0.0-beta.0",
     "@types/express": "^4.7.0",
     "file-system-cache": "2.3.0"
   },