@caido/sdk-frontend 0.56.1 → 0.56.3-beta.0

package/src/types/index.d.ts

@@ -1,6 +1,7 @@
 export { FooterSlot, type FooterSlotContent } from "./types/footer";
-export type { DialogOptions } from "./types/window";
+export type { DialogOptions, DialogComponent } from "./types/window";
 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 ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
@@ -9,21 +10,22 @@ export type { SitemapEntry, SitemapRootEntry, ChildState, } from "./types/sitema
 export { SearchSlot, type SearchSlotContent } from "./types/search";
 export type { HostedFile } from "./types/files";
 export { FilterSlot, type Filter, type FilterSlotContent, type CurrentFilterChangeEvent, } from "./types/filter";
-export type { HTTPQL, ID, ComponentDefinition, Selection } from "./types/utils";
+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 { 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, } from "./types/matchReplace";
+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";
 export { HTTPHistorySlot, type HTTPHistorySlotContent, } from "./types/httpHistory";
 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 { ListenerHandle, AddIndicatorOptions, Indicator, ComponentProps, ComponentPropsWithSdk, } from "./types/utils";
 export type { AIProvider, AILanguageModelSettings, AIReasoningSettings, AIUpstreamProvider, AIUpstreamProviderId, AIUpstreamProviderStatus, } 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";

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

