@askly/widget 2.4.0 → 2.6.1

package/README.md

@@ -89,7 +89,7 @@ Askly.identify({
 | :--- | :--- | :--- |
 | `userId` | `string` | **Required.** Your application's user ID. |
 | `hash` | `string` | HMAC-SHA256 of `userId + timestamp`, using your Widget Secret Key. |
-| `timestamp` | `number` | Unix seconds the hash was generated for. Valid for 5 minutes. |
+| `timestamp` | `number` | **Required with `hash`.** Unix seconds the hash was generated for. Valid for 5 minutes. |
 | `email` / `name` / `phone` | `string` | Optional profile fields shown to your agents. |
 | `attributes` | `object` | Any extra traits you want on the contact record. |
 
@@ -108,6 +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.
+
 #### Logging out
 
 ```javascript
@@ -116,7 +121,13 @@ Askly.shutdown();  // the same, and remove the widget from the page
 ```
 
 Call one of these on logout, particularly for shared computers — otherwise the next person to
-use the browser inherits the previous person's conversations.
+use the browser inherits the previous person's conversations. `reset()` takes effect immediately
+in an open widget: the transcript on screen is cleared, a new anonymous visitor id is issued, and
+any identity passed to `init()` stops being sent. After `shutdown()` you can call `init()` again.
+
+Both really do discard the anonymous visitor: the next message comes from a new visitor with no
+history. Call them on logout only — not on every page load for guests, and not to hide the widget
+on some routes (use `includePaths` / `excludePaths`, or `Askly.close()`, for that).
 
 #### Identifying at init time
 
@@ -196,6 +207,20 @@ Askly.init({
 
 None required. The widget talks to Askly's hosted backend automatically — you only provide an `appId`.
 
+### Reply formatting
+
+The server and the widget share one rendering contract, the **Askly reply markdown subset v1**. The AI is instructed to write only this subset, the server normalises anything else away, and the widget renders exactly this subset with a small built-in parser (no third-party markdown library). Every message carries a `format` field: `"markdown"` for AI replies, `"text"` for operator replies and visitor messages, which are shown verbatim with URLs auto-linked.
+
+| Allowed | Syntax |
+| --- | --- |
+| Paragraphs | blank line between them; a single newline is a soft break |
+| Bold, italic | `**bold**`, `*italic*` or `_italic_` |
+| Inline code, code blocks | `` `code` ``, fenced ```` ``` ```` with an optional language |
+| Lists | `- item`, `* item`, `1. item`; never nested |
+| Links | `[text](https://…)` (https, http, mailto, tel) and bare URLs |
+
+Headings, tables, images, blockquotes, horizontal rules and raw HTML are not part of the contract and appear as literal text. The canonical definition lives in `src/markdown.ts`; the server copy is `app/services/reply_format.py`.
+
 ## Development
 
 ```bash

package/dist/icons.d.ts

@@ -9,6 +9,8 @@ export declare const Minus: ({ size, color, strokeWidth, ...rest }: IconProps) =
 export declare const ArrowUp: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
 export declare const Mic: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
 export declare const MicOff: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
+export declare const Volume2: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
+export declare const VolumeX: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
 export declare const Home: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
 export declare const Compass: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;
 export declare const MessageSquare: ({ size, color, strokeWidth, ...rest }: IconProps) => React.ReactSVGElement;

package/dist/identity.d.ts

@@ -17,12 +17,17 @@
  * The stable per-browser token for this organization, minting one if needed.
  * Scoped per org so a browser visiting two Askly-powered sites keeps them separate.
  */
-export declare function getVisitorId(orgId: string): string;
+export declare function getVisitorId(orgId: string, adoptFrom?: string): string;
 /**
  * Forget this browser's identity and chat history — call on logout so the next person at
  * a shared computer starts clean rather than inheriting the previous session.
  */
 export declare function resetVisitor(orgId: string): void;
+/**
+ * Record that data initialised under `scope` (the app id, or "detect") actually lives under
+ * `resolved` (the organization id from remote config). Not personal data, so reset keeps it.
+ */
+export declare function rememberResolvedScope(scope: string, resolved: string): void;
 /** A fresh server-side thread id. Mirrors the local chat id so one chat is one thread. */
 export declare function newThreadKey(): string;
 export interface AsklyIdentity {
@@ -30,7 +35,10 @@ export interface AsklyIdentity {
     userId: string;
     /** HMAC-SHA256 of `userId + timestamp` under the org's widget secret, computed server-side. */
     hash?: string;
-    /** Unix seconds the hash was generated for. Defaults to now. */
+    /**
+     * Unix seconds the hash was generated for. Required with `hash`: the server recomputes the
+     * HMAC from this exact value and rejects it once it is more than 5 minutes old.
+     */
     timestamp?: number;
     email?: string;
     name?: string;
@@ -47,4 +55,10 @@ type IdentityListener = (identity: AsklyIdentity) => void;
 export declare function publishIdentity(identity: AsklyIdentity): void;
 export declare function subscribeIdentity(listener: IdentityListener): () => void;
 export declare function clearIdentity(): void;
+type ResetListener = () => void;
+/** How many times reset() has run on this page. Lets a widget notice a reset it missed. */
+export declare function getResetGeneration(): number;
+/** Tell the mounted widget that Askly.reset() ran, so it drops what it holds in memory. */
+export declare function publishReset(): void;
+export declare function subscribeReset(listener: ResetListener): () => void;
 export {};

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export interface AsklyConfig {
     themeColor?: string;
     theme?: "light" | "dark" | "auto";
     enableVoiceChat?: boolean;
+    readAloud?: boolean;
     welcomeMessage?: string;
     placeholderText?: string;
     organizationLogo?: string;
@@ -26,6 +27,7 @@ export interface AsklyConfig {
     excludePaths?: string[];
     includePaths?: string[];
     configOverride?: Record<string, any>;
+    debug?: boolean;
     onMessageSent?: (message: string) => void;
     onMessageReceived?: (reply: string) => void;
     onChatOpened?: () => void;