@zoomrx/zena-chatbot-client 1.0.3 → 1.0.5

package/README.md

@@ -115,6 +115,8 @@ All of these can alternatively be passed via `get-config` (see Events below). Wh
 |---|---|---|
 | `get-config` | `{ resolve }` | Fired once on init. Call `resolve(config)` to provide sensitive credentials. See below. |
 | `before-send` | `{ message, resolve }` | Fired before each message is sent. Call `resolve(data)` with any extra data to merge into the request. |
+| `get-available-surveys` | `{ resolve }` | Fired once when the chat is first opened. Call `resolve(ids)` with the user's available survey IDs so the widget can skip its own fetch. See below. |
+| `sentry-additionaldata` | `{ event, resolve }` | Fired before an error is sent to Sentry. Call `resolve(context)` with `{ tags, extra }` to enrich it, or `resolve(null)` to send it unchanged. See below. |
 | `stuck-survey-selected` | `{ survey }` | Fire-and-forget. Fired when the user selects a survey from a stuck-survey dropdown, before the support ticket is created. |
 
 #### `get-config`
@@ -159,6 +161,57 @@ chatbot.on('before-send', ({ message, resolve }) => {
 });
 ```
 
+#### `get-available-surveys`
+
+Fired **once, when the chat is first opened** (not on mount), so the widget can
+learn which surveys the user currently has available — needed to answer
+"is this survey still available?" prompts. Asking lazily at open time means the
+host's survey list has finished loading, avoiding the staleness of a value
+frozen at connect.
+
+Call `resolve` with an array of survey IDs (numbers or strings). Resolve `null`
+(or an empty array) if the host has no list to share — the widget then falls
+back to fetching `users/get_surveys` itself. If the host does not answer within
+~1.5 seconds, the widget assumes no list and fetches.
+
+```js
+chatbot.on('get-available-surveys', ({ resolve }) => {
+  // Host already has the user's surveys loaded — hand over the IDs.
+  resolve(surveys.map(s => s.survey?.id).filter(Boolean));
+  // ...or, when the host has no such list (e.g. inside a survey):
+  // resolve(null);
+});
+```
+
+When the host supplies IDs this way (or via the `available-survey-ids`
+attribute / `availableSurveyIds` config), the widget makes **no**
+`users/get_surveys` call.
+
+#### `sentry-additionaldata`
+
+Fired **before each error is sent to Sentry**, letting the host attach its own
+context. The component's `@sentry/browser` captures every error on the page —
+including the host's own unhandled rejections — so a host typically filters by
+origin and only enriches its own errors.
+
+The payload is `{ event, resolve }`, where `event` is the Sentry `ErrorEvent`
+about to be sent. Call `resolve({ tags, extra })` to merge in context, or
+`resolve(null)` to send the event unchanged. If the host does not answer within
+the timeout, the event is sent with no extra data.
+
+```js
+chatbot.on('sentry-additionaldata', ({ event, resolve }) => {
+  // Inspect event (e.g. by stack-frame origin) to decide whether it's yours
+  const isMine = event?.exception?.values?.[0]?.stacktrace?.frames
+    ?.some(f => (f.filename || '').includes('/my-app/'));
+  if (!isMine) return resolve(null);
+  resolve({
+    tags: { module: 'survey' },
+    extra: { responseId: 123 },
+  });
+});
+```
+
 #### `stuck-survey-selected`
 
 Fired when the user picks a survey from a `stuck_survey_dropdown` response. Fires **before** the support-ticket API call — the host receives it even if ticket creation subsequently fails.