@player-devtools/client 0.0.2-next.0

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/src/panel/index.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/src/constants/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/src/plugins/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/src/state/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/src/state/reducer.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/src/helpers/flowDiff.ts"],"sourcesContent":["import React, { useRef } from \"react\";\nimport type {\n  MessengerOptions,\n  ExtensionSupportedEvents,\n} from \"@player-devtools/types\";\nimport { DataController, Flow, useReactPlayer } from \"@player-ui/react\";\nimport { useEffect } from \"react\";\nimport { ErrorBoundary } from \"react-error-boundary\";\nimport {\n  Card,\n  CardBody,\n  CardHeader,\n  ChakraProvider,\n  Container,\n  extendTheme,\n  Flex,\n  FormControl,\n  FormLabel,\n  Heading,\n  Select,\n  Text,\n  type ThemeConfig,\n} from \"@chakra-ui/react\";\n\nimport { ThemeProvider, useDarkMode } from \"@devtools-ds/themes\";\n\nimport { INITIAL_FLOW } from \"../constants\";\nimport { PLAYER_PLUGINS, PUBSUB_PLUGIN } from \"../plugins\";\nimport { useExtensionState } from \"../state\";\nimport { flowDiff } from \"../helpers/flowDiff\";\n\nconst fallbackRender: ErrorBoundary[\"props\"][\"fallbackRender\"] = ({\n  error,\n}) => {\n  return (\n    <Container centerContent>\n      <Card>\n        <CardHeader>\n          <Heading>Ops, something went wrong.</Heading>\n        </CardHeader>\n        <CardBody>\n          <Text as=\"pre\">{error.message}</Text>\n        </CardBody>\n      </Card>\n    </Container>\n  );\n};\n\n/**\n * Panel Component\n *\n * This component serves as the main container for the devtools plugin content defined by plugin authors using Player-UI DSL.\n *\n * Props:\n * - `communicationLayer`: An object that allows communication between the devtools and the Player-UI plugins,\n *   enabling the exchange of data and events.\n *\n * Features:\n * - Error Handling: Utilizes the `ErrorBoundary` component from `react-error-boundary` to gracefully handle and display errors\n *   that may occur during the rendering of the plugin's content.\n * - State Management: Integrates with custom hooks such as `useExtensionState` to manage the state of the plugin and its components.\n * - Player Integration: Uses the `useReactPlayer` hook from `player-ui/react` to render interactive player components based on the\n *   DSL defined by the plugin authors.\n *\n * Example Usage:\n * ```tsx\n * <Panel communicationLayer={myCommunicationLayer} />\n * ```\n *\n * Note: The `communicationLayer` prop is essential for the proper functioning of the `Panel` component, as it enables the necessary\n * communication and data exchange with the player-ui/react library.\n */\nexport const Panel: React.FC<{\n  /** the communication layer to use for the extension */\n  readonly communicationLayer: Pick<\n    MessengerOptions<ExtensionSupportedEvents>,\n    \"sendMessage\" | \"addListener\" | \"removeListener\"\n  >;\n  baseTheme?: Record<string, unknown>;\n}> = ({ communicationLayer, baseTheme }) => {\n  const { state, selectPlayer, selectPlugin, handleInteraction } =\n    useExtensionState({\n      communicationLayer,\n    });\n\n  const { reactPlayer, playerState } = useReactPlayer({\n    plugins: PLAYER_PLUGINS,\n  });\n\n  const dataController = useRef<WeakRef<DataController> | null>(null);\n\n  const currentFlow = useRef<Flow | null>(null);\n\n  useEffect(() => {\n    reactPlayer.player.hooks.dataController.tap(\"devtools-panel\", (d) => {\n      dataController.current = new WeakRef(d);\n    });\n  }, [reactPlayer]);\n\n  useEffect(() => {\n    // we subscribe to all messages from the devtools plugin\n    // so the plugin author can define their own events\n    PUBSUB_PLUGIN.subscribe(\"*\", (type: string, payload: string) => {\n      handleInteraction({\n        type,\n        payload,\n      });\n    });\n  }, []);\n\n  useEffect(() => {\n    const { player, plugin } = state.current;\n\n    const flow =\n      player && plugin\n        ? state.players[player]?.plugins?.[plugin]?.flow || INITIAL_FLOW\n        : INITIAL_FLOW;\n\n    if (!currentFlow.current) {\n      currentFlow.current = flow;\n      reactPlayer.start(flow);\n      return;\n    }\n\n    const diff = flowDiff({\n      curr: currentFlow.current as Flow,\n      next: flow,\n    });\n\n    if (diff) {\n      const { change, value } = diff;\n\n      if (change === \"flow\") {\n        currentFlow.current = value;\n        reactPlayer.start(value);\n      } else if (change === \"data\") {\n        if (dataController.current) {\n          dataController.current.deref()?.set(value as Record<string, unknown>);\n        } else {\n          reactPlayer.start(flow);\n        }\n      }\n    }\n  }, [reactPlayer, state]);\n\n  const isDarkMode = useDarkMode();\n  const colorMode = isDarkMode ? \"dark\" : \"light\";\n\n  const config: ThemeConfig = {\n    initialColorMode: colorMode,\n    useSystemColorMode: true,\n  };\n  const theme = extendTheme({ config, ...baseTheme });\n\n  const Component = reactPlayer.Component as React.FC;\n\n  return (\n    <ChakraProvider resetCSS={false} theme={theme}>\n      <ThemeProvider theme=\"chrome\" colorScheme={colorMode}>\n        <ErrorBoundary fallbackRender={fallbackRender}>\n          <Flex\n            direction=\"column\"\n            h=\"100vh\"\n            alignItems={\"normal\"}\n            overflow=\"scroll\"\n          >\n            {state.current.player ? (\n              <Flex direction=\"column\" gap=\"20px\">\n                <Flex gap=\"16px\">\n                  <FormControl>\n                    <FormLabel>Player</FormLabel>\n                    <Select\n                      id=\"player\"\n                      value={state.current.player || \"\"}\n                      onChange={(event) => selectPlayer(event.target.value)}\n                    >\n                      {Object.keys(state.players).map((playerID) => (\n                        <option key={playerID} value={playerID}>\n                          {playerID}\n                        </option>\n                      ))}\n                    </Select>\n                  </FormControl>\n                  <FormControl>\n                    <FormLabel>Plugin</FormLabel>\n                    <Select\n                      id=\"plugin\"\n                      value={state.current.plugin || \"\"}\n                      onChange={(event) => selectPlugin(event.target.value)}\n                    >\n                      {Object.keys(\n                        state.players[state.current.player]?.plugins ?? [],\n                      ).map((pluginID) => (\n                        <option key={pluginID} value={pluginID}>\n                          {pluginID}\n                        </option>\n                      ))}\n                    </Select>\n                  </FormControl>\n                </Flex>\n                <Flex width=\"100%\">\n                  {playerState.status === \"error\" ? (\n                    fallbackRender({\n                      error: playerState.error,\n                      resetErrorBoundary: () => {},\n                    })\n                  ) : (\n                    <Component />\n                  )}\n                </Flex>\n                <details>\n                  <summary>Debug</summary>\n                  <pre style={{ maxHeight: \"30vh\", overflow: \"scroll\" }}>\n                    {JSON.stringify(state, null, 2)}\n                  </pre>\n                </details>\n              </Flex>\n            ) : (\n              <Flex justifyContent=\"center\" padding=\"6\">\n                <Text>\n                  No Player-UI instance or devtools plugin detected. Visit{\" \"}\n                  <a href=\"https://player-ui.github.io/\">\n                    https://player-ui.github.io/\n                  </a>{\" \"}\n                  for more info.\n                </Text>\n              </Flex>\n            )}\n          </Flex>\n        </ErrorBoundary>\n      </ThemeProvider>\n    </ChakraProvider>\n  );\n};\n","import type { ExtensionState } from \"@player-devtools/types\";\nimport type { Flow } from \"@player-ui/player\";\n\nexport const INITIAL_FLOW: Flow = {\n  id: \"initial-flow\",\n  views: [\n    {\n      id: \"view-1\",\n      type: \"text\",\n      value: \"connecting...\",\n    },\n  ],\n  navigation: {\n    BEGIN: \"FLOW_1\",\n    FLOW_1: {\n      startState: \"VIEW_1\",\n      VIEW_1: {\n        state_type: \"VIEW\",\n        ref: \"view-1\",\n        transitions: {},\n      },\n    },\n  },\n};\n\nexport const INITIAL_EXTENSION_STATE: ExtensionState = {\n  current: {\n    player: null,\n    plugin: null,\n  },\n  players: {},\n};\n","import DevtoolsUIAssetsPlugin from \"@devtools-ui/plugin\";\nimport { PubSubPlugin } from \"@player-ui/pubsub-plugin\";\nimport { CommonExpressionsPlugin } from \"@player-ui/common-expressions-plugin\";\nimport { CommonTypesPlugin } from \"@player-ui/common-types-plugin\";\nimport { DataChangeListenerPlugin } from \"@player-ui/data-change-listener-plugin\";\nimport {\n  ConsoleLogger,\n  Player,\n  PlayerPlugin,\n  ReactPlayer,\n  type ReactPlayerPlugin,\n} from \"@player-ui/react\";\n\nclass LogForwarder implements PlayerPlugin, ReactPlayerPlugin {\n  name = \"Log\";\n  apply(player: Player) {\n    player.logger.addHandler(new ConsoleLogger(\"trace\", console));\n  }\n\n  applyReact(reactPlayer: ReactPlayer) {\n    this.apply(reactPlayer.player);\n  }\n}\n\nexport const PUBSUB_PLUGIN = new PubSubPlugin();\n\nexport const PLAYER_PLUGINS: ReactPlayerPlugin[] = [\n  new CommonTypesPlugin(),\n  new CommonExpressionsPlugin(),\n  new DataChangeListenerPlugin(),\n  new DevtoolsUIAssetsPlugin(),\n  new LogForwarder(),\n  PUBSUB_PLUGIN,\n];\n","import { Messenger } from \"@player-devtools/messenger\";\nimport type {\n  ExtensionSupportedEvents,\n  MessengerOptions,\n} from \"@player-devtools/types\";\nimport { useCallback, useEffect, useMemo, useReducer } from \"react\";\n\nimport { INITIAL_EXTENSION_STATE } from \"../constants\";\nimport { reducer } from \"./reducer\";\n\nconst NOOP_ID = -1;\n\n/**\n * Custom React hook for managing the state of the devtools extension.\n *\n * This hook initializes the extension's state and sets up a communication layer\n * using the `Messenger` class. It provides methods to select a player or plugin,\n * and handle interactions, which dispatch actions to update the state accordingly.\n *\n */\nexport const useExtensionState = ({\n  communicationLayer,\n}: {\n  /** the communication layer to use for the extension */\n  communicationLayer: Pick<\n    MessengerOptions<ExtensionSupportedEvents>,\n    \"sendMessage\" | \"addListener\" | \"removeListener\"\n  >;\n}) => {\n  const [state, dispatch] = useReducer(reducer, INITIAL_EXTENSION_STATE);\n\n  const messengerOptions = useMemo<MessengerOptions<ExtensionSupportedEvents>>(\n    () => ({\n      context: \"devtools\",\n      target: \"player\",\n      messageCallback: (message) => {\n        dispatch(message);\n      },\n      ...communicationLayer,\n      logger: console,\n    }),\n    [dispatch, communicationLayer],\n  );\n\n  const messenger = useMemo(\n    () => new Messenger(messengerOptions),\n    [messengerOptions],\n  );\n\n  useEffect(() => {\n    return () => {\n      messenger.destroy();\n    };\n  }, []);\n\n  const selectPlayer = useCallback(\n    (playerID: string) => {\n      dispatch({\n        id: NOOP_ID,\n        sender: \"internal\",\n        context: \"devtools\",\n        _messenger_: false,\n        timestamp: Date.now(),\n        type: \"PLAYER_DEVTOOLS_PLAYER_SELECTED\",\n        payload: {\n          playerID,\n        },\n      });\n\n      messenger.sendMessage({\n        type: \"PLAYER_DEVTOOLS_PLUGIN_INTERACTION\",\n        payload: {\n          type: \"player-selected\",\n          payload: playerID,\n        },\n      });\n    },\n    [dispatch],\n  );\n\n  const selectPlugin = useCallback(\n    (pluginID: string) => {\n      dispatch({\n        id: NOOP_ID,\n        sender: \"internal\",\n        context: \"devtools\",\n        _messenger_: false,\n        timestamp: Date.now(),\n        type: \"PLAYER_DEVTOOLS_PLUGIN_SELECTED\",\n        payload: {\n          pluginID,\n        },\n      });\n    },\n    [dispatch],\n  );\n\n  /**\n   * Plugin authors can add interactive elements to the Player-UI content by leveraging\n   * the pub-sub plugin and having the handle interaction proxy the message to the inspected\n   * Player-UI instance.\n   */\n  const handleInteraction = useCallback(\n    ({\n      type,\n      payload,\n    }: {\n      /** interaction type */\n      type: string;\n      /** interaction payload */\n      payload?: string;\n    }) => {\n      messenger.sendMessage({\n        type: \"PLAYER_DEVTOOLS_PLUGIN_INTERACTION\",\n        payload: {\n          type,\n          payload,\n        },\n        ...(state.current.player ? { target: state.current.player } : {}),\n      });\n    },\n    [messenger],\n  );\n\n  return { state, selectPlayer, selectPlugin, handleInteraction };\n};\n","import type {\n  ExtensionState,\n  ExtensionSupportedEvents,\n  Transaction,\n} from \"@player-devtools/types\";\nimport { dsetAssign } from \"@player-devtools/utils\";\nimport { produce } from \"immer\";\n\n/** Extension state reducer */\nexport const reducer = (\n  state: ExtensionState,\n  transaction: Transaction<ExtensionSupportedEvents>,\n): ExtensionState => {\n  switch (transaction.type) {\n    case \"PLAYER_DEVTOOLS_PLAYER_INIT\":\n      return produce(state, (draft) => {\n        const {\n          sender,\n          payload: { plugins },\n        } = transaction;\n\n        const [plugin] = Object.values(plugins);\n        if (!plugin) return;\n\n        draft.current.player = sender;\n        draft.current.plugin = draft.current.plugin || plugin.id;\n\n        // TODO: Verify this works with multiple plugins\n        dsetAssign(draft, [\"players\", sender, \"plugins\"], plugins, true);\n        dsetAssign(draft.players, [sender, \"active\"], true);\n      });\n    case \"PLAYER_DEVTOOLS_PLUGIN_FLOW_CHANGE\":\n      return produce(state, (draft) => {\n        const {\n          sender,\n          payload: { flow, pluginID },\n        } = transaction;\n\n        dsetAssign(\n          draft,\n          [\"players\", sender, \"plugins\", pluginID, \"flow\"],\n          flow,\n        );\n      });\n    case \"PLAYER_DEVTOOLS_PLUGIN_DATA_CHANGE\":\n      return produce(state, (draft) => {\n        const {\n          sender,\n          payload: { data, pluginID },\n        } = transaction;\n        dsetAssign(\n          draft,\n          [\"players\", sender, \"plugins\", pluginID, \"flow\", \"data\"],\n          data,\n        );\n      });\n    case \"MESSENGER_EVENT_BATCH\":\n      return transaction.payload.events.reduce(reducer, state);\n    case \"PLAYER_DEVTOOLS_PLAYER_STOPPED\":\n      return produce(state, (draft) => {\n        const { sender } = transaction;\n        dsetAssign(draft, [\"players\", sender, \"active\"], false);\n      });\n    case \"PLAYER_DEVTOOLS_PLAYER_SELECTED\":\n      return produce(state, (draft) => {\n        const { playerID } = transaction.payload;\n        draft.current.player = playerID;\n      });\n    case \"PLAYER_DEVTOOLS_PLUGIN_SELECTED\":\n      return produce(state, (draft) => {\n        const { pluginID } = transaction.payload;\n        draft.current.plugin = pluginID;\n      });\n    default:\n      return state;\n  }\n};\n","import type { Flow } from \"@player-ui/react\";\nimport { dequal } from \"dequal\";\n\n/**\n * Compares two Flow objects and identifies if there's a change in their structure or data.\n *\n * This function takes two Flow objects as input, `curr` (current) and `next` (next), and compares them\n * to determine if there's a change in the flow's structure or its data. If there's a change in the flow's\n * structure (excluding the `data` property), it returns an object indicating a \"flow\" change along with the\n * new flow. If there's a change in the `data` property, it returns an object indicating a \"data\" change along\n * with the new data. If there are no changes, it returns null.\n */\nexport const flowDiff = ({\n  curr,\n  next,\n}: {\n  curr: Flow;\n  next: Flow;\n}):\n  | { change: \"data\"; value: Flow[\"data\"] }\n  | { change: \"flow\"; value: Flow }\n  | null => {\n  // compare flows except for the `data` property\n  const currCopy = { ...curr, data: null };\n  const nextCopy = { ...next, data: null };\n\n  const baseFlowIsEqual = dequal(currCopy, nextCopy);\n\n  if (!baseFlowIsEqual) {\n    return { change: \"flow\", value: next };\n  }\n\n  // compare data\n  const currData = curr.data;\n  const nextData = next.data;\n\n  const dataIsEqual = dequal(currData, nextData);\n\n  if (!dataIsEqual) {\n    return { change: \"data\", value: nextData };\n  }\n\n  return null;\n};\n"],"mappings":";AAAA,OAAO,SAAS,cAAc;AAK9B,SAA+B,sBAAsB;AACrD,SAAS,aAAAA,kBAAiB;AAC1B,SAAS,qBAAqB;AAC9B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAEP,SAAS,eAAe,mBAAmB;;;ACrBpC,IAAM,eAAqB;AAAA,EAChC,IAAI;AAAA,EACJ,OAAO;AAAA,IACL;AAAA,MACE,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,OAAO;AAAA,IACT;AAAA,EACF;AAAA,EACA,YAAY;AAAA,IACV,OAAO;AAAA,IACP,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,QAAQ;AAAA,QACN,YAAY;AAAA,QACZ,KAAK;AAAA,QACL,aAAa,CAAC;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,0BAA0C;AAAA,EACrD,SAAS;AAAA,IACP,QAAQ;AAAA,IACR,QAAQ;AAAA,EACV;AAAA,EACA,SAAS,CAAC;AACZ;;;AC/BA,OAAO,4BAA4B;AACnC,SAAS,oBAAoB;AAC7B,SAAS,+BAA+B;AACxC,SAAS,yBAAyB;AAClC,SAAS,gCAAgC;AACzC;AAAA,EACE;AAAA,OAKK;AAEP,IAAM,eAAN,MAA8D;AAAA,EAA9D;AACE,gBAAO;AAAA;AAAA,EACP,MAAM,QAAgB;AACpB,WAAO,OAAO,WAAW,IAAI,cAAc,SAAS,OAAO,CAAC;AAAA,EAC9D;AAAA,EAEA,WAAW,aAA0B;AACnC,SAAK,MAAM,YAAY,MAAM;AAAA,EAC/B;AACF;AAEO,IAAM,gBAAgB,IAAI,aAAa;AAEvC,IAAM,iBAAsC;AAAA,EACjD,IAAI,kBAAkB;AAAA,EACtB,IAAI,wBAAwB;AAAA,EAC5B,IAAI,yBAAyB;AAAA,EAC7B,IAAI,uBAAuB;AAAA,EAC3B,IAAI,aAAa;AAAA,EACjB;AACF;;;ACjCA,SAAS,iBAAiB;AAK1B,SAAS,aAAa,WAAW,SAAS,kBAAkB;;;ACA5D,SAAS,kBAAkB;AAC3B,SAAS,eAAe;AAGjB,IAAM,UAAU,CACrB,OACA,gBACmB;AACnB,UAAQ,YAAY,MAAM;AAAA,IACxB,KAAK;AACH,aAAO,QAAQ,OAAO,CAAC,UAAU;AAC/B,cAAM;AAAA,UACJ;AAAA,UACA,SAAS,EAAE,QAAQ;AAAA,QACrB,IAAI;AAEJ,cAAM,CAAC,MAAM,IAAI,OAAO,OAAO,OAAO;AACtC,YAAI,CAAC,OAAQ;AAEb,cAAM,QAAQ,SAAS;AACvB,cAAM,QAAQ,SAAS,MAAM,QAAQ,UAAU,OAAO;AAGtD,mBAAW,OAAO,CAAC,WAAW,QAAQ,SAAS,GAAG,SAAS,IAAI;AAC/D,mBAAW,MAAM,SAAS,CAAC,QAAQ,QAAQ,GAAG,IAAI;AAAA,MACpD,CAAC;AAAA,IACH,KAAK;AACH,aAAO,QAAQ,OAAO,CAAC,UAAU;AAC/B,cAAM;AAAA,UACJ;AAAA,UACA,SAAS,EAAE,MAAM,SAAS;AAAA,QAC5B,IAAI;AAEJ;AAAA,UACE;AAAA,UACA,CAAC,WAAW,QAAQ,WAAW,UAAU,MAAM;AAAA,UAC/C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,KAAK;AACH,aAAO,QAAQ,OAAO,CAAC,UAAU;AAC/B,cAAM;AAAA,UACJ;AAAA,UACA,SAAS,EAAE,MAAM,SAAS;AAAA,QAC5B,IAAI;AACJ;AAAA,UACE;AAAA,UACA,CAAC,WAAW,QAAQ,WAAW,UAAU,QAAQ,MAAM;AAAA,UACvD;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,KAAK;AACH,aAAO,YAAY,QAAQ,OAAO,OAAO,SAAS,KAAK;AAAA,IACzD,KAAK;AACH,aAAO,QAAQ,OAAO,CAAC,UAAU;AAC/B,cAAM,EAAE,OAAO,IAAI;AACnB,mBAAW,OAAO,CAAC,WAAW,QAAQ,QAAQ,GAAG,KAAK;AAAA,MACxD,CAAC;AAAA,IACH,KAAK;AACH,aAAO,QAAQ,OAAO,CAAC,UAAU;AAC/B,cAAM,EAAE,SAAS,IAAI,YAAY;AACjC,cAAM,QAAQ,SAAS;AAAA,MACzB,CAAC;AAAA,IACH,KAAK;AACH,aAAO,QAAQ,OAAO,CAAC,UAAU;AAC/B,cAAM,EAAE,SAAS,IAAI,YAAY;AACjC,cAAM,QAAQ,SAAS;AAAA,MACzB,CAAC;AAAA,IACH;AACE,aAAO;AAAA,EACX;AACF;;;ADlEA,IAAM,UAAU;AAUT,IAAM,oBAAoB,CAAC;AAAA,EAChC;AACF,MAMM;AACJ,QAAM,CAAC,OAAO,QAAQ,IAAI,WAAW,SAAS,uBAAuB;AAErE,QAAM,mBAAmB;AAAA,IACvB,OAAO;AAAA,MACL,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,iBAAiB,CAAC,YAAY;AAC5B,iBAAS,OAAO;AAAA,MAClB;AAAA,MACA,GAAG;AAAA,MACH,QAAQ;AAAA,IACV;AAAA,IACA,CAAC,UAAU,kBAAkB;AAAA,EAC/B;AAEA,QAAM,YAAY;AAAA,IAChB,MAAM,IAAI,UAAU,gBAAgB;AAAA,IACpC,CAAC,gBAAgB;AAAA,EACnB;AAEA,YAAU,MAAM;AACd,WAAO,MAAM;AACX,gBAAU,QAAQ;AAAA,IACpB;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,eAAe;AAAA,IACnB,CAAC,aAAqB;AACpB,eAAS;AAAA,QACP,IAAI;AAAA,QACJ,QAAQ;AAAA,QACR,SAAS;AAAA,QACT,aAAa;AAAA,QACb,WAAW,KAAK,IAAI;AAAA,QACpB,MAAM;AAAA,QACN,SAAS;AAAA,UACP;AAAA,QACF;AAAA,MACF,CAAC;AAED,gBAAU,YAAY;AAAA,QACpB,MAAM;AAAA,QACN,SAAS;AAAA,UACP,MAAM;AAAA,UACN,SAAS;AAAA,QACX;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,CAAC,QAAQ;AAAA,EACX;AAEA,QAAM,eAAe;AAAA,IACnB,CAAC,aAAqB;AACpB,eAAS;AAAA,QACP,IAAI;AAAA,QACJ,QAAQ;AAAA,QACR,SAAS;AAAA,QACT,aAAa;AAAA,QACb,WAAW,KAAK,IAAI;AAAA,QACpB,MAAM;AAAA,QACN,SAAS;AAAA,UACP;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,CAAC,QAAQ;AAAA,EACX;AAOA,QAAM,oBAAoB;AAAA,IACxB,CAAC;AAAA,MACC;AAAA,MACA;AAAA,IACF,MAKM;AACJ,gBAAU,YAAY;AAAA,QACpB,MAAM;AAAA,QACN,SAAS;AAAA,UACP;AAAA,UACA;AAAA,QACF;AAAA,QACA,GAAI,MAAM,QAAQ,SAAS,EAAE,QAAQ,MAAM,QAAQ,OAAO,IAAI,CAAC;AAAA,MACjE,CAAC;AAAA,IACH;AAAA,IACA,CAAC,SAAS;AAAA,EACZ;AAEA,SAAO,EAAE,OAAO,cAAc,cAAc,kBAAkB;AAChE;;;AE5HA,SAAS,cAAc;AAWhB,IAAM,WAAW,CAAC;AAAA,EACvB;AAAA,EACA;AACF,MAMY;AAEV,QAAM,WAAW,EAAE,GAAG,MAAM,MAAM,KAAK;AACvC,QAAM,WAAW,EAAE,GAAG,MAAM,MAAM,KAAK;AAEvC,QAAM,kBAAkB,OAAO,UAAU,QAAQ;AAEjD,MAAI,CAAC,iBAAiB;AACpB,WAAO,EAAE,QAAQ,QAAQ,OAAO,KAAK;AAAA,EACvC;AAGA,QAAM,WAAW,KAAK;AACtB,QAAM,WAAW,KAAK;AAEtB,QAAM,cAAc,OAAO,UAAU,QAAQ;AAE7C,MAAI,CAAC,aAAa;AAChB,WAAO,EAAE,QAAQ,QAAQ,OAAO,SAAS;AAAA,EAC3C;AAEA,SAAO;AACT;;;ALZA,IAAM,iBAA2D,CAAC;AAAA,EAChE;AACF,MAAM;AACJ,SACE,oCAAC,aAAU,eAAa,QACtB,oCAAC,YACC,oCAAC,kBACC,oCAAC,eAAQ,4BAA0B,CACrC,GACA,oCAAC,gBACC,oCAAC,QAAK,IAAG,SAAO,MAAM,OAAQ,CAChC,CACF,CACF;AAEJ;AA0BO,IAAM,QAOR,CAAC,EAAE,oBAAoB,UAAU,MAAM;AAC1C,QAAM,EAAE,OAAO,cAAc,cAAc,kBAAkB,IAC3D,kBAAkB;AAAA,IAChB;AAAA,EACF,CAAC;AAEH,QAAM,EAAE,aAAa,YAAY,IAAI,eAAe;AAAA,IAClD,SAAS;AAAA,EACX,CAAC;AAED,QAAM,iBAAiB,OAAuC,IAAI;AAElE,QAAM,cAAc,OAAoB,IAAI;AAE5C,EAAAC,WAAU,MAAM;AACd,gBAAY,OAAO,MAAM,eAAe,IAAI,kBAAkB,CAAC,MAAM;AACnE,qBAAe,UAAU,IAAI,QAAQ,CAAC;AAAA,IACxC,CAAC;AAAA,EACH,GAAG,CAAC,WAAW,CAAC;AAEhB,EAAAA,WAAU,MAAM;AAGd,kBAAc,UAAU,KAAK,CAAC,MAAc,YAAoB;AAC9D,wBAAkB;AAAA,QAChB;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH,GAAG,CAAC,CAAC;AAEL,EAAAA,WAAU,MAAM;AACd,UAAM,EAAE,QAAQ,OAAO,IAAI,MAAM;AAEjC,UAAM,OACJ,UAAU,SACN,MAAM,QAAQ,MAAM,GAAG,UAAU,MAAM,GAAG,QAAQ,eAClD;AAEN,QAAI,CAAC,YAAY,SAAS;AACxB,kBAAY,UAAU;AACtB,kBAAY,MAAM,IAAI;AACtB;AAAA,IACF;AAEA,UAAM,OAAO,SAAS;AAAA,MACpB,MAAM,YAAY;AAAA,MAClB,MAAM;AAAA,IACR,CAAC;AAED,QAAI,MAAM;AACR,YAAM,EAAE,QAAQ,MAAM,IAAI;AAE1B,UAAI,WAAW,QAAQ;AACrB,oBAAY,UAAU;AACtB,oBAAY,MAAM,KAAK;AAAA,MACzB,WAAW,WAAW,QAAQ;AAC5B,YAAI,eAAe,SAAS;AAC1B,yBAAe,QAAQ,MAAM,GAAG,IAAI,KAAgC;AAAA,QACtE,OAAO;AACL,sBAAY,MAAM,IAAI;AAAA,QACxB;AAAA,MACF;AAAA,IACF;AAAA,EACF,GAAG,CAAC,aAAa,KAAK,CAAC;AAEvB,QAAM,aAAa,YAAY;AAC/B,QAAM,YAAY,aAAa,SAAS;AAExC,QAAM,SAAsB;AAAA,IAC1B,kBAAkB;AAAA,IAClB,oBAAoB;AAAA,EACtB;AACA,QAAM,QAAQ,YAAY,EAAE,QAAQ,GAAG,UAAU,CAAC;AAElD,QAAM,YAAY,YAAY;AAE9B,SACE,oCAAC,kBAAe,UAAU,OAAO,SAC/B,oCAAC,iBAAc,OAAM,UAAS,aAAa,aACzC,oCAAC,iBAAc,kBACb;AAAA,IAAC;AAAA;AAAA,MACC,WAAU;AAAA,MACV,GAAE;AAAA,MACF,YAAY;AAAA,MACZ,UAAS;AAAA;AAAA,IAER,MAAM,QAAQ,SACb,oCAAC,QAAK,WAAU,UAAS,KAAI,UAC3B,oCAAC,QAAK,KAAI,UACR,oCAAC,mBACC,oCAAC,iBAAU,QAAM,GACjB;AAAA,MAAC;AAAA;AAAA,QACC,IAAG;AAAA,QACH,OAAO,MAAM,QAAQ,UAAU;AAAA,QAC/B,UAAU,CAAC,UAAU,aAAa,MAAM,OAAO,KAAK;AAAA;AAAA,MAEnD,OAAO,KAAK,MAAM,OAAO,EAAE,IAAI,CAAC,aAC/B,oCAAC,YAAO,KAAK,UAAU,OAAO,YAC3B,QACH,CACD;AAAA,IACH,CACF,GACA,oCAAC,mBACC,oCAAC,iBAAU,QAAM,GACjB;AAAA,MAAC;AAAA;AAAA,QACC,IAAG;AAAA,QACH,OAAO,MAAM,QAAQ,UAAU;AAAA,QAC/B,UAAU,CAAC,UAAU,aAAa,MAAM,OAAO,KAAK;AAAA;AAAA,MAEnD,OAAO;AAAA,QACN,MAAM,QAAQ,MAAM,QAAQ,MAAM,GAAG,WAAW,CAAC;AAAA,MACnD,EAAE,IAAI,CAAC,aACL,oCAAC,YAAO,KAAK,UAAU,OAAO,YAC3B,QACH,CACD;AAAA,IACH,CACF,CACF,GACA,oCAAC,QAAK,OAAM,UACT,YAAY,WAAW,UACtB,eAAe;AAAA,MACb,OAAO,YAAY;AAAA,MACnB,oBAAoB,MAAM;AAAA,MAAC;AAAA,IAC7B,CAAC,IAED,oCAAC,eAAU,CAEf,GACA,oCAAC,iBACC,oCAAC,iBAAQ,OAAK,GACd,oCAAC,SAAI,OAAO,EAAE,WAAW,QAAQ,UAAU,SAAS,KACjD,KAAK,UAAU,OAAO,MAAM,CAAC,CAChC,CACF,CACF,IAEA,oCAAC,QAAK,gBAAe,UAAS,SAAQ,OACpC,oCAAC,YAAK,4DACqD,KACzD,oCAAC,OAAE,MAAK,kCAA+B,8BAEvC,GAAK,KAAI,gBAEX,CACF;AAAA,EAEJ,CACF,CACF,CACF;AAEJ;","names":["useEffect","useEffect"]}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ],
+  "name": "@player-devtools/client",
+  "version": "0.0.2-next.0",
+  "main": "dist/cjs/index.cjs",
+  "dependencies": {
+    "@player-devtools/messenger": "0.0.2-next.0",
+    "@player-devtools/types": "0.0.2-next.0",
+    "@player-devtools/utils": "0.0.2-next.0",
+    "@chakra-ui/react": "2.8.2",
+    "@player-ui/pubsub-plugin": "0.12.0-next.1",
+    "@player-ui/player": "0.12.0-next.1",
+    "@player-ui/react": "0.12.0-next.1",
+    "@player-ui/common-expressions-plugin": "0.12.0-next.1",
+    "@player-ui/common-types-plugin": "0.12.0-next.1",
+    "@player-ui/data-change-listener-plugin": "0.12.0-next.1",
+    "@devtools-ui/plugin": "0.4.0",
+    "@types/react": "^18.2.51",
+    "immer": "^10.0.3",
+    "react": "^18.2.0",
+    "react-error-boundary": "^4.0.12",
+    "dequal": "^2.0.2",
+    "@devtools-ds/themes": "^1.2.1",
+    "tslib": "^2.6.2"
+  },
+  "module": "dist/index.legacy-esm.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    "./dist/index.css": "./dist/index.css",
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/cjs/index.cjs"
+    }
+  },
+  "peerDependencies": {}
+}

