@caido/sdk-frontend 0.44.2-beta.9 → 0.45.1-beta.0

package/package.json

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

package/src/types/assets.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Utilities to interact with the plugin's static assets.
+ * @category Files
+ */
+export type AssetsSDK = {
+    /**
+     * Get a file from the assets folder.
+     * @returns The asset file.
+     */
+    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/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

@@ -1,4 +1,5 @@
 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";
@@ -7,6 +8,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 +17,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 +28,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
@@ -70,6 +75,10 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * 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.
      */
@@ -110,4 +119,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;
+};