@wscsports/blaze-web-sdk 0.6.0 → 0.7.1

package/package.json

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

package/publish/index.d.ts

@@ -148,6 +148,7 @@ export declare class ReferringEventInfo {
     'story_source': string;
 }
 export declare class AnalyticsEvent {
+    'sdk_event_session_counter': number;
     'sdk_event_id': string;
     'timestamp_utc': string;
     'timestamp_user_tz': string;
@@ -208,6 +209,8 @@ export declare class StoryEvent {
     'custom_action_button_name': string;
     'enrichment_layer_id': string;
     'enrichment_layer_url': string;
+    'story_page_parent_id': string;
+    'story_composition_type': string;
 }
 export declare class MomentEvent {
     'moments_session_id': string;
@@ -355,6 +358,7 @@ export interface BlazeDataSourceType {
     orderType?: OrderType;
     maxItems?: number;
     advancedOrdering?: AdvancedOrdering;
+    personalized?: BlazePersonalized;
 }
 export declare const BlazeInternalError: {
     LabelExpressionMustNotBeEmpty: string;
@@ -666,7 +670,7 @@ export declare class BlazeButton extends BaseWidget {
     isAnimationOnDesktopInitialized: boolean;
     get refElement(): ShadowRoot | this;
     constructor();
-    static get observedAttributes(): ("height" | "order" | "width" | "icon-color" | "disabled" | "blaze-btn-visible" | "blaze-btn-hidden" | "button-desktop-animation")[];
+    static get observedAttributes(): ("height" | "order" | "width" | "icon-color" | "blaze-btn-visible" | "disabled" | "blaze-btn-hidden" | "button-desktop-animation")[];
     private onMouseEnter;
     private onMouseLeave;
     private onClick;
@@ -1149,6 +1153,7 @@ export interface IContentPage extends IBasePage {
     thumbnail: IThumbnail;
     baseLayer: ILayer;
     cta: ICta;
+    parentStoryId?: string;
     shouldShowImaAd?: boolean;
     adInfo?: IAdInfo;
     interaction?: Interaction;
@@ -1173,6 +1178,7 @@ export interface IStory extends IContent {
     isLive: boolean;
     pages: IPage[];
     adInfo?: IAdInfo;
+    compositionType?: string;
 }
 
 export interface IThumbnail {
@@ -1646,6 +1652,7 @@ export interface IWidgetView extends HTMLElement {
     updateOverrideStyles: (perItemStyleOverrides: PerItemStyleOverrides) => void;
     setId: (id: string) => void;
     updateDataSource: (dataSource: BlazeDataSourceType) => void;
+    setPersonalized: (personalized: BlazePersonalized) => void;
     setLabels: (labels: string | string[] | BlazeWidgetLabel, options?: ISetWidgetOptions) => void;
     setLabelsPriority: (labelsPriority: string | string[] | BlazeWidgetLabel[], options?: ISetWidgetOptions) => void;
     setContentIds: (storyIds: string[], options?: ISetWidgetOptions) => void;
@@ -1679,6 +1686,7 @@ declare const AnalyticsServiceClass_base: {
 declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base implements IService {
     events: AnalyticsEvent[];
     uaParsed?: IDevice;
+    eventSessionCounter: number;
     init(): Promise<void>;
     sendAnalyticsData(): Promise<void>;
     bulkEvent(body: Partial<AnalyticsEvent>[]): Promise<any>;
@@ -1694,6 +1702,17 @@ declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base
 }
 export declare const AnalyticsService: AnalyticsServiceClass;
 
+type GetOptions = {
+    orderType?: OrderType;
+};
+type GetByLabelsOptions = GetOptions & {
+    labels: string;
+    maxItems?: number;
+    labelsPriority?: string;
+};
+type GetByIdsOptions = GetOptions & {
+    ids: string[];
+};
 export interface ApiResponse<T> {
     assetsExpiryTime: string;
     totalItems: number;
@@ -1712,45 +1731,41 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     api: API;
     init(): Promise<void>;
     private setAdsOnStories;
-    getStoriesByIds(options: {
-        storyIds: string[];
-        orderType?: OrderType;
+    getStoriesByIds(options: GetByIdsOptions & {
         showLiveFirst?: boolean;
+        personalized?: BlazePersonalized;
     }): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
         data?: StoriesResponse | undefined;
         error?: Error | undefined;
     }>;
-    getStoriesByLabels(options: {
-        labels: string;
-        orderType?: OrderType;
-        maxItems?: number;
-        labelsPriority?: string;
+    getStoriesByLabels(options: GetByLabelsOptions & {
         showLiveFirst?: boolean;
+        personalized?: BlazePersonalized;
     }): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
         data?: StoriesResponse | undefined;
         error?: Error | undefined;
     }>;
-    getMomentByIds(ids: string[], orderType?: OrderType): Promise<{
+    getMomentByIds(options: GetByIdsOptions): Promise<{
         httpStatus?: number | undefined;
         data?: MomentsResponse | undefined;
         error?: Error | undefined;
     }>;
-    getMomentsByLabels(labels: string, orderType?: OrderType, maxItems?: number): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
+    getMomentsByLabels(options: GetByLabelsOptions): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
     updateMomentLikeStatus(options: {
         momentId: string;
         setLiked: boolean;
     }): Promise<void>;
     getStaticStories(): Promise<IStory | null>;
-    getVideosByIds(ids: string[], orderType?: OrderType): Promise<{
+    getVideosByIds(options: GetByIdsOptions): Promise<{
         httpStatus?: number | undefined;
         data?: VideosResponse | undefined;
         error?: Error | undefined;
     }>;
-    getVideosByLabels(labels: string, orderType?: OrderType, maxItems?: number, labelsPriority?: string): Promise<{
+    getVideosByLabels(options: GetByLabelsOptions): Promise<{
         httpStatus?: number | undefined;
         data?: VideosResponse | undefined;
         error?: Error | undefined;
@@ -1759,10 +1774,6 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
         videoId: string;
         setLiked: boolean;
     }): Promise<void>;
-    preview(storyId: string, publishedOnly?: boolean): Promise<import("../interfaces").IHttpResponse<IStory & {
-        status: number;
-    }>>;
-    preivewMoment(momentId: string, publishedOnly?: boolean): Promise<IResponse<any>>;
     sendAnaltyicsEvents(body: Partial<AnalyticsEvent>[]): Promise<import("../interfaces").IHttpResponse<unknown>>;
     sendInteractionResponse(options: {
         interactionId: Interaction['id'];
@@ -1772,6 +1783,9 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     getUserToken(body: GetUserTokenRequest): Promise<import("../interfaces").IHttpResponse<TokenData>>;
     refreshUserToken(body: RefreshUserTokenRequest): Promise<import("../interfaces").IHttpResponse<TokenData>>;
     getAppConfigurations(): Promise<import("../interfaces").IHttpResponse<AppConfiguration>>;
+    private getContentDefaultParams;
+    private getContentParamsByLabels;
+    private getContentParamsByIds;
 }
 export declare const ApiService: ApiServiceClass;
 
@@ -3064,7 +3078,7 @@ export type ComponentsElementType = 'blaze-alert' | 'blaze-chip' | 'blaze-image'
 export type WidgetElementType = 'blaze-sdk';
 export type ElementType = WidgetElementType | ComponentsElementType;
 
-export type EnvironmentType = 'prod' | 'uat';
+export type EnvironmentType = 'prod' | 'uat' | 'local';
 
 export type StoryGestureType = 'Swipe Up' | 'CTA Click';
 export type MomentGestureType = 'CTA Click';
@@ -3085,6 +3099,7 @@ export * from './item.type';
 export * from './label.type';
 export * from './locale.type';
 export * from './order.type';
+export * from './personalized.type';
 export * from './platform.type';
 export * from './play.type';
 export * from './player-layout.type';
@@ -3121,6 +3136,18 @@ export type LocaleDirectionType = 'LTR' | 'RTL';
 export type OrderType = 'Manual' | 'AtoZ' | 'ZtoA' | 'RecentlyUpdatedFirst' | 'RecentlyUpdatedLast' | 'RecentlyCreatedFirst' | 'RecentlyCreatedLast';
 export type ContentOrderType = 'LIVE_CHIP' | 'STORY_TITLE' | 'PUBLISHED_DATE';
 
+type BlazePersonalizedIds = {
+    type: 'ids';
+    teams?: Array<string>;
+    players?: Array<string>;
+};
+type BlazePersonalizedLabels = {
+    type: 'labels';
+    labelsFilterExpression: string | string[] | BlazeWidgetLabel;
+    labelsPriority: string | string[] | BlazeWidgetLabel[];
+};
+export type BlazePersonalized = BlazePersonalizedIds | BlazePersonalizedLabels;
+
 export type Platform = 'mobile' | 'tablet' | 'desktop';
 
 export declare const PlayTypeArray: readonly ["Widget", "Share", "SingleContent", "AutoAdvance"];
@@ -3244,11 +3271,29 @@ export * from './common.utils';
 export * from './country-location.utils';
 export * from './guard.utils';
 export * from './helper';
+export * from './personalized.utils';
 export * from './regex.utils';
 export * from './stopwatch';
 export * from './position.utils';
 export * from './ad-info.utils';
 
+export declare function getPersonalizedParamsForRequest(personalized?: BlazePersonalized): {
+    PersonalPlayers?: undefined;
+    PersonalTeams?: undefined;
+    PersonalLabelFilterExpression?: undefined;
+    PersonalLabelPriority?: undefined;
+} | {
+    PersonalPlayers: string[] | undefined;
+    PersonalTeams: string[] | undefined;
+    PersonalLabelFilterExpression?: undefined;
+    PersonalLabelPriority?: undefined;
+} | {
+    PersonalLabelFilterExpression: string | string[] | import("../classes").BlazeWidgetLabel;
+    PersonalLabelPriority: string | string[] | import("../classes").BlazeWidgetLabel[];
+    PersonalPlayers?: undefined;
+    PersonalTeams?: undefined;
+};
+
 export declare function calculatePosition(statusIndicatorPosition: PositionType): {
     isOutside: boolean;
     isInside: boolean;
@@ -4052,6 +4097,7 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
     bindedOnPlayerDismissed: (e: Event) => void;
     private get theme();
     constructor();
+    setPersonalized(personalized: BlazePersonalized): void;
     static get observedAttributes(): string[];
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -4204,6 +4250,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     onResizeEvent: (this: Window, ev: UIEvent) => void;
     shouldReloadWhenPlayerIsClosed: boolean;
     shouldReloadData: boolean;
+    private personalized?;
     get refElement(): ShadowRoot | BlazeWidgetLayout;
     constructor();
     connectedCallback(): void;
@@ -4298,6 +4345,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     connectWidgets(): void;
     get thumbnailShape(): ThumbnailShape;
     widgetType(): WidgetType;
+    setPersonalized(personalized?: BlazePersonalized): void;
 }
 
 export declare class BlazeWidgetModal extends BaseWidget {