@blotoutio/edgetag-sdk-browser 0.6.9 → 0.7.1

package/README.md

@@ -1,3 +1,3 @@
 # EdgeTag SDK Browser
 
-More info on https://app.edgetag.io/integration/js
+More info on https://app.edgetag.io/docs/js

package/index.js

@@ -38,132 +38,6 @@
         });
     }
 
-    const tagStorage = 'edgeTag';
-    const consentKey = 'consent';
-    const keyPrefix = `_worker`;
-
-    const initKey = `${keyPrefix}Store`;
-    const getCookieValue = (key) => {
-        if (!document || !document.cookie) {
-            return '';
-        }
-        const name = `${key}=`;
-        const decodedCookie = decodeURIComponent(document.cookie);
-        const ca = decodedCookie.split(';');
-        for (let i = 0; i < ca.length; i++) {
-            let c = ca[i];
-            while (c.charAt(0) === ' ') {
-                c = c.substring(1);
-            }
-            if (c.indexOf(name) === 0) {
-                return c.substring(name.length, c.length);
-            }
-        }
-        return '';
-    };
-    const saveDataPerKey = (persistType, provider, value, key) => {
-        const storage = getData$1(persistType);
-        if (!storage['data']) {
-            storage['data'] = {};
-        }
-        if (!storage['data'][provider]) {
-            storage['data'][provider] = {};
-        }
-        storage['data'][provider][key] = value;
-        saveData(persistType, storage);
-    };
-    const savePerKey = (persistType, provider, value, key) => {
-        const storage = getData$1(persistType);
-        if (!storage[provider]) {
-            storage[provider] = {};
-        }
-        storage[provider][key] = value;
-        saveData(persistType, storage);
-    };
-    const getDataPerKey = (persistType, provider, key) => {
-        const storage = getData$1(persistType);
-        if (!storage[provider]) {
-            return undefined;
-        }
-        return storage[provider][key];
-    };
-    const saveData = (persistType, value, key = initKey) => {
-        if (persistType === 'session') {
-            saveSession(value, key);
-            return;
-        }
-        saveLocal(value, key);
-    };
-    const getData$1 = (persistType, key = initKey) => {
-        if (persistType === 'session') {
-            return getSession(key);
-        }
-        return getLocal(key);
-    };
-    const saveKV = (data) => {
-        let currentSession = getData$1('session');
-        if (!currentSession) {
-            currentSession = {};
-        }
-        if (!currentSession['kv']) {
-            currentSession['kv'] = {};
-        }
-        currentSession['kv'] = Object.assign(Object.assign({}, currentSession['kv']), data);
-        saveData('session', currentSession);
-    };
-    const saveLocal = (value, key) => {
-        try {
-            if (!localStorage) {
-                return;
-            }
-            localStorage.setItem(key, JSON.stringify(value));
-        }
-        catch (_a) {
-            console.log('Local storage not supported');
-        }
-    };
-    const getLocal = (key) => {
-        try {
-            if (!localStorage) {
-                return {};
-            }
-            const data = localStorage.getItem(key);
-            if (!data) {
-                return {};
-            }
-            return JSON.parse(data) || {};
-        }
-        catch (_a) {
-            return {};
-        }
-    };
-    const saveSession = (value, key) => {
-        try {
-            if (!sessionStorage) {
-                return;
-            }
-            sessionStorage.setItem(key, JSON.stringify(value));
-        }
-        catch (_a) {
-            console.log('Session storage not supported');
-        }
-    };
-    const getSession = (key) => {
-        try {
-            if (!sessionStorage) {
-                return {};
-            }
-            const data = sessionStorage.getItem(key);
-            if (!data) {
-                return {};
-            }
-            return JSON.parse(data) || {};
-        }
-        catch (_a) {
-            return {};
-        }
-    };
-
     let endpointUrl = '';
     const generateUrl = (path) => {
         const endpoint = getUrl();
@@ -224,13 +98,18 @@
             }
             providersPackages[provider.name] = provider;
         });
-        if (window && Array.isArray(window.edgetagProviders)) {
-            window.edgetagProviders.forEach((provider) => {
-                if (!provider.name) {
-                    return;
-                }
-                providersPackages[provider.name] = provider;
-            });
+        try {
+            if (window && Array.isArray(window.edgetagProviders)) {
+                window.edgetagProviders.forEach((provider) => {
+                    if (!provider.name) {
+                        return;
+                    }
+                    providersPackages[provider.name] = provider;
+                });
+            }
+        }
+        catch (_b) {
+            // do nothing
         }
         setUrl(preferences.edgeURL);
         return true;
@@ -246,44 +125,75 @@
         allowedProvider = providers;
     };
 
