shcp-api-lib 1.0.0

package/dist/types/src/type/model/device-model.d.ts

@@ -0,0 +1,295 @@
+import { DeviceType, DeviceStatus } from '../../constants/shcp-common';
+/**
+ * 健康设备查询请求
+ */
+export interface DeviceQuery {
+    /**
+     * 设备id
+     */
+    id?: number;
+    /**
+     * 设备id集合
+     */
+    ids?: number[];
+    /**
+     * 所属租户ID
+     */
+    tenantId?: string;
+    /**
+     * 设备类型
+     */
+    type?: DeviceType;
+    /**
+     * 设备名称
+     */
+    name?: string;
+    /**
+     * 设备品牌
+     */
+    brand?: string;
+    /**
+     * 设备型号
+     */
+    model?: string;
+    /**
+     * 设备版本号
+     */
+    version?: string;
+    /**
+     * 设备状态
+     */
+    status?: DeviceStatus;
+}
+/**
+ * 创建租户设备请求
+ */
+export interface DeviceCreateRequest {
+    /**
+     * 租户设备所属租户ID
+     */
+    tenantId: string;
+    /**
+     * 租户设备名称
+     */
+    name: string;
+    /**
+     * 设备品牌
+     */
+    brand: string;
+    /**
+     * 设备型号
+     */
+    model?: string;
+    /**
+     * 设备版本号
+     */
+    version?: string;
+    /**
+     * 租户设备图标
+     */
+    icon: string;
+    /**
+     * 租户设备描述
+     */
+    remark?: string;
+    /**
+     * 租户设备类型
+     */
+    type: DeviceType;
+    /**
+     * 租户设备状态
+     */
+    status: DeviceStatus;
+    /**
+     * 租户设备供应商（数据来源）
+     */
+    vendor?: string;
+    /**
+     * 租户设备相关配置（如三方的appid和key）
+     */
+    settings?: string;
+}
+/**
+ * 创建租户设备请求
+ */
+export interface DeviceUpdateRequest {
+    /**
+     * 租户设备ID
+     */
+    id: number;
+    /**
+     * 租户设备所属租户ID
+     */
+    tenantId: string;
+    /**
+     * 租户设备名称
+     */
+    name: string;
+    /**
+     * 设备型号
+     */
+    model?: string;
+    /**
+     * 设备版本号
+     */
+    version?: string;
+    /**
+     * 租户设备图标
+     */
+    icon: string;
+    /**
+     * 租户设备描述
+     */
+    remark?: string;
+    /**
+     * 租户设备类型
+     */
+    type: DeviceType;
+    /**
+     * 租户设备状态
+     */
+    status: DeviceStatus;
+    /**
+     * 租户设备供应商（数据来源）
+     */
+    vendor?: string;
+    /**
+     * 租户设备相关配置（如三方的appid和key）
+     */
+    settings?: string;
+}
+/**
+ * 创建租户设备请求
+ */
+export interface DeviceDeleteRequest {
+    /**
+     * 租户设备ID
+     */
+    idList: number[];
+}
+/**
+ * 华为手表设备相关配置
+ */
+export interface HuaWeiWatchConfig {
+    /**
+     * 华为数据服务器地址
+     */
+    serverDomain?: string;
+    /**
+     * 访问华为数据服务的appId
+     */
+    appId?: string;
+    /**
+     * 访问华为数据服务的appSecret
+     */
+    appSecret?: string;
+    /**
+     * 要采集的指标的配置
+     */
+    metrics?: HuaWeiWatchMetric[];
+}
+/**
+ * 华为手表指标配置
+ */
+export interface HuaWeiWatchMetric {
+    /**
+     * 是否启用
+     */
+    enabled?: boolean;
+    /**
+     * 指标的类别
+     */
+    category?: HuaWeiWatchMetricCategory;
+    /**
+     * 指标的查询频度
+     */
+    frequency?: string;
+    /**
+     * 指标字段的标签映射
+     */
+    tags?: Record<string, number>;
+}
+/**
+ * 华为手表指标类别
+ */
+export declare enum HuaWeiWatchMetricCategory {
+    BloodPressure = "bp",
+    BloodFat = "bf",
+    BloodSugar = "bs",
+    Sleep = "sleep_standard",
+    SPO2 = "spo2",
+    HeartRate = "heart_rate",
+    BodyTemperature = "tw",
+    SportSingle = "sport_single",
+    Sport = "sport",
+    Stress = "stress",
+    Unknown = "unknown"
+}
+/**
+ * 租户设备信息
+ */
+export interface DeviceDTO {
+    /**
+     * 设备id
+     */
+    id?: number;
+    /**
+     * 设备所属租户ID
+     */
+    tenantId?: string;
+    /**
+     * 设备名称
+     */
+    name?: string;
+    /**
+     * 品牌
+     */
+    brand?: string;
+    /**
+     * 设备型号 如：GT5
+     */
+    model?: string;
+    /**
+     * 设备版本号 如：5G 4G
+     */
+    version?: string;
+    /**
+     * 权益图标URL地址
+     */
+    icon?: string;
+    /**
+     * 设备描述
+     */
+    remark?: string;
+    /**
+     * 设备类型
+     */
+    type?: DeviceType;
+    /**
+     * 设备状态
+     */
+    status?: DeviceStatus;
+    /**
+     * 设备供应商
+     */
+    vendor?: string;
+    /**
+     * 租户设备相关配置, JSON格式，具体类型参考: DeviceConfig
+     */
+    setting?: string;
+}
+/**
+ * 华为手表设备上下文
+ */
+export interface HuaWeiWatch {
+    /**
+     * 授权链接
+     */
+    authorUrl?: string;
+    /**
+     * 健康服务任务id
+     */
+    taskId?: number;
+}
+/**
+ * 设备复制请求
+ */
+export interface DeviceCopyRequest {
+    /**
+     * 模版租户ID
+     */
+    templateTenantId: string;
+    /**
+     * 新租户ID
+     */
+    newTenantId: string;
+}
+/**
+ * 设备复制响应
+ */
+export interface DeviceCopyResponse {
+    /**
+     * 设备id映射
+     */
+    deviceIdMapping: Record<number, number>;
+}

