Add app install, foreground and background event and application entity tracking (snowplow#1396)

Author: matus-tomlein

api-docs/docs/react-native-tracker/markdown/react-native-tracker.applifecycleconfiguration.appbuild.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) &gt; [appBuild](./react-native-tracker.applifecycleconfiguration.appbuild.md)
+
+## AppLifecycleConfiguration.appBuild property
+
+Build name of the application e.g s9f2k2d or 1.1.0 beta
+
+Entity schema: `iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0`
+
+<b>Signature:</b>
+
+```typescript
+appBuild?: string;
+```

api-docs/docs/react-native-tracker/markdown/react-native-tracker.applifecycleconfiguration.appversion.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) &gt; [appVersion](./react-native-tracker.applifecycleconfiguration.appversion.md)
+
+## AppLifecycleConfiguration.appVersion property
+
+Version number of the application e.g 1.1.0 (semver or git commit hash).
+
+Entity schema if `appBuild` property is set: `iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0` Entity schema if `appBuild` property is not set: `iglu:com.snowplowanalytics.snowplow/application/jsonschema/1-0-0`
+
+<b>Signature:</b>
+
+```typescript
+appVersion?: string;
+```

api-docs/docs/react-native-tracker/markdown/react-native-tracker.applifecycleconfiguration.installautotracking.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) &gt; [installAutotracking](./react-native-tracker.applifecycleconfiguration.installautotracking.md)
+
+## AppLifecycleConfiguration.installAutotracking property
+
+Whether to automatically track app install event on first run.
+
+Schema: `iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0`
+
+<b>Signature:</b>
+
+```typescript
+installAutotracking?: boolean;
+```

api-docs/docs/react-native-tracker/markdown/react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) &gt; [lifecycleAutotracking](./react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md)
+
+## AppLifecycleConfiguration.lifecycleAutotracking property
+
+Whether to automatically track app lifecycle events (app foreground and background events). Also adds a lifecycle context entity to all events.
+
+Foreground event schema: `iglu:com.snowplowanalytics.snowplow/application_foreground/jsonschema/1-0-0` Background event schema: `iglu:com.snowplowanalytics.snowplow/application_background/jsonschema/1-0-0` Context entity schema: `iglu:com.snowplowanalytics.mobile/application_lifecycle/jsonschema/1-0-0`
+
+<b>Signature:</b>
+
+```typescript
+lifecycleAutotracking?: boolean;
+```

api-docs/docs/react-native-tracker/markdown/react-native-tracker.applifecycleconfiguration.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md)
+
+## AppLifecycleConfiguration interface
+
+Configuration for app lifecycle tracking
+
+<b>Signature:</b>
+
+```typescript
+export interface AppLifecycleConfiguration 
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [appBuild?](./react-native-tracker.applifecycleconfiguration.appbuild.md) | string | <i>(Optional)</i> Build name of the application e.g s9f2k2d or 1.1.0 beta<!-- -->Entity schema: <code>iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0</code> |
+| [appVersion?](./react-native-tracker.applifecycleconfiguration.appversion.md) | string | <i>(Optional)</i> Version number of the application e.g 1.1.0 (semver or git commit hash).<!-- -->Entity schema if <code>appBuild</code> property is set: <code>iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0</code> Entity schema if <code>appBuild</code> property is not set: <code>iglu:com.snowplowanalytics.snowplow/application/jsonschema/1-0-0</code> |
+| [installAutotracking?](./react-native-tracker.applifecycleconfiguration.installautotracking.md) | boolean | <i>(Optional)</i> Whether to automatically track app install event on first run.<!-- -->Schema: <code>iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0</code> |
+| [lifecycleAutotracking?](./react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md) | boolean | <i>(Optional)</i> Whether to automatically track app lifecycle events (app foreground and background events). Also adds a lifecycle context entity to all events.<!-- -->Foreground event schema: <code>iglu:com.snowplowanalytics.snowplow/application_foreground/jsonschema/1-0-0</code> Background event schema: <code>iglu:com.snowplowanalytics.snowplow/application_background/jsonschema/1-0-0</code> Context entity schema: <code>iglu:com.snowplowanalytics.mobile/application_lifecycle/jsonschema/1-0-0</code> |
+

api-docs/docs/react-native-tracker/markdown/react-native-tracker.md

@@ -24,6 +24,7 @@
 
 | Interface | Description |
 | --- | --- |
+| [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) | Configuration for app lifecycle tracking |
 | [CoreConfiguration](./react-native-tracker.coreconfiguration.md) | The configuration object for the tracker core library |
 | [CorePlugin](./react-native-tracker.coreplugin.md) | Interface which defines Core Plugins |
 | [CorePluginConfiguration](./react-native-tracker.corepluginconfiguration.md) | The configuration of the plugin to add |

api-docs/docs/react-native-tracker/markdown/react-native-tracker.newtracker.md

@@ -9,14 +9,14 @@ Creates a new tracker instance with the given configuration
 <b>Signature:</b>
 
 ```typescript
