@livechat/customer-sdk 3.1.4 → 4.0.0

package/types/types/serverEntities.d.ts

@@ -0,0 +1,409 @@
+import { Any } from 'ts-toolbelt';
+import * as userTypes from '../constants/userTypes';
+export type SideStorage = Record<string, never>;
+export type Greeting = {
+    id: number;
+    addon?: string;
+    unique_id: string;
+    displayed_first_time: boolean;
+    accepted?: boolean;
+    subtype?: string;
+    event: GreetingEvent;
+    agent: {
+        id: string;
+        name: string;
+        avatar: string;
+        job_title: string;
+        is_bot: boolean;
+    };
+};
+export type DynamicConfig = {
+    organization_id: string;
+    customer_data: {
+        chats_count: number;
+        invitations_accepted_count: number;
+        invitations_shown_count: number;
+        last_visit_timestamp: number;
+        name?: string;
+        page_views_count: number;
+        visits_count: number;
+    };
+    customer_groups: {
+        monitoring: {
+            id: number;
+            static_config_url: string;
+            language_config_url: string;
+        };
+        chats?: Record<number, {
+            chat_ids: string[];
+            static_config_url: string;
+            language_config_url: string;
+        }>;
+    };
+    online_groups_ids?: number[];
+    static_config_version: string;
+    greeting?: Greeting;
+};
+export type Access = {
+    group_ids?: number[];
+};
+export type Properties = {
+    [namespace: string]: {
+        [key: string]: string | number;
+    };
+};
+export type CustomerFields = Record<string, string>;
+export type CustomerSessionFields = Array<CustomerFields>;
+export type Queue = {
+    position: number;
+    wait_time: number;
+    queued_at: string;
+};
+export type QueueUpdate = Pick<Queue, 'position' | 'wait_time'>;
+export type Thread = {
+    id: string;
+    active: boolean;
+    access?: Access;
+    created_at: string;
+    user_ids: string[];
+    events: Event[];
+    properties?: Properties;
+    previous_thread_id?: string;
+    next_thread_id?: string;
+    queue?: Queue;
+};
+export type Chat = {
+    id: string;
+    thread?: Thread;
+    users: ChatUser[];
+    access?: Access;
+    properties?: Properties;
+};
+export type IncomingChat = Chat & {
+    thread: Thread;
+};
+export type ChatSummary = {
+    id: string;
+    active: boolean;
+    users: ChatUser[];
+    access?: Access;
+    properties?: Properties;
+    last_thread_id?: string;
+    last_thread_created_at?: string;
+    last_event_per_type: {
+        [Type in Event['type']]?: {
+            thread_id: string;
+            thread_created_at: string;
+            event: Extract<Event, {
+                type: Type;
+            }>;
+        };
+    };
+};
+export type Agent = {
+    type: typeof userTypes.AGENT;
+    id: string;
+    name: string;
+    avatar: string;
+    job_title: string;
+    present: boolean;
+    events_seen_up_to?: string;
+};
+export type OptionalCustomerProps = {
+    name?: string;
+    email?: string;
+    avatar?: string;
+    session_fields?: CustomerSessionFields;
+};
+type ChatUserProps = {
+    present: boolean;
+    events_seen_up_to?: string;
+};
+export type Customer = Any.Compute<{
+    type: typeof userTypes.CUSTOMER;
+    id: string;
+    statistics: {
+        chats_count: number;
+        threads_count: number;
+        visits_count: number;
+        page_views_count: number;
+        greetings_shown_count: number;
+        greetings_accepted_count: number;
+    };
+} & OptionalCustomerProps>;
+export type User = Agent | Customer;
+export type ChatAgent = Any.Compute<Agent & ChatUserProps>;
+export type ChatCustomer = Any.Compute<Omit<Customer, 'statistics'> & ChatUserProps>;
+export type ChatUser = ChatAgent | ChatCustomer;
+export type PredictedAgent = Any.Compute<Pick<Agent, 'id' | 'avatar' | 'job_title' | 'type' | 'name'> & {
+    is_bot: boolean;
+}>;
+export type CustomerUpdate = Pick<Customer, 'avatar' | 'email' | 'name' | 'session_fields'>;
+export type FormType = 'prechat' | 'postchat' | 'ticket';
+type FormFieldOption = {
+    id: string;
+    label: string;
+    checked: boolean;
+};
+type HeaderField = {
+    type: 'header';
+    id: string;
+    label: string;
+};
+type NameField = {
+    type: 'name';
+    id: string;
+    label: string;
+    required: boolean;
+};
+type EmailField = {
+    type: 'email';
+    id: string;
+    label: string;
+    required: boolean;
+};
+type QuestionField = {
+    type: 'question';
+    id: string;
+    label: string;
+    required: boolean;
+};
+type TextareaField = {
+    type: 'textarea';
+    id: string;
+    label: string;
+    required: boolean;
+};
+type RadioField = {
+    type: 'radio';
+    id: string;
+    label: string;
+    options: FormFieldOption[];
+    required: boolean;
+};
+type SelectField = {
+    type: 'select';
+    id: string;
+    label: string;
+    options: FormFieldOption[];
+    required: boolean;
+};
+type CheckboxField = {
+    type: 'checkbox';
+    id: string;
+    label: string;
+    options: FormFieldOption[];
+    required: boolean;
+};
+type CheckboxForEmailField = {
+    type: 'checkbox_for_email';
+    id: string;
+    label: string;
+    required: boolean;
+    checked: boolean;
+};
+type GroupChooserField = {
+    type: 'group_chooser';
+    id: string;
+    label: string;
+    options: Array<{
+        id: string;
+        label: string;
+        group_id: number;
+    }>;
+    required: boolean;
+};
+type RatingField = {
+    type: 'rating';
+    id: string;
+    label: string;
+    comment_label: string;
+    required: boolean;
+};
+type SubjectField = {
+    type: 'subject';
+    id: string;
+    label: string;
+    required: boolean;
+};
+export type FormField = HeaderField | NameField | EmailField | QuestionField | TextareaField | RadioField | SelectField | CheckboxField | CheckboxForEmailField | GroupChooserField | RatingField | SubjectField;
+type CreateFilledField<Field extends FormField, Answer> = Any.Compute<Pick<Field, 'type' | 'id' | 'label'> & Answer>;
+type FilledNameField = CreateFilledField<NameField, {
+    answer?: string;
+}>;
+type FilledEmailField = CreateFilledField<EmailField, {
+    answer?: string;
+}>;
+type FilledQuestionField = CreateFilledField<QuestionField, {
+    answer?: string;
+}>;
+type FilledTextareaField = CreateFilledField<TextareaField, {
+    answer?: string;
+}>;
+type FilledRadioField = CreateFilledField<RadioField, {
+    answer?: {
+        id: string;
+        label: string;
+    };
+}>;
+type FilledSelectField = CreateFilledField<SelectField, {
+    answer?: {
+        id: string;
+        label: string;
+    };
+}>;
+type FilledCheckboxField = CreateFilledField<CheckboxField, {
+    answers?: Array<{
+        id: string;
+        label: string;
+    }>;
+}>;
+type FilledCheckboxForEmailField = CreateFilledField<CheckboxForEmailField, {
+    answer?: boolean;
+}>;
+type FilledGroupChooserField = CreateFilledField<GroupChooserField, {
+    answer?: {
+        id: string;
+        group_id: number;
+        label: string;
+    };
+}>;
+type FilledSubjectField = CreateFilledField<SubjectField, {
+    answer?: string;
+}>;
+export type FilledFormField = FilledNameField | FilledEmailField | FilledQuestionField | FilledTextareaField | FilledRadioField | FilledSelectField | FilledCheckboxField | FilledCheckboxForEmailField | FilledGroupChooserField | FilledSubjectField;
+export type RichMessageButtonRole = 'default' | 'primary' | 'danger';
+type RichMessageButtonBase = {
+    postback_id: string;
+    text: string;
+    user_ids: string[];
+    role?: RichMessageButtonRole;
+};
+type RichMessageButtonWithoutValue = Any.Compute<RichMessageButtonBase & {
+    type?: undefined;
+}>;
+type RichMessageMessageButton = Any.Compute<RichMessageButtonBase & {
+    type: 'message';
+    value: string;
+}>;
+type RichMessageUrlButton = Any.Compute<RichMessageButtonBase & {
+    type: 'url';
+    value: string;
+    target?: 'current' | 'new';
+}>;
+type RichMessagePhoneButton = Any.Compute<RichMessageButtonBase & {
+    type: 'phone';
+    value: string;
+}>;
+type RichMessageCancelButton = Any.Compute<RichMessageButtonBase & {
+    type: 'cancel';
+}>;
+type RichMessageWebviewButton = Any.Compute<RichMessageButtonBase & {
+    type: 'webview';
+    value: string;
+    webview_height?: 'full' | 'tall' | 'compact';
+}>;
+export type RichMessageButton = RichMessageButtonWithoutValue | RichMessageMessageButton | RichMessageUrlButton | RichMessagePhoneButton | RichMessageCancelButton | RichMessageWebviewButton;
+export type RichMessageElement = {
+    title?: string;
+    subtitle?: string;
+    image?: {
+        url: string;
+        name?: string;
+        alternative_text?: string;
+        content_type?: string;
+        size?: number;
+        width?: number;
+        height?: number;
+    };
+    buttons?: RichMessageButton[];
+};
+type RichMessageTemplate = 'cards' | 'quick_replies' | 'sticker';
+type ServerGeneratedEventBase = {
+    id: string;
+    author_id: string;
+    created_at: string;
+};
+export type EventBase = {
+    custom_id?: string;
+    properties?: Properties;
+};
+type FileSpecificProps = {
+    type: 'file';
+    content_type: string;
+    url: string;
+    name: string;
+};
+type ImageSpecificProps = {
+    width: number;
+    height: number;
+    thumbnail_url: string;
+    thumbnail2x_url: string;
+    alternative_text?: string;
+};
+type NonImageSpecificProps = {
+    width?: undefined;
+    height?: undefined;
+};
+type FormSpecificProps = {
+    type: 'form';
+    form_id: string;
+    fields: FormField[];
+};
+type FilledFormSpecificProps = {
+    type: 'filled_form';
+    form_id: string;
+    fields: FilledFormField[];
+};
+type MessageSpecificProps = {
+    type: 'message';
+    text: string;
+    postback?: {
+        id: string;
+        thread_id: string;
+        event_id: string;
+        type: string;
+        value: string;
+    };
+};
+type RichMessageSpecificProps = {
+    type: 'rich_message';
+    template_id: RichMessageTemplate;
+    elements: RichMessageElement[];
+};
+type SystemMessageSpecificProps = {
+    type: 'system_message';
+    text: string;
+    system_message_type: string;
+    text_vars?: Record<string, string>;
+};
+type CustomEventSpecificProps = {
+    type: 'custom';
+    content?: any;
+};
+export type GroupStatus = 'online' | 'online_for_queue' | 'offline';
+type RequestBodyFile = Any.Compute<EventBase & {
+    type: 'file';
+    url: string;
+    alternative_text: string;
+}>;
+type RequestBodyFilledForm = Any.Compute<EventBase & FilledFormSpecificProps>;
+type RequestBodyMessage = Any.Compute<EventBase & MessageSpecificProps>;
+type RequestBodySystemMessage = Any.Compute<EventBase & SystemMessageSpecificProps & {
+    recipients?: 'all' | 'agents';
+}>;
+type RequestBodyCustomEvent = Any.Compute<EventBase & CustomEventSpecificProps>;
+export type RequestBodyEvent = RequestBodyFile | RequestBodyFilledForm | RequestBodyMessage | RequestBodySystemMessage | RequestBodyCustomEvent;
+export type ImageFile = Any.Compute<ServerGeneratedEventBase & EventBase & FileSpecificProps & ImageSpecificProps>;
+export type NonImageFile = Any.Compute<ServerGeneratedEventBase & EventBase & FileSpecificProps & NonImageSpecificProps>;
+export type File = ImageFile | NonImageFile;
+export type Form = Any.Compute<ServerGeneratedEventBase & EventBase & FormSpecificProps>;
+export type FilledForm = Any.Compute<ServerGeneratedEventBase & EventBase & FilledFormSpecificProps>;
+export type Message = Any.Compute<ServerGeneratedEventBase & EventBase & MessageSpecificProps>;
+export type RichMessage = Any.Compute<ServerGeneratedEventBase & EventBase & RichMessageSpecificProps>;
+export type SystemMessage = Any.Compute<ServerGeneratedEventBase & EventBase & SystemMessageSpecificProps>;
+export type CustomEvent = Any.Compute<ServerGeneratedEventBase & EventBase & CustomEventSpecificProps>;
+export type GreetingEvent = Message | RichMessage;
+export type Event = File | Form | FilledForm | Message | RichMessage | SystemMessage | CustomEvent;
+export {};
+//# sourceMappingURL=serverEntities.d.ts.map

