@wscsports/blaze-web-sdk 0.3.11 → 0.3.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wscsports/blaze-web-sdk",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "main": "publish/index",
   "types": "publish/index",
   "files": [
@@ -38,7 +38,8 @@
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.15.1",
     "webpack-obfuscator": "^3.5.1",
-    "media-captions": "^0.0.18"
+    "@types/videojs-vtt.js": "^0.15.3",
+    "videojs-vtt.js": "^0.15.5"
   },
   "dependencies": {
     "animejs": "^3.2.1",

package/publish/index.d.ts

@@ -18,6 +18,7 @@ export declare function setGoogleCustomNativeAdsHandler(handler: CustomNativeAdH
 export declare function setImaHandler(handler: ImaAdHandler): void;
 export declare function playStory(storyId: string, style?: StoryPlayerStyle): Promise<void>;
 export declare function playStories(dataSource: BlazeDataSourceType, style?: StoryPlayerStyle): Promise<void>;
+export declare function setAbTestParams(abTestParams: BlazeAbTestType): void;
 declare const _default: {
     Initialize: typeof Initialize;
     WidgetGridView: typeof WidgetGridView;
@@ -37,6 +38,7 @@ declare const _default: {
     setExternalUserId: typeof setExternalUserId;
     playStory: typeof playStory;
     playStories: typeof playStories;
+    setAbTestParams: typeof setAbTestParams;
 };
 export default _default;
 
@@ -81,6 +83,8 @@ declare class UserEventInfo {
     'mac_address': string;
     'user_type': string;
     'is_bot': true;
+    'ab_test_id': string;
+    'ab_test_variant': string;
 }
 declare class TechEventInfo {
     'device_type': string;
@@ -182,6 +186,7 @@ export declare class StoryEvent {
     'player_type': PlayerType;
     'player_orientation': ContentAspectRatio;
     'cc_state': string;
+    'content_extra_info': string;
 }
 export declare class MomentEvent {
     'moments_session_id': string;
@@ -199,6 +204,7 @@ export declare class MomentEvent {
     'loop_number': string;
     'gesture_type': MomentGestureType;
     'cc_state': string;
+    'content_extra_info': string;
 }
 export declare class WidgetEvent {
     'page_view_id': string;
@@ -245,6 +251,7 @@ export declare class AdEvent {
     'ad_unit_id': string;
     'session_id': string;
     'gesture_type': MomentGestureType | StoryGestureType;
+    'content_extra_info': string;
 }
 export declare class ImaAdEvent {
     'story_id': string;
@@ -261,6 +268,7 @@ export declare class ImaAdEvent {
     'ad_type': string;
     'ima_url': string;
     'player_orientation': ContentAspectRatio;
+    'content_extra_info': string;
 }
 export declare class InteractionEvent {
     'interaction_id': string;
@@ -274,6 +282,7 @@ export declare class InteractionEvent {
     'content_page_id': string;
     'playback_action_method': string;
     'audio_state': string;
+    'content_extra_info': string;
 }
 
 export declare abstract class BaseWidget extends HTMLElement {
@@ -566,19 +575,23 @@ export declare class BlazeCtaButton extends BaseWidget {
     iconArrowElement: BlazeButton;
     ctaTextElement: BlazeDiv;
     isButtonCreated: boolean;
+    private animationTimeouts;
     constructor();
     static observedAttributes: string[];
     connectedCallback(): void;
     disconnectedCallback(): void;
     attributeChangedCallback(name: AttributeType, oldValue: string, newValue: string): void;
     createButton(): void;
-    animateButton(): void;
+    animateButton(animationType: AnimationType): void;
+    animateIcon(animationType: AnimationType): void;
+    animateElement(element: HTMLElement, animationType: AnimationType, duration: number, delay: number, repeat: number): void;
     setCtaText(value: string): void;
     setWidth(value: string): void;
     setMargin(value: string): void;
     setAnchorButtonStyles(styles: Partial<CSSStyleDeclaration>): void;
     setCtaTextStyle(styles: Partial<CSSStyleDeclaration>): void;
     setCtaIconStyles(styles: Partial<CSSStyleDeclaration>): void;
+    clearAllAnimations(): void;
 }
 
 export * from './share-button';
@@ -754,6 +767,12 @@ export interface IBannerAdInfo {
     type: 'Banner';
 }
 
+export interface AppConfiguration {
+    configurations: {
+        analyticsAddEntitiesInfo?: string;
+    };
+}
+
 export interface IContent {
     id: string;
     title: string;
@@ -778,6 +797,7 @@ export interface ICTA {
     url: string;
     backgroundColor: string;
     textColor: string;
+    enhancements: EnhancementsType;
 }
 
 export * from './ad-info.interface';
@@ -911,6 +931,7 @@ export interface IThumbnail {
 export declare enum ErrorCode {
     FailedToFindContainerId = 1,
     FailedContainerIdHasWidgetAlready = 2,
+    FailedLoadingAppConfigurations = 3,
     FailedLoadingStories = 100,
     FailedEnrichStories = 101,
     FailedToHaveLabels = 103,
@@ -1407,9 +1428,23 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     }): Promise<void>;
     getUserToken(body: GetUserTokenRequest): Promise<import("../interfaces").IHttpResponse<TokenData>>;
     refreshUserToken(body: RefreshUserTokenRequest): Promise<import("../interfaces").IHttpResponse<TokenData>>;
+    getAppConfigurations(): Promise<import("../interfaces").IHttpResponse<AppConfiguration>>;
 }
 export declare const ApiService: ApiServiceClass;
 
+declare const AppConfigurationServiceClass_base: {
+    new (): {};
+    _instance: AppConfigurationServiceClass;
+    getInstance(): AppConfigurationServiceClass;
+};
+declare abstract class AppConfigurationServiceClass extends AppConfigurationServiceClass_base implements IService {
+    private _appConfigurations?;
+    constructor();
+    get appConfigurations(): AppConfiguration | undefined;
+    init(): Promise<void>;
+}
+export declare const AppConfigurationService: AppConfigurationServiceClass;
+
 declare const ConfigServiceClass_base: {
     new (): {};
     _instance: ConfigServiceClass;
@@ -1456,6 +1491,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     get doNotTrack(): boolean;
     set doNotTrack(value: boolean);
     get shouldAllowHorizontalStories(): boolean;
+    set shouldAllowHorizontalStories(value: boolean);
     get geoLocation(): string;
     set geoLocation(value: string);
     get staticContent(): boolean;
@@ -1577,6 +1613,7 @@ export declare const EventService: EventServiceClass;
 export * from './ad.service';
 export * from './analytics.service';
 export * from './api.service';
+export * from './app-configuration.service';
 export * from './config.service';
 export * from './database.service';
 export * from './error.service';
@@ -1684,6 +1721,10 @@ declare abstract class StoryServiceClass extends StoryServiceClass_base implemen
 }
 export declare const StoryService: StoryServiceClass;
 
+export type BlazeAbTestType = {
+    id: string;
+    variant: string;
+};
 declare const UserServiceClass_base: {
     new (): {};
     _instance: UserServiceClass;
@@ -1692,9 +1733,12 @@ declare const UserServiceClass_base: {
 declare abstract class UserServiceClass extends UserServiceClass_base implements IService {
     _userId: string;
     _sessionId: string;
+    _abTest: BlazeAbTestType | null;
     constructor();
     get userId(): string;
     get sessionId(): string;
+    get abTest(): BlazeAbTestType | null;
+    set abTest(abTest: BlazeAbTestType);
     init(): Promise<void>;
     private ensureSessionId;
     assignUserId(): Promise<void>;
@@ -1863,6 +1907,7 @@ export interface LabelStyle {
     gap: number;
     width: number | 'auto';
     color: string;
+    backgroundColor?: string;
     height: string | number;
     padding: string;
     font: string;
@@ -1894,6 +1939,13 @@ export interface StoryPlayerStyle {
     contentOrder: ContentOrderType[];
     icons: BlazeStoryIcons;
 }
+export type BlazeStoryPlayerCtaStyle = {
+    ctaAnimationType?: 'growingAnimation' | null;
+    swipeUpCTA?: BlazeSwipeUpCTA;
+};
+export type BlazeSwipeUpCTA = {
+    isEnabled: boolean;
+};
 export type BlazeMomentsPlayerTextStyle = {
     font: string;
     textSizeMobile: string;
@@ -1980,15 +2032,14 @@ export interface MomentPlayerStyle {
     ctaButton: BlazeMomentsPlayerCtaStyle;
 }
 export interface CtaButtonStyle {
+    isAnimated: boolean;
+    isDisplayCtaModal: boolean;
     borderRadius: string;
     border: string;
     fontSize: string;
     font: string;
     backgroundColor: string;
     color: string;
-    isVisible: boolean;
-    isAnimated: boolean;
-    isDisplayCtaModal: boolean;
     fontWeight: FontWeightType;
     textTransform: TextTransformType;
     padding: string;
@@ -2020,6 +2071,7 @@ export declare const Colors: {
     readonly White: "#FFFFFF";
     readonly Black: "#000000";
     readonly Gray: "#B6B7B8";
+    readonly Yellow: "#FFD325";
 };
 
 export type ThemeType = 'grid-2-columns' | 'grid-3-columns' | 'row-circle' | 'row-rectangle' | 'row-rectangle-horizontal' | 'grid-2-columns-horizontal' | 'grid-3-columns-horizontal' | 'default';
@@ -2032,6 +2084,17 @@ export declare function isStoryPlayerStyle(playerStyle: StoryPlayerStyle | Momen
 export declare function isMomentPlayerStyle(playerStyle: StoryPlayerStyle | MomentPlayerStyle): playerStyle is MomentPlayerStyle;
 
 
+export type AnimationType = 'Growing' | 'Shrinking' | 'BottomToTop';
+export declare const animationCssMapper: {
+    Growing: string;
+    Shrinking: string;
+    BottomToTop: string;
+};
+export type EnhancementsType = {
+    animationType: AnimationType;
+    hasSwipeUp: boolean;
+} | null;
+
 export interface IAttributeParser {
     getIntAttribute(key: string, defaultValue?: number): number | undefined;
     getFloatAttribute(key: string, defaultValue?: number): number | undefined;
@@ -2451,6 +2514,7 @@ export * from './trigger.type';
 export * from './gesture.type';
 export * from './closed-captions.type';
 export * from './ratio.type';
+export * from './animation.type';
 
 export type EntitiesType = 'playerId' | 'teamId' | 'gameId' | 'roundId';
 export type PerItemStyleOverrides = Partial<Record<EntitiesType, Array<{
@@ -2626,12 +2690,13 @@ export * from './widget-cta-modal';
 export * from './widget-captions';
 
 export declare class BlazeWidgetCaptions extends HTMLElement {
+    private parser;
     private container;
-    private renderer;
     private observer;
     private captions;
     private video;
     private startTime;
+    private cues;
     private boundTimeUpdate;
     private boundSeekUpdate;
     constructor();
@@ -2649,6 +2714,7 @@ export declare class BlazeWidgetCaptions extends HTMLElement {
     private setupStyles;
     initialize(video: HTMLVideoElement, captions: ICaptionFile[]): Promise<void>;
     private setupCaptions;
+    private updateCaptions;
 }
 
 export declare abstract class BlazeWidgetContent extends HTMLElement {
@@ -3071,6 +3137,7 @@ export declare class BlazeWidgetSDK extends BaseWidget {
     modal: BlazeWidgetStoryModal | BlazeWidgetMomentModal;
     boundOnResizeEvent: (this: Window, ev: UIEvent) => void;
     boundOnResizeEventDelay: () => void;
+    static get observedAttributes(): string[];
     constructor();
     connectedCallback(): Promise<void>;
     disconnectedCallback(): void;
@@ -3088,6 +3155,7 @@ export declare class BlazeWidgetSDK extends BaseWidget {
     handleStaticContentLoad(playReference: playRefType): Promise<void>;
     enrichContent(content: IStory[]): Promise<IStory[]>;
     setupModalAndLoadContent(contentType: ContentType, playReference: playRefType, content: IStory | IMoment): Promise<void>;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     private getConfigAttributes;
     private initialize;
     private injectToHead;
@@ -3560,11 +3628,13 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
     boundOnResizeEventDelay: (this: Window, ev: UIEvent) => void;
     boundOnKeyDown: (ev: KeyboardEvent) => void;
     boundOnBeforeUnload: () => void;
+    private currentState;
     constructor(parentWidget: HTMLElement, playerLayout: StoryPlayerStyle);
     connectedCallback(): void;
     disconnectedCallback(): void;
     onBeforeUnload(): null | undefined;
     setTheme(playerStyle: StoryPlayerStyle): void;
+    updateModalContent(): void;
     setModalContent(stories: IStory[], indexOfContentInWidget: number, defaultAdsInfo?: IAdInfo): void;
     onKeyDown(ev: KeyboardEvent): void;
     close(): void;
@@ -3588,6 +3658,7 @@ export declare class BlazeWidgetStoryPlayer extends WidgetAbstractPlayer {
     disconnectedCallback(): void;
     setupEventListeners(): void;
     applyStyles(): void;
+    updateContentConfig(stories: IStory[]): void;
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     setContent(content: BlazeWidgetStory[]): void;
     navigateContent(direction: ContentDirection): void;
@@ -3679,7 +3750,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     private applyIconStyle;
     onShareClick(): Promise<void>;
     private onClosedCaptionClick;
-    updateCtaButtonLayout(): void;
+    private updateCtaButtonLayout;
     private updateChip;
     setTheme(playerStyle: StoryPlayerStyle): void;
     private disableStoriesNavigationButtons;
@@ -3694,7 +3765,13 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     }): void;
     muteToggle(): boolean;
     resetStoryLocationIndexToLastUnseen(): void;
-    setData(data: any): void;
+    private determineAspectRatio;
+    private clearExistingContent;
+    private createPageElement;
+    private setupPageEndedHandler;
+    private createProgressElements;
+    private createProgressPart;
+    setData(story: IStory): void;
     get currentPage(): BlazeWidgetVideoBase;
     get nextPage(): BlazeWidgetVideoBase;
     get prevPage(): BlazeWidgetVideoBase;
@@ -3736,6 +3813,11 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     disconnectedCallback(): void;
     updateCTAButtonPosition(): void;
     updateCta(pageIndex: number): void;
+    private updateCtaButtonWidth;
+    private animateCtaButton;
+    private handleCtaButtonAnimation;
+    private setCtaButtonAttributes;
+    private setCtaIconVisibility;
     updatePlayerButtonsState(displayPageNavigationButtons?: boolean): void;
     updateButtonState(buttonType: ButtonNavigation, button: BlazeButton | undefined): void;
     private isSingleStoryWithAutoAdvance;