@caido/sdk-frontend 0.49.1-beta.2 → 0.49.1-beta.3

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

@@ -0,0 +1,21 @@
+import { type MenuItem } from "../types/menu";
+/**
+ * Utilities to insert menu items and context-menus throughout the UI.
+ * @category Menu
+ */
+export type MenuSDK = {
+    /**
+     * Register a menu item.
+     * @param item The menu item to register.
+     *
+     * @example
+     * ```ts
+     * sdk.menu.registerItem({
+     *   type: "Request",
+     *   commandId: "hello",
+     *   leadingIcon: "fas fa-hand",
+     * });
+     * ```
+     */
+    registerItem: (item: MenuItem) => void;
+};

package/src/types/{replay.d.ts → sdks/replay.d.ts}

@@ -1,58 +1,7 @@
 import { type Extension } from "@codemirror/state";
-import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "./slots";
-import type { ID } from "./utils";
-export declare const ReplaySlot: {
-    readonly SessionToolbarPrimary: "session-toolbar-primary";
-    readonly SessionToolbarSecondary: "session-toolbar-secondary";
-    readonly Topbar: "topbar";
-};
-export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
-/**
- * A replay tab.
- * @category Replay
- */
-export type ReplayTab = {
-    /**
-     * The ID of the session associated with this tab.
-     */
-    sessionId: ID;
-};
-/**
- * A session in Replay.
- * @category Replay
- */
-export type ReplaySession = {
-    /**
-     * The ID of the session.
-     */
-    id: ID;
-    /**
-     * The name of the session.
-     */
-    name: string;
-    /**
-     * The ID of the collection the session belongs to.
-     */
-    collectionId: ID;
-};
-/**
- * A collection in Replay.
- * @category Replay
- */
-export type ReplayCollection = {
-    /**
-     * The ID of the collection.
-     */
-    id: ID;
-    /**
-     * The name of the collection.
-     */
-    name: string;
-    /**
-     * The sessions in the collection.
-     */
-    sessionIds: ID[];
-};
+import { type ReplayCollection, type ReplaySession, type ReplaySlot, type ReplayTab } from "../types/replay";
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "../types/slots";
+import type { ID } from "../types/utils";
 /**
  * Utilities to interact with Replay.
  * @category Replay

package/src/types/{scopes.d.ts → sdks/scopes.d.ts}

@@ -1,4 +1,5 @@
-import type { ID } from "./utils";
+import { type Scope } from "../types/scopes";
+import type { ID } from "../types/utils";
 /**
  * Utilities to interact with scopes
  * @category Scopes
@@ -52,25 +53,3 @@ export type ScopesSDK = {
      */
     deleteScope: (id: ID) => Promise<boolean>;
 };
-/**
- * Represents a scope.
- * @category Scopes
- */
-export type Scope = {
-    /**
-     * The unique ID of the scope.
-     */
-    id: ID;
-    /**
-     * The name of the scope.
-     */
-    name: string;
-    /**
-     * The list of included items.
-     */
-    allowlist: string[];
-    /**
-     * The list of excluded items.
-     */
-    denylist: string[];
-};

package/src/types/{search.d.ts → sdks/search.d.ts}

@@ -1,4 +1,4 @@
-import type { HTTPQL, ID } from "./utils";
+import type { HTTPQL, ID } from "../types/utils";
 /**
  * Utilities to interact with the Search page.
  * @category Search

package/src/types/{shortcuts.d.ts → sdks/shortcuts.d.ts}

@@ -1,4 +1,4 @@
-import type { CommandID } from "./utils";
+import type { CommandID } from "../types/commands";
 /**
  * Utilities to interact with shortcuts.
  * @category Shortcuts

package/src/types/{sidebar.d.ts → sdks/sidebar.d.ts}

@@ -1,4 +1,5 @@
-import type { Icon } from "./utils";
+import { type SidebarItem } from "../types/sidebar";
+import type { Icon } from "../types/utils";
 /**
  * Utilities to interact with the sidebar.
  * @category Sidebar
@@ -27,15 +28,3 @@ export type SidebarSDK = {
         isExternal?: boolean;
     }) => SidebarItem;
 };
-/**
- * Represents a sidebar item.
- * @category Sidebar
- */
-type SidebarItem = {
-    /**
-     * Set the value of a notification badge next to the sidebar item.
-     * @param count - The number to display in the badge. A value of 0 will hide the badge.
-     */
-    setCount: (count: number) => void;
-};
-export {};

