@player-tools/devtools-types 0.8.0-next.0 → 0.8.0

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/types/src/index.ts"],"sourcesContent":["import type { Flow } from \"@player-ui/types\";\n\nexport interface BaseEvent<T extends string, P = null> {\n  /** Event type */\n  type: T;\n  /** Event payload */\n  payload: P;\n}\n\nexport type TransactionMetadata = {\n  /** Unique ID */\n  id: number;\n  /** Timestamp */\n  timestamp: number;\n  /** Sender ID */\n  sender: string;\n  /** Target ID */\n  target?: string;\n  /** Context */\n  context: \"player\" | \"devtools\";\n  /** Messenger tag */\n  _messenger_: boolean;\n};\n\nexport type BeaconEvent = BaseEvent<\"MESSENGER_BEACON\">;\n\nexport type EventsBatchEvent<T extends BaseEvent<string, unknown>> = BaseEvent<\n  \"MESSENGER_EVENT_BATCH\",\n  {\n    /** Array of Events */\n    events: (MessengerEvent<T> & TransactionMetadata)[];\n  }\n>;\n\nexport type RequestLostEventsEvent = BaseEvent<\n  \"MESSENGER_REQUEST_LOST_EVENTS\",\n  {\n    /** Last received message id */\n    lastReceivedMessageId: number;\n  }\n>;\n\nexport type DisconnectEvent = BaseEvent<\"MESSENGER_DISCONNECT\">;\n\nexport type InternalEvent<T extends BaseEvent<string, unknown>> =\n  | BeaconEvent\n  | RequestLostEventsEvent\n  | EventsBatchEvent<T>\n  | DisconnectEvent;\n\nexport type MessengerEvent<T extends BaseEvent<string, unknown>> =\n  | T\n  | InternalEvent<T>;\n\nexport type Transaction<T extends BaseEvent<string, unknown>> =\n  TransactionMetadata & MessengerEvent<T>;\n\nexport type Connection = {\n  /** Target ID */\n  id: string;\n  /** Last sent message id */\n  lastSentMessageId: number;\n  /** Last received message id */\n  lastReceivedMessageId: number;\n  /** Lost events since the last one received */\n  desync: boolean;\n};\n\n/** Messenger options */\nexport interface MessengerOptions<T extends BaseEvent<string, unknown>> {\n  /** API to send messages (e.g. window.postMessage, browser.runtime.sendMessage) */\n  sendMessage: (message: MessengerEvent<T>) => Promise<void>;\n  /** API to add a listener (e.g. window.addEventListener, browser.runtime.onMessage.addListener) */\n  addListener: (\n    callback: (message: TransactionMetadata & MessengerEvent<T>) => void\n  ) => void;\n  /** API to remove a listener (e.g. window.removeEventListener, browser.runtime.onMessage.removeListener) */\n  removeListener: (\n    callback: (message: TransactionMetadata & MessengerEvent<T>) => void\n  ) => void;\n  /** Callback to handle messages */\n  messageCallback: (message: TransactionMetadata & MessengerEvent<T>) => void;\n  /** Context */\n  context: \"player\" | \"devtools\";\n  /** Unique id */\n  id?: string;\n  /** Time between beacons in ms */\n  beaconIntervalMS?: number;\n  /** Debug mode */\n  debug?: boolean;\n  /** Handle failed message */\n  handleFailedMessage?: (message: Transaction<T>) => void;\n  /** Logger */\n  logger: {\n    /** Log message */\n    log: (...args: Array<unknown>) => void;\n  };\n}\n\n/** Plugin data */\nexport interface PluginData {\n  /** Plugin id */\n  id: string;\n  /** Plugin version */\n  version: string;\n  /** Plugin name */\n  name: string;\n  /** Plugin description */\n  description: string;\n  /** Plugin UI */\n  flow: Flow;\n}\n\nexport interface ExtensionState {\n  /** currently being inspected */\n  current: {\n    /** player */\n    player: string | null;\n    /** plugin */\n    plugin: string | null;\n  };\n  /**  */\n  players: Record<\n    string,\n    {\n      /** registeredPlugins */\n      plugins: Record<string, PluginData>;\n      /** active */\n      active: boolean;\n      /** config */\n      config: Record<string, unknown>;\n    }\n  >;\n}\n\ninterface InitPayload {\n  /** Devtools plugins */\n  plugins: Record<string, PluginData>;\n}\n\ninterface FlowChangePayload {\n  /** Flow */\n  flow: Partial<Flow>;\n  /** Plugin ID */\n  pluginID: string;\n}\n\ninterface DataChangePayload {\n  /** Data */\n  data: Flow[\"data\"];\n  /** Plugin ID */\n  pluginID: string;\n}\n\ninterface EventsBatchPayload {\n  /** Events */\n  events: Array<TransactionMetadata & MessengerEvent<ExtensionSupportedEvents>>;\n}\n\n/** Proxy events from the devtools player to the devtools plungins */\ninterface PluginInteractionPayload {\n  /** Interaction Type */\n  type: string;\n  /** Stringified payload */\n  payload?: string;\n}\n\nexport type PlayerInitEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLAYER_INIT\",\n  InitPayload\n>;\n\nexport type DevtoolsFlowChangeEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_FLOW_CHANGE\",\n  FlowChangePayload\n>;\n\nexport type DevtoolsDataChangeEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_DATA_CHANGE\",\n  DataChangePayload\n>;\n\nexport type PlayerStoppedEvent = BaseEvent<\"PLAYER_DEVTOOLS_PLAYER_STOPPED\">;\n\nexport type DevtoolsEventsBatchEvent = BaseEvent<\n  \"MESSENGER_EVENT_BATCH\",\n  EventsBatchPayload\n>;\n\nexport type ExtensionSelectedPlayerEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLAYER_SELECTED\",\n  {\n    /** Player ID */\n    playerID: string;\n  }\n>;\n\nexport type ExtensionSelectedPluginEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_SELECTED\",\n  {\n    /** Plugin ID */\n    pluginID: string;\n  }\n>;\n\nexport type DevtoolsPluginInteractionEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_INTERACTION\",\n  PluginInteractionPayload\n>;\n\nexport type ExtensionSupportedEvents =\n  | PlayerInitEvent\n  | DevtoolsFlowChangeEvent\n  | DevtoolsDataChangeEvent\n  | PlayerStoppedEvent\n  | DevtoolsEventsBatchEvent\n  | ExtensionSelectedPlayerEvent\n  | ExtensionSelectedPluginEvent\n  | BeaconEvent\n  | DisconnectEvent\n  | DevtoolsPluginInteractionEvent;\n\nexport type CommunicationLayerMethods = Pick<\n  MessengerOptions<ExtensionSupportedEvents>,\n  \"sendMessage\" | \"addListener\" | \"removeListener\"\n>;\n\n/** Interface representing the Devtools Plugins Store. */\nexport interface DevtoolsPluginsStore {\n  /** Plugins data. */\n  plugins: Record<string, PluginData>;\n  /** Array of supported events. */\n  messages: Array<ExtensionSupportedEvents>;\n  /** Array of interactions triggered from the Devtools Player Content by plugin and player */\n  interactions: Array<DevtoolsPluginInteractionEvent>;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/types/src/index.ts"],"sourcesContent":["import type { Flow } from \"@player-ui/types\";\n\nexport interface BaseEvent<T extends string, P = null> {\n  /** Event type */\n  type: T;\n  /** Event payload */\n  payload: P;\n  /** Target ID */\n  target?: string;\n}\n\nexport type TransactionMetadata = {\n  /** Unique ID */\n  id: number;\n  /** Timestamp */\n  timestamp: number;\n  /** Sender ID */\n  sender: string;\n  /** Context */\n  context: \"player\" | \"devtools\";\n  /** Messenger tag */\n  _messenger_: boolean;\n};\n\nexport type BeaconEvent = BaseEvent<\"MESSENGER_BEACON\">;\n\nexport type EventsBatchEvent<T extends BaseEvent<string, unknown>> = BaseEvent<\n  \"MESSENGER_EVENT_BATCH\",\n  {\n    /** Array of Events */\n    events: (MessengerEvent<T> & TransactionMetadata)[];\n  }\n>;\n\nexport type RequestLostEventsEvent = BaseEvent<\n  \"MESSENGER_REQUEST_LOST_EVENTS\",\n  {\n    /** Messages received count */\n    messagesReceived: number;\n  }\n>;\n\nexport type DisconnectEvent = BaseEvent<\"MESSENGER_DISCONNECT\">;\n\nexport type InternalEvent<T extends BaseEvent<string, unknown>> =\n  | BeaconEvent\n  | RequestLostEventsEvent\n  | EventsBatchEvent<T>\n  | DisconnectEvent;\n\nexport type MessengerEvent<T extends BaseEvent<string, unknown>> =\n  | T\n  | InternalEvent<T>;\n\nexport type Transaction<T extends BaseEvent<string, unknown>> =\n  TransactionMetadata & MessengerEvent<T>;\n\nexport type Connection = {\n  /** Target ID */\n  id: string;\n  /** Messages sent*/\n  messagesSent: number;\n  /** Messages received */\n  messagesReceived: number;\n  /** Lost events since the last one received */\n  desync: boolean;\n};\n\n/** Messenger options */\nexport interface MessengerOptions<T extends BaseEvent<string, unknown>> {\n  /** API to send messages (e.g. window.postMessage, browser.runtime.sendMessage) */\n  sendMessage: (message: MessengerEvent<T>) => Promise<void>;\n  /** API to add a listener (e.g. window.addEventListener, browser.runtime.onMessage.addListener) */\n  addListener: (\n    callback: (message: TransactionMetadata & MessengerEvent<T>) => void\n  ) => void;\n  /** API to remove a listener (e.g. window.removeEventListener, browser.runtime.onMessage.removeListener) */\n  removeListener: (\n    callback: (message: TransactionMetadata & MessengerEvent<T>) => void\n  ) => void;\n  /** Callback to handle messages */\n  messageCallback: (message: TransactionMetadata & MessengerEvent<T>) => void;\n  /** Context */\n  context: \"player\" | \"devtools\";\n  /** Unique id */\n  id?: string;\n  /** Time between beacons in ms */\n  beaconIntervalMS?: number;\n  /** Debug mode */\n  debug?: boolean;\n  /** Handle failed message */\n  handleFailedMessage?: (message: Transaction<T>) => void;\n  /** Logger */\n  logger: {\n    /** Log message */\n    log: (...args: Array<unknown>) => void;\n  };\n}\n\n/** Plugin data */\nexport interface PluginData {\n  /** Plugin id */\n  id: string;\n  /** Plugin version */\n  version: string;\n  /** Plugin name */\n  name: string;\n  /** Plugin description */\n  description: string;\n  /** Plugin UI */\n  flow: Flow;\n}\n\nexport interface ExtensionState {\n  /** currently being inspected */\n  current: {\n    /** player */\n    player: string | null;\n    /** plugin */\n    plugin: string | null;\n  };\n  /**  */\n  players: Record<\n    string,\n    {\n      /** registeredPlugins */\n      plugins: Record<string, PluginData>;\n      /** active */\n      active: boolean;\n      /** config */\n      config: Record<string, unknown>;\n    }\n  >;\n}\n\ninterface InitPayload {\n  /** Devtools plugins */\n  plugins: Record<string, PluginData>;\n}\n\ninterface FlowChangePayload {\n  /** Flow */\n  flow: Partial<Flow>;\n  /** Plugin ID */\n  pluginID: string;\n}\n\ninterface DataChangePayload {\n  /** Data */\n  data: Flow[\"data\"];\n  /** Plugin ID */\n  pluginID: string;\n}\n\ninterface EventsBatchPayload {\n  /** Events */\n  events: Array<TransactionMetadata & MessengerEvent<ExtensionSupportedEvents>>;\n}\n\n/** Proxy events from the devtools player to the devtools plungins */\ninterface PluginInteractionPayload {\n  /** Interaction Type */\n  type: string;\n  /** Stringified payload */\n  payload?: string;\n}\n\nexport type PlayerInitEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLAYER_INIT\",\n  InitPayload\n>;\n\nexport type DevtoolsFlowChangeEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_FLOW_CHANGE\",\n  FlowChangePayload\n>;\n\nexport type DevtoolsDataChangeEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_DATA_CHANGE\",\n  DataChangePayload\n>;\n\nexport type PlayerStoppedEvent = BaseEvent<\"PLAYER_DEVTOOLS_PLAYER_STOPPED\">;\n\nexport type DevtoolsEventsBatchEvent = BaseEvent<\n  \"MESSENGER_EVENT_BATCH\",\n  EventsBatchPayload\n>;\n\nexport type ExtensionSelectedPlayerEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLAYER_SELECTED\",\n  {\n    /** Player ID */\n    playerID: string;\n  }\n>;\n\nexport type ExtensionSelectedPluginEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_SELECTED\",\n  {\n    /** Plugin ID */\n    pluginID: string;\n  }\n>;\n\nexport type DevtoolsPluginInteractionEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_PLUGIN_INTERACTION\",\n  PluginInteractionPayload\n>;\n\nexport type DevtoolsPluginSelectedPlayerEvent = BaseEvent<\n  \"PLAYER_DEVTOOLS_SELECTED_PLAYER_CHANGE\",\n  {\n    /** Player ID */\n    playerID: string;\n  }\n>;\n\nexport type ExtensionSupportedEvents =\n  | PlayerInitEvent\n  | DevtoolsFlowChangeEvent\n  | DevtoolsDataChangeEvent\n  | PlayerStoppedEvent\n  | DevtoolsEventsBatchEvent\n  | ExtensionSelectedPlayerEvent\n  | ExtensionSelectedPluginEvent\n  | BeaconEvent\n  | DisconnectEvent\n  | DevtoolsPluginInteractionEvent\n  | DevtoolsPluginSelectedPlayerEvent;\n\nexport type CommunicationLayerMethods = Pick<\n  MessengerOptions<ExtensionSupportedEvents>,\n  \"sendMessage\" | \"addListener\" | \"removeListener\"\n>;\n\n/** Interface representing the Devtools Plugins Store. */\nexport interface DevtoolsPluginsStore {\n  /** Plugins data. */\n  plugins: Record<string, PluginData>;\n  /** Array of supported events. */\n  messages: Array<ExtensionSupportedEvents>;\n  /** Array of interactions triggered from the Devtools Player Content by plugin and player */\n  interactions: Array<DevtoolsPluginInteractionEvent>;\n  /** Current player ID */\n  currentPlayer: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/package.json

@@ -1,10 +1,15 @@
 {
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ],
   "name": "@player-tools/devtools-types",
-  "version": "0.8.0-next.0",
+  "version": "0.8.0",
   "main": "dist/cjs/index.cjs",
   "module": "dist/index.legacy-esm.js",
   "types": "types/index.d.ts",
-  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     "./dist/index.css": "./dist/index.css",
@@ -14,11 +19,6 @@
       "default": "./dist/cjs/index.cjs"
     }
   },
