📃 docs: add new API

Author: ccnnde

docs/Reference.md

@@ -10,6 +10,7 @@ This document lays out the current public properties and methods for the React N
 | ---------------------- | --- | ------- | -------------------------------------------------------- | ------- | ------------------------------------------- |
 | connect                | ✅  | ✅      | options: [VpnOptions](#vpnoptions)                       | promise | Connecting to OpenVPN                       |
 | disconnect             | ✅  | ✅      | none                                                     | promise | Close the OpenVPN connection                |
+| getCurrentState        | ✅  | ✅      | none                                                     | promise | Get current VPN status                      |
 | observeState           | ✅  | ❌      | none                                                     | promise | Listening for VPN status                    |
 | stopObserveState       | ✅  | ❌      | none                                                     | promise | Stop listening to VPN status                |
 | addVpnStateListener    | ✅  | ✅      | callback: (e: [VpnEventParams](#vpneventparams)) => void | void    | Add VPN status change event listener        |
@@ -31,10 +32,16 @@ interface VpnOptions {
   remoteAddress?: string;
   ovpnString?: string;
   ovpnFileName?: string;
+  username?: string;
+  password?: string;
   assetsPath?: string;
   notificationTitle?: string;
   compatMode?: RNSimpleOpenvpn.CompatMode;
   useLegacyProvider?: boolean;
+  useCustomConfig?: boolean;
+  customConfigOptions?: string;
+  allowedAppsVpn?: Array<string>;
+  allowedAppsVpnAreDisallowed?: boolean;
   providerBundleIdentifier: string;
   localizedDescription?: string;
 }
@@ -54,6 +61,14 @@ String format reference [example.ovpn](../example/android/app/src/main/assets/Ja
 
 The name of the OpenVPN configuration file, without extensions, using the default name `client` if not passed in
 
+#### username
+
+The username for auth, using the default value `''` if not passed in
+
+#### password
+
+The password for auth, using the default value `''` if not passed in
+
 #### assetsPath
 
 **Android only**，the path to the OpenVPN configuration file under `android/app/src/main/assets/`
@@ -80,6 +95,31 @@ The name of the OpenVPN configuration file, without extensions, using the defaul
 
 **Android only**，load OpenSSL legacy provider or not, using the default value `false` if not passed in
 
+#### useCustomConfig
+
+**Android only**, use custom config or not, using the default value `false` if not passed in
+
+#### customConfigOptions
+
+**Android only**, add your own configuration string like below, using the default value `''` if not passed in
+
+```text
+http-proxy ...
+http-proxy-option ...
+```
+
+#### allowedAppsVpn
+
+**Android only**, list of application package names for VPN connection, the default value is an empty array
+
+```js
+['com.app1', 'com.app2'];
+```
+
+#### allowedAppsVpnAreDisallowed
+
+**Android only**, the packages that we specify **allowedAppsVpn** use our VPN connection or not, and the rest is the opposite, using the default value `true` if not passed in
+
 #### providerBundleIdentifier
 
 **iOS only**，the bundle identifier of the Network Extension target

docs/Reference.zh-CN.md

@@ -10,6 +10,7 @@
 | ---------------------- | --- | ------- | -------------------------------------------------------- | ------- | ------------------------- |
 | connect                | ✅  | ✅      | options: [VpnOptions](#vpnoptions)                       | promise | 连接 OpenVPN              |
 | disconnect             | ✅  | ✅      | 无                                                       | promise | 关闭 OpenVPN 连接         |
+| getCurrentState        | ✅  | ✅      | none                                                     | promise | 获取 VPN 当前状态         |
 | observeState           | ✅  | ❌      | 无                                                       | promise | 监听 VPN 状态             |
 | stopObserveState       | ✅  | ❌      | 无                                                       | promise | 停止监听 VPN 状态         |
 | addVpnStateListener    | ✅  | ✅      | callback: (e: [VpnEventParams](#vpneventparams)) => void | void    | 添加 VPN 状态变更事件监听 |
@@ -31,10 +32,16 @@ interface VpnOptions {
   remoteAddress?: string;
   ovpnString?: string;
   ovpnFileName?: string;
+  username?: string;
+  password?: string;
   assetsPath?: string;
   notificationTitle?: string;
   compatMode?: RNSimpleOpenvpn.CompatMode;
   useLegacyProvider?: boolean;
+  useCustomConfig?: boolean;
+  customConfigOptions?: string;
+  allowedAppsVpn?: Array<string>;
+  allowedAppsVpnAreDisallowed?: boolean;
   providerBundleIdentifier: string;
   localizedDescription?: string;
 }
@@ -54,6 +61,14 @@ OpenVPN 配置文件内容的字符串形式，未传入时或传递空字符串
 
 OpenVPN 配置文件的名称，不含扩展名，未传入时使用默认名称 `client`
 
+#### username
+
+鉴权用户名, 未传入时使用默认名称 `''`
+
+#### password
+
+鉴权密码, 未传入时使用默认名称 `''`
+
 #### assetsPath
 
 **Android 专用**，OpenVPN 配置文件在 `android/app/src/main/assets/` 下的路径
@@ -80,6 +95,31 @@ OpenVPN 配置文件的名称，不含扩展名，未传入时使用默认名称
 
 **Android 专用**，是否加载 OpenSSL legacy provider，未传入时使用默认值 `false`
 
+#### useCustomConfig
+
+**Android 专用**， 是否使用自定义配置，未传入时使用默认值 `false`
+
+#### customConfigOptions
+
+**Android 专用**，添加类似下方的配置字符串，未传入时使用默认值 `''`
+
+```text
+http-proxy ...
+http-proxy-option ...
+```
+
+#### allowedAppsVpn
+
+**Android 专用**, 进行 VPN 连接的应用包名列表, 默认值为空数组
+
+```js
+['com.app1', 'com.app2'];
+```
+
+#### allowedAppsVpnAreDisallowed
+
+**Android 专用**, 控制 **allowedAppsVpn** 中所列的应用是否使用 VPN 连接, 而剩下的应用则相反, 未传入时使用默认值 `true`
+
 #### providerBundleIdentifier
 
 **iOS 专用**，Network Extension target 的 bundle identifier