chore: 初始化医签通前端项目结构与文档

This commit is contained in:
yelan
2026-08-27 10:40:29 +08:00
commit 3f27d4dd3a
47 changed files with 5829 additions and 0 deletions

21
packages/README.md Normal file
View File

@@ -0,0 +1,21 @@
# packages
公共代码包目录,供 ```clinical-web``` 和 ```patient-h5``` 复用。
## 目录
```text
packages/
├─ api-client/ 公共后端接口客户端
└─ types/ 公共 TypeScript 类型
```
## 使用原则
- 这里不放具体页面;
- 不放 Element Plus 或 Vant 组件;
- 不放只属于医护端或患者端的业务逻辑;
- 公共代码需要保持浏览器端可用;
- 公共包不单独部署,构建时会被打包进使用它的应用。
后续如果确有需要,可以增加 ```utils```、```signature-adapter``` 等公共包。

View File

@@ -0,0 +1,34 @@
# api-client
医签通公共接口客户端,负责封装前端访问后端 API 的方式。
## 计划职责
- 统一 API 基础地址;
- 统一请求和响应类型;
- 统一认证信息传递;
- 统一错误处理;
- 封装患者、就诊、医嘱、文书和签署任务接口;
- 处理超时、重试和重复提交;
- 配合 OpenAPI 生成类型安全的接口代码。
## 计划接口类别
- 患者和就诊查询;
- 文书模板查询;
- 签署任务创建;
- 签署状态查询;
- 签署结果提交;
- PDF 原件和签名证据查询;
- Webhook 或回传状态确认。
## 使用原则
- 不在这里放页面代码;
- 不在前端保存服务端密钥;
- 最终权限和签署有效性由后端校验;
- 不能为了方便在多个应用中复制同一套接口定义。
## 当前状态
当前仅完成目录和说明文档,尚未创建接口代码。

38
packages/types/README.md Normal file
View File

@@ -0,0 +1,38 @@
# types
医签通公共 TypeScript 类型定义包。
## 计划包含的类型
- 患者;
- 门诊/住院就诊;
- 医嘱和收费项目;
- 知情同意文书;
- 签署任务和任务组;
- 签署人及监护人关系;
- 签署状态;
- 回传结果;
- 分页、错误和审计记录。
示例:
```ts
type ConsentStatus =
| 'pending'
| 'signed'
| 'rejected'
| 'expired'
| 'voided'
```
## 使用原则
- 类型命名使用清晰的业务名词;
- 前后端字段命名和枚举值保持一致;
- 只放公共类型和必要的枚举;
- 不放页面组件和接口请求逻辑;
- 优先使用 ```import type```,避免产生不必要的运行时代码。
## 当前状态
当前仅完成目录和说明文档,尚未创建类型代码。