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

package/src/components/StoryBlock.tsx

@@ -1,14 +1,25 @@
-import React from 'react';
+import type { ForwardRefRenderFunction } from 'react';
+import React, {
+  forwardRef,
+  useEffect,
+  useImperativeHandle,
+  useReducer,
+  useRef,
+  useState,
+} from 'react';
 
-import type {
-  EmitterSubscription,
+import {
+  BackHandler,
+  findNodeHandle,
   NativeSyntheticEvent,
+  Platform,
   StyleProp,
+  UIManager,
   ViewStyle,
 } from 'react-native';
-import { findNodeHandle, Platform, UIManager } from 'react-native';
 
 import FireworkSDK from '../FireworkSDK';
+import type AdConfiguration from '../models/AdConfiguration';
 import type FWError from '../models/FWError';
 import { FWEventName } from '../models/FWEventName';
 import type { StoryBlockSource } from '../models/StoryBlockSource';
@@ -18,17 +29,16 @@ import FWStoryBlock from './FWStoryBlock';
 
 const NativeComponentName = 'FWStoryBlock';
 
-const createFragment = (viewId: any) => {
-  if (Platform.OS === 'android') {
-    UIManager.dispatchViewManagerCommand(
-      viewId,
-      UIManager.getViewManagerConfig(
-        NativeComponentName
-      ).Commands.create.toString(),
-      [viewId]
-    );
-  }
-};
+export interface IStoryBlockMethods {
+  /**
+   * Play the story block.
+   */
+  play: () => void;
+  /**
+   * Pause the story block.
+   */
+  pause: () => void;
+}
 
 /**
  * The props type of StoryBlock component.
@@ -55,98 +65,126 @@ export interface IStoryBlockProps {
    */
   dynamicContentParameters?: { [key: string]: string[] };
   /**
-   * Specifies if Picture in Picture is enabled.
+   * Hashtag filter expression is an s-expression used to provide feeds filtered by hashtags with specified criteria.
+   * Queries are specified with boolean predicates on what hashtags are there on the video.
+   * For instance, (and sport food) (or sport food) (and sport (or food comedy)) sport are all valid expressions.
+   * Non-UTF-8 characters are not allowed. If using boolean predicates, the expression needs to be wrapped with parenthesis.
+   */
+  hashtagFilterExpression?: string;
+  /**
+   * Specifies if Picture in Picture is enabled. Only supported on iOS.
    */
   enablePictureInPicture?: boolean;
+  /**
+   * Ad configuration of the feed. Only supported on iOS.
+   */
+  adConfiguration?: AdConfiguration;
   /**
    * The feed loading result callback. It means loading successfully when error equals to undefined.
    */
   onStoryBlockLoadFinished?: (error?: FWError) => void;
 }
 