package/src/constants/index.ts

@@ -0,0 +1,32 @@
+import type { ExtensionState } from "@player-devtools/types";
+import type { Flow } from "@player-ui/player";
+
+export const INITIAL_FLOW: Flow = {
+  id: "initial-flow",
+  views: [
+    {
+      id: "view-1",
+      type: "text",
+      value: "connecting...",
+    },
+  ],
+  navigation: {
+    BEGIN: "FLOW_1",
+    FLOW_1: {
+      startState: "VIEW_1",
+      VIEW_1: {
+        state_type: "VIEW",
+        ref: "view-1",
+        transitions: {},
+      },
+    },
+  },
+};
+
+export const INITIAL_EXTENSION_STATE: ExtensionState = {
+  current: {
+    player: null,
+    plugin: null,
+  },
+  players: {},
+};

package/src/helpers/__tests__/flowDiff.test.ts

@@ -0,0 +1,72 @@
+import { describe, test, expect } from "vitest";
+import type { Flow } from "@player-ui/react";
+import { flowDiff } from "../flowDiff";
+
+const mockFlow1: Flow = {
+  id: "flow",
+  views: [
+    {
+      id: "view",
+      type: "info",
+    },
+  ],
+  data: {
+    foo: "bar",
+  },
+  navigation: {
+    BEGIN: "BEGIN",
+  },
+};
+
+const mockFlow2: Flow = {
+  id: "flow",
+  views: [
+    {
+      id: "view",
+      type: "info",
+    },
+  ],
+  data: {
+    foo: "bar",
+    something: "else",
+  },
+  navigation: {
+    BEGIN: "BEGIN",
+  },
+};
+
+const mockFlow3: Flow = {
+  id: "another_flow",
+  views: [
+    {
+      id: "view",
+      type: "info",
+    },
+  ],
+  data: {
+    foo: "bar",
+  },
+  navigation: {
+    BEGIN: "BEGIN",
+  },
+};
+
+describe("flowDiff", () => {
+  test("returns null if no changes", () => {
+    const result = flowDiff({ curr: mockFlow1, next: mockFlow1 });
+
+    expect(result).toBeNull();
+  });
+
+  test("returns flow change if base flow is different", () => {
+    const result = flowDiff({ curr: mockFlow1, next: mockFlow3 });
+
+    expect(result).toEqual({ change: "flow", value: mockFlow3 });
+  });
+
+  test("returns data change if data is different", () => {
+    const result = flowDiff({ curr: mockFlow1, next: mockFlow2 });
+
+    expect(result).toEqual({ change: "data", value: mockFlow2.data });
+  });
+});

