@maestro_io/maestro-web-sdk 4.0.0-beta.5 → 5.0.0

package/dist/index.d.ts

@@ -19,18 +19,17 @@
 
 declare module '@maestro_io/maestro-web-sdk' {
     import IMaestroEventDelegate, { PanelEvent } from '@maestro_io/maestro-web-sdk/interfaces/IMaestroEventDelegate';
-    import IMaestroManager, { SDKConfigParams } from '@maestro_io/maestro-web-sdk/interfaces/IMaestroManager';
+    import IMaestroManager, { SDKConfigParams, SDKEventConfigParams, SDKStopEventParams } from '@maestro_io/maestro-web-sdk/interfaces/IMaestroManager';
     import IMaestroEvent from '@maestro_io/maestro-web-sdk/interfaces/IMaestroEvent';
     import { MaestroEventViewModel } from '@maestro_io/maestro-web-sdk/view-models/MaestroEventViewModel';
     import IMaestroKeyPlaysResponse from '@maestro_io/maestro-web-sdk/modules/key-plays/interfaces/IKeyPlaysResponse';
-    import { IUserSettings } from '@maestro_io/maestro-web-sdk/interfaces/IUserSettings';
     import { GlobalConfig, PageConfig } from '@maestro_io/maestro-web-sdk/services/StaticService/types';
     import { MaestroPanelType } from '@maestro_io/maestro-web-sdk/models/IPanel';
     export { default as Overlay } from '@maestro_io/maestro-web-sdk/components/molecules/Overlay/Overlay';
     export { OverlayType, IMaestroOverlayEvent, IOverlaySize, IOverlayPosition, IFantasyPayload, IOverlayAnalyticsEvent, } from '@maestro_io/maestro-web-sdk/types/OverlayTypes';
     export { IWinningBet } from '@maestro_io/maestro-web-sdk/models/IWinningBet';
     export { ActionTrackEvent, ImpressionTrackEvent, Metadata, PanelClickAction, PanelViewAction, } from '@maestro_io/maestro-web-sdk/services/AnalyticsService/types';
-    export { PanelEvent, IMaestroEventDelegate, IMaestroEvent, IMaestroKeyPlaysResponse, MaestroPanelType, };
+    export { PanelEvent, IMaestroEventDelegate, IMaestroEvent, IMaestroKeyPlaysResponse, MaestroPanelType, SDKEventConfigParams, SDKStopEventParams, };
     export { IUserSettings, DEFAULT_USER_SETTINGS, } from '@maestro_io/maestro-web-sdk/interfaces/IUserSettings';
     /**
         * Main SDK class that serves as the entry point for the Maestro TV SDK
@@ -42,8 +41,8 @@ declare module '@maestro_io/maestro-web-sdk' {
                 * @returns {MaestroWebSDK} - The MaestroWebSDK instance
                 */
             static getInstance(): MaestroWebSDK;
-            userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate, userSettings?: IUserSettings): Promise<IMaestroEvent>;
-            userDidStopWatchingEvent(_: string): Promise<void>;
+            userDidStartWatchingEvent({ eventId, pageId, userSettings, delegate, useProdEnv, }: SDKEventConfigParams): Promise<IMaestroEvent>;
+            userDidStopWatchingEvent(_config: SDKStopEventParams): Promise<void>;
             configure(configParams: SDKConfigParams): void;
             /**
                 * Sets the site ID for the SDK
@@ -51,6 +50,7 @@ declare module '@maestro_io/maestro-web-sdk' {
                 */
             setSiteID(siteID: string): void;
             getSiteID(): string;
+            getIsProdEnv(): boolean;
             /**
                 * Gets the event view model
                 * @returns The current event view model
@@ -155,6 +155,40 @@ declare module '@maestro_io/maestro-web-sdk/interfaces/IMaestroManager' {
                 */
             userSettings?: IUserSettings;
     };
+    export type SDKStopEventParams = {
+            /**
+                * Event ID for the event being stopped.
+                */
+            eventId?: string;
+            /**
+                * Page ID for the event being stopped.
+                */
+            pageId?: string;
+    };
+    export type SDKEventConfigParams = {
+            /**
+                * The page ID to use to load the page configuration.
+                */
+            pageId?: string;
+            /**
+                * User settings for customizing SDK behavior (panel visibility, feature toggles, etc.)
+                */
+            userSettings?: IUserSettings;
+            /**
+                * Event ID as metadata value to use to load the page configuration.
+                * This is typically used when the page ID is not known, but a metadata value is available.
+                */
+            eventId?: string;
+            /**
+                * The instance of the app's implementation of IMaestroEventDelegate
+                */
+            delegate: IMaestroEventDelegate;
+            /**
+                * @description - Indicates whether to use the production environment for this event.
+                * @default true
+                */
+            useProdEnv?: boolean;
+    };
     /**
      This is the MaestroKit top-level API for initializing and configuring the framework.  It encompasses all functionality that is not specific to an event.
         */
