@caido/sdk-frontend 0.53.2-beta.0 → 0.53.2-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.53.2-beta.0",
+  "version": "0.53.2-beta.1",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",

package/src/types/index.d.ts

@@ -2,7 +2,7 @@ export { FooterSlot, type FooterSlotContent } from "./types/footer";
 export type { DialogOptions } from "./types/window";
 export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 export type { MenuItem } from "./types/menu";
-export { type ReplayTab, type ReplaySession, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
+export { type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
 export type { HostedFile } from "./types/files";
 export type { Filter } from "./types/filter";
 export type { HTTPQL, ID, ComponentDefinition } from "./types/utils";

package/src/types/sdks/replay.d.ts

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplaySession, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+import { type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayEntry, type ReplaySession, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
 import type { RequestViewModeOptions } from "../types/request";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { ID, ListenerHandle } from "../types/utils";
@@ -134,6 +134,34 @@ export type ReplaySDK = {
      * ```
      */
     sendRequest: (sessionId: ID, options: SendRequestOptions) => Promise<void>;
+    /**
+     * Show a specific entry in a replay session.
+     * This will open the session tab if not already open, set it as the selected session, and display the specified entry.
+     * @param sessionId The ID of the session containing the entry.
+     * @param entryId The ID of the entry to show.
+     * @param options The options for showing the entry.
+     * @param options.overwriteDraft Whether to overwrite the request draft. If true, the draft will be removed and the entry's raw request will be shown. If false, the draft will be kept.
+     * @example
+     * ```ts
+     * await sdk.replay.showEntry(sessionId, entryId, {
+     *   overwriteDraft: true,
+     * });
+     * ```
+     */
+    showEntry: (sessionId: ID, entryId: ID, options?: {
+        overwriteDraft?: boolean;
+    }) => Promise<void>;
+    /**
+     * Get a replay entry by its ID.
+     * @param entryId The ID of the entry to get.
+     * @returns The replay entry.
+     * @example
+     * ```ts
+     * const entry = await sdk.replay.getEntry(entryId);
+     * console.log(entry.id, entry.sessionId, entry.requestId);
+     * ```
+     */
+    getEntry: (entryId: ID) => ReplayEntry;
     /**
      * Subscribe to current replay session changes.
      * @param callback The callback to call when the selected session changes.

package/src/types/types/replay.d.ts

@@ -62,6 +62,28 @@ export type ReplaySession = {
      * The ID of the collection the session belongs to.
      */
     collectionId: ID;
+    /**
+     * The IDs of all entries in this session.
+     */
+    entryIds: ID[];
+};
+/**
+ * A replay entry.
+ * @category Replay
+ */
+export type ReplayEntry = {
+    /**
+     * The ID of the entry.
+     */
+    id: ID;
+    /**
+     * The ID of the session this entry belongs to.
+     */
+    sessionId: ID;
+    /**
+     * The ID of the request associated with this entry, if any.
+     */
+    requestId?: ID;
 };
 /**
  * A collection in Replay.