shcp-api-lib 1.0.0

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

@@ -0,0 +1,181 @@
+import { HealthServiceType, ServiceTaskCategory } from '../../constants/shcp-common';
+import type { PageRequest } from './common-model';
+export declare enum AggregateType {
+    BY_COUNT = 1,// 按次聚合
+    BY_DAY = 2,// 按天聚合
+    BY_HOUR = 3,// 按小时聚合
+    Unknown = 99
+}
+export interface HealthMetricTrendDTO {
+    consumerId: number;
+    tagId: number;
+    tagName: string;
+    unit: string;
+    aggregateType: AggregateType;
+    details: Detail[];
+    aggregation: Aggregation;
+}
+export interface Detail {
+    value: string | number;
+    max: string | number;
+    min: string | number;
+    eventTime: string;
+}
+export interface Aggregation {
+    avg: string;
+    max: string;
+    min: string;
+    count: number;
+}
+export interface HealthMetricTrendQuery {
+    consumerId: number | string;
+    tagIds: number[];
+    aggregateType: AggregateType;
+    eventTimeMin: string;
+    eventTimeMax: string;
+}
+/**
+ * 健康档案指标查询请求
+ */
+export interface HealthMetricQuery extends PageRequest {
+    /**
+     * 消费者ID
+     */
+    consumerId: number | string;
+    /**
+     * 所属业务租户ID
+     */
+    tenantId?: string;
+    /**
+     * 指标更新的日志ID
+     */
+    logIds?: Set<number>;
+    /**
+     * 指标标签ID
+     */
+    tagIds?: Set<number>;
+    /**
+     * 业务时间最小值
+     */
+    eventTimeMin?: string;
+    /**
+     * 业务时间最大值
+     */
+    eventTimeMax?: string;
+    /**
+     * 是否查询指标的最新值
+     */
+    queryLatest?: boolean;
+}
+export interface HealthMetricDTO {
+    id: number;
+    consumerId: number;
+    tenantId: string;
+    logId: number;
+    tagId: number;
+    tagName: string;
+    tagCategoryId: number;
+    value: string;
+    unit: string;
+    eventTime?: string;
+    createTime?: string;
+    updateTime?: string;
+}
+export interface HealthMetricLogDTO {
+    id: number;
+    tenantId: string;
+    consumerId: number;
+    rightId: number;
+    serviceType: HealthServiceType;
+    flowId: number;
+    flowName: string;
+    taskCategory: ServiceTaskCategory;
+    taskId: number;
+    taskName: string;
+    remark: string;
+    eventTime: string;
+    createTime: string;
+    updateTime: string;
+}
+export interface BloodPressureLevelRange {
+    sort: number;
+    SBP: number[];
+    DBP: number[];
+    desc: string;
+    name: string;
+    tag: string;
+    color: string;
+}
+export interface BloodOxygenLevelRange {
+    sort: number;
+    value: number[];
+    desc: string;
+    name: string;
+    tag: string;
+    color: string;
+}
+export interface HeartRateLevelRange extends BloodOxygenLevelRange {
+}
+export interface BloodPressureMetricInfo {
+    time: Date;
+    DBP: number;
+    dbpLevel: BloodPressureLevelRange;
+    SBP: number;
+    sbpLevel: BloodPressureLevelRange;
+}
+export interface HeartRateMetricInfo {
+    time: string;
+    max: number | string;
+    min: number | string;
+    avg: number | string;
+    avgLevel: HeartRateLevelRange;
+    minLevel: HeartRateLevelRange;
+    maxLevel: HeartRateLevelRange;
+}
+export interface StepsMetricInfo {
+    time: string;
+    total: number | string;
+}
+export interface BloodOxygenMetricInfo {
+    time: Date;
+    max: number;
+    min: number;
+    avg: number;
+    avgLevel: BloodOxygenLevelRange;
+    minLevel: BloodOxygenLevelRange;
+    maxLevel: BloodOxygenLevelRange;
+}
+export interface BloodPressureExceptionInfo {
+    exceptionCount: number;
+    count: number;
+    normalTooHeight: number;
+    mildTooHeight: number;
+    moderateTooHeight: number;
+    severeTooHeight: number;
+    hypotension: number;
+    rangeDesc?: string[];
+}
+export interface HeartRateExceptionInfo {
+    exceptionCount: number;
+    count: number;
+    tooHeight: number;
+    tooLow: number;
+    rangeDesc?: string[];
+}
+export interface BloodOxygenExceptionInfo {
+    exceptionCount: number;
+    count: number;
+    tooHeight: number;
+    tooLow: number;
+    rangeDesc?: string[];
+}
+export type MetricRecordInfo = HeartRateMetricInfo | BloodOxygenMetricInfo | BloodPressureMetricInfo | StepsMetricInfo;
+export type MetricExceptionInfo = BloodPressureExceptionInfo | HeartRateExceptionInfo | BloodOxygenExceptionInfo;
+export interface MetricTrendInfo {
+    records: MetricRecordInfo[];
+    orgRecords?: MetricRecordInfo[];
+    stastic?: Aggregation;
+    exception?: MetricExceptionInfo;
+}
+export interface HealthMetric {
+}

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