package/src/types/{sitemap.d.ts → sdks/sitemap.d.ts}

@@ -1,4 +1,4 @@
-import type { ID } from "./utils";
+import type { ID } from "../types/utils";
 /**
  * Utilities to interact with the Sitemap page.
  * @category Sitemap

package/src/types/{storage.d.ts → sdks/storage.d.ts}

@@ -1,4 +1,4 @@
-import type { JSONCompatible, JSONValue } from "./utils";
+import type { JSONCompatible, JSONValue } from "../types/json";
 /**
  * Utilities to interact with frontend-plugin storage.
  * @category Storage

package/src/types/{ui.d.ts → sdks/ui.d.ts}

@@ -1,5 +1,5 @@
-import type { HTTPRequestEditor, HTTPResponseEditor } from "./editor";
-import type { Icon } from "./utils";
+import type { HTTPRequestEditor, HTTPResponseEditor } from "../types/editor";
+import type { Icon } from "../types/utils";
 /**
  * Utilities to create UI components.
  * @category UI

package/src/types/{window.d.ts → sdks/window.d.ts}

@@ -1,5 +1,6 @@
-import type { Editor } from "./editor";
-import type { CustomSlotContent } from "./slots";
+import type { Editor } from "../types/editor";
+import type { CustomSlotContent } from "../types/slots";
+import { type DialogOptions } from "../types/window";
 /**
  * Utilities to interact with the active page.
  * @category Window
@@ -34,11 +35,3 @@ export type WindowSDK = {
      */
     showDialog: (component: CustomSlotContent, options?: DialogOptions) => void;
 };
-export type DialogOptions = {
-    title?: string;
-    draggable?: boolean;
-    closeOnEscape?: boolean;
-    closable?: boolean;
-    modal?: boolean;
-    position?: "left" | "right" | "top" | "bottom" | "center" | "topleft" | "topright" | "bottomleft" | "bottomright";
-};

package/src/types/{workflows.d.ts → sdks/workflows.d.ts}

@@ -1,4 +1,5 @@
-import { type ID, type ListenerHandle } from "./utils";
+import { type ListenerHandle } from "../types/utils";
+import { type OnCreatedWorkflowCallback, type OnDeletedWorkflowCallback, type OnUpdatedWorkflowCallback, type Workflow } from "../types/workflows";
 /**
  * Utilities to interact with workflows.
  * @category Workflows
@@ -25,27 +26,3 @@ export type WorkflowSDK = {
      */
     onDeletedWorkflow: (callback: OnDeletedWorkflowCallback) => ListenerHandle;
 };
-/**
- * A workflow
- * @category Workflows
- */
-export type Workflow = {
-    id: string;
-    name: string;
-    description: string;
-    kind: WorkflowKind;
-};
-/**
- * The kind of workflow.
- * @category Workflows
- */
-export type WorkflowKind = "Convert" | "Active" | "Passive";
-export type OnCreatedWorkflowCallback = (event: {
-    workflow: Workflow;
-}) => void;
-export type OnUpdatedWorkflowCallback = (event: {
-    workflow: Workflow;
-}) => void;
-export type OnDeletedWorkflowCallback = (event: {
-    id: ID;
-}) => void;

package/src/types/types/assets.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A static asset.
+ * @category Files
+ */
+export type Asset = {
+    asReadableStream: () => ReadableStream;
+    asArrayBuffer: () => Promise<ArrayBuffer>;
+    asString: () => Promise<string>;
+    asJson: <T = unknown>() => Promise<T>;
+};

