@opencx/widget 2.0.0

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

@@ -0,0 +1,489 @@
+import { default as z } from 'zod';
+export declare enum SessionStatus {
+    OPEN = 0,
+    CLOSED_RESOLVED = 1,
+    CLOSED_UNRESOLVED = 2
+}
+export declare enum SessionChannel {
+    WEB = "web",
+    WEB_VOICE = "web_voice",
+    PHONE_VOICE = "phone_voice",
+    EMAIL = "email",
+    SMS = "sms",
+    WHATSAPP = "whatsapp",
+    API = "api"
+}
+export declare enum AIClosureType {
+    resolved = "resolved",
+    assumed_resolved = "assumed_resolved",
+    handed_off = "handed_off"
+}
+export declare enum SentimentEnum {
+    happy = "happy",
+    neutral = "neutral",
+    angry = "angry"
+}
+export declare enum MessageTypeEnum {
+    MESSAGE = "message",
+    HANDOFF = "handoff",
+    HANDOFF_TO_ZENDESK = "handoff_to_zendesk",
+    AGENT_MESSAGE = "agent_message",
+    AGENT_JOINED = "agent_joined",
+    AGENT_TOOK_SESSION_FROM_AI = "agent_took_session_from_ai",
+    AI_DECIDED_TO_RESOLVE_THE_ISSUE = "ai_decided_to_resolve_the_issue",
+    EMAIL_DRAFT_MESSAGE = "email_draft_message",
+    FOLLOWUP = "followup"
+}
+export declare const chatSessionSchema: z.ZodObject<{
+    id: z.ZodString;
+    ai_closure_type: z.ZodNullable<z.ZodNativeEnum<typeof AIClosureType>>;
+    assignee_id: z.ZodNullable<z.ZodNumber>;
+    channel: z.ZodNativeEnum<typeof SessionChannel>;
+    summary: z.ZodNullable<z.ZodString>;
+    status: z.ZodNativeEnum<typeof SessionStatus>;
+    language: z.ZodNullable<z.ZodString>;
+    last_message: z.ZodNullable<z.ZodString>;
+    last_message_at: z.ZodNullable<z.ZodDate>;
+    assignee: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        email: z.ZodString;
+        avatar_url: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        email: string;
+        name: string;
+        avatar_url?: string | undefined;
+    }, {
+        email: string;
+        name: string;
+        avatar_url?: string | undefined;
+    }>>>;
+    sentiment: z.ZodNullable<z.ZodNativeEnum<typeof SentimentEnum>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    ai_closure_type: AIClosureType | null;
+    assignee_id: number | null;
+    channel: SessionChannel;
+    status: SessionStatus;
+    summary: string | null;
+    language: string | null;
+    last_message: string | null;
+    last_message_at: Date | null;
+    sentiment: SentimentEnum | null;
+    assignee?: {
+        email: string;
+        name: string;
+        avatar_url?: string | undefined;
+    } | null | undefined;
+}, {
+    id: string;
+    ai_closure_type: AIClosureType | null;
+    assignee_id: number | null;
+    channel: SessionChannel;
+    status: SessionStatus;
+    summary: string | null;
+    language: string | null;
+    last_message: string | null;
+    last_message_at: Date | null;
+    sentiment: SentimentEnum | null;
+    assignee?: {
+        email: string;
+        name: string;
+        avatar_url?: string | undefined;
+    } | null | undefined;
+}>;
+export type ChatAttachmentType = {
+    id: string;
+    name: string;
+    size: number;
+    type: string;
+    url: string;
+};
+export declare const chatAttachmentSchema: z.ZodType<ChatAttachmentType>;
+export declare const chatHistoryMessageSchema: z.ZodObject<{
+    publicId: z.ZodString;
+    message: z.ZodNullable<z.ZodString>;
+    type: z.ZodNullable<z.ZodString>;
+    agent_avatar: z.ZodNullable<z.ZodString>;
+    agent_id: z.ZodNullable<z.ZodNumber>;
+    agent_name: z.ZodNullable<z.ZodString>;
+    created_at: z.ZodString;
+    from_user: z.ZodNullable<z.ZodBoolean>;
+    handoff_happened_during_office_hours: z.ZodNullable<z.ZodBoolean>;
+    session_id: z.ZodString;
+    updated_at: z.ZodNullable<z.ZodString>;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodType<ChatAttachmentType, z.ZodTypeDef, ChatAttachmentType>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    message: string | null;
+    type: string | null;
+    publicId: string;
+    agent_avatar: string | null;
+    agent_id: number | null;
+    agent_name: string | null;
+    created_at: string;
+    from_user: boolean | null;
+    handoff_happened_during_office_hours: boolean | null;
+    session_id: string;
+    updated_at: string | null;
+    attachments?: ChatAttachmentType[] | undefined;
+}, {
+    message: string | null;
+    type: string | null;
+    publicId: string;
+    agent_avatar: string | null;
+    agent_id: number | null;
+    agent_name: string | null;
+    created_at: string;
+    from_user: boolean | null;
+    handoff_happened_during_office_hours: boolean | null;
+    session_id: string;
+    updated_at: string | null;
+    attachments?: ChatAttachmentType[] | undefined;
+}>;
+declare const agentSchema: z.ZodObject<{
+    name: z.ZodString;
+    is_ai: z.ZodBoolean;
+    profile_picture: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    id: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string | null;
+    name: string;
+    is_ai: boolean;
+    profile_picture?: string | null | undefined;
+}, {
+    id: string | null;
+    name: string;
+    is_ai: boolean;
+    profile_picture?: string | null | undefined;
+}>;
+export declare const structuredSocketMessageSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"message">;
+    value: z.ZodString;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodType<ChatAttachmentType, z.ZodTypeDef, ChatAttachmentType>, "many">>;
+    is_stream_chunk: z.ZodOptional<z.ZodBoolean>;
+    server_session_id: z.ZodString;
+    client_message_id: z.ZodOptional<z.ZodString>;
+    server_message_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "message";
+    server_session_id: string;
+    server_message_id: string;
+    attachments?: ChatAttachmentType[] | undefined;
+    is_stream_chunk?: boolean | undefined;
+    client_message_id?: string | undefined;
+}, {
+    value: string;
+    type: "message";
+    server_session_id: string;
+    server_message_id: string;
+    attachments?: ChatAttachmentType[] | undefined;
+    is_stream_chunk?: boolean | undefined;
+    client_message_id?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"info">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "info";
+}, {
+    value: string;
+    type: "info";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"ui">;
+    value: z.ZodObject<{
+        type: z.ZodString;
+        request_response: z.ZodAny;
+        name: z.ZodString;
+        content: z.ZodString;
+        message_id: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        content: string;
+        request_response?: any;
+        message_id?: string | undefined;
+    }, {
+        type: string;
+        name: string;
+        content: string;
+        request_response?: any;
+        message_id?: string | undefined;
+    }>;
+    client_message_id: z.ZodOptional<z.ZodString>;
+    server_session_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: {
+        type: string;
+        name: string;
+        content: string;
+        request_response?: any;
+        message_id?: string | undefined;
+    };
+    type: "ui";
+    server_session_id: string;
+    client_message_id?: string | undefined;
+}, {
+    value: {
+        type: string;
+        name: string;
+        content: string;
+        request_response?: any;
+        message_id?: string | undefined;
+    };
+    type: "ui";
+    server_session_id: string;
+    client_message_id?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"chat_event">;
+    value: z.ZodObject<{
+        event: z.ZodNativeEnum<typeof MessageTypeEnum>;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        event: MessageTypeEnum;
+    }, {
+        message: string;
+        event: MessageTypeEnum;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    value: {
+        message: string;
+        event: MessageTypeEnum;
+    };
+    type: "chat_event";
+}, {
+    value: {
+        message: string;
+        event: MessageTypeEnum;
+    };
+    type: "chat_event";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"options">;
+    value: z.ZodObject<{
+        options: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        options: string[];
+    }, {
+        options: string[];
+    }>;
+    server_session_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: {
+        options: string[];
+    };
+    type: "options";
+    server_session_id: string;
+}, {
+    value: {
+        options: string[];
+    };
+    type: "options";
+    server_session_id: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"session_update">;
+    value: z.ZodObject<{
+        session: z.ZodObject<{
+            id: z.ZodString;
+            ai_closure_type: z.ZodNullable<z.ZodNativeEnum<typeof AIClosureType>>;
+            assignee_id: z.ZodNullable<z.ZodNumber>;
+            channel: z.ZodNativeEnum<typeof SessionChannel>;
+            summary: z.ZodNullable<z.ZodString>;
+            status: z.ZodNativeEnum<typeof SessionStatus>;
+            language: z.ZodNullable<z.ZodString>;
+            last_message: z.ZodNullable<z.ZodString>;
+            last_message_at: z.ZodNullable<z.ZodDate>;
+            assignee: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                name: z.ZodString;
+                email: z.ZodString;
+                avatar_url: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            }, {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            }>>>;
+            sentiment: z.ZodNullable<z.ZodNativeEnum<typeof SentimentEnum>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            ai_closure_type: AIClosureType | null;
+            assignee_id: number | null;
+            channel: SessionChannel;
+            status: SessionStatus;
+            summary: string | null;
+            language: string | null;
+            last_message: string | null;
+            last_message_at: Date | null;
+            sentiment: SentimentEnum | null;
+            assignee?: {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            } | null | undefined;
+        }, {
+            id: string;
+            ai_closure_type: AIClosureType | null;
+            assignee_id: number | null;
+            channel: SessionChannel;
+            status: SessionStatus;
+            summary: string | null;
+            language: string | null;
+            last_message: string | null;
+            last_message_at: Date | null;
+            sentiment: SentimentEnum | null;
+            assignee?: {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            } | null | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        session: {
+            id: string;
+            ai_closure_type: AIClosureType | null;
+            assignee_id: number | null;
+            channel: SessionChannel;
+            status: SessionStatus;
+            summary: string | null;
+            language: string | null;
+            last_message: string | null;
+            last_message_at: Date | null;
+            sentiment: SentimentEnum | null;
+            assignee?: {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            } | null | undefined;
+        };
+    }, {
+        session: {
+            id: string;
+            ai_closure_type: AIClosureType | null;
+            assignee_id: number | null;
+            channel: SessionChannel;
+            status: SessionStatus;
+            summary: string | null;
+            language: string | null;
+            last_message: string | null;
+            last_message_at: Date | null;
+            sentiment: SentimentEnum | null;
+            assignee?: {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            } | null | undefined;
+        };
+    }>;
+    server_session_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: {
+        session: {
+            id: string;
+            ai_closure_type: AIClosureType | null;
+            assignee_id: number | null;
+            channel: SessionChannel;
+            status: SessionStatus;
+            summary: string | null;
+            language: string | null;
+            last_message: string | null;
+            last_message_at: Date | null;
+            sentiment: SentimentEnum | null;
+            assignee?: {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            } | null | undefined;
+        };
+    };
+    type: "session_update";
+    server_session_id: string;
+}, {
+    value: {
+        session: {
+            id: string;
+            ai_closure_type: AIClosureType | null;
+            assignee_id: number | null;
+            channel: SessionChannel;
+            status: SessionStatus;
+            summary: string | null;
+            language: string | null;
+            last_message: string | null;
+            last_message_at: Date | null;
+            sentiment: SentimentEnum | null;
+            assignee?: {
+                email: string;
+                name: string;
+                avatar_url?: string | undefined;
+            } | null | undefined;
+        };
+    };
+    type: "session_update";
+    server_session_id: string;
+}>]>, z.ZodObject<{
+    timestamp: z.ZodString;
+    agent: z.ZodObject<{
+        name: z.ZodString;
+        is_ai: z.ZodBoolean;
+        profile_picture: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        id: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string | null;
+        name: string;
+        is_ai: boolean;
+        profile_picture?: string | null | undefined;
+    }, {
+        id: string | null;
+        name: string;
+        is_ai: boolean;
+        profile_picture?: string | null | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    timestamp: string;
+    agent: {
+        id: string | null;
+        name: string;
+        is_ai: boolean;
+        profile_picture?: string | null | undefined;
+    };
+}, {
+    timestamp: string;
+    agent: {
+        id: string | null;
+        name: string;
+        is_ai: boolean;
+        profile_picture?: string | null | undefined;
+    };
+}>>;
+export declare const consumerSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    created_at: z.ZodString;
+    avatar_url: z.ZodNullable<z.ZodString>;
+    email: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    email: string | null;
+    id: string;
+    name: string | null;
+    avatar_url: string | null;
+    created_at: string;
+}, {
+    email: string | null;
+    id: string;
+    name: string | null;
+    avatar_url: string | null;
+    created_at: string;
+}>;
+type AgentType = z.infer<typeof agentSchema>;
+type ConsumerType = z.infer<typeof consumerSchema>;
+type ChatSessionType = z.infer<typeof chatSessionSchema>;
+type ChatSessionWithStatus = ChatSessionType & {
+    isSessionClosed: boolean;
+    isAssignedToAi: boolean;
+    isAssignedToHuman: boolean;
+    isPendingHuman: boolean;
+};
+type StructuredSocketMessageType = z.infer<typeof structuredSocketMessageSchema>;
+type ChatHistoryMessageType = z.infer<typeof chatHistoryMessageSchema>;
+export type { AgentType, ConsumerType, ChatSessionType, StructuredSocketMessageType, ChatHistoryMessageType, ChatSessionWithStatus, };

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

