@wscsports/blaze-web-sdk 0.2.6 → 0.2.7

package/package.json

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

package/publish/index.d.ts

@@ -357,7 +357,6 @@ export * from './url';
 export * from './data-source.class';
 
 export declare class BlazeWidgetLabel {
-    every(arg0: (item: any) => item is BlazeWidgetLabel): void;
     value: string;
     constructor(value: string);
     static singleLabel(label: string): BlazeWidgetLabel;
@@ -715,11 +714,13 @@ interface IAdInfoConfiguration {
     adsLocationType: 'FixedPages' | 'EveryXStories';
     type: 'Story' | 'Moment';
 }
+export type IAdContext = Record<string, string>;
 export interface IAdInfo {
     path?: string;
     tag?: string;
     type: 'Web' | 'IMA';
     configuration?: IAdInfoConfiguration;
+    context?: IAdContext;
 }
 
 export interface IContent {
@@ -821,6 +822,7 @@ export interface IMoment extends IContent {
 export type MomentDB = {
     id: string;
     liked: boolean;
+    viewed: boolean;
 };
 
 export interface IContentPage {
@@ -837,6 +839,7 @@ export interface IContentPage {
     createTime: string;
     shouldShowImaAd?: boolean;
     imaUrl?: string;
+    adContext?: IAdContext;
     interaction?: Interaction;
     poster?: IThumbnail;
 }
@@ -1205,6 +1208,7 @@ export interface IWidgetViewOptionsBase {
     delegates?: Record<Delegation, EventListenerOrEventListenerObject>;
     perItemStyleOverrides?: PerItemStyleOverrides;
     shouldOrderWidgetByReadStatus?: boolean;
+    contentIds?: string[];
 }
 export interface IWidgetViewOptionsWithLabels extends IWidgetViewOptionsBase {
     labels: string | string[] | BlazeWidgetLabel;
@@ -1224,7 +1228,7 @@ export interface IWidgetViewOptionsWithDataSource extends IWidgetViewOptionsBase
 export type IWidgetViewOptions = IWidgetViewOptionsWithLabels | IWidgetViewOptionsWithStoryIds | IWidgetViewOptionsWithDataSource;
 
 export interface IWidgetView extends HTMLElement {
-    setTheme: (theme: IWidgetTheme) => void;
+    setTheme: (theme: IWidgetTheme | ThemeType) => void;
     getTheme: () => IWidgetTheme;
     setLabels: (labels: string | string[] | BlazeWidgetLabel, options?: ISetWidgetOptions) => void;
     setLabelsPriority: (labelsPriority: string | string[] | BlazeWidgetLabel[], options?: ISetWidgetOptions) => void;
@@ -1279,6 +1283,14 @@ declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base
 }
 export declare const AnalyticsService: AnalyticsServiceClass;
 
+export interface ApiResponse<T> {
+    assetsExpiryTime: string;
+    totalItems: number;
+    result: T[];
+    defaultAdsInfo?: IAdInfo;
+}
+export type MomentsResponse = ApiResponse<IMoment>;
+export type StoriesResponse = ApiResponse<IStory>;
 declare const ApiServiceClass_base: {
     new (): {};
     _instance: ApiServiceClass;
@@ -1291,40 +1303,21 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     getStoriesByIds(storyIds: string[], orderType?: OrderType): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
-        data?: {
-            assetsExpiryTime: string;
-            totalItems: number;
-            result: IStory[];
-            defaultAdsInfo?: IAdInfo | undefined;
-        } | undefined;
+        data?: StoriesResponse | undefined;
         error?: Error | undefined;
     }>;
     getStories(labels: string, orderType?: OrderType, maxItemsSize?: number, labelsPriority?: string): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
-        data?: {
-            assetsExpiryTime: string;
-            totalItems: number;
-            result: IStory[];
-            defaultAdsInfo?: IAdInfo | undefined;
-        } | undefined;
+        data?: StoriesResponse | undefined;
         error?: Error | undefined;
     }>;
-    getMomentByIds(momentIds: string[], orderType?: OrderType): Promise<{
+    getMomentByIds(ids: string[], orderType?: OrderType): Promise<{
         httpStatus?: number | undefined;
-        data?: {
-            assetsExpiryTime: string;
-            totalItems: number;
-            result: IMoment[];
-        } | undefined;
+        data?: MomentsResponse | undefined;
         error?: Error | undefined;
     }>;
-    getMoments(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<import("../interfaces").IHttpResponse<{
-        assetsExpiryTime: string;
-        totalItems: number;
-        result: IMoment[];
-        defaultAdsInfo?: IAdInfo | undefined;
-    }>>;
+    getMomentsByLabels(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
     updateMomentLikeStatus(options: {
         momentId: string;
         setLiked: boolean;
@@ -1417,8 +1410,6 @@ declare abstract class DatabaseServiceClass extends DatabaseServiceClass_base im
     onOpen(): Promise<void>;
     onError(e: Event): Promise<void>;
     onUpgradeNeeded(db: IDBDatabase): Promise<void>;
-    getPageViewed(id: string): Promise<any>;
-    updatePageViewed(id: string, storyId: string): Promise<any>;
     getUserId(): Promise<IResponse<{
         id: string;
         value: string;
@@ -1427,13 +1418,17 @@ declare abstract class DatabaseServiceClass extends DatabaseServiceClass_base im
         id: string;
         value: string;
     }>>;
-    update(tableName: string, value: any): Promise<any>;
-    enrichStories(stories: IStory[]): Promise<IStory[]>;
+    getPageViewed(id: string): Promise<any>;
+    updatePageViewed(id: string, storyId: string): Promise<any>;
     isPageViewed(id: string): Promise<boolean>;
+    enrichStories(stories: IStory[]): Promise<IStory[]>;
     updateInteraction(data: InteractionDB): Promise<any>;
     getInteraction(id: string): Promise<IResponse<InteractionDB> | null>;
     updateLike(momentId: string, isLike: boolean): Promise<IResponse | null>;
     getLike(momentId: string): Promise<IResponse<MomentDB> | null>;
+    updateViewedMoment(momentId: string): Promise<any>;
+    getViewedMoment(momentId: string): Promise<boolean>;
+    enrichMoments(moments: IMoment[]): Promise<IMoment[]>;
 }
 export declare const DatabaseService: DatabaseServiceClass;
 
@@ -1509,6 +1504,7 @@ export * from './user.service';
 export * from './video-cache.service';
 export * from './video-player.service';
 export * from './widgets.service';
+export * from './moment.service';
 export * from './story.service';
 
 declare const InteractionServiceClass_base: {
@@ -1567,6 +1563,19 @@ declare class LoggerServiceClass extends LoggerServiceClass_base implements ISer
 }
 export declare const LoggerService: LoggerServiceClass;
 
+declare const MomentServiceClass_base: {
+    new (): {};
+    _instance: MomentServiceClass;
+    getInstance(): MomentServiceClass;
+};
+declare abstract class MomentServiceClass extends MomentServiceClass_base implements IService {
+    init(): void;
+    updateMomentReadStatusById(momentId: string): Promise<any>;
+    encrichMoment(moment: IMoment[]): Promise<IMoment[]>;
+    getMoments(dataSource: any): Promise<MomentsResponse>;
+}
+export declare const MomentService: MomentServiceClass;
+
 declare const StartupServiceClass_base: {
     new (): {};
     _instance: StartupServiceClass;
@@ -2205,6 +2214,8 @@ export type FontWeightType = 'normal' | 'bold' | 'bolder' | 'lighter' | 'inherit
 export type TextTransformType = 'capitalize' | 'uppercase' | 'lowercase' | 'none';
 
 export type Direction = 'UP' | 'DOWN' | 'RIGHT' | 'LEFT';
+export type NavigationType = 'Automatic' | 'Manual' | '';
+export type NavigationDirectionType = 'Forwards' | 'Backwards' | '';
 
 export type ComponentsElementType = 'blaze-alert' | 'blaze-toast' | 'blaze-chip' | 'blaze-image';
 export type WidgetElementType = 'blaze-sdk';
@@ -2233,12 +2244,13 @@ export * from './user.type';
 export * from './widget.type';
 export * from './chip-status.type';
 export * from './prefetch.type';
+export * from './trigger.type';
 
-export type EntitiesType = 'playerId' | 'teamId' | 'gameId';
-export type PerItemStyleOverrides = Record<EntitiesType, Array<{
+export type EntitiesType = 'playerId' | 'teamId' | 'gameId' | 'roundId';
+export type PerItemStyleOverrides = Partial<Record<EntitiesType, Array<{
     name: string;
     theme: IWidgetTheme;
-}>>;
+}>>>;
 
 export type LabelsType = string | string[] | BlazeWidgetLabel;
 
@@ -2276,6 +2288,9 @@ export type ThumbnailType = 'SQUARE_ICON' | 'VERTICAL_TWO_BY_THREE' | 'CUSTOM';
 export type ThumbnailShape = 'Circle' | 'Rectangle';
 export declare function thumbnailMapping(thumbnailType: ThumbnailType): ThumbnailApiType;
 
+export type ExitTriggerType = 'Swipe' | 'Swipe Left' | 'Swipe Right' | 'Swipe Down' | 'Swipe Up' | 'Skip' | 'Close Button' | 'CTA Click' | 'Escape Button' | 'Stories Completed' | 'Story Completed' | '';
+export type StartTriggerType = 'Embedded Player in Viewport' | 'UI Button' | 'Widget' | 'Deeplink' | 'Swipe' | 'Skip' | 'SingleStory' | 'Share' | '';
+
 export type GetUserTokenRequest = {
     externalId: string | null;
 };
@@ -2334,6 +2349,11 @@ export declare function flattenObject<T extends Record<string, any>>(obj: T): Re
 export declare function mergeStyles(element: HTMLElement, styles: Partial<CSSStyleDeclaration>): object;
 export declare function getMaxValue(currentMax: string, newValue: string): string;
 export declare function isReadByLastUnIgnoredPageStatus(story: IStory): boolean;
+export declare function sortByHasViewed(a: {
+    hasViewed: boolean;
+}, b: {
+    hasViewed: boolean;
+}): number;
 export declare function applyPlayerStyleChanges(defaultPlayerStyle: StoryPlayerStyle, mergedPlayerStyle: StoryPlayerStyle, themePlayerStyle: StoryPlayerStyle, playerStyleChanges: any): void;
 export declare function getChangedProperties(source: any, target: any, level: string, playerStyleChanges: any, parentKeys?: string): void;
 export declare function removeDuplicates(source: string[], checkAgainst: string[]): string[];
@@ -2395,10 +2415,6 @@ export * from './widget-video';
 export * from './moment/widget-moment-seek-bar';
 export * from './widget-cta-modal';
 
-export type ExitTriggerType = 'Swipe' | 'Swipe Down' | 'Swipe Up' | 'Skip' | 'Close Button' | 'CTA Click' | 'Escape Button' | '';
-export type StartTriggerType = 'Embedded Player in Viewport' | 'UI Button' | 'Widget' | 'Deeplink' | 'Swipe' | 'Skip' | 'SingleStory' | 'Share' | '';
-export type NavigationType = 'Automatic' | 'Manual' | '';
-export type NavigationDirectionType = 'Forwards' | 'Backwards' | '';
 export declare abstract class BlazeWidgetContent extends HTMLElement {
     container: HTMLElement;
     pageIndex: number;
@@ -2421,6 +2437,7 @@ export declare abstract class BlazeWidgetContent extends HTMLElement {
     connectedCallback(): void;
     disconnectedCallback(): void;
     setWidgetItemParent(item: BlazeWidgetItem): void;
+    updateWidgetStatusReadUnread(): void;
     getRefferingObject(): ReferringEventInfo;
     render(): void;
 }
@@ -2612,27 +2629,29 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     shouldReloadData: boolean;
     get refElement(): ShadowRoot | BlazeWidgetLayout;
     constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
     onResizeEventDelay(): void;
     onResize(): void;
     handleHeightChangeMutation(mutationsList: MutationRecord[]): void;
     handleIntersection(entries: IntersectionObserverEntry[]): void;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     onKeyDown(e: KeyboardEvent): void;
-    onStoryChange(mode: ContentDirection): void;
+    onContentChange(mode: ContentDirection): void;
     onPlayerClose(): void;
     onPlayerOpen(): void;
     getParentHeightWithoutPadding(): number | null;
     setId(id: string): void;
+    handlePopState(): void;
     private setReloadData;
     addDelegateListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions | undefined): void;
     set storyIds(value: string);
+    set contentIds(value: string);
     setContentIds(storyIds: string[], options?: ISetWidgetOptions): void;
     setLabelsPriority(labelsPriority: string | string[] | BlazeWidgetLabel[], options?: ISetWidgetOptions): void;
     setLabels(labels: string | string[] | BlazeWidgetLabel, options?: ISetWidgetOptions): void;
     getTheme(): IWidgetTheme;
-    setTheme(theme: IWidgetTheme | string): void;
+    setTheme(theme: IWidgetTheme | ThemeType): void;
     private get theme();
     updateOverrideStyles(perItemStyleOverrides: PerItemStyleOverrides): void;
     reload(): void;
@@ -2645,11 +2664,14 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     setMaxItemsDisplaySize(maxSize: number): void;
     setMaxItemsSize(maxItemsSize?: number): void;
     private updatePlayerStyle;
-    createModal(type: string): void;
-    appendModalToBlazeSDK(modal: BlazeWidgetMomentModal | BlazeWidgetStoryModal): void;
+    private createModal;
+    private appendModalToBlazeSDK;
     static get observedAttributes(): string[];
-    onItemClick(item: BlazeWidgetItem, i: number): void;
-    loadContent(): Promise<void>;
+    private onItemClick;
+    private loadContent;
+    handleAssetsExpiry(data: {
+        assetsExpiryTime: string;
+    }): void;
     processStoriesInWidget(): void;
     calculateChipSizes(theme: IWidgetTheme): {
         badge: {
@@ -2686,10 +2708,11 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
         labelAdditionalWidth: number;
         labelAdditionalHeight: number;
     };
-    maxSize(): number;
     event(action: WidgetAction, data: Partial<WidgetEvent>, label?: string | undefined): void;
+    private reorderWidgets;
     updateWidgetsData(): void;
-    reorderWidgets(): void;
+    private updateWidgetDisplay;
+    private maxSize;
     connectWidgets(): void;
     get thumbnailShape(): ThumbnailShape;
     widgetType(): WidgetType;
@@ -2704,12 +2727,12 @@ export declare class BlazeWidgetModal extends BaseWidget {
     hammer: HammerManager | null;
     isMultiTouch: boolean;
     boundOnResizeEvent: (this: Window, ev: UIEvent) => void;
-    boundOnPopStateEvent: (this: Window, ev: PopStateEvent) => void;
+    onContentChange?: (mode: ContentDirection) => void;
     constructor(type: 'story' | 'moment');
     connectedCallback(): void;
     disconnectedCallback(): void;
     onResize(): void;
-    handlePopState(ev: PopStateEvent): void;
+    handleOnContentChange(mode: ContentDirection): void;
     seek(id: string): void;
     setupHammer(): void;
     handlePanStart(ev: HammerInput): void;
@@ -2741,6 +2764,7 @@ export declare abstract class WidgetAbstractPlayer extends BaseWidget {
     currentNextAnimation?: anime.AnimeInstance;
     currentPrevAnimation?: anime.AnimeInstance;
     onClose?: () => void;
+    onContentChange?: (mode: ContentDirection) => void;
     listeners: EventsListener;
     boundHandlePanStart: (ev: HammerInput) => void;
     boundHandlePanMove: (ev: HammerInput) => void;
@@ -2787,18 +2811,17 @@ export declare abstract class WidgetAbstractPlayer extends BaseWidget {
 
 export declare class BlazeWidgetScrollable extends BaseWidget {
     buttonsState: never[];
-    mouseMoveEvent: ((e: MouseEvent) => void | undefined) | undefined;
-    touchMoveEvent: ((e: TouchEvent) => boolean | undefined) | undefined;
-    clickEvent: ((e: MouseEvent) => void | undefined) | undefined;
+    boundOnMouseMoveEvent: (e: MouseEvent) => void;
+    boundOnClickEvent: (this: HTMLElement, ev: MouseEvent) => void;
+    boundOnMouseWheelEvent: (event: WheelEvent) => void;
     totalMovement: number;
     constructor();
-    render(): void;
     connectedCallback(): void;
+    disconnectedCallback(): void;
     onClick(event: MouseEvent): void;
     onMouseMove(event: MouseEvent): void;
     onMouseWheel(event: WheelEvent): void;
-    onTouchMove(event: TouchEvent): boolean;
-    disconnectedCallback(): void;
+    render(): void;
 }
 
 export type playRefType = 'Share' | 'SingleStory';
@@ -2852,6 +2875,7 @@ export declare class BlazeWidgetShareModal extends BaseWidget {
     onDrawerClose(): void;
     open(shareUrl: string): void;
     close(): void;
+    get isOpen(): boolean;
     renderButtons(): void;
     renderTitle(): void;
     render(): void;
@@ -3055,8 +3079,9 @@ export declare class BlazeWidgetMomentPlayer extends WidgetAbstractPlayer {
     handleNextDirection(): void;
     updateItemData(itemToReplaceWith: BlazeWidgetMoment & BlazeWidgetStory, nextItemToInsert: BlazeWidgetMoment | BlazeWidgetStory): void;
     createAnimation(content: BlazeWidgetMoment, direction: ContentDirection, targetIndex: number): AnimeTimelineInstance;
-    loadAndPlayContent(): Promise<void>;
+    handleAnimationStart(content: BlazeWidgetMoment, direction: ContentDirection): void;
     handleAnimationCompletion(content: BlazeWidgetMoment, mode: ContentDirection): Promise<void>;
+    loadAndPlayContent(): Promise<void>;
     setContent(content: BlazeWidgetMoment[]): void;
     preloadAdjacentContent(direction: ContentDirection): Promise<void>;
     prefetchPosters(): Promise<void>;
@@ -3161,6 +3186,7 @@ export declare class BlazeWidgetMoment extends BlazeWidgetContent {
     isActive: boolean;
     shouldShowImaAdOnStart: boolean;
     imaUrl: string;
+    adContext?: IAdContext;
     elementsToHideOnImaAds: (HTMLElement | undefined)[];
     elementsToHideOnCustomAds: (HTMLElement | undefined)[];
     constructor();
@@ -3233,13 +3259,11 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
     playerLayout: StoryPlayerStyle;
     onOpen?: () => void;
     onClose?: (options?: ISmoothOpenCloseModal) => void;
-    onStoryChange?: (mode: ContentDirection) => void;
     boundOnResizeEventDelay: (this: Window, ev: UIEvent) => void;
     boundOnKeyDown: (ev: KeyboardEvent) => void;
     constructor(parentWidget: HTMLElement, playerLayout: StoryPlayerStyle);
     connectedCallback(): void;
     disconnectedCallback(): void;
-    handleOnStoryChange(mode: ContentDirection): void;
     setTheme(theme: IWidgetTheme): void;
     setModalContent(stories: IStory[], indexOfContentInWidget: number, defaultAdsInfo?: IAdInfo): void;
     onKeyDown(ev: KeyboardEvent): void;
@@ -3255,7 +3279,6 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
 }
 
 export declare class BlazeWidgetStoryPlayer extends WidgetAbstractPlayer {
-    onStoryChange?: (mode: ContentDirection) => void;
     boundOnKeyDown: (event: KeyboardEvent) => Promise<void>;
     backgroundAnimation?: Animation;
     constructor();
@@ -3274,7 +3297,7 @@ export declare class BlazeWidgetStoryPlayer extends WidgetAbstractPlayer {
     resetStyles(): void;
     play(options?: ISmoothOpenCloseModal): void;
     loadAndPlayContent(): Promise<void>;
-    handleAnimationCompletion(content: BlazeWidgetStory, mode: ContentDirection): void;
+    handleAnimationCompletion(content: BlazeWidgetStory, direction: ContentDirection): void;
     createAnimation(content: BlazeWidgetStory, direction: ContentDirection, targetIndex: number): anime.AnimeTimelineInstance;
     handleAnimationStart(content: BlazeWidgetStory, targetContent: BlazeWidgetStory, direction: ContentDirection): void;
     closeWithAnimation(direction: Direction): void;
@@ -3301,8 +3324,8 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     type: string;
     progressElement: HTMLElement;
     onPageStart?: () => void;
-    onPrevStory?: () => void;
-    onNextStory?: () => void;
+    onPrevStory?: (navigation: NavigationType) => void;
+    onNextStory?: (navigation: NavigationType) => void;
     onClose?: () => void;
     buttonsContainer: BlazeDiv;
     playbackParts: HTMLElement[];
@@ -3337,6 +3360,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     requestAnimationId: number | null;
     shouldShowImaAdOnStart: boolean;
     imaUrl: string;
+    adContext?: IAdContext;
     constructor(playerStyle: StoryPlayerStyle, mode: ScreenMode);
     private isButtonVisible;
     private createPlayerButtonsAndAppendToButtonsContainer;
@@ -3381,13 +3405,13 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     onVisibilityChange(): void;
     onBlur(): void;
     onFocus(): void;
-    close(isDirectCloseCall?: boolean): void;
+    close(isDirectCloseCall?: boolean): Promise<void>;
     pause(): void;
     resume(): void;
     resetPosition(): void;
     updateWidgetStatusReadUnread(): void;
     markAsRead(): Promise<any>;
-    goNextPage(navigationType?: 'Automatic' | 'Manual'): void;
+    goNextPage(navigationType?: NavigationType): void;
     goPrevPage(): void;
     disconnectedCallback(): void;
     updateCTAButtonPosition(): void;