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

package/package.json

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

@@ -8,10 +8,11 @@ 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 } 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, } from "./types/matchReplace";
 export { MatchReplaceSlot, type MatchReplaceSlotContent, } from "./types/matchReplace";
 export { ScopeSlot, type CurrentScopeChangeEvent, type Scope, type ScopeSlotContent, } from "./types/scopes";
@@ -25,3 +26,22 @@ export type { CommandPaletteView } from "./sdks/commandPalette";
 export type { LogSDK } from "./sdks/log";
 export type { API } from "./sdks";
 export { Routes } from "./types/navigation";
+export { type GlobalContext, type PageContext } from "./types/window";
+export type { AssistantPageContext } from "./types/assistant";
+export type { AutomatePageContext } from "./types/automate";
+export type { BackupsPageContext } from "./types/backups";
+export type { CertificatePageContext } from "./types/certificate";
+export type { EnvironmentPageContext } from "./types/environment";
+export type { ExportsPageContext } from "./types/exports";
+export type { FilesPageContext } from "./types/files";
+export type { FilterPageContext } from "./types/filter";
+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";

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

@@ -1,6 +1,6 @@
 import type { Editor } from "../types/editor";
-import type { ComponentDefinition } from "../types/utils";
-import { type Dialog, type DialogOptions } from "../types/window";
+import type { ComponentDefinition, ListenerHandle } from "../types/utils";
+import { type Dialog, type DialogOptions, type GlobalContext } from "../types/window";
 /**
  * Utilities to interact with the active page.
  * @category Window
@@ -35,4 +35,15 @@ export type WindowSDK = {
      * @returns A dialog object that can be used to close the dialog.
      */
     showDialog: (component: ComponentDefinition, options?: DialogOptions) => Dialog;
+    /**
+     * Get the current global context.
+     * @returns The current global context.
+     */
+    getContext: () => GlobalContext;
+    /**
+     * Subscribe to global context changes.
+     * @param callback The callback to call when the context changes.
+     * @returns An object with a `stop` method that can be called to stop listening to context changes.
+     */
+    onContextChange: (callback: (context: GlobalContext) => void) => ListenerHandle;
 };

package/src/types/types/assistant.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Assistant page context.
+ * @category Assistant
+ */
+export type AssistantPageContext = {
+    kind: "Assistant";
+};

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

@@ -1,4 +1,4 @@
-import type { ID } from "./utils";
+import { type ID, type Selection } from "./utils";
 /**
  * A automate session.
  * @category Automate
@@ -39,3 +39,18 @@ export type AutomateEntry = {
      */
     createdAt: Date;
 };
+/**
+ * Automate page context.
+ * @category Automate
+ */
+export type AutomatePageContext = {
+    kind: "Automate";
+    requestSelection: Selection<ID>;
+    selection: Selection<{
+        kind: "AutomateSession";
+        id: ID;
+    } | {
+        kind: "AutomateEntry";
+        id: ID;
+    }>;
+};

package/src/types/types/backups.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Backups page context.
+ * @category Backups
+ */
+export type BackupsPageContext = {
+    kind: "Backups";
+};

package/src/types/types/certificate.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Certificate page context.
+ * @category Certificate
+ */
+export type CertificatePageContext = {
+    kind: "Certificate";
+};

package/src/types/types/environment.d.ts

@@ -1,3 +1,4 @@
+import { type ID, type Selection } from "./utils";
 /**
  * Represents an environment variable.
  * @category Environment
@@ -16,3 +17,11 @@ export type EnvironmentVariable = {
      */
     isSecret: boolean;
 };
+/**
+ * Environment page context.
+ * @category Environment
+ */
+export type EnvironmentPageContext = {
+    kind: "Environment";
+    selection: Selection<ID>;
+};

package/src/types/types/exports.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Exports page context.
+ * @category Exports
+ */
+export type ExportsPageContext = {
+    kind: "Exports";
+};

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

@@ -32,3 +32,10 @@ export type HostedFile = {
      */
     updatedAt: Date;
 };
+/**
+ * Files page context.
+ * @category Files
+ */
+export type FilesPageContext = {
+    kind: "Files";
+};

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

