@caido/sdk-frontend 0.57.1-beta.4 → 0.57.1-beta.6

package/src/types/index.d.ts

@@ -4,7 +4,7 @@ export type { _AnalyticsSDK } from "./private/analytics";
 export type { MessageViewModeOptions, StreamWsMessageMeta, MessageViewModePropsInternal, MessageViewModeProps, } from "./types/websocket";
 export type { CommandContext, CommandContextRequest, CommandContextRequestRow, CommandContextResponse, CommandContextBase, } from "./types/commands";
 export type { MenuItem } from "./types/menu";
-export { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
+export { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, ReplaySessionKind, type ReplayPageContext, } from "./types/replay";
 export type { AutomateSession, AutomateEntry } from "./types/automate";
 export type { SitemapEntry, SitemapRootEntry, ChildState, } from "./types/sitemap";
 export { SearchSlot, type SearchSlotContent } from "./types/search";
@@ -43,7 +43,6 @@ export type { FindingsPageContext } from "./types/findings";
 export type { HTTPHistoryPageContext } from "./types/httpHistory";
 export type { InterceptPageContext } from "./types/intercept";
 export type { ProjectsPageContext } from "./types/projects";
-export type { ReplayPageContext } from "./types/replay";
 export type { ScopePageContext } from "./types/scopes";
 export type { SearchPageContext } from "./types/search";
 export type { SitemapPageContext } from "./types/sitemap";

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

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+import { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySessionKind, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
 import type { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
 import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
@@ -27,9 +27,13 @@ export type ReplaySDK = {
     getTabs: () => ReplayTab[];
     /**
      * Get the list of all replay sessions.
+     * @param options The options for getting the sessions.
+     * @param options.collectionId The ID of the collection to get the sessions for.
      * @returns The list of all replay sessions.
      */
-    getSessions: () => ReplaySession[];
+    getSessions: (options?: {
+        collectionId?: ID;
+    }) => ReplaySession[];
     /**
      * Get the currently selected replay session.
      * @returns The currently selected replay session, or undefined if no session is selected.
@@ -79,10 +83,22 @@ export type ReplaySDK = {
     deleteSessions: (sessionIds: ID[]) => Promise<ID[]>;
     /**
      * Create a session.
-     * @param sessionId The ID of the request to add.
-     * @param collectionId The ID of the collection to add the request.
+     * @param source The source of the session to create.
+     * @param collectionId The ID of the collection to add the session to.
+     * @example
+     * ```ts
+     * sdk.replay.createSession({
+     *   type: "Raw",
+     *   raw: "GET / HTTP/1.1\r\nHost: example.com\r\n\r\n",
+     *   connectionInfo: {
+     *     host: "example.com",
+     *     port: 443,
+     *     isTLS: true,
+     *   },
+     * });
+     * ```
      */
-    createSession: (source: RequestSource, collectionId?: ID) => Promise<void>;
+    createSession: (source: RequestSource, collectionId?: ID, sessionKind?: ReplaySessionKind) => Promise<ReplaySession>;
     /**
      * Get the list of all replay collections.
      * @returns The list of all replay collections.

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

@@ -224,6 +224,19 @@ export type AddSessionIndicatorOptions = AddIndicatorOptions & {
  * @category Replay
  */
 export type AddCollectionIndicatorOptions = AddIndicatorOptions;
+/**
+ * The kind of a replay session.
+ * @category Replay
+ */
+export declare const ReplaySessionKind: {
+    readonly Http: "HTTP";
+    readonly Ws: "WS";
+};
+/**
+ * The kind of a replay session.
+ * @category Replay
+ */
+export type ReplaySessionKind = (typeof ReplaySessionKind)[keyof typeof ReplaySessionKind];
 /**
  * A unique replay session identifier.
  * @category Replay