react-native-firework-sdk 1.0.4 → 1.1.0

package/src/models/FWEventName.ts

@@ -0,0 +1,14 @@
+export enum FWEventName {
+  SDKInit = 'fw:sdk-init',
+  CustomCTAClick = 'fw:custom-cta-click',
+  VideoPlayback = 'fw:video-playback',
+  VideoFeedClick = 'fw:video-feed-click',
+  AddToCart = 'fw:shopping:add-to-cart',
+  ClickCartIcon = 'fw:shopping:click-cart-icon',
+  UpdateProductDetails = 'fw:shopping:update-product-details',
+  WillDisplayProduct = 'fw:shopping:will-display-product',
+  onLiveStreamEvent = 'fw:livestream',
+  onLiveStreamChatEvent = 'fw:livestream-chat',
+  ShareBaseURLUpdated = 'fw:share-base-url-updated',
+  AdBadgeConfigurationUpdated = 'fw:ad-badge-configuration-updated',
+}

package/src/models/FWEvents.ts

@@ -2,17 +2,10 @@ import type VideoPlaybackDetails from './VideoPlaybackDetails';
 import type FWError from './FWError';
 import type VideoPlaybackEventName from './VideoPlaybackEventName';
 import type FeedItemDetails from './FeedItemDetails';
