tmui-cli 2.0.3 → 2.0.4

package/data/uni-app-x-docs/native/modules/android/uni-push.md

@@ -0,0 +1,229 @@
+## uni-push
+
+uni-app x 在4.81版本支持了FCM渠道，所以文档区分为国内和国外的配置，开发者根据需要集成，**二者配置不能同时集成**。
+
+### 国内
+
+国内推送包括华为、小米、魅族、VIVO、OPPO、荣耀厂商渠道
+
+### Gradle配置
+
+首先需在项目根目录下的build.gradle增加个推仓库源
+
+```
+buildscript {
+	repositories {
+		jcenter()
+		google()
+	}
+}
+allprojects {
+	repositories {
+		jcenter()
+		google()
+        // 个推的Maven仓库地址。
+        maven { 
+            url 'https://mvn.getui.com/nexus/content/repositories/releases' 
+        }
+        // 配置荣耀的Maven仓地址，荣耀厂商推送需要。
+        maven {
+            url 'https://developer.hihonor.com/repo/'
+        }
+	}
+}
+```
+
+项目应用下的build.gradle
+
+```
+android {
+    defaultConfig {
+        manifestPlaceholders = [
+            "GETUI_APPID" : "%GETUI_APPID%",
+            "PUSH_APPID" : "%PUSH_APPID%",
+            "GETUI_APP_ID": "%GETUI_APP_ID%",
+            "dcloud_unipush_auto_notification":"%透传时是否自动创建通知，布尔类型%"
+            // 厂商推送配置
+            //小米
+            "XIAOMI_APP_ID":"%XIAOMI_APP_ID%",
+            "XIAOMI_APP_KEY":"%XIAOMI_APP_KEY%",
+            //魅族
+            "MEIZU_APP_ID":"%MEIZU_APP_ID%",
+            "MEIZU_APP_KEY":"%MEIZU_APP_KEY%",
+            //OPPO
+            "OPPO_APP_KEY":"%OPPO_APP_KEY%",
+            "OPPO_APP_SECRET":"%OPPO_APP_SECRET%",
+            //华为
+            "HUAWEI_APP_ID":"%HUAWEI_APP_ID%",
+            //vivo
+            "VIVO_APP_ID":"%VIVO_APP_ID%",
+            "VIVO_APP_KEY":"%VIVO_APP_KEY%",
+            //荣耀
+            "HONOR_APP_ID":"%HONOR_APP_ID%",
+        ]
+    }
+}
+
+dependencies {
+    implementation 'com.getui:gtc-dcloud:3.2.16.7'  //个推核心组件
+    implementation('com.getui:gtsdk:3.3.7.0'){ exclude(group: 'com.getui') }  //个推SDK
+
+    // 根据所需厂商选择集成
+    implementation 'com.getui.opt:hwp:3.1.2'   // 华为
+    implementation 'com.huawei.hms:push:6.11.0.300' // 华为
+
+    implementation 'com.getui.opt:xmp:3.3.1'   // 小米
+
+    implementation 'com.assist-v3:oppo:3.4.0'  // oppo
+    implementation 'com.google.code.gson:gson:2.6.2' // oppo
+    implementation 'commons-codec:commons-codec:1.6' // oppo
+    implementation 'androidx.annotation:annotation:1.1.0' // oppo
+
+    implementation 'com.assist-v3:vivo:3.1.2'  // vivo
+
+    implementation 'com.getui.opt:mzp:3.2.3'   // 魅族
+
+    implementation 'com.getui.opt:honor:3.6.0' // 荣耀
+    implementation 'com.hihonor.mcs:push:7.0.61.303' // 荣耀
+}
+
+
+```
+`GETUI_APPID`、`PUSH_APPID`和`GETUI_APP_ID` 在开发者中心->uni-push->2.0->消息推送->配置管理->应用配置->AppID，请务必填写一致，`PUSH_APPID`字段是与一键登录出现AppID冲突时优先读取。
+
+厂商相关的字段内容，在开发者中心->uni-push->2.0->厂商推送设置。
+
+
+### 本地依赖库
+
+|名称                   |备注|
+|:--				    |:--|
+|uni-push-release.aar   ||
+
+将本地依赖库复制到app项目的libs下。
+
+
+#### 华为配置
+
+
+##### Gradle配置
+
+* 需在项目根目录下的build.gradle增加华为推送的仓库地址
+```
+buildscript {
+	repositories {
+		jcenter()
+		google()
+		// 配置HMS Core SDK的Maven仓地址。
+		maven {url 'https://developer.huawei.com/repo/'}
+	}
+	dependencies {
+		// 增加agcp配置。
+		classpath 'com.huawei.agconnect:agcp:1.6.0.300'
+	}
+}
+allprojects {
+	repositories {
+		jcenter()
+		google()
+		// 配置HMS Core SDK的Maven仓地址。
+		maven {url 'https://developer.huawei.com/repo/'}
+	}
+}
+```
+
+* 项目应用下的build.gradle
+
+在文件头 apply plugin: 'com.android.application' 下一行添加如下配置。
+
+
+```
+apply plugin: 'com.android.application'
+apply plugin: 'com.huawei.agconnect'
+```
+
+* 添加华为推送的配置文件
+
+登录华为的AppGallery Connect网站，找到需要集成华为推送的应用，在“项目设置 > 常规”页面的“应用”区域，点击`agconnect-services.json`下载配置文件。
+
+
+将`agconnect-services.json`文件拷贝到应用级根目录下即可。
+
+
+
+### 国外
+
+国外推送只包括FCM
+#### FCM配置
+
+### Gradle配置
+
+首先需在项目根目录下的build.gradle增加个推仓库源
+
+```
+buildscript {
+	repositories {
+		jcenter()
+		google()
+	}
+	dependencies {
+		// 增加agcp配置。
+		classpath 'com.google.gms:google-services:4.3.15'
+	}
+}
+allprojects {
+	repositories {
+		jcenter()
+		google()
+        // 个推的Maven仓库地址。
+        maven { 
+            url 'https://mvn.getui.com/nexus/content/repositories/releases' 
+        }
+	}
+}
+```
+
+* 项目应用下的build.gradle
+
+在文件头 apply plugin: 'com.android.application' 下一行添加如下配置。
+
+
+```
+apply plugin: 'com.android.application'
+apply plugin: 'com.google.gms.google-services'
+
+android {
+    defaultConfig {
+        manifestPlaceholders = [
+            "GETUI_APPID" : "%GETUI_APPID%",
+            "PUSH_APPID" : "%PUSH_APPID%",
+            "GETUI_APP_ID": "%GETUI_APP_ID%",
+            "dcloud_unipush_auto_notification":"%透传时是否自动创建通知，布尔类型%"
+        ]
+    }
+}
+
+dependencies {
+    implementation 'com.getui:sdk-for-gj:4.4.3.17'
+    implementation 'com.getui.opt:fcm:3.1.2' 
+    implementation 'com.google.firebase:firebase-messaging:23.2.1'
+}
+```
+`GETUI_APPID`、`PUSH_APPID`和`GETUI_APP_ID` 在开发者中心->uni-push->2.0->消息推送->配置管理->应用配置->AppID，请务必填写一致。
+
+
+* 添加 FCM 的配置文件
+
+登录[FCM网站](https://firebase.google.com/)，找到需要集成FCM的应用，获取`google-services.json`配置文件。
+
+
+将`google-services.json`文件拷贝到应用级根目录下即可。
+
+
+### 本地依赖库
+
+|名称                   |备注|
+|:--				    |:--|
+|uni-push-release.aar   ||
+
+将本地依赖库复制到app项目的libs下。

package/data/uni-app-x-docs/native/modules/android/uni-share.md

@@ -0,0 +1,61 @@
+## uni-share
+
+### 微信分享
+
+项目应用下的build.gradle添加：
+
+::: preview
+
+> build.gradle
+
+```groovy
+dependencies {
+    implementation 'com.tencent.mm.opensdk:wechat-sdk-android:6.8.0'
+}
+```
+
+> build.gradle.kts
+
+```groovy
+dependencies {
+    implementation("com.tencent.mm.opensdk:wechat-sdk-android:6.8.0")
+}
+```
+
+:::
+
+|本地依赖库名称									|
+|:--											|
+|uni-share-release.aar	|
+|uni-share-weixin-release.aar	|
+|uni-weixin-common-release.aar |
+
+#### 插件注册
+
+以下配置在 VDOM 和 蒸汽模式（Vapor）下均适用，将内容添加到主模块的build.gradle。
+
+::: preview
+
+> build.gradle
+
+```groovy
+defaultConfig {
+    buildConfigField "String", "UTSRegisterProviders", "\"[{\\\"name\\\":\\\"weixin\\\",\\\"service\\\":\\\"share\\\",\\\"class\\\":\\\"uts.sdk.modules.DCloudUniShareWeixin.UniShareWeixinProviderImpl\\\"}]\""
+}
+```
+
+> build.gradle.kts
+
+```groovy
+defaultConfig {
+    buildConfigField("String", "UTSRegisterProviders", "\"[{\\\"name\\\":\\\"weixin\\\",\\\"service\\\":\\\"share\\\",\\\"class\\\":\\\"uts.sdk.modules.DCloudUniShareWeixin.UniShareWeixinProviderImpl\\\"}]\"")
+}
+```
+
+:::
+
+蒸汽模式（Vapor）还需依赖 `uni-event`。
+
+### 注意
+
+1. 同时导入微信分享和微信登录模块时，`uni-weixin-common-release.aar`只保留一个即可。

package/data/uni-app-x-docs/native/modules/android/uni-verify.md

@@ -0,0 +1,105 @@
+## uni-verify
+
+### 本地依赖库
+
+|名称                   |
+|:--				    |
+|uni-verify-release.aar |
+|GY-3.1.6.3-release.aar	|
+
+将本地依赖库复制到app项目的libs下。
+
+### 线上依赖库
+
+1. 在项目根目录下的settings.gradle中增加个推仓库源。
+
+```groovy
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+		...
+        maven {
+            url 'https://mvn.getui.com/nexus/content/repositories/releases'
+        }
+    }
+}
+```
+
+2. 将线上依赖库添加到app项目的build.gradle下。
+
+::: preview
+
+> build.gradle
+
+```groovy
+dependencies {
+    implementation "com.getui:gtc-dcloud:3.2.16.7"
+}
+```
+
+> build.gradle.kts
+
+```groovy
+dependencies {
+    implementation("com.getui:gtc-dcloud:3.2.16.7")
+}
+```
+
+:::
+
+### 配置应用ID
+
+在app项目下的build.gradle配置一键登录的应用ID。
+
+```groovy
+android {
+    defaultConfig {
+        manifestPlaceholders = [
+			"GETUI_APPID" : "%GETUI_APPID%",
+            "GY_APP_ID" : "%GY_APP_ID%",
+        ]
+    }
+}
+```
+
+GETUI_APPID与GY_APP_ID对应[开发者中心](https://dev.dcloud.net.cn/)一键登录->基础配置->一键登录应用ID，GETUI_APPID与GY_APP_ID取值相同。
+
+### 插件注册
+
+将以下内容添加到主模块的build.gradle。
+
+::: preview
+
+> build.gradle（蒸汽模式）
+
+```groovy
+defaultConfig {
+    buildConfigField 'String', 'UTSMethodRegister', '"uts.sdk.modules.DCloudUniVerify.UniUTSMethodRegister"'
+}
+```
+
+> build.gradle.kts（蒸汽模式）
+
+```groovy
+defaultConfig {
+    buildConfigField("String", "UTSMethodRegister", "\"uts.sdk.modules.DCloudUniVerify.UniUTSMethodRegister\"")
+}
+```
+
+> build.gradle（VDOM模式）
+
+```groovy
+defaultConfig {
+    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniVerify.UniVerifyExtApiPagesRegister\",\"method\":\"register\"}]"'
+}
+```
+
+> build.gradle.kts（VDOM模式）
+
+```groovy
+defaultConfig {
+    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniVerify.UniVerifyExtApiPagesRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
+}
+```
+
+:::

package/data/uni-app-x-docs/native/modules/android/uni-video.md

@@ -0,0 +1,135 @@
+## uni-video
+
+**HBuilderX 5.08以上版本配置**
+
+### 本地依赖库
+
+|名称					|
+|:--					|
+|uni-video-release.aar	|
+
+将本地依赖库复制到app项目的libs下。
+
+### 线上依赖库
+
+::: preview
+
+> build.gradle
+
+```groovy
+dependencies {
+    implementation 'androidx.media3:media3-exoplayer:1.8.0'
+    implementation 'androidx.media3:media3-exoplayer-hls:1.8.0'
+}
+```
+
+> build.gradle.kts
+
+```groovy
+dependencies {
+    implementation("androidx.media3:media3-exoplayer:1.8.0")
+    implementation("androidx.media3:media3-exoplayer-hls:1.8.0")
+}
+```
+
+:::
+
+
+### 模块依赖
+
+|名称					|
+|:--					|
+|uni-fileSystemManager	|
+|uni-getSystemInfo		|
+|uni-screenBrightness	|
+
+蒸汽模式（Vapor）还需依赖 `uni-event`。
+
+### 组件注册
+
+将以下内容添加到主模块的build.gradle，详见[根据configjson配置应用](../../use/androiduts.md#utscomponents)。
+
+::: preview
+
+> build.gradle（VDOM模式）
+
+```groovy
+defaultConfig {
+    buildConfigField 'String', 'UTSEasyCom', '"[{\"class\":\"uts.sdk.modules.DCloudUniVideo.UniVideoExtApiComponentsRegister\",\"method\":\"register\"}]"'
+}
+```
+
+> build.gradle.kts（VDOM模式）
+
+```groovy
+defaultConfig {
+    buildConfigField("String", "UTSEasyCom", "\"[{\\\"class\\\":\\\"uts.sdk.modules.DCloudUniVideo.UniVideoExtApiComponentsRegister\\\",\\\"method\\\":\\\"register\\\"}]\"")
+}
+```
+
+:::
+
+**HBuilderX 5.08以下版本配置**
+
+### 本地依赖库
+
+|名称					|
+|:--					|
+|uni-video-release.aar	|
+|ijkplayer.aar			|
+|videoplayer.aar		|
+
+将本地依赖库复制到app项目的libs下。
+
+### 线上依赖库
+
+::: preview
+
+> build.gradle
+
+```groovy
+dependencies {
+    implementation 'com.github.bumptech.glide:glide:4.9.0'
+    implementation 'androidx.annotation:annotation:1.1.0'
+    implementation 'androidx.core:core:1.1.0'
+}
+```
+
+> build.gradle.kts
+
+```groovy
+dependencies {
+    implementation("com.github.bumptech.glide:glide:4.9.0")
+    implementation("androidx.annotation:annotation:1.1.0")
+    implementation("androidx.core:core:1.1.0")
+}
+```
+
+:::
+
+
+将线上依赖库添加到app项目的build.gradle下。
+
+### 组件注册
+
+将以下内容添加到主模块的build.gradle，详见[根据configjson配置应用](../../use/androiduts.md#utscomponents)。
+
+::: preview
+
+> build.gradle
+
+```groovy
+defaultConfig {
+    buildConfigField "String", "UTSRegisterComponents", "\"[{\\\"name\\\":\\\"video\\\",\\\"class\\\":\\\"uts.sdk.modules.DCloudUniVideo.VideoComponent\\\"}]\""
+}
+```
+
+> build.gradle.kts
+
+```groovy
+defaultConfig {
+    buildConfigField("String", "UTSRegisterComponents", "\"[{\\\"name\\\":\\\"video\\\",\\\"class\\\":\\\"uts.sdk.modules.DCloudUniVideo.VideoComponent\\\"}]\"")
+}
+```
+
+:::

package/data/uni-app-x-docs/native/modules/harmony/facialVerify.md

@@ -0,0 +1,47 @@
+## 实人认证
+
+### 配置依赖
+
+依赖har包：`@uni_modules/uni-facialverify`，此har包未发布到鸿蒙ohpm需要自行到任意uni-app-x项目编译到鸿蒙的产物（`unpackage/dist/dev/app-harmony/libs/uni_modules__uni_facialverify.har`）内拷贝到鸿蒙原生项目。
+
+在鸿蒙原生项目`oh-package.json5`文件内`dependencies`字段下添加如下内容：
+
+```json
+"@uni_modules/uni-facialverify": "./libs/uni_modules__uni_facialverify.har"
+```
+
+### 注册模块
+
+在uni_modules入口文件`index.generated.ets`内注册实人认证api。
+
+::: preview
+> VDOM模式
+```typescript
+import { registerUniProvider, uni } from "@dcloudio/uni-app-x-runtime";
+import { startFacialRecognitionVerify, getFacialRecognitionMetaInfo } from '@uni_modules/uni-facialverify'
+
+export function initUniModules() {
+  initUniExtApi();
+}
+
+function initUniExtApi() {
+  uni.startFacialRecognitionVerify = startFacialRecognitionVerify
+  uni.getFacialRecognitionMetaInfo = getFacialRecognitionMetaInfo
+}
+```
+> 蒸汽模式
+```typescript
+import { registerUniProvider, uni } from "@dcloudio/uni-app-x-vapor-runtime";
+import { startFacialRecognitionVerify, getFacialRecognitionMetaInfo } from '@uni_modules/uni-facialverify'
+
+export function initUniModules() {
+  initUniExtApi();
+}
+
+function initUniExtApi() {
+  uni.startFacialRecognitionVerify = startFacialRecognitionVerify
+  uni.getFacialRecognitionMetaInfo = getFacialRecognitionMetaInfo
+}
+```
+
+

package/data/uni-app-x-docs/native/modules/harmony/location.md

@@ -0,0 +1,43 @@
+## 定位
+
+### 系统定位
+
+#### 配置依赖
+
+依赖har包：`@uni_modules/uni-location-system`，此har包未发布到鸿蒙ohpm需要自行到任意uni-app-x项目编译到鸿蒙的产物（`unpackage/dist/dev/app-harmony/libs/uni_modules__uni_location_system.har`）内拷贝到鸿蒙原生项目。
+
+在鸿蒙原生项目`oh-package.json5`文件内`dependencies`字段下添加如下内容：
+
+```json
+"@uni_modules/uni-location-system": "./libs/uni_modules__uni_location_system.har"
+```
+
+#### 注册模块
+
+在uni_modules入口文件`index.generated.ets`内注册系统定位api。
+
+::: preview
+> VDOM模式
+```typescript
+import { registerUniProvider, uni } from '@dcloudio/uni-app-x-runtime'
+import { UniLocationSystemProviderImpl } from '@uni_modules/uni-location-system'
+
+export function initUniModules() {
+  initUniExtApi()
+}
+function initUniExtApi() {
+  registerUniProvider('location', 'system', new UniLocationSystemProviderImpl())
+}
+```
+> 蒸汽模式
+```typescript
+import { registerUniProvider, uni } from '@dcloudio/uni-app-x-vapor-runtime'
+import { UniLocationSystemProviderImpl } from '@uni_modules/uni-location-system'
+
+export function initUniModules() {
+  initUniExtApi()
+}
+function initUniExtApi() {
+  registerUniProvider('location', 'system', new UniLocationSystemProviderImpl())
+}
+```

package/data/uni-app-x-docs/native/modules/harmony/map.md

@@ -0,0 +1,64 @@
+## 腾讯地图
+
+### 模块依赖
+
+依赖har包：`@uni_modules/uni-map-tencent`，此har包未发布到鸿蒙ohpm需要自行到任意uni-app-x项目编译到鸿蒙的产物（`unpackage/dist/dev/app-harmony/libs/uni_modules__uni_map_tencent.har`）内拷贝到鸿蒙原生项目。
+
+### 配置腾讯地图key
+
+在`entry/src/main/module.json5`文件内配置腾讯地图key。
+
+```json
+{
+  "module": {
+    // ...
+    "metadata": [
+      {
+        "name": "TENCENT_MAP_KEY",
+        "value": "腾讯地图的key"
+      }
+    ],
+    // ...
+  }
+  // ...
+}
+```
+
+### 注册模块
+在uni_modules入口文件`index.generated.ets`内注册腾讯地图api。
+
+::: preview
+> VDOM模式
+```typescript
+import { registerUniProvider, uni } from "@dcloudio/uni-app-x-runtime";
+import { createMapContext } from '@uni_modules/uni-map-tencent'
+import { UniMapElement } from '@uni_modules/uni-map-tencent'
+import * as uniMapTencent from '@uni_modules/uni-map-tencent'
+
+export function initUniModules() {
+  initUniExtApi();
+  uni.registerUTSPlugin('uni_modules/uni-map-tencent', uniMapTencent)
+}
+
+function initUniExtApi() {
+  uni.createMapContext = createMapContext
+  globalThis.UniMapElement = UniMapElement
+}
+```
+> 蒸汽模式
+```typescript
+import { registerUniProvider, uni } from "@dcloudio/uni-app-x-vapor-runtime";
+import { createMapContext } from '@uni_modules/uni-map-tencent'
+import { UniMapElement } from '@uni_modules/uni-map-tencent'
+import * as uniMapTencent from '@uni_modules/uni-map-tencent'
+
+export function initUniModules() {
+  initUniExtApi();
+  uni.registerUTSPlugin('uni_modules/uni-map-tencent', uniMapTencent)
+}
+
+function initUniExtApi() {
+  uni.createMapContext = createMapContext
+  globalThis.UniMapElement = UniMapElement
+}
+```

package/data/uni-app-x-docs/native/modules/harmony/modules.md

@@ -0,0 +1,23 @@
+如在uni-app项目manifest.json内已勾选对应的鸿蒙模块，则在编译产物的uni_modules目录下会生成对应的`index.generated.ets`和`oh-package.json5`文件，参考[集成编译产物到项目内](../../importfeproject/harmony.md)文档将这两个文件集成到鸿蒙项目内即可。
+
+为简化描述，此处约定后文中的部分概念：
+
+- `index.generated.ets`: 鸿蒙原生工程内的uni_modules入口文件，位于`/entry/src/main/ets/uni_modules/index.generated.ets`，如果没有请自行创建
+- `oh-package.json5`: 鸿蒙原生工程内根目录的`/oh-package.json5`文件
+
+鸿蒙项目的`entry/src/main/ets/entryability/EntryAbility.ets`文件中添加如下代码。
+
+```ts
+import { initUniModules } from '../uni_modules/index.generated'
+initUniModules()
+```
+
+目前如下模块涉及配置依赖或参数：
+
+- [地图](./map.md)
+- [推送](./push.md)
+- [三方登录](./oauth.md)
+- [实人认证](./facialVerify.md)
+- [支付](./pay.md)
+- [一键登录](./verify.md)
+- [定位](./location.md)