@snowplow/react-native-tracker 1.2.1 → 1.4.0

package/dist/index.js

@@ -1,21 +1,9 @@
 import { NativeModules } from 'react-native';
+import { trackerCore, buildSelfDescribingEvent, buildStructEvent, buildPageView, buildConsentGranted, buildConsentWithdrawn, buildEcommerceTransactionItem, buildEcommerceTransaction } from '@snowplow/tracker-core';
+import { v4 } from 'uuid';
 
 /*
- * 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.
- * 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.
- */
-const { RNSnowplowTracker } = NativeModules;
-
-/*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
@@ -81,7 +69,7 @@ function isObject(x) {
 }
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
@@ -148,9 +136,397 @@ const logMessages = {
     setColorDepth: 'setColorDepth: colorDepth can only be a number(integer) or null',
     setSubjectData: 'setSubjectData:',
 };
+const schemas = {
+    payloadData: 'iglu:com.snowplowanalytics.snowplow/payload_data/jsonschema/1-0-4',
+    timingSchema: 'iglu:com.snowplowanalytics.snowplow/timing/jsonschema/1-0-0',
+    deepLinkReceivedSchema: 'iglu:com.snowplowanalytics.mobile/deep_link_received/jsonschema/1-0-0',
+    messageNotificationSchema: 'iglu:com.snowplowanalytics.mobile/message_notification/jsonschema/1-0-0',
+    screenViewSchema: 'iglu:com.snowplowanalytics.mobile/screen_view/jsonschema/1-0-0',
+};
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
+ */
+// Tracker version added to the events
+const trackerVersion = 'rn-1.4.0';
+let trackers = {};
+function preparePayload(payload) {
+    const stringifiedPayload = {};
+    payload['stm'] = new Date().getTime().toString();
+    for (const key in payload) {
+        if (Object.prototype.hasOwnProperty.call(payload, key)) {
+            stringifiedPayload[key] = String(payload[key]);
+        }
+    }
+    return stringifiedPayload;
+}
+function createEmitCallback(networkConfig) {
+    return (e) => {
+        const postJson = {
+            schema: schemas.payloadData,
+            data: [preparePayload(e)],
+        };
+        const endpoint = networkConfig.endpoint;
+        const postPath = networkConfig.customPostPath ?? '/com.snowplowanalytics.snowplow/tp2';
+        const headers = networkConfig.requestHeaders ?? {};
+        fetch(endpoint + postPath, {
+            method: 'POST',
+            body: JSON.stringify(postJson),
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+        }).catch(errorHandler);
+    };
+}
+function updateTrackerProperties(tracker, configuration) {
+    tracker.setPlatform(configuration.trackerConfig?.devicePlatform ?? 'mob');
+    tracker.setTrackerVersion(trackerVersion);
+    tracker.setTrackerNamespace(configuration.namespace);
+    if (configuration.trackerConfig?.appId != null) {
+        tracker.setAppId(configuration.trackerConfig.appId);
+    }
+    if (configuration.subjectConfig?.colorDepth != null) {
+        tracker.setColorDepth(String(configuration.subjectConfig.colorDepth));
+    }
+    if (configuration.subjectConfig?.domainUserId != null) {
+        tracker.setDomainUserId(configuration.subjectConfig.domainUserId);
+    }
+    if (configuration.subjectConfig?.ipAddress != null) {
+        tracker.setIpAddress(configuration.subjectConfig.ipAddress);
+    }
+    if (configuration.subjectConfig?.language != null) {
+        tracker.setLang(configuration.subjectConfig.language);
+    }
+    if (configuration.subjectConfig?.screenResolution != null) {
+        tracker.setScreenResolution(String(configuration.subjectConfig.screenResolution[0]), String(configuration.subjectConfig.screenResolution[1]));
+    }
+    if (configuration.subjectConfig?.screenViewport != null) {
+        tracker.setViewport(String(configuration.subjectConfig.screenViewport[0]), String(configuration.subjectConfig.screenViewport[1]));
+    }
+    if (configuration.subjectConfig?.timezone != null) {
+        tracker.setTimezone(configuration.subjectConfig.timezone);
+    }
+    if (configuration.subjectConfig?.userId != null) {
+        tracker.setUserId(configuration.subjectConfig.userId);
+    }
+    if (configuration.subjectConfig?.useragent != null) {
+        tracker.setUseragent(configuration.subjectConfig.useragent);
+    }
+}
+function createTracker$2(configuration, emitCallback) {
+    // create an emit callback if not given
+    const emitter = emitCallback ?? createEmitCallback(configuration.networkConfig);
+    // the tracker core does not provide an option to set the duid, so we need to add custom
+    let domainUserId;
+    const setDomainUserId = (userId) => {
+        domainUserId = userId;
+    };
+    let networkUserId;
+    const setNetworkUserId = (userId) => {
+        networkUserId = userId;
+    };
+    // initialize the tracker core
+    const core = trackerCore({
+        base64: configuration.trackerConfig?.base64Encoding ?? true,
+        callback: (payload) => {
+            if (domainUserId != null) {
+                payload.add('duid', domainUserId);
+            }
+            if (networkUserId != null) {
+                payload.add('tnuid', networkUserId);
+            }
+            const builtPayload = payload.build();
+            emitter(builtPayload);
+        },
+    });
+    const tracker = { ...core, setDomainUserId, setNetworkUserId };
+    trackers[configuration.namespace] = tracker;
+    // update tracker properties to reflect subject and tracker info
+    updateTrackerProperties(tracker, configuration);
+    return Promise.resolve();
+}
+function removeTracker$2(details) {
+    delete trackers[details.tracker];
+    return Promise.resolve(true);
+}
+function removeAllTrackers$2() {
+    trackers = {};
+    return Promise.resolve(true);
+}
+function forTracker(namespace, callback) {
+    const tracker = namespace != null ? trackers[namespace] : Object.values(trackers)[0];
+    if (tracker) {
+        callback(tracker);
+    }
+    else {
+        errorHandler(new Error('No such tracker found.'));
+    }
+}
+function trackSelfDescribingEvent$2(details) {
+    forTracker(details.tracker, (tracker) => {
+        tracker.track(buildSelfDescribingEvent({
+            event: details.eventData,
+        }), details.contexts);
+    });
+    return Promise.resolve();
+}
+function trackStructuredEvent$2(details) {
+    forTracker(details.tracker, (tracker) => {
+        tracker.track(buildStructEvent(details.eventData), details.contexts);
+    });
+    return Promise.resolve();
+}
+function trackScreenViewEvent$2(details) {
+    const data = {
+        name: details.eventData.name,
+        id: details.eventData.id ?? v4()
+    };
+    if (details.eventData.type != null) {
+        data.type = details.eventData.type;
+    }
+    if (details.eventData.previousName != null) {
+        data.previousName = details.eventData.previousName;
+    }
+    if (details.eventData.previousId != null) {
+        data.previousId = details.eventData.previousId;
+    }
+    if (details.eventData.previousType != null) {
+        data.previousType = details.eventData.previousType;
+    }
+    if (details.eventData.transitionType != null) {
+        data.transitionType = details.eventData.transitionType;
+    }
+    return trackSelfDescribingEvent$2({
+        tracker: details.tracker,
+        eventData: {
+            schema: schemas.screenViewSchema,
+            data: data
+        },
+        contexts: details.contexts,
+    });
+}
+function trackPageViewEvent$2(details) {
+    forTracker(details.tracker, (tracker) => {
+        tracker.track(buildPageView(details.eventData), details.contexts);
+    });
+    return Promise.resolve();
+}
+function trackTimingEvent$2(details) {
+    return trackSelfDescribingEvent$2({
+        tracker: details.tracker,
+        eventData: {
+            schema: schemas.timingSchema,
+            data: details.eventData,
+        },
+        contexts: details.contexts,
+    });
+}
+function trackConsentGrantedEvent$2(details) {
+    forTracker(details.tracker, (tracker) => {
+        const built = buildConsentGranted({
+            id: details.eventData.documentId,
+            version: details.eventData.version,
+            name: details.eventData.name,
+            description: details.eventData.documentDescription,
+            expiry: details.eventData.expiry,
+        });
+        tracker.track(built.event, details.contexts.concat(built.context));
+    });
+    return Promise.resolve();
+}
+function trackConsentWithdrawnEvent$2(details) {
+    forTracker(details.tracker, (tracker) => {
+        const built = buildConsentWithdrawn({
+            all: details.eventData.all,
+            id: details.eventData.documentId,
+            version: details.eventData.version,
+            name: details.eventData.name,
+            description: details.eventData.documentDescription,
+        });
+        tracker.track(built.event, details.contexts.concat(built.context));
+    });
+    return Promise.resolve();
+}
+function trackEcommerceTransactionEvent$2(details) {
+    forTracker(details.tracker, (tracker) => {
+        details.eventData.items.forEach(item => {
+            tracker.track(buildEcommerceTransactionItem({
+                ...item,
+                orderId: details.eventData.orderId
+            }), details.contexts);
+        });
+        tracker.track(buildEcommerceTransaction({
+            orderId: details.eventData.orderId,
+            total: details.eventData.totalValue,
+            affiliation: details.eventData.affiliation,
+            tax: details.eventData.taxValue,
+            shipping: details.eventData.shipping,
+            city: details.eventData.city,
+            state: details.eventData.state,
+            country: details.eventData.country,
+            currency: details.eventData.currency,
+        }), details.contexts);
+    });
+    return Promise.resolve();
+}
+function trackDeepLinkReceivedEvent$2(details) {
+    return trackSelfDescribingEvent$2({
+        tracker: details.tracker,
+        eventData: {
+            schema: schemas.deepLinkReceivedSchema,
+            data: details.eventData,
+        },
+        contexts: details.contexts,
+    });
+}
+function trackMessageNotificationEvent$2(details) {
+    return trackSelfDescribingEvent$2({
+        tracker: details.tracker,
+        eventData: {
+            schema: schemas.messageNotificationSchema,
+            data: details.eventData,
+        },
+        contexts: details.contexts,
+    });
+}
+function removeGlobalContexts$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function addGlobalContexts$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function setUserId$2(details) {
+    trackers[details.tracker]?.setUserId(details.userId ?? '');
+    return Promise.resolve();
+}
+function setNetworkUserId$2(details) {
+    trackers[details.tracker]?.setNetworkUserId(details.networkUserId ?? '');
+    return Promise.resolve();
+}
+function setDomainUserId$2(details) {
+    trackers[details.tracker]?.setDomainUserId(details.domainUserId ?? '');
+    return Promise.resolve();
+}
+function setIpAddress$2(details) {
+    trackers[details.tracker]?.setIpAddress(details.ipAddress ?? '');
+    return Promise.resolve();
+}
+function setUseragent$2(details) {
+    trackers[details.tracker]?.setUseragent(details.useragent ?? '');
+    return Promise.resolve();
+}
+function setTimezone$2(details) {
+    trackers[details.tracker]?.setTimezone(details.timezone ?? '');
+    return Promise.resolve();
+}
+function setLanguage$2(details) {
+    trackers[details.tracker]?.setLang(details.language ?? '');
+    return Promise.resolve();
+}
+function setScreenResolution$2(details) {
+    if (details.screenResolution) {
+        trackers[details.tracker]?.setScreenResolution(String(details.screenResolution[0]), String(details.screenResolution[1]));
+    }
+    else {
+        trackers[details.tracker]?.addPayloadPair('res', '');
+    }
+    return Promise.resolve();
+}
+function setScreenViewport$2(details) {
+    if (details.screenViewport) {
+        trackers[details.tracker]?.setViewport(String(details.screenViewport[0]), String(details.screenViewport[1]));
+    }
+    else {
+        trackers[details.tracker]?.addPayloadPair('vp', '');
+    }
+    return Promise.resolve();
+}
+function setColorDepth$2(details) {
+    trackers[details.tracker]?.setColorDepth(String(details.colorDepth ?? ''));
+    return Promise.resolve();
+}
+function getSessionUserId$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function getSessionId$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function getSessionIndex$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function getIsInBackground$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function getBackgroundIndex$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+function getForegroundIndex$1() {
+    return Promise.reject(new Error('Not implemented'));
+}
+const JSSnowplowTracker = Object.freeze({
+    createTracker: createTracker$2,
+    removeTracker: removeTracker$2,
+    removeAllTrackers: removeAllTrackers$2,
+    trackSelfDescribingEvent: trackSelfDescribingEvent$2,
+    trackStructuredEvent: trackStructuredEvent$2,
+    trackScreenViewEvent: trackScreenViewEvent$2,
+    trackPageViewEvent: trackPageViewEvent$2,
+    trackTimingEvent: trackTimingEvent$2,
+    trackConsentGrantedEvent: trackConsentGrantedEvent$2,
+    trackConsentWithdrawnEvent: trackConsentWithdrawnEvent$2,
+    trackEcommerceTransactionEvent: trackEcommerceTransactionEvent$2,
+    trackDeepLinkReceivedEvent: trackDeepLinkReceivedEvent$2,
+    trackMessageNotificationEvent: trackMessageNotificationEvent$2,
+    removeGlobalContexts: removeGlobalContexts$1,
+    addGlobalContexts: addGlobalContexts$1,
+    setUserId: setUserId$2,
+    setNetworkUserId: setNetworkUserId$2,
+    setDomainUserId: setDomainUserId$2,
+    setIpAddress: setIpAddress$2,
+    setUseragent: setUseragent$2,
+    setTimezone: setTimezone$2,
+    setLanguage: setLanguage$2,
+    setScreenResolution: setScreenResolution$2,
+    setScreenViewport: setScreenViewport$2,
+    setColorDepth: setColorDepth$2,
+    getSessionUserId: getSessionUserId$1,
+    getSessionId: getSessionId$1,
+    getSessionIndex: getSessionIndex$1,
+    getIsInBackground: getIsInBackground$1,
+    getBackgroundIndex: getBackgroundIndex$1,
+    getForegroundIndex: getForegroundIndex$1,
+});
+
+/*
+ * 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.
+ */
+const isAvailable = NativeModules.RNSnowplowTracker != null;
+if (!isAvailable) {
+    errorHandler(new Error('Unable to access the native iOS/Android Snowplow tracker, a tracker implementation with very limited functionality is used.'));
+}
+const RNSnowplowTracker = isAvailable ? NativeModules.RNSnowplowTracker : JSSnowplowTracker;
+
+/*
+ * 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.
@@ -394,7 +770,7 @@ function validateEcommerceTransaction(argmap) {
 }
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
@@ -408,7 +784,12 @@ function validateEcommerceTransaction(argmap) {
 /**
  * Configuration properties
  */