@@ -174,12 +208,14 @@ declare module '@maestro_io/maestro-web-sdk/interfaces/IMaestroManager' {
                  - userSettings: Optional user settings to override the configured settings for this event
                  The function returns an instance of MaestroEventViewModel, which includes an implementation of IMaestroEvent.  IMaestroEvent represents the app-facing portion of the MaestroKit API related to the currently-loaded event.  So after `userDidStartWatchingEvent` is called, the SDK has access to the API detailed in `MaestroEventDelegate` for making calls to the app, and the app has access to the API detailed in `IMaestroEvent` for making calls to the SDK.
                  */
-            userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate, userSettings?: IUserSettings): Promise<IMaestroEvent>;
+            userDidStartWatchingEvent(config: SDKEventConfigParams): Promise<IMaestroEvent>;
             /**
                 * @description Tells the SDK the user has closed an event that was open in the app's player.
-                * @param eventID
+                * @param params - Parameters including eventId or pageId to identify the event being stopped.
+                * @param params.eventId - The Event ID for the event being stopped.
+                * @param params.pageId - The Page ID for the event being stopped.
                 */
-            userDidStopWatchingEvent(eventID: string): void;
+            userDidStopWatchingEvent(params: SDKStopEventParams): Promise<void>;
             /**
                 * Render the PanelManager with the available panels for the current event in the specified HTML id element.
                 * @param id - The ID of the HTML element where the panel will be rendered.
@@ -342,7 +378,7 @@ declare module '@maestro_io/maestro-web-sdk/view-models/MaestroEventViewModel' {
         shopViewModel: ShopViewModel | null;
         panelManagerViewModel: PanelManagerViewModel;
         navigation: SpatialNavigation;
-        constructor(eventId: string | undefined, delegate: IMaestroEventDelegate);
+        constructor(eventId: string | undefined, pageId: string | undefined, delegate: IMaestroEventDelegate);
         setActivePanel(panelType: MaestroPanelType): void;
         updatePlayerTimeCode(timestamp: number): void;
         getPlayerTimeCode(): number | null;
@@ -426,54 +462,8 @@ declare module '@maestro_io/maestro-web-sdk/modules/key-plays/interfaces/IKeyPla
     export {};
 }
 
-declare module '@maestro_io/maestro-web-sdk/interfaces/IUserSettings' {
-    /**
-        * User settings interface for customizing Maestro Web SDK behavior
-        * Supports panel-level and feature-level customizations
-        */
-    export interface IUserSettings {
-            panels?: {
-                    bets?: {
-                            /** Hide the entire bets panel from panel selection */
-                            hidePanel?: boolean;
-                            /** Hide wager values (dollar amounts) in betting cards */
-                            hideWagers?: boolean;
-                    };
-                    stats?: {
-                            /** Hide the entire stats panel from panel selection */
-                            hidePanel?: boolean;
-                    };
-                    keyPlays?: {
-                            /** Hide the entire key plays panel from panel selection */
-                            hidePanel?: boolean;
-                    };
-                    fantasy?: {
-                            /** Hide the entire fantasy panel from panel selection */
-                            hidePanel?: boolean;
-                    };
-                    shop?: {
-                            /** Hide the entire shop panel from panel selection */
-                            hidePanel?: boolean;
-                    };
-            };
-    }
-    /**
-        * Default user settings - all features enabled by default
-        */
-    export const DEFAULT_USER_SETTINGS: IUserSettings;
-    /**
-        * Panel-specific settings type helpers
-        */
-    export type BetsSettings = NonNullable<IUserSettings['panels']>['bets'];
-    export type StatsSettings = NonNullable<IUserSettings['panels']>['stats'];
-    export type KeyPlaysSettings = NonNullable<IUserSettings['panels']>['keyPlays'];
-    /**
-        * Utility type for getting panel settings by panel type
-        */
-    export type PanelSettings<T extends keyof NonNullable<IUserSettings['panels']>> = NonNullable<IUserSettings['panels']>[T];
-}
-
 declare module '@maestro_io/maestro-web-sdk/services/StaticService/types' {
+    import { MaestroPanelType } from '@/models/IPanel';
     import ITheme from '@/models/ITheme';
     type PlatformConfig = {
             analytics: {
@@ -489,7 +479,7 @@ declare module '@maestro_io/maestro-web-sdk/services/StaticService/types' {
             _id: string;
             slug: string;
             panel_name?: string;
-            panel_type?: string;
+            panel_type?: MaestroPanelType;
             icon_name?: string;
             renderer?: {
                     block_data?: TBlockData;
@@ -554,11 +544,12 @@ declare module '@maestro_io/maestro-web-sdk/services/StaticService/types' {
 
 declare module '@maestro_io/maestro-web-sdk/models/IPanel' {
     export const MaestroPanelType: {
-        readonly KEY_PLAYS: "keyPlays";
-        readonly STATS: "stats";
-        readonly BETS: "bets";
-        readonly FANTASY: "fantasy";
-        readonly SHOP: "shop";
+        readonly KEY_PLAYS: "espnKeyPlays";
+        readonly STATS: "espnStats";
+        readonly BETS: "espnBet";
+        readonly FANTASY: "espnFantasy";
+        readonly SHOP: "espnShop";
+        readonly HELLO_WORLD: "helloWorld";
     };
     export type MaestroPanelType = typeof MaestroPanelType[keyof typeof MaestroPanelType];
     export interface PanelTypeInfo {
@@ -567,7 +558,6 @@ declare module '@maestro_io/maestro-web-sdk/models/IPanel' {
         imageNamePrefix: string;
         iconName: string;
     }
-    export const PANEL_TYPE_INFO: Record<MaestroPanelType, PanelTypeInfo>;
 }
 
 declare module '@maestro_io/maestro-web-sdk/components/molecules/Overlay/Overlay' {
@@ -728,6 +718,53 @@ declare module '@maestro_io/maestro-web-sdk/services/AnalyticsService/types' {
     export type ActionTrackEvent = PanelClickAction;
 }
 
+declare module '@maestro_io/maestro-web-sdk/interfaces/IUserSettings' {
+    /**
+        * User settings interface for customizing Maestro Web SDK behavior
+        * Supports panel-level and feature-level customizations
+        */
+    export interface IUserSettings {
+            panels?: {
+                    bets?: {
+                            /** Hide the entire bets panel from panel selection */
+                            hidePanel?: boolean;
+                            /** Hide wager values (dollar amounts) in betting cards */
+                            hideWagers?: boolean;
+                    };
+                    stats?: {
+                            /** Hide the entire stats panel from panel selection */
+                            hidePanel?: boolean;
+                    };
+                    keyPlays?: {
+                            /** Hide the entire key plays panel from panel selection */
+                            hidePanel?: boolean;
+                    };
+                    fantasy?: {
+                            /** Hide the entire fantasy panel from panel selection */
+                            hidePanel?: boolean;
+                    };
+                    shop?: {
+                            /** Hide the entire shop panel from panel selection */
+                            hidePanel?: boolean;
+                    };
+            };
+    }
+    /**
+        * Default user settings - all features enabled by default
+        */
+    export const DEFAULT_USER_SETTINGS: IUserSettings;
+    /**
+        * Panel-specific settings type helpers
+        */
+    export type BetsSettings = NonNullable<IUserSettings['panels']>['bets'];
+    export type StatsSettings = NonNullable<IUserSettings['panels']>['stats'];
+    export type KeyPlaysSettings = NonNullable<IUserSettings['panels']>['keyPlays'];
+    /**
+        * Utility type for getting panel settings by panel type
+        */
+    export type PanelSettings<T extends keyof NonNullable<IUserSettings['panels']>> = NonNullable<IUserSettings['panels']>[T];
+}
+
 declare module '@maestro_io/maestro-web-sdk/helpers/Observable' {
     /**
       * Basic observable implementation for view models
@@ -1143,6 +1180,10 @@ declare module '@maestro_io/maestro-web-sdk/view-models/PanelManagerViewModel' {
             getPanelType(atIndex: number): MaestroPanelType | null;
             get panelTypeToLeft(): MaestroPanelType | null;
             get panelTypeToRight(): MaestroPanelType | null;
+            /**
+                * @returns Array of PanelInfo for panels defined in config but not listed in MaestroPanelType
+                */
+            getUnlistedPanels(): PanelInfo[];
     }
 }