@maxzima/wa-communicator 1.0.50 → 1.0.52

package/dist/engine/Communicator/Constants/RegistrationMetadata.d.ts

@@ -0,0 +1 @@
+export declare const registrationMetadataKeys: readonly ["wa.country_code", "wa.device_type", "wa.hash", "google._gcl_aw", "google._ga", "meta._fbc", "meta._fbp", "microsoft._uetmsclkid", "microsoft._uetvid", "linkedin.li_fat_id", "appsflyer.cuid", "utm.source", "utm.medium", "utm.campaign", "utm.term"];

package/dist/engine/Communicator/Constants/RegistrationMetadata.js

@@ -0,0 +1,17 @@
+export const registrationMetadataKeys = [
+    'wa.country_code',
+    'wa.device_type',
+    'wa.hash',
+    'google._gcl_aw',
+    'google._ga',
+    'meta._fbc',
+    'meta._fbp',
+    'microsoft._uetmsclkid',
+    'microsoft._uetvid',
+    'linkedin.li_fat_id',
+    'appsflyer.cuid',
+    'utm.source',
+    'utm.medium',
+    'utm.campaign',
+    'utm.term',
+];

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

@@ -2,6 +2,7 @@ import { __awaiter } from "tslib";
 import { CommunicatorDefaultRequestData } from "./../Constants/Communicator";
 import { jsonParse } from "./../Utils/jsonParseSafe";
 import { CommunicatorAuthAPIEndpointEnum, CommunicatorFAPIEndpointEnum } from "./../Enums/CommunicatorEnum";
