@caido/sdk-workflow 0.41.0 → 0.41.1-beta.1

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.
Files changed (2) hide show
  1. package/package.json +5 -2
  2. package/src/typing.d.ts +25 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caido/sdk-workflow",
3
- "version": "0.41.0",
3
+ "version": "0.41.1-beta.1",
4
4
  "description": "Typing for the Caido Workflow SDK",
5
5
  "author": "Caido Labs Inc. <dev@caido.io>",
6
6
  "license": "MIT",
@@ -9,6 +9,9 @@
9
9
  "src/*"
10
10
  ],
11
11
  "dependencies": {
12
- "@caido/quickjs-types": "0.7.0"
12
+ "@caido/quickjs-types": "0.8.2"
13
+ },
14
+ "scripts": {
15
+ "documentation": "typedoc"
13
16
  }
14
17
  }
package/src/typing.d.ts CHANGED
@@ -5,27 +5,47 @@ declare module "caido:workflow" {
5
5
  RequestsSDK,
6
6
  Request,
7
7
  Response,
8
+ ReplaySDK,
8
9
  } from "caido:utils";
9
10
 
11
+ /**
12
+ * The input for the HTTP Javascript Nodes
13
+ * @category Data
14
+ */
10
15
  export type HttpInput = {
11
16
  request: Request | undefined;
12
17
  response: Response | undefined;
13
18
  };
14
19
  /**
15
20
  * @deprecated Use HttpInput instead.
21
+ * @category Data
16
22
  */
17
23
  export type PassiveInput = HttpInput;
24
+ /**
25
+ * The input for the Javascript Nodes.
26
+ * @category Data
27
+ */
18
28
  export type BytesInput = Array<number>;
19
29
  /**
20
30
  * @deprecated Use BytesInput instead.
31
+ * @category Data
21
32
  */
22
33
  export type ConvertInput = BytesInput;
23
34
 
35
+ /**
36
+ * The output for the Javascript Nodes.
37
+ * @category Data
38
+ */
24
39
  export type Data = Bytes;
40
+ /**
41
+ * The output for the If/Else Javascript Nodes.
42
+ * @category Data
43
+ */
25
44
  export type Decision = boolean;
26
45
 
27
46
  /**
28
47
  * The SDK object available to all scripts.
48
+ * @category SDK
29
49
  */
30
50
  export type SDK = {
31
51
  /**
@@ -39,9 +59,13 @@ declare module "caido:workflow" {
39
59
  */
40
60
  findings: FindingsSDK;
41
61
  /**
42
- * The SDK for the Requests services
62
+ * The SDK for the Requests service.
43
63
  */
44
64
  requests: RequestsSDK;
65
+ /**
66
+ * The SDK for the Replay service.
67
+ */
68
+ replay: ReplaySDK;
45
69
  /**
46
70
  * Converts bytes to a string.
47
71
  *