react-native-persona 2.2.1 → 2.2.2

package/CHANGELOG.md

@@ -7,6 +7,13 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## [v2.2.2] - 2022-02-24
+
+### Changed
+
+- Upgrade to Android Inquiry SDK 2.2.8
+- Upgrade to iOS Inquiry SDK 2.2.4
+
 ## [v2.2.1] - 2022-02-17
 
 ### Changed

package/README.md

@@ -1,3 +1,157 @@
-# react-native-persona
+# Persona Android SDKs and Demo
+
+## Development
+
+First, run yarn in the project root.
+
+```
+yarn
+```
+
+To test changes to SDK, we will use the Example App in `example` app.
+
+### Start Metro bundler.
+
+This will bundle JavaScript and serve it to your React Native sample app. Keep the Metro bundler running in a terminal.
+
+```
+yarn example start
+```
+
+Metro bundler compiles source code and caches compiled targets to speed up incremental rebuilds. However, it's possible
+that this can lead to random failures if things get out of sync. If you ever run into any weird issues, it's worth
+running `yarn example start --reset-cache` again.
+
+### Start example app in iOS simulator
+
+Use the built-in CLI command with Metro running.
+
+```
+yarn example ios
+```
+
+Or open `ios/example.xcworkspace` in XCode and build + run.
+
+### Start example app in Android simulator
+
+Use the built-in CLI command with Metro running.
+
+```
+yarn example android
+```
+
+Or open the Android project in Android Studio and build + run.
+
+### Install persona-tools
+
+Link the binary persona-tool in the example app
+
+```
+$ cd example
+$ yarn dev-only:link-bin
+```
+
+Run the persona-tool to customize the theme
+
+```
+$ cd example
+$ yarn persona-tool
+```
+
+# Installing in your own project
+
+```
+
+yarn add react-native-persona
+
+```
+
+## Usage
+
+```typescript
+import {Environment, Inquiry} from "react-native-persona";
+
+// Start an inquiry.
+Inquiry.fromTemplate('itmpl_Ygs16MKTkA6obnF8C3Rb17dm')
+  .environment(Environment.SANDBOX)
+  .onComplete((inquiryId, status, fields) =>
+    Alert.alert('Complete', `Inquiry ${inquiryId} completed with status "${status}."`,),
+  )
+  .onCanceled((inquiryId, sessionToken) =>
+    Alert.alert('Canceled', `Inquiry ${inquiryId} was cancelled`),
+  )
+  .onError(error => Alert.alert('Error', error.message))
+  .build()
+  .start();
+```
+
+### Theming
+
+Theming can be handled universally through our persona-tools CLI provided in this repository.
+
+To test themes, use the example app:
+
+```
+cd example
+```
+
+Link the `persona-tool` using the following command (only necessary during development, linked automatically when the
+package is installed using `yarn add` or `npm install`).
+
+```
+yarn dev-only:link-bin
+```
+
+To unlink:
+
+```
+yarn dev-only:unlink-bin
+```
+
+Run through the tool using `yarn persona-tool` and following the instructions to add the required snippet to
+your `package.json`.
+
+Update theme colors accordingly:
+
+- Example: Update `persona.androidTheme.backgroundColor` to `#FFFFFF`
+
+Run `yarn persona-tool` again.
+
+Launch the example app and launch a flow.
+
+### Updating SDK Versions
+
+*Android*
+
+Update the sdk version in `android/build.gradle`
+
+```
+implementation 'com.withpersona.sdk2:inquiry:X.Y.Z'
+```
+
+*iOS*
+
+Update the sdk version in `RNPersonaInquiry2.podspec`
+
+```
+s.dependency 'PersonaInquirySDK2', '~> X.Y.Z'
+```
+
+Go to `example/ios` directory, update the Podfiles by running
+
+```
+pod update PersonaInquirySDK2 --repo-update
+pod install --repo-update
+```
+
+*React Native*
+
+Bump react native version in `package.json` if needed.
+
+Commit and push changed files including:
+
+- `android/build.gradle`
+- `RNPersonaInquiry2.podspec`
+- `package.json`
+- `example/ios/Podfile.lock`
 
-Please refer to the docs: https://docs.withpersona.com/docs/react-native-sdk-integration

package/RNPersonaInquiry2.podspec

@@ -22,7 +22,7 @@ Pod::Spec.new do |s|
   s.requires_arc  = true
 
   s.dependency 'React-Core'
-  s.dependency 'PersonaInquirySDK2', '2.2.3'
+  s.dependency 'PersonaInquirySDK2', '2.2.4'
 
   s.static_framework = true
 end

package/android/build.gradle

@@ -66,5 +66,5 @@ dependencies {
     //noinspection GradleDynamicVersion
     implementation 'com.facebook.react:react-native:+'  // From node_modules
 
-    implementation 'com.withpersona.sdk2:inquiry:2.2.6'
+    implementation 'com.withpersona.sdk2:inquiry:2.2.8'
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-persona",
   "title": "React Native Persona",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Launch a mobile native implementation of the Persona inquiry flow from React Native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -44,10 +44,10 @@
     "name": "Persona Identities, Inc.",
     "email": "support@withpersona.com"
   },
-  "homepage": "https://docs.withpersona.com/docs/react-native-sdk-v1-integration",
+  "homepage": "https://docs.withpersona.com/docs/react-native-sdk-integration",
   "license": "MIT",
   "licenseFilename": "LICENSE",
-  "readmeFilename": "README.md",
+  "readmeFilename": "PUBLIC.md",
   "peerDependencies": {
     "react": "*",
     "react-native": "*"