react-native-firework-sdk 1.0.0-beta

package/lib/module/index.js

@@ -0,0 +1,10 @@
+import { AppRegistry } from 'react-native';
+import CartContainer from './components/CartContainer';
+import VideoFeed from './components/VideoFeed';
+import FireworkSDK from './FireworkSDK';
+import VideoPlaybackEventName from './models/VideoPlaybackEventName';
+import VideoShopping from './VideoShopping';
+AppRegistry.registerComponent('FWShoppingCartPage', () => CartContainer);
+export default FireworkSDK;
+export { VideoFeed, VideoPlaybackEventName, VideoShopping };
+//# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.tsx"],"names":["AppRegistry","CartContainer","VideoFeed","FireworkSDK","VideoPlaybackEventName","VideoShopping","registerComponent"],"mappings":"AAAA,SAASA,WAAT,QAA4B,cAA5B;AAEA,OAAOC,aAAP,MAA0B,4BAA1B;AAMA,OAAOC,SAAP,MAAsB,wBAAtB;AAOA,OAAOC,WAAP,MAAwB,eAAxB;AAgCA,OAAOC,sBAAP,MAAmC,iCAAnC;AAaA,OAAOC,aAAP,MAA0B,iBAA1B;AAEAL,WAAW,CAACM,iBAAZ,CAA8B,oBAA9B,EAAoD,MAAML,aAA1D;AAEA,eAAeE,WAAf;AAEA,SAsBED,SAtBF,EAiCEE,sBAjCF,EAuCEC,aAvCF","sourcesContent":["import { AppRegistry } from 'react-native';\n\nimport CartContainer from './components/CartContainer';\nimport type {\n  IVideoFeedProps,\n  VideoFeedMode,\n  VideoFeedSource,\n} from './components/VideoFeed';\nimport VideoFeed from './components/VideoFeed';\nimport type {\n  CustomCTAClickCallback,\n  SDKInitCallback,\n  VideoFeedClickCallback,\n  VideoPlaybackCallback,\n} from './FireworkSDK';\nimport FireworkSDK from './FireworkSDK';\nimport type ADConfig from './models/ADConfig';\nimport type AddToCartResult from './models/AddToCartResult';\nimport type FeedItemDetails from './models/FeedItemDetails';\nimport type FWError from './models/FWError';\nimport type {\n  AddToCartEvent,\n  CustomCTAClickEvent,\n  SDKInitEvent,\n  UpdateProductDetailsEvent,\n  VideoPlaybackEvent,\n  WillDisplayProductEvent,\n} from './models/FWEvents';\nimport type Product from './models/Product';\nimport type ProductInfoViewConfiguration from './models/ProductInfoViewConfiguration';\nimport type {\n  AddToCartButtonConfiguration,\n  CartIconConfiguration,\n} from './models/ProductInfoViewConfiguration';\nimport type ProductUnit from './models/ProductUnit';\nimport type { ProductPrice } from './models/ProductUnit';\nimport type VideoFeedConfiguration from './models/VideoFeedConfiguration';\nimport type {\n  VideoFeedPlayIconConfiguration,\n  VideoFeedTitleConfiguration,\n  VideoFeedTitlePosition,\n} from './models/VideoFeedConfiguration';\nimport type VideoPlaybackDetails from './models/VideoPlaybackDetails';\nimport type {\n  VideoBadge,\n  VideoPlayerSize,\n} from './models/VideoPlaybackDetails';\nimport VideoPlaybackEventName from './models/VideoPlaybackEventName';\nimport type VideoPlayerConfiguration from './models/VideoPlayerConfiguration';\nimport type {\n  VideoPlayerCompleteAction,\n  VideoPlayerCTAStyle,\n  VideoPlayerStyle,\n} from './models/VideoPlayerConfiguration';\nimport type {\n  AddToCartCallback,\n  ClickCartIconCallback,\n  UpdateProductDetailsCallback,\n  WillDisplayProductCallback,\n} from './VideoShopping';\nimport VideoShopping from './VideoShopping';\n\nAppRegistry.registerComponent('FWShoppingCartPage', () => CartContainer);\n\nexport default FireworkSDK;\n\nexport {\n  ADConfig,\n  AddToCartButtonConfiguration,\n  AddToCartCallback,\n  AddToCartEvent,\n  AddToCartResult,\n  CartIconConfiguration,\n  ClickCartIconCallback,\n  CustomCTAClickCallback,\n  CustomCTAClickEvent,\n  FeedItemDetails,\n  FWError,\n  IVideoFeedProps,\n  Product,\n  ProductInfoViewConfiguration,\n  ProductPrice,\n  ProductUnit,\n  SDKInitCallback,\n  SDKInitEvent,\n  UpdateProductDetailsCallback,\n  UpdateProductDetailsEvent,\n  VideoBadge,\n  VideoFeed,\n  VideoFeedClickCallback,\n  VideoFeedConfiguration,\n  VideoFeedMode,\n  VideoFeedPlayIconConfiguration,\n  VideoFeedSource,\n  VideoFeedTitleConfiguration,\n  VideoFeedTitlePosition,\n  VideoPlaybackCallback,\n  VideoPlaybackDetails,\n  VideoPlaybackEvent,\n  VideoPlaybackEventName,\n  VideoPlayerCompleteAction,\n  VideoPlayerConfiguration,\n  VideoPlayerCTAStyle,\n  VideoPlayerSize,\n  VideoPlayerStyle,\n  VideoShopping,\n  WillDisplayProductCallback,\n  WillDisplayProductEvent,\n};\n"]}

