@livechat/customer-sdk 3.1.1 → 3.1.2

package/types/serverFrameParser.d.ts

@@ -0,0 +1,385 @@
+import { O } from 'ts-toolbelt';
+import * as clientEntities from './types/clientEntities';
+import * as serverEntities from './types/serverEntities';
+import { Request, Push, DirectResponse } from './types/frames';
+export declare const parseForm: (form: {
+    id: string;
+    fields: serverEntities.FormField[];
+}) => {
+    id: string;
+    fields: clientEntities.FormField[];
+};
+export declare const parsePush: (push: Push) => {
+    action: "chat_deactivated";
+    payload: {
+        chatId: string;
+    };
+} | {
+    action: "chat_properties_deleted";
+    payload: {
+        chatId: string;
+        properties: Record<string, string[]>;
+    };
+} | {
+    action: "chat_properties_updated";
+    payload: {
+        chatId: string;
+        properties: serverEntities.Properties;
+    };
+} | {
+    action: "chat_transferred";
+    payload: {
+        reason: "manual";
+        requesterId: string | undefined;
+        chatId: string;
+        threadId: string;
+        transferredTo: {
+            groupIds?: number[] | undefined;
+            agentIds?: number[] | undefined;
+        };
+        queue: {
+            queuedAt: string;
+            position: number;
+            waitTime: number;
+        } | null;
+    } | {
+        reason: "routing.inactive" | "routing.assigned";
+        chatId: string;
+        threadId: string;
+        transferredTo: {
+            groupIds?: number[] | undefined;
+            agentIds?: number[] | undefined;
+        };
+        queue: {
+            queuedAt: string;
+            position: number;
+            waitTime: number;
+        } | null;
+    };
+} | {
+    action: "customer_side_storage_updated";
+    payload: {
+        customer_side_storage: serverEntities.SideStorage;
+    };
+} | {
+    action: "customer_disconnected";
+    payload: {
+        reason: "access_token_expired" | "connection_timeout" | "customer_banned" | "customer_temporarily_blocked" | "inactivity_timeout" | "internal_error" | "license_expired" | "license_not_found" | "misdirected_connection" | "product_version_changed" | "service_temporarily_unavailable" | "too_many_connections" | "too_many_unauthorized_connections" | "unsupported_version";
+        data?: any;
+    };
+} | {
+    action: "customer_page_updated";
+    payload: {
+        url: string;
+        title: string | undefined;
+        openedAt: string;
+    };
+} | {
+    action: "customer_updated";
+    payload: {
+        name?: string | undefined;
+        email?: string | undefined;
+        avatar?: string | undefined;
+        sessionFields?: clientEntities.CustomerSessionFields | undefined;
+        id: string;
+    };
+} | {
+    action: "event_properties_deleted";
+    payload: {
+        chatId: string;
+        threadId: string;
+        eventId: string;
+        properties: Record<string, string[]>;
+    };
+} | {
+    action: "event_properties_updated";
+    payload: {
+        chatId: string;
+        threadId: string;
+        eventId: string;
+        properties: serverEntities.Properties;
+    };
+} | {
+    action: "event_updated";
+    payload: {
+        chatId: string;
+        threadId: string;
+        event: clientEntities.Event | null;
+    };
+} | {
+    action: "events_marked_as_seen";
+    payload: {
+        chatId: string;
+        userId: string;
+        seenUpTo: string;
+    };
+} | {
+    action: "greeting_accepted";
+    payload: {
+        uniqueId: string;
+    };
+} | {
+    action: "greeting_canceled";
+    payload: {
+        uniqueId: string;
+    };
+} | {
+    action: "incoming_chat";
+    payload: {
+        chat: {
+            thread: clientEntities.Thread;
+            id: string;
+            access: clientEntities.Access;
+            users: clientEntities.ChatUser[];
+            properties: serverEntities.Properties;
+            eventsSeenUpToMap: clientEntities.EventsSeenUpToMap;
+        };
+    };
+} | {
+    action: "incoming_event";
+    payload: {
+        chatId: string;
+        event: clientEntities.Event | null;
+    };
+} | {
+    action: "incoming_greeting";
+    payload: clientEntities.Greeting;
+} | {
+    action: "incoming_multicast";
+    payload: {
+        type?: string | undefined;
+        content: any;
+    };
+} | {
+    action: "incoming_rich_message_postback";
+    payload: {
+        userId: string;
+        chatId: string;
+        threadId: string;
+        eventId: string;
+        postback: {
+            id: string;
+            toggled: boolean;
+        };
+    };
+} | {
+    action: "incoming_typing_indicator";
+    payload: {
+        chatId: string;
+        typingIndicator: {
+            authorId: string;
+            isTyping: boolean;
+        };
+    };
+} | {
+    action: "queue_position_updated";
+    payload: {
+        chatId: string;
+        threadId: string;
+        queue: {
+            position: number;
+            waitTime: number;
+        };
+    };
+} | {
+    action: "thread_properties_deleted";
+    payload: {
+        chatId: string;
+        threadId: string;
+        properties: Record<string, string[]>;
+    };
+} | {
+    action: "thread_properties_updated";
+    payload: {
+        chatId: string;
+        threadId: string;
+        properties: serverEntities.Properties;
+    };
+} | {
+    action: "user_added_to_chat";
+    payload: {
+        chatId: string;
+        user: clientEntities.ChatUser;
+        present: boolean;
+    };
+} | {
+    action: "user_removed_from_chat";
+    payload: {
+        chatId: string;
+        userId: string;
+    };
+};
+export declare const parseResponse: ({ request, response, }: {
+    request: O.Pick<Request, 'action' | 'payload'>;
+    response: DirectResponse;
+}) => {
+    action: "accept_greeting";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "cancel_greeting";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "delete_chat_properties";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "delete_event_properties";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "delete_thread_properties";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "get_chat";
+    payload: {
+        thread: clientEntities.Thread | null;
+        id: string;
+        access: clientEntities.Access;
+        users: clientEntities.ChatUser[];
+        properties: serverEntities.Properties;
+        eventsSeenUpToMap: clientEntities.EventsSeenUpToMap;
+    };
+} | {
+    action: "get_customer";
+    payload: {
+        type: "customer";
+        id: string;
+        name?: string | undefined;
+        email?: string | undefined;
+        avatar?: string | undefined;
+        sessionFields: clientEntities.CustomerSessionFields;
+        statistics: {
+            chatsCount: number;
+            threadsCount: number;
+            visitsCount: number;
+            pageViewsCount: number;
+            greetingsShownCount: number;
+            greetingsAcceptedCount: number;
+        };
+    };
+} | {
+    action: "get_form";
+    payload: {
+        enabled: false;
+    } | {
+        form: {
+            id: string;
+            fields: clientEntities.FormField[];
+        };
+        enabled: true;
+    };
+} | {
+    action: "get_predicted_agent";
+    payload: clientEntities.PredictedAgent;
+} | {
+    action: "get_url_info";
+    payload: clientEntities.UrlInfo;
+} | {
+    action: "list_chats";
+    payload: {
+        chatsSummary: any;
+        totalChats: number;
+        users: clientEntities.ChatUser[];
+        previousPageId: string | null;
+        nextPageId: string | null;
+    };
+} | {
+    action: "list_group_statuses";
+    payload: Record<number, serverEntities.GroupStatus>;
+} | {
+    action: "list_threads";
+    payload: {
+        threads: clientEntities.Thread[];
+        previousPageId: string | null;
+        nextPageId: string | null;
+    };
+} | {
+    action: "login";
+    payload: {
+        greeting?: clientEntities.Greeting | undefined;
+        dynamicConfig: serverEntities.DynamicConfig;
+        customer: {
+            type: "customer";
+            id: string;
+            name?: string | undefined;
+            email?: string | undefined;
+            avatar?: string | undefined;
+            sessionFields: clientEntities.CustomerSessionFields;
+            statistics: {
+                chatsCount: number;
+                threadsCount: number;
+                visitsCount: number;
+                pageViewsCount: number;
+                greetingsShownCount: number;
+                greetingsAcceptedCount: number;
+            };
+        };
+        availability: clientEntities.AvailabilityStatus;
+        chats: {
+            id: string;
+            active: boolean | undefined;
+            hasUnreadEvents: boolean;
+        }[];
+    };
+} | {
+    action: "mark_events_as_seen";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "send_sneak_peek";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "set_customer_session_fields";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "send_rich_message_postback";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "update_chat_properties";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "update_customer";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "update_customer_page";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "update_event_properties";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+} | {
+    action: "update_thread_properties";
+    payload: Readonly<{
+        readonly success: true;
+    }>;
+};
+export declare const parseServerError: (error: {
+    type: string;
+    message: string;
+}) => {
+    code: string;
+    message: string;
+};
+//# sourceMappingURL=serverFrameParser.d.ts.map

