@zfqh/uniapp 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 0.1.1 (2026-05-31)
+
+**Note:** Version bump only for package @zfqh/uniapp
+
+
+
+
+
+## [0.1.0](http://10.10.200.92:8090/gmcb/front-end/compare/@zfqh/uniapp@0.1.0) (2026-05-31)
+
+**Note:** Version bump only for package @zfqh/uniapp

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aniu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# @zfqh/uniapp
+
+uni-app 公共能力包，面向 Vue 3 项目提供统一配置、请求封装、导航、Toast、COS 上传、常用工具、组合式 hooks 和 `g-*` 公共组件。
+
+## 安装
+
+```bash
+npm i @zfqh/uniapp
+```
+
+本包依赖 `@gmcb/uv-ui`、Vue 3、Vuex、Vue I18n、腾讯云 IM/TRTC 相关 SDK 等能力，适合在已有 uni-app 业务项目中复用。
+
+## 注册插件
+
+```ts
+import { createSSRApp } from 'vue';
+import uniapp from '@zfqh/uniapp';
+import App from './App.vue';
+
+export function createApp() {
+  const app = createSSRApp(App);
+  app.use(uniapp);
+  return { app };
+}
+```
+
+## 公共组件
+
+```json
+{
+  "easycom": {
+    "autoscan": true,
+    "custom": {
+      "^g-(.*)": "@zfqh/uniapp/lib/components/g-$1/g-$1.vue",
+      "^uv-(.*)": "@gmcb/uv-ui/components/uv-$1/uv-$1.vue"
+    }
+  }
+}
+```

package/docs/api/apis/core.md

