✨ feat(version): release 2.0.0

Author: ccnnde

README.md

@@ -1,19 +1,23 @@
 # react-native-simple-openvpn
 
 [![npm latest][version-img]][pkg-url]
-[![download][download-img]][pkg-url]
+[![download month][dl-month-img]][pkg-url]
+[![download total][dl-total-img]][pkg-url]
 ![platforms][platform-img]
 [![GNU General Public License][license-img]](LICENSE)
 
 English | [简体中文](./README.zh-CN.md)
 
 A simple react native module to interact with OpenVPN
 
+If this project has helped you out, please support us with a star 🌟
+
 ## Versions
 
 | RNSimpleOpenvpn | React Native |
 | --------------- | ------------ |
 | 1.0.0 ~ 1.2.0   | 0.56 ~ 0.66  |
+| 2.0.0           | 0.63 ~ 0.68  |
 
 ## Preview
 
@@ -42,6 +46,40 @@ From react-native 0.60 autolinking will take care of the link step
 react-native link react-native-simple-openvpn
 ```
 
+### Android
+
+Add the following to `android/settings.gradle` :
+
+```diff
+rootProject.name = 'example'
++ include ':vpnLib'
++ project(':vpnLib').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-simple-openvpn/vpnLib')
+apply from: file("../node_modules/@react-native-community/cli-platform-android/native_modules.gradle"); applyNativeModulesSettingsGradle(settings)
+include ':app'
+```
+
+#### Import jniLibs
+
+Due to file size limitations, jniLibs are too big to be published on npm. Use the assets on [GitHub Releases](https://github.com/ccnnde/react-native-simple-openvpn/releases) instead
+
+Download and unzip the resources you need for the corresponding architecture, and put them in `android/app/src/main/jniLibs` (create a new `jniLibs` folder if you don't have one)
+
+```sh
+project
+├── android
+│   ├── app
+│   │   └── src
+│   │       └── main
+│   │           └── jniLibs
+│   │               ├── arm64-v8a
+│   │               ├── armeabi-v7a
+│   │               ├── x86
+│   │               └── x86_64
+│   └── ...
+├── ios
+└── ...
+```
+
 ### iOS
 
 If using CocoaPods, run it in the `ios/` directory
@@ -164,9 +202,10 @@ export default App;
 
 ## Properties
 
-| Name     | Value                                                                                                                                                     | Description        |
-| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
-| VpnState | VPN_STATE_DISCONNECTED = 0 <br/> VPN_STATE_CONNECTING = 1 <br/> VPN_STATE_CONNECTED = 2 <br/> VPN_STATE_DISCONNECTING = 3 <br/> VPN_OTHER_STATE = 4 <br/> | VPN Current Status |
+| Name       | Value                                                                                                                                                     | Description                                  |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| VpnState   | VPN_STATE_DISCONNECTED = 0 <br/> VPN_STATE_CONNECTING = 1 <br/> VPN_STATE_CONNECTED = 2 <br/> VPN_STATE_DISCONNECTING = 3 <br/> VPN_OTHER_STATE = 4 <br/> | VPN Current Status                           |
+| CompatMode | MODERN_DEFAULTS = 0 <br/> OVPN_TWO_FIVE_PEER = 1 <br/> OVPN_TWO_FOUR_PEER = 2 <br/> OVPN_TWO_THREE_PEER = 3 <br/>                                         | OpenVPN Compatibility Mode(**Android only**) |
 
 ## Types
 
@@ -178,6 +217,9 @@ interface VpnOptions {
   ovpnString?: string;
   ovpnFileName?: string;
   assetsPath?: string;
+  notificationTitle?: string;
+  compatMode?: RNSimpleOpenvpn.CompatMode;
+  useLegacyProvider?: boolean;
   providerBundleIdentifier: string;
   localizedDescription?: string;
 }
@@ -204,6 +246,25 @@ The name of the OpenVPN configuration file, without extensions, using the defaul
 - `assetsPath` is `''` when not passed in, the file path is `assets/xxx.ovpn`
 - When passing in a path, such as `'ovpn/'`, the file path is `assets/ovpn/xxx.ovpn`
 
+#### notificationTitle
+
+**Android only**，the title of the notification, using the default value `OpenVPN` if not passed in
+
+#### compatMode
+
+**Android only**，[OpenVPN compatibility mode](#properties), using the default value `MODERN_DEFAULTS` if not passed in
+
+| Mode                | Description                   |
+| ------------------- | ----------------------------- |
+| MODERN_DEFAULTS     | Modern defaults               |
+| OVPN_TWO_FIVE_PEER  | OpenVPN 2.5.x peers           |
+| OVPN_TWO_FOUR_PEER  | OpenVPN 2.4.x peers           |
+| OVPN_TWO_THREE_PEER | OpenVPN 2.3.x and older peers |
+
+#### useLegacyProvider
+
+**Android only**，load OpenSSL legacy provider or not, using the default value `false` if not passed in
+
 #### providerBundleIdentifier
 
 **iOS only**，the bundle identifier of the Network Extension target
@@ -255,13 +316,13 @@ However, if you need to dynamically change the `remote` address in the configura
 
 The following items were used in this project
 
-- Android - [ics-openvpn](https://github.com/schwabe/ics-openvpn), for personal project reasons, the Android side is currently using an older version of its core library
+- Android - [ics-openvpn](https://github.com/schwabe/ics-openvpn) v0.7.33
 - iOS - [OpenVPNAdapter](https://github.com/ss-abramchuk/OpenVPNAdapter) v0.8.0
 
 ## Todo
 
 - [x] Resolve RN 0.65 warning
-- [ ] Upgrade to the latest Android OpenVPN library
+- [x] Upgrade to the latest Android OpenVPN library
 
 ## License
 
@@ -271,6 +332,7 @@ The following items were used in this project
 
 [pkg-url]: https://www.npmjs.com/package/react-native-simple-openvpn
 [version-img]: https://img.shields.io/npm/v/react-native-simple-openvpn?color=deepgreen&style=flat-square
-[download-img]: https://img.shields.io/npm/dm/react-native-simple-openvpn?style=flat-square
+[dl-month-img]: https://img.shields.io/npm/dm/react-native-simple-openvpn?style=flat-square
+[dl-total-img]: https://img.shields.io/npm/dt/react-native-simple-openvpn?label=total&style=flat-square
 [platform-img]: https://img.shields.io/badge/platforms-android%20|%20ios-lightgrey?style=flat-square
 [license-img]: https://img.shields.io/badge/license-GPL%20v2-orange?style=flat-square

README.zh-CN.md

@@ -1,19 +1,23 @@
 # react-native-simple-openvpn
 
 [![npm latest][version-img]][pkg-url]
-[![download][download-img]][pkg-url]
+[![download month][dl-month-img]][pkg-url]
+[![download total][dl-total-img]][pkg-url]
 ![platforms][platform-img]
 [![GNU General Public License][license-img]](LICENSE)
 
 简体中文 | [English](./README.md)
 
-A simple react native module to interact with OpenVPN
+react-native-simple-openvpn 提供了与 OpenVPN 交互的接口
+
+如果本项目对你有所帮助，请 star 🌟 鼓励，谢谢 🙏
 
 ## 版本
 
 | RNSimpleOpenvpn | React Native |
 | --------------- | ------------ |
 | 1.0.0 ~ 1.2.0   | 0.56 ~ 0.66  |
+| 2.0.0           | 0.63 ~ 0.68  |
 
 ## 预览
 
@@ -42,6 +46,40 @@ yarn add react-native-simple-openvpn
 react-native link react-native-simple-openvpn
 ```
 