@@ -1,7 +1,7 @@
 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 { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { AddIndicatorOptions, ID, Indicator } from "../types/utils";
 /**
  * Utilities to interact with the Automate page.
@@ -17,12 +17,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/backend.d.ts

@@ -1,11 +1,17 @@
-import { type BackendEndpoints, type BackendEvents } from "../types/backend";
+import { type BackendEndpoints, type BackendEvents, type BackendSpec } from "../types/backend";
 import type { PromisifiedReturnType } from "../types/utils";
+type ResolvedAPI<T> = T extends {
+    api: infer A;
+} ? A : T;
+type ResolvedEvents<T, E> = T extends {
+    events: infer A;
+} ? A : E;
 /**
  * Utilities to interact with the backend plugin.
  * @category Backend
  */
-export type BackendSDK<T extends BackendEndpoints, E extends BackendEvents> = {
-    [K in keyof T]: (...args: Parameters<T[K]>) => PromisifiedReturnType<T[K]>;
+export type BackendSDK<T extends BackendEndpoints | BackendSpec, E extends BackendEvents> = {
+    [K in keyof ResolvedAPI<T>]: (...args: Parameters<ResolvedAPI<T>[K]>) => PromisifiedReturnType<ResolvedAPI<T>[K]>;
 } & {
     /**
      * Subscribe to a backend event.
@@ -13,7 +19,8 @@ export type BackendSDK<T extends BackendEndpoints, E extends BackendEvents> = {
      * @param callback The callback to call when the event is emitted.
      * @returns An object with a `stop` method that can be called to stop listening to the event.
      */
-    onEvent: <K extends keyof E>(event: K, callback: E[K]) => {
+    onEvent: <K extends keyof ResolvedEvents<T, E>>(event: K, callback: ResolvedEvents<T, E>[K]) => {
         stop: () => void;
     };
 };
+export {};

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/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 { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { ID } from "../types/utils";
 /**
  * Utilities to interact with findings
@@ -33,10 +33,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 { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { HTTPQL, ID } from "../types/utils";
 /**
@@ -43,12 +43,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

@@ -1,6 +1,6 @@
 import type { Sdk as GraphqlSDK } from "../__generated__/graphql-sdk";
 import type { _AnalyticsSDK } from "../private/analytics";
-import { type BackendEndpoints, type BackendEvents } from "../types/backend";
+import { type BackendEndpoints, type BackendEvents, type BackendSpec } from "../types/backend";
 import type { AiSDK } from "./ai";
 import type { AssetsSDK } from "./assets";
 import type { AutomateSDK } from "./automate";
@@ -29,13 +29,14 @@ import type { SidebarSDK } from "./sidebar";
 import type { SitemapSDK } from "./sitemap";
 import type { StorageSDK } from "./storage";
 import type { UISDK } from "./ui";
+import type { WebsocketSDK } from "./websocket";
 import type { WindowSDK } from "./window";
 import type { WorkflowSDK } from "./workflows";
 /**
  * Utilities for frontend plugins.
  * @category SDK
  */
-export type API<T extends BackendEndpoints = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
+export type API<T extends BackendEndpoints | BackendSpec = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
     /**
      * Utilities to interact with the GraphQL API.
      */
@@ -160,6 +161,10 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with the settings page.
      */
     settings: SettingsSDK;
+    /**
+     * Utilities to interact with the Websocket page.
+     */
+    websocket: WebsocketSDK;
     /**
      * @private
      * Utilities to track analytics events.

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 { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { ID } from "../types/utils";
 /**
  * Utilities to interact with the Intercept page.
@@ -20,10 +20,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/matchReplace.d.ts

@@ -1,6 +1,6 @@
 import { type CurrentMatchReplaceRuleChangeEvent, type MatchReplaceCollection, type MatchReplaceRule, type MatchReplaceSection, type MatchReplaceSlotContent, type Source } from "../types/matchReplace";
 import { type DefineAddToSlotFn } from "../types/slots";
-import type { AddIndicatorOptions, HTTPQL, ID, Indicator, ListenerHandle } from "../types/utils";
+import type { AddIndicatorOptions, ID, Indicator, ListenerHandle, QueryInput } from "../types/utils";
 /**
  * Utilities to interact with the Match and Replace page.
  * @category Match and Replace
@@ -73,13 +73,13 @@ export type MatchReplaceSDK = {
      * Create a rule.
      * @param options - The options for the rule.
      * @param options.name - The name of the rule.
-     * @param options.query - The HTTPQL query to match the rule against.
+     * @param options.query - The query to match the rule against.
      * @param options.collectionId - The ID of the collection the rule belongs to.
      * @param options.sources - The sources the rule belongs to.
      */
     createRule: (options: {
         name: string;
-        query: HTTPQL;
+        query: QueryInput;
         section: MatchReplaceSection;
         collectionId: ID;
         sources: Array<Source>;
@@ -89,13 +89,13 @@ export type MatchReplaceSDK = {
      * @param id - The ID of the rule.
      * @param options - The new values for the rule.
      * @param options.name - The new name of the rule.
-     * @param options.query - The new HTTPQL query of the rule.
+     * @param options.query - The new query of the rule.
      * @param options.section - The new section of the rule.
      * @param options.sources - The new sources of the rule.
      */
     updateRule: (id: ID, options: {
         name: string;
-        query?: HTTPQL;
+        query?: QueryInput;
         section: MatchReplaceSection;
         sources: Array<Source>;
     }) => Promise<MatchReplaceRule>;

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

@@ -1,7 +1,7 @@
 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 { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
 import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
@@ -129,12 +129,12 @@ 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;
     /**
      * Send a request to the Replay backend.
      * @param request The request to send.
@@ -159,18 +159,12 @@ export type ReplaySDK = {
      * 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,
-     * });
+     * await sdk.replay.showEntry(sessionId, entryId);
      * ```
      */
-    showEntry: (sessionId: ID, entryId: ID, options?: {
-        overwriteDraft?: boolean;
-    }) => Promise<void>;
+    showEntry: (sessionId: ID, entryId: ID) => Promise<void>;
     /**
      * Get a replay entry by its ID.
      * @param entryId The ID of the entry to get.

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 { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { SearchSlot, SearchSlotContent } from "../types/search";
 import type { HTTPQL, ID } from "../types/utils";
 /**
@@ -37,12 +37,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 { RequestReadableViewModeProps, RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import type { SitemapEntry, SitemapEntryChildStateUpdateEvent, SitemapRootEntry } from "../types/sitemap";
 import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
@@ -53,12 +53,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

@@ -0,0 +1,12 @@
+import type { MessageViewModeOptions, MessageViewModeProps } from "../types/websocket";
+/**
+ * Utilities to interact with websockets
+ * @category Websockets
+ */
+export type WebsocketSDK = {
+    /**
+     * Add a custom message view mode.
+     * @param options The view mode options.
+     */
+    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
@@ -34,7 +34,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/backend.d.ts

@@ -12,3 +12,11 @@ export type BackendEndpoints = {
 export type BackendEvents = {
     [key: string]: (...args: any[]) => void;
 };
+/**
+ * A specification for the backend plugin.
+ * @category Backend
+ */
+export type BackendSpec = {
+    api: BackendEndpoints;
+    events: BackendEvents;
+};

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

@@ -1,6 +1,6 @@
 import { type ID, type Selection } from "./utils";
 /**
- * Represents a {@link https://docs.caido.io/reference/features/logging/findings|Finding}.
+ * Represents a {@link https://docs.caido.io/app/quickstart/findings.html|Finding}.
  * @category Findings
  */
 export type Finding = {

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;
 };

package/src/types/types/httpHistory.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 ID, type Selection } from "./utils";
 /**
  * The slots in the HTTP History UI.
@@ -11,8 +11,12 @@ export declare const HTTPHistorySlot: {
     readonly ToolbarPrimary: "toolbar-primary";
 };
 export type HTTPHistorySlot = (typeof HTTPHistorySlot)[keyof typeof HTTPHistorySlot];
-export type HTTPHistorySlotContent = {
-    [HTTPHistorySlot.ToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+/**
+ * Content that can be added to HTTP history slots.
+ * @category HTTP History
+ */
+export type HTTPHistorySlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in HTTPHistorySlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };
 /**
  * HTTP history page context.

package/src/types/types/matchReplace.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";
 /**
  * A rule in Match and Replace.
@@ -48,7 +48,7 @@ export type Source = (typeof Source)[keyof typeof Source];
  * A discriminated union of all possible match and replace sections.
  * @category Match and Replace
  */
-export type MatchReplaceSection = MatchReplaceSectionRequestAll | MatchReplaceSectionRequestBody | MatchReplaceSectionRequestFirstLine | MatchReplaceSectionRequestHeader | MatchReplaceSectionRequestMethod | MatchReplaceSectionRequestPath | MatchReplaceSectionRequestQuery | MatchReplaceSectionRequestSNI | MatchReplaceSectionResponseAll | MatchReplaceSectionResponseBody | MatchReplaceSectionResponseFirstLine | MatchReplaceSectionResponseHeader | MatchReplaceSectionResponseStatusCode;
+export type MatchReplaceSection = MatchReplaceSectionRequestAll | MatchReplaceSectionRequestBody | MatchReplaceSectionRequestFirstLine | MatchReplaceSectionRequestHeader | MatchReplaceSectionRequestMethod | MatchReplaceSectionRequestPath | MatchReplaceSectionRequestQuery | MatchReplaceSectionRequestSNI | MatchReplaceSectionResponseAll | MatchReplaceSectionResponseBody | MatchReplaceSectionResponseFirstLine | MatchReplaceSectionResponseHeader | MatchReplaceSectionResponseStatusCode | MatchReplaceSectionResponseWebsocket | MatchReplaceSectionRequestWebsocket;
 /**
  * A section for the entire request.
  * @category Match and Replace
@@ -100,6 +100,36 @@ export type MatchReplaceOperationStatusCodeUpdate = {
     kind: "OperationStatusCodeUpdate";
     replacer: MatchReplaceReplacer;
 };
+/**
+ * A section for the response websocket.
+ * @category Match and Replace
+ */
+export type MatchReplaceSectionResponseWebsocket = {
+    kind: "SectionResponseWebsocket";
+    operation: MatchReplaceOperationWebsocket;
+};
+/**
+ * A section for the request websocket.
+ * @category Match and Replace
+ */
+export type MatchReplaceSectionRequestWebsocket = {
+    kind: "SectionRequestWebsocket";
+    operation: MatchReplaceOperationWebsocket;
+};
+/**
+ * An operation for the response websocket section.
+ * @category Match and Replace
+ */
+export type MatchReplaceOperationWebsocket = KeepOperation<MatchReplaceOperationWebsocketRaw>;
+/**
+ * A raw operation for the response websocket section.
+ * @category Match and Replace
+ */
+export type MatchReplaceOperationWebsocketRaw = {
+    kind: "OperationWebsocketRaw";
+    matcher: MatchReplaceMatcherRaw;
+    replacer: MatchReplaceReplacer;
+};
 /**
  * A section for the request query string.
  * @category Match and Replace
@@ -418,9 +448,8 @@ export type MatchReplaceSlot = (typeof MatchReplaceSlot)[keyof typeof MatchRepla
  * Content that can be added to match and replace slots.
  * @category Match and Replace
  */
-export type MatchReplaceSlotContent = {
-    [MatchReplaceSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    [MatchReplaceSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+export type MatchReplaceSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in MatchReplaceSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };
 /**
  * Event fired when the current match and replace rule changes.