-    const getUserAgent = () => {
-        const nav = navigator;
-        let ua = nav.userAgent;
-        ua += nav.brave ? `${ua} Brave` : '';
-        return ua;
-    };
-    const allowTag = (providers) => {
-        if (!allowProviders(providers)) {
-            return false;
-        }
-        const consent = getDataPerKey('local', tagStorage, consentKey);
+    const checkConsent = (providers) => {
         if (isConsentDisabled()) {
             return true;
         }
+        const consent = getConsent();
         if (!consent) {
             return false;
         }
-        if (consent['all']) {
-            return true;
+        const consentLength = Object.keys(consent).length;
+        if (!consentLength || (consentLength === 1 && consent['all'] === false)) {
+            return false;
         }
-        if (!providers) {
+        const providersLength = Object.keys(providers || {}).length;
+        if (!providers ||
+            providersLength === 0 ||
+            (providersLength === 1 && providers['all'])) {
             return (Object.values(consent).find((isAllowed) => isAllowed) || false);
         }
-        const allProviders = getAllowedProviders();
-        for (const provider of allProviders) {
-            const tagProviderSetting = providers[provider];
-            if (tagProviderSetting ||
-                (providers['all'] === true && tagProviderSetting === undefined) ||
-                (providers['all'] === false && tagProviderSetting === true)) {
-                if (consent[provider]) {
+        for (const [key, value] of Object.entries(providers)) {
+            if (value === false || consent[key] === false) {
+                continue;
+            }
+            // we have consent
+            if (consent[key] ||
+                (consent['all'] === true && consent[key] === undefined)) {
+                // we have provider
+                if (value || (providers['all'] && providers[key] === undefined)) {
                     return true;
                 }
             }
         }
         return false;
     };
+    const getUserAgent = () => {
+        try {
+            const nav = navigator;
+            let ua = nav.userAgent;
+            ua += nav.brave ? `${ua} Brave` : '';
+            return ua;
+        }
+        catch (_a) {
+            return '';
+        }
+    };
+    const isProviderIncluded = (providers, providerValue) => {
+        return (providerValue || (providers['all'] === true && providerValue === undefined));
+    };
+    const allowTag = (providers) => {
+        if (!checkConsent(providers)) {
+            return false;
+        }
+        const providersLength = Object.values(providers || {}).length;
+        if (!providers || providersLength === 0) {
+            return true;
+        }
+        const allProviders = getAllowedProviders();
+        const allProvidersLength = Object.keys(allProviders || {}).length;
+        if (allProvidersLength === 0) {
+            return true;
+        }
+        for (const provider of allProviders) {
+            if (isProviderIncluded(providers, providers[provider])) {
+                return true;
+            }
+        }
+        return false;
+    };
     const allowProviders = (providers) => {
-        if (!providers || Object.keys(providers).length === 0) {
+        if (!providers || Object.keys(providers).length === 0 || providers['all']) {
             return true;
         }
         const allowedProvider = getAllowedProviders();
@@ -315,41 +225,223 @@
         if (!allowProvider(providerId)) {
             return false;
         }
+        if (!checkConsent(providers)) {
+            return false;
+        }
         if (providers && Object.keys(providers).length) {
-            const tagProvider = providers[providerId];
-            if (!(tagProvider ||
-                (providers['all'] === true && tagProvider === undefined) ||
-                (providers['all'] === false && tagProvider === true))) {
+            if (!isProviderIncluded(providers, providers[providerId])) {
                 return false;
             }
         }
-        const consent = getDataPerKey('local', tagStorage, consentKey);
-        if (isConsentDisabled()) {
-            return true;
+        return true;
+    };
+
+    const tagStorage = 'edgeTag';
+    const consentKey = 'consent';
+    const keyPrefix = `_worker`;
+
+    const initKey = `${keyPrefix}Store`;
+    const getCookieValue = (key) => {
+        try {
+            if (!document || !document.cookie) {
+                return '';
+            }
+            const name = `${key}=`;
+            const decodedCookie = decodeURIComponent(document.cookie);
+            const ca = decodedCookie.split(';');
+            for (let i = 0; i < ca.length; i++) {
+                let c = ca[i];
+                while (c.charAt(0) === ' ') {
+                    c = c.substring(1);
+                }
+                if (c.indexOf(name) === 0) {
+                    return c.substring(name.length, c.length);
+                }
+            }
+            return '';
         }
-        if (!consent) {
-            return false;
+        catch (_a) {
+            return '';
         }
-        if (consent['all']) {
-            return true;
+    };
+    const saveDataPerKey = (persistType, provider, value, key) => {
+        const storage = getData$1(persistType);
+        if (!storage['data']) {
+            storage['data'] = {};
+        }
+        if (!storage['data'][provider]) {
+            storage['data'][provider] = {};
+        }
+        storage['data'][provider][key] = value;
+        saveData(persistType, storage);
+    };
+    const savePerKey = (persistType, provider, value, key) => {
+        const storage = getData$1(persistType);
+        if (!storage[provider]) {
+            storage[provider] = {};
+        }
+        storage[provider][key] = value;
+        saveData(persistType, storage);
+    };
+    const getDataPerKey = (persistType, provider, key) => {
+        const storage = getData$1(persistType);
+        if (!storage[provider]) {
+            return undefined;
+        }
+        return storage[provider][key];
+    };
+    const saveData = (persistType, value, key = initKey) => {
+        if (persistType === 'session') {
+            saveSession(value, key);
+            return;
         }
-        return consent[providerId];
+        saveLocal(value, key);
+    };
+    const getData$1 = (persistType, key = initKey) => {
+        if (persistType === 'session') {
+            return getSession(key);
+        }
+        return getLocal(key);
+    };
+    const saveKV = (data) => {
+        let currentSession = getData$1('session');
+        if (!currentSession) {
+            currentSession = {};
+        }
+        if (!currentSession['kv']) {
+            currentSession['kv'] = {};
+        }
+        currentSession['kv'] = Object.assign(Object.assign({}, currentSession['kv']), data);
+        saveData('session', currentSession);
+    };
+    const saveLocal = (value, key) => {
+        try {
+            if (!localStorage) {
+                return;
+            }
+            localStorage.setItem(key, JSON.stringify(value));
+        }
+        catch (_a) {
+            console.log('Local storage not supported');
+        }
+    };
+    const getLocal = (key) => {
+        try {
+            if (!localStorage) {
+                return {};
+            }
+            const data = localStorage.getItem(key);
+            if (!data) {
+                return {};
+            }
+            return JSON.parse(data) || {};
+        }
+        catch (_a) {
+            return {};
+        }
+    };
+    const saveSession = (value, key) => {
+        try {
+            if (!sessionStorage) {
+                return;
+            }
+            sessionStorage.setItem(key, JSON.stringify(value));
+        }
+        catch (_a) {
+            console.log('Session storage not supported');
+        }
+    };
+    const getSession = (key) => {
+        try {
+            if (!sessionStorage) {
+                return {};
+            }
+            const data = sessionStorage.getItem(key);
+            if (!data) {
+                return {};
+            }
+            return JSON.parse(data) || {};
+        }
+        catch (_a) {
+            return {};
+        }
+    };
+
+    let initUserId = '';
+    const handleGetUserId = () => {
+        if (initUserId) {
+            return initUserId;
+        }
+        return getCookieValue('tag_user_id');
+    };
+    const setUserId = (userId) => {
+        initUserId = userId;
     };
 
+    const getHeaders = () => ({
+        'Content-type': 'application/json; charset=utf-8',
+        Accept: 'application/json; charset=utf-8',
+        EdgeTagUserId: handleGetUserId(),
+    });
     const beacon = (url, payload) => {
-        let blob;
-        if (payload) {
-            blob = new Blob([JSON.stringify(payload)], { type: 'application/json' });
+        try {
+            let blob;
+            if (payload) {
+                blob = new Blob([JSON.stringify(payload)], { type: 'application/json' });
+            }
+            return navigator.sendBeacon(url, blob);
+        }
+        catch (e) {
+            console.log('Beacon not supported.');
+            return Promise.reject(new Error('Beacon not supported'));
         }
-        return navigator.sendBeacon(url, blob);
     };
+    const fallbackAjax = (method, url, payload) => __awaiter(void 0, void 0, void 0, function* () {
+        const https = yield import('https');
+        const options = {
+            method,
+            headers: getHeaders(),
+        };
+        return new Promise((resolve, reject) => {
+            const req = https.request(url, options, (res) => {
+                res.on('data', (data) => {
+                    try {
+                        data = JSON.parse(data);
+                    }
+                    catch (_a) {
+                        // do nothing
+                    }
+                    resolve({
+                        body: data,
+                        status: res.statusCode || 500,
+                    });
+                });
+            });
+            req.on('error', (e) => {
+                reject(new Error(e.message));
+            });
+            if (payload && method !== 'GET') {
+                req.write(JSON.stringify(payload));
+            }
+            req.end();
+        });
+    });
     const ajax = (method, url, payload) => __awaiter(void 0, void 0, void 0, function* () {
+        if (typeof fetch === 'undefined') {
+            return yield fallbackAjax(method, url, payload)
+                .then((data) => {
+                if (data.status < 200 || data.status >= 300) {
+                    return Promise.reject(new Error(JSON.stringify(data.body)));
+                }
+                return Promise.resolve(data.body);
+            })
+                .catch((error) => {
+                return Promise.reject(new Error(error));
+            });
+        }
         return yield fetch(url, {
             method,
-            headers: {
-                'Content-type': 'application/json; charset=utf-8',
-                Accept: 'application/json; charset=utf-8',
-            },
+            headers: getHeaders(),
             body: JSON.stringify(payload),
             credentials: 'include',
         })
@@ -367,7 +459,14 @@
         });
     });
     const getStandardPayload = (payload) => {
-        const data = Object.assign({ pageUrl: window.location.href, userAgent: getUserAgent() }, (payload || {}));
+        let pageUrl;
+        try {
+            pageUrl = window.location.href;
+        }
+        catch (_a) {
+            pageUrl = '';
+        }
+        const data = Object.assign({ pageUrl, userAgent: getUserAgent() }, (payload || {}));
         let storage = {};
         const session = getData$1('session');
         if (session) {
@@ -409,7 +508,9 @@
     const info = (data) => {
     };
 
+    let memoryConsent;
     const saveConsent = (consent) => {
+        setConsent(consent);
         savePerKey('local', tagStorage, consent, consentKey);
     };
     const handleConsent = (consent) => {
@@ -419,6 +520,16 @@
         saveConsent(consent);
         postRequest(getConsentURL(), payload).catch(info);
     };
+    const setConsent = (newConsent) => {
+        memoryConsent = newConsent;
+    };
+    const getConsent = () => {
+        const storageConsent = getDataPerKey('local', tagStorage, consentKey);
+        if (storageConsent) {
+            return storageConsent;
+        }
+        return memoryConsent;
+    };
 
     // Unique ID creation requires a high quality random # generator. In the browser we therefore
     // require the crypto API and do not support built-in fallback to lower quality random number
@@ -900,6 +1011,12 @@
 
     v35('v5', 0x50, sha1);
 
+    const encodeString = (name) => {
+        if (typeof btoa === 'undefined') {
+            return Buffer.from(name).toString('base64');
+        }
+        return btoa(name);
+    };
     const generateEventId = (name) => {
         let time = Date.now().toString();
         if (typeof performance !== 'undefined' &&
@@ -909,11 +1026,7 @@
                 time = perf.toFixed(4);
             }
         }
-        return `${btoa(name)}-${v4()}-${time}`;
-    };
-
-    const handleGetUserId = () => {
-        return getCookieValue('tag_user_id');
+        return `${encodeString(name)}-${v4()}-${time}`;
     };
 
     const manifestVariables = {};
@@ -934,6 +1047,7 @@
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore
             stubs.forEach((stub) => api$1[stub.name](...(stub.arguments || [])));
+            stubs = [];
         }
         catch (e) {
             console.error(e);
@@ -942,6 +1056,7 @@
 
     const sendTag = ({ eventName, eventId, data, providerData, providers, options, }) => {
         if (!allowProviders(providers)) {
+            console.log('Provider is not allowed.');
             return;
         }
         const payload = {
@@ -964,6 +1079,10 @@
             });
             return;
         }
+        if (!allowProviders(providers)) {
+            console.log('Provider is not allowed.');
+            return;
+        }
         if (!allowTag(providers)) {
             console.log('No consent');
             return;
@@ -1028,7 +1147,12 @@
         handleData({ [`${provider}::${key}`]: value });
     };
     const handleCaptureQuery = (provider, key, persistType) => {
-        if (!window) {
+        try {
+            if (!window) {
+                return;
+            }
+        }
+        catch (_a) {
             return;
         }
         const params = new URLSearchParams(window.location.search);
@@ -1130,6 +1254,7 @@
             saveConsent({ all: true });
         }
         if (preferences.userId) {
+            setUserId(preferences.userId);
             url.searchParams.set('userId', preferences.userId);
         }
         getRequest(url.href)
@@ -1232,6 +1357,10 @@
       keys(callback) {
         keys(callback);
       }
+
+      getUserId() {
+        return getUserId()
+      }
     }
 
     var api = new API();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/edgetag-sdk-browser",
-  "version": "0.6.9",
+  "version": "0.7.1",
   "description": "Browser SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",