mix-public 1.2.0 → 1.2.2

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/033-JumpHalfScreenApp.md

@@ -0,0 +1,126 @@
+---
+date: 2026-03-06
+permalink: /pages/api-jump-half-screen-app/
+categories: 
+  - API
+  - 小程序
+tags: []
+author: { name: AI Assistant }
+---
+
+# JumpHalfScreenApp - 跳转本地半屏小程序
+
+## 功能描述
+
+以全屏 + 半屏的形式打开小程序。若不传OnlineUrl在web端则不跳转。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+JumpHalfScreenApp(option: { 
+  OnlineUrl?: string; 
+  ParentId?: string; 
+  HalfScreenId: string; 
+  Height: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| OnlineUrl | string | 否 | web端小程序链接 | "" |
+| ParentId | string | 否 | 全屏小程序ID | "" |
+| HalfScreenId | string | 是 | 半屏小程序ID | "" |
+| Height | number | 是 | 半屏小程序高度 | 0.8 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 基本使用（仅APP端）
+mixPublicLib.JumpHalfScreenApp({ 
+  HalfScreenId: "halfscreen123",
+  Height: 0.8
+});
+
+// 完整配置（支持Web和APP端）
+mixPublicLib.JumpHalfScreenApp({ 
+  OnlineUrl: "https://example.com/miniapp",
+  ParentId: "parent123",
+  HalfScreenId: "halfscreen123",
+  Height: 0.7
+});
+```
+
+### TypeScript 示例
+
+```
+import type { JumpHalfScreenAppType } from './paramsTypes';
+
+const options: JumpHalfScreenAppType = {
+  OnlineUrl: "https://example.com/miniapp",
+  ParentId: "parent123",
+  HalfScreenId: "halfscreen123",
+  Height: 0.7
+};
+
+mixPublicLib.JumpHalfScreenApp(options);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **APP端**: 以全屏+半屏的形式同时打开两个小程序
+- **Web端**: 如果提供了OnlineUrl，则跳转到该URL；否则输出控制台日志提示
+
+### 参数说明
+
+- **OnlineUrl**: 
+  - Web端使用的小程序在线链接
+  - 如果不提供，Web端不会执行跳转
+  - APP端忽略此参数
+- **ParentId**: 
+  - 全屏显示的小程序ID
+  - 如果不提供，可能使用默认的全屏小程序
+  - APP端可选参数
+- **HalfScreenId**: 
+  - 半屏显示的小程序ID
+  - 必须在APP中已配置的小程序ID
+  - APP端必需参数
+- **Height**: 
+  - 半屏小程序的高度比例
+  - 取值范围：0-1（表示占屏幕高度的比例）
+  - 默认值为0.8（占屏幕高度的80%）
+
+### 使用场景
+
+- 需要同时展示两个小程序内容的场景
+- 主从式小程序交互（如主页面+侧边栏）
+- 提供更丰富的用户界面布局
+
+## 注意事项
+
+- HalfScreenId必须是APP中已配置的有效小程序ID
+- Web端需要提供OnlineUrl才能正常跳转
+- APP端的小程序需要提前在OMEGA项目中配置
+- 跳转成功后会记录小程序打开历史（Web端）
+- Height参数建议在0.3-0.9范围内，避免过小或过大影响用户体验
+- 某些设备可能对半屏模式有特殊限制
+- 建议在调用前验证小程序ID的有效性
+
+## 相关 API
+
+- [`JumpMiniApp`](./032-JumpMiniApp.md) - 跳转APP内小程序
+- [`getMiniProgramUsageRecord`](./034-getMiniProgramUsageRecord.md) - 获取小程序打开历史
+- [`Goto`](./001-Goto.md) - 跳转页面

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/034-getMiniProgramUsageRecord.md

@@ -0,0 +1,115 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-mini-program-usage-record/
+categories: 
+  - API
+  - 小程序
+tags: []
+author: { name: AI Assistant }
+---
+
+# getMiniProgramUsageRecord - 获取小程序打开历史
+
+## 功能描述
+
+获取小程序打开历史记录。返回本地存储的小程序使用记录列表。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+getMiniProgramUsageRecord(): Array<JumpMiniAppRecordType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+Array<JumpMiniAppRecordType> - 返回小程序使用记录数组，每个记录包含以下字段：
+- id: 小程序 id
+- time: 小程序打开时间
+- name: 小程序名称
+- imagePath: 小程序图标
+
+#### JumpMiniAppRecordType 接口定义
+
+```typescript
+interface JumpMiniAppRecordType {
+  id: string;
+  time?: string;
+  name?: string;
+  imagePath?: string;
+}
+```
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取小程序使用记录
+const records = mixPublicLib.getMiniProgramUsageRecord();
+console.log("小程序使用记录:", records);
+
+// 遍历记录
+records.forEach(record => {
+  console.log(`小程序ID: ${record.id}, 打开时间: ${record.time}`);
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { JumpMiniAppRecordType } from './paramsTypes';
+
+const records: Array<JumpMiniAppRecordType> = mixPublicLib.getMiniProgramUsageRecord();
+console.log("小程序使用记录:", records);
+
+// 类型安全的遍历
+records.forEach((record: JumpMiniAppRecordType) => {
+  console.log(`小程序ID: ${record.id}, 打开时间: ${record.time}`);
+});
+```
+
+## 使用说明
+
+### 数据来源
+
+- 记录由 `JumpMiniApp` 和 `JumpHalfScreenApp` 方法调用时自动添加
+- Web端通过cookie存储记录（key: "mix_miniapp_open_record"）
+- APP端通过原生存储机制保存记录
+
+### 记录内容
+
+- **id**: 小程序的唯一标识符
+- **time**: 记录创建的时间戳（毫秒）
+- **name**: 小程序名称（Web端默认为空字符串）
+- **imagePath**: 小程序图标路径（Web端默认为空字符串）
+
+### 使用场景
+
+- 显示最近使用的小程序列表
+- 实现小程序使用统计功能
+- 提供用户常用小程序的快捷入口
+
+## 注意事项
+
+- 如果没有小程序使用记录，返回空数组
+- Web端的记录存储在cookie中，受浏览器存储限制
+- 记录不会自动清理，可能需要手动管理存储空间
+- 时间戳格式为毫秒级Unix时间戳
+- name和imagePath字段在Web端可能为空
+- 建议定期清理过期或无效的记录
+
+## 相关 API
+
+- [`JumpMiniApp`](./032-JumpMiniApp.md) - 跳转APP内小程序
+- [`JumpHalfScreenApp`](./033-JumpHalfScreenApp.md) - 跳转本地半屏小程序
+- [`MiniAppDelete`](./035-MiniAppDelete.md) - 清除本地所有小程序

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/035-MiniAppDelete.md

@@ -0,0 +1,86 @@
+---
+date: 2026-03-06
+permalink: /pages/api-mini-app-delete/
+categories: 
+  - API
+  - 小程序
+tags: []
+author: { name: AI Assistant }
+---
+
+# MiniAppDelete - 清除本地所有小程序
+
+## 功能描述
+
+清除本地所有小程序安装包（下次进入小程序需要重新下载）。用于清理小程序缓存和安装包。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+MiniAppDelete(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 清除所有小程序缓存
+mixPublicLib.MiniAppDelete();
+```
+
+### TypeScript 示例
+
+```typescript
+// 清除所有小程序缓存
+mixPublicLib.MiniAppDelete();
+```
+
+## 使用说明
+
+### 功能说明
+
+- 清除本地存储的所有小程序安装包
+- 清理小程序相关的缓存数据
+- 下次访问小程序时需要重新下载安装包
+
+### 平台差异
+
+- **APP端**: 调用原生方法清除小程序安装包和缓存
+- **Web端**: 控制台输出提示信息："调用清除本地所有小程序缓存"
+
+### 使用场景
+
+- 用户手动清理小程序缓存
+- 解决小程序加载异常问题
+- 释放设备存储空间
+- 强制更新小程序版本
+
+## 注意事项
+
+- 此操作不可逆，会删除所有小程序的本地数据
+- 下次使用小程序时需要重新下载，可能影响用户体验
+- 建议在用户明确确认后执行此操作
+- Web端调用此方法不会产生实际效果
+- 某些系统可能对缓存清理有特殊限制
+- 清理后的小程序需要重新授权和配置
+
+## 相关 API
+
+- [`getMiniProgramUsageRecord`](./034-getMiniProgramUsageRecord.md) - 获取小程序打开历史
+- [`JumpMiniApp`](./032-JumpMiniApp.md) - 跳转APP内小程序
+- [`ClearAppCache`](./073-ClearAppCache.md) - 清理APP缓存

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/046-OCRBankCard.md

@@ -0,0 +1,131 @@
+---
+date: 2026-03-06
+permalink: /pages/api-ocr-bank-card/
+categories: 
+  - API
+  - OCR识别
+tags: []
+author: { name: AI Assistant }
+---
+
+# OCRBankCard - 银行卡OCR
+
+## 功能描述
+
+调用相机进行银行卡OCR识别并返回识别出的信息。Web端无此方法，仅在APP端有效。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+OCRBankCard(): Promise<OCRBankCardType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+#### OCRBankCardType 接口定义
+
+```typescript
+interface OCRBankCardType {
+  Type: number;
+  BankCardNumber: string;
+  BankCardExpire: string;
+  BankCardIssuer: string;
+  BankCardOrganization: string;
+  BankCardType: string;
+  BankCardImgFile: object;
+}
+```
+
+### 返回值说明
+
+Promise<OCRBankCardType> - 返回银行卡识别结果，包含以下字段：
+- Type: 类型（固定为3，表示银行卡）
+- BankCardNumber: 银行卡号码
+- BankCardExpire: 过期时间（格式：2099.12.31）
+- BankCardIssuer: 持卡人姓名
+- BankCardOrganization: 归属地
+- BankCardType: 卡片类型
+- BankCardImgFile: 图像file文件
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 银行卡OCR识别
+mixPublicLib.OCRBankCard()
+  .then(result => {
+    console.log("银行卡识别结果:", result);
+    console.log("卡号:", result.BankCardNumber);
+    console.log("持卡人:", result.BankCardIssuer);
+    console.log("过期时间:", result.BankCardExpire);
+  })
+  .catch(error => {
+    console.error("OCR识别失败:", error);
+  });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { OCRBankCardType } from './paramsTypes';
+
+mixPublicLib.OCRBankCard()
+  .then((result: OCRBankCardType) => {
+    console.log("银行卡识别结果:", result);
+    console.log("卡号:", result.BankCardNumber);
+    console.log("持卡人:", result.BankCardIssuer);
+    console.log("过期时间:", result.BankCardExpire);
+  })
+  .catch((error: any) => {
+    console.error("OCR识别失败:", error);
+  });
+```
+
+## 使用说明
+
+### 平台支持
+
+- **APP端**: 调用原生OCR SDK进行银行卡识别
+- **Web端**: 模拟OCR功能，调用相机或相册选择图片后返回模拟数据
+
+### Web端模拟数据
+
+- BankCardNumber: "1000000000"
+- BankCardExpire: "2099.12.31"
+- BankCardIssuer: "张三"
+- BankCardOrganization: "中华人民共和国"
+- BankCardType: "卡片类型"
+
+### 识别流程
+
+1. 调用相机或相册选择银行卡图片
+2. 系统自动识别银行卡信息
+3. 返回识别结果和处理后的图片文件
+4. 应用可以使用识别结果进行后续处理
+
+## 注意事项
+
+- 此功能主要在APP环境中有效
+- Web端提供模拟功能用于开发测试
+- 需要用户授权相机和相册权限（APP端）
+- 银行卡图片需要清晰、完整、无遮挡
+- 识别准确率受图片质量和光线条件影响
+- 建议在良好的光照条件下进行识别
+- 识别结果需要进行业务验证
+- 敏感信息（如卡号）需要妥善处理和存储
+- 某些特殊银行卡可能无法正确识别
+
+## 相关 API
+
+- [`OCRIdCard`](./047-OCRIdCard.md) - 身份证OCR
+- [`ScanQRCode`](./048-ScanQRCode.md) - 扫码
+- [`UploadPhoto`](./025-UploadPhoto.md) - 选择图片

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/047-OCRIdCard.md

@@ -0,0 +1,170 @@
+---
+date: 2026-03-06
+permalink: /pages/api-ocr-id-card/
+categories: 
+  - API
+  - OCR识别
+tags: []
+author: { name: AI Assistant }
+---
+
+# OCRIdCard - 身份证OCR
+
+## 功能描述
+
+调用相机进行身份证OCR识别并返回识别出的信息。Web端无此方法，仅在APP端有效。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+OCRIdCard(option: { 
+  Type: number; 
+}): Promise<OCRIdCardType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Type | number | 是 | 识别类型（1: 身份证正面 2: 身份证反面） | 1 |
+
+#### OCRIdCardType 接口定义
+
+```typescript
+interface OCRIdCardType {
+  Type: number;
+  IdCardNumber: string;
+  IdCardName: string;
+  IdCardAddress: string;
+  BankCardImgFile: object;
+  IdCardValidDate: string;
+  IdCardNation: string;
+  IdCardSex: string;
+  IdCardAuthority: string;
+}
+```
+
+### 返回值说明
+
+Promise<OCRIdCardType> - 返回身份证识别结果，包含以下字段：
+- Type: 类型（1:身份证正面，2:身份证反面）
+- IdCardNumber: 身份证号码
+- IdCardName: 姓名
+- IdCardAddress: 地址
+- BankCardImgFile: 图像file文件
+- IdCardValidDate: 有效期（格式：2026.12.31-2099.12.31）
+- IdCardNation: 民族
+- IdCardSex: 性别（识别可能不准确，请以身份证倒数第二位判断性别）
+- IdCardAuthority: 归属地（签发机关）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 身份证正面OCR识别
+mixPublicLib.OCRIdCard({ Type: 1 })
+  .then(result => {
+    console.log("身份证识别结果:", result);
+    console.log("姓名:", result.IdCardName);
+    console.log("身份证号:", result.IdCardNumber);
+    console.log("地址:", result.IdCardAddress);
+  })
+  .catch(error => {
+    console.error("OCR识别失败:", error);
+  });
+
+// 身份证反面OCR识别
+mixPublicLib.OCRIdCard({ Type: 2 })
+  .then(result => {
+    console.log("身份证反面识别结果:", result);
+    console.log("有效期:", result.IdCardValidDate);
+    console.log("签发机关:", result.IdCardAuthority);
+  })
+  .catch(error => {
+    console.error("OCR识别失败:", error);
+  });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { OCRIdCardParamsType, OCRIdCardType } from './paramsTypes';
+
+// 身份证正面识别
+const frontOptions: OCRIdCardParamsType = { Type: 1 };
+mixPublicLib.OCRIdCard(frontOptions)
+  .then((result: OCRIdCardType) => {
+    console.log("身份证识别结果:", result);
+    console.log("姓名:", result.IdCardName);
+    console.log("身份证号:", result.IdCardNumber);
+  })
+  .catch((error: any) => {
+    console.error("OCR识别失败:", error);
+  });
+
+// 身份证反面识别
+const backOptions: OCRIdCardParamsType = { Type: 2 };
+mixPublicLib.OCRIdCard(backOptions)
+  .then((result: OCRIdCardType) => {
+    console.log("身份证反面识别结果:", result);
+    console.log("有效期:", result.IdCardValidDate);
+    console.log("签发机关:", result.IdCardAuthority);
+  })
+  .catch((error: any) => {
+    console.error("OCR识别失败:", error);
+  });
+```
+
+## 使用说明
+
+### 平台支持
+
+- **APP端**: 调用原生OCR SDK进行身份证识别
+- **Web端**: 模拟OCR功能，调用相机或相册选择图片后返回模拟数据
+
+### Web端模拟数据
+
+- IdCardNumber: "510000000000000000"
+- IdCardName: "张三"
+- IdCardAddress: "北京市东城区东长安街"
+- IdCardValidDate: "2026.12.31-2099.12.31"
+- IdCardNation: "民族"
+- IdCardSex: "0"
+- IdCardAuthority: "中华人民共和国公安局"
+
+### 识别类型说明
+
+- **Type: 1**: 身份证正面（包含姓名、性别、民族、出生日期、住址、身份证号码）
+- **Type: 2**: 身份证反面（包含签发机关、有效期限）
+
+### 识别流程
+
+1. 调用相机或相册选择身份证图片
+2. 系统自动识别身份证信息
+3. 返回识别结果和处理后的图片文件
+4. 应用可以使用识别结果进行后续处理
+
+## 注意事项
+
+- 此功能主要在APP环境中有效
+- Web端提供模拟功能用于开发测试
+- 需要用户授权相机和相册权限（APP端）
+- 身份证图片需要清晰、完整、无遮挡
+- 识别准确率受图片质量和光线条件影响
+- 建议在良好的光照条件下进行识别
+- **性别识别可能不准确**，请以身份证号码倒数第二位判断性别（奇数为男，偶数为女）
+- 识别结果需要进行业务验证
+- 敏感信息（如身份证号）需要妥善处理和存储
+- 某些特殊身份证可能无法正确识别
+- 正反面需要分别调用，不能同时识别
+
+## 相关 API
+
+- [`OCRBankCard`](./046-OCRBankCard.md) - 银行卡OCR
+- [`ScanQRCode`](./048-ScanQRCode.md) - 扫码
+- [`UploadPhoto`](./025-UploadPhoto.md) - 选择图片