@askly/widget 2.6.1 → 2.8.0

package/README.md

@@ -108,10 +108,11 @@ const hash = crypto
 
 Without a valid `hash` the traits are still used locally, but Askly will not link the accounts.
 
-> **Known limitation:** a signature is accepted for 5 minutes from its `timestamp`. On a page that
-> stays open longer, call `Askly.identify()` again with a freshly generated `hash` and `timestamp`
-> (for example on a timer, or before the user opens the chat). If `identify()` is rejected, the
-> reason is logged to the browser console.
+The `hash` only has to be fresh at the moment `identify()` (or `init()`) runs: it is valid for 5
+minutes from its `timestamp`. Once Askly has verified it, the widget holds a session for that user
+and keeps renewing it, so a page that stays open for hours keeps working without a new hash. If
+`identify()` is rejected, the reason is logged to the browser console and messages are sent as
+the anonymous visitor.
 
 #### Logging out
 
@@ -140,6 +141,31 @@ instead of calling `identify()` separately:
 | `timestamp` | `number` | Signature timestamp. |
 | `signature` | `string` | HMAC request signature (same value as `hash` above). |
 
+### Greeting bubble
+
+A few seconds after the page loads, the widget shows a short hello next to the launcher —
+*"Hi, I'm Maya from Acme. How can I help?"* — with up to three of your FAQs as one-tap questions.
+Clicking it opens the chat with that line as the first message.
+
+Turn it on or off, and set the text and delay, on **Widget → Branding** in the portal. In the text,
+`{ai_name}` and `{organizationName}` are filled in for you; if the AI is not answering, the default
+greeting does not name one. A visitor who dismisses it, or opens the chat, does not see it again
+that session. It is not shown with `autoOpen`.
+
+To override per embed:
+
+```javascript
+Askly.init({ appId: "YOUR_APP_ID", greeting: false });                       // off on this site
+Askly.init({ appId: "YOUR_APP_ID", greeting: { message: "Need a hand?", delayMs: 5000 } });
+```
+
+```html
+<script src="…/widget.js" data-app-id="YOUR_APP_ID" data-greeting="false" async></script>
+```
+
+The widget dispatches `askly:greeting:shown`, `askly:greeting:clicked` and
+`askly:greeting:dismissed` on `window` for analytics.
+
 ### Asking visitors for their email
 
 Anonymous visitors can't be replied to once they close the tab — the answer just waits in a widget

package/dist/index.d.ts

@@ -16,6 +16,10 @@ export interface AsklyConfig {
     buttonIcon?: string;
     buttonShape?: "round" | "square";
     autoOpen?: boolean;
+    greeting?: boolean | {
+        message?: string;
+        delayMs?: number;
+    };
     showTimestamp?: boolean;
     soundEnabled?: boolean;
     soundVolume?: number;