Skip to content

Commit 7c533e5

Browse files
caidobotcaidobot
committed
Update SDK Documentation
1 parent fd6efb4 commit 7c533e5

File tree

8 files changed

+508
-1
lines changed

8 files changed

+508
-1
lines changed

‎src/reference/sdks/frontend/ai.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,51 @@ Creates a new AI provider instance that can be used with the [ai](https://ai-sdk
6767
[`AIProvider`](#aiprovider)
6868

6969
A provider instance compatible with the [ai](https://ai-sdk.dev/) library.
70+
71+
##### getUpstreamProviders()
72+
73+
> **getUpstreamProviders**: () => [`AIUpstreamProvider`](#aiupstreamprovider)[]
74+
75+
Gets the list of upstream AI providers with their configuration status.
76+
77+
###### Returns
78+
79+
[`AIUpstreamProvider`](#aiupstreamprovider)[]
80+
81+
An array of AI upstream providers with their configuration status.
82+
83+
***
84+
85+
### AIUpstreamProvider
86+
87+
> **AIUpstreamProvider** = `object`
88+
89+
AI upstream provider information.
90+
91+
#### Properties
92+
93+
##### id
94+
95+
> **id**: [`AIUpstreamProviderId`](#aiupstreamproviderid)
96+
97+
##### status
98+
99+
> **status**: [`AIUpstreamProviderStatus`](#aiupstreamproviderstatus)
100+
101+
***
102+
103+
### AIUpstreamProviderId
104+
105+
> **AIUpstreamProviderId** = `"anthropic"` \| `"google"` \| `"openai"` \| `"openrouter"`
106+
107+
AI upstream provider ID.
108+
109+
***
110+
111+
### AIUpstreamProviderStatus
112+
113+
> **AIUpstreamProviderStatus** = `"Ready"` \| `"Missing"`
114+
115+
AI upstream provider status.
116+
Ready: The upstream provider is ready to use.
117+
Missing: The upstream provider is not configured.

‎src/reference/sdks/frontend/automate.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,33 @@
11
# Automate
22

3+
### AutomateEntry
4+
5+
> **AutomateEntry** = `object`
6+
7+
A automate entry.
8+
9+
#### Properties
10+
11+
##### createdAt
12+
13+
> **createdAt**: `Date`
14+
15+
The date the entry was created.
16+
17+
##### id
18+
19+
> **id**: [`ID`](utils.md#id)
20+
21+
The ID of the entry.
22+
23+
##### name
24+
25+
> **name**: `string`
26+
27+
The name of the entry.
28+
29+
***
30+
331
### AutomateSDK
432

533
> **AutomateSDK** = `object`
@@ -8,6 +36,38 @@ Utilities to interact with the Automate page.
836

937
#### Properties
1038

39+
##### addEntryIndicator()
40+
41+
> **addEntryIndicator**: (`entryId`: `ID`, `indicator`: `AddIndicatorOptions`) => `Indicator`
42+
43+
Add an indicator to an automate entry.
44+
Indicators are displayed next to the entry name in the collections tree.
45+
46+
###### Parameters
47+
48+
| Parameter | Type | Description |
49+
| ------ | ------ | ------ |
50+
| `entryId` | `ID` | The ID of the entry to add the indicator to. |
51+
| `indicator` | `AddIndicatorOptions` | The indicator configuration. |
52+
53+
###### Returns
54+
55+
`Indicator`
56+
57+
A handle object with a `remove` method to remove the indicator.
58+
59+
###### Example
60+
61+
```ts
62+
const indicator = sdk.automate.addEntryIndicator(entryId, {
63+
icon: "fas fa-exclamation-triangle",
64+
description: "Security warning",
65+
});
66+
67+
// Later, remove the indicator
68+
indicator.remove();
69+
```
70+
1171
##### addRequestEditorExtension()
1272

1373
> **addRequestEditorExtension**: (`extension`: `Extension`) => `void`
@@ -39,3 +99,67 @@ Add a custom request view mode.
3999
###### Returns
40100

41101
`void`
102+
103+
##### getEntries()
104+
105+
> **getEntries**: (`sessionId`: `ID`) => `AutomateEntry`[]
106+
107+
Get the list of all automate entries.
108+
109+
###### Parameters
110+
111+
| Parameter | Type | Description |
112+
| ------ | ------ | ------ |
113+
| `sessionId` | `ID` | The ID of the session to get the entries of. |
114+
115+
###### Returns
116+
117+
`AutomateEntry`[]
118+
119+
The list of all automate entries.
120+
121+
##### getSessions()
122+
123+
> **getSessions**: () => `AutomateSession`[]
124+
125+
Get the list of all automate sessions.
126+
127+
###### Returns
128+
129+
`AutomateSession`[]
130+
131+
The list of all automate sessions.
132+
133+
***
134+
135+
### AutomateSession
136+
137+
> **AutomateSession** = `object`
138+
139+
A automate session.
140+
141+
#### Properties
142+
143+
##### createdAt
144+
145+
> **createdAt**: `Date`
146+
147+
The date the session was created.
148+
149+
##### entryIds
150+
151+
> **entryIds**: [`ID`](utils.md#id)[]
152+
153+
The IDs of all entries in this session.
154+
155+
##### id
156+
157+
> **id**: [`ID`](utils.md#id)
158+
159+
The ID of the session.
160+
161+
##### name
162+
163+
> **name**: `string`
164+
165+
The name of the session.

‎src/reference/sdks/frontend/match-and-replace.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,38 @@ Utilities to interact with the Match and Replace page.
597597

598598
#### Properties
599599

600+
##### addRuleIndicator()
601+
602+
> **addRuleIndicator**: (`ruleId`: [`ID`](utils.md#id), `indicator`: [`AddIndicatorOptions`](utils.md#addindicatoroptions)) => [`Indicator`](utils.md#indicator)
603+
604+
Add an indicator to a rule.
605+
Indicators are displayed next to the session name in the collections tree.
606+
607+
###### Parameters
608+
609+
| Parameter | Type | Description |
610+
| ------ | ------ | ------ |
611+
| `ruleId` | [`ID`](utils.md#id) | The ID of the rule to add the indicator to. |
612+
| `indicator` | [`AddIndicatorOptions`](utils.md#addindicatoroptions) | The indicator configuration. |
613+
614+
###### Returns
615+
616+
[`Indicator`](utils.md#indicator)
617+
618+
A handle object with a `remove` method to remove the indicator.
619+
620+
###### Example
621+
622+
```ts
623+
const indicator = sdk.matchReplace.addRuleIndicator(ruleId, {
624+
icon: "fas fa-exclamation-triangle",
625+
description: "Security warning",
626+
});
627+
628+
// Later, remove the indicator
629+
indicator.remove();
630+
```
631+
600632
##### addToSlot
601633

602634
> **addToSlot**: [`DefineAddToSlotFn`](slots.md#defineaddtoslotfn)\<[`MatchReplaceSlotContent`](#matchreplaceslotcontent)\>

‎src/reference/sdks/frontend/navigation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Available route identifiers in Caido.
150150
151151
##### MatchReplace
152152

153-
> `readonly` **MatchReplace**: `"Tamper"`
153+
> `readonly` **MatchReplace**: `"MatchReplace"`
154154
155155
##### Plugins
156156

‎src/reference/sdks/frontend/other.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Other
22

3+
### ChildState
4+
5+
> **ChildState** = \{ `kind`: `"Empty"`; \} \| \{ `kind`: `"NotLoaded"`; \} \| \{ `items`: [`ID`](utils.md#id)[]; `kind`: `"Loaded"`; \}
6+
7+
***
8+
39
### CommandID
410

511
> **CommandID** = `string` & `object`
@@ -171,6 +177,32 @@ A unique command identifier.
171177
172178
***
173179

180+
### SitemapRootEntry
181+
182+
> **SitemapRootEntry** = `object`
183+
184+
#### Properties
185+
186+
##### childState
187+
188+
> **childState**: [`ChildState`](#childstate)
189+
190+
The child state of the entry.
191+
192+
##### id
193+
194+
> **id**: [`ID`](utils.md#id)
195+
196+
The ID of the entry.
197+
198+
##### label
199+
200+
> **label**: `string`
201+
202+
The label of the entry.
203+
204+
***
205+
174206
### Source
175207

176208
> **Source** = *typeof* [`Source`](match-and-replace.md#source)\[keyof *typeof* [`Source`](#source-1)\]

‎src/reference/sdks/frontend/replay.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,38 @@ Add a custom view mode for requests.
145145

146146
`void`
147147

148+
##### addSessionIndicator()
149+
150+
> **addSessionIndicator**: (`sessionId`: [`ID`](utils.md#id), `indicator`: [`AddIndicatorOptions`](utils.md#addindicatoroptions)) => [`Indicator`](utils.md#indicator)
151+
152+
Add an indicator to a replay session.
153+
Indicators are displayed next to the session name in the collections tree.
154+
155+
###### Parameters
156+
157+
| Parameter | Type | Description |
158+
| ------ | ------ | ------ |
159+
| `sessionId` | [`ID`](utils.md#id) | The ID of the session to add the indicator to. |
160+
| `indicator` | [`AddIndicatorOptions`](utils.md#addindicatoroptions) | The indicator configuration. |
161+
162+
###### Returns
163+
164+
[`Indicator`](utils.md#indicator)
165+
166+
A handle object with a `remove` method to remove the indicator.
167+
168+
###### Example
169+
170+
```ts
171+
const indicator = sdk.replay.addSessionIndicator(sessionId, {
172+
icon: "fas fa-exclamation-triangle",
173+
description: "Security warning",
174+
});
175+
176+
// Later, remove the indicator
177+
indicator.remove();
178+
```
179+
148180
##### addToSlot
149181

150182
> **addToSlot**: [`DefineAddToSlotFn`](slots.md#defineaddtoslotfn)\<[`ReplaySlotContent`](other.md#replayslotcontent)\>

0 commit comments

Comments
 (0)