-const networkProps = ['endpoint', 'method'];
+const networkProps = [
+    'endpoint',
+    'method',
+    'customPostPath',
+    'requestHeaders',
+];
 const trackerProps = [
     'appId',
     'devicePlatform',
@@ -424,7 +805,8 @@ const trackerProps = [
     'lifecycleAutotracking',
     'installAutotracking',
     'exceptionAutotracking',
-    'diagnosticAutotracking'
+    'diagnosticAutotracking',
+    'userAnonymisation'
 ];
 const sessionProps = [
     'foregroundTimeout',
@@ -436,6 +818,7 @@ const emitterProps = [
     'threadPoolSize',
     'byteLimitPost',
     'byteLimitGet',
+    'serverAnonymisation',
 ];
 const subjectProps = [
     'userId',
@@ -641,7 +1024,7 @@ function initValidate(init) {
 }
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
@@ -854,7 +1237,7 @@ function trackMessageNotificationEvent$1(namespace, argmap, contexts = []) {
 }
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
@@ -1077,7 +1460,7 @@ function setSubjectData$1(namespace, config) {
 }
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
@@ -1454,7 +1837,77 @@ function getForegroundIndex(namespace) {
 }
 
 /*
- * Copyright (c) 2020-2022 Snowplow Analytics Ltd. All rights reserved.
+ * 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.
+ */
+function forEachTracker(trackers, iterator) {
+    if (trackers && trackers.length > 0) {
+        trackers.forEach(iterator);
+    }
+    else {
+        iterator(null);
+    }
+}
+/**
+ * Enables tracking events from apps rendered in react-native-webview components.
+ * The apps need to use the Snowplow WebView tracker to track the events.
+ *
+ * To subscribe for the events, set the `onMessage` attribute:
+ * <WebView onMessage={getWebViewCallback()} ... />
+ *
+ * @returns Callback to subscribe for events from Web views tracked using the Snowplow WebView tracker.
+ */
+function getWebViewCallback() {
+    return (message) => {
+        const data = JSON.parse(message.nativeEvent.data);
+        switch (data.command) {
+            case 'trackSelfDescribingEvent':
+                forEachTracker(data.trackers, (namespace) => {
+                    trackSelfDescribingEvent$1(namespace, data.event, data.context || []).catch((error) => {
+                        errorHandler(error);
+                    });
+                });
+                break;
+            case 'trackStructEvent':
+                forEachTracker(data.trackers, (namespace) => {
+                    trackStructuredEvent$1(namespace, data.event, data.context || []).catch((error) => {
+                        errorHandler(error);
+                    });
+                });
+                break;
+            case 'trackPageView':
+                forEachTracker(data.trackers, (namespace) => {
+                    const event = data.event;
+                    trackPageViewEvent$1(namespace, {
+                        pageTitle: event.title ?? '',
+                        pageUrl: event.url ?? '',
+                        referrer: event.referrer,
+                    }).catch((error) => {
+                        errorHandler(error);
+                    });
+                });
+                break;
+            case 'trackScreenView':
+                forEachTracker(data.trackers, (namespace) => {
+                    trackScreenViewEvent$1(namespace, data.event, data.context || []).catch((error) => {
+                        errorHandler(error);
+                    });
+                });
+                break;
+        }
+    };
+}
+
+/*
+ * 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.
@@ -1569,5 +2022,5 @@ function removeAllTrackers() {
         .catch((e) => errorHandler(e));
 }
 
-export { createTracker, removeAllTrackers, removeTracker };
+export { createTracker, getWebViewCallback, removeAllTrackers, removeTracker };
 //# sourceMappingURL=index.js.map