Merge pull request #79 from FriendlyCaptcha/update-sdk-reference

Update SDK reference documentation

Author: greenberga

docs/sdk/reference/sdk.frcwidgetstatechangeeventdata.md

@@ -24,6 +24,7 @@ export interface FRCWidgetStateChangeEventData
 |  --- | --- | --- | --- |
 |  [error?](./sdk.frcwidgetstatechangeeventdata.error.md) |  | [WidgetErrorData](./sdk.widgeterrordata.md) | _(Optional)_ The error that caused the state change, if any. Undefined if <code>state</code> is not equal to <code>&quot;error&quot;</code>. |
 |  [id](./sdk.frcwidgetstatechangeeventdata.id.md) |  | string | The widget ID that the event originated from. |
+|  [mode?](./sdk.frcwidgetstatechangeeventdata.mode.md) |  | [WidgetMode](./sdk.widgetmode.md) | _(Optional)_ The WidgetMode returned from the API. Smart Mode intelligently chooses between One-click Mode ("interactive") and Zero-click Mode ("noninteractive"). The mode is configured in the Friendly Captcha dashboard. |
 |  [name](./sdk.frcwidgetstatechangeeventdata.name.md) |  | typeof [FRCWidgetStateChangeEventName](./sdk.frcwidgetstatechangeeventname.md) | <code>&quot;frc:widget.statechange&quot;</code> |
 |  [response](./sdk.frcwidgetstatechangeeventdata.response.md) |  | string | The current <code>frc-captcha-response</code> value. |
 |  [state](./sdk.frcwidgetstatechangeeventdata.state.md) |  | [WidgetState](./sdk.widgetstate.md) | The new state of the widget. |

docs/sdk/reference/sdk.frcwidgetstatechangeeventdata.mode.md

@@ -0,0 +1,23 @@
+---
+id: sdk.frcwidgetstatechangeeventdata.mode
+title: FRCWidgetStateChangeEventData.mode
+hide_title: true
+sidebar_class_name: sidebar-hidden
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[@friendlycaptcha/sdk](./sdk.md) &gt; [FRCWidgetStateChangeEventData](./sdk.frcwidgetstatechangeeventdata.md) &gt; [mode](./sdk.frcwidgetstatechangeeventdata.mode.md)
+
+## FRCWidgetStateChangeEventData.mode property
+
+The WidgetMode returned from the API. Smart Mode intelligently chooses between One-click Mode ("interactive") and Zero-click Mode ("noninteractive"). The mode is configured in the Friendly Captcha dashboard.
+
+**Signature:**
+
+```typescript
+mode?: WidgetMode;
+```
+
+## Remarks
+
+The API chooses the mode during activation, meaning that the mode will not be available prior to the `"activated"` state. In other words, `mode` will be only be present for `"activated"`<!-- -->, `"requesting"`<!-- -->, `"solving"`<!-- -->, `"verifying"`<!-- -->, `"completed"`<!-- -->, and `"error"`<!-- -->. For other states, it will be `undefined`<!-- -->. See the [widget lifecycle](../lifecycle) docs for more information.

docs/sdk/reference/sdk.md

@@ -58,5 +58,6 @@ A library for integrating Friendly Captcha into your website. This SDK allows yo
 |  [SentinelResponse](./sdk.sentinelresponse.md) | Response values used in the hidden input field when no valid solution is present, these tell you something about the state of the widget. |
 |  [StartMode](./sdk.startmode.md) | <p>The start mode of the widget.</p><p>\* <code>&quot;auto&quot;</code>: the widget gets activated as soon as it is created. \* <code>&quot;focus&quot;</code>: the widget gets activated as soon as the form above it is focused. \* <code>&quot;none&quot;</code>: The widget does not get activated automatically at all, the user needs to press the widget (or <code>.start()</code> gets called using the Javascript API).</p> |
 |  [WidgetErrorCode](./sdk.widgeterrorcode.md) | <p>Error codes that can be returned by the widget.</p><p>\* <code>&quot;network_error&quot;</code>: The user's browser could not connect to the Friendly Captcha API. \* <code>&quot;sitekey_invalid&quot;</code>: The sitekey is invalid. \* <code>&quot;sitekey_missing&quot;</code>: The sitekey is missing. \* <code>&quot;other&quot;</code>: Some other error occurred.</p><p>In all cases it's the best practice to enable the "submit" button when the widget errors, so that the user can still perform the action despite not having solved the captcha.</p> |
+|  [WidgetMode](./sdk.widgetmode.md) | The mode of the widget. \* <code>&quot;interactive&quot;</code> (default): the widget is interactive: the user needs to click the checkbox to finalize the captcha. This mode offers the best anti-bot protection. \* <code>&quot;noninteractive&quot;</code>: the widget is non-interactive: the captcha is solved without any user interaction required. |
 |  [WidgetResetTrigger](./sdk.widgetresettrigger.md) | What caused the widget to reset. \* <code>root</code>: Code on the root page (= your website code or plugin) caused the reset. \* <code>widget</code>: The reset came from the widget. The user likely clicked the reset button within the widget. \* <code>agent</code>: The reset came from the agent - this currently does not happen but may in the future. |
-|  [WidgetState](./sdk.widgetstate.md) | The state the widget is in. See the \[widget lifecycle\](../lifecycle) docs for more information. |
+|  [WidgetState](./sdk.widgetstate.md) | The state the widget is in. See the [widget lifecycle](../lifecycle) docs for more information. |

docs/sdk/reference/sdk.sentinelresponse.md

@@ -15,5 +15,5 @@ Response values used in the hidden input field when no valid solution is present
 **Signature:**
 
 ```typescript
-export type SentinelResponse = ".UNINITIALIZED" | ".UNCONNECTED" | ".UNSTARTED" | ".REQUESTING" | ".SOLVING" | ".VERIFYING" | ".EXPIRED" | ".DESTROYED" | ".ERROR" | ".RESET";
+export type SentinelResponse = ".UNINITIALIZED" | ".UNCONNECTED" | ".UNSTARTED" | ".REQUESTING" | ".SOLVING" | ".VERIFYING" | ".EXPIRED" | ".DESTROYED" | ".ERROR" | ".ERROR.UNREACHABLE" | ".RESET";
 ```

docs/sdk/reference/sdk.widgetmode.md

@@ -0,0 +1,19 @@
+---
+id: sdk.widgetmode
+title: WidgetMode
+hide_title: true
+sidebar_class_name: sidebar-hidden
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[@friendlycaptcha/sdk](./sdk.md) &gt; [WidgetMode](./sdk.widgetmode.md)
+
+## WidgetMode type
+
+The mode of the widget. \* `"interactive"` (default): the widget is interactive: the user needs to click the checkbox to finalize the captcha. This mode offers the best anti-bot protection. \* `"noninteractive"`<!-- -->: the widget is non-interactive: the captcha is solved without any user interaction required.
+
+**Signature:**
+
+```typescript
+export type WidgetMode = "interactive" | "noninteractive";
+```

docs/sdk/reference/sdk.widgetstate.md

@@ -10,7 +10,7 @@ sidebar_class_name: sidebar-hidden
 
 ## WidgetState type
 
-The state the widget is in. See the \[widget lifecycle\](../lifecycle) docs for more information.
+The state the widget is in. See the [widget lifecycle](../lifecycle) docs for more information.
 
 **Signature:**