@caido/sdk-backend 0.55.3 → 0.55.4-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-backend",
-  "version": "0.55.3",
+  "version": "0.55.4-beta.1",
   "description": "Typing for the Caido Backend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",
@@ -10,10 +10,12 @@
     "src/*"
   ],
   "dependencies": {
-    "@caido/quickjs-types": "^0.25.4",
-    "@caido/sdk-shared": "^0.1.0"
+    "@caido/quickjs-types": "^0.26.0",
+    "@caido/sdk-shared": "^0.2.0"
   },
   "scripts": {
+    "build": "echo 'No build step required for @caido/sdk-backend'",
+    "typecheck": "tsc --noEmit",
     "generate:doc": "typedoc"
   }
 }

package/src/typing.d.ts

@@ -1,30 +1,47 @@
 declare module "caido:plugin" {
-  import type { Database } from "sqlite";
   import type {
-    MaybePromise,
-    FindingsSDK,
-    RequestsSDK,
-    Request,
-    Response,
-    ReplaySDK,
-    ProjectsSDK,
-    Project,
+    Connection,
     EnvironmentSDK,
-    RuntimeSDK,
-    ScopeSDK,
+    FindingsSDK,
     GraphQLSDK,
     HostedFileSDK,
+    MaybePromise,
     NetSDK,
-    RequestSpecRaw,
-    Connection,
+    Project,
+    ProjectsSDK,
+    ReplaySDK,
+    Request,
     RequestSpec,
+    RequestSpecRaw,
+    RequestsSDK,
+    Response,
+    RuntimeSDK,
+    ScopeSDK,
   } from "caido:utils";
+  import type { Database } from "sqlite";
+
+  type MaybePromise<T> = T | Promise<T>;
+
+  type AnyFn = (...args: any[]) => MaybePromise<any>;
+  type InvalidCallbackMessage =
+    "Your callback must respect the format (sdk: SDK, ...args: unknown[]) => MaybePromise<unknown>";
+  type ResolvedAPI<T> = T extends { api: infer A } ? A : T;
+  type APICallback<T> = T extends AnyFn
+    ? (sdk: SDK, ...args: Parameters<T>) => ReturnType<T>
+    : InvalidCallbackMessage;
+
+  type AnyVoidFn = (...args: any[]) => MaybePromise<void>;
+  type ResolvedEvents<T, Events> = T extends { events: infer A } ? A : Events;
+  type InvalidEventParametersMessage = "Invalid event parameters";
+  type EventParameters<T> = T extends AnyVoidFn
+    ? A
+    : InvalidEventParametersMessage;
 
   /**
    * The SDK for the API RPC service.
    * @category API
    */
-  export type APISDK<API = {}, Events = {}> = {
+  export type APISDK<SpecOrAPI = {}, Events = {}> = {
     /**
      * Sends an event to the frontend plugin.
      *
@@ -33,7 +50,10 @@ declare module "caido:plugin" {
      * sdk.api.send("myEvent", 5, "hello");
      * ```
      */
-    send(event: keyof Events, ...args: any[]): void;
+    send<K extends keyof ResolvedEvents<SpecOrAPI, Events>>(
+      event: K,
+      ...args: EventParameters<ResolvedEvents<SpecOrAPI, Events>[K]>
+    ): void;
 
     /**
      * Registers a new backend function for the RPC.
@@ -45,9 +65,9 @@ declare module "caido:plugin" {
      * });
      * ```
      */
-    register(
-      name: keyof API,
-      callback: (sdk: SDK, ...args: any[]) => MaybePromise<any>,
+    register<K extends keyof ResolvedAPI<SpecOrAPI>>(
+      name: K,
+      callback: APICallback<ResolvedAPI<SpecOrAPI>[K]>,
     ): void;
   };