@snowplow/signals-browser-plugin 0.0.1 → 0.2.0

package/dist/index.umd.js

@@ -1,7 +1,7 @@
 /*!
- * Snowplow Signals Interventions SDK v0.0.1 (https://github.com/snowplow-incubator/signals-browser-plugin)
+ * Snowplow Signals Interventions SDK v0.2.0 (https://github.com/snowplow-incubator/signals-browser-plugin)
  * Copyright 2025 Snowplow Analytics Ltd
- * Licensed under BSD-3-Clause
+ * Licensed under Apache-2.0
  */
 
 (function (global, factory) {
@@ -652,15 +652,15 @@
         return cursor;
     };
     /**
-     * Given a list of rules to extract entity IDs and a Snowplow event payload, return any extracted ID results.
-     * @param targets Map of entity names to rule definitions for how to find ID values
+     * Given a list of rules to extract attribute key IDs and a Snowplow event payload, return any extracted ID results.
+     * @param targets Map of attribute key names to rule definitions for how to find ID values
      * @param pb Snowplow event
      * @returns Resulting IDs extracted from the event
      */
-    function extractEntityValues(targets, pb) {
+    function extractAttributeKeyValues(targets, pb) {
         var extracted = {};
         Object.entries(targets).forEach(function (_a) {
-            var entityName = _a[0], pointers = _a[1];
+            var attributeKeyName = _a[0], pointers = _a[1];
             pointers = Array.isArray(pointers) ? pointers : [pointers];
             for (var _i = 0, pointers_1 = pointers; _i < pointers_1.length; _i++) {
                 var pointer = pointers_1[_i];
@@ -669,7 +669,7 @@
                 }
                 var candidateId = derefJsonPointer(pointer, pb);
                 if (candidateId != null) {
-                    extracted[entityName] = String(candidateId);
+                    extracted[attributeKeyName] = String(candidateId);
                     return;
                 }
             }
@@ -678,26 +678,26 @@
     }
 
     var DEFAULT_PULL_API_PATH = '/api/v1/interventions';
-    var DEFAULT_ENTITY_TARGETS = {
+    var DEFAULT_ATTRIBUTE_KEY_TARGETS = {
         domain_userid: '/domain_userid',
         domain_sessionid: '/domain_sessionid',
-        //pageview_id: '/co/com.snowplowanalytics.snowplow/web_page/id', // not a default entity seed
-        //tab_id: '/co/com.snowplowanalytics.snowplow/browser_context/tabId', // not a default entity seed
+        //pageview_id: '/co/com.snowplowanalytics.snowplow/web_page/id', // not a default attribute key seed
+        //tab_id: '/co/com.snowplowanalytics.snowplow/browser_context/tabId', // not a default attribute key seed
     };
     var DEFAULT_CONNECTION_TIMEOUT_MS = 2500;
     /**
-     * Default `Fetcher` implementation; uses SSEs, auto updates based on observed entity IDs defined with JSON Pointers
+     * Default `Fetcher` implementation; uses SSEs, auto updates based on observed attribute key IDs defined with JSON Pointers
      */
     var InterventionFetcher = /** @class */ (function () {
         function InterventionFetcher(tracker, dispatch) {
             this.tracker = tracker;
             this.dispatch = dispatch;
-            this.entityValues = {};
+            this.attributeKeyValues = {};
             this.aborter = new AbortController();
             this.timeoutMs = DEFAULT_CONNECTION_TIMEOUT_MS;
             this.newEndpoint = false;
             this.currentParams = '';
-            this.entitySelectors = DEFAULT_ENTITY_TARGETS;
+            this.attributeKeySelectors = DEFAULT_ATTRIBUTE_KEY_TARGETS;
             // reasonable defaults even without any events observed
             var info = tracker.getDomainUserInfo();
             this.update({
@@ -706,23 +706,23 @@
             });
         }
         InterventionFetcher.prototype.configure = function (_a) {
-            var endpoint = _a.endpoint, _b = _a.apiPath, apiPath = _b === void 0 ? DEFAULT_PULL_API_PATH : _b, _c = _a.entityTargets, entityTargets = _c === void 0 ? DEFAULT_ENTITY_TARGETS : _c, _d = _a.entityIds, entityIds = _d === void 0 ? {} : _d, _e = _a.connectionTimeoutMs, connectionTimeoutMs = _e === void 0 ? DEFAULT_CONNECTION_TIMEOUT_MS : _e;
-            this.entitySelectors = Object.assign({}, this.entitySelectors, entityTargets);
+            var endpoint = _a.endpoint, _b = _a.apiPath, apiPath = _b === void 0 ? DEFAULT_PULL_API_PATH : _b, _c = _a.attributeKeyTargets, attributeKeyTargets = _c === void 0 ? DEFAULT_ATTRIBUTE_KEY_TARGETS : _c, _d = _a.attributeKeyIds, attributeKeyIds = _d === void 0 ? {} : _d, _e = _a.connectionTimeoutMs, connectionTimeoutMs = _e === void 0 ? DEFAULT_CONNECTION_TIMEOUT_MS : _e;
+            this.attributeKeySelectors = Object.assign({}, this.attributeKeySelectors, attributeKeyTargets);
             this.timeoutMs = connectionTimeoutMs;
             var prevEndpoint = this.endpoint;
             this.endpoint = "".concat(/\/\//.test(endpoint) ? endpoint : 'https://' + endpoint).concat(apiPath);
             this.newEndpoint = prevEndpoint != this.endpoint;
-            this.update(undefined, entityIds);
+            this.update(undefined, attributeKeyIds);
         };
-        InterventionFetcher.prototype.update = function (payload, explicitEntities) {
-            if (explicitEntities === void 0) { explicitEntities = {}; }
+        InterventionFetcher.prototype.update = function (payload, explicitAttributeKeys) {
+            if (explicitAttributeKeys === void 0) { explicitAttributeKeys = {}; }
             if (payload) {
-                Object.assign(this.entityValues, extractEntityValues(this.entitySelectors, payload));
+                Object.assign(this.attributeKeyValues, extractAttributeKeyValues(this.attributeKeySelectors, payload));
             }
-            Object.assign(this.entityValues, explicitEntities);
-            var newParams = new URLSearchParams(this.entityValues).toString();
+            Object.assign(this.attributeKeyValues, explicitAttributeKeys);
+            var newParams = new URLSearchParams(this.attributeKeyValues).toString();
             if (this.endpoint && (newParams != this.currentParams || this.newEndpoint)) {
-                logger(LogLevel.DEBUG, this.tracker.id, 'Entity IDs updated', this.entityValues);
+                logger(LogLevel.DEBUG, this.tracker.id, 'Attribute key IDs updated', this.attributeKeyValues);
                 this.currentParams = newParams;
                 this.requestInterventions();
             }
@@ -788,11 +788,11 @@
     var handlerRegistry = {}; // handlers can be added/removed for individual trackers
     var measurementSettings = {}; // currently global and only specified per-plugin instance but may be required in future
     /**
-     * Create an instance of the Signals Interventions plugin.
+     * Create an instance of the Signals plugin.
      * @param configuration Configuration for the plugin
      * @returns Configured plugin instance
      */
-    function SignalsInterventionsPlugin(_a) {
+    function SignalsPlugin(_a) {
         var _b = _a === void 0 ? {
             measurement: DEFAULT_MEASUREMENT_SETTINGS,
             handlers: {},
@@ -812,7 +812,7 @@
                 }
             },
             logger: function (LOG) {
-                setLogger(SignalsInterventionsPlugin.name, LOG);
+                setLogger(SignalsPlugin.name, LOG);
             },
         };
     }
@@ -835,8 +835,11 @@
                         intervention_id: intervention.intervention_id,
                         name: intervention.name,
                         version: intervention.version,
-                        entity: intervention.target_entity,
-                        attributes: intervention.attributes,
+                        attributeKey: intervention.target_attribute_key,
+                        attributes: Object.entries(intervention.attributes).map(function (_a) {
+                            var attribute = _a[0], value = _a[1];
+                            return ({ attribute: attribute, value: value });
+                        }),
                     },
                 },
             ];
@@ -900,7 +903,7 @@
     };
     /**
      * Configure the endpoint information for the plugin's `Fetcher` to subscribe to events from
-     * @param config Configuration about the endpoint and entity IDs/definitions to configure
+     * @param config Configuration about the endpoint and attribute key IDs/definitions to configure
      * @param trackers List of tracker IDs that have activated the plugin to configure a `Fetcher` for
      */
     function subscribeToInterventions(config, trackers) {
@@ -942,7 +945,7 @@
         }
     }
 
-    exports.SignalsInterventionsPlugin = SignalsInterventionsPlugin;
+    exports.SignalsPlugin = SignalsPlugin;
     exports.addInterventionHandlers = addInterventionHandlers;
     exports.removeInterventionHandlers = removeInterventionHandlers;
     exports.subscribeToInterventions = subscribeToInterventions;