@hachther/akilio-widget 0.6.5 → 0.7.0

package/dist/types.d.ts

@@ -2,10 +2,13 @@ import type { ReactNode } from 'react';
 import type { AkilioResolvedCopy } from './lib/copy';
 export type AkilioMode = 'floating' | 'inline' | 'side-panel' | 'drawer' | 'hybrid';
 export type AkilioColorMode = 'light' | 'dark' | 'system';
+export type AkilioLauncherPosition = 'bottom-right' | 'bottom-left' | 'right-middle';
 export type AkilioLocale = string;
 export type AkilioMessageRole = 'user' | 'assistant';
 export type AkilioFeedbackRating = 'up' | 'down';
 export type AkilioAssistantMode = 'auto' | 'general' | 'knowledge' | 'ecommerce' | 'hybrid';
+export type AkilioChatIntent = 'answer' | 'summarize_page' | 'contact';
+export type AkilioCapabilitySurface = 'widget' | 'public_api';
 export type AkilioWidgetBranding = 'akilio_required' | 'removable' | 'white_label';
 export type AkilioCommerceCapabilityType = 'product_search' | 'product_recommendation';
 export type AkilioCommerceEventType = 'search' | 'recommendation' | 'compare' | 'add_to_cart' | 'checkout' | 'purchase';
@@ -120,10 +123,67 @@ export interface AkilioProjectConfig {
     default_language: string;
     supported_languages: string[];
     widget_policy?: AkilioWidgetPolicy;
+    capabilities?: AkilioPublicRuntimeCapabilities;
     privacy_notice?: string;
     privacy_notice_url?: string;
     require_consent?: boolean;
 }
