@maestro_io/maestro-web-sdk 2.1.2 → 2.2.0

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/Rive/index.d.ts

@@ -10,6 +10,7 @@ declare const _default: {
         onLoadRiveInstance: (riveInstance: any) => void;
     } & WithFocusableProps) | undefined, context?: any): {
         state: import("../../../external/spatial-navigation/withFocusable").WithFocusableState;
+        navigation: import("../../../external/spatial-navigation/spatialNavigation").default;
         getChildContext(): {
             parentFocusKey: string;
         };

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/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/components/molecules/ActionButton/ActionButton.d.ts

@@ -5,6 +5,7 @@ import React from 'react';
 declare const _default: {
     new (props?: (object & WithFocusableProps) | undefined, context?: any): {
         state: import("../../../external/spatial-navigation/withFocusable").WithFocusableState;
+        navigation: import("../../../external/spatial-navigation/spatialNavigation").default;
         getChildContext(): {
             parentFocusKey: string;
         };

package/dist/components/molecules/PanelNavButton/PanelNavButton.d.ts

@@ -14,6 +14,7 @@ type PanelNavButtonProps = {
 declare const _default: {
     new (props?: (PanelNavButtonProps & import("@/external/spatial-navigation").WithFocusableProps) | undefined, context?: any): {
         state: import("../../../external/spatial-navigation/withFocusable").WithFocusableState;
+        navigation: import("../../../external/spatial-navigation/spatialNavigation").default;
         getChildContext(): {
             parentFocusKey: string;
         };

package/dist/components/organisms/SegmentController/SegmentController.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import './SegmentController.styles.css';
-import { Details, Direction, Layout } from '@/external/spatial-navigation/utils';
+import { Direction, Layout } from '@/external/spatial-navigation/utils';
 import { WithFocusableProps } from '@/external/spatial-navigation';
 export type SegmentItem = {
     title: string;
@@ -22,7 +22,7 @@ declare class SegmentController extends React.Component<SegmentControllerProps>
         lastActiveIndex: number;
     };
     onBecameFocused: (item: SegmentItem, i: number) => (layout: Layout) => void;
-    handleArrowPress: (index: number) => (direction: Direction, _props: WithFocusableProps, details: Details) => void;
+    handleArrowPress: (index: number) => (direction: Direction, _props: WithFocusableProps) => void;
     render(): React.JSX.Element;
 }
 export default SegmentController;

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

@@ -1,5 +1,4 @@
 import withFocusable, { WithFocusableProps } from './withFocusable';
-import { InitOptions, KeyMap } from './spatialNavigation';
-declare const destroy: () => void, pause: () => void, resume: () => void, setFocus: (targetFocusKey: string, details?: Record<string, any>) => void, init: ({ debug, visualDebug, nativeMode, throttle, throttleKeypresses, }?: InitOptions) => void, setKeyMap: (keyMap: KeyMap) => void;
-export { withFocusable, init, setKeyMap, destroy, pause, resume, setFocus };
+import SpatialNavigation, { InitOptions, KeyMap } from './spatialNavigation';
+export { withFocusable, SpatialNavigation };
 export { InitOptions, KeyMap, WithFocusableProps };

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

@@ -70,9 +70,8 @@ interface UpdateFocusableOptions {
 export declare const getChildClosestToOrigin: (children: FocusableComponent[]) => FocusableComponent;
 declare class SpatialNavigation {
     private focusableComponents;
-    private focusKey;
+    focusKey: string | null;
     private parentsHavingFocusedChild;
-    private enabled;
     private nativeMode;
     private throttle;
     private throttleKeypresses;
@@ -105,7 +104,7 @@ declare class SpatialNavigation {
      * They used as a base to measure adjacent slices
      */
     sortSiblingsByPriority(siblings: FocusableComponent[], currentLayout: Layout, direction: Direction, _focusKey: string): FocusableComponent[];
-    constructor();
+    constructor(options?: InitOptions);
     init({ debug, visualDebug, nativeMode, throttle, throttleKeypresses, }?: InitOptions): void;
     startDrawLayouts(): void;
     destroy(): void;
@@ -153,5 +152,4 @@ declare class SpatialNavigation {
 /**
  * Export singleton
  */
-declare const _default: SpatialNavigation;
-export default _default;
+export default SpatialNavigation;

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

@@ -34,6 +34,7 @@ export interface WithFocusableState {
 declare const withFocusable: <P extends object>({ forgetLastFocusedChild: configForgetLastFocusedChild, trackChildren: configTrackChildren, autoRestoreFocus: configAutoRestoreFocus, blockNavigationOut: configBlockNavigationOut, }?: WithFocusableConfig) => (WrappedComponent: import("react").ComponentType<P & WithFocusableProps>) => {
     new (props?: (P & WithFocusableProps) | undefined, context?: any): {
         state: WithFocusableState;
+        navigation: import("./spatialNavigation").default;
         getChildContext(): {
             parentFocusKey: string;
         };

package/dist/interfaces/IMaestroEvent.d.ts

@@ -6,58 +6,72 @@ import IMaestroKeyPlaysResponse from '../modules/key-plays/interfaces/IKeyPlaysR
 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>;
     simulateUseCase<T = any>(useCase: TestUseCase, panelType: MaestroPanelType, testData?: T): void;

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