@wscsports/blaze-web-sdk 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wscsports/blaze-web-sdk",
-  "version": "0.2.00",
+  "version": "0.2.01",
   "main": "publish/index",
   "types": "publish/index",
   "files": [

package/publish/index.d.ts

@@ -1,6 +1,6 @@
 export declare function setDoNotTrack(value: boolean): void;
 export declare function setGeoLocation(value: string): void;
-export declare function setExternalUserId(value: string): void;
+export declare function setExternalUserId(value: string): Promise<void>;
 export declare function Initialize(apiKey: string, options?: Omit<IBlazeSDKOptions, "apiKey">): Promise<void>;
 export declare function WidgetRowView(containerId: string, options: IWidgetViewOptions): IWidgetView;
 export declare function WidgetGridView(containerId: string, options: IWidgetViewOptions): IWidgetView;
@@ -26,6 +26,7 @@ declare const _default: {
     setGoogleCustomNativeAdsHandler: typeof setGoogleCustomNativeAdsHandler;
     pauseCurrentPlayer: typeof pauseCurrentPlayer;
     resumeCurrentPlayer: typeof resumeCurrentPlayer;
+    setExternalUserId: typeof setExternalUserId;
 };
 export default _default;
 
@@ -34,19 +35,19 @@ export interface IAPIOptions {
     analyticsBaseUrl: string | undefined;
 }
 export interface IRequestOptions {
-    init?: RequestInit;
+    init?: Pick<RequestInit, 'method' | 'body' | 'headers' | 'credentials'>;
     baseUrl?: string;
     urlSearchParams?: {};
+    auth?: boolean;
 }
 export declare class API {
     private readonly options;
     constructor(options: IAPIOptions);
     private get baseUrl();
-    private get analyticsBaseUrl();
-    get<T>(url: string, options?: IRequestOptions): Promise<IResponse<T>>;
-    post<T>(url: string, body?: any | null, options?: IRequestOptions): Promise<IResponse<T>>;
-    put<T>(url: string, options?: IRequestOptions): Promise<IResponse<T>>;
-    request<T>(url: string, options?: IRequestOptions): Promise<IResponse<T>>;
+    get<T>(url: string, options?: IRequestOptions): Promise<IHttpResponse<T>>;
+    post<T>(url: string, options?: IRequestOptions): Promise<IHttpResponse<T>>;
+    put<T>(url: string, options?: IRequestOptions): Promise<IHttpResponse<T>>;
+    request<T>(url: string, options?: IRequestOptions): Promise<IHttpResponse<T>>;
 }
 
 export * from './api';
@@ -377,6 +378,16 @@ export declare enum ImaAdAction {
     MIDPOINT = "ima_ad_midpoint",
     THIRD_QUARTILE = "ima_ad_third_quartile"
 }
+export declare enum InteractionAction {
+    VIEW = "interaction_view",
+    ANSWER = "interaction_answer",
+    AUDIO = "audio",
+    ShareClick = "share_click",
+    ShareSelect = "share_select",
+    ShareSuccess = "share_success",
+    PlaybackPause = "playback_pause",
+    PlaybackPlay = "playback_play"
+}
 export declare const StoryToAdActionMapper: {
     story_page_start: AdAction;
     story_page_exit: AdAction;
@@ -477,6 +488,29 @@ export type Interaction = {
     initData: string;
     designOverridesStr: string;
 };
+export type InteractionDB = Pick<Interaction, 'id' | 'initData'> & {
+    userResponse?: string;
+};
+export declare const ANSWER_FEEDBACK_VIBRATE_PATTERNS: Record<string, number[]>;
+export type InteractionAnalyticCustomEvent = {
+    action: InteractionAction;
+    body: Partial<InteractionEvent>;
+};
+export type InteractionIframeResponse = {
+    type: 'USER_RESPONSE';
+    data: {
+        newInitData: string;
+        userResponse: string;
+    };
+};
+export type InteractionIframeVibrate = {
+    type: 'USER_VIBRATE';
+    data: {
+        type: keyof typeof ANSWER_FEEDBACK_VIBRATE_PATTERNS;
+    };
+};
+export type InteractionIframeCustomEvent = InteractionIframeResponse | InteractionIframeVibrate;
+export declare const INTERACTION_ANALYTICS = "INTERACTION_ANALYTICS";
 
 export interface ILayerContent {
     renditions: IRendition[];
@@ -584,8 +618,20 @@ export declare enum InternalEvent {
     AD_RESUMED = "ad_resumed"
 }
 
+export declare const HttpStatus: {
+    readonly Ok: 200;
+    readonly Created: 201;
+    readonly NoContent: 204;
+    readonly BadRequest: 400;
+    readonly Unauthorized: 401;
+    readonly Forbidden: 403;
+    readonly NotFound: 404;
+    readonly InternalServerError: 500;
+};
+
 export * from './error-codes.enum';
 export * from './event.enum';
+export * from './http-status.enum';
 
 export interface WidgetsTagNameMap {
     'blaze-sdk': BlazeWidgetSDK;
@@ -713,6 +759,11 @@ export interface CustomNativeAdHandler {
     provideAdExtraParams?: (args: CustomNativeArgs) => CustomNativeTargeting;
 }
 
+export interface ISmoothOpenCloseModal {
+    storyId?: string;
+    pageIndex: number;
+}
+
 export interface IBlazeSDKOptions {
     apiKey: string;
     environment?: EnvironmentType;
@@ -720,17 +771,14 @@ export interface IBlazeSDKOptions {
     previewUrl?: string;
     previewMomentUrl?: string;
     doNotTrack?: boolean;
-    externalUserId?: string;
     geoLocation?: string;
     staticContent?: boolean;
     runInShadowDom?: boolean;
     playerStyleCustomization?: Partial<StoryPlayerStyle>;
     shouldModifyUrlWithStoryId?: boolean;
     shouldDismissPlayer?: boolean;
-}
-export interface ISmoothOpenCloseModal {
-    storyId?: string;
-    pageIndex: number;
+    shouldCreateUser?: boolean;
+    externalUserId?: string | null;
 }
 
 export interface IButtonPlayerNavigationConfig {
@@ -790,6 +838,10 @@ export interface IDrawable {
     render: () => void;
 }
 
+export interface IHttpResponse<T = any> extends IResponse<T> {
+    httpStatus?: number;
+}
+
 export interface IIcons {
     play: string;
     pause: string;
@@ -808,11 +860,13 @@ export interface IIcons {
 }
 
 export * from './ad-handler.interface';
+export * from './behaviors.interface';
 export * from './blaze-sdk.interface';
 export * from './button.interface';
 export * from './database.interface';
 export * from './device.interface';
 export * from './drawable.interface';
+export * from './http-response.interface';
 export * from './icons.interface';
 export * from './player.interface';
 export * from './response.interface';
@@ -829,7 +883,7 @@ export default interface IntersectionObservable {
 export type ScreenMode = 'Full Screen' | 'Embedded';
 
 export interface IResponse<T = any> {
-    data: T;
+    data?: T;
     error?: Error;
 }
 
@@ -891,7 +945,7 @@ declare const AdServiceClass_base: {
 declare abstract class AdServiceClass extends AdServiceClass_base implements IService {
     canRunAds: boolean;
     init(): Promise<void>;
-    pushCustomNativeAdsBetweenStories(defaultAdsInfo: IAdInfo | undefined, widgets: BlazeWidgetStory[], stories: IStory[], index: number, playerLayout: StoryPlayerStyle, showInteraction: boolean, mode?: ScreenMode): void;
+    pushCustomNativeAdsBetweenStories(defaultAdsInfo: IAdInfo | undefined, widgets: BlazeWidgetStory[], stories: IStory[], index: number, playerLayout: StoryPlayerStyle, mode?: ScreenMode): void;
 }
 export declare const AdService: AdServiceClass;
 
@@ -909,6 +963,7 @@ declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base
     pushStoryEvent(action: StoryAction, body: Partial<StoryEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushAdEvent(action: AdAction, body: Partial<AdEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushImaAdEvent(action: ImaAdAction, body: Partial<ImaAdEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
+    pushInteractionEvent(action: InteractionAction, body: Partial<InteractionEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushWidgetEvent(action: WidgetAction, body: Partial<WidgetEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     setupEvent(category: Category, action: string, body: object, label?: string | undefined, referrer?: ReferringEventInfo | undefined): AnalyticsEvent;
 }
@@ -916,7 +971,8 @@ export declare const AnalyticsService: AnalyticsServiceClass;
 export declare enum Category {
     Story = "story",
     Widget = "widget",
-    Ad = "ad"
+    Ad = "ad",
+    Interaction = "interaction"
 }
 declare class UserEventInfo {
     'generated_user_id': string;
@@ -1001,6 +1057,7 @@ export declare class AnalyticsEvent {
     story: Partial<StoryEvent> | undefined;
     widget: Partial<WidgetEvent> | undefined;
     ad: Partial<AdEvent> | undefined;
+    interaction: Partial<InteractionEvent> | undefined;
 }
 export declare class StoryEvent {
     'story_start_id': string;
@@ -1085,6 +1142,19 @@ export declare class ImaAdEvent {
     'failure_reason': string;
     'ad_type': string;
 }
+export declare class InteractionEvent {
+    'interaction_id': string;
+    'interaction_type': string;
+    'interaction_text': string;
+    'interaction_selected_answer': string;
+    'content_session_id': string;
+    'content_type': string;
+    'content_id': string;
+    'content_title': string;
+    'content_page_id': string;
+    'playback_action_method': string;
+    'audio_state': string;
+}
 
 declare const ApiServiceClass_base: {
     new (): {};
@@ -1097,35 +1167,44 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     private setAdsOnStories;
     getStoriesByIds(storyIds: string[], orderType?: OrderType): Promise<{
         result: IStory[];
-        data: {
+        httpStatus?: number | undefined;
+        data?: {
             assetsExpiryTime: string;
             totalItems: number;
             result: IStory[];
             defaultAdsInfo?: IAdInfo | undefined;
-        };
+        } | undefined;
         error?: Error | undefined;
     }>;
     getStories(labels: string, orderType: OrderType, maxItemsSize?: number, labelsPriority?: string): Promise<{
         result: IStory[];
-        data: {
+        httpStatus?: number | undefined;
+        data?: {
             assetsExpiryTime: string;
             totalItems: number;
             result: IStory[];
             defaultAdsInfo?: IAdInfo | undefined;
-        };
+        } | undefined;
         error?: Error | undefined;
     }>;
-    getShorts(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<IResponse<{
+    getShorts(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<import("../interfaces").IHttpResponse<{
         assetsExpiryTime: string;
         totalItems: number;
         result: IMoment[];
     }>>;
     getStaticStories(): Promise<IStory | null>;
-    preview(storyId: string, publishedOnly?: boolean): Promise<IResponse<IStory & {
+    preview(storyId: string, publishedOnly?: boolean): Promise<import("../interfaces").IHttpResponse<IStory & {
         status: number;
     }>>;
     preivewMoment(momentId: string, publishedOnly?: boolean): Promise<IResponse<any>>;
-    analyticsEvents(body: Partial<AnalyticsEvent>[]): Promise<IResponse<unknown>>;
+    analyticsEvents(body: Partial<AnalyticsEvent>[]): Promise<import("../interfaces").IHttpResponse<unknown>>;
+    sendInteractionResponse(options: {
+        interactionId: Interaction['id'];
+        responseId: string;
+        interactionType: Interaction['type'];
+    }): Promise<void>;
+    getUserToken(body: GetUserTokenRequest): Promise<import("../interfaces").IHttpResponse<TokenData>>;
+    refreshUserToken(body: RefreshUserTokenRequest): Promise<import("../interfaces").IHttpResponse<TokenData>>;
 }
 export declare const ApiService: ApiServiceClass;
 
@@ -1143,7 +1222,6 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _previewMomentUrl;
     private _sendAnaltyics;
     private _doNotTrack;
-    private _externalUserId;
     private _geoLocation;
     private _staticContent;
     private _runInShadowDom;
@@ -1151,6 +1229,8 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _shouldDismissPlayer;
     private _googleCustomNativeAdHandler?;
     private _playerStyleCustomization?;
+    private _shouldCreateUser;
+    private _externalUserId;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private _urls;
@@ -1159,9 +1239,10 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     get environment(): EnvironmentType;
     private set environment(value);
     get sendAnalytics(): boolean;
+    get shouldCreateUser(): boolean;
     get analyticsApiUrl(): string;
-    get externalUserId(): string;
-    set externalUserId(value: string);
+    get externalUserId(): string | null;
+    set externalUserId(value: string | null);
     get doNotTrack(): boolean;
     set doNotTrack(value: boolean);
     get geoLocation(): string;
@@ -1195,17 +1276,19 @@ declare abstract class DatabaseServiceClass extends DatabaseServiceClass_base im
     onUpgradeNeeded(db: IDBDatabase): Promise<void>;
     getPageViewed(id: string): Promise<any>;
     updatePageViewed(id: string, storyId: string): Promise<any>;
-    getUserId(): Promise<import("../interfaces").IResponse<{
+    getUserId(): Promise<IResponse<{
         id: string;
         value: string;
     }>>;
-    updateUserId(id: string): Promise<import("../interfaces").IResponse<{
+    updateUserId(id: string): Promise<IResponse<{
         id: string;
         value: string;
     }>>;
     update(tableName: string, value: any): Promise<any>;
     enrichStories(stories: IStory[]): Promise<IStory[]>;
     isPageViewed(id: string): Promise<boolean>;
+    updateInteraction(data: InteractionDB): Promise<any>;
+    getInteraction(id: string): Promise<IResponse<InteractionDB> | null>;
 }
 export declare const DatabaseService: DatabaseServiceClass;
 
@@ -1273,6 +1356,7 @@ export * from './database.service';
 export * from './error.service';
 export * from './event-bus.service';
 export * from './event.service';
+export * from './interaction.service';
 export * from './logger.service';
 export * from './startup.service';
 export * from './user.service';
@@ -1280,6 +1364,19 @@ export * from './video-cache.service';
 export * from './video-player.service';
 export * from './widgets.service';
 
+declare const InteractionServiceClass_base: {
+    new (): {};
+    _instance: InteractionServiceClass;
+    getInstance(): InteractionServiceClass;
+};
+declare abstract class InteractionServiceClass extends InteractionServiceClass_base implements IService {
+    constructor();
+    init(): Promise<void>;
+    updateInteraction(data: InteractionDB): Promise<void>;
+    getInteraction(id: InteractionDB['id']): Promise<InteractionDB | null | undefined>;
+}
+export declare const InteractionService: InteractionServiceClass;
+
 interface LoggerParams {
     message: string;
     level?: LogLevel;
@@ -1334,6 +1431,13 @@ declare abstract class UserServiceClass extends UserServiceClass_base implements
     init(): Promise<void>;
     onBlazeDatabaseServiceOpen(): Promise<void>;
     getUserId(): Promise<string | null>;
+    private makeSureCurrentExternalUserTokenExists;
+    getAndStoreNewUserToken(): Promise<void>;
+    refreshUserToken(): Promise<void>;
+    private storeUserTokenData;
+    getUserTokenDataFromStorage(): TokenData | undefined;
+    private setStorageItem;
+    private getStorageItem;
 }
 export declare const UserService: UserServiceClass;
 
@@ -1947,6 +2051,7 @@ export * from './severity.type';
 export * from './size.type';
 export * from './story-direction.type';
 export * from './thumbnail.type';
+export * from './user.type';
 export * from './widget.type';
 
 export type EntitiesType = 'playerId' | 'teamId' | 'gameId';
@@ -1988,6 +2093,18 @@ export type ThumbnailType = 'SQUARE_ICON' | 'VERTICAL_TWO_BY_THREE' | 'CUSTOM';
 export type ThumbnailShape = 'Circle' | 'Rectangle';
 export declare function thumbnailMapping(thumbnailType: ThumbnailType): ThumbnailApiType;
 
+export type GetUserTokenRequest = {
+    externalId: string | null;
+};
+export type RefreshUserTokenRequest = GetUserTokenRequest & {
+    tokenData: TokenData;
+};
+export type TokenData = {
+    accessToken: string;
+    refreshToken: string;
+    userId: string;
+};
+
 export type WidgetType = 'Row' | 'Grid';
 
 interface ChipSizeOptions {
@@ -2216,10 +2333,21 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
 
 export declare class BlazeWidgetInteraction extends BaseWidget {
     private iframe;
+    private interaction?;
+    private isActive;
+    private shouldForceHide;
+    private responseHandler;
+    private focusMainWindowHandler;
+    private orientationChangeHandler;
     loadInteraction(interactionData: Interaction): void;
-    showInteraction(): void;
+    showInteraction(interactionData?: Interaction): void;
     hideInteraction(): void;
     unloadInteraction(): void;
+    private onUserResponse;
+    private pushAnalyticsEvent;
+    private focusMainWindow;
+    private initInteraction;
+    private orientationChange;
 }
 
 export interface BlazeWidgetItemOptions {
@@ -2712,7 +2840,7 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
     constructor(parentWidget: HTMLElement, playerLayout: StoryPlayerStyle);
     handleOnStoryChange(mode: StoryDirectionType): void;
     setTheme(theme: IWidgetTheme): void;
-    setStories(stories: IStory[], showInteraction?: boolean, defaultAdsInfo?: IAdInfo): void;
+    setStories(stories: IStory[], defaultAdsInfo?: IAdInfo): void;
     seek(id: string): void;
     handleExit(): void;
     onKeyDown(ev: KeyboardEvent): void;
@@ -2849,7 +2977,6 @@ export declare class BlazeWidgetStoryPreview extends BlazeWidgetStory {
 }
 
 export declare class BlazeWidgetStoryVideo extends BlazeWidgetStoryBase {
-    private disableInteraction;
     data: IPage | undefined;
     video: HTMLVideoElement;
     loader: HTMLElement;
@@ -2875,7 +3002,7 @@ export declare class BlazeWidgetStoryVideo extends BlazeWidgetStoryBase {
     googleIMA: any;
     isCurrentlyTryingToRunImaAd: boolean;
     hasPoster: boolean;
-    constructor(storyParent: BlazeWidgetStory, disableInteraction?: boolean);
+    constructor(storyParent: BlazeWidgetStory);
     connectedCallback(): void;
     disconnectedCallback(): void;
     setData(data: IPage): void;
@@ -2914,6 +3041,7 @@ export declare class BlazeWidgetStoryVideo extends BlazeWidgetStoryBase {
     onContentResumeRequested(): void;
     removeAdLoader(): void;
     loadInteraction(): void;
+    handleInteractionEvent(event: CustomEvent<InteractionAnalyticCustomEvent>): void;
 }
 
 export declare class BlazeWidgetStory extends HTMLElement {
@@ -2996,7 +3124,7 @@ export declare class BlazeWidgetStory extends HTMLElement {
     muteToggle(): boolean;
     setWidgetParent(parent: BlazeWidgetItem): void;
     resetStoryLocationIndexToLastUnseen(): void;
-    setData(data: any, showInteraction?: boolean): void;
+    setData(data: any): void;
     get currentPage(): BlazeWidgetStoryBase;
     get nextPage(): BlazeWidgetStoryBase;
     get prevPage(): BlazeWidgetStoryBase;