@caido/sdk-frontend 0.54.2-beta.1 → 0.54.2-beta.10

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

@@ -0,0 +1,25 @@
+import { type CustomSlotContent } from "./slots";
+/**
+ * The slots in the Settings UI.
+ * @category Settings
+ */
+export declare const SettingsSlot: {
+    /**
+     * The plugins section in the settings sidebar.
+     */
+    readonly PluginsSection: "plugins-section";
+};
+export type SettingsSlot = (typeof SettingsSlot)[keyof typeof SettingsSlot];
+/**
+ * Content for a settings plugin slot.
+ * @category Settings
+ */
+export type SettingsPluginSlotContent = CustomSlotContent & {
+    /**
+     * The name of the plugin settings page displayed in the sidebar.
+     */
+    name: string;
+};
+export type SettingsSlotContent = {
+    [SettingsSlot.PluginsSection]: SettingsPluginSlotContent;
+};

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

@@ -0,0 +1,96 @@
+import { type ID, type Selection } from "./utils";
+/**
+ * An entry in sitemap.
+ * @category Sitemap
+ */
+export type SitemapEntry = {
+    /**
+     * The ID of the entry.
+     */
+    id: ID;
+    /**
+     * The label of the entry.
+     */
+    label: string;
+    /**
+     * The kind of the entry.
+     */
+    kind: SitemapEntryKind;
+    /**
+     * The ID of the parent entry.
+     */
+    parentId?: ID;
+    /**
+     * The child state of the entry.
+     */
+    childState: ChildState;
+};
+export type SitemapRootEntry = {
+    /**
+     * The ID of the entry.
+     */
+    id: ID;
+    /**
+     * The label of the entry.
+     */
+    label: string;
+    /**
+     * The child state of the entry.
+     */
+    childState: ChildState;
+};
+/**
+ * The kind of a sitemap entry.
+ * @category Sitemap
+ */
+export declare const SitemapEntryKind: {
+    readonly Directory: "DIRECTORY";
+    readonly Domain: "DOMAIN";
+    readonly Request: "REQUEST";
+    readonly RequestBody: "REQUEST_BODY";
+    readonly RequestQuery: "REQUEST_QUERY";
+};
+/**
+ * The kind of a sitemap entry.
+ * @category Sitemap
+ * @example
+ * ```ts
+ * const entry = {
+ *   id: "123",
+ *   label: "Example",
+ *   kind: SitemapEntryKind.Request,
+ * };
+ * ```
+ */
+export type SitemapEntryKind = (typeof SitemapEntryKind)[keyof typeof SitemapEntryKind];
+export type ChildState = {
+    kind: "Empty";
+} | {
+    kind: "NotLoaded";
+} | {
+    kind: "Loaded";
+    items: ID[];
+};
+/**
+ * Event fired when the child state of a sitemap entry changes.
+ * @category Sitemap
+ */
+export type SitemapEntryChildStateUpdateEvent = {
+    /**
+     * The ID of the entry that changed.
+     */
+    entryId: ID;
+    /**
+     * The new child state of the entry.
+     */
+    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,3 +60,31 @@ 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.
+ * @category Utils
+ */
+export type AddIndicatorOptions = {
+    icon: Icon;
+    description: string;
+};
+/**
+ * Providing operations that can be performed on a item indicator.
+ * @category Utils
+ */
+export type Indicator = {
+    remove: () => void;
+};

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