-
-export enum FWEventName {
-  SDKInit = 'fw:sdk-init',
-  CustomCTAClick = 'fw:custom-cta-click',
-  VideoPlayback = 'fw:video-playback',
-  VideoFeedClick = 'fw:video-feed-click',
-  AddToCart = 'fw:shopping:add-to-cart',
-  ClickCartIcon = 'fw:shopping:click-cart-icon',
-  UpdateProductDetails = 'fw:shopping:update-product-details',
-  WillDisplayProduct = 'fw:shopping:will-display-product',
-}
+import type LiveStreamMessageDetails from './LiveStreamMessageDetails';
+import type LiveStreamChatEventName from './LiveStreamChatEventName';
+import type LiveStreamEventDetails from './LiveStreamEventDetails';
+import type LiveStreamEventName from './LiveStreamEventName';
 
 export interface SDKInitEvent {
   /**
@@ -50,9 +43,9 @@ export interface AddToCartEvent {
 
 export interface UpdateProductDetailsEvent {
   /**
-   * A unique identifier of the product.
+   * A unique identifier list of the products.
    */
-  productId: string;
+  productIds: string[];
 }
 
 export interface WillDisplayProductEvent {
@@ -60,4 +53,15 @@ export interface WillDisplayProductEvent {
    * A unique identifier of the video.
    */
   videoId: string;
+}
+
+export interface LiveStreamEvent {
+  eventName: LiveStreamEventName;
+  info: LiveStreamEventDetails;
+}
+
+export interface LiveStreamChatEvent {
+  eventName: LiveStreamChatEventName;
+  message: LiveStreamMessageDetails;
+  liveStream: LiveStreamEventDetails;
 }

package/src/models/FeedItemDetails.ts

@@ -1,14 +1,22 @@
+import type VideoFeedSource from '../models/VideoFeedSource';
+
 export default interface FeedItemDetails {
   /**
-   * The index of the thumbnail tapped in the video feed.
+   * The index of the thumbnail tapped in the feed.
    */
   index: number;
   /**
-   * A unique id for the video.
+   * The unique id of the thumbnail.
+   * If the source is `playlistGroup` this value will represent the playlist's id; otherwise this value is the id of the selected video.
    */
-  videoId: string;
+  id: string;
   /**
-   * The total duration of the video
+   * The total duration of the video.
+   * If the source is `playlistGroup` this value will always be 0; otherwise this value is the duration of the selected video.
    */
   duration: number;
+  /**
+   * The content source of the feed.
+   */
+  source: VideoFeedSource;
 }

package/src/models/LiveStreamChatEventName.ts

@@ -0,0 +1,8 @@
+enum LiveStreamChatEventName {
+  /**
+   * Called when a user sends messages to an active live stream.
+   */
+  userSendChat = 'fw:livestream:user-send-chat',
+}
+
+export default LiveStreamChatEventName;

package/src/models/LiveStreamEventDetails.ts

@@ -0,0 +1,4 @@
+export default interface LiveStreamEventDetails {
+  /// A unique identifier of the live stream.
+  id: string;
+}

package/src/models/LiveStreamEventName.ts

@@ -0,0 +1,16 @@
+enum LiveStreamEventName {
+  /**
+   * Called when a user joins an active live stream.
+   */
+  userDidjoin = 'fw:livestream:user-join',
+  /**
+   * Called when the user leaves an active live stream.
+   */
+  userDidLeave = 'fw:livestream:user-leave',
+  /**
+   * Called when a user sends a like to an active live stream.
+   */
+  userSendLike = 'fw:livestream:user-send-like',
+}
+
+export default LiveStreamEventName;

package/src/models/LiveStreamMessageDetails.ts

@@ -0,0 +1,14 @@
+export default interface LiveStreamMessageDetails {
+  /**
+   * A unique identifier of the message.
+   */
+  messageId: string;
+  /**
+   * The username of the user.
+   */
+  username?: string | null;
+  /**
+   * The text of the message.
+   */
+  text?: string | null;
+}

package/src/models/VideoFeedConfiguration.ts

@@ -13,11 +13,11 @@ export type VideoFeedTitlePosition = 'stacked' | 'nested';
 
 export default interface VideoFeedConfiguration {
   /**
-   * BackgroundColor of video feed.
+   * Background color of video feed.
    */
   backgroundColor?: string;
   /**
-   * CornerRadius of video feed. Only supported on iOS.
+   * Corner radius of video feed. Only supported on iOS.
    */
   cornerRadius?: number;
   /**
@@ -25,11 +25,15 @@ export default interface VideoFeedConfiguration {
    */
   title?: VideoFeedTitleConfiguration;
   /**
-   * Configuration of video feed title position.
+   * Title position of video feed.
    */
   titlePosition?: VideoFeedTitlePosition;
   /**
    * Configuration of video feed play icon. Only supported on iOS.
    */
   playIcon?: VideoFeedPlayIconConfiguration;
+  /**
+   * Indicates if the video feed shows ad badge. 
+   */
+  showAdBadge?: boolean;
 }

package/src/models/VideoFeedSource.ts

@@ -0,0 +1,2 @@
+type VideoFeedSource = 'discover' | 'channel' | 'playlist' | 'playlistGroup';
+export default VideoFeedSource;

package/src/models/VideoPlaybackDetails.ts

@@ -3,8 +3,6 @@ export interface VideoPlayerSize {
   height: number;
 }
 
-export type VideoBadge = 'ad' | 'demo' | 'featured';
-
 export default interface VideoPlaybackDetails {
   /**
    * A unique identifier of the video.
@@ -21,7 +19,7 @@ export default interface VideoPlaybackDetails {
   /**
    * Video badge type.
    */
-  badge?: VideoBadge | null;
+  badge?: string | null;
   /**
    * The size of the player.
    */

package/src/models/VideoPlaybackEventName.ts

@@ -24,7 +24,7 @@ enum VideoPlaybackEventName {
    */
   Complete = 'fw:video:complete',
   /**
-   * When ad video finishes playing
+   * When ad video finishes playing.
    */
   AdEnd = 'fw:video:ad-end',
   /**

package/src/models/VideoPlayerConfiguration.ts

@@ -6,6 +6,8 @@ export interface VideoPlayerCTAStyle {
   fontSize?: number;
 }
 
+export type VideoLaunchBehavior = 'default' | 'muteOnFirstLaunch';
+
 export default interface VideoPlayerConfiguration {
   /**
    * Sets the proportion of the video player to its container.
@@ -23,4 +25,16 @@ export default interface VideoPlayerConfiguration {
    * The style of CTA button style. Only supported on iOS.
    */
   ctaButtonStyle?: VideoPlayerCTAStyle;
+  /**
+   * Indicates if the video player shows playback button. 
+   */
+  showPlaybackButton?: boolean;
+  /**
+   * Indicates if the video player shows mute button. 
+   */
+  showMuteButton?: boolean;
+  /**
+   * The property is valid only if showMuteButton is true.
+   */
+  launchBehavior?: VideoLaunchBehavior;
 }

package/src/modules/FireworkSDKModule.ts

@@ -1,8 +1,9 @@
-import type { NativeModule } from 'react-native';
+import { NativeEventEmitter, NativeModule } from 'react-native';
 import { NativeModules } from 'react-native';
+import type AdBadgeConfiguration from 'src/models/AdBadgeConfiguration';
 
 import { LINKING_ERROR } from '../constants/FWErrorMessage';
-import type ADConfig from '../models/ADConfig';
+import type AdConfig from '../models/AdConfig';
 import type VideoPlayerConfiguration from '../models/VideoPlayerConfiguration';
 
 const FireworkSDKModule = NativeModules.FireworkSDK
@@ -17,11 +18,16 @@ const FireworkSDKModule = NativeModules.FireworkSDK
     );
 
 interface IFireworkSDKModule extends NativeModule {
-  init(userId?: string, adConfig?: ADConfig): void;
+  init(userId?: string, adConfig?: AdConfig): void;
   openVideoPlayer(url: string, config?: VideoPlayerConfiguration): void;
   setCustomCTAClickEnabled(enabled: boolean): void;
-  setShareBaseURL(url?: string): void;
+  setShareBaseURL(url?: string): Promise<any>;
   setVideoPlaybackEventEnabled(enabled: boolean): void;
+  setAdBadgeConfiguration(config?: AdBadgeConfiguration): Promise<any>;
 }
 
+const FireworkSDKModuleEventEmitter = new NativeEventEmitter(FireworkSDKModule);
+export {
+  FireworkSDKModuleEventEmitter,
+}
 export default FireworkSDKModule as IFireworkSDKModule;

package/src/modules/LiveStreamModule.ts

@@ -0,0 +1,26 @@
+import {
+  NativeEventEmitter,
+  NativeModule,
+  NativeModules,
+} from 'react-native';
+
+import { LINKING_ERROR } from '../constants/FWErrorMessage';
+
+const LiveStreamModule = NativeModules.LiveStreamModule
+  ? NativeModules.LiveStreamModule
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
+
+interface ILiveStreamModule extends NativeModule {
+  init(): void;
+}
+const LiveStreamModuleEventEmitter = new NativeEventEmitter(LiveStreamModule);
+export { LiveStreamModuleEventEmitter };
+
+export default LiveStreamModule as ILiveStreamModule;

package/src/modules/ShoppingModule.ts

@@ -1,7 +1,4 @@
-import {
-  NativeModule,
-  NativeModules,
-} from 'react-native';
+import { NativeEventEmitter, NativeModule, NativeModules } from 'react-native';
 import type Product from '../models/Product';
 import type ProductInfoViewConfiguration from '../models/ProductInfoViewConfiguration';
 import { LINKING_ERROR } from '../constants/FWErrorMessage';
@@ -19,13 +16,23 @@ const ShoppingModule = NativeModules.ShoppingModule
 
 interface IShoppingModule extends NativeModule {
   init(): void;
-  updateVideoProduct(production: Product, callbackId: number | string): void;
-  updateProductViewConfig(config: ProductInfoViewConfiguration, callbackId: number | string): void;
-  updateAddToCartStatus(res: string, tips: string, callbackId: number | string): 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): void;
   exitCartPage(): void;
   setCartIconVisible(visible: boolean): void;
   setCartItemCount(count: number): void;
 }
 