package/lib/module/models/ADConfig.js

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

package/lib/module/models/ADConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/AddToCartResult.js

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

package/lib/module/models/AddToCartResult.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/FWError.js

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

package/lib/module/models/FWError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/FWEvents.js

@@ -0,0 +1,13 @@
+export let FWEventName;
+
+(function (FWEventName) {
+  FWEventName["SDKInit"] = "fw:sdk-init";
+  FWEventName["CustomCTAClick"] = "fw:custom-cta-click";
+  FWEventName["VideoPlayback"] = "fw:video-playback";
+  FWEventName["VideoFeedClick"] = "fw:video-feed-click";
+  FWEventName["AddToCart"] = "fw:shopping:add-to-cart";
+  FWEventName["ClickCartIcon"] = "fw:shopping:click-cart-icon";
+  FWEventName["UpdateProductDetails"] = "fw:shopping:update-product-details";
+  FWEventName["WillDisplayProduct"] = "fw:shopping:will-display-product";
+})(FWEventName || (FWEventName = {}));
+//# sourceMappingURL=FWEvents.js.map

package/lib/module/models/FWEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FWEvents.ts"],"names":["FWEventName"],"mappings":"AAKA,WAAYA,WAAZ;;WAAYA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;AAAAA,EAAAA,W;GAAAA,W,KAAAA,W","sourcesContent":["import type VideoPlaybackDetails from './VideoPlaybackDetails';\nimport type FWError from './FWError';\nimport type VideoPlaybackEventName from './VideoPlaybackEventName';\nimport type FeedItemDetails from './FeedItemDetails';\n\nexport enum FWEventName {\n  SDKInit = 'fw:sdk-init',\n  CustomCTAClick = 'fw:custom-cta-click',\n  VideoPlayback = 'fw:video-playback',\n  VideoFeedClick = 'fw:video-feed-click',\n  AddToCart = 'fw:shopping:add-to-cart',\n  ClickCartIcon = 'fw:shopping:click-cart-icon',\n  UpdateProductDetails = 'fw:shopping:update-product-details',\n  WillDisplayProduct = 'fw:shopping:will-display-product',\n}\n\nexport interface SDKInitEvent {\n  /**\n   * If error equals undefined/null, it means the initialization is successful.\n   */\n  error?: FWError | null;\n}\n\nexport interface CustomCTAClickEvent {\n  /**\n   * Action URL that is associated with this CTA\n   */\n  url: string;\n}\n\nexport interface VideoPlaybackEvent {\n  eventName: VideoPlaybackEventName;\n  info: VideoPlaybackDetails;\n}\n\nexport interface VideoFeedClickEvent {\n  info: FeedItemDetails;\n}\n\nexport interface AddToCartEvent {\n  /**\n   * A unique identifier of the product.\n   */\n  productId: string;\n  /**\n   * A unique identifier of the product unit.\n   */\n  unitId: string;\n}\n\nexport interface UpdateProductDetailsEvent {\n  /**\n   * A unique identifier of the product.\n   */\n  productId: string;\n}\n\nexport interface WillDisplayProductEvent {\n  /**\n   * A unique identifier of the video.\n   */\n  videoId: string;\n}"]}

