@maestro_io/maestro-web-sdk 1.0.0 → 2.0.1

package/dist/index.d.ts

@@ -1,382 +1,60 @@
-declare type AthleteId = string;
-
-export declare type Environment = 'development' | 'staging' | 'production';
-
-declare interface IKeyPlay {
-    id: string;
-    description: string;
-    homeTeamName: string;
-    awayTeamName: string;
-    homeTeamScore?: number;
-    awayTeamScore?: number;
-    clipID: string;
-    teamImageUrl?: string;
-    playerImageUrl?: string;
-    thumbnailImageUrl?: string;
-    section?: string;
-}
-
-/**
- * This is the public API that the app can use to make calls to the SDK related to the currently-loaded event.
- */
-export declare interface IMaestroEvent {
-    /**
-     * @description Tells the SDK that the user just started playing a new key play clip at the given index.
-     */
-    didStartPlayingClip(index: number): void;
-    /**
-     * @description Tells the SDK that the user just stopped playing a key play clip at the given index.
-     */
-    didStopPlayingClip(index: number): void;
-    /**
-     * @description Tells the SDK that the user tried to play the clip but it failed to play back.
-     */
-    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.
-     */
-    didUpdatePlaybackProgressOfClip(index: number, to: number): void;
-    /**
-     * @description Tells the SDK that the app displayed the MaestroPanel.
-     */
-    didShowPanel(): Promise<void>;
-    /**
-     * @description Tells the SDK that the app hid the MaestroPanel.
-     */
-    didHidePanel(): Promise<void>;
-    /**
-     * @description Alerts the SDK that the current event does not support key plays.
-     */
-    currentEventDoesNotSupportKeyPlays(): void;
-    /**
-     * @description Retrieves the event ID for the currently loaded event.
-     */
-    getCurrentEventID(): string | null;
-    /**
-     * @description Retrieves the array index of the key play clip that is currently being played.
-     */
-    getCurrentlyPlayingClipIndex(): number | null;
-    /**
-     * @description Retrieves the array index of the key plays clip that was most recently played.
-     */
-    getLastPlayedClipIndex(): number | null;
-    /**
-     * @description Retrieves the progress (between 0 and 1) of the currently-played key play clip.
-     */
-    getCurrentClipPlaybackProgress(): number | null;
-    /**
-     * @description Retrieves the number of key plays.
-     */
-    getKeyPlaysCount(): number | null;
-    /**
-     * @description Tells the SDK to start managing focus.
-     */
-    startFocusManagement(): Promise<void>;
-    /**
-     * @description Feeds the SDK new key plays data. A null value indicates a failure to retrieve the data.
-     */
-    updateKeyPlaysData(data: IMaestroKeyPlaysResponse | null): Promise<void>;
-}
-
-/**
- * @description Interface for the client app to implement in order to handle Maestro TV SDK events.
- */
-export declare 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.
-     */
-    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.
-     */
-    playClip(atIndex: number): void;
-    /**
-     * @description SDK can notify the client app when its time to handle the focus management
-     */
-    startFocusManagement(): Promise<void>;
-}
-
-export declare interface IMaestroKeyPlaysResponse {
-    entities: {
-        team: Record<TeamId, IMaestroKeyPlaysTeam>;
-        athlete: Record<AthleteId, MaestroKeyPlaysAthlete>;
-    };
-    sections: MaestroKeyPlaysSection[];
-}
-
-declare interface IMaestroKeyPlaysTeam {
-    id: string;
-    displayName: string;
-    shortName: string;
-    color: string;
-    alternateColor: string;
-    homeAway: string;
-    displayOrder: string;
-    logoRef: string;
-    logoDarkRef: string;
-}
-
-/**
- This is the MaestroKit top-level API for initializing and configuring the framework.  It encompasses all functionality that is not specific to an event.
- */
-declare interface IMaestroManager {
-    /**
-     * @description Configure the MaestroWebSDK.
-     * @param {SDKConfigParams} configParams - Configuration parameters
-     * @param {SDKConfigParams['environment']} configParams.environment - The type of environment to use. Defaults to 'development'.
-     * @param {SDKConfigParams['pollFrequency']} configParams.pollFrequency - The frequency in seconds to poll for updates. Defaults to 5.0.
-     * @param {SDKConfigParams['progressUpdateFrequency']} configParams.progressUpdateFrequency - The frequency in seconds to update progress. Defaults to 0.1.
-     * @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.
-     */
-    configure(configParams: SDKConfigParams): void;
-    /**
-     Tells the SDK the user has opened an event in the app's player.
-     Arguments:
-     - eventID: The Event ID for the event opened in the player.
-     - delegate: an instance of the app's implementation of IMaestroEventDelegate
-     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>;
-    /**
-     * @description Tells the SDK the user has closed an event that was open in the app's player.
-     * @param eventID
-     */
-    userDidStopWatchingEvent(eventID: string): void;
-    /**
-     * @description Authenticates user.
-     * @param id - The user's ID.
-     * @param jwt - The user's jwt.
-     */
-    authenticateUser(id: string, jwt: string): Promise<void>;
-    /**
-     * Logs out currently-authenticated user.
-     */
-    deauthenticateUser(): Promise<void>;
-    /**
-     * Gets the site ID for the SDK
-     * @returns The site ID
-     */
-    getSiteID(): string | undefined;
-    /**
-     * Gets the JWT token for authentication
-     * @returns The JWT token
-     */
-    getJwt(): string | undefined;
-    /**
-     * Gets the user ID for the SDK
-     * @returns The user ID
-     */
-    getUserID(): string | undefined;
-}
-
-declare const KEY_PLAYS_ERROR_STATE: {
-    readonly unsupportedEvent: "unsupportedEvent";
-    readonly unpopulatedEvent: "unpopulatedEvent";
-    readonly tabLoadFailure: "tabLoadFailure";
-};
-
-declare const KEY_PLAYS_LOAD_FAILURE_STATUS: {
-    readonly noFailure: "noFailure";
-    readonly recentFailure: "recentFailure";
-    readonly nonRecentFailure: "nonRecentFailure";
-};
-
-declare type KeyPlayItem = {
-    title: string;
-    items: IKeyPlay[];
-};
-
-declare type KeyPlayLoadFailureStatus = (typeof KEY_PLAYS_LOAD_FAILURE_STATUS)[keyof typeof KEY_PLAYS_LOAD_FAILURE_STATUS];
-
-declare type KeyPlaysErrorState = (typeof KEY_PLAYS_ERROR_STATE)[keyof typeof KEY_PLAYS_ERROR_STATE];
-
-declare class KeyPlaysViewModel {
-    currentlyPlayingClipIndex: Observable<number | null>;
-    lastPlayedClipIndex: Observable<number | null>;
-    currentClipPlaybackProgress: Observable<number | null>;
-    errorState: Observable<KeyPlaysErrorState | null>;
-    failedClips: Observable<{
-        [key: string]: KeyPlayLoadFailureStatus;
-    }>;
-    items: Observable<KeyPlayItem[]>;
-    isCurrentlyPlaying(index: number): boolean;
-    setKeyPlays(items: IMaestroKeyPlaysResponse | null): Promise<void>;
-    private cleanErrors;
-    playKeyPlay(atIndex: number): Promise<void>;
-    parseNetworkResponse(response: IMaestroKeyPlaysResponse): KeyPlayItem[];
-    get allItems(): IKeyPlay[];
-    clipID(forKeyPlayAtIndex: number): string | undefined;
-    handleKeyPlayLoadFailure(forKeyPlayAtIndex: number): void;
-    loadFailureStatus(forKeyPlayAtIndex: number): KeyPlayLoadFailureStatus;
-    clearLoadFailureStatus(forKeyPlayAtIndex: number): void;
-    userRequestedNewKeyPlaysData(): Promise<void>;
-}
-
-declare class MaestroEventViewModel extends ViewModel implements IMaestroEvent {
-    private _eventId;
-    private _title;
-    private _isLive;
-    delegate: IMaestroEventDelegate;
-    keyPlaysViewModel: KeyPlaysViewModel;
-    constructor(eventId: string | undefined, delegate: IMaestroEventDelegate);
-    deinit(): void;
-    updateKeyPlaysData(data: IMaestroKeyPlaysResponse | null): Promise<void>;
-    startFocusManagement(): Promise<void>;
-    didStartPlayingClip(index: number): void;
-    didStopPlayingClip(index: number): void;
-    didFailToPlayClip(index: number): void;
-    didUpdatePlaybackProgressOfClip(index: number, to: number): void;
-    didShowPanel(): Promise<void>;
-    didHidePanel(): Promise<void>;
-    didShowOverlay(): Promise<void>;
-    didHideOverlay(): Promise<void>;
-    currentEventDoesNotSupportKeyPlays(): void;
-    getCurrentEventID(): string;
-    getCurrentlyPlayingClipIndex(): number | null;
-    getLastPlayedClipIndex(): number | null;
-    getCurrentClipPlaybackProgress(): number | null;
-    getKeyPlaysCount(): number;
-    get eventId(): Observable<string>;
-    get title(): Observable<string>;
-    get isLive(): Observable<boolean>;
-}
-
-declare interface MaestroKeyPlay {
-    description: string;
-    team: string;
-    wallClock: string;
-    displayClock: string;
-    shortPeriod: string;
-    scoringPlay: boolean;
-    athlete: string;
-    thumbnail: string;
-    thumbnailType: string;
-    clipID: string;
-    awayScore?: string;
-    homeScore?: string;
-}
-
-declare interface MaestroKeyPlaysAthlete {
-    id: string;
-    shortName: string;
-    headshot: string;
-}
-
-declare interface MaestroKeyPlaysSection {
-    title: string;
-    items: MaestroKeyPlay[];
-}
-
-/**
- * Main SDK class that serves as the entry point for the Maestro TV SDK
- * Follows a singleton pattern similar to the Swift implementation
- */
-declare class MaestroWebSDK implements IMaestroManager {
-    private static instance;
-    private renderer;
-    private siteID?;
-    private jwt?;
-    private userID?;
-    private maestroEventViewModel;
-    private constructor();
-    userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate): Promise<IMaestroEvent>;
-    userDidStopWatchingEvent(_: string): void;
-    authenticateUser(_: string, __: string): Promise<void>;
-    deauthenticateUser(): Promise<void>;
-    /**
-     * @description Returns the MaestroWebSDK instance
-     * @returns {MaestroWebSDK} - The MaestroWebSDK instance
-     */
-    static getInstance(): MaestroWebSDK;
-    configure(configParams: SDKConfigParams): void;
-    /**
-     * Checks if this is an authorized client based on siteID
-     */
-    get isAuthorizedClient(): boolean;
-    /**
-     * Sets the site ID for the SDK
-     * @param siteID The site ID to set
-     */
-    setSiteID(siteID?: string): void;
-    getSiteID(): string | undefined;
-    /**
-     * Sets the JWT token for authentication
-     * @param jwt The JWT token to set
-     */
-    setJwt(jwt: string): void;
-    getJwt(): string | undefined;
-    /**
-     * Sets the user ID for the SDK
-     * @param userID The user ID to set
-     */
-    setUserID(userID: string): void;
-    getUserID(): string | undefined;
-    /**
-     * Gets the event view model
-     * @returns The current event view model
-     */
-    getMaestroEventViewModel(): MaestroEventViewModel;
-    renderPanel(id: string): Promise<() => void>;
-}
-
-/**
- * Basic observable implementation for view models
- */
-declare class Observable<T> {
-    private listeners;
-    private _value;
-    constructor(initialValue: T);
-    get value(): T;
-    set value(newValue: T);
-    subscribe(listener: (value: T) => void): () => void;
-    private notify;
-}
-
-declare const SDK: MaestroWebSDK;
-export default SDK;
-
-declare type SDKConfigParams = {
-    /**
-     * The type of environment to use. Defaults to `development`. The available options are `development`, `staging`, and `production`.
-     */
-    environment?: 'development' | 'staging' | 'production';
-    /**
-     * The frequency in seconds to poll for updates. Defaults to 5.0.
-     */
-    pollFrequency?: number;
-    /**
-     * The frequency in seconds to update progress. Defaults to 0.1.
-     */
-    progressUpdateFrequency?: number;
-    /**
-     * The site ID to use for the SDK.
-     */
-    siteID?: string;
-    /**
-     * The JWT token to use for authentication.
-     */
-    jwt?: string;
-    /**
-     * The user ID of the logged account.
-     */
-    userID?: string;
-};
-
-declare type TeamId = string;
-
-/**
- * Base view model that implements reactive properties
- */
-declare abstract class ViewModel {
-    private _isLoading;
-    private _error;
-    get isLoading(): Observable<boolean>;
-    get error(): Observable<string | null>;
-    protected setLoading(loading: boolean): void;
-    protected setError(error: string | null): void;
-}
-
-export { }
+import IMaestroEventDelegate from './interfaces/IMaestroEventDelegate';
+import IMaestroManager, { SDKConfigParams } from './interfaces/IMaestroManager';
+import IMaestroEvent from './interfaces/IMaestroEvent';
+import { MaestroEventViewModel } from './view-models/MaestroEventViewModel';
+import type IMaestroKeyPlaysResponse from './modules/key-plays/interfaces/IKeyPlaysResponse';
+export { type IMaestroEventDelegate, type IMaestroEvent, type IMaestroKeyPlaysResponse, };
+export type Environment = 'development' | 'staging' | 'production';
+/**
+ * Main SDK class that serves as the entry point for the Maestro TV SDK
+ * Follows a singleton pattern similar to the Swift implementation
+ */
+declare class MaestroWebSDK implements IMaestroManager {
+    private static instance;
+    private renderer;
+    private siteID?;
+    private jwt?;
+    private userID?;
+    private maestroEventViewModel;
+    private constructor();
+    userDidStartWatchingEvent(eventID: string, delegate: IMaestroEventDelegate): Promise<IMaestroEvent>;
+    userDidStopWatchingEvent(eventId: string): void;
+    authenticateUser(_: string, __: string): Promise<void>;
+    deauthenticateUser(): Promise<void>;
+    /**
+     * @description Returns the MaestroWebSDK instance
+     * @returns {MaestroWebSDK} - The MaestroWebSDK instance
+     */
+    static getInstance(): MaestroWebSDK;
+    configure(configParams: SDKConfigParams): void;
+    /**
+     * Checks if this is an authorized client based on siteID
+     */
+    get isAuthorizedClient(): boolean;
+    /**
+     * Sets the site ID for the SDK
+     * @param siteID The site ID to set
+     */
+    setSiteID(siteID?: string): void;
+    getSiteID(): string | undefined;
+    /**
+     * Sets the JWT token for authentication
+     * @param jwt The JWT token to set
+     */
+    setJwt(jwt: string): void;
+    getJwt(): string | undefined;
+    /**
+     * Sets the user ID for the SDK
+     * @param userID The user ID to set
+     */
+    setUserID(userID: string): void;
+    getUserID(): string | undefined;
+    /**
+     * Gets the event view model
+     * @returns The current event view model
+     */
+    getMaestroEventViewModel(): MaestroEventViewModel;
+    renderPanel(id: string): Promise<() => void>;
+}
+declare const SDK: MaestroWebSDK;
+export default SDK;

