@maestro_io/maestro-web-sdk 2.2.1 → 2.2.2

package/dist/modules/bets/types/BetsAnalyticsTypes.d.ts

@@ -0,0 +1,25 @@
+import { BaseMetadata } from '../../../services/AnalyticsService/types';
+/**
+ * Valid bet types as specified in the analytics spec
+ */
+export type BetType = 'straight' | 'parlay' | 'parlay_plus' | 'teaser' | 'boost';
+/**
+ * Valid card types for bets module
+ */
+export type BetCardType = '6-pack' | 'my bets > live' | 'my bets > settled' | 'my bets > upcoming' | 'hot-props' | 'promo' | 'disclaimer';
+/**
+ * Metadata for bet panel view events
+ */
+export interface BetPanelViewMetadata extends BaseMetadata {
+    in_game_bets: number;
+    total_bets: number;
+}
+/**
+ * Metadata for bet card click events
+ */
+export interface BetCardClickMetadata extends BaseMetadata {
+    card: BetCardType;
+    in_game_bets: number;
+    total_bets: number;
+    bet_type: BetType | null;
+}

package/dist/modules/bets/view/SixPack/SixPackView.d.ts

@@ -15,6 +15,7 @@ export default class FocusableSixPackViewWrapper extends React.Component<Props>
     context: import("@/components/core/ScrollableContainer/ScrollableContainer").ScrollableContainerContextType;
     onBecameFocused: (layout: Layout) => void;
     onArrowPress: (d: Direction, _props: any) => void;
+    onEnterPress: () => void;
     render(): React.JSX.Element;
 }
 export {};

package/dist/modules/bets/view/UserBets/UserBetsView.d.ts

@@ -17,7 +17,6 @@ declare class UserBetsView extends React.Component<UserBetsViewProps, {
     segmentItems: (SegmentItem & {
         type: Segments;
     })[];
-    onSegmentChange: (segment: Segments) => void;
     renderBet: (bet: IUserBet) => React.JSX.Element | null;
     renderBets: () => React.JSX.Element | (React.JSX.Element | null)[];
     get bets(): IUserBet[] | null;

package/dist/modules/bets/view/components/PromoCodeBanner/PromoCodeBanner.d.ts

@@ -18,5 +18,6 @@ export default class FocusablePromoCodeBannerWrapper extends React.Component<Pro
     context: import("@/components/core/ScrollableContainer/ScrollableContainer").ScrollableContainerContextType;
     onBecameFocused: (layout: Layout) => void;
     onArrowPress: (d: Direction, _props: any) => void;
+    onEnterPress: () => void;
     render(): React.JSX.Element;
 }

package/dist/modules/bets/view-model/BetsViewModel.d.ts

@@ -3,6 +3,7 @@ import { ITeam, IUserBet, IBetLeg } from '../interfaces/IBets';
 import { ViewModel } from '../../../view-models/ViewModel';
 import { TestUseCase } from '@/interfaces/IMaestroEvent';
 import IMaestroEventDelegate from '@/interfaces/IMaestroEventDelegate';