+### Android
+
+在项目的 `android/settings.gradle` 中添加以下代码：
+
+```diff
+rootProject.name = 'example'
++ include ':vpnLib'
++ project(':vpnLib').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-simple-openvpn/vpnLib')
+apply from: file("../node_modules/@react-native-community/cli-platform-android/native_modules.gradle"); applyNativeModulesSettingsGradle(settings)
+include ':app'
+```
+
+#### 导入 jniLibs
+
+由于存在文件大小的限制，jniLibs 无法随模块一起发布到 npm 上。故使用 [GitHub Releases](https://github.com/ccnnde/react-native-simple-openvpn/releases) 中的 assets 来代替
+
+下载并解压你需要的相应架构的资源，然后将其放入 `android/app/src/main/jniLibs` 中（如果 `jniLibs` 文件夹不存在则手动新建一个）
+
+```sh
+project
+├── android
+│   ├── app
+│   │   └── src
+│   │       └── main
+│   │           └── jniLibs
+│   │               ├── arm64-v8a
+│   │               ├── armeabi-v7a
+│   │               ├── x86
+│   │               └── x86_64
+│   └── ...
+├── ios
+└── ...
+```
+
 ### iOS
 
 如果使用 CocoaPods, 在 `ios/` 目录下运行
@@ -164,9 +202,10 @@ export default App;
 
 ## 属性
 
-| 名称     | 值                                                                                                                                                        | 描述         |
-| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
-| VpnState | VPN_STATE_DISCONNECTED = 0 <br/> VPN_STATE_CONNECTING = 1 <br/> VPN_STATE_CONNECTED = 2 <br/> VPN_STATE_DISCONNECTING = 3 <br/> VPN_OTHER_STATE = 4 <br/> | VPN 当前状态 |
+| 名称       | 值                                                                                                                                                        | 描述                               |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
+| VpnState   | VPN_STATE_DISCONNECTED = 0 <br/> VPN_STATE_CONNECTING = 1 <br/> VPN_STATE_CONNECTED = 2 <br/> VPN_STATE_DISCONNECTING = 3 <br/> VPN_OTHER_STATE = 4 <br/> | VPN 当前状态                       |
+| CompatMode | MODERN_DEFAULTS = 0 <br/> OVPN_TWO_FIVE_PEER = 1 <br/> OVPN_TWO_FOUR_PEER = 2 <br/> OVPN_TWO_THREE_PEER = 3 <br>                                          | OpenVPN 兼容模式(**Android only**) |
 
 ## 类型
 
@@ -178,6 +217,9 @@ interface VpnOptions {
   ovpnString?: string;
   ovpnFileName?: string;
   assetsPath?: string;
+  notificationTitle?: string;
+  compatMode?: RNSimpleOpenvpn.CompatMode;
+  useLegacyProvider?: boolean;
   providerBundleIdentifier: string;
   localizedDescription?: string;
 }
@@ -204,6 +246,25 @@ OpenVPN 配置文件的名称，不含扩展名，未传入时使用默认名称
 - 未传入时 `assetsPath` 为 `''`，文件路径为 `assets/xxx.ovpn`
 - 传入路径时，比如 `'ovpn/'`，文件路径为 `assets/ovpn/xxx.ovpn`
 
+#### notificationTitle
+
+**Android 专用**，通知的标题，未传入时使用默认值 `OpenVPN`
+
+#### compatMode
+
+**Android 专用**，[OpenVPN 兼容模式](#properties)，未传入时使用默认值 `MODERN_DEFAULTS`
+
+| 模式                | 描述                          |
+| ------------------- | ----------------------------- |
+| MODERN_DEFAULTS     | Modern defaults               |
+| OVPN_TWO_FIVE_PEER  | OpenVPN 2.5.x peers           |
+| OVPN_TWO_FOUR_PEER  | OpenVPN 2.4.x peers           |
+| OVPN_TWO_THREE_PEER | OpenVPN 2.3.x and older peers |
+
+#### useLegacyProvider
+
+**Android 专用**，是否加载 OpenSSL legacy provider，未传入时使用默认值 `false`
+
 #### providerBundleIdentifier
 
 **iOS 专用**，Network Extension target 的 bundle identifier
@@ -255,7 +316,7 @@ remote <IP address> <port>
 
 本项目使用到了以下项目
 
-- Android - [ics-openvpn](https://github.com/schwabe/ics-openvpn)，由于个人项目的原因，Android 端目前使用的是其核心库的较旧版本
+- Android - [ics-openvpn](https://github.com/schwabe/ics-openvpn) v0.7.33
 - iOS - [OpenVPNAdapter](https://github.com/ss-abramchuk/OpenVPNAdapter) v0.8.0
 
 ## License
@@ -266,6 +327,7 @@ remote <IP address> <port>
 
 [pkg-url]: https://www.npmjs.com/package/react-native-simple-openvpn
 [version-img]: https://img.shields.io/npm/v/react-native-simple-openvpn?color=deepgreen&style=flat-square
-[download-img]: https://img.shields.io/npm/dm/react-native-simple-openvpn?style=flat-square
+[dl-month-img]: https://img.shields.io/npm/dm/react-native-simple-openvpn?style=flat-square
+[dl-total-img]: https://img.shields.io/npm/dt/react-native-simple-openvpn?label=total&style=flat-square
 [platform-img]: https://img.shields.io/badge/platforms-android%20|%20ios-lightgrey?style=flat-square
 [license-img]: https://img.shields.io/badge/license-GPL%20v2-orange?style=flat-square

package.json

@@ -1,13 +1,14 @@
 {
   "name": "react-native-simple-openvpn",
   "title": "React Native Simple Openvpn",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "React Native Open VPN Module",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "README.md",
     "android",
+    "vpnLib",
     "index.js",
     "index.d.ts",
     "ios",
@@ -38,6 +39,9 @@
   "license": "GPL-2.0-or-later",
   "licenseFilename": "LICENSE",
   "readmeFilename": "README.md",
+  "peerDependencies": {
+    "react-native": ">=0.63"
+  },
   "devDependencies": {
     "archiver": "^5.3.0",
     "clang-format": "^1.4.0",

vpnLib/.npmignore

@@ -0,0 +1,7 @@
+# ignored suffix
+.DS_Store
+.npmignore
+.clang-format
+
+# .so
+src/main/jniLibs/