react-native-firework-sdk 2.3.0 → 2.4.0-beta.1

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

@@ -1,37 +0,0 @@
-import type { VideoPlayerCTADelay } from './VideoPlayerCTADelay';
-import type { VideoPlayerCTAWidth } from './VideoPlayerCTAWidth';
-import type { VideoPlayerCompleteAction } from './VideoPlayerCompleteAction';
-export interface StoryBlockConfiguration {
-    /**
-     * Behavior occurring after video is complete.
-     */
-    videoCompleteAction?: VideoPlayerCompleteAction;
-    /**
-     * Indicates if the video player shows share button.
-     */
-    showShareButton?: boolean;
-    /**
-     * Indicates if the video player shows playback button.
-     */
-    showPlaybackButton?: boolean;
-    /**
-     * Indicates if Firework branding should be showed or not.
-     */
-    showBranding?: boolean;
-    /**
-     * Specifies the delay before showing the CTA.
-     */
-    ctaDelay?: VideoPlayerCTADelay;
-    /**
-     * Specifies the delay before the highlight animation occurs. Only supported on iOS.
-     */
-    ctaHighlightDelay?: VideoPlayerCTADelay;
-    /**
-     * The share base URL of the video.
-     */
-    shareBaseURL?: string;
-    /**
-     * Specifies the desired width for the Video Player CTA button.
-     */
-    ctaWidth?: VideoPlayerCTAWidth;
-}

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

@@ -1 +0,0 @@
-export type StoryBlockSource = 'discover' | 'channel' | 'playlist' | 'dynamicContent' | 'hashtagPlaylist';

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

@@ -1,26 +0,0 @@
-export default interface TrackPurchaseParameters {
-    /**
-     * A unique identifier for the user's order.
-     */
-    orderId: string;
-    /**
-     * The value of the order.
-     */
-    value?: number;
-    /**
-     * The currency code of the purchase value.
-     */
-    currencyCode?: string;
-    /**
-     * The country code of the purchase.
-     */
-    countryCode?: string;
-    /**
-     * Any additional information associated to the purchase.
-     * Reserved keys: order_id, value, currency, country.
-     * Any values passed in the additionalInfo that use a reserved key will be ignored.
-     */
-    additionalInfo?: {
-        [key: string]: string;
-    };
-}

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

@@ -1,108 +0,0 @@
-import type IOSFontInfo from './IOSFontInfo';
-import type AndroidFontInfo from './AndroidFontInfo';
-import type GradientDrawable from './GradientDrawable';
-export interface VideoFeedTitleConfiguration {
-    /**
-     * Specifies if the video feed title is hidden.
-     */
-    hidden?: boolean;
-    /**
-     * The text color of video feed title.
-     */
-    textColor?: string;
-    /**
-     * The font size of video feed title.
-     */
-    fontSize?: number;
-    /**
-     * Specifies the number of allowed lines for the label.
-     * Only supported on iOS.
-     */
-    numberOfLines?: number;
-    /**
-     * The iOS font info of video feed title.
-     * The property is ignored when fontSize is not set.
-     * Only supported on iOS.
-     */
-    iOSFontInfo?: IOSFontInfo;
-    /**
-     * The Android font info of "VideoFeedTitle".
-     * The property is ignored when fontSize is not set.
-     * Only supported on Android.
-     */
-    androidFontInfo?: AndroidFontInfo;
-    /**
-     * The background color of video feed title.
-     * The property is ignored when gradientDrawable is set.
-     * Only supported on Android.
-     */
-    backgroundColor?: string;
-    /**
-     * The background drawable of video feed title.
-     * Only supported on Android.
-     */
-    gradientDrawable?: GradientDrawable;
-}
-export interface VideoFeedPlayIconConfiguration {
-    hidden?: boolean;
-    iconWidth?: number;
-}
-export type VideoFeedTitlePosition = 'stacked' | 'nested';
-export interface VideoFeedPadding {
-    top?: number;
-    right?: number;
-    bottom?: number;
-    left?: number;
-}
-export default interface VideoFeedConfiguration {
-    /**
-     * Background color of video feed.
-     */
-    backgroundColor?: string;
-    /**
-     * Corner radius of video feed item.
-     */
-    cornerRadius?: number;
-    /**
-     * Configuration of video feed item title.
-     */
-    title?: VideoFeedTitleConfiguration;
-    /**
-     * Title position of video feed item.
-     */
-    titlePosition?: VideoFeedTitlePosition;
-    /**
-     * The padding of video feed title. Only supported on iOS.
-     */
-    titlePadding?: VideoFeedPadding;
-    /**
-     * Configuration of video feed item play icon.
-     */
-    playIcon?: VideoFeedPlayIconConfiguration;
-    /**
-     * Indicates if the video feed item shows ad badge.
-     */
-    showAdBadge?: boolean;
-    /**
-     * The aspect ratio(width / height) for video feed item. Only supported on iOS.
-     */
-    aspectRatio?: number;
-    /**
-     * The padding of video feed content. Only supported on iOS.
-     */
-    contentPadding?: VideoFeedPadding;
-    /**
-     * The item spacing for video feed.
-     */
-    itemSpacing?: number;
-    /**
-     * Specifies if autoplay is enabled.
-     */
-    enableAutoplay?: boolean;
-    /**
-     * The number of feed items to be displayed per row.
-     * The property only takes effect when video feed mode is grid.
-     * The property value needs to be an integer and greater than 0.
-     */
-    gridColumns?: number;
-}

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

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

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

