feat:适配harmony平台

Author: yangyuchun (C)

README.md

@@ -1,119 +1,17 @@
-@sparkfabrik/react-native-idfa-aaid
+# react-native-idfa-aaid
 
-# React Native module to get IDFA (iOS) or AAID (Android)
+本项目基于 [react-native-idfa-aaid](https://github.com/sparkfabrik/sparkfabrik-react-native-idfa-aaid)
 
-## Intro
+## 文档地址 / Documentation URL 
 
-[React Native](https://reactnative.dev/) is a framework for creating native mobile apps based on React.
+[中文 / Chinese](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-idfa-aaid.md)
 
-The **Advertising Identifier** ([IDFA](https://developer.apple.com/documentation/adsupport/asidentifiermanager) on iOS, [AAID](https://developer.android.com/training/articles/ad-id) on Android) is a device-specific, unique, resettable ID for advertising that allows developers and marketers to track activity for advertising purposes.
+## Codegen
 
-This npm module allows any mobile application built with React Native to access the Advertising ID, following the OS specific definition and user permissions.
+该库已接入 codegen，具体请查阅文档。
 
-The module output in the RN framework is the following:
+The library has been integrated with codegen. Please refer to the documentation for details.
 
-```ts
-interface AdvertisingInfoResponse {
-  id: string; // the Advertising ID (or null if not defined/permitted)
-  isAdTrackingLimited: boolean; // the user defined permission to track
-}
-```
+## 请悉知 / Acknowledgements
 
-## Supported platform
-
-- Android
-- iOS
-
-## Installation
-
-```sh
-npm install @sparkfabrik/react-native-idfa-aaid
-```
-
-or
-
-```sh
-yarn add @sparkfabrik/react-native-idfa-aaid
-```
-
-Then run `pod install` in your `ios` folder after installation.
-
-## Usage
-
-### iOS configuration
-
-For `native` apps, in `info.plist` make sure to add:
-
-```xml
-<key>NSUserTrackingUsageDescription</key>
-<string>...</string>
-```
-
-For `Expo` apps, in `app.json` make sure to add:
-
-```json
-{
-  "expo": {
-    "plugins": [
-      [
-        "expo-tracking-transparency",
-        {
-          "userTrackingPermission": "..."
-        }
-      ]
-    ]
-  }
-}
-```
-
-### React Native components
-
-Example of a basic integration in a RN component.
-
-```js
-import ReactNativeIdfaAaid, { AdvertisingInfoResponse } from '@sparkfabrik/react-native-idfa-aaid';
-
-const MyComponent: React.FC = () => {
-  const [idfa, setIdfa] = useState<string | null>();
-
-  useEffect(() => {
-    ReactNativeIdfaAaid.getAdvertisingInfo()
-      .then((res: AdvertisingInfoResponse) =>
-        !res.isAdTrackingLimited ? setIdfa(res.id) : setIdfa(null),
-      )
-      .catch((err) => {
-        console.log(err);
-        return setIdfa(null);
-      });
-  }, []);
-```
-
-#### iOS 17.4
-
-In order to prevent a bug present in iOS 17.4 we also expose the `getAdvertisingInfoAndCheckAuthorization(check: boolean)` which aims to solve the problem of `ATT Tracking Manager` returning status `denied` even if the ATT modal was not yet displayed to the user.
-
-```js
-import ReactNativeIdfaAaid, { AdvertisingInfoResponse } from '@sparkfabrik/react-native-idfa-aaid';
-
-const MyComponent: React.FC = () => {
-  const [idfa, setIdfa] = useState<string | null>();
-
-  useEffect(() => {
-    ReactNativeIdfaAaid.getAdvertisingInfoAndCheckAuthorization(true)
-      .then((res: AdvertisingInfoResponse) =>
-        !res.isAdTrackingLimited ? setIdfa(res.id) : setIdfa(null),
-      )
-      .catch((err) => {
-        console.log(err);
-        return setIdfa(null);
-      });
-  }, []);
-```
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
-
-## License
-
-MIT
+本项目基于 [The MIT License (MIT)](https://github.com/sparkfabrik/sparkfabrik-react-native-idfa-aaid/blob/master/LICENSE) ，请自由地享受和参与开源。

harmony/getOaid.har

@@ -0,0 +1 @@
+export * from "./ts";

harmony/getOaid/Index.ets

@@ -0,0 +1,28 @@
+{
+  "apiType": "stageMode",
+  "buildOption": {
+  },
+  "buildOptionSet": [
+    {
+      "name": "release",
+      "arkOptions": {
+        "obfuscation": {
+          "ruleOptions": {
+            "enable": true,
+            "files": [
+              "./obfuscation-rules.txt"
+            ]
+          },
+        }
+      },
+    },
+  ],
+  "targets": [
+    {
+      "name": "default"
+    },
+    {
+      "name": "ohosTest"
+    }
+  ]
+}

harmony/getOaid/build-profile.json5

@@ -0,0 +1,6 @@
+import { harTasks } from '@ohos/hvigor-ohos-plugin';
+
+export default {
+    system: harTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */
+    plugins:[]         /* Custom plugin to extend the functionality of Hvigor. */
+}

harmony/getOaid/hvigorfile.ts

@@ -0,0 +1,18 @@
+# Define project specific obfuscation rules here.
+# You can include the obfuscation configuration files in the current module's build-profile.json5.
+#
+# For more details, see
+#   https://gitee.com/openharmony/arkcompiler_ets_frontend/blob/master/arkguard/README.md
+
+# Obfuscation options:
+# -disable-obfuscation: disable all obfuscations
+# -enable-property-obfuscation: obfuscate the property names
+# -enable-toplevel-obfuscation: obfuscate the names in the global scope
+# -compact: remove unnecessary blank spaces and all line feeds
+# -remove-log: remove all console.* statements
+# -print-namecache: print the name cache that contains the mapping from the old names to new names
+# -apply-namecache: reuse the given cache file
+
+# Keep options:
+# -keep-property-name: specifies property names that you want to keep
+# -keep-global-name: specifies names that you want to keep in the global scope

harmony/getOaid/obfuscation-rules.txt

@@ -0,0 +1,10 @@
+{
+  "name": "@react-native-oh-tpl/react-native-idfa-aaid",
+  "version": "1.2.0-0.0.1",
+  "description": "",
+  "main": "Index.ets",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@rnoh/react-native-openharmony": 'file:../react_native_openharmony',
+  }
+}

harmony/getOaid/oh-package.json5

@@ -0,0 +1,88 @@
+import { TurboModule } from '@rnoh/react-native-openharmony/ts';
+import { TM } from "@rnoh/react-native-openharmony/generated/ts"
+import { abilityAccessCtrl, Permissions, bundleManager, common } from '@kit.AbilityKit';
+import { identifier } from '@kit.AdsKit';
+
+export type AdvertisingInfoResponse = {
+  id: string | null;
+  isAdTrackingLimited: boolean;
+};
+
+const permission = 'ohos.permission.APP_TRACKING_CONSENT';
+
+async function getAccessTokenID(): Promise<number> {
+  try {
+    const bundleInfo: bundleManager.BundleInfo =
+      await bundleManager.getBundleInfoForSelf(bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION);
+    const appInfo: bundleManager.ApplicationInfo = bundleInfo.appInfo;
+    return appInfo.accessTokenId;
+  } catch (error) {
+    throw new Error(`Error getting AccessToken ID: ${error}`);
+  }
+}
+
+async function checkPermissionGrant(tokenId: number, permission: Permissions): Promise<abilityAccessCtrl.GrantStatus> {
+  const atManager = abilityAccessCtrl.createAtManager();
+  return await atManager.checkAccessToken(tokenId, permission);
+}
+
+async function requestPermission(context: common.UIAbilityContext, permission: Permissions): Promise<void> {
+  const atManager = abilityAccessCtrl.createAtManager();
+  await atManager.requestPermissionsFromUser(context, [permission]);
+}
+
+async function obtainingPermissions(tokenId: number): Promise<string | null> {
+  try {
+    const oaid = await identifier.getOAID();
+    return oaid;
+  } catch (error) {
+    console.error('Error retrieving OAID:', error);
+    return null;
+  }
+}
+
+async function ModuleImplementation(context): Promise<AdvertisingInfoResponse> {
+  let result: AdvertisingInfoResponse = { id: null, isAdTrackingLimited: true };
+  try {
+    const tokenId = await getAccessTokenID();
+    let isAdTrackingLimited = false;
+
+    const permissionStatus = await checkPermissionGrant(tokenId, permission);
+    if (permissionStatus !== abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
+      try {
+        await requestPermission(context, permission);
+        const newPermissionStatus = await checkPermissionGrant(tokenId, permission);
+        if (newPermissionStatus !== abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
+          isAdTrackingLimited = true;
+        }
+      } catch (error) {
+        console.error('Permission request failed:', error);
+        isAdTrackingLimited = true;
+      }
+    }
+    const oaid = await obtainingPermissions(tokenId);
+    result.id = oaid;
+    result.isAdTrackingLimited = isAdTrackingLimited;
+    return result;
+  } catch (error) {
+    console.error('Error getting OAID with permission:', error);
+    return result;
+  }
+}
+
+export class GetOaidModule extends TurboModule implements TM.RTNGetOaidNativeModule.Spec {
+  private context: common.UIAbilityContext = this.ctx.uiAbilityContext;
+
+  async getAdvertisingInfo(): Promise<AdvertisingInfoResponse> {
+    return ModuleImplementation(this.context);
+  }
+
+  async getAdvertisingInfoAndCheckAuthorization(check: boolean): Promise<AdvertisingInfoResponse> {
+    return ModuleImplementation(this.context);
+  }
+}
+
+
+
+
+

harmony/getOaid/src/main/ets/GetOaidModule.ts

@@ -0,0 +1,29 @@
+import {
+    RNPackage,
+    TurboModulesFactory,
+  } from "@rnoh/react-native-openharmony/ts";
+  import type {
+    TurboModule,
+    TurboModuleContext,
+  } from "@rnoh/react-native-openharmony/ts";
+  import { TM } from "@rnoh/react-native-openharmony/generated/ts";
+  import { GetOaidModule } from './GetOaidModule';
+  
+  class GetOaidModulesFactory extends TurboModulesFactory {
+    createTurboModule(name: string): TurboModule | null {
+      if (name === TM.RTNGetOaidNativeModule.NAME) {
+        return new GetOaidModule(this.ctx);
+      }
+      return null;
+    }
+
+    hasTurboModule(name: string): boolean {
+      return name === TM.RTNGetOaidNativeModule.NAME;
+    }
+  }
+  
+  export class GetOaidPackage extends RNPackage {
+    createTurboModulesFactory(ctx: TurboModuleContext): TurboModulesFactory {
+      return new GetOaidModulesFactory(ctx);
+    }
+  }

harmony/getOaid/src/main/ets/GetOaidPackage.ts

@@ -0,0 +1,20 @@
+
+{
+  "module" : {
+    "name": 'getOaid',
+    "type": 'har',
+    "deviceTypes": ['default'],
+    "requestPermissions":[
+      {
+        "name" : "ohos.permission.APP_TRACKING_CONSENT",
+        "reason": "$string:page_show",
+        "usedScene": {
+          "abilities": [
+            "FormAbility"
+          ],
+          "when":"always"
+        },
+      },
+    ]
+  }
+}

harmony/getOaid/src/main/module.json5

@@ -0,0 +1,16 @@
+{
+  "string": [
+    {
+      "name": "module_desc",
+      "value": "module description"
+    },
+    {
+      "name": "EntryAbility_desc",
+      "value": "description"
+    },
+    {
+      "name": "EntryAbility_label",
+      "value": "label"
+    }
+  ]
+}

harmony/getOaid/src/main/resources/en_US/element/string.json

@@ -0,0 +1,16 @@
+{
+  "string": [
+    {
+      "name": "module_desc",
+      "value": "模块描述"
+    },
+    {
+      "name": "EntryAbility_desc",
+      "value": "description"
+    },
+    {
+      "name": "EntryAbility_label",
+      "value": "label"
+    }
+  ]
+}

harmony/getOaid/src/main/resources/zh_CN/element/string.json

@@ -0,0 +1,2 @@
+export * from "./src/main/ets/GetOaidPackage";
+export * from "./src/main/ets/GetOaidModule";