@snowplow/react-native-tracker 1.0.0-beta.1 → 1.2.0

package/dist/index.d.ts

@@ -18,6 +18,10 @@ declare type Basis = 'consent' | 'contract' | 'legal_obligation' | 'legitimate_i
  * BufferOption
  */
 declare type BufferOption = 'single' | 'default' | 'large';
+/**
+ * Trigger for MessageNotification event
+ */
+declare type Trigger = 'push' | 'location' | 'calendar' | 'timeInterval' | 'other';
 /**
  * ScreenSize
  */
@@ -25,7 +29,7 @@ declare type ScreenSize = [number, number];
 /**
  * SelfDescribing type
  */
-declare type SelfDescribing = {
+declare type SelfDescribing<T extends Record<keyof T, unknown> = Record<string, unknown>> = {
     /**
      * Schema
      */
@@ -33,7 +37,7 @@ declare type SelfDescribing = {
     /**
      * Data
      */
-    data: Record<string, unknown>;
+    data: T;
 };
 /**
  * EventContext type
@@ -97,6 +101,11 @@ interface TrackerConfiguration {
      * @defaultValue true
      */
     sessionContext?: boolean;
+    /**
+     * Whether to attach a Deep Link entity to the first ScreenView tracked in the tracker after DeepLinkReceived event.
+     * @defaultValue true
+     */
+    deepLinkContext?: boolean;
     /**
      * Whether screen context is attached to tracked events.
      * @defaultValue true
@@ -430,6 +439,104 @@ declare type EcommerceTransactionProps = {
     country?: string;
     currency?: string;
 };
+/**
+ * DeepLinkReceived event properties
+ * schema: iglu:com.snowplowanalytics.mobile/deep_link_received/jsonschema/1-0-0
+ */
+declare type DeepLinkReceivedProps = {
+    /**
+     * URL in the received deep-link.
+     */
+    url: string;
+    /**
+     * Referrer URL, source of this deep-link.
+     */
+    referrer?: string;
+};
+/**
+ * Attachment object that identify an attachment in the MessageNotification.
+ */
+declare type MessageNotificationAttachmentProps = {
+    identifier: string;
+    type: string;
+    url: string;
+};
+/**
+ * MessageNotification event properties
+ * schema: iglu:com.snowplowanalytics.mobile/message_notification/jsonschema/1-0-0
+ */
+declare type MessageNotificationProps = {
+    /**
+     * The action associated with the notification.
+     */
+    action?: string;
+    attachments?: MessageNotificationAttachmentProps[];
+    /**
+     * The notification's body.
+     */
+    body: string;
+    bodyLocArgs?: string[];
+    /**
+     * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
+     */
+    bodyLocKey?: string;
+    /**
+     * The category associated to the notification.
+     */
+    category?: string;
+    /**
+     * The application is notified of the delivery of the notification if it's in the foreground or background, the app will be woken up (iOS only).
+     */
+    contentAvailable?: boolean;
+    /**
+     * The group which this notification is part of.
+     */
+    group?: string;
+    /**
+     * The icon associated to the notification (Android only).
+     */
+    icon?: string;
+    /**
+     * The number of items this notification represent.
+     */
+    notificationCount?: number;
+    /**
+     * The time when the event of the notification occurred.
+     */
+    notificationTimestamp?: string;
+    /**
+     * The sound played when the device receives the notification.
+     */
+    sound?: string;
+    /**
+     * The notification's subtitle. (iOS only)
+     */
+    subtitle?: string;
+    /**
+     * An identifier similar to 'group' but usable for different purposes (Android only).
+     */
+    tag?: string;
+    /**
+     * An identifier similar to 'group' but usable for different purposes (iOS only).
+     */
+    threadIdentifier?: string;
+    /**
+     * The notification's title.
+     */
+    title: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in titleLocArgs to use to localize the title text to the user's current localization.
+     */
+    titleLocArgs?: string[];
+    /**
+     * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
+     */
+    titleLocKey?: string;
+    /**
+     * The trigger that raised the notification message. Must be one of: push, location, calendar, timeInterval, other
+     */
+    trigger: Trigger;
+};
 /**
  * The ReactNativeTracker type
  */
@@ -439,8 +546,9 @@ declare type ReactNativeTracker = {
      *
      * @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: (argmap: SelfDescribing, contexts?: EventContext[]) => Promise<void>;
+    readonly trackSelfDescribingEvent: <TData extends Record<keyof TData, unknown> = Record<string, unknown>>(argmap: SelfDescribing<TData>, contexts?: EventContext[]) => Promise<void>;
     /**
      * Tracks a screen-view event
      *
@@ -490,6 +598,20 @@ declare type ReactNativeTracker = {
      * @param contexts - The array of event contexts
      */
     readonly trackEcommerceTransactionEvent: (argmap: EcommerceTransactionProps, contexts?: EventContext[]) => Promise<void>;
+    /**
+     * Tracks a deep link received event
+     *
+     * @param argmap - The deep link received event properties
+     * @param contexts - The array of event contexts
+     */
+    readonly trackDeepLinkReceivedEvent: (argmap: DeepLinkReceivedProps, contexts?: EventContext[]) => Promise<void>;
+    /**
+     * Tracks a message notification event
+     *
+     * @param argmap - The message notification event properties
+     * @param contexts - The array of event contexts
+     */
+    readonly trackMessageNotificationEvent: (argmap: MessageNotificationProps, contexts?: EventContext[]) => Promise<void>;
     /**
      * Removes global contexts
      *
@@ -629,4 +751,4 @@ declare function removeTracker(trackerNamespace: string): Promise<boolean>;
  */
 declare function removeAllTrackers(): Promise<boolean>;
 
-export { Basis, BufferOption, ConsentDocument, ConsentGrantedProps, ConsentWithdrawnProps, DevicePlatform, EcommerceItem, EcommerceTransactionProps, EmitterConfiguration, EventContext, GCConfiguration, GdprConfiguration, GlobalContext, HttpMethod, LogLevel, NetworkConfiguration, PageViewProps, ReactNativeTracker, ScreenSize, ScreenViewProps, SelfDescribing, SessionConfiguration, StructuredProps, SubjectConfiguration, TimingProps, TrackerConfiguration, TrackerControllerConfiguration, createTracker, removeAllTrackers, removeTracker };
+export { Basis, BufferOption, ConsentDocument, ConsentGrantedProps, ConsentWithdrawnProps, DeepLinkReceivedProps, DevicePlatform, EcommerceItem, EcommerceTransactionProps, EmitterConfiguration, EventContext, GCConfiguration, GdprConfiguration, GlobalContext, HttpMethod, LogLevel, MessageNotificationProps, NetworkConfiguration, PageViewProps, ReactNativeTracker, ScreenSize, ScreenViewProps, SelfDescribing, SessionConfiguration, StructuredProps, SubjectConfiguration, TimingProps, TrackerConfiguration, TrackerControllerConfiguration, Trigger, createTracker, removeAllTrackers, removeTracker };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { NativeModules } from 'react-native';
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -15,7 +15,7 @@ import { NativeModules } from 'react-native';
 const { RNSnowplowTracker } = NativeModules;
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -81,7 +81,7 @@ function isObject(x) {
 }
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -114,6 +114,8 @@ const logMessages = {
     consentGReq: 'consentGranted event requires expiry, documentId and version parameters to be set',
     consentWReq: 'consentWithdrawn event requires all, documentId and version parameters to be set',
     ecomReq: 'ecommerceTransaction event requires orderId, totalValue to be set and items to be an array of valid ecommerceItems',
+    deepLinkReq: 'deepLinkReceived event requires the url parameter to be set',
+    messageNotificationReq: 'messageNotification event requires title, body, and trigger parameters to be set',
     // global contexts errors
     gcTagType: 'tag argument is required to be a string',
     gcType: 'global context argument is invalid',
@@ -129,6 +131,8 @@ const logMessages = {
     trackConsentGranted: 'trackConsentGranted:',
     trackConsentWithdrawn: 'trackConsentWithdrawn:',
     trackEcommerceTransaction: 'trackEcommerceTransaction:',
+    trackDeepLinkReceived: 'trackDeepLinkReceivedEvent:',
+    trackMessageNotification: 'trackMessageNotificationEvent:',
     removeGlobalContexts: 'removeGlobalContexts:',
     addGlobalContexts: 'addGlobalContexts:',
     // setters
@@ -146,7 +150,7 @@ const logMessages = {
 };
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -305,6 +309,43 @@ function validateConsentWithdrawn(argmap) {
     }
     return Promise.resolve(true);
 }
+/**
+ * Validates a deep link received event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateDeepLinkReceived(argmap) {
+    // validate type
+    if (!isObject(argmap)) {
+        return Promise.reject(new Error(logMessages.evType));
+    }
+    // validate required props
+    if (typeof argmap.url !== 'string') {
+        return Promise.reject(new Error(logMessages.deepLinkReq));
+    }
+    return Promise.resolve(true);
+}
+/**
+ * Validates a message notification event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateMessageNotification(argmap) {
+    // validate type
+    if (!isObject(argmap)) {
+        return Promise.reject(new Error(logMessages.evType));
+    }
+    // validate required props
+    if (typeof argmap.title !== 'string'
+        || typeof argmap.body !== 'string'
+        || typeof argmap.trigger !== 'string'
+        || !['push', 'location', 'calendar', 'timeInterval', 'other'].includes(argmap.trigger)) {
+        return Promise.reject(new Error(logMessages.messageNotificationReq));
+    }
+    return Promise.resolve(true);
+}
 /**
  * Validates whether an object is valid ecommerce-item
  *
@@ -353,7 +394,7 @@ function validateEcommerceTransaction(argmap) {
 }
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -377,6 +418,7 @@ const trackerProps = [
     'platformContext',
     'geoLocationContext',
     'sessionContext',
+    'deepLinkContext',
     'screenContext',
     'screenViewAutotracking',
     'lifecycleAutotracking',
@@ -599,7 +641,7 @@ function initValidate(init) {
 }
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -770,9 +812,49 @@ function trackEcommerceTransactionEvent$1(namespace, argmap, contexts = []) {
         throw new Error(`${logMessages.trackEcommerceTransaction} ${error.message}`);
     });
 }
+/**
+ * Tracks a deep link received event
+ *
+ * @param namespace {string} - the tracker namespace
+ * @param argmap {Object} - the event data
+ * @param contexts {Array}- the event contexts
+ * @returns {Promise}
+ */
+function trackDeepLinkReceivedEvent$1(namespace, argmap, contexts = []) {
+    return validateDeepLinkReceived(argmap)
+        .then(() => validateContexts(contexts))
+        .then(() => RNSnowplowTracker.trackDeepLinkReceivedEvent({
+        tracker: namespace,
+        eventData: argmap,
+        contexts: contexts
+    }))
+        .catch((error) => {
+        throw new Error(`${logMessages.trackDeepLinkReceived} ${error.message}`);
+    });
+}
+/**
+ * Tracks a message notification event
+ *
+ * @param namespace {string} - the tracker namespace
+ * @param argmap {Object} - the event data
+ * @param contexts {Array}- the event contexts
+ * @returns {Promise}
+ */
+function trackMessageNotificationEvent$1(namespace, argmap, contexts = []) {
+    return validateMessageNotification(argmap)
+        .then(() => validateContexts(contexts))
+        .then(() => RNSnowplowTracker.trackMessageNotificationEvent({
+        tracker: namespace,
+        eventData: argmap,
+        contexts: contexts
+    }))
+        .catch((error) => {
+        throw new Error(`${logMessages.trackMessageNotification} ${error.message}`);
+    });
+}
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -995,7 +1077,7 @@ function setSubjectData$1(namespace, config) {
 }
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -1127,6 +1209,28 @@ function trackEcommerceTransactionEvent(namespace) {
         return trackEcommerceTransactionEvent$1(namespace, argmap, contexts);
     };
 }
+/**
+ * Returns a function to track an DeepLinkReceived event by a tracker
+ *
+ * @param namespace {string} - The tracker namespace
+ * @returns - A function to track an DeepLinkReceived event
+ */
+function trackDeepLinkReceivedEvent(namespace) {
+    return function (argmap, contexts = []) {
+        return trackDeepLinkReceivedEvent$1(namespace, argmap, contexts);
+    };
+}
+/**
+ * Returns a function to track an MessageNotification event by a tracker
+ *
+ * @param namespace {string} - The tracker namespace
+ * @returns - A function to track an MessageNotification event
+ */
+function trackMessageNotificationEvent(namespace) {
+    return function (argmap, contexts = []) {
+        return trackMessageNotificationEvent$1(namespace, argmap, contexts);
+    };
+}
 /**
  * Returns a function to remove global contexts by a tracker
  *
@@ -1350,7 +1454,7 @@ function getForegroundIndex(namespace) {
 }
 
 /*
- * Copyright (c) 2020-2021 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2020-2022 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.
@@ -1389,6 +1493,8 @@ function createTracker(namespace, networkConfig, controllerConfig = {}) {
     const trackConsentGrantedEvent$1 = mkMethod(trackConsentGrantedEvent(namespace));
     const trackConsentWithdrawnEvent$1 = mkMethod(trackConsentWithdrawnEvent(namespace));
     const trackEcommerceTransactionEvent$1 = mkMethod(trackEcommerceTransactionEvent(namespace));
+    const trackDeepLinkReceivedEvent$1 = mkMethod(trackDeepLinkReceivedEvent(namespace));
+    const trackMessageNotificationEvent$1 = mkMethod(trackMessageNotificationEvent(namespace));
     // Global Contexts
     const removeGlobalContexts$1 = mkMethod(removeGlobalContexts(namespace));
     const addGlobalContexts$1 = mkMethod(addGlobalContexts(namespace));
@@ -1420,6 +1526,8 @@ function createTracker(namespace, networkConfig, controllerConfig = {}) {
         trackConsentGrantedEvent: trackConsentGrantedEvent$1,
         trackConsentWithdrawnEvent: trackConsentWithdrawnEvent$1,
         trackEcommerceTransactionEvent: trackEcommerceTransactionEvent$1,
+        trackDeepLinkReceivedEvent: trackDeepLinkReceivedEvent$1,
+        trackMessageNotificationEvent: trackMessageNotificationEvent$1,
         removeGlobalContexts: removeGlobalContexts$1,
         addGlobalContexts: addGlobalContexts$1,
         setUserId: setUserId$1,