@caido/sdk-frontend 0.58.2 → 0.58.3-beta.0

package/src/types/index.d.ts

@@ -1,10 +1,13 @@
+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, } 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";
@@ -23,7 +26,7 @@ export { SettingsSlot, type SettingsSlotContent, type SettingsPluginSlotContent,
 export type { EnvironmentVariable } from "./types/environment";
 export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./types/workflows";
 export type { ListenerHandle, AddIndicatorOptions, Indicator, ComponentProps, ComponentPropsWithSdk, } from "./types/utils";
-export type { AIProvider, AILanguageModelSettings, AIReasoningSettings, AIUpstreamProvider, AIUpstreamProviderId, AIUpstreamProviderStatus, } from "./types/ai";
+export type { AIProvider, AILanguageModelSettings, AIReasoningSettings, AIUpstreamProvider, AIUpstreamProviderApi, AIUpstreamProviderId, } from "./types/ai";
 export type { SelectedProjectChangeEvent } from "./types/projects";
 export type { CommandPaletteViewProps, CommandPaletteViewPropsInternal, } from "./types/commandPalette";
 export type { CommandPaletteView } from "./sdks/commandPalette";
@@ -43,9 +46,12 @@ 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";
 export type { MatchReplacePageContext } from "./types/matchReplace";
 export type { WorkflowsPageContext } from "./types/workflows";
+export type { HTTPQLEditorProps };
+export declare const HTTPQLEditor: DefineComponent<HTTPQLEditorProps & {
+    modelValue?: string;
+}>;

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

@@ -10,8 +10,8 @@ export type AiSDK = {
      */
     createProvider: () => AIProvider;
     /**
-     * Gets the list of upstream AI providers with their configuration status.
-     * @returns An array of AI upstream providers with their configuration status.
+     * Gets the list of configured upstream AI providers.
+     * @returns An array of configured AI upstream providers.
      */
     getUpstreamProviders: () => AIUpstreamProvider[];
 };

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/index.d.ts

@@ -39,6 +39,23 @@ import type { WorkflowSDK } from "./workflows";
 export type API<T extends BackendEndpoints | BackendSpec = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
     /**
      * Utilities to interact with the GraphQL API.
+     *
+     * Queries and mutations return a promise; subscriptions return an
+     * `AsyncIterable`. On success they resolve with the response data or yield
+     * it. On failure (network error or any GraphQL errors returned by the
+     * server) the promise rejects, or the iterator throws into the `for await`
+     * loop, with the underlying error. Failures can be handled with `try`/
+     * `catch` or `.catch()`.
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const result = await sdk.graphql.automateEntry({ id: "1" });
+     *   // use result
+     * } catch (err) {
+     *   // err.message, err.graphQLErrors, err.networkError
+     * }
+     * ```
      */
     graphql: GraphqlSDK;
     /**

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,9 +1,10 @@
 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 { 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";
 /**
  * Utilities to interact with Replay.
  * @category Replay
@@ -27,9 +28,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.
@@ -58,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.
@@ -79,10 +99,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.
@@ -149,6 +181,11 @@ export type ReplaySDK = {
      * @param options The view mode options.
      */
     addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
+    /**
+     * Add a custom WebSocket message view mode.
+     * @param options The view mode options.
+     */
+    addWebsocketMessageViewMode: (options: MessageViewModeOptions<MessageViewModeProps>) => void;
     /**
      * Send a request to the Replay backend.
      * @param request The request to send.

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/ai.d.ts

@@ -26,19 +26,18 @@ export type AIProvider = ProviderV3 & ((modelId: string, settings?: AILanguageMo
  * AI upstream provider ID.
  * @category AI
  */
-export type AIUpstreamProviderId = "anthropic" | "google" | "openai" | "openrouter";
+export type AIUpstreamProviderId = string;
+/**
+ * The response API a provider speaks.
+ * @category AI
+ */
+export type AIUpstreamProviderApi = "ANTHROPIC" | "GEMINI" | "OPENAI_COMPLETION" | "OPENAI_RESPONSE" | "OPENROUTER";
 /**
  * AI upstream provider information.
+ * Only configured providers are returned.
  * @category AI
  */
 export type AIUpstreamProvider = {
     id: AIUpstreamProviderId;
-    status: AIUpstreamProviderStatus;
+    api: AIUpstreamProviderApi;
 };
-/**
- * AI upstream provider status.
- * Ready: The upstream provider is ready to use.
- * Missing: The upstream provider is not configured.
- * @category AI
- */
-export type AIUpstreamProviderStatus = "Ready" | "Missing";

package/src/types/types/httpqlEditor.d.ts

@@ -0,0 +1,3 @@
+export type HTTPQLEditorProps = {
+    isReadOnly?: boolean;
+};

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
@@ -224,6 +255,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