@askly/widget 2.11.0 → 3.1.0

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "@askly/widget",
-  "version": "2.11.0",
-  "description": "Embeddable AI support chat widget for React — drop-in customer support chatbot with voice, RAG (docs-grounded) answers, and human handoff. One line to install.",
+  "version": "3.1.0",
+  "description": "Embeddable AI support chat widget for React \u2014 drop-in customer support chatbot with voice, RAG (docs-grounded) answers, and human handoff. One line to install.",
   "main": "dist/index.umd.js",
   "module": "dist/index.esm.js",
   "unpkg": "dist/widget.js",
   "jsdelivr": "dist/widget.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "scripts": {
-    "build": "rollup -c",
+    "build": "rm -rf dist && rollup -c rollup.config.mjs && npm run build:react",
     "test": "tsc src/markdown.ts --outDir test/.build --module commonjs --target es2019 --strict --skipLibCheck && node --test test/markdown.test.cjs",
     "typecheck": "tsc --noEmit -p .",
     "test:e2e": "playwright test",
     "size": "node scripts/check-size.cjs",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "build:react": "tsc -p packages/react/tsconfig.json"
   },
   "files": [
     "dist",
     "README.md",
+    "MIGRATION-3.0.md",
     "LICENSE"
   ],
   "keywords": [
@@ -51,29 +53,39 @@
     "url": "https://github.com/StrontiumTechnologies/Askly-SDK/issues"
   },
   "homepage": "https://github.com/StrontiumTechnologies/Askly-SDK#readme",
-  "peerDependencies": {
-    "react": ">=18.0.0",
-    "react-dom": ">=18.0.0"
-  },
   "devDependencies": {
+    "@axe-core/playwright": "^4.13.0",
     "@playwright/test": "^1.63.0",
-    "@rollup/plugin-commonjs": "^28.0.6",
-    "@rollup/plugin-node-resolve": "^16.0.2",
-    "@rollup/plugin-replace": "^5.0.7",
-    "@rollup/plugin-typescript": "^8.3.0",
+    "@rollup/plugin-alias": "^6.0.0",
+    "@rollup/plugin-commonjs": "^28.0.9",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-replace": "^6.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.3.0",
     "@types/react": "^18.0.0",
     "@types/react-dom": "^18.0.0",
     "cors": "^2.8.5",
     "express": "^5.1.0",
     "postcss": "^8.4.5",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
-    "rollup": "^2.60.0",
+    "preact": "^10.29.8",
+    "rollup": "^4.64.0",
     "rollup-plugin-postcss": "^4.0.2",
-    "rollup-plugin-terser": "^7.0.2",
-    "typescript": "^4.5.4"
+    "typescript": "^5.9.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "default": "./dist/index.umd.js"
+    },
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json"
   },
-  "dependencies": {
-    "tslib": "^2.8.1"
-  }
+  "sideEffects": [
+    "dist/widget.js",
+    "dist/loader.js",
+    "dist/index.esm.js",
+    "dist/index.umd.js",
+    "dist/app/*"
+  ]
 }

package/dist/core/format.d.ts

@@ -1,2 +0,0 @@
-/** Small display helpers shared by the UI components. */
-export declare function formatTime(dateAny: any): string;

package/dist/index.d.ts

