@maestro_io/maestro-web-sdk 2.1.3 → 2.2.1

package/dist/MaestroEventDelegate.d.ts

@@ -3,6 +3,7 @@ import IMaestroEventDelegate from './interfaces/IMaestroEventDelegate';
  * Our own implementation of the IMaestroEventDelegate interface. Useful for Development and Testing
  */
 export default class MaestroEventDelegate implements IMaestroEventDelegate {
+    getStatsAPIBaseURL(): string;
     getBettingAPIBaseURL(): string;
     userRequestedNewKeyPlaysData(): Promise<void>;
     startFocusManagement(): Promise<void>;

package/dist/components/atoms/SvgIcon/Icon.d.ts

@@ -3,7 +3,6 @@ import KeyPlaysIcon from './KeyPlaysIcon';
 import PlayIcon from './PlayIcon';
 import BetsIcon from './BetsIcon';
 import StatsIcon from './StatsIcon';
-import FantasyIcon from './FantasyIcon';
 import WarningIcon from './WarningIcon';
 import FlameIcon from './FlameIcon';
 import BetsWarningIcon from './BetsWarningIcon';
@@ -13,7 +12,6 @@ declare const iconImports: {
     play: typeof PlayIcon;
     bets: typeof BetsIcon;
     stats: typeof StatsIcon;
-    fantasy: typeof FantasyIcon;
     warning: typeof WarningIcon;
     expand: (props: IconProps) => React.JSX.Element;
     collapse: (props: IconProps) => React.JSX.Element;

package/dist/components/core/PanelManager/PanelManager.d.ts

@@ -3,9 +3,12 @@ import './PanelManager.styles.css';
 import { MaestroPanelType } from '@/models/IPanel';
 interface PanelManagerState {
     activePanel: MaestroPanelType;
+    visiblePanels: MaestroPanelType[];
 }
 declare class PanelManager extends React.Component<{}, PanelManagerState> {
     private unsubscribe;
+    private panelsUnsubscribe;
+    private viewModel;
     constructor(props: {});
     componentDidMount(): void;
     componentWillUnmount(): void;

package/dist/components/core/ScrollableContainer/ScrollableContainer.d.ts

@@ -11,7 +11,9 @@ export interface ScrollableContainerContextType {
      * Called when an item is focused.
      * This function scrolls the container to the focused item if necessary.
      */
-    scrollToFocusedElement: (layout: Layout) => void;
+    scrollToFocusedElement: (layout: Layout, options?: {
+        offsetTop?: number;
+    }) => void;
     /**
      * An array of all registered focusable items.
      * This is used to determine the order of focusable items.

package/dist/external/spatial-navigation/spatialNavigation.d.ts

@@ -70,7 +70,7 @@ interface UpdateFocusableOptions {
 export declare const getChildClosestToOrigin: (children: FocusableComponent[]) => FocusableComponent;
 declare class SpatialNavigation {
     private focusableComponents;
-    private focusKey;
+    focusKey: string | null;
     private parentsHavingFocusedChild;
     private nativeMode;
     private throttle;

package/dist/helpers/url.d.ts

@@ -0,0 +1 @@
+export declare const setImageDimensions: (url: string, width: number, height: number) => string;

package/dist/index.d.ts

@@ -3,10 +3,12 @@ import IMaestroManager, { SDKConfigParams } from './interfaces/IMaestroManager';
 import IMaestroEvent from './interfaces/IMaestroEvent';
 import { MaestroEventViewModel } from './view-models/MaestroEventViewModel';
 import IMaestroKeyPlaysResponse from './modules/key-plays/interfaces/IKeyPlaysResponse';
+import { IUserSettings } from './interfaces/IUserSettings';
 export { default as Overlay } from './components/molecules/Overlay/Overlay';
 export { OverlayType, IMaestroOverlayEvent, IOverlaySize, IOverlayPosition, IFantasyPayload, IOverlayAnalyticsEvent, } from './types/OverlayTypes';
 export { IWinningBet } from './models/IWinningBet';
 export { IMaestroEventDelegate, IMaestroEvent, IMaestroKeyPlaysResponse };
+export { IUserSettings, DEFAULT_USER_SETTINGS, } from './interfaces/IUserSettings';
 export type Environment = 'development' | 'staging' | 'production';
 /**
  * Main SDK class that serves as the entry point for the Maestro TV SDK
@@ -27,7 +29,7 @@ declare class MaestroWebSDK implements IMaestroManager {
      * @returns {MaestroWebSDK} - The MaestroWebSDK instance
      */
     static getInstance(): MaestroWebSDK;
-    userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate): Promise<IMaestroEvent>;
+    userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate, userSettings?: IUserSettings): Promise<IMaestroEvent>;
     userDidStopWatchingEvent(_: string): void;
     configure(configParams: SDKConfigParams): void;
     /**

package/dist/interfaces/IMaestroEvent.d.ts

@@ -1,65 +1,92 @@
 import { MaestroPanelType } from '@/models/IPanel';
 import IMaestroKeyPlaysResponse from '../modules/key-plays/interfaces/IKeyPlaysResponse';
+import { IUserSettings } from './IUserSettings';
 /**
  * This is the public API that the app can use to make calls to the SDK related to the currently-loaded event.
  */
 export default interface IMaestroEvent {
     /**
      * @description Tells the SDK that the user just started playing a new key play clip at the given index.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/playback-controls/didStartPlayingClip
      */
     didStartPlayingClip(index: number): void;
     /**
      * @description Tells the SDK that the user just stopped playing a key play clip at the given index.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/playback-controls/didStopPlayingClip
      */
     didStopPlayingClip(index: number): void;
     /**
      * @description Tells the SDK that the user tried to play the clip but it failed to play back.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/playback-controls/didFailToPlayClip
      */
     didFailToPlayClip(index: number): void;
     /**
      * @description Updates the SDK with the latest progress in the playback of the currently-played key play clip, from 0 to 1.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/playback-controls/didUpdatePlaybackProgressOfClip
      */
     didUpdatePlaybackProgressOfClip(index: number, to: number): void;
     /**
      * @description Tells the SDK that the app displayed the MaestroPanel.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/panel-management/didShowPanel
      */
     didShowPanel(): Promise<void>;
     /**
      * @description Tells the SDK that the app hid the MaestroPanel.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/panel-management/didHidePanel
      */
     didHidePanel(): Promise<void>;
     /**
      * @description Alerts the SDK that the current event does not support key plays.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/panel-management/currentEventDoesNotSupportKeyPlays
      */
     currentEventDoesNotSupportKeyPlays(): void;
     /**
      * @description Retrieves the event ID for the currently loaded event.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/getCurrentEventID
      */
     getCurrentEventID(): string | null;
     /**
      * @description Retrieves the array index of the key play clip that is currently being played.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/getCurrentlyPlayingClipIndex
      */
     getCurrentlyPlayingClipIndex(): number | null;
     /**
      * @description Retrieves the array index of the key plays clip that was most recently played.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/getLastPlayedClipIndex
      */
     getLastPlayedClipIndex(): number | null;
     /**
      * @description Retrieves the progress (between 0 and 1) of the currently-played key play clip.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/getCurrentClipPlaybackProgress
      */
     getCurrentClipPlaybackProgress(): number | null;
     /**
      * @description Retrieves the number of key plays.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/getKeyPlaysCount
      */
     getKeyPlaysCount(): number | null;
     /**
      * @description Tells the SDK to start managing focus.
+     * https://developers.maestro.io/sdk/web/focus-management/parent-app-focus
      */
     startFocusManagement(): Promise<void>;
     /**
      * @description Feeds the SDK new key plays data. A null value indicates a failure to retrieve the data.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/updateKeyPlaysData
      */
     updateKeyPlaysData(data: IMaestroKeyPlaysResponse | null): Promise<void>;
+    updateUserSettings(settings: IUserSettings): Promise<void>;
+    /**
+     * @description Updates the SDK with the current time code of the player.
+     * This is used to synchronize the SDK with the player's current time code.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/updatePlayerTimeCode
+     */
+    updatePlayerTimeCode(timestamp: number): void;
+    /**
+     * @description Retrieves the current player time code stored in the SDK.
+     * https://developers.maestro.io/sdk/web/maestro-event-interface/state/getPlayerTimeCode
+     */
+    getPlayerTimeCode(): number | null;
     simulateUseCase<T = any>(useCase: TestUseCase, panelType: MaestroPanelType, testData?: T): void;
 }
 declare const TEST_USE_CASES: {

package/dist/interfaces/IMaestroEventDelegate.d.ts

@@ -5,31 +5,44 @@ export default interface IMaestroEventDelegate {
     /**
      * @description Allows the SDK to tell the client app that the user has encountered an error screen for lack of valid key
        plays data, indicating the client app should call `updateKeyPlaysData` as soon as possible.
+       https://developers.maestro.io/sdk/web/event-delegate/userRequestedNewKeyPlaysData
      */
     userRequestedNewKeyPlaysData(): Promise<void>;
     /**
      * Allows the SDK to request the client app play a particular key plays clip, given its array index in the key plays list.  Note that the `MaestroKeyPlaysResponse` subdivides the key plays by section, so the `index` referenced here assumes the client app has access to a flattened list of the key plays, disregarding the sectional subdivisions.
+     * https://developers.maestro.io/sdk/web/event-delegate/playClip
      */
     playClip(atIndex: number): void;
     /**
-     * @description SDK can notify the client app when its time to handle the focus management
+     * @description SDK can notify the client app when its time to handle the focus management.
+     * https://developers.maestro.io/sdk/web/event-delegate/startFocusManagement
      */
     startFocusManagement(): Promise<void>;
     /**
-     * @description Check if the user is authenticated for betting
+     * @description Check if the user is authenticated for betting.
+     * https://developers.maestro.io/sdk/web/event-delegate/userIsAuthenticated
      */
     userIsAuthenticated(): Promise<boolean>;
     /**
-     * @description Get the user's SWID for authenticated betting requests
+     * @description Get the user's SWID for authenticated betting requests.
+     * https://developers.maestro.io/sdk/web/event-delegate/getUserSWID
      */
     getUserSWID(): Promise<string | null>;
     /**
-     * @description Get the user's Cookie token for authenticated betting requests
+     * @description Get the user's Cookie token for authenticated betting requests.
+     * https://developers.maestro.io/sdk/web/event-delegate/getUserToken
      */
     getUserToken(): Promise<string | null>;
     /**
-     * @description Get the API endpoint for betting-related requests.
-     * This endpoint is used to fetch betting data, such as odds and betting lines.
+     * @description Get the API base URL for betting-related requests.
+     * This baseURL is used to fetch betting data, such as odds and betting lines.
+     * https://developers.maestro.io/sdk/web/event-delegate/getBettingAPIBaseURL
      */
     getBettingAPIBaseURL(): string;
+    /**
+     * @description Get the API base URL for stats-related requests.
+     * This baseURL is used to fetch stats data for the event.
+     *
+     */
+    getStatsAPIBaseURL(): string;
 }

package/dist/interfaces/IMaestroManager.d.ts

@@ -1,5 +1,6 @@
 import IMaestroEventDelegate from './IMaestroEventDelegate';
 import IMaestroEvent from './IMaestroEvent';
+import { IUserSettings } from './IUserSettings';
 export type SDKConfigParams = {
     /**
      * The type of environment to use. Defaults to `development`. The available options are `development`, `staging`, and `production`.
@@ -33,6 +34,10 @@ export type SDKConfigParams = {
      * The client app SWID for authentication.
      */
     clientAppSwid?: string;
+    /**
+     * User settings for customizing SDK behavior (panel visibility, feature toggles, etc.)
+     */
+    userSettings?: IUserSettings;
 };
 /**
  This is the MaestroKit top-level API for initializing and configuring the framework.  It encompasses all functionality that is not specific to an event.
@@ -47,6 +52,7 @@ export default interface IMaestroManager {
      * @param {SDKConfigParams['siteID']} configParams.siteID - The site ID to use for the SDK.
      * @param {SDKConfigParams['jwt']} configParams.jwt - The JWT token to use for authentication.
      * @param {SDKConfigParams['userID']} configParams.userID - The user ID of the logged account.
+     * @param {SDKConfigParams['userSettings']} configParams.userSettings - User settings for customizing SDK behavior.
      */
     configure(configParams: SDKConfigParams): void;
     /**
@@ -54,9 +60,10 @@ export default interface IMaestroManager {
        Arguments:
        - eventID: The Event ID for the event opened in the player.
        - delegate: an instance of the app's implementation of IMaestroEventDelegate
+       - 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): Promise<IMaestroEvent>;
+    userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate, userSettings?: IUserSettings): Promise<IMaestroEvent>;
     /**
      * @description Tells the SDK the user has closed an event that was open in the app's player.
      * @param eventID

package/dist/interfaces/IUserSettings.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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;
+        };
+    };
+}
+/**
+ * Default user settings - all features enabled by default
+ */
+export declare 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];