+const ShoppingModuleEventEmitter = new NativeEventEmitter(ShoppingModule);
+export { ShoppingModuleEventEmitter };
+
 export default ShoppingModule as IShoppingModule;

package/android/src/main/java/com/reactnativefireworksdk/components/videofeed/FWVideoFeed.kt

@@ -1,124 +0,0 @@
-package com.reactnativefireworksdk.components.videofeed
-
-import android.app.Activity
-import android.graphics.Color
-import android.util.AttributeSet
-import android.view.LayoutInflater
-import android.widget.RelativeLayout
-import com.facebook.react.uimanager.ThemedReactContext
-import com.loopnow.fireworklibrary.FeedType
-import com.loopnow.fireworklibrary.models.FeedLayout
-import com.loopnow.fireworklibrary.models.FeedTitlePosition
-import com.loopnow.fireworklibrary.views.OnItemClickedListener
-import com.loopnow.fireworklibrary.views.VideoFeedView
-import com.reactnativefireworksdk.R
-import com.reactnativefireworksdk.models.*
-import com.reactnativefireworksdk.utils.FWEventUtils
-import com.reactnativefireworksdk.utils.FWVideoPlayerUtils
-
-
-class FWVideoFeed(
-  context: ThemedReactContext,
-  attrs: AttributeSet?
-) : RelativeLayout(context, attrs) {
-
-//  private val reactContext: ReactContext = context.reactApplicationContext
-  private val activity: Activity = context.currentActivity as Activity
-
-  private val videoFeedView: VideoFeedView
-  private var channelId: String? = null
-  private var playlistId: String? = null
-  private var feedType: FeedType? = null
-  private var feedLayout: FeedLayout? = null
-  private var titlePosition: FeedTitlePosition? = null
-
-  constructor(context: ThemedReactContext) : this(context, null)
-
-  init {
-    val view = LayoutInflater.from(activity).inflate(R.layout.fwrn_fragment_videofeed, this, true)
-    videoFeedView = view.findViewById(R.id.fwrn_integrated_videofeed)
-    videoFeedView.addOnItemClickedListener(object: OnItemClickedListener {
-      override fun onItemClicked(index: Int, title: String, id: String, videoDuration: Long) {
-        val fwVideoFeedItemDetailsModel = FWVideoFeedItemDetailsModel(index, id, videoDuration.toInt())
-        FWEventUtils.sendVideoFeedClickEvent(context, fwVideoFeedItemDetailsModel)
-      }
-
-      override fun onItemClicked(index: Int) {
-        super.onItemClicked(index)
-      }
-
-      override fun onItemClicked(index: Int, feedId: Int): Boolean {
-        return super.onItemClicked(index, feedId)
-      }
-    })
-  }
-
-  fun setSource(source: String?) {
-    feedType = when {
-      source.equals(FWVideoFeedSource.Channel.rawValue) -> {
-        FeedType.CHANNEL
-      }
-      source.equals(FWVideoFeedSource.Playlist.rawValue) -> {
-        FeedType.PLAYLIST
-      }
-      else -> {
-        FeedType.DISCOVER
-      }
-    }
-    setFeed(channelId, playlistId, feedType)
-  }
-
-  fun setChannel(channel: String?) {
-    channelId = channel
-    setFeed(channelId, playlistId, feedType)
-  }
-
-  fun setPlaylist(playlist: String?) {
-    playlistId = playlist
-    setFeed(channelId, playlistId, feedType)
-  }
-
-  fun setMode(mode: String?) {
-    feedLayout = when {
-      mode.equals(FWVideoFeedMode.Column.rawValue) -> FeedLayout.VERTICAL
-      mode.equals(FWVideoFeedMode.Grid.rawValue) -> FeedLayout.GRID
-      else -> FeedLayout.HORIZONTAL
-    }
-    videoFeedView.setLayout(feedLayout)
-  }
-
-  fun setVideoFeedConfig(config: FWVideoFeedConfigModel?) {
-    val backgroundColor = config?.backgroundColor
-    if (!backgroundColor.isNullOrBlank()) {
-      videoFeedView.setBackgroundColor(Color.parseColor(backgroundColor))
-    } else {
-      videoFeedView.setBackgroundColor(Color.TRANSPARENT)
-    }
-
-    videoFeedView.setTitleVisible(config?.title?.hidden != true)
-
-    titlePosition = when {
-      config?.titlePosition.equals(FWVideoFeedTitlePosition.Stacked.rawValue) -> FeedTitlePosition.BELOW
-      else -> FeedTitlePosition.ALIGN_BOTTOM
-    }
-    videoFeedView.setTitlePosition(titlePosition)
-  }
-
-  fun setVideoPlayerConfig(config: FWVideoPlayerConfigModel?) {
-    FWVideoPlayerUtils.setVideoPlayerConfig(config)
-  }
-
-  fun refresh() {
-    videoFeedView.refreshFeed()
-  }
-
-  private fun setFeed(channelId: String?, playlistId: String?, feedType: FeedType?) {
-    if (feedType == FeedType.CHANNEL && !channelId.isNullOrBlank()) {
-      videoFeedView.setFeed(channelId, null, FeedType.CHANNEL)
-    } else if (feedType == FeedType.PLAYLIST && !channelId.isNullOrBlank() && !playlistId.isNullOrBlank()) {
-      videoFeedView.setFeed(channelId, playlistId, FeedType.PLAYLIST)
-    } else {
-      videoFeedView.setFeed(null, null, FeedType.DISCOVER)
-    }
-  }
-}