package/lib/module/models/FeedItemDetails.js

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

package/lib/module/models/FeedItemDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/Product.js

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

package/lib/module/models/Product.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/ProductInfoViewConfiguration.js

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

package/lib/module/models/ProductInfoViewConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/ProductUnit.js

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

package/lib/module/models/ProductUnit.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/VideoFeedConfiguration.js

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

package/lib/module/models/VideoFeedConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/VideoPlaybackDetails.js

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

package/lib/module/models/VideoPlaybackDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/models/VideoPlaybackEventName.js

@@ -0,0 +1,16 @@
+var VideoPlaybackEventName;
+
+(function (VideoPlaybackEventName) {
+  VideoPlaybackEventName["Impression"] = "fw:video:impression";
+  VideoPlaybackEventName["Start"] = "fw:video:start";
+  VideoPlaybackEventName["FirstQuartile"] = "fw:video:first-quartile";
+  VideoPlaybackEventName["Midpoint"] = "fw:video:midpoint";
+  VideoPlaybackEventName["ThirdQuartile"] = "fw:video:third-quartile";
+  VideoPlaybackEventName["Complete"] = "fw:video:complete";
+  VideoPlaybackEventName["AdEnd"] = "fw:video:ad-end";
+  VideoPlaybackEventName["ClickCTA"] = "fw:video:click-cta";
+  VideoPlaybackEventName["ClickShare"] = "fw:video:click-share";
+})(VideoPlaybackEventName || (VideoPlaybackEventName = {}));
+
+export default VideoPlaybackEventName;
+//# sourceMappingURL=VideoPlaybackEventName.js.map

package/lib/module/models/VideoPlaybackEventName.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["VideoPlaybackEventName.ts"],"names":["VideoPlaybackEventName"],"mappings":"IAAKA,sB;;WAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;GAAAA,sB,KAAAA,sB;;AAuCL,eAAeA,sBAAf","sourcesContent":["enum VideoPlaybackEventName {\n  /**\n   * When video is shown to the user.\n   */\n  Impression = 'fw:video:impression',\n  /**\n   * Video started.\n   */\n  Start = 'fw:video:start',\n  /**\n   * Video reached 25%.\n   */\n  FirstQuartile = 'fw:video:first-quartile',\n  /**\n   * Video reached 50%.\n   */\n  Midpoint = 'fw:video:midpoint',\n  /**\n   * Video reached 75%.\n   */\n  ThirdQuartile = 'fw:video:third-quartile',\n  /**\n   * Video reached 100%.\n   */\n  Complete = 'fw:video:complete',\n  /**\n   * When ad video finishes playing\n   */\n  AdEnd = 'fw:video:ad-end',\n  /**\n   * When a visitor clicks on CTA button (if available).\n   */\n  ClickCTA = 'fw:video:click-cta',\n  /**\n   * When user clicks on \"Share\" button.\n   */\n  ClickShare = 'fw:video:click-share',\n}\n\nexport default VideoPlaybackEventName;\n"]}

package/lib/module/models/VideoPlayerConfiguration.js

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

package/lib/module/models/VideoPlayerConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/modules/FireworkSDKModule.js

@@ -0,0 +1,10 @@
+import { NativeModules } from 'react-native';
+import { LINKING_ERROR } from '../constants/FWErrorMessage';
+const FireworkSDKModule = NativeModules.FireworkSDK ? NativeModules.FireworkSDK : new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+
+});
+export default FireworkSDKModule;
+//# sourceMappingURL=FireworkSDKModule.js.map

