@maxzima/wa-communicator 1.0.20 → 1.0.21

package/dist/engine/AccountTracker/Enums/AccountTrackerEnum.d.ts

@@ -1,6 +1,15 @@
+declare const enum GA4EventActionEnum {
+    VERIFY_CONTACT = "verify_contact"
+}
+declare const enum GA4EventContactEnum {
+    PHONE = "phone",
+    EMAIL = "email"
+}
 declare const enum LintrkActionTypeEnum {
     TRACK = "track"
 }
 declare const enum LintrkEventIdEnum {
+    PHONE = 8612332,
+    EMAIL = 8612340,
     REGISTRATION = 8612308
 }

package/dist/engine/AccountTracker/Public/AccountTracker.d.ts

@@ -1,6 +1,9 @@
 export declare class AccountTracker {
     private props;
     constructor(props: TAccountTrackerProps);
+    sendPhoneVerifyEvent(): void;
+    sendEmailVerifyEvent(): void;
     sendRegistrationSuccessEvent(): void;
+    private sendGA4Event;
     private sendLinkedInEvent;
 }

package/dist/engine/AccountTracker/Public/AccountTracker.js

@@ -1,5 +1,16 @@
 export class AccountTracker {
     constructor(props) {
+        this.sendGA4Event = (action, contact) => {
+            if (typeof this.props.gtag === 'undefined' || !this.props.ga4Id) {
+                return;
+            }
+            const params = {
+                contact: contact,
+                origin: this.props.origin || null,
+                send_to: this.props.ga4Id,
+            };
+            this.props.gtag('event', action, params);
+        };
         this.sendLinkedInEvent = (id) => {
             if (typeof this.props.lintrk === 'undefined') {
                 return;
@@ -10,6 +21,14 @@ export class AccountTracker {
         };
         this.props = props;
     }
+    sendPhoneVerifyEvent() {
+        this.sendGA4Event("verify_contact", "phone");
+        this.sendLinkedInEvent(8612332);
+    }
+    sendEmailVerifyEvent() {
+        this.sendGA4Event("verify_contact", "email");
+        this.sendLinkedInEvent(8612340);
+    }
     sendRegistrationSuccessEvent() {
         this.sendLinkedInEvent(8612308);
     }

package/dist/engine/AccountTracker/Types/TAccountTracker.d.ts

@@ -1,6 +1,15 @@
+/// <reference types="gtag.js" />
 declare type TLintrkOptions = {
     conversation_id: LintrkEventIdEnum;
 };
+declare type TGA4Event = {
+    contact: GA4EventContactEnum;
+    send_to: TAccountTrackerProps['ga4Id'];
+    origin?: TAccountTrackerProps['origin'];
+};
 declare type TAccountTrackerProps = {
+    origin?: string;
+    gtag?: Gtag.Gtag;
     lintrk?: (action: LintrkActionTypeEnum, options: TLintrkOptions) => void;
+    ga4Id?: string;
 };

package/dist/engine/Communicator/Public/Communicator.js

@@ -42,7 +42,8 @@ export class Communicator {
             const headers = this.getHeaders();
             const meta = this.getMeta(data.browserData);
             const body = JSON.stringify({
-                captcha_response: '_',
+                captcha_solution: '_',
+                device_id: data.deviceId,
                 meta,
                 mobile: data.phoneNumber,
             });

package/dist/types/TCommunicator.d.ts

@@ -18,7 +18,8 @@ declare type TResponse = {
     ok: boolean;
 };
 declare type TSignInStartRequestBody = {
-    captcha_response?: string;
+    captcha_solution?: string;
+    device_id: string;
     meta: TAccountMeta;
     mobile?: string;
 };
@@ -39,6 +40,7 @@ declare type TAccountBrowserData = {
 };
 declare type TSignInByMobileRequestData = {
     phoneNumber: string;
+    deviceId: string;
     browserData: TAccountBrowserData;
 };
 declare type TSignInByMobileResponse = {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.20",
+  "version": "1.0.21",
   "name": "@maxzima/wa-communicator",
   "description": "",
   "author": "Noname",
@@ -7,7 +7,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "engines": {
-    "node": ">=14"
+    "node": ">=20.11.1 <21"
   },
   "repository": {
     "type": "git",
@@ -23,7 +23,8 @@
     }
   ],
   "scripts": {
-    "prepublishOnly": "npm run test && npm run build && npm run size",
+    "postinstall": "engine-version",
+    "prepublishOnly": "engine-version && npm run test && npm run build && npm run size",
     "clean": "node tools/cleanup",
     "build": "npm run clean && run-p build:*",
     "build:esm": "tsc -p config/tsconfig.esm.json",
@@ -40,6 +41,7 @@
     "@types/jest": "28.1.8",
     "@typescript-eslint/eslint-plugin": "5.59.5",
     "@typescript-eslint/parser": "5.59.5",
+    "engine-version": "^1.0.2",
     "eslint": "8.40.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-editorconfig": "4.0.3",

package/src/engine/AccountTracker/Enums/AccountTrackerEnum.ts

@@ -1,7 +1,18 @@
+const enum GA4EventActionEnum {
+  VERIFY_CONTACT = 'verify_contact',
+}
+
+const enum GA4EventContactEnum {
+  PHONE = 'phone',
+  EMAIL = 'email',
+}
+
 const enum LintrkActionTypeEnum {
   TRACK= 'track',
 }
 
 const enum LintrkEventIdEnum {
+  PHONE = 8612332,
+  EMAIL = 8612340,
   REGISTRATION = 8612308,
 }

package/src/engine/AccountTracker/Public/AccountTracker.ts

@@ -5,10 +5,34 @@ export class AccountTracker {
     this.props = props;
   }
 
+  public sendPhoneVerifyEvent () {
+    this.sendGA4Event(GA4EventActionEnum.VERIFY_CONTACT, GA4EventContactEnum.PHONE);
+    this.sendLinkedInEvent(LintrkEventIdEnum.PHONE);
+  }
+
+  public sendEmailVerifyEvent () {
+    this.sendGA4Event(GA4EventActionEnum.VERIFY_CONTACT, GA4EventContactEnum.EMAIL);
+    this.sendLinkedInEvent(LintrkEventIdEnum.EMAIL);
+  }
+
   public sendRegistrationSuccessEvent () {
     this.sendLinkedInEvent(LintrkEventIdEnum.REGISTRATION);
   }
 
+  private sendGA4Event = (action: GA4EventActionEnum, contact: GA4EventContactEnum) => {
+    if (typeof this.props.gtag === 'undefined' || !this.props.ga4Id) {
+      return;
+    }
+
+    const params: TGA4Event = {
+      contact: contact,
+      origin: this.props.origin || null,
+      send_to: this.props.ga4Id,
+    };
+
+    this.props.gtag('event', action, params);
+  };
+
   private sendLinkedInEvent = (id: LintrkEventIdEnum) => {
     if (typeof this.props.lintrk === 'undefined') {
       return;

package/src/engine/AccountTracker/Types/TAccountTracker.ts

@@ -2,6 +2,15 @@ type TLintrkOptions = {
   conversation_id: LintrkEventIdEnum;
 }
 
+type TGA4Event = {
+  contact: GA4EventContactEnum;
+  send_to: TAccountTrackerProps['ga4Id'];
+  origin?: TAccountTrackerProps['origin'];
+}
+
 type TAccountTrackerProps = {
+  origin?: string;
+  gtag?: Gtag.Gtag;
   lintrk?: (action: LintrkActionTypeEnum, options: TLintrkOptions) => void;
+  ga4Id?: string;
 }

package/src/engine/Communicator/Public/Communicator.ts

@@ -35,7 +35,8 @@ export class Communicator {
     const headers = this.getHeaders();
     const meta = this.getMeta(data.browserData);
     const body = JSON.stringify({
-      captcha_response: '_',
+      captcha_solution: '_',
+      device_id: data.deviceId,
       meta,
       mobile: data.phoneNumber,
     } as TSignInStartRequestBody);

package/src/types/TCommunicator.ts

@@ -23,7 +23,8 @@ type TResponse = {
 
 /* region signIn */
 type TSignInStartRequestBody =  {
-  captcha_response?: string,
+  captcha_solution?: string,
+  device_id: string,
   meta: TAccountMeta,
   mobile?: string,
 }
@@ -47,6 +48,7 @@ type TAccountBrowserData = {
 
 type TSignInByMobileRequestData = {
   phoneNumber: string,
+  deviceId: string,
   browserData: TAccountBrowserData,
 }
 

package/test/__snapshots__/communicator.spec.ts.snap

@@ -125,7 +125,7 @@ Object {
 
 exports[`Communicator requests signIn 1`] = `
 Object {
-  "body": "{\\"captcha_response\\":\\"_\\",\\"meta\\":{\\"audit_source_type\\":\\"Backend\\",\\"browser_page_resolution\\":\\"800x600\\",\\"cookies_enabled\\":true,\\"ip\\":\\"127.0.0.1\\",\\"js_enabled\\":true,\\"language\\":\\"ENG\\",\\"user_agent\\":\\"_userAgent_\\"},\\"mobile\\":\\"+16234401486\\"}",
+  "body": "{\\"captcha_solution\\":\\"_\\",\\"device_id\\":\\"ov4lNmyk7armoC5DMiOpL5hl846kVQgS\\",\\"meta\\":{\\"audit_source_type\\":\\"Backend\\",\\"browser_page_resolution\\":\\"800x600\\",\\"cookies_enabled\\":true,\\"ip\\":\\"127.0.0.1\\",\\"js_enabled\\":true,\\"language\\":\\"ENG\\",\\"user_agent\\":\\"_userAgent_\\"},\\"mobile\\":\\"+16234401486\\"}",
   "headers": Object {
     "Accept": "application/json, text/plain, */*",
     "Content-Type": "application/json",

package/test/accountTracker.spec.ts

@@ -1,12 +1,14 @@
 import {AccountTracker} from "../src";
-import {registrationSuccessEvents} from "./testunits/accountTracker/events";
+import {accountTrackerInitPropsNormal} from "./testunits/accountTracker/general";
+import {emailVerifyEvents, phoneVerifyEvents, registrationSuccessEvents} from "./testunits/accountTracker/events";
 
+const mockGtag = jest.fn().mockImplementation();
 const mockLintrk = jest.fn().mockImplementation();
-
 const accountTrackerInitProps = {
+  ...accountTrackerInitPropsNormal,
+  gtag: mockGtag,
   lintrk: mockLintrk,
 };
-
 const accountTracker = new AccountTracker(accountTrackerInitProps);
 
 describe('AccountTracker', () => {
@@ -14,9 +16,35 @@ describe('AccountTracker', () => {
     jest.clearAllMocks();
   });
 
+  test('sendPhoneVerifyEvent', () => {
+    accountTracker.sendPhoneVerifyEvent();
+
+    expect(mockGtag.mock.calls[0][1]).toBe(phoneVerifyEvents.ga4.action);
+    expect(mockGtag.mock.calls[0][2]).toEqual(phoneVerifyEvents.ga4.event);
+    expect(mockGtag).toHaveBeenCalled();
+
+    expect(mockLintrk.mock.calls[0][0]).toBe(phoneVerifyEvents.linkedIn.action);
+    expect(mockLintrk.mock.calls[0][1]).toEqual(phoneVerifyEvents.linkedIn.event);
+    expect(mockLintrk).toHaveBeenCalled();
+  });
+
+  test('sendEmailVerifyEvent', () => {
+    accountTracker.sendEmailVerifyEvent();
+
+    expect(mockGtag.mock.calls[0][1]).toBe(emailVerifyEvents.ga4.action);
+    expect(mockGtag.mock.calls[0][2]).toEqual(emailVerifyEvents.ga4.event);
+    expect(mockGtag).toHaveBeenCalled();
+
+    expect(mockLintrk.mock.calls[0][0]).toBe(emailVerifyEvents.linkedIn.action);
+    expect(mockLintrk.mock.calls[0][1]).toEqual(emailVerifyEvents.linkedIn.event);
+    expect(mockLintrk).toHaveBeenCalled();
+  });
+
   test('sendRegistrationSuccessEvent', () => {
     accountTracker.sendRegistrationSuccessEvent();
 
+    expect(mockGtag).not.toHaveBeenCalled();
+
     expect(mockLintrk.mock.calls[0][0]).toBe(registrationSuccessEvents.linkedIn.action);
     expect(mockLintrk.mock.calls[0][1]).toEqual(registrationSuccessEvents.linkedIn.event);
     expect(mockLintrk).toHaveBeenCalled();

package/test/testunits/accountTracker/events.ts

@@ -1,3 +1,39 @@
+import {accountTrackerInitPropsNormal} from "./general";
+
+const phoneVerifyEvents = {
+  ga4: {
+    action: 'verify_contact',
+    event: {
+      contact: 'phone',
+      origin: accountTrackerInitPropsNormal.origin,
+      send_to: accountTrackerInitPropsNormal.ga4Id,
+    },
+  },
+  linkedIn: {
+    action: 'track',
+    event: {
+      conversation_id: 8612332,
+    },
+  },
+};
+
+const emailVerifyEvents = {
+  ga4: {
+    action: 'verify_contact',
+    event: {
+      contact: 'email',
+      origin: accountTrackerInitPropsNormal.origin,
+      send_to: accountTrackerInitPropsNormal.ga4Id,
+    },
+  },
+  linkedIn: {
+    action: 'track',
+    event: {
+      conversation_id: 8612340,
+    },
+  },
+};
+
 const registrationSuccessEvents = {
   linkedIn: {
     action: 'track',
@@ -8,5 +44,7 @@ const registrationSuccessEvents = {
 };
 
 export {
+  phoneVerifyEvents,
+  emailVerifyEvents,
   registrationSuccessEvents,
 };

package/test/testunits/accountTracker/general.ts

@@ -0,0 +1,8 @@
+const accountTrackerInitPropsNormal = {
+  origin: '_origin_',
+  ga4Id: '_ga4Id_',
+};
+
+export {
+  accountTrackerInitPropsNormal,
+};

package/test/testunits/communicator/general.ts

@@ -18,6 +18,7 @@ const communicatorTestData = {
   challenge: 'email_otp' as TChallenge,
   companyName: '_companyName_',
   deviceType: 'mobile' as TRegistrationRequestBodySourceDeviceType,
+  deviceId: 'ov4lNmyk7armoC5DMiOpL5hl846kVQgS',
   otpCode: '123456',
   countryCode: 'CAN',
   authToken: '_authToken_',

package/test/testunits/communicator/requests.ts

@@ -14,6 +14,7 @@ import {communicatorTestData} from "./general";
 import {CountryTypeEnum} from "../../../src/enums";
 
 const signInData: TSignInByMobileRequestData = {
+  deviceId: communicatorTestData.deviceId,
   phoneNumber: communicatorTestData.phoneNumber,
   browserData: communicatorTestData.browserData,
 };