Add screen tracking plugin and add support for browser plugins (snowplow#1394)

Author: matus-tomlein

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): Promise<ReactNativeTracker>;
+export declare function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration): 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) | 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 | Configuration for the tracker |
 
 <b>Returns:</b>
 

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

@@ -10,15 +10,19 @@ The ReactNativeTracker type
 
 ```typescript
 export declare type ReactNativeTracker = {
+    namespace: string;
     readonly trackSelfDescribingEvent: <T extends Record<string, unknown> = Record<string, unknown>>(argmap: SelfDescribingJson<T>, contexts?: EventContext[]) => void;
+    readonly trackScreenViewEvent: (argmap: ScreenViewProps, contexts?: EventContext[]) => void;
+    readonly trackScrollChangedEvent: (argmap: ScrollChangedProps, contexts?: EventContext[]) => void;
+    readonly trackListItemViewEvent: (argmap: ListItemViewProps, contexts?: EventContext[]) => void;
     readonly trackStructuredEvent: (argmap: StructuredEvent, contexts?: EventContext[]) => void;
     readonly trackPageViewEvent: (argmap: PageViewEvent, contexts?: EventContext[]) => void;
     readonly trackTimingEvent: (argmap: TimingProps, contexts?: EventContext[]) => void;
     readonly trackMessageNotificationEvent: (argmap: MessageNotificationProps, contexts?: EventContext[]) => void;
     addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive> | Record<string, ConditionalContextProvider | ContextPrimitive>): void;
     clearGlobalContexts(): void;
     removeGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive | string>): void;
-    addPlugin(configuration: CorePluginConfiguration): void;
+    addPlugin(configuration: BrowserPluginConfiguration): void;
     flush: () => Promise<void>;
     readonly setAppId: (appId: string) => void;
     readonly setPlatform: (value: string) => void;
@@ -39,5 +43,5 @@ export declare type ReactNativeTracker = {
     readonly getSessionState: () => Promise<SessionState | undefined>;
 };
 ```
-<b>References:</b> [EventContext](./react-native-tracker.eventcontext.md)<!-- -->, [TimingProps](./react-native-tracker.timingprops.md)<!-- -->, [MessageNotificationProps](./react-native-tracker.messagenotificationprops.md)<!-- -->, [ScreenSize](./react-native-tracker.screensize.md)<!-- -->, [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md)<!-- -->, [SessionState](./react-native-tracker.sessionstate.md)
+<b>References:</b> [EventContext](./react-native-tracker.eventcontext.md)<!-- -->, [ScreenViewProps](./react-native-tracker.screenviewprops.md)<!-- -->, [ScrollChangedProps](./react-native-tracker.scrollchangedprops.md)<!-- -->, [ListItemViewProps](./react-native-tracker.listitemviewprops.md)<!-- -->, [TimingProps](./react-native-tracker.timingprops.md)<!-- -->, [MessageNotificationProps](./react-native-tracker.messagenotificationprops.md)<!-- -->, [ScreenSize](./react-native-tracker.screensize.md)<!-- -->, [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md)<!-- -->, [SessionState](./react-native-tracker.sessionstate.md)
 

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

@@ -19,4 +19,5 @@ export interface TrackerConfiguration
 |  [appId?](./react-native-tracker.trackerconfiguration.appid.md) | string | <i>(Optional)</i> The application ID |
 |  [encodeBase64?](./react-native-tracker.trackerconfiguration.encodebase64.md) | boolean | <i>(Optional)</i> Whether unstructured events and custom contexts should be base64 encoded. |
 |  [namespace](./react-native-tracker.trackerconfiguration.namespace.md) | string | The namespace of the tracker |
+|  [plugins?](./react-native-tracker.trackerconfiguration.plugins.md) | BrowserPlugin\[\] | <i>(Optional)</i> Inject plugins which will be evaluated for each event |
 

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