package/android/src/main/java/com/reactnativefireworksdk/manager/FWVideoFeedManager.kt

@@ -1,88 +0,0 @@
-package com.reactnativefireworksdk.manager
-
-import com.facebook.react.bridge.ReadableArray
-import com.facebook.react.bridge.ReadableMap
-import com.facebook.react.uimanager.SimpleViewManager
-import com.facebook.react.uimanager.ThemedReactContext
-
-import com.facebook.react.uimanager.annotations.ReactProp
-import com.reactnativefireworksdk.constants.FWCommandConstant
-import com.reactnativefireworksdk.models.FWVideoFeedConfigModel
-import com.reactnativefireworksdk.models.FWVideoPlayerConfigModel
-import com.reactnativefireworksdk.utils.FWJsonUtils
-import com.facebook.react.common.MapBuilder
-import com.reactnativefireworksdk.components.videofeed.FWVideoFeed
-import com.reactnativefireworksdk.models.FWFeedViewEventName
-
-
-class FWVideoFeedManager : SimpleViewManager<FWVideoFeed>() {
-
-  override fun getName(): String {
-    return "FWVideoFeed"
-  }
-
-  override fun createViewInstance(reactContext: ThemedReactContext): FWVideoFeed {
-    // currentActivity cannot be null
-    return FWVideoFeed(reactContext)
-  }
-
-  @ReactProp(name = "source")
-  fun setSource(view: FWVideoFeed, source: String?) {
-    view.setSource(source)
-  }
-
-  @ReactProp(name = "channel")
-  fun setChannel(view: FWVideoFeed, channel: String?) {
-    view.setChannel(channel)
-  }
-
-  @ReactProp(name = "playlist")
-  fun setPlaylist(view: FWVideoFeed, playlist: String?) {
-    view.setPlaylist(playlist)
-  }
-
-  @ReactProp(name = "mode")
-  fun setMode(view: FWVideoFeed, mode: String?) {
-    view.setMode(mode)
-  }
-
-  @ReactProp(name = "videoFeedConfiguration")
-  fun setVideoFeedConfig(view: FWVideoFeed, config: ReadableMap?) {
-    val configMap = config?.toHashMap()
-    val videoFeedConfigModel = FWJsonUtils.fromMap(configMap, FWVideoFeedConfigModel::class.java)
-    view.setVideoFeedConfig(videoFeedConfigModel)
-  }
-
-  @ReactProp(name = "videoPlayerConfiguration")
-  fun setVideoPlayerConfig(view: FWVideoFeed, config: ReadableMap?) {
-    val configMap = config?.toHashMap()
-    val videoPlayerConfigModel = FWJsonUtils.fromMap(configMap, FWVideoPlayerConfigModel::class.java)
-    view.setVideoPlayerConfig(videoPlayerConfigModel)
-  }
-
-  override fun getCommandsMap(): MutableMap<String, Int> {
-    val map: MutableMap<String, Int> = HashMap()
-    map["refresh"] = FWCommandConstant.FW_COMMAND_VIDEO_FEED_REFRESH
-    return map
-  }
-
-  override fun receiveCommand(root: FWVideoFeed, commandId: Int, args: ReadableArray?) {
-    when (commandId) {
-        FWCommandConstant.FW_COMMAND_VIDEO_FEED_REFRESH -> {
-          root.refresh()
-        }
-    }
-  }
-
-  /**
-   * To map the "onVideoFeedLoadFinished" event name to the "onVideoFeedLoadFinished" callback prop in JavaScript
-   * first onVideoFeedLoadFinished is event name
-   * second onVideoFeedLoadFinished is callback prop in JavaScript
-   */
-  override fun getExportedCustomBubblingEventTypeConstants(): MutableMap<String, Any>? {
-    return MapBuilder.builder<String, Any>()
-      .put(FWFeedViewEventName.VideoFeedLoadFinished.rawValue, MapBuilder.of("phasedRegistrationNames", MapBuilder.of("bubbled", FWFeedViewEventName.VideoFeedLoadFinished.rawValue)))
-      .build()
-  }
-
-}

