@caido/sdk-frontend 0.54.2-beta.3 → 0.54.2-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.54.2-beta.3",
+  "version": "0.54.2-beta.4",
   "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

@@ -12,6 +12,7 @@ export type { HTTPQL, ID, ComponentDefinition } 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 { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
 export { ScopeSlot, type CurrentScopeChangeEvent, type Scope, type ScopeSlotContent, } from "./types/scopes";

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

@@ -2,6 +2,7 @@ import type { Extension } from "@codemirror/state";
 import type { AutomateEntry, AutomateSession } from "src/types/automate";
 import type { AddIndicatorOptions, ID, Indicator } from "src/types/utils";
 import type { RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions } from "../types/response";
 /**
  * Utilities to interact with the Automate page.
  * @category Automate
@@ -17,6 +18,11 @@ export type AutomateSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add a custom response view mode.
+     * @param options The view mode options.
+     */
+    addResponseViewMode: (options: ResponseViewModeOptions) => void;
     /**
      * Get the list of all automate sessions.
      * @returns The list of all automate sessions.

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

@@ -1,6 +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 { ID } from "../types/utils";
 /**
  * Utilities to interact with findings
@@ -33,4 +34,9 @@ export type FindingsSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add a custom response view mode.
+     * @param options The view mode options.
+     */
+    addResponseViewMode: (options: ResponseViewModeOptions) => void;
 };

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

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

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

@@ -1,5 +1,6 @@
 import type { Extension } from "@codemirror/state";
 import type { RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions } from "../types/response";
 import type { SearchSlot, SearchSlotContent } from "../types/search";
 import type { HTTPQL, ID } from "../types/utils";
 /**
@@ -37,6 +38,11 @@ export type SearchSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add a custom response view mode.
+     * @param options The view mode options.
+     */
+    addResponseViewMode: (options: ResponseViewModeOptions) => 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,5 +1,6 @@
 import type { Extension } from "@codemirror/state";
 import type { RequestViewModeOptions } from "../types/request";
+import type { ResponseViewModeOptions } from "../types/response";
 import type { SitemapEntry, SitemapEntryChildStateUpdateEvent, SitemapRootEntry } from "../types/sitemap";
 import type { AddIndicatorOptions, ID, Indicator, ListenerHandle } from "../types/utils";
 /**
@@ -53,6 +54,11 @@ export type SitemapSDK = {
      * @param options The view mode options.
      */
     addRequestViewMode: (options: RequestViewModeOptions) => void;
+    /**
+     * Add a custom response view mode.
+     * @param options The view mode options.
+     */
+    addResponseViewMode: (options: ResponseViewModeOptions) => void;
     /**
      * Add an indicator to a sitemap session.
      * Indicators are displayed next to the entry name in the collections tree.

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

@@ -0,0 +1,27 @@
+import type { As, ComponentDefinition, ID, Prettify } from "./utils";
+/**
+ * A complete response with all metadata and raw content.
+ * @category Response
+ */
+export type ResponseFull = Prettify<As<"ResponseFull"> & {
+    id: ID;
+    raw: string;
+    statusCode: number;
+    roundtripTime: number;
+    length: number;
+    createdAt: Date;
+}>;
+/**
+ * Options for defining a custom response view mode.
+ * @category Response
+ */
+export type ResponseViewModeOptions = {
+    /**
+     * The label of the view mode.
+     */
+    label: string;
+    /**
+     * The component to render when the view mode is selected.
+     */
+    view: ComponentDefinition;
+};