Skip to content

Commit 9528528

Browse files
Fix API docs CI action and update it's dependencies (#1324)
1 parent 36e1d63 commit 9528528

20 files changed

+1293
-1458
lines changed

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,13 @@ export type EventBatch = GetBatch | PostBatch;
222222
// @public (undocumented)
223223
export type EventMethod = "post" | "get" | "beacon";
224224

225+
// @public
226+
export interface EventPayloadAndContext {
227+
context: Array<SelfDescribingJson>;
228+
// Warning: (ae-forgotten-export) The symbol "PayloadBuilder" needs to be exported by the entry point index.module.d.ts
229+
event: PayloadBuilder;
230+
}
231+
225232
// @public (undocumented)
226233
export type ExtendedCrossDomainLinkerAttributes = {
227234
userId?: boolean;
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) &gt; [context](./browser-tracker.eventpayloadandcontext.context.md)
4+
5+
## EventPayloadAndContext.context property
6+
7+
List of context entities to track along with the event
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
context: Array<SelfDescribingJson>;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) &gt; [event](./browser-tracker.eventpayloadandcontext.event.md)
4+
5+
## EventPayloadAndContext.event property
6+
7+
Tracker payload for the event data
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
event: PayloadBuilder;
13+
```
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md)
4+
5+
## EventPayloadAndContext interface
6+
7+
Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson).
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface EventPayloadAndContext
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [context](./browser-tracker.eventpayloadandcontext.context.md) | Array&lt;SelfDescribingJson&gt; | List of context entities to track along with the event |
20+
| [event](./browser-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data |
21+

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
| [ContextEvent](./browser-tracker.contextevent.md) | Argument for [ContextGenerator](./browser-tracker.contextgenerator.md) and [ContextFilter](./browser-tracker.contextfilter.md) callback |
6060
| [DisableAnonymousTrackingConfiguration](./browser-tracker.disableanonymoustrackingconfiguration.md) | The configuration that can be changed when disabling anonymous tracking |
6161
| [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) | The configuration that can be changed when enabling anonymous tracking |
62+
| [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) | Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). |
6263
| [FlushBufferConfiguration](./browser-tracker.flushbufferconfiguration.md) | The configuration that can be changed when flushing the buffer |
6364
| [PageViewEvent](./browser-tracker.pageviewevent.md) | A Page View event Used for tracking a page view |
6465
| [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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,7 @@ Build a Consent Granted Event Used for tracking when a user grants their consent
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function buildConsentGranted(event: ConsentGrantedEvent): {
13-
event: PayloadBuilder;
14-
context: {
15-
schema: string;
16-
data: Record<string, unknown>;
17-
}[];
18-
};
12+
declare function buildConsentGranted(event: ConsentGrantedEvent): EventPayloadAndContext;
1913
```
2014

2115
## Parameters
@@ -26,7 +20,7 @@ declare function buildConsentGranted(event: ConsentGrantedEvent): {
2620

2721
<b>Returns:</b>
2822

29-
{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
23+
EventPayloadAndContext
3024

3125
An object containing the PayloadBuilder to be sent to and a 'consent\_document' context
3226

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,7 @@ Build a Consent Withdrawn Event Used for tracking when a user withdraws their co
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
13-
event: PayloadBuilder;
14-
context: {
15-
schema: string;
16-
data: Record<string, unknown>;
17-
}[];
18-
};
12+
declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): EventPayloadAndContext;
1913
```
2014

2115
## Parameters
@@ -26,7 +20,7 @@ declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
2620

2721
<b>Returns:</b>
2822

29-
{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
23+
EventPayloadAndContext
3024

3125
An object containing the PayloadBuilder to be sent to and a 'consent\_document' context
3226

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) &gt; [context](./node-tracker.eventpayloadandcontext.context.md)
4+
5+
## EventPayloadAndContext.context property
6+
7+
List of context entities to track along with the event
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
context: Array<SelfDescribingJson>;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) &gt; [event](./node-tracker.eventpayloadandcontext.event.md)
4+
5+
## EventPayloadAndContext.event property
6+
7+
Tracker payload for the event data
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
event: PayloadBuilder;
13+
```
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md)
4+
5+
## EventPayloadAndContext interface
6+
7+
Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson).
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface EventPayloadAndContext
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [context](./node-tracker.eventpayloadandcontext.context.md) | Array&lt;SelfDescribingJson&gt; | List of context entities to track along with the event |
20+
| [event](./node-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data |
21+

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
| [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. |
5454
| [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 |
5555
| [Emitter](./node-tracker.emitter.md) | |
56+
| [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) | Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). |
5657
| [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. |
5758
| [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) | A Form Submission Event Used to track when a user submits a form |
5859
| [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

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,10 @@ export function buildAddToCart(event: AddToCartEvent): PayloadBuilder;
7272
export function buildAdImpression(event: AdImpressionEvent): PayloadBuilder;
7373

7474
// @public
75-
export function buildConsentGranted(event: ConsentGrantedEvent): {
76-
event: PayloadBuilder;
77-
context: {
78-
schema: string;
79-
data: Record<string, unknown>;
80-
}[];
81-
};
75+
export function buildConsentGranted(event: ConsentGrantedEvent): EventPayloadAndContext;
8276

8377
// @public
84-
export function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
85-
event: PayloadBuilder;
86-
context: {
87-
schema: string;
88-
data: Record<string, unknown>;
89-
}[];
90-
};
78+
export function buildConsentWithdrawn(event: ConsentWithdrawnEvent): EventPayloadAndContext;
9179

9280
// @public
9381
export function buildEcommerceTransaction(event: EcommerceTransactionEvent): PayloadBuilder;
@@ -216,6 +204,12 @@ export interface Emitter {
216204
setAnonymization?: (shouldAnonymize: boolean) => void;
217205
}
218206

207+
// @public
208+
export interface EventPayloadAndContext {
209+
context: Array<SelfDescribingJson>;
210+
event: PayloadBuilder;
211+
}
212+
219213
// @public
220214
export interface FormFocusOrChangeEvent {
221215
elementClasses?: Array<string> | null;

0 commit comments

Comments
 (0)