Types: Remove Framework in favor of Renderer types

storybookjs · Jan 5, 2024 · 759db42 · 759db42
1 parent 7802938
commit 759db42
Show file tree

Hide file tree

Showing 9 changed files with 5 additions and 35 deletions.
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -33,6 +33,7 @@
     - [StorybookViteConfig type from @storybook/builder-vite](#storybookviteconfig-type-from-storybookbuilder-vite)
     - [props from WithTooltipComponent from @storybook/components](#props-from-withtooltipcomponent-from-storybookcomponents)
     - [LinkTo direct import from addon-links](#linkto-direct-import-from-addon-links)
+    - ["Framework" TypeScript types](#framework-typescript-types)
 - [From version 7.5.0 to 7.6.0](#from-version-750-to-760)
     - [CommonJS with Vite is deprecated](#commonjs-with-vite-is-deprecated)
     - [Using implicit actions during rendering is deprecated](#using-implicit-actions-during-rendering-is-deprecated)
@@ -619,6 +620,10 @@ import LinkTo from '@storybook/addon-links';
 import LinkTo from '@storybook/addon-links/react';
 ```
 
+#### "Framework" TypeScript types
+
+The Framework types such as `ReactFramework` are now removed in favor of Renderer types such as `ReactRenderer`. This affects all frameworks. [More info](#renamed-xframework-to-xrenderer).
+
 ## From version 7.5.0 to 7.6.0
 
 #### CommonJS with Vite is deprecated

diff --git a/code/frameworks/angular/src/client/types.ts b/code/frameworks/angular/src/client/types.ts
@@ -37,10 +37,6 @@ export interface StoryFnAngularReturnType {
   userDefinedTemplate?: boolean;
 }
 
-/**
- * @deprecated Use `AngularRenderer` instead.
- */
-export type AngularFramework = AngularRenderer;
 export interface AngularRenderer extends WebRenderer {
   component: any;
   storyResult: StoryFnAngularReturnType;

diff --git a/code/frameworks/ember/src/client/preview/types.ts b/code/frameworks/ember/src/client/preview/types.ts
@@ -13,10 +13,6 @@ export interface OptionsArgs {
   element: any;
 }
 
-/**
- * @deprecated Use `EmberRenderer` instead.
- */
-export type EmberFramework = EmberRenderer;
 export interface EmberRenderer extends WebRenderer {
   component: any;
   storyResult: OptionsArgs;

diff --git a/code/renderers/html/src/types.ts b/code/renderers/html/src/types.ts
@@ -14,10 +14,6 @@ export interface ShowErrorArgs {
   description: string;
 }
 
-/**
- * @deprecated Use `HtmlRenderer` instead.
- */
-export type HtmlFramework = HtmlRenderer;
 export interface HtmlRenderer extends WebRenderer {
   component: string | HTMLElement | ArgsStoryFn<HtmlRenderer>;
   storyResult: StoryFnHtmlReturnType;

diff --git a/code/renderers/preact/src/types.ts b/code/renderers/preact/src/types.ts
@@ -10,13 +10,6 @@ export interface ShowErrorArgs {
   description: string;
 }
 
-/**
- * @dep
- */
-/**
- * @deprecated Use `PreactRenderer` instead.
- */
-export type PreactFramework = PreactRenderer;
 export interface PreactRenderer extends WebRenderer {
   component: AnyComponent<any, any>;
   storyResult: StoryFnPreactReturnType;

diff --git a/code/renderers/react/src/types.ts b/code/renderers/react/src/types.ts
@@ -3,10 +3,6 @@ import type { WebRenderer } from '@storybook/types';
 
 export type { RenderContext, StoryContext } from '@storybook/types';
 
-/**
- * @deprecated Use `ReactRenderer` instead.
- */
-export type ReactFramework = ReactRenderer;
 export interface ReactRenderer extends WebRenderer {
   component: ComponentType<this['T']>;
   storyResult: StoryFnReactReturnType;

diff --git a/code/renderers/server/src/types.ts b/code/renderers/server/src/types.ts
@@ -5,10 +5,6 @@ export type { RenderContext } from '@storybook/types';
 export type StoryFnServerReturnType = any;
 export type StoryContext = StoryContextBase<ServerRenderer>;
 
-/**
- * @deprecated Use `ServerRenderer` instead.
- */
-export type ServerFramework = ServerRenderer;
 export interface ServerRenderer extends WebRenderer {
   component: string;
   storyResult: StoryFnServerReturnType;

diff --git a/code/renderers/vue3/src/types.ts b/code/renderers/vue3/src/types.ts
@@ -16,10 +16,6 @@ export type StoryContext = StoryContextBase<VueRenderer>;
 
 export type StorybookVueApp = { vueApp: App<any>; storyContext: StoryContext };
 
-/**
- * @deprecated Use `VueRenderer` instead.
- */
-export type VueFramework = VueRenderer;
 export interface VueRenderer extends WebRenderer {
   // We are omitting props, as we don't use it internally, and more importantly, it completely changes the assignability of meta.component.
   // Try not omitting, and check the type errros in the test file, if you want to learn more.

diff --git a/code/renderers/web-components/src/types.ts b/code/renderers/web-components/src/types.ts
@@ -10,10 +10,6 @@ export type StoryFnHtmlReturnType =
 
 export type StoryContext = StoryContextBase<WebComponentsRenderer>;
 
-/**
- * @deprecated Use `WebComponentsRenderer` instead.
- */
-export type WebComponentsFramework = WebComponentsRenderer;
 export interface WebComponentsRenderer extends WebRenderer {
   component: string;
   storyResult: StoryFnHtmlReturnType;