react-native-mparticle 2.5.0 → 2.6.2

package/README.md

@@ -3,38 +3,58 @@
 [![npm version](https://badge.fury.io/js/react-native-mparticle.svg)](https://badge.fury.io/js/react-native-mparticle)
 [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](http://standardjs.com/)
 
+React Native allows developers to use a single code base to deploy features to multiple platforms. With the mParticle React Native library, you can leverage a single API to deploy your data to hundreds of integrations from your iOS and Android apps.
+
+### Supported Features
+| Method | Android | iOS |
+| ---    | ---     | --- |
+| Custom Events | <li> [X] </li> | <li> [X]  </li> |
+| Page Views | <li> [X]  </li> | <li> [X]  </li> |
+| Identity | <li> [X]  </li> | <li> [X]  </li> |
+| eCommerce | <li> [X]  </li> | <li> [X]  </li> |
+| Consent | <li> [X]  </li> | <li> [X]  </li> |
+
 # Installation
 
-**First, download the library** from npm:
+1. **Download and install the mParticle React Native library** from npm:
 
 ```bash
 $ npm install react-native-mparticle --save
 ```
 
-**Second, install the native dependencies**. You can use `rnpm` (now part of `react-native` core via `link`) to add native dependencies automatically:
+2. **Install the native dependencies**. You can use `rnpm` (now part of `react-native` core via `link`) to add native dependencies automatically:
 
 ```bash
 $ react-native link
 ```
 
-**Grab your mParticle key and secret** from [your app's dashboard][1] and move on to the OS-specific instructions below.
+## <a name="iOS"></a>iOS
 
-[1]: https://app.mparticle.com/apps
+1. **Copy your mParticle key and secret** from [your app's dashboard][1].
 
-## <a name="iOS"></a>iOS
+[1]: https://app.mparticle.com/setup/inputs/apps
 
-**Install the SDK** using CocoaPods:
+2. **Install the SDK** using CocoaPods:
 
 ```bash
 $ # Update your Podfile to depend on 'mParticle-Apple-SDK' version 7.2.0 or later
 $ pod install
 ```
 
-The mParticle SDK is initialized by calling the `startWithOptions` method within the `application:didFinishLaunchingWithOptions:` delegate call. Preferably the location of the initialization method call should be one of the last statements in the `application:didFinishLaunchingWithOptions:`. The `startWithOptions` method requires an options argument containing your key and secret and an initial Identity request.
+The mParticle SDK is initialized by calling the `startWithOptions` method within the `application:didFinishLaunchingWithOptions:` delegate call.
+
+Preferably the location of the initialization method call should be one of the last statements in the `application:didFinishLaunchingWithOptions:`.
+
+The `startWithOptions` method requires an options argument containing your key and secret and an initial Identity request.
+
+> Note that you must initialize the SDK in the `application:didFinishLaunchingWithOptions:` method. Other parts of the SDK rely on the `UIApplicationDidBecomeActiveNotification` notification to function properly. Failing to start the SDK as indicated will impair it. Also, please do **not** use _GCD_'s `dispatch_async` to start the SDK.
 
-> Note that it is imperative for the SDK to be initialized in the `application:didFinishLaunchingWithOptions:` method. Other parts of the SDK rely on the `UIApplicationDidBecomeActiveNotification` notification to function properly. Failing to start the SDK as indicated will impair it. Also, please do **not** use _GCD_'s `dispatch_async` to start the SDK.
+For more help, see [the iOS set up docs](https://docs.mparticle.com/developers/sdk/ios/getting-started/#create-an-input).
 
-#### Swift
+3. Import and start the mParticle Apple SDK into Swift or Objective-C.
+
+
+#### Swift Example
 
 ```swift
 import mParticle_Apple_SDK
@@ -62,7 +82,7 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
 }
 ```
 
-#### Objective-C
+#### Objective-C Example
 
 For apps supporting iOS 8 and above, Apple recommends using the import syntax for **modules** or **semantic import**. However, if you prefer the traditional CocoaPods and static libraries delivery mechanism, that is fully supported as well.
 
@@ -107,15 +127,17 @@ Next, you'll need to start the SDK:
 }
 ```
 
-Please see [Identity](http://docs.mparticle.com/developers/sdk/ios/identity/) for more information on supplying an `MPIdentityApiRequest` object during SDK initialization.
+See [Identity](http://docs.mparticle.com/developers/sdk/ios/identity/) for more information on supplying an `MPIdentityApiRequest` object during SDK initialization.
 
 
 ## <a name="Android"></a>Android
 
-1. Grab your mParticle key and secret from [your workspace's dashboard](https://app.mparticle.com/apps) and construct an `MParticleOptions` object.
+1. Copy your mParticle key and secret from [your workspace's dashboard](https://app.mparticle.com/setup/inputs/apps) and construct an `MParticleOptions` object.
 
 2. Call `start` from the `onCreate` method of your app's `Application` class. It's crucial that the SDK be started here for proper session management. If you don't already have an `Application` class, create it and then specify its fully-qualified name in the `<application>` tag of your app's `AndroidManifest.xml`.
 
+For more help, see [the Android set up docs](https://docs.mparticle.com/developers/sdk/android/getting-started/#create-an-input).
+
 ```java
 package com.example.myapp;
 
@@ -143,28 +165,26 @@ public class MyApplication extends Application {
 }
 ```
 
-> **Warning:** It's generally not a good idea to log events in your `Application.onCreate()`. Android may instantiate your `Application` class for a lot of reasons, in the background, while the user isn't even using their device. 
+> **Warning:** Don't log events in your `Application.onCreate()`. Android may instantiate your `Application` class in the background without your knowledge, including when the user isn't using their device, and lead to unexpected results. 
 
 
 # Usage
 
-## Import
-
-**Importing** the module:
+## Import the mParticle Module
 
 ```js
 import MParticle from 'react-native-mparticle'
 ```
 
-## Events
+## Logging Events
 
-**Logging** events:
+To log basic events:
 
 ```js
 MParticle.logEvent('Test event', MParticle.EventType.Other, { 'Test key': 'Test value' })
 ```
 
-**Logging** commerce events:
+To log commerce events:
 
 ```js
 const product = new MParticle.Product('Test product for cart', '1234', 19.99)
@@ -189,16 +209,16 @@ const event = MParticle.CommerceEvent.createImpressionEvent([impression])
 MParticle.logCommerceEvent(event)
 ```
 
-**Logging** screen events:
+To log screen events:
 
 ```js
 MParticle.logScreenEvent('Test screen', { 'Test key': 'Test value' })
 ```
 
 ## User
-**Setting** user attributes and tags:
 
-Use Identify or currentUser to retrieve the userID for these calls
+To set, remove, and get user details, call the `User` or `Identity` methods as follows:
+
 ```js
 MParticle.User.setUserAttribute('User ID', 'Test key', 'Test value')
 ```
@@ -254,9 +274,6 @@ MParticle.Identity.getCurrentUser((currentUser) => {
 });
 ```
 
-**Using** static methods to update and change identity
-
-
 ```js
 var request = new MParticle.IdentityRequest();
 
@@ -330,7 +347,7 @@ MParticle.setOptOut(!isOptedOut);
 
 ## Push Registration
 
-The method `MParticle.logPushRegistration()` accepts 2 parameters. For Android, provide both the pushToken and senderId. For iOS, provide the push token in the first parameter, and simply pass `null` for the second parameter
+The method `MParticle.logPushRegistration()` accepts 2 parameters. For Android, provide both the `pushToken` and `senderId`. For iOS, provide the push token in the first parameter, and simply pass `null` for the second parameter.
 
 ### Android
 

package/android/.classpath

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11/"/>
+	<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
+	<classpathentry kind="output" path="bin/default"/>
+</classpath>

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Wed Mar 17 12:51:17 EDT 2021
+gradle.version=5.4.1

package/android/.project

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>android</name>
+	<comment>Project android created by Buildship.</comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.buildship.core.gradleprojectbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
+	</natures>
+	<filteredResources>
+		<filter>
+			<id>1630678802180</id>
+			<name></name>
+			<type>30</type>
+			<matcher>
+				<id>org.eclipse.core.resources.regexFilterMatcher</id>
+				<arguments>node_modules|.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments>
+			</matcher>
+		</filter>
+	</filteredResources>
+</projectDescription>

package/android/.settings/org.eclipse.buildship.core.prefs

@@ -0,0 +1,13 @@
+arguments=
+auto.sync=false
+build.scans.enabled=false
+connection.gradle.distribution=GRADLE_DISTRIBUTION(WRAPPER)
+connection.project.dir=
+eclipse.preferences.version=1
+gradle.user.home=
+java.home=/Library/Java/JavaVirtualMachines/adoptopenjdk-11.jdk/Contents/Home
+jvm.arguments=
+offline.mode=false
+override.workspace.settings=true
+show.console.view=true
+show.executions.view=true

package/android/build.gradle

@@ -24,7 +24,7 @@ android {
 
 buildscript {
     repositories {
-        jcenter()
+        mavenCentral()
         google()
     }
     dependencies {
@@ -33,7 +33,7 @@ buildscript {
 }
 
 repositories {
-    jcenter()
+    mavenCentral()
     google()
 }
 

package/android/src/main/java/com/mparticle/react/MParticleModule.java

@@ -86,9 +86,9 @@ public class MParticleModule extends ReactContextBaseJavaModule {
     }
 
     @ReactMethod
-    public void logScreenEvent(final String event, final ReadableMap attributesMap) {
+    public void logScreenEvent(final String event, final ReadableMap attributesMap, final boolean shouldUploadEvent) {
         Map<String, String> attributes = ConvertStringMap(attributesMap);
-        MParticle.getInstance().logScreen(event, attributes);
+        MParticle.getInstance().logScreen(event, attributes, shouldUploadEvent);
     }
 
     @ReactMethod
@@ -595,6 +595,19 @@ public class MParticleModule extends ReactContextBaseJavaModule {
         if (map.hasKey("shouldUploadEvent")) {
             builder.shouldUploadEvent(map.getBoolean("shouldUploadEvent"));
         }
+        if (map.hasKey("customAttributes")) {
+            builder.customAttributes(ConvertStringMap(map.getMap("customAttributes")));
+        }
+        if (map.hasKey("currency")) {
+            builder.currency(map.getString("currency"));
+        }
+        if (map.hasKey("checkoutStep")) {
+            builder.checkoutStep(map.getInt("checkoutStep"));
+        }
+        if (map.hasKey("checkoutOptions")) {
+            builder.checkoutOptions(map.getString("checkoutOptions"));
+        }
+
 
         return builder.build();
     }

package/ios/RNMParticle/RNMParticle.m

@@ -34,9 +34,9 @@ RCT_EXPORT_METHOD(logCommerceEvent:(MPCommerceEvent *)commerceEvent)
     [[MParticle sharedInstance] logCommerceEvent:commerceEvent];
 }
 
-RCT_EXPORT_METHOD(logScreenEvent:(NSString *)screenName attributes:(NSDictionary *)attributes)
+RCT_EXPORT_METHOD(logScreenEvent:(NSString *)screenName attributes:(NSDictionary *)attributes shouldUploadEvent:(BOOL)shouldUploadEvent)
 {
-    [[MParticle sharedInstance] logScreen:screenName eventInfo:attributes];
+    [[MParticle sharedInstance] logScreen:screenName eventInfo:attributes shouldUploadEvent:shouldUploadEvent];
 }
 
 RCT_EXPORT_METHOD(setATTStatus:(NSInteger)status withATTStatusTimestampMillis:(nonnull NSNumber *)timestamp)
@@ -413,11 +413,13 @@ typedef NS_ENUM(NSUInteger, MPReactCommerceEventAction) {
     commerceEvent.productListSource = json[@"productActionListSource"];
     commerceEvent.screenName = json[@"screenName"];
     commerceEvent.transactionAttributes = [RCTConvert MPTransactionAttributes:json[@"transactionAttributes"]];
-    commerceEvent.action = [RCTConvert MPCommerceEventAction:json[@"productActionType"]];
     commerceEvent.checkoutStep = [json[@"checkoutStep"] intValue];
     commerceEvent.nonInteractive = [json[@"nonInteractive"] boolValue];
     if (json[@"shouldUploadEvent"] != nil) {
-        event.shouldUploadEvent = [json[@"shouldUploadEvent"] boolValue]
+        commerceEvent.shouldUploadEvent = [json[@"shouldUploadEvent"] boolValue];
+    }
+    if (json[@"customAttributes"] != nil) {
+        commerceEvent.customAttributes = json[@"customAttributes"];
     }
 
     NSMutableArray *products = [NSMutableArray array];
@@ -606,7 +608,7 @@ typedef NS_ENUM(NSUInteger, MPReactCommerceEventAction) {
     event.startTime = json[@"startTime"];
     event.type = [json[@"type"] intValue];
     if (json[@"shouldUploadEvent"] != nil) {
-        event.shouldUploadEvent = [json[@"shouldUploadEvent"] boolValue]
+        event.shouldUploadEvent = [json[@"shouldUploadEvent"] boolValue];
     }
 
     NSDictionary *jsonFlags = json[@"customFlags"];

package/ios/RNMParticle.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:">
+   </FileRef>
+</Workspace>

package/ios/RNMParticle.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

package/ios/RNMParticle.xcodeproj/xcuserdata/bstalnaker.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Bucket
+   uuid = "39402CF6-7BAB-4033-9C4A-41AE5477C134"
+   type = "1"
+   version = "2.0">
+</Bucket>

package/ios/RNMParticle.xcodeproj/xcuserdata/bstalnaker.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>SchemeUserState</key>
+	<dict>
+		<key>RNMParticle.xcscheme_^#shared#^_</key>
+		<dict>
+			<key>orderHint</key>
+			<integer>0</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

package/js/index.js

@@ -96,8 +96,8 @@ const logCommerceEvent = (commerceEvent) => {
   NativeModules.MParticle.logCommerceEvent(commerceEvent)
 }
 
-const logScreenEvent = (screenName, attributes = null) => {
-  NativeModules.MParticle.logScreenEvent(screenName, attributes)
+const logScreenEvent = (screenName, attributes = null, shouldUploadEvent = true) => {
+  NativeModules.MParticle.logScreenEvent(screenName, attributes, shouldUploadEvent)
 }
 
 // Use ATTAuthStatus constants for status

package/package.json

@@ -4,7 +4,7 @@
   "homepage": "https://www.mparticle.com",
   "license": "Apache-2.0",
   "repository": "mParticle/react-native-mparticle",
-  "version": "2.5.0",
+  "version": "2.6.2",
   "main": "js/index.js",
   "scripts": {
     "test": "./node_modules/standard/bin/cmd.js",