@@ -1,5 +1,5 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
-import { type HTTPQL, type ID } from "./utils";
+import { type HTTPQL, type ID, type Selection } from "./utils";
 /**
  * Represents a filter.
  * @category Filters
@@ -56,3 +56,11 @@ export type CurrentFilterChangeEvent = {
      */
     filterId: ID | undefined;
 };
+/**
+ * Filter page context.
+ * @category Filters
+ */
+export type FilterPageContext = {
+    kind: "Filter";
+    selection: Selection<ID>;
+};

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

@@ -1,4 +1,4 @@
-import { type ID } from "./utils";
+import { type ID, type Selection } from "./utils";
 /**
  * Represents a {@link https://docs.caido.io/reference/features/logging/findings|Finding}.
  * @category Findings
@@ -29,3 +29,11 @@ export type Finding = {
      */
     path: string;
 };
+/**
+ * Findings page context.
+ * @category Findings
+ */
+export type FindingsPageContext = {
+    kind: "Findings";
+    selection: Selection<ID>;
+};

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

@@ -1,4 +1,5 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
+import { type ID, type Selection } from "./utils";
 /**
  * The slots in the HTTP History UI.
  * @category HTTP History
@@ -13,3 +14,11 @@ export type HTTPHistorySlot = (typeof HTTPHistorySlot)[keyof typeof HTTPHistoryS
 export type HTTPHistorySlotContent = {
     [HTTPHistorySlot.ToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
+/**
+ * HTTP history page context.
+ * @category HTTP History
+ */
+export type HTTPHistoryPageContext = {
+    kind: "HTTPHistory";
+    selection: Selection<ID>;
+};

package/src/types/types/intercept.d.ts

@@ -0,0 +1,19 @@
+import { type Selection } from "./utils";
+/**
+ * A unique intercept message identifier.
+ * @category Intercept
+ */
+type InterceptMessageId = string & {
+    __interceptMessageId?: never;
+};
+/**
+ * Intercept page context.
+ * @category Intercept
+ */
+export type InterceptPageContext = {
+    kind: "Intercept";
+    requestSelection: Selection<InterceptMessageId>;
+    responseSelection: Selection<InterceptMessageId>;
+    websocketSelection: Selection<InterceptMessageId>;
+};
+export {};

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

@@ -1,5 +1,5 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
-import { type HTTPQL, type ID } from "./utils";
+import { type HTTPQL, type ID, type Selection } from "./utils";
 /**
  * A rule in Match and Replace.
  * @category Match and Replace
@@ -432,4 +432,12 @@ export type CurrentMatchReplaceRuleChangeEvent = {
      */
     ruleId: ID | undefined;
 };
+/**
+ * Match and Replace page context.
+ * @category Match and Replace
+ */
+export type MatchReplacePageContext = {
+    kind: "MatchReplace";
+    selection: Selection<ID>;
+};
 export {};

package/src/types/types/projects.d.ts

@@ -6,3 +6,10 @@ import { type ID } from "./utils";
 export type SelectedProjectChangeEvent = {
     projectId: ID | undefined;
 };
+/**
+ * Projects page context.
+ * @category Projects
+ */
+export type ProjectsPageContext = {
+    kind: "Projects";
+};

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

@@ -1,5 +1,5 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
-import { type ID } from "./utils";
+import { type ID, type Selection } from "./utils";
 /**
  * The slots in the Replay UI.
  * @category Replay
@@ -218,3 +218,19 @@ export type ReplayCollectionCreatedEvent = {
      */
     collection: ReplayCollection;
 };
+/**
+ * Replay page context.
+ * @category Replay
+ */
+export type ReplayPageContext = {
+    kind: "Replay";
+    selection: Selection<ReplaySessionId>;
+};
+/**
+ * A unique replay session identifier.
+ * @category Replay
+ */
+type ReplaySessionId = string & {
+    __replaySessionId?: never;
+};
+export {};

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

package/src/types/types/scopes.d.ts

@@ -1,5 +1,5 @@
 import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
-import { type ID } from "./utils";
+import { type ID, type Selection } from "./utils";
 /**
  * Represents a scope.
  * @category Scopes
@@ -51,3 +51,11 @@ export type CurrentScopeChangeEvent = {
      */
     scopeId: ID | undefined;
 };