package/dist/types/src/type/model/device-user-model.d.ts

@@ -0,0 +1,53 @@
+export interface DeviceUserCreateRequest {
+    appClientId: number;
+    loginAccount: string;
+    loginPassword: string;
+    nickname: string;
+    avatar: string;
+    mobile: string;
+    gender: number;
+}
+export interface DeviceUserQuery {
+    loginAccount?: string;
+    appClientId?: string;
+    id?: number | string;
+}
+export interface DeviceUserDTO {
+    appClientId: number;
+    loginAccount: string;
+    loginPassword: string;
+    nickname: string;
+    avatar: string;
+    mobile: string;
+    gender: number;
+    tenantId: string;
+    status: number;
+    id: number;
+}
+export interface DeviceUserLoginRequest {
+    encryptedData?: string;
+    iv?: string;
+    jsCode: string;
+    avatarUrl: string;
+    province?: string;
+    city?: string;
+    country?: string;
+    gender: number;
+    language?: string;
+    nickName: string;
+    rawData?: string;
+    signature: string;
+    mobile?: string;
+    id?: number;
+    appClientId?: number;
+}
+export interface DeviceUserUpdateRequest {
+    id: number | string;
+    appClientId?: number;
+    loginAccount?: string;
+    loginPassword?: string;
+    nickname?: string;
+    avatar?: string;
+    mobile?: string;
+    gender?: number;
+}

package/dist/types/src/type/model/health-care-config-model.d.ts

