@caido/sdk-frontend 0.55.4-beta.7 → 0.56.0

package/src/types/index.d.ts

@@ -1,7 +1,6 @@
 export { FooterSlot, type FooterSlotContent } from "./types/footer";
 export type { DialogOptions } from "./types/window";
 export type { _AnalyticsSDK } from "./private/analytics";
-export type { MessageViewModeOptions, StreamWsMessageMeta, } 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";
@@ -10,12 +9,12 @@ 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, StreamQL, ID, ComponentDefinition, Selection, QueryInput, } from "./types/utils";
+export type { HTTPQL, ID, ComponentDefinition, Selection } 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, MatchReplaceSectionResponseWebsocket, MatchReplaceSectionRequestWebsocket, MatchReplaceOperationWebsocket, MatchReplaceOperationWebsocketRaw, } from "./types/matchReplace";
+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 { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
 export { ScopeSlot, type CurrentScopeChangeEvent, type Scope, type ScopeSlotContent, } from "./types/scopes";
 export { HTTPHistorySlot, type HTTPHistorySlotContent, } from "./types/httpHistory";

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

@@ -29,7 +29,6 @@ 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";
 /**
@@ -161,10 +160,6 @@ 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/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, ID, Indicator, ListenerHandle, QueryInput } from "../types/utils";
+import type { AddIndicatorOptions, HTTPQL, ID, Indicator, ListenerHandle } 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 query to match the rule against.
+     * @param options.query - The HTTPQL 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: QueryInput;
+        query: HTTPQL;
         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 query of the rule.
+     * @param options.query - The new HTTPQL 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?: QueryInput;
+        query?: HTTPQL;
         section: MatchReplaceSection;
         sources: Array<Source>;
     }) => Promise<MatchReplaceRule>;

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

@@ -159,12 +159,18 @@ 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);
+     * await sdk.replay.showEntry(sessionId, entryId, {
+     *   overwriteDraft: true,
+     * });
      * ```
      */
-    showEntry: (sessionId: ID, entryId: ID) => Promise<void>;
+    showEntry: (sessionId: ID, entryId: ID, options?: {
+        overwriteDraft?: boolean;
+    }) => Promise<void>;
     /**
      * Get a replay entry by its ID.
      * @param entryId The ID of the entry to get.

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/app/quickstart/findings.html|Finding}.
+ * Represents a {@link https://docs.caido.io/reference/features/logging/findings|Finding}.
  * @category Findings
  */
 export type Finding = {

package/src/types/types/matchReplace.d.ts

@@ -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 | MatchReplaceSectionResponseWebsocket | MatchReplaceSectionRequestWebsocket;
+export type MatchReplaceSection = MatchReplaceSectionRequestAll | MatchReplaceSectionRequestBody | MatchReplaceSectionRequestFirstLine | MatchReplaceSectionRequestHeader | MatchReplaceSectionRequestMethod | MatchReplaceSectionRequestPath | MatchReplaceSectionRequestQuery | MatchReplaceSectionRequestSNI | MatchReplaceSectionResponseAll | MatchReplaceSectionResponseBody | MatchReplaceSectionResponseFirstLine | MatchReplaceSectionResponseHeader | MatchReplaceSectionResponseStatusCode;
 /**
  * A section for the entire request.
  * @category Match and Replace
@@ -100,36 +100,6 @@ 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

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

@@ -1,28 +1,5 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
 import { type ID, type Selection } from "./utils";
-/**
- * The connection information to use for the request.
- * @category Replay
- */
-type ConnectionInfo = {
-    /**
-     * The host to use for the request.
-     */
-    host: string;
-    /**
-     * The port to use for the request.
-     */
-    port: number;
-    /**
-     * Whether the request is TLS.
-     */
-    isTLS: boolean;
-    /**
-     * The SNI to use for the request.
-     * If not provided, the SNI will be inferred from the host.
-     */
-    SNI?: string;
-};
 /**
  * The slots in the Replay UI.
  * @category Replay
@@ -131,6 +108,49 @@ export type ReplayCollection = {
  * @category Replay
  */
 export type SendRequestOptions = {
+    /**
+     * The connection information to use for the request.
+     */
+    connectionInfo: {
+        /**
+         * The host to use for the request.
+         */
+        host: string;
+        /**
+         * The port to use for the request.
+         */
+        port: number;
+        /**
+         * Whether the request is TLS.
+         */
+        isTLS: boolean;
+        /**
+         * The SNI to use for the request.
+         * If not provided, the SNI will be inferred from the host.
+         */
+        SNI?: string;
+    };
+    /**
+     * The raw request to send.
+     */
+    raw: string;
+    /**
+     * Whether to update the content length automatically to match the body.
+     * Defaults to true.
+     */
+    updateContentLength?: boolean;
+    /**
+     * Whether to force close the connection by setting Connection: close header.
+     * Defaults to true.
+     */
+    connectionClose?: boolean;
+    /**
+     * Whether to overwrite the editor's draft content.
+     * If true, draft content will be overwritten with the new request.
+     * If false, the draft will be kept.
+     * Defaults to true.
+     */
+    overwriteDraft?: boolean;
     /**
      * Whether to send the request in the background without updating the UI.
      * If true, the request will not update the UI.
@@ -163,7 +183,7 @@ export type SendRequestOptions = {
 export type RequestSource = {
     type: "Raw";
     raw: string;
-    connectionInfo: ConnectionInfo;
+    connectionInfo: SendRequestOptions["connectionInfo"];
 } | {
     type: "ID";
     id: string;

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

@@ -14,21 +14,6 @@ export type ID = string & {
 export type HTTPQL = string & {
     __httpql?: never;
 };
-/**
- * A STREAMQL expression.
- * @example `ws.raw.cont:"hello"`
- * @category Utils
- */
-export type StreamQL = string & {
-    __streamql?: never;
-};
-/**
- * A query input.
- * @example `"req.method.eq:'POST'"`
- * @example `"ws.raw.cont:'hello'"`
- * @category Utils
- */
-export type QueryInput = HTTPQL | StreamQL;
 /**
  * A {@link https://fontawesome.com/icons|FontAwesome} icon class.
  * @example "fas fa-rocket"

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

@@ -1,4 +1,3 @@
-import type { As, ComponentDefinition, ID, Prettify } from "./utils";
 /**
  * Certificate page context.
  * @category Websockets
@@ -6,36 +5,3 @@ import type { As, ComponentDefinition, ID, Prettify } from "./utils";
 export type WebsocketPageContext = {
     kind: "Websocket";
 };
-/**
- * A complete message with all metadata and raw content.
- * @category Websockets
- */
-export type StreamWsMessageMeta = Prettify<As<"StreamWsMessageMeta"> & {
-    id: ID;
-    streamId: ID;
-    head: {
-        id: ID;
-        length: number;
-        direction: "CLIENT" | "SERVER";
-        format: "BINARY" | "CLOSE" | "PING" | "PONG" | "TEXT";
-        createdAt: Date;
-    };
-}>;
-/**
- * Options for defining a custom message view mode.
- * @category Websockets
- */
-export type MessageViewModeOptions = {
-    /**
-     * The label of the view mode.
-     */
-    label: string;
-    /**
-     * The component to render when the view mode is selected.
-     */
-    view: ComponentDefinition;
-    /**
-     * A function that determines if the view mode should be shown for a given message.
-     */
-    when?: (message: StreamWsMessageMeta) => boolean;
-};

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

@@ -1,12 +0,0 @@
-import type { MessageViewModeOptions } 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) => void;
-};