@caido/sdk-frontend 0.44.2-beta.8 → 0.45.0

package/package.json

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

package/src/types/__generated__/graphql-sdk.d.ts

@@ -8770,9 +8770,11 @@ export type InterceptMessageMetaFragment = InterceptMessageMeta_InterceptRequest
 export type InterceptOptionsMetaFragment = {
     request: {
         enabled: boolean;
+        filter?: string | undefined | null;
     };
     response: {
         enabled: boolean;
+        filter?: string | undefined | null;
     };
     scope?: {
         scopeId: string;
@@ -8780,9 +8782,11 @@ export type InterceptOptionsMetaFragment = {
 };
 export type InterceptRequestOptionsMetaFragment = {
     enabled: boolean;
+    filter?: string | undefined | null;
 };
 export type InterceptResponseOptionsMetaFragment = {
     enabled: boolean;
+    filter?: string | undefined | null;
 };
 export type InterceptScopeOptionsMetaFragment = {
     scopeId: string;
@@ -8812,9 +8816,11 @@ export type SetInterceptOptionsMutation = {
         options: {
             request: {
                 enabled: boolean;
+                filter?: string | undefined | null;
             };
             response: {
                 enabled: boolean;
+                filter?: string | undefined | null;
             };
             scope?: {
                 scopeId: string;
@@ -9021,9 +9027,11 @@ export type InterceptOptionsQuery = {
     interceptOptions: {
         request: {
             enabled: boolean;
+            filter?: string | undefined | null;
         };
         response: {
             enabled: boolean;
+            filter?: string | undefined | null;
         };
         scope?: {
             scopeId: string;
@@ -9135,9 +9143,11 @@ export type UpdatedInterceptOptionsSubscription = {
         options: {
             request: {
                 enabled: boolean;
+                filter?: string | undefined | null;
             };
             response: {
                 enabled: boolean;
+                filter?: string | undefined | null;
             };
             scope?: {
                 scopeId: string;
@@ -15680,8 +15690,8 @@ export declare const HostedFileFullFragmentDoc = "\n    fragment hostedFileFull
 export declare const InterceptRequestMessageMetaFragmentDoc = "\n    fragment interceptRequestMessageMeta on InterceptRequestMessage {\n  __typename\n  id\n  request {\n    ...requestMeta\n  }\n}\n    ";
 export declare const InterceptResponseMessageMetaFragmentDoc = "\n    fragment interceptResponseMessageMeta on InterceptResponseMessage {\n  __typename\n  id\n  response {\n    ...responseMeta\n  }\n  request {\n    ...requestMeta\n  }\n}\n    ";
 export declare const InterceptMessageMetaFragmentDoc = "\n    fragment interceptMessageMeta on InterceptMessage {\n  __typename\n  ... on InterceptRequestMessage {\n    ...interceptRequestMessageMeta\n  }\n  ... on InterceptResponseMessage {\n    ...interceptResponseMessageMeta\n  }\n}\n    ";
-export declare const InterceptRequestOptionsMetaFragmentDoc = "\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n}\n    ";
-export declare const InterceptResponseOptionsMetaFragmentDoc = "\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n}\n    ";
+export declare const InterceptRequestOptionsMetaFragmentDoc = "\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n  filter\n}\n    ";
+export declare const InterceptResponseOptionsMetaFragmentDoc = "\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n  filter\n}\n    ";
 export declare const InterceptScopeOptionsMetaFragmentDoc = "\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
 export declare const InterceptOptionsMetaFragmentDoc = "\n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    ";
 export declare const TamperRuleFullFragmentDoc = "\n    fragment tamperRuleFull on TamperRule {\n  __typename\n  id\n  isEnabled\n  isRegex\n  name\n  matchTerm\n  replaceTerm\n  strategy\n  rank\n  condition\n  collection {\n    id\n  }\n}\n    ";
@@ -15858,15 +15868,15 @@ export declare const UploadHostedFileDocument = "\n    mutation uploadHostedFile
 export declare const HostedFilesDocument = "\n    query hostedFiles {\n  hostedFiles {\n    ...hostedFileFull\n  }\n}\n    \n    fragment hostedFileFull on HostedFile {\n  __typename\n  id\n  name\n  path\n  size\n  updatedAt\n  createdAt\n}\n    ";
 export declare const ForwardInterceptMessageDocument = "\n    mutation forwardInterceptMessage($id: ID!, $input: ForwardInterceptMessageInput) {\n  forwardInterceptMessage(id: $id, input: $input) {\n    forwardedId\n  }\n}\n    ";
 export declare const DropInterceptMesageDocument = "\n    mutation dropInterceptMesage($id: ID!) {\n  dropInterceptMessage(id: $id) {\n    droppedId\n  }\n}\n    ";
-export declare const SetInterceptOptionsDocument = "\n    mutation setInterceptOptions($input: InterceptOptionsInput!) {\n  setInterceptOptions(input: $input) {\n    options {\n      ...interceptOptionsMeta\n    }\n  }\n}\n    \n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    \n\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n}\n    \n\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n}\n    \n\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
+export declare const SetInterceptOptionsDocument = "\n    mutation setInterceptOptions($input: InterceptOptionsInput!) {\n  setInterceptOptions(input: $input) {\n    options {\n      ...interceptOptionsMeta\n    }\n  }\n}\n    \n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    \n\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n  filter\n}\n    \n\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n  filter\n}\n    \n\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
 export declare const PauseInterceptDocument = "\n    mutation pauseIntercept {\n  pauseIntercept {\n    status\n  }\n}\n    ";
 export declare const ResumeInterceptDocument = "\n    mutation resumeIntercept {\n  resumeIntercept {\n    status\n  }\n}\n    ";
 export declare const InterceptRequestMessagesDocument = "\n    query interceptRequestMessages($first: Int!) {\n  interceptMessages(first: $first, kind: REQUEST) {\n    nodes {\n      ...interceptMessageMeta\n    }\n  }\n}\n    \n    fragment interceptMessageMeta on InterceptMessage {\n  __typename\n  ... on InterceptRequestMessage {\n    ...interceptRequestMessageMeta\n  }\n  ... on InterceptResponseMessage {\n    ...interceptResponseMessageMeta\n  }\n}\n    \n\n    fragment interceptRequestMessageMeta on InterceptRequestMessage {\n  __typename\n  id\n  request {\n    ...requestMeta\n  }\n}\n    \n\n    fragment requestMeta on Request {\n  __typename\n  id\n  host\n  port\n  path\n  query\n  method\n  edited\n  isTls\n  sni\n  length\n  alteration\n  metadata {\n    ...requestMetadataFull\n  }\n  fileExtension\n  source\n  createdAt\n  response {\n    ...responseMeta\n  }\n}\n    \n\n    fragment requestMetadataFull on RequestMetadata {\n  __typename\n  id\n  color\n}\n    \n\n    fragment responseMeta on Response {\n  __typename\n  id\n  statusCode\n  roundtripTime\n  length\n  createdAt\n  alteration\n  edited\n}\n    \n\n    fragment interceptResponseMessageMeta on InterceptResponseMessage {\n  __typename\n  id\n  response {\n    ...responseMeta\n  }\n  request {\n    ...requestMeta\n  }\n}\n    ";
 export declare const InterceptResponseMessagesDocument = "\n    query interceptResponseMessages($first: Int!) {\n  interceptMessages(first: $first, kind: RESPONSE) {\n    nodes {\n      ...interceptMessageMeta\n    }\n  }\n}\n    \n    fragment interceptMessageMeta on InterceptMessage {\n  __typename\n  ... on InterceptRequestMessage {\n    ...interceptRequestMessageMeta\n  }\n  ... on InterceptResponseMessage {\n    ...interceptResponseMessageMeta\n  }\n}\n    \n\n    fragment interceptRequestMessageMeta on InterceptRequestMessage {\n  __typename\n  id\n  request {\n    ...requestMeta\n  }\n}\n    \n\n    fragment requestMeta on Request {\n  __typename\n  id\n  host\n  port\n  path\n  query\n  method\n  edited\n  isTls\n  sni\n  length\n  alteration\n  metadata {\n    ...requestMetadataFull\n  }\n  fileExtension\n  source\n  createdAt\n  response {\n    ...responseMeta\n  }\n}\n    \n\n    fragment requestMetadataFull on RequestMetadata {\n  __typename\n  id\n  color\n}\n    \n\n    fragment responseMeta on Response {\n  __typename\n  id\n  statusCode\n  roundtripTime\n  length\n  createdAt\n  alteration\n  edited\n}\n    \n\n    fragment interceptResponseMessageMeta on InterceptResponseMessage {\n  __typename\n  id\n  response {\n    ...responseMeta\n  }\n  request {\n    ...requestMeta\n  }\n}\n    ";
-export declare const InterceptOptionsDocument = "\n    query interceptOptions {\n  interceptOptions {\n    ...interceptOptionsMeta\n  }\n}\n    \n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    \n\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n}\n    \n\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n}\n    \n\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
+export declare const InterceptOptionsDocument = "\n    query interceptOptions {\n  interceptOptions {\n    ...interceptOptionsMeta\n  }\n}\n    \n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    \n\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n  filter\n}\n    \n\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n  filter\n}\n    \n\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
 export declare const InterceptStatusDocument = "\n    query interceptStatus {\n  interceptStatus\n}\n    ";
 export declare const CreatedInterceptMessageDocument = "\n    subscription createdInterceptMessage {\n  createdInterceptMessage {\n    messageEdge {\n      node {\n        ...interceptMessageMeta\n      }\n    }\n    snapshot\n  }\n}\n    \n    fragment interceptMessageMeta on InterceptMessage {\n  __typename\n  ... on InterceptRequestMessage {\n    ...interceptRequestMessageMeta\n  }\n  ... on InterceptResponseMessage {\n    ...interceptResponseMessageMeta\n  }\n}\n    \n\n    fragment interceptRequestMessageMeta on InterceptRequestMessage {\n  __typename\n  id\n  request {\n    ...requestMeta\n  }\n}\n    \n\n    fragment requestMeta on Request {\n  __typename\n  id\n  host\n  port\n  path\n  query\n  method\n  edited\n  isTls\n  sni\n  length\n  alteration\n  metadata {\n    ...requestMetadataFull\n  }\n  fileExtension\n  source\n  createdAt\n  response {\n    ...responseMeta\n  }\n}\n    \n\n    fragment requestMetadataFull on RequestMetadata {\n  __typename\n  id\n  color\n}\n    \n\n    fragment responseMeta on Response {\n  __typename\n  id\n  statusCode\n  roundtripTime\n  length\n  createdAt\n  alteration\n  edited\n}\n    \n\n    fragment interceptResponseMessageMeta on InterceptResponseMessage {\n  __typename\n  id\n  response {\n    ...responseMeta\n  }\n  request {\n    ...requestMeta\n  }\n}\n    ";
-export declare const UpdatedInterceptOptionsDocument = "\n    subscription updatedInterceptOptions {\n  updatedInterceptOptions {\n    options {\n      ...interceptOptionsMeta\n    }\n  }\n}\n    \n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    \n\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n}\n    \n\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n}\n    \n\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
+export declare const UpdatedInterceptOptionsDocument = "\n    subscription updatedInterceptOptions {\n  updatedInterceptOptions {\n    options {\n      ...interceptOptionsMeta\n    }\n  }\n}\n    \n    fragment interceptOptionsMeta on InterceptOptions {\n  request {\n    ...interceptRequestOptionsMeta\n  }\n  response {\n    ...interceptResponseOptionsMeta\n  }\n  scope {\n    ...interceptScopeOptionsMeta\n  }\n}\n    \n\n    fragment interceptRequestOptionsMeta on InterceptRequestOptions {\n  enabled\n  filter\n}\n    \n\n    fragment interceptResponseOptionsMeta on InterceptResponseOptions {\n  enabled\n  filter\n}\n    \n\n    fragment interceptScopeOptionsMeta on InterceptScopeOptions {\n  scopeId\n}\n    ";
 export declare const TamperRuleCollectionsDocument = "\n    query tamperRuleCollections {\n  tamperRuleCollections {\n    nodes {\n      ...tamperRuleCollectionFull\n    }\n    pageInfo {\n      ...pageInfoFull\n    }\n    snapshot\n  }\n}\n    \n    fragment tamperRuleCollectionFull on TamperRuleCollection {\n  __typename\n  id\n  name\n  rules {\n    ...tamperRuleFull\n  }\n}\n    \n\n    fragment tamperRuleFull on TamperRule {\n  __typename\n  id\n  isEnabled\n  isRegex\n  name\n  matchTerm\n  replaceTerm\n  strategy\n  rank\n  condition\n  collection {\n    id\n  }\n}\n    \n\n    fragment pageInfoFull on PageInfo {\n  __typename\n  hasPreviousPage\n  hasNextPage\n  startCursor\n  endCursor\n}\n    ";
 export declare const RenameTamperRuleCollectionDocument = "\n    mutation renameTamperRuleCollection($id: ID!, $name: String!) {\n  renameTamperRuleCollection(id: $id, name: $name) {\n    collection {\n      ...tamperRuleCollectionFull\n    }\n  }\n}\n    \n    fragment tamperRuleCollectionFull on TamperRuleCollection {\n  __typename\n  id\n  name\n  rules {\n    ...tamperRuleFull\n  }\n}\n    \n\n    fragment tamperRuleFull on TamperRule {\n  __typename\n  id\n  isEnabled\n  isRegex\n  name\n  matchTerm\n  replaceTerm\n  strategy\n  rank\n  condition\n  collection {\n    id\n  }\n}\n    ";
 export declare const CreateTamperRuleCollectionDocument = "\n    mutation createTamperRuleCollection($input: CreateTamperRuleCollectionInput!) {\n  createTamperRuleCollection(input: $input) {\n    collection {\n      ...tamperRuleCollectionFull\n    }\n  }\n}\n    \n    fragment tamperRuleCollectionFull on TamperRuleCollection {\n  __typename\n  id\n  name\n  rules {\n    ...tamperRuleFull\n  }\n}\n    \n\n    fragment tamperRuleFull on TamperRule {\n  __typename\n  id\n  isEnabled\n  isRegex\n  name\n  matchTerm\n  replaceTerm\n  strategy\n  rank\n  condition\n  collection {\n    id\n  }\n}\n    ";

package/src/types/environment.d.ts

@@ -9,4 +9,23 @@ export type EnvironmentSDK = {
      * @returns The value of the environment variable.
      */
     getVar: (name: string) => string | undefined;
+    /**
+     * Get all environment variables available in the global environment and the selected environment.
+     * @returns All environment variables.
+     */
+    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/httpHistory.d.ts

@@ -1,4 +1,4 @@
-import type { HTTPQL } from "./utils";
+import type { HTTPQL, ID } from "./utils";
 /**
  * Utilities to interact with the HTTP History page.
  * @category HTTP History
@@ -14,4 +14,14 @@ export type HTTPHistorySDK = {
      * @returns The current HTTPQL query.
      */
     getQuery: () => HTTPQL;
+    /**
+     * Get the current scope ID.
+     * @returns The current scope ID.
+     */
+    getScopeId: () => ID | undefined;
+    /**
+     * Set the current scope.
+     * @param id The ID of the scope to set.
+     */
+    setScope: (id: ID | undefined) => Promise<void>;
 };

package/src/types/index.d.ts

@@ -7,6 +7,7 @@ import type { FilesSDK } from "./files";
 import type { FiltersSDK } from "./filters";
 import type { FindingsSDK } from "./findings";
 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";
@@ -15,6 +16,7 @@ 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";
@@ -25,6 +27,8 @@ export type { HostedFile } from "./files";
 export type { Filter } from "./filters";
 export type { HTTPQL, ID } from "./utils";
 export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceStrategy, } from "./matchReplace";
+export type { Scope } from "./scopes";
+export type { EnvironmentVariable } from "./environment";
 /**
  * Utilities for frontend plugins.
  * @category SDK
@@ -110,4 +114,12 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * 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;
 };

package/src/types/intercept.d.ts

@@ -0,0 +1,17 @@
+import type { ID } from "./utils";
+/**
+ * Utilities to interact with the Intercept page.
+ * @category Intercept
+ */
+export type InterceptSDK = {
+    /**
+     * Get the current scope ID.
+     * @returns The current scope ID.
+     */
+    getScopeId: () => ID | undefined;
+    /**
+     * Set the current scope.
+     * @param scopeId The ID of the scope to set.
+     */
+    setScope: (id: ID | undefined) => void;
+};

package/src/types/scopes.d.ts

@@ -56,7 +56,7 @@ export type ScopesSDK = {
  * Represents a scope.
  * @category Scopes
  */
-type Scope = {
+export type Scope = {
     /**
      * The unique ID of the scope.
      */
@@ -74,4 +74,3 @@ type Scope = {
      */
     denylist: string[];
 };
-export {};

package/src/types/search.d.ts

@@ -1,4 +1,4 @@
-import type { HTTPQL } from "./utils";
+import type { HTTPQL, ID } from "./utils";
 /**
  * Utilities to interact with the Search page.
  * @category Search
@@ -14,4 +14,14 @@ export type SearchSDK = {
      * @returns The current HTTPQL query.
      */
     getQuery: () => HTTPQL;
+    /**
+     * Get the current scope ID.
+     * @returns The current scope ID.
+     */
+    getScopeId: () => ID | undefined;
+    /**
+     * Set the current scope.
+     * @param id The ID of the scope to set.
+     */
+    setScope: (id: ID | undefined) => Promise<void>;
 };

package/src/types/sitemap.d.ts

@@ -0,0 +1,17 @@
+import type { ID } from "./utils";
+/**
+ * Utilities to interact with the Sitemap page.
+ * @category Sitemap
+ */
+export type SitemapSDK = {
+    /**
+     * Get the current scope ID.
+     * @returns The current scope ID.
+     */
+    getScopeId: () => ID | undefined;
+    /**
+     * Set the current scope.
+     * @param id The ID of the scope to set.
+     */
+    setScope: (id: ID | undefined) => void;
+};