@opencx/widget 2.6.0 → 2.6.2

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

@@ -3,15 +3,18 @@ export type FunctionReturningPromise = (...args: any[]) => Promise<any>;
 export type MakeKeysNotNullable<T, K extends keyof T> = Omit<T, K> & {
     [P in K]-?: NonNullable<T[P]>;
 };
-export type LoadingReason = 'sending_message_to_bot' | 'sending_message_to_agent' | 'creating_session' | 'polling' | 'loading_contact' | 'saving_contact' | 'cleaning_up' | null;
+export type LoadingReason = 'sending_message_to_bot' | 'sending_message_to_agent' | 'creating_session' | 'polling' | 'loading_contact' | 'saving_contact' | 'cleaning_up' | 'creating_unauthenticated_contact' | null;
 export type LoadingState = {
     isLoading: boolean;
     reason: LoadingReason;
 };
-export type ErrorCode = 'SESSION_CREATION_FAILED' | 'SESSION_CLEAR_FAILED' | 'SESSION_PERSISTENCE_FAILED' | 'SESSION_POLLING_FAILED' | 'MESSAGES_POLLING_FAILED' | 'MESSAGE_SEND_FAILED' | 'NO_ACTIVE_SESSION' | 'CONTACT_PERSISTENCE_FAILED' | 'CONTACT_LOAD_FAILED' | 'CONTACT_SAVE_FAILED' | 'CONTACT_CLEANUP_FAILED';
+export type ErrorCode = 'SESSION_CREATION_FAILED' | 'SESSION_CLEAR_FAILED' | 'SESSION_PERSISTENCE_FAILED' | 'SESSION_POLLING_FAILED' | 'MESSAGES_POLLING_FAILED' | 'MESSAGE_SEND_FAILED' | 'NO_ACTIVE_SESSION' | 'CONTACT_PERSISTENCE_FAILED' | 'CONTACT_LOAD_FAILED' | 'CONTACT_SAVE_FAILED' | 'CONTACT_CLEANUP_FAILED' | 'CONTACT_CREATION_FAILED';
 export type ErrorState = {
     hasError: boolean;
     message?: string;
     code?: ErrorCode;
 };
 export type SomeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type SafeOmit<T, K extends keyof T> = Omit<T, K>;
+export type SafeExtract<T, K extends T> = Extract<T, K>;
+export type StringOrLiteral<T extends string> = T | (string & {});

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

@@ -1,3 +1,4 @@
+import { AgentType } from './messages';
 import { ChatAttachmentType } from './schemas-v2';
 export * from './messages';
 export * from './schemas-v2';
@@ -28,15 +29,11 @@ export interface CoreOptions {
     pathParams?: Record<string, string>;
     collectUserData?: boolean;
     debug?: boolean;
+    initialMessages?: string[];
     language?: string;
     user?: User;
     contactToken?: string;
-    bot?: {
-        name?: string;
-        avatarUrl?: string;
-        id?: number | null;
-        is_ai?: boolean;
-    };
+    bot?: AgentType;
     pollingInterval?: number;
     soundEffectFiles?: {
         messageArrived?: string;
@@ -49,4 +46,7 @@ export interface CoreOptions {
         persistSession?: boolean;
         useSoundEffects?: boolean;
     };
+    assets?: {
+        organizationLogo?: string;
+    };
 }

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

@@ -1,10 +1,18 @@
-import { AgentType, ChatAttachmentType, ChatHistoryMessageType } from './schemas';
+import { DefaultTextComponentBaseProps, WidgetLiteralComponentKey } from '../../react-web/types';
+import { ChatAttachmentType, WidgetHistoryDto } from './schemas-v2';
+import { SafeExtract, StringOrLiteral } from './helpers';
+export type AgentType = {
+    isAi: boolean;
+    id: string | null;
+    name: string;
+    avatar: string | null;
+};
 export type UserMessageType = {
     id: string;
     type: "FROM_USER";
     content: string;
     deliveredAt: string | null;
-    attachments?: ChatAttachmentType[];
+    attachments?: ChatAttachmentType[] | null;
     timestamp: string;
     user?: {
         name?: string;
@@ -14,23 +22,26 @@ export type UserMessageType = {
         avatarUrl?: string;
     };
 };
-export type BotMessageType<TData = unknown> = {
+export type BotMessageType<TData = DefaultTextComponentBaseProps | unknown> = {
     id: string;
     type: "FROM_BOT";
-    component: string;
+    /**
+     * The type is a bot_message literal string or other strings that correspond to the UI responses from AI action calls
+     */
+    component: StringOrLiteral<SafeExtract<WidgetLiteralComponentKey, "bot_message">>;
     data: TData;
     timestamp: string;
-    original?: ChatHistoryMessageType;
+    original?: WidgetHistoryDto;
     agent?: AgentType;
     attachments?: ChatAttachmentType[];
 };
-export type AgentMessageType<TData = unknown> = {
+export type AgentMessageType = {
     id: string;
     type: "FROM_AGENT";
-    component: string;
-    data: TData;
+    component: SafeExtract<WidgetLiteralComponentKey, "agent_message">;
+    data: DefaultTextComponentBaseProps;
     timestamp?: string;
-    original?: ChatHistoryMessageType;
+    original?: WidgetHistoryDto;
     agent?: AgentType;
     attachments?: ChatAttachmentType[];
 };