@maestro_io/maestro-web-sdk 2.2.0 → 2.2.2

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;
+}

package/dist/services/NetworkManager/NetworkManager.d.ts

@@ -1,12 +1,7 @@
+import { Environment } from '@/index';
 import { ICacheManager } from '../../external/ports/cacheManager';
 import { INetworkClient } from '../../external/ports/networkClient';
-export declare const WorkingEnvironment: {
-    readonly DEVELOPMENT: "development";
-    readonly STAGING: "staging";
-    readonly PRODUCTION: "production";
-};
-export type WorkingEnvironment = typeof WorkingEnvironment[keyof typeof WorkingEnvironment];
-export declare const MAESTRO_BASE_URLS: Record<WorkingEnvironment, string>;
+export declare const MAESTRO_BASE_URLS: Record<Environment, string>;
 export declare const SDK_FLAVOR = "MaestroKit_Web";
 export declare const ENDPOINTS: {
     CAN_I_PLAY: string;
@@ -22,7 +17,6 @@ export declare const HttpMethod: {
 };
 export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
 export interface NetworkManagerOptions {
-    environment?: WorkingEnvironment;
     networkClient?: INetworkClient;
     externalNetworkClient?: INetworkClient;
     externalBaseURL?: string;
@@ -30,23 +24,12 @@ export interface NetworkManagerOptions {
     defaultCacheDuration?: number;
 }
 declare class NetworkManager {
-    private static instance;
     private cacheManager;
     private maestroClient;
     private externalClient;
-    private environment;
     private pollingTasks;
     private localStorage;
-    private constructor();
-    static getInstance(options?: NetworkManagerOptions, localStorageOverride?: Storage): NetworkManager;
-    /**
-     * Sets the working environment (development, staging, production)
-     */
-    setEnvironment(environment: WorkingEnvironment): void;
-    /**
-     * Get current environment
-     */
-    getEnvironment(): WorkingEnvironment;
+    constructor(options?: NetworkManagerOptions, localStorageOverride?: Storage);
     /**
      * Set authentication for Maestro APIs
      */

package/dist/services/NetworkManager/NetworkManagerFactory.d.ts

@@ -0,0 +1,42 @@
+import NetworkManager, { NetworkManagerOptions } from './NetworkManager';
+import { ServiceType, ServiceNetworkManagerConfig, IStatsNetworkManager, IBetsNetworkManager, IMaestroNetworkManager, NetworkManagerFactoryConfig } from './types';
+/**
+ * Service-specific NetworkManager that includes metadata about its service type
+ */
+declare class ServiceNetworkManager extends NetworkManager {
+    readonly serviceType: ServiceType;
+    readonly externalBaseURL: string;
+    constructor(serviceType: ServiceType, externalBaseURL: string, options?: NetworkManagerOptions, localStorageOverride?: Storage);
+}
+/**
+ * Factory for creating service-specific NetworkManager instances
+ * This replaces the singleton pattern with a factory pattern
+ */
+export declare class NetworkManagerFactory {
+    private static defaultConfig;
+    /**
+     * Configure factory defaults
+     */
+    static configure(config: NetworkManagerFactoryConfig): void;
+    /**
+     * Create a Stats service NetworkManager
+     */
+    static createStatsNetworkManager(externalBaseURL: string, options?: Partial<NetworkManagerOptions>): IStatsNetworkManager;
+    /**
+     * Create a Bets service NetworkManager
+     */
+    static createBetsNetworkManager(externalBaseURL: string, options?: Partial<NetworkManagerOptions>): IBetsNetworkManager;
+    /**
+     * Create a Maestro service NetworkManager
+     */
+    static createMaestroNetworkManager(options?: Partial<NetworkManagerOptions>): IMaestroNetworkManager;
+    /**
+     * Create a NetworkManager for any service type
+     */
+    static createForService(config: ServiceNetworkManagerConfig, options?: Partial<NetworkManagerOptions>): ServiceNetworkManager;
+    /**
+     * Reset factory to defaults (useful for testing)
+     */
+    static reset(): void;
+}
+export default NetworkManagerFactory;

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

@@ -0,0 +1,73 @@
+/**
+ * Service types for different NetworkManager contexts
+ */
+export declare const ServiceType: {
+    readonly STATS: "stats";
+    readonly BETS: "bets";
+    readonly MAESTRO: "maestro";
+};
+export type ServiceType = typeof ServiceType[keyof typeof ServiceType];
+/**
+ * Configuration for creating service-specific NetworkManager instances
+ */
+export interface ServiceNetworkManagerConfig {
+    serviceType: ServiceType;
+    externalBaseURL: string;
+    defaultCacheDuration?: number;
+}
+/**
+ * Base interface for all NetworkManager instances
+ */
+export interface IServiceNetworkManager {
+    readonly serviceType: ServiceType;
+    readonly externalBaseURL: string;
+    externalApiRequest<T = any>(options: {
+        endpoint: string;
+        method?: string;
+        params?: Record<string, any>;
+        headers?: Record<string, string>;
+        data?: any;
+        useCache?: boolean;
+        skipResponseBodyDeserialization?: boolean;
+    }): Promise<T>;
+    pollExternalApiRequest<T = any>(options: {
+        endpoint: string;
+        interval: number;
+        method?: string;
+        params?: Record<string, any>;
+        headers?: Record<string, string>;
+        data?: any;
+        onData: (data: T) => void;
+        onError?: (error: Error) => void;
+    }): {
+        stop: () => void;
+    };
+}
+/**
+ * Stats service NetworkManager interface
+ */
+export interface IStatsNetworkManager extends IServiceNetworkManager {
+    serviceType: 'stats';
+}
+/**
+ * Bets service NetworkManager interface
+ */
+export interface IBetsNetworkManager extends IServiceNetworkManager {
+    serviceType: 'bets';
+}
+/**
+ * Maestro service NetworkManager interface
+ */
+export interface IMaestroNetworkManager extends IServiceNetworkManager {
+    serviceType: 'maestro';
+}
+/**
+ * Union type for all service NetworkManager types
+ */
+export type ServiceNetworkManager = IStatsNetworkManager | IBetsNetworkManager | IMaestroNetworkManager;
+/**
+ * Factory configuration for different service types
+ */
+export interface NetworkManagerFactoryConfig {
+    defaultCacheDuration?: number;
+}

package/dist/services/StatsService.d.ts

@@ -1,11 +1,11 @@
-import NetworkManager from './NetworkManager/NetworkManager';
+import { IStatsNetworkManager } from './NetworkManager/types';
 import { StatsApiResponse } from '../modules/stats/interfaces/IStats';
 import IMaestroEventDelegate from '@/interfaces/IMaestroEventDelegate';
 /**
  * Service for handling stats-related API calls
  */
 declare class StatsService {
-    networkManager: NetworkManager;
+    networkManager: IStatsNetworkManager;
     constructor(delegate: IMaestroEventDelegate);
     /**
      * Get stats for an event

package/dist/services/UserSettingsManager.d.ts

@@ -0,0 +1,63 @@
+import { Observable } from '@/helpers/Observable';
+import { IUserSettings, PanelSettings } from '@/interfaces/IUserSettings';
+import { MaestroPanelType } from '@/models/IPanel';
+/**
+ * UserSettingsManager - Singleton service for managing user settings
+ * Uses Observable pattern for reactive updates across the SDK
+ */
+export declare class UserSettingsManager {
+    private static instance;
+    private _settings;
+    private constructor();
+    /**
+     * Get the singleton instance of UserSettingsManager
+     */
+    static getInstance(): UserSettingsManager;
+    /**
+     * Get the current settings as an Observable
+     */
+    get settings(): Observable<IUserSettings>;
+    /**
+     * Get the current settings value (snapshot)
+     */
+    getCurrentSettings(): IUserSettings;
+    /**
+     * Update user settings with validation and merge logic
+     * @param userSettings - New settings to apply
+     */
+    updateSettings(userSettings: IUserSettings): void;
+    /**
+     * Get settings for a specific panel type
+     * @param panelType - Panel type to get settings for
+     */
+    getPanelSettings<T extends keyof NonNullable<IUserSettings['panels']>>(panelType: T): PanelSettings<T> | undefined;
+    /**
+     * Check if a panel should be hidden
+     * @param panelType - Panel type to check
+     */
+    isPanelHidden(panelType: MaestroPanelType): boolean;
+    /**
+     * Check if wagers should be hidden for betting panel
+     */
+    shouldHideWagers(): boolean;
+    /**
+     * Reset settings to defaults
+     */
+    resetToDefaults(): void;
+    /**
+     * Validate settings structure and values
+     * @param settings - Settings to validate
+     */
+    private validateSettings;
+    /**
+     * Merge user settings with current settings (deep merge)
+     * @param currentSettings - Current settings
+     * @param userSettings - New settings to merge
+     */
+    private mergeSettings;
+    /**
+     * Map MaestroPanelType to settings key
+     * @param panelType - Panel type from MaestroPanelType enum
+     */
+    private mapPanelTypeToSettingsKey;
+}

package/dist/view-models/MaestroEventViewModel.d.ts

@@ -8,19 +8,24 @@ import SpatialNavigation from '@/external/spatial-navigation/spatialNavigation';
 import StatsViewModel from '../modules/stats/view-model/StatsViewModel';
 import IMaestroKeyPlaysResponse from '../modules/key-plays/interfaces/IKeyPlaysResponse';
 import { MaestroPanelType } from '@/models/IPanel';
+import { IUserSettings } from '../interfaces/IUserSettings';
 export declare class MaestroEventViewModel extends ViewModel implements IMaestroEvent {
     private _eventId;
     private _title;
     private _isLive;
     private _isShowingPanel;
+    private playerTimeCode;
     delegate: IMaestroEventDelegate;
     keyPlaysViewModel: KeyPlaysViewModel;
     betsViewModel: BetsViewModel;
     statsViewModel: StatsViewModel;
     navigation: SpatialNavigation;
     constructor(eventId: string | undefined, delegate: IMaestroEventDelegate);
+    updatePlayerTimeCode(timestamp: number): void;
+    getPlayerTimeCode(): number | null;
     deinit(): void;
     updateKeyPlaysData(data: IMaestroKeyPlaysResponse | null): Promise<void>;
+    updateUserSettings(settings: IUserSettings): Promise<void>;
     startFocusManagement(): Promise<void>;
     didStartPlayingClip(index: number): void;
     didStopPlayingClip(index: number): void;

package/dist/view-models/PanelManagerViewModel.d.ts

@@ -4,6 +4,30 @@ export declare class PanelManagerViewModel {
     private _panels;
     private _currentPanel;
     private _newlyFocusedPanel;
+    private settingsManager;
+    private settingsUnsubscribe;
+    private readonly ALL_PANELS;
+    constructor();
+    /**
+     * Initialize panels based on current settings
+     */
+    private initializePanels;
+    /**
+     * Subscribe to settings changes to update panels dynamically
+     */
+    private subscribeToSettingsChanges;
+    /**
+     * Filter panels based on user settings
+     */
+    private filterPanelsBasedOnSettings;
+    /**
+     * Update panels when settings change
+     */
+    private updatePanelsBasedOnSettings;
+    /**
+     * Cleanup subscriptions
+     */
+    cleanup(): void;
     get panels(): MaestroPanelType[];
     get panelsObservable(): Observable<MaestroPanelType[]>;
     get currentPanel(): MaestroPanelType;

package/dist/view-models/index.d.ts

@@ -12,6 +12,10 @@ export declare class MaestroViewModels {
     readonly keyPlaysViewModel: KeyPlaysViewModel;
     readonly overlayViewModel: OverlayViewModel;
     constructor(eventViewModel: MaestroEventViewModel);
+    /**
+     * Cleanup all view models
+     */
+    cleanup(): void;
     /**
      * Creates view models from an event ID
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maestro_io/maestro-web-sdk",
   "private": false,
-  "version": "2.2.0",
+  "version": "2.2.2",
   "type": "commonjs",
   "license": "MIT",
   "main": "dist/maestro-web-sdk.umd.js",