@caido/sdk-frontend 0.56.3-beta.2 → 0.57.1-beta.10

package/src/types/index.d.ts

@@ -1,10 +1,12 @@
+import type { DefineComponent } from "vue";
+import type { HTTPQLEditorProps } from "./types/httpqlEditor";
 export { FooterSlot, type FooterSlotContent } from "./types/footer";
 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 AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, } from "./types/replay";
+export { type AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type ReplayTab, type ReplaySession, type ReplayEntry, type ReplayCollection, type SendRequestOptions, ReplaySlot, type ReplaySlotContent, type RequestSource, type CurrentReplaySessionChangeEvent, ReplaySessionKind, type ReplayPageContext, } from "./types/replay";
 export type { AutomateSession, AutomateEntry } from "./types/automate";
 export type { SitemapEntry, SitemapRootEntry, ChildState, } from "./types/sitemap";
 export { SearchSlot, type SearchSlotContent } from "./types/search";
@@ -43,9 +45,12 @@ 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";
+export type { HTTPQLEditorProps };
+export declare const HTTPQLEditor: DefineComponent<HTTPQLEditorProps & {
+    modelValue?: string;
+}>;

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

@@ -1,5 +1,5 @@
-import { type ListenerHandle } from "src/types/utils";
 import { type HostedFile } from "../types/files";
+import { type ListenerHandle } from "../types/utils";
 /**
  * SDK for interacting with the Files page.
  * @category Files

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

@@ -39,6 +39,23 @@ import type { WorkflowSDK } from "./workflows";
 export type API<T extends BackendEndpoints | BackendSpec = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
     /**
      * Utilities to interact with the GraphQL API.
+     *
+     * Queries and mutations return a promise; subscriptions return an
+     * `AsyncIterable`. On success they resolve with the response data or yield
+     * it. On failure (network error or any GraphQL errors returned by the
+     * server) the promise rejects, or the iterator throws into the `for await`
+     * loop, with the underlying error. Failures can be handled with `try`/
+     * `catch` or `.catch()`.
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const result = await sdk.graphql.automateEntry({ id: "1" });
+     *   // use result
+     * } catch (err) {
+     *   // err.message, err.graphQLErrors, err.networkError
+     * }
+     * ```
      */
     graphql: GraphqlSDK;
     /**

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

@@ -1,5 +1,5 @@
 import { type Extension } from "@codemirror/state";
-import { type AddSessionIndicatorOptions, 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 AddCollectionIndicatorOptions, type AddSessionIndicatorOptions, type CurrentReplaySessionChangeEvent, type OpenTabOptions, type ReplayCollection, type ReplayCollectionCreatedEvent, type ReplayEntry, type ReplaySession, type ReplaySessionCreatedEvent, type ReplaySessionKind, type ReplaySlotContent, type ReplayTab, type RequestSource, type SendRequestOptions } from "../types/replay";
 import type { RequestViewModeOptions, RequestWritableViewModeProps } from "../types/request";
 import type { ResponseViewModeOptions, ResponseViewModeProps } from "../types/response";
 import { type DefineAddToSlotFn } from "../types/slots";
@@ -27,9 +27,13 @@ export type ReplaySDK = {
     getTabs: () => ReplayTab[];
     /**
      * Get the list of all replay sessions.
+     * @param options The options for getting the sessions.
+     * @param options.collectionId The ID of the collection to get the sessions for.
      * @returns The list of all replay sessions.
      */
-    getSessions: () => ReplaySession[];
+    getSessions: (options?: {
+        collectionId?: ID;
+    }) => ReplaySession[];
     /**
      * Get the currently selected replay session.
      * @returns The currently selected replay session, or undefined if no session is selected.
@@ -44,6 +48,20 @@ export type ReplaySDK = {
      * ```
      */
     getCurrentSession: () => ReplaySession | undefined;
+    /**
+     * Get the entry currently displayed in the active replay session.
+     * @returns The active entry, or undefined if no entry is currently loaded.
+     * @example
+     * ```ts
+     * const currentEntry = sdk.replay.getCurrentEntry();
+     * if (currentEntry) {
+     *   console.log(`Currently viewing entry ${currentEntry.id}`);
+     * } else {
+     *   console.log("No entry is currently displayed");
+     * }
+     * ```
+     */
+    getCurrentEntry: () => ReplayEntry | undefined;
     /**
      * Rename a session.
      * @param id The ID of the session to rename.
@@ -65,10 +83,22 @@ export type ReplaySDK = {
     deleteSessions: (sessionIds: ID[]) => Promise<ID[]>;
     /**
      * Create a session.
-     * @param sessionId The ID of the request to add.
-     * @param collectionId The ID of the collection to add the request.
+     * @param source The source of the session to create.
+     * @param collectionId The ID of the collection to add the session to.
+     * @example
+     * ```ts
+     * sdk.replay.createSession({
+     *   type: "Raw",
+     *   raw: "GET / HTTP/1.1\r\nHost: example.com\r\n\r\n",
+     *   connectionInfo: {
+     *     host: "example.com",
+     *     port: 443,
+     *     isTLS: true,
+     *   },
+     * });
+     * ```
      */
-    createSession: (source: RequestSource, collectionId?: ID) => Promise<void>;
+    createSession: (source: RequestSource, collectionId?: ID, sessionKind?: ReplaySessionKind) => Promise<ReplaySession>;
     /**
      * Get the list of all replay collections.
      * @returns The list of all replay collections.
@@ -243,4 +273,22 @@ export type ReplaySDK = {
      *
      */
     addSessionIndicator: (sessionId: ID, indicator: AddSessionIndicatorOptions) => Indicator;
+    /**
+     * Add an indicator to a replay collection.
+     * Indicators are displayed next to the collection name in the collections tree.
+     * @param collectionId The ID of the collection to add the indicator to.
+     * @param indicator The indicator configuration.
+     * @returns A handle object with a `remove` method to remove the indicator.
+     * @example
+     *
+     * const indicator = sdk.replay.addCollectionIndicator(collectionId, {
+     *   icon: "fas fa-folder-open",
+     *   description: "Has unresolved findings",
+     * });
+     *
+     * // Later, remove the indicator
+     * indicator.remove();
+     *
+     */
+    addCollectionIndicator: (collectionId: ID, indicator: AddCollectionIndicatorOptions) => Indicator;
 };

package/src/types/types/httpqlEditor.d.ts

@@ -0,0 +1,3 @@
+export type HTTPQLEditorProps = {
+    isReadOnly?: boolean;
+};

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

@@ -219,6 +219,24 @@ export type AddSessionIndicatorOptions = AddIndicatorOptions & {
      */
     showTabIcon?: boolean;
 };
+/**
+ * Options for adding an indicator to a replay collection.
+ * @category Replay
+ */
+export type AddCollectionIndicatorOptions = AddIndicatorOptions;
+/**
+ * The kind of a replay session.
+ * @category Replay
+ */
+export declare const ReplaySessionKind: {
+    readonly Http: "HTTP";
+    readonly Ws: "WS";
+};
+/**
+ * The kind of a replay session.
+ * @category Replay
+ */
+export type ReplaySessionKind = (typeof ReplaySessionKind)[keyof typeof ReplaySessionKind];
 /**
  * A unique replay session identifier.
  * @category Replay