@sonordev/site-kit 7.1.2 → 7.2.0

package/dist/{engage → chat}/EchoUiActions.d.ts

@@ -1,5 +1,5 @@
 /**
- * @sonordev/site-kit/engage - Echo UI Actions
+ * @sonordev/site-kit/chat - Echo UI Actions
  *
  * Renders the optional `uiActions` the visitor Echo concierge returns alongside
  * a chat reply. Rendered beneath the assistant

package/dist/chat/SiteChat.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @sonordev/site-kit/chat - SiteChat: the Website chat a site shows
+ * (Sonor → Messages).
+ *
+ * Echo's launcher, mounted once the browser is idle. SiteKitLayout mounts it
+ * for you (its `chat` prop); mount it yourself only on a site without
+ * SiteKitLayout. ChatWidget, its markdown renderer and its socket download
+ * when it first renders, never with the page. It shows only while the
+ * project's chat is switched on in Sonor (see ChatWidget's isChatEnabled).
+ */
+import React from 'react';
+import type { ChatLauncherPlacement } from './types';
+import { type AnalyticsGateOptions } from '../shared/reporting-gate';
+export interface SiteChatProps extends ChatLauncherPlacement, AnalyticsGateOptions {
+    apiUrl?: string;
+    apiKey?: string;
+    /** For chat routing. Resolved from the API key when absent. */
+    projectId?: string;
+}
+/**
+ * Same gate as analytics (frames, localhost, a key to send with): a chat
+ * launcher in a case study's device frame would talk to the agency's visitor,
+ * not this site's.
+ */
+export declare function SiteChat(props: SiteChatProps): React.JSX.Element | null;

package/dist/{engage → chat}/brand-color.d.ts

@@ -1,5 +1,5 @@
 /**
- * @sonordev/site-kit/engage — Echo's brand colours
+ * @sonordev/site-kit/chat — Echo's brand colours
  *
  * Single source of truth for how Echo turns the site's brand colour into
  * foreground colours. ChatWidget and EchoUiActions route every such decision

package/dist/{engage → chat}/chat-messages.d.ts

@@ -1,5 +1,5 @@
 /**
- * @sonordev/site-kit/engage — Echo's transcript: message shapes and turns
+ * @sonordev/site-kit/chat — Echo's transcript: message shapes and turns
  *
  * Single source of truth for what ChatWidget adds to the transcript when a
  * visitor speaks, and for the one AI turn every send path goes through.

package/dist/{engage → chat}/echo-config.d.ts

@@ -1,5 +1,5 @@
 /**
- * @sonordev/site-kit/engage - Echo Public Configuration
+ * @sonordev/site-kit/chat - Echo Public Configuration
  *
  * Helpers for configuring the ChatWidget with Echo-specific defaults
  * for the Sonor public site (sonor.io).

package/dist/chat/index.d.ts

@@ -2,10 +2,14 @@
  * @sonordev/site-kit/chat — Website chat (Sonor → Messages).
  *
  * The chat launcher and Echo conversation a site shows. SiteKitLayout mounts
- * it for you (its `chat` prop, `engage` before 6.6); import it here to place
- * it yourself. It used to live in `./engage`, which still re-exports it.
+ * it for you (its `chat` prop); `SiteChat` places it yourself the same way
+ * (idle-deferred, gated like analytics), and `ChatWidget` is the widget
+ * itself. `@sonordev/site-kit/engage` (deprecated) re-exports these.
  */
-export { ChatWidget, EchoChat, isChatEnabled } from '../engage/ChatWidget';
-export { chatLauncherStyles, DEFAULT_LAUNCHER_OFFSET_BOTTOM } from '../engage/launcher-placement';
-export type { ChatLauncherStyles } from '../engage/launcher-placement';
-export type { ChatAvailability, ChatConfig, ChatConversation, ChatLauncherPlacement, ChatLauncherPosition, ChatMessage, UiAction, UiActionType, } from '../engage/types';
+export { SiteChat, type SiteChatProps } from './SiteChat';
+export { ChatWidget, EchoChat, isChatEnabled } from './ChatWidget';
+export { chatLauncherStyles, DEFAULT_LAUNCHER_OFFSET_BOTTOM } from './launcher-placement';
+export type { ChatLauncherStyles } from './launcher-placement';
+export { SONOR_PUBLIC_ECHO_DEFAULTS, getEchoWidgetProps } from './echo-config';
+export type { EchoPublicConfig } from './echo-config';
+export type { ChatAvailability, ChatConfig, ChatConversation, ChatLauncherPlacement, ChatLauncherPosition, ChatMessage, UiAction, UiActionType, } from './types';

package/dist/chat/index.js