-/**
- * StoryBlock component. Only supported on iOS.
- */
-class StoryBlock extends React.Component<IStoryBlockProps> {
-  private _nativeComponentRef = React.createRef<any>();
+const StoryBlock: ForwardRefRenderFunction<
+  IStoryBlockMethods,
+  IStoryBlockProps
+> = (props: IStoryBlockProps, forwardedRef) => {
+  const nativeComponentRef = useRef(null);
+  const [isFullscreenState, setIsFullscreenState] = useState<boolean>(false);
+  const [, forceUpdate] = useReducer((x) => x + 1, 0);
+  useImperativeHandle(
+    forwardedRef,
+    () => {
+      const sendCommand = (command: string) => {
+        const nativeNodeHandle = findNodeHandle(nativeComponentRef.current);
 
-  private _subscriptions: EmitterSubscription[] = [];
+        let commandId: string | number =
+          UIManager.getViewManagerConfig(NativeComponentName).Commands[command];
+        if (Platform.OS === 'android') {
+          commandId = commandId.toString();
+        }
 
-  /**
-   * @ignore
-   */
-  componentDidMount() {
+        UIManager.dispatchViewManagerCommand(
+          findNodeHandle(nativeNodeHandle),
+          commandId,
+          []
+        );
+      };
+      return {
+        play: () => {
+          sendCommand('play');
+        },
+        pause: () => {
+          sendCommand('pause');
+        },
+      };
+    },
+    []
+  );
+  useEffect(() => {
     const subscriptionOfShareBaseURLUpdated =
       FireworkSDKModuleEventEmitter.addListener(
         FWEventName.ShareBaseURLUpdated,
         () => {
-          this.setState({});
+          FWLoggerUtil.log('Receive FWEventName.ShareBaseURLUpdated');
+          forceUpdate();
         }
       );
-    this._subscriptions.push(subscriptionOfShareBaseURLUpdated);
-
     const subscriptionOfAdBadgeConfigurationUpdated =
       FireworkSDKModuleEventEmitter.addListener(
         FWEventName.AdBadgeConfigurationUpdated,
         () => {
-          this.setState({});
+          FWLoggerUtil.log('Receive FWEventName.AdBadgeConfigurationUpdated');
+          forceUpdate();
         }
       );
-    this._subscriptions.push(subscriptionOfAdBadgeConfigurationUpdated);
 
     const subscriptionOfVideoLaunchBehaviorUpdated =
       FireworkSDKModuleEventEmitter.addListener(
         FWEventName.VideoLaunchBehaviorUpdated,
         () => {
           FWLoggerUtil.log('Receive FWEventName.VideoLaunchBehaviorUpdated');
-          this.setState({});
+          forceUpdate();
         }
       );
-    this._subscriptions.push(subscriptionOfVideoLaunchBehaviorUpdated);
 
-    if (Platform.OS === 'android') {
-      const viewId = findNodeHandle(this._nativeComponentRef.current);
-      FWLoggerUtil.log(
-        `StoryBlock componentDidMount createFragment viewId: ${viewId}`
+    const subscriptionOfAppLanguageUpdated =
+      FireworkSDKModuleEventEmitter.addListener(
+        FWEventName.AppLanguageUpdated,
+        () => {
+          FWLoggerUtil.log('Receive FWEventName.AppLanguageUpdated');
+          forceUpdate();
+        }
       );
-      createFragment(viewId);
-    }
-  }
-
-  /**
-   * @ignore
-   */
-  componentWillUnmount() {
-    this._subscriptions.forEach((value) => {
-      value.remove();
-    });
 
-    this._subscriptions = [];
-  }
+    if (Platform.OS === 'android') {
+      setTimeout(() => {
+        const viewId = findNodeHandle(nativeComponentRef.current);
+        FWLoggerUtil.log(`StoryBlock createFragment viewId: ${viewId}`);
+        UIManager.dispatchViewManagerCommand(
+          viewId,
+          UIManager.getViewManagerConfig(
+            NativeComponentName
+          ).Commands.create.toString(),
+          [viewId]
+        );
+      }, 500);
+    }
 
-  /**
-   * @ignore
-   */
-  render() {
-    const { style } = this.props;
-
-    return (
-      <FWStoryBlock
-        ref={this._nativeComponentRef}
-        key={this._generateKey()}
-        {...this.props}
-        onStoryBlockLoadFinished={this._onStoryBlockLoadFinished}
-        style={Object.assign({}, style, { zIndex: -1 })}
-      />
-    );
-  }
+    return () => {
+      subscriptionOfShareBaseURLUpdated.remove();
+      subscriptionOfAdBadgeConfigurationUpdated.remove();
+      subscriptionOfVideoLaunchBehaviorUpdated.remove();
+      subscriptionOfAppLanguageUpdated.remove();
+    };
+  }, []);
 
-  private _onStoryBlockLoadFinished = (event: NativeSyntheticEvent<any>) => {
+  const handleStoryBlockLoadFinished = (event: NativeSyntheticEvent<any>) => {
     FWLoggerUtil.log(
-      `StoryBlock _onStoryBlockLoadFinished ${event.nativeEvent.name}`
+      `StoryBlock handleStoryBlockLoadFinished ${event.nativeEvent.name}`
     );
 
-    const { onStoryBlockLoadFinished } = this.props;
+    const { onStoryBlockLoadFinished } = props;
     const { name, reason } = event.nativeEvent;
 
     if (onStoryBlockLoadFinished) {
@@ -162,60 +200,134 @@ class StoryBlock extends React.Component<IStoryBlockProps> {
     }
   };
 
-  private _generateKey(): string {
+  const handleStoryBlockFullscreenStateChanged = (
+    event: NativeSyntheticEvent<any>
+  ) => {
+    FWLoggerUtil.log(
+      `StoryBlock handleStoryBlockFullscreenStateChanged ${event.nativeEvent.isFullScreen}`
+    );
+    const { isFullScreen } = event.nativeEvent;
+    setIsFullscreenState(isFullScreen);
+  };
+
+  const generateDynamicContentParametersString = (): string => {
+    const { dynamicContentParameters } = props;
+
+    if (!dynamicContentParameters) {
+      return '';
+    }
+
+    let resultString = '';
+    const sortedKeyList = Object.keys(dynamicContentParameters).sort();
+    for (const key of sortedKeyList) {
+      const value = dynamicContentParameters[key];
+      const valueString = value.join(',');
+      if (resultString.length > 0) {
+        resultString += '_';
+      }
+
+      resultString += `${key}:${valueString}`;
+    }
+
+    return resultString;
+  };
+
+  const generateVastAttributesString = () => {
+    const { adConfiguration } = props;
+    const vastAttributes = adConfiguration?.vastAttributes ?? '';
+    if (!vastAttributes) {
+      return '';
+    }
+
+    let resultString = '';
+    for (const attribute of vastAttributes) {
+      if (resultString.length > 0) {
+        resultString += '_';
+      }
+      resultString += `${attribute.name ?? ''}:${attribute.value}`;
+    }
+
+    return resultString;
+  };
+
+  const generateKey = (): string => {
     const {
       source,
       channel = '',
       playlist = '',
       enablePictureInPicture = false,
-    } = this.props;
+      adConfiguration,
+      hashtagFilterExpression = '',
+    } = props;
 
-    const shareBaseURL = FireworkSDK.getInstance().getShareBaseURL() ?? '';
+    const gShareBaseURL = FireworkSDK.getInstance().shareBaseURL ?? '';
+    const videoLaunchBehavior =
+      FireworkSDK.getInstance().videoLaunchBehavior ?? 'default';
     const adBadgeConfiguration =
       FireworkSDK.getInstance().getAdBadgeConfiguration() ?? {};
     const adBadgeTextType = adBadgeConfiguration.badgeTextType ?? '';
     const backgroundColorOfAdBadge = adBadgeConfiguration.backgroundColor ?? '';
     const textColorOfAdBadge = adBadgeConfiguration.textColor ?? '';
     const dynamicContentParametersString =
-      this._generateDynamicContentParametersString();
-    const videoLaunchBehavior =
-      FireworkSDK.getInstance().getVideoLaunchBehavior() ?? 'default';
+      generateDynamicContentParametersString();
+    const appLanguage = FireworkSDK.getInstance().appLanguage ?? '';
+    const requiresAds = adConfiguration?.requiresAds ?? false;
+    const adsFetchTimeout = adConfiguration?.adsFetchTimeout ?? 10;
+    const vastAttributesString = generateVastAttributesString();
 
     let key = `source:${source}`;
     key += `_channel:${channel}`;
     key += `_playlist:${playlist}`;
-    key += `_shareBaseURL:${shareBaseURL}`;
+    key += `_gShareBaseURL:${gShareBaseURL}`;
+    key += `_videoLaunchBehavior:${videoLaunchBehavior}`;
     key += `_adBadgeTextType:${adBadgeTextType}`;
     key += `_backgroundColorOfAdBadge:${backgroundColorOfAdBadge}`;
     key += `_textColorOfAdBadge:${textColorOfAdBadge}`;
     key += `_dynamicContentParameters:${dynamicContentParametersString}`;
     key += `_enablePictureInPicture:${enablePictureInPicture}`;
-    key += `_videoLaunchBehavior:${videoLaunchBehavior}`;
+    key += `_appLanguage:${appLanguage}`;
+    key += `_requiresAds:${requiresAds}`;
+    key += `_adsFetchTimeout:${adsFetchTimeout}`;
+    key += `_vastAttributes:${vastAttributesString}`;
+    key += `_hashtagFilterExpression:${hashtagFilterExpression}`;
 
     return key;
-  }
-
-  private _generateDynamicContentParametersString(): string {
-    const { dynamicContentParameters } = this.props;
+  };
 
-    if (!dynamicContentParameters) {
-      return '';
+  useEffect(() => {
+    if (Platform.OS === 'android') {
+      const onBackPress = () => {
+        if (isFullscreenState) {
+          FireworkSDK.getInstance().navigator.popNativeContainer();
+          return true;
+        }
+        return false;
+      };
+      const subscription = BackHandler.addEventListener(
+        'hardwareBackPress',
+        onBackPress
+      );
+      return () => {
+        subscription.remove();
+      };
     }
 
-    let resultString = '';
-    const sortedKeyList = Object.keys(dynamicContentParameters).sort();
-    for (const key of sortedKeyList) {
-      const value = dynamicContentParameters[key];
-      const valueString = value.join(',');
-      if (resultString.length > 0) {
-        resultString += '_';
-      }
+    return;
+  }, [isFullscreenState]);
 
-      resultString += `${key}:${valueString}`;
-    }
-
-    return resultString;
-  }
-}
+  const { style } = props;
+  return (
+    <FWStoryBlock
+      ref={nativeComponentRef}
+      key={generateKey()}
+      {...props}
+      onStoryBlockLoadFinished={handleStoryBlockLoadFinished}
+      onStoryBlockFullScreenStateChanged={
+        handleStoryBlockFullscreenStateChanged
+      }
+      style={Object.assign({}, style, { zIndex: -1 })}
+    />
+  );
+};
 
-export default StoryBlock;
+export default forwardRef(StoryBlock);

package/src/components/VideoFeed.tsx

@@ -51,6 +51,13 @@ export interface IVideoFeedProps {
    * The dynamic content parameters of the feed. Required when the source is set as dynamicContent.
    */
   dynamicContentParameters?: { [key: string]: string[] };
+  /**
+   * Hashtag filter expression is an s-expression used to provide feeds filtered by hashtags with specified criteria.
+   * Queries are specified with boolean predicates on what hashtags are there on the video.
+   * For instance, (and sport food) (or sport food) (and sport (or food comedy)) sport are all valid expressions.
+   * Non-UTF-8 characters are not allowed. If using boolean predicates, the expression needs to be wrapped with parenthesis.
+   */
+  hashtagFilterExpression?: string;
   /**
    * One of three available display modes. Defaults to row.
    */
@@ -170,6 +177,15 @@ class VideoFeed extends React.Component<IVideoFeedProps> {
         }
       );
     this._subscriptions.push(subscriptionOfVideoLaunchBehaviorUpdated);
+    const subscriptionOfAppLanguageUpdated =
+      FireworkSDKModuleEventEmitter.addListener(
+        FWEventName.AppLanguageUpdated,
+        () => {
+          FWLoggerUtil.log('Receive FWEventName.AppLanguageUpdated');
+          this.setState({});
+        }
+      );
+    this._subscriptions.push(subscriptionOfAppLanguageUpdated);
   }
 
   /**
@@ -201,11 +217,12 @@ class VideoFeed extends React.Component<IVideoFeedProps> {
       mode = 'row',
       adConfiguration,
       enablePictureInPicture = false,
+      hashtagFilterExpression = '',
     } = this.props;
     const videoFeedConfiguration = this._getVideoFeedConfiguration();
     const titleHidden = videoFeedConfiguration?.title?.hidden ?? false;
     const titlePosition = videoFeedConfiguration?.titlePosition ?? 'nested';
-    const shareBaseURL = FireworkSDK.getInstance().getShareBaseURL() ?? '';
+    const gShareBaseURL = FireworkSDK.getInstance().shareBaseURL ?? '';
     const adBadgeConfiguration =
       FireworkSDK.getInstance().getAdBadgeConfiguration() ?? {};
     const adBadgeTextType = adBadgeConfiguration.badgeTextType ?? '';
@@ -221,8 +238,8 @@ class VideoFeed extends React.Component<IVideoFeedProps> {
     const vastAttributesString = this._generateVastAttributesString();
     const showAdBadge = videoFeedConfiguration?.showAdBadge ?? false;
     const videoLaunchBehavior =
-      FireworkSDK.getInstance().getVideoLaunchBehavior() ?? 'default';
-
+      FireworkSDK.getInstance().videoLaunchBehavior ?? 'default';
+    const appLanguage = FireworkSDK.getInstance().appLanguage ?? '';
     let key = `source:${source}`;
     key += `_channel:${channel}`;
     key += `_playlist:${playlist}`;
@@ -230,7 +247,7 @@ class VideoFeed extends React.Component<IVideoFeedProps> {
     key += `_mode:${mode}`;
     key += `_titleHidden:${titleHidden}`;
     key += `_titlePosition:${titlePosition}`;
-    key += `_shareBaseURL:${shareBaseURL}`;
+    key += `_gShareBaseURL:${gShareBaseURL}`;
     key += `_adBadgeTextType:${adBadgeTextType}`;
     key += `_backgroundColorOfAdBadge:${backgroundColorOfAdBadge}`;
     key += `_textColorOfAdBadge:${textColorOfAdBadge}`;
@@ -243,6 +260,8 @@ class VideoFeed extends React.Component<IVideoFeedProps> {
     key += `_vastAttributes:${vastAttributesString}`;
     key += `_showAdBadge:${showAdBadge}`;
     key += `_videoLaunchBehavior:${videoLaunchBehavior}`;
+    key += `_appLanguage:${appLanguage}`;
+    key += `_hashtagFilterExpression:${hashtagFilterExpression}`;
 
     return (
       <FWVideoFeed

package/src/index.ts

@@ -1,4 +1,7 @@
-import type { IStoryBlockProps } from './components/StoryBlock';
+import type {
+  IStoryBlockMethods,
+  IStoryBlockProps,
+} from './components/StoryBlock';
 import StoryBlock from './components/StoryBlock';
 import type { IVideoFeedProps, VideoFeedMode } from './components/VideoFeed';
 import VideoFeed from './components/VideoFeed';
@@ -19,17 +22,16 @@ import type AdBadgeConfiguration from './models/AdBadgeConfiguration';
 import type { AdBadgeTextType } from './models/AdBadgeConfiguration';
 import type AdConfiguration from './models/AdConfiguration';
 import type { VastAttribute } from './models/AdConfiguration';
-import type AddToCartResult from './models/AddToCartResult';
 import type AndroidFontInfo from './models/AndroidFontInfo';
 import type FeedItemDetails from './models/FeedItemDetails';
 import type FWError from './models/FWError';
 import type {
-  AddToCartEvent,
   CustomClickLinkButtonEvent,
   CustomCTAClickEvent,
   LiveStreamChatEvent,
   LiveStreamEvent,
   SDKInitEvent,
+  ShoppingCTAEvent,
   UpdateProductDetailsEvent,
   VideoFeedClickEvent,
   VideoPlaybackEvent,
@@ -46,13 +48,15 @@ import type LiveStreamMessageDetails from './models/LiveStreamMessageDetails';
 import type Product from './models/Product';
 import type ProductInfoViewConfiguration from './models/ProductInfoViewConfiguration';
 import type {
-  AddToCartButtonConfiguration,
   LinkButtonConfiguration,
+  ShoppingCTAButtonConfiguration,
+  ShoppingCTAButtonText,
 } from './models/ProductInfoViewConfiguration';
 import type ProductUnit from './models/ProductUnit';
 import type { ProductPrice, ProductUnitOption } from './models/ProductUnit';
 import type SDKInitOptions from './models/SDKInitOptions';
 import type { VideoLaunchBehavior } from './models/SDKInitOptions';
+import type ShoppingCTAResult from './models/ShoppingCTAResult';
 import type { StoryBlockSource } from './models/StoryBlockSource';
 import type TrackPurchaseParameters from './models/TrackPurchaseParameters';
 import type VideoFeedConfiguration from './models/VideoFeedConfiguration';
@@ -75,9 +79,9 @@ import type {
   VideoPlayerStyle,
 } from './models/VideoPlayerConfiguration';
 import type {
-  AddToCartCallback,
   CustomClickCartIconCallback,
   CustomClickLinkButtonCallback,
+  ShoppingCTACallback,
   UpdateProductDetailsCallback,
 } from './VideoShopping';
 import VideoShopping from './VideoShopping';
@@ -88,10 +92,6 @@ export {
   AdBadgeConfiguration,
   AdBadgeTextType,
   AdConfiguration,
-  AddToCartButtonConfiguration,
-  AddToCartCallback,
-  AddToCartEvent,
-  AddToCartResult,
   AndroidFontInfo,
   CustomClickCartIconCallback,
   CustomClickLinkButtonCallback,
@@ -105,6 +105,7 @@ export {
   IOSFontInfo,
   IOSSystemFontStyle,
   IOSSystemFontWeight,
+  IStoryBlockMethods,
   IStoryBlockProps,
   IVideoFeedProps,
   LinkButtonConfiguration,
@@ -125,6 +126,11 @@ export {
   SDKInitCallback,
   SDKInitEvent,
   SDKInitOptions,
+  ShoppingCTAButtonConfiguration,
+  ShoppingCTAButtonText,
+  ShoppingCTACallback,
+  ShoppingCTAEvent,
+  ShoppingCTAResult,
   StoryBlock,
   StoryBlockSource,
   TrackPurchaseParameters,

package/src/models/FWEventName.ts

@@ -4,6 +4,7 @@ export enum FWEventName {
   VideoPlayback = 'fw:video-playback',
   VideoFeedClick = 'fw:video-feed-click',
   AddToCart = 'fw:shopping:add-to-cart',
+  ShoppingCTAButtonClick = 'fw:shopping:cta-button-click',
   ClickCartIcon = 'fw:shopping:click-cart-icon',
   UpdateProductDetails = 'fw:shopping:update-product-details',
   LiveStream = 'fw:livestream',
@@ -11,6 +12,8 @@ export enum FWEventName {
   ShareBaseURLUpdated = 'fw:share-base-url-updated',
   VideoLaunchBehaviorUpdated = 'fw:video-launch-behavior-updated',
   AdBadgeConfigurationUpdated = 'fw:ad-badge-configuration-updated',
+  AppLanguageUpdated = 'fw:app-language-updated',
+  NativeAppLanguageUpdated = 'fw:native-app-language-updated',
   LogMessage = 'fw:log-message',
   CustomLinkButtonClick = 'fw:shopping:custom-link-button-click',
 }

package/src/models/FWEvents.ts

@@ -30,7 +30,11 @@ export interface VideoFeedClickEvent {
   info: FeedItemDetails;
 }
 
-export interface AddToCartEvent {
+export interface ShoppingCTAEvent {
+  /**
+   * The url for the product unit
+   */
+  url: string;
   /**
    * A unique identifier of the product.
    */
@@ -60,7 +64,16 @@ export interface LiveStreamChatEvent {
 }
 
 export interface CustomClickLinkButtonEvent {
+  /**
+   * The url for the product unit
+   */
   url: string;
+  /**
+   * A unique identifier of the product.
+   */
   productId: string;
+  /**
+   * A unique identifier of the product unit.
+   */
   unitId: string;
 }

package/src/models/ProductInfoViewConfiguration.ts

@@ -1,22 +1,27 @@
 import type IOSFontInfo from './IOSFontInfo';
 
-export interface AddToCartButtonConfiguration {
+export type ShoppingCTAButtonText = 'addToCart' | 'shopNow';
+
+export interface ShoppingCTAButtonConfiguration {
+  /**
+   * The text of shopping CTA button.
+   */
+  text?: ShoppingCTAButtonText;
   /**
-   * The background color of "Add to cart" button.
+   * The background color of CTA button.
    */
   backgroundColor?: string;
   /**
-   * The text color of "Add to cart" button.
+   * The text color of CTA button.
    */
   textColor?: string;
   /**
-   * The font size of "Add to cart" button.
+   * 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;
 }
@@ -27,11 +32,11 @@ export interface LinkButtonConfiguration {
 
 export default interface ProductInfoViewConfiguration {
   /**
-   * Configuration of "Add to cart" button. Only supported on iOS.
+   * Configuration of shopping CTA button. Only supported on iOS.
    */
-  addToCartButton?: AddToCartButtonConfiguration;
+  ctaButton?: ShoppingCTAButtonConfiguration;
   /**
-   * Configuration of link button next to "Add to cart" button. Only supported on iOS.
+   * Configuration of link button next to "Add to cart" button.
    */
   linkButton?: LinkButtonConfiguration;
 }

package/src/models/SDKInitOptions.ts

@@ -1,7 +1,12 @@
 export type VideoLaunchBehavior = 'default' | 'muteOnFirstLaunch';
 
 export default interface SDKInitOptions {
+  /**
+   * Custom value to identify the current user.
+   */
   userId?: string;
-  shareBaseURL?: string;
+  /**
+   * Behavior occurring after video is launched.
+   */
   videoLaunchBehavior?: VideoLaunchBehavior;
 }

package/src/models/ShoppingCTAResult.ts

@@ -0,0 +1,11 @@
+export default interface ShoppingCTAResult {
+  /**
+   * The result of shopping CTA button.
+   */
+  res: 'success' | 'fail';
+  /**
+   * We will show a toast to display the tips.
+   * If the property is undefined or empty string, we don't show a toast.
+   */
+  tips?: string;
+}