[Checkout Widgets][CM-990]feat: Deprecate Old Widgets (#2327)

immutable · Nov 12, 2024 · 5ccfc6c · 5ccfc6c
1 parent 0e349bd
commit 5ccfc6c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/packages/checkout/sdk/src/widgets/definitions/global.ts b/packages/checkout/sdk/src/widgets/definitions/global.ts
@@ -8,6 +8,7 @@ import {
   WidgetProperties,
   WidgetType,
   WidgetEventData,
+  IWidgetsFactoryCreate,
 } from './types';
 
 /**
@@ -19,7 +20,7 @@ declare global {
   namespace ImmutableCheckoutWidgets {
     class WidgetsFactory implements IWidgetsFactory {
       constructor(sdk: Checkout, config: CheckoutWidgetsConfig);
-      create<T extends WidgetType>(type: T, props?: WidgetProperties<T>): Widget<T>;
+      create: IWidgetsFactoryCreate;
       updateProvider(provider: Web3Provider): void;
     }
 

diff --git a/packages/checkout/sdk/src/widgets/definitions/types.ts b/packages/checkout/sdk/src/widgets/definitions/types.ts
@@ -271,14 +271,24 @@ export interface IWidgetsFactory {
    * @param type widget type to instantiate.
    * @param props widget configurations and provider.
    */
-  create<T extends WidgetType>(type: T, props?: WidgetProperties<T>): Widget<T>;
+  create: IWidgetsFactoryCreate;
   /**
    * Update the widgets provider instance.
    * @param provider the provider instance to update all widgets.
    */
   updateProvider(provider: Web3Provider): void;
 }
 
+export interface IWidgetsFactoryCreate {
+  (type: WidgetType.IMMUTABLE_COMMERCE, props?: WidgetProperties<WidgetType.IMMUTABLE_COMMERCE>):
+  Widget<WidgetType.IMMUTABLE_COMMERCE>;
+
+  /** @deprecated
+   * Use WidgetType.IMMUTABLE_COMMERCE instead, see https://docs.immutable.com/products/zkEVM/checkout/commerce-widget
+   * */
+  <T extends Exclude<WidgetType, WidgetType.IMMUTABLE_COMMERCE>>(type: T, props?: WidgetProperties<T>): Widget<T>;
+}
+
 /**
  * Widget interface. Every widget implements this interface.
  */

diff --git a/packages/checkout/widgets-lib/src/factory.ts b/packages/checkout/widgets-lib/src/factory.ts
@@ -2,6 +2,7 @@ import { Web3Provider } from '@ethersproject/providers';
 import {
   Checkout,
   IWidgetsFactory,
+  IWidgetsFactoryCreate,
   Widget,
   WidgetConfiguration,
   WidgetConfigurations,
@@ -17,8 +18,8 @@ import {
 import { WalletConnectManager } from './lib/walletConnect';
 import { AddTokens } from './widgets/add-tokens/AddTokensRoot';
 import { Bridge } from './widgets/bridge/BridgeWidgetRoot';
-import { CommerceWidgetRoot } from './widgets/immutable-commerce/CommerceWidgetRoot';
 import { Connect } from './widgets/connect/ConnectWidgetRoot';
+import { CommerceWidgetRoot } from './widgets/immutable-commerce/CommerceWidgetRoot';
 import { OnRamp } from './widgets/on-ramp/OnRampWidgetRoot';
 import { Sale } from './widgets/sale/SaleWidgetRoot';
 import { Swap } from './widgets/swap/SwapWidgetRoot';
@@ -53,9 +54,9 @@ export class WidgetsFactory implements IWidgetsFactory {
     sendProviderUpdatedEvent({ provider });
   }
 
-  create<T extends WidgetType>(type: T, props?: WidgetProperties<T>): Widget<T> {
+  create: IWidgetsFactoryCreate = <T extends WidgetType>(type: T, props?: WidgetProperties<T>) => {
     const { provider } = props ?? {};
-    const config = props?.config as WidgetConfigurations[T] || {};
+    const config = props?.config as WidgetConfigurations[WidgetType] || {};
 
     switch (type) {
       case WidgetType.CONNECT: {
@@ -109,5 +110,5 @@ export class WidgetsFactory implements IWidgetsFactory {
       default:
         throw new Error('widget type not supported');
     }
-  }
+  };
 }