@livechat/customer-sdk 3.1.4 → 3.1.5

package/types/types/clientEntities.d.ts

@@ -0,0 +1,374 @@
+import { Any, Object } from 'ts-toolbelt';
+import * as eventTypes from '../constants/eventTypes';
+import * as userTypes from '../constants/userTypes';
+import * as serverEntities from './serverEntities';
+export type GreetingSubtype = 'greeting' | 'announcement';
+export type Greeting = {
+    id: number;
+    addon: string | null;
+    uniqueId: string;
+    displayedFirstTime: boolean;
+    accepted: boolean;
+    subtype: GreetingSubtype;
+    event: GreetingEvent;
+    agent: {
+        id: string;
+        name: string;
+        avatar: string;
+        jobTitle: string;
+        isBot: boolean;
+    };
+};
+export type Access = {
+    groupIds?: number[];
+};
+export type EventsSeenUpToMap = {
+    [userId: string]: string | null;
+};
+export type Properties = {
+    [namespace: string]: {
+        [key: string]: string | number;
+    };
+};
+export type CustomerSessionFields = Record<string, string>;
+export type Thread = {
+    id: string;
+    chatId: string;
+    active: boolean;
+    access: Access;
+    createdAt: string;
+    userIds: string[];
+    events: Event[];
+    properties: Properties;
+    previousThreadId: string | null;
+    nextThreadId: string | null;
+    queue: {
+        position: number;
+        waitTime: number;
+        queuedAt: string;
+    } | null;
+};
+export type ChatSummary = {
+    id: string;
+    active: boolean;
+    access: Access;
+    properties: Properties;
+    users: ChatUser[];
+    lastThreadId: string | null;
+    lastThreadCreatedAt: string | null;
+    eventsSeenUpToMap: EventsSeenUpToMap;
+    lastEventsPerType?: {
+        [Type in Event['type']]?: Extract<Event, {
+            type: Type;
+        }>;
+    };
+    lastEvent?: Event;
+};
+export type Chat = {
+    id: string;
+    access?: Access;
+    users: ChatUser[];
+    properties: Properties;
+    thread: Thread | null;
+    eventsSeenUpToMap: EventsSeenUpToMap;
+};
+export type IncomingChat = Chat & {
+    thread: Thread;
+};
+export type Agent = {
+    type: typeof userTypes.AGENT;
+    id: string;
+    name: string;
+    avatar: string;
+    jobTitle: string;
+};
+export type CustomerCommonProps = {
+    type: typeof userTypes.CUSTOMER;
+    id: string;
+    name?: string;
+    email?: string;
+    avatar?: string;
+    sessionFields: CustomerSessionFields;
+};
+export type CustomerOptionalProps = {
+    name?: string;
+    email?: string;
+    avatar?: string;
+    sessionFields?: CustomerSessionFields;
+};
+type ChatUserProps = {
+    present: boolean;
+};
+export type Customer = Any.Compute<CustomerCommonProps & {
+    statistics: {
+        chatsCount: number;
+        threadsCount: number;
+        visitsCount: number;
+        pageViewsCount: number;
+        greetingsShownCount: number;
+        greetingsAcceptedCount: number;
+    };
+}>;
+export type User = Agent | Customer;
+export type ChatAgent = Any.Compute<Agent & ChatUserProps>;
+export type ChatCustomer = Any.Compute<CustomerCommonProps & ChatUserProps>;
+export type ChatUser = ChatAgent | ChatCustomer;
+export type PredictedAgent = {
+    agent: Any.Compute<Pick<Agent, 'avatar' | 'id' | 'name' | 'jobTitle' | 'type'> & {
+        isBot: boolean;
+    }>;
+    queue: boolean;
+};
+export type CustomerUpdate = Any.Compute<Partial<Pick<Customer, 'avatar' | 'email' | 'name' | 'sessionFields'>>>;
+export type FormType = serverEntities.FormType;
+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;
+        groupId: number;
+    }>;
+    required: boolean;
+};
+type RatingField = {
+    type: 'rating';
+    id: string;
+    label: string;
+    commentLabel: 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 FilledGroupChooserField = CreateFilledField<GroupChooserField, {
+    answer?: {
+        id: string;
+        groupId: number;
+        label: string;
+    };
+}>;
+export type FilledFormField = Exclude<serverEntities.FilledFormField, {
+    type: 'group_chooser';
+}> | FilledGroupChooserField;
+type RichMessageButtonBase = {
+    postbackId: string;
+    text: string;
+    userIds: string[];
+    role: serverEntities.RichMessageButtonRole;
+};
+type RichMessageButtonWithoutValue = Any.Compute<RichMessageButtonBase & {
+    type?: void;
+}>;
+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;
+    webviewHeight?: 'full' | 'tall' | 'compact';
+}>;
+export type RichMessageButton = RichMessageButtonWithoutValue | RichMessageMessageButton | RichMessageUrlButton | RichMessagePhoneButton | RichMessageCancelButton | RichMessageWebviewButton;
+export type RichMessageElement = {
+    title?: string;
+    subtitle?: string;
+    image?: {
+        url: string;
+        name?: string;
+        alternativeText?: string;
+        content_type?: string;
+        size?: number;
+        width?: number;
+        height?: number;
+    };
+    buttons?: RichMessageButton[];
+};
+export type AvailabilityStatus = 'online' | 'offline';
+type RichMessageTemplate = 'cards' | 'quick_replies' | 'sticker';
+type Thumbnail = {
+    url: string;
+    height: number;
+    width: number;
+};
+type ServerGeneratedEventBase = {
+    id: string;
+    authorId: string;
+    createdAt: string;
+};
+type ClientGeneratedEventBase = {
+    threadId: string;
+};
+type EventBase = {
+    customId?: string;
+    properties: Properties;
+};
+export type NonSpecificEventBase = ServerGeneratedEventBase & ClientGeneratedEventBase & EventBase;
+type FileSpecificProps = {
+    type: typeof eventTypes.FILE;
+    contentType: string;
+    url: string;
+    name: string;
+};
+type ImageSpecificProps = {
+    width: number;
+    height: number;
+    thumbnails: {
+        high: Thumbnail;
+        default: Thumbnail;
+    };
+    alternativeText?: string;
+};
+type NonImageSpecificProps = {
+    width?: undefined;
+    height?: undefined;
+};
+type FormSpecificProps = {
+    type: typeof eventTypes.FORM;
+    formId: string;
+    fields: FormField[];
+};
+type FilledFormSpecificProps = {
+    type: typeof eventTypes.FILLED_FORM;
+    formId: string;
+    fields: FilledFormField[];
+};
+type CustomEventSpecificProps = {
+    type: typeof eventTypes.CUSTOM;
+    content?: any;
+};
+type MessageSpecificProps = {
+    type: typeof eventTypes.MESSAGE;
+    text: string;
+    postback?: {
+        id: string;
+        threadId: string;
+        eventId: string;
+        type: string;
+        value: string;
+    };
+};
+type RichMessageSpecificProps = {
+    type: typeof eventTypes.RICH_MESSAGE;
+    template: RichMessageTemplate;
+    elements: RichMessageElement[];
+};
+type SystemMessageSpecificProps = {
+    type: typeof eventTypes.SYSTEM_MESSAGE;
+    text: string;
+    systemMessageType: string;
+    textVars?: Record<string, string>;
+};
+type RequestBodyFile = Any.Compute<EventBase & {
+    type: typeof eventTypes.FILE;
+    url: string;
+    alternativeText: 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<NonSpecificEventBase & FileSpecificProps & ImageSpecificProps>;
+export type NonImageFile = Any.Compute<NonSpecificEventBase & FileSpecificProps & NonImageSpecificProps>;
+export type File = ImageFile | NonImageFile;
+export type Form = Any.Compute<NonSpecificEventBase & FormSpecificProps>;
+export type FilledForm = Any.Compute<NonSpecificEventBase & FilledFormSpecificProps>;
+export type CustomEvent = Any.Compute<NonSpecificEventBase & CustomEventSpecificProps>;
+export type Message = Any.Compute<NonSpecificEventBase & MessageSpecificProps>;
+export type RichMessage = Any.Compute<NonSpecificEventBase & RichMessageSpecificProps>;
+export type SystemMessage = Any.Compute<NonSpecificEventBase & SystemMessageSpecificProps>;
+export type GreetingEvent = Object.Update<Message | RichMessage, 'threadId', null>;
+export type Event = File | Form | FilledForm | Message | RichMessage | SystemMessage | CustomEvent;
+export type UrlInfo = {
+    url: string;
+    title?: string;
+    description?: string;
+    imageUrl?: string;
+    imageWidth?: number;
+    imageHeight?: number;
+};
+export {};
+//# sourceMappingURL=clientEntities.d.ts.map