Merge branch 'master' into am/avoid-undelivered-notifications

api-docs/docs/browser-tracker/browser-tracker.api.md

@@ -222,6 +222,13 @@ export type EventBatch = GetBatch | PostBatch;
 // @public (undocumented)
 export type EventMethod = "post" | "get" | "beacon";
 
+// @public
+export interface EventPayloadAndContext {
+    context: Array<SelfDescribingJson>;
+    // Warning: (ae-forgotten-export) The symbol "PayloadBuilder" needs to be exported by the entry point index.module.d.ts
+    event: PayloadBuilder;
+}
+
 // @public (undocumented)
 export type ExtendedCrossDomainLinkerAttributes = {
     userId?: boolean;

api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.context.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) &gt; [context](./browser-tracker.eventpayloadandcontext.context.md)
+
+## EventPayloadAndContext.context property
+
+List of context entities to track along with the event
+
+<b>Signature:</b>
+
+```typescript
+context: Array<SelfDescribingJson>;
+```

api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.event.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) &gt; [event](./browser-tracker.eventpayloadandcontext.event.md)
+
+## EventPayloadAndContext.event property
+
+Tracker payload for the event data
+
+<b>Signature:</b>
+
+```typescript
+event: PayloadBuilder;
+```

api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md)
+
+## EventPayloadAndContext interface
+
+Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson).
+
+<b>Signature:</b>
+
+```typescript
+interface EventPayloadAndContext 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [context](./browser-tracker.eventpayloadandcontext.context.md) | Array&lt;SelfDescribingJson&gt; | List of context entities to track along with the event |
+|  [event](./browser-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data |
+

api-docs/docs/browser-tracker/markdown/browser-tracker.md

@@ -59,6 +59,7 @@
 |  [ContextEvent](./browser-tracker.contextevent.md) | Argument for [ContextGenerator](./browser-tracker.contextgenerator.md) and [ContextFilter](./browser-tracker.contextfilter.md) callback |
 |  [DisableAnonymousTrackingConfiguration](./browser-tracker.disableanonymoustrackingconfiguration.md) | The configuration that can be changed when disabling anonymous tracking |
 |  [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) | The configuration that can be changed when enabling anonymous tracking |
+|  [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) | Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). |
 |  [FlushBufferConfiguration](./browser-tracker.flushbufferconfiguration.md) | The configuration that can be changed when flushing the buffer |
 |  [PageViewEvent](./browser-tracker.pageviewevent.md) | A Page View event Used for tracking a page view |
 |  [RuleSet](./browser-tracker.ruleset.md) | A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs |

api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md

@@ -9,13 +9,7 @@ Build a Consent Granted Event Used for tracking when a user grants their consent
 <b>Signature:</b>
 
 ```typescript
-declare function buildConsentGranted(event: ConsentGrantedEvent): {
-    event: PayloadBuilder;
-    context: {
-        schema: string;
-        data: Record<string, unknown>;
-    }[];
-};
+declare function buildConsentGranted(event: ConsentGrantedEvent): EventPayloadAndContext;
 ```
 
 ## Parameters
@@ -26,7 +20,7 @@ declare function buildConsentGranted(event: ConsentGrantedEvent): {
 
 <b>Returns:</b>
 
-{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
+EventPayloadAndContext
 
 An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context
 

api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md

@@ -9,13 +9,7 @@ Build a Consent Withdrawn Event Used for tracking when a user withdraws their co
 <b>Signature:</b>
 
 ```typescript
-declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
-    event: PayloadBuilder;
-    context: {
-        schema: string;
-        data: Record<string, unknown>;
-    }[];
-};
+declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): EventPayloadAndContext;
 ```
 
 ## Parameters
@@ -26,7 +20,7 @@ declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
 
 <b>Returns:</b>
 
-{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
+EventPayloadAndContext
 
 An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context
 

api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) &gt; [context](./node-tracker.eventpayloadandcontext.context.md)
+
+## EventPayloadAndContext.context property
+
+List of context entities to track along with the event
+
+<b>Signature:</b>
+
+```typescript
+context: Array<SelfDescribingJson>;
+```

api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) &gt; [event](./node-tracker.eventpayloadandcontext.event.md)
+
+## EventPayloadAndContext.event property
+
+Tracker payload for the event data
+
+<b>Signature:</b>
+
+```typescript
+event: PayloadBuilder;
+```

api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md)
+
+## EventPayloadAndContext interface
+
+Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson).
+
+<b>Signature:</b>
+
+```typescript
+interface EventPayloadAndContext 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [context](./node-tracker.eventpayloadandcontext.context.md) | Array&lt;SelfDescribingJson&gt; | List of context entities to track along with the event |
+|  [event](./node-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data |
+

api-docs/docs/node-tracker/markdown/node-tracker.md

@@ -53,6 +53,7 @@
 |  [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) | An Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a customer completes a transaction. |
 |  [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) | An Ecommerce Transaction Item Related to the [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events |
 |  [Emitter](./node-tracker.emitter.md) |  |
+|  [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) | Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). |
 |  [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) | Represents either a Form Focus or Form Change event When a user focuses on a form element or when a user makes a change to a form element. |
 |  [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) | A Form Submission Event Used to track when a user submits a form |
 |  [LinkClickEvent](./node-tracker.linkclickevent.md) | A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag <code>&lt;a&gt;</code> |

api-docs/docs/node-tracker/node-tracker.api.md

@@ -72,22 +72,10 @@ export function buildAddToCart(event: AddToCartEvent): PayloadBuilder;
 export function buildAdImpression(event: AdImpressionEvent): PayloadBuilder;
 
 // @public
-export function buildConsentGranted(event: ConsentGrantedEvent): {
-    event: PayloadBuilder;
-    context: {
-        schema: string;
-        data: Record<string, unknown>;
-    }[];
-};
+export function buildConsentGranted(event: ConsentGrantedEvent): EventPayloadAndContext;
 
 // @public
-export function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
-    event: PayloadBuilder;
-    context: {
-        schema: string;
-        data: Record<string, unknown>;
-    }[];
-};
+export function buildConsentWithdrawn(event: ConsentWithdrawnEvent): EventPayloadAndContext;
 
 // @public
 export function buildEcommerceTransaction(event: EcommerceTransactionEvent): PayloadBuilder;
@@ -216,6 +204,12 @@ export interface Emitter {
     setAnonymization?: (shouldAnonymize: boolean) => void;
 }
 
+// @public
+export interface EventPayloadAndContext {
+    context: Array<SelfDescribingJson>;
+    event: PayloadBuilder;
+}
+
 // @public
 export interface FormFocusOrChangeEvent {
     elementClasses?: Array<string> | null;