@caido/sdk-backend 0.54.0 → 0.55.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-backend",
-  "version": "0.54.0",
+  "version": "0.55.0-beta.0",
   "description": "Typing for the Caido Backend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",
@@ -10,7 +10,7 @@
     "src/*"
   ],
   "dependencies": {
-    "@caido/quickjs-types": "^0.24.0",
+    "@caido/quickjs-types": "^0.25.0",
     "@caido/sdk-shared": "^0.1.0"
   },
   "scripts": {

package/src/typing.d.ts

@@ -14,6 +14,10 @@ declare module "caido:plugin" {
     ScopeSDK,
     GraphQLSDK,
     HostedFileSDK,
+    NetSDK,
+    RequestSpecRaw,
+    Connection,
+    RequestSpec,
   } from "caido:utils";
 
   /**
@@ -47,6 +51,19 @@ declare module "caido:plugin" {
     ): void;
   };
 
+  /**
+   * The result of an upstream callback.
+   * @category Events
+   */
+  export type UpstreamResult =
+    | Connection
+    | RequestSpec
+    | {
+        connection?: Connection;
+        request?: RequestSpec;
+      }
+    | undefined;
+
   /**
    * The SDK for the API RPC service.
    * @category Events
@@ -110,6 +127,35 @@ declare module "caido:plugin" {
         project: Project | null,
       ) => MaybePromise<void>,
     ): void;
+
+    /**
+     * Callback called before the request is sent to the target.
+     *
+     * This callback is called synchronously so special care should be taken
+     * to not impact overall performance.
+     *
+     * The callback can return a `Connection` that will then be used to send the request.
+     * It can also return a `RequestSpec` to override the request sent to the target.
+     *
+     * This will only be called if the user has enabled it for a given domain
+     * in the settings for Upstream Plugins.
+     *
+     * @example
+     * ```ts
+     * sdk.events.onUpstream(async (sdk, request) => {
+     *    // Send all requests to example.com
+     *    return {
+     *      connection: await sdk.net.connect("https://example.com"),
+     *    };
+     * });
+     * ```
+     */
+    onUpstream(
+      callback: (
+        sdk: SDK<API, Events>,
+        request: RequestSpecRaw,
+      ) => MaybePromise<UpstreamResult>,
+    ): void;
   };
 
   /**
@@ -205,5 +251,9 @@ declare module "caido:plugin" {
      * The SDK for the HostedFile service.
      */
     hostedFile: HostedFileSDK;
+    /**
+     * The SDK for the Net service.
+     */
+    net: NetSDK;
   }
 }