package/lib/module/modules/FireworkSDKModule.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["FireworkSDKModule.ts"],"names":["NativeModules","LINKING_ERROR","FireworkSDKModule","FireworkSDK","Proxy","get","Error"],"mappings":"AACA,SAASA,aAAT,QAA8B,cAA9B;AAEA,SAASC,aAAT,QAA8B,6BAA9B;AAIA,MAAMC,iBAAiB,GAAGF,aAAa,CAACG,WAAd,GACtBH,aAAa,CAACG,WADQ,GAEtB,IAAIC,KAAJ,CACE,EADF,EAEE;AACEC,EAAAA,GAAG,GAAG;AACJ,UAAM,IAAIC,KAAJ,CAAUL,aAAV,CAAN;AACD;;AAHH,CAFF,CAFJ;AAmBA,eAAeC,iBAAf","sourcesContent":["import type { NativeModule } from 'react-native';\nimport { NativeModules } from 'react-native';\n\nimport { LINKING_ERROR } from '../constants/FWErrorMessage';\nimport type ADConfig from '../models/ADConfig';\nimport type VideoPlayerConfiguration from '../models/VideoPlayerConfiguration';\n\nconst FireworkSDKModule = NativeModules.FireworkSDK\n  ? NativeModules.FireworkSDK\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\ninterface IFireworkSDKModule extends NativeModule {\n  init(userId?: string, adConfig?: ADConfig): void;\n  openVideoPlayer(url: string, config?: VideoPlayerConfiguration): void;\n  setCustomCTAClickEnabled(enabled: boolean): void;\n  setShareBaseURL(url?: string): void;\n  setVideoPlaybackEventEnabled(enabled: boolean): void;\n}\n\nexport default FireworkSDKModule as IFireworkSDKModule;\n"]}

package/lib/module/modules/ShoppingModule.js

@@ -0,0 +1,10 @@
+import { NativeModules } from 'react-native';
+import { LINKING_ERROR } from '../constants/FWErrorMessage';
+const ShoppingModule = NativeModules.ShoppingModule ? NativeModules.ShoppingModule : new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+
+});
+export default ShoppingModule;
+//# sourceMappingURL=ShoppingModule.js.map

package/lib/module/modules/ShoppingModule.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["ShoppingModule.ts"],"names":["NativeModules","LINKING_ERROR","ShoppingModule","Proxy","get","Error"],"mappings":"AAAA,SAEEA,aAFF,QAGO,cAHP;AAMA,SAASC,aAAT,QAA8B,6BAA9B;AAEA,MAAMC,cAAc,GAAGF,aAAa,CAACE,cAAd,GACnBF,aAAa,CAACE,cADK,GAEnB,IAAIC,KAAJ,CACE,EADF,EAEE;AACEC,EAAAA,GAAG,GAAG;AACJ,UAAM,IAAIC,KAAJ,CAAUJ,aAAV,CAAN;AACD;;AAHH,CAFF,CAFJ;AAoBA,eAAeC,cAAf","sourcesContent":["import {\n  NativeModule,\n  NativeModules,\n} from 'react-native';\nimport type Product from '../models/Product';\nimport type ProductInfoViewConfiguration from '../models/ProductInfoViewConfiguration';\nimport { LINKING_ERROR } from '../constants/FWErrorMessage';\n\nconst ShoppingModule = NativeModules.ShoppingModule\n  ? NativeModules.ShoppingModule\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\ninterface IShoppingModule extends NativeModule {\n  init(): void;\n  updateVideoProduct(production: Product, callbackId: number): void;\n  updateProductViewConfig(config: ProductInfoViewConfiguration, callbackId: number): void;\n  updateAddToCartStatus(res: string, tips: string, callbackId: number): void;\n  jumpToCartPage(callbackId: number): void;\n  exitCartPage(): void;\n}\n\nexport default ShoppingModule as IShoppingModule;\n"]}

package/lib/typescript/FireworkSDK.d.ts

