@wildix/xbees-connect 1.2.19-alpha.0 → 1.2.19-alpha.11

package/dist-cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.2.18",
+    "version": "1.2.19-alpha.10",
     "description": "This library provides easy communication between x-bees and integrated web applications",
     "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
     "homepage": "",

package/dist-cjs/src/Client.js

@@ -113,11 +113,11 @@ class Client {
         });
     }
     sendDailyIntegrationUsageAnalytics() {
-        const sendedUsageAnalyticsDate = this.getFromStorage('sendedUsageAnalyticsDate');
+        const sentUsageAnalyticsDate = this.getFromStorage('sentUsageAnalyticsDate');
         const today = new Date().toDateString();
-        if (sendedUsageAnalyticsDate !== today) {
+        if (sentUsageAnalyticsDate !== today) {
             this.sendAnalytics('xBeesIntegrationUsage');
-            this.saveToStorage('sendedUsageAnalyticsDate', today);
+            this.saveToStorage('sentUsageAnalyticsDate', today);
         }
     }
     ready(props = types_1.SupportedPlatformVariant.ALL) {
@@ -204,6 +204,9 @@ class Client {
     getCurrentConversation() {
         return this.sendAsync({ type: enums_1.ClientEventType.CURRENT_CONVERSATION });
     }
+    getCachedContact() {
+        return this.sendAsync({ type: enums_1.ClientEventType.CACHED_CONTACT });
+    }
     contactUpdated(query, contact) {
         return this.sendAsync({ type: enums_1.ClientEventType.CONTACT_CREATE_OR_UPDATE, payload: { query, contact } });
     }
@@ -340,8 +343,9 @@ class Client {
     getFromStorage(key) {
         return this.localStorageManager.retrieve(key);
     }
-    saveToStorage(key, value) {
+    saveToStorage(key, value, sendToXbees = false) {
         this.localStorageManager.save(key, value);
+        sendToXbees && this.sendToXbeesStorage(key, value);
     }
     deleteFromStorage(key) {
         this.localStorageManager.delete(key);
@@ -374,5 +378,20 @@ class Client {
     onVisibilityChange(callback) {
         return this.addEventListener(enums_1.EventType.VISIBILITY, callback);
     }
+    sendToXbeesStorage(key, value) {
+        void this.sendAsync({
+            type: enums_1.ClientEventType.SAVE_TO_STORAGE,
+            payload: {
+                key,
+                value: typeof value === 'string' ? value : JSON.stringify(value),
+            },
+        });
+    }
+    requestFromXbeesStorage(key) {
+        return this.sendAsync({
+            type: enums_1.ClientEventType.REQUEST_FROM_STORAGE,
+            payload: { key },
+        });
+    }
 }
 exports.Client = Client;

package/dist-cjs/src/enums/index.js

@@ -40,6 +40,9 @@ var ClientEventType;
     ClientEventType["SEND_ANALYTICS"] = "xBeesSendAnalytics";
     ClientEventType["SEND_TECHNICAL_SUPPORT_INFORMATION"] = "xBeesSendTechInfo";
     ClientEventType["USER"] = "xBeesUser";
+    ClientEventType["SAVE_TO_STORAGE"] = "xBeesSaveToStorage";
+    ClientEventType["REQUEST_FROM_STORAGE"] = "xBeesRequestFromStorage";
+    ClientEventType["CACHED_CONTACT"] = "xBeesCachedContact";
 })(ClientEventType || (exports.ClientEventType = ClientEventType = {}));
 var UrlParams;
 (function (UrlParams) {

package/dist-cjs/types/CachedContact.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.2.18",
+    "version": "1.2.19-alpha.10",
     "description": "This library provides easy communication between x-bees and integrated web applications",
     "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
     "homepage": "",

package/dist-es/src/Client.js

@@ -107,11 +107,11 @@ export class Client {
         });
     }
     sendDailyIntegrationUsageAnalytics() {
-        const sendedUsageAnalyticsDate = this.getFromStorage('sendedUsageAnalyticsDate');
+        const sentUsageAnalyticsDate = this.getFromStorage('sentUsageAnalyticsDate');
         const today = new Date().toDateString();
-        if (sendedUsageAnalyticsDate !== today) {
+        if (sentUsageAnalyticsDate !== today) {
             this.sendAnalytics('xBeesIntegrationUsage');
-            this.saveToStorage('sendedUsageAnalyticsDate', today);
+            this.saveToStorage('sentUsageAnalyticsDate', today);
         }
     }
     ready(props = SupportedPlatformVariant.ALL) {
@@ -198,6 +198,9 @@ export class Client {
     getCurrentConversation() {
         return this.sendAsync({ type: ClientEventType.CURRENT_CONVERSATION });
     }
+    getCachedContact() {
+        return this.sendAsync({ type: ClientEventType.CACHED_CONTACT });
+    }
     contactUpdated(query, contact) {
         return this.sendAsync({ type: ClientEventType.CONTACT_CREATE_OR_UPDATE, payload: { query, contact } });
     }
@@ -334,8 +337,9 @@ export class Client {
     getFromStorage(key) {
         return this.localStorageManager.retrieve(key);
     }
-    saveToStorage(key, value) {
+    saveToStorage(key, value, sendToXbees = false) {
         this.localStorageManager.save(key, value);
+        sendToXbees && this.sendToXbeesStorage(key, value);
     }
     deleteFromStorage(key) {
         this.localStorageManager.delete(key);
@@ -368,4 +372,19 @@ export class Client {
     onVisibilityChange(callback) {
         return this.addEventListener(EventType.VISIBILITY, callback);
     }
+    sendToXbeesStorage(key, value) {
+        void this.sendAsync({
+            type: ClientEventType.SAVE_TO_STORAGE,
+            payload: {
+                key,
+                value: typeof value === 'string' ? value : JSON.stringify(value),
+            },
+        });
+    }
+    requestFromXbeesStorage(key) {
+        return this.sendAsync({
+            type: ClientEventType.REQUEST_FROM_STORAGE,
+            payload: { key },
+        });
+    }
 }

package/dist-es/src/enums/index.js

@@ -37,6 +37,9 @@ export var ClientEventType;
     ClientEventType["SEND_ANALYTICS"] = "xBeesSendAnalytics";
     ClientEventType["SEND_TECHNICAL_SUPPORT_INFORMATION"] = "xBeesSendTechInfo";
     ClientEventType["USER"] = "xBeesUser";
+    ClientEventType["SAVE_TO_STORAGE"] = "xBeesSaveToStorage";
+    ClientEventType["REQUEST_FROM_STORAGE"] = "xBeesRequestFromStorage";
+    ClientEventType["CACHED_CONTACT"] = "xBeesCachedContact";
 })(ClientEventType || (ClientEventType = {}));
 export var UrlParams;
 (function (UrlParams) {

package/dist-es/types/CachedContact.js

@@ -0,0 +1 @@
+export {};

package/dist-types/src/Client.d.ts

@@ -52,6 +52,7 @@ export declare class Client implements ConnectClient {
     getContext(): Promise<Message<ClientEventType.CONTEXT>>;
     getCurrentContact(): Promise<Message<ClientEventType.CURRENT_CONTACT>>;
     getCurrentConversation(): Promise<Message<ClientEventType.CURRENT_CONVERSATION>>;
+    getCachedContact(): Promise<Message<ClientEventType.CACHED_CONTACT>>;
     contactUpdated(query: ContactQuery, contact: Contact): Promise<Message<ClientEventType.CONTACT_CREATE_OR_UPDATE>>;
     contactMatchUpdated(query: ContactQuery, contact: Contact): Promise<ResponseMessage<ClientEventType.CONTACT_MATCH_UPDATE>>;
     getThemeMode(): Promise<Message<ClientEventType.THEME_MODE>>;
@@ -75,7 +76,7 @@ export declare class Client implements ConnectClient {
     onLookupAndMatchContact(callback: (query: ContactQuery, resolve: LookupAndMatchContactsResolver, reject: Reject) => void): RemoveEventListener;
     onThemeChange(callback: Callback<EventType.USE_THEME>): RemoveEventListener;
     getFromStorage<Type>(key: string): Type | null;
-    saveToStorage<SavingType>(key: string, value: SavingType): void;
+    saveToStorage<SavingType>(key: string, value: SavingType, sendToXbees?: boolean): void;
     deleteFromStorage(key: string): void;
     onStorage(listener: StorageEventCallback): () => void;
     onLogout(callback: Callback<EventType.LOGOUT>): RemoveEventListener;
@@ -83,4 +84,6 @@ export declare class Client implements ConnectClient {
     setIntegrationStorageKey(integrationKey: string): void;
     getTechnicalSupport(): TechnicalSupport;
     onVisibilityChange(callback: Callback<EventType.VISIBILITY>): RemoveEventListener;
+    sendToXbeesStorage<SavingType>(key: string, value: SavingType): void;
+    requestFromXbeesStorage(key: string): Promise<ResponseMessage<ClientEventType.REQUEST_FROM_STORAGE>>;
 }

package/dist-types/src/enums/index.d.ts

@@ -34,7 +34,10 @@ export declare enum ClientEventType {
     LOGOUT_IS_SUPPORTED = "xBeesLogoutIsSupported",
     SEND_ANALYTICS = "xBeesSendAnalytics",
     SEND_TECHNICAL_SUPPORT_INFORMATION = "xBeesSendTechInfo",
-    USER = "xBeesUser"
+    USER = "xBeesUser",
+    SAVE_TO_STORAGE = "xBeesSaveToStorage",
+    REQUEST_FROM_STORAGE = "xBeesRequestFromStorage",
+    CACHED_CONTACT = "xBeesCachedContact"
 }
 export declare enum UrlParams {
     TOKEN = "t",

package/dist-types/types/CachedContact.d.ts

@@ -0,0 +1,4 @@
+import { ContactShape } from './Contact';
+export type CachedContact = ContactShape & {
+    name?: string;
+};

package/dist-types/types/Client.d.ts

@@ -75,6 +75,9 @@ export interface ConnectClient {
     /**
      * Retrieves current opened in x-bees conversation data or undefined if the conversation is temporary */
     getCurrentConversation: () => Promise<ResponseMessage<ClientEventType.CURRENT_CONVERSATION>>;
+    /**
+     * Retrieves contact cached by x-bees */
+    getCachedContact: () => Promise<ResponseMessage<ClientEventType.CACHED_CONTACT>>;
     /**
      * Sends notification to x-bees about contact data updated */
     contactUpdated(query: ContactQuery, contact: Contact): Promise<ResponseMessage<ClientEventType.CONTACT_CREATE_OR_UPDATE>>;
@@ -143,7 +146,7 @@ export interface ConnectClient {
     off: (callback: Callback | StorageEventCallback) => void;
     /**
      * saves data to localStorage */
-    saveToStorage: <SavingType>(key: string, value: SavingType) => void;
+    saveToStorage: <SavingType>(key: string, value: SavingType, sendToXbees?: boolean) => void;
     /**
      * Retrieves data from localStorage */
     getFromStorage: <Type>(key: string) => Type | null;
@@ -168,4 +171,10 @@ export interface ConnectClient {
     /**
      * Starts listen for the events of changing iframe activity and handle with the provided callback */
     onVisibilityChange: (callback: Callback<EventType.VISIBILITY>) => RemoveEventListener;
+    /**
+     * Send data to save in x-bees storage */
+    sendToXbeesStorage: (key: string, value: string) => void;
+    /**
+     * Request stored data from x-bees storage */
+    requestFromXbeesStorage: (key: string) => Promise<ResponseMessage<ClientEventType.REQUEST_FROM_STORAGE>>;
 }

package/dist-types/types/Contact.d.ts

@@ -1,8 +1,9 @@
-interface ContactShape {
+export interface ContactShape {
     id: string;
     name: string;
     email?: string;
     phone?: string;
+    picture?: string;
     mobileNumber?: string;
     officeNumber?: string;
     faxNumber?: string;
@@ -21,4 +22,3 @@ export type ContactQuery = {
     email?: string;
     phone?: string;
 };
-export {};

package/dist-types/types/Event.d.ts

@@ -1,10 +1,11 @@
 import { ClientEventType, EventType } from '../src/enums';
+import { CachedContact } from './CachedContact';
 import { ContactQuery } from './Contact';
 import { Message, MessageType } from './Message';
-import { IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadSendAnalytics, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
+import { IPayloadAutoSuggestResult, IPayloadCallStart, IPayloadCallStartedInfo, IPayloadContactMatchResult, IPayloadContactMatchResultNotFound, IPayloadContactResult, IPayloadContextResult, IPayloadConversationResult, IPayloadRequestFromStorage, IPayloadSendAnalytics, IPayloadSentToStorage, IPayloadTechSupport, IPayloadThemeChange, IPayloadToast, IPayloadVersion, IPayloadViewPort } from './Payload';
 import { SupportedPlatformVariant } from './Platform';
 import { XBeesUser } from './XBeesUser';
-export type EventPayload<T extends MessageType> = T extends EventType.GET_CONTACTS_AUTO_SUGGEST ? string : T extends ClientEventType.CONTACTS_AUTO_SUGGEST ? IPayloadAutoSuggestResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH | ClientEventType.CONTACT_CREATE_OR_UPDATE | ClientEventType.CONTACT_MATCH_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends ClientEventType.CURRENT_CONVERSATION ? IPayloadConversationResult : T extends EventType.ADD_CALL ? IPayloadCallStartedInfo : T extends ClientEventType.START_CALL ? IPayloadCallStart : T extends ClientEventType.READY ? IPayloadVersion : T extends ClientEventType.VIEW_PORT ? IPayloadViewPort : T extends ClientEventType.THEME ? IPayloadThemeChange : T extends EventType.USE_THEME ? IPayloadThemeChange : T extends ClientEventType.TOAST ? IPayloadToast : T extends ClientEventType.SEND_ANALYTICS ? IPayloadSendAnalytics : T extends ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION ? IPayloadTechSupport : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : T extends EventType.GET_LOOK_UP_AND_MATCH ? ContactQuery : T extends EventType.VISIBILITY ? boolean : T extends ClientEventType.USER ? XBeesUser : never;
+export type EventPayload<T extends MessageType> = T extends EventType.GET_CONTACTS_AUTO_SUGGEST ? string : T extends ClientEventType.CONTACTS_AUTO_SUGGEST ? IPayloadAutoSuggestResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH | ClientEventType.CONTACT_CREATE_OR_UPDATE | ClientEventType.CONTACT_MATCH_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_LOOKUP_AND_MATCH_NOT_FOUND ? IPayloadContactMatchResultNotFound : T extends ClientEventType.CONTEXT ? IPayloadContextResult : T extends ClientEventType.CURRENT_CONTACT ? IPayloadContactResult : T extends ClientEventType.CURRENT_CONVERSATION ? IPayloadConversationResult : T extends EventType.ADD_CALL ? IPayloadCallStartedInfo : T extends ClientEventType.START_CALL ? IPayloadCallStart : T extends ClientEventType.READY ? IPayloadVersion : T extends ClientEventType.VIEW_PORT ? IPayloadViewPort : T extends ClientEventType.THEME ? IPayloadThemeChange : T extends EventType.USE_THEME ? IPayloadThemeChange : T extends ClientEventType.TOAST ? IPayloadToast : T extends ClientEventType.SEND_ANALYTICS ? IPayloadSendAnalytics : T extends ClientEventType.SEND_TECHNICAL_SUPPORT_INFORMATION ? IPayloadTechSupport : T extends EventType.PBX_TOKEN ? string : T extends ClientEventType.TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : T extends EventType.GET_LOOK_UP_AND_MATCH ? ContactQuery : T extends EventType.VISIBILITY ? boolean : T extends ClientEventType.USER ? XBeesUser : T extends ClientEventType.SAVE_TO_STORAGE ? IPayloadSentToStorage : T extends ClientEventType.REQUEST_FROM_STORAGE ? IPayloadRequestFromStorage : T extends ClientEventType.CACHED_CONTACT ? CachedContact | null : never;
 export type EventPayloadMap = {
     [EventType.GET_CONTACTS_AUTO_SUGGEST]: string;
     [EventType.GET_LOOK_UP_AND_MATCH]: ContactQuery;

package/dist-types/types/Payload.d.ts

@@ -54,6 +54,13 @@ export interface IPayloadSendAnalytics {
     eventName: string;
     params?: Record<string, string>;
 }
+export interface IPayloadSentToStorage {
+    key: string;
+    value: string;
+}
+export interface IPayloadRequestFromStorage {
+    key: string;
+}
 export interface IPayloadTechSupport {
     'x-iframe-params': ClientParams;
     message: string;

package/dist-types/types/XBeesUser.d.ts

@@ -1,4 +1,5 @@
 export interface XBeesUser {
+    id: string;
     email: string;
     extension: string;
     domain: string;

package/dist-types/types/index.d.ts

@@ -1,3 +1,4 @@
+export type { CachedContact } from './CachedContact';
 export type { Callback } from './Callback';
 export type { ConnectClient } from './Client';
 export type { Contact, ContactQuery } from './Contact';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.2.19-alpha.0",
+  "version": "1.2.19-alpha.11",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -43,5 +43,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "6b7bfd2d3edfb7466a3bba7de47fda7f427a07e9"
+  "gitHead": "4e47a9b96439ce9ff8c255aef1be20fbe957284c"
 }

package/dist-types/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.3"
-    }
-  ]
-}