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

package/package.json

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

package/src/types/index.d.ts

@@ -1,7 +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, } 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";
@@ -12,9 +12,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 +22,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 { 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/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/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/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.

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

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

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.
@@ -448,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.

package/src/types/types/replay.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 connection information to use for the request.
@@ -42,10 +42,12 @@ export declare const ReplaySlot: {
     readonly Topbar: "topbar";
 };
 export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
-export type ReplaySlotContent = {
-    [ReplaySlot.SessionToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    [ReplaySlot.SessionToolbarSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    [ReplaySlot.Topbar]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+/**
+ * Content that can be added to replay slots.
+ * @category Replay
+ */
+export type ReplaySlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in ReplaySlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };
 /**
  * Options for opening a tab.

package/src/types/types/request.d.ts

@@ -1,3 +1,5 @@
+import { type EditorView } from "@codemirror/view";
+import { type API } from "../sdks";
 import { type As, type ComponentDefinition, type ID, type Prettify } from "./utils";
 /**
  * A draft request that has not yet been saved to the database.
@@ -38,11 +40,47 @@ export type RequestFull = Prettify<As<"RequestFull"> & {
     streamId: ID | undefined;
     raw: string;
 }>;
+/**
+ * The internal props for the request read-only view mode.
+ * @category Request
+ */
+export type RequestReadableViewModePropsInternal = {
+    request: RequestFull;
+    view: EditorView;
+};
+/**
+ * The internal props for the request writable view mode.
+ * @category Request
+ */
+export type RequestWritableViewModePropsInternal = {
+    request: RequestFull | undefined;
+    draft: RequestDraft;
+    view: EditorView;
+};
+/**
+ * The props for the request writable view mode.
+ * @category Request
+ */
+export type RequestWritableViewModeProps = RequestWritableViewModePropsInternal & {
+    sdk: API;
+};
+/**
+ * The props for the request read-only view mode.
+ * @category Request
+ */
+export type RequestReadableViewModeProps = RequestReadableViewModePropsInternal & {
+    sdk: API;
+};
+/**
+ * The props group for the request view mode.
+ * @category Request
+ */
+export type RequestViewModeProps = RequestReadableViewModeProps | RequestWritableViewModeProps | RequestReadableViewModePropsInternal | RequestWritableViewModePropsInternal;
 /**
  * Options for defining a custom request view mode.
  * @category Request
  */
-export type RequestViewModeOptions = {
+export type RequestViewModeOptions<TProps extends RequestViewModeProps> = {
     /**
      * The label of the view mode.
      */
@@ -50,7 +88,7 @@ export type RequestViewModeOptions = {
     /**
      * The component to render when the view mode is selected.
      */
-    view: ComponentDefinition;
+    view: ComponentDefinition<TProps>;
     /**
      * A function that determines if the view mode should be shown for a given request.
      */

package/src/types/types/response.d.ts

@@ -1,3 +1,5 @@
+import { type EditorView } from "@codemirror/view";
+import { type API } from "../sdks";
 import type { RequestFull, RequestMeta } from "./request";
 import type { As, ComponentDefinition, ID, Prettify } from "./utils";
 /**
@@ -12,11 +14,26 @@ export type ResponseFull = Prettify<As<"ResponseFull"> & {
     length: number;
     createdAt: Date;
 }>;
+/**
+ * The internal props for the response view mode.
+ * @category Response
+ */
+export type ResponseViewModePropsInternal = {
+    response: ResponseFull;
+    view: EditorView;
+};
+/**
+ * The props for the response view mode.
+ * @category Response
+ */
+export type ResponseViewModeProps = ResponseViewModePropsInternal & {
+    sdk: API;
+};
 /**
  * Options for defining a custom response view mode.
  * @category Response
  */
-export type ResponseViewModeOptions = {
+export type ResponseViewModeOptions<TProps extends ResponseViewModeProps | ResponseViewModePropsInternal> = {
     /**
      * The label of the view mode.
      */
@@ -24,7 +41,7 @@ export type ResponseViewModeOptions = {
     /**
      * The component to render when the view mode is selected.
      */
-    view: ComponentDefinition;
+    view: ComponentDefinition<TProps>;
     /**
      * A function that determines if the view mode should be shown for a given response.
      */

package/src/types/types/scopes.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";
 /**
  * Represents a scope.
@@ -37,9 +37,12 @@ export declare const ScopeSlot: {
     readonly CreateHeader: "create-header";
 };
 export type ScopeSlot = (typeof ScopeSlot)[keyof typeof ScopeSlot];
-export type ScopeSlotContent = {
-    [ScopeSlot.UpdateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    [ScopeSlot.CreateHeader]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+/**
+ * Content that can be added to scope slots.
+ * @category Scopes
+ */
+export type ScopeSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in ScopeSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };
 /**
  * Event fired when the current scope changes.

package/src/types/types/search.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 Search UI.
  * @category Search
@@ -10,8 +10,12 @@ export declare const SearchSlot: {
     readonly ToolbarPrimary: "search-toolbar-primary";
 };
 export type SearchSlot = (typeof SearchSlot)[keyof typeof SearchSlot];
-export type SearchSlotContent = {
-    [SearchSlot.ToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+/**
+ * Content that can be added to search slots.
+ * @category Search
+ */
+export type SearchSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = {
+    [K in SearchSlot]: ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 };
 /**
  * Search page context.

package/src/types/types/slots.d.ts

@@ -1,8 +1,26 @@
+import { type API } from "../sdks";
 import { type CommandID } from "./commands";
 import { type ComponentDefinition, type Prettify } from "./utils";
 type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = Prettify<{
     type: TType;
 } & P>;
+/**
+ * The internal props for a slot content.
+ * @category Slots
+ */
+export type SlotContentPropsInternal = {};
+/**
+ * The props for a slot content.
+ * @category Slots
+ */
+export type SlotContentProps = SlotContentPropsInternal & {
+    sdk: API;
+};
+/**
+ * The props group for a slot content.
+ * @category Slots
+ */
+export type SlotContentPropsGroup = SlotContentProps | SlotContentPropsInternal;
 /**
  * Content for a button slot.
  * @category Slots
@@ -16,8 +34,8 @@ export type ButtonSlotContent = DefineSlotContent<"Button", {
  * Content for a custom component slot.
  * @category Slots
  */
-export type CustomSlotContent = DefineSlotContent<"Custom", {
-    definition: ComponentDefinition;
+export type CustomSlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = DefineSlotContent<"Custom", {
+    definition: ComponentDefinition<TProps>;
 }>;
 /**
  * Content for a command slot.
@@ -31,7 +49,7 @@ export type CommandSlotContent = DefineSlotContent<"Command", {
  * Union type of all possible slot content types.
  * @category Slots
  */
-export type SlotContent = ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+export type SlotContent<TProps extends SlotContentPropsGroup = SlotContentProps> = ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent;
 /**
  * A function type for adding content to slots.
  * @category Slots

package/src/types/types/utils.d.ts

@@ -1,4 +1,5 @@
 import { type Component as VueComponent } from "vue";
+import { type API } from "../index";
 /**
  * A unique Caido identifier per type.
  * @category Utils
@@ -37,13 +38,25 @@ export type QueryInput = HTTPQL | StreamQL;
 export type Icon = string & {
     __icon?: never;
 };
+/**
+ * A set of properties that can be passed to a component.
+ * @category Utils
+ */
+export type ComponentProps = Record<string, unknown>;
+/**
+ * A set of properties that can be passed to a component definition with the SDK.
+ * @category Utils
+ */
+export type ComponentPropsWithSdk<TProps extends ComponentProps> = TProps & {
+    sdk: API;
+};
 /**
  * A custom component that will be rendered in the UI.
  * @category Utils
  */
-export type ComponentDefinition = {
-    component: VueComponent;
-    props?: Record<string, unknown>;
+export type ComponentDefinition<TProps = ComponentProps> = {
+    component: VueComponent<TProps>;
+    props?: ComponentProps;
     events?: Record<string, (...args: unknown[]) => void>;
 };
 /**

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

@@ -1,4 +1,5 @@
-import type { As, ComponentDefinition, ID, Prettify } from "./utils";
+import { type EditorView } from "@codemirror/view";
+import type { As, ComponentDefinition, ComponentPropsWithSdk, ID, Prettify } from "./utils";
 /**
  * Certificate page context.
  * @category Websockets
@@ -21,11 +22,24 @@ export type StreamWsMessageMeta = Prettify<As<"StreamWsMessageMeta"> & {
         createdAt: Date;
     };
 }>;
+/**
+ * The internal props for the message view mode.
+ * @category Websockets
+ */
+export type MessageViewModePropsInternal = {
+    message: StreamWsMessageMeta;
+    view: EditorView;
+};
+/**
+ * The props for the message view mode.
+ * @category Websockets
+ */
+export type MessageViewModeProps = ComponentPropsWithSdk<MessageViewModePropsInternal>;
 /**
  * Options for defining a custom message view mode.
  * @category Websockets
  */
-export type MessageViewModeOptions = {
+export type MessageViewModeOptions<TProps extends MessageViewModeProps | MessageViewModePropsInternal> = {
     /**
      * The label of the view mode.
      */
@@ -33,7 +47,7 @@ export type MessageViewModeOptions = {
     /**
      * The component to render when the view mode is selected.
      */
-    view: ComponentDefinition;
+    view: ComponentDefinition<TProps>;
     /**
      * A function that determines if the view mode should be shown for a given message.
      */

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

@@ -15,6 +15,7 @@ import type { ReplayPageContext } from "./replay";
 import type { ScopePageContext } from "./scopes";
 import type { SearchPageContext } from "./search";
 import type { SitemapPageContext } from "./sitemap";
+import type { ComponentDefinition, ComponentProps, ComponentPropsWithSdk } from "./utils";
 import { type WebsocketPageContext } from "./websocket";
 import type { WorkflowsPageContext } from "./workflows";
 /**
@@ -29,6 +30,11 @@ export type DialogOptions = {
     modal?: boolean;
     position?: "left" | "right" | "top" | "bottom" | "center" | "topleft" | "topright" | "bottomleft" | "bottomright";
 };
+/**
+ * The component definition for a dialog.
+ * @category Window
+ */
+export type DialogComponent = ComponentDefinition<ComponentPropsWithSdk<ComponentProps>>;
 /**
  * A dialog instance that can be closed programmatically.
  * @category Window