@@ -0,0 +1,74 @@
+import type ADConfig from './models/ADConfig';
+import type { CustomCTAClickEvent, SDKInitEvent, VideoPlaybackEvent } from './models/FWEvents';
+import { VideoFeedClickEvent } from './models/FWEvents';
+import type VideoPlayerConfiguration from './models/VideoPlayerConfiguration';
+import VideoShopping from './VideoShopping';
+export declare type SDKInitCallback = (event: SDKInitEvent) => void;
+export declare type CustomCTAClickCallback = (event: CustomCTAClickEvent) => void;
+export declare type VideoPlaybackCallback = (event: VideoPlaybackEvent) => void;
+export declare type VideoFeedClickCallback = (event: VideoFeedClickEvent) => void;
+/**
+ * Entry class of Firework SDK, which supports the sdk initialization and global configuration.
+ */
+declare class FireworkSDK {
+    private static _instance?;
+    private _onCustomCTAClick;
+    private _onVideoPlayback?;
+    /**
+     * Clicking Video Feed callback
+     */
+    onVideoFeedClick?: VideoFeedClickCallback;
+    private _shareBaseURL;
+    /**
+     * SDK initialization callback.
+     */
+    onSDKInit?: SDKInitCallback;
+    /**
+     * Get Custom Clicking CTA callback.
+     */
+    get onCustomCTAClick(): CustomCTAClickCallback | undefined;
+    /**
+     * Set Custom Clicking CTA callback.
+     */
+    set onCustomCTAClick(value: CustomCTAClickCallback | undefined);
+    /**
+     * Get Video Playback callback.
+     */
+    get onVideoPlayback(): VideoPlaybackCallback | undefined;
+    /**
+     * Set Video Playback callback.
+     */
+    set onVideoPlayback(value: VideoPlaybackCallback | undefined);
+    /**
+     * get Share Base URL
+     */
+    get shareBaseURL(): string | undefined;
+    /**
+     * set Share Base URL
+     */
+    set shareBaseURL(value: string | undefined);
+    private eventEmitter;
+    /**
+     * Get VideoShopping object.
+     */
+    get shopping(): VideoShopping;
+    /**
+     * Get global single instance of FireworkSDK class.
+     * @returns FireworkSDK
+     */
+    static getInstance(): FireworkSDK;
+    private constructor();
+    /**
+     * Initializes Firework SDK.
+     * @param {string?} userId An id to uniquely identify device or user.
+     * @param {ADConfig?} adConfig Configuration of Ad.
+     */
+    init(userId?: string, adConfig?: ADConfig): void;
+    /**
+     * Open Video URL.
+     * @param {string} url
+     * @param {VideoPlayerConfiguration} config
+     */
+    openVideoPlayer(url: string, config?: VideoPlayerConfiguration): void;
+}
+export default FireworkSDK;

package/lib/typescript/VideoShopping.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="react" />
+import type AddToCartResult from './models/AddToCartResult';
+import { AddToCartEvent, UpdateProductDetailsEvent, WillDisplayProductEvent } from './models/FWEvents';
+import type Product from './models/Product';
+import type ProductInfoViewConfiguration from './models/ProductInfoViewConfiguration';
+export declare type AddToCartCallback = (event: AddToCartEvent) => Promise<AddToCartResult | undefined | null>;
+export declare type ClickCartIconCallback = () => Promise<React.ReactNode | undefined | null>;
+export declare type UpdateProductDetailsCallback = (event: UpdateProductDetailsEvent) => Promise<Product | undefined | null>;
+export declare type WillDisplayProductCallback = (event: WillDisplayProductEvent) => Promise<ProductInfoViewConfiguration | undefined | null>;
+/**
+ * Entry class of Video Shopping
+ */
+declare class VideoShopping {
+    private static _instance?;
+    /**
+     * This callback is triggered when the user clicks the "Add to cart" button.
+     *
+     * The host app can return an AddToCartResult object to tell FireworkSDK the result of adding to cart.
+     */
+    onAddToCart?: AddToCartCallback;
+    /**
+     * This callback is triggered when the user clicks the shopping cart icon.
+     *
+     * The host app can return a React.Node to integrate custom cart page to shopping flow.
+     */
+    onClickCartIcon?: ClickCartIconCallback;
+    /**
+     * This callback is triggered when the video will be shown.
+     *
+     * The host app can return a Product object to update the latest product information.
+     */
+    onUpdateProductDetails?: UpdateProductDetailsCallback;
+    /**
+     * This callback is triggered when the product will be shown.
+     *
+     * The host app can return a ProductInfoViewConfiguration object to configure "Add to cart" button style and cart icon style.
+     */
+    onWillDisplayProduct?: WillDisplayProductCallback;
+    currentCartPage?: React.ReactNode;
+    private eventEmitter;
+    static getInstance(): VideoShopping;
+    private constructor();
+    /**
+     * Exit Cart Page.
+     *
+     * The host app can call this method to exit their cart page.
+     */
+    exitCartPage(): void;
+    private handleAddToCartEvent;
+    private handleClickCartIconEvent;
+    private handleUpdateProductDetailsEvent;
+    private handleWillDisplayProductEvent;
+}
+export default VideoShopping;

