Skip to content

Commit 3ced0f7

Browse files
committed
Update SDK Documentation
1 parent 307d0ce commit 3ced0f7

File tree

5 files changed

+184
-1
lines changed

5 files changed

+184
-1
lines changed

src/reference/sdks/frontend/ai.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ Settings for AI language model.
88

99
#### Properties
1010

11+
##### capabilities?
12+
13+
> `optional` **capabilities**: `object`
14+
15+
###### reasoning
16+
17+
> **reasoning**: `boolean`
18+
19+
###### structured\_output
20+
21+
> **structured\_output**: `boolean`
22+
1123
##### reasoning?
1224

1325
> `optional` **reasoning**: [`AIReasoningSettings`](#aireasoningsettings)

src/reference/sdks/frontend/filters.md

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

3+
### CurrentFilterChangeEvent
4+
5+
> **CurrentFilterChangeEvent** = `object`
6+
7+
Event fired when the current filter changes.
8+
9+
#### Properties
10+
11+
##### filterId
12+
13+
> **filterId**: [`ID`](utils.md#id) \| `undefined`
14+
15+
The ID of the newly selected filter, or undefined if no filter is selected.
16+
17+
***
18+
319
### Filter
420

521
> **Filter** = `object`
@@ -130,6 +146,47 @@ Gets all filters.
130146

131147
The filters.
132148

149+
##### getCurrentFilter()
150+
151+
> **getCurrentFilter**: () => [`Filter`](#filter) \| `undefined`
152+
153+
Get the currently selected filter.
154+
155+
###### Returns
156+
157+
[`Filter`](#filter) \| `undefined`
158+
159+
The currently selected filter, or undefined if no filter is selected.
160+
161+
##### onCurrentFilterChange()
162+
163+
> **onCurrentFilterChange**: (`callback`: (`event`: [`CurrentFilterChangeEvent`](#currentfilterchangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)
164+
165+
Subscribe to current filter changes.
166+
167+
###### Parameters
168+
169+
| Parameter | Type | Description |
170+
| ------ | ------ | ------ |
171+
| `callback` | (`event`: [`CurrentFilterChangeEvent`](#currentfilterchangeevent)) => `void` | The callback to call when the selected filter changes. |
172+
173+
###### Returns
174+
175+
[`ListenerHandle`](utils.md#listenerhandle)
176+
177+
An object with a `stop` method that can be called to stop listening to filter changes.
178+
179+
###### Example
180+
181+
```ts
182+
const handler = sdk.filters.onCurrentFilterChange((event) => {
183+
console.log(`Filter ${event.filterId} got selected!`);
184+
});
185+
186+
// Later, stop listening
187+
handler.stop();
188+
```
189+
133190
##### update()
134191

135192
> **update**: (`id`: [`ID`](utils.md#id), `options`: `object`) => `Promise`\<[`Filter`](#filter)\>

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

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Match and Replace
22

3+
### CurrentMatchReplaceRuleChangeEvent
4+
5+
> **CurrentMatchReplaceRuleChangeEvent** = `object`
6+
7+
Event fired when the current match and replace rule changes.
8+
9+
#### Properties
10+
11+
##### ruleId
12+
13+
> **ruleId**: [`ID`](utils.md#id) \| `undefined`
14+
15+
The ID of the newly selected rule, or undefined if no rule is selected.
16+
17+
***
18+
319
### MatchReplaceCollection
420

521
> **MatchReplaceCollection** = `object`
@@ -712,6 +728,18 @@ Get all collections.
712728

713729
[`MatchReplaceCollection`](#matchreplacecollection)[]
714730

731+
##### getCurrentRule()
732+
733+
> **getCurrentRule**: () => [`MatchReplaceRule`](#matchreplacerule) \| `undefined`
734+
735+
Get the currently selected rule.
736+
737+
###### Returns
738+
739+
[`MatchReplaceRule`](#matchreplacerule) \| `undefined`
740+
741+
The currently selected rule, or undefined if no rule is selected.
742+
715743
##### getRules()
716744

717745
> **getRules**: () => [`MatchReplaceRule`](#matchreplacerule)[]
@@ -724,6 +752,35 @@ Get all rules.
724752

725753
All rules.
726754

755+
##### onCurrentRuleChange()
756+
757+
> **onCurrentRuleChange**: (`callback`: (`event`: [`CurrentMatchReplaceRuleChangeEvent`](#currentmatchreplacerulechangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)
758+
759+
Subscribe to current rule changes.
760+
761+
###### Parameters
762+
763+
| Parameter | Type | Description |
764+
| ------ | ------ | ------ |
765+
| `callback` | (`event`: [`CurrentMatchReplaceRuleChangeEvent`](#currentmatchreplacerulechangeevent)) => `void` | The callback to call when the selected rule changes. |
766+
767+
###### Returns
768+
769+
[`ListenerHandle`](utils.md#listenerhandle)
770+
771+
An object with a `stop` method that can be called to stop listening to rule changes.
772+
773+
###### Example
774+
775+
```ts
776+
const handler = sdk.matchReplace.onCurrentRuleChange((event) => {
777+
console.log(`Rule ${event.ruleId} got selected!`);
778+
});
779+
780+
// Later, stop listening
781+
handler.stop();
782+
```
783+
727784
##### selectRule()
728785

729786
> **selectRule**: (`id`: [`ID`](utils.md#id) \| `undefined`) => `void`

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/scopes.md

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

3+
### CurrentScopeChangeEvent
4+
5+
> **CurrentScopeChangeEvent** = `object`
6+
7+
Event fired when the current scope changes.
8+
9+
#### Properties
10+
11+
##### scopeId
12+
13+
> **scopeId**: [`ID`](utils.md#id) \| `undefined`
14+
15+
The ID of the newly selected scope, or undefined if no scope is selected.
16+
17+
***
18+
319
### Scope
420

521
> **Scope** = `object`
@@ -129,6 +145,18 @@ Delete a scope.
129145

130146
Whether the scope was deleted.
131147

148+
##### getCurrentScope()
149+
150+
> **getCurrentScope**: () => [`Scope`](#scope) \| `undefined`
151+
152+
Get the currently selected scope.
153+
154+
###### Returns
155+
156+
[`Scope`](#scope) \| `undefined`
157+
158+
The currently selected scope, or undefined if no scope is selected.
159+
132160
##### getScopes()
133161

134162
> **getScopes**: () => [`Scope`](#scope)[]
@@ -141,6 +169,35 @@ Get all scopes.
141169

142170
A list of scopes.
143171

172+
##### onCurrentScopeChange()
173+
174+
> **onCurrentScopeChange**: (`callback`: (`event`: [`CurrentScopeChangeEvent`](#currentscopechangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)
175+
176+
Subscribe to current scope changes.
177+
178+
###### Parameters
179+
180+
| Parameter | Type | Description |
181+
| ------ | ------ | ------ |
182+
| `callback` | (`event`: [`CurrentScopeChangeEvent`](#currentscopechangeevent)) => `void` | The callback to call when the selected scope changes. |
183+
184+
###### Returns
185+
186+
[`ListenerHandle`](utils.md#listenerhandle)
187+
188+
An object with a `stop` method that can be called to stop listening to scope changes.
189+
190+
###### Example
191+
192+
```ts
193+
const handler = sdk.scopes.onCurrentScopeChange((event) => {
194+
console.log(`Scope ${event.scopeId} got selected!`);
195+
});
196+
197+
// Later, stop listening
198+
handler.stop();
199+
```
200+
144201
##### updateScope()
145202

146203
> **updateScope**: (`id`: [`ID`](utils.md#id), `options`: `object`) => `Promise`\<[`Scope`](#scope) \| `undefined`\>

0 commit comments

Comments
 (0)