@wscsports/blaze-web-sdk 0.3.6 → 0.3.8

package/package.json

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

package/publish/index.d.ts

@@ -409,15 +409,28 @@ interface UpdateLocationContentHashParams {
     contentId?: string;
     isAd?: boolean;
 }
+export declare const URL_PARAMS: {
+    readonly SESSION_ID: "wsc_session_id";
+    readonly USER_ID: "wsc_user_id";
+    readonly EXCLUDE_CONTENT_ID: "wsc_exclude_content_id";
+};
 export declare class URLManager {
     static isUpdateLocationByScript: boolean;
     static isBackWasCalled: boolean;
+    static isAutoAdvancingEnabled: boolean;
     static resetLocationAfterContentClose(): void;
     static resetLocation(): void;
     static updateLocationContentHash(params: UpdateLocationContentHashParams): void;
     static getHashMatch(): boolean;
     static getHash(): string;
     static updateContentInHash(contentId: string, contentType: ContentType): void;
+    static appendUrlForPrefetch(url?: string, timeout?: number): void;
+    static navigateToLink(url: string): void;
+    static removeUrlParamFromSearchParams(param: string, searchParams: URLSearchParams): URLSearchParams;
+    static removeStringParamsFromCurrentUrl(paramsToDelete: string | string[]): void;
+    static updateParamInUrl(param: string, value: string): void;
+    static updateCurrentUrlWithParams(params: URLSearchParams): void;
+    static navigateTo(navigationFeature: 'AUTO_ADVANCE'): Promise<void>;
 }
 
 export declare class BlazeAlert extends BaseWidget {
@@ -1085,6 +1098,8 @@ export interface IBlazeSDKOptions {
     externalUserId?: string | null;
     prefetchingPolicy?: PrefetchingPolicyType;
     shouldAllowHorizontalStories?: boolean;
+    shouldAutoAdvance?: boolean;
+    autoAdvanceUrl?: string;
 }
 
 export interface IButtonPlayerNavigationConfig {
@@ -1343,7 +1358,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
         data?: StoriesResponse | undefined;
         error?: Error | undefined;
     }>;
-    getStories(labels: string, orderType?: OrderType, maxItemsSize?: number, labelsPriority?: string): Promise<{
+    getStoriesByLabels(labels: string, orderType?: OrderType, maxItems?: number, labelsPriority?: string): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
         data?: StoriesResponse | undefined;
@@ -1354,7 +1369,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
         data?: MomentsResponse | undefined;
         error?: Error | undefined;
     }>;
-    getMomentsByLabels(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
+    getMomentsByLabels(labels: string, orderType?: OrderType, maxItems?: number): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
     updateMomentLikeStatus(options: {
         momentId: string;
         setLiked: boolean;
@@ -1394,6 +1409,8 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _runInShadowDom;
     private _shouldModifyUrlWithStoryId;
     private _shouldDismissPlayer;
+    private _shouldAutoAdvance;
+    private _autoAdvanceUrl;
     private _googleCustomNativeAdHandler?;
     private _imaAdHandler?;
     private _playerStyleCustomization?;
@@ -1401,6 +1418,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _externalUserId;
     private _prefetchingPolicy;
     private _shouldAllowHorizontalStories;
+    private _excludeContentId;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private _urls;
@@ -1429,12 +1447,16 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     set playerStyleCustomization(value: Partial<StoryPlayerStyle>);
     get shouldModifyUrlWithStoryId(): boolean;
     get shouldDismissPlayer(): boolean;
+    get shouldAutoAdvance(): boolean;
+    get autoAdvanceUrl(): string | undefined;
     get googleCustomNativeAdHandler(): CustomNativeAdHandler | undefined;
     set googleCustomNativeAdHandler(value: CustomNativeAdHandler | undefined);
     get imaAdHandler(): ImaAdHandler | undefined;
     set imaAdHandler(value: ImaAdHandler | undefined);
     get prefetchingPolicy(): PrefetchingPolicyType;
     set prefetchingPolicy(value: PrefetchingPolicyType);
+    get excludeContentId(): string | undefined;
+    set excludeContentId(value: string | undefined);
 }
 export declare const ConfigService: ConfigServiceClass;
 
@@ -1453,7 +1475,7 @@ declare abstract class DatabaseServiceClass extends DatabaseServiceClass_base im
         id: string;
         value: string;
     }>>;
-    updateUserId(id: string): Promise<IResponse<{
+    updateUserId(userId: string): Promise<IResponse<{
         id: string;
         value: string;
     }>>;
@@ -1609,9 +1631,9 @@ declare const MomentServiceClass_base: {
 };
 declare abstract class MomentServiceClass extends MomentServiceClass_base implements IService {
     init(): void;
+    fetchContent(dataSource: BlazeDataSourceType): Promise<MomentsResponse>;
     updateMomentReadStatusById(momentId: string): Promise<any>;
     encrichMoment(moment: IMoment[]): Promise<IMoment[]>;
-    getMoments(dataSource: any): Promise<MomentsResponse>;
 }
 export declare const MomentService: MomentServiceClass;
 
@@ -1625,13 +1647,17 @@ declare abstract class StartupServiceClass extends StartupServiceClass_base impl
 }
 export declare const StartupService: StartupServiceClass;
 
-export declare class StoryService {
-    static fetchStories(dataSource: BlazeDataSourceType): Promise<{
-        data: any;
-        error: any;
-    }>;
-    static enrichStories(stories: IStory[]): Promise<IStory[]>;
+declare const StoryServiceClass_base: {
+    new (): {};
+    _instance: StoryServiceClass;
+    getInstance(): StoryServiceClass;
+};
+declare abstract class StoryServiceClass extends StoryServiceClass_base implements IService {
+    init(): void;
+    fetchContent(dataSource: BlazeDataSourceType): Promise<StoriesResponse>;
+    enrichStories(stories: IStory[]): Promise<IStory[]>;
 }
+export declare const StoryService: StoryServiceClass;
 
 declare const UserServiceClass_base: {
     new (): {};
@@ -1645,8 +1671,12 @@ declare abstract class UserServiceClass extends UserServiceClass_base implements
     get userId(): string;
     get sessionId(): string;
     init(): Promise<void>;
+    private ensureSessionId;
+    assignUserId(): Promise<void>;
     onBlazeDatabaseServiceOpen(): Promise<void>;
-    getUserId(): Promise<string | null>;
+    private getUserId;
+    private fetchUserIdFromDatabase;
+    private handleMissingUserId;
     private makeSureCurrentExternalUserTokenExists;
     getAndStoreNewUserToken(): Promise<void>;
     refreshUserToken(): Promise<void>;
@@ -1699,12 +1729,16 @@ declare abstract class VideoPlayerServiceClass extends VideoPlayerServiceClass_b
     private _isModalOpen;
     private _isSeekBarDragging;
     private _playReference;
+    private _currentPlayedContentId;
     muteStateBeforeAd: 'mute' | 'unmute' | 'no-ad';
     playerLoadingSpinner: HTMLElement | undefined;
     constructor();
     init(): Promise<void>;
     get isMuted(): boolean;
     set isMuted(value: boolean);
+    private updateExcludeContentIdFromURL;
+    get currentlyPlayedContentId(): string;
+    set currentlyPlayedContentId(value: string);
     get isPlaying(): boolean;
     set isPlaying(value: boolean);
     get isNavigating(): boolean;
@@ -1782,6 +1816,7 @@ export interface LayoutStyle {
     isSkeleton: boolean;
     labelStyle: LabelStyle;
     lines: number;
+    wordBreak: string;
     horizontalItemsSpacing: number;
     verticalItemsSpacing: number;
     borderWidth: number;
@@ -1804,6 +1839,7 @@ export interface LabelStyle {
     padding: string;
     font: string;
     fontSize: string;
+    fontWeight: FontWeightType;
     textAlign?: string;
     position: PositionType;
 }
@@ -1912,7 +1948,6 @@ export interface MomentPlayerStyle {
     buttons: BlazeMomentsPlayerButtonsStyle;
     icons: BlazeMomentIconsStyle;
     iconsButtonOrder: IconButtonType[];
-    iconsPosition: IconsPositionType;
     contentBoxHorizontalSpacing: string;
     seekBar: BlazeMomentsPlayerSeekBarStyle;
     ctaButton: BlazeMomentsPlayerCtaStyle;
@@ -2310,7 +2345,7 @@ export declare function AttributeParser<TBase extends GHTMLElement>(Base: TBase)
     };
 } & TBase;
 
-export type ButtonType = 'ALL' | 'PAGE_NAVIGATION_ONLY' | 'STORY_NAVIGATION_ONLY';
+export type ButtonType = 'ALL' | 'PAGE_NAVIGATION_ONLY' | 'STORIES_NAVIGATION_ONLY';
 export type ButtonState = 'ACTIVE' | 'DISABLED';
 export declare enum ButtonNavigation {
     PREV_STORY = 0,
@@ -2392,7 +2427,7 @@ export type LocaleDirectionType = 'LTR' | 'RTL';
 export type OrderType = 'Manual' | 'AtoZ' | 'ZtoA' | 'RecentlyUpdatedFirst' | 'RecentlyUpdatedLast' | 'RecentlyCreatedFirst' | 'RecentlyCreatedLast';
 export type ContentOrderType = 'LIVE_CHIP' | 'STORY_TITLE' | 'PUBLISHED_DATE';
 
-export declare const PlayTypeArray: readonly ["Widget", "Share", "SingleStory"];
+export declare const PlayTypeArray: readonly ["Widget", "Share", "SingleStory", "AutoAdvance"];
 export type PlayType = typeof PlayTypeArray[number];
 
 export type PositionInsideType = 'insideTopLeft' | 'insideTopRight' | 'insideTop' | 'insideTopMiddle' | 'insideBottomRight' | 'insideBottomLeft' | 'insideBottom' | 'insideBottomMiddle' | 'insideMiddle' | 'insideMiddleLeft' | 'insideMiddleRight';
@@ -2422,7 +2457,7 @@ 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 StartTriggerType = 'Embedded Player in Viewport' | 'UI Button' | 'Widget' | 'Deeplink' | 'Swipe' | 'Skip' | 'SingleStory' | 'Share' | 'AutoAdvance' | '';
 
 export type GetUserTokenRequest = {
     externalId: string | null;
@@ -2781,7 +2816,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     addDelegateListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions | undefined): void;
     set storyIds(value: string);
     set contentIds(value: string);
-    setContentIds(storyIds: string[], options?: ISetWidgetOptions): void;
+    setContentIds(ids: string[], options?: ISetWidgetOptions): void;
     setLabelsPriority(labelsPriority: string | string[] | BlazeWidgetLabel[], options?: ISetWidgetOptions): void;
     setLabels(labels: string | string[] | BlazeWidgetLabel, options?: ISetWidgetOptions): void;
     getTheme(): IWidgetTheme;
@@ -2796,7 +2831,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     setDelegations(delegates: Record<Delegation, EventListenerOrEventListenerObject>): void;
     private setOrderType;
     setMaxItemsDisplaySize(maxSize: number): void;
-    setMaxItemsSize(maxItemsSize?: number): void;
+    setMaxItemsSize(maxItemsSize?: number, options?: ISetWidgetOptions): void;
     private updatePlayerStyle;
     private createModal;
     private appendModalToBlazeSDK;
@@ -2962,12 +2997,11 @@ export declare class BlazeWidgetScrollable extends BaseWidget {
     render(): void;
 }
 
-export type playRefType = 'Share' | 'SingleStory';
+export type playRefType = 'Share' | 'SingleStory' | 'AutoAdvance';
 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;
@@ -2985,7 +3019,6 @@ 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): Promise<void>;
     private getConfigAttributes;
     private initialize;
     private injectToHead;
@@ -3436,7 +3469,7 @@ export declare class BlazeWidgetMoment extends BlazeWidgetContent {
     resume(): void;
     resetPosition(): void;
     restartVideo(): void;
-    adjustAdView(): void;
+    adjustContentView(): void;
     event(action: MomentAction, momentData: Partial<MomentEvent>, label?: string | undefined): Promise<void>;
     render(): void;
 }
@@ -3460,6 +3493,7 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
     open(options?: ISmoothOpenCloseModal): void;
     play(): void;
     render(): void;
+    private shouldShowExitButton;
     playToggleCurrentStory(): void;
     onResize(): void;
     onResizeEventDelay(): void;
@@ -3487,7 +3521,12 @@ export declare class BlazeWidgetStoryPlayer extends WidgetAbstractPlayer {
     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;
+    animateCloseWithDirection(options: {
+        direction: Direction;
+        callback?: () => void;
+        exitTrigger?: ExitTriggerType;
+        navigationType?: NavigationType;
+    }): void;
     onKeyDown(event: KeyboardEvent): false | undefined;
     render(): void;
     loadContentBatch(): void;
@@ -3551,16 +3590,19 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     adContext?: IAdContext;
     bannerAdElement?: BlazeWidgetBannerAd;
     constructor(playerStyle: StoryPlayerStyle, mode: ScreenMode);
-    private isButtonVisible;
+    isButtonVisible(iconName: IconButtonType | StoryDirectionType): boolean | undefined;
     private createPlayerButtonsAndAppendToButtonsContainer;
     private createNavigationButtonsAndAppendToWidgetStoryContainer;
+    private createResumeAfterBlurButton;
     private applyIconStyle;
     onShareClick(): Promise<void>;
     private updateCtaButtonLayout;
     private updateChip;
     setTheme(playerStyle: StoryPlayerStyle): void;
+    private disableStoriesNavigationButtons;
+    private disablePageNavigationButtons;
     private setButtonNavigationAsDisabled;
-    adjustAdView(): void;
+    adjustContentView(): void;
     private setPlayerButtonPosition;
     updatePlayerButtonIcons(): void;
     handleCtaAction(event: Event, gestureType: StoryGestureType): boolean;
@@ -3601,6 +3643,10 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     resetPosition(): void;
     updateWidgetStatusReadUnread(): void;
     markAsRead(): Promise<any>;
+    private hasNoMorePagesToPlay;
+    isLastPage(): boolean;
+    private isAutomaticNavigation;
+    private handleLastPageAutomaticNavigation;
     goNextPage(navigationType?: NavigationType): void;
     goPrevPage(): void;
     disconnectedCallback(): void;
@@ -3608,6 +3654,8 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     updateCta(pageIndex: number): void;
     updatePlayerButtonsState(displayPageNavigationButtons?: boolean): void;
     updateButtonState(buttonType: ButtonNavigation, button: BlazeButton | undefined): void;
+    private isSingleStoryWithAutoAdvance;
+    private isStoryPagesNavigation;
     isNavigationButtonActive(navigationType: ButtonNavigation): boolean;
     updateNavButton(state: ButtonState, navButtonElement: BlazeButton): void;
     updatePlayerButtonsStyleAttributes(): void;