@react-native-ohos/react-native-sensitive-info 6.0.1-rc.1

package/harmony/react_native_sensitive_info/src/ohosTest/ets/testability/pages/Index.ets

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+@Entry
+@Component
+struct Index {
+  @State message: string = 'Hello World';
+
+  build() {
+    Row() {
+      Column() {
+        Text(this.message)
+          .fontSize(50)
+          .fontWeight(FontWeight.Bold)
+      }
+      .width('100%')
+    }
+    .height('100%')
+  }
+}

package/harmony/react_native_sensitive_info/src/ohosTest/ets/testrunner/OpenHarmonyTestRunner.ets

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+import { abilityDelegatorRegistry, TestRunner } from '@kit.TestKit';
+import { UIAbility, Want } from '@kit.AbilityKit';
+import { BusinessError } from '@kit.BasicServicesKit';
+import { hilog } from '@kit.PerformanceAnalysisKit';
+import { resourceManager } from '@kit.LocalizationKit';
+import { util } from '@kit.ArkTS';
+
+let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
+let abilityDelegatorArguments: abilityDelegatorRegistry.AbilityDelegatorArgs;
+let jsonPath: string = 'mock/mock-config.json';
+let tag: string = 'testTag';
+
+async function onAbilityCreateCallback(data: UIAbility) {
+  hilog.info(0x0000, 'testTag', 'onAbilityCreateCallback, data: ${}', JSON.stringify(data));
+}
+
+async function addAbilityMonitorCallback(err: BusinessError) {
+  hilog.info(0x0000, 'testTag', 'addAbilityMonitorCallback : %{public}s', JSON.stringify(err) ?? '');
+}
+
+export default class OpenHarmonyTestRunner implements TestRunner {
+  constructor() {
+  }
+
+  onPrepare() {
+    hilog.info(0x0000, 'testTag', '%{public}s', 'OpenHarmonyTestRunner OnPrepare');
+  }
+
+  async onRun() {
+    let tag = 'testTag';
+    hilog.info(0x0000, tag, '%{public}s', 'OpenHarmonyTestRunner onRun run');
+    abilityDelegatorArguments = abilityDelegatorRegistry.getArguments()
+    abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator()
+    let moduleName = abilityDelegatorArguments.parameters['-m'];
+    let context = abilityDelegator.getAppContext().getApplicationContext().createModuleContext(moduleName);
+    let mResourceManager = context.resourceManager;
+    await checkMock(abilityDelegator, mResourceManager);
+    const bundleName = abilityDelegatorArguments.bundleName;
+    const testAbilityName: string = 'TestAbility';
+    let lMonitor: abilityDelegatorRegistry.AbilityMonitor = {
+      abilityName: testAbilityName,
+      onAbilityCreate: onAbilityCreateCallback,
+      moduleName: moduleName
+    };
+    abilityDelegator.addAbilityMonitor(lMonitor, addAbilityMonitorCallback)
+    const want: Want = {
+      bundleName: bundleName,
+      abilityName: testAbilityName,
+      moduleName: moduleName
+    };
+    abilityDelegator.startAbility(want, (err: BusinessError, data: void) => {
+      hilog.info(0x0000, tag, 'startAbility : err : %{public}s', JSON.stringify(err) ?? '');
+      hilog.info(0x0000, tag, 'startAbility : data : %{public}s', JSON.stringify(data) ?? '');
+    })
+    hilog.info(0x0000, tag, '%{public}s', 'OpenHarmonyTestRunner onRun end');
+  }
+}
+
+async function checkMock(abilityDelegator: abilityDelegatorRegistry.AbilityDelegator,
+  resourceManager: resourceManager.ResourceManager) {
+  let rawFile: Uint8Array;
+  try {
+    rawFile = resourceManager.getRawFileContentSync(jsonPath);
+    hilog.info(0x0000, tag, 'MockList file exists');
+    let mockStr: string = util.TextDecoder.create('utf-8', { ignoreBOM: true }).decodeWithStream(rawFile);
+    let mockMap: Record<string, string> = getMockList(mockStr);
+    try {
+      abilityDelegator.setMockList(mockMap)
+    } catch (error) {
+      let code = (error as BusinessError).code;
+      let message = (error as BusinessError).message;
+      hilog.error(0x0000, tag, `abilityDelegator.setMockList failed, error code: ${code}, message: ${message}.`);
+    }
+  } catch (error) {
+    let code = (error as BusinessError).code;
+    let message = (error as BusinessError).message;
+    hilog.error(0x0000, tag,
+      `ResourceManager:callback getRawFileContent failed, error code: ${code}, message: ${message}.`);
+  }
+}
+
+function getMockList(jsonStr: string) {
+  let jsonObj: Record<string, Object> = JSON.parse(jsonStr);
+  let map: Map<string, object> = new Map<string, object>(Object.entries(jsonObj));
+  let mockList: Record<string, string> = {};
+  map.forEach((value: object, key: string) => {
+    let realValue: string = value['source'].toString();
+    mockList[key] = realValue;
+  });
+  hilog.info(0x0000, tag, '%{public}s', 'mock-json value:' + JSON.stringify(mockList) ?? '');
+  return mockList;
+}

