@player-tools/devtools-types 0.5.3--canary.90.2515

package/dist/cjs/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// ../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/types/src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +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":[]}

package/dist/index.legacy-esm.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@player-tools/devtools-types",
+  "version": "0.5.3--canary.90.2515",
+  "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",
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/cjs/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ],
+  "dependencies": {
+    "@player-ui/types": "0.7.2-next.4",
+    "tslib": "^2.6.2"
+  },
+  "peerDependencies": {}
+}

package/src/index.ts

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

package/types/index.d.ts

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