@player-tools/devtools-client 0.2.1 → 0.2.2--canary.17.363

package/dist/index.d.ts

@@ -1,21 +1,40 @@
-import { Runtime, RPCRequestHandler, RPCRequestMessageEvent, PlayersState, Message } from '@player-tools/devtools-common';
-export * from '@player-tools/devtools-common';
-import { Store } from 'redux';
-import { AsyncThunk, ActionReducerMapBuilder } from '@reduxjs/toolkit';
+import * as _reduxjs_toolkit from '@reduxjs/toolkit';
+import { AsyncThunk, ActionCreatorWithPayload, AnyAction, ActionReducerMapBuilder, Middleware, Dispatch, EnhancedStore } from '@reduxjs/toolkit';
+import * as _player_tools_devtools_common from '@player-tools/devtools-common';
+import { Methods as Methods$1, Events as Events$1, Message, ProfilerNode } from '@player-tools/devtools-common';
+import * as _reduxjs_toolkit_dist_createReducer from '@reduxjs/toolkit/dist/createReducer';
+import * as _player_ui_types from '@player-ui/types';
+import { View, Flow } from '@player-ui/types';
+import * as reselect from 'reselect';
 
-declare type RuntimeRPCRequestHandlers = {
-    [key in Runtime.RuntimeRPCTypes]: RPCRequestHandler<any>;
+declare namespace Methods {
+    /** Type describing an object containing async thunks for each Method defined */
+    type MethodThunks = {
+        [key in Methods$1.Method["type"]]: AsyncThunk<Methods$1.ByType<key>['result'], Methods$1.ByType<key>, any>;
+    };
+    type MethodHandler = <T extends Methods$1.MethodTypes>(method: Methods$1.ByType<T>) => Promise<Methods$1.ByType<T>['result']>;
+    const buildAsyncThunks: (onMethodRequest: MethodHandler) => MethodThunks;
+}
+declare namespace Events {
+    /** Redux actions associated against all possible event types */
+    type EventActions = {
+        [key in Events$1.EventTypes]: ActionCreatorWithPayload<Events$1.ByType<key>, key>;
+    };
+    export interface EventAction<T extends Events$1.EventTypes = Events$1.EventTypes> extends AnyAction {
+        payload: Events$1.ByType<T>;
+    }
+    /** Redux actions associated against all defined event types */
+    export const actions: EventActions;
+    export {};
+}
+declare const Actions: {
+    'selected-player': _reduxjs_toolkit.ActionCreatorWithOptionalPayload<string | undefined, string>;
+    'player-timeline-event': ActionCreatorWithPayload<Events$1.TimelineEvents, string>;
+    'clear-selected-data-details': _reduxjs_toolkit.ActionCreatorWithoutPayload<"clear-selected-data-details">;
+    'clear-console': _reduxjs_toolkit.ActionCreatorWithoutPayload<"clear-console">;
+    'clear-logs': _reduxjs_toolkit.ActionCreatorWithoutPayload<"clear-logs">;
+    'clear-store': _reduxjs_toolkit.ActionCreatorWithoutPayload<"clear-store">;
 };
-declare const buildRPCRequests: (onRequestMessage: (message: RPCRequestMessageEvent<Runtime.RuntimeRPC>) => void) => RuntimeRPCRequestHandlers;
-
-declare type AsyncRPCActions = {
-    [key in Runtime.RuntimeRPCTypes]: AsyncThunk<Extract<Runtime.RuntimeRPC, {
-        type: key;
-    }>['result'], Extract<Runtime.RuntimeRPC, {
-        type: key;
-    }>['params'], any>;
-};
-declare const buildRPCActions: (handlers: RuntimeRPCRequestHandlers) => AsyncRPCActions;
 
 declare const GET_INFO_DETAILS = "GET_INFO_DETAILS";
 declare const GET_CONFIG_DETAILS = "GET_CONFIG_DETAILS";
@@ -24,15 +43,287 @@ declare const GET_DATA_BINDING_DETAILS = "GET_DATA_BINDING_DETAILS";
 declare const GET_CONSOLE_EVAL = "GET_CONSOLE_EVAL";
 declare const START_PROFILER = "START_PROFILER";
 declare const STOP_PROFILER = "STOP_PROFILER";
-declare const buildAliases: (actions: AsyncRPCActions) => () => (next: any) => (action: any) => any;
+interface MethodAction<T extends Methods$1.MethodTypes> {
+    payload: Methods$1.ByType<T>;
+}
+declare const buildAliases: (methods: Methods.MethodThunks) => () => (next: any) => (action: any) => any;
+
+declare function handleMessage(message: Message): void;
+
+declare type ActivePlayerState = {
+    /**
+     * state associated with player config
+     */
+    configState?: Methods$1.PlayerConfigMethod['result'] | null;
+    /**
+     * Flow related Information of the player.
+     */
+    flowInfo?: Methods$1.PlayerRuntimeInfoMethod['result'] | null;
+    /**
+     * A collection of all the events associated with the running player instance.
+     */
+    timelineEvents: Array<Events$1.TimelineEvents>;
+    /**
+     * View related information of the player.
+     */
+    view?: View | undefined;
+    /**
+     * State assocaited with the data of the player
+     */
+    dataState: DataState;
+    /**
+     * State associated with the console evaluations.
+     */
+    consoleState: ConsoleState;
+    /**
+     * profiler related information of the player
+     */
+    profilerInfo?: ProfilerNode | null;
+};
+declare type PlayersState = {
+    /**
+     * This represents the currently selected player id.
+     */
+    selectedPlayerId: string | null;
+    /**
+     * Collection of all the players active on the web page.
+     */
+    activePlayers: Record<string, ActivePlayerState>;
+    /**
+     * Web Player version
+     */
+    version: string;
+};
+declare type StoreState = {
+    /**
+     * State related to all the players on the web page.
+     */
+    players: PlayersState;
+};
+declare type FlowInfoState = {
+    /**
+     * Current Flow Id.
+     */
+    currentFlowID?: string;
+    /**
+     * Current Flow State
+     */
+    currentFlowState?: string;
+    /**
+     * Current View Id.
+     */
+    currentViewID?: string;
+    /**
+     * Current FLow
+     */
+    currentFlow?: Flow;
+};
+declare type DataState = {
+    /**
+     * The binding selected on the Data panel.
+     */
+    selectedBinding?: Methods$1.PlayerDataBindingMethod['result'];
+    /**
+     * All the bindings in the data state.
+     */
+    allBindings?: Methods$1.PlayerDataBindingMethod['result'];
+};
+interface ConsoleState {
+    /**
+     * History of all the console evaluations
+     */
+    history: Array<{
+        /**
+         * Unique Id representing a Console evaluation.
+         */
+        id: string;
+        /**
+         * Expression being evaluated.
+         */
+        expression: string;
+        /**
+         * Result of the console evaluation.
+         */
+        result: Methods$1.PlayerExpressionMethod['result'];
+    }>;
+}
 
+declare const methodsReducer: (methods: Methods.MethodThunks) => (builder: ActionReducerMapBuilder<PlayersState>) => void;
+declare const eventsReducer: (builder: ActionReducerMapBuilder<PlayersState>) => void;
+declare const actionsReducer: (builder: ActionReducerMapBuilder<PlayersState>) => void;
+declare const playersReducer: (methods: Methods.MethodThunks) => _reduxjs_toolkit_dist_createReducer.ReducerWithInitialState<PlayersState>;
+
+declare const selectPlayerVersion: ((state: {
+    players: PlayersState;
+}) => string) & reselect.OutputSelectorFields<(args_0: PlayersState) => string & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectPlayerIds: ((state: {
+    players: PlayersState;
+}) => string[]) & reselect.OutputSelectorFields<(args_0: Record<string, ActivePlayerState>) => string[] & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 /**
- * Callback function that adds cases for async actions for the player.
- * @param playerReducerCallback
- * @returns
+ * Selects the selected/currently active player Id.
  */
-declare const buildPlayerReducerCallback: (actions: AsyncRPCActions) => (builder: ActionReducerMapBuilder<PlayersState>) => void;
+declare const selectSelectedPlayerId: ((state: {
+    players: PlayersState;
+}) => string | null) & reselect.OutputSelectorFields<(args_0: PlayersState) => string & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectCurrentPlayer: ((state: {
+    players: PlayersState;
+}) => ActivePlayerState | null) & reselect.OutputSelectorFields<(args_0: Record<string, ActivePlayerState>, args_1: string | null) => ActivePlayerState & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectConfig: ((state: {
+    players: PlayersState;
+}) => {
+    plugins?: string[] | undefined;
+    schema?: any;
+    expressions?: any;
+} | null) & reselect.OutputSelectorFields<(args_0: ActivePlayerState | null) => {
+    plugins?: string[] | undefined;
+    schema?: any;
+    expressions?: any;
+} & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectFlowInfo: ((state: {
+    players: PlayersState;
+}) => {
+    currentFlowID?: string | undefined;
+    currentFlowState?: string | undefined;
+    currentViewID?: string | undefined;
+    currentFlow?: _player_ui_types.Flow<_player_ui_types.Asset<string>> | undefined;
+} | null | undefined) & reselect.OutputSelectorFields<(args_0: ActivePlayerState | null) => {
+    currentFlowID?: string | undefined;
+    currentFlowState?: string | undefined;
+    currentViewID?: string | undefined;
+    currentFlow?: _player_ui_types.Flow<_player_ui_types.Asset<string>> | undefined;
+} & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectCurrentFlow: ((state: {
+    players: PlayersState;
+}) => _player_ui_types.Flow<_player_ui_types.Asset<string>> | undefined) & reselect.OutputSelectorFields<(args_0: {
+    currentFlowID?: string | undefined;
+    currentFlowState?: string | undefined;
+    currentViewID?: string | undefined;
+    currentFlow?: _player_ui_types.Flow<_player_ui_types.Asset<string>> | undefined;
+} | null | undefined) => _player_ui_types.Flow<_player_ui_types.Asset<string>> & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectCurrentTopic: ((state: {
+    players: PlayersState;
+}) => unknown) & reselect.OutputSelectorFields<(args_0: _player_ui_types.Flow<_player_ui_types.Asset<string>> | undefined) => {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectEvents: ((state: {
+    players: PlayersState;
+}) => _player_tools_devtools_common.Events.TimelineEvents[]) & reselect.OutputSelectorFields<(args_0: ActivePlayerState | null) => _player_tools_devtools_common.Events.TimelineEvents[] & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectView: ((state: {
+    players: PlayersState;
+}) => (_player_ui_types.Asset<string> & {
+    validation?: _player_ui_types.Validation.CrossfieldReference[] | undefined;
+}) | null | undefined) & reselect.OutputSelectorFields<(args_0: ActivePlayerState | null) => _player_ui_types.Asset<string> & {
+    validation?: _player_ui_types.Validation.CrossfieldReference[] | undefined;
+} & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectAllBindings: ((state: {
+    players: PlayersState;
+}) => {
+    binding: string;
+    value: {
+        currentValue?: any;
+        formattedValue?: any;
+        modelValue?: any;
+    };
+    type?: _player_ui_types.Schema.DataType<unknown> | undefined;
+    validation?: any;
+} | undefined) & reselect.OutputSelectorFields<(args_0: DataState | undefined) => {
+    binding: string;
+    value: {
+        currentValue?: any;
+        formattedValue?: any;
+        modelValue?: any;
+    };
+    type?: _player_ui_types.Schema.DataType<unknown> | undefined;
+    validation?: any;
+} & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectSelectedBinding: ((state: {
+    players: PlayersState;
+}) => {
+    binding: string;
+    value: {
+        currentValue?: any;
+        formattedValue?: any;
+        modelValue?: any;
+    };
+    type?: _player_ui_types.Schema.DataType<unknown> | undefined;
+    validation?: any;
+} | undefined) & reselect.OutputSelectorFields<(args_0: DataState | undefined) => {
+    binding: string;
+    value: {
+        currentValue?: any;
+        formattedValue?: any;
+        modelValue?: any;
+    };
+    type?: _player_ui_types.Schema.DataType<unknown> | undefined;
+    validation?: any;
+} & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectConsole: ((state: {
+    players: PlayersState;
+}) => ConsoleState) & reselect.OutputSelectorFields<(args_0: ActivePlayerState | null) => ConsoleState & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+declare const selectProfiler: ((state: {
+    players: PlayersState;
+}) => _player_tools_devtools_common.ProfilerNode | null | undefined) & reselect.OutputSelectorFields<(args_0: ActivePlayerState | null) => _player_tools_devtools_common.ProfilerNode & {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 
-declare function handleMessage(store: Store, message: Message): void;
+/**
+ * This function returns the players store. Accepts optional middleware and callback to enhance the store.
+ * @param middleware : Middleware to be added to the store. Optional.
+ * @param additionalReducers Additional reducers to be added to the store. Optional
+ * @returns
+ */
+declare const createDevtoolsStore: (onMethodRequest: Methods.MethodHandler, middleware?: Middleware<any, StoreState, Dispatch<AnyAction>>, additionalReducers?: any) => EnhancedStore<StoreState, any, Middleware<any, StoreState, Dispatch<AnyAction>>[]>;
 
-export { AsyncRPCActions, GET_CONFIG_DETAILS, GET_CONSOLE_EVAL, GET_DATA_BINDING_DETAILS, GET_INFO_DETAILS, GET_VIEW_DETAILS, RuntimeRPCRequestHandlers, START_PROFILER, STOP_PROFILER, buildAliases, buildPlayerReducerCallback, buildRPCActions, buildRPCRequests, handleMessage };
+export { Actions, ActivePlayerState, ConsoleState, DataState, Events, FlowInfoState, GET_CONFIG_DETAILS, GET_CONSOLE_EVAL, GET_DATA_BINDING_DETAILS, GET_INFO_DETAILS, GET_VIEW_DETAILS, MethodAction, Methods, PlayersState, START_PROFILER, STOP_PROFILER, StoreState, actionsReducer, buildAliases, createDevtoolsStore, eventsReducer, handleMessage, methodsReducer, playersReducer, selectAllBindings, selectConfig, selectConsole, selectCurrentFlow, selectCurrentPlayer, selectCurrentTopic, selectEvents, selectFlowInfo, selectPlayerIds, selectPlayerVersion, selectProfiler, selectSelectedBinding, selectSelectedPlayerId, selectView };