package/types/sideEffects/checkGoals.d.ts

@@ -0,0 +1,5 @@
+import { CustomerAuth } from '@livechat/customer-auth';
+import { Store, CustomerSessionFields } from '../types';
+declare const checkGoals: (store: Store, auth: CustomerAuth, sessionFields?: CustomerSessionFields) => Promise<void>;
+export default checkGoals;
+//# sourceMappingURL=checkGoals.d.ts.map

package/types/sideEffects/index.d.ts

@@ -0,0 +1,12 @@
+import { CustomerAuth } from '@livechat/customer-auth';
+import { SocketClient } from '../socketClient';
+import { Action } from '../types/actions';
+import { CustomerDataProvider, Store } from '../types';
+declare const _default: ({ auth, customerDataProvider, emitter, socket, }: {
+    auth: CustomerAuth;
+    customerDataProvider?: CustomerDataProvider | undefined;
+    socket: SocketClient;
+    emitter: any;
+}) => (action: Action, store: Store) => void;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/types/sideStorage.d.ts

@@ -0,0 +1,5 @@
+import { Store } from './types';
+import { SideStorage } from './types/serverEntities';
+export declare const getSideStorage: (store: Store) => Promise<SideStorage>;
+export declare const saveSideStorage: (store: Store, sideStorage: SideStorage) => Promise<void>;
+//# sourceMappingURL=sideStorage.d.ts.map