package/harmony/react_native_sensitive_info/src/ohosTest/module.json5

@@ -0,0 +1,28 @@
+{
+  "module": {
+    "name": "react_native_sensitive_info_test",
+    "type": "feature",
+    "description": "$string:module_test_desc",
+    "mainElement": "TestAbility",
+    "deviceTypes": [
+      "phone",
+      "tablet",
+      "2in1"
+    ],
+    "deliveryWithInstall": true,
+    "installationFree": false,
+    "pages": "$profile:test_pages",
+    "abilities": [
+      {
+        "name": "TestAbility",
+        "srcEntry": "./ets/testability/TestAbility.ets",
+        "description": "$string:TestAbility_desc",
+        "icon": "$media:icon",
+        "label": "$string:TestAbility_label",
+        "exported": true,
+        "startWindowIcon": "$media:icon",
+        "startWindowBackground": "$color:start_window_background"
+      }
+    ]
+  }
+}

package/harmony/react_native_sensitive_info/src/ohosTest/resources/base/element/color.json

@@ -0,0 +1,8 @@
+{
+  "color": [
+    {
+      "name": "start_window_background",
+      "value": "#FFFFFF"
+    }
+  ]
+}

package/harmony/react_native_sensitive_info/src/ohosTest/resources/base/element/string.json

@@ -0,0 +1,16 @@
+{
+  "string": [
+    {
+      "name": "module_test_desc",
+      "value": "test ability description"
+    },
+    {
+      "name": "TestAbility_desc",
+      "value": "the test ability"
+    },
+    {
+      "name": "TestAbility_label",
+      "value": "test label"
+    }
+  ]
+}

package/harmony/react_native_sensitive_info/src/ohosTest/resources/base/profile/test_pages.json

@@ -0,0 +1,5 @@
+{
+  "src": [
+    "testability/pages/Index"
+  ]
+}

package/harmony/react_native_sensitive_info/src/test/List.test.ets

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+import localUnitTest from './LocalUnit.test';
+
+export default function testsuite() {
+  localUnitTest();
+}

package/harmony/react_native_sensitive_info/src/test/LocalUnit.test.ets

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+import { describe, beforeAll, beforeEach, afterEach, afterAll, it, expect } from '@ohos/hypium';
+
+export default function localUnitTest() {
+  describe('localUnitTest', () => {
+    // Defines a test suite. Two parameters are supported: test suite name and test suite function.
+    beforeAll(() => {
+      // Presets an action, which is performed only once before all test cases of the test suite start.
+      // This API supports only one parameter: preset action function.
+    });
+    beforeEach(() => {
+      // Presets an action, which is performed before each unit test case starts.
+      // The number of execution times is the same as the number of test cases defined by **it**.
+      // This API supports only one parameter: preset action function.
+    });
+    afterEach(() => {
+      // Presets a clear action, which is performed after each unit test case ends.
+      // The number of execution times is the same as the number of test cases defined by **it**.
+      // This API supports only one parameter: clear action function.
+    });
+    afterAll(() => {
+      // Presets a clear action, which is performed after all test cases of the test suite end.
+      // This API supports only one parameter: clear action function.
+    });
+    it('assertContain', 0, () => {
+      // Defines a test case. This API supports three parameters: test case name, filter parameter, and test case function.
+      let a = 'abc';
+      let b = 'b';
+      // Defines a variety of assertion methods, which are used to declare expected boolean conditions.
+      expect(a).assertContain(b);
+      expect(a).assertEqual(a);
+    });
+  });
+}

package/harmony/react_native_sensitive_info/ts.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+export * from './src/main/ets/RNSensitiveInfoPackage';
+export * from './src/main/ets/RNSensitiveInfoTurboModule';
+

package/index.d.ts

