@snowplow/react-native-tracker 2.0.0 → 2.1.0

package/src/tracker.ts

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 'use strict';
 
 import { RNSnowplowTracker } from './native';
@@ -19,6 +6,8 @@ import {
   validateContexts,
   validateSelfDesc,
   validateScreenView,
+  validateScrollChanged,
+  validateListItemView,
   validateStructured,
   validatePageView,
   validateTiming,
@@ -40,6 +29,8 @@ import type {
   EcommerceTransactionProps,
   DeepLinkReceivedProps,
   MessageNotificationProps,
+  ScrollChangedProps,
+  ListItemViewProps,
 } from './types';
 
 /**
@@ -96,6 +87,60 @@ function trackScreenViewEvent(
     });
 }
 
+/**
+ * Tracks a scroll-changed event
+ *
+ * @param namespace {string} - the tracker namespace
+ * @param argmap {Object} - the event data
+ * @param contexts {Array}- the event contexts
+ * @returns {Promise}
+ */
+function trackScrollChangedEvent(
+  namespace: string | null,
+  argmap: ScrollChangedProps,
+  contexts: EventContext[] = []
+): Promise<void> {
+  return <Promise<void>>validateScrollChanged(argmap)
+    .then(() => validateContexts(contexts))
+    .then(
+      () => <Promise<void>>RNSnowplowTracker.trackScrollChangedEvent({
+          tracker: namespace,
+          eventData: argmap,
+          contexts: contexts,
+        })
+    )
+    .catch((error) => {
+      throw new Error(`${logMessages.trackScrollChanged} ${error.message}`);
+    });
+}
+
+/**
+ * Tracks a list item view event
+ *
+ * @param namespace {string} - the tracker namespace
+ * @param argmap {Object} - the event data
+ * @param contexts {Array}- the event contexts
+ * @returns {Promise}
+ */
+function trackListItemViewEvent(
+  namespace: string | null,
+  argmap: ListItemViewProps,
+  contexts: EventContext[] = []
+): Promise<void> {
+  return <Promise<void>>validateListItemView(argmap)
+    .then(() => validateContexts(contexts))
+    .then(
+      () => <Promise<void>>RNSnowplowTracker.trackListItemViewEvent({
+          tracker: namespace,
+          eventData: argmap,
+          contexts: contexts,
+        })
+    )
+    .catch((error) => {
+      throw new Error(`${logMessages.trackListItemView} ${error.message}`);
+    });
+}
+
 /**
  * Tracks a structured event
  *
@@ -319,6 +364,8 @@ function trackMessageNotificationEvent(
 export {
   trackSelfDescribingEvent,
   trackScreenViewEvent,
+  trackScrollChangedEvent,
+  trackListItemViewEvent,
   trackStructuredEvent,
   trackPageViewEvent,
   trackTimingEvent,

package/src/types.ts

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 /**
  * HttpMethod type
  */
@@ -48,7 +35,7 @@ export type Basis =
 /**
  * BufferOption
  */
-export type BufferOption = 'single' | 'default' | 'large';
+export type BufferOption = 'single' | 'small' | 'large';
 
 /**
  * Trigger for MessageNotification event
@@ -69,7 +56,7 @@ export type ScreenSize = [number, number];
  * SelfDescribing type
  */
 export type SelfDescribing<
-  T extends Record<keyof T, unknown> = Record<string, unknown>
+  T extends Record<string, unknown> = Record<string, unknown>
 > = {
   /**
    * Schema
@@ -176,9 +163,15 @@ export interface TrackerConfiguration {
    * @defaultValue false
    */
   screenViewAutotracking?: boolean;
+  /**
+   * Whether to enable tracking of the screen end event and the screen summary context entity.
+   * Make sure that you have lifecycle autotracking enabled for screen summary to have complete information.
+   * @defaultValue true
+   */
+  screenEngagementAutotracking?: boolean;
   /**
    * Whether enable automatic tracking of background and foreground transitions.
-   * @defaultValue false
+   * @defaultValue true
    */
   lifecycleAutotracking?: boolean;
   /**
@@ -404,6 +397,56 @@ export type ScreenViewProps = {
   transitionType?: string;
 };
 
+/**
+ * Event tracked when a scroll view's scroll position changes.
+ * If screen engagement tracking is enabled, the scroll changed events will be aggregated into a `screen_summary` entity.
+ *
+ * Schema: `iglu:com.snowplowanalytics.mobile/scroll_changed/jsonschema/1-0-0`
+ */
+export type ScrollChangedProps = {
+  /**
+   * Vertical scroll offset in pixels
+   */
+  yOffset?: number;
+  /**
+   * Horizontal scroll offset in pixels.
+   */
+  xOffset?: number;
+  /**
+   * The height of the scroll view in pixels
+   */
+  viewHeight?: number;
+  /**
+   * The width of the scroll view in pixels
+   */
+  viewWidth?: number;
+  /**
+   * The height of the content in the scroll view in pixels
+   */
+  contentHeight?: number;
+  /**
+   * The width of the content in the scroll view in pixels
+   */
+  contentWidth?: number;
+};
+
+/**
+ * Event tracking the view of an item in a list.
+ * If screen engagement tracking is enabled, the list item view events will be aggregated into a `screen_summary` entity.
+ *
+ * Schema: `iglu:com.snowplowanalytics.mobile/list_item_view/jsonschema/1-0-0`
+ */
+export type ListItemViewProps = {
+  /**
+   * Index of the item in the list
+   */
+  index: number;
+  /**
+   * Total number of items in the list
+   */
+  itemsCount?: number;
+};
+
 /**
  * Structured event properties
  */
@@ -700,14 +743,14 @@ export type MessageNotificationProps = {
  */
 export type ReactNativeTracker = {
   /**
-   * Tracks a self-descibing event
+   * Tracks a self-describing event
    *
    * @param argmap - The self-describing event properties
    * @param contexts - The array of event contexts
    * @typeParam TData - The type of the data object within the SelfDescribing object
    */
   readonly trackSelfDescribingEvent: <
-    TData extends Record<keyof TData, unknown> = Record<string, unknown>
+    TData extends Record<string, unknown> = Record<string, unknown>
   >(
     argmap: SelfDescribing<TData>,
     contexts?: EventContext[]
@@ -724,6 +767,28 @@ export type ReactNativeTracker = {
     contexts?: EventContext[]
   ) => Promise<void>;
 
+  /**
+   * Tracks a scroll changed event
+   *
+   * @param argmap - The scroll changed event's properties
+   * @param contexts - The array of event contexts
+   */
+  readonly trackScrollChangedEvent: (
+    argmap: ScrollChangedProps,
+    contexts?: EventContext[]
+  ) => Promise<void>;
+
+  /**
+   * Tracks a list item view event
+   *
+   * @param argmap - The list item view event's properties
+   * @param contexts - The array of event contexts
+   */
+  readonly trackListItemViewEvent: (
+    argmap: ListItemViewProps,
+    contexts?: EventContext[]
+  ) => Promise<void>;
+
   /**
    * Tracks a structured event
    *
@@ -995,6 +1060,16 @@ export interface Native {
     eventData: ScreenViewProps;
     contexts: EventContext[];
   }) => Promise<void>;
+  trackScrollChangedEvent: (details: {
+    tracker: string | null;
+    eventData: ScrollChangedProps;
+    contexts: EventContext[];
+  }) => Promise<void>;
+  trackListItemViewEvent: (details: {
+    tracker: string | null;
+    eventData: ListItemViewProps;
+    contexts: EventContext[];
+  }) => Promise<void>;
   trackPageViewEvent: (details: {
     tracker: string | null;
     eventData: PageViewProps;

package/src/utils.ts

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 'use strict';
 
 /**

package/src/webViewInterface.ts

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 'use strict';
 
 import {

package/yarn.lock

@@ -2036,10 +2036,10 @@
   dependencies:
     "@sinonjs/commons" "^1.7.0"
 
-"@snowplow/tracker-core@3.8.0":
-  version "3.8.0"
-  resolved "https://registry.yarnpkg.com/@snowplow/tracker-core/-/tracker-core-3.8.0.tgz#bedcd84cdede8df4b8275f6031d57342e0d87769"
-  integrity sha512-fBQhHetV5c5s+Ea5bqaWrAcwG7C7Fdo0ztHKxvoVECwxMocWuTuiau0oM+dzkcjNyMoCa7bvX8BUNySvwwSrZA==
+"@snowplow/tracker-core@3.21.0":
+  version "3.21.0"
+  resolved "https://registry.yarnpkg.com/@snowplow/tracker-core/-/tracker-core-3.21.0.tgz#c1241ff06d59550e4a97aeb12a023d22baa3a316"
+  integrity sha512-zNxEZgibTofk29vklbasPv0GP2R7URPyhB+Vd3q5d5gPPTwjZXQ6X/EDHHCK9YFC9u0I+NAcgDm7GEGMm6ib4A==
   dependencies:
     tslib "^2.3.1"
     uuid "^3.4.0"