@@ -0,0 +1,83 @@
+import { FileType, HealthRecordType, ServiceTaskCategory, ServiceTaskStatus } from '../../constants/shcp-common';
+import { KMForm } from './km-form-model';
+import type { Operator, ServiceTaskRequests } from './common-right-model';
+export interface BaseProfileTaskDTO {
+    /**
+     * 任务ID
+     */
+    id: number;
+    /**
+     * 任务名称
+     */
+    name: string;
+    /**
+     * 指标对应的填写表单
+     */
+    form: KMForm.FormResultDTO;
+}
+export interface DiaryTaskSubmit extends ServiceTaskRequests.Submit {
+}
+export interface DiaryTaskFetch {
+    /** 消费者Id */
+    consumerId: number | string;
+    /** 指标上报使用的分类名称，如：饮食/饮酒/血压等 */
+    categoryName: string;
+    /** 操作人信息 */
+    operator: Operator;
+    /** 任务ID */
+    taskId?: number | string;
+    /** 权益ID */
+    rightId?: number | string;
+}
+export interface DiaryTaskDTO {
+    /** 任务ID */
+    id: number;
+    /** 任务名称 */
+    name: string;
+    /** 指标对应的填写表单 */
+    form: KMForm.FormResultDTO;
+    /** 任务当前状态 */
+    status: ServiceTaskStatus;
+}
+export interface ReportTaskDTO {
+    /** 任务ID */
+    id: number;
+    /** 任务名称 */
+    name: string;
+    /** 任务当前状态 */
+    status: ServiceTaskStatus;
+    context: {
+        recordType: HealthRecordType;
+        remark?: string;
+        records: HealthRecord[];
+    };
+}
+export interface ReportTaskSubmit {
+    /** 消费者Id */
+    consumerId: number | string;
+    /** 医疗记录的类型 */
+    recordType: HealthRecordType;
+    /** 权益ID */
+    rightId: number | string;
+    /** 医疗记录的列表 */
+    records: HealthRecord[];
+    /** 上传备注 */
+    remark: string;
+    /** 操作人信息 */
+    operator: Operator;
+}
+export interface ReportTaskFetch extends ServiceTaskRequests.Fetch {
+    category: ServiceTaskCategory;
+}
+export interface HealthRecord {
+    /** 医疗记录的类型 */
+    recordType: HealthRecordType;
+    /** 医疗记录产生的时间 */
+    recordTime: string;
+    /** 上传的文件名称 */
+    fileName: string;
+    /** 上传的文件Url */
+    fileUrl: string;
+    /** 上传的文件类型 */
+    fileType: FileType;
+}

package/dist/types/src/type/model/health-self-assess-model.d.ts

@@ -0,0 +1,35 @@
+import type { ServiceTaskStatus } from '../../constants/shcp-common';
+import type { KMForm } from './km-form-model';
+import type { RightServiceConfigDTO } from './health-care-config-model';
+export interface AssessmentTaskDTO {
+    /** 任务ID */
+    id: number;
+    /** 任务名称 */
+    name: string;
+    /** 任务当前状态 */
+    status: ServiceTaskStatus;
+    /** 任务关联的评估表单 */
+    form: KMForm.FormResultDTO;
+    /** 权益配置信息 */
+    config: HealthSelfAssessmentConfigDTO;
+    /** 任务流程记录 */
+    result: AssessmentResultDTO;
+}
+export interface HealthSelfAssessmentConfigDTO extends RightServiceConfigDTO {
+    /** 自测关联的表单ID */
+    formId: number;
+    /** 自测关联的表单名称 */
+    formName: string;
+    /** 自测关联的规则ID */
+    ruleId: number;
+    /** 自测表单题目的总分 */
+    totalScore: string;
+}
+export interface AssessmentResultDTO {
+    /** 总得分 */
+    totalScore: number;
+    /** 自测结果 */
+    resultDescription: string;
+    /** 建议 */
+    suggestion: string;
+}

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

