Skip to content

Commit 06e106f

Browse files
committed
Update SDK Documentation
1 parent fd6efb4 commit 06e106f

File tree

3 files changed

+118
-1
lines changed

3 files changed

+118
-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/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/replay.md

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

3+
### AddSessionIndicatorOptions
4+
5+
> **AddSessionIndicatorOptions** = `object`
6+
7+
Visual indicator displayed next to a session label in the replay tree component.
8+
Includes an icon and an associated description.
9+
10+
#### Properties
11+
12+
##### description
13+
14+
> **description**: `string`
15+
16+
##### icon
17+
18+
> **icon**: `string`
19+
20+
***
21+
322
### CurrentReplaySessionChangeEvent
423

524
> **CurrentReplaySessionChangeEvent** = `object`
@@ -145,6 +164,38 @@ Add a custom view mode for requests.
145164

146165
`void`
147166

167+
##### addSessionIndicator()
168+
169+
> **addSessionIndicator**: (`sessionId`: [`ID`](utils.md#id), `indicator`: [`AddSessionIndicatorOptions`](#addsessionindicatoroptions)) => [`SessionIndicator`](#sessionindicator)
170+
171+
Add an indicator to a replay session.
172+
Indicators are displayed next to the session name in the collections tree.
173+
174+
###### Parameters
175+
176+
| Parameter | Type | Description |
177+
| ------ | ------ | ------ |
178+
| `sessionId` | [`ID`](utils.md#id) | The ID of the session to add the indicator to. |
179+
| `indicator` | [`AddSessionIndicatorOptions`](#addsessionindicatoroptions) | The indicator configuration. |
180+
181+
###### Returns
182+
183+
[`SessionIndicator`](#sessionindicator)
184+
185+
A handle object with a `remove` method to remove the indicator.
186+
187+
###### Example
188+
189+
```ts
190+
const indicator = sdk.replay.addSessionIndicator(sessionId, {
191+
icon: "fas fa-exclamation-triangle",
192+
description: "Security warning",
193+
});
194+
195+
// Later, remove the indicator
196+
indicator.remove();
197+
```
198+
148199
##### addToSlot
149200

150201
> **addToSlot**: [`DefineAddToSlotFn`](slots.md#defineaddtoslotfn)\<[`ReplaySlotContent`](other.md#replayslotcontent)\>
@@ -746,6 +797,24 @@ Defaults to true.
746797

747798
***
748799

800+
### SessionIndicator
801+
802+
> **SessionIndicator** = `object`
803+
804+
Providing operations that can be performed on a session indicator.
805+
806+
#### Properties
807+
808+
##### remove()
809+
810+
> **remove**: () => `void`
811+
812+
###### Returns
813+
814+
`void`
815+
816+
***
817+
749818
### ReplaySlot
750819

751820
> `const` **ReplaySlot**: `object`

0 commit comments

Comments
 (0)