@livechat/customer-sdk 3.1.4 → 4.0.0

package/types/reducer.d.ts

@@ -0,0 +1,545 @@
+import { Action } from './types/actions';
+import { InitialStateData, State } from './types/state';
+export declare const getAllRequests: (state: State) => Record<string, {
+    id: string;
+    promise: Promise<any>;
+    resolve: (val: any) => void;
+    reject: (err: any) => void;
+    request: import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "accept_greeting";
+        payload: {
+            greeting_id: number;
+            unique_id: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "cancel_greeting";
+        payload: {
+            unique_id: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "deactivate_chat";
+        payload: {
+            id: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "delete_chat_properties";
+        payload: {
+            id: string;
+            properties: Record<string, string[]>;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "delete_event_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            event_id: string;
+            properties: Record<string, string[]>;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "delete_thread_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            properties: Record<string, string[]>;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_chat";
+        payload: {
+            chat_id: string;
+            thread_id?: string | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_customer";
+        payload: {
+            [x: string]: never;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_form";
+        payload: {
+            type: import("./types/serverEntities").FormType;
+            group_id: number;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_predicted_agent";
+        payload: {
+            group_id?: number | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_url_info";
+        payload: {
+            url: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "list_group_statuses";
+        payload: {
+            group_ids: number[];
+        } | {
+            all: true;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "list_chats";
+        payload: {
+            limit?: number | undefined;
+            page_id?: string | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "list_threads";
+        payload: {
+            chat_id: string;
+            sort_order?: "asc" | "desc" | undefined;
+            limit?: number | undefined;
+            page_id?: string | undefined;
+            min_events_count?: number | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "login";
+        payload: {
+            token: string;
+            customer?: {
+                avatar?: string | undefined;
+                email?: string | undefined;
+                name?: string | undefined;
+                fields?: import("./types/serverEntities").CustomerSessionFields | undefined;
+            } | undefined;
+            customer_page?: {
+                url?: string | undefined;
+                title?: string | undefined;
+            } | undefined;
+            customer_side_storage?: import("./types/serverEntities").SideStorage | undefined;
+            is_mobile?: boolean | undefined;
+            group_id?: number | undefined;
+            referrer?: string | undefined;
+            pushes?: Record<string, readonly import("./types").SubscribablePush[]> | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "mark_events_as_seen";
+        payload: {
+            chat_id: string;
+            seen_up_to: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "resume_chat";
+        payload: {
+            active?: boolean | undefined;
+            chat: {
+                id: string;
+                access?: import("./types/serverEntities").Access | undefined;
+                properties?: import("./types/serverEntities").Properties | undefined;
+                thread?: {
+                    events?: import("./types/serverEntities").RequestBodyEvent[] | undefined;
+                    properties?: import("./types/serverEntities").Properties | undefined;
+                } | undefined;
+            };
+            continuous?: boolean | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "send_event";
+        payload: {
+            chat_id: string;
+            event: import("./types/serverEntities").RequestBodyEvent;
+            attach_to_last_thread?: boolean | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "send_rich_message_postback";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            event_id: string;
+            postback: {
+                id: string;
+                toggled: boolean;
+            };
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "send_sneak_peek";
+        payload: {
+            chat_id: string;
+            sneak_peek_text: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "set_customer_session_fields";
+        payload: {
+            session_fields: import("./types/serverEntities").CustomerSessionFields;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "start_chat";
+        payload: {
+            active?: boolean | undefined;
+            chat?: {
+                access?: import("./types/serverEntities").Access | undefined;
+                properties?: import("./types/serverEntities").Properties | undefined;
+                thread?: {
+                    events?: import("./types/serverEntities").RequestBodyEvent[] | undefined;
+                    properties?: import("./types/serverEntities").Properties | undefined;
+                } | undefined;
+            } | undefined;
+            continuous?: boolean | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_chat_properties";
+        payload: {
+            id: string;
+            properties: import("./types/serverEntities").Properties;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_customer_page";
+        payload: {
+            url: string;
+            title?: string | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_customer";
+        payload: {
+            avatar?: string | undefined;
+            name?: string | undefined;
+            email?: string | undefined;
+            fields?: import("./types/serverEntities").CustomerSessionFields | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_event_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            event_id: string;
+            properties: import("./types/serverEntities").Properties;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_thread_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            properties: import("./types/serverEntities").Properties;
+        };
+    }, "action" | "payload">;
+}>;
+export declare const getConnectionStatus: (state: State) => "connected" | "destroyed" | "disconnected" | "paused" | "reconnecting";
+export declare const getRequest: (state: State, id: string) => {
+    id: string;
+    promise: Promise<any>;
+    resolve: (val: any) => void;
+    reject: (err: any) => void;
+    request: import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "accept_greeting";
+        payload: {
+            greeting_id: number;
+            unique_id: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "cancel_greeting";
+        payload: {
+            unique_id: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "deactivate_chat";
+        payload: {
+            id: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "delete_chat_properties";
+        payload: {
+            id: string;
+            properties: Record<string, string[]>;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "delete_event_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            event_id: string;
+            properties: Record<string, string[]>;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "delete_thread_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            properties: Record<string, string[]>;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_chat";
+        payload: {
+            chat_id: string;
+            thread_id?: string | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_customer";
+        payload: {
+            [x: string]: never;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_form";
+        payload: {
+            type: import("./types/serverEntities").FormType;
+            group_id: number;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_predicted_agent";
+        payload: {
+            group_id?: number | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "get_url_info";
+        payload: {
+            url: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "list_group_statuses";
+        payload: {
+            group_ids: number[];
+        } | {
+            all: true;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "list_chats";
+        payload: {
+            limit?: number | undefined;
+            page_id?: string | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "list_threads";
+        payload: {
+            chat_id: string;
+            sort_order?: "asc" | "desc" | undefined;
+            limit?: number | undefined;
+            page_id?: string | undefined;
+            min_events_count?: number | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "login";
+        payload: {
+            token: string;
+            customer?: {
+                avatar?: string | undefined;
+                email?: string | undefined;
+                name?: string | undefined;
+                fields?: import("./types/serverEntities").CustomerSessionFields | undefined;
+            } | undefined;
+            customer_page?: {
+                url?: string | undefined;
+                title?: string | undefined;
+            } | undefined;
+            customer_side_storage?: import("./types/serverEntities").SideStorage | undefined;
+            is_mobile?: boolean | undefined;
+            group_id?: number | undefined;
+            referrer?: string | undefined;
+            pushes?: Record<string, readonly import("./types").SubscribablePush[]> | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "mark_events_as_seen";
+        payload: {
+            chat_id: string;
+            seen_up_to: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "resume_chat";
+        payload: {
+            active?: boolean | undefined;
+            chat: {
+                id: string;
+                access?: import("./types/serverEntities").Access | undefined;
+                properties?: import("./types/serverEntities").Properties | undefined;
+                thread?: {
+                    events?: import("./types/serverEntities").RequestBodyEvent[] | undefined;
+                    properties?: import("./types/serverEntities").Properties | undefined;
+                } | undefined;
+            };
+            continuous?: boolean | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "send_event";
+        payload: {
+            chat_id: string;
+            event: import("./types/serverEntities").RequestBodyEvent;
+            attach_to_last_thread?: boolean | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "send_rich_message_postback";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            event_id: string;
+            postback: {
+                id: string;
+                toggled: boolean;
+            };
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "send_sneak_peek";
+        payload: {
+            chat_id: string;
+            sneak_peek_text: string;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "set_customer_session_fields";
+        payload: {
+            session_fields: import("./types/serverEntities").CustomerSessionFields;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "start_chat";
+        payload: {
+            active?: boolean | undefined;
+            chat?: {
+                access?: import("./types/serverEntities").Access | undefined;
+                properties?: import("./types/serverEntities").Properties | undefined;
+                thread?: {
+                    events?: import("./types/serverEntities").RequestBodyEvent[] | undefined;
+                    properties?: import("./types/serverEntities").Properties | undefined;
+                } | undefined;
+            } | undefined;
+            continuous?: boolean | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_chat_properties";
+        payload: {
+            id: string;
+            properties: import("./types/serverEntities").Properties;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_customer_page";
+        payload: {
+            url: string;
+            title?: string | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_customer";
+        payload: {
+            avatar?: string | undefined;
+            name?: string | undefined;
+            email?: string | undefined;
+            fields?: import("./types/serverEntities").CustomerSessionFields | undefined;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_event_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            event_id: string;
+            properties: import("./types/serverEntities").Properties;
+        };
+    }, "action" | "payload"> | import("Object/Pick")._Pick<{
+        request_id: string;
+        version?: string | undefined;
+        action: "update_thread_properties";
+        payload: {
+            chat_id: string;
+            thread_id: string;
+            properties: import("./types/serverEntities").Properties;
+        };
+    }, "action" | "payload">;
+};
+export declare const getSelfId: (state: State) => string | null;
+export declare const isChatActive: (state: State, chatId: string) => boolean;
+export declare const isConnected: (state: State) => boolean;
+export declare const isDestroyed: (state: State) => boolean;
+export declare const getApiOrigin: (state: State) => string;
+export declare const getServerUrl: (state: State) => string;
+export declare const createInitialState: (initialStateData: InitialStateData) => State;
+declare const _default: (state: State) => import("redux").Reducer<State, Action>;
+export default _default;
+//# sourceMappingURL=reducer.d.ts.map

package/types/sendRequestAction.d.ts

@@ -0,0 +1,4 @@
+import { Store } from './types';
+declare const sendRequestAction: (store: Store, action: any) => Promise<unknown>;
+export default sendRequestAction;
+//# sourceMappingURL=sendRequestAction.d.ts.map

package/types/sendTicketForm.d.ts

@@ -0,0 +1,14 @@
+import { CustomerAuth } from '@livechat/customer-auth';
+import { Store } from './types';
+import * as clientEntities from './types/clientEntities';
+declare const sendTicketForm: (store: Store, auth: CustomerAuth, { filledForm, groupId, timeZone, }: {
+    filledForm: Extract<clientEntities.RequestBodyEvent, {
+        type: 'filled_form';
+    }>;
+    groupId?: number | undefined;
+    timeZone?: string | undefined;
+}) => Promise<{
+    id: string;
+}>;
+export default sendTicketForm;
+//# sourceMappingURL=sendTicketForm.d.ts.map

package/types/serverDataParser.d.ts

@@ -0,0 +1,34 @@
+import * as ClientEntities from './types/clientEntities';
+import * as ServerEntities from './types/serverEntities';
+export declare const parseAccess: (access?: ServerEntities.Access) => ClientEntities.Access;
+export declare const getEventsSeenUpToMap: (users: ServerEntities.ChatUser[]) => ClientEntities.EventsSeenUpToMap;
+export declare const parseThread: (chatId: string, thread: ServerEntities.Thread) => ClientEntities.Thread;
+export declare const parseChatCommon: (chat: Omit<ServerEntities.Chat, 'thread'>) => {
+    id: string;
+    access: ClientEntities.Access;
+    users: ClientEntities.ChatUser[];
+    properties: ServerEntities.Properties;
+    eventsSeenUpToMap: ClientEntities.EventsSeenUpToMap;
+};
+export declare const parseChatAgent: (agent: ServerEntities.ChatAgent) => ClientEntities.ChatAgent;
+export declare const parseCustomerOptionalProps: (customerProps: ServerEntities.OptionalCustomerProps) => ClientEntities.CustomerOptionalProps;
+export declare const parseChatCustomer: (customer: ServerEntities.ChatCustomer) => ClientEntities.ChatCustomer;
+export declare const parseCustomer: (customer: ServerEntities.Customer) => ClientEntities.Customer;
+type PredictedAgentPayload = {
+    agent: ServerEntities.PredictedAgent;
+    queue: boolean;
+};
+export declare const parsePredictedAgent: (payload: PredictedAgentPayload) => ClientEntities.PredictedAgent;
+export declare const parseQueueUpdate: (queueUpdate: ServerEntities.QueueUpdate) => {
+    position: number;
+    waitTime: number;
+};
+export declare const parseQueue: (queue: ServerEntities.Queue) => {
+    queuedAt: string;
+    position: number;
+    waitTime: number;
+};
+export declare const parseChatUser: (user: ServerEntities.ChatUser) => ClientEntities.ChatUser;
+export declare const parseGroupStatus: (status: ServerEntities.GroupStatus) => ClientEntities.AvailabilityStatus;
+export {};
+//# sourceMappingURL=serverDataParser.d.ts.map

package/types/serverEventParser.d.ts

@@ -0,0 +1,12 @@
+import * as ClientEntities from './types/clientEntities';
+import * as ServerEntities from './types/serverEntities';
+export declare const parseFile: (thread: string, file: ServerEntities.File) => ClientEntities.File;
+export declare const parseForm: (thread: string, form: ServerEntities.Form) => ClientEntities.Form;
+export declare const parseFilledForm: (thread: string, filledForm: ServerEntities.FilledForm) => ClientEntities.FilledForm;
+export declare const parseMessage: (thread: string, message: ServerEntities.Message) => ClientEntities.Message;
+export declare const parseCustomEvent: (thread: string, event: ServerEntities.CustomEvent) => ClientEntities.CustomEvent;
+export declare const parseRichMessage: (thread: string, richMessage: ServerEntities.RichMessage) => ClientEntities.RichMessage | null;
+export declare const parseSystemMessage: (thread: string, systemMessage: ServerEntities.SystemMessage) => ClientEntities.SystemMessage;
+export declare const parseEvent: (thread: string, event: ServerEntities.Event) => ClientEntities.Event | null;
+export declare const parseGreeting: (greeting: ServerEntities.Greeting) => ClientEntities.Greeting;
+//# sourceMappingURL=serverEventParser.d.ts.map