@@ -0,0 +1,189 @@
+# core
+
+公共接口集合。发布路径：`@zfqh/uniapp/lib/apis/core`
+
+| 方法 | HTTP | 路径 | 说明 |
+| --- | --- | --- | --- |
+| `sendSmsCode` | `POST` | `/admin-api/system/auth/send-checkCode` | 发送短信验证码。 |
+| `getTencentToken` | `GET` | `/app-api/infra/file/getTencentToken` | 获取腾讯上传临时 Token。 |
+| `getLastVersion` | `POST` | `/app-api/system/app/version/get-last-version` | 获取最新版本。 |
+| `getCosUrls` | `POST` | `/app-api/infra/cos/getUrls` | 获取 COS 签名后的地址。 |
+| `postRefreshToken` | `POST` | `/app-api/robot/store/auth/refreshToken?refreshToken=:refreshToken` | 刷新 token。 |
+| `getDictData` | `GET` | `/app-api/system/dict-data/type` | 获取字典数据。 |
+
+## 基本使用
+
+上传配置、字典下拉和 token 刷新都可以直接复用公共接口。
+
+```ts
+import { getTencentToken, postRefreshToken, getDictData, getLastVersion } from '@zfqh/uniapp/lib/apis';
+
+export async function loadUploadToken() {
+  const { data } = await getTencentToken();
+  return {
+    secret_id: data.tmpSecretId,
+    secret_key: data.tmpSecretKey,
+    session_token: data.sessionToken,
+  };
+}
+
+export const getCardTypeOptions = () => getDictData({ type: 'system_user_id_type' });
+
+export const refreshLoginToken = (refreshToken: string) => postRefreshToken({ refreshToken });
+
+export const checkAppVersion = () => getLastVersion({ appCode: 'merchant' });
+```
+
+## 接口用法
+
+### sendSmsCode
+
+发送短信验证码。
+
+```ts
+import { sendSmsCode } from '@zfqh/uniapp/lib/apis';
+
+await sendSmsCode({
+  phone: '13800138000',
+});
+```
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | --- | --- |
+| `data` | `Record<string, any>` | 是 | 请求体。常用字段为手机号，例如 `phone` 或后端约定的手机号字段。 |
+
+| 返回值 | 说明 |
+| --- | --- |
+| `Promise<ApiResponse>` | 成功时 resolve 后端响应对象；失败、非 `code == 0` 或网络异常时 reject 统一错误响应。 |
+
+### getTencentToken
+
+获取腾讯云上传临时 Token，常用于 COS 直传。
+
+```ts
+import { getTencentToken } from '@zfqh/uniapp/lib/apis';
+
+const { data } = await getTencentToken();
+const credentials = {
+  secretId: data.tmpSecretId,
+  secretKey: data.tmpSecretKey,
+  sessionToken: data.sessionToken,
+};
+```
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | --- | --- |
+| `data` | `Record<string, any>` | 否 | 查询参数；通常不需要传。 |
+
+| 返回值 | 说明 |
+| --- | --- |
+| `Promise<ApiResponse<TencentToken>>` | 成功时 `data` 为后端返回的临时密钥信息。 |
+
+### getLastVersion
+
+获取 App 最新版本信息，常用于更新弹窗。
+
+```ts
+import { getLastVersion } from '@zfqh/uniapp/lib/apis';
+
+const { data } = await getLastVersion({
+  version: '1.0.0',
+  packageName: 'uni.UNI07DD08D',
+  type: 2,
+  platform: 1,
+});
+```
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | --- | --- |
+| `data.version` | `string \| number` | 否 | 当前版本号。 |
+| `data.packageName` | `string` | 否 | 应用包名。 |
+| `data.type` | `number` | 否 | 应用类型，按后端约定传值。 |
+| `data.platform` | `number` | 否 | 平台，常见约定为 Android `1`、iOS `2`。 |
+| `data.appCode` | `string` | 否 | 应用编码，业务按后端约定传。 |
+
+| 返回值 | 说明 |
+| --- | --- |
+| `Promise<ApiResponse<AppVersion>>` | 成功时 `data` 为版本信息，例如版本号、状态、整包地址、热更新地址等后端字段。 |
+
+### getCosUrls
+
+获取 COS 私有资源签名访问地址。
+
+```ts
+import { getCosUrls } from '@zfqh/uniapp/lib/apis';
+
+const { data: urls } = await getCosUrls({
+  urls: ['/report/2026/05/demo.pdf'],
+});
+
+const firstUrl = urls[0];
+```
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | --- | --- |
+| `data.urls` | `string[]` | 是 | 需要签名的 COS 路径数组，通常传去掉域名后的路径。 |
+
+| 返回值 | 说明 |
+| --- | --- |
+| `Promise<ApiResponse<string[]>>` | 成功时 `data` 为签名后的 URL 数组。 |
+
+### postRefreshToken
+
+刷新登录 token。
+
+```ts
+import { postRefreshToken } from '@zfqh/uniapp/lib/apis';
+
+const { data } = await postRefreshToken({
+  refreshToken: loginInfo.refreshToken,
+});
+```
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | --- | --- |
+| `data.refreshToken` | `string` | 是 | 刷新 token。该字段会替换 URL 中的 `:refreshToken`。 |
+
+| 返回值 | 说明 |
+| --- | --- |
+| `Promise<ApiResponse<LoginToken>>` | 成功时 `data` 为后端返回的新登录凭证。 |
+
+### getDictData
+
+按字典类型获取字典数据。
+
+```ts
+import { getDictData } from '@zfqh/uniapp/lib/apis';
+
+const { data } = await getDictData({
+  type: 'group_relation',
+});
+
+const options = data.map((item) => ({
+  label: item.label,
+  value: item.value,
+}));
+```
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | --- | --- |
+| `data.type` | `string` | 是 | 字典类型。 |
+
+| 返回值 | 说明 |
+| --- | --- |
+| `Promise<ApiResponse<DictItem[]>>` | 成功时 `data` 为字典项数组，字段以当前后端返回为准。 |
+
+## 返回值约定
+
+以上接口都基于 `GET`、`POST` 封装，成功时返回后端响应对象，常见结构如下：
+
+```ts
+type ApiResponse<T = any> = {
+  code: number;
+  data: T;
+  msg?: string;
+  message?: string;
+};
+```
+
+当响应 `code != 0`、HTTP 状态异常或网络异常时，请求会进入 `catch`，错误对象会被规范为包含 `status`、`data.code`、`data.msg` 和 `config` 的响应结构。

package/docs/api/apis/index.md