+import { BetCardType, BetType } from '../types/BetsAnalyticsTypes';
 declare const BET_ITEM_TYPE: {
     readonly ODDS: "odds";
     readonly USER_BETS: "userBets";
@@ -108,6 +109,7 @@ export declare class BetsViewModel extends ViewModel {
     private eventId;
     private delegate;
     private betsService;
+    private analyticsService;
     private pollingInterval;
     private pollingTask;
     private lastNonPersonalizedResponseHash;
@@ -128,6 +130,22 @@ export declare class BetsViewModel extends ViewModel {
      * Clean up resources when the ViewModel is no longer needed
      */
     cleanup(): void;
+    /**
+     * Track panel view event
+     */
+    private trackPanelView;
+    /**
+     * Track card click event
+     */
+    trackCardClick(cardType: BetCardType, betType?: BetType | null): Promise<void>;
+    /**
+     * Get base metadata for analytics events
+     */
+    private getBaseMetadata;
+    /**
+     * Get user bet counts for analytics
+     */
+    private getUserBetCounts;
     /**
      * Refresh polling for bet data
      */
@@ -181,7 +199,7 @@ export declare class BetsViewModel extends ViewModel {
      */
     shouldHideWagers(): boolean;
     /**
-     * Update hideWagers Observable from current settings (reactive approach)
+     * Update hideWagers Observable from current settings
      */
     private updateHideWagersFromSettings;
     private refreshBetItemsWithNewSettings;

package/dist/modules/key-plays/view-model/KeyPlaysViewModel.d.ts

@@ -1,6 +1,7 @@
 import IMaestroKeyPlaysResponse from '../interfaces/IKeyPlaysResponse';
 import IKeyPlay, { KeyPlayLoadFailureStatus, KeyPlaysErrorState } from '../interfaces/IKeyPlays';
 import { Observable } from '@/helpers/Observable';
+import AnalyticsService from '@/services/AnalyticsService/AnalyticsService';
 type KeyPlayItem = {
     title: string;
     items: IKeyPlay[];
@@ -15,6 +16,8 @@ declare class KeyPlaysViewModel {
     }>;
     items: Observable<KeyPlayItem[]>;
     filteredItems: Observable<KeyPlayItem[]>;
+    analyticsService: AnalyticsService;
+    constructor();
     onUpdatePlayerTimeCode(playerTimeCode: number | null): void;
     private filterItemsByPlayerTimeCode;
     private shouldShowKeyPlay;
@@ -22,6 +25,7 @@ declare class KeyPlaysViewModel {
     setKeyPlays(items: IMaestroKeyPlaysResponse | null, playerTimeCode: number | null): Promise<void>;
     private cleanErrors;
     playKeyPlay(atIndex: number): Promise<void>;
+    init(): Promise<void>;
     parseNetworkResponse(response: IMaestroKeyPlaysResponse): KeyPlayItem[];
     get allItems(): IKeyPlay[];
     clipID(forKeyPlayAtIndex: number): string | undefined;

package/dist/modules/stats/interfaces/IStats.d.ts

@@ -15,7 +15,7 @@ export interface Team {
     shortDisplayName?: string;
     color?: string;
     alternateColor?: string;
-    logo: string;
+    logo?: string;
     statistics?: TeamStatistic[];
     homeAway?: string;
     record?: string;

package/dist/modules/stats/view/ActiveAthletes/ActiveAthletes.d.ts

@@ -5,6 +5,7 @@ import { ActiveAthletesItem } from '../../view-model/StatsViewModel';
 export type ActiveAthletesProps = {
     item: ActiveAthletesItem;
     onBecameFocused: (layout: Layout) => void;
+    onEnterPress: () => void;
 };
 declare class ActiveAthletes extends React.Component<ActiveAthletesProps, {
     expanded: boolean;

package/dist/modules/stats/view/ActiveAthletes/CollapsedAthletes/CollapsedAthletes.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
 import './CollapsedAthletes.styles.css';
 import { ActiveAthletesProps } from '../ActiveAthletes';
-declare const CollapsedAthletes: (props: ActiveAthletesProps) => React.JSX.Element;
+declare const CollapsedAthletes: (props: Pick<ActiveAthletesProps, 'item'>) => React.JSX.Element;
 export default CollapsedAthletes;

package/dist/modules/stats/view/ActiveAthletes/ExpandedAthletes/ExpandedAthletes.d.ts

@@ -5,6 +5,6 @@ import { Direction } from '@/external/spatial-navigation/utils';
 type Props = {
     onArrowPress: (index: number) => (direction: Direction) => void;
     onBackPress: () => void;
-} & ActiveAthletesProps;
+} & Pick<ActiveAthletesProps, 'item' | 'onBecameFocused' | 'onEnterPress'>;
 declare const ExpandedAthletes: (props: Props) => React.JSX.Element;
 export default ExpandedAthletes;

package/dist/modules/stats/view/DriveSummary/DriveSummary.d.ts

@@ -5,6 +5,7 @@ import './DriveSummary.styles.css';
 import { DriveSummaryItem } from '../../view-model/StatsViewModel';
 type DriveSummaryProps = {
     item: DriveSummaryItem;
+    onItemEnterPress: () => void;
 };
 export default class DriveSummary extends React.Component<DriveSummaryProps & WithFocusableProps> {
     static contextTypes: {

package/dist/modules/stats/view/GameLeaders/GameLeaders.d.ts

@@ -4,6 +4,7 @@ import { GameLeadersStatsItem } from '../../view-model/StatsViewModel';
 import { Direction, Layout } from '@/external/spatial-navigation/utils';
 export type GameLeaderProps = {
     item: GameLeadersStatsItem;
+    onEnterPress: () => void;
 };
 declare class GameLeaders extends React.Component<GameLeaderProps> {
     static contextTypes: {

package/dist/modules/stats/view/StatsItemView.d.ts

@@ -3,6 +3,7 @@ import { StatsItem } from '../view-model/StatsViewModel';
 import { Direction, Layout } from '@/external/spatial-navigation/utils';
 type Props = {
     item: StatsItem;
+    onEnterPress: (item: StatsItem) => void;
 };
 declare class StatsItemView extends React.Component<Props> {
     static contextTypes: {
@@ -13,6 +14,7 @@ declare class StatsItemView extends React.Component<Props> {
     context: import("@/components/core/ScrollableContainer/ScrollableContainer").ScrollableContainerContextType;
     onBecameFocused: (layout: Layout) => void;
     onArrowPress: (d: Direction) => void;
+    onEnterPress: (item: StatsItem) => () => void;
     renderItem(): React.JSX.Element | null;
     render(): React.JSX.Element;
 }

package/dist/modules/stats/view/StatsView.d.ts

@@ -15,6 +15,7 @@ declare class StatsView extends Component<{}, StatsViewState> {
     componentDidMount(): void;
     componentWillUnmount(): void;
     renderItems: () => React.JSX.Element[] | null;
+    onEnterPress: (item: StatsItem) => void;
     render(): React.JSX.Element;
 }
 export default StatsView;

package/dist/modules/stats/view-model/StatsViewModel.d.ts

@@ -4,6 +4,7 @@ import { DrivePlay, Team } from '../interfaces/IStats';
 import { AthletesStatisticsItem } from '../view/components/AthletesStatistics/AthletesStatistics';
 import StatsService from '@/services/StatsService';
 import IMaestroEventDelegate from '@/interfaces/IMaestroEventDelegate';
+import AnalyticsService from '@/services/AnalyticsService/AnalyticsService';
 declare const STATS_ERROR_STATE: {
     readonly NONE: "none";
     readonly TAB_LOAD_FAILURE: "tabLoadFailure";
@@ -28,11 +29,11 @@ export type HeaderTeamStatItem = {
 type RecentGamesPreviousGame = {
     score: string;
     gameResult: string;
-    teamLogo: string;
+    teamLogo?: string;
     homeAway: string;
 };
 type RecentGamesTeam = {
-    logo: string;
+    logo?: string;
     name?: string;
     events: RecentGamesPreviousGame[];
 };
@@ -110,7 +111,9 @@ export declare class StatsViewModel extends ViewModel {
     eventId: string;
     statsItems: Observable<StatsItem[]>;
     errorState: Observable<BetsErrorState>;
+    currentGameState: Observable<string>;
     statsService: StatsService;
+    analyticsService: AnalyticsService;
     private pollingInterval;
     private useMockData;
     private pollingTask;
@@ -123,6 +126,7 @@ export declare class StatsViewModel extends ViewModel {
      * Initialize the ViewModel and start data fetching
      */
     init(): Promise<void>;
+    onEngage: (type: StatsItem['type']) => void;
     /**
      * Clean up resources when the ViewModel is no longer needed
      */

package/dist/services/AnalyticsService/AnalyticsService.d.ts

@@ -0,0 +1,65 @@
+import InsightsPayloadBuilder from '../InsightsService/InsightsPayloadBuilder';
+import InsightsService from '../InsightsService/InsightsService';
+import { Metadata } from './types';
+type KeyPlaysClickedAction = {
+    panel_id: string;
+    panel_name: string;
+    panel_type: string;
+    name: 'key_play_clicked';
+    metadata: {
+        league: string;
+        event: string;
+        airing: string;
+        sport: string;
+        action: string;
+        clip: string;
+        key_play: string;
+    };
+};
+type BetsItemClickedAction = {
+    panel_id: string;
+    panel_name: string;
+    panel_type: string;
+    name: 'bets_item_clicked';
+    metadata: {
+        league: string;
+        event: string;
+        airing: string;
+        sport: string;
+        card: string;
+        bet_type: string | null;
+        in_game_bets: number;
+        total_bets: number;
+    };
+};
+type StatsItemClickedAction = {
+    panel_id: string;
+    panel_name: string;
+    panel_type: string;
+    name: 'stats_item_clicked';
+    metadata: {
+        league: string;
+        event: string;
+        airing: string;
+        sport: string;
+        card: string[];
+        game_state: string[];
+    };
+};
+type PanelClickPayload = KeyPlaysClickedAction | BetsItemClickedAction | StatsItemClickedAction;
+type PanelViewPayload = {
+    panel_type: string;
+    panel_id: string;
+    panel_name: string;
+    metadata: Metadata;
+};
+declare class AnalyticsService {
+    insightsService: InsightsService;
+    insightsPayloadBuilder: InsightsPayloadBuilder;
+    constructor();
+    private trackAction;
+    private trackImpression;
+    panelView({ panel_type, panel_id, panel_name, metadata, }: PanelViewPayload): Promise<void>;
+    panelClick({ panel_type, panel_id, panel_name, metadata, name, }: PanelClickPayload): Promise<void>;
+}
+export default AnalyticsService;

package/dist/services/AnalyticsService/types.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Generic metadata type that accepts any object extending BaseMetadata
+ */
+export type Metadata = BaseMetadata & {
+    [key: string]: any;
+};
+export type Kingdom = 'panel';
+export type Phylum = 'view' | 'engage';
+/**
+ * Base metadata analytics events should include
+ */
+export interface BaseMetadata {
+    league: string;
+    event: string;
+    airing: string;
+    sport: string;
+}
+export type PanelViewAction = {
+    name: 'panel_selected';
+    e0_kingdom: Kingdom;
+    e1_phylum: Phylum;
+    /**
+     * Panel Type
+     */
+    e2_class: string;
+    /**
+     * Panel ID
+     */
+    e3_order: string;
+    /**
+     * Panel Name
+     */
+    e4_family: string;
+    e5_genus?: string;
+    e6_species?: string;
+    /**
+     * Additional metadata for the panel view action.
+     */
+    metadata: Metadata;
+};
+export type ImpressionTrackEvent = PanelViewAction;
+export type PanelClickAction = {
+    name: string;
+    e0_kingdom: 'panel';
+    e1_phylum: 'engage';
+    /**
+     * Panel Type
+     */
+    e2_class: string;
+    /**
+     * Panel ID.
+     */
+    e3_order: string;
+    /**
+     * Panel Name
+     */
+    e4_family: string;
+    e5_genus?: string;
+    e6_species?: string;
+    /**
+     * Additional metadata for the panel click action.
+     */
+    metadata: Metadata;
+};
+export type ActionTrackEvent = PanelClickAction;

package/dist/services/InsightsService/InsightsPayloadBuilder.d.ts

@@ -0,0 +1,278 @@
+import { ICacheManager } from '@/external/ports/cacheManager';
+import InsightsService from './InsightsService';
+type EventData = {
+    url?: string;
+    metadata?: Record<string, unknown>;
+    ontology: {
+        kingdom: string;
+        phylum: string;
+        class: string;
+        order?: string;
+        family: string;
+        genus?: string;
+        species?: string;
+    };
+};
+export default class InsightsPayloadBuilder {
+    currentTime: number;
+    serverOffsetTime: number;
+    insightsService: InsightsService;
+    cacheManager: ICacheManager;
+    constructor();
+    getPayload(event: EventData): Promise<{
+        /**
+         * @description Event Domain. NAMESPACE env var.
+         * @example maestro
+         */
+        e_d: string;
+        /**
+         * @description Event stringified metadata. defaults to null.
+         * @example "{\"key\":\"value\"}"
+         */
+        e_m: string | null;
+        /**
+         * @description Event time accounting for offset.
+         */
+        e_t: number;
+        /**
+         * @description Event URL. defaults to undefined.
+         */
+        e_u: string | undefined;
+        /**
+         * @description Event ontology kingdom. This is the highest level of the ontology and can be used to identify the event type.
+         * @example 'panel', 'engage', 'espn_key_plays'
+         */
+        e0: string;
+        /**
+         * @description Event phylum.
+         * @example 'view', 'click', 'play clip'
+         */
+        e1: string;
+        /**
+         * @description Event class.
+         * @example 'panel_type'
+         */
+        e2: string;
+        /**
+         * @description Event order.
+         * @example 'panel_id'
+         */
+        e3: string | undefined;
+        /**
+         * @description Event family.
+         * @example 'panel_name'
+         */
+        e4: string;
+        /**
+         * @description Event genus. This is a more specific level of the ontology and can be used to identify the event type.
+         */
+        e5: string | undefined;
+        /**
+         * @description Event species. This is the most specific level of the ontology and can be used to identify the event type.
+         */
+        e6: string | undefined;
+        /**
+         * @description Current timestamp.
+         */
+        t: number;
+        /**
+         * @description User avatar URL. Stored in user profile. defaults to null
+         * @example GET 'https://api.maestro.io/userprofile/v1'
+         */
+        u_a: null;
+        /**
+         * @description User account created date in milliseconds since epoch. defaults to null
+         * @example account.created
+         */
+        u_c: null;
+        /**
+         * @description Logged User email. defaults to null
+         * @example account.email
+         */
+        u_e: null;
+        /**
+         * @description Logged User ID. defaults to null
+         * @example account._id
+         */
+        u_id: null;
+        /**
+         * @description Logged User is logged in or not. defaults to false
+         */
+        u_li: boolean;
+        /**
+         * @description Logged User name. defaults to null
+         * @example account.name
+         */
+        u_n: null;
+        /**
+         * @description Logged User new user or not. Usually we compare server time and account.created. If it was created less than 1 day ago it's a new user. defaults to false
+         * @example Math.abs((serverTime || Date.now()) - account.created) < msIn.day
+         */
+        u_nu: boolean;
+        /**
+         * @description Logged User service. defaults to null
+         * @example account.service
+         */
+        u_s: null;
+        /**
+         * @description Logged User UID. defaults to null
+         * @example account.uid
+         */
+        u_u: null;
+        /**
+         * @description Logged User name. defaults to null
+         * @example account.name
+         */
+        u_un: null;
+        /**
+         * @description Site domain.
+         * @example site.settings.domain.url. 'maestro.tv/site_slug'
+         */
+        si_d: string;
+        /**
+         * @description Site ID.
+         * @example site._id
+         */
+        si_id: string;
+        /**
+         * @description Site package ID.
+         * @example `${site.package.id}-sapphire`
+         */
+        si_pid: string;
+        /**
+         * @description Site package version.
+         * @example `${site.package.version}-sapphire`
+         */
+        si_pv: string;
+        /**
+         * @description Site slug.
+         * @example site.slug
+         */
+        si_s: string;
+        /**
+         * @description Session ID, which can be used to track the session across requests. You might wanna keep this fixed for the session you're in using a local storage or something related.
+         */
+        se_id: string;
+        /**
+         * @description Session created timestamp. Usually set when the first event is fired
+         * @example new Date().getTime()
+         */
+        se_s: number;
+        /**
+         * @description Referrer domain, which can be used to track the domain from which the user came. Defaults to "$direct"
+         * @example 'example.com'.
+         */
+        r_d: string;
+        /**
+         * @description Referrer source, which can be used to track the source from which the user came (queryParam.r). Defaults to null
+         * @example const urlParams = new URLSearchParams(window.location.search);
+         *              urlParams.get('r') || null
+         */
+        r_s: null;
+        /**
+         * @description Referrer URL, which can be used to track the full URL from which the user came. Defaults to "$direct"
+         * @example document.referrer
+         */
+        r_u: string;
+        /**
+         * @description Metadata version, used to track changes in the metadata structure.
+         * @example '1.00.0'
+         */
+        m_iv: string;
+        /**
+         * @description Unique identifier for the insights ID. Stored in site's document.
+         * @example site.settings.services.insights_id
+         */
+        i_id: string;
+        /**
+         * @description Device created timestamp. You might wanna keep this fixed for the device you're in using a local storage or something related
+         * @example new Date().getTime()
+         */
+        d_ct: number;
+        /**
+         * @description New device or not. If you want to keep track of new devices, you can use a local storage or something related
+         * @example localStorage.getItem('isNewDevice') === 'true'
+         */
+        d_nd: boolean;
+        /**
+         * @description Navigator Platform (more Web API specific).
+         * @example 'MacIntel', 'Win32', 'Linux x86_64'
+         * @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/platform
+         */
+        d_np: string;
+        /**
+         * @description A unique identifier for the device, which can be used to track the device across sessions. You might wanna save this into a local storage or something related.
+         * @example localStorage.getItem('devicePermanentId') || generateUniqueId()
+         */
+        d_pid: any;
+        /**
+         * @description Device screen height in pixels.
+         * @example window.screen.height
+         */
+        d_sh: number;
+        /**
+         * @description Device screen width in pixels.
+         * @example window.screen.width
+         */
+        d_sw: number;
+        /**
+         * @description Device tab ID, which can be used to track the device across tabs.
+         */
+        d_tid: string;
+        /**
+         * @description Device time in milliseconds since epoch.
+         */
+        d_tim: number;
+        /**
+         * @description Device time offset in milliseconds. You might wanna keep this fixed for the device you're in using a local storage or something related.
+         */
+        d_tof: number;
+        /**
+         * @description Device user agent string.
+         * @example navigator.userAgent ('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3')
+         * @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgent
+         */
+        d_ua: string;
+        /**
+         * @description MongoDB page collection name (e.g. 'pages')
+         * @example object.collection
+         */
+        p_c: string;
+        /**
+         * @description MongoDB page document ID (e.g. 'pageId')
+         * @example object._id
+         */
+        p_id: string;
+        /**
+         * @description MongoDB page name (e.g. 'Home', 'Product Page')
+         * @example object.data.name || object.seo.title
+         */
+        p_n: string;
+        /**
+         * @description MongoDB page slug (e.g. 'home', 'product-page')
+         * @example object.slug
+         */
+        p_s: string;
+        /**
+         * @description MongoDB page type (e.g. 'landing', 'channel')
+         * @example object.type
+         */
+        p_t: string;
+    }>;
+    private getEventInsights;
+    private getPageInsights;
+    private getDevicePermanentID;
+    private getDeviceCreated;
+    private getTabID;
+    private getDeviceInsights;
+    private randomId;
+    private getDeviceOffset;
+    private getInsightsInsights;
+    private getMetadataInsights;
+    private getReferrerInsights;
+    private getSessionID;
+    private getSessionInsights;
+    private getSiteInsights;
+    private getUserInsights;
+}
+export {};

package/dist/services/InsightsService/InsightsService.d.ts

@@ -0,0 +1,10 @@
+export default class InsightsService {
+    private client;
+    constructor();
+    action(payload: Record<string, unknown>): Promise<void>;
+    getServerTime(): Promise<{
+        time: number;
+        diff: number;
+    }>;
+    private randomId;
+}