+/**
+ * Scope page context.
+ * @category Scopes
+ */
+export type ScopePageContext = {
+    kind: "Scope";
+    selection: Selection<ID>;
+};

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

@@ -13,3 +13,10 @@ export type SearchSlot = (typeof SearchSlot)[keyof typeof SearchSlot];
 export type SearchSlotContent = {
     [SearchSlot.ToolbarPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
 };
+/**
+ * Search page context.
+ * @category Search
+ */
+export type SearchPageContext = {
+    kind: "Search";
+};

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

@@ -1,4 +1,4 @@
-import { type ID } from "./utils";
+import { type ID, type Selection } from "./utils";
 /**
  * An entry in sitemap.
  * @category Sitemap
@@ -85,3 +85,12 @@ export type SitemapEntryChildStateUpdateEvent = {
      */
     newChildState: ChildState;
 };
+/**
+ * Sitemap page context.
+ * @category Sitemap
+ */
+export type SitemapPageContext = {
+    kind: "Sitemap";
+    entrySelection: Selection<ID>;
+    requestSelection: Selection<ID>;
+};

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

@@ -60,6 +60,18 @@ export type Prettify<T> = {
 export type As<TType extends string> = {
     type: TType;
 };
+/**
+ * Generic selection type with main and secondary items.
+ * Main represents the primary selected item, secondary represents additional selected items.
+ * @category Utils
+ */
+export type Selection<TId> = {
+    kind: "Empty";
+} | {
+    kind: "Selected";
+    main: TId;
+    secondary: TId[];
+};
 /**
  * Visual indicator displayed next to a item label in a tree component.
  * Includes an icon and an associated description.

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

@@ -0,0 +1,7 @@
+/**
+ * Certificate page context.
+ * @category Websockets
+ */
+export type WebsocketPageContext = {
+    kind: "Websocket";
+};

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

@@ -1,3 +1,22 @@
+import type { AssistantPageContext } from "./assistant";
+import type { AutomatePageContext } from "./automate";
+import type { BackupsPageContext } from "./backups";
+import type { CertificatePageContext } from "./certificate";
+import type { EnvironmentPageContext } from "./environment";
+import type { ExportsPageContext } from "./exports";
+import type { FilesPageContext } from "./files";
+import type { FilterPageContext } from "./filter";
+import type { FindingsPageContext } from "./findings";
+import type { HTTPHistoryPageContext } from "./httpHistory";
+import type { InterceptPageContext } from "./intercept";
+import type { MatchReplacePageContext } from "./matchReplace";
+import type { ProjectsPageContext } from "./projects";
+import type { ReplayPageContext } from "./replay";
+import type { ScopePageContext } from "./scopes";
+import type { SearchPageContext } from "./search";
+import type { SitemapPageContext } from "./sitemap";
+import { type WebsocketPageContext } from "./websocket";
+import type { WorkflowsPageContext } from "./workflows";
 /**
  * Options for configuring a dialog.
  * @category Window
@@ -17,3 +36,15 @@ export type DialogOptions = {
 export type Dialog = {
     close: () => void;
 };
+/**
+ * Represents the context of the current page.
+ * @category Window
+ */
+export type PageContext = AssistantPageContext | AutomatePageContext | BackupsPageContext | CertificatePageContext | ExportsPageContext | EnvironmentPageContext | FilterPageContext | FindingsPageContext | HTTPHistoryPageContext | ReplayPageContext | ScopePageContext | SearchPageContext | WorkflowsPageContext | ProjectsPageContext | FilesPageContext | MatchReplacePageContext | InterceptPageContext | SitemapPageContext | WebsocketPageContext;
+/**
+ * Represents the global context of the application.
+ * @category Window
+ */
+export type GlobalContext = {
+    page?: PageContext;
+};

package/src/types/types/workflows.d.ts

@@ -35,3 +35,10 @@ export type OnUpdatedWorkflowCallback = (event: {
 export type OnDeletedWorkflowCallback = (event: {
     id: ID;
 }) => void;
+/**
+ * Workflows page context.
+ * @category Workflows
+ */
+export type WorkflowsPageContext = {
+    kind: "Workflows";
+};