package/dist/interfaces/IMaestroEvent.d.ts

@@ -0,0 +1,62 @@
+import IMaestroKeyPlaysResponse from '../modules/key-plays/interfaces/IKeyPlaysResponse';
+/**
+ * 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.
+     */
+    didStartPlayingClip(index: number): void;
+    /**
+     * @description Tells the SDK that the user just stopped playing a key play clip at the given index.
+     */
+    didStopPlayingClip(index: number): void;
+    /**
+     * @description Tells the SDK that the user tried to play the clip but it failed to play back.
+     */
+    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.
+     */
+    didUpdatePlaybackProgressOfClip(index: number, to: number): void;
+    /**
+     * @description Tells the SDK that the app displayed the MaestroPanel.
+     */
+    didShowPanel(): Promise<void>;
+    /**
+     * @description Tells the SDK that the app hid the MaestroPanel.
+     */
+    didHidePanel(): Promise<void>;
+    /**
+     * @description Alerts the SDK that the current event does not support key plays.
+     */
+    currentEventDoesNotSupportKeyPlays(): void;
+    /**
+     * @description Retrieves the event ID for the currently loaded event.
+     */
+    getCurrentEventID(): string | null;
+    /**
+     * @description Retrieves the array index of the key play clip that is currently being played.
+     */
+    getCurrentlyPlayingClipIndex(): number | null;
+    /**
+     * @description Retrieves the array index of the key plays clip that was most recently played.
+     */
+    getLastPlayedClipIndex(): number | null;
+    /**
+     * @description Retrieves the progress (between 0 and 1) of the currently-played key play clip.
+     */
+    getCurrentClipPlaybackProgress(): number | null;
+    /**
+     * @description Retrieves the number of key plays.
+     */
+    getKeyPlaysCount(): number | null;
+    /**
+     * @description Tells the SDK to start managing focus.
+     */
+    startFocusManagement(): Promise<void>;
+    /**
+     * @description Feeds the SDK new key plays data. A null value indicates a failure to retrieve the data.
+     */
+    updateKeyPlaysData(data: IMaestroKeyPlaysResponse | null): Promise<void>;
+}

