fidel-react-native 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -1,63 +1,3 @@
 # Fidel React Native bridge library change log
 
-## 1.6.4
-- Updated the consent text for United States and Canadian issued cards.
-
-## 1.6.3
-- Replace "Fidel" with "Fidel API" in the consent text.
-- Allow expiration date editing on Android without switching to country selection.
-
-## 1.6.2
-- Update Fidel API logo
-
-## 1.6.2
-- Update Fidel API logo
-
-## 1.6.1
-- Always provide the `scheme` field in Android, after successful card enrollments.
-- Provide support for `resConfigs` optimization parameter in Android.
-
-## 1.6.0
-- Added the `defaultSelectedCountry` property which sets the country that will be selected by default, when opening the card enrollment screen.
-
-## 1.5.0
-- Remove card scanning confirmation screen.
-
-## 1.4.3
-- Add United Arab Emirates option as a country of issuance.
-- Country label shrinks its font size, to fit longer country names, on smaller devices.
-
-## 1.4.2
-- Update Fidel Android SDK version to allow French & Swedish translations be available in more countries.
-
-## 1.4.1
-- Update Fidel & Android SDK versions.
-- Prepare for the newest React Native versions.
-- Fix some unit tests.
-- Made it easier to automate testing this React Native bridge library.
-
-## 1.4.0
-
-- Now the SDK allows you to select multiple allowed countries from which the user can pick. Please check the docs for information about the new `allowedCountries` option.
-- Removed the `country` option. To set a default country and not allow the user to pick the country, set a single country in the new `allowedCountries` option. Check the example project or the README docs to see how to do that.
-- If available, the linking result object now includes the `firstNumbers` field. So, if in the Fidel Dashboard, under your security settings, you allow showing the first numbers of the linked card numbers, the information will be available in the linking result object too. If you do not allow showing the first numbers in the linking result, the `firstNumbers` field will return `"******"` (just like the object which the Fidel API returns).
-
-## 1.3.1
-
-- Fixes an Android issue in the latest React Native versions, when specifying the banner image in release environment.
-- Checking for `null` values, in mandatory SDK fields, to prevent unclear bugs.
-
-## 1.3.0
-
-- Localised the SDK for French and Swedish users.
-- The terms & conditions text now adjusts to the card scheme name that the user inputs (Visa, MasterCard or Amex).
-- If you set the default country of the SDK to USA or Canada (with `country` option) or, if you do not set a default country, the terms and conditions text will adjust depending on the country you have set. For USA & Canada, the following would be an example Terms & Conditions text, for Cashback Inc (an example company):
-
-*By submitting your card information and checking this box, you authorize Visa to monitor and share transaction data with Fidel (our service provider) to participate in  program. You also acknowledge and agree that Fidel may share certain details of your qualifying transactions with Cashback Inc to enable your participation in  program and for other purposes in accordance with the Cashback Inc Terms and Conditions, Cashback Inc privacy policy and Fidel’s Privacy Policy. You may opt-out of transaction monitoring on the linked card at any time by contacting support.*
-
-For the rest of the world:
-
-*I authorise Visa to monitor my payment card to identify transactions that qualify for a reward and for Visa to share such information with Cashback Inc, to enable my card linked offers and target offers that may be of interest to me. For information about Cashback Inc privacy practices, please see the privacy policy. You may opt-out of transaction monitoring on the payment card you entered at any time by contacting support.*
-
-- Added the `programName` and `termsConditionsUrl` options. They are used when building the new USA / Canada specific terms and conditions text that the user must agree with, before linking a card. If you set the `country` option to a USA or Canada, it's mandatory for you to provide your terms and conditions URL via `termsConditionsUrl`. If you do not provide it, you will receive an error when you try to open Fidel's linking screen.
-- Fixed bug that returned an empty link result in Android, when linking is successful.
+Please check our website for the latest information about our [React Native SDK releases](https://fidelapi.com/docs/select/sdks/react-native/releases).

package/README.md

@@ -1,143 +1,12 @@
-# Fidel React Native bridge SDK
+# Fidel React Native SDK
 
 This SDK is a bridge between React Native and Fidel's native iOS and Android SDKs. It helps you to add card linking technology to your React Native apps in minutes. It captures credit/debit card numbers securely and links them to your programs.
 
 ![Demo GIF](https://cl.ly/a47b1852f029/Screen%252520Recording%2525202018-09-18%252520at%25252004.34%252520PM.gif)
 
-## Getting started
+## Documentation
 
-`$ npm install fidel-react-native`
-
-or
-
-`$ yarn add fidel-react-native`
-
-### iOS
-
-**1.** Please make sure that the minimum platform is set to 9.1 in your Podfile: `platform :ios, '9.1'`.
-
-**2.** Run `pod install`.
-
-### Android
-
-**1.** Append Jitpack to `android/build.gradle`:
-
-```java
-allprojects {
-  repositories {
-    ...
-    maven { url "https://jitpack.io" }
-  }
-}
-```
-
-**2.** Make sure that the `minSdkVersion` is the same or higher than the `minSdkVersion` of our native Android SDK:
-
-```java
-buildscript {
-  ext {
-    ...
-    minSdkVersion = 19
-    ...
-  }
-}
-```
-
-## How to use Fidel's React Native SDK
-
-Import Fidel in your RN project:
-
-```javascript
-import Fidel from "fidel-react-native";
-```
-
-Set up Fidel with your API key and your program ID. Without them you can't open the Fidel card linking UI:
-
-```javascript
-Fidel.setup({
-  apiKey: "your api key",
-  programId: "your program id",
-});
-```
-
-Set the options that create the experience of linking a card with Fidel:
-
-```javascript
-const myImage = require("./images/fdl_test_banner.png");
-const resolveAssetSource = require("react-native/Libraries/Image/resolveAssetSource");
-const resolvedImage = resolveAssetSource(myImage);
-
-//this is the default value for supported card schemes,
-//but you can remove the support for some of the card schemes if you want to
-const cardSchemes = new Set([
-  Fidel.CardScheme.visa,
-  Fidel.CardScheme.mastercard,
-  Fidel.CardScheme.americanExpress,
-]);
-
-const countries = [Fidel.Country.ireland, Fidel.Country.unitedStates];
-
-Fidel.setOptions({
-  bannerImage: resolvedImage,
-  allowedCountries: countries,
-  defaultSelectedCountry: Fidel.Country.unitedStates,
-  supportedCardSchemes: Array.from(cardSchemes),
-  autoScan: false,
-  metaData: { "meta-data-1": "value1" }, // additional data to pass with the card
-  companyName: "My RN Company", // the company name displayed in the checkbox text
-  deleteInstructions: "Your custom delete instructions!",
-  privacyUrl: "https://fidel.uk",
-  termsConditionsUrl: "https://fidel.uk/privacy", // mandatory when you include USA/Canada in the list of allowed countries or when the user can select USA/Canada from the country selection UI
-  programName: "My program name", // optional, is used when you include USA/Canada in the list of allowed countries or when the user can select USA/Canada from the country selection UI
-});
-```
-
-Open the card linking view by calling:
-
-```javascript
-Fidel.openForm((error, result) => {
-  if (error) {
-    console.error(error);
-  } else {
-    console.info(result);
-  }
-});
-```
-
-Both `result` and `error` are objects that look like in the following examples:
-
-### Result
-
-```javascript
-{
-  accountId: "the-account-id"
-  countryCode: "GBR" // the country selected by the user, in the Fidel SDK form
-  created: "2019-04-22T05:26:45.611Z"
-  expDate: "2023-12-31T23:59:59.999Z" // the card expiration date
-  expMonth: 12 // for your convenience, this is the card expiration month
-  expYear: 2023 // for your convenience, this is the card expiration year
-  id: "card-id" // the card ID as registered on the Fidel platform
-  firstNumbers: "444400" //first numbers of the card
-  lastNumbers: "4001" //last numbers of the card
-  live: false
-  mapped: false
-  metaData: {meta-data-1: "value1"} //the meta data that you specified for the Fidel SDK
-  programId: "your program ID, as specified for the Fidel SDK"
-  scheme: "visa"
-  type: "visa"
-  updated: "2019-04-22T05:26:45.611Z"
-}
-```
-
-### Error
-
-```javascript
-{
-  code: "item-save"; // the code of the error
-  date: "2019-04-22T05:34:04.621Z"; // the date of the card link request
-  message: "Item already exists"; // the message of the error
-}
-```
+Our website includes all the [React Native SDK documentation](https://fidelapi.com/docs/select/sdks/react-native/guide-v2).
 
 ## How to run the example application
 
@@ -155,251 +24,9 @@ Both `result` and `error` are objects that look like in the following examples:
    3. Run the following command to start Metro: `npx react-native start`
    4. Run the project on your preferred emulator/device.
 
-## Options documentation
-
-### bannerImage
-
-Use this option to customize the topmost banner image with the Fidel UI. Your custom asset needs to be resolved in order to be passed to our native module:
-
-```javascript
-const myImage = require('./images/fdl_test_banner.png');
-const resolveAssetSource = require('react-native/Libraries/Image/resolveAssetSource');
-const resolvedImage = resolveAssetSource(myImage);
-Fidel.setOptions({
-  bannerImage: resolvedImage
-}
-```
-
-### allowedCountries
-
-To set the countries that the users can select, use
-
-```javascript
-const countries = [Fidel.Country.ireland, Fidel.Country.unitedStates];
-Fidel.setOptions({
-  allowedCountries: countries,
-});
-```
-
-The possible options are: `.canada`, `.ireland`, `.japan`, `.sweden`, `.unitedArabEmirates`, `.unitedKingdom`, `.unitedStates`. You can set one or multiple of these countries. If you don't set any allowed countries, the user will be able to choose any of the countries above. If you set only one country, the card linking screen will not show the country picker UI. Note that, when you set multiple countries, they will be displayed in the country picker UI in the order that you set them.
-
-### defaultSelectedCountry
-
-Use this parameter to set the country that will be selected by default when opening the card enrollment screen.
-
-```javascript
-Fidel.setOptions({
-  defaultSelectedCountry: Fidel.Country.unitedKingdom,
-});
-```
-
-The possible options are: `.canada`, `.ireland`, `.japan`, `.sweden`, `.unitedArabEmirates`, `.unitedKingdom`, `.unitedStates`. The `defaultSelectedCountry` has to be part of the `allowedCountries` list. The default value of this option is `.unitedKingdom`.
-
-### supportedCardSchemes
-
-We currently support _Visa_, _Mastercard_ and _AmericanExpress_, but you can choose to support only one, two or all three. By default the SDK is configured to support all three.
-
-If you set this option to an empty array or to `null`, of course, you will not be able to open the Fidel UI. You must support at least one our supported card schemes.
-
-Please check the example below:
-
-```javascript
-//this is the default value for supported card schemes,
-//but you can remove the support for some of the card schemes if you want to
-const cardSchemes = new Set([
-  Fidel.CardScheme.visa,
-  Fidel.CardScheme.mastercard,
-  Fidel.CardScheme.americanExpress,
-]);
-Fidel.setOptions({
-  supportedCardSchemes: Array.from(cardSchemes),
-});
-```
-
-### autoScan
-
-Set this property to `true`, if you want to open the card scanning UI immediately after executing `Fidel.openForm`. The default value is `false`.
-
-```javascript
-Fidel.setOptions({
-  autoScan: true,
-});
-```
-
-### metaData
-
-Use this option to pass any other data with the card data:
-
-```javascript
-Fidel.setOptions({
-  metaData: { "meta-data-key-1": "value1" },
-});
-```
-
-### companyName
-
-Set your company name as it will appear in our consent checkbox text. Please set it to a maximum of 60 characters.
-
-```javascript
-Fidel.setOptions({
-  companyName: "Your Company Name",
-});
-```
-
-### deleteInstructions
-
-Write your custom opt-out instructions for your users. They will be displayed in the consent checkbox text as well.
-
-```javascript
-Fidel.setOptions({
-  deleteInstructions: "Your custom card delete instructions!",
-});
-```
-
-### privacyUrl
-
-This is the privacy policy URL that you can set for the consent checkbox text.
-
-```javascript
-Fidel.setOptions({
-  privacyUrl: "https://fidel.uk",
-});
-```
-
-### programName (applied to the consent text only for USA and Canada)
-
-Set your program name as it will appear in the consent text. Note that **this parameter is optional** and used when you set United States or Canada as allowed countries or don't set any allowed countries (meaning that the user is free to select United States or Canada as their country). Please set it to a maximum of 60 characters.
-
-```javascript
-Fidel.setOptions({
-  programName: "Your Program Name",
-});
-```
-
-### termsConditionsUrl (applied to the consent text only for USA and Canada)
-
-This is the terms & conditions URL that you can set for the consent text. Note that **this parameter is mandatory** when you set United States or Canada as allowed countries or don't set any allowed countries (meaning that the user is free to select United States or Canada as their country).
-
-```javascript
-Fidel.setOptions({
-  termsConditionsUrl: "https://fidel.uk",
-});
-```
-
-## Customizing the consent text
-
-In order to properly set the consent text, please follow these steps:
-
-1. **Set the company name**
-
-This parameter is optional, but we recommended setting it. If you don't set a company name, we'll show the default value in the consent text: `Your Company Name`
-
-2. **Set the privacy policy URL**
-
-This is an optional parameter. It is added as a hyperlink to the `privacy policy` text. Please see the full behaviour below.
-
-3. **Set the delete instructions**
-
-Optional parameter whose default value is `going to your account settings`. This default value is applied for both consent texts - for the USA & Canada as well as for the rest of the world.
-
-4. **Set the card scheme name**
-
-By default, we allow the user to input card numbers from either Visa, Mastercard or American Express, but you can control which card networks you accept. The consent text changes based on what you define or based on what the user inputs. Please see the full behaviour below.
-
-5. **Set the program name (applied to the consent text only for USA and Canada)**
-
-This parameter is taken into account only for USA and Canada. The default value for program name is `our`.
-
-6. **Set the terms and conditions URL (applied to the consent text only for USA and Canada)**
-
-This parameter is mandatory for USA and Canada. Once set, it will be applied as a hyperlink on the `Terms and Conditions` text.
-
-Note that the consent text has a different form depending on the allowed countries you set or the country the user can select. Below you can find the specifics for each case.
-
-### Consent text for United States and Canada
-
-When you set United States and/or Canada as allowed countries or don't set any countries (meaning that the user is free to select United States or Canada as their country), a different consent text will be applied.
-
-For USA & Canada, the following would be an example Terms & Conditions text for `Cashback Inc` (an example company) that uses `Awesome Bonus` as their program name:
-
-_By submitting your card information and checking this box, you authorize `card_scheme_name` to monitor and share transaction data with Fidel (our service provider) to participate in `Awesome Bonus` program. You also acknowledge and agree that Fidel may share certain details of your qualifying transactions with `Cashback Inc` to enable your participation in `Awesome Bonus` program and for other purposes in accordance with the `Cashback Inc` Terms and Conditions, `Cashback Inc` privacy policy and Fidel’s Privacy Policy. You may opt-out of transaction monitoring on the linked card at any time by `deleteInstructions`._
-
-There are two specific parameters that you can set for this consent text:
-
-#### 1. termsConditionsUrl
-
-This parameter is mandatory when you set United States and/or Canada as allowed countries or don't set any countries (meaning that the user is free to select United States or Canada as their country). When you set this parameter, the `Terms and Conditions` from the consent text will get a hyperlink with the URL you set.
-
-```javascript
-Fidel.setOptions({
-  termsConditionsUrl: "https://fidel.uk",
-});
-```
-
-If you don't set this parameter, you'll get an error when trying to open the card linking interface: `You have included a North American country in the list of allowed countries or you allow the user to select a North American country. For North American countries it is mandatory for you to provide the Terms and Conditions URL.`
-
-#### 2. programName
-
-This parameter is optional when you set United States or Canada as allowed countries or don't set any allowed countries. If you don't set a program name, we'll use `our` as the default value (for example, in the text above, you would see _...to monitor and share transaction data with Fidel (our service provider) to participate in `our` program..._)
-
-```javascript
-Fidel.setOptions({
-  programName: "Your Program Name",
-});
-```
-
-#### Consent text behaviour for card scheme name
-
-If you don't set a card scheme (meaning the user can input either Visa, Mastercard or American Express cards) _OR_ set 2 or 3 card scheme names, the default value used will be `your payment card network` (e.g. _you authorize `your payment card network` to monitor and share transaction data with Fidel (our service provider)_). When the user starts typing in a card number, `your payment card network` will be replaced with the scheme name of the card that they typed in (e.g. Visa).
-
-If you set one card scheme name, it will be displayed in the consent text (e.g. for Mastercard it would be _you authorize `Mastercard` to monitor and share transaction data with Fidel (our service provider)_) This value - `Mastercard` - will not change when the user starts typing in a card number.
-
-#### Consent text behaviour for privacy policy
-
-Notice the following excerpt from the consent text above: _in accordance with the `Cashback Inc` Terms and Conditions, `Cashback Inc` privacy policy and Fidel’s Privacy Policy_. If you set a `privacyUrl`, this is the text that will be displayed, along with a hyperlink set on _privacy policy_.
-If you do not set a `privacyUrl`, the text will become _in accordance with the `Cashback Inc` Terms and Conditions and Fidel’s Privacy Policy._
-
-### Consent text for the rest of the world
-
-When you set Ireland, Japan , Sweden, United Arab Emirates or United Kingdom as allowed countries or the user selects one of these countries from the list, a consent text specific for these countries will be applied.
-
-The following would be an example Terms & Conditions text for `Cashback Inc` (an example company):
-
-_I authorise `card_scheme_name` to monitor my payment card to identify transactions that qualify for a reward and for `card_scheme_name` to share such information with `Cashback Inc`, to enable my card linked offers and target offers that may be of interest to me. For information about `Cashback Inc` privacy practices, please see the privacy policy. You may opt-out of transaction monitoring on the payment card you entered at any time by `deleteInstructions`._
-
-#### Consent text behaviour for card scheme name
-
-If you don't set a card scheme (meaning the user can input either Visa, Mastercard or American Express cards) _OR_ set 2 or 3 card scheme names, the default value used will be `my card network` (e.g. _I authorise `my card network` to monitor my payment card_). When the user starts typing in a card number, `my card network` will be replaced with the scheme name of the card that they typed in (e.g. Visa).
-
-If you set one card scheme name, it will be displayed in the consent text (e.g. for Mastercard it would be _I authorise `Mastercard` to monitor my payment card_) This value - `Mastercard` - will not change when the user starts typing in a card number.
-
-#### Consent text behaviour for privacy policy
-
-If you do not set a privacy policy URL, the privacy policy related phrase will be removed from the text.
-
-Notice the following excerpt from the consent text above: _...may be of interest to me. For information about `Cashback Inc` privacy practices, please see the privacy policy. You may opt-out of..._ If you set a `privacyUrl`, this is the text that will be displayed, along with a hyperlink set on _privacy policy_.
-
-If you do not set a `privacyUrl`, the text will become _...may be of interest to me. You may opt-out of..._
-
-## Localisation
-
-The SDK's default language is English, but it's also localised for French and Swedish languages. When the device has either `Français (Canada)` or `Svenska (Sverige)` as its language, the appropriate texts will be displayed. Please note that developer error messages are in English only and they will not be displayed to the user.
-
-Please make sure that your project also supports localisation for the languages that you want to support.
-
-## Test card numbers
-
-In the test environment please use our VISA, Mastercard or American Express test card numbers. You must use a test API Key for them to work.
-
-VISA: _4444000000004\*\*\*_ (the last 3 numbers can be anything)
-
-Mastercard: _5555000000005\*\*\*_ (the last 3 numbers can be anything)
-
-American Express: _3400000000003\*\*_ or _3700000000003\*\*_ (the last 2 numbers can be anything)
-
 ## Feedback
 
-The Fidel SDK is in active development, we welcome your feedback!
+The Fidel API SDKs is in active development, so we welcome your feedback!
 
 Get in touch:
 

package/android/build.gradle

@@ -44,7 +44,8 @@ repositories {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.github.FidelLimited:android-sdk:2.0.0'
+    implementation 'com.github.FidelLimited:android-sdk:2.1.2'
+    implementation 'com.github.FidelLimited:kotlin-multiplatform-analytics:1.3.0'
     testImplementation 'junit:junit:4.13.2'
     testImplementation 'androidx.test.ext:junit:1.1.5'
     testImplementation 'org.assertj:assertj-core:3.13.2'

package/android/jacoco.gradle

@@ -41,8 +41,8 @@ project.afterEvaluate {
                 executionData.from = files("${buildDir}/jacoco/${testTaskName}.exec")
 
                 reports {
-                    xml.enabled = true
-                    html.enabled = true
+                    xml.required = true
+                    html.required = true
                 }
             }
         }

package/android/src/main/java/com/fidelreactlibrary/FidelModule.java

@@ -10,6 +10,8 @@ import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableMap;
 import com.fidelapi.Fidel;
+import com.fidelapi.analytics.Analytics;
+import com.fidelapi.analytics.domain.SdkDetails;
 import com.fidelapi.entities.CardVerificationConfiguration;
 import com.fidelapi.entities.abstraction.OnCardVerificationChoiceSelectedObserver;
 import com.fidelapi.entities.abstraction.OnCardVerificationStartedObserver;
@@ -98,6 +100,13 @@ public class FidelModule extends ReactContextBaseJavaModule {
     }
   }
 
+  @ReactMethod
+  public void identifyMetricsDataSource(String name, String version) {
+    SdkDetails reactNativeSdkDetails = new SdkDetails(name, version);
+    Analytics analytics = new Analytics();
+    analytics.identifyMultiplatformDataSource(reactNativeSdkDetails);
+  }
+  
   @Nullable
   @Override
   public Map<String, Object> getConstants() {

package/index.js

@@ -1,4 +1,5 @@
 import { NativeEventEmitter, NativeModules } from "react-native";
+import { version } from "./package.json";
 
 const { NativeFidelBridge } = NativeModules;
 
@@ -64,12 +65,18 @@ export default class Fidel {
   }
 
   static start() {
+    Fidel.identifyMetricsDataSource()
     NativeFidelBridge.start();
   }
 
   static verifyCard(params) {
+    Fidel.identifyMetricsDataSource()
     NativeFidelBridge.verifyCard(params);
   }
+
+  static identifyMetricsDataSource() {
+    NativeFidelBridge.identifyMetricsDataSource("rn", version);
+  }
 }
 
 export const ENROLLMENT_RESULT = NativeFidelBridge.ResultType.EnrollmentResult;

package/ios/NativeFidelBridge.m

@@ -8,4 +8,6 @@ RCT_EXTERN_METHOD(start)
 
 RCT_EXTERN_METHOD(verifyCard:(NSDictionary *)cardVerificationConfiguration)
 
+RCT_EXTERN_METHOD(identifyMetricsDataSource:(NSString *)name version:(NSString *)version)
+
 @end

package/ios/NativeFidelBridge.swift

@@ -8,6 +8,7 @@
 import Foundation
 import React
 import Fidel
+import analytics
 
 @objc(NativeFidelBridge)
 class NativeFidelBridge: RCTEventEmitter {
@@ -44,6 +45,12 @@ class NativeFidelBridge: RCTEventEmitter {
         let cardVerificationConfig = verificationConfigAdapter.adapt(parameters)
         Fidel.verifyCard(from: startViewController, cardVerificationConfiguration: cardVerificationConfig)
     }
+    
+    @objc(identifyMetricsDataSource:version:)
+    func identifyMetricsDataSource(name: String, version: String) {
+        let reactNativeSdkDetails = SdkDetails(name: name, version: version)
+        Analytics().identifyMultiplatformDataSource(sdkDetails: reactNativeSdkDetails)
+    }
 
     override func supportedEvents() -> [String]! {
         return BridgeLibraryEvent.allCases.map { $0.rawValue }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fidel-react-native",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Fidel's React Native bridge library for iOS and Android.",
   "main": "index.js",
   "nativePackage": true,