package/android/src/main/java/com/reactnativefireworksdk/models/FWVideoFeedConfigModel.kt

@@ -1,27 +0,0 @@
-package com.reactnativefireworksdk.models
-
-import android.os.Parcelable
-import kotlinx.android.parcel.Parcelize
-
-@Parcelize
-data class FWVideoFeedConfigModel(
-  val backgroundColor: String?,
-  val cornerRadius: Int?,
-  val title: FWTitleModel?,
-  val titlePosition: String?,
-  val playIcon: FWPlayIconModel?
-) : Parcelable {
-
-  @Parcelize
-  data class FWTitleModel(
-    val hidden: Boolean?,
-    val textColor: String?,
-    val fontSize: Int?,
-  ) : Parcelable
-
-  @Parcelize
-  data class FWPlayIconModel(
-    val hidden: Boolean?,
-    val iconWidth: Int?,
-  ) : Parcelable
-}

package/android/src/main/java/com/reactnativefireworksdk/models/FWVideoFeedMode.kt

@@ -1,7 +0,0 @@
-package com.reactnativefireworksdk.models
-
-enum class FWVideoFeedMode(val rawValue: String) {
-  Row("row"),
-  Column("column"),
-  Grid("grid"),
-}

package/android/src/main/java/com/reactnativefireworksdk/models/FWVideoPlayerConfigModel.kt