package/types/socketClient.d.ts

@@ -0,0 +1,11 @@
+import { PlatformClient } from '@livechat/platform-client';
+import { Store } from './types';
+import { Push, PushResponse, Response, ResponseError, Request } from './types/frames';
+type Incoming = Push | PushResponse | Response | ResponseError;
+type ParametrizedPlatformClient = PlatformClient<Incoming, Request>;
+export type SocketClient = ParametrizedPlatformClient & {
+    reinitialize(): void;
+};
+declare const createSocketClient: (store: Store) => SocketClient;
+export default createSocketClient;
+//# sourceMappingURL=socketClient.d.ts.map

package/types/socketListener.d.ts

@@ -0,0 +1,9 @@
+import { SocketClient } from './socketClient';
+import { Store } from './types';
+import { Push, PushResponse, ResponseError } from './types/frames';
+declare const _default: (store: Store, socket: SocketClient) => {
+    <Key extends keyof import("@livechat/platform-client/types").PlatformClientEvents<PushResponse | Push | import("./types/frames").Response | ResponseError>>(type: Key, handler?: import("mitt").Handler<import("@livechat/platform-client/types").PlatformClientEvents<PushResponse | Push | import("./types/frames").Response | ResponseError>[Key]> | undefined): void;
+    (type: "*", handler: import("mitt").WildcardHandler<import("@livechat/platform-client/types").PlatformClientEvents<PushResponse | Push | import("./types/frames").Response | ResponseError>>): void;
+} & (() => void);
+export default _default;
+//# sourceMappingURL=socketListener.d.ts.map

package/types/thunks.d.ts

@@ -0,0 +1,4 @@
+import { Store } from './types';
+export declare const failAllRequests: ({ getState, dispatch }: Store, reason: string) => void;
+export declare const failRequest: ({ getState, dispatch }: Store, requestAction: any, error: any) => void;
+//# sourceMappingURL=thunks.d.ts.map

package/types/types/actions.d.ts

