@snowplow/react-native-tracker 1.3.0 → 2.0.0

package/src/utils.ts

@@ -0,0 +1,78 @@
+/*
+ * 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';
+
+/**
+ * Returns a function that accepts a side-effect function as its argument and subscribes
+ * that function to aPromise's fullfillment,
+ * and errHandle to aPromise's rejection.
+ *
+ * @param aPromise - A void Promise
+ * @param errHandle - A function to handle the promise being rejected
+ * @returns - A function subscribed to the Promise's fullfillment
+ */
+function safeWait(aPromise: Promise<void>, errHandle: (err: Error) => void) {
+  return <F extends (...args: never[]) => Promise<void>>(func: F) => {
+    return (...args: Parameters<F>): Promise<void> => {
+      return aPromise.then(() => func(...args)).catch((err) => errHandle(err));
+    };
+  };
+}
+
+/**
+ * Returns a function that accepts a callback function as its argument and subscribes
+ * that function to aPromise's fullfillment,
+ * and errHandle to aPromise's rejection.
+ *
+ * @param aPromise - A void Promise
+ * @param errHandle - A function to handle the promise being rejected
+ * @returns - A function subscribed to the Promise's fullfillment
+ */
+function safeWaitCallback(
+  callPromise: Promise<void>,
+  errHandle: (err: Error) => undefined
+) {
+  return <T, F extends (...args: never[]) => Promise<T>>(func: F) => {
+    return (...args: Parameters<F>): ReturnType<F> | Promise<undefined> => {
+      return callPromise
+        .then(() => <ReturnType<F>>func(...args))
+        .catch((err) => errHandle(err));
+    };
+  };
+}
+
+/**
+ * Handles an error.
+ *
+ * @param err - The error to be handled.
+ */
+function errorHandler(err: Error): undefined {
+  if (__DEV__) {
+    console.warn('SnowplowTracker:' + err.message);
+    return undefined;
+  }
+  return undefined;
+}
+
+/**
+ * Helper to check whether its argument is of object type
+ *
+ * @param x - The argument to check.
+ * @returns - A boolean
+ */
+function isObject<Type>(x: Type): boolean {
+  return Object.prototype.toString.call(x) === '[object Object]';
+}
+
+export { safeWait, safeWaitCallback, errorHandler, isObject };

package/src/webViewInterface.ts

@@ -0,0 +1,105 @@
+/*
+ * 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 {
+  trackPageViewEvent,
+  trackScreenViewEvent,
+  trackSelfDescribingEvent,
+  trackStructuredEvent,
+} from './tracker';
+import type {
+  ScreenViewProps,
+  SelfDescribing,
+  StructuredProps,
+  WebViewPageViewEvent,
+  WebViewMessage,
+} from './types';
+import { errorHandler } from './utils';
+
+function forEachTracker(
+  trackers: Array<string> | undefined,
+  iterator: (namespace: string | null) => void
+): void {
+  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.
+ */
+export function getWebViewCallback() {
+  return (message: { nativeEvent: { data: string } }): void => {
+    const data = JSON.parse(message.nativeEvent.data) as WebViewMessage;
+    switch (data.command) {
+      case 'trackSelfDescribingEvent':
+        forEachTracker(data.trackers, (namespace) => {
+          trackSelfDescribingEvent(
+            namespace,
+            data.event as SelfDescribing,
+            data.context || []
+          ).catch((error) => {
+            errorHandler(error);
+          });
+        });
+        break;
+
+      case 'trackStructEvent':
+        forEachTracker(data.trackers, (namespace) => {
+          trackStructuredEvent(
+            namespace,
+            data.event as StructuredProps,
+            data.context || []
+          ).catch((error) => {
+            errorHandler(error);
+          });
+        });
+        break;
+
+      case 'trackPageView':
+        forEachTracker(data.trackers, (namespace) => {
+          const event = data.event as WebViewPageViewEvent;
+          trackPageViewEvent(namespace, {
+            pageTitle: event.title ?? '',
+            pageUrl: event.url ?? '',
+            referrer: event.referrer,
+          }).catch((error) => {
+            errorHandler(error);
+          });
+        });
+        break;
+
+      case 'trackScreenView':
+        forEachTracker(data.trackers, (namespace) => {
+          trackScreenViewEvent(
+            namespace,
+            data.event as ScreenViewProps,
+            data.context || []
+          ).catch((error) => {
+            errorHandler(error);
+          });
+        });
+        break;
+    }
+  };
+}

package/tsconfig.build.json

@@ -0,0 +1,5 @@
+
+{
+  "extends": "./tsconfig",
+  "exclude": ["example"]
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./",
+    "paths": {
+      "@snowplow/react-native-tracker": ["./src/index"]
+    },
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react",
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitReturns": true,
+    "noImplicitUseStrict": false,
+    "noStrictGenericChecks": false,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "esnext",
+    "verbatimModuleSyntax": true
+  }
+}

package/turbo.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "pipeline": {
+    "build:android": {
+      "inputs": [
+        "package.json",
+        "android",
+        "!android/build",
+        "src/*.ts",
+        "src/*.tsx",
+        "example/package.json",
+        "example/android",
+        "!example/android/.gradle",
+        "!example/android/build",
+        "!example/android/app/build"
+      ],
+      "outputs": []
+    },
+    "build:ios": {
+      "inputs": [
+        "package.json",
+        "*.podspec",
+        "ios",
+        "src/*.ts",
+        "src/*.tsx",
+        "example/package.json",
+        "example/ios",
+        "!example/ios/build",
+        "!example/ios/Pods"
+      ],
+      "outputs": []
+    }
+  }
+}