@@ -1,124 +0,0 @@
-import { type AsklyEventMap, type AsklyEventName, type AsklyEventHandler, type AsklySpace } from "./core/events";
-import { type AsklyIdentity } from "./identity";
-export interface AsklyConfig {
-    appId?: string;
-    widgetId?: string;
-    orgId?: string;
-    orgServerRoute?: string;
-    organizationName?: string;
-    position?: "left" | "right";
-    themeColor?: string;
-    theme?: "light" | "dark" | "auto";
-    voiceInput?: false | "review" | "auto-send";
-    /** @deprecated use `voiceInput`. */
-    enableVoiceChat?: boolean;
-    /** @deprecated removed in 2.11.0; ignored. */
-    readAloud?: boolean;
-    welcomeMessage?: string;
-    placeholderText?: string;
-    organizationLogo?: string;
-    buttonIcon?: string;
-    buttonShape?: "round" | "square";
-    autoOpen?: boolean;
-    greeting?: boolean | {
-        message?: string;
-        delayMs?: number;
-    };
-    showTimestamp?: boolean;
-    soundEnabled?: boolean;
-    soundVolume?: number;
-    poweredBy?: string;
-    userId?: string;
-    timestamp?: number;
-    signature?: string;
-    turnstileSiteKey?: string;
-    excludePaths?: string[];
-    includePaths?: string[];
-    configOverride?: Record<string, any>;
-    debug?: boolean;
-    onMessageSent?: (message: string) => void;
-    onMessageReceived?: (reply: string) => void;
-    onChatOpened?: () => void;
-    onChatClosed?: () => void;
-    onEscalation?: (data: any) => void;
-}
-declare const Askly: {
-    init: (config?: AsklyConfig) => void;
-    /**
-     * Tell Askly who the current visitor is.
-     *
-     * Call this after your user logs in. Everything they did anonymously beforehand — on this
-     * browser — is merged into their profile, so an agent sees one person with one history
-     * instead of a stranger every session.
-     *
-     *   Askly.identify({
-     *     userId: "usr_8812",
-     *     email: "priya@example.com",
-     *     name: "Priya Raman",
-     *     hash: "<HMAC-SHA256 of userId+timestamp, computed on YOUR server>",
-     *     timestamp: 1735689600,
-     *   });
-     *
-     * The `hash` is what makes the claim trustworthy. Compute it server-side with your
-     * organization's widget secret key — never ship that secret to the browser. Without a
-     * hash the traits are used locally but the server will not link the accounts, because
-     * anything the browser asserts unsigned could be forged to claim another person's history.
-     */
-    identify: (identity: AsklyIdentity) => void;
-    /**
-     * Forget the current visitor: clears their browser token and local chat history.
-     * Call on logout, especially on shared computers — otherwise the next person inherits
-     * the previous one's conversations.
-     */
-    reset: () => void;
-    /** Remove the widget from the page. Also resets identity, as on logout. */
-    shutdown: () => void;
-    /** Open the chat panel — for host-page CTAs like a "Contact us" button. */
-    open: () => void;
-    /** Close the chat panel. */
-    close: () => void;
-    /** Toggle the chat panel. */
-    toggle: () => void;
-    /** Aliases of open() / close(). */
-    show: () => void;
-    hide: () => void;
-    /** Whether the chat panel is open right now. */
-    isOpen: () => boolean;
-    /** Agent replies the visitor has not seen yet (the number on the launcher badge). */
-    getUnreadCount: () => number;
-    /** This browser's anonymous visitor id, or "" before the widget has mounted. */
-    getVisitorId: () => string;
-    /**
-     * Listen for a widget event. Returns a function that removes the listener.
-     *
-     *   Askly.on("message:received", ({ text, from }) => analytics.track("support_reply", { from }));
-     *   Askly.on("unread", ({ count }) => setBadge(count));
-     */
-    on: <K extends keyof AsklyEventMap>(name: K, handler: AsklyEventHandler<K>) => (() => void);
-    off: <K_1 extends keyof AsklyEventMap>(name: K_1, handler: AsklyEventHandler<K_1>) => void;
-    once: <K_2 extends keyof AsklyEventMap>(name: K_2, handler: AsklyEventHandler<K_2>) => (() => void);
-    /** Resolves when the widget has mounted and applied its configuration. */
-    ready: () => Promise<void>;
-    /** Open the widget on a section: "home", "messages" or "help". */
-    showSpace: (space: AsklySpace) => void;
-    /** Open the chat with the composer ready, optionally pre-filled. Nothing is sent. */
-    showNewMessage: (text?: string) => void;
-    /**
-     * Open the chat and send a message as the visitor. It goes through the same checks as a
-     * typed message; if one is pending (email required, security check) it waits in the composer.
-     */
-    sendMessage: (text: string) => void;
-    /** Open a help article by id, as listed in the Help tab. */
-    showArticle: (articleId: string) => void;
-    /** Open the chat and start recording a voice message. The browser may ask for the microphone. */
-    startVoiceInput: () => void;
-    /** Finish the recording in progress and transcribe it. */
-    stopVoiceInput: () => void;
-    /**
-     * Change display settings on the mounted widget without re-initialising: the fields the
-     * portal controls, e.g. `{ themeColor, theme, organizationName, welcomeMessage, buttonShape }`.
-     */
-    update: (config: Record<string, any>) => void;
-};
-export default Askly;
-export type { AsklyIdentity, AsklyEventMap, AsklyEventName, AsklyEventHandler, AsklySpace };

package/dist/ui/ChatTerms.d.ts

@@ -1,3 +0,0 @@
-import React from "react";
-/** The terms and "Powered by" line under the composer. */
-export declare function ChatTerms(): React.JSX.Element;

package/dist/widget.d.ts

@@ -1,4 +0,0 @@
-import React from "react";
-import type { ChatWidgetProps } from "./core/types";
-import "./styles.css";
-export declare const ChatWidget: ({ orgId, organizationName: initialOrganizationName, themeColor: initialThemeColor, theme: initialTheme, position, orgServerRoute, enableVoiceChat: initialEnableVoiceChat, voiceInput: initialVoiceInput, welcomeMessage: initialWelcomeMessage, placeholderText, organizationLogo: initialOrganizationLogo, buttonIcon, buttonShape: initialButtonShape, autoOpen, greeting, showTimestamp, soundEnabled, soundVolume, poweredBy, userId, timestamp, signature, turnstileSiteKey, excludePaths, includePaths, configOverride, resetGeneration: initResetGeneration, onMessageSent, onMessageReceived, onChatOpened, onChatClosed, onEscalation, }: ChatWidgetProps) => React.JSX.Element | null;