@wscsports/blaze-web-sdk 0.9.0 → 0.11.0

package/README.md

@@ -3,11 +3,4 @@ Welcome to WSC Sports Web SDK.
 
 # Getting Started
 Please visit out documentation website for installation guides:<br/>
-https://dev.wsc-sports.com/docs/sdk-integration
-
-# Local Development
-To run the project locally, follow these steps:
-1. Install Docker on your local machine
-2. run `npm run start:dev-docker` in the root directory of the project
-3. Open your browser and navigate to `http://localhost:3005`
-
+https://dev.wsc-sports.com/docs/sdk-integration

package/package.json

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

package/publish/index.d.ts

@@ -29,6 +29,7 @@ export declare function playContent(contentType: ContentType, options: PlayConte
 export declare function setAbTestParams(abTestParams: BlazeAbTestType): void;
 export declare function getAppContextManager(): Record<string, any>;
 export declare const pushConsentEvent: (action: string, body: Record<string, any>) => void;
+export declare const isInitialized: () => boolean;
 declare const _default: {
     Initialize: typeof Initialize;
     WidgetGridView: typeof WidgetGridView;
@@ -52,6 +53,7 @@ declare const _default: {
     setAbTestParams: typeof setAbTestParams;
     getAppContextManager: typeof getAppContextManager;
     pushConsentEvent: (action: string, body: Record<string, any>) => void;
+    isInitialized: () => boolean;
 };
 export default _default;
 
@@ -376,7 +378,12 @@ export declare class BlazeDataSourceValidations {
     static validateFormat(dataSource: BlazeDataSourceType): void;
 }
 
-export declare function debounce<T extends (...args: any[]) => any>(func: T, delay: number): (...args: Parameters<T>) => void;
+export declare function debounce<T extends (...args: any[]) => any>(func: T, delay: number): {
+    (...args: Parameters<T>): void;
+    cancel(): void;
+} & {
+    cancel: () => void;
+};
 
 export declare const Platform: {
     readonly Console: "console";
@@ -1238,7 +1245,7 @@ export interface IStory extends IContent {
 }
 
 export interface IThumbnail {
-    type: 'SquareIcon' | 'VerticalTwoByThree' | 'MainThumbnail' | 'PosterPortrait';
+    type: ThumbnailApiType;
     rendition: IRendition;
     renditions?: IRendition[];
 }
@@ -1647,6 +1654,7 @@ export * from './service.interface';
 export * from './widget-label-builder.interface';
 export * from './widget-options.interface';
 export * from './widget-view.interface';
+export { default as Observable } from './observable';
 
 export default interface IntersectionObservable {
     intersectionObserver: IntersectionObserver;
@@ -2398,7 +2406,9 @@ export declare class Presets {
     static Grid3ColumnHorizontal: LayoutStyle;
     static RowCircle: LayoutStyle;
     static RowRectangle: LayoutStyle;
+    static RowRectangleAnimated: LayoutStyle;
     static RowHorizontalRectangle: LayoutStyle;
+    static RowHorizontalRectangleAnimated: LayoutStyle;
     static Default: LayoutStyle;
     static DefaultStoryStyle: StoryPlayerStyle;
     static DefaultMomentStyle: MomentPlayerStyle;
@@ -2701,7 +2711,7 @@ export declare const Colors: {
     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';
+export type ThemeType = 'grid-2-columns' | 'grid-3-columns' | 'row-circle' | 'row-rectangle' | 'row-rectangle-animated' | 'row-rectangle-horizontal' | 'grid-2-columns-horizontal' | 'grid-3-columns-horizontal' | 'default';
 export declare class ThemeFactory {
     static create(name: ThemeType, contentType: 'moment'): IWidgetTheme<MomentPlayerStyle>;
     static create(name: ThemeType, contentType: 'story'): IWidgetTheme<StoryPlayerStyle>;
@@ -3255,8 +3265,8 @@ export type SizeType = 'small' | 'medium' | 'large';
 export type StoryDirectionType = 'PREV_STORY' | 'NEXT_STORY' | 'PREV_PAGE' | 'NEXT_PAGE';
 export type ContentDirection = 'PREV' | 'NEXT';
 
-export type ThumbnailApiType = 'SquareIcon' | 'VerticalTwoByThree' | 'MainThumbnail';
-export type ThumbnailType = 'SQUARE_ICON' | 'VERTICAL_TWO_BY_THREE' | 'CUSTOM';
+export type ThumbnailApiType = 'SquareIcon' | 'VerticalTwoByThree' | 'Gif' | 'AnimatedThumbnailPoster' | 'MainThumbnail';
+export type ThumbnailType = 'SQUARE_ICON' | 'VERTICAL_TWO_BY_THREE' | 'GIF' | 'ANIMATED_THUMBNAIL_POSTER' | 'CUSTOM';
 export type ThumbnailShape = 'Circle' | 'Rectangle';
 export declare function thumbnailMapping(thumbnailType: ThumbnailType): ThumbnailApiType;
 
@@ -3334,6 +3344,9 @@ export declare function updateStyle(styleToUpdate: any, path: string[], newValue
 export declare function getNestedValue(obj: any, path: string[]): any;
 export declare function formatLikes(count: number): string;
 export declare function isElementInsideTarget(target: EventTarget | null, selectors: string[]): boolean;
+export declare function findParentOfType<T>(target: EventTarget | null, type: {
+    new (...args: any[]): T;
+}, stopAt: Element): T | null;
 
 export * from './chip.utils';
 export * from './common.utils';
@@ -4286,7 +4299,7 @@ export interface BlazeWidgetItemOptions {
     layout: LayoutStyle;
     content: IStory | IMoment | IVideo;
 }
-export declare class BlazeWidgetItem extends BaseWidget {
+export declare class BlazeWidgetItem extends BaseWidget implements Observable {
     protected options: BlazeWidgetItemOptions;
     private wrapper;
     private container;
@@ -4303,6 +4316,7 @@ export declare class BlazeWidgetItem extends BaseWidget {
     private analyticsCalls;
     contentType: ContentType | undefined;
     chipType: ChipStatusType;
+    intersectionObserver: IntersectionObserver;
     get parentRef(): BlazeWidgetLayout;
     statusIndicatorSettings: IndicatorStyle;
     paddingItem: PositionOffset;
@@ -4319,7 +4333,10 @@ export declare class BlazeWidgetItem extends BaseWidget {
     private setupEventListeners;
     private handleWidgetClick;
     disconnectedCallback(): void;
+    handleIntersection(): void;
     private setData;
+    isFullyVisibleInParent(): boolean;
+    loadNewThumbnail(): void;
     getThumbnailUrl(): string;
     setThumbnailBorderColor(color: string): void;
     private updateLabel;
@@ -4365,9 +4382,15 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     analyticsStack: Record<WidgetAction, boolean>;
     actionHandlers: ActionHandler[];
     onResizeEvent: (this: Window, ev: UIEvent) => void;
+    onMouseMoveEvent: ((e: MouseEvent) => void) & {
+        cancel: () => void;
+    };
+    onMouseLeaveEvent: (e: MouseEvent) => void;
     shouldReloadWhenPlayerIsClosed: boolean;
     shouldReloadData: boolean;
     private personalized?;
+    currentlyAnimatedItem: BlazeWidgetItem | undefined;
+    firstVisibleItem: BlazeWidgetItem | undefined;
     get refElement(): ShadowRoot | BlazeWidgetLayout;
     constructor();
     connectedCallback(): void;
@@ -4382,6 +4405,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     onContentChange(mode: ContentDirection): void;
     onPlayerClose(): void;
     onPlayerOpen(): void;
+    setFirstVisibleItem(): void;
     getParentHeightWithoutPadding(): number | null;
     setId(id: string): void;
     private setReloadData;
@@ -4434,6 +4458,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
         maxChipHeight: number;
         maxChipWidth: number;
     };
+    isAnimatedThumbnail(): boolean;
     getMaxSizes(badge: {
         height: number;
         width: number;
@@ -4587,9 +4612,11 @@ export declare class BlazeWidgetScrollable extends BaseWidget {
 
 export type playRefType = 'Share' | 'SingleContent' | 'AutoAdvance';
 export declare class BlazeWidgetSDK extends BaseWidget {
+    private static _isSdkConnected;
     modal: BlazeWidgetStoryModal | BlazeWidgetMomentModal | BlazeWidgetVideoModal;
     boundOnResizeEvent: (this: Window, ev: UIEvent) => void;
     boundOnResizeEventDelay: () => void;
+    static isSdkConnected(): boolean;
     static get observedAttributes(): string[];
     constructor();
     connectedCallback(): Promise<void>;