@askly/widget 2.11.0 → 3.1.0

package/dist/{core → types/core}/types.d.ts

@@ -6,6 +6,13 @@ export interface ChatWidgetProps {
     themeColor?: string;
     theme?: "light" | "dark" | "auto";
     position?: "left" | "right";
+    offset?: {
+        bottom?: number;
+        side?: number;
+    };
+    hideLauncher?: boolean;
+    customLauncherSelector?: string;
+    locale?: string;
     orgServerRoute: string;
     voiceInput?: false | "review" | "auto-send";
     /** @deprecated use `voiceInput`. `false` turns voice input off for this embed. */
@@ -34,6 +41,7 @@ export interface ChatWidgetProps {
     includePaths?: string[];
     configOverride?: Record<string, any>;
     resetGeneration?: number;
+    greetingStartedAt?: number;
     onMessageSent?: (message: string) => void;
     onMessageReceived?: (reply: string) => void;
     onChatOpened?: () => void;

package/dist/types/core/voice.d.ts

@@ -0,0 +1,6 @@
+export type VoiceInputMode = "off" | "review" | "auto-send";
+/** Why voice input could not start or finish. */
+export type VoiceErrorCode = "insecure" | "unsupported" | "denied" | "no-microphone" | "no-speech" | "no-audio" | "limit" | "disabled" | "network" | "failed";
+export declare function normalizeVoiceInputMode(value: any): VoiceInputMode | undefined;
+/** What to tell the visitor. */
+export declare function voiceErrorMessage(code: VoiceErrorCode): string;

package/dist/types/i18n/en.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Every string the widget shows, in English. Other locales live in ./locales and may leave
+ * keys out; English fills the gaps. `{name}` marks a value filled in at runtime. Keys ending
+ * in `_one` / `_other` are plural forms chosen with Intl.PluralRules.
+ */
+declare const en: {
+    launcher_open: string;
+    launcher_close: string;
+    launcher_open_unread_one: string;
+    launcher_open_unread_other: string;
+    launcher_unread_overflow: string;
+    panel_label: string;
+    header_messages: string;
+    header_help_center: string;
+    header_back_to_conversations: string;
+    header_expand: string;
+    header_collapse: string;
+    header_close: string;
+    conversation_label: string;
+    sending_to_team: string;
+    uploading_attachment: string;
+    new_messages_one: string;
+    new_messages_other: string;
+    reaction_helpful: string;
+    reaction_not_helpful: string;
+    copy_message: string;
+    copied: string;
+    message_from_agent: string;
+    message_from_you: string;
+    terms_notice: string;
+    terms_link: string;
+    powered_by: string;
+    tab_explore: string;
+    tab_messages: string;
+    tab_help: string;
+    tabs_label: string;
+    conversations_empty_title: string;
+    conversations_empty_desc: string;
+    conversation_no_messages: string;
+    conversation_title: string;
+    start_new_chat: string;
+    composer_label: string;
+    composer_placeholder: string;
+    composer_placeholder_lead_required: string;
+    composer_placeholder_security_check: string;
+    composer_hint: string;
+    attach_file: string;
+    insert_emoji: string;
+    emoji_picker_label: string;
+    send_message: string;
+    attachment_image_alt: string;
+    attachment_file_label: string;
+    notice_security_check_required: string;
+    voice_start: string;
+    voice_finish: string;
+    voice_status_waiting: string;
+    voice_status_listening: string;
+    voice_status_transcribing: string;
+    voice_seconds_left_one: string;
+    voice_seconds_left_other: string;
+    voice_countdown: string;
+    voice_cancel: string;
+    voice_stop: string;
+    voice_retry: string;
+    voice_error_insecure: string;
+    voice_error_unsupported: string;
+    voice_error_denied: string;
+    voice_error_no_microphone: string;
+    voice_error_no_speech: string;
+    voice_error_no_audio: string;
+    voice_error_limit: string;
+    voice_error_disabled: string;
+    voice_error_network: string;
+    voice_error_failed: string;
+    lead_prompt: string;
+    lead_email_placeholder: string;
+    lead_email_label: string;
+    lead_save: string;
+    lead_saving: string;
+    lead_dismiss: string;
+    lead_error_invalid_email: string;
+    lead_error_save_failed: string;
+    greeting_default: string;
+    greeting_default_persona: string;
+    greeting_dismiss: string;
+    welcome_default: string;
+    explore_hero_title: string;
+    explore_hero_subtitle: string;
+    explore_search_placeholder: string;
+    explore_cta_title: string;
+    explore_cta_sub: string;
+    explore_tile_help_title: string;
+    explore_tile_help_sub: string;
+    explore_tile_messages_title: string;
+    explore_tile_messages_sub: string;
+    explore_popular_questions: string;
+    explore_ask_ai_about_this: string;
+    explore_recommended_reading: string;
+    help_search_placeholder: string;
+    help_search_label: string;
+    help_searching: string;
+    help_search_no_results: string;
+    help_all_collections: string;
+    help_back_to_articles: string;
+    help_document_type_fallback: string;
+    help_written_by: string;
+    help_updated_recently: string;
+    help_read_time_one: string;
+    help_read_time_other: string;
+    help_feedback_title: string;
+    help_feedback_thanks: string;
+    help_feedback_yes: string;
+    help_feedback_somewhat: string;
+    help_feedback_no: string;
+    help_handoff_title: string;
+    help_handoff_desc: string;
+    help_handoff_prefill: string;
+    help_collection_articles: string;
+    help_article_count_one: string;
+    help_article_count_other: string;
+    help_empty_title: string;
+    help_empty_desc: string;
+    help_collection_guide_title: string;
+    help_collection_guide_desc: string;
+    help_collection_faq_title: string;
+    help_collection_faq_desc: string;
+    help_collection_troubleshooting_title: string;
+    help_collection_troubleshooting_desc: string;
+    help_collection_other_title: string;
+    help_collection_other_desc: string;
+    help_featured_article: string;
+    help_untitled_article: string;
+    help_unavailable: string;
+    link_opens_new_tab: string;
+    error_search_rate_limited: string;
+    error_search_unavailable: string;
+    error_send_rate_limited: string;
+    error_send_failed: string;
+    error_attachment_rejected: string;
+    error_attachment_upload_failed: string;
+};
+export type Messages = typeof en;
+export type MessageKey = keyof Messages;
+export default en;

package/dist/types/i18n/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Translations. English is built in; other locales are chunks fetched on demand. The host
+ * page can override any string with `Askly.updateTexts()`, and the portal can set the
+ * tenant's locale, which wins over the browser's.
+ */
+import { type Messages, type MessageKey } from "./en";
+export type { Messages, MessageKey };
+export declare const SUPPORTED_LOCALES: string[];
+/** The language tag in use, e.g. "en", "pt-BR". */
+export declare function getLocale(): string;
+/** Text direction for the current locale. */
+export declare function getDirection(): "ltr" | "rtl";
+/** The shipped pack that best matches a requested tag: exact, then its language. */
+export declare function resolveLocale(requested: string | undefined | null): string;
+/**
+ * Switch locale. Resolves once the pack is in place (immediately for English or a pack
+ * already fetched). An unknown locale falls back to English; a pack that fails to load
+ * leaves English in place rather than failing.
+ */
+export declare function setLocale(requested: string | undefined | null): Promise<string>;
+/** Replace any strings with the host's own wording, in whatever locale is active. */
+export declare function updateTexts(texts: Partial<Record<MessageKey, string>>): void;
+/** Re-render on locale or text changes. Returns the unsubscribe. */
+export declare function onTextsChange(listener: () => void): () => void;
+type Params = Record<string, string | number>;
+/** A string in the current locale, with `{name}` placeholders filled in. */
+export declare function t(key: MessageKey, params?: Params): string;
+/** A plural string: `key_one` / `key_other` (and `_zero`, `_two`, `_few`, `_many` when a pack has them). */
+export declare function tn(key: string, count: number, params?: Params): string;
+export declare function formatNumber(n: number): string;
+/** A clock time (today) or a short date (earlier) in the visitor's locale. */
+export declare function formatTime(dateAny: any): string;

package/dist/types/i18n/locales/ar.d.ts

@@ -0,0 +1,3 @@
+import type { Messages } from "../en";
+declare const ar: Partial<Messages> & Record<string, string>;
+export default ar;

package/dist/types/i18n/locales/de.d.ts

@@ -0,0 +1,3 @@
+import type { Messages } from "../en";
+declare const de: Partial<Messages>;
+export default de;

package/dist/types/i18n/locales/es.d.ts

@@ -0,0 +1,3 @@
+import type { Messages } from "../en";
+declare const es: Partial<Messages>;
+export default es;

package/dist/types/i18n/locales/fr.d.ts

@@ -0,0 +1,3 @@
+import type { Messages } from "../en";
+declare const fr: Partial<Messages>;
+export default fr;

package/dist/types/i18n/locales/hi.d.ts

@@ -0,0 +1,3 @@
+import type { Messages } from "../en";
+declare const hi: Partial<Messages>;
+export default hi;

package/dist/types/i18n/locales/pt.d.ts

@@ -0,0 +1,3 @@
+import type { Messages } from "../en";
+declare const pt: Partial<Messages>;
+export default pt;

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+import type { AsklyApi } from "./core/api";
+declare const Askly: AsklyApi;
+export default Askly;
+export type { AsklyApi } from "./core/api";
+export type { AsklyConfig } from "./core/config";
+export type { AsklyIdentity } from "./identity";
+export type { AsklyEventMap, AsklyEventName, AsklyEventHandler, AsklySpace } from "./core/events";
+export type { MessageKey as AsklyTextKey } from "./i18n/en";

package/dist/types/loader/attrs.d.ts

@@ -0,0 +1,4 @@
+/** `data-*` attributes on the script tag, as init() options. */
+import type { AsklyConfig } from "../core/config";
+export declare function appIdFromScript(script: Element | null): string | undefined;
+export declare function configFromScript(currentScript: Element, autoAppId: string): AsklyConfig;

package/dist/types/loader/core.d.ts

@@ -0,0 +1,26 @@
+export declare const ASKLY_API_BASE = "https://api.askly.co.in";
+export declare const APP_FILE = "app/askly-app.js";
+export interface LoaderOptions {
+    /** URL of the app module (`app/askly-app.js`). */
+    appUrl: string;
+    /** Tried when `appUrl` cannot be fetched (the versioned CDN copy). */
+    fallbackUrl?: string;
+}
+/** The queue the app replays. `v` lets a future app recognise an older stub. */
+export interface AsklyStub {
+    q: Array<[string, any[]]> | null;
+    v: number;
+    _r: Array<() => void>;
+    _t: number;
+    _unpaint?: () => void;
+    [method: string]: any;
+}
+export declare function createLoader(initial: LoaderOptions): AsklyStub;
+/**
+ * Where the loader's script came from, as the place to fetch the app from. A floating CDN
+ * tag (`@3`, `@latest`, none) is pinned to this exact version so the app and its chunks
+ * always come from one immutable path.
+ */
+export declare function appUrlFromScript(src: string | null | undefined, version: string, fallback: string): string;
+/** The <script> that loaded this file: `document.currentScript`, else the tag that names it. */
+export declare function findLoaderScript(): HTMLScriptElement | null;

package/dist/types/ui/ChatTerms.d.ts

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

package/dist/{ui → types/ui}/GreetingBubble.d.ts

@@ -4,9 +4,13 @@ export interface GreetingBubbleProps {
     accentVars: React.CSSProperties;
     aiAnswering: boolean;
     aiAvatarUrl: string | null;
+    /** Text direction of the current locale, set on the root. */
+    dir: "ltr" | "rtl";
     dismissGreeting: () => void;
     faqs: Faq[];
     greetingText: string;
+    /** Language tag of the current locale, for screen readers' pronunciation. */
+    lang: string;
     openFromGreeting: (question?: string) => void;
     organizationLogo: string | undefined;
     position: "left" | "right";

package/dist/{ui → types/ui}/Launcher.d.ts

@@ -6,11 +6,16 @@ export interface LauncherProps {
     buttonIcon: string;
     buttonShape: "round" | "square";
     buttonStyle: React.CSSProperties;
+    /** Text direction of the current locale, set on the root so the badge and glyph follow it. */
+    dir: "ltr" | "rtl";
+    /** Language tag of the current locale, for screen readers' pronunciation. */
+    lang: string;
     launcherUnread: number;
     resolvedTheme: string;
     setActiveChatId: (chatId: string | null) => void;
     setActiveTab: (tab: WidgetTab) => void;
     unreadChatId: string | undefined;
+    launcherRef?: React.RefObject<HTMLButtonElement>;
 }
 /** The floating button that opens and closes the panel, with the unread badge. */
 export declare function Launcher(props: LauncherProps): React.JSX.Element;

package/dist/{ui → types/ui}/MessageList.d.ts

@@ -7,6 +7,11 @@ export interface MessageListProps {
     setCopiedMsgIndex: React.Dispatch<React.SetStateAction<number | null>>;
     setMsgReactions: React.Dispatch<React.SetStateAction<Record<number, "up" | "down">>>;
     showTimestamp: boolean;
+    /**
+     * Bumped by the widget whenever the locale or the host's text overrides change. The list is
+     * memoised on its props, so without this a text change would leave stale labels on screen.
+     */
+    textsVersion: number;
 }
 /** The messages of the chat on screen. */
 declare function MessageListView(props: MessageListProps): React.JSX.Element;

package/dist/types/widget-entry.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/widget.d.ts

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