@ray-js/lock-sdk 1.0.1-beta-2 → 1.0.2

package/lib/interface.d.ts

@@ -3,50 +3,17 @@ export type ParamType<T> = T extends (param: infer K) => any ? K : never;
 export type DpValue = string | boolean | number;
 export type DpData = Record<string, DpValue>;
 export interface LockSDKOption {
-    /**
-     * 设备id
-     */
     deviceId?: string;
-    /**
-     * 设备信息
-     */
     devInfo?: any;
-    /**
-     * 是否严格模式
-     * 如果为 true，则 dp 数据进行严格校验，否则不进行严格校验
-     * 默认为 true
-     */
     strictMode?: boolean;
-    /**
-     * 密码支持的进制，只支持十以内的进制
-     * 默认为 十进制
-     */
     passwordDigitalBase?: number;
-    /**
-     * 密码是否支持 0
-     * 默认为 true
-     */
     passwordSupportZero?: boolean;
 }
 export interface ErrorData {
     errorCode: number;
     errorMsg: string;
 }
-/**
- * 位状态
- */
 export type BitStatus = 0 | 1;
-/**
- * 周数据， 0 表示不生效，1 表示生效
- * 根据下标依次表示：
- * 0 表示周日
- * 1 表示周一
- * 2 表示周二
- * 3 表示周三
- * 4 表示周四
- * 5 表示周五
- * 6 表示周六
- */
 export type Week = [
     BitStatus,
     BitStatus,
@@ -56,9 +23,6 @@ export type Week = [
     BitStatus,
     BitStatus
 ];
-/**
- * 设备信息
- */
 export interface DeviceInfo {
     devId: string;
     productId: string;
@@ -76,9 +40,6 @@ export interface DeviceInfo {
     activeTime: number;
     dpsTime: Record<string, string>;
 }
-/**
- * DP 定义信息
- */
 export interface DpSchema {
     type: "raw" | "obj";
     name: string;
@@ -96,10 +57,6 @@ export interface DpSchema {
         maxlen: number;
     };
 }
-/**
- * 设备能力信息
- * 设备侧上报
- */
 export interface CapabilityInfo {
     type: ModuleType;
     vedioType: VedioType;
@@ -108,212 +65,61 @@ export interface CapabilityInfo {
     communicationType: CommunicationType;
     rotateType: RotateType;
 }
-/**
- * 当前登录用户的信息
- */
 export interface CurrentUser {
-    /**
-     * 用户id
-     */
     userId: string;
-    /**
-     * 锁端用户id
-     */
     lockUserId: number;
-    /**
-     * 用户类型
-     */
     userType: UserType;
-    /**
-     *  支持的开锁 dp
-     */
     allOpenDps: string;
-    /**
-     * 支持的开锁类型
-     */
     allOpenType: number[];
-    /**
-     * 产品属性
-     */
     productAttribute: number;
     phase: number;
-    /**
-     * 是否管理员
-     */
     admin: boolean;
-    /**
-     * 是否支持离线开锁
-     */
     offlineUnlock: boolean;
-    /**
-     * 是否永久有效
-     */
     permanent: boolean;
 }
 export interface UnlockMethodBaseInfo {
-    /**
-     * 开锁方式硬件id
-     */
     unlockId: string;
-    /**
-     * 开锁方式名称
-     */
     unlockName: string;
-    /**
-     * 是否为云端关联的开锁方式
-     * true - 关联的开锁方式
-     * false - 非关联的开锁方式
-     */
     isBound: boolean;
-    /**
-     * 开锁方式id
-     * 云端分配的开锁方式id
-     */
     id: number;
-    /**
-     * 是否为图片开锁方式
-     */
     photoUnlock: boolean;
-    /**
-     * 是否为特殊开锁方式
-     */
     isSpecial: boolean;
 }
-/**
- * 开锁方式类型
- * finger 表示 指纹开锁
- * face 表示 人脸开锁
- * password 表示 密码开锁
- * card 表示 卡片开锁
- * fingerVein 表示 指静脉开锁
- * hand 表示 掌静脉开锁
- * eye 表示 眼纹开锁
- */
 export type UnlockMethodType = "finger" | "face" | "password" | "card" | "fingerVein" | "hand" | "eye";
-/**
- * 开锁方式配置
- */
 export interface UnlockMethodConfig {
-    /**
-     * 开锁方式类型
-     */
     type: UnlockMethodType;
-    /**
-     * 开锁方式对应的 dp code
-     */
     code: string;
-    /**
-     * 开锁方式对应的协议 id
-     * 1 - 密码开锁
-     * 2 - 卡片开锁
-     * 3 - 指纹开锁
-     * 4 - 人脸开锁
-     * 5 - 掌静脉开锁
-     * 6 - 指静脉开锁
-     */
     id: number;
 }
-/**
- * 门锁面板信息
- */
 export interface UserInfo {
-    /**
-     * 用户id
-     */
     userId: string;
-    /**
-     * 锁端用户id
-     */
     lockUserId: number;
-    /**
-     * 用户头像
-     */
     avatarUrl: string;
     backHomeNotifyAttr: number;
     effectiveFlag: number;
-    /**
-     * 昵称
-     */
     nickName: string;
-    /**
-     * 是否支持离线开锁
-     */
     offlineUnlock: boolean;
-    /**
-     * 生效时间配置
-     */
     timeScheduleInfo: {
         effectiveTime: number;
         expiredTime: number;
-        /**
-         * 是否永久有效
-         */
         permanent: boolean;
-        /**
-         * 重复配置
-         * permanent 为 true 时，无此配置
-         */
         scheduleDetails?: {
-            /**
-             * 是否周重复
-             */
             repeat: boolean;
-            /**
-             * 每天的生效时间，单位分钟
-             */
             effectiveTime: number;
-            /**
-             * 每天的失效时间，单位分钟
-             */
             invalidTime: number;
-            /**
-             * 时区
-             */
             timeZoneId: string;
-            /**
-             * 周重复数据
-             */
             weeks: Week;
         };
     };
-    /**
-     * 开锁方式列表
-     */
     unlockDetails: {
-        /**
-         * 本类开锁方式的数量
-         */
         count: number;
-        /**
-         * 对应的开锁方式dp code
-         * 为开锁记录的 dp code
-         */
         dpCode: string;
-        /**
-         * 对应的开锁方式dp id
-         * 为开锁记录的 dp id
-         */
         dpId: number;
-        /**
-         * 本类开锁方式的类型
-         */
         type: UnlockMethodType;
-        /**
-         * 本类开锁方式详细列表
-         */
         unlockList: UnlockMethodBaseInfo[];
     }[];
-    /**
-     * 用户账号
-     */
     userContact: string;
-    /**
-     * 用户类型
-     */
     userType: UserType;
-    /**
-     * 是否为账号用户
-     */
     isAccountUser: boolean;
 }
 type MapItem = {
@@ -333,111 +139,31 @@ export type DpMapDataType<T extends DpMapType> = {
     }>>;
 };
 export interface NotifyInfo {
-    /**
-     * 是否开启 App 消息通知
-     */
     appSend?: boolean;
-    /**
-     * 短信通知手机号，有手机号时，表示开启短信通知
-     */
     msgPhone?: string;
-    /**
-     * 短信通知国家码
-     */
     countryCode?: string;
 }
-/**
- * 开锁方式详细信息
- */
 export interface UnlockMethodDetail {
-    /**
-     * 是否为云端关联的开锁方式
-     */
     isBound: boolean;
-    /**
-     * 开锁方式状态
-     */
     phase: number;
-    /**
-     * 开锁方式对应的 dp id
-     */
     dpId: number;
-    /**
-     * 是否为特殊开锁方式
-     */
     isSpecial: boolean;
-    /**
-     * 开锁方式名称
-     */
     unlockName: string;
-    /**
-     * 所属用户 id
-     */
     userId: string;
-    /**
-     * 开锁方式硬件id
-     */
     unlockId: number;
-    /**
-     * 锁端用户 id
-     */
     lockUserId: number;
-    /**
-     * 开锁方式 id
-     */
     id: string;
-    /**
-     * 用户类型
-     */
     userType: number;
-    /**
-     * 开锁消息通知配置
-     * 当 isSpecial 为 true 时，值才有效
-     */
     notifyInfo: NotifyInfo;
 }
-/**
- * 时效配置
- */
 export interface EffectiveConfig {
-    /**
-     * 生效日期
-     * 单位为秒
-     */
     effectiveDate: number;
-    /**
-     * 失效日期
-     * 单位为秒
-     */
     expiredDate: number;
-    /**
-     * 重复类型
-     * 目前支持 none 和 week
-     * 默认为 none
-     */
     repeat?: "none" | "week";
-    /**
-     * 周重复配置
-     * 仅当 repeat 为 week 时生效
-     */
     weeks?: Week;
-    /**
-     * 生效时间，单位分钟
-     * 如生效时间为12:00，则值为 720
-     */
     effectiveTime?: number;
-    /**
-     * 失效时间，单位分钟
-     * 如生效时间为23:00，则值为 1380
-     */
     expiredTime?: number;
 }
-/**
- * 远程权限
- * everyOne 表示所有人都可以远程开关门
- * adminsOnly 表示仅管理员可以远程开关门
- * noOne 表示所有人都不可以远程开关门
- */
 export type RemotePermission = "everyOne" | "adminsOnly" | "noOne";
 export interface UnBindUnlockMethod {
     dpId: number;
@@ -452,30 +178,10 @@ export interface UnBindUnlockMethodGroup {
     type: UnlockMethodType;
     list: UnBindUnlockMethod[];
 }
-/**
- * 设备状态信息
- */
 export interface DeviceStatus {
-    /**
-     * 设备状态
-     * online: 在线
-     * offline: 离线
-     * sleep: 休眠
-     */
     type: "offline" | "online" | "sleep";
-    /**
-     * 是否可手动连接设备
-     */
     connectEanble: boolean;
-    /**
-     * 在线类型
-     * 当 type 为 online 时有效
-     */
     onlineType: "local" | "cloud" | "ble" | "none" | "unknown";
-    /**
-     * 休眠时间段
-     * 仅当 type 为 sleep 时有效
-     */
     sleepPeriod?: {
         start: number;
         end: number;
@@ -489,44 +195,12 @@ export interface UnionUnlockInfo {
     type: UnlockMethodType;
 }
 export interface LocalOperateRecordInfo {
-    /**
-     * 操作分类
-     * 开锁方式类：
-     * 0 表示 添加开锁方式
-     * 1 表示删除开锁方式
-     * 2 表示修改开锁方式
-     *
-     * 操作用户类：
-     * 16：添加用户
-     * 17：删除用户
-     *
-     * 本地设置类：
-     * 32 表示本地设备设置
-     */
     operClassify: LocalOperateCategory;
-    /**
-     * 操作人 id
-     */
     userId: number;
-    /**
-     * 操作人类型
-     */
     userType: LocalOperateUserType;
-    /**
-     * 操作类型
-     */
     operType: number;
-    /**
-     * 操作值
-     */
     operDetail: string;
-    /**
-     * 被操作人类型
-     */
     toUserType: LocalOperateUserType;
-    /**
-     * 被操作人 id
-     */
     toUserId: number;
 }
 interface LocalOperateBaseData {
@@ -535,273 +209,76 @@ interface LocalOperateBaseData {
     toUserType: LocalOperateUserType;
     toUserId: number;
 }
-/**
- * 本地管理开锁方式记录
- */
 export interface LocalUnlockMethodData extends LocalOperateBaseData {
     category: LocalOperateCategory.ADD_UNLOCK_METHOD | LocalOperateCategory.DELETE_UNLOCK_METHOD | LocalOperateCategory.MODIFY_UNLOCK_METHOD;
     unlockMethod: UnlockMethodType | "remoteControl";
-    /**
-     * 开锁方式 id
-     */
     unlockId: number;
-    /**
-     * 是否为删除所有开锁方式
-     */
     isRemoveAll: boolean;
 }
-/**
- * 本地管理添加/删除用户记录
- */
 export interface LocalAddUserData extends LocalOperateBaseData {
     category: LocalOperateCategory.ADD_USER | LocalOperateCategory.DELETE_USER;
 }
-/**
- * 本地管理设置记录
- */
 export interface LocalSettingData extends LocalOperateBaseData {
     category: LocalOperateCategory.SETTING;
-    /**
-     * 设置类型
-     */
     type: number;
     data: number | Uint8Array;
-    /**
-     * 原始数据
-     */
     originData: Uint8Array;
 }
-/**
- * 本地管理其他记录
- */
 export interface LocalOperateOtherData extends LocalOperateBaseData {
-    /**
-     * 操作分类
-     */
     category: number;
-    /**
-     * 操作类型
-     */
     type: number;
-    /**
-     * 操作数据
-     */
     data: Uint8Array;
 }
-/**
- * 设备本地操作记录
- */
 export type LocalOperateData = LocalUnlockMethodData | LocalAddUserData | LocalSettingData | LocalOperateOtherData;
-/**
- * 多媒体信息
- */
 export interface MediaInfo {
-    /**
-     * 媒体路径
-     */
     mediaPath: string;
-    /**
-     * 图片 key
-     */
     fileKey: string;
-    /**
-     * 图片 url
-     */
     fileUrl: string;
-    /**
-     * 媒体桶
-     */
     mediaBucket: string;
-    /**
-     * 媒体 key
-     */
     mediaKey: string;
 }
-/**
- * 日志类型
- * alarm_record 表示告警日志
- * close_record 表示关锁日志
- * unlock_record 表示开锁日志
- * operation 操作类日志
- * local_operation 设备本地操作日志
- * dev_bind 设备绑定日志
- */
 export type LogType = "alarm_record" | "close_record" | "unlock_record" | "operation" | "local_operation" | "dev_bind";
-/**
- * 关门记录值
- * UNDEFINED: '未定义方式 关锁',
- * VOICE_REMOTE: '远程语音 关锁',
- * APP_REMOTE: '远程 关锁',
- * AUTO: '自动 关锁',
- * LOCAL_MANUAL: '本地手动 关锁',
- * FITTINGS: '门锁配件 关锁',
- * APP: '使用 手机蓝牙 关锁',
- * GEO_FENCE: '使用 地理围栏 关锁',
- */
 export type CloseValue = "UNDEFINED" | "VOICE_REMOTE" | "APP_REMOTE" | "AUTO" | "LOCAL_MANUAL" | "FITTINGS" | "APP" | "GEO_FENCE";
 export interface LogData {
-    /**
-     * 日志id
-     */
     logId: string;
-    /**
-     * 日志生成时间戳，单位毫秒
-     */
     time: number;
-    /**
-     * 是否当前用户
-     */
     currentUser: boolean;
-    /**
-     * 日志类型
-     */
     type: LogType;
-    /**
-     * 与记录相关的用户id
-     */
     userId: string;
-    /**
-     * 相关dp id
-     */
     dpId: number;
-    /**
-     * 相关 dp code
-     */
     dpCode: string;
-    /**
-     * 记录对应的数据
-     * 如果是 dp 相关的，则值为 dp 的值
-     * 如果是其他类型的，则值为其他类型的数据
-     */
     data: any;
-    /**
-     * 与记录相关的用户昵称
-     */
     userName: string;
-    /**
-     * 是否未绑定，当 type 为 unlock_record 时值有意义
-     */
     bindable: boolean;
-    /**
-     * 开锁方式的名称，当 type 为 unlock_record 时，值有意义
-     * 如果开锁记录无对应的密码名称时，此值为空
-     */
     unlockName: string;
-    /**
-     * 日志对应的消息图片或视频
-     */
     mediaInfo?: MediaInfo[];
-    /**
-     * 组合开锁记录，当 type 为 unlock_record 时，可能有值
-     * 如果明确记录为开锁记录，但此字段无值的，则需要检查上报的数据是否有问题
-     *
-     */
     unionUnlockInfo?: UnionUnlockInfo[];
-    /**
-     * 关门记录值，当 type 为 close_record 时有值
-     * UNDEFINED: '未定义方式 关锁',
-     * VOICE_REMOTE: '远程语音 关锁',
-     * APP_REMOTE: '远程 关锁',
-     * AUTO: '自动 关锁',
-     * LOCAL_MANUAL: '本地手动 关锁',
-     * FITTINGS: '门锁配件 关锁',
-     * APP: '使用 手机蓝牙 关锁',
-     * GEO_FENCE: '使用 地理围栏 关锁',
-     */
     closeValue?: CloseValue;
-    /**
-     * 设备本地日志，当 type 为 local_operation 时，有值
-     */
     localRecord?: LocalOperateData;
-    /**
-     * 是否为劫持告警
-     */
     isHijack?: boolean;
-    /**
-     * 开锁方式类型，当 type 为 unlock_record 时，值有意义
-     */
     unlockMethod?: UnlockMethodType;
 }
-/**
- * 临时密码类型
- * custom 表示自定义密码
- * once 表示一次性密码
- * limit 表示限时密码
- * clear 表示清除密码
- * clearOne 表示清除单个密码
- */
 export type TemporaryPasswordType = "custom" | "once" | "limit" | "clear" | "clearOne";
-/**
- * 临时密码结果
- */
 export interface TempPasswordResult {
-    /**
-     * 临时密码类型
-     */
     type: TemporaryPasswordType | "dynamic";
-    /**
-     * 密码名称
-     */
     name: string;
-    /**
-     * 密码
-     */
     password: string;
-    /**
-     * 解锁绑定 ID
-     */
     unlockBindingId: string;
-    /**
-     * 时效配置
-     */
     effectiveConfig: EffectiveConfig;
 }
 export interface AlbumMessage extends MediaInfo {
-    /**
-     * id
-     */
     id: string;
-    /**
-     * AI 检测结果
-     */
     aiInfos: {
         id: number;
-        /**
-         * 事件类型
-         */
         type: number;
-        /**
-         * 事件名称
-         */
         name: string;
-        /**
-         * 事件描述
-         */
         desc: string;
-        /**
-         * 发生时间，单位毫秒
-         */
         happenTime: number;
-        /**
-         * 是否已修正
-         */
         isCorrected: boolean;
     }[];
-    /**
-     *  AI 检测结果类型
-     */
     aiTypes: number[];
-    /**
-     * 消息描述
-     */
     describe: string;
-    /**
-     * 消息类型
-     */
     type: number;
-    /**
-     * 创建时间，单位毫秒
-     */
     createTime: number;
 }
 export {};