@@ -1,20 +0,0 @@
-package com.reactnativefireworksdk.models
-
-import android.os.Parcelable
-import kotlinx.android.parcel.Parcelize
-
-@Parcelize
-data class FWVideoPlayerConfigModel(
-  val playerStyle: String?,
-  val videoCompleteAction: String?,
-  val showShareButton: Boolean?,
-  val ctaButtonStyle: FWCtaButtonStyleModel?
-) : Parcelable {
-
-  @Parcelize
-  data class FWCtaButtonStyleModel(
-    val backgroundColor: String?,
-    val fontSize: String?,
-    val textColor: String?,
-  ) : Parcelable
-}

package/android/src/main/java/com/reactnativefireworksdk/utils/FWVideoPlayerUtils.kt

@@ -1,18 +0,0 @@
-package com.reactnativefireworksdk.utils
-
-import com.loopnow.fireworklibrary.VideoPlayerProperties
-import com.reactnativefireworksdk.constants.FWVideoPlayerConstant
-import com.reactnativefireworksdk.models.FWVideoPlayerConfigModel
-
-object FWVideoPlayerUtils {
-
-  var customCTAClickEnabled: Boolean = false
-  var videoPlaybackEventEnabled: Boolean = false
-
-  fun setVideoPlayerConfig(config: FWVideoPlayerConfigModel?) {
-    VideoPlayerProperties.share = config?.showShareButton != false
-    VideoPlayerProperties.loop = config?.videoCompleteAction != FWVideoPlayerConstant.FW_VIDEO_COMPLETE_ACTION_ADVANCE_TO_NEXT
-//    VideoPlayerProperties.autoPlayOnComplete = config?.videoCompleteAction != FWVideoPlayerConstant.FW_VIDEO_COMPLETE_ACTION_LOOP
-    VideoPlayerProperties.fullScreenPlayer = config?.playerStyle == FWVideoPlayerConstant.FW_PLAYER_STYLE_FULL
-  }
-}

package/lib/commonjs/models/ADConfig.js

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

package/lib/module/models/ADConfig.js

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