refactor: Migrate CookieSyncManager to TypeScript (#944)

Author: alexs-mparticle

.gitignore

@@ -12,4 +12,5 @@ test/integrations/requirejs/test-requirejs-bundle.js
 browserstack.err
 local.log
 test/cross-browser-testing/CBT-tests-es5.js
-test/cross-browser-testing/CBT-tests.js
+test/cross-browser-testing/CBT-tests.js
+coverage/

src/configAPIClient.ts

@@ -13,6 +13,7 @@ import {
     FetchUploader,
     XHRUploader,
 } from './uploaders';
+import { IPixelConfiguration } from './cookieSyncManager.interfaces';
 
 export interface IKitConfigs extends IKitFilterSettings {
     name: string;
@@ -65,17 +66,6 @@ export interface IConsentRuleValue {
     hasConsented: boolean;
 }
 
-export interface IPixelConfig {
-    name: string;
-    moduleId: number;
-    esId: number;
-    isDebug: boolean;
-    isProduction: boolean;
-    settings: Dictionary;
-    frequencyCap: number;
-    pixelUrl: string;
-    redirectUrl: string;
-}
 
 export interface IConfigResponse {
     appName: string;
@@ -85,7 +75,7 @@ export interface IConfigResponse {
     secureServiceUrl: string;
     minWebviewBridgeVersion: number;
     workspaceToken: string;
-    pixelConfigs: IPixelConfig[];
+    pixelConfigs: IPixelConfiguration[];
     flags: SDKEventCustomFlags;
 }
 

src/consent.ts

@@ -38,6 +38,10 @@ export interface SDKConsentApi {
     createConsentState: (consentState?: ConsentState) => ConsentState;
     ConsentSerialization: IConsentSerialization;
     createPrivacyConsent: ICreatePrivacyConsentFunction;
+    isEnabledForUserConsent: (
+        consentRules: IConsentRules,
+        user: IMParticleUser
+    ) => boolean;
 }
 
 export interface IConsentSerialization {

src/cookieSyncManager.interfaces.ts

@@ -1,23 +1,39 @@
-import { MPID } from "@mparticle/web-sdk";
-import { Dictionary } from "./utils";
-import { IConsentRules } from "./consent";
+import { MPID } from '@mparticle/web-sdk';
+import { Dictionary } from './utils';
+import { IConsentRules } from './consent';
 
+export type CookieSyncDates = Dictionary<number>; 
+
+export interface IPixelConfiguration {
+    name?: string;
+    moduleId: number;
+    esId?: number;
+    isDebug?: boolean;
+    isProduction?: boolean;
+    settings: Dictionary<string>;
+    frequencyCap: number;
+    pixelUrl: string;
+    redirectUrl: string;
+    filteringConsentRuleValues?: IConsentRules;
+}
 export interface ICookieSyncManager {
-    attemptCookieSync: (previousMPID: MPID, mpid: MPID, mpidIsNotInCookies: boolean) => void;
+    attemptCookieSync: (
+        previousMPID: MPID,
+        mpid: MPID,
+        mpidIsNotInCookies?: boolean
+    ) => void;
     performCookieSync: (
         url: string,
-        moduleId: number,
+        moduleId: string,
         mpid: MPID,
-        cookieSyncDates: Dictionary<number>,
+        cookieSyncDates: CookieSyncDates,
         filteringConsentRuleValues: IConsentRules,
         mpidIsNotInCookies: boolean,
         requiresConsent: boolean
     ) => void;
-    replaceAmpWithAmpersand: (string: string) => string;
-    replaceMPID: (string: string, mpid: MPID) => string;
-
-    /**
-     * @deprecated replaceAmp has been deprecated, use replaceAmpersandWithAmp instead
-     */
-    replaceAmp: (string: string) => string;
-}
+    combineUrlWithRedirect: (
+        mpid: MPID,
+        pixelUrl: string,
+        redirectUrl: string
+    ) => string;
+}