package/src/types/types/backend.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Endpoints provided by the backend plugin.
+ * @category Backend
+ */
+export type BackendEndpoints = {
+    [key: string]: (...args: any[]) => any;
+};
+/**
+ * Events emitted by the backend plugin.
+ * @category Backend
+ */
+export type BackendEvents = {
+    [key: string]: (...args: any[]) => void;
+};

package/src/types/{commands.d.ts → types/commands.d.ts}

@@ -1,33 +1,10 @@
-import type { CommandID, ID } from "./utils";
+import { type ID } from "./utils";
 /**
- * Utilities to interact with commands
- * @category Commands
+ * A unique command identifier.
+ * @example "my-super-command"
  */
-export type CommandsSDK = {
-    /**
-     * Register a command.
-     * @param id The id of the command.
-     * @param options Options for the command.
-     * @param options.name The name of the command.
-     * @param options.run The function to run when the command is executed.
-     * @param options.group The group this command belongs to.
-     * @param options.when A function to determine if the command is available.
-     *
-     * @example
-     * ```ts
-     * sdk.commands.register("hello", {
-     *   name: "Print to console.",
-     *   run: () => console.log("Hello world!"),
-     *   group: "Custom Commands",
-     * });
-     * ```
-     */
-    register: (id: CommandID, options: {
-        name: string;
-        run: (context: CommandContext) => Promise<void> | void;
-        group?: string;
-        when?: (context: CommandContext) => Promise<boolean> | boolean;
-    }) => void;
+export type CommandID = string & {
+    __commandId?: never;
 };
 /**
  * Represents the context in which a command is executed.

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

@@ -0,0 +1,14 @@
+export type EnvironmentVariable = {
+    /**
+     * The name of the environment variable.
+     */
+    name: string;
+    /**
+     * The value of the environment variable.
+     */
+    value: string;
+    /**
+     * Whether the environment variable is a secret.
+     */
+    isSecret: boolean;
+};

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

@@ -0,0 +1,30 @@
+/**
+ * A hosted file.
+ * @category Files
+ */
+export type HostedFile = {
+    /**
+     * The ID of the file.
+     */
+    id: string;
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The size of the file in bytes.
+     */
+    size: number;
+    /**
+     * The path of the file.
+     */
+    path: string;
+    /**
+     * The date the file was created.
+     */
+    createdAt: Date;
+    /**
+     * The date the file was updated.
+     */
+    updatedAt: Date;
+};

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

@@ -0,0 +1,24 @@
+import { type HTTPQL, type ID } from "./utils";
+/**
+ * Represents a filter.
+ * @category Filters
+ */
+export type Filter = {
+    /**
+     * The ID of the filter.
+     */
+    id: ID;
+    /**
+     * The name of the filter.
+     */
+    name: string;
+    /**
+     * The alias of the filter.
+     * This alias is used when referencing the filter in an HTTPQL query (e.g. `preset:my-alias`).
+     */
+    alias: string;
+    /**
+     * The HTTPQL expression of the filter.
+     */
+    query: HTTPQL;
+};

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

@@ -0,0 +1,31 @@
+import { type ID } from "./utils";
+/**
+ * Represents a {@link https://docs.caido.io/reference/features/logging/findings|Finding}.
+ * @category Findings
+ */
+export type Finding = {
+    /**
+     * The ID of the finding.
+     */
+    id: ID;
+    /**
+     * The title of the finding.
+     */
+    title: string;
+    /**
+     * The description of the finding.
+     */
+    description?: string;
+    /**
+     * The reporter of the finding.
+     */
+    reporter: string;
+    /**
+     * The host of the request attached to this finding
+     */
+    host: string;
+    /**
+     * The path of the request attached to this finding
+     */
+    path: string;
+};

package/src/types/types/footer.d.ts

