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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.49.1-beta.2",
+  "version": "0.49.1-beta.4",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",

package/src/types/index.d.ts

@@ -1,151 +1,17 @@
-import type { Sdk as GraphqlSDK } from "./__generated__/graphql-sdk";
-import type { AssetsSDK } from "./assets";
-import type { BackendEndpoints, BackendEvents, BackendSDK } from "./backend";
-import type { CommandPaletteSDK } from "./commandPalette";
-import type { CommandsSDK } from "./commands";
-import type { EnvironmentSDK } from "./environment";
-import type { FilesSDK } from "./files";
-import type { FiltersSDK } from "./filters";
-import type { FindingsSDK } from "./findings";
-import type { FooterSDK } from "./footer";
-import type { HTTPHistorySDK } from "./httpHistory";
-import type { InterceptSDK } from "./intercept";
-import type { MatchReplaceSDK } from "./matchReplace";
-import type { MenuSDK } from "./menu";
-import type { NavigationSDK } from "./navigation";
-import type { ReplaySDK } from "./replay";
-import type { RuntimeSDK } from "./runtime";
-import type { ScopesSDK } from "./scopes";
-import type { SearchSDK } from "./search";
-import type { ShortcutsSDK } from "./shortcuts";
-import type { SidebarSDK } from "./sidebar";
-import type { SitemapSDK } from "./sitemap";
-import type { StorageSDK } from "./storage";
-import type { UISDK } from "./ui";
-import type { WindowSDK } from "./window";
-import type { WorkflowSDK } from "./workflows";
-export { FooterSlot } from "./footer";
-export type { DialogOptions } from "./window";
-export type { CommandContext } from "./commands";
-export type { MenuItem } from "./menu";
-export { type ReplayTab, type ReplaySession, type ReplayCollection, ReplaySlot, } from "./replay";
-export type { HostedFile } from "./files";
-export type { Filter } from "./filters";
-export type { HTTPQL, ID, JSONValue, JSONCompatible } from "./utils";
-export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, } from "./slots";
-export type { RequestViewModeOptions } from "./request";
-export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, } from "./matchReplace";
-export type { Scope } from "./scopes";
-export type { EnvironmentVariable } from "./environment";
-export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./workflows";
-export type { ListenerHandle } from "./utils";
-/**
- * Utilities for frontend plugins.
- * @category SDK
- */
-export type API<T extends BackendEndpoints = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
-    /**
-     * Utilities to interact with the GraphQL API.
-     */
-    graphql: GraphqlSDK;
-    /**
-     * Utilities to interact with the backend plugin.
-     */
-    backend: BackendSDK<T, E>;
-    /**
-     * Utilities to create UI components.
-     */
-    ui: UISDK;
-    /**
-     * Utilities to interact with scopes
-     */
-    scopes: ScopesSDK;
-    /**
-     * Utilities to interact with findings
-     */
-    findings: FindingsSDK;
-    /**
-     * Utilities to interact with commands
-     */
-    commands: CommandsSDK;
-    /**
-     * Utilities to insert menu items and context-menus throughout the UI.
-     */
-    menu: MenuSDK;
-    /**
-     * Utilities to interact with navigation.
-     */
-    navigation: NavigationSDK;
-    /**
-     * Utilities to interact with the active page.
-     */
-    window: WindowSDK;
-    /**
-     * Utilities to interact with frontend-plugin storage.
-     */
-    storage: StorageSDK;
-    /**
-     * Utilities to interact with the plugin's static assets.
-     */
-    assets: AssetsSDK;
-    /**
-     * Utilities to interact with shortcuts.
-     */
-    shortcuts: ShortcutsSDK;
-    /**
-     * Utilities to interact with the command palette.
-     */
-    commandPalette: CommandPaletteSDK;
-    /**
-     * Utilities to interact with the sidebar.
-     */
-    sidebar: SidebarSDK;
-    /**
-     * Utilities to interact with the Replay page.
-     */
-    replay: ReplaySDK;
-    /**
-     * Utilities to interact with the Search page.
-     */
-    search: SearchSDK;
-    /**
-     * Utilities to interact with the HTTP History page.
-     */
-    httpHistory: HTTPHistorySDK;
-    /**
-     * Utilities to interact with the Files page.
-     */
-    files: FilesSDK;
-    /**
-     * Utilities to interact with Filters page.
-     */
-    filters: FiltersSDK;
-    /**
-     * Utilities to interact with Match and Replace page.
-     */
-    matchReplace: MatchReplaceSDK;
-    /**
-     * Utilities to interact with the environment.
-     */
-    env: EnvironmentSDK;
-    /**
-     * Utilities to interact with the Sitemap page.
-     */
-    sitemap: SitemapSDK;
-    /**
-     * Utilities to interact with the Intercept page.
-     */
-    intercept: InterceptSDK;
-    /**
-     * Utilities to interact with the runtime.
-     */
-    runtime: RuntimeSDK;
-    /**
-     * Utilities to interact with workflows.
-     */
-    workflows: WorkflowSDK;
-    /**
-     * Utilities to interact with the footer.
-     */
-    footer: FooterSDK;
-};
+export { FooterSlot, type FooterSlotContent } from "./types/footer";
+export type { DialogOptions } from "./types/window";
+export type { CommandContext } from "./types/commands";
+export type { MenuItem } from "./types/menu";
+export { type ReplayTab, type ReplaySession, type ReplayCollection, ReplaySlot, type ReplaySlotContent, } from "./types/replay";
+export type { HostedFile } from "./types/files";
+export type { Filter } from "./types/filter";
+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 } from "./types/request";
+export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, } from "./types/matchReplace";
+export type { Scope } from "./types/scopes";
+export type { EnvironmentVariable } from "./types/environment";
+export type { Workflow, WorkflowKind, OnCreatedWorkflowCallback, OnUpdatedWorkflowCallback, OnDeletedWorkflowCallback, } from "./types/workflows";
+export type { ListenerHandle } from "./types/utils";
+export type { API } from "./sdks";

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

