@caido/sdk-backend 0.41.1-beta.2 → 0.41.1-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/src/typing.d.ts +13 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@caido/sdk-backend",
|
|
3
|
-
"version": "0.41.1-beta.
|
|
3
|
+
"version": "0.41.1-beta.4",
|
|
4
4
|
"description": "Typing for the Caido Backend SDK",
|
|
5
5
|
"author": "Caido Labs Inc. <dev@caido.io>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"src/*"
|
|
10
10
|
],
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@caido/quickjs-types": "0.8.
|
|
12
|
+
"@caido/quickjs-types": "0.8.5",
|
|
13
13
|
"@caido/sdk-shared": "0.1.1"
|
|
14
14
|
},
|
|
15
15
|
"scripts": {
|
package/src/typing.d.ts
CHANGED
|
@@ -11,14 +11,16 @@ declare module "caido:plugin" {
|
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* The SDK for the API RPC service.
|
|
14
|
-
* @category
|
|
14
|
+
* @category API
|
|
15
15
|
*/
|
|
16
16
|
export type APISDK<API = {}, Events = {}> = {
|
|
17
17
|
/**
|
|
18
18
|
* Sends an event to the frontend plugin.
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
|
+
* ```ts
|
|
21
22
|
* sdk.api.send("myEvent", 5, "hello");
|
|
23
|
+
* ```
|
|
22
24
|
*/
|
|
23
25
|
send(event: keyof Events, ...args: any[]): void;
|
|
24
26
|
|
|
@@ -26,9 +28,11 @@ declare module "caido:plugin" {
|
|
|
26
28
|
* Registers a new backend function for the RPC.
|
|
27
29
|
*
|
|
28
30
|
* @example
|
|
31
|
+
* ```ts
|
|
29
32
|
* sdk.api.register("multiply", (sdk: SDK, a: number, b: number) => {
|
|
30
33
|
* return a * b;
|
|
31
34
|
* });
|
|
35
|
+
* ```
|
|
32
36
|
*/
|
|
33
37
|
register(
|
|
34
38
|
name: keyof API,
|
|
@@ -38,7 +42,7 @@ declare module "caido:plugin" {
|
|
|
38
42
|
|
|
39
43
|
/**
|
|
40
44
|
* The SDK for the API RPC service.
|
|
41
|
-
* @category
|
|
45
|
+
* @category Events
|
|
42
46
|
*/
|
|
43
47
|
export type EventsSDK<API = {}, Events = {}> = {
|
|
44
48
|
/**
|
|
@@ -47,9 +51,11 @@ declare module "caido:plugin" {
|
|
|
47
51
|
* This callback is called asynchronously and cannot modify requests.
|
|
48
52
|
*
|
|
49
53
|
* @example
|
|
50
|
-
*
|
|
54
|
+
* ```ts
|
|
55
|
+
* sdk.events.onInterceptRequest((sdk, request) => {
|
|
51
56
|
* // Do something with the request
|
|
52
57
|
* });
|
|
58
|
+
* ```
|
|
53
59
|
*/
|
|
54
60
|
onInterceptRequest(
|
|
55
61
|
callback: (sdk: SDK<API, Events>, request: Request) => MaybePromise<void>,
|
|
@@ -61,9 +67,11 @@ declare module "caido:plugin" {
|
|
|
61
67
|
* This callback is called asynchronously and cannot modify responses.
|
|
62
68
|
*
|
|
63
69
|
* @example
|
|
64
|
-
*
|
|
70
|
+
* ```ts
|
|
71
|
+
* sdk.events.onInterceptResponse((sdk, request, response) => {
|
|
65
72
|
* // Do something with the request/response
|
|
66
73
|
* });
|
|
74
|
+
* ```
|
|
67
75
|
*/
|
|
68
76
|
onInterceptResponse(
|
|
69
77
|
callback: (
|
|
@@ -76,7 +84,7 @@ declare module "caido:plugin" {
|
|
|
76
84
|
|
|
77
85
|
/**
|
|
78
86
|
* The SDK for metadata information about the plugin.
|
|
79
|
-
* @category
|
|
87
|
+
* @category Meta
|
|
80
88
|
*/
|
|
81
89
|
export type MetaSDK = {
|
|
82
90
|
/**
|