@blotoutio/edgetag-sdk-js 0.33.0 → 0.35.0

package/index.cjs.js

@@ -4,6 +4,7 @@ var api = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get consent () { return consent; },
     get data () { return data; },
+    get getConsent () { return getConsent; },
     get getData () { return getData; },
     get getUserId () { return getUserId; },
     get init () { return init; },
@@ -334,7 +335,7 @@ const getStandardPayload = (payload) => {
         referrer: getReferrer(),
         search: getSearch(),
         locale: getLocale(),
-        sdkVersion: "0.33.0" ,
+        sdkVersion: "0.35.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -395,8 +396,12 @@ const setUrl = (url) => {
     }
     endpointUrl = url;
 };
-const getTagURL = () => {
-    return generateUrl('/tag');
+const getTagURL = (options) => {
+    const url = new URL(generateUrl('/tag'));
+    if (options === null || options === void 0 ? void 0 : options.sync) {
+        url.searchParams.set('sync', 'true');
+    }
+    return url.toString();
 };
 const getInitURL = () => {
     return generateUrl('/init');
@@ -434,7 +439,7 @@ const handleConsent = (consent, options) => {
 const setConsent = (newConsent) => {
     memoryConsent = newConsent;
 };
-const getConsent = () => {
+const getConsent$1 = () => {
     const storageConsent = getDataPerKey('local', tagStorage, consentKey);
     if (storageConsent) {
         return storageConsent;
@@ -592,7 +597,7 @@ const sendTag = ({ eventName, eventId, data, providerData, providers, options, }
     if (providers) {
         payload.providers = providers;
     }
-    postRequest(getTagURL(), payload, options).catch(error);
+    postRequest(getTagURL(options), payload, options).catch(error);
 };
 const handleTag = (eventName, data = {}, providers, options) => {
     if (!isInitialized()) {
@@ -610,7 +615,7 @@ const handleTag = (eventName, data = {}, providers, options) => {
     const configuredTags = getConfiguredTags();
     const userId = handleGetUserId();
     const providerData = {};
-    const consent = getConsent();
+    const consent = getConsent$1();
     for (const pkg of Object.values(providerPackages)) {
         if (!pkg || !pkg.name || !pkg.tag) {
             continue;
@@ -677,7 +682,7 @@ const handleData = (data, providers, options) => {
     const providerPackages = getProvidersPackage();
     const configuredTags = getConfiguredTags();
     const userId = handleGetUserId();
-    const consent = getConsent();
+    const consent = getConsent$1();
     for (const pkg of Object.values(providerPackages)) {
         if (!pkg || !pkg.user || !pkg.name) {
             continue;
@@ -706,6 +711,7 @@ const handleData = (data, providers, options) => {
     postRequest(getDataURL(), { data, providers }, options).catch(error);
 };
 
+const cacheKey = `${keyPrefix}Cache`;
 const saveDataToEdge = (key, value, provider) => {
     if (!value) {
         return;
@@ -744,6 +750,21 @@ const handleCaptureQuery = (provider, key, persistType) => {
     }
     saveDataPerKey(persistType, provider, data, key);
 };
+const getFromCache = (persistType, provider, key) => {
+    var _a;
+    const cache = getData$1(persistType === 'edge' ? 'local' : persistType, cacheKey);
+    return (_a = cache[provider]) === null || _a === void 0 ? void 0 : _a[key];
+};
+const saveToCache = (persistType, provider, key, value) => {
+    const cache = getData$1(persistType === 'edge' ? 'local' : persistType, cacheKey);
+    if (!cache[provider]) {
+        cache[provider] = { [key]: value };
+    }
+    else {
+        cache[provider][key] = value;
+    }
+    saveData(persistType === 'edge' ? 'local' : persistType, cache, cacheKey);
+};
 const handleCaptureStorage = (provider, key, persistType, location) => {
     let data;
     try {
@@ -764,10 +785,12 @@ const handleCaptureStorage = (provider, key, persistType, location) => {
     catch {
         return;
     }
+    const cachedValue = getFromCache(persistType, provider, key);
+    saveToCache(persistType, provider, key, data);
     if (!data) {
         return;
     }
-    if (persistType === 'edge') {
+    if (persistType === 'edge' && cachedValue !== data) {
         saveDataToEdge(key, data, provider);
         return;
     }
@@ -858,7 +881,7 @@ const handleInit = (preferences) => {
         if (result.userId) {
             setUserId(result.userId);
         }
-        const consent = getConsent();
+        const consent = getConsent$1();
         if (result.consent && !consent) {
             saveConsent(result.consent);
         }
@@ -877,7 +900,7 @@ const handleUser = (key, value, providers, options) => {
     });
     const providerPackages = getProvidersPackage();
     const configuredTags = getConfiguredTags();
-    const consent = getConsent();
+    const consent = getConsent$1();
     const userId = handleGetUserId();
     for (const pkg of Object.values(providerPackages)) {
         if (!pkg || !pkg.name || !pkg.user) {
@@ -919,6 +942,24 @@ const handleKeys = (callback) => {
         .catch(error);
 };
 
+const handleGetConsent = (callback) => {
+    getRequest(getConsentURL())
+        .then((result) => {
+        // this will try to return the consent data stored in Edge
+        return result === null || result === void 0 ? void 0 : result.result;
+    })
+        .catch(() => undefined)
+        .then((result) => {
+        const consent = result !== null && result !== void 0 ? result : getConsent$1(); // this is a default value i.e. value from local storage and memory incase Edge doesn't have consent
+        if (consent) {
+            callback(consent);
+        }
+        else {
+            callback(null, new Error('Consent not found for Current User!'));
+        }
+    });
+};
+
 const init = (preferences) => {
     handleInit(preferences);
 };
@@ -943,9 +984,13 @@ const keys = (callback) => {
 const getUserId = () => {
     return handleGetUserId();
 };
+const getConsent = (callback) => {
+    handleGetConsent(callback);
+};
 
 exports.consent = consent;
 exports.data = data;
+exports.getConsent = getConsent;
 exports.getData = getData;
 exports.getUserId = getUserId;
 exports.init = init;

package/index.d.ts

@@ -6,6 +6,7 @@ type PersistType = 'local' | 'session' | 'edge'
 
 type EventOptions = {
   method?: 'beacon'
+  sync?: boolean
 }
 
 type Data = Record<string, unknown>

package/index.mjs

@@ -2,6 +2,7 @@ var api = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get consent () { return consent; },
     get data () { return data; },
+    get getConsent () { return getConsent; },
     get getData () { return getData; },
     get getUserId () { return getUserId; },
     get init () { return init; },
@@ -332,7 +333,7 @@ const getStandardPayload = (payload) => {
         referrer: getReferrer(),
         search: getSearch(),
         locale: getLocale(),
-        sdkVersion: "0.33.0" ,
+        sdkVersion: "0.35.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -393,8 +394,12 @@ const setUrl = (url) => {
     }
     endpointUrl = url;
 };
-const getTagURL = () => {
-    return generateUrl('/tag');
+const getTagURL = (options) => {
+    const url = new URL(generateUrl('/tag'));
+    if (options === null || options === void 0 ? void 0 : options.sync) {
+        url.searchParams.set('sync', 'true');
+    }
+    return url.toString();
 };
 const getInitURL = () => {
     return generateUrl('/init');
@@ -432,7 +437,7 @@ const handleConsent = (consent, options) => {
 const setConsent = (newConsent) => {
     memoryConsent = newConsent;
 };
-const getConsent = () => {
+const getConsent$1 = () => {
     const storageConsent = getDataPerKey('local', tagStorage, consentKey);
     if (storageConsent) {
         return storageConsent;
@@ -590,7 +595,7 @@ const sendTag = ({ eventName, eventId, data, providerData, providers, options, }
     if (providers) {
         payload.providers = providers;
     }
-    postRequest(getTagURL(), payload, options).catch(error);
+    postRequest(getTagURL(options), payload, options).catch(error);
 };
 const handleTag = (eventName, data = {}, providers, options) => {
     if (!isInitialized()) {
@@ -608,7 +613,7 @@ const handleTag = (eventName, data = {}, providers, options) => {
     const configuredTags = getConfiguredTags();
     const userId = handleGetUserId();
     const providerData = {};
-    const consent = getConsent();
+    const consent = getConsent$1();
     for (const pkg of Object.values(providerPackages)) {
         if (!pkg || !pkg.name || !pkg.tag) {
             continue;
@@ -675,7 +680,7 @@ const handleData = (data, providers, options) => {
     const providerPackages = getProvidersPackage();
     const configuredTags = getConfiguredTags();
     const userId = handleGetUserId();
-    const consent = getConsent();
+    const consent = getConsent$1();
     for (const pkg of Object.values(providerPackages)) {
         if (!pkg || !pkg.user || !pkg.name) {
             continue;
@@ -704,6 +709,7 @@ const handleData = (data, providers, options) => {
     postRequest(getDataURL(), { data, providers }, options).catch(error);
 };
 
+const cacheKey = `${keyPrefix}Cache`;
 const saveDataToEdge = (key, value, provider) => {
     if (!value) {
         return;
@@ -742,6 +748,21 @@ const handleCaptureQuery = (provider, key, persistType) => {
     }
     saveDataPerKey(persistType, provider, data, key);
 };
+const getFromCache = (persistType, provider, key) => {
+    var _a;
+    const cache = getData$1(persistType === 'edge' ? 'local' : persistType, cacheKey);
+    return (_a = cache[provider]) === null || _a === void 0 ? void 0 : _a[key];
+};
+const saveToCache = (persistType, provider, key, value) => {
+    const cache = getData$1(persistType === 'edge' ? 'local' : persistType, cacheKey);
+    if (!cache[provider]) {
+        cache[provider] = { [key]: value };
+    }
+    else {
+        cache[provider][key] = value;
+    }
+    saveData(persistType === 'edge' ? 'local' : persistType, cache, cacheKey);
+};
 const handleCaptureStorage = (provider, key, persistType, location) => {
     let data;
     try {
@@ -762,10 +783,12 @@ const handleCaptureStorage = (provider, key, persistType, location) => {
     catch {
         return;
     }
+    const cachedValue = getFromCache(persistType, provider, key);
+    saveToCache(persistType, provider, key, data);
     if (!data) {
         return;
     }
-    if (persistType === 'edge') {
+    if (persistType === 'edge' && cachedValue !== data) {
         saveDataToEdge(key, data, provider);
         return;
     }
@@ -856,7 +879,7 @@ const handleInit = (preferences) => {
         if (result.userId) {
             setUserId(result.userId);
         }
-        const consent = getConsent();
+        const consent = getConsent$1();
         if (result.consent && !consent) {
             saveConsent(result.consent);
         }
@@ -875,7 +898,7 @@ const handleUser = (key, value, providers, options) => {
     });
     const providerPackages = getProvidersPackage();
     const configuredTags = getConfiguredTags();
-    const consent = getConsent();
+    const consent = getConsent$1();
     const userId = handleGetUserId();
     for (const pkg of Object.values(providerPackages)) {
         if (!pkg || !pkg.name || !pkg.user) {
@@ -917,6 +940,24 @@ const handleKeys = (callback) => {
         .catch(error);
 };
 
+const handleGetConsent = (callback) => {
+    getRequest(getConsentURL())
+        .then((result) => {
+        // this will try to return the consent data stored in Edge
+        return result === null || result === void 0 ? void 0 : result.result;
+    })
+        .catch(() => undefined)
+        .then((result) => {
+        const consent = result !== null && result !== void 0 ? result : getConsent$1(); // this is a default value i.e. value from local storage and memory incase Edge doesn't have consent
+        if (consent) {
+            callback(consent);
+        }
+        else {
+            callback(null, new Error('Consent not found for Current User!'));
+        }
+    });
+};
+
 const init = (preferences) => {
     handleInit(preferences);
 };
@@ -941,5 +982,8 @@ const keys = (callback) => {
 const getUserId = () => {
     return handleGetUserId();
 };
+const getConsent = (callback) => {
+    handleGetConsent(callback);
+};
 
-export { consent, data, getData, getUserId, init, keys, tag, user };
+export { consent, data, getConsent, getData, getUserId, init, keys, tag, user };

package/package.json

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