-export declare function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration & PlatformContextConfiguration & DeepLinkConfiguration): Promise<ReactNativeTracker>;
+export declare function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration & PlatformContextConfiguration & DeepLinkConfiguration & AppLifecycleConfiguration): Promise<ReactNativeTracker>;
 ```
 
 ## Parameters
 
 | Parameter | Type | Description |
 | --- | --- | --- |
-| configuration | [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) &amp; EmitterConfiguration &amp; [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) &amp; [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) &amp; [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) &amp; ScreenTrackingConfiguration &amp; [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) &amp; [DeepLinkConfiguration](./react-native-tracker.deeplinkconfiguration.md) | Configuration for the tracker |
+| configuration | [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) &amp; EmitterConfiguration &amp; [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) &amp; [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) &amp; [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) &amp; ScreenTrackingConfiguration &amp; [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) &amp; [DeepLinkConfiguration](./react-native-tracker.deeplinkconfiguration.md) &amp; [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) | Configuration for the tracker |
 
 <b>Returns:</b>
 

api-docs/docs/react-native-tracker/markdown/react-native-tracker.reactnativetracker.md

@@ -42,6 +42,9 @@ export declare type ReactNativeTracker = {
  readonly getSessionId: () => Promise<string | undefined>;
  readonly getSessionIndex: () => Promise<number | undefined>;
  readonly getSessionState: () => Promise<SessionState | undefined>;
+ readonly getIsInBackground: () => boolean | undefined;
+ readonly getBackgroundIndex: () => number | undefined;
+ readonly getForegroundIndex: () => number | undefined;
  readonly enablePlatformContext: () => Promise<void>;
  readonly disablePlatformContext: () => void;
  readonly refreshPlatformContext: () => Promise<void>;

api-docs/docs/react-native-tracker/react-native-tracker.api.md

@@ -8,6 +8,14 @@ import { BrowserPlugin } from '@snowplow/browser-tracker-core';
 import { BrowserPluginConfiguration } from '@snowplow/browser-tracker-core';
 import { ScreenTrackingConfiguration } from '@snowplow/browser-plugin-screen-tracking';
 
+// @public
+export interface AppLifecycleConfiguration {
+ appBuild?: string;
+ appVersion?: string;
+ installAutotracking?: boolean;
+ lifecycleAutotracking?: boolean;
+}
+
 // @public
 export type ConditionalContextProvider = FilterProvider | RuleSetProvider;
 
@@ -260,7 +268,7 @@ export type MessageNotificationProps = {
 };
 
 // @public
-export function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration & PlatformContextConfiguration & DeepLinkConfiguration): Promise<ReactNativeTracker>;
+export function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration & PlatformContextConfiguration & DeepLinkConfiguration & AppLifecycleConfiguration): Promise<ReactNativeTracker>;
 
 // @public
 export interface PageViewEvent {
@@ -377,6 +385,9 @@ export type ReactNativeTracker = {
  readonly getSessionId: () => Promise<string | undefined>;
  readonly getSessionIndex: () => Promise<number | undefined>;
  readonly getSessionState: () => Promise<SessionState | undefined>;
+ readonly getIsInBackground: () => boolean | undefined;
+ readonly getBackgroundIndex: () => number | undefined;
+ readonly getForegroundIndex: () => number | undefined;
  readonly enablePlatformContext: () => Promise<void>;
  readonly disablePlatformContext: () => void;
  readonly refreshPlatformContext: () => Promise<void>;

common/changes/@snowplow/react-native-tracker/issue-react-native-lifecycle-tracking_2024-12-02-08-40.json

@@ -0,0 +1,10 @@
+{
+ "changes": [
+ {
+ "packageName": "@snowplow/react-native-tracker",
+ "comment": "Add app install, foreground and background event and application entity tracking (#1396)",
+ "type": "none"
+ }
+ ],
+ "packageName": "@snowplow/react-native-tracker"
+}