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

package/src/redux/state.ts

@@ -0,0 +1,105 @@
+import { Flow, View } from '@player-ui/types';
+import { Methods, Events, ProfilerNode } from '@player-tools/devtools-common';
+
+export type ActivePlayerState = {
+  /**
+   * state associated with player config
+   */
+  configState?: Methods.PlayerConfigMethod['result'] | null;
+  /**
+   * Flow related Information of the player.
+   */
+  flowInfo?: Methods.PlayerRuntimeInfoMethod['result'] | null;
+  /**
+   * A collection of all the events associated with the running player instance.
+   */
+  timelineEvents: Array<Events.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;
+};
+
+export 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;
+};
+
+export type StoreState = {
+  /**
+   * State related to all the players on the web page.
+   */
+  players: PlayersState;
+};
+
+export type FlowInfoState = {
+  /**
+   * Current Flow Id.
+   */
+  currentFlowID?: string;
+  /**
+   * Current Flow State
+   */
+  currentFlowState?: string;
+  /**
+   * Current View Id.
+   */
+  currentViewID?: string;
+  /**
+   * Current FLow
+   */
+  currentFlow?: Flow;
+};
+
+export type DataState = {
+  /**
+   * The binding selected on the Data panel.
+   */
+  selectedBinding?: Methods.PlayerDataBindingMethod['result'];
+  /**
+   * All the bindings in the data state.
+   */
+  allBindings?: Methods.PlayerDataBindingMethod['result'];
+};
+
+export 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.PlayerExpressionMethod['result'];
+  }>;
+}

package/src/redux/store.ts

@@ -0,0 +1,49 @@
+import {
+  type AnyAction,
+  type Dispatch,
+  type Middleware,
+  type MiddlewareArray,
+  type ActionReducerMapBuilder,
+  type EnhancedStore,
+  configureStore,
+  createReducer,
+  combineReducers,
+  createAsyncThunk,
+} from '@reduxjs/toolkit';
+import { Message } from '@player-tools/devtools-common';
+import { PlayersState, StoreState } from './state';
+import { Methods } from './actions';
+import { playersReducer } from './reducers';
+import { listenerMiddleware } from './middleware';
+
+/**
+ * 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
+ */
+export const createDevtoolsStore = (
+  onMethodRequest: Methods.MethodHandler,
+  middleware?: Middleware<any, StoreState, Dispatch<AnyAction>>,
+  additionalReducers?: any,
+): EnhancedStore<
+  StoreState,
+  any,
+  Middleware<any, StoreState, Dispatch<AnyAction>>[]
+> =>
+  configureStore({
+    reducer: {
+      // TODO: Look into slices
+      players: playersReducer(Methods.buildAsyncThunks(onMethodRequest)),
+      ...additionalReducers,
+    },
+    middleware: (getDefaultMiddleware) => {
+      // TODO: Potentially hook up our own middleware for dispatching additional actions from event actions
+      const m = getDefaultMiddleware()
+        .concat(listenerMiddleware.middleware)
+
+      if (middleware) m.prepend(middleware)
+
+      return m
+    }
+  });

package/src/rpc/index.ts

@@ -1,21 +0,0 @@
-import {
-  type RPCRequestMessageEvent,
-  type RPCRequestHandler,
-  createRPCRequest,
-  Runtime,
-  PANEL_SOURCE,
-} from '@player-tools/devtools-common';
-
-export type RuntimeRPCRequestHandlers = {
-  [key in Runtime.RuntimeRPCTypes]: RPCRequestHandler<any>;
-};
-
-export const buildRPCRequests = (
-  onRequestMessage: (
-    message: RPCRequestMessageEvent<Runtime.RuntimeRPC>
-  ) => void
-): RuntimeRPCRequestHandlers =>
-  Runtime.RuntimeRPCTypes.reduce((acc, rpcType) => {
-    acc[rpcType] = createRPCRequest(rpcType, PANEL_SOURCE, onRequestMessage);
-    return acc;
-  }, {} as RuntimeRPCRequestHandlers);