@livechat/customer-sdk 4.0.1 → 5.0.0

package/types/types/serverEntities.d.ts

@@ -8,6 +8,7 @@ export type Greeting = {
     displayed_first_time: boolean;
     accepted?: boolean;
     subtype?: string;
+    is_exit_intent: boolean;
     event: GreetingEvent;
     agent: {
         id: string;
@@ -138,7 +139,9 @@ 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 CustomerUpdate = Pick<Customer, 'avatar' | 'email' | 'name' | 'session_fields'> & {
+    name_is_default?: boolean;
+};
 export type FormType = 'prechat' | 'postchat' | 'ticket';
 type FormFieldOption = {
     id: string;
@@ -278,6 +281,7 @@ type RichMessageButtonBase = {
     text: string;
     user_ids: string[];
     role?: RichMessageButtonRole;
+    button_id?: string;
 };
 type RichMessageButtonWithoutValue = Any.Compute<RichMessageButtonBase & {
     type?: undefined;
@@ -291,10 +295,27 @@ type RichMessageUrlButton = Any.Compute<RichMessageButtonBase & {
     value: string;
     target?: 'current' | 'new';
 }>;
+type RichMessageOpenExternalButton = Any.Compute<RichMessageButtonBase & {
+    type: 'open_external';
+    value: string;
+    target?: 'current' | 'new';
+}>;
+type RichMessageAddToCartButton = Any.Compute<RichMessageButtonBase & {
+    type: 'add_to_cart';
+    value: string;
+}>;
+type RichMessageShowGalleryButton = Any.Compute<RichMessageButtonBase & {
+    type: 'show_gallery';
+    value: string;
+}>;
 type RichMessagePhoneButton = Any.Compute<RichMessageButtonBase & {
     type: 'phone';
     value: string;
 }>;
+type RichMessageCopyButton = Any.Compute<RichMessageButtonBase & {
+    type: 'copy';
+    value: string;
+}>;
 type RichMessageCancelButton = Any.Compute<RichMessageButtonBase & {
     type: 'cancel';
 }>;
@@ -303,7 +324,57 @@ type RichMessageWebviewButton = Any.Compute<RichMessageButtonBase & {
     value: string;
     webview_height?: 'full' | 'tall' | 'compact';
 }>;
-export type RichMessageButton = RichMessageButtonWithoutValue | RichMessageMessageButton | RichMessageUrlButton | RichMessagePhoneButton | RichMessageCancelButton | RichMessageWebviewButton;
+export type RichMessageButton = RichMessageButtonWithoutValue | RichMessageMessageButton | RichMessageUrlButton | RichMessageOpenExternalButton | RichMessageAddToCartButton | RichMessageShowGalleryButton | RichMessagePhoneButton | RichMessageCancelButton | RichMessageWebviewButton | RichMessageCopyButton;
+type RichMessageEcommerceAddonPriceRange = {
+    addon_type: 'price_range';
+    range_from?: string | number;
+    range_to?: string | number;
+    currency?: string;
+};
+type RichMessageEcommerceAddonMoreItems = {
+    addon_type: 'more_items';
+};
+type RichMessageEcommerceAddon = RichMessageEcommerceAddonPriceRange | RichMessageEcommerceAddonMoreItems;
+type RichMessageEcommerceBaseOption = {
+    label: string;
+    option_id: string;
+    price?: string | number;
+    regular_price?: string | number;
+    max_price?: string | number;
+    currency?: string;
+    selected?: boolean;
+    available?: boolean;
+};
+type RichMessageEcommerceTagOption = RichMessageEcommerceBaseOption;
+type RichMessageEcommerceSwatchOption = RichMessageEcommerceBaseOption & {
+    color: string;
+};
+type RichMessageEcommerceImageOption = RichMessageEcommerceBaseOption & {
+    image_url: string;
+    image_thumbnail_url?: string;
+};
+type RichMessageEcommerceSelectOption = RichMessageEcommerceBaseOption;
+type RichMessageEcommerceWithTags = {
+    view_type: 'tags';
+    options?: RichMessageEcommerceTagOption[];
+};
+type RichMessageEcommerceWithSwatches = {
+    view_type: 'swatch';
+    options?: RichMessageEcommerceSwatchOption[];
+};
+type RichMessageEcommerceWithImages = {
+    view_type: 'images';
+    options?: RichMessageEcommerceImageOption[];
+};
+type RichMessageEcommerceWithSelect = {
+    view_type: 'select';
+    options?: RichMessageEcommerceSelectOption[];
+};
+type RichMessageEcommerce = {
+    product_id: string;
+    label?: string;
+    addons?: RichMessageEcommerceAddon[];
+} & (RichMessageEcommerceWithTags | RichMessageEcommerceWithSwatches | RichMessageEcommerceWithImages | RichMessageEcommerceWithSelect);
 export type RichMessageElement = {
     title?: string;
     subtitle?: string;
@@ -316,9 +387,10 @@ export type RichMessageElement = {
         width?: number;
         height?: number;
     };
+    ecommerce?: RichMessageEcommerce;
     buttons?: RichMessageButton[];
 };
-type RichMessageTemplate = 'cards' | 'quick_replies' | 'sticker';
+type RichMessageTemplate = 'cards' | 'quick_replies' | 'sticker' | 'ecommerce';
 type ServerGeneratedEventBase = {
     id: string;
     author_id: string;
@@ -348,11 +420,13 @@ type NonImageSpecificProps = {
 type FormSpecificProps = {
     type: 'form';
     form_id: string;
+    form_type?: string;
     fields: FormField[];
 };
 type FilledFormSpecificProps = {
     type: 'filled_form';
     form_id: string;
+    form_type?: string;
     fields: FilledFormField[];
 };
 type MessageSpecificProps = {
@@ -404,6 +478,7 @@ export type RichMessage = Any.Compute<ServerGeneratedEventBase & EventBase & Ric
 export type SystemMessage = Any.Compute<ServerGeneratedEventBase & EventBase & SystemMessageSpecificProps>;
 export type CustomEvent = Any.Compute<ServerGeneratedEventBase & EventBase & CustomEventSpecificProps>;
 export type GreetingEvent = Message | RichMessage;
+export type PredictedWelcomeMessage = Omit<Message, 'postback'> | RichMessage;
 export type Event = File | Form | FilledForm | Message | RichMessage | SystemMessage | CustomEvent;
 export {};
 //# sourceMappingURL=serverEntities.d.ts.map

package/types/types/state.d.ts

@@ -14,6 +14,7 @@ export type InitialStateData = {
     page?: Page | null;
     region?: string | null;
     referrer?: string | null;
+    tabId?: string | null;
     uniqueGroups?: boolean;
     mobile?: boolean;
 };
@@ -35,6 +36,7 @@ export type State = {
     page: Page | null;
     region: string | null;
     referrer: string | null;
+    tabId: string | null;
     requests: Record<string, {
         id: string;
         promise: Promise<any>;

package/types/sendTicketForm.d.ts

@@ -1,15 +0,0 @@
-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, licenseId, timeZone, }: {
-    filledForm: Extract<clientEntities.RequestBodyEvent, {
-        type: 'filled_form';
-    }>;
-    licenseId: number;
-    groupId?: number | undefined;
-    timeZone?: string | undefined;
-}) => Promise<{
-    id: string;
-}>;
-export default sendTicketForm;
-//# sourceMappingURL=sendTicketForm.d.ts.map