@wildix/xbees-connect 1.0.6-alpha.9 → 1.1.0-alpha.0

package/dist-es/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wildix/xbees-connect",
-    "version": "1.0.6-alpha.8",
+    "version": "1.0.6-alpha.12",
     "description": "This library provides easy communication between x-bees and integrated web applications",
     "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
     "homepage": "",
@@ -11,6 +11,7 @@
     "module": "./dist-es/index.js",
     "type": "module",
     "scripts": {
+        "build": "yarn clean && yarn build:es && yarn build:types",
         "build:es": "tsc -p tsconfig.es.json",
         "build:types": "tsc -p tsconfig.types.json",
         "build:docs": "typedoc",

package/dist-es/src/Client.js

@@ -1,5 +1,5 @@
 import packageJson from '../package.json';
-import { ClientEventType, EventType, UrlParams } from './enums';
+import { ClientEventType, DeprecatedUrlParams, EventType, UrlParams } from './enums';
 import PostMessageControllerNative from './helpers/PostMessageControllerNative';
 import PostMessageControllerWeb from './helpers/PostMessageControllerWeb';
 /**
@@ -38,12 +38,12 @@ export class Client {
     variant = null;
     constructor() {
         const params = new URLSearchParams(window.location.search);
-        this.iframeId = params.get(UrlParams.ID);
-        this.variant = params.get(UrlParams.VARIANT);
-        this.userEmail = params.get(UrlParams.USER);
-        this.userToken = params.get(UrlParams.TOKEN);
-        this.referrer = params.get(UrlParams.REFERRER);
-        this.needAuthorize = params.has(UrlParams.AUTHORIZE);
+        this.iframeId = (params.get(UrlParams.ID) ?? params.get(DeprecatedUrlParams.ID));
+        this.variant = (params.get(UrlParams.VARIANT) ?? params.get(DeprecatedUrlParams.VARIANT));
+        this.userEmail = (params.get(UrlParams.USER) ?? params.get(DeprecatedUrlParams.USER));
+        this.userToken = (params.get(UrlParams.TOKEN) ?? params.get(DeprecatedUrlParams.TOKEN));
+        this.referrer = (params.get(UrlParams.REFERRER) ?? params.get(DeprecatedUrlParams.REFERRER));
+        this.needAuthorize = (params.has(UrlParams.AUTHORIZE) ?? params.has(DeprecatedUrlParams.AUTHORIZE));
         // @ts-expect-error window.ReactNativeWebView will be provided by ReactNative WebView
         this.worker = window.ReactNativeWebView
             ? new PostMessageControllerNative()
@@ -107,7 +107,7 @@ export class Client {
         return this.userEmail;
     }
     isDataOnly() {
-        return this.variant === 'd';
+        return this.variant === 'no-ui' || this.variant === 'daemon';
     }
     showsUi() {
         return !this.isDataOnly();
@@ -121,6 +121,9 @@ export class Client {
     getCurrentContact() {
         return this.sendAsync({ type: ClientEventType.CURRENT_CONTACT });
     }
+    contactUpdated(query, contact) {
+        return this.sendAsync({ type: ClientEventType.CONTACT_CREATE_OR_UPDATE, payload: { query, contact } });
+    }
     getThemeMode() {
         return this.sendAsync({ type: ClientEventType.THEME_MODE });
     }

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

@@ -22,7 +22,17 @@ export var ClientEventType;
     ClientEventType["AUTHORIZED"] = "xBeesAuthorized";
     ClientEventType["CONTACTS_AUTO_SUGGEST"] = "xBeesContactsAutoSuggest";
     ClientEventType["CONTACT_LOOKUP_AND_MATCH"] = "xBeesContactLookupAndMatch";
+    ClientEventType["CONTACT_CREATE_OR_UPDATE"] = "xBeesContactCreateOrUpdate";
 })(ClientEventType || (ClientEventType = {}));
+export var DeprecatedUrlParams;
+(function (DeprecatedUrlParams) {
+    DeprecatedUrlParams["TOKEN"] = "token";
+    DeprecatedUrlParams["ID"] = "iframeId";
+    DeprecatedUrlParams["VARIANT"] = "variant";
+    DeprecatedUrlParams["USER"] = "u";
+    DeprecatedUrlParams["REFERRER"] = "referrer";
+    DeprecatedUrlParams["AUTHORIZE"] = "authorize";
+})(DeprecatedUrlParams || (DeprecatedUrlParams = {}));
 export var UrlParams;
 (function (UrlParams) {
     UrlParams["TOKEN"] = "t";

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

@@ -1,4 +1,4 @@
-import { Callback, ConnectClient, ContactQuery, IPayloadAutoSuggestResult, IPayloadContactMatchResult, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, SuggestContactsResolver } from '../types';
+import { Callback, ConnectClient, Contact, ContactQuery, IPayloadAutoSuggestResult, IPayloadContactMatchResult, IPayloadViewPort, LookupAndMatchContactsResolver, Message, Reject, RemoveEventListener, ResponseMessage, SuggestContactsResolver } from '../types';
 import { ClientEventType, EventType } from './enums';
 /**
  * Client provides functionality of communication between xBees and integrated web applications via iFrame or ReactNative WebView
@@ -30,6 +30,7 @@ export declare class Client implements ConnectClient {
     isActivationOnly(): boolean;
     getContext(): Promise<Message<ClientEventType.CONTEXT>>;
     getCurrentContact(): Promise<Message<ClientEventType.CURRENT_CONTACT>>;
+    contactUpdated(query: ContactQuery, contact: Contact): Promise<Message<ClientEventType.CONTACT_CREATE_OR_UPDATE>>;
     getThemeMode(): Promise<Message<ClientEventType.THEME_MODE>>;
     getTheme(): Promise<Message<ClientEventType.THEME>>;
     startCall(phoneNumber: string): Promise<Message<ClientEventType.START_CALL>>;

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

@@ -19,7 +19,16 @@ export declare enum ClientEventType {
     NOT_AUTHORIZED = "xBeesNotAuthorized",
     AUTHORIZED = "xBeesAuthorized",
     CONTACTS_AUTO_SUGGEST = "xBeesContactsAutoSuggest",
-    CONTACT_LOOKUP_AND_MATCH = "xBeesContactLookupAndMatch"
+    CONTACT_LOOKUP_AND_MATCH = "xBeesContactLookupAndMatch",
+    CONTACT_CREATE_OR_UPDATE = "xBeesContactCreateOrUpdate"
+}
+export declare enum DeprecatedUrlParams {
+    TOKEN = "token",
+    ID = "iframeId",
+    VARIANT = "variant",
+    USER = "u",
+    REFERRER = "referrer",
+    AUTHORIZE = "authorize"
 }
 export declare enum UrlParams {
     TOKEN = "t",

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

@@ -19,16 +19,8 @@ export type Contact = (ContactShape & {
     phone: string;
 });
 export type ContactQuery = {
-    id?: string;
-    email: string;
-    phone?: string;
-} | {
     id?: string;
     email?: string;
-    phone: string;
-} | {
-    id: string;
-    email?: string;
     phone?: string;
 };
 export interface IPayloadViewPort {
@@ -65,7 +57,7 @@ export interface IPayloadContactResult {
 }
 export interface IPayloadContextResult extends IPayloadContactResult {
 }
-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 ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : 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 EventType.PBX_TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
+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 ? IPayloadContactMatchResult : T extends ClientEventType.CONTACT_CREATE_OR_UPDATE ? IPayloadContactMatchResult : T extends ClientEventType.CONTEXT ? IPayloadContextResult : 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 EventType.PBX_TOKEN ? string : T extends ClientEventType.TO_CLIPBOARD ? string : never;
 export type Message<T extends MessageType = MessageType> = {
     type: T;
     payload?: EventPayload<T>;
@@ -98,7 +90,8 @@ export interface Listener<T extends EventType = EventType> {
     eventName: T;
     callback: Callback<T>;
 }
-export type WorkVariants = 'ui' | 'no-ui' | 'd';
+type DeprecatedWorkVariants = 'info-frame' | 'daemon' | 'dialog';
+export type WorkVariants = 'ui' | 'no-ui' | 'd' | DeprecatedWorkVariants;
 export interface PostMessageController {
     sendAsync<T extends MessageType>(data: MessageIFrameResponse<T>): Promise<ResponseMessage<T>>;
 }
@@ -137,6 +130,9 @@ export interface ConnectClient {
     /**
      * Retrieves current opened in x-bees contact data */
     getCurrentContact: () => Promise<Message<ClientEventType.CURRENT_CONTACT>>;
+    /**
+     * Sends notification to x-bees about contact data updated */
+    contactUpdated(query: ContactQuery, contact: Contact): Promise<Message<ClientEventType.CONTACT_CREATE_OR_UPDATE>>;
     /**
      * Retrieves current theme mode (light or dark) */
     getThemeMode: () => Promise<Message<ClientEventType.THEME_MODE>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wildix/xbees-connect",
-  "version": "1.0.6-alpha.9",
+  "version": "1.1.0-alpha.0",
   "description": "This library provides easy communication between x-bees and integrated web applications",
   "author": "dimitri.chernykh <dimitri.chernykh@wildix.com>",
   "homepage": "",
@@ -11,6 +11,7 @@
   "module": "./dist-es/index.js",
   "type": "module",
   "scripts": {
+    "build": "yarn clean && yarn build:es && yarn build:types",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
     "build:docs": "typedoc",
@@ -41,5 +42,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "b236e9266bc7d907e8423a1138b29dd7febf31ca"
+  "gitHead": "9d4812edf4f972f695efbda9dfaebed3a5a6af1f"
 }