@@ -0,0 +1,31 @@
+import { CoreOptions } from './index';
+import { ApiCaller } from '../client/api';
+import { SessionManager } from '../managers/session-manager';
+import { ChatAttachmentType } from './schemas';
+export type TransportOptions = {
+    api: ApiCaller;
+    sessionManager: SessionManager;
+    coreOptions: CoreOptions;
+};
+export interface MessageData {
+    id: string;
+    content: {
+        text: string;
+    };
+    timestamp: string;
+    bot_token: string;
+    session_id: string;
+    headers?: Record<string, string>;
+    attachments?: ChatAttachmentType[];
+    pathParams?: Record<string, string>;
+    queryParams?: Record<string, string>;
+    user?: {
+        external_id?: string;
+        name?: string;
+        email?: string;
+        phone?: string;
+        customData?: Record<string, string>;
+        avatarUrl?: string;
+    };
+    language?: string;
+}

package/dist/core/utils/genId.d.ts

@@ -0,0 +1,2 @@
+declare const genId: (len?: number) => string;
+export { genId };

package/dist/core/utils/genId.test.d.ts

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

package/dist/core/utils/history-to-widget-messages.d.ts

@@ -0,0 +1,4 @@
+import { MessageType } from '../types/messages';
+import { ChatHistoryMessageType } from '../types/schemas';
+declare function mapChatHistoryToMessage(value: ChatHistoryMessageType[]): MessageType[];
+export { mapChatHistoryToMessage };