@@ -1,3 +1,4 @@
+import { type Asset } from "../types/assets";
 /**
  * Utilities to interact with the plugin's static assets.
  * @category Files
@@ -9,14 +10,3 @@ export type AssetsSDK = {
      */
     get: (path: string) => Promise<Asset>;
 };
-/**
- * A static asset.
- * @category Files
- */
-type Asset = {
-    asReadableStream: () => ReadableStream;
-    asArrayBuffer: () => Promise<ArrayBuffer>;
-    asString: () => Promise<string>;
-    asJson: <T = unknown>() => Promise<T>;
-};
-export {};

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

@@ -1,18 +1,5 @@
-import type { PromisifiedReturnType } from "./utils";
-/**
- * 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;
-};
+import { type BackendEndpoints, type BackendEvents } from "../types/backend";
+import type { PromisifiedReturnType } from "../types/utils";
 /**
  * Utilities to interact with the backend plugin.
  * @category Backend

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

@@ -1,3 +1,4 @@
+import { type CommandID } from "../types/commands";
 /**
  * Utilities to interact with the command palette.
  * @category Command Palette
@@ -5,8 +6,7 @@
 export type CommandPaletteSDK = {
     /**
      * Register a command.
-     * @deprecated Use `sdk.commandPalette.addToSlot` instead.
      * @param commandId The id of the command to register.
      */
-    register: (commandId: string) => void;
+    register: (commandId: CommandID) => void;
 };

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

@@ -0,0 +1,31 @@
+import type { CommandContext, CommandID } from "../types/commands";
+/**
+ * Utilities to interact with commands
+ * @category Commands
+ */
+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;
+};

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

@@ -1,3 +1,4 @@
+import { type EnvironmentVariable } from "../types/environment";
 /**
  * Utilities to interact with the environment.
  * @category Environment
@@ -15,17 +16,3 @@ export type EnvironmentSDK = {
      */
     getVars: () => EnvironmentVariable[];
 };
-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/{files.d.ts → sdks/files.d.ts}

@@ -1,3 +1,4 @@
+import { type HostedFile } from "../types/files";
 /**
  * SDK for interacting with the Files page.
  * @category Files
@@ -28,33 +29,3 @@ export type FilesSDK = {
      */
     delete: (id: string) => Promise<void>;
 };
-/**
- * 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/{filters.d.ts → sdks/filters.d.ts}

@@ -1,4 +1,5 @@
-import type { HTTPQL, ID } from "./utils";
+import { type Filter } from "../types/filter";
+import type { HTTPQL, ID } from "../types/utils";
 /**
  * SDK for interacting with the Filters page.
  * @category Filters
@@ -45,26 +46,3 @@ export type FiltersSDK = {
      */
     delete: (id: ID) => Promise<void>;
 };
-/**
- * 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/{findings.d.ts → sdks/findings.d.ts}

@@ -1,4 +1,5 @@
-import type { ID } from "./utils";
+import { type Finding } from "../types/findings";
+import type { ID } from "../types/utils";
 /**
  * Utilities to interact with findings
  * @category Findings
@@ -21,34 +22,3 @@ export type FindingsSDK = {
         dedupeKey?: string;
     }) => Promise<Finding | undefined>;
 };
-/**
- * Represents a {@link https://docs.caido.io/reference/features/logging/findings|Finding}.
- * @category Findings
- */
-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;
-};
-export {};

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

@@ -1,9 +1,5 @@
-import { type ButtonSlotContent, type CommandSlotContent, type CustomSlotContent, type DefineAddToSlotFn } from "./slots";
-export declare const FooterSlot: {
-    readonly FooterSlotPrimary: "footer-primary";
-    readonly FooterSlotSecondary: "footer-secondary";
-};
-export type FooterSlot = (typeof FooterSlot)[keyof typeof FooterSlot];
+import { type FooterSlotContent } from "../types/footer";
+import { type DefineAddToSlotFn } from "../types/slots";
 /**
  * Utilities to interact with the footer.
  * @category Footer
@@ -36,8 +32,5 @@ export type FooterSDK = {
      * });
      * ```
      */
-    addToSlot: DefineAddToSlotFn<{
-        [FooterSlot.FooterSlotPrimary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-        [FooterSlot.FooterSlotSecondary]: ButtonSlotContent | CustomSlotContent | CommandSlotContent;
-    }>;
+    addToSlot: DefineAddToSlotFn<FooterSlotContent>;
 };

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

@@ -1,6 +1,6 @@
 import type { Extension } from "@codemirror/state";
-import type { RequestViewModeOptions } from "./request";
-import type { HTTPQL, ID } from "./utils";
+import type { RequestViewModeOptions } from "../types/request";
+import type { HTTPQL, ID } from "../types/utils";
 /**
  * Utilities to interact with the HTTP History page.
  * @category HTTP History

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

@@ -0,0 +1,137 @@
+import type { Sdk as GraphqlSDK } from "../__generated__/graphql-sdk";
+import { type BackendEndpoints, type BackendEvents } from "../types/backend";
+import type { AssetsSDK } from "./assets";
+import type { BackendSDK } from "./backend";
+import type { CommandPaletteSDK } from "./commandPalette";
+import type { CommandsSDK } from "./commands";
+import type { EnvironmentSDK } from "./environment";
+import type { FilesSDK } from "./files";
+import type { FiltersSDK } from "./filters";
+import type { FindingsSDK } from "./findings";
+import type { FooterSDK } from "./footer";
+import type { HTTPHistorySDK } from "./httpHistory";
+import type { InterceptSDK } from "./intercept";
+import type { MatchReplaceSDK } from "./matchReplace";
+import type { MenuSDK } from "./menu";
+import type { NavigationSDK } from "./navigation";
+import type { ReplaySDK } from "./replay";
+import type { RuntimeSDK } from "./runtime";
+import type { ScopesSDK } from "./scopes";
+import type { SearchSDK } from "./search";
+import type { ShortcutsSDK } from "./shortcuts";
+import type { SidebarSDK } from "./sidebar";
+import type { SitemapSDK } from "./sitemap";
+import type { StorageSDK } from "./storage";
+import type { UISDK } from "./ui";
+import type { WindowSDK } from "./window";
+import type { WorkflowSDK } from "./workflows";
+/**
+ * Utilities for frontend plugins.
+ * @category SDK
+ */
+export type API<T extends BackendEndpoints = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
+    /**
+     * Utilities to interact with the GraphQL API.
+     */
+    graphql: GraphqlSDK;
+    /**
+     * Utilities to interact with the backend plugin.
+     */
+    backend: BackendSDK<T, E>;
+    /**
+     * Utilities to create UI components.
+     */
+    ui: UISDK;
+    /**
+     * Utilities to interact with scopes
+     */
+    scopes: ScopesSDK;
+    /**
+     * Utilities to interact with findings
+     */
+    findings: FindingsSDK;
+    /**
+     * Utilities to interact with commands
+     */
+    commands: CommandsSDK;
+    /**
+     * Utilities to insert menu items and context-menus throughout the UI.
+     */
+    menu: MenuSDK;
+    /**
+     * Utilities to interact with navigation.
+     */
+    navigation: NavigationSDK;
+    /**
+     * Utilities to interact with the active page.
+     */
+    window: WindowSDK;
+    /**
+     * Utilities to interact with frontend-plugin storage.
+     */
+    storage: StorageSDK;
+    /**
+     * Utilities to interact with the plugin's static assets.
+     */
+    assets: AssetsSDK;
+    /**
+     * Utilities to interact with shortcuts.
+     */
+    shortcuts: ShortcutsSDK;
+    /**
+     * Utilities to interact with the command palette.
+     */
+    commandPalette: CommandPaletteSDK;
+    /**
+     * Utilities to interact with the sidebar.
+     */
+    sidebar: SidebarSDK;
+    /**
+     * Utilities to interact with the Replay page.
+     */
+    replay: ReplaySDK;
+    /**
+     * Utilities to interact with the Search page.
+     */
+    search: SearchSDK;
+    /**
+     * Utilities to interact with the HTTP History page.
+     */
+    httpHistory: HTTPHistorySDK;
+    /**
+     * Utilities to interact with the Files page.
+     */
+    files: FilesSDK;
+    /**
+     * Utilities to interact with Filters page.
+     */
+    filters: FiltersSDK;
+    /**
+     * Utilities to interact with Match and Replace page.
+     */
+    matchReplace: MatchReplaceSDK;
+    /**
+     * Utilities to interact with the environment.
+     */
+    env: EnvironmentSDK;
+    /**
+     * Utilities to interact with the Sitemap page.
+     */
+    sitemap: SitemapSDK;
+    /**
+     * Utilities to interact with the Intercept page.
+     */
+    intercept: InterceptSDK;
+    /**
+     * Utilities to interact with the runtime.
+     */
+    runtime: RuntimeSDK;
+    /**
+     * Utilities to interact with workflows.
+     */
+    workflows: WorkflowSDK;
+    /**
+     * Utilities to interact with the footer.
+     */
+    footer: FooterSDK;
+};

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

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

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

@@ -0,0 +1,87 @@
+import { type MatchReplaceCollection, type MatchReplaceRule, type MatchReplaceSection } from "../types/matchReplace";
+import type { HTTPQL, ID } from "../types/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>;
+};