react-native-firework-sdk 2.4.0 → 2.4.1

package/lib/typescript/FWNavigator.d.ts

@@ -1,3 +1,4 @@
+import type PushRNContainerParams from './models/PushRNContainerParams';
 /**
  * You can use this class for pushing RN page from the native page.
  */
@@ -5,6 +6,19 @@ declare class FWNavigator {
     private static _instance?;
     static getInstance(): FWNavigator;
     private constructor();
+    /**
+     * Push a new RN container.
+     * You could use this method to make a RN page on top of
+     * SDK full-screen player.
+     * @param params {PushRNContainerParams}
+     * @returns {Promise<boolean>} The result of pushing a new Container.
+     */
+    pushRNContainer(params: PushRNContainerParams): Promise<boolean>;
+    /**
+     * Pop the RN container you pushed before.
+     * @returns {Promise<boolean>} The result of popping a new Container.
+     */
+    popRNContainer(): Promise<boolean>;
     /**
      * 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,

package/lib/typescript/FireworkSDK.d.ts

@@ -23,7 +23,9 @@ declare class FireworkSDK {
     /**
      * the callback of clicking Video Feed.
      */
-    onVideoFeedClick?: VideoFeedClickCallback;
+    get onVideoFeedClick(): VideoFeedClickCallback | undefined;
+    set onVideoFeedClick(value: VideoFeedClickCallback | undefined);
+    private _onVideoFeedClick?;
     /**
      * The callback of clicking custom CTA.
      */

package/lib/typescript/index.d.ts

@@ -29,6 +29,8 @@ import type ProductInfoViewConfiguration from './models/ProductInfoViewConfigura
 import type { LinkButtonConfiguration, ShoppingCTAButtonConfiguration, ShoppingCTAButtonText } from './models/ProductInfoViewConfiguration';
 import type ProductUnit from './models/ProductUnit';
 import type { ProductPrice, ProductUnitOption } from './models/ProductUnit';
+import type PushRNContainerParams from './models/PushRNContainerParams';
+import type { RNAppProps } from './models/PushRNContainerParams';
 import type SDKInitOptions from './models/SDKInitOptions';
 import type { VideoLaunchBehavior } from './models/SDKInitOptions';
 import type ShoppingCTAResult from './models/ShoppingCTAResult';
@@ -50,4 +52,4 @@ import type { VideoPlayerStyle } from './models/VideoPlayerStyle';
 import type { CustomClickCartIconCallback, CustomClickLinkButtonCallback, ShoppingCTACallback, UpdateProductDetailsCallback } from './VideoShopping';
 import VideoShopping from './VideoShopping';
 export default FireworkSDK;
-export { AdBadgeConfiguration, AdBadgeTextType, AdConfiguration, AndroidFontInfo, CustomClickCartIconCallback, CustomClickLinkButtonCallback, CustomClickLinkButtonEvent, CustomCTAClickCallback, CustomCTAClickEvent, FeedItemDetails, FireworkSDK, FWError, FWNavigator, GradientDrawable, GradientDrawableOrientation, IOSFontInfo, IOSSystemFontStyle, IOSSystemFontWeight, IStoryBlockMethods, IStoryBlockProps, IVideoFeedProps, LinkButtonConfiguration, LiveStream, LiveStreamChatEvent, LiveStreamChatEventName, LiveStreamEvent, LiveStreamEventDetails, LiveStreamEventName, LiveStreamMessageDetails, onLiveStreamChatEventCallback, onLiveStreamEventCallback, OpenVideoPlayerConfiguration, Product, ProductInfoViewConfiguration, ProductPrice, ProductUnit, ProductUnitOption, SDKInitCallback, SDKInitEvent, SDKInitOptions, ShoppingCTAButtonConfiguration, ShoppingCTAButtonText, ShoppingCTACallback, ShoppingCTAEvent, ShoppingCTAResult, StoryBlock, StoryBlockConfiguration, StoryBlockSource, TrackPurchaseParameters, UpdateProductDetailsCallback, UpdateProductDetailsEvent, VastAttribute, VideoFeed, VideoFeedClickCallback, VideoFeedClickEvent, VideoFeedConfiguration, VideoFeedMode, VideoFeedPadding, VideoFeedPlayIconConfiguration, VideoFeedSource, VideoFeedTitleConfiguration, VideoFeedTitlePosition, VideoLaunchBehavior, VideoPlaybackCallback, VideoPlaybackDetails, VideoPlaybackEvent, VideoPlaybackEventName, VideoPlayerCompleteAction, VideoPlayerConfiguration, VideoPlayerCTADelay, VideoPlayerCTADelayType, VideoPlayerCTAStyle, VideoPlayerCTAWidth, VideoPlayerSize, VideoPlayerStyle, VideoShopping, };
+export { AdBadgeConfiguration, AdBadgeTextType, AdConfiguration, AndroidFontInfo, CustomClickCartIconCallback, CustomClickLinkButtonCallback, CustomClickLinkButtonEvent, CustomCTAClickCallback, CustomCTAClickEvent, FeedItemDetails, FireworkSDK, FWError, FWNavigator, GradientDrawable, GradientDrawableOrientation, IOSFontInfo, IOSSystemFontStyle, IOSSystemFontWeight, IStoryBlockMethods, IStoryBlockProps, IVideoFeedProps, LinkButtonConfiguration, LiveStream, LiveStreamChatEvent, LiveStreamChatEventName, LiveStreamEvent, LiveStreamEventDetails, LiveStreamEventName, LiveStreamMessageDetails, onLiveStreamChatEventCallback, onLiveStreamEventCallback, OpenVideoPlayerConfiguration, Product, ProductInfoViewConfiguration, ProductPrice, ProductUnit, ProductUnitOption, PushRNContainerParams, RNAppProps, SDKInitCallback, SDKInitEvent, SDKInitOptions, ShoppingCTAButtonConfiguration, ShoppingCTAButtonText, ShoppingCTACallback, ShoppingCTAEvent, ShoppingCTAResult, StoryBlock, StoryBlockConfiguration, StoryBlockSource, TrackPurchaseParameters, UpdateProductDetailsCallback, UpdateProductDetailsEvent, VastAttribute, VideoFeed, VideoFeedClickCallback, VideoFeedClickEvent, VideoFeedConfiguration, VideoFeedMode, VideoFeedPadding, VideoFeedPlayIconConfiguration, VideoFeedSource, VideoFeedTitleConfiguration, VideoFeedTitlePosition, VideoLaunchBehavior, VideoPlaybackCallback, VideoPlaybackDetails, VideoPlaybackEvent, VideoPlaybackEventName, VideoPlayerCompleteAction, VideoPlayerConfiguration, VideoPlayerCTADelay, VideoPlayerCTADelayType, VideoPlayerCTAStyle, VideoPlayerCTAWidth, VideoPlayerSize, VideoPlayerStyle, VideoShopping, };

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

@@ -0,0 +1,8 @@
+export interface RNAppProps {
+    initialRouteName?: string;
+    initialParams?: any;
+}
+export default interface PushRNContainerParams {
+    appKey: string;
+    appProps?: RNAppProps;
+}

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

@@ -1,5 +1,8 @@
 import { NativeEventEmitter, NativeModule } from 'react-native';
+import type PushRNContainerParams from '../models/PushRNContainerParams';
 interface IFWNavigatorModule extends NativeModule {
+    pushRNContainer(params: PushRNContainerParams): Promise<boolean>;
+    popRNContainer(): Promise<boolean>;
     popNativeContainer(): Promise<boolean>;
     canPopNativeContainer(): Promise<boolean>;
     startFloatingPlayer(): Promise<boolean>;

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

@@ -6,6 +6,7 @@ import type VideoPlayerNativeConfiguration from '../models/VideoPlayerNativeConf
 interface IFireworkSDKModule extends NativeModule {
     init(options?: SDKInitOptions): Promise<any>;
     openVideoPlayer(url: string, config?: VideoPlayerNativeConfiguration): void;
+    setVideoFeedClickCallbackEnabled(enabled: boolean): void;
     setCustomCTAClickEnabled(enabled: boolean): void;
     setShareBaseURL(url?: string): Promise<any>;
     setVideoPlaybackEventEnabled(enabled: boolean): void;

package/package.json

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

package/src/FWNavigator.ts

@@ -1,4 +1,5 @@
 import { FWEventName } from './models/FWEventName';
+import type PushRNContainerParams from './models/PushRNContainerParams';
 import FWNavigatorModule, {
   FWNavigatorModuleEventEmitter,
 } from './modules/FWNavigatorModule';
@@ -22,6 +23,25 @@ class FWNavigator {
     FWNavigatorModuleEventEmitter.addListener(FWEventName.LogMessage, () => {});
   }
 
+  /**
+   * Push a new RN container.
+   * You could use this method to make a RN page on top of
+   * SDK full-screen player.
+   * @param params {PushRNContainerParams}
+   * @returns {Promise<boolean>} The result of pushing a new Container.
+   */
+  public pushRNContainer(params: PushRNContainerParams): Promise<boolean> {
+    return FWNavigatorModule.pushRNContainer(params);
+  }
+
+  /**
+   * Pop the RN container you pushed before.
+   * @returns {Promise<boolean>} The result of popping a new Container.
+   */
+  public popRNContainer(): Promise<boolean> {
+    return FWNavigatorModule.popRNContainer();
+  }
+
   /**
    * 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,

package/src/FireworkSDK.ts

@@ -48,7 +48,16 @@ class FireworkSDK {
   /**
    * the callback of clicking Video Feed.
    */
-  public onVideoFeedClick?: VideoFeedClickCallback;
+  public get onVideoFeedClick(): VideoFeedClickCallback | undefined {
+    return this._onVideoFeedClick;
+  }
+  public set onVideoFeedClick(value: VideoFeedClickCallback | undefined) {
+    this._onVideoFeedClick = value;
+    if (Platform.OS === 'ios') {
+      FireworkSDKModule.setVideoFeedClickCallbackEnabled(!!value);
+    }
+  }
+  private _onVideoFeedClick?: VideoFeedClickCallback | undefined;
 
   /**
    * The callback of clicking custom CTA.

package/src/index.ts

@@ -57,6 +57,8 @@ import type {
 } from './models/ProductInfoViewConfiguration';
 import type ProductUnit from './models/ProductUnit';
 import type { ProductPrice, ProductUnitOption } from './models/ProductUnit';
+import type PushRNContainerParams from './models/PushRNContainerParams';
+import type { RNAppProps } from './models/PushRNContainerParams';
 import type SDKInitOptions from './models/SDKInitOptions';
 import type { VideoLaunchBehavior } from './models/SDKInitOptions';
 import type ShoppingCTAResult from './models/ShoppingCTAResult';
@@ -131,6 +133,8 @@ export {
   ProductPrice,
   ProductUnit,
   ProductUnitOption,
+  PushRNContainerParams,
+  RNAppProps,
   SDKInitCallback,
   SDKInitEvent,
   SDKInitOptions,

package/src/models/PushRNContainerParams.ts

@@ -0,0 +1,9 @@
+export interface RNAppProps {
+  initialRouteName?: string;
+  initialParams?: any;
+}
+
+export default interface PushRNContainerParams {
+  appKey: string;
+  appProps?: RNAppProps;
+}

package/src/modules/FWNavigatorModule.ts

@@ -1,6 +1,7 @@
-import { NativeEventEmitter, NativeModule } from 'react-native';
-import { NativeModules } from 'react-native';
+import { NativeEventEmitter, NativeModule, NativeModules } from 'react-native';
+
 import { LINKING_ERROR } from '../constants/FWErrorMessage';
+import type PushRNContainerParams from '../models/PushRNContainerParams';
 
 const FWNavigatorModule = NativeModules.FWNavigatorModule
   ? NativeModules.FWNavigatorModule
@@ -13,6 +14,8 @@ const FWNavigatorModule = NativeModules.FWNavigatorModule
       }
     );
 interface IFWNavigatorModule extends NativeModule {
+  pushRNContainer(params: PushRNContainerParams): Promise<boolean>;
+  popRNContainer(): Promise<boolean>;
   popNativeContainer(): Promise<boolean>;
   canPopNativeContainer(): Promise<boolean>;
   startFloatingPlayer(): Promise<boolean>;

package/src/modules/FireworkSDKModule.ts

@@ -20,6 +20,7 @@ const FireworkSDKModule = NativeModules.FireworkSDK
 interface IFireworkSDKModule extends NativeModule {
   init(options?: SDKInitOptions): Promise<any>;
   openVideoPlayer(url: string, config?: VideoPlayerNativeConfiguration): void;
+  setVideoFeedClickCallbackEnabled(enabled: boolean): void; // Only supported on iOS
   setCustomCTAClickEnabled(enabled: boolean): void;
   setShareBaseURL(url?: string): Promise<any>;
   setVideoPlaybackEventEnabled(enabled: boolean): void;