@snowplow/signals-browser-plugin 0.0.1 → 0.1.0

package/dist/index.module.d.ts

@@ -25,21 +25,21 @@ type Intervention = {
      */
     version: number;
     /**
-     * The complete or requested set of attributes for the Entity this intervention was triggered against an their values when it was triggered.
+     * The complete or requested set of attributes for the attribute key this intervention was triggered against an their values when it was triggered.
      */
     attributes: Record<string, OneOrMore<string | number | boolean>>;
     /**
-     * Information about the Entity that triggered this intervention or is intended to receive it.
+     * Information about the attribute key that triggered this intervention or is intended to receive it.
      */
-    target_entity?: {
+    target_attribute_key?: {
         /**
-         * The name/type of Entity that is the target/triggerer of this intervention.
+         * The name/type of attribute key that is the target/triggerer of this intervention.
          */
-        name: EntityName;
+        name: AttributeKeyName;
         /**
-         * The specific identifier for the instance of type `entityName` that is the target/triggerer of this intervention.
+         * The specific identifier for the instance of type `attributeKeyName` that is the target/triggerer of this intervention.
          */
-        id?: EntityId;
+        id?: AttributeKeyId;
     };
 };
 /**
@@ -55,13 +55,13 @@ type JSONPointer = '' | `/${string}`;
  */
 type JSONPointerList = OneOrMore<JSONPointer>;
 /**
- * Handle for an entity type to request Interventions for. The name is paired with an EntityId as URL parameters in the request for Interventions.
+ * Handle for an attribute key type to request Interventions for. The name is paired with an AttributeKeyId as URL parameters in the request for Interventions.
  */
-type EntityName = string;
+type AttributeKeyName = string;
 /**
- * An identifier for a specific Entity instance.
+ * An identifier for a specific attribute key instance.
  */
-type EntityId = string;
+type AttributeKeyId = string;
 /**
  * Unique name/identifier for an Intervention handler.
  */
@@ -83,13 +83,13 @@ type SignalsInterventionConfiguration = {
      */
     apiPath?: string;
     /**
-     * A definition of entity types and JSON Pointers to extract the ID values from. These will be extracted from events as they are tracked to update the Intervention request as values are updated.
+     * A definition of attribute key types and JSON Pointers to extract the ID values from. These will be extracted from events as they are tracked to update the Intervention request as values are updated.
      */
-    entityTargets?: Record<EntityName, JSONPointerList>;
+    attributeKeyTargets?: Record<AttributeKeyName, JSONPointerList>;
     /**
-     * An explicit set of entity types and corresponding IDs to request interventions for.
+     * An explicit set of attribute key types and corresponding IDs to request interventions for.
      */
-    entityIds?: Record<EntityName, EntityId>;
+    attributeKeyIds?: Record<AttributeKeyName, AttributeKeyId>;
     /**
      * Timeout duration to wait for the initial API to accept the Intervention request.
      */
@@ -135,20 +135,20 @@ interface FetcherFactory {
 /**
  * A `Fetcher` is expected to react to calls to `configure()` and use the provided information to subscribe to Interventions.
  * When interventions are received, a `Fetcher` is expected to call the `dispatch` callback that was provided to the `FetchFactory` that constructed the `Fetcher` and provide the `BrowserTracker` to measure events with.
- * `update()` will be called when new Snowplow events are observed, or explicit entity IDs are provided. It should update the connection so Interventions may be received for new entities described in the event.
+ * `update()` will be called when new Snowplow events are observed, or explicit attribute key IDs are provided. It should update the connection so Interventions may be received for new attribute keys described in the event.
  */
 interface Fetcher {
     /**
      * Accept a configuration for an interventions endpoint, and set up a connection to subscribe for Interventions on any configured entities.
-     * @param config Endpoint/entity configuration information.
+     * @param config Endpoint/attribute key configuration information.
      */
     configure(config: SignalsInterventionConfiguration): void;
     /**
-     * Called when a new Snowplow event has been observed or entity IDs provided. Entity IDs should be extracted and intervention subscription updated to accommodate new IDs if found.
+     * Called when a new Snowplow event has been observed or attribute key IDs provided. Attribute key IDs should be extracted and intervention subscription updated to accommodate new IDs if found.
      * @param payload A Snowplow event payload observed.
-     * @param explicitEntities An explicit set of entity names/IDs to subscribe for.
+     * @param explicitEntities An explicit set of attribute key names/IDs to subscribe for.
      */
-    update(payload?: Payload, explicitEntities?: Record<EntityName, EntityId>): void;
+    update(payload?: Payload, explicitEntities?: Record<AttributeKeyName, AttributeKeyId>): void;
 }
 /**
  * `Handler`s are delivered Intervention instanced as they are received.
@@ -166,7 +166,7 @@ type Handler = (intervention: Intervention, tracker: BrowserTracker) => Promise<
 declare function SignalsInterventionsPlugin({ fetcher, measurement, handlers }?: SignalsHandlerConfiguration): BrowserPlugin;
 /**
  * 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
  */
 declare function subscribeToInterventions(config: SignalsInterventionConfiguration, trackers?: TrackerId[]): void;
@@ -184,4 +184,4 @@ declare function addInterventionHandlers(handlers: Record<HandlerId, Handler>, t
 declare function removeInterventionHandlers(handlerIds: OneOrMore<HandlerId>, trackers?: TrackerId[]): void;
 
 export { SignalsInterventionsPlugin, addInterventionHandlers, removeInterventionHandlers, subscribeToInterventions };
-export type { EntityId, EntityName, Fetcher, FetcherFactory, Handler, HandlerId, Intervention, JSONPointer, JSONPointerList, MeasurementEvents, MeasurementSettings, OneOrMore, SignalsHandlerConfiguration, SignalsInterventionConfiguration, TrackerId };
+export type { AttributeKeyId, AttributeKeyName, Fetcher, FetcherFactory, Handler, HandlerId, Intervention, JSONPointer, JSONPointerList, MeasurementEvents, MeasurementSettings, OneOrMore, SignalsHandlerConfiguration, SignalsInterventionConfiguration, TrackerId };

package/dist/index.module.js

@@ -1,5 +1,5 @@
 /*!
- * Snowplow Signals Interventions SDK v0.0.1 (https://github.com/snowplow-incubator/signals-browser-plugin)
+ * Snowplow Signals Interventions SDK v0.1.0 (https://github.com/snowplow-incubator/signals-browser-plugin)
  * Copyright 2025 Snowplow Analytics Ltd
  * Licensed under BSD-3-Clause
  */
@@ -355,15 +355,15 @@ var derefJsonPointer = function (pointerString, obj) {
     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];
@@ -372,7 +372,7 @@ function extractEntityValues(targets, pb) {
             }
             var candidateId = derefJsonPointer(pointer, pb);
             if (candidateId != null) {
-                extracted[entityName] = String(candidateId);
+                extracted[attributeKeyName] = String(candidateId);
                 return;
             }
         }
@@ -381,26 +381,26 @@ function extractEntityValues(targets, pb) {
 }
 
 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({
@@ -409,23 +409,23 @@ var InterventionFetcher = /** @class */ (function () {
         });
     }
     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();
         }
@@ -538,8 +538,11 @@ var measure = function (settings, tracker, measurement, intervention, payload) {
                     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 });
+                    }),
                 },
             },
         ];
@@ -603,7 +606,7 @@ var dispatch = function (intervention, tracker) {
 };
 /**
  * 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) {