react-native-firework-sdk 1.7.0 → 2.0.0-beta.1

package/lib/typescript/models/VideoPlayerConfiguration.d.ts

@@ -1,9 +1,25 @@
+import type IOSFontInfo from './IOSFontInfo';
 export declare type VideoPlayerStyle = 'full' | 'fit';
 export declare type VideoPlayerCompleteAction = 'loop' | 'advanceToNext';
 export interface VideoPlayerCTAStyle {
+    /**
+     * The background color of CTA button.
+     */
     backgroundColor?: string;
+    /**
+     * The text color of CTA button.
+     */
     textColor?: string;
+    /**
+     * The font size of CTA button.
+     */
     fontSize?: number;
+    /**
+     * The iOS font info of "Add to cart" button.
+     * The property is ignored when fontSize is not set.
+     * Only supported on iOS.
+     */
+    iOSFontInfo?: IOSFontInfo;
 }
 export declare type VideoPlayerCTADelayType = 'constant' | 'percentage';
 export interface VideoPlayerCTADelay {
@@ -43,7 +59,7 @@ export default interface VideoPlayerConfiguration {
      */
     showMuteButton?: boolean;
     /**
-     * Specifies the video player launch behavior.
+     * Specifies the video player launch behavior. Only supported on iOS.
      */
     launchBehavior?: VideoLaunchBehavior;
     /**
@@ -55,7 +71,7 @@ export default interface VideoPlayerConfiguration {
      */
     ctaDelay?: VideoPlayerCTADelay;
     /**
-     * Specifies the delay before the highlight animation occurs.
+     * Specifies the delay before the highlight animation occurs. Only supported on iOS.
      */
     ctaHighlightDelay?: VideoPlayerCTADelay;
 }

package/lib/typescript/modules/FWNavigatorModule.d.ts

@@ -1,10 +1,9 @@
 import { NativeEventEmitter, NativeModule } from 'react-native';
 interface IFWNavigatorModule extends NativeModule {
-    pushNativeContainer(props: {
-        [key: string]: any;
-    }): Promise<boolean>;
     popNativeContainer(): Promise<boolean>;
     canPopNativeContainer(): Promise<boolean>;
+    startFloatingPlayer(): Promise<boolean>;
+    stopFloatingPlayer(): Promise<boolean>;
 }
 declare const FWNavigatorModuleEventEmitter: NativeEventEmitter;
 export { FWNavigatorModuleEventEmitter };

package/lib/typescript/modules/FireworkSDKModule.d.ts

@@ -6,11 +6,9 @@ interface IFireworkSDKModule extends NativeModule {
     init(userId?: string): void;
     openVideoPlayer(url: string, config?: VideoPlayerConfiguration): void;
     setCustomCTAClickEnabled(enabled: boolean): void;
-    setCustomCTALinkContentPageRouteName(name?: string): Promise<any>;
     setShareBaseURL(url?: string): Promise<any>;
     setVideoPlaybackEventEnabled(enabled: boolean): void;
     setAdBadgeConfiguration(config?: AdBadgeConfiguration): Promise<any>;
-    setAppComponentName(name?: string): Promise<any>;
     trackPurchase(parameters: TrackPurchaseParameters): void;
     changeAppLanguage(language: string): Promise<boolean>;
     restart(): Promise<void>;

package/lib/typescript/modules/ShoppingModule.d.ts

@@ -1,17 +1,16 @@
 import { NativeEventEmitter, NativeModule } from 'react-native';
-import type { NewNativeContainerProps } from '../models/NewNativeContainerProps';
 import type Product from '../models/Product';
 import type ProductInfoViewConfiguration from '../models/ProductInfoViewConfiguration';
 interface IShoppingModule extends NativeModule {
     init(): void;
     updateVideoProducts(products: Product[], callbackId: number | string): void;
-    updateProductViewConfig(config: ProductInfoViewConfiguration, callbackId: number | string): void;
     updateAddToCartStatus(res: string, tips: string, callbackId: number | string): void;
-    jumpToCartPage(callbackId: number | string, props: NewNativeContainerProps): void;
     setCartIconVisible(visible: boolean): void;
     setCartItemCount(count: number): void;
     setCustomClickCartIconEnabled(enabled: boolean): Promise<void>;
     clearCallbackId(callbackId: number | string, eventName: string): void;
+    setProductInfoViewConfiguration(config: ProductInfoViewConfiguration): void;
+    setCustomClickLinkButtonEnabled(enabled: boolean): Promise<void>;
 }
 declare const ShoppingModuleEventEmitter: NativeEventEmitter;
 export { ShoppingModuleEventEmitter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-firework-sdk",
-  "version": "1.7.0",
+  "version": "2.0.0-beta.1",
   "description": "Firework React Native SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/react-native-firework-sdk.podspec

@@ -26,6 +26,6 @@ cp $module_header_path "${PODS_ROOT}/Headers/Public/react_native_firework_sdk/"'
 
   s.dependency "React-Core"
 
-  s.dependency "FireworkVideo", "1.6.0"
+  s.dependency "FireworkVideo", "1.7.0"
 
 end

package/src/FWNavigator.ts

@@ -0,0 +1,52 @@
+import { FWEventName } from './models/FWEventName';
+import FWNavigatorModule, {
+  FWNavigatorModuleEventEmitter,
+} from './modules/FWNavigatorModule';
+import FWLoggerUtil from './utils/FWLoggerUtil';
+
+/**
+ * You can use this class for pushing RN page from the native page.
+ */
+class FWNavigator {
+  private static _instance?: FWNavigator;
+
+  public static getInstance(): FWNavigator {
+    if (!FWNavigator._instance) {
+      FWNavigator._instance = new FWNavigator();
+    }
+    return FWNavigator._instance!;
+  }
+
+  private constructor() {
+    FWLoggerUtil.log('FWNavigator constructor');
+    FWNavigatorModuleEventEmitter.addListener(FWEventName.LogMessage, () => {});
+  }
+
+  /**
+   * Pop the native container. You could use the method to close the fullscreen player.
+   * But if the enablePictureInPicture of the associated video feed is true,
+   * we can't close the fullscreen player.
+   * @returns {Promise<boolean>} The result of popping the native container.
+   */
+  public popNativeContainer(): Promise<boolean> {
+    return FWNavigatorModule.popNativeContainer();
+  }
+
+  /**
+   * Change current fullscreen player to floating player.
+   * @returns {Promise<boolean>} If the result is true, it means that the fullscreen
+   * player is changed to floating player.
+   */
+  public async startFloatingPlayer(): Promise<boolean> {
+    return FWNavigatorModule.startFloatingPlayer();
+  }
+
+  /**
+   * Stop current floating player.
+   */
+  public async stopFloatingPlayer(): Promise<void> {
+    await FWNavigatorModule.stopFloatingPlayer();
+  }
+}
+
+export default FWNavigator;

package/src/FireworkSDK.ts

@@ -55,19 +55,7 @@ class FireworkSDK {
   private _onCustomCTAClick: CustomCTAClickCallback | undefined;
 
   /**
-   * The custom CTA link content page route name.
-   */
-  public get customCTALinkContentPageRouteName(): string | undefined {
-    return this._customCTALinkContentPageRouteName;
-  }
-  public set customCTALinkContentPageRouteName(value: string | undefined) {
-    this._customCTALinkContentPageRouteName = value;
-    FireworkSDKModule.setCustomCTALinkContentPageRouteName(value ?? '');
-  }
-  private _customCTALinkContentPageRouteName: string | undefined;
-
-  /**
-   * The callback of video playback.
+   * The callback of video playback. Only supported on iOS.
    */
   public get onVideoPlayback(): VideoPlaybackCallback | undefined {
     return this._onVideoPlayback;
@@ -79,7 +67,7 @@ class FireworkSDK {
   private _onVideoPlayback?: VideoPlaybackCallback | undefined;
 
   /**
-   * The share base URL of videos.
+   * The share base URL of videos. Only supported on iOS.
    */
   public get shareBaseURL(): string | undefined {
     return this._shareBaseURL;
@@ -96,7 +84,7 @@ class FireworkSDK {
   private _shareBaseURL: string | undefined;
 
   /**
-   * The configuration for ad badges.
+   * The configuration for ad badges. Only supported on iOS.
    */
   public get adBadgeConfiguration(): AdBadgeConfiguration | undefined {
     return this._adBadgeConfiguration;
@@ -116,19 +104,8 @@ class FireworkSDK {
   private _adBadgeConfiguration: AdBadgeConfiguration | undefined;
 
   /**
-   * The app component name.
-   */
-  public get appComponentName(): string | undefined {
-    return this._appComponentName;
-  }
-  public set appComponentName(value: string | undefined) {
-    this._appComponentName = value;
-    FireworkSDKModule.setAppComponentName(value ?? '');
-  }
-  private _appComponentName: string | undefined;
-
-  /**
-   * Defaults to false. You can enable debug logs by setting this property to true.
+   * Defaults to false.
+   * You can enable debug logs by setting this property to true.
    */
   public get debugLogsEnabled(): boolean {
     return FWLoggerUtil.enabled;
@@ -257,9 +234,6 @@ class FireworkSDK {
   public async changeAppLanguage(language: string): Promise<boolean> {
     if (Platform.OS === 'android') {
       const result = await FireworkSDKModule.changeAppLanguage(language);
-      if (result) {
-        await FireworkSDKModule.restart();
-      }
       return result;
     }
 

package/src/LiveStream.ts

@@ -16,11 +16,11 @@ class LiveStream {
   private static _instance?: LiveStream;
 
   /**
-   * The callback of live stream event.
+   * The callback of live stream event. Only supported on iOS.
    */
   public onLiveStreamEvent?: onLiveStreamEventCallback;
   /**
-   * The callback of live stream chat event.
+   * The callback of live stream chat event. Only supported on iOS.
    */
   public onLiveStreamChatEvent?: onLiveStreamChatEventCallback;
 

package/src/VideoShopping.ts

@@ -3,8 +3,8 @@ import { NativeEventEmitter, Platform } from 'react-native';
 import type AddToCartResult from './models/AddToCartResult';
 import type {
   AddToCartEvent,
+  CustomClickLinkButtonEvent,
   UpdateProductDetailsEvent,
-  WillDisplayProductEvent,
 } from './models/FWEvents';
 import { FWEventName } from './models/FWEventName';
 import type Product from './models/Product';
@@ -12,26 +12,21 @@ import type ProductInfoViewConfiguration from './models/ProductInfoViewConfigura
 import ShoppingModule, {
   ShoppingModuleEventEmitter,
 } from './modules/ShoppingModule';
-import type { NewNativeContainerProps } from './models/NewNativeContainerProps';
 import FWLoggerUtil from './utils/FWLoggerUtil';
 
 export type AddToCartCallback = (
   event: AddToCartEvent
 ) => Promise<AddToCartResult | undefined | null>;
 
-export type ClickCartIconCallback = () => Promise<
-  NewNativeContainerProps | undefined | null
->;
-
 export type CustomClickCartIconCallback = () => Promise<void>;
 
 export type UpdateProductDetailsCallback = (
   event: UpdateProductDetailsEvent
 ) => Promise<Product[] | undefined | null>;
 
-export type WillDisplayProductCallback = (
-  event: WillDisplayProductEvent
-) => Promise<ProductInfoViewConfiguration | undefined | null>;
+export type CustomClickLinkButtonCallback = (
+  event: CustomClickLinkButtonEvent
+) => Promise<void>;
 
 type CallbackInfo = { callbackId?: number | string };
 
@@ -52,14 +47,8 @@ class VideoShopping {
   /**
    * This callback is triggered when the user clicks the shopping cart icon.
    *
-   * The host app can return NewNativeContainerProps object and we will push a new native container with the props.
-   */
-  public onClickCartIcon?: ClickCartIconCallback;
-
-  /**
-   * This callback is triggered when the user clicks the shopping cart icon.
-   *
-   * The host app can customize the processing logic of clicking the shopping cart icon by setting the callback.
+   * The host app can customize the click event processing logic of
+   * the shopping cart icon by setting the callback.
    */
   public get onCustomClickCartIcon(): CustomClickCartIconCallback | undefined {
     return this._onCustomClickCartIcon;
@@ -82,14 +71,8 @@ class VideoShopping {
   public onUpdateProductDetails?: UpdateProductDetailsCallback;
 
   /**
-   * This callback is triggered when the product will be shown. Only supported on iOS.
-   *
-   * The host app can return a ProductInfoViewConfiguration object to configure "Add to cart" button style and cart icon style.
-   */
-  public onWillDisplayProduct?: WillDisplayProductCallback;
-
-  /**
-   * Defaults to true. You can hide the cart icon by setting this property to false.
+   * Defaults to true.
+   * You can hide the cart icon by setting this property to false.
    */
   public get cartIconVisible(): boolean {
     return this._cartIconVisible;
@@ -100,6 +83,51 @@ class VideoShopping {
   }
   private _cartIconVisible: boolean = true;
 
+  /**
+   * The host app can use this property to configure "Add to cart" button style
+   * and hide the link button next to "Add to cart" button. Only supported on iOS.
+   */
+  public get productInfoViewConfiguration():
+    | ProductInfoViewConfiguration
+    | undefined {
+    return this._productInfoViewConfiguration;
+  }
+
+  public set productInfoViewConfiguration(
+    value: ProductInfoViewConfiguration | undefined
+  ) {
+    this._productInfoViewConfiguration = value;
+    if (Platform.OS === 'ios') {
+      ShoppingModule.setProductInfoViewConfiguration(value ?? {});
+    }
+  }
+
+  private _productInfoViewConfiguration?:
+    | ProductInfoViewConfiguration
+    | undefined;
+
+  /**
+   * This callback is triggered when the user clicks
+   * the link button next to Add to cart button. Only supported on Android.
+   *
+   * The host app can customize the click event processing logic of
+   * the link button by setting the callback.
+   */
+  public get onCustomClickLinkButton():
+    | CustomClickLinkButtonCallback
+    | undefined {
+    return this._onCustomClickLinkButton;
+  }
+  public set onCustomClickLinkButton(
+    value: CustomClickLinkButtonCallback | undefined
+  ) {
+    this._onCustomClickLinkButton = value;
+    if (Platform.OS === 'android') {
+      ShoppingModule.setCustomClickLinkButtonEnabled(!!value);
+    }
+  }
+  private _onCustomClickLinkButton?: CustomClickLinkButtonCallback | undefined;
+
   private get eventEmitter(): NativeEventEmitter {
     return ShoppingModuleEventEmitter;
   }
@@ -116,30 +144,36 @@ class VideoShopping {
   private constructor() {
     this.eventEmitter.addListener(FWEventName.AddToCart, (event) => {
       FWLoggerUtil.log(
-        `Receive AddToCart event productId: ${event.productId} unitId: ${event.unitId}`
+        `Receive AddToCart event productId: ${event?.productId} unitId: ${event?.unitId}`
       );
       this.handleAddToCartEvent(event);
     });
 
-    this.eventEmitter.addListener(FWEventName.ClickCartIcon, (event) => {
+    this.eventEmitter.addListener(FWEventName.ClickCartIcon, () => {
       FWLoggerUtil.log('Receive ClickCartIcon event');
-      this.handleClickCartIconEvent(event);
+      this.handleClickCartIconEvent();
     });
 
     this.eventEmitter.addListener(FWEventName.UpdateProductDetails, (event) => {
       FWLoggerUtil.log(
-        `Receive UpdateProductDetails event productIds: ${event.productIds}`
+        `Receive UpdateProductDetails event productIds: ${event?.productIds}`
       );
       this.handleUpdateProductDetailsEvent(event);
     });
 
-    this.eventEmitter.addListener(FWEventName.WillDisplayProduct, (event) => {
-      FWLoggerUtil.log(
-        `Receive WillDisplayProduct event videoId: ${event.videoId}`
-      );
-      this.handleWillDisplayProductEvent(event);
-    });
     this.eventEmitter.addListener(FWEventName.LogMessage, () => {});
+
+    if (Platform.OS === 'android') {
+      this.eventEmitter.addListener(
+        FWEventName.CustomLinkButtonClick,
+        (event) => {
+          FWLoggerUtil.log(
+            `Receive CustomLinkButtonClick event url: ${event?.url}`
+          );
+          this.handleCustomLinkButtonClickEvent(event);
+        }
+      );
+    }
   }
 
   /**
@@ -183,16 +217,9 @@ class VideoShopping {
     }
   }
 
-  private async handleClickCartIconEvent(event: CallbackInfo) {
+  private async handleClickCartIconEvent() {
     if (this.onCustomClickCartIcon) {
       this.onCustomClickCartIcon();
-    } else if (this.onClickCartIcon) {
-      const callbackId = event.callbackId;
-      delete event.callbackId;
-      const props = await this.onClickCartIcon();
-      if (callbackId) {
-        ShoppingModule.jumpToCartPage(callbackId, props ?? {});
-      }
     }
   }
 
@@ -246,18 +273,11 @@ class VideoShopping {
     }
   }
 
-  private async handleWillDisplayProductEvent(
-    event: WillDisplayProductEvent & CallbackInfo
+  private async handleCustomLinkButtonClickEvent(
+    event: CustomClickLinkButtonEvent
   ) {
-    if (this.onWillDisplayProduct) {
-      const callbackId = event.callbackId;
-      delete event.callbackId;
-      const config = await this.onWillDisplayProduct(
-        event as WillDisplayProductEvent
-      );
-      if (config && callbackId) {
-        ShoppingModule.updateProductViewConfig(config, callbackId);
-      }
+    if (this.onCustomClickLinkButton) {
+      this.onCustomClickLinkButton(event);
     }
   }
 }

package/src/components/StoryBlock.tsx

@@ -52,7 +52,7 @@ export interface IStoryBlockProps {
    */
   dynamicContentParameters?: { [key: string]: string[] };
   /**
-   * Specifies if Picture in Picture is enabled. Only supported on iOS.
+   * Specifies if Picture in Picture is enabled.
    */
   enablePictureInPicture?: boolean;
   /**
@@ -61,6 +61,9 @@ export interface IStoryBlockProps {
   onStoryBlockLoadFinished?: (error?: FWError) => void;
 }
 
+/**
+ * Only supported on iOS.
+ */
 export default class StoryBlock extends React.Component<IStoryBlockProps> {
   nativeComponentRef = React.createRef<any>();
 

package/src/components/VideoFeed.tsx

@@ -29,7 +29,7 @@ export interface IVideoFeedProps {
    */
   style?: StyleProp<ViewStyle>;
   /**
-   * One of five available video feed sources.
+   * One of five available video feed sources.The playlistGroup is only supported on iOS
    */
   source: VideoFeedSource;
   /**
@@ -41,7 +41,7 @@ export interface IVideoFeedProps {
    */
   playlist?: string;
   /**
-   * PlaylistGroup id of the feed. Required when the source is set as playlistGroup.
+   * PlaylistGroup id of the feed. Required when the source is set as playlistGroup. Only supported on iOS.
    */
   playlistGroup?: string;
   /**
@@ -65,7 +65,11 @@ export interface IVideoFeedProps {
    */
   adConfiguration?: AdConfiguration;
   /**
-   * The feed loading result callback. It means loading successfully when error equals to undefined.
+   * Specifies if Picture in Picture is enabled.
+   */
+  enablePictureInPicture?: boolean;
+  /**
+   * The feed loading result callback. It means loading successfully when error equals to undefined. Only supported on iOS.
    */
   onVideoFeedLoadFinished?: (error?: FWError) => void;
 }
@@ -171,6 +175,7 @@ export default class VideoFeed extends React.Component<IVideoFeedProps> {
       playlistGroup = '',
       mode = 'row',
       adConfiguration,
+      enablePictureInPicture = false,
     } = this.props;
     const videoFeedConfiguration = this._getVideoFeedConfiguration();
     const titleHidden = videoFeedConfiguration?.title?.hidden ?? false;
@@ -185,8 +190,12 @@ export default class VideoFeed extends React.Component<IVideoFeedProps> {
     const dynamicContentParametersString =
       this._generateDynamicContentParametersString();
     const enableAutoplay = videoFeedConfiguration?.enableAutoplay ?? false;
-    const enablePictureInPicture =
-      videoFeedConfiguration?.enablePictureInPicture ?? false;
+
+    let enablePictureInPictureLegacy = false;
+    if (videoFeedConfiguration) {
+      enablePictureInPictureLegacy =
+        (videoFeedConfiguration as any).enablePictureInPicture ?? false;
+    }
     const gridColumns = videoFeedConfiguration?.gridColumns ?? 2;
     const requiresAds = adConfiguration?.requiresAds ?? false;
     const adsFetchTimeout = adConfiguration?.adsFetchTimeout ?? 10;
@@ -208,6 +217,7 @@ export default class VideoFeed extends React.Component<IVideoFeedProps> {
     key += `_dynamicContentParameters:${dynamicContentParametersString}`;
     key += `_enableAutoplay:${enableAutoplay}`;
     key += `_enablePictureInPicture:${enablePictureInPicture}`;
+    key += `_enablePictureInPictureLegacy:${enablePictureInPictureLegacy}`;
     key += `_gridColumns:${gridColumns}`;
     key += `_requiresAds:${requiresAds}`;
     key += `_adsFetchTimeout:${adsFetchTimeout}`;

package/src/{index.tsx → index.ts}

@@ -23,22 +23,29 @@ import type FeedItemDetails from './models/FeedItemDetails';
 import type FWError from './models/FWError';
 import type {
   AddToCartEvent,
+  CustomClickLinkButtonEvent,
   CustomCTAClickEvent,
   LiveStreamChatEvent,
   LiveStreamEvent,
   SDKInitEvent,
   UpdateProductDetailsEvent,
   VideoPlaybackEvent,
-  WillDisplayProductEvent,
 } from './models/FWEvents';
+import type IOSFontInfo from './models/IOSFontInfo';
+import type {
+  IOSSystemFontStyle,
+  IOSSystemFontWeight,
+} from './models/IOSFontInfo';
 import LiveStreamChatEventName from './models/LiveStreamChatEventName';
 import type LiveStreamEventDetails from './models/LiveStreamEventDetails';
 import LiveStreamEventName from './models/LiveStreamEventName';
 import type LiveStreamMessageDetails from './models/LiveStreamMessageDetails';
-import type { NewNativeContainerProps } from './models/NewNativeContainerProps';
 import type Product from './models/Product';
 import type ProductInfoViewConfiguration from './models/ProductInfoViewConfiguration';
-import type { AddToCartButtonConfiguration } from './models/ProductInfoViewConfiguration';
+import type {
+  AddToCartButtonConfiguration,
+  LinkButtonConfiguration,
+} from './models/ProductInfoViewConfiguration';
 import type ProductUnit from './models/ProductUnit';
 import type { ProductPrice, ProductUnitOption } from './models/ProductUnit';
 import type { StoryBlockSource } from './models/StoryBlockSource';
@@ -65,10 +72,9 @@ import type {
 } from './models/VideoPlayerConfiguration';
 import type {
   AddToCartCallback,
-  ClickCartIconCallback,
   CustomClickCartIconCallback,
+  CustomClickLinkButtonCallback,
   UpdateProductDetailsCallback,
-  WillDisplayProductCallback,
 } from './VideoShopping';
 import VideoShopping from './VideoShopping';
 
@@ -82,14 +88,19 @@ export {
   AddToCartCallback,
   AddToCartEvent,
   AddToCartResult,
-  ClickCartIconCallback,
   CustomClickCartIconCallback,
+  CustomClickLinkButtonCallback,
+  CustomClickLinkButtonEvent,
   CustomCTAClickCallback,
   CustomCTAClickEvent,
   FeedItemDetails,
   FWError,
   FWNavigator,
+  IOSFontInfo,
+  IOSSystemFontStyle,
+  IOSSystemFontWeight,
   IVideoFeedProps,
+  LinkButtonConfiguration,
   LiveStream,
   LiveStreamChatEvent,
   LiveStreamChatEventName,
@@ -97,7 +108,6 @@ export {
   LiveStreamEventDetails,
   LiveStreamEventName,
   LiveStreamMessageDetails,
-  NewNativeContainerProps,
   onLiveStreamChatEventCallback,
   onLiveStreamEventCallback,
   Product,
@@ -135,6 +145,4 @@ export {
   VideoPlayerSize,
   VideoPlayerStyle,
   VideoShopping,
-  WillDisplayProductCallback,
-  WillDisplayProductEvent,
 };

package/src/models/FWEventName.ts

@@ -6,10 +6,10 @@ export enum FWEventName {
   AddToCart = 'fw:shopping:add-to-cart',
   ClickCartIcon = 'fw:shopping:click-cart-icon',
   UpdateProductDetails = 'fw:shopping:update-product-details',
-  WillDisplayProduct = 'fw:shopping:will-display-product',
   LiveStream = 'fw:livestream',
   LiveStreamChat = 'fw:livestream-chat',
   ShareBaseURLUpdated = 'fw:share-base-url-updated',
   AdBadgeConfigurationUpdated = 'fw:ad-badge-configuration-updated',
   LogMessage = 'fw:log-message',
+  CustomLinkButtonClick = 'fw:shopping:custom-link-button-click',
 }

package/src/models/FWEvents.ts

@@ -48,13 +48,6 @@ export interface UpdateProductDetailsEvent {
   productIds: string[];
 }
 
-export interface WillDisplayProductEvent {
-  /**
-   * A unique identifier of the video.
-   */
-  videoId: string;
-}
-
 export interface LiveStreamEvent {
   eventName: LiveStreamEventName;
   info: LiveStreamEventDetails;
@@ -65,3 +58,9 @@ export interface LiveStreamChatEvent {
   message: LiveStreamMessageDetails;
   liveStream: LiveStreamEventDetails;
 }
+
+export interface CustomClickLinkButtonEvent {
+  url: string;
+  productId: string;
+  unitId: string;
+}