@caido/sdk-frontend 0.57.1 → 0.57.2-beta.1

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 } from "./types/window";
+export type { DialogOptions, DialogComponent } from "./types/window";
+export type { Editor } from "./types/editor";
 export type { _AnalyticsSDK } from "./private/analytics";
-export type { MessageViewModeOptions, StreamWsMessageMeta, } from "./types/websocket";
+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 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";
@@ -12,9 +15,9 @@ export type { HostedFile } from "./types/files";
 export { FilterSlot, type Filter, type FilterSlotContent, type CurrentFilterChangeEvent, } from "./types/filter";
 export type { HTTPQL, StreamQL, ID, ComponentDefinition, Selection, QueryInput, } from "./types/utils";
 export type { JSONValue, JSONCompatible } from "./types/json";
-export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, } from "./types/slots";
-export type { RequestViewModeOptions, RequestFull, RequestDraft, RequestMeta, } from "./types/request";
-export type { ResponseViewModeOptions, ResponseFull } from "./types/response";
+export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, SlotContentPropsInternal, SlotContentProps, } from "./types/slots";
+export type { RequestViewModeOptions, RequestWritableViewModeProps, RequestReadableViewModeProps, RequestReadableViewModePropsInternal, RequestWritableViewModePropsInternal, RequestViewModeProps, RequestFull, RequestDraft, RequestMeta, } from "./types/request";
+export type { ResponseViewModePropsInternal, ResponseViewModeOptions, ResponseViewModeProps, ResponseFull, } from "./types/response";
 export type { CurrentMatchReplaceRuleChangeEvent, MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestAll, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionRequestSNI, MatchReplaceSectionResponseAll, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationAll, MatchReplaceOperationAllRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceOperationSNI, MatchReplaceOperationSNIRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, MatchReplaceSectionResponseWebsocket, MatchReplaceSectionRequestWebsocket, MatchReplaceOperationWebsocket, MatchReplaceOperationWebsocketRaw, } from "./types/matchReplace";
 export { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
 export { ScopeSlot, type CurrentScopeChangeEvent, type Scope, type ScopeSlotContent, } from "./types/scopes";
@@ -22,9 +25,10 @@ export { HTTPHistorySlot, type HTTPHistorySlotContent, } from "./types/httpHisto
 export { SettingsSlot, type SettingsSlotContent, type SettingsPluginSlotContent, } from "./types/settings";
 export type { EnvironmentVariable } from "./types/environment";
 export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./types/workflows";
-export type { ListenerHandle, AddIndicatorOptions, Indicator, } from "./types/utils";
-export type { AIProvider, AILanguageModelSettings, AIReasoningSettings, AIUpstreamProvider, AIUpstreamProviderId, AIUpstreamProviderStatus, } from "./types/ai";
+export type { ListenerHandle, AddIndicatorOptions, Indicator, ComponentProps, ComponentPropsWithSdk, } from "./types/utils";
+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";
 export type { LogSDK } from "./sdks/log";
 export type { API } from "./sdks";
@@ -42,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 { RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions } 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.
@@ -17,12 +27,12 @@ export type AutomateSDK = {
      * Add a custom request view mode.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestReadableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
     /**
      * Get the list of all automate sessions.
      * @returns The list of all automate sessions.

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

@@ -1,3 +1,4 @@
+import { type CommandPaletteViewProps } from "../types/commandPalette";
 import { type CommandID } from "../types/commands";
 import { type ComponentDefinition } from "../types/utils";
 /**
@@ -6,7 +7,7 @@ import { type ComponentDefinition } from "../types/utils";
  */
 export type CommandPaletteView = {
     type: "Custom";
-    definition: ComponentDefinition;
+    definition: ComponentDefinition<CommandPaletteViewProps>;
 };
 /**
  * Utilities to interact with the command palette.

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

@@ -1,5 +1,5 @@
-import { type ListenerHandle } from "src/types/utils";
 import { type HostedFile } from "../types/files";
+import { type ListenerHandle } from "../types/utils";
 /**
  * SDK for interacting with the Files page.
  * @category Files

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 { RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions } 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.
@@ -33,10 +43,10 @@ export type FindingsSDK = {
      * Add a custom request view mode.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestReadableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
 };

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 { RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions } 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.
@@ -43,12 +53,12 @@ export type HTTPHistorySDK = {
      * Add a custom request view mode.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestReadableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
     /**
      * Scrolls the HTTP History table to a specific entry.
      * @param id The ID of the entry to scroll to.

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 } from "../types/request";
-import type { ResponseViewModeOptions } 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.
@@ -20,10 +30,10 @@ export type InterceptSDK = {
      * Add a custom request view mode.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestWritableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
 };

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

@@ -1,9 +1,10 @@
 import { type Extension } from "@codemirror/state";
-import { 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 } from "../types/request";
-import type { ResponseViewModeOptions } 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 { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
+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.
@@ -44,6 +49,35 @@ export type ReplaySDK = {
      * ```
      */
     getCurrentSession: () => ReplaySession | undefined;
+    /**
+     * Get the entry currently displayed in the active replay session.
+     * @returns The active entry, or undefined if no entry is currently loaded.
+     * @example
+     * ```ts
+     * const currentEntry = sdk.replay.getCurrentEntry();
+     * if (currentEntry) {
+     *   console.log(`Currently viewing entry ${currentEntry.id}`);
+     * } else {
+     *   console.log("No entry is currently displayed");
+     * }
+     * ```
+     */
+    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.
@@ -65,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.
@@ -129,12 +175,17 @@ export type ReplaySDK = {
      * Add a custom view mode for requests.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestWritableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    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.
@@ -235,11 +286,30 @@ export type ReplaySDK = {
      * const indicator = sdk.replay.addSessionIndicator(sessionId, {
      *   icon: "fas fa-exclamation-triangle",
      *   description: "Security warning",
+     *   showTabIcon: true,
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addSessionIndicator: (sessionId: ID, indicator: AddSessionIndicatorOptions) => Indicator;
+    /**
+     * Add an indicator to a replay collection.
+     * Indicators are displayed next to the collection name in the collections tree.
+     * @param collectionId The ID of the collection to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.replay.addCollectionIndicator(collectionId, {
+     *   icon: "fas fa-folder-open",
+     *   description: "Has unresolved findings",
      * });
      *
      * // Later, remove the indicator
      * indicator.remove();
      *
      */
-    addSessionIndicator: (sessionId: ID, indicator: AddIndicatorOptions) => Indicator;
+    addCollectionIndicator: (collectionId: ID, indicator: AddCollectionIndicatorOptions) => Indicator;
 };

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

@@ -1,6 +1,6 @@
 import type { Extension } from "@codemirror/state";
-import type { RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions } 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.
@@ -37,12 +47,12 @@ export type SearchSDK = {
      * Add a custom request view mode.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestReadableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
     /**
      * Scrolls the Search table to a specific request.
      * @param id The ID of the request to scroll to.

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

@@ -1,6 +1,6 @@
 import type { Extension } from "@codemirror/state";
-import type { RequestViewModeOptions } from "../types/request";
-import type { ResponseViewModeOptions } 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.
@@ -53,12 +63,12 @@ export type SitemapSDK = {
      * Add a custom request view mode.
      * @param options The view mode options.
      */
-    addRequestViewMode: (options: RequestViewModeOptions) => void;
+    addRequestViewMode: (options: RequestViewModeOptions<RequestReadableViewModeProps>) => void;
     /**
      * Add a custom response view mode.
      * @param options The view mode options.
      */
-    addResponseViewMode: (options: ResponseViewModeOptions) => void;
+    addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void;
     /**
      * Add an indicator to a sitemap session.
      * Indicators are displayed next to the entry name in the collections tree.

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

@@ -1,4 +1,4 @@
-import type { MessageViewModeOptions } from "../types/websocket";
+import type { MessageViewModeOptions, MessageViewModeProps } from "../types/websocket";
 /**
  * Utilities to interact with websockets
  * @category Websockets
@@ -8,5 +8,5 @@ export type WebsocketSDK = {
      * Add a custom message view mode.
      * @param options The view mode options.
      */
-    addMessageViewMode: (options: MessageViewModeOptions) => void;
+    addMessageViewMode: (options: MessageViewModeOptions<MessageViewModeProps>) => void;
 };

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

@@ -1,6 +1,6 @@
 import type { Editor } from "../types/editor";
-import type { ComponentDefinition, ListenerHandle } from "../types/utils";
-import { type Dialog, type DialogOptions, type GlobalContext } from "../types/window";
+import type { ListenerHandle } from "../types/utils";
+import { type Dialog, type DialogComponent, type DialogOptions, type GlobalContext } from "../types/window";
 /**
  * Utilities to interact with the active page.
  * @category Window
@@ -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.
@@ -34,7 +44,7 @@ export type WindowSDK = {
      * @param options.closable Whether the close icon is hidden . Defaults to false
      * @returns A dialog object that can be used to close the dialog.
      */
-    showDialog: (component: ComponentDefinition, options?: DialogOptions) => Dialog;
+    showDialog: (component: DialogComponent, options?: DialogOptions) => Dialog;
     /**
      * Get the current global context.
      * @returns The current global context.

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

@@ -0,0 +1,22 @@
+import { type API } from "../sdks";
+/**
+ * The internal props for the command palette view.
+ * @category Command Palette
+ */
+export type CommandPaletteViewPropsInternal = {
+    /**
+     * The function to call when the command palette is closed.
+     */
+    onClose: () => void;
+    /**
+     * The function to call when the command palette is backed.
+     */
+    onBack: () => void;
+};
+/**
+ * The props for the command palette view.
+ * @category Command Palette
+ */
+export type CommandPaletteViewProps = CommandPaletteViewPropsInternal & {
+    sdk: API;
+};

package/src/types/types/filter.d.ts

@@ -1,4 +1,4 @@
-import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type SlotContentProps, type SlotContentPropsGroup } from "./slots";
 import { type HTTPQL, type ID, type Selection } from "./utils";
 /**
  * Represents a filter.
@@ -42,9 +42,8 @@ export type FilterSlot = (typeof FilterSlot)[keyof typeof FilterSlot];
  * Content that can be added to filter slots.
  * @category Filter
  */
-export type FilterSlotContent = {
-    [FilterSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    [FilterSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+export type FilterSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in FilterSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };
 /**
  * Event fired when the current filter changes.

package/src/types/types/footer.d.ts

@@ -1,4 +1,4 @@
-import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type SlotContentProps, type SlotContentPropsGroup } from "./slots";
 /**
  * The slots in the Footer UI.
  * @category Footer
@@ -12,7 +12,6 @@ export type FooterSlot = (typeof FooterSlot)[keyof typeof FooterSlot];
  * Content that can be added to footer slots.
  * @category Footer
  */
-export type FooterSlotContent = {
-    [FooterSlot.FooterSlotPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    [FooterSlot.FooterSlotSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+export type FooterSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in FooterSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };