@caido/sdk-frontend 0.42.1-beta.6 → 0.42.1-beta.8

package/package.json

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

package/src/types/filters.d.ts

@@ -0,0 +1,70 @@
+import type { HTTPQL, ID } from "./utils";
+/**
+ * SDK for interacting with the Filters page.
+ * @category Filters
+ */
+export type FiltersSDK = {
+    /**
+     * Gets all filters.
+     * @returns The filters.
+     */
+    getAll: () => Filter[];
+    /**
+     * Creates a filter.
+     * @param options Options for the filter.
+     * @param options.name The name of the filter. Should be unique.
+     * @param options.query The HTTPQL query of the filter.
+     * @param options.alias The alias of the filter. Used when referencing the filter in an HTTPQL query (e.g. `preset:my-alias`).
+     *
+     * Should be unique and follow the format `[a-zA-Z0-9_-]+`.
+     *
+     * @returns The created filter.
+     */
+    create: (options: {
+        name: string;
+        query: HTTPQL;
+        alias: string;
+    }) => Promise<Filter>;
+    /**
+     * Updates a filter.
+     * @param id The ID of the filter to update.
+     * @param options Options for the filter.
+     * @param options.name The name of the filter.
+     * @param options.alias The alias of the filter.
+     * @param options.query The HTTPQL query of the filter.
+     * @returns The updated filter.
+     */
+    update: (id: ID, options: {
+        name: string;
+        alias: string;
+        query: HTTPQL;
+    }) => Promise<Filter>;
+    /**
+     * Deletes a filter.
+     * @param id The ID of the filter to delete.
+     */
+    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/httpHistory.d.ts

@@ -1,3 +1,4 @@
+import type { HTTPQL } from "./utils";
 /**
  * Utilities to interact with the HTTP History page.
  * @category HTTP History
@@ -7,10 +8,10 @@ export type HTTPHistorySDK = {
      * Set the HTTPQL query that will be applied on the HTTP History table results.
      * @param query The HTTPQL query.
      */
-    setQuery: (query: string) => void;
+    setQuery: (query: HTTPQL) => void;
     /**
      * Get the current HTTPQL query.
      * @returns The current HTTPQL query.
      */
-    getQuery: () => string;
+    getQuery: () => HTTPQL;
 };

package/src/types/index.d.ts

@@ -15,10 +15,15 @@ import type { ReplaySDK } from "./replay";
 import type { SearchSDK } from "./search";
 import type { HTTPHistorySDK } from "./httpHistory";
 import type { FilesSDK } from "./files";
+import type { FiltersSDK } from "./filters";
+import type { MatchReplaceSDK } from "./matchReplace";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
 export type { ReplayTab, ReplaySession, ReplayCollection } from "./replay";
 export type { HostedFile } from "./files";
+export type { Filter } from "./filters";
+export type { HTTPQL, ID } from "./utils";
+export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceStrategy, } from "./matchReplace";
 /**
  * Utilities for frontend plugins.
  * @category SDK
@@ -89,7 +94,15 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      */
     httpHistory: HTTPHistorySDK;
     /**
-     * Utilities to interact with files.
+     * 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;
 };

package/src/types/matchReplace.d.ts

@@ -0,0 +1,150 @@
+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.isEnabled - Whether the rule is enabled.
+     * @param options.matchTerm - The match term of the rule.
+     * @param options.replaceTerm - The replace term of the rule.
+     * @param options.isRegex - Whether the match term is a regex.
+     * @param options.strategy - The strategy 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;
+        isEnabled: boolean;
+        matchTerm: string;
+        replaceTerm: string;
+        isRegex: boolean;
+        query: HTTPQL;
+        strategy: MatchReplaceStrategy;
+        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.isEnabled - Whether the rule is enabled.
+     * @param options.matchTerm - The new match term of the rule.
+     * @param options.replaceTerm - The new replace term of the rule.
+     * @param options.isRegex - Whether the match term is a regex.
+     * @param options.query - The new HTTPQL query of the rule.
+     * @param options.strategy - The new strategy of the rule.
+     */
+    updateRule: (id: ID, options: {
+        name: string;
+        isEnabled: boolean;
+        matchTerm: string;
+        replaceTerm: string;
+        isRegex: boolean;
+        query: HTTPQL;
+        strategy: MatchReplaceStrategy;
+    }) => Promise<MatchReplaceRule>;
+    /**
+     * Delete a rule.
+     * @param id - The ID of the rule.
+     */
+    deleteRule: (id: ID) => Promise<void>;
+};
+/**
+ * A rule in Match and Replace.
+ * @category Match and Replace
+ */
+export type MatchReplaceRule = {
+    /**
+     * The ID of the rule.
+     */
+    id: ID;
+    /**
+     * The name of the rule.
+     */
+    name: string;
+    /**
+     * Whether the rule is enabled.
+     */
+    isEnabled: boolean;
+    /**
+     * The match term of the rule.
+     */
+    matchTerm: string;
+    /**
+     * The replace term of the rule.
+     */
+    replaceTerm: string;
+    /**
+     * Whether the match term is a regex.
+     */
+    isRegex: boolean;
+    /**
+     * The HTTPQL query to match the rule against.
+     * Only requests that match the query will be affected by the rule.
+     */
+    query: HTTPQL;
+    /**
+     * The strategy of the rule.
+     */
+    strategy: MatchReplaceStrategy;
+    /**
+     * The ID of the collection the rule belongs to.
+     */
+    collectionId: ID;
+};
+export type MatchReplaceStrategy = "REQUEST_FIRST_LINE" | "REQUEST_HEADER" | "REQUEST_BODY" | "RESPONSE_FIRST_LINE" | "RESPONSE_HEADER" | "RESPONSE_BODY";
+/**
+ * A collection in Match and Replace.
+ * @category Match and Replace
+ */
+export type MatchReplaceCollection = {
+    id: ID;
+    name: string;
+    ruleIds: ID[];
+};

package/src/types/replay.d.ts

@@ -1,3 +1,4 @@
+import type { ID } from "./utils";
 /**
  * A replay tab.
  * @category Replay
@@ -6,7 +7,7 @@ export type ReplayTab = {
     /**
      * The ID of the session associated with this tab.
      */
-    sessionId: string;
+    sessionId: ID;
 };
 /**
  * A session in Replay.
@@ -16,7 +17,7 @@ export type ReplaySession = {
     /**
      * The ID of the session.
      */
-    id: string;
+    id: ID;
     /**
      * The name of the session.
      */
@@ -24,7 +25,7 @@ export type ReplaySession = {
     /**
      * The ID of the collection the session belongs to.
      */
-    collectionId: string;
+    collectionId: ID;
 };
 /**
  * A collection in Replay.
@@ -34,7 +35,7 @@ export type ReplayCollection = {
     /**
      * The ID of the collection.
      */
-    id: string;
+    id: ID;
     /**
      * The name of the collection.
      */
@@ -42,7 +43,7 @@ export type ReplayCollection = {
     /**
      * The sessions in the collection.
      */
-    sessionIds: string[];
+    sessionIds: ID[];
 };
 /**
  * Utilities to interact with Replay.
@@ -53,12 +54,12 @@ export type ReplaySDK = {
      * Open a replay tab for the given session.
      * @param sessionId The ID of the session to open.
      */
-    openTab: (sessionId: string) => void;
+    openTab: (sessionId: ID) => void;
     /**
      * Close a replay tab for the given session.
      * @param sessionId The ID of the session to close.
      */
-    closeTab: (sessionId: string) => void;
+    closeTab: (sessionId: ID) => void;
     /**
      * Get the list of all open replay tabs.
      * @returns The list of all open replay tabs.
@@ -80,5 +81,5 @@ export type ReplaySDK = {
      * @param name The new name of the session.
      * @returns The updated session.
      */
-    renameSession: (id: string, name: string) => Promise<ReplaySession>;
+    renameSession: (id: ID, name: string) => Promise<ReplaySession>;
 };

package/src/types/search.d.ts

@@ -1,3 +1,4 @@
+import type { HTTPQL } from "./utils";
 /**
  * Utilities to interact with the Search page.
  * @category Search
@@ -7,10 +8,10 @@ export type SearchSDK = {
      * Set the HTTPQL query that will be applied on the search table results.
      * @param query The HTTPQL query.
      */
-    setQuery: (query: string) => void;
+    setQuery: (query: HTTPQL) => void;
     /**
      * Get the current HTTPQL query.
      * @returns The current HTTPQL query.
      */
-    getQuery: () => string;
+    getQuery: () => HTTPQL;
 };

package/src/types/utils.d.ts

@@ -12,6 +12,13 @@ export type ID = string & {
 export type CommandID = string & {
     __commandId?: never;
 };
+/**
+ * An HTTPQL expression.
+ * @example `req.method.eq:"POST"`
+ */
+export type HTTPQL = string & {
+    __httpql?: never;
+};
 /**
  * A {@link https://fontawesome.com/icons|FontAwesome} icon class.
  * @example "fas fa-rocket"