@@ -0,0 +1,105 @@
+import { ServiceStartRequest } from './common-right-model';
+import { RightServiceConfigDTO } from './health-care-config-model';
+/**
+ * 文章分类
+ */
+export interface ArticleCategory {
+    /**
+     * 分类名称
+     */
+    categoryName?: string;
+    /**
+     * 描述
+     */
+    remark?: string;
+    /**
+     * 封面图地址
+     */
+    coverUrl?: string;
+    /**
+     * 文章列表
+     */
+    articleItems?: ArticleItem[];
+}
+/**
+ * 文章列表
+ */
+export interface ArticleItem {
+    /**
+     * 图标地址
+     */
+    iconUrl?: string;
+    /**
+     * 标题
+     */
+    title?: string;
+    /**
+     * 文章id
+     */
+    articleId?: string;
+    /**
+     * 副标题
+     */
+    subTitle?: string;
+}
+/**
+ * 健康工具类配置
+ */
+export interface HealthToolConfigDTO extends RightServiceConfigDTO {
+    /**
+     * 工具页面链接的类型，取值: localPage/wxMiniProgram/h5Page
+     */
+    linkType?: string;
+    /**
+     * 工具对应的页面地址
+     */
+    linkUrl?: string;
+    /**
+     * 其他配置信息
+     */
+    others?: Record<string, any>;
+    /**
+     * 文章分类
+     */
+    articleCategories?: ArticleCategory[];
+}
+/**
+ * 健康工具.任务DTO对象
+ */
+export interface HealthToolTaskDTO {
+    /**
+     * 配置信息
+     */
+    config?: HealthToolConfigDTO;
+}
+/**
+ * 健康工具任务发起请求
+ */
+export interface HealthToolTaskStart extends ServiceStartRequest {
+}
+/**
+ * 健康工具任务获取请求
+ */
+export interface HealthToolTaskFetch {
+    /**
+     * 权益ID
+     */
+    rightId?: number | string;
+    /**
+     * 用户id
+     */
+    consumerId?: number | string;
+}
+/**
+ * 健康工具.任务发起DTO对象
+ */
+export interface HealthToolTaskStartDTO {
+    /**
+     * 工具页面链接的类型，取值: localPage/wxMiniProgram/h5Page
+     */
+    linkType?: string;
+    /**
+     * 工具对应的页面地址
+     */
+    linkUrl?: string;
+}

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

@@ -0,0 +1,44 @@
+import type { ShcpUserType } from '../../constants/shcp-common';
+import type { ConsumerDTO } from './consumer-model';
+import type { UserDTO } from './blade-system-model';
+import type { RightDTO } from './common-right-model';
+export interface IMUserRequest {
+    /**
+     * shcp用户id
+     */
+    shcpUserId: number | string;
+    /**
+     * 用户类型 1.C端消费用户、2.C端设备用户、3.租户端用户、4.系统
+     */
+    userType: ShcpUserType;
+    /**
+     * 用户登录时的终端类型 1：iOS，2：Android，3：Windows，4：OSX，5：WEB，6：小程序，7：linux，8：AndroidPad，9：IPad，10：Admin
+     */
+    platformID?: number;
+    /**
+     * IM用户id
+     */
+    userID?: string;
+}
+export interface IMUserDTO {
+    /** shcp用户ID */
+    shcpUserId: number;
+    /** 用户类型 1.C端消费用户、2.C端设备用户、3.租户端用户、4.系统 */
+    userType: ShcpUserType;
+    /** IM用户id */
+    imUserId: string;
+    /** IM用户token */
+    token: string;
+    /** IM用户token过期时间 */
+    expireTimeSeconds: number;
+    /** consumer用户信息 */
+    consumer?: ConsumerDTO;
+    /** tenantUser用户信息 */
+    tenantUser?: UserDTO;
+    /** 参加的权益列表 */
+    rights?: RightDTO[];
+}
+export interface IMUserQuery {
+    /** IM用户ids */
+    imUserIds: string[];
+}

package/dist/types/src/type/model/index.d.ts

@@ -0,0 +1,30 @@
+export * from './app-client-model';
+export * from './app-client-setting-model';
+export * from './blade-system-model';
+export * from './common-dict-model';
+export * from './common-model';
+export * from './common-right-model';
+export * from './common-file-model';
+export * from './consumer-bind-model';
+export * from './consumer-device-model';
+export * from './consumer-favorite-model';
+export * from './consumer-model';
+export * from './device-model';
+export * from './device-user-model';
+export * from './health-care-config-model';
+export * from './health-metric-model';
+export * from './health-profile-model';
+export * from './health-self-assess-model';
+export * from './health-tool-model';
+export * from './im-user-model';
+export * from './km-article-model';
+export * from './km-form-model';
+export * from './km-form-rule-relation-model';
+export * from './login-model';
+export * from './marketing-model';
+export * from './message-record-model';
+export * from './mine-model';
+export * from './right-qrcode-model';
+export * from './right-service-config-model';
+export * from './system-right-model';
+export * from './user-group-model';