@@ -0,0 +1,13 @@
+<!-- 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; [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) &gt; [plugins](./react-native-tracker.trackerconfiguration.plugins.md)
+
+## TrackerConfiguration.plugins property
+
+Inject plugins which will be evaluated for each event
+
+<b>Signature:</b>
+
+```typescript
+plugins?: BrowserPlugin[];
+```

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

@@ -4,6 +4,10 @@
 
 ```ts
 
+import { BrowserPlugin } from '@snowplow/browser-tracker-core';
+import { BrowserPluginConfiguration } from '@snowplow/browser-tracker-core';
+import { ScreenTrackingConfiguration } from '@snowplow/browser-plugin-screen-tracking';
+
 // @public
 export type ConditionalContextProvider = FilterProvider | RuleSetProvider;
 
@@ -251,7 +255,7 @@ export type MessageNotificationProps = {
 };
 
 // @public
-export function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration): Promise<ReactNativeTracker>;
+export function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration): Promise<ReactNativeTracker>;
 
 // @public
 export interface PageViewEvent {
@@ -277,15 +281,19 @@ export interface PayloadBuilder {
 
 // @public
 export type ReactNativeTracker = {
+    namespace: string;
     readonly trackSelfDescribingEvent: <T extends Record<string, unknown> = Record<string, unknown>>(argmap: SelfDescribingJson<T>, contexts?: EventContext[]) => void;
+    readonly trackScreenViewEvent: (argmap: ScreenViewProps, contexts?: EventContext[]) => void;
+    readonly trackScrollChangedEvent: (argmap: ScrollChangedProps, contexts?: EventContext[]) => void;
+    readonly trackListItemViewEvent: (argmap: ListItemViewProps, contexts?: EventContext[]) => void;
     readonly trackStructuredEvent: (argmap: StructuredEvent, contexts?: EventContext[]) => void;
     readonly trackPageViewEvent: (argmap: PageViewEvent, contexts?: EventContext[]) => void;
     readonly trackTimingEvent: (argmap: TimingProps, contexts?: EventContext[]) => void;
     readonly trackMessageNotificationEvent: (argmap: MessageNotificationProps, contexts?: EventContext[]) => void;
     addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive> | Record<string, ConditionalContextProvider | ContextPrimitive>): void;
     clearGlobalContexts(): void;
     removeGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive | string>): void;
-    addPlugin(configuration: CorePluginConfiguration): void;
+    addPlugin(configuration: BrowserPluginConfiguration): void;
     flush: () => Promise<void>;
     readonly setAppId: (appId: string) => void;
     readonly setPlatform: (value: string) => void;
@@ -426,6 +434,7 @@ export interface TrackerConfiguration {
     appId?: string;
     encodeBase64?: boolean;
     namespace: string;
+    plugins?: BrowserPlugin[];
 }
 
 // @public

common/changes/@snowplow/browser-plugin-screen-tracking/issue-screen-tracking_2024-11-26-13-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-plugin-screen-tracking",
+      "comment": "Add screen tracking plugin and add support for browser plugins (#1394)",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-plugin-screen-tracking"
+}

common/changes/@snowplow/react-native-tracker/issue-screen-tracking_2024-11-26-13-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/react-native-tracker",
+      "comment": "Add screen tracking plugin and add support for browser plugins (#1394)",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/react-native-tracker"
+}

common/config/rush/browser-approved-packages.json

@@ -126,6 +126,10 @@
       "name": "@snowplow/browser-plugin-privacy-sandbox",
       "allowedCategories": [ "trackers" ]
     },
+    {
+      "name": "@snowplow/browser-plugin-screen-tracking",
+      "allowedCategories": [ "trackers" ]
+    },
     {
       "name": "@snowplow/browser-plugin-site-tracking",
       "allowedCategories": [ "trackers" ]

common/config/rush/pnpm-lock.yaml

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "50fa04b4f2a1f9fdbf83a84ce901759859832bfd",
+  "pnpmShrinkwrapHash": "d1933251824ef3eb837586f089856ce0f6036111",
   "preferredVersionsHash": "bf21a9e8fbc5a3846fb05b4fa0859e0917b2202f"
 }