@@ -1,16 +1,22 @@
 'use client';
-export { ChatWidget, EchoChat, isChatEnabled } from '../chunk-RHNWA34F.js';
-import '../chunk-JE4A5S4F.js';
-export { DEFAULT_LAUNCHER_OFFSET_BOTTOM, chatLauncherStyles } from '../chunk-NDF4A5JM.js';
+export { SONOR_PUBLIC_ECHO_DEFAULTS, getEchoWidgetProps } from '../chunk-HODO5BX5.js';
+export { ChatWidget, DEFAULT_LAUNCHER_OFFSET_BOTTOM, EchoChat, chatLauncherStyles, isChatEnabled } from '../chunk-64DKGVEI.js';
+export { SiteChat } from '../chunk-NV72HZ4W.js';
 import '../chunk-6T6CQVNL.js';
-import '../chunk-V6FDQLR7.js';
-import '../chunk-AQSNPZY4.js';
+import '../chunk-JE4A5S4F.js';
+import '../chunk-27FISYK4.js';
+import '../chunk-FR6BYFPC.js';
+import '../chunk-Q6E4OPGG.js';
+import '../chunk-C2FZBUSS.js';
 import '../chunk-5SQK3D53.js';
+import '../chunk-HW7B43E5.js';
 import '../chunk-NJCTQH2P.js';
 import '../chunk-S22FSH7C.js';
 import '../chunk-L2V5PUFN.js';
 import '../chunk-GJWI74ZZ.js';
-import '../chunk-3SDOQUUF.js';
-import '../chunk-VDF5DFWT.js';
-import '../chunk-AH5Q262S.js';
+import '../chunk-43OCZ3JA.js';
+import '../chunk-EKBEOXTH.js';
+import '../chunk-D6ZC7XKZ.js';
+import '../chunk-K4ZHAURD.js';
+import '../chunk-F24FNCTK.js';
 import '../chunk-PKBMQBKP.js';

package/dist/{engage → chat}/launcher-placement.d.ts

@@ -1,5 +1,5 @@
 /**
- * @sonordev/site-kit/engage - Chat launcher placement
+ * @sonordev/site-kit/chat - Chat launcher placement
  *
  * Single source of truth for where the Echo launcher sits and, derived from
  * it, where the chat popup opens, on screen and in the stacking order.
@@ -14,12 +14,6 @@ import type { CSSProperties } from 'react';
 import type { ChatLauncherPlacement } from './types';
 /** Launcher clearance above the bottom edge when a site sets nothing. */
 export declare const DEFAULT_LAUNCHER_OFFSET_BOTTOM = "20px";
