react-native-firework-sdk 2.0.0 → 2.1.0

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,
@@ -48,11 +50,14 @@ import type ProductInfoViewConfiguration from './models/ProductInfoViewConfigura
 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 +80,9 @@ import type {
   VideoPlayerStyle,
 } from './models/VideoPlayerConfiguration';
 import type {
-  AddToCartCallback,
   CustomClickCartIconCallback,
   CustomClickLinkButtonCallback,
+  ShoppingCTACallback,
   UpdateProductDetailsCallback,
 } from './VideoShopping';
 import VideoShopping from './VideoShopping';
@@ -89,9 +94,6 @@ export {
   AdBadgeTextType,
   AdConfiguration,
   AddToCartButtonConfiguration,
-  AddToCartCallback,
-  AddToCartEvent,
-  AddToCartResult,
   AndroidFontInfo,
   CustomClickCartIconCallback,
   CustomClickLinkButtonCallback,
@@ -105,6 +107,7 @@ export {
   IOSFontInfo,
   IOSSystemFontStyle,
   IOSSystemFontWeight,
+  IStoryBlockMethods,
   IStoryBlockProps,
   IVideoFeedProps,
   LinkButtonConfiguration,
@@ -125,6 +128,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,7 @@ 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',
   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,5 +1,9 @@
 import type IOSFontInfo from './IOSFontInfo';
 
+/**
+ * @deprecated The interface will be removed since RN SDK V2.1.
+ * Use {@link ShoppingCTAButtonConfiguration} instead.
+ */
 export interface AddToCartButtonConfiguration {
   /**
    * The background color of "Add to cart" button.
@@ -21,6 +25,32 @@ export interface AddToCartButtonConfiguration {
   iOSFontInfo?: IOSFontInfo;
 }
 
+export type ShoppingCTAButtonText = 'addToCart' | 'shopNow';
+
+export interface ShoppingCTAButtonConfiguration {
+  /**
+   * The text of shopping CTA button.
+   */
+  text?: ShoppingCTAButtonText;
+  /**
+   * 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.
+   */
+  iOSFontInfo?: IOSFontInfo;
+}
+
 export interface LinkButtonConfiguration {
   isHidden?: boolean;
 }
@@ -28,10 +58,17 @@ export interface LinkButtonConfiguration {
 export default interface ProductInfoViewConfiguration {
   /**
    * Configuration of "Add to cart" button. Only supported on iOS.
+   *
+   * @deprecated The property will be removed since RN SDK V2.1.
+   * Use {@link ctaButton} instead.
    */
   addToCartButton?: AddToCartButtonConfiguration;
   /**
-   * Configuration of link button next to "Add to cart" button. Only supported on iOS.
+   * Configuration of shopping CTA button. Only supported on iOS.
+   */
+  ctaButton?: ShoppingCTAButtonConfiguration;
+  /**
+   * Configuration of link button next to "Add to cart" button.
    */
   linkButton?: LinkButtonConfiguration;
 }

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;
+}

package/src/modules/FireworkSDKModule.ts

@@ -25,8 +25,7 @@ interface IFireworkSDKModule extends NativeModule {
   setVideoPlaybackEventEnabled(enabled: boolean): void;
   setAdBadgeConfiguration(config?: AdBadgeConfiguration): Promise<any>;
   trackPurchase(parameters: TrackPurchaseParameters): void;
-  changeAppLanguage(language: string): Promise<boolean>;
-  restart(): Promise<any>;
+  changeAppLanguage(language?: string | null): Promise<boolean>;
 }
 
 const FireworkSDKModuleEventEmitter = new NativeEventEmitter(FireworkSDKModule);

package/src/modules/ShoppingModule.ts

@@ -3,6 +3,7 @@ import { NativeEventEmitter, NativeModule, NativeModules } from 'react-native';
 import { LINKING_ERROR } from '../constants/FWErrorMessage';
 import type Product from '../models/Product';
 import type ProductInfoViewConfiguration from '../models/ProductInfoViewConfiguration';
+import type ShoppingCTAResult from '../models/ShoppingCTAResult';
 
 const ShoppingModule = NativeModules.ShoppingModule
   ? NativeModules.ShoppingModule
@@ -18,17 +19,16 @@ const ShoppingModule = NativeModules.ShoppingModule
 interface IShoppingModule extends NativeModule {
   init(): void;
   updateVideoProducts(products: Product[], callbackId: number | string): void;
-  updateAddToCartStatus(
-    res: string,
-    tips: string,
+  updateShoppingCTAResult(
+    result: ShoppingCTAResult,
     callbackId: number | string
   ): void;
   setCartIconVisible(visible: boolean): void;
   setCartItemCount(count: number): void;
   setCustomClickCartIconEnabled(enabled: boolean): Promise<void>; // Only supported on iOS
   clearCallbackId(callbackId: number | string, eventName: string): void; // Only supported on iOS
-  setProductInfoViewConfiguration(config: ProductInfoViewConfiguration): void; // Only supported on iOS
-  setCustomClickLinkButtonEnabled(enabled: boolean): Promise<void>; // Only supported on Android
+  setProductInfoViewConfiguration(config: ProductInfoViewConfiguration): void;
+  setCustomClickLinkButtonEnabled(enabled: boolean): Promise<void>;
 }
 
 const ShoppingModuleEventEmitter = new NativeEventEmitter(ShoppingModule);

package/android/src/main/java/com/fireworksdk/bridge/constants/FWCommandConstant.kt

@@ -1,6 +0,0 @@
-package com.fireworksdk.bridge.constants
-
-object FWCommandConstant {
-
-  const val FW_COMMAND_VIDEO_FEED_REFRESH = 1000000 // "fw_command_video_refresh"
-}

package/ios/Utils/UIView+ParentViewController.swift

@@ -1,21 +0,0 @@
-//
-//  View+ParentViewController.swift
-//  react-native-firework-sdk
-//
-//  Created by Jeff Zheng on 2021/12/22.
-//
-
-import UIKit
-
-extension UIView {
-    var parentViewController: UIViewController? {
-        var parentResponder: UIResponder? = self
-        while parentResponder != nil {
-            parentResponder = parentResponder!.next
-            if let viewController = parentResponder as? UIViewController {
-                return viewController
-            }
-        }
-        return nil
-    }
-}

package/lib/commonjs/models/AddToCartResult.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=AddToCartResult.js.map

package/lib/module/models/AddToCartResult.js

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=AddToCartResult.js.map

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

@@ -1,10 +0,0 @@
-export default interface AddToCartResult {
-    /**
-     * The result of Adding to Cart
-     */
-    res: 'success' | 'fail';
-    /**
-     * Success or fail message to display to the user
-     */
-    tips: string;
-}

package/src/models/AddToCartResult.ts

@@ -1,10 +0,0 @@
-export default interface AddToCartResult {
-  /**
-   * The result of Adding to Cart
-   */
-  res: 'success' | 'fail';
-  /**
-   * Success or fail message to display to the user
-   */
-  tips: string;
-}