-  "files": [
-    "dist",
-    "src",
-    "types"
-  ],
   "dependencies": {
     "@player-ui/types": "0.7.3",
     "tslib": "^2.6.2"

package/src/index.ts

@@ -5,6 +5,8 @@ export interface BaseEvent<T extends string, P = null> {
   type: T;
   /** Event payload */
   payload: P;
+  /** Target ID */
+  target?: string;
 }
 
 export type TransactionMetadata = {
@@ -14,8 +16,6 @@ export type TransactionMetadata = {
   timestamp: number;
   /** Sender ID */
   sender: string;
-  /** Target ID */
-  target?: string;
   /** Context */
   context: "player" | "devtools";
   /** Messenger tag */
@@ -35,8 +35,8 @@ export type EventsBatchEvent<T extends BaseEvent<string, unknown>> = BaseEvent<
 export type RequestLostEventsEvent = BaseEvent<
   "MESSENGER_REQUEST_LOST_EVENTS",
   {
-    /** Last received message id */
-    lastReceivedMessageId: number;
+    /** Messages received count */
+    messagesReceived: number;
   }
 >;
 
@@ -58,10 +58,10 @@ export type Transaction<T extends BaseEvent<string, unknown>> =
 export type Connection = {
   /** Target ID */
   id: string;
-  /** Last sent message id */
-  lastSentMessageId: number;
-  /** Last received message id */
-  lastReceivedMessageId: number;
+  /** Messages sent*/
+  messagesSent: number;
+  /** Messages received */
+  messagesReceived: number;
   /** Lost events since the last one received */
   desync: boolean;
 };
@@ -208,6 +208,14 @@ export type DevtoolsPluginInteractionEvent = BaseEvent<
   PluginInteractionPayload
 >;
 
+export type DevtoolsPluginSelectedPlayerEvent = BaseEvent<
+  "PLAYER_DEVTOOLS_SELECTED_PLAYER_CHANGE",
+  {
+    /** Player ID */
+    playerID: string;
+  }
+>;
+
 export type ExtensionSupportedEvents =
   | PlayerInitEvent
   | DevtoolsFlowChangeEvent
@@ -218,7 +226,8 @@ export type ExtensionSupportedEvents =
   | ExtensionSelectedPluginEvent
   | BeaconEvent
   | DisconnectEvent
-  | DevtoolsPluginInteractionEvent;
+  | DevtoolsPluginInteractionEvent
+  | DevtoolsPluginSelectedPlayerEvent;
 
 export type CommunicationLayerMethods = Pick<
   MessengerOptions<ExtensionSupportedEvents>,
@@ -233,4 +242,6 @@ export interface DevtoolsPluginsStore {
   messages: Array<ExtensionSupportedEvents>;
   /** Array of interactions triggered from the Devtools Player Content by plugin and player */
   interactions: Array<DevtoolsPluginInteractionEvent>;
+  /** Current player ID */
+  currentPlayer: string;
 }

package/types/index.d.ts

@@ -4,6 +4,8 @@ export interface BaseEvent<T extends string, P = null> {
     type: T;
     /** Event payload */
     payload: P;
+    /** Target ID */
+    target?: string;
 }
 export type TransactionMetadata = {
     /** Unique ID */
@@ -12,8 +14,6 @@ export type TransactionMetadata = {
     timestamp: number;
     /** Sender ID */
     sender: string;
-    /** Target ID */
-    target?: string;
     /** Context */
     context: "player" | "devtools";
     /** Messenger tag */
@@ -25,8 +25,8 @@ export type EventsBatchEvent<T extends BaseEvent<string, unknown>> = BaseEvent<"
     events: (MessengerEvent<T> & TransactionMetadata)[];
 }>;
 export type RequestLostEventsEvent = BaseEvent<"MESSENGER_REQUEST_LOST_EVENTS", {
-    /** Last received message id */
-    lastReceivedMessageId: number;
+    /** Messages received count */
+    messagesReceived: number;
 }>;
 export type DisconnectEvent = BaseEvent<"MESSENGER_DISCONNECT">;
 export type InternalEvent<T extends BaseEvent<string, unknown>> = BeaconEvent | RequestLostEventsEvent | EventsBatchEvent<T> | DisconnectEvent;
@@ -35,10 +35,10 @@ export type Transaction<T extends BaseEvent<string, unknown>> = TransactionMetad
 export type Connection = {
     /** Target ID */
     id: string;
-    /** Last sent message id */
-    lastSentMessageId: number;
-    /** Last received message id */
-    lastReceivedMessageId: number;
+    /** Messages sent*/
+    messagesSent: number;
+    /** Messages received */
+    messagesReceived: number;
     /** Lost events since the last one received */
     desync: boolean;
 };
@@ -140,7 +140,11 @@ export type ExtensionSelectedPluginEvent = BaseEvent<"PLAYER_DEVTOOLS_PLUGIN_SEL
     pluginID: string;
 }>;
 export type DevtoolsPluginInteractionEvent = BaseEvent<"PLAYER_DEVTOOLS_PLUGIN_INTERACTION", PluginInteractionPayload>;
-export type ExtensionSupportedEvents = PlayerInitEvent | DevtoolsFlowChangeEvent | DevtoolsDataChangeEvent | PlayerStoppedEvent | DevtoolsEventsBatchEvent | ExtensionSelectedPlayerEvent | ExtensionSelectedPluginEvent | BeaconEvent | DisconnectEvent | DevtoolsPluginInteractionEvent;
+export type DevtoolsPluginSelectedPlayerEvent = BaseEvent<"PLAYER_DEVTOOLS_SELECTED_PLAYER_CHANGE", {
+    /** Player ID */
+    playerID: string;
+}>;
+export type ExtensionSupportedEvents = PlayerInitEvent | DevtoolsFlowChangeEvent | DevtoolsDataChangeEvent | PlayerStoppedEvent | DevtoolsEventsBatchEvent | ExtensionSelectedPlayerEvent | ExtensionSelectedPluginEvent | BeaconEvent | DisconnectEvent | DevtoolsPluginInteractionEvent | DevtoolsPluginSelectedPlayerEvent;
 export type CommunicationLayerMethods = Pick<MessengerOptions<ExtensionSupportedEvents>, "sendMessage" | "addListener" | "removeListener">;
 /** Interface representing the Devtools Plugins Store. */
 export interface DevtoolsPluginsStore {
@@ -150,6 +154,8 @@ export interface DevtoolsPluginsStore {
     messages: Array<ExtensionSupportedEvents>;
     /** Array of interactions triggered from the Devtools Player Content by plugin and player */
     interactions: Array<DevtoolsPluginInteractionEvent>;
+    /** Current player ID */
+    currentPlayer: string;
 }
 export {};
 //# sourceMappingURL=index.d.ts.map