package/src/helpers/flowDiff.ts

@@ -0,0 +1,44 @@
+import type { Flow } from "@player-ui/react";
+import { dequal } from "dequal";
+
+/**
+ * Compares two Flow objects and identifies if there's a change in their structure or data.
+ *
+ * This function takes two Flow objects as input, `curr` (current) and `next` (next), and compares them
+ * to determine if there's a change in the flow's structure or its data. If there's a change in the flow's
+ * structure (excluding the `data` property), it returns an object indicating a "flow" change along with the
+ * new flow. If there's a change in the `data` property, it returns an object indicating a "data" change along
+ * with the new data. If there are no changes, it returns null.
+ */
+export const flowDiff = ({
+  curr,
+  next,
+}: {
+  curr: Flow;
+  next: Flow;
+}):
+  | { change: "data"; value: Flow["data"] }
+  | { change: "flow"; value: Flow }
+  | null => {
+  // compare flows except for the `data` property
+  const currCopy = { ...curr, data: null };
+  const nextCopy = { ...next, data: null };
+
+  const baseFlowIsEqual = dequal(currCopy, nextCopy);
+
+  if (!baseFlowIsEqual) {
+    return { change: "flow", value: next };
+  }
+
+  // compare data
+  const currData = curr.data;
+  const nextData = next.data;
+
+  const dataIsEqual = dequal(currData, nextData);
+
+  if (!dataIsEqual) {
+    return { change: "data", value: nextData };
+  }
+
+  return null;
+};