+export interface AkilioChatIntentCapability {
+    code: AkilioChatIntent | string;
+    enabled: boolean;
+    requirements: string[];
+    surfaces: AkilioCapabilitySurface[];
+}
+export interface AkilioChatIntentCatalog {
+    intents_schema_version: string;
+    default_intent: AkilioChatIntent | string;
+    intents: AkilioChatIntentCapability[];
+    contact_request?: AkilioContactRequestCapability;
+}
+export interface AkilioContactRequestCapability {
+    enabled: boolean;
+    endpoint: string;
+    method: string;
+    consent_required: boolean;
+    consent_text: string;
+    required_fields: string[];
+}
+export type AkilioContactOptionType = 'email' | 'phone' | 'form';
+export interface AkilioContactOption {
+    type: AkilioContactOptionType;
+    label: string;
+    value?: string;
+    url: string;
+}
+export interface AkilioCustomerAction {
+    type: 'start_contact_request';
+    label: string;
+    prompt: string;
+    endpoint: string;
+    method: string;
+    requires_confirmation: boolean;
+    fields: string[];
+}
+export type AkilioPreferredContactMethod = 'email' | 'phone' | 'either';
+export interface AkilioContactRequest {
+    conversation_id: string;
+    source_message_id: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    preferred_contact_method: AkilioPreferredContactMethod;
+    preferred_contact_time?: string;
+    message: string;
+    consent_given: boolean;
+}
+export interface AkilioContactRequestResponse {
+    id: string;
+    status?: string;
+    created_at: string;
+}
+export interface AkilioPublicRuntimeCapabilities {
+    chat: AkilioChatIntentCatalog;
+}
 export interface AkilioWidgetPolicy {
     /** Whether the widget may currently accept user interactions. */
     available: boolean;
@@ -138,6 +198,8 @@ export interface AkilioChatRequest {
     project_key: string;
     conversation_id?: string;
     message: string;
+    /** Explicit action selected from the public config capability catalog. */
+    intent?: AkilioChatIntent;
     locale?: string;
     channel?: string;
     audience?: string;
@@ -175,6 +237,9 @@ export interface AkilioChatResponse {
     cost_usd?: string;
     commerce?: AkilioCommerceCapability | null;
     suggestions?: string[];
+    intent?: AkilioChatIntent;
+    contact_options?: AkilioContactOption[];
+    actions?: AkilioCustomerAction[];
     warnings?: string[];
     assistant_mode?: string;
     active_route?: string;
@@ -265,6 +330,8 @@ export interface AkilioChatMessage {
     streaming?: boolean;
     error?: boolean;
     feedback?: AkilioFeedbackRating;
+    contactOptions?: AkilioContactOption[];
+    actions?: AkilioCustomerAction[];
 }
 export interface AkilioCopyOverrides {
     launcher?: string;
@@ -286,6 +353,24 @@ export interface AkilioCopyOverrides {
     online?: string;
     feedbackQuestion?: string;
     feedbackThanks?: string;
+    feedbackSending?: string;
+    contextualPlaceholder?: string;
+    contextualDismiss?: string;
+    contact?: string;
+    contactName?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    contactMethod?: string;
+    contactMethodEmail?: string;
+    contactMethodPhone?: string;
+    contactMethodEither?: string;
+    contactTime?: string;
+    contactMessage?: string;
+    contactConsent?: string;
+    contactSubmit?: string;
+    contactSending?: string;
+    contactSuccess?: string;
+    contactFailed?: string;
     voteUp?: string;
     voteDown?: string;
     requestFailed?: string;
@@ -304,6 +389,7 @@ export interface AkilioCopyOverrides {
     tourMessage?: string;
     tourAction?: string;
     tourDismiss?: string;
+    summarizePage?: string;
     privacyDefaultNotice?: string;
     switchToLightMode?: string;
     switchToDarkMode?: string;
@@ -322,6 +408,14 @@ export interface AkilioLauncherRenderProps {
 }
 export type AkilioLauncher = 'default' | 'hidden' | ((controls: AkilioLauncherRenderProps) => ReactNode);
 export type AkilioStyleIsolation = 'shadow' | 'scoped' | 'none';
+export interface AkilioContextualPromptOptions {
+    enabled?: boolean;
+    trigger?: 'near-page-end';
+    /** Distance from the document end that reveals the prompt. Defaults to 320px. */
+    threshold?: number;
+    placeholder?: string;
+    dismissible?: boolean;
+}
 export type IntegrationType = 'shopify' | 'woocommerce' | 'wordpress' | 'prestashop' | 'magento' | 'wix' | 'webflow' | 'squarespace' | 'nextjs' | 'react' | 'vue' | 'angular' | 'vanilla' | 'unknown';
 export interface AkilioWidgetProps {
     apiBaseUrl?: string;
@@ -338,6 +432,10 @@ export interface AkilioWidgetProps {
     showAkilioBranding?: boolean;
     /** Use the authenticated SSE chat endpoint. Set false for synchronous compatibility. */
     streaming?: boolean;
+    /** Play a short notification chime after a successful final response. */
+    enableResponseSound?: boolean;
+    /** Notification volume from 0 to 1. Defaults to 0.22. */
+    responseSoundVolume?: number;
     /** Isolate widget CSS from the host page. Shadow DOM is the safest default. */
     styleIsolation?: AkilioStyleIsolation;
     defaultOpen?: boolean;
@@ -345,6 +443,10 @@ export interface AkilioWidgetProps {
     open?: boolean;
     /** Built-in launcher, no launcher, or a custom React launcher renderer. */
     launcher?: AkilioLauncher;
+    /** Position of the built-in launcher. right-middle opens a desktop drawer. */
+    launcherPosition?: AkilioLauncherPosition;
+    /** Show a question prompt as the reader approaches the end of the page. */
+    contextualPrompt?: boolean | AkilioContextualPromptOptions;
     persistOpenState?: boolean;
     /** Show a one-time, dependency-free coachmark beside the default launcher. */
     enableTour?: boolean;
@@ -381,6 +483,7 @@ export interface AkilioWidgetProps {
     integration?: IntegrationType;
 }
 export interface ChatPanelProps {
+    panelId: string;
     open: boolean;
     isDesktop: boolean;
     inline: boolean;
@@ -392,6 +495,7 @@ export interface ChatPanelProps {
     copy: AkilioResolvedCopy;
     locale: string;
     messages: AkilioChatMessage[];
+    feedbackPending: Record<string, AkilioFeedbackRating | undefined>;
     streamingMessage?: AkilioChatMessage | null;
     loading: boolean;
     loadingLabel?: string;
@@ -407,9 +511,17 @@ export interface ChatPanelProps {
     onSubmit: (query: string) => Promise<AkilioChatResponse>;
     onDraftChange?: (draft: string, manual: boolean) => void;
     onFeedback: (message: AkilioChatMessage, rating: AkilioFeedbackRating) => void;
+    contactRequestCapability?: AkilioContactRequestCapability;
+    onContactRequest: (request: AkilioContactRequest) => Promise<AkilioContactRequestResponse>;
     onSuggestion: (suggestion: string) => void;
+    intentActions?: Array<{
+        intent: AkilioChatIntent;
+        label: string;
+    }>;
+    onIntentAction: (intent: AkilioChatIntent, label: string) => void;
     onProductClick: (message: AkilioChatMessage, product: AkilioProduct, variant?: AkilioProductVariant) => void;
     primaryColor?: string;
+    slug?: string;
 }
 export type IntegrationDetection = {
     integration: IntegrationType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hachther/akilio-widget",
-  "version": "0.6.5",
+  "version": "0.7.0",
   "description": "Embeddable React AI assistant widget for Akilio backend.",
   "license": "UNLICENSED",
   "type": "module",