@@ -0,0 +1,157 @@
+import { Any, O } from 'ts-toolbelt';
+import * as reduxActions from '../constants/reduxActions';
+import { CustomerSessionFields, Page } from '.';
+import * as clientEntities from './clientEntities';
+import * as serverEntities from './serverEntities';
+import * as serverFrameParser from '../serverFrameParser';
+import { PushResponse, Request } from './frames';
+export type ChangeRegionAction = {
+    type: typeof reduxActions.CHANGE_REGION;
+    payload: {
+        region: string;
+    };
+};
+export type CheckGoalsAction = {
+    type: typeof reduxActions.CHECK_GOALS;
+    payload: {
+        sessionFields?: CustomerSessionFields;
+    };
+};
+export type DestroyAction = {
+    type: typeof reduxActions.DESTROY;
+    payload: {
+        reason: string;
+    };
+};
+export type FailAllRequestsAction = {
+    type: typeof reduxActions.FAIL_ALL_REQUESTS;
+    payload: {
+        reason: string;
+        rejects: ((err: any) => void)[];
+    };
+};
+export type LoginSuccessAction = {
+    type: typeof reduxActions.LOGIN_SUCCESS;
+    payload: {
+        dynamicConfig: serverEntities.DynamicConfig;
+        customer: clientEntities.Customer;
+        availability: 'online' | 'offline';
+        chats: Array<{
+            id: string;
+            active: boolean;
+            hasUnreadEvents: boolean;
+        }>;
+        greeting?: clientEntities.Greeting;
+    };
+};
+export type PauseConnectionAction = {
+    type: typeof reduxActions.PAUSE_CONNECTION;
+    payload: {
+        reason: string;
+    };
+};
+export type PrefetchTokenAction = {
+    type: typeof reduxActions.PREFETCH_TOKEN;
+    payload: {
+        fresh: boolean;
+    };
+};
+export type PushReceivedAction = {
+    type: typeof reduxActions.PUSH_RECEIVED;
+    payload: ReturnType<typeof serverFrameParser.parsePush>;
+};
+type ParsedPush = ReturnType<typeof serverFrameParser.parsePush>;
+type ParsedPushResponse = Extract<ParsedPush, {
+    action: PushResponse['action'];
+}>;
+type PushResponsePayload = {
+    [T in ParsedPushResponse['action']]: Any.Compute<{
+        id: string;
+        promise: Promise<any>;
+        resolve: (value: any) => void;
+    } & Extract<ParsedPushResponse, {
+        action: T;
+    }>>;
+}[ParsedPushResponse['action']];
+export type PushResponseReceivedAction = {
+    type: typeof reduxActions.PUSH_RESPONSE_RECEIVED;
+    payload: PushResponsePayload;
+};
+export type RequestFailedAction = {
+    type: typeof reduxActions.REQUEST_FAILED;
+    payload: {
+        id: string;
+        reject: (err: any) => void;
+        error: {
+            code: string;
+            message: string;
+        };
+    };
+};
+export type ReconnectAction = {
+    type: typeof reduxActions.RECONNECT;
+    payload: {
+        delay: number;
+    };
+};
+type ParsedResponse = ReturnType<typeof serverFrameParser.parseResponse>;
+type DirectResponsePayload = {
+    [T in ParsedResponse['action']]: Any.Compute<{
+        id: string;
+        promise: Promise<any>;
+        resolve: (value: any) => void;
+    } & Extract<ParsedResponse, {
+        action: T;
+    }>>;
+}[ParsedResponse['action']];
+export type ResponseReceivedAction = {
+    type: typeof reduxActions.RESPONSE_RECEIVED;
+    payload: DirectResponsePayload;
+};
+export type SendRequestAction = {
+    type: typeof reduxActions.SEND_REQUEST;
+    payload: {
+        action: string;
+        promise: Promise<any>;
+        resolve: (val: any) => void;
+        reject: (err: any) => void;
+        id: string;
+        request: O.Pick<Request, 'action' | 'payload'>;
+        source?: 'login';
+    };
+};
+export type SetChatActiveAction = {
+    type: typeof reduxActions.SET_CHAT_ACTIVE;
+    payload: {
+        id: string;
+        active: boolean;
+    };
+};
+export type SetSelfIdAction = {
+    type: typeof reduxActions.SET_SELF_ID;
+    payload: {
+        id: string;
+    };
+};
+export type SocketConnectedAction = {
+    type: typeof reduxActions.SOCKET_CONNECTED;
+};
+export type SocketDisconnectedAction = {
+    type: typeof reduxActions.SOCKET_DISCONNECTED;
+};
+export type SocketRecoveredAction = {
+    type: typeof reduxActions.SOCKET_RECOVERED;
+};
+export type SocketUnstableAction = {
+    type: typeof reduxActions.SOCKET_UNSTABLE;
+};
+export type StartConnectionAction = {
+    type: typeof reduxActions.START_CONNECTION;
+};
+export type UpdateCustomerPageAction = {
+    type: typeof reduxActions.UPDATE_CUSTOMER_PAGE;
+    payload: Page;
+};
+export type Action = ChangeRegionAction | CheckGoalsAction | DestroyAction | FailAllRequestsAction | LoginSuccessAction | PauseConnectionAction | PrefetchTokenAction | PushReceivedAction | PushResponseReceivedAction | ReconnectAction | RequestFailedAction | ResponseReceivedAction | SendRequestAction | SetChatActiveAction | SetSelfIdAction | SocketConnectedAction | SocketDisconnectedAction | SocketRecoveredAction | SocketUnstableAction | StartConnectionAction | UpdateCustomerPageAction;
+export {};
+//# sourceMappingURL=actions.d.ts.map