@@ -1,47 +0,0 @@
-export interface VideoPlayerSize {
-    width: number;
-    height: number;
-}
-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?: string | null;
-    /**
-     * The size of the player.
-     */
-    playerSize?: VideoPlayerSize | null;
-    /**
-     * Indicates if the video is associated with a call-to-action (CTA).
-     */
-    hasCTA?: boolean | null;
-    /**
-     * The amount of time the video was playing at the time of the event.
-     */
-    progress?: number | null;
-    /**
-     * The type of the CTA button clicked: "buy" "download" "view" "book".
-     * Only supported on iOS.
-     */
-    ctaActionType?: string | null;
-    /**
-     * The url of the CTA button clicked.
-     */
-    ctaActionURL?: string | null;
-    /**
-     * The associated feed ID
-     */
-    feedId?: string | null;
-}

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

@@ -1,51 +0,0 @@
-declare enum VideoPlaybackEventName {
-    /**
-     * When video is shown to the user.
-     */
-    Impression = "fw:video:impression",
-    /**
-     * Video started.
-     */
-    Start = "fw:video:start",
-    /**
-     * Video paused.
-     */
-    Pause = "fw:video:pause",
-    /**
-     * Video resume.
-     */
-    Resume = "fw:video:resume",
-    /**
-     * Video reached 25%.
-     */
-    FirstQuartile = "fw:video:first-quartile",
-    /**
-     * Video reached 50%.
-     */
-    Midpoint = "fw:video:midpoint",
-    /**
-     * Video reached 75%.
-     */
-    ThirdQuartile = "fw:video:third-quartile",
-    /**
-     * Video reached 100%.
-     */
-    Complete = "fw:video:complete",
-    /**
-     * Ad video started playing.
-     */
-    AdStart = "fw:video:ad-start",
-    /**
-     * Ad video completed playing.
-     */
-    AdEnd = "fw:video:ad-end",
-    /**
-     * When a visitor clicks on CTA button (if available).
-     */
-    ClickCTA = "fw:video:click-cta",
-    /**
-     * When user clicks on "Share" button.
-     */
-    ClickShare = "fw:video:click-share"
-}
-export default VideoPlaybackEventName;

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

@@ -1,11 +0,0 @@
-export type VideoPlayerCTADelayType = 'constant' | 'percentage';
-export interface VideoPlayerCTADelay {
-    type: VideoPlayerCTADelayType;
-    /**
-     * If type is constant, the value is the number of seconds of delay.
-     * Value should be greater than or equal to 0 and less than or equal to 10 when type is constant.
-     * If type is percentage, the value is a percentage based on the the total duration of the video length.
-     * Value must be greater than or equal to 0 and less than 1 when type is percentage.
-     */
-    value: number;
-}

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

@@ -1,21 +0,0 @@
-import type IOSFontInfo from './IOSFontInfo';
-export interface VideoPlayerCTAStyle {
-    /**
-     * 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 CTA button.
-     * The property is ignored when fontSize is not set.
-     * Only supported on iOS.
-     */
-    iOSFontInfo?: IOSFontInfo;
-}

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

@@ -1 +0,0 @@
-export type VideoPlayerCTAWidth = 'fullWidth' | 'compact' | 'sizeToFit';

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

@@ -1 +0,0 @@
-export type VideoPlayerCompleteAction = 'loop' | 'advanceToNext';

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

@@ -1,51 +0,0 @@
-import type { VideoPlayerCTADelay } from './VideoPlayerCTADelay';
-import type { VideoPlayerCTAStyle } from './VideoPlayerCTAStyle';
-import type { VideoPlayerCTAWidth } from './VideoPlayerCTAWidth';
-import type { VideoPlayerCompleteAction } from './VideoPlayerCompleteAction';
-import type { VideoPlayerStyle } from './VideoPlayerStyle';
-export default interface VideoPlayerConfiguration {
-    /**
-     * Sets the proportion of the video player to its container.
-     */
-    playerStyle?: VideoPlayerStyle;
-    /**
-     * Behavior occurring after video is complete.
-     */
-    videoCompleteAction?: VideoPlayerCompleteAction;
-    /**
-     * Indicates if the video player shows share button.
-     */
-    showShareButton?: boolean;
-    /**
-     * 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;
-    /**
-     * Indicates if Firework branding should be showed or not.
-     */
-    showBranding?: boolean;
-    /**
-     * Specifies the delay before showing the CTA.
-     */
-    ctaDelay?: VideoPlayerCTADelay;
-    /**
-     * Specifies the delay before the highlight animation occurs. Only supported on iOS.
-     */
-    ctaHighlightDelay?: VideoPlayerCTADelay;
-    /**
-     * The share base URL of the video.
-     */
-    shareBaseURL?: string;
-    /**
-     * Specifies the desired width for the Video Player CTA button.
-     */
-    ctaWidth?: VideoPlayerCTAWidth;
-}

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