-/**
- * Layer everything Engage renders stacks on when a site sets nothing:
- * popups, nudges, bars and the chat launcher, with the chat popup one below.
- * EngageWidget's default comes from here too.
- */
-export declare const DEFAULT_ENGAGE_Z_INDEX = 9999;
 /**
  * Custom property a stylesheet can set to move the launcher. Wins over the
  * `offsetBottom` option. Deliberately never declared by the kit: a property

package/dist/{engage → chat}/socket-loader.d.ts

@@ -1,8 +1,8 @@
 import type { Socket } from 'socket.io-client';
 /**
  * Lazy socket.io loader — kept in a separate file so bundlers
- * (Turbopack, webpack) never pull socket.io-client into the main
- * engage chunk.  Only loaded when the user actually opens the chat.
+ * (Turbopack, webpack) never pull socket.io-client into the chat
+ * chunk. Only loaded when the user actually opens the chat.
  *
  * This module owns site-kit's entire socket.io surface. If you are wondering
  * why package.json declares `engine.io-client` and `socket.io-parser` when

package/dist/chat/types.d.ts

@@ -0,0 +1,136 @@
+/**
+ * @sonordev/site-kit/chat: Website chat types (Sonor → Messages).
+ */
+/** The corner the Echo chat launcher sits in. */
+export type ChatLauncherPosition = 'bottom-right' | 'bottom-left';
+/**
+ * Where the Echo chat launcher sits, including the layer it stacks on. The
+ * single definition of launcher placement: the layout's `chat` config,
+ * SiteChat's props and ChatConfig all extend it, so a new placement option is
+ * added once. ChatWidget turns it into styles through `chatLauncherStyles`
+ * (./launcher-placement).
+ */
+export interface ChatLauncherPlacement {
+    /** Corner. Default: 'bottom-right' */
+    position?: ChatLauncherPosition;
+    /**
+     * Distance from the bottom of the viewport to the launcher, as any CSS
+     * length (`'88px'`, `'5.5rem'`, `'calc(4rem + 8px)'`). A number is pixels.
+     * Default: `'20px'`.
+     *
+     * The device's safe-area inset is added on top, so pass the clearance you
+     * want above your own UI, not the inset. The chat popup opens above the
+     * launcher wherever this puts it.
+     *
+     * A `--sk-echo-offset-bottom` custom property set anywhere above the
+     * launcher (`:root`, `body`, a media query, a `:has()` rule) wins over this
+     * value. Use that when the offset depends on the page or the breakpoint,
+     * such as clearing a sticky bar that only some pages render.
+     */
+    offsetBottom?: string | number;
+    /**
+     * Stacking layer. The launcher sits on it and the chat popup one layer
+     * beneath. Default: 9999.
+     *
+     * Through SiteKitLayout the same number also stacks popups, banners and
+     * toasts, so everything a site's widgets render shares one layer. Lower it
+     * when the site's own fixed UI (a mobile menu, a cookie banner) has to
+     * cover the chat.
+     */
+    zIndex?: number;
+}
+export interface ChatConfig extends ChatLauncherPlacement {
+    /** Widget position */
+    position: ChatLauncherPosition;
+    /** Widget appearance */
+    buttonIcon?: 'chat' | 'help' | 'custom';
+    buttonColor?: string;
+    buttonText?: string;
+    /** Brand primary color */
+    brandPrimary?: string;
+    /** Welcome message */
+    welcomeMessage?: string;
+    /** Operating hours */
+    operatingHours?: {
+        enabled: boolean;
+        timezone: string;
+        hours: {
+            [day: number]: {
+                start: string;
+                end: string;
+            } | null;
+        };
+    };
+    /** AI vs Live Chat */
+    mode: 'ai' | 'live' | 'hybrid';
+    /** AI settings (if mode is 'ai' or 'hybrid') */
+    aiSettings?: {
+        skillId?: string;
+        handoffToLive?: boolean;
+        handoffKeywords?: string[];
+        /** When AI should suggest handoff based on sentiment or keywords */
+        handoffTriggers?: {
+            negativesentiment?: boolean;
+            keywords?: string[];
+            afterMessages?: number;
+        };
+    };
+    /** Offline mode settings (when no agents available) */
+    offlineMode?: 'form' | 'ai' | 'message';
+    /** Form slug to show when offline (defaults to 'contact') */
+    offlineFormSlug?: string;
+    /** AI fallback when no agents online (hybrid mode) */
+    aiFallbackEnabled?: boolean;
+    /** Custom offline message */
+    offlineMessage?: string;
+}
+/**
+ * UI actions the visitor Echo endpoint (POST /echo/public/chat) may return on
+ * the JSON response alongside `content` / `conversationId`. The chat widget
+ * renders each as an inline card or chip beneath the assistant message.
+ *
+ * This mirrors the shape Echo's endpoint sends. It is a LOCAL contract on
+ * purpose: the kit never imports from the API.
+ *
+ * - `show_form`            → data.formSlug (+ optional data.prefill) — offer the managed form inline.
+ * - `suggest_action`       → data.action + data.message — clickable chip (send message or navigate).
+ * - `show_portfolio_item`  → data.slug — the generic widget ignores it (a site's own chat UI handles it).
+ */
+export type UiActionType = 'show_form' | 'suggest_action' | 'show_portfolio_item';
+export interface UiAction {
+    type: UiActionType | string;
+    data: Record<string, unknown>;
+}
+export interface ChatMessage {
+    id: string;
+    conversation_id: string;
+    role: 'user' | 'assistant' | 'agent' | 'system';
+    content: string;
+    metadata?: Record<string, unknown>;
+    created_at: string;
+    /** Name of the agent (for agent messages) */
+    sender_name?: string;
+    /** Avatar URL of the agent */
+    sender_avatar?: string;
+}
+export interface ChatConversation {
+    id: string;
+    project_id: string;
+    visitor_id: string;
+    status: 'active' | 'ai' | 'pending_handoff' | 'human' | 'closed';
+    assigned_to?: string;
+    last_message_at: string;
+    created_at: string;
+    /** AI summary of the conversation */
+    ai_summary?: string;
+    /** Visitor info */
+    visitor_name?: string;
+    visitor_email?: string;
+}
+/** Availability status returned by the widget API */
+export interface ChatAvailability {
+    available: boolean;
+    mode: 'live' | 'ai' | 'offline';
+    agentsOnline: number;
+    operatingHoursActive: boolean;
+}

package/dist/chunk-27FISYK4.js

@@ -0,0 +1,4 @@
+// src/shared/layers.ts
+var DEFAULT_WIDGET_Z_INDEX = 9999;
+
+export { DEFAULT_WIDGET_Z_INDEX };