package/lib/typescript/components/CartContainer.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const CartContainer: () => JSX.Element;
+export default CartContainer;

package/lib/typescript/components/FWVideoFeed.d.ts

@@ -0,0 +1,2 @@
+declare const FWVideoFeed: import("react-native").HostComponent<any> | (() => never);
+export default FWVideoFeed;

package/lib/typescript/components/VideoFeed.d.ts

@@ -0,0 +1,53 @@
+import React from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+import type VideoPlayerConfiguration from '../models/VideoPlayerConfiguration';
+import type VideoFeedConfiguration from '../models/VideoFeedConfiguration';
+import type FWError from '../models/FWError';
+export declare type VideoFeedSource = 'discover' | 'channel' | 'playlist';
+export declare type VideoFeedMode = 'row' | 'column' | 'grid';
+export interface IVideoFeedProps {
+    /**
+     * Standard React Native View Style.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * One of three available video feed sources.
+     */
+    source: VideoFeedSource;
+    /**
+     * Channel name from which content should be displayed. Videos are ordered as a channel timeline. The prop is required when the source is set as channel or playlist.
+     */
+    channel?: string;
+    /**
+     * Playlist Id for selected content. Please note channel name is necessary. Required when the source is set as playlist.
+     */
+    playlist?: string;
+    /**
+     * One of three available display modes. Defaults to row.
+     */
+    mode?: VideoFeedMode;
+    /**
+     * Configuration of Video Feed.
+     */
+    videoFeedConfiguration?: VideoFeedConfiguration;
+    /**
+     * Configuration of Video Player.
+     */
+    videoPlayerConfiguration?: VideoPlayerConfiguration;
+    /**
+     * Video feed loading result callback. It means loading successfully when error equals to undefined.
+     */
+    onVideoFeedLoadFinished?: (error?: FWError) => void;
+}
+export default class VideoFeed extends React.Component<IVideoFeedProps> {
+    static defaultProps: {
+        mode: string;
+    };
+    nativeComponentRef: React.RefObject<any>;
+    /**
+     * Force refreshing the video feed.
+     */
+    refresh: () => void;
+    private _onVideoFeedLoadFinished;
+    render(): JSX.Element;
+}

package/lib/typescript/constants/FWErrorMessage.d.ts

@@ -0,0 +1,2 @@
+declare const LINKING_ERROR: string;
+export { LINKING_ERROR, };

package/lib/typescript/index.d.ts

