@caido/sdk-frontend 0.42.0 → 0.42.1-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "v0.42.0",
+  "version": "0.42.1-beta.1",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",

package/src/types/index.d.ts

@@ -1,6 +1,6 @@
 import type { Sdk as GraphqlSDK } from "./__generated__/graphql-sdk";
 import type { BackendEndpoints, BackendEvents, BackendSDK } from "./backend";
-import type { CommandPaletteSDK } from "./command_palette";
+import type { CommandPaletteSDK } from "./commandPalette";
 import type { CommandsSDK } from "./commands";
 import type { FindingsSDK } from "./findings";
 import type { MenuSDK } from "./menu";
@@ -11,8 +11,10 @@ import type { SidebarSDK } from "./sidebar";
 import type { StorageSDK } from "./storage";
 import type { UISDK } from "./ui";
 import type { WindowSDK } from "./window";
+import type { ReplaySDK } from "./replay";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
+export type { ReplayTab, ReplaySession, ReplayCollection } from "./replay";
 /**
  * Utilities for frontend plugins.
  * @category SDK
@@ -70,4 +72,8 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with the sidebar.
      */
     sidebar: SidebarSDK;
+    /**
+     * Utilities to interact with Replay.
+     */
+    replay: ReplaySDK;
 };

package/src/types/replay.d.ts

@@ -0,0 +1,80 @@
+/**
+ * A replay tab.
+ * @category Replay
+ */
+export type ReplayTab = {
+    /**
+     * The ID of the session associated with this tab.
+     */
+    sessionId: string;
+};
+/**
+ * A session in Replay.
+ * @category Replay
+ */
+export type ReplaySession = {
+    /**
+     * The ID of the session.
+     */
+    id: string;
+    /**
+     * The name of the session.
+     */
+    name: string;
+    /**
+     * The ID of the collection the session belongs to.
+     */
+    collectionId: string;
+};
+export type ReplayCollection = {
+    /**
+     * The ID of the collection.
+     */
+    id: string;
+    /**
+     * The name of the collection.
+     */
+    name: string;
+    /**
+     * The sessions in the collection.
+     */
+    sessionIds: string[];
+};
+/**
+ * Utilities to interact with Replay.
+ * @category Replay
+ */
+export type ReplaySDK = {
+    /**
+     * Open a replay tab for the given session.
+     * @param sessionId The ID of the session to open.
+     */
+    openTab: (sessionId: string) => void;
+    /**
+     * Close a replay tab for the given session.
+     * @param sessionId The ID of the session to close.
+     */
+    closeTab: (sessionId: string) => void;
+    /**
+     * Get the list of all open replay tabs.
+     * @returns The list of all open replay tabs.
+     */
+    getTabs: () => ReplayTab[];
+    /**
+     * Get the list of all replay collections.
+     * @returns The list of all replay collections.
+     */
+    getCollections: () => ReplayCollection[];
+    /**
+     * Get the list of all replay sessions.
+     * @returns The list of all replay sessions.
+     */
+    getSessions: () => ReplaySession[];
+    /**
+     * Rename a session.
+     * @param id The ID of the session to rename.
+     * @param name The new name of the session.
+     * @returns The updated session.
+     */
+    renameSession: (id: string, name: string) => Promise<ReplaySession>;
+};

package/src/types/shortcuts.d.ts

@@ -7,7 +7,7 @@ export type ShortcutsSDK = {
     /**
      * Register a shortcut.
      * @param commandId The id of the command to run when the shortcut is triggered.
-     * @param keys The keys of the shortcut.
+     * @param keys The keys of the shortcut. Check out {@link https://github.com/jaywcjlove/hotkeys-js?tab=readme-ov-file#supported-keys hotkeys-js} for the list of supported keys.
      */
     register: (commandId: CommandID, keys: string[]) => void;
 };