package/dist/interfaces/IMaestroEventDelegate.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @description Interface for the client app to implement in order to handle Maestro TV SDK events.
+ */
+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.
+     */
+    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.
+     */
+    playClip(atIndex: number): void;
+    /**
+     * @description SDK can notify the client app when its time to handle the focus management
+     */
+    startFocusManagement(): Promise<void>;
+}

package/dist/interfaces/IMaestroManager.d.ts

@@ -0,0 +1,82 @@
+import IMaestroEventDelegate from './IMaestroEventDelegate';
+import IMaestroEvent from './IMaestroEvent';
+export type SDKConfigParams = {
+    /**
+     * The type of environment to use. Defaults to `development`. The available options are `development`, `staging`, and `production`.
+     */
+    environment?: 'development' | 'staging' | 'production';
+    /**
+     * The frequency in seconds to poll for updates. Defaults to 5.0.
+     */
+    pollFrequency?: number;
+    /**
+     * The frequency in seconds to update progress. Defaults to 0.1.
+     */
+    progressUpdateFrequency?: number;
+    /**
+     * The site ID to use for the SDK.
+     */
+    siteID?: string;
+    /**
+     * The JWT token to use for authentication.
+     */
+    jwt?: string;
+    /**
+     * The user ID of the logged account.
+     */
+    userID?: string;
+};
+/**
+ This is the MaestroKit top-level API for initializing and configuring the framework.  It encompasses all functionality that is not specific to an event.
+ */
+export default interface IMaestroManager {
+    /**
+     * @description Configure the MaestroWebSDK.
+     * @param {SDKConfigParams} configParams - Configuration parameters
+     * @param {SDKConfigParams['environment']} configParams.environment - The type of environment to use. Defaults to 'development'.
+     * @param {SDKConfigParams['pollFrequency']} configParams.pollFrequency - The frequency in seconds to poll for updates. Defaults to 5.0.
+     * @param {SDKConfigParams['progressUpdateFrequency']} configParams.progressUpdateFrequency - The frequency in seconds to update progress. Defaults to 0.1.
+     * @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.
+     */
+    configure(configParams: SDKConfigParams): void;
+    /**
+     Tells the SDK the user has opened an event in the app's player.
+     Arguments:
+     - eventID: The Event ID for the event opened in the player.
+     - delegate: an instance of the app's implementation of IMaestroEventDelegate
+     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>;
+    /**
+     * @description Tells the SDK the user has closed an event that was open in the app's player.
+     * @param eventID
+     */
+    userDidStopWatchingEvent(eventID: string): void;
+    /**
+     * @description Authenticates user.
+     * @param id - The user's ID.
+     * @param jwt - The user's jwt.
+     */
+    authenticateUser(id: string, jwt: string): Promise<void>;
+    /**
+     * Logs out currently-authenticated user.
+     */
+    deauthenticateUser(): Promise<void>;
+    /**
+     * Gets the site ID for the SDK
+     * @returns The site ID
+     */
+    getSiteID(): string | undefined;
+    /**
+     * Gets the JWT token for authentication
+     * @returns The JWT token
+     */
+    getJwt(): string | undefined;
+    /**
+     * Gets the user ID for the SDK
+     * @returns The user ID
+     */
+    getUserID(): string | undefined;
+}