npm - @blotoutio/edgetag-sdk-js - Versions diffs - 1.46.1 → 1.47.0 - Mend

@blotoutio/edgetag-sdk-js 1.46.1 → 1.47.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/index.cjs.js CHANGED Viewed

@@ -1310,7 +1310,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "1.46.1" ,
+        sdkVersion: "1.47.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -1498,8 +1498,65 @@ const sendTag = (destination, { eventName, eventId, data, providerData, provider
     }
     postRequest(getTagURL(destination, eventName, options), payload, options).catch(logger.error);
 };
-const processTag = (destination, eventName, data = {}, providers, options) => {
+const getPlugins = (destination) => {
+    var _a, _b, _c;
+    try {
+        const g = globalThis;
+        return ((_c = (_b = (_a = g.edgetag) === null || _a === void 0 ? void 0 : _a.destinations) === null || _b === void 0 ? void 0 : _b[destination]) === null || _c === void 0 ? void 0 : _c.plugins) || [];
+    }
+    catch {
+        return [];
+    }
+};
+const runPluginHook = async (plugins, hookName, baseParams) => {
     var _a, _b;
+    const payload = baseParams['payload'];
+    let currentEventName = payload['eventName'];
+    let currentData = payload['data'];
+    let skip = false;
+    for (const plugin of plugins) {
+        const hook = plugin.rules[hookName];
+        if (!hook)
+            continue;
+        try {
+            const result = await hook({
+                ...baseParams,
+                payload: {
+                    ...payload,
+                    eventName: currentEventName,
+                    data: jsonClone(currentData),
+                },
+                variables: plugin.variables || {},
+            });
+            if (result === null || result === void 0 ? void 0 : result.skipEvent) {
+                skip = true;
+                break;
+            }
+            if ((_a = result === null || result === void 0 ? void 0 : result.payload) === null || _a === void 0 ? void 0 : _a.eventName) {
+                currentEventName = result.payload.eventName;
+            }
+            if ((_b = result === null || result === void 0 ? void 0 : result.payload) === null || _b === void 0 ? void 0 : _b.data) {
+                currentData = result.payload.data;
+            }
+            if (result === null || result === void 0 ? void 0 : result.additionalEvents) {
+                for (const evt of result.additionalEvents) {
+                    handleTag(evt.eventName, evt.data, undefined, undefined);
+                }
+            }
+        }
+        catch (e) {
+            logger.error(`Plugin ${plugin.name} ${hookName} error: ${e}`);
+        }
+    }
+    return {
+        eventName: currentEventName,
+        data: currentData,
+        skip,
+    };
+};
+const processTag = async (destination, eventName, data = {}, providers, options) => {
+    var _a, _b;
+    let currentEventName = eventName;
     if (!getSetting(destination, 'initialized')) {
         addStub(destination, {
             name: 'tag',
@@ -1509,7 +1566,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
     }
     let eventId = data['eventId'];
     if (!eventId) {
-        eventId = generateEventId(eventName);
+        eventId = generateEventId(currentEventName);
     }
     const providerPackages = getSetting(destination, 'browserPackages');
     const configuredTags = getSetting(destination, 'channels');
@@ -1543,8 +1600,42 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
             // eslint-disable-next-line no-param-reassign
             providers = rulesResult.updatedProviders;
         }
+        const plugins = getPlugins(destination);
+        if (plugins.length > 0) {
+            const pluginSettings = {
+                userId,
+                sessionId,
+                geoCountry: requestCountry,
+                geoRegion: requestRegion,
+                isEURequest,
+                ip,
+                consent: consentChannel,
+                consentCategories: consentCategory,
+                userProperties,
+            };
+            const baseParams = {
+                payload: { eventName: currentEventName, data, eventId },
+                settings: pluginSettings,
+            };
+            const rootResult = await runPluginHook(plugins, 'tagRoot', baseParams);
+            if (rootResult.skip) {
+                sendTag(destination, {
+                    configuratorProcessed: true,
+                    eventName: currentEventName,
+                    eventId,
+                    data,
+                    providerData: {},
+                    providers,
+                    options,
+                });
+                return;
+            }
+            currentEventName = rootResult.eventName;
+            // eslint-disable-next-line no-param-reassign
+            data = rootResult.data;
+        }
         if (!rulesResult.skipBrowserEvent) {
-            const conversion = preparePayloadWithConversion(jsonClone(data), getSetting(destination, 'currency'));
+            const currencySettings = getSetting(destination, 'currency');
             for (const pkg of providerPackages) {
                 if (!pkg || !pkg.name || !pkg.tag) {
                     continue;
@@ -1553,6 +1644,33 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                     logger.log(`Provider ${pkg.name} is not in allow list`);
                     continue;
                 }
+                let providerEventName = currentEventName;
+                let providerData = data;
+                if (plugins.length > 0) {
+                    const channelResult = await runPluginHook(plugins, 'tagChannel', {
+                        payload: {
+                            eventName: providerEventName,
+                            data: providerData,
+                            eventId,
+                        },
+                        settings: {
+                            userId,
+                            sessionId,
+                            geoCountry: requestCountry,
+                            geoRegion: requestRegion,
+                            isEURequest,
+                            ip,
+                            consent: consentChannel,
+                            consentCategories: consentCategory,
+                            userProperties,
+                        },
+                        providerId: pkg.name,
+                    });
+                    if (channelResult.skip)
+                        continue;
+                    providerEventName = channelResult.eventName;
+                    providerData = channelResult.data;
+                }
                 const variables = getProviderVariables(destination, pkg.name);
                 const result = {};
                 const executionContext = new Map();
@@ -1569,14 +1687,42 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                         logger.log('GEO request region does not match the filter, skipping');
                         continue;
                     }
+                    let instanceEventName = providerEventName;
+                    let instanceData = providerData;
+                    if (plugins.length > 0) {
+                        const instanceResult = await runPluginHook(plugins, 'tagInstance', {
+                            payload: {
+                                eventName: instanceEventName,
+                                data: instanceData,
+                                eventId,
+                            },
+                            settings: {
+                                userId,
+                                sessionId,
+                                geoCountry: requestCountry,
+                                geoRegion: requestRegion,
+                                isEURequest,
+                                ip,
+                                consent: consentChannel,
+                                consentCategories: consentCategory,
+                                userProperties,
+                            },
+                            providerId: pkg.name,
+                        });
+                        if (instanceResult.skip)
+                            continue;
+                        instanceEventName = instanceResult.eventName;
+                        instanceData = instanceResult.data;
+                    }
+                    const conversion = preparePayloadWithConversion(jsonClone(instanceData), currencySettings);
                     const payload = ((_a = conversion === null || conversion === void 0 ? void 0 : conversion.providers) === null || _a === void 0 ? void 0 : _a.length) === 0 ||
                         ((_b = conversion === null || conversion === void 0 ? void 0 : conversion.providers) === null || _b === void 0 ? void 0 : _b.includes(pkg.name))
                         ? conversion.payload
-                        : data;
+                        : instanceData;
                     result[variable.tagName] = pkg.tag({
                         userId,
                         sessionId,
-                        eventName,
+                        eventName: instanceEventName,
                         eventId,
                         data: jsonClone(payload),
                         sendTag: sendTag.bind(null, destination),
@@ -1588,6 +1734,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                         geoRegion: requestRegion,
                         isEURequest,
                         ip,
+                        pageUrl: getPageUrl(destination),
                     });
                 }
                 providerData[pkg.name] = result;
@@ -1601,7 +1748,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
         }
         sendTag(destination, {
             configuratorProcessed: true,
-            eventName,
+            eventName: currentEventName,
             eventId,
             data,
             providerData,
@@ -1619,11 +1766,11 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
 };
 const handleTag = (eventName, data = {}, providers, options) => {
     if (options === null || options === void 0 ? void 0 : options.destination) {
-        processTag(options.destination, eventName, data, providers, options);
+        processTag(options.destination, eventName, data, providers, options).catch(logger.error);
         return;
     }
     getInstances().forEach((instance) => {
-        processTag(instance, eventName, data, providers, options);
+        processTag(instance, eventName, data, providers, options).catch(logger.error);
     });
 };
 const hasAllowedManifestTags = (tags, consent, providersConfig) => {
@@ -1788,6 +1935,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
                 geoRegion: requestRegion,
                 isEURequest,
                 ip,
+                pageUrl: getPageUrl(destination),
             });
         }
     }