package/src/index.ts

@@ -0,0 +1 @@
+export { Panel } from "./panel";

package/src/panel/index.tsx

@@ -0,0 +1,234 @@
+import React, { useRef } from "react";
+import type {
+  MessengerOptions,
+  ExtensionSupportedEvents,
+} from "@player-devtools/types";
+import { DataController, Flow, useReactPlayer } from "@player-ui/react";
+import { useEffect } from "react";
+import { ErrorBoundary } from "react-error-boundary";
+import {
+  Card,
+  CardBody,
+  CardHeader,
+  ChakraProvider,
+  Container,
+  extendTheme,
+  Flex,
+  FormControl,
+  FormLabel,
+  Heading,
+  Select,
+  Text,
+  type ThemeConfig,
+} from "@chakra-ui/react";
+
+import { ThemeProvider, useDarkMode } from "@devtools-ds/themes";
+
+import { INITIAL_FLOW } from "../constants";
+import { PLAYER_PLUGINS, PUBSUB_PLUGIN } from "../plugins";
+import { useExtensionState } from "../state";
+import { flowDiff } from "../helpers/flowDiff";
+
+const fallbackRender: ErrorBoundary["props"]["fallbackRender"] = ({
+  error,
+}) => {
+  return (
+    <Container centerContent>
+      <Card>
+        <CardHeader>
+          <Heading>Ops, something went wrong.</Heading>
+        </CardHeader>
+        <CardBody>
+          <Text as="pre">{error.message}</Text>
+        </CardBody>
+      </Card>
+    </Container>
+  );
+};
+
+/**
+ * Panel Component
+ *
+ * This component serves as the main container for the devtools plugin content defined by plugin authors using Player-UI DSL.
+ *
+ * Props:
+ * - `communicationLayer`: An object that allows communication between the devtools and the Player-UI plugins,
+ *   enabling the exchange of data and events.
+ *
+ * Features:
+ * - Error Handling: Utilizes the `ErrorBoundary` component from `react-error-boundary` to gracefully handle and display errors
+ *   that may occur during the rendering of the plugin's content.
+ * - State Management: Integrates with custom hooks such as `useExtensionState` to manage the state of the plugin and its components.
+ * - Player Integration: Uses the `useReactPlayer` hook from `player-ui/react` to render interactive player components based on the
+ *   DSL defined by the plugin authors.
+ *
+ * Example Usage:
+ * ```tsx
+ * <Panel communicationLayer={myCommunicationLayer} />
+ * ```
+ *
+ * Note: The `communicationLayer` prop is essential for the proper functioning of the `Panel` component, as it enables the necessary
+ * communication and data exchange with the player-ui/react library.
+ */
+export const Panel: React.FC<{
+  /** the communication layer to use for the extension */
+  readonly communicationLayer: Pick<
+    MessengerOptions<ExtensionSupportedEvents>,
+    "sendMessage" | "addListener" | "removeListener"
+  >;
+  baseTheme?: Record<string, unknown>;
+}> = ({ communicationLayer, baseTheme }) => {
+  const { state, selectPlayer, selectPlugin, handleInteraction } =
+    useExtensionState({
+      communicationLayer,
+    });
+
+  const { reactPlayer, playerState } = useReactPlayer({
+    plugins: PLAYER_PLUGINS,
+  });
+
+  const dataController = useRef<WeakRef<DataController> | null>(null);
+
+  const currentFlow = useRef<Flow | null>(null);
+
+  useEffect(() => {
+    reactPlayer.player.hooks.dataController.tap("devtools-panel", (d) => {
+      dataController.current = new WeakRef(d);
+    });
+  }, [reactPlayer]);
+
+  useEffect(() => {
+    // we subscribe to all messages from the devtools plugin
+    // so the plugin author can define their own events
+    PUBSUB_PLUGIN.subscribe("*", (type: string, payload: string) => {
+      handleInteraction({
+        type,
+        payload,
+      });
+    });
+  }, []);
+
+  useEffect(() => {
+    const { player, plugin } = state.current;
+
+    const flow =
+      player && plugin
+        ? state.players[player]?.plugins?.[plugin]?.flow || INITIAL_FLOW
+        : INITIAL_FLOW;
+
+    if (!currentFlow.current) {
+      currentFlow.current = flow;
+      reactPlayer.start(flow);
+      return;
+    }
+
+    const diff = flowDiff({
+      curr: currentFlow.current as Flow,
+      next: flow,
+    });
+
+    if (diff) {
+      const { change, value } = diff;
+
+      if (change === "flow") {
+        currentFlow.current = value;
+        reactPlayer.start(value);
+      } else if (change === "data") {
+        if (dataController.current) {
+          dataController.current.deref()?.set(value as Record<string, unknown>);
+        } else {
+          reactPlayer.start(flow);
+        }
+      }
+    }
+  }, [reactPlayer, state]);
+
+  const isDarkMode = useDarkMode();
+  const colorMode = isDarkMode ? "dark" : "light";
+
+  const config: ThemeConfig = {
+    initialColorMode: colorMode,
+    useSystemColorMode: true,
+  };
+  const theme = extendTheme({ config, ...baseTheme });
+
+  const Component = reactPlayer.Component as React.FC;
+
+  return (
+    <ChakraProvider resetCSS={false} theme={theme}>
+      <ThemeProvider theme="chrome" colorScheme={colorMode}>
+        <ErrorBoundary fallbackRender={fallbackRender}>
+          <Flex
+            direction="column"
+            h="100vh"
+            alignItems={"normal"}
+            overflow="scroll"
+          >
+            {state.current.player ? (
+              <Flex direction="column" gap="20px">
+                <Flex gap="16px">
+                  <FormControl>
+                    <FormLabel>Player</FormLabel>
+                    <Select
+                      id="player"
+                      value={state.current.player || ""}
+                      onChange={(event) => selectPlayer(event.target.value)}
+                    >
+                      {Object.keys(state.players).map((playerID) => (
+                        <option key={playerID} value={playerID}>
+                          {playerID}
+                        </option>
+                      ))}
+                    </Select>
+                  </FormControl>
+                  <FormControl>
+                    <FormLabel>Plugin</FormLabel>
+                    <Select
+                      id="plugin"
+                      value={state.current.plugin || ""}
+                      onChange={(event) => selectPlugin(event.target.value)}
+                    >
+                      {Object.keys(
+                        state.players[state.current.player]?.plugins ?? [],
+                      ).map((pluginID) => (
+                        <option key={pluginID} value={pluginID}>
+                          {pluginID}
+                        </option>
+                      ))}
+                    </Select>
+                  </FormControl>
+                </Flex>
+                <Flex width="100%">
+                  {playerState.status === "error" ? (
+                    fallbackRender({
+                      error: playerState.error,
+                      resetErrorBoundary: () => {},
+                    })
+                  ) : (
+                    <Component />
+                  )}
+                </Flex>
+                <details>
+                  <summary>Debug</summary>
+                  <pre style={{ maxHeight: "30vh", overflow: "scroll" }}>
+                    {JSON.stringify(state, null, 2)}
+                  </pre>
+                </details>
+              </Flex>
+            ) : (
+              <Flex justifyContent="center" padding="6">
+                <Text>
+                  No Player-UI instance or devtools plugin detected. Visit{" "}
+                  <a href="https://player-ui.github.io/">
+                    https://player-ui.github.io/
+                  </a>{" "}
+                  for more info.
+                </Text>
+              </Flex>
+            )}
+          </Flex>
+        </ErrorBoundary>
+      </ThemeProvider>
+    </ChakraProvider>
+  );
+};

