@blueconic/blueconic-react-native 1.3.1 → 2.0.0

package/CHANGELOG.md

@@ -2,10 +2,18 @@
 All notable changes to this project will be documented in this file.
 `@blueconic/blueconic-react-native` adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [1.3.1] - 2022-11-22
+## [2.0.0] - 2022-11-24
 
+- Released 1.3.1 alpha as 2.0.0 latest, since it contains breaking changes.
+
+## [1.3.1] - 2022-11-22 (alpha)
+
+- Changed the way the blueconic android AAR is loaded (no longer via direct .AAR reference) (breaking change)
+- Added targetSdkVersion 31 (breaking change)
+
+## [1.3.0] - 2022-11-22 (alpha)
 - Changed peerDependency for react-native to <1.0.0, to fix error with NPM v7 when an app uses a different version of react-native than this package. 
-- Changed the way the blueconic android AAR is loaded (no longer via direct .AAR reference)
+- This release was pulled from NPM, as it shouldn't be used without the changes made in 1.3.1
 
 ## [1.2.0] - 2021-21-6
 

package/README.md

@@ -22,11 +22,9 @@ Or include it to your React Native project's package.json
 {
 "react": "16.8.6",
 "react-native": "0.60.4",
-"@blueconic/blueconic-react-native": "^1.3.1"
+"@blueconic/blueconic-react-native": "^2.0.0"
 }
 ```
-
-
  
  
 ## iOS implementation of the React Native App
@@ -37,9 +35,8 @@ Or include it to your React Native project's package.json
 node_modules/@blueconic/blueconic-react-native/ios
 ```
 
-
 -  The `.xcodeproj` will include a Product folder, make sure the `libBlueConicClient.a` library is added to the Link Binary with Libraries section of the Build Phases of the app's target
--   The package is dependent on react-native. It searches for the react-native headers both in your project’s node `modules/react-native/React` directory, as well as in `./ios/Pods/Headers/Public` in case react-native is used through CocoaPods. If the react-native headers are saved elsewhere, add the correct path to the Header Search Paths Build Setting of the BlueConicClient target.
+-  The package is dependent on react-native. It searches for the react-native headers both in your project’s node `modules/react-native/React` directory, as well as in `./ios/Pods/Headers/Public` in case react-native is used through CocoaPods. If the react-native headers are saved elsewhere, add the correct path to the Header Search Paths Build Setting of the BlueConicClient target.
 
 #### 2. Add the configuration key for BlueConic:
  Locate your app's Information Property List file under "Supporting Files".
@@ -103,10 +100,8 @@ bc_debug
  
 ##  Android implementation of the React Native App
 
-```
-
-#### 1. Add the file blueconic-lib-<version>.aar to your project
-* Create `blueconic` directory in your projects `android` root directory
+#### 1. Add the Android SDK blueconic-lib-<version>.aar to your app project as gradle module
+* Create `blueconic` directory in your projects' in the `android` root directory
 * Add `build.gradle` file with these contents:
 
 ```
@@ -115,25 +110,38 @@ artifacts.add("default", file('blueconic-lib-<version>.aar'))
 ```
 
 Add the .aar file to the 'blueconic' directory, alongside the `build.gradle`.
+You now have a gradle module called 'blueconic' which can be used in your app as well as in the BlueConic react-native NPM module.
 
-#### 2. Include the React Native project to the settings.gradle
- Append the following lines to `android/settings.gradle`
+#### 2. Include the React Native project in the settings.gradle
+Append the following lines to the `android/settings.gradle` file.
+ 
 ``` 
- include ':blueconic'
- include ':blueconic_blueconic-react-native'
- project(':blueconic_blueconic-react-native').projectDir = new File(rootProject.projectDir,
+include ':blueconic'
+include ':blueconic_blueconic-react-native'
+project(':blueconic_blueconic-react-native').projectDir = new File(rootProject.projectDir,
         '../node_modules/@blueconic/blueconic-react-native/android')
 ```
+
 This loads both the BlueConic React Native library as the BlueConic Android SDK.
+
+#### 3. (Optionally) Set "allow backup"-option to true in the AndroidManifest.xml
+It could be that the IDE requires to override the "allowBackup" options in order to build
+Add/ change this option in the AndroidManifest.xml
+
+```
+android:allowBackup="true"
+```
  
-#### 3. Add permissions to the AndroidManifest.xml:
+#### 4. Add permissions to the AndroidManifest.xml:
+
 ```
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 ```
  
-#### 4. Add intent filters to the AndroidManifest.xml for connecting to the simulator:
- Configure your appId at the android:scheme attribute in the code fragment below. For example `"com.test.testapp"`.
+#### 5. Add intent filters to the AndroidManifest.xml for connecting to the simulator:
+Configure your appId at the android:scheme attribute in the code fragment below. For example `"com.test.testapp"`.
+
 ```
  <activity android:name=".MainActivity" android:label="@string/app_name">
  <intent-filter>
@@ -156,7 +164,7 @@ This loads both the BlueConic React Native library as the BlueConic Android SDK.
  </activity>
 ```
 
-#### 5. Add the configuration file for BlueConic:
+#### 6. Add the configuration file for BlueConic:
  Create a file named `blueconic_configuration.xml` in `/res/values/`:
 ```
 <?xml version="1.0" encoding="utf-8"?>
@@ -172,7 +180,7 @@ This loads both the BlueConic React Native library as the BlueConic Android SDK.
  </resources>
 ```
 
-#### 6. Optionally, enable debug mode:
+#### 7. Optionally, enable debug mode:
  Add the following node to the configuration file
  ```
 <bool name="bc_debug">true</bool>

package/android/build.gradle

@@ -29,10 +29,6 @@ android {
 
 repositories {
     mavenCentral()
-
-    flatDir {
-        dirs '../../../../android/app/libs'
-    }
 }
 
 dependencies {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueconic/blueconic-react-native",
-  "version": "1.3.1",
+  "version": "2.0.0",
   "description": "The BlueConicClient Framework provides the basis for communication with BlueConic.",
   "main": "index.js",
   "scripts": {