@maestro_io/maestro-web-sdk 2.2.0 → 2.2.2

package/dist/MaestroEventDelegate.d.ts

@@ -1,8 +1,11 @@
 import IMaestroEventDelegate from './interfaces/IMaestroEventDelegate';
+import { ActionTrackEvent, ImpressionTrackEvent } from './services/AnalyticsService/types';
 /**
  * Our own implementation of the IMaestroEventDelegate interface. Useful for Development and Testing
  */
 export default class MaestroEventDelegate implements IMaestroEventDelegate {
+    trackImpression(impression: ImpressionTrackEvent): void;
+    trackAction(action: ActionTrackEvent): void;
     getStatsAPIBaseURL(): string;
     getBettingAPIBaseURL(): string;
     userRequestedNewKeyPlaysData(): Promise<void>;

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/organisms/SegmentController/SegmentController.d.ts

@@ -22,6 +22,7 @@ declare class SegmentController extends React.Component<SegmentControllerProps>
         lastActiveIndex: number;
     };
     onBecameFocused: (item: SegmentItem, i: number) => (layout: Layout) => void;
+    onEnterPress: (item: SegmentItem) => () => void;
     handleArrowPress: (index: number) => (direction: Direction, _props: WithFocusableProps) => void;
     render(): React.JSX.Element;
 }

package/dist/external/AxiosNetworkClient.d.ts

@@ -14,7 +14,7 @@ declare class AxiosNetworkClient implements INetworkClient {
     });
     private retry;
     get<TResponseData = any>(endpoint: string, params?: Record<string, any>, headers?: Record<string, string>): Promise<TResponseData>;
-    post<TRequestData = any, TResponseData = any>(endpoint: string, data: TRequestData): Promise<TResponseData>;
+    post<TRequestData = any, TResponseData = any>(endpoint: string, data: TRequestData, params?: Record<string, any>, headers?: Record<string, string>): Promise<TResponseData>;
     setAuthentication(token: string | null, apiKey: string | null): void;
 }
 export default AxiosNetworkClient;

package/dist/external/ports/networkClient.d.ts

@@ -1,5 +1,5 @@
 export interface INetworkClient {
     get<TResponseData = any>(endpoint: string, params?: Record<string, any>, headers?: Record<string, string>): Promise<TResponseData>;
-    post<TRequestData = any, TResponseData = any>(endpoint: string, data: TRequestData): Promise<TResponseData>;
+    post<TRequestData = any, TResponseData = any>(endpoint: string, data: TRequestData, params?: Record<string, any>, headers?: Record<string, string>): Promise<TResponseData>;
     setAuthentication(token: string | null, apiKey: string | null): void;
 }

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,11 +3,14 @@ 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 { ActionTrackEvent, ImpressionTrackEvent, Metadata, PanelClickAction, PanelViewAction, } from './services/AnalyticsService/types';
 export { IMaestroEventDelegate, IMaestroEvent, IMaestroKeyPlaysResponse };
-export type Environment = 'development' | 'staging' | 'production';
+export { IUserSettings, DEFAULT_USER_SETTINGS, } from './interfaces/IUserSettings';
+export type Environment = 'development' | 'production';
 /**
  * Main SDK class that serves as the entry point for the Maestro TV SDK
  * Follows a singleton pattern similar to the Swift implementation
@@ -21,15 +24,22 @@ declare class MaestroWebSDK implements IMaestroManager {
     private clientAppToken?;
     private clientAppSwid?;
     private maestroEventViewModel;
+    private environment;
     private constructor();
     /**
      * @description Returns the MaestroWebSDK instance
      * @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;
+    /**
+     * Sets the environment for the SDK
+     * @param environment The environment to set
+     */
+    setEnvironment(environment: Environment): void;
+    getEnvironment(): Environment;
     /**
      * Checks if this is an authorized client based on siteID
      */

package/dist/interfaces/IMaestroEvent.d.ts

@@ -1,5 +1,6 @@
 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.
  */
@@ -74,6 +75,18 @@ export default interface IMaestroEvent {
      * 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

@@ -1,3 +1,4 @@
+import { ActionTrackEvent, ImpressionTrackEvent } from '@/services/AnalyticsService/types';
 /**
  * @description Interface for the client app to implement in order to handle Maestro TV SDK events.
  */
@@ -45,4 +46,14 @@ export default interface IMaestroEventDelegate {
      *
      */
     getStatsAPIBaseURL(): string;
+    /**
+     * @description Track an user's action event for analytics. (i.e. key play clicked)
+     * https://developers.maestro.io/sdk/web/event-delegate/trackAction
+     */
+    trackAction(action: ActionTrackEvent): void;
+    /**
+     * @description Track an impression event for analytics. (i.e. panel view)
+     * https://developers.maestro.io/sdk/web/event-delegate/trackImpression
+     */
+    trackImpression(impression: ImpressionTrackEvent): void;
 }

package/dist/interfaces/IMaestroManager.d.ts

@@ -1,10 +1,12 @@
 import IMaestroEventDelegate from './IMaestroEventDelegate';
 import IMaestroEvent from './IMaestroEvent';
+import { Environment } from '..';
+import { IUserSettings } from './IUserSettings';
 export type SDKConfigParams = {
     /**
      * The type of environment to use. Defaults to `development`. The available options are `development`, `staging`, and `production`.
      */
-    environment?: 'development' | 'staging' | 'production';
+    environment?: Environment;
     /**
      * The frequency in seconds to poll for updates. Defaults to 5.0.
      */
@@ -33,6 +35,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 +53,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 +61,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];