@@ -0,0 +1,301 @@
+import { GroupJoinType, HealthServiceType, PlanExecMethod, PlanExecType, StudyType, VisitType } from '../../constants/shcp-common';
+export interface RightServiceConfigDTO {
+    id?: number;
+    tenantId?: string;
+    rightId: number;
+    serviceType: HealthServiceType;
+}
+export interface DiseaseCareConfigDTO extends RightServiceConfigDTO {
+    diseaseName: string;
+    assessmentConfigs: AssessmentConfig[];
+    groupingConfig: GroupingConfig;
+    careConfigs: CareConfig[];
+} /**
+ * 课题研究权益的服务配置
+ */
+export interface HealthStudyConfigDTO extends RightServiceConfigDTO {
+    /**
+     * 课题名称
+     */
+    topicName?: string;
+    /**
+     * 课题介绍
+     */
+    topicIntroduce?: string;
+    /**
+     * 纳排标准
+     */
+    acceptCriteria?: string;
+    /**
+     * 课题研究附件URL
+     */
+    studyAttachment?: string;
+    /**
+     * 课题研究附件名称
+     */
+    studyAttachmentName?: string;
+    /**
+     * 课题研究类型，如：单中心模式、多中心模式
+     */
+    studyType?: StudyType;
+    /**
+     * 分组加入方式，如：随机入组、手动指定入组
+     */
+    joinType?: GroupJoinType;
+    /**
+     * 评估方案配置
+     */
+    crfFormList?: AssessConfigDTO[];
+    /**
+     * 用户分组方案配置
+     */
+    groupingConfig?: GroupingConfigDTO;
+    /**
+     * 每组的管理方案配置
+     */
+    careConfigs?: CareConfig[];
+}
+export interface AssessmentConfig {
+    name: string;
+    formId: number;
+    formName: string;
+    ruleId: number;
+    sort: number;
+    consumerReminderTimeAfterStart?: string;
+    others?: {
+        [key: string]: any;
+    };
+}
+export interface GroupingConfig {
+    ruleId: number;
+    groups: Group[];
+    others?: {
+        [key: string]: any;
+    };
+}
+export interface Group {
+    id: number;
+    name: string;
+    remark: string;
+}
+export interface CareConfig {
+    groupId: number;
+    startTimeOffset: string;
+    followUpConfig: FollowUpConfigDTO;
+    returnVisitConfig: ReturnVisitConfigDTO;
+    educationConfig: EducationConfigDTO;
+    metricMonitorConfig: MetricMonitorConfigDTO;
+    adviceConfig: AdviceConfigDTO;
+}
+export interface FollowUpConfigDTO {
+    plans: FollowUpPlan[];
+    consumerReminderEnabled?: boolean;
+    consumerReminderTimeBeforeStart?: string;
+    consumerReminderTimeAfterStart?: string;
+    consumerNoticeAfterDone?: boolean;
+    others?: {
+        [key: string]: any;
+    };
+}
+export interface FollowUpPlan {
+    name: string;
+    formId: number;
+    formName: string;
+    ruleId?: number;
+    visitType: VisitType;
+    execMethod: PlanExecMethod;
+    execTimeConfig: ExecTimeConfig;
+}
+export interface ReturnVisitConfigDTO {
+    execSuggestionArticleId: number | string;
+    execTimeConfig: ExecTimeConfig;
+    consumerReminderEnabled?: boolean;
+    consumerReminderTimeBeforeStart?: string;
+    consumerReminderTimeAfterStart?: string;
+    consumerNoticeAfterDone?: boolean;
+}
+export interface MetricMonitorConfigDTO {
+    plans: MetricMonitorPlan[];
+    others?: {
+        [key: string]: any;
+    };
+}
+export interface MetricMonitorPlan {
+    name: string;
+    targetMetrics: Metric[];
+    metricTemplateFormName: string;
+    metricTemplateFormId: string;
+    execTimeConfig: ExecTimeConfig;
+    formId: string;
+    formName: string;
+}
+export interface ExecTimeConfig {
+    execType: PlanExecType;
+    execFrequency: string;
+    execCount: number;
+    execDuration: string;
+    execTimePoints: string[];
+}
+export interface Metric {
+    name: string;
+    displayName: string;
+    tagId: string;
+    expectValue?: number | null;
+    expectScope?: string | null;
+}
+export interface AdviceConfigDTO {
+    adviceConfigArticleId: number;
+}
+export interface GuideArticle {
+    articleId: number;
+    articleTitle: string;
+    execTimePoint: string;
+}
+export interface NewsArticleTag {
+    tagId: number;
+    tagName: string;
+}
+export interface EducationConfigDTO {
+    manualArticleRootCategoryId: number | string;
+    manualArticleRootCategoryName?: string;
+    guideArticles: GuideArticle[];
+    newsArticleTags: NewsArticleTag[];
+    newsArticleExecTimeConfig: ExecTimeConfig;
+}
+/**
+ * 评估配置
+ */
+export interface AssessConfigDTO {
+    /**
+     * 评估任务名称
+     */
+    name?: string;
+    /**
+     * 关联的评估表单ID
+     */
+    formId?: number;
+    /**
+     * 关联的评估表单名称 注: 冗余字段
+     */
+    formName?: string;
+    /**
+     * 关联的评估规则ID
+     */
+    ruleId?: number;
+    /**
+     * 评估任务排序，可以按顺序给用户推送
+     */
+    sort?: number;
+    /**
+     * 每次评估任务开始后的提醒时间，默认: 第7天 如: P7D(第七天), P2M(第2月), P1Y(年)
+     */
+    consumerReminderTimeAfterStart?: string;
+    /**
+     * 评估任务的其他配置，比如：推送的消息模板
+     */
+    others?: Record<string, any>;
+}
+/**
+ * 用户分组方案配置
+ */
+export interface GroupingConfigDTO {
+    /**
+     * 分组使用的规则ID
+     */
+    ruleId?: number;
+    /**
+     * 分组信息
+     */
+    groups?: Group[];
+    /**
+     * 其他配置
+     */
+    others?: Record<string, any>;
+}
+/**
+ * 权益服务配置查询
+ */
+export interface RightServiceConfigQuery {
+    /**
+     * 权益服务配置ID
+     */
+    id?: number | string;
+    /**
+     * 所属的权益ID
+     */
+    rightId?: number | string;
+    /**
+     * 所属的权益Ids
+     */
+    rightIds?: (number | string)[];
+    /**
+     * 关联的健管服务类型
+     */
+    serviceType?: HealthServiceType;
+}
+/**
+ * 健康咨询类配置
+ */
+export interface HealthConsultConfigDTO extends RightServiceConfigDTO {
+    /**
+     * 咨询工具页面链接的类型，取值: localPage/wxMiniProgram/h5Page
+     */
+    linkType?: string;
+    /**
+     * 咨询工具对应的页面地址
+     */
+    linkUrl?: string;
+    /**
+     * 其他配置信息
+     */
+    others?: Record<string, any>;
+    /**
+     * FastGPT AI智能体
+     */
+    fastAgent?: FastAgent;
+}
+/**
+ * FastGPT AI智能体
+ */
+export interface FastAgent {
+    /**
+     * apiKey
+     */
+    apiKey?: string;
+    /**
+     * 服务器地址
+     */
+    serverAddress?: string;
+    /**
+     * appId
+     */
+    appId?: string;
+    /**
+     * 会话时长（单位：分钟）
+     */
+    sessionTime?: number;
+    /**
+     * 是否展示「引用文献」
+     */
+    showReference?: boolean;
+    /**
+     * 是否展示「猜你想问」
+     */
+    showGuess?: boolean;
+    /**
+     * 是否展示「推理过程」
+     */
+    showInference?: boolean;
+    /**
+     * 历史记录展示条数
+     */
+    historyCount?: number;
+    /**
+     * 提问字数
+     */
+    questionCount?: number;
+    /**
+     * 是否支持「文件上传」
+     */
+    supportFile?: boolean;
+}