@@ -0,0 +1,25 @@
+import type { IVideoFeedProps, VideoFeedMode, VideoFeedSource } from './components/VideoFeed';
+import VideoFeed from './components/VideoFeed';
+import type { CustomCTAClickCallback, SDKInitCallback, VideoFeedClickCallback, VideoPlaybackCallback } from './FireworkSDK';
+import FireworkSDK from './FireworkSDK';
+import type ADConfig from './models/ADConfig';
+import type AddToCartResult from './models/AddToCartResult';
+import type FeedItemDetails from './models/FeedItemDetails';
+import type FWError from './models/FWError';
+import type { AddToCartEvent, CustomCTAClickEvent, SDKInitEvent, UpdateProductDetailsEvent, VideoPlaybackEvent, WillDisplayProductEvent } from './models/FWEvents';
+import type Product from './models/Product';
+import type ProductInfoViewConfiguration from './models/ProductInfoViewConfiguration';
+import type { AddToCartButtonConfiguration, CartIconConfiguration } from './models/ProductInfoViewConfiguration';
+import type ProductUnit from './models/ProductUnit';
+import type { ProductPrice } from './models/ProductUnit';
+import type VideoFeedConfiguration from './models/VideoFeedConfiguration';
+import type { VideoFeedPlayIconConfiguration, VideoFeedTitleConfiguration, VideoFeedTitlePosition } from './models/VideoFeedConfiguration';
+import type VideoPlaybackDetails from './models/VideoPlaybackDetails';
+import type { VideoBadge, VideoPlayerSize } from './models/VideoPlaybackDetails';
+import VideoPlaybackEventName from './models/VideoPlaybackEventName';
+import type VideoPlayerConfiguration from './models/VideoPlayerConfiguration';
+import type { VideoPlayerCompleteAction, VideoPlayerCTAStyle, VideoPlayerStyle } from './models/VideoPlayerConfiguration';
+import type { AddToCartCallback, ClickCartIconCallback, UpdateProductDetailsCallback, WillDisplayProductCallback } from './VideoShopping';
+import VideoShopping from './VideoShopping';
+export default FireworkSDK;
+export { ADConfig, AddToCartButtonConfiguration, AddToCartCallback, AddToCartEvent, AddToCartResult, CartIconConfiguration, ClickCartIconCallback, CustomCTAClickCallback, CustomCTAClickEvent, FeedItemDetails, FWError, IVideoFeedProps, Product, ProductInfoViewConfiguration, ProductPrice, ProductUnit, SDKInitCallback, SDKInitEvent, UpdateProductDetailsCallback, UpdateProductDetailsEvent, VideoBadge, VideoFeed, VideoFeedClickCallback, VideoFeedConfiguration, VideoFeedMode, VideoFeedPlayIconConfiguration, VideoFeedSource, VideoFeedTitleConfiguration, VideoFeedTitlePosition, VideoPlaybackCallback, VideoPlaybackDetails, VideoPlaybackEvent, VideoPlaybackEventName, VideoPlayerCompleteAction, VideoPlayerConfiguration, VideoPlayerCTAStyle, VideoPlayerSize, VideoPlayerStyle, VideoShopping, WillDisplayProductCallback, WillDisplayProductEvent, };

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

@@ -0,0 +1,10 @@
+export default interface ADConfig {
+    /**
+     * Defaults to none.
+     */
+    type?: 'none' | 'admob' | 'ima';
+    /**
+     * Defaults to true. The property only takes effect when type is admob.
+     */
+    startMobileAds?: boolean;
+}

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

@@ -0,0 +1,10 @@
+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/lib/typescript/models/FWError.d.ts

@@ -0,0 +1,10 @@
+export default interface FWError {
+    /**
+     * Error name
+     */
+    name: string;
+    /**
+     * Error Reason
+     */
+    reason?: string | null;
+}

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

@@ -0,0 +1,55 @@
+import type VideoPlaybackDetails from './VideoPlaybackDetails';
+import type FWError from './FWError';
+import type VideoPlaybackEventName from './VideoPlaybackEventName';
+import type FeedItemDetails from './FeedItemDetails';
+export declare 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"
+}
+export interface SDKInitEvent {
+    /**
+     * If error equals undefined/null, it means the initialization is successful.
+     */
+    error?: FWError | null;
+}
+export interface CustomCTAClickEvent {
+    /**
+     * Action URL that is associated with this CTA
+     */
+    url: string;
+}
+export interface VideoPlaybackEvent {
+    eventName: VideoPlaybackEventName;
+    info: VideoPlaybackDetails;
+}
+export interface VideoFeedClickEvent {
+    info: FeedItemDetails;
+}
+export interface AddToCartEvent {
+    /**
+     * A unique identifier of the product.
+     */
+    productId: string;
+    /**
+     * A unique identifier of the product unit.
+     */
+    unitId: string;
+}
+export interface UpdateProductDetailsEvent {
+    /**
+     * A unique identifier of the product.
+     */
+    productId: string;
+}
+export interface WillDisplayProductEvent {
+    /**
+     * A unique identifier of the video.
+     */
+    videoId: string;
+}

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

