Applying documentation updates.

Author: github-actions[bot]

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.eventindex.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [eventIndex](./browser-tracker.clientsession.eventindex.md)
+
+## ClientSession.eventIndex property
+
+Index of the current event in the session
+
+<b>Signature:</b>
+
+```typescript
+eventIndex: number;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventid.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [firstEventId](./browser-tracker.clientsession.firsteventid.md)
+
+## ClientSession.firstEventId property
+
+Identifier of the first event for this session
+
+<b>Signature:</b>
+
+```typescript
+firstEventId: string | null;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventtimestamp.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [firstEventTimestamp](./browser-tracker.clientsession.firsteventtimestamp.md)
+
+## ClientSession.firstEventTimestamp property
+
+Date-time timestamp of when the first event in the session was tracked
+
+<b>Signature:</b>
+
+```typescript
+firstEventTimestamp: string | null;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [ClientSession](./browser-tracker.clientsession.md)
+
+## ClientSession interface
+
+Schema for client client session context entity
+
+<b>Signature:</b>
+
+```typescript
+interface ClientSession extends Record<string, unknown> 
+```
+<b>Extends:</b> Record&lt;string, unknown&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [eventIndex](./browser-tracker.clientsession.eventindex.md) | number | Index of the current event in the session |
+|  [firstEventId](./browser-tracker.clientsession.firsteventid.md) | string \| null | Identifier of the first event for this session |
+|  [firstEventTimestamp](./browser-tracker.clientsession.firsteventtimestamp.md) | string \| null | Date-time timestamp of when the first event in the session was tracked |
+|  [previousSessionId](./browser-tracker.clientsession.previoussessionid.md) | string \| null | The previous session identifier for this user |
+|  [sessionId](./browser-tracker.clientsession.sessionid.md) | string | An identifier for the session (same as domain\_sessionid) |
+|  [sessionIndex](./browser-tracker.clientsession.sessionindex.md) | number | The index of the current session for this user (same as domain\_sessionidx) |
+|  [storageMechanism](./browser-tracker.clientsession.storagemechanism.md) | string | The mechanism that the session information has been stored on the device |
+|  [userId](./browser-tracker.clientsession.userid.md) | string | An identifier for the user of the session (same as domain\_userid) |
+

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.previoussessionid.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [previousSessionId](./browser-tracker.clientsession.previoussessionid.md)
+
+## ClientSession.previousSessionId property
+
+The previous session identifier for this user
+
+<b>Signature:</b>
+
+```typescript
+previousSessionId: string | null;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionid.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [sessionId](./browser-tracker.clientsession.sessionid.md)
+
+## ClientSession.sessionId property
+
+An identifier for the session (same as domain\_sessionid)
+
+<b>Signature:</b>
+
+```typescript
+sessionId: string;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionindex.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [sessionIndex](./browser-tracker.clientsession.sessionindex.md)
+
+## ClientSession.sessionIndex property
+
+The index of the current session for this user (same as domain\_sessionidx)
+
+<b>Signature:</b>
+
+```typescript
+sessionIndex: number;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.storagemechanism.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [storageMechanism](./browser-tracker.clientsession.storagemechanism.md)
+
+## ClientSession.storageMechanism property
+
+The mechanism that the session information has been stored on the device
+
+<b>Signature:</b>
+
+```typescript
+storageMechanism: string;
+```

trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.userid.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; [ClientSession](./browser-tracker.clientsession.md) &gt; [userId](./browser-tracker.clientsession.userid.md)
+
+## ClientSession.userId property
+
+An identifier for the user of the session (same as domain\_userid)
+
+<b>Signature:</b>
+
+```typescript
+userId: string;
+```

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

@@ -52,6 +52,7 @@
 |  [BrowserPluginConfiguration](./browser-tracker.browserpluginconfiguration.md) | The configuration of the plugin to add |
 |  [BrowserTracker](./browser-tracker.browsertracker.md) | The Browser Tracker |
 |  [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) | The configuration that can be changed when enabling anonymous tracking |
+|  [ClientSession](./browser-tracker.clientsession.md) | Schema for client client session context entity |
 |  [CommonEventProperties](./browser-tracker.commoneventproperties.md) | Additional data points to set when tracking an event |
 |  [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 |

trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md

@@ -39,6 +39,7 @@ type TrackerConfiguration = {
     customHeaders?: Record<string, string>;
     retryStatusCodes?: number[];
     dontRetryStatusCodes?: number[];
+    onSessionUpdateCallback?: (updatedSession: ClientSession) => void;
 };
 ```
 

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

@@ -17,4 +17,6 @@ interface Tracker extends TrackerCore
 |  --- | --- | --- |
 |  [setDomainUserId](./node-tracker.tracker.setdomainuserid.md) | (userId: string) => void | Set the domain user ID |
 |  [setNetworkUserId](./node-tracker.tracker.setnetworkuserid.md) | (userId: string) => void | Set the network user ID |
+|  [setSessionId](./node-tracker.tracker.setsessionid.md) | (sessionId: string) =&gt; void | Set the session ID (<code>domain_sessionid</code> in the atomic events) |
+|  [setSessionIndex](./node-tracker.tracker.setsessionindex.md) | (sessionIndex: string \| number) =&gt; void | Set the session index (<code>domain_sessionidx</code> in the atomic events) |
 

trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionid.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; [Tracker](./node-tracker.tracker.md) &gt; [setSessionId](./node-tracker.tracker.setsessionid.md)
+
+## Tracker.setSessionId property
+
+Set the session ID (`domain_sessionid` in the atomic events)
+
+<b>Signature:</b>
+
+```typescript
+setSessionId: (sessionId: string) => void;
+```

trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionindex.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; [Tracker](./node-tracker.tracker.md) &gt; [setSessionIndex](./node-tracker.tracker.setsessionindex.md)
+
+## Tracker.setSessionIndex property
+
+Set the session index (`domain_sessionidx` in the atomic events)
+
+<b>Signature:</b>
+
+```typescript
+setSessionIndex: (sessionIndex: string | number) => void;
+```