@react-native-ohos/react-native-system-setting 1.7.7-rc.1 → 1.7.7-rc.3

package/harmony/react_native_system_setting/{ts.ts → ts.ets}

@@ -1,25 +1,25 @@
-/*
- * MIT License
- *
- * Copyright (C) 2024 Huawei Device Co., Ltd.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
+/*
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
 export * from './src/main/ets/RNSystemSettingPackage'

package/iOS.md

@@ -0,0 +1,101 @@
+# iOS
+
+Some functions are diabled by default:
+
+* `switchWifi()`
+* `switchBluetooth()`
+* `switchLocation()`
+* `switchAirplane()`
+* `isBluetoothEnabled()`
+* `addBluetoothListener()`
+
+When you call these functions, you'll just get some warning log.
+
+You can enable it by add a preprocessor macros.
+
+## Private API
+
+There are some functions which start with `switch`:
+
+* `switchWifi()`
+* `switchBluetooth()`
+* `switchLocation()`
+* `switchAirplane()`
+
+I implement them by using non-public APIs, which is not permitted on the App Store, see [this issue](https://github.com/c19354837/react-native-system-setting/issues/28). 
+
+**These functions are disabled by default. You must not call them If your app need submit to App Store. As an alternative, you can show a tip to tell the user how to change the system setting.**
+
+Only when you'll distribute the app outside App Store, you can enable them by add a preprocessor macros `PRIVATE_API`.
+
+**WARNING: If you enable it and submit app to App Store, you'll definitely get a rejection from apple. In the worst case, your account will be ban!**
+
+![add preprocessor macros `PRIVATE_API `](./screenshot/ios_private_api.png)
+
+> You should add `PRIVATE_API` in both `Debug` and `Release` 
+
+## Bluetooth
+
+There are some bluetooth-function:
+
+* `isBluetoothEnabled()`
+* `addBluetoothListener()`
+
+You can enable them in a few steps: 
+
+First, add preprocessor macros `BLUETOOTH`, either
+1) Manually, or
+2) Using `post_install` hook in Podfile (for React-Native >=0.60 with autolinking)
+
+### Manually adding a preprocessor macro:
+
+![add preprocessor macros `BLUETOOTH`](./screenshot/ios_bluetooth.png)
+
+> You should add `BLUETOOTH` in both `Debug` and `Release`
+
+### Automatically adding a preprocessor macro via Podfile
+Add `post_install` hook in `Podfile`:
+```ruby
+  post_install do |installer|
+    flipper_post_install(installer)
+
+    ## ADD THE FOLLOWING:
+
+    # Enables bluetooth functionality of react-native-system-setting
+    installer.pods_project.targets.each do |target|
+      if target.name == "RCTSystemSetting"
+        target.build_configurations.each do |config|
+          config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)']
+          if !config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'].include? 'BLUETOOTH'
+            puts 'Adding BLUETOOTH in GCC_PREPROCESSOR_DEFINITIONS of Pod RCTSystemSetting...'
+            config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] << 'BLUETOOTH'
+          end
+        end
+      end
+    end
+  end
+```
+
+Then open `Info.plist` as source code.
+
+![open Info.plist as source code](./screenshot/ios_bluetooth_plist.png)
+ 
+Finally, add `NSBluetoothPeripheralUsageDescription` in `Info.plist`, see [Info.plist - example](https://github.com/c19354837/react-native-system-setting/blob/master/examples/SystemSettingExample/ios/SystemSettingExample/Info.plist#L55-L56)
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  
+  ...
+  
+  <key>NSBluetoothPeripheralUsageDescription</key>
+  <string>Explain the reasons for accessing...</string>
+  
+</dict>
+</plist>
+```
+
+> You can change the `string` as you need
+

package/package.json

@@ -1,47 +1,49 @@
-{
-    "name": "@react-native-ohos/react-native-system-setting",
-    "version": "1.7.7-rc.1",
-    "description": "provide some system setting APIs. Volume, brightness, wifi, location, bluetooth, airplane...",
-    "main": "SystemSetting.js",
-    "types": "SystemSetting.d.ts",
-    "homepage": "https://github.com/c19354837/react-native-system-setting",
-    "bugs": {
-        "url": "https://github.com/c19354837/react-native-system-setting/issues"
-    },
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "keywords": [
-        "react-native",
-        "system",
-        "setting",
-        "volume",
-        "wifi",
-        "brightness",
-        "location",
-        "bluetooth",
-        "airplane"
-    ],
-    "files": [
-        "src/",
-        "SystemSetting.d.ts",
-        "SystemSetting.js",
-        "Utils.js",
-        "/*.podspec",
-        "API.md",
-        "harmony"
-    ],
-    "author": {
-        "name": "Ninty",
-        "email": "c19354837@hotmail.com",
-        "url": "https://github.com/c19354837"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/c19354837/react-native-system-setting.git"
-    },
-    "license": "MIT",
-    "harmony": {
-        "alias": "react-native-system-setting"
-    }
+{
+    "name": "@react-native-ohos/react-native-system-setting",
+    "version": "1.7.7-rc.3",
+    "description": "provide some system setting APIs. Volume, brightness, wifi, location, bluetooth, airplane...",
+    "main": "SystemSetting.js",
+    "types": "SystemSetting.d.ts",
+    "homepage": "https://gitcode.com/openharmony-sig/rntpc_react-native-system-setting",
+    "bugs": {
+        "url": "https://gitcode.com/openharmony-sig/rntpc_react-native-system-setting/issues"
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "codegen-lib": "react-native codegen-lib-harmony --no-safety-check --npm-package-name react-native-system-setting --cpp-output-path ./harmony/react_native_system_setting/src/main/cpp/generated --ets-output-path ./harmony/react_native_system_setting/src/main/ets/generated --turbo-modules-spec-paths ./src  --arkts-components-spec-paths ./src"
+    },
+    "keywords": [
+        "react-native",
+        "system",
+        "setting",
+        "volume",
+        "wifi",
+        "brightness",
+        "location",
+        "bluetooth",
+        "airplane"
+    ],
+    "author": {
+        "name": "Ninty",
+        "email": "c19354837@hotmail.com",
+        "url": "https://github.com/c19354837"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://gitcode.com/openharmony-sig/rntpc_react-native-system-setting.git"
+    },
+    "license": "MIT",
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/",
+        "access": "public"
+    },
+    "harmony": {
+        "alias": "react-native-system-setting",
+        "autolinking": {
+            "etsPackageClassName": "SystemSettingPackage",
+            "cppPackageClassName": "SystemSettingPackage",
+            "cmakeLibraryTargetName": "rnoh_system_setting",
+            "ohPackageName": "@react-native-ohos/react-native-system-setting"
+        }
+    }
 }

package/src/ReactRNSystemSetting.ts

@@ -1,113 +1,109 @@
-import type { TurboModule } from 'react-native';
-import { TurboModuleRegistry } from 'react-native';
-
-export interface Spec extends TurboModule {
-    getBrightness: () => Promise<number>;
-
-    setBrightness: (val: number) => Promise<boolean>;
-
-    setBrightnessForce: (val: number) => Promise<boolean>;
-
-    getAppBrightness: () => Promise<number>;
-
-    setAppBrightness: (val: number) => Promise<boolean>;
-
-    grantWriteSettingPremission: () => void;
-
-    getScreenMode: () => Promise<number>;
-
-    setScreenMode: (val: number) => Promise<boolean>;
-
-    saveBrightness: () => Promise<void>;
-
-    restoreBrightness: () => number;
-
-    getVolume: (type?: VolumeType) => Promise<number>;
-
-    setVolume: (value: number, config?: VolumeConfig | VolumeType) => void;
-
-    addVolumeListener: () => void;
-
-    removeVolumeListener: (listener?: EmitterSubscription) => void;
-
-    isWifiEnabled: () => Promise<boolean>;
-
-    switchWifiSilence: (onComplete?: CompleteFunc) => void;
-
-    switchWifi: (onComplete?: CompleteFunc) => void;
-
-    isLocationEnabled: () => Promise<boolean>;
-
-    getLocationMode: () => Promise<number>;
-
-    switchLocation: (onComplete?: CompleteFunc) => void;
-
-    isBluetoothEnabled: () => Promise<boolean>;
-
-    switchBluetooth: (onComplete?: CompleteFunc) => void;
-
-    switchBluetoothSilence: (onComplete?: CompleteFunc) => void;
-
-    isAirplaneEnabled: () => Promise<boolean>;
-
-    switchAirplane: (onComplete?: CompleteFunc) => void;
-
-    openAppSystemSettings: () => void;
-
-    addBluetoothListener: () => void;
-
-    addWifiListener: (
-        callback: (wifiEnabled: boolean) => void
-    ) => Promise<EmitterSubscription | null>;
-
-    addLocationListener: (
-        callback: (locationEnabled: boolean) => void
-    ) => Promise<EmitterSubscription | null>;
-
-    addLocationModeListener: (
-        callback: (locationMode: number) => void
-    ) => Promise<EmitterSubscription | null>;
-
-    addAirplaneListener: (
-        callback: (airplaneModeEnabled: boolean) => void
-    ) => Promise<EmitterSubscription | null>;
-
-    removeListener: (type: string) => void;
-
-    addListener(eventName: string): void;
-  
-    removeListeners(count: number): void;
-}
-
-type EmitterSubscription = {
-    remove: unknown;
-    type: 'bluetooth' | 'wifi' | 'location' | 'locationMode' | 'airplane'
-}
-
-type CompleteFunc = () => void
-
-type VolumeType =
-    | "call"
-    | "system"
-    | "ring"
-    | "music"
-    | "alarm"
-    | "notification";
-
-type VolumeConfig = {
-    type?: VolumeType;
-    playSound?: boolean;
-    showUI?: boolean;
-}
-
-type VolumeData = {
-    value: number;
-    call?: number;
-    system?: number;
-    ring?: number;
-    music?: number;
-    alarm?: number;
-    notification?: number;
-}
-
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+    getBrightness: () => Promise<number>;
+
+    setBrightness: (val: number) => Promise<boolean>;
+
+    setBrightnessForce: (val: number) => Promise<boolean>;
+
+    getAppBrightness: () => Promise<number>;
+
+    setAppBrightness: (val: number) => Promise<boolean>;
+
+    grantWriteSettingPremission: () => void;
+
+    getScreenMode: () => Promise<number>;
+
+    setScreenMode: (val: number) => Promise<boolean>;
+
+    saveBrightness: () => Promise<void>;
+
+    restoreBrightness: () => number;
+
+    getVolume: (type?: VolumeType) => Promise<number>;
+
+    setVolume: (value: number, config?: VolumeConfig | VolumeType) => void;
+
+    addVolumeListener: () => void;
+
+    removeVolumeListener: (listener?: EmitterSubscription) => void;
+
+    isWifiEnabled: () => Promise<boolean>;
+
+    switchWifiSilence: (onComplete?: CompleteFunc) => void;
+
+    switchWifi: (onComplete?: CompleteFunc) => void;
+
+    isLocationEnabled: () => Promise<boolean>;
+
+    getLocationMode: () => Promise<number>;
+
+    switchLocation: (onComplete?: CompleteFunc) => void;
+
+    isBluetoothEnabled: () => Promise<boolean>;
+
+    switchBluetooth: (onComplete?: CompleteFunc) => void;
+
+    switchBluetoothSilence: (onComplete?: CompleteFunc) => void;
+
+    isAirplaneEnabled: () => Promise<boolean>;
+
+    switchAirplane: (onComplete?: CompleteFunc) => void;
+
+    openAppSystemSettings: () => void;
+
+    addBluetoothListener: () => void;
+
+    addWifiListener: (
+        callback: (wifiEnabled: boolean) => void
+    ) => Promise<EmitterSubscription | null>;
+
+    addLocationListener: (
+        callback: (locationEnabled: boolean) => void
+    ) => Promise<EmitterSubscription | null>;
+
+    addLocationModeListener: (
+        callback: (locationMode: number) => void
+    ) => Promise<EmitterSubscription | null>;
+
+    addAirplaneListener: (
+        callback: (airplaneModeEnabled: boolean) => void
+    ) => Promise<EmitterSubscription | null>;
+
+    removeListener: (type: string) => void;
+}
+
+type EmitterSubscription = {
+    remove: unknown;
+    type: 'bluetooth' | 'wifi' | 'location' | 'locationMode' | 'airplane'
+}
+
+type CompleteFunc = () => void
+
+type VolumeType =
+    | "call"
+    | "system"
+    | "ring"
+    | "music"
+    | "alarm"
+    | "notification";
+
+type VolumeConfig = {
+    type?: VolumeType;
+    playSound?: boolean;
+    showUI?: boolean;
+}
+
+type VolumeData = {
+    value: number;
+    call?: number;
+    system?: number;
+    ring?: number;
+    music?: number;
+    alarm?: number;
+    notification?: number;
+}
+
 export default TurboModuleRegistry.get<Spec>('ReactNativeSystemSetting') as Spec | null;

package/harmony/react_native_system_setting/BuildProfile.ets

@@ -1,6 +0,0 @@
-export default class BuildProfile { 
-	static readonly HAR_VERSION = '1.0.0';
-	static readonly BUILD_MODE_NAME = 'debug';
-	static readonly DEBUG = true;
-	static readonly TARGET_NAME = 'default';
-}