@@ -0,0 +1,10 @@
+import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent } from "./slots";
+export declare const FooterSlot: {
+    readonly FooterSlotPrimary: "footer-primary";
+    readonly FooterSlotSecondary: "footer-secondary";
+};
+export type FooterSlot = (typeof FooterSlot)[keyof typeof FooterSlot];
+export type FooterSlotContent = {
+    [FooterSlot.FooterSlotPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+    [FooterSlot.FooterSlotSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
+};

package/src/types/types/json.d.ts

@@ -0,0 +1,9 @@
+type JSONPrimitive = string | number | boolean | null | undefined;
+export type JSONValue = JSONPrimitive | JSONValue[] | {
+    [key: string]: JSONValue;
+};
+type NotAssignableToJson = bigint | symbol | Function;
+export type JSONCompatible<T> = unknown extends T ? never : {
+    [P in keyof T]: T[P] extends JSONValue ? T[P] : T[P] extends NotAssignableToJson ? never : JSONCompatible<T[P]>;
+};
+export {};

package/src/types/{matchReplace.d.ts → types/matchReplace.d.ts}

@@ -1,89 +1,4 @@
-import type { HTTPQL, ID } from "./utils";
-/**
- * Utilities to interact with the Match and Replace page.
- * @category Match and Replace
- */
-export type MatchReplaceSDK = {
-    /**
-     * Get all collections.
-     */
-    getCollections: () => MatchReplaceCollection[];
-    /**
-     * Create a collection.
-     * @param options - The options for the collection.
-     * @param options.name - The name of the collection.
-     */
-    createCollection: (options: {
-        name: string;
-    }) => Promise<MatchReplaceCollection>;
-    /**
-     * Update a collection.
-     * @param id - The ID of the collection.
-     * @param options - The new values for the collection.
-     * @param options.name - The new name of the collection.
-     */
-    updateCollection: (id: ID, options: {
-        name: string;
-    }) => Promise<MatchReplaceCollection>;
-    /**
-     * Delete a collection.
-     * @param id - The ID of the collection.
-     */
-    deleteCollection: (id: ID) => Promise<void>;
-    /**
-     * Get all rules.
-     * @returns All rules.
-     */
-    getRules: () => MatchReplaceRule[];
-    /**
-     * Get all active rules.
-     * Rules are ordered in priority from highest to lowest.
-     * @returns All active rules.
-     */
-    getActiveRules: () => MatchReplaceRule[];
-    /**
-     * Select a rule to be displayed in the UI.
-     * @param id - The ID of the rule, or undefined to clear the selection.
-     */
-    selectRule: (id: ID | undefined) => void;
-    /**
-     * Create a rule.
-     * @param options - The options for the rule.
-     * @param options.name - The name of the rule.
-     * @param options.query - The HTTPQL query to match the rule against.
-     * @param options.collectionId - The ID of the collection the rule belongs to.
-     */
-    createRule: (options: {
-        name: string;
-        query: HTTPQL;
-        section: MatchReplaceSection;
-        collectionId: ID;
-    }) => Promise<MatchReplaceRule>;
-    /**
-     * Update a rule.
-     * @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 HTTPQL query of the rule.
-     * @param options.section - The new section of the rule.
-     */
-    updateRule: (id: ID, options: {
-        name: string;
-        query?: HTTPQL;
-        section: MatchReplaceSection;
-    }) => Promise<MatchReplaceRule>;
-    /**
-     * Toggle a rule.
-     * @param id - The ID of the rule.
-     * @param enabled - Whether the rule should be enabled.
-     */
-    toggleRule: (id: ID, enabled: boolean) => Promise<void>;
-    /**
-     * Delete a rule.
-     * @param id - The ID of the rule.
-     */
-    deleteRule: (id: ID) => Promise<void>;
-};
+import { type HTTPQL, type ID } from "./utils";
 /**
  * A rule in Match and Replace.
  * @category Match and Replace

package/src/types/{menu.d.ts → types/menu.d.ts}

@@ -1,24 +1,5 @@
-import type { CommandID, Icon } from "./utils";
-/**
- * Utilities to insert menu items and context-menus throughout the UI.
- * @category Menu
- */
-export type MenuSDK = {
-    /**
-     * Register a menu item.
-     * @param item The menu item to register.
-     *
-     * @example
-     * ```ts
-     * sdk.menu.registerItem({
-     *   type: "Request",
-     *   commandId: "hello",
-     *   leadingIcon: "fas fa-hand",
-     * });
-     * ```
-     */
-    registerItem: (item: MenuItem) => void;
-};
+import { type CommandID } from "./commands";
+import { type Icon } from "./utils";
 /**
  * A content-menu item.
  * @category Menu

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

@@ -0,0 +1,53 @@
+import { type ID } from "./utils";
+export declare const ReplaySlot: {
+    readonly SessionToolbarPrimary: "session-toolbar-primary";
+    readonly SessionToolbarSecondary: "session-toolbar-secondary";
+    readonly Topbar: "topbar";
+};
+export type ReplaySlot = (typeof ReplaySlot)[keyof typeof ReplaySlot];
+/**
+ * A replay tab.
+ * @category Replay
+ */
+export type ReplayTab = {
+    /**
+     * The ID of the session associated with this tab.
+     */
+    sessionId: ID;
+};
+/**
+ * A session in Replay.
+ * @category Replay
+ */
+export type ReplaySession = {
+    /**
+     * The ID of the session.
+     */
+    id: ID;
+    /**
+     * The name of the session.
+     */
+    name: string;
+    /**
+     * The ID of the collection the session belongs to.
+     */
+    collectionId: ID;
+};
+/**
+ * A collection in Replay.
+ * @category Replay
+ */
+export type ReplayCollection = {
+    /**
+     * The ID of the collection.
+     */
+    id: ID;
+    /**
+     * The name of the collection.
+     */
+    name: string;
+    /**
+     * The sessions in the collection.
+     */
+    sessionIds: ID[];
+};

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

@@ -0,0 +1,23 @@
+import { type ID } from "./utils";
+/**
+ * Represents a scope.
+ * @category Scopes
+ */
+export type Scope = {
+    /**
+     * The unique ID of the scope.
+     */
+    id: ID;
+    /**
+     * The name of the scope.
+     */
+    name: string;
+    /**
+     * The list of included items.
+     */
+    allowlist: string[];
+    /**
+     * The list of excluded items.
+     */
+    denylist: string[];
+};

package/src/types/types/sidebar.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Represents a sidebar item.
+ * @category Sidebar
+ */
+export type SidebarItem = {
+    /**
+     * Set the value of a notification badge next to the sidebar item.
+     * @param count - The number to display in the badge. A value of 0 will hide the badge.
+     */
+    setCount: (count: number) => void;
+};

package/src/types/{slots.d.ts → types/slots.d.ts}

@@ -1,5 +1,5 @@
 import { type Component } from "vue";
-import { type CommandID } from "./utils";
+import { type CommandID } from "./commands";
 type DefineSlotContent<TType extends string, P extends Record<string, unknown>> = {
     type: TType;
 } & P;

package/src/types/{utils.d.ts → types/utils.d.ts}

@@ -1,17 +1,9 @@
-type JSONPrimitive = string | number | boolean | null | undefined;
 /**
  * A unique Caido identifier per type.
  */
 export type ID = string & {
     __id?: never;
 };
-/**
- * A unique command identifier.
- * @example "my-super-command"
- */
-export type CommandID = string & {
-    __commandId?: never;
-};
 /**
  * An HTTPQL expression.
  * @example `req.method.eq:"POST"`
@@ -26,13 +18,6 @@ export type HTTPQL = string & {
 export type Icon = string & {
     __icon?: never;
 };
-export type JSONValue = JSONPrimitive | JSONValue[] | {
-    [key: string]: JSONValue;
-};
-type NotAssignableToJson = bigint | symbol | Function;
-export type JSONCompatible<T> = unknown extends T ? never : {
-    [P in keyof T]: T[P] extends JSONValue ? T[P] : T[P] extends NotAssignableToJson ? never : JSONCompatible<T[P]>;
-};
 export type PromisifiedReturnType<T extends (...args: unknown[]) => unknown> = ReturnType<T> extends Promise<infer U> ? Promise<U> : Promise<ReturnType<T>>;
 /**
  * A handle for a listener.
@@ -43,4 +28,3 @@ export type ListenerHandle = {
      */
     stop: () => void;
 };
-export {};