@@ -0,0 +1,74 @@
+type RNSensitiveInfoBiometryType = 'Touch ID' | 'Face ID';
+
+type RNSensitiveInfoAccessControlOptions =
+  | 'kSecAccessControlApplicationPassword'
+  | 'kSecAccessControlPrivateKeyUsage'
+  | 'kSecAccessControlDevicePasscode'
+  | 'kSecAccessControlTouchIDAny'
+  | 'kSecAccessControlTouchIDCurrentSet'
+  | 'kSecAccessControlUserPresence'
+  | 'kSecAccessControlBiometryAny'
+  | 'kSecAccessControlBiometryCurrentSet';
+
+type RNSensitiveInfoAttrAccessibleOptions =
+  | 'kSecAttrAccessibleAfterFirstUnlock'
+  | 'kSecAttrAccessibleAlways'
+  | 'kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly'
+  | 'kSecAttrAccessibleWhenUnlockedThisDeviceOnly'
+  | 'kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly'
+  | 'kSecAttrAccessibleAlwaysThisDeviceOnly'
+  | 'kSecAttrAccessibleWhenUnlocked';
+
+interface RNSensitiveInfoAndroidDialogStrings {
+  header?: string;
+  description?: string;
+  hint?: string;
+  success?: string;
+  notRecognized?: string;
+  cancel?: string;
+  cancelled?: string;
+}
+
+export interface RNSensitiveInfoOptions {
+  kSecAccessControl?: RNSensitiveInfoAccessControlOptions;
+  kSecAttrAccessible?: RNSensitiveInfoAttrAccessibleOptions;
+  kSecAttrSynchronizable?: boolean;
+  keychainService?: string;
+  sharedPreferencesName?: string;
+  touchID?: boolean;
+  showModal?: boolean;
+  kSecUseOperationPrompt?: string;
+  kLocalizedFallbackTitle?: string;
+  strings?: RNSensitiveInfoAndroidDialogStrings;
+}
+
+export declare function setItem(
+  key: string,
+  value: string,
+  options: RNSensitiveInfoOptions,
+): Promise<null>;
+export declare function getItem(
+  key: string,
+  options: RNSensitiveInfoOptions,
+): Promise<string>;
+
+interface SensitiveInfoEntry {
+  key: string;
+  value: string;
+  service: string;
+}
+export declare function getAllItems(
+  options: RNSensitiveInfoOptions,
+): Promise<[SensitiveInfoEntry[]]>;
+
+export declare function deleteItem(
+  key: string,
+  options: RNSensitiveInfoOptions,
+): Promise<null>;
+export declare function isSensorAvailable(): Promise<
+  RNSensitiveInfoBiometryType | boolean
+>;
+
+export declare function hasEnrolledFingerprints(): Promise<boolean>;
+export declare function cancelFingerprintAuth(): void;
+export declare function setInvalidatedByBiometricEnrollment(set: boolean): void;

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@react-native-ohos/react-native-sensitive-info",
+  "version": "6.0.1-rc.1",
+  "main": "build/index.js",
+  "module": "build/index.es.js",
+  "jsnext:main": "build/index.es.js",
+  "types": "index.d.ts",
+  "description": "react-native-sensitive-info manages all data stored in Android Shared Preferences and iOS Keychain. You can set, get and delete keys/values using simple methods.",
+  "scripts": {
+    "build": "rimraf -rf build && rollup -c",
+    "prepublishOnly": "yarn build",
+    "localPublish": "yalc publish && cd example && yalc add react-native-sensitive-info --yarn && cd ..",
+    "codegen-lib": "react-native codegen-lib-harmony --no-safety-check --npm-package-name react-native-sensitive-info --cpp-output-path ./harmony/react_native_sensitive_info/src/main/cpp/generated --ets-output-path ./harmony/react_native_sensitive_info/src/main/ets/generated --turbo-modules-spec-paths ./src/NativeSensitiveInfo.ts"
+  },
+  "contributors": [
+    "Mateus Andrade mtw.andrade@gmail.com",
+    "Samin Shams <samin@classapp.co>"
+  ],
+  "homepage": "https://gitcode.com/openharmony-sig/rntpc_react-native-sensitive-info",
+  "bugs": {
+    "url": "https://gitcode.com/openharmony-sig/rntpc_react-native-sensitive-info/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitcode.com:openharmony-sig/rntpc_react-native-sensitive-info.git"
+  },
+  "harmony": {
+    "alias": "react-native-sensitive-info"
+  },
+  "keywords": [
+    "android",
+    "ios",
+    "keychain",
+    "harmony",
+    "shared-preferences",
+    "react-native",
+    "windows"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "react-native": "*",
+    "react-native-sensitive-info": "6.0.0-alpha.9"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^16.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^4.6.1",
+    "@typescript-eslint/parser": "^4.6.1",
+    "eslint": "^7.12.1",
+    "eslint-config-airbnb": "^18.2.0",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-import-resolver-typescript": "^2.3.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-prettier": "^3.1.4",
+    "eslint-plugin-react": "^7.21.5",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "prettier": "^2.1.2",
+    "react": "^17.0.1",
+    "react-native": "^0.62.2",
+    "react-native-windows": "0.63.6",
+    "rollup": "^2.33.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-typescript2": "^0.29.0",
+    "typescript": "^4.0.5",
+    "yalc": "^1.0.0-pre.45",
+    "react-native-harmony-cli": "npm:@react-native-oh/react-native-harmony-cli@^0.0.27"
+  }
+}

