react-native-idosdk 1.0.4 → 1.0.6

package/react-native-harmony-ido/README.md

@@ -0,0 +1,266 @@
+ [Github 地址](https://github.com/GetuiLaboratory/react-native-idosdk/tree/main/react-native-harmony-ido)
+
+## 安装与使用
+
+下载 [gt-ido-ohos-plugin-1.0.1.tgz](gt-ido-ohos-plugin-1.0.1.tgz) 并放到 React Native 工程根目录，然后执行：
+
+```sh
+npm install file:./gt-ido-ohos-plugin-1.0.1.tgz
+```
+
+
+下面的代码展示了这个库的基本使用场景：
+完成代码参考[App.tsx](../example/OhosDemo/App.tsx)
+
+> [!WARNING] 使用时 import 的库名不变。
+
+```js
+import { GetuiIdo } from "gt-ido-ohos-plugin";
+//....省略
+function App(): React.JSX.Element {
+    const isDarkMode = useColorScheme() === 'dark';
+    const [gtcid, setGtcid] = useState<string | null>(null); // 存储 gtcid
+    const [version, setVersion] = useState<string>('未知'); // 存储版本号
+    
+    // 初始化运营工具
+    const initIdo = () => {
+        try {
+            // 获取版本号
+            GetuiIdo.version((ver: string) => {
+                setVersion(ver);
+            });
+
+            const appId = '你的 AppID';
+            const channel = 'rn';
+            GetuiIdo.setDebugEnable(true)
+
+            GetuiIdo.startSdk(appId, channel);
+
+            setTimeout((): void => {
+                // 获取 gtcid
+                GetuiIdo.gtcid((id: string) => {
+                    Alert.alert('成功', '运营工具初始化成功 \n '+id);
+                    setGtcid(id);
+                });
+            }, 1000);
+            
+            // 开启调试模式（可选）
+            GetuiIdo.setDebugEnable(true);
+            // 设置其他可选配置（根据需求调整，时间单位为毫秒）
+            GetuiIdo.setSessionTime(30000); // 设置会话时间（毫秒）
+            GetuiIdo.setMinAppActiveDuration(60000); // 设置最小活跃时长（毫秒）
+            GetuiIdo.setMaxAppActiveDuration(3600000); // 设置最大活跃时长（毫秒）
+            GetuiIdo.setEventUploadInterval(300000); // 设置事件上传间隔（毫秒）
+            GetuiIdo.setEventForceUploadSize(50); // 设置强制上传事件数量
+            GetuiIdo.setProfileUploadInterval(600000); // 设置用户画像上传间隔（毫秒）
+            GetuiIdo.setProfileForceUploadSize(20); // 设置用户画像强制上传数量
+
+            const profiles = {
+                "userId": 123,
+                "name": "Alice",
+                "isActive": true
+            };
+
+            GetuiIdo.setProfile(profiles,  "sss");
+        } catch (error) {
+            Alert.alert('错误', '初始化运营工具失败: ' + error);
+        }
+    };
+    const trackCountEvent = () =>{
+        const profiles = {
+            "userId": 123,
+            "name": "Alice",
+            "isActive": true
+        };
+
+        GetuiIdo.trackCountEvent("123",profiles,"ss");
+    };
+}
+//....省略
+export default App;
+
+```
+
+## Link
+
+目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。
+
+首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony`
+
+### 1.在工程根目录的 `oh-package.json5` 添加 overrides 字段
+
+```json
+{
+  ...
+  "overrides": {
+    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
+  }
+}
+```
+
+### 2.引入原生端代码
+
+> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。
+
+打开 `entry/oh-package.json5`，添加以下依赖
+
+```json
+"dependencies": {
+    "@rnoh/react-native-openharmony": "0.72.90",
+    "IdoOhosSdk": "file:../../node_modules/gt-ido-ohos-plugin/harmony/IdoOhosSdk.har"
+  }
+```
+点击右上角的 `sync` 按钮
+
+
+### 3.配置 CMakeLists 和引入 IdoPackage
+
+打开 `entry/src/main/cpp/CMakeLists.txt`，添加：
+
+```diff
+project(rnapp)
+cmake_minimum_required(VERSION 3.4.1)
+set(CMAKE_SKIP_BUILD_RPATH TRUE)
+set(OH_MODULE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
+set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+
+set(RNOH_CPP_DIR "${OH_MODULE_DIR}/@rnoh/react-native-openharmony/src/main/cpp")
+set(RNOH_GENERATED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/generated")
+set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments")
+set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie")
+add_compile_definitions(WITH_HITRACE_SYSTRACE)
+set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
+
+add_subdirectory("${RNOH_CPP_DIR}" ./rn)
+add_subdirectory("${OH_MODULE_DIR}/IdoOhosSdk/src/main/cpp" ./ido)
+
+add_library(rnoh_app SHARED
+   "./PackageProvider.cpp"
+   "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
+ )
+
+target_link_libraries(rnoh_app PUBLIC rnoh)
+target_link_libraries(rnoh_app PUBLIC rnoh_ido)
+```
+
+打开 `entry/src/main/cpp/PackageProvider.cpp`，添加：
+
+```diff
+#include "RNOH/PackageProvider.h"  
+#include "IdoPackage.h"
+
+using namespace rnoh;  
+std::vector<std::shared_ptr<Package>> 
+PackageProvider::getPackages(Package::Context ctx) {
+   return {
+          std::make_shared<IdoPackage>(ctx)
+   };
+}
+```
+
+### 4.在 ArkTS 侧引入 IdoPackage
+
+打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加：
+
+```diff
+import { RNPackageContext, RNPackage } from '@rnoh/react-native-openharmony/ts';
+import  { IdoPackage } from 'IdoOhosSdk/ts';
+
+export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
+  return [
+    new IdoPackage(ctx),
+  ];
+}
+```
+
+### 5.配置appid参数
+
+打开 `entry/src/main/module.json5`，添加：
+
+```diff
+    "metadata": [
+      {
+        "name": "GETUI_APPID",
+        "value": "你的 AppID"
+      },
+
+    ],
+    "requestPermissions": [
+      {
+        "name": "ohos.permission.INTERNET"
+      },
+      {
+        "name": "ohos.permission.GET_NETWORK_INFO"
+      },
+      {
+        "name": "ohos.permission.GET_WIFI_INFO"
+      },
+      {
+        "name": "ohos.permission.APP_TRACKING_CONSENT",
+        "reason" : "$string:oaid_reason",
+        "usedScene": {
+          "when": "always"
+        }
+      }
+    ]
+```
+
+### 6.运行
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+然后编译、运行即可。
+
+## 约束与限制
+
+## 兼容性
+
+要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。
+
+
+## 方法
+
+```ts
+export interface Spec extends TurboModule {
+
+startSdk(appid: string, channel: string): void;
+
+gtcid(cb: (param: string) => void): void;
+
+version(cb: (param: string) => void): void;
+
+setDebugEnable(isEnable: boolean): void;
+
+setSessionTime(time: number): void;
+
+setMinAppActiveDuration(val: number): void;
+
+setMaxAppActiveDuration(val: number): void;
+
+setEventUploadInterval(val: number): void;
+
+setEventForceUploadSize(val: number): void;
+
+setProfileUploadInterval(val: number): void;
+
+setProfileForceUploadSize(val: number): void;
+
+setUserId(val: string): void;
+
+trackCustomKeyValueEventBegin(eventId: string): void;
+
+trackCustomKeyValueEventEnd(eventId: string, args:{[key: string]: string|number|boolean}, ext: string): void;
+
+trackCountEvent(eventId: string, args:{[key: string]: string|number|boolean}, ext: string): void;
+
+setProfile(profiles: {[key: string]: string|number|boolean}, ext: string): void;
+
+}
+```

package/react-native-harmony-ido/harmony/BuildProfile.ets

@@ -0,0 +1,17 @@
+/**
+ * Use these variables when you tailor your ArkTS code. They must be of the const type.
+ */
+export const HAR_VERSION = '1.0.0';
+export const BUILD_MODE_NAME = 'debug';
+export const DEBUG = true;
+export const TARGET_NAME = 'default';
+
+/**
+ * BuildProfile Class is used only for compatibility purposes.
+ */
+export default class BuildProfile { 
+	static readonly HAR_VERSION = HAR_VERSION;
+	static readonly BUILD_MODE_NAME = BUILD_MODE_NAME;
+	static readonly DEBUG = DEBUG;
+	static readonly TARGET_NAME = TARGET_NAME;
+}

package/react-native-harmony-ido/harmony/Index.ets

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

package/react-native-harmony-ido/harmony/build-profile.json5

@@ -0,0 +1,36 @@
+{
+  "apiType": "stageMode",
+  "buildOption": {
+    "resOptions": {
+      "copyCodeResource": {
+        "enable": false
+      }
+    }
+  },
+  "buildOptionSet": [
+    {
+      "name": "release",
+      "arkOptions": {
+        "obfuscation": {
+          "ruleOptions": {
+            "enable": false,
+            "files": [
+              "./obfuscation-rules.txt"
+            ]
+          },
+          "consumerFiles": [
+            "./consumer-rules.txt"
+          ]
+        }
+      },
+    },
+  ],
+  "targets": [
+    {
+      "name": "default"
+    },
+    {
+      "name": "ohosTest"
+    }
+  ]
+}

package/react-native-harmony-ido/harmony/hvigorfile.ts

@@ -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. */
+}

package/react-native-harmony-ido/harmony/obfuscation-rules.txt

@@ -0,0 +1,23 @@
+# 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://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/source-obfuscation-V5
+
+# 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
+
+-enable-property-obfuscation
+-enable-toplevel-obfuscation
+-enable-filename-obfuscation
+-enable-export-obfuscation

package/react-native-harmony-ido/harmony/oh-package-lock.json5

@@ -0,0 +1,38 @@
+{
+  "meta": {
+    "stableOrder": true,
+    "enableUnifiedLockfile": false
+  },
+  "lockfileVersion": 3,
+  "ATTENTION": "THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.",
+  "specifiers": {
+    "@getui/gtc@../oh_modules/.ohpm/@getui+ido@zkoyyirssaxz8gef8vqhhop3efu+q3r1jbt0qr5k6hs=/oh_modules/@getui/ido/libs/GTC-HM-1.0.5.har": "@getui/gtc@../oh_modules/.ohpm/@getui+ido@zkoyyirssaxz8gef8vqhhop3efu+q3r1jbt0qr5k6hs=/oh_modules/@getui/ido/libs/GTC-HM-1.0.5.har",
+    "@getui/ido@libs/getui_ido_1.0.1.har": "@getui/ido@libs/getui_ido_1.0.1.har",
+    "@rnoh/react-native-openharmony@0.72.90": "@rnoh/react-native-openharmony@0.72.90"
+  },
+  "packages": {
+    "@getui/gtc@../oh_modules/.ohpm/@getui+ido@zkoyyirssaxz8gef8vqhhop3efu+q3r1jbt0qr5k6hs=/oh_modules/@getui/ido/libs/GTC-HM-1.0.5.har": {
+      "name": "@getui/gtc",
+      "version": "1.0.5",
+      "resolved": "../oh_modules/.ohpm/@getui+ido@zkoyyirssaxz8gef8vqhhop3efu+q3r1jbt0qr5k6hs=/oh_modules/@getui/ido/libs/GTC-HM-1.0.5.har",
+      "registryType": "local"
+    },
+    "@getui/ido@libs/getui_ido_1.0.1.har": {
+      "name": "",
+      "version": "1.0.1",
+      "integrity": "",
+      "resolved": "",
+      "registryType": "local",
+      "dependencies": {
+        "@getui/gtc": "file:./libs/GTC-HM-1.0.5.har"
+      }
+    },
+    "@rnoh/react-native-openharmony@0.72.90": {
+      "name": "",
+      "version": "0.72.90",
+      "integrity": "sha512-15mpPRjzAWad/qTzQasUmKEvQi+FVnrjnduxam7YjOMI8+NNGuF5Srx0B/71KX3hyQTROUlwnUWUdMhfsQ/olw==",
+      "resolved": "https://repo.harmonyos.com/ohpm/@rnoh/react-native-openharmony/-/react-native-openharmony-0.72.90.har",
+      "registryType": "ohpm"
+    }
+  }
+}

package/react-native-harmony-ido/harmony/oh-package.json5

@@ -0,0 +1,12 @@
+{
+  "name": "IdoOhosSdk",
+  "version": "1.0.0",
+  "description": "Please describe the basic information.",
+  "main": "Index.ets",
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@rnoh/react-native-openharmony": "0.72.90",
+    "@getui/ido": "file:./libs/getui_ido_1.0.1.har"
+  }
+}

package/react-native-harmony-ido/harmony/src/main/cpp/CMakeLists.txt

@@ -0,0 +1,7 @@
+cmake_minimum_required(VERSION 3.4.1)
+set(CMAKE_VERBOSE_MAKEFILE on)
+
+file(GLOB rnoh_ido_SRC CONFIGURE_DEPENDS *.cpp)
+add_library(rnoh_ido SHARED ${rnoh_ido_SRC})
+target_include_directories(rnoh_ido PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(rnoh_ido PUBLIC rnoh)

package/react-native-harmony-ido/harmony/src/main/cpp/IdoModule.cpp

@@ -0,0 +1,38 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ * 
+ * @generatorVersion: 1
+ */
+
+
+#include "IdoModule.h"
+
+namespace rnoh {
+using namespace facebook;
+
+IdoModule::IdoModule(const ArkTSTurboModule::Context ctx, const std::string name) : ArkTSTurboModule(ctx, name) {
+    methodMap_ = {
+        ARK_METHOD_METADATA(startSdk, 2),
+        ARK_METHOD_METADATA(gtcid, 1),
+        ARK_METHOD_METADATA(version, 1),
+        ARK_METHOD_METADATA(setDebugEnable, 1),
+        ARK_METHOD_METADATA(setSessionTime, 1),
+        ARK_METHOD_METADATA(setMinAppActiveDuration, 1),
+        ARK_METHOD_METADATA(setMaxAppActiveDuration, 1),
+        ARK_METHOD_METADATA(setEventUploadInterval, 1),
+        ARK_METHOD_METADATA(setEventForceUploadSize, 1),
+        ARK_METHOD_METADATA(setProfileUploadInterval, 1),
+        ARK_METHOD_METADATA(setProfileForceUploadSize, 1),
+        ARK_METHOD_METADATA(setUserId, 1),
+        ARK_METHOD_METADATA(trackCustomKeyValueEventBegin, 1),
+        ARK_METHOD_METADATA(trackCustomKeyValueEventEnd, 3),
+        ARK_METHOD_METADATA(trackCountEvent, 3),
+        ARK_METHOD_METADATA(setProfile, 2),
+    };
+}
+
+} // namespace rnoh
+

package/react-native-harmony-ido/harmony/src/main/cpp/IdoModule.h

@@ -0,0 +1,21 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ * 
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ * 
+ * @generatorVersion: 1
+ */
+
+#pragma once
+
+#include "RNOH/ArkTSTurboModule.h"
+
+namespace rnoh {
+
+class JSI_EXPORT IdoModule : public ArkTSTurboModule {
+  public:
+    IdoModule(const ArkTSTurboModule::Context ctx, const std::string name);
+};
+
+} // namespace rnoh

package/react-native-harmony-ido/harmony/src/main/cpp/IdoPackage.h

@@ -0,0 +1,76 @@
+/**
+ * This code was generated by "react-native codegen-harmony"
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be
+ * lost once the code is regenerated.
+ *
+ * @generatorVersion: 1
+ */
+
+#pragma once
+
+#include "RNOH/Package.h"
+#include "RNOH/ArkTSTurboModule.h"
+#include "IdoModule.h"
+
+namespace rnoh {
+
+class IdoPackageTurboModuleFactoryDelegate : public TurboModuleFactoryDelegate {
+  public:
+    SharedTurboModule createTurboModule(Context ctx, const std::string &name) const override {
+        if (name == "IdoModule") {
+            return std::make_shared<IdoModule>(ctx, name);
+        }
+        return nullptr;
+    };
+};
+
+class GeneratedEventEmitRequestHandler : public EventEmitRequestHandler {
+  public:
+    void handleEvent(Context const &ctx) override {
+        auto eventEmitter = ctx.shadowViewRegistry->getEventEmitter<facebook::react::EventEmitter>(ctx.tag);
+        auto componentName = ctx.shadowViewRegistry->getComponentName(ctx.tag);
+
+        if (eventEmitter == nullptr) {
+            return;
+        }
+
+        std::vector<std::string> supportedComponentNames = {
+        };
+
+        std::vector<std::string> supportedEventNames = {
+        };
+
+        if (std::find(supportedComponentNames.begin(), supportedComponentNames.end(), componentName) != supportedComponentNames.end() &&
+            std::find(supportedEventNames.begin(), supportedEventNames.end(), ctx.eventName) != supportedEventNames.end()) {
+            eventEmitter->dispatchEvent(ctx.eventName, ArkJS(ctx.env).getDynamic(ctx.payload));
+        }    
+    }
+};
+
+class IdoPackage : public Package {
+  public:
+    IdoPackage(Package::Context ctx) : Package(ctx){};
+
+    std::unique_ptr<TurboModuleFactoryDelegate> createTurboModuleFactoryDelegate() override {
+        return std::make_unique<IdoPackageTurboModuleFactoryDelegate>();
+    }
+
+    std::vector<facebook::react::ComponentDescriptorProvider> createComponentDescriptorProviders() override {
+        return {
+        };
+    }
+
+    ComponentJSIBinderByString createComponentJSIBinderByName() override {
+        return {
+        };
+    };
+
+    EventEmitRequestHandlers createEventEmitRequestHandlers() override {
+        return {
+            std::make_shared<GeneratedEventEmitRequestHandler>(),
+        };
+    }
+};
+
+} // namespace rnoh