@@ -1 +0,0 @@
-export type VideoPlayerStyle = 'full' | 'fit';

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

@@ -1,11 +0,0 @@
-import { NativeEventEmitter, NativeModule } from 'react-native';
-interface IFWNavigatorModule extends NativeModule {
-    popNativeContainer(): Promise<boolean>;
-    canPopNativeContainer(): Promise<boolean>;
-    startFloatingPlayer(): Promise<boolean>;
-    stopFloatingPlayer(): Promise<boolean>;
-}
-declare const FWNavigatorModuleEventEmitter: NativeEventEmitter;
-export { FWNavigatorModuleEventEmitter };
-declare const _default: IFWNavigatorModule;
-export default _default;

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

@@ -1,19 +0,0 @@
-import { NativeEventEmitter, NativeModule } from 'react-native';
-import type AdBadgeConfiguration from '../models/AdBadgeConfiguration';
-import type SDKInitOptions from '../models/SDKInitOptions';
-import type TrackPurchaseParameters from '../models/TrackPurchaseParameters';
-import type VideoPlayerConfiguration from '../models/VideoPlayerConfiguration';
-interface IFireworkSDKModule extends NativeModule {
-    init(options?: SDKInitOptions): Promise<any>;
-    openVideoPlayer(url: string, config?: VideoPlayerConfiguration): void;
-    setCustomCTAClickEnabled(enabled: boolean): void;
-    setShareBaseURL(url?: string): Promise<any>;
-    setVideoPlaybackEventEnabled(enabled: boolean): void;
-    setAdBadgeConfiguration(config?: AdBadgeConfiguration): Promise<any>;
-    trackPurchase(parameters: TrackPurchaseParameters): void;
-    changeAppLanguage(language?: string | null): Promise<boolean>;
-}
-declare const FireworkSDKModuleEventEmitter: NativeEventEmitter;
-export { FireworkSDKModuleEventEmitter };
-declare const _default: IFireworkSDKModule;
-export default _default;

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

@@ -1,8 +0,0 @@
-import { NativeEventEmitter, NativeModule } from 'react-native';
-interface ILiveStreamModule extends NativeModule {
-    init(): Promise<any>;
-}
-declare const LiveStreamModuleEventEmitter: NativeEventEmitter;
-export { LiveStreamModuleEventEmitter };
-declare const _default: ILiveStreamModule;
-export default _default;

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

@@ -1,18 +0,0 @@
-import { NativeEventEmitter, NativeModule } from 'react-native';
-import type Product from '../models/Product';
-import type ProductInfoViewConfiguration from '../models/ProductInfoViewConfiguration';
-import type ShoppingCTAResult from '../models/ShoppingCTAResult';
-interface IShoppingModule extends NativeModule {
-    init(): Promise<any>;
-    updateVideoProducts(products: Product[], callbackId: number | string): void;
-    updateShoppingCTAResult(result: ShoppingCTAResult, callbackId: number | string): void;
-    setCartIconVisible(visible: boolean): void;
-    setCartItemCount(count: number): void;
-    clearCallbackId(callbackId: number | string, eventName: string): void;
-    setProductInfoViewConfiguration(config: ProductInfoViewConfiguration): void;
-    setCustomClickLinkButtonEnabled(enabled: boolean): Promise<any>;
-}
-declare const ShoppingModuleEventEmitter: NativeEventEmitter;
-export { ShoppingModuleEventEmitter };
-declare const _default: IShoppingModule;
-export default _default;

package/lib/typescript/utils/FWGlobalState.d.ts

@@ -1,10 +0,0 @@
-declare class FWGlobalState {
-    private static _instance?;
-    private sdkInitCalledResolveFunc?;
-    sdkInitCalledPromise: Promise<void>;
-    sdkInitCalled: boolean;
-    static getInstance(): FWGlobalState;
-    private constructor();
-    resolveSdkInitCalled(): void;
-}
-export default FWGlobalState;

package/lib/typescript/utils/FWLoggerUtil.d.ts

@@ -1,6 +0,0 @@
-export default class FWLoggerUtil {
-    static enabled: boolean;
-    static log(message: string): void;
-    static logNativeMessage(nativeMessage: string): void;
-    private static toISOString;
-}