+import { prepareMetadata } from "./../Utils/registrationMetaData";
 export class Communicator {
     constructor(props) {
         this.getHeaders = (token) => {
@@ -204,7 +205,7 @@ export class Communicator {
     registration(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const headers = this.getHeaders(data.accessToken);
-            const body = JSON.stringify(Object.assign(Object.assign({ name: data.name }, (data.countryCode && { country_code: data.countryCode })), { source: {
+            const body = JSON.stringify(Object.assign(Object.assign(Object.assign({ name: data.name }, (data.countryCode && { country_code: data.countryCode })), { source: {
                     hash: data.hash,
                     device_type: data.deviceType,
                     ga_id: data.gaId,
@@ -215,7 +216,7 @@ export class Communicator {
                     utm_campaign: data.utmCampaign,
                     utm_term: data.utmTerm,
                     fbclid: data.fbclid,
-                } }));
+                } }), (data.metadata && { metadata: prepareMetadata(data.metadata) })));
             return yield this.send({
                 method: 'POST',
                 url: `${this.props.clientFAPIBaseUrl}${CommunicatorFAPIEndpointEnum.REGISTRATION}`,
@@ -227,7 +228,7 @@ export class Communicator {
     setStorageValues(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const headers = this.getHeaders(data.accessToken);
-            const body = JSON.stringify(Object.assign({ seo_source: data.origin }, (data.productId && { last_profile_id: data.productId })));
+            const body = JSON.stringify(Object.assign({ seo_source: data.origin }, (data.profileId && { last_profile_id: data.profileId })));
             return yield this.send({
                 method: 'POST',
                 url: `${this.props.clientFAPIBaseUrl}${CommunicatorFAPIEndpointEnum.STORAGE}`,

package/dist/engine/Communicator/Utils/registrationMetaData.d.ts

@@ -0,0 +1,2 @@
+import type { TRegistrationMetadata, TRegistrationRequestBodySourceMetadata } from "@root/types";
+export declare function prepareMetadata(obj: TRegistrationMetadata): TRegistrationRequestBodySourceMetadata[];

package/dist/engine/Communicator/Utils/registrationMetaData.js

@@ -0,0 +1,13 @@
+import { registrationMetadataKeys } from "../Constants/RegistrationMetadata";
+export function prepareMetadata(obj) {
+    const result = [];
+    for (const key of registrationMetadataKeys) {
+        if (key in obj && typeof obj[key] === 'string') {
+            result.push({
+                key,
+                value: obj[key],
+            });
+        }
+    }
+    return result;
+}

package/dist/types/TCommunicator.d.ts

@@ -1,6 +1,11 @@
+import type { TRegistrationMetadata, TRegistrationMetadataKey } from "./TRegistrationMetadata";
 type TChallenge = 'email_otp' | 'mobile_otp' | 'pin' | 'out_of_band';
 type TAuditSource = 'Backend' | 'SelfService';
 type TRegistrationRequestBodySourceDeviceType = 'mobile' | 'regular';
+export type TRegistrationRequestBodySourceMetadata = {
+    key: TRegistrationMetadataKey;
+    value: string;
+};
 type TRequestProps = {
     url?: string;
     method?: RequestInit['method'];
@@ -141,6 +146,7 @@ type TRegistrationRequestBodySource = {
     utm_campaign: string;
     utm_term: string;
     fbclid: string;
+    metadata: TRegistrationRequestBodySourceMetadata[];
 };
 type TRegistrationRequestBody = {
     name: string;
@@ -164,11 +170,12 @@ type TRegistrationRequestData = {
     utmCampaign: TRegistrationRequestBodySource['utm_campaign'];
     utmTerm: TRegistrationRequestBodySource['utm_term'];
     fbclid: TRegistrationRequestBodySource['fbclid'];
+    metadata: TRegistrationMetadata;
 };
 type TStorageRequestData = {
     accessToken: string;
     origin: string;
-    productId?: string;
+    profileId?: string;
 };
 type TGetRestrictedCountriesData = {
     entityType?: import('@root/enums').CountryTypeEnum;

package/dist/types/TRegistrationMetadata.d.ts

@@ -0,0 +1,3 @@
+import type { registrationMetadataKeys } from "@root/engine/Communicator/Constants/RegistrationMetadata";
+export type TRegistrationMetadataKey = typeof registrationMetadataKeys[number];
+export type TRegistrationMetadata = Partial<Record<TRegistrationMetadataKey, string>>;

package/dist/types/TRegistrationMetadata.js

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

package/dist/types/index.d.ts

@@ -1 +1,2 @@
+export * from "./TRegistrationMetadata";
 export * from "./TCommunicator";

package/dist/types/index.js

@@ -1 +1,2 @@
+export * from "./TRegistrationMetadata";
 export * from "./TCommunicator";

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.50",
+  "version": "1.0.52",
   "name": "@maxzima/wa-communicator",
   "description": "",
   "author": "Noname",

package/src/engine/Communicator/Constants/RegistrationMetadata.ts

@@ -0,0 +1,17 @@
+export const registrationMetadataKeys = [
+  'wa.country_code',
+  'wa.device_type',
+  'wa.hash',
+  'google._gcl_aw',
+  'google._ga',
+  'meta._fbc',
+  'meta._fbp',
+  'microsoft._uetmsclkid',
+  'microsoft._uetvid',
+  'linkedin.li_fat_id',
+  'appsflyer.cuid',
+  'utm.source',
+  'utm.medium',
+  'utm.campaign',
+  'utm.term',
+] as const;

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

@@ -31,6 +31,7 @@ import {
   CommunicatorAuthAPIEndpointEnum,
   CommunicatorFAPIEndpointEnum
 } from "./../Enums/CommunicatorEnum";
+import {prepareMetadata} from "./../Utils/registrationMetaData";
 
 export class Communicator {
   private props: TCommunicatorProps;
@@ -229,7 +230,8 @@ export class Communicator {
         utm_campaign: data.utmCampaign,
         utm_term: data.utmTerm,
         fbclid: data.fbclid,
-      }
+      },
+      ...(data.metadata && { metadata: prepareMetadata(data.metadata) }),
     });
 
     return await this.send({
@@ -244,7 +246,7 @@ export class Communicator {
     const headers = this.getHeaders(data.accessToken);
     const body = JSON.stringify({
       seo_source: data.origin,
-      ...(data.productId && { last_profile_id: data.productId })
+      ...(data.profileId && { last_profile_id: data.profileId })
     });
 
     return await this.send({

package/src/engine/Communicator/Utils/registrationMetaData.ts

@@ -0,0 +1,17 @@
+import { registrationMetadataKeys } from "../Constants/RegistrationMetadata";
+import type { TRegistrationMetadata, TRegistrationRequestBodySourceMetadata } from "@root/types";
+
+export function prepareMetadata(obj: TRegistrationMetadata): TRegistrationRequestBodySourceMetadata[] {
+  const result: TRegistrationRequestBodySourceMetadata[] = [];
+
+  for (const key of registrationMetadataKeys) {
+    if (key in obj && typeof obj[key] === 'string') {
+      result.push({
+        key,
+        value: obj[key],
+      })
+    }
+  }
+
+  return result;
+}

package/src/types/TCommunicator.ts

@@ -1,6 +1,9 @@
+import type {TRegistrationMetadata, TRegistrationMetadataKey} from "./TRegistrationMetadata";
+
 type TChallenge = 'email_otp' | 'mobile_otp' | 'pin' | 'out_of_band';
 type TAuditSource = 'Backend' | 'SelfService';
 type TRegistrationRequestBodySourceDeviceType = 'mobile' | 'regular';
+export type TRegistrationRequestBodySourceMetadata = { key: TRegistrationMetadataKey, value: string }
 
 type TRequestProps = {
   url?: string,
@@ -190,6 +193,7 @@ type TRegistrationRequestBodySource = {
   utm_campaign: string,
   utm_term: string,
   fbclid: string,
+  metadata: TRegistrationRequestBodySourceMetadata[],
 }
 
 type TRegistrationRequestBody = {
@@ -216,6 +220,7 @@ type TRegistrationRequestData = {
   utmCampaign: TRegistrationRequestBodySource['utm_campaign'],
   utmTerm: TRegistrationRequestBodySource['utm_term'],
   fbclid: TRegistrationRequestBodySource['fbclid'],
+  metadata: TRegistrationMetadata,
 }
 /* endregion registration */
 
@@ -223,7 +228,7 @@ type TRegistrationRequestData = {
 type TStorageRequestData = {
   accessToken: string,
   origin: string,
-  productId?: string,
+  profileId?: string,
 }
 /* endregion registration */
 

package/src/types/TRegistrationMetadata.ts

@@ -0,0 +1,5 @@
+import type { registrationMetadataKeys } from "@root/engine/Communicator/Constants/RegistrationMetadata";
+
+export type TRegistrationMetadataKey = typeof registrationMetadataKeys[number];
+
+export type TRegistrationMetadata = Partial<Record<TRegistrationMetadataKey, string>>;

package/src/types/index.ts

@@ -1 +1,2 @@
+export * from "./TRegistrationMetadata";
 export * from "./TCommunicator";

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

@@ -108,7 +108,7 @@ exports[`Communicator requests profileAssign 1`] = `
 
 exports[`Communicator requests registration 1`] = `
 {
-  "body": "{"name":"_companyName_","country_code":"CAN","source":{"hash":"_hash_","device_type":"mobile","ga_id":"_gaId_","origin":"_origin_","gc_id":"_gcId_","utm_source":"_utmSource_","utm_medium":"_utmMedium_","utm_campaign":"_utmCampaign_","utm_term":"_utmTerm_"}}",
+  "body": "{"name":"_companyName_","country_code":"CAN","source":{"hash":"_hash_","device_type":"mobile","ga_id":"_gaId_","origin":"_origin_","gc_id":"_gcId_","utm_source":"_utmSource_","utm_medium":"_utmMedium_","utm_campaign":"_utmCampaign_","utm_term":"_utmTerm_","fbclid":"_fbclid_"},"metadata":[{"key":"wa.country_code","value":"CAN"},{"key":"wa.device_type","value":"mobile"},{"key":"wa.hash","value":"_hash_"},{"key":"google._gcl_aw","value":"_gcl_aw_"},{"key":"google._ga","value":"_ga_"},{"key":"meta._fbc","value":"_fbc_"},{"key":"meta._fbp","value":"_fbp_"},{"key":"microsoft._uetmsclkid","value":"_uetmsclkid_"},{"key":"microsoft._uetvid","value":"_uetvid_"},{"key":"linkedin.li_fat_id","value":"_li_fat_id_"},{"key":"appsflyer.cuid","value":"_cuid_"},{"key":"utm.source","value":"_utmSource_"},{"key":"utm.medium","value":"_utmMedium_"},{"key":"utm.campaign","value":"_utmCampaign_"},{"key":"utm.term","value":"_utmTerm_"}]}",
   "headers": {
     "Accept": "application/json, text/plain, */*",
     "Authorization": "Bearer _accessToken_",
@@ -134,7 +134,7 @@ exports[`Communicator requests setStorageValues 1`] = `
 
 exports[`Communicator requests setStorageValuesWithProductId 1`] = `
 {
-  "body": "{"seo_source":"_origin_","last_profile_id":"_productId_"}",
+  "body": "{"seo_source":"_origin_","last_profile_id":"_profileId_"}",
   "headers": {
     "Accept": "application/json, text/plain, */*",
     "Authorization": "Bearer _accessToken_",

package/test/communicator.spec.ts

@@ -17,7 +17,8 @@ import {
   setStorageValuesData,
   getRestrictedCountriesData,
   getAssignedProductsData,
-  profileAssignData, setStorageValuesDataWithProductId,
+  profileAssignData,
+  setStorageValuesDataWithProfileId,
 } from "./testunits/communicator/requests";
 import {communicatorTestData} from "./testunits/communicator/general";
 
@@ -113,7 +114,7 @@ describe('Communicator requests', () => {
   });
 
   test('setStorageValuesWithProductId', async () => {
-    const setStorageValuesRequestData = await communicator.setStorageValues(setStorageValuesDataWithProductId);
+    const setStorageValuesRequestData = await communicator.setStorageValues(setStorageValuesDataWithProfileId);
     expect(setStorageValuesRequestData).toMatchSnapshot();
   });
 

package/test/testunits/communicator/general.ts

@@ -35,8 +35,26 @@ const communicatorTestData = {
   utmMedium: '_utmMedium_',
   utmCampaign: '_utmCampaign_',
   utmTerm: '_utmTerm_',
+  fbclid: '_fbclid_',
   userId: '_userId_',
-  productId: '_productId_',
+  profileId: '_profileId_',
+  metadata: {
+    'wa.country_code': 'CAN',
+    'wa.device_type': 'mobile' as TRegistrationRequestBodySourceDeviceType,
+    'wa.hash': '_hash_',
+    'google._gcl_aw': '_gcl_aw_',
+    'google._ga': '_ga_',
+    'meta._fbc': '_fbc_',
+    'meta._fbp': '_fbp_',
+    'microsoft._uetmsclkid': '_uetmsclkid_',
+    'microsoft._uetvid': '_uetvid_',
+    'linkedin.li_fat_id': '_li_fat_id_',
+    'appsflyer.cuid': '_cuid_',
+    'utm.source': '_utmSource_',
+    'utm.medium': '_utmMedium_',
+    'utm.campaign': '_utmCampaign_',
+    'utm.term': '_utmTerm_',
+  }
 };
 
 export {

package/test/testunits/communicator/requests.ts

@@ -72,6 +72,8 @@ const registrationData: TRegistrationRequestData = {
   utmMedium: communicatorTestData.utmMedium,
   utmCampaign: communicatorTestData.utmCampaign,
   utmTerm: communicatorTestData.utmTerm,
+  fbclid: communicatorTestData.fbclid,
+  metadata: communicatorTestData.metadata,
 };
 
 const setStorageValuesData: TStorageRequestData = {
@@ -79,10 +81,10 @@ const setStorageValuesData: TStorageRequestData = {
   origin: communicatorTestData.origin,
 };
 
-const setStorageValuesDataWithProductId: TStorageRequestData = {
+const setStorageValuesDataWithProfileId: TStorageRequestData = {
   accessToken: communicatorTestData.accessToken,
   origin: communicatorTestData.origin,
-  productId: communicatorTestData.productId
+  profileId: communicatorTestData.profileId
 };
 
 const getRestrictedCountriesData: TGetRestrictedCountriesData = {
@@ -109,7 +111,7 @@ export {
   getCurrentUserProfileData,
   registrationData,
   setStorageValuesData,
-  setStorageValuesDataWithProductId,
+  setStorageValuesDataWithProfileId,
   getRestrictedCountriesData,
   profileAssignData,
   getAssignedProductsData