@@ -0,0 +1,14 @@
+export default interface FeedItemDetails {
+    /**
+     * The index of the thumbnail tapped in the video feed.
+     */
+    index: number;
+    /**
+     * A unique id for the video.
+     */
+    videoId: string;
+    /**
+     * The total duration of the video
+     */
+    duration: number;
+}

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

@@ -0,0 +1,19 @@
+import type ProductUnit from './ProductUnit';
+export default interface Product {
+    /**
+     * A unique identifier of the product.
+     */
+    productId: string;
+    /**
+     * The name of the product.
+     */
+    name?: string | null;
+    /**
+     * The description of the product.
+     */
+    description?: string | null;
+    /**
+     * The unit array of the product
+     */
+    units?: ProductUnit[] | null;
+}

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

@@ -0,0 +1,18 @@
+export interface CartIconConfiguration {
+    isHidden?: boolean;
+}
+export interface AddToCartButtonConfiguration {
+    backgroundColor?: string;
+    textColor?: string;
+    fontSize?: number;
+}
+export default interface ProductInfoViewConfiguration {
+    /**
+     * Configuration of cart icon.
+     */
+    cartIcon?: CartIconConfiguration;
+    /**
+     * Configuration of "Add to cart" button.
+     */
+    addToCartButton?: AddToCartButtonConfiguration;
+}

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

@@ -0,0 +1,22 @@
+export interface ProductPrice {
+    amount: number;
+    currencyCode: string;
+}
+export default interface ProductUnit {
+    /**
+     * The unique identifier of the product unit.
+     */
+    unitId: string;
+    /**
+     * The name of the product unit.
+     */
+    name?: string | null;
+    /**
+     * The url of the product unit.
+     */
+    url?: string;
+    /**
+     * The price of the product unit.
+     */
+    price?: ProductPrice;
+}

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

@@ -0,0 +1,32 @@
+export interface VideoFeedTitleConfiguration {
+    hidden?: boolean;
+    textColor?: string;
+    fontSize?: number;
+}
+export interface VideoFeedPlayIconConfiguration {
+    hidden?: boolean;
+    iconWidth?: number;
+}
+export declare type VideoFeedTitlePosition = 'stacked' | 'nested';
+export default interface VideoFeedConfiguration {
+    /**
+     * BackgroundColor of video feed.
+     */
+    backgroundColor?: string;
+    /**
+     * CornerRadius of video feed.
+     */
+    cornerRadius?: number;
+    /**
+     * Configuration of video feed title.
+     */
+    title?: VideoFeedTitleConfiguration;
+    /**
+     * Configuration of video feed title position.
+     */
+    titlePosition?: VideoFeedTitlePosition;
+    /**
+     * Configuration of video feed play icon.
+     */
+    playIcon?: VideoFeedPlayIconConfiguration;
+}

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

@@ -0,0 +1,31 @@
+export interface VideoPlayerSize {
+    width: number;
+    height: number;
+}
+export declare type VideoBadge = 'ad' | 'demo' | 'featured';
+export default interface VideoPlaybackDetails {
+    /**
+     * A unique identifier of the video.
+     */
+    videoId: string;
+    /**
+     * The total duration of the video.
+     */
+    duration?: number | null;
+    /**
+     * The caption for the video.
+     */
+    caption?: string | null;
+    /**
+     * Video badge type.
+     */
+    badge?: VideoBadge | null;
+    /**
+     * The size of the player.
+     */
+    playerSize?: VideoPlayerSize | null;
+    /**
+     * Indicates if the video is associated with a call-to-action (CTA).
+     */
+    hasCTA?: boolean | null;
+}