package/react-native-sensitive-info.podspec

@@ -0,0 +1,19 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name         = package['name']
+  s.version      = package['version']
+  s.summary      = package['description']
+  s.license      = package['license']
+
+  s.authors      = package['author']
+  s.homepage     = package['homepage']
+  s.platforms    = { :ios => "8.0" }
+
+  s.source       = { :git => "https://github.com/mCodex/react-native-sensitive-info", :tag => "v#{s.version}" }
+  s.source_files  = "ios/**/*.{h,m}"
+
+  s.dependency 'React-Core'
+end

package/src/NativeSensitiveInfo.ts

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd. All rights reserved
+ * Use of this source code is governed by a MIT license that can be
+ * found in the LICENSE file.
+ */
+
+import type { TurboModule } from 'react-native/Libraries/TurboModule/RCTExport';
+import { TurboModuleRegistry } from 'react-native';
+
+type RNSensitiveInfoBiometryType = 'Touch ID' | 'Face ID';
+
+type RNSensitiveInfoAccessControlOptions =
+  | 'kSecAccessControlApplicationPassword'
+  | 'kSecAccessControlPrivateKeyUsage'
+  | 'kSecAccessControlDevicePasscode'
+  | 'kSecAccessControlTouchIDAny'
+  | 'kSecAccessControlTouchIDCurrentSet'
+  | 'kSecAccessControlUserPresence'
+  | 'kSecAccessControlBiometryAny'
+  | 'kSecAccessControlBiometryCurrentSet';
+
+type RNSensitiveInfoAttrAccessibleOptions =
+  | 'kSecAttrAccessibleAfterFirstUnlock'
+  | 'kSecAttrAccessibleAlways'
+  | 'kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly'
+  | 'kSecAttrAccessibleWhenUnlockedThisDeviceOnly'
+  | 'kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly'
+  | 'kSecAttrAccessibleAlwaysThisDeviceOnly'
+  | 'kSecAttrAccessibleWhenUnlocked';
+
+interface RNSensitiveInfoAndroidDialogStrings {
+  header?: string;
+  description?: string;
+  hint?: string;
+  success?: string;
+  notRecognized?: string;
+  cancel?: string;
+  cancelled?: string;
+}
+export interface RNSensitiveInfoOptions {
+    kSecAccessControl?: RNSensitiveInfoAccessControlOptions;
+    kSecAttrAccessible?: RNSensitiveInfoAttrAccessibleOptions;
+    kSecAttrSynchronizable?: boolean;
+    keychainService?: string;
+    sharedPreferencesName?: string;
+    touchID?: boolean;
+    showModal?: boolean;
+    kSecUseOperationPrompt?: string;
+    kLocalizedFallbackTitle?: string;
+    strings?: RNSensitiveInfoAndroidDialogStrings;
+  }
+  interface SensitiveInfoEntry {
+    key: string;
+    value: string;
+    service: string;
+  }
+export interface Spec extends TurboModule {
+    setItem: (key: string,
+        value: string,
+        options: RNSensitiveInfoOptions) => Promise<null>;
+    getItem: (key: string,
+        options: RNSensitiveInfoOptions) => Promise<string>;
+    hasItem(
+      key: string,
+      options: RNSensitiveInfoOptions,
+    ): Promise<boolean>;
+    getAllItems(
+        options: RNSensitiveInfoOptions,
+        ): Promise<[SensitiveInfoEntry[]]>;
+    deleteItem(
+        key: string,
+        options: RNSensitiveInfoOptions,
+        ): Promise<null>;
+    isSensorAvailable(): Promise<
+        RNSensitiveInfoBiometryType | boolean
+      >;
+    hasEnrolledFingerprints(): Promise<boolean>;
+    cancelFingerprintAuth(): void;
+    setInvalidatedByBiometricEnrollment(set: boolean): void;
+} 
+export default TurboModuleRegistry.get<Spec>('SensitiveInfoNativeModule') as Spec | null;