@caido/sdk-frontend 0.57.2-beta.0 → 0.57.2-beta.2

package/package.json

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

package/src/types/__generated__/graphql-sdk.d.ts

@@ -1447,6 +1447,15 @@ export type EnvironmentVariableKind = (typeof EnvironmentVariableKind)[keyof typ
 export type ExpiredViewerProfilePayload = {
     expiredAt: Scalars["Timestamp"]["output"];
 };
+export type ExportAutomateEntriesError = OtherUserError | PermissionDeniedUserError;
+export type ExportAutomateEntriesInput = {
+    sessions: Array<Scalars["ID"]["input"]>;
+    settings: DataExportSettingsInput;
+};
+export type ExportAutomateEntriesPayload = {
+    error?: Maybe<ExportAutomateEntriesError>;
+    export?: Maybe<DataExportOnDemand>;
+};
 export type ExportFindingsError = OtherUserError | PermissionDeniedUserError;
 export type ExportFindingsInput = {
     filter: FilterClauseFindingInput;
@@ -1945,6 +1954,7 @@ export type MutationRoot = {
     deleteWorkflow: DeleteWorkflowPayload;
     dropInterceptMessage: DropInterceptMessagePayload;
     duplicateAutomateSession: DuplicateAutomateSessionPayload;
+    exportAutomateEntries: ExportAutomateEntriesPayload;
     exportFindings: ExportFindingsPayload;
     exportSitemapEntries: ExportSitemapEntriesPayload;
     exportTamper: ExportTamperPayload;
@@ -2217,6 +2227,9 @@ export type MutationRootDropInterceptMessageArgs = {
 export type MutationRootDuplicateAutomateSessionArgs = {
     id: Scalars["ID"]["input"];
 };
+export type MutationRootExportAutomateEntriesArgs = {
+    input: ExportAutomateEntriesInput;
+};
 export type MutationRootExportFindingsArgs = {
     input: ExportFindingsInput;
 };
@@ -7842,6 +7855,25 @@ export type StartAutomateTaskMutation = {
         } | undefined | null;
     };
 };
+export type ExportAutomateEntriesMutationVariables = Exact<{
+    input: ExportAutomateEntriesInput;
+}>;
+export type ExportAutomateEntriesMutation = {
+    exportAutomateEntries: {
+        export?: {
+            downloadUri: string;
+            id: string;
+        } | undefined | null;
+        error?: {
+            __typename: "OtherUserError";
+            code: string;
+        } | {
+            __typename: "PermissionDeniedUserError";
+            code: string;
+            permissionDeniedReason: PermissionDeniedErrorReason;
+        } | undefined | null;
+    };
+};
 export type CreatedAutomateEntryRequestSubscriptionVariables = Exact<{
     order?: InputMaybe<AutomateEntryRequestOrderInput>;
     filter?: InputMaybe<HttpqlInput>;
@@ -123837,6 +123869,7 @@ export declare const CancelAutomateTaskDocument = "\n    mutation cancelAutomate
 export declare const PauseAutomateTaskDocument = "\n    mutation pauseAutomateTask($id: ID!) {\n  pauseAutomateTask(id: $id) {\n    automateTask {\n      ...automateTaskMeta\n    }\n    userError {\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment automateTaskMeta on AutomateTask {\n  id\n  paused\n  entry {\n    ...automateEntryMeta\n  }\n}\n    \n\n    fragment automateEntryMeta on AutomateEntry {\n  __typename\n  id\n  name\n  createdAt\n  session {\n    id\n  }\n}\n    \n\n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    ";
 export declare const ResumeAutomateTaskDocument = "\n    mutation resumeAutomateTask($id: ID!) {\n  resumeAutomateTask(id: $id) {\n    automateTask {\n      ...automateTaskMeta\n    }\n    userError {\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment automateTaskMeta on AutomateTask {\n  id\n  paused\n  entry {\n    ...automateEntryMeta\n  }\n}\n    \n\n    fragment automateEntryMeta on AutomateEntry {\n  __typename\n  id\n  name\n  createdAt\n  session {\n    id\n  }\n}\n    \n\n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    ";
 export declare const StartAutomateTaskDocument = "\n    mutation startAutomateTask($automateSessionId: ID!) {\n  startAutomateTask(automateSessionId: $automateSessionId) {\n    automateTask {\n      ...automateTaskMeta\n    }\n  }\n}\n    \n    fragment automateTaskMeta on AutomateTask {\n  id\n  paused\n  entry {\n    ...automateEntryMeta\n  }\n}\n    \n\n    fragment automateEntryMeta on AutomateEntry {\n  __typename\n  id\n  name\n  createdAt\n  session {\n    id\n  }\n}\n    ";
+export declare const ExportAutomateEntriesDocument = "\n    mutation exportAutomateEntries($input: ExportAutomateEntriesInput!) {\n  exportAutomateEntries(input: $input) {\n    export {\n      ...dataExportOnDemandMeta\n    }\n    error {\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n      ... on PermissionDeniedUserError {\n        ...permissionDeniedUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment dataExportOnDemandMeta on DataExportOnDemand {\n  downloadUri\n  id\n}\n    \n\n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment permissionDeniedUserErrorFull on PermissionDeniedUserError {\n  ...userErrorFull\n  permissionDeniedReason: reason\n}\n    ";
 export declare const CreatedAutomateEntryRequestDocument = "\n    subscription createdAutomateEntryRequest($order: AutomateEntryRequestOrderInput, $filter: HTTPQLInput) {\n  createdAutomateEntryRequest(filter: $filter) {\n    automateEntryRequestEdge(order: $order) {\n      ...automateEntryRequestEdgeMeta\n    }\n    snapshot\n  }\n}\n    \n    fragment automateEntryRequestEdgeMeta on AutomateEntryRequestEdge {\n  __typename\n  node {\n    ...automateEntryRequestMeta\n  }\n  cursor\n}\n    \n\n    fragment automateEntryRequestMeta on AutomateEntryRequest {\n  __typename\n  sequenceId\n  automateEntryId\n  error\n  request {\n    ...requestMeta\n  }\n  payloads {\n    ...automateEntryRequestPayloadFull\n  }\n  extracts {\n    ...automateEntryRequestExtractFull\n  }\n}\n    \n\n    fragment requestMeta on Request {\n  __typename\n  id\n  host\n  port\n  path\n  query\n  method\n  edited\n  isTls\n  sni\n  length\n  alteration\n  metadata {\n    ...requestMetadataFull\n  }\n  fileExtension\n  source\n  createdAt\n  response {\n    ...responseMeta\n  }\n  stream {\n    id\n  }\n}\n    \n\n    fragment requestMetadataFull on RequestMetadata {\n  __typename\n  id\n  color\n}\n    \n\n    fragment responseMeta on Response {\n  __typename\n  id\n  statusCode\n  roundtripTime\n  length\n  createdAt\n  alteration\n  edited\n}\n    \n\n    fragment automateEntryRequestPayloadFull on AutomateEntryRequestPayload {\n  __typename\n  position\n  raw\n}\n    \n\n    fragment automateEntryRequestExtractFull on AutomateEntryExtract {\n  __typename\n  name\n  raw\n}\n    ";
 export declare const CreatedAutomateTaskDocument = "\n    subscription createdAutomateTask {\n  createdAutomateTask {\n    automateTaskEdge {\n      ...automateTaskEdgeMeta\n    }\n    snapshot\n  }\n}\n    \n    fragment automateTaskEdgeMeta on AutomateTaskEdge {\n  node {\n    ...automateTaskMeta\n  }\n}\n    \n\n    fragment automateTaskMeta on AutomateTask {\n  id\n  paused\n  entry {\n    ...automateEntryMeta\n  }\n}\n    \n\n    fragment automateEntryMeta on AutomateEntry {\n  __typename\n  id\n  name\n  createdAt\n  session {\n    id\n  }\n}\n    ";
 export declare const DeletedAutomateTaskDocument = "\n    subscription deletedAutomateTask {\n  deletedAutomateTask {\n    deletedAutomateTaskId\n    snapshot\n    status\n  }\n}\n    ";
@@ -124195,6 +124228,7 @@ export declare function getSdk<C>(requester: Requester<C>): {
     pauseAutomateTask(variables: PauseAutomateTaskMutationVariables, options?: C): Promise<PauseAutomateTaskMutation>;
     resumeAutomateTask(variables: ResumeAutomateTaskMutationVariables, options?: C): Promise<ResumeAutomateTaskMutation>;
     startAutomateTask(variables: StartAutomateTaskMutationVariables, options?: C): Promise<StartAutomateTaskMutation>;
+    exportAutomateEntries(variables: ExportAutomateEntriesMutationVariables, options?: C): Promise<ExportAutomateEntriesMutation>;
     createdAutomateEntryRequest(variables?: CreatedAutomateEntryRequestSubscriptionVariables, options?: C): AsyncIterable<CreatedAutomateEntryRequestSubscription>;
     createdAutomateTask(variables?: CreatedAutomateTaskSubscriptionVariables, options?: C): AsyncIterable<CreatedAutomateTaskSubscription>;
     deletedAutomateTask(variables?: DeletedAutomateTaskSubscriptionVariables, options?: C): AsyncIterable<DeletedAutomateTaskSubscription>;

package/src/types/index.d.ts

@@ -2,11 +2,12 @@ import type { DefineComponent } from "vue";
 import type { HTTPQLEditorProps } from "./types/httpqlEditor";
 export { FooterSlot, type FooterSlotContent } from "./types/footer";
 export type { DialogOptions, DialogComponent } from "./types/window";
+export type { Editor } from "./types/editor";
 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, ReplaySessionKind, type ReplayPageContext, } from "./types/replay";
+export { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplaySelectedExchange, type ReplayWebSocketMessage, 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";

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

@@ -1,13 +1,23 @@
 import type { Extension } from "@codemirror/state";
 import type { AutomateEntry, AutomateSession } from "../types/automate";
-import type { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
+import type { RequestFull, RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { AddIndicatorOptions, ID, Indicator } from "../types/utils";
 /**
  * Utilities to interact with the Automate page.
  * @category Automate
  */
 export type AutomateSDK = {
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Add an extension to the request editor.
      * @param extension The extension to add.

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

@@ -1,7 +1,7 @@
 import type { Extension } from "@codemirror/state";
 import { type Finding } from "../types/findings";
-import type { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
+import type { RequestFull, RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { ID } from "../types/utils";
 /**
  * Utilities to interact with findings
@@ -24,6 +24,16 @@ export type FindingsSDK = {
         reporter: string;
         dedupeKey?: string;
     }) => Promise<Finding | undefined>;
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Add an extension to the request editor.
      * @param extension The extension to add.

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

@@ -1,7 +1,7 @@
 import type { Extension } from "@codemirror/state";
 import type { HTTPHistorySlotContent } from "../types/httpHistory";
-import type { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
+import type { RequestFull, RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { HTTPQL, ID } from "../types/utils";
 /**
@@ -24,6 +24,16 @@ export type HTTPHistorySDK = {
      * @returns The current scope ID.
      */
     getScopeId: () => ID | undefined;
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Set the current scope.
      * @param id The ID of the scope to set.

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

@@ -1,5 +1,5 @@
-import type { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
-import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
+import type { RequestFull, RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { ID } from "../types/utils";
 /**
  * Utilities to interact with the Intercept page.
@@ -11,6 +11,16 @@ export type InterceptSDK = {
      * @returns The current scope ID.
      */
     getScopeId: () => ID | undefined;
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Set the current scope.
      * @param scopeId The ID of the scope to set.

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

@@ -1,7 +1,7 @@
 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 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 AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySelectedExchange, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySessionKind, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
+import type { RequestFull, RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { ID, Indicator, ListenerHandle } from "../types/utils";
 import type { MessageViewModeOptions, MessageViewModeProps } from "../types/websocket";
@@ -63,6 +63,21 @@ export type ReplaySDK = {
      * ```
      */
     getCurrentEntry: () => ReplayEntry | undefined;
+    /**
+     * Get the currently selected Replay exchange.
+     * @returns The currently selected Replay exchange.
+     */
+    getSelectedExchange: () => ReplaySelectedExchange | undefined;
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Rename a session.
      * @param id The ID of the session to rename.

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

@@ -1,6 +1,6 @@
 import type { Extension } from "@codemirror/state";
-import type { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
+import type { RequestFull, RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { SearchSlot, SearchSlotContent } from "../types/search";
 import type { HTTPQL, ID } from "../types/utils";
 /**
@@ -23,6 +23,16 @@ export type SearchSDK = {
      * @returns The current scope ID.
      */
     getScopeId: () => ID | undefined;
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Set the current scope.
      * @param id The ID of the scope to set.

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

@@ -1,6 +1,6 @@
 import type { Extension } from "@codemirror/state";
-import type { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
+import type { RequestFull, RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseFull, ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { SitemapEntry, SitemapEntryChildStateUpdateEvent, SitemapRootEntry } from "../types/sitemap";
 import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
@@ -39,6 +39,16 @@ export type SitemapSDK = {
      * @returns The current scope ID.
      */
     getScopeId: () => ID | undefined;
+    /**
+     * Get the currently selected request.
+     * @returns The currently selected request.
+     */
+    getSelectedRequest: () => RequestFull | undefined;
+    /**
+     * Get the currently selected response.
+     * @returns The currently selected response.
+     */
+    getSelectedResponse: () => ResponseFull | undefined;
     /**
      * Set the current scope.
      * @param id The ID of the scope to set.

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

@@ -11,6 +11,16 @@ export type WindowSDK = {
      * @returns The active editor.
      */
     getActiveEditor: () => Editor | undefined;
+    /**
+     * Get the active request editor.
+     * @returns The active request editor.
+     */
+    getActiveRequestEditor: () => Editor | undefined;
+    /**
+     * Get the active response editor.
+     * @returns The active response editor.
+     */
+    getActiveResponseEditor: () => Editor | undefined;
     /**
      * Show a toast message.
      * @param message The message to show.

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

@@ -1,3 +1,5 @@
+import type { RequestFull } from "./request";
+import type { ResponseFull } from "./response";
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type SlotContentProps, type SlotContentPropsGroup } from "./slots";
 import { type AddIndicatorOptions, type ID, type Selection } from "./utils";
 /**
@@ -110,6 +112,35 @@ export type ReplayEntry = {
      */
     requestId?: ID;
 };
+/**
+ * The currently selected Replay exchange.
+ * @category Replay
+ */
+export type ReplaySelectedExchange = {
+    kind: typeof ReplaySessionKind.Http;
+    entryId: ID;
+    sessionId: ID;
+    request: RequestFull;
+    response?: ResponseFull;
+} | {
+    kind: typeof ReplaySessionKind.Ws;
+    entryId: ID;
+    sessionId: ID;
+    streamId?: ID;
+    activeTab: "http-upgrade" | "messages";
+    upgradeRequest?: RequestFull;
+    upgradeResponse?: ResponseFull;
+    message?: ReplayWebSocketMessage;
+};
+/**
+ * The currently edited WebSocket message in Replay.
+ * @category Replay
+ */
+export type ReplayWebSocketMessage = {
+    raw: string;
+    direction: "CLIENT" | "SERVER";
+    format: "BINARY" | "CLOSE" | "PING" | "PONG" | "TEXT";
+};
 /**
  * A collection in Replay.
  * @category Replay