Extend cross-domain linking with more user/session information and op…

…tional configuration #1278
snowplow · Jan 15, 2024 · 2bcb587 · 2bcb587
1 parent 8626747
commit 2bcb587
Show file tree

Hide file tree

Showing 14 changed files with 698 additions and 49 deletions.
diff --git a/.bundlemonrc.json b/.bundlemonrc.json
@@ -7,22 +7,22 @@
     },
     {
       "path": "./trackers/browser-tracker/dist/index.umd.min.js",
-      "maxSize": "15kb",
+      "maxSize": "15.5kb",
       "maxPercentIncrease": 10
     },
     {
       "path": "./trackers/javascript-tracker/dist/sp.js",
-      "maxSize": "25kb",
+      "maxSize": "25.5kb",
       "maxPercentIncrease": 10
     },
     {
       "path": "./trackers/javascript-tracker/dist/sp.lite.js",
-      "maxSize": "15.5kb",
+      "maxSize": "16kb",
       "maxPercentIncrease": 10
     },
     {
       "path": "./libraries/browser-tracker-core/dist/index.module.js",
-      "maxSize": "26kb",
+      "maxSize": "27kb",
       "maxPercentIncrease": 10
     },
     {

diff --git a/api-docs/docs/browser-tracker/browser-tracker.api.md b/api-docs/docs/browser-tracker/browser-tracker.api.md
@@ -221,6 +221,18 @@ export type EventBatch = GetBatch | PostBatch;
 // @public (undocumented)
 export type EventMethod = "post" | "get" | "beacon";
 
+// @public (undocumented)
+export type ExtendedCrossDomainLinkerAttributes = {
+    userId?: boolean;
+    sessionId?: boolean;
+    sourceId?: boolean;
+    sourcePlatform?: boolean;
+    reason?: boolean | ((evt: Event) => string);
+};
+
+// @public (undocumented)
+export type ExtendedCrossDomainLinkerOptions = boolean | ExtendedCrossDomainLinkerAttributes;
+
 // @public
 export type FilterProvider = [
 ContextFilter,
@@ -371,6 +383,7 @@ export type TrackerConfiguration = {
     useStm?: boolean;
     bufferSize?: number;
     crossDomainLinker?: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean;
+    useExtendedCrossDomainLinker?: ExtendedCrossDomainLinkerOptions;
     maxPostBytes?: number;
     maxGetBytes?: number;
     discoverRootDomain?: boolean;

diff --git a/...low/browser-tracker-core/feature-extend-cross-domain-linking-entity_2023-08-28-10-46.json b/...low/browser-tracker-core/feature-extend-cross-domain-linking-entity_2023-08-28-10-46.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker-core",
+      "comment": "Allow for extended cross domain linking information using the useExtendedCrossDomainLinker option",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker-core"
+}
diff --git a/...snowplow/browser-tracker/feature-extend-cross-domain-linking-entity_2023-08-28-10-46.json b/...snowplow/browser-tracker/feature-extend-cross-domain-linking-entity_2023-08-28-10-46.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker",
+      "comment": "Add new useExtendedCrossDomainLinker option",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker"
+}
diff --git a/common/config/rush/browser-approved-packages.json b/common/config/rush/browser-approved-packages.json
@@ -138,6 +138,10 @@
       "name": "@snowplow/tracker-core",
       "allowedCategories": [ "libraries", "plugins", "trackers" ]
     },
+    {
+      "name": "@testing-library/dom",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "@types/dockerode",
       "allowedCategories": [ "trackers" ]