@@ -2015,6 +2163,7 @@ const handleManifest = (destination, response) => {
                     geoRegion: response.geoRegion,
                     isEURequest: response.isEURequest,
                     ip: response.ip,
+                    pageUrl: getPageUrl(destination),
                 });
             }
         }

package/index.mjs CHANGED Viewed

@@ -1308,7 +1308,7 @@ const getStandardPayload = (destination, payload) => {
         referrer: getReferrer(destination),
         search: getSearch(destination),
         locale: getLocale(),
-        sdkVersion: "1.46.1" ,
+        sdkVersion: "1.47.0" ,
         ...(payload || {}),
     };
     let storage = {};
@@ -1496,8 +1496,65 @@ const sendTag = (destination, { eventName, eventId, data, providerData, provider
     }
     postRequest(getTagURL(destination, eventName, options), payload, options).catch(logger.error);
 };
-const processTag = (destination, eventName, data = {}, providers, options) => {
+const getPlugins = (destination) => {
+    var _a, _b, _c;
+    try {
+        const g = globalThis;
+        return ((_c = (_b = (_a = g.edgetag) === null || _a === void 0 ? void 0 : _a.destinations) === null || _b === void 0 ? void 0 : _b[destination]) === null || _c === void 0 ? void 0 : _c.plugins) || [];
+    }
+    catch {
+        return [];
+    }
+};
+const runPluginHook = async (plugins, hookName, baseParams) => {
     var _a, _b;
+    const payload = baseParams['payload'];
+    let currentEventName = payload['eventName'];
+    let currentData = payload['data'];
+    let skip = false;
+    for (const plugin of plugins) {
+        const hook = plugin.rules[hookName];
+        if (!hook)
+            continue;
+        try {
+            const result = await hook({
+                ...baseParams,
+                payload: {
+                    ...payload,
+                    eventName: currentEventName,
+                    data: jsonClone(currentData),
+                },
+                variables: plugin.variables || {},
+            });
+            if (result === null || result === void 0 ? void 0 : result.skipEvent) {
+                skip = true;
+                break;
+            }
+            if ((_a = result === null || result === void 0 ? void 0 : result.payload) === null || _a === void 0 ? void 0 : _a.eventName) {
+                currentEventName = result.payload.eventName;
+            }
+            if ((_b = result === null || result === void 0 ? void 0 : result.payload) === null || _b === void 0 ? void 0 : _b.data) {
+                currentData = result.payload.data;
+            }
+            if (result === null || result === void 0 ? void 0 : result.additionalEvents) {
+                for (const evt of result.additionalEvents) {
+                    handleTag(evt.eventName, evt.data, undefined, undefined);
+                }
+            }
+        }
+        catch (e) {
+            logger.error(`Plugin ${plugin.name} ${hookName} error: ${e}`);
+        }
+    }
+    return {
+        eventName: currentEventName,
+        data: currentData,
+        skip,
+    };
+};
+const processTag = async (destination, eventName, data = {}, providers, options) => {
+    var _a, _b;
+    let currentEventName = eventName;
     if (!getSetting(destination, 'initialized')) {
         addStub(destination, {
             name: 'tag',
@@ -1507,7 +1564,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
     }
     let eventId = data['eventId'];
     if (!eventId) {
-        eventId = generateEventId(eventName);
+        eventId = generateEventId(currentEventName);
     }
     const providerPackages = getSetting(destination, 'browserPackages');
     const configuredTags = getSetting(destination, 'channels');
@@ -1541,8 +1598,42 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
             // eslint-disable-next-line no-param-reassign
             providers = rulesResult.updatedProviders;
         }
+        const plugins = getPlugins(destination);
+        if (plugins.length > 0) {
+            const pluginSettings = {
+                userId,
+                sessionId,
+                geoCountry: requestCountry,
+                geoRegion: requestRegion,
+                isEURequest,
+                ip,
+                consent: consentChannel,
+                consentCategories: consentCategory,
+                userProperties,
+            };
+            const baseParams = {
+                payload: { eventName: currentEventName, data, eventId },
+                settings: pluginSettings,
+            };
+            const rootResult = await runPluginHook(plugins, 'tagRoot', baseParams);
+            if (rootResult.skip) {
+                sendTag(destination, {
+                    configuratorProcessed: true,
+                    eventName: currentEventName,
+                    eventId,
+                    data,
+                    providerData: {},
+                    providers,
+                    options,
+                });
+                return;
+            }
+            currentEventName = rootResult.eventName;
+            // eslint-disable-next-line no-param-reassign
+            data = rootResult.data;
+        }
         if (!rulesResult.skipBrowserEvent) {
-            const conversion = preparePayloadWithConversion(jsonClone(data), getSetting(destination, 'currency'));
+            const currencySettings = getSetting(destination, 'currency');
             for (const pkg of providerPackages) {
                 if (!pkg || !pkg.name || !pkg.tag) {
                     continue;
@@ -1551,6 +1642,33 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                     logger.log(`Provider ${pkg.name} is not in allow list`);
                     continue;
                 }
+                let providerEventName = currentEventName;
+                let providerData = data;
+                if (plugins.length > 0) {
+                    const channelResult = await runPluginHook(plugins, 'tagChannel', {
+                        payload: {
+                            eventName: providerEventName,
+                            data: providerData,
+                            eventId,
+                        },
+                        settings: {
+                            userId,
+                            sessionId,
+                            geoCountry: requestCountry,
+                            geoRegion: requestRegion,
+                            isEURequest,
+                            ip,
+                            consent: consentChannel,
+                            consentCategories: consentCategory,
+                            userProperties,
+                        },
+                        providerId: pkg.name,
+                    });
+                    if (channelResult.skip)
+                        continue;
+                    providerEventName = channelResult.eventName;
+                    providerData = channelResult.data;
+                }
                 const variables = getProviderVariables(destination, pkg.name);
                 const result = {};
                 const executionContext = new Map();
@@ -1567,14 +1685,42 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                         logger.log('GEO request region does not match the filter, skipping');
                         continue;
                     }
+                    let instanceEventName = providerEventName;
+                    let instanceData = providerData;
+                    if (plugins.length > 0) {
+                        const instanceResult = await runPluginHook(plugins, 'tagInstance', {
+                            payload: {
+                                eventName: instanceEventName,
+                                data: instanceData,
+                                eventId,
+                            },
+                            settings: {
+                                userId,
+                                sessionId,
+                                geoCountry: requestCountry,
+                                geoRegion: requestRegion,
+                                isEURequest,
+                                ip,
+                                consent: consentChannel,
+                                consentCategories: consentCategory,
+                                userProperties,
+                            },
+                            providerId: pkg.name,
+                        });
+                        if (instanceResult.skip)
+                            continue;
+                        instanceEventName = instanceResult.eventName;
+                        instanceData = instanceResult.data;
+                    }
+                    const conversion = preparePayloadWithConversion(jsonClone(instanceData), currencySettings);
                     const payload = ((_a = conversion === null || conversion === void 0 ? void 0 : conversion.providers) === null || _a === void 0 ? void 0 : _a.length) === 0 ||
                         ((_b = conversion === null || conversion === void 0 ? void 0 : conversion.providers) === null || _b === void 0 ? void 0 : _b.includes(pkg.name))
                         ? conversion.payload
-                        : data;
+                        : instanceData;
                     result[variable.tagName] = pkg.tag({
                         userId,
                         sessionId,
-                        eventName,
+                        eventName: instanceEventName,
                         eventId,
                         data: jsonClone(payload),
                         sendTag: sendTag.bind(null, destination),
@@ -1586,6 +1732,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
                         geoRegion: requestRegion,
                         isEURequest,
                         ip,
+                        pageUrl: getPageUrl(destination),
                     });
                 }
                 providerData[pkg.name] = result;
@@ -1599,7 +1746,7 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
         }
         sendTag(destination, {
             configuratorProcessed: true,
-            eventName,
+            eventName: currentEventName,
             eventId,
             data,
             providerData,
@@ -1617,11 +1764,11 @@ const processTag = (destination, eventName, data = {}, providers, options) => {
 };
 const handleTag = (eventName, data = {}, providers, options) => {
     if (options === null || options === void 0 ? void 0 : options.destination) {
-        processTag(options.destination, eventName, data, providers, options);
+        processTag(options.destination, eventName, data, providers, options).catch(logger.error);
         return;
     }
     getInstances().forEach((instance) => {
-        processTag(instance, eventName, data, providers, options);
+        processTag(instance, eventName, data, providers, options).catch(logger.error);
     });
 };
 const hasAllowedManifestTags = (tags, consent, providersConfig) => {
@@ -1786,6 +1933,7 @@ const processConsent = (destination, consent, consentCategories, options) => {
                 geoRegion: requestRegion,
                 isEURequest,
                 ip,
+                pageUrl: getPageUrl(destination),
             });
         }
     }
@@ -2013,6 +2161,7 @@ const handleManifest = (destination, response) => {
                     geoRegion: response.geoRegion,
                     isEURequest: response.isEURequest,
                     ip: response.ip,
+                    pageUrl: getPageUrl(destination),
                 });
             }
         }

package/package.json CHANGED Viewed

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