@avaya/infinity-omni-sdk-messaging-ui 1.0.2 → 1.0.4

package/lib/index.d.ts

@@ -36,10 +36,6 @@ export declare type Action = {
  */
 export declare enum ActionType {
     REPLY = "reply",
-    /**
-     * @hidden
-     * This is not intended to be used by consumers, it is reserved for future use.
-     */
     LINK = "link",
     /**
      * @hidden
@@ -89,6 +85,25 @@ export declare interface Attachment {
     attachmentUrl: string;
 }
 
+/**
+ * A flat `autoPopup` proactive-chat config entry. When its timer fires, the chat
+ * window is programmatically maximized. The discriminator value `"autoPopup"` is
+ * wire-locked.
+ */
+export declare type AutoPopupConfigEntry = {
+    type: ProactiveChatActionType.AUTO_POPUP;
+    details: {
+        /**
+         * The structured delay before the auto-popup fires. See
+         * {@link WebchatActionTimerDelay} for unit/scalar semantics and ranges.
+         *
+         * Arming is presence-based: an `autoPopup` entry is armed simply by being
+         * present in `triggers[]`.
+         */
+        timerDelay: WebchatActionTimerDelay;
+    };
+};
+
 /**
  * Web Component that implements the Avaya Infinity Messaging UI. The Web Component is
  * highly customizable and can be easily integrated into the Client website
@@ -250,6 +265,33 @@ export declare class AvayaInfinityOmniSdkMessagingUi extends HTMLElement {
     /* Excluded from this release type: connectedCallback */
 }
 
+/**
+ * A `bubbleTeaser` proactive-chat config entry. When its timer fires, the teaser
+ * message is shown next to the minimized chat bubble. The discriminator value
+ * `"bubbleTeaser"` is wire-locked.
+ */
+export declare type BubbleTeaserConfigEntry = {
+    type: ProactiveChatActionType.BUBBLE_TEASER;
+    details: {
+        /**
+         * Discriminator for the `message` payload. When absent, the entry is
+         * treated as a plain `text` config for backward compatibility.
+         */
+        messageType?: ProactiveChatMessageType;
+        /**
+         * The typed message payload. For `text`, this is a string. For `template`
+         * and `richMedia`, this is a server-resolved structured payload. Today only
+         * the `text` path is wired; non-text payloads are warn-and-skipped.
+         */
+        message: string | object;
+        /**
+         * The structured delay before the bubble teaser is shown. See
+         * {@link WebchatActionTimerDelay} for unit/scalar semantics and ranges.
+         */
+        timerDelay: WebchatActionTimerDelay;
+    };
+};
+
 /**
  * The configuration for the button in the theme.
  */
@@ -262,6 +304,19 @@ export declare type ButtonConfig = {
     activeTextColor?: CSSProperties["color"];
 };
 
+/**
+ * The shape of the new `/config` response. `proactiveChatConfigs` is optional
+ * on the wire — when omitted (or when the SDK falls back to the legacy
+ * `/themes` endpoint on a 404) the proactive-chat engine is a no-op.
+ *
+ * The `proactiveChatConfigs` list carries only `autoPopup` and `bubbleTeaser`
+ * config entries.
+ */
+export declare type ConfigResponse = {
+    themes: ThemesResponse;
+    proactiveChatConfigs?: ReadonlyArray<ProactiveChatConfig>;
+};
+
 /**
  * State of the connection with Avaya Infinity platform servers.
  */
@@ -647,6 +702,28 @@ export declare type MessagingUiConfig = {
      * @param message - The message that is to be rendered.
      */
     beforeMessageRender?: (message: Message) => Message;
+    /**
+     * Client-side override for the Proactive-Chat (auto popup / bubble teaser)
+     * configuration. When provided, this overrides any per-URL config rows received
+     * from the server. Set to an empty array to disable proactive-chat entirely
+     * for this client deployment.
+     *
+     * This list carries only the two proactive-chat configs: `autoPopup` (flat
+     * row) and `bubbleTeaser`.
+     *
+     * @see {@link ProactiveChatConfig}
+     */
+    proactiveChatConfigs?: ReadonlyArray<ProactiveChatConfig>;
+    /**
+     * The handler function that will be called when the SDK fails to fetch the
+     * proactive-chat configuration in a non-recoverable way (network error,
+     * server 5xx, JWT failure). A graceful 404 fallback to the legacy `/themes`
+     * endpoint is NOT routed through this callback — it is the expected state
+     * during phased rollout.
+     *
+     * @param error - The typed error describing what went wrong.
+     */
+    onProactiveChatError?: (error: ProactiveChatError) => void;
 };
 
 /**
@@ -694,6 +771,37 @@ export declare type MessagingUiTheme = {
         backgroundColor?: CSSProperties["backgroundColor"];
         iconSource?: string;
         border?: CSSProperties["border"];
+        /**
+         * Visual configuration for the Bubble Teaser — the small message preview
+         * that animates next to the minimized chat bubble during proactive
+         * engagement.
+         *
+         * Server values arrive via the `/config` themes payload as
+         * `bubbleTeaserBackgroundColor` / `bubbleTeaserTextColor` and are mapped
+         * into this `teaser` sub-config during the admin theme merge.
+         */
+        teaser?: {
+            /** Background color of the teaser bubble. Default: `#FFFFFF`. */
+            backgroundColor?: CSSProperties["backgroundColor"];
+            /** Text color of the teaser bubble. Default: `#1F3A68`. */
+            textColor?: CSSProperties["color"];
+            /**
+             * Close ("dismiss") affordance for the teaser. Client-side only — these
+             * are NOT part of the admin `/config` themes payload (the admin merge
+             * only maps `bubbleTeaserBackgroundColor` / `bubbleTeaserTextColor`).
+             * Consumers may override via a client theme.
+             */
+            closeButton?: {
+                /**
+                 * Icon for the close button. Accepts a Neo icon class (e.g.
+                 * `neo-icon-close`) or an image URL, matching {@link CustomIcon}.
+                 * Default: `neo-icon-close`.
+                 */
+                iconSource?: string;
+                /** Color of the close icon. Defaults to the teaser `textColor`. */
+                color?: CSSProperties["color"];
+            };
+        };
     };
     messagingWindow?: {
         title?: {
@@ -776,7 +884,7 @@ export declare type MessagingUiTheme = {
             composite?: {
                 linkButtons?: ButtonConfig;
                 postBackButtons?: ButtonConfig;
-                quickReplyButtons?: ButtonConfig;
+                quickReplyButtons?: QuickReplyButtonConfig;
                 locationRequest?: {
                     button?: ButtonConfig;
                     iconSource?: string;
@@ -915,6 +1023,137 @@ export declare enum ParticipantType {
     BOT = "BOT"
 }
 
+/**
+ * The well-known `type` discriminators for proactive-chat config entries. The
+ * values are wire-locked: `"autoPopup"` for {@link AutoPopupConfigEntry} and
+ * `"bubbleTeaser"` for {@link BubbleTeaserConfigEntry}.
+ */
+export declare enum ProactiveChatActionType {
+    AUTO_POPUP = "autoPopup",
+    BUBBLE_TEASER = "bubbleTeaser"
+}
+
+/**
+ * A row of proactive-chat config entries scoped to a specific URL pattern.
+ *
+ * Deliberately excludes server-internal fields (`accountId`, `webChatId`, `id`) —
+ * the SDK consumes only the URL and the trigger list. The inner `triggers[]`
+ * array carries the {@link ProactiveChatConfigEntry} discriminated union.
+ */
+export declare type ProactiveChatConfig = {
+    /**
+     * The URL (or pattern matched by the SPA navigation detector) that this set
+     * of proactive-chat triggers applies to.
+     */
+    url: string;
+    /**
+     * The trigger entries to evaluate when the user is on the matching URL.
+     */
+    triggers: ReadonlyArray<ProactiveChatConfigEntry>;
+};
+
+/**
+ * The flat, top-level shape of a single proactive-chat config entry — a
+ * discriminated union on `type` of {@link AutoPopupConfigEntry} and
+ * {@link BubbleTeaserConfigEntry}. The discriminator values `"autoPopup"` and
+ * `"bubbleTeaser"` are wire-locked.
+ */
+export declare type ProactiveChatConfigEntry = AutoPopupConfigEntry | BubbleTeaserConfigEntry;
+
+/**
+ * The typed error passed to {@link MessagingUiConfig.onProactiveChatError}.
+ *
+ * A 404 from `/config` is NOT an error — it is the expected fallback path
+ * during phased rollout and is logged at INFO level, not surfaced here.
+ */
+export declare type ProactiveChatError = {
+    /**
+     * Machine-readable error code.
+     */
+    code: ProactiveChatErrorCode;
+    /**
+     * Human-readable message suitable for logging. Never contains PII or JWTs.
+     */
+    message: string;
+    /**
+     * The HTTP status returned by the server, when the error originated from a
+     * non-404 HTTP response.
+     */
+    status?: number;
+    /**
+     * The underlying error, when the failure was a thrown exception
+     * (e.g., a network error before a response was received).
+     */
+    cause?: unknown;
+};
+
+/**
+ * The set of well-known error codes surfaced by {@link MessagingUiConfig.onProactiveChatError}.
+ *
+ * `CONFIG_FETCH_FAILED` is the only code currently emitted; future codes can be
+ * added without breaking existing consumers because the callback receives the
+ * full object.
+ */
+export declare type ProactiveChatErrorCode = "CONFIG_FETCH_FAILED";
+
+/**
+ * The well-known set of `messageType` discriminators carried inside a
+ * `bubbleTeaser` config's `details`. The `text` path is the only one wired
+ * end-to-end today; `template` and `richMedia` payloads are accepted on the
+ * wire but the engine warn-and-skips them for now.
+ */
+export declare enum ProactiveChatMessageType {
+    TEXT = "text",
+    TEMPLATE = "template",
+    RICH_MEDIA = "richMedia"
+}
+
+/**
+ * The configuration for quick reply buttons, extending ButtonConfig with inactive button state properties.
+ *
+ * Quick reply buttons support additional styling options for inactive states, allowing you to either
+ * apply a brightness filter to the active button colors or use explicit inactive colors.
+ *
+ * @example
+ * ```typescript
+ * const quickReplyConfig: QuickReplyButtonConfig = {
+ *   backgroundColor: "#4F46E5",
+ *   fontConfig: { color: "#FFFFFF" },
+ *   useInactiveBackgroundBrightness: true,
+ *   inactiveButtonBrightness: 0.8
+ * };
+ * ```
+ */
+export declare type QuickReplyButtonConfig = ButtonConfig & {
+    /**
+     * Determines the styling strategy for inactive buttons.
+     * - When true, inactive buttons use a brightness filter (controlled by the `inactiveButtonBrightness` property) on the active background color.
+     * - When false, inactive buttons use the explicit `inactiveButtonBackgroundColor` and `inactiveButtonTextColor` properties as the background and text color respectively.
+     *
+     * @default true
+     */
+    useInactiveBackgroundBrightness?: boolean;
+    /**
+     * The brightness value to apply for inactive state when `useInactiveBackgroundBrightness` is true.
+     * Values less than 1 darken the button, values greater than 1 brighten it.
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/filter-function/brightness}
+     *
+     * @default 0.8
+     */
+    inactiveButtonBrightness?: number;
+    /**
+     * Background color for inactive quick reply buttons when `useInactiveBackgroundBrightness` is false.
+     * This property is only used when `useInactiveBackgroundBrightness` is set to false.
+     */
+    inactiveButtonBackgroundColor?: CSSProperties["backgroundColor"];
+    /**
+     * Text color for inactive quick reply buttons when `useInactiveBackgroundBrightness` is false.
+     * This property is only used when `useInactiveBackgroundBrightness` is set to false.
+     * If not specified, falls back to the `fontConfig` color.
+     */
+    inactiveButtonTextColor?: CSSProperties["color"];
+};
+
 /**
  * Payload for the rich media content which covers image, file, postback, reply, location, carousel.
  */
@@ -984,16 +1223,56 @@ export declare type TextConfig = {
     translations?: Translations;
 };
 
+/**
+ * The shape of the legacy `/themes` payload — a list of named theme objects with
+ * flat property maps. The SDK consumes the entry named `"default"`.
+ *
+ * The same shape is embedded as the `themes` field of the new `/config`
+ * response.
+ */
+export declare type ThemesResponse = ReadonlyArray<{
+    name: string;
+    properties?: Record<string, string>;
+}>;
+
+/**
+ * The unit a {@link WebchatActionTimerDelay} `scalar` is expressed in. The
+ * values are wire-locked (`"seconds"` / `"minutes"`).
+ */
+export declare enum TimerDelayUnit {
+    SECONDS = "seconds",
+    MINUTES = "minutes"
+}
+
 /**
  * The translation for the Messaging UI for different {@link Locale}.
  */
 export declare type Translations = Partial<Record<Locale, string>>;
 
+/**
+ * A structured delay value used by proactive-chat config entries
+ * (`autoPopup`, `bubbleTeaser`). The admin UI captures both a numeric scalar
+ * and the unit it represents — the SDK converts this to milliseconds when
+ * arming its `setTimeout` (see `ProactiveChatEngine`).
+ *
+ * Server-enforced ranges:
+ * - `seconds`: scalar in `[1, 3600]`
+ * - `minutes`: scalar in `[1, 60]`
+ *
+ * Both ranges resolve to the same maximum (60 minutes / 3600 seconds); `unit` is
+ * a presentation choice, not a capability change.
+ */
+declare type WebchatActionTimerDelay = {
+    /**
+     * The unit `scalar` is expressed in.
+     */
+    unit: TimerDelayUnit;
+    /**
+     * The numeric delay value. Must be a positive integer within the
+     * unit-appropriate range — out-of-range values cause the engine to
+     * warn-and-skip arming the row.
+     */
+    scalar: number;
+};
+
 export { }
-
-
-declare global {
-    interface Window {
-        messagingUiConfig?: MessagingUiConfig;
-    }
-}

package/package.json

@@ -1,31 +1,31 @@
 {
   "name": "@avaya/infinity-omni-sdk-messaging-ui",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "type": "module",
   "dependencies": {
-    "@ant-design/icons": "^5.4.0",
-    "@avaya/infinity-omni-sdk-core": "^1.0.2",
-    "@avaya/infinity-omni-sdk-messaging": "^1.0.2",
+    "@ant-design/icons": "^5.6.1",
+    "@avaya/infinity-omni-sdk-core": "^1.0.4",
+    "@avaya/infinity-omni-sdk-messaging": "^1.0.4",
     "@avaya/neo-react": "^1.1.10",
     "@emoji-mart/data": "^1.1.2",
     "@emoji-mart/react": "^1.1.1",
-    "@reduxjs/toolkit": "^2.2.2",
-    "@testing-library/jest-dom": "^6.4.5",
-    "@testing-library/react": "^16.0.0",
-    "antd": "^5.15.4",
+    "@reduxjs/toolkit": "^2.12.0",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "antd": "^5.29.3",
     "emoji-mart": "^5.5.2",
-    "i18next": "^23.10.1",
-    "lodash": "^4.17.21",
-    "react": "^18.2.0",
+    "i18next": "^23.16.8",
+    "lodash": "^4.18.1",
+    "react": "^18.3.1",
     "react-custom-scrollbars-2": "^4.5.0",
-    "react-dom": "^18.2.0",
-    "react-i18next": "^15.0.1",
+    "react-dom": "^18.3.1",
+    "react-i18next": "^15.7.4",
     "react-markdown": "^10.1.0",
-    "react-redux": "^9.0.4",
-    "react-to-print": "3.1.0",
-    "react-uuid": "^2.0.0",
+    "react-redux": "^9.3.0",
+    "react-to-print": "3.3.0",
     "redux": "^5.0.0",
-    "remark-gfm": "^4.0.1"
+    "remark-gfm": "^4.0.1",
+    "uuid": "^11.1.1"
   },
   "exports": {
     ".": {