package/types/types/state.d.ts

@@ -0,0 +1,56 @@
+import { O } from 'ts-toolbelt';
+import { ConnectionStatus, Env, Page } from '.';
+import { Request } from './frames';
+type StateUser = Record<string, unknown>;
+export type InitialStateData = {
+    application?: {
+        channelType?: 'direct_link' | 'code';
+        name?: string;
+        version?: string;
+    };
+    organizationId: string;
+    groupId?: number | null;
+    env: Env;
+    page?: Page | null;
+    region?: string | null;
+    referrer?: string | null;
+    uniqueGroups?: boolean;
+    mobile?: boolean;
+};
+export type State = {
+    application?: {
+        channelType?: 'direct_link' | 'code';
+        name?: string;
+        version?: string;
+    };
+    env: Env;
+    organizationId: string;
+    groupId: number | null;
+    chats: Record<string, {
+        active: boolean;
+    }>;
+    connection: {
+        status: ConnectionStatus;
+    };
+    page: Page | null;
+    region: string | null;
+    referrer: string | null;
+    requests: Record<string, {
+        id: string;
+        promise: Promise<any>;
+        resolve: (val: any) => void;
+        reject: (err: any) => void;
+        request: O.Pick<Request, 'action' | 'payload'>;
+    }>;
+    users: {
+        self: {
+            id: string | null;
+            type: 'customer';
+        };
+        others: Record<string, StateUser>;
+    };
+    uniqueGroups: boolean;
+    mobile: boolean;
+};
+export {};
+//# sourceMappingURL=state.d.ts.map

package/types/uploadFile.d.ts

@@ -0,0 +1,19 @@
+import { CustomerAuth } from '@livechat/customer-auth';
+import { Options as GenericUploadFileOptions } from '@livechat/file-upload';
+import { Store } from './types';
+type UploadFileDependencies = {
+    auth: CustomerAuth;
+    store: Store;
+};
+export type UploadFileOptions = {
+    file: File;
+    onProgress?: GenericUploadFileOptions['onProgress'];
+};
+declare const uploadFile: ({ auth, store }: UploadFileDependencies, { file, onProgress }: UploadFileOptions) => {
+    promise: Promise<{
+        url: string;
+    }>;
+    cancel(): void;
+};
+export default uploadFile;
+//# sourceMappingURL=uploadFile.d.ts.map

package/types/validateFile/index.d.ts

@@ -0,0 +1,3 @@
+declare const validateFile: (file: File) => void;
+export default validateFile;
+//# sourceMappingURL=index.d.ts.map