react-native-firework-sdk 1.8.0 → 1.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-firework-sdk",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Firework React Native SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -18,13 +18,15 @@
     "!ios/build",
     "!**/__tests__",
     "!**/__fixtures__",
-    "!**/__mocks__"
+    "!**/__mocks__",
+    "!docs/"
   ],
   "scripts": {
     "test": "jest",
     "typescript": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepare": "bob build"
+    "prepare": "bob build",
+    "generate-doc": "rm -rf docs && npx typedoc"
   },
   "keywords": [
     "react-native",
@@ -32,7 +34,7 @@
     "android"
   ],
   "repository": "",
-  "author": "",
+  "author": "Loop Now Technologies, Inc.",
   "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/loopsocial/react-native-firework-sdk/issues"
@@ -57,7 +59,8 @@
     "react": "17.0.2",
     "react-native": "0.66.4",
     "react-native-builder-bob": "^0.18.0",
-    "typescript": "^4.4.4"
+    "typedoc": "^0.23.27",
+    "typescript": "^4.9.5"
   },
   "peerDependencies": {
     "react": "*",
@@ -98,7 +101,8 @@
   },
   "eslintIgnore": [
     "node_modules/",
-    "lib/"
+    "lib/",
+    "docs/"
   ],
   "prettier": {
     "quoteProps": "consistent",

package/react-native-firework-sdk.podspec

@@ -1,31 +1,33 @@
-require "json"
+require 'json'
 
-package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name         = "react-native-firework-sdk"
-  s.version      = package["version"]
-  s.summary      = package["description"]
-  s.homepage     = package["homepage"]
-  s.license      = "Apache License, Version 2.0"
-  s.authors      = package["author"]
+  s.name         = 'react-native-firework-sdk'
+  s.version      = package['version']
+  s.summary      = package['description']
+  s.homepage     = package['homepage']
+  s.license      = 'Apache License, Version 2.0'
+  s.authors      = package['author']
 
-  s.platforms    = { :ios => "12.0" }
-  s.source       = { :git => "https://github.com/loopsocial/bogano.git", :tag => "#{s.version}" }
+  s.platforms    = { ios: '12.0' }
+  s.source       = { git: 'https://github.com/loopsocial/bogano.git', tag: "#{s.version}" }
 
   s.swift_version = '5.0'
-  # s.header_dir = "ios"
-  # s.public_header_files = "ios/*.h"
-  s.source_files = "ios/**/*.{h,m,mm,swift}"
-
-  s.script_phase = { :name => 'Copy module header files', :script => 'echo "react-native-firework-sdk module_header_path path is"
-module_header_path=${PODS_TARGET_SRCROOT}"/ios/react_native_firework_sdk.h"
-echo $module_header_path
-cp $module_header_path "${PODS_ROOT}/Headers/Public/react_native_firework_sdk/"', :execution_position => :before_compile }
-
-
-  s.dependency "React-Core"
-
-  s.dependency "FireworkVideo", "1.7.0"
-
+  # s.header_dir = 'ios'
+  # s.public_header_files = 'ios/*.h'
+  s.source_files = 'ios/**/*.{h,m,mm,swift}'
+  s.exclude_files = 'ios/Support/**/*.{h,m,mm,swift}'
+  s.script_phase = { name: 'Copy module header files', script: '
+module_header_path="${PODS_TARGET_SRCROOT}/ios/react_native_firework_sdk.h"
+target_header_directory="${PODS_ROOT}/Headers/Public/react_native_firework_sdk/"
+echo "module_header_path $module_header_path"
+echo "target_header_directory $target_header_directory"
+if [ -d $target_header_directory ]
+then
+  cp -f $module_header_path $target_header_directory
+fi
+', execution_position: :before_compile }
+  s.dependency 'React-Core'
+  s.dependency 'FireworkVideo', '1.8.0'
 end

package/src/FWNavigator.ts

@@ -5,7 +5,10 @@ import FWNavigatorModule, {
 } from './modules/FWNavigatorModule';
 import FWLoggerUtil from './utils/FWLoggerUtil';
 
-type FWNativeContainerProps = {
+/**
+ * @deprecated The type will be deprecated since RN SDK V2.0.
+ */
+export type FWNativeContainerProps = {
   [key: string]: any;
 };
 
@@ -33,7 +36,7 @@ class FWNavigator {
    * @param {FWNativeContainerProps} props We will pass the props to your app component.
    * @returns {Promise<boolean>} The result of pushing RN page from native page.
    *
-   * @deprecated The property will be deprecated since RN SDK V2.
+   * @deprecated The method will be deprecated since RN SDK V2.0.
    */
   public pushNativeContainer(props: FWNativeContainerProps): Promise<boolean> {
     FWLoggerUtil.log(`Enter pushNewNativeContainer`);
@@ -54,7 +57,7 @@ class FWNavigator {
    * @returns {Promise<boolean>} If the result is true,
    * we could call popNativeContainer to pop top-most native container.
    *
-   * @deprecated The property will be deprecated since RN SDK V2.
+   * @deprecated The method will be deprecated since RN SDK V2.0.
    */
   public canPopNativeContainer(): Promise<boolean> {
     return FWNavigatorModule.canPopNativeContainer();

package/src/FireworkSDK.ts

@@ -56,10 +56,15 @@ class FireworkSDK {
 
   /**
    * The custom CTA link content page route name.
+   *
+   * @deprecated The get accessor will be deprecated since RN SDK V2.0.
    */
   public get customCTALinkContentPageRouteName(): string | undefined {
     return this._customCTALinkContentPageRouteName;
   }
+  /**
+   * @deprecated The set accessor will be deprecated since RN SDK V2.0.
+   */
   public set customCTALinkContentPageRouteName(value: string | undefined) {
     this._customCTALinkContentPageRouteName = value;
     FireworkSDKModule.setCustomCTALinkContentPageRouteName(value ?? '');
@@ -120,16 +125,26 @@ class FireworkSDK {
 
   /**
    * The app component name.
+   *
+   * @deprecated The get accessor will be deprecated since RN SDK V2.0.
    */
   public get appComponentName(): string | undefined {
     return this._appComponentName;
   }
+  /**
+   * @deprecated The set accessor will be deprecated since RN SDK V2.0.
+   */
   public set appComponentName(value: string | undefined) {
     this._appComponentName = value;
     FireworkSDKModule.setAppComponentName(value ?? '');
   }
   private _appComponentName: string | undefined;
 
+  public get appLanguage(): string | undefined | null {
+    return this._appLanguage;
+  }
+  private _appLanguage: string | undefined | null;
+
   /**
    * Defaults to false. You can enable debug logs by setting this property to true.
    */
@@ -253,17 +268,21 @@ class FireworkSDK {
   }
 
   /**
-   * Change App level language. Only supported on Android.
-   * @param {string} language Such as en, ar and en-US
+   * Change App level language.
+   * @param {string | undefined | null} language Such as en, ar and en-US
+   * If language is null or undefined or empty string, we will use system language.
    * @returns
    */
-  public async changeAppLanguage(language: string): Promise<boolean> {
-    if (Platform.OS === 'android') {
-      const result = await FireworkSDKModule.changeAppLanguage(language);
-      return result;
+  public async changeAppLanguage(language?: string | null): Promise<boolean> {
+    const result = await FireworkSDKModule.changeAppLanguage(language);
+    if (result) {
+      const valueHasChanged = this._appLanguage !== language;
+      this._appLanguage = language;
+      if (valueHasChanged) {
+        this.eventEmitter.emit(FWEventName.AppLanguageUpdated);
+      }
     }
-
-    return false;
+    return result;
   }
 }
 

package/src/VideoShopping.ts

@@ -4,6 +4,7 @@ import type AddToCartResult from './models/AddToCartResult';
 import type {
   AddToCartEvent,
   CustomClickLinkButtonEvent,
+  ShoppingCTAEvent,
   UpdateProductDetailsEvent,
   WillDisplayProductEvent,
 } from './models/FWEvents';
@@ -15,11 +16,22 @@ import ShoppingModule, {
 } from './modules/ShoppingModule';
 import type { NewNativeContainerProps } from './models/NewNativeContainerProps';
 import FWLoggerUtil from './utils/FWLoggerUtil';
+import type ShoppingCTAResult from './models/ShoppingCTAResult';
 
+/**
+ * @deprecated The type will be deprecated since RN SDK V2.1.
+ */
 export type AddToCartCallback = (
   event: AddToCartEvent
 ) => Promise<AddToCartResult | undefined | null>;
 
+export type ShoppingCTACallback = (
+  event: ShoppingCTAEvent
+) => Promise<ShoppingCTAResult>;
+
+/**
+ * @deprecated The type will be deprecated since RN SDK V2.0.
+ */
 export type ClickCartIconCallback = () => Promise<
   NewNativeContainerProps | undefined | null
 >;
@@ -30,6 +42,9 @@ export type UpdateProductDetailsCallback = (
   event: UpdateProductDetailsEvent
 ) => Promise<Product[] | undefined | null>;
 
+/**
+ * @deprecated The type will be deprecated since RN SDK V2.0.
+ */
 export type WillDisplayProductCallback = (
   event: WillDisplayProductEvent
 ) => Promise<ProductInfoViewConfiguration | undefined | null>;
@@ -38,8 +53,6 @@ export type CustomClickLinkButtonCallback = (
   event: CustomClickLinkButtonEvent
 ) => Promise<void>;
 
-type CallbackInfo = { callbackId?: number | string };
-
 /**
  * The entry class of video shopping.
  */
@@ -51,14 +64,23 @@ class VideoShopping {
    *
    * The host apps can return an AddToCartResult object to tell FireworkSDK the result of adding to cart.
    * If the host apps want to customize the processing logic of clicking "Add to cart" button, they could return null or undefined in the callback.
+   * @deprecated The callback will be deprecated since RN SDK V2.1.
    */
   public onAddToCart?: AddToCartCallback;
 
+  /**
+   * This callback is triggered when the user clicks the "Add to cart" or "Shop now" button.
+   * The host app can return a ShoppingCTAResult object to tell SDK how to handle the result.
+   */
+  public onShoppingCTA?: ShoppingCTACallback;
+
   /**
    * 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.
+   *
+   * @deprecated The property will be deprecated since RN SDK V2.0.
    */
   public onClickCartIcon?: ClickCartIconCallback;
 
@@ -91,7 +113,8 @@ class VideoShopping {
   /**
    * Please use productInfoViewConfiguration property. Only supported on iOS.
    *
-   * @deprecated The property will be deprecated since RN SDK V2.
+   * @deprecated The property will be deprecated since RN SDK V2.0.
+   * Use {@link productInfoViewConfiguration} instead.
    */
   public onWillDisplayProduct?: WillDisplayProductCallback;
 
@@ -109,8 +132,9 @@ 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.
+   * The configuration of product info view.
+   * Please refer to {@link ProductInfoViewConfiguration} for more details.
+   * Only supported on iOS.
    */
   public get productInfoViewConfiguration():
     | ProductInfoViewConfiguration
@@ -147,9 +171,7 @@ class VideoShopping {
     value: CustomClickLinkButtonCallback | undefined
   ) {
     this._onCustomClickLinkButton = value;
-    if (Platform.OS === 'android') {
-      ShoppingModule.setCustomClickLinkButtonEnabled(!!value);
-    }
+    ShoppingModule.setCustomClickLinkButtonEnabled(!!value);
   }
   private _onCustomClickLinkButton?: CustomClickLinkButtonCallback | undefined;
 
@@ -167,12 +189,26 @@ class VideoShopping {
   }
 
   private constructor() {
-    this.eventEmitter.addListener(FWEventName.AddToCart, (event) => {
-      FWLoggerUtil.log(
-        `Receive AddToCart event productId: ${event?.productId} unitId: ${event?.unitId}`
+    if (Platform.OS === 'android') {
+      this.eventEmitter.addListener(FWEventName.AddToCart, (event) => {
+        FWLoggerUtil.log(
+          `Receive AddToCart event productId: ${event?.productId} unitId: ${event?.unitId}`
+        );
+        this.handleShoppingCTAEvent(event);
+      });
+    }
+
+    if (Platform.OS === 'ios') {
+      this.eventEmitter.addListener(
+        FWEventName.ShoppingCTAButtonClick,
+        (event) => {
+          FWLoggerUtil.log(
+            `Receive ShoppingCTA event productId: ${event?.productId} unitId: ${event?.unitId} url: ${event?.url}`
+          );
+          this.handleShoppingCTAEvent(event);
+        }
       );
-      this.handleAddToCartEvent(event);
-    });
+    }
 
     this.eventEmitter.addListener(FWEventName.ClickCartIcon, (event) => {
       FWLoggerUtil.log('Receive ClickCartIcon event');
@@ -194,17 +230,15 @@ class VideoShopping {
     });
     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);
-        }
-      );
-    }
+    this.eventEmitter.addListener(
+      FWEventName.CustomLinkButtonClick,
+      (event) => {
+        FWLoggerUtil.log(
+          `Receive CustomLinkButtonClick event url: ${event?.url}`
+        );
+        this.handleCustomLinkButtonClickEvent(event);
+      }
+    );
   }
 
   /**
@@ -219,36 +253,75 @@ class VideoShopping {
     ShoppingModule.setCartItemCount(count);
   }
 
-  private async handleAddToCartEvent(event: AddToCartEvent & CallbackInfo) {
+  private async handleShoppingCTAEvent(event: any) {
     const callbackId = event.callbackId;
     delete event.callbackId;
-    if (this.onAddToCart) {
+    let isShopNowCTA = false;
+    if (
+      Platform.OS === 'ios' &&
+      this.productInfoViewConfiguration?.ctaButton?.text === 'shopNow'
+    ) {
+      isShopNowCTA = true;
+    }
+
+    if (this.onShoppingCTA) {
+      const result = await this.onShoppingCTA(event as ShoppingCTAEvent);
+      if (callbackId) {
+        if (Platform.OS === 'ios') {
+          ShoppingModule.updateShoppingCTAResult(result, callbackId);
+        } else {
+          if (result.tips) {
+            ShoppingModule.updateAddToCartStatus(
+              result.res,
+              result.tips,
+              callbackId
+            );
+          }
+        }
+      }
+    } else if (this.onAddToCart && !isShopNowCTA) {
+      if (event.url) {
+        delete event.url;
+      }
       const result = await this.onAddToCart(event as AddToCartEvent);
       if (result) {
         if (callbackId) {
-          ShoppingModule.updateAddToCartStatus(
-            result.res,
-            result.tips,
-            callbackId
-          );
+          if (Platform.OS === 'ios') {
+            ShoppingModule.updateShoppingCTAResult(
+              { res: result.res, tips: result.tips },
+              callbackId
+            );
+          } else {
+            ShoppingModule.updateAddToCartStatus(
+              result.res,
+              result.tips ?? '',
+              callbackId
+            );
+          }
         }
       } else {
         if (callbackId) {
           if (Platform.OS === 'ios') {
-            ShoppingModule.clearCallbackId(callbackId, FWEventName.AddToCart);
+            ShoppingModule.clearCallbackId(
+              callbackId,
+              FWEventName.ShoppingCTAButtonClick
+            );
           }
         }
       }
     } else {
       if (callbackId) {
         if (Platform.OS === 'ios') {
-          ShoppingModule.clearCallbackId(callbackId, FWEventName.AddToCart);
+          ShoppingModule.clearCallbackId(
+            callbackId,
+            FWEventName.ShoppingCTAButtonClick
+          );
         }
       }
     }
   }
 
-  private async handleClickCartIconEvent(event: CallbackInfo) {
+  private async handleClickCartIconEvent(event: any) {
     if (this.onCustomClickCartIcon) {
       this.onCustomClickCartIcon();
     } else if (this.onClickCartIcon) {
@@ -261,9 +334,7 @@ class VideoShopping {
     }
   }
 
-  private async handleUpdateProductDetailsEvent(
-    event: UpdateProductDetailsEvent & CallbackInfo
-  ) {
+  private async handleUpdateProductDetailsEvent(event: any) {
     const callbackId = event.callbackId;
     delete event.callbackId;
     if (this.onUpdateProductDetails) {
@@ -311,16 +382,14 @@ class VideoShopping {
     }
   }
 
-  private async handleWillDisplayProductEvent(
-    event: WillDisplayProductEvent & CallbackInfo
-  ) {
+  private async handleWillDisplayProductEvent(event: any) {
     if (this.onWillDisplayProduct) {
       delete event.callbackId;
       const config = await this.onWillDisplayProduct(
         event as WillDisplayProductEvent
       );
       if (config) {
-        ShoppingModule.setProductInfoViewConfiguration(config);
+        this.productInfoViewConfiguration = config;
       }
     }
   }