@caido/sdk-backend 0.1.1 → 0.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-backend",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Typing for the Caido Backend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",

package/src/index.d.ts

@@ -1,2 +1,5 @@
+///<reference path="types/runtime.d.ts" />
+///<reference path="types/common.d.ts" />
+///<reference path="types/typing.d.ts" />
 export * from "caido:common";
-export * from "./types/typing";
+export * from "caido:sdk";

package/src/types/typing.d.ts

@@ -1,43 +1,58 @@
-import { MaybePromise, FindingsSDK, RequestsSDK } from "caido:common";
+declare module "caido:sdk" {
+  import { MaybePromise, FindingsSDK, RequestsSDK } from "caido:common";
 
-/**
- * The SDK for the API RPC service.
- */
-export type APISDK = {
-  /**
-   * Registers a new backend function for the RPC.
-   *
-   * @example
-   * sdk.api.register("multiply", (a: number, b: number) => {
-   *    return a * b;
-   * });
-   */
-  register(
-    name: string,
-    callback: (...args: unknown[]) => MaybePromise<unknown>,
-  ): void;
-};
+  export type DefineAPI<
+    API extends Record<string, (...args: any[]) => MaybePromise<any>>,
+  > = {
+    [K in keyof API]: DefineCallback<API[K]>;
+  };
+
+  export type DefineCallback<F> = F extends (
+    sdk: SDK,
+    ...args: infer A
+  ) => infer R
+    ? (...args: A) => R
+    : "Your callback must respect the format (sdk: SDK, ...args: unknown[]) => MaybePromise<unknown>";
 
-/**
- * The SDK object available to all scripts.
- */
-export type SDK = {
-  /**
-   * The console.
-   *
-   * This is currently the same as the global `console`.
-   */
-  console: Console;
-  /**
-   * The SDK for the Findings service.
-   */
-  findings: FindingsSDK;
   /**
-   * The SDK for the Requests services
+   * The SDK for the API RPC service.
    */
-  requests: RequestsSDK;
+  export type APISDK = {
+    /**
+     * Registers a new backend function for the RPC.
+     *
+     * @example
+     * sdk.api.register("multiply", (a: number, b: number) => {
+     *    return a * b;
+     * });
+     */
+    register(
+      name: string,
+      callback: (sdk: SDK, ...args: any[]) => MaybePromise<any>,
+    ): void;
+  };
+
   /**
-   * The SDK for the API RPC service.
+   * The SDK object available to all scripts.
    */
-  api: APISDK;
-};
+  export type SDK = {
+    /**
+     * The console.
+     *
+     * This is currently the same as the global `console`.
+     */
+    console: Console;
+    /**
+     * The SDK for the Findings service.
+     */
+    findings: FindingsSDK;
+    /**
+     * The SDK for the Requests services
+     */
+    requests: RequestsSDK;
+    /**
+     * The SDK for the API RPC service.
+     */
+    api: APISDK;
+  };
+}