@blotoutio/edgetag-sdk-js 0.35.3 → 0.36.0

package/index.cjs.js

@@ -335,7 +335,7 @@ const getStandardPayload = (payload) => {
         referrer: getReferrer(),
         search: getSearch(),
         locale: getLocale(),
-        sdkVersion: "0.35.3" ,
+        sdkVersion: "0.36.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -422,31 +422,6 @@ const getKeysURL = () => {
     return generateUrl(`/keys`);
 };
 
-let memoryConsent;
-const saveConsent = (consent) => {
-    setConsent(consent);
-    savePerKey('local', tagStorage, consent, consentKey);
-};
-const handleConsent = (consent, options) => {
-    const payload = {
-        consentString: consent,
-    };
-    saveConsent(consent);
-    if (!(options === null || options === void 0 ? void 0 : options.localSave)) {
-        postRequest(getConsentURL(), payload).catch(error);
-    }
-};
-const setConsent = (newConsent) => {
-    memoryConsent = newConsent;
-};
-const getConsent$1 = () => {
-    const storageConsent = getDataPerKey('local', tagStorage, consentKey);
-    if (storageConsent) {
-        return storageConsent;
-    }
-    return memoryConsent;
-};
-
 const isBool = (v) => typeof v == 'boolean';
 const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
 /**
@@ -474,6 +449,25 @@ const hasUserConsent = (consent, provider, tagName) => {
     }
     return allowed;
 };
+/**
+ * This function validates user consent for a given provider type, not based on tagName.
+ */
+const hasUserConsentForProvider = (consent, provider) => {
+    if (!isRecord(consent)) {
+        return false;
+    }
+    let allowed = isBool(consent.all) ? consent.all : false;
+    if (provider in consent) {
+        const providerSpecific = consent[provider];
+        if (isBool(providerSpecific)) {
+            allowed = providerSpecific;
+        }
+        else if (isRecord(providerSpecific)) {
+            return Object.keys(providerSpecific).some((instance) => providerSpecific[instance] === true);
+        }
+    }
+    return allowed;
+};
 /**
  * This function validates provider allowance for a given provider and tag name.
  * It should not be used to validate `UserConsent`.
@@ -673,6 +667,18 @@ const hasAllowedManifestTags = (tags, consent, providersConfig) => {
     return false;
 };
 
+const handleGetData = (keys, callback) => {
+    if (!keys || keys.length === 0) {
+        error('Provide keys for get data API.');
+        return;
+    }
+    getRequest(getGetDataURL(keys))
+        .then((result) => {
+        callback((result === null || result === void 0 ? void 0 : result.result) || {});
+    })
+        .catch(error);
+};
+
 const handleData = (data, providers, options) => {
     if (!data || Object.keys(data).length === 0) {
         error('Provide data for data API.');
@@ -711,7 +717,72 @@ const handleData = (data, providers, options) => {
     postRequest(getDataURL(), { data, providers }, options).catch(error);
 };
 
+let memoryConsent;
+const saveConsent = (consent) => {
+    setConsent(consent);
+    savePerKey('local', tagStorage, consent, consentKey);
+};
+const handleConsent = (consent, options) => {
+    const payload = {
+        consentString: consent,
+    };
+    saveConsent(consent);
+    if (!(options === null || options === void 0 ? void 0 : options.localSave)) {
+        postRequest(getConsentURL(), payload).catch(error);
+    }
+    const userId = handleGetUserId();
+    const providerPackages = getProvidersPackage();
+    const executionContext = new Map();
+    /* Calling Init for all provider instances based on consent check */
+    for (const pkg of Object.values(providerPackages)) {
+        if (!pkg || !pkg.name || !pkg.init) {
+            continue;
+        }
+        const variables = getProviderVariables(pkg.name);
+        const providerVariables = Object.entries(variables);
+        for (const [tagName, variablesSet] of providerVariables) {
+            const hasConsent = hasUserConsent(consent, pkg.name, tagName);
+            if (!hasConsent) {
+                continue;
+            }
+            pkg.init({
+                userId,
+                manifest: {
+                    tagName,
+                    variables: variablesSet,
+                    package: pkg.name,
+                },
+                sendTag,
+                sendEdgeData: handleData,
+                getEdgeData: handleGetData,
+                keyName: `${keyPrefix}Store`,
+                executionContext,
+            });
+        }
+    }
+    /* Calling Consent for all providers, not on instance level */
+    for (const pkg of Object.values(providerPackages)) {
+        if (!pkg || !pkg.name || !pkg.consent) {
+            continue;
+        }
+        /* Returns True if any one instance of given provider has consent */
+        const hasConsent = hasUserConsentForProvider(consent, pkg.name);
+        pkg.consent({ hasConsent });
+    }
+};
+const setConsent = (newConsent) => {
+    memoryConsent = newConsent;
+};
+const getConsent$1 = () => {
+    const storageConsent = getDataPerKey('local', tagStorage, consentKey);
+    if (storageConsent) {
+        return storageConsent;
+    }
+    return memoryConsent;
+};
+
 const cacheKey = `${keyPrefix}Cache`;
