@burtson-labs/bandit-engine 2.0.117 → 2.0.118
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chat-J2WTUEBN.mjs → chat-RGXA26FO.mjs} +2 -2
- package/dist/{chunk-UEWOOLEB.mjs → chunk-RBMHAWU7.mjs} +63 -7
- package/dist/chunk-RBMHAWU7.mjs.map +1 -0
- package/dist/{chunk-3JR3GT5F.mjs → chunk-YLETAU5Y.mjs} +5 -3
- package/dist/{chunk-3JR3GT5F.mjs.map → chunk-YLETAU5Y.mjs.map} +1 -1
- package/dist/index.js +64 -7
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/management/management.js +64 -7
- package/dist/management/management.js.map +1 -1
- package/dist/management/management.mjs +1 -1
- package/docs/package-settings.md +37 -0
- package/package.json +1 -1
- package/dist/chunk-UEWOOLEB.mjs.map +0 -1
- /package/dist/{chat-J2WTUEBN.mjs.map → chat-RGXA26FO.mjs.map} +0 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Package Settings Cheatsheet
|
|
2
|
+
|
|
3
|
+
Use package-level settings to ship sane defaults while still allowing end users to override them in Preferences.
|
|
4
|
+
|
|
5
|
+
## Home Button URL default
|
|
6
|
+
- Set `homeUrl` in `ChatProvider`'s `packageSettings` to define the fallback target for the home button.
|
|
7
|
+
- End users can override this in Management → Preferences; a blank user value reverts to the package default.
|
|
8
|
+
- Example:
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
<ChatProvider
|
|
12
|
+
packageSettings={{
|
|
13
|
+
...otherSettings,
|
|
14
|
+
homeUrl: "https://yourapp.example.com",
|
|
15
|
+
}}
|
|
16
|
+
>
|
|
17
|
+
<App />
|
|
18
|
+
</ChatProvider>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Advanced knowledge sync default
|
|
22
|
+
- Set `advancedKnowledgeSyncDefaultEnabled: true` in `packageSettings` to default the **Advanced knowledge sync** toggle to on (when the feature is available for the account).
|
|
23
|
+
- The user’s saved preference and server preference still win; the package default only applies when no explicit value exists yet.
|
|
24
|
+
- Example:
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
<ChatProvider
|
|
28
|
+
packageSettings={{
|
|
29
|
+
...otherSettings,
|
|
30
|
+
advancedKnowledgeSyncDefaultEnabled: true,
|
|
31
|
+
}}
|
|
32
|
+
>
|
|
33
|
+
<App />
|
|
34
|
+
</ChatProvider>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Tip: Keep `gatewayApiUrl` configured; advanced knowledge sync requires a reachable gateway and valid auth token to sync preferences.
|