@@ -0,0 +1,82 @@
+# 接口
+
+业务 API 发布路径为 `@zfqh/uniapp/lib/apis`。当前只保留通用请求入口和少量公共接口，已删除原先按业务域拆分的 `login`、`user`、`order`、`consult`、`im`、`message`、`search`、`member`、`prescribe`、`constitution`、`home`、 `goods`、`doctor`、`cos` 等模块。
+
+## 基本使用
+
+推荐从聚合入口引入，并在业务项目的 `apis/*.ts` 中按领域封装请求函数：
+
+```ts
+import { GET, POST } from '@zfqh/uniapp/lib/apis';
+
+export const getFamilyList = (data) => GET('/app-api/robot/user-family/getUserFamily', data);
+
+export const submitConsult = (data) => POST('/app-api/robot/api/medical/inquirySubmitV2', data);
+
+export const getReportByNo = (no: string) => GET('/app-api/constitution/new/getReportByNo?no=:no', { no });
+```
+
+也可以按文件深度引入：
+
+```ts
+import request, { GET, POST, PUT, DELETE } from '@zfqh/uniapp/lib/apis/request';
+import { getTencentToken, getDictData } from '@zfqh/uniapp/lib/apis/core';
+```
+
+## 调用契约
+
+- `GET` 会把 data 作为 query params。
+- `POST`、`PUT`、`DELETE` 会把 data 作为请求体或方法参数传给底层请求实例。
+- URL 中的 `:id`、`/:id` 会由 `formatURL` 使用 data 同名字段替换，并从 data 中删除该字段。
+- 响应拦截器要求后端成功码为 `code == 0`；失败时会按配置弹 toast，并在 401 时触发 `uni.$store.dispatch('logout')`。
+
+## 接口清单
+
+### 请求方法
+
+| 接口 | 参数 | 返回值 | 说明 |
+| --- | --- | --- | --- |
+| `GET(url, data?, options?)` | `url: string`、`data?: Record<string, any>`、`options?: Record<string, any>` | `Promise<ApiResponse<T>>` | 发起 GET 请求，`data` 作为 query。 |
+| `POST(url, data?, options?)` | `url: string`、`data?: Record<string, any>`、`options?: Record<string, any>` | `Promise<ApiResponse<T>>` | 发起 POST 请求，`data` 作为请求体。 |
+| `PUT(url, data?, options?)` | `url: string`、`data?: Record<string, any>`、`options?: Record<string, any>` | `Promise<ApiResponse<T>>` | 发起 PUT 请求，`data` 作为请求体。 |
+| `DELETE(url, data?, options?)` | `url: string`、`data?: Record<string, any>`、`options?: Record<string, any>` | `Promise<ApiResponse<T>>` | 发起 DELETE 请求。 |
+
+```ts
+import { GET, POST, PUT, DELETE } from '@zfqh/uniapp/lib/apis';
+
+export const getDetail = (id: number) => GET('/app-api/demo/detail?id=:id', { id });
+export const createItem = (data) => POST('/app-api/demo/create', data);
+export const updateItem = (data) => PUT('/app-api/demo/update', data);
+export const removeItem = (id: number) => DELETE('/app-api/demo/delete?id=:id', { id });
+```
+
+### 公共接口
+
+| 接口 | 参数 | 返回值 | 说明 |
+| --- | --- | --- | --- |
+| `sendSmsCode(data)` | `data: Record<string, any>` | `Promise<ApiResponse>` | 发送短信验证码。 |
+| `getTencentToken(data?)` | `data?: Record<string, any>` | `Promise<ApiResponse<TencentToken>>` | 获取腾讯云上传临时 Token。 |
+| `getLastVersion(data?)` | `data?: Record<string, any>` | `Promise<ApiResponse<AppVersion>>` | 获取最新版本。 |
+| `getCosUrls(data)` | `data: { urls: string[] }` | `Promise<ApiResponse<string[]>>` | 获取 COS 签名后的访问地址。 |
+| `postRefreshToken(data)` | `data: { refreshToken: string }` | `Promise<ApiResponse<LoginToken>>` | 刷新登录 token。 |
+| `getDictData(data)` | `data: { type: string }` | `Promise<ApiResponse<DictItem[]>>` | 按字典类型获取字典数据。 |
+
+```ts
+import {
+  sendSmsCode,
+  getTencentToken,
+  getLastVersion,
+  getCosUrls,
+  postRefreshToken,
+  getDictData,
+} from '@zfqh/uniapp/lib/apis';
+
+await sendSmsCode({ phone: '13800138000' });
+await getTencentToken();
+await getLastVersion({ version: '1.0.0', packageName: 'uni.UNI07DD08D', type: 2, platform: 1 });
+await getCosUrls({ urls: ['/report/demo.pdf'] });
+await postRefreshToken({ refreshToken: 'refresh-token' });
+await getDictData({ type: 'group_relation' });
+```
+
+更细的参数说明和单接口用法见 [request](./request.md) 与 [core](./core.md)。