+const identity = (v) => v;
 const saveDataToEdge = (key, value, provider) => {
     if (!value) {
         return;
@@ -727,7 +798,7 @@ const saveDataToEdge = (key, value, provider) => {
     }
     handleData({ [`${provider}::${key}`]: value });
 };
-const handleCaptureQuery = (provider, key, persistType) => {
+const handleCaptureQuery = (provider, key, persistType, map) => {
     try {
         if (!window) {
             return;
@@ -740,7 +811,7 @@ const handleCaptureQuery = (provider, key, persistType) => {
     if (!params || !params.get(key)) {
         return;
     }
-    const data = params.get(key);
+    const data = (map !== null && map !== void 0 ? map : identity)(params.get(key));
     if (!data) {
         return;
     }
@@ -765,20 +836,20 @@ const saveToCache = (persistType, provider, key, value) => {
     }
     saveData(persistType === 'edge' ? 'local' : persistType, cache, cacheKey);
 };
-const handleCaptureStorage = (provider, key, persistType, location) => {
+const handleCaptureStorage = (provider, key, persistType, location, map) => {
     let data;
     try {
         switch (location) {
             case 'cookie': {
-                data = getCookieValue(key);
+                data = (map !== null && map !== void 0 ? map : identity)(getCookieValue(key));
                 break;
             }
             case 'local': {
-                data = localStorage.getItem(key);
+                data = (map !== null && map !== void 0 ? map : identity)(localStorage.getItem(key));
                 break;
             }
             case 'session': {
-                data = sessionStorage.getItem(key);
+                data = (map !== null && map !== void 0 ? map : identity)(sessionStorage.getItem(key));
             }
         }
     }
@@ -797,51 +868,42 @@ const handleCaptureStorage = (provider, key, persistType, location) => {
     }
     saveDataPerKey(persistType, provider, data, key);
 };
-const handleCapture = (provider, params) => {
+const handleCapture = (provider, params, capture) => {
     params.forEach((param) => {
         switch (param.type) {
             case 'query': {
-                handleCaptureQuery(provider, param.key, param.persist);
+                handleCaptureQuery(provider, param.key, param.persist, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
                 break;
             }
             case 'storage': {
-                handleCaptureStorage(provider, param.key, param.persist, param.location);
+                handleCaptureStorage(provider, param.key, param.persist, param.location, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
                 break;
             }
         }
     });
 };
 
-const handleGetData = (keys, callback) => {
-    if (!keys || keys.length === 0) {
-        error('Provide keys for get data API.');
-        return;
-    }
-    getRequest(getGetDataURL(keys))
-        .then((result) => {
-        callback((result === null || result === void 0 ? void 0 : result.result) || {});
-    })
-        .catch(error);
-};
-
-const handleManifest = (manifest) => {
+const handleManifest = (manifest, consent) => {
     const providerPackages = getProvidersPackage();
     const userId = handleGetUserId();
+    const executionContext = new Map();
     manifest.forEach((provider) => {
         addConfiguredTag(provider.package, provider.tagName);
         addProviderVariable(provider.package, provider.variables, provider.tagName);
+        const pkg = providerPackages[provider.package];
         if (provider.rules) {
             Object.entries(provider.rules).forEach(([name, recipe]) => {
                 switch (name) {
                     case 'capture': {
-                        handleCapture(provider.package, recipe);
+                        handleCapture(provider.package, recipe, pkg === null || pkg === void 0 ? void 0 : pkg.capture);
                         return;
                     }
                 }
             });
         }
-        const pkg = providerPackages[provider.package];
-        if (pkg && pkg.name && pkg.init) {
+        /* this defines if the consent is given for a specific instance of a provider */
+        const hasConsent = hasUserConsent(consent, pkg.name, provider.tagName);
+        if (pkg && pkg.name && pkg.init && hasConsent) {
             pkg.init({
                 userId,
                 manifest: provider,
@@ -849,6 +911,7 @@ const handleManifest = (manifest) => {
                 sendEdgeData: handleData,
                 getEdgeData: handleGetData,
                 keyName: `${keyPrefix}Store`,
+                executionContext,
             });
         }
     });
@@ -886,7 +949,7 @@ const handleInit = (preferences) => {
         if (result.consent && !consent) {
             saveConsent(result.consent);
         }
-        handleManifest(result.result);
+        handleManifest(result.result, consent || result.consent);
     })
         .catch(error);
 };

package/index.d.ts

@@ -1,64 +1,17 @@
-// TODO this all located in '@blotoutio/shared/utility-sdk'
-
-import { Library, ProvidersConfig } from '@blotoutio/cdn/types'
-
-type PersistType = 'local' | 'session' | 'edge'
-
-type EventOptions = {
-  method?: 'beacon'
-  sync?: boolean
-}
-
-type Data = Record<string, unknown>
-
-export type SendTag = {
-  eventName: string
-  eventId: string
-  data: Data
-  providerData?: Partial<Record<Library, Record<string, Data>>>
-  providers?: Possibly<ProvidersConfig>
-  options?: EventOptions
-}
-
-type ManifestRule = {
-  type: string
-  key: string
-  persist: PersistType
-  location?: string
-}
-
-type Manifest = {
-  package: Library
-  tagName: string
-  variables?: Record<string, string>
-  rules: Record<string, ManifestRule[]>
-}
-
-type InitParams = {
-  userId: string
-  manifest: Manifest
-  sendTag: (params: SendTag) => void
-}
-
-type TagParams = {
-  userId: string
-  eventId: string
-  eventName: string
-  data: Data
-  manifestVariables: Record<string, string>
-  sendTag: (params: SendTag) => void
-  executionContext: Map<string, unknown>
-}
-
-type ProviderInit = {
-  name?: Library
-  init?: (params: InitParams) => void
-  tag?: (params: TagParams) => unknown
-}
-
-// end TODO
-
-type UserKey =
+import { ProvidersConfig } from '@blotoutio/cdn/types'
+export {
+  InitParams,
+  TagParams,
+  ManifestRule,
+  Manifest,
+  ProviderInit,
+  SendTag,
+  Data,
+  EventOptions,
+  PersistType,
+} from '@blotoutio/shared/utility-sdk'
+
+export type UserKey =
   | 'email'
   | 'phone'
   | 'firstName'
@@ -71,9 +24,9 @@ type UserKey =
   | 'zip'
   | 'address'
 
-type Stub = { name: string; arguments: unknown[] }
+export type Stub = { name: string; arguments: unknown[] }
 
-type InitPreferences = {
+export type InitPreferences = {
   edgeURL: string
   disableConsentCheck?: boolean
   userId?: string

package/index.mjs

@@ -333,7 +333,7 @@ const getStandardPayload = (payload) => {
         referrer: getReferrer(),
         search: getSearch(),
         locale: getLocale(),
-        sdkVersion: "0.35.3" ,
+        sdkVersion: "0.36.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -420,31 +420,6 @@ const getKeysURL = () => {
     return generateUrl(`/keys`);
 };
 
-let memoryConsent;
-const saveConsent = (consent) => {
-    setConsent(consent);
-    savePerKey('local', tagStorage, consent, consentKey);
-};
-const handleConsent = (consent, options) => {
-    const payload = {
-        consentString: consent,
-    };
-    saveConsent(consent);
-    if (!(options === null || options === void 0 ? void 0 : options.localSave)) {
-        postRequest(getConsentURL(), payload).catch(error);
-    }
-};
-const setConsent = (newConsent) => {
-    memoryConsent = newConsent;
-};
-const getConsent$1 = () => {
-    const storageConsent = getDataPerKey('local', tagStorage, consentKey);
-    if (storageConsent) {
-        return storageConsent;
-    }
-    return memoryConsent;
-};
-
 const isBool = (v) => typeof v == 'boolean';
 const isRecord = (v) => !!v && typeof v == 'object' && !Array.isArray(v);
 /**
@@ -472,6 +447,25 @@ const hasUserConsent = (consent, provider, tagName) => {
     }
     return allowed;
 };
+/**
+ * This function validates user consent for a given provider type, not based on tagName.
+ */
+const hasUserConsentForProvider = (consent, provider) => {
+    if (!isRecord(consent)) {
+        return false;
+    }
+    let allowed = isBool(consent.all) ? consent.all : false;
+    if (provider in consent) {
+        const providerSpecific = consent[provider];
+        if (isBool(providerSpecific)) {
+            allowed = providerSpecific;
+        }
+        else if (isRecord(providerSpecific)) {
+            return Object.keys(providerSpecific).some((instance) => providerSpecific[instance] === true);
+        }
+    }
+    return allowed;
+};
 /**
  * This function validates provider allowance for a given provider and tag name.
  * It should not be used to validate `UserConsent`.
@@ -671,6 +665,18 @@ const hasAllowedManifestTags = (tags, consent, providersConfig) => {
     return false;
 };
 
+const handleGetData = (keys, callback) => {
+    if (!keys || keys.length === 0) {
+        error('Provide keys for get data API.');
+        return;
+    }
+    getRequest(getGetDataURL(keys))
+        .then((result) => {
+        callback((result === null || result === void 0 ? void 0 : result.result) || {});
+    })
+        .catch(error);
+};
+
 const handleData = (data, providers, options) => {
     if (!data || Object.keys(data).length === 0) {
         error('Provide data for data API.');
@@ -709,7 +715,72 @@ const handleData = (data, providers, options) => {
     postRequest(getDataURL(), { data, providers }, options).catch(error);
 };
 
+let memoryConsent;
+const saveConsent = (consent) => {
+    setConsent(consent);
+    savePerKey('local', tagStorage, consent, consentKey);
+};
+const handleConsent = (consent, options) => {
+    const payload = {
+        consentString: consent,
+    };
+    saveConsent(consent);
+    if (!(options === null || options === void 0 ? void 0 : options.localSave)) {
+        postRequest(getConsentURL(), payload).catch(error);
+    }
+    const userId = handleGetUserId();
+    const providerPackages = getProvidersPackage();
+    const executionContext = new Map();
+    /* Calling Init for all provider instances based on consent check */
+    for (const pkg of Object.values(providerPackages)) {
+        if (!pkg || !pkg.name || !pkg.init) {
+            continue;
+        }
+        const variables = getProviderVariables(pkg.name);
+        const providerVariables = Object.entries(variables);
+        for (const [tagName, variablesSet] of providerVariables) {
+            const hasConsent = hasUserConsent(consent, pkg.name, tagName);
+            if (!hasConsent) {
+                continue;
+            }
+            pkg.init({
+                userId,
+                manifest: {
+                    tagName,
+                    variables: variablesSet,
+                    package: pkg.name,
+                },
+                sendTag,
+                sendEdgeData: handleData,
+                getEdgeData: handleGetData,
+                keyName: `${keyPrefix}Store`,
+                executionContext,
+            });
+        }
+    }
+    /* Calling Consent for all providers, not on instance level */
+    for (const pkg of Object.values(providerPackages)) {
+        if (!pkg || !pkg.name || !pkg.consent) {
+            continue;
+        }
+        /* Returns True if any one instance of given provider has consent */
+        const hasConsent = hasUserConsentForProvider(consent, pkg.name);
+        pkg.consent({ hasConsent });
+    }
+};
+const setConsent = (newConsent) => {
+    memoryConsent = newConsent;
+};
+const getConsent$1 = () => {
+    const storageConsent = getDataPerKey('local', tagStorage, consentKey);
+    if (storageConsent) {
+        return storageConsent;
+    }
+    return memoryConsent;
+};
+
 const cacheKey = `${keyPrefix}Cache`;
+const identity = (v) => v;
 const saveDataToEdge = (key, value, provider) => {
     if (!value) {
         return;
@@ -725,7 +796,7 @@ const saveDataToEdge = (key, value, provider) => {
     }
     handleData({ [`${provider}::${key}`]: value });
 };
-const handleCaptureQuery = (provider, key, persistType) => {
+const handleCaptureQuery = (provider, key, persistType, map) => {
     try {
         if (!window) {
             return;
@@ -738,7 +809,7 @@ const handleCaptureQuery = (provider, key, persistType) => {
     if (!params || !params.get(key)) {
         return;
     }
-    const data = params.get(key);
+    const data = (map !== null && map !== void 0 ? map : identity)(params.get(key));
     if (!data) {
         return;
     }
@@ -763,20 +834,20 @@ const saveToCache = (persistType, provider, key, value) => {
     }
     saveData(persistType === 'edge' ? 'local' : persistType, cache, cacheKey);
 };
-const handleCaptureStorage = (provider, key, persistType, location) => {
+const handleCaptureStorage = (provider, key, persistType, location, map) => {
     let data;
     try {
         switch (location) {
             case 'cookie': {
-                data = getCookieValue(key);
+                data = (map !== null && map !== void 0 ? map : identity)(getCookieValue(key));
                 break;
             }
             case 'local': {
-                data = localStorage.getItem(key);
+                data = (map !== null && map !== void 0 ? map : identity)(localStorage.getItem(key));
                 break;
             }
             case 'session': {
-                data = sessionStorage.getItem(key);
+                data = (map !== null && map !== void 0 ? map : identity)(sessionStorage.getItem(key));
             }
         }
     }
@@ -795,51 +866,42 @@ const handleCaptureStorage = (provider, key, persistType, location) => {
     }
     saveDataPerKey(persistType, provider, data, key);
 };
-const handleCapture = (provider, params) => {
+const handleCapture = (provider, params, capture) => {
     params.forEach((param) => {
         switch (param.type) {
             case 'query': {
-                handleCaptureQuery(provider, param.key, param.persist);
+                handleCaptureQuery(provider, param.key, param.persist, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
                 break;
             }
             case 'storage': {
-                handleCaptureStorage(provider, param.key, param.persist, param.location);
+                handleCaptureStorage(provider, param.key, param.persist, param.location, capture === null || capture === void 0 ? void 0 : capture.bind(null, param));
                 break;
             }
         }
     });
 };
 
-const handleGetData = (keys, callback) => {
-    if (!keys || keys.length === 0) {
-        error('Provide keys for get data API.');
-        return;
-    }
-    getRequest(getGetDataURL(keys))
-        .then((result) => {
-        callback((result === null || result === void 0 ? void 0 : result.result) || {});
-    })
-        .catch(error);
-};
-
-const handleManifest = (manifest) => {
+const handleManifest = (manifest, consent) => {
     const providerPackages = getProvidersPackage();
     const userId = handleGetUserId();
+    const executionContext = new Map();
     manifest.forEach((provider) => {
         addConfiguredTag(provider.package, provider.tagName);
         addProviderVariable(provider.package, provider.variables, provider.tagName);
+        const pkg = providerPackages[provider.package];
         if (provider.rules) {
             Object.entries(provider.rules).forEach(([name, recipe]) => {
                 switch (name) {
                     case 'capture': {
-                        handleCapture(provider.package, recipe);
+                        handleCapture(provider.package, recipe, pkg === null || pkg === void 0 ? void 0 : pkg.capture);
                         return;
                     }
                 }
             });
         }
-        const pkg = providerPackages[provider.package];
-        if (pkg && pkg.name && pkg.init) {
+        /* this defines if the consent is given for a specific instance of a provider */
+        const hasConsent = hasUserConsent(consent, pkg.name, provider.tagName);
+        if (pkg && pkg.name && pkg.init && hasConsent) {
             pkg.init({
                 userId,
                 manifest: provider,
@@ -847,6 +909,7 @@ const handleManifest = (manifest) => {
                 sendEdgeData: handleData,
                 getEdgeData: handleGetData,
                 keyName: `${keyPrefix}Store`,
+                executionContext,
             });
         }
     });
@@ -884,7 +947,7 @@ const handleInit = (preferences) => {
         if (result.consent && !consent) {
             saveConsent(result.consent);
         }
-        handleManifest(result.result);
+        handleManifest(result.result, consent || result.consent);
     })
         .catch(error);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/edgetag-sdk-js",
-  "version": "0.35.3",
+  "version": "0.36.0",
   "description": "JS SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",