From 4057da23741ac266787ecfc342aa17b9eace96e6 Mon Sep 17 00:00:00 2001
From: Caido Bot <dev@caido.io>
Date: Tue, 9 Dec 2025 17:24:16 +0000
Subject: [PATCH] Update SDK Documentation

---
 src/reference/sdks/frontend/ai.md             | 12 ++++
 src/reference/sdks/frontend/filters.md        | 57 +++++++++++++++++++
 .../sdks/frontend/match-and-replace.md        | 57 +++++++++++++++++++
 src/reference/sdks/frontend/scopes.md         | 57 +++++++++++++++++++
 4 files changed, 183 insertions(+)

diff --git a/src/reference/sdks/frontend/ai.md b/src/reference/sdks/frontend/ai.md
index 6b8bbfe..143a1ae 100644
--- a/src/reference/sdks/frontend/ai.md
+++ b/src/reference/sdks/frontend/ai.md
@@ -8,6 +8,18 @@ Settings for AI language model.
 
 #### Properties
 
+##### capabilities?
+
+> `optional` **capabilities**: `object`
+
+###### reasoning
+
+> **reasoning**: `boolean`
+
+###### structured\_output
+
+> **structured\_output**: `boolean`
+
 ##### reasoning?
 
 > `optional` **reasoning**: [`AIReasoningSettings`](#aireasoningsettings)
diff --git a/src/reference/sdks/frontend/filters.md b/src/reference/sdks/frontend/filters.md
index f16d33d..794de3f 100644
--- a/src/reference/sdks/frontend/filters.md
+++ b/src/reference/sdks/frontend/filters.md
@@ -1,5 +1,21 @@
 # Filters
 
+### CurrentFilterChangeEvent
+
+> **CurrentFilterChangeEvent** = `object`
+
+Event fired when the current filter changes.
+
+#### Properties
+
+##### filterId
+
+> **filterId**: [`ID`](utils.md#id) \| `undefined`
+
+The ID of the newly selected filter, or undefined if no filter is selected.
+
+***
+
 ### Filter
 
 > **Filter** = `object`
@@ -130,6 +146,47 @@ Gets all filters.
 
 The filters.
 
+##### getCurrentFilter()
+
+> **getCurrentFilter**: () => [`Filter`](#filter) \| `undefined`
+
+Get the currently selected filter.
+
+###### Returns
+
+[`Filter`](#filter) \| `undefined`
+
+The currently selected filter, or undefined if no filter is selected.
+
+##### onCurrentFilterChange()
+
+> **onCurrentFilterChange**: (`callback`: (`event`: [`CurrentFilterChangeEvent`](#currentfilterchangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)
+
+Subscribe to current filter changes.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback` | (`event`: [`CurrentFilterChangeEvent`](#currentfilterchangeevent)) => `void` | The callback to call when the selected filter changes. |
+
+###### Returns
+
+[`ListenerHandle`](utils.md#listenerhandle)
+
+An object with a `stop` method that can be called to stop listening to filter changes.
+
+###### Example
+
+```ts
+const handler = sdk.filters.onCurrentFilterChange((event) => {
+  console.log(`Filter ${event.filterId} got selected!`);
+});
+
+// Later, stop listening
+handler.stop();
+```
+
 ##### update()
 
 > **update**: (`id`: [`ID`](utils.md#id), `options`: `object`) => `Promise`\<[`Filter`](#filter)\>
diff --git a/src/reference/sdks/frontend/match-and-replace.md b/src/reference/sdks/frontend/match-and-replace.md
index 818a0c3..3a19490 100644
--- a/src/reference/sdks/frontend/match-and-replace.md
+++ b/src/reference/sdks/frontend/match-and-replace.md
@@ -1,5 +1,21 @@
 # Match and Replace
 
+### CurrentMatchReplaceRuleChangeEvent
+
+> **CurrentMatchReplaceRuleChangeEvent** = `object`
+
+Event fired when the current match and replace rule changes.
+
+#### Properties
+
+##### ruleId
+
+> **ruleId**: [`ID`](utils.md#id) \| `undefined`
+
+The ID of the newly selected rule, or undefined if no rule is selected.
+
+***
+
 ### MatchReplaceCollection
 
 > **MatchReplaceCollection** = `object`
@@ -712,6 +728,18 @@ Get all collections.
 
 [`MatchReplaceCollection`](#matchreplacecollection)[]
 
+##### getCurrentRule()
+
+> **getCurrentRule**: () => [`MatchReplaceRule`](#matchreplacerule) \| `undefined`
+
+Get the currently selected rule.
+
+###### Returns
+
+[`MatchReplaceRule`](#matchreplacerule) \| `undefined`
+
+The currently selected rule, or undefined if no rule is selected.
+
 ##### getRules()
 
 > **getRules**: () => [`MatchReplaceRule`](#matchreplacerule)[]
@@ -724,6 +752,35 @@ Get all rules.
 
 All rules.
 
+##### onCurrentRuleChange()
+
+> **onCurrentRuleChange**: (`callback`: (`event`: [`CurrentMatchReplaceRuleChangeEvent`](#currentmatchreplacerulechangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)
+
+Subscribe to current rule changes.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback` | (`event`: [`CurrentMatchReplaceRuleChangeEvent`](#currentmatchreplacerulechangeevent)) => `void` | The callback to call when the selected rule changes. |
+
+###### Returns
+
+[`ListenerHandle`](utils.md#listenerhandle)
+
+An object with a `stop` method that can be called to stop listening to rule changes.
+
+###### Example
+
+```ts
+const handler = sdk.matchReplace.onCurrentRuleChange((event) => {
+  console.log(`Rule ${event.ruleId} got selected!`);
+});
+
+// Later, stop listening
+handler.stop();
+```
+
 ##### selectRule()
 
 > **selectRule**: (`id`: [`ID`](utils.md#id) \| `undefined`) => `void`
diff --git a/src/reference/sdks/frontend/scopes.md b/src/reference/sdks/frontend/scopes.md
index 7d3ba15..905a7af 100644
--- a/src/reference/sdks/frontend/scopes.md
+++ b/src/reference/sdks/frontend/scopes.md
@@ -1,5 +1,21 @@
 # Scopes
 
+### CurrentScopeChangeEvent
+
+> **CurrentScopeChangeEvent** = `object`
+
+Event fired when the current scope changes.
+
+#### Properties
+
+##### scopeId
+
+> **scopeId**: [`ID`](utils.md#id) \| `undefined`
+
+The ID of the newly selected scope, or undefined if no scope is selected.
+
+***
+
 ### Scope
 
 > **Scope** = `object`
@@ -129,6 +145,18 @@ Delete a scope.
 
 Whether the scope was deleted.
 
+##### getCurrentScope()
+
+> **getCurrentScope**: () => [`Scope`](#scope) \| `undefined`
+
+Get the currently selected scope.
+
+###### Returns
+
+[`Scope`](#scope) \| `undefined`
+
+The currently selected scope, or undefined if no scope is selected.
+
 ##### getScopes()
 
 > **getScopes**: () => [`Scope`](#scope)[]
@@ -141,6 +169,35 @@ Get all scopes.
 
 A list of scopes.
 
+##### onCurrentScopeChange()
+
+> **onCurrentScopeChange**: (`callback`: (`event`: [`CurrentScopeChangeEvent`](#currentscopechangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)
+
+Subscribe to current scope changes.
+
+###### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback` | (`event`: [`CurrentScopeChangeEvent`](#currentscopechangeevent)) => `void` | The callback to call when the selected scope changes. |
+
+###### Returns
+
+[`ListenerHandle`](utils.md#listenerhandle)
+
+An object with a `stop` method that can be called to stop listening to scope changes.
+
+###### Example
+
+```ts
+const handler = sdk.scopes.onCurrentScopeChange((event) => {
+  console.log(`Scope ${event.scopeId} got selected!`);
+});
+
+// Later, stop listening
+handler.stop();
+```
+
 ##### updateScope()
 
 > **updateScope**: (`id`: [`ID`](utils.md#id), `options`: `object`) => `Promise`\<[`Scope`](#scope) \| `undefined`\>