package/src/plugins/index.ts

@@ -0,0 +1,34 @@
+import DevtoolsUIAssetsPlugin from "@devtools-ui/plugin";
+import { PubSubPlugin } from "@player-ui/pubsub-plugin";
+import { CommonExpressionsPlugin } from "@player-ui/common-expressions-plugin";
+import { CommonTypesPlugin } from "@player-ui/common-types-plugin";
+import { DataChangeListenerPlugin } from "@player-ui/data-change-listener-plugin";
+import {
+  ConsoleLogger,
+  Player,
+  PlayerPlugin,
+  ReactPlayer,
+  type ReactPlayerPlugin,
+} from "@player-ui/react";
+
+class LogForwarder implements PlayerPlugin, ReactPlayerPlugin {
+  name = "Log";
+  apply(player: Player) {
+    player.logger.addHandler(new ConsoleLogger("trace", console));
+  }
+
+  applyReact(reactPlayer: ReactPlayer) {
+    this.apply(reactPlayer.player);
+  }
+}
+
+export const PUBSUB_PLUGIN = new PubSubPlugin();
+
+export const PLAYER_PLUGINS: ReactPlayerPlugin[] = [
+  new CommonTypesPlugin(),
+  new CommonExpressionsPlugin(),
+  new DataChangeListenerPlugin(),
+  new DevtoolsUIAssetsPlugin(),
+  new LogForwarder(),
+  PUBSUB_PLUGIN,
+];