Add CommonEventProperties type argument (close #1249)

#1250
snowplow · Oct 12, 2023 · 23b0c02 · 23b0c02
1 parent 265d062
commit 23b0c02
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/...wplow/browser-tracker/feature-1249-common-event-properties-type-arg_2023-10-11-10-45.json b/...wplow/browser-tracker/feature-1249-common-event-properties-type-arg_2023-10-11-10-45.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker",
+      "comment": "Add CommonEventProperties type argument",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker"
+}
diff --git a/...snowplow/tracker-core/feature-1249-common-event-properties-type-arg_2023-10-11-10-22.json b/...snowplow/tracker-core/feature-1249-common-event-properties-type-arg_2023-10-11-10-22.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/tracker-core",
+      "comment": "Add CommonEventProperties type argument",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/tracker-core"
+}
diff --git a/libraries/tracker-core/src/core.ts b/libraries/tracker-core/src/core.ts
@@ -119,9 +119,9 @@ function getTimestamp(timestamp?: Timestamp | null): TimestampPayload {
 }
 
 /** Additional data points to set when tracking an event */
-export interface CommonEventProperties {
+export interface CommonEventProperties<T = Record<string, unknown>> {
   /** Add context to an event by setting an Array of Self Describing JSON */
-  context?: Array<SelfDescribingJson> | null;
+  context?: Array<SelfDescribingJson<T>> | null;
   /** Set the true timestamp or overwrite the device sent timestamp on an event */
   timestamp?: Timestamp | null;
 }

diff --git a/trackers/browser-tracker/docs/browser-tracker.api.md b/trackers/browser-tracker/docs/browser-tracker.api.md
@@ -142,8 +142,8 @@ export interface ClientSession extends Record<string, unknown> {
 }
 
 // @public
-export interface CommonEventProperties {
-    context?: Array<SelfDescribingJson> | null;
+export interface CommonEventProperties<T = Record<string, unknown>> {
+    context?: Array<SelfDescribingJson<T>> | null;
     // Warning: (ae-forgotten-export) The symbol "Timestamp" needs to be exported by the entry point index.module.d.ts
     timestamp?: Timestamp | null;
 }