@ray-js/lock-sdk 1.0.0-beta-1

package/lib/api/user.d.ts

@@ -0,0 +1,154 @@
+import { CurrentUser } from "../interface";
+/**
+ * 获取当前登录用户信息
+ * @param deviceId
+ * @returns
+ */
+export declare const getCurrentUserInfo: (deviceId: string) => Promise<CurrentUser>;
+interface UserTimeScheduleParams {
+    devId: string;
+    userId: string;
+    timeScheduleInfo: {
+        permanent: boolean;
+        userTimeSet: string;
+        effectiveTime: number;
+        expiredTime: number;
+        scheduleDetails: {
+            allDay: boolean;
+            effectiveTime: number;
+            invalidTime: number;
+            workingDay: number;
+        }[];
+    };
+}
+export declare const updateUserTimeSchedule: (params: UserTimeScheduleParams) => Promise<unknown>;
+interface AddNormalUserParams {
+    devId: string;
+    name: string;
+}
+export declare const addNormalUser: (params: AddNormalUserParams) => Promise<unknown>;
+interface RemoveNormalUserParams {
+    devId: string;
+    userId: string;
+    shouldDeleteUnlockInfo: boolean;
+    issueDp: boolean;
+}
+export declare const removeNormalUser: (params: RemoveNormalUserParams) => Promise<unknown>;
+interface getUserListParams {
+    devId: string;
+    dpCodes: string;
+    keyword?: string;
+    offset: number;
+    limit: number;
+}
+export interface UserListItem {
+    /**
+     * 用户id
+     */
+    userId: string;
+    /**
+     * 锁端用户id
+     */
+    lockUserId: number;
+    /**
+     * 用户头像
+     */
+    avatarUrl: string;
+    backHomeNotifyAttr: number;
+    effectiveFlag: number;
+    /**
+     * 昵称
+     */
+    nickName: string;
+    /**
+     * 是否支持离线开锁
+     */
+    offlineUnlock: boolean;
+    /**
+     * 生效时间配置
+     */
+    timeScheduleInfo: {
+        effectiveTime: number;
+        expiredTime: number;
+        /**
+         * 是否永久有效
+         */
+        permanent: boolean;
+        /**
+         * 重复配置
+         */
+        scheduleDetails: {
+            allDay: boolean;
+            effectiveTime: number;
+            invalidTime: number;
+            timeZoneId: string;
+            workingDay: number;
+        }[];
+    };
+    /**
+     * 开锁方式列表
+     */
+    unlockDetail: {
+        /**
+         * 本类开锁方式的数量
+         */
+        count: number;
+        /**
+         * 对应的开锁方式dp code
+         */
+        dpCode: string;
+        /**
+         * 对应的开锁方式dp id
+         */
+        dpId: number;
+        /**
+         * 本类开锁方式详细列表
+         */
+        unlockList: {
+            unlockId: string;
+            opModeId: number;
+            unlockName: string;
+            unlockAttr: number;
+            admin: boolean;
+            allocateFlag: number;
+            photoUnlock: boolean;
+        }[];
+    }[];
+    /**
+     * 用户账号
+     */
+    userContact: string;
+    userType: 10 | 20 | 30 | 40 | 50;
+    userListType: "panel_user" | "group_user";
+}
+/**
+ * 获取用户列表
+ * @param params
+ * @returns
+ */
+export declare const getUserList: (params: getUserListParams) => Promise<{
+    admin: UserListItem[];
+    user: UserListItem[];
+    hasNext: boolean;
+}>;
+interface GetUserDetailParams {
+    devId: string;
+    userId: string;
+}
+interface UserDetail {
+    allOpenType: number[];
+    avatarUrl: string;
+    lockUserId: number;
+    nickName: string;
+    phase: number;
+    productAttribute: number;
+    status: number;
+    supportOpenType: number[];
+    uid: string;
+    userContact: string;
+    userId: string;
+    userTimeSet: string;
+    userType: number;
+}
+export declare const getUserDetail: (params: GetUserDetailParams) => Promise<UserDetail>;
+export {};

package/lib/api/user.js

@@ -0,0 +1,59 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+
+/**
+ * 获取当前登录用户信息
+ * @param deviceId
+ * @returns
+ */
+export const getCurrentUserInfo = deviceId => {
+  return requestCloud({
+    api: `${THING}.m.device.member.get`,
+    version: "3.0",
+    data: {
+      devId: deviceId,
+      dpIds: ""
+    }
+  });
+};
+export const updateUserTimeSchedule = params => {
+  return requestCloud({
+    api: `${THING}.m.device.user.time.schedule.update`,
+    version: "1.0",
+    data: params
+  });
+};
+export const addNormalUser = async params => {
+  return requestCloud({
+    api: "m.smart.scale.history.user.add",
+    version: "1.0",
+    data: params
+  });
+};
+export const removeNormalUser = async params => {
+  return requestCloud({
+    api: "m.smart.scale.history.user.delete",
+    version: "2.0",
+    data: params
+  });
+};
+/**
+ * 获取用户列表
+ * @param params
+ * @returns
+ */
+export const getUserList = params => {
+  return requestCloud({
+    api: "m.lock.member.family.panel.all.list",
+    version: "1.0",
+    data: params
+  });
+};
+// 注意此 api 与 getUserList 中返回的数据有区别，建议只在 SDK 内部使用
+export const getUserDetail = params => {
+  return requestCloud({
+    api: `${THING}.m.device.member.detail`,
+    version: "4.0",
+    data: params
+  });
+};

package/lib/api/video.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 获取设备的旋转角度
+ * @param deviceId
+ * @returns
+ */
+export declare const getRotateInfo: (deviceId: string) => Promise<{
+    angle: number;
+    actualAngle: number;
+}>;

package/lib/api/video.js

@@ -0,0 +1,17 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+
+/**
+ * 获取设备的旋转角度
+ * @param deviceId
+ * @returns
+ */
+export const getRotateInfo = deviceId => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.media.rotate.get`,
+    version: "1.0",
+    data: {
+      devId: deviceId
+    }
+  });
+};

package/lib/config/dp-code/index.d.ts

@@ -0,0 +1,175 @@
+/**
+ * 门锁支持的 DP
+ */
+declare const dpCodes: {
+    /**
+     * 远程开程 dp
+     */
+    remoteNoDpKey: string;
+    /**
+     * 密钥配置
+     */
+    remoteNoPdSetkey: string;
+    /**
+     * 同步开锁方式 dp
+     */
+    synchMethodW: string;
+    synchMethod: string;
+    /**
+     * 解锁方式管理 dp
+     */
+    unlockMethodCreateW: string;
+    unlockMethodCreate: string;
+    unlockMethodDelW: string;
+    unlockMethodDel: string;
+    unlockMethodEditW: string;
+    unlockMethodEdit: string;
+    tempPwdCreateW: string;
+    tempPwdCreate: string;
+    tempPwdDelW: string;
+    tempPwdDel: string;
+    tempPwdEditW: string;
+    tempPwdEdit: string;
+    /**
+     * 普通密码解锁 61
+     */
+    unlockPassword: string;
+    /**
+     * 指纹解锁 63
+     */
+    unlockFingerprint: string;
+    /**
+     *  指静脉解锁 67
+     */
+    unlockFingerVein: string;
+    /**
+     * 掌静脉解锁 66
+     */
+    unlockHand: string;
+    /**
+     * 动态密码解锁 90
+     */
+    unlockDynamic: string;
+    /**
+     * 钥匙解锁 71
+     */
+    unlockKey: string;
+    /**
+     * 卡片解锁 64
+     */
+    unlockCard: string;
+    /**
+     * 人脸解锁 65
+     */
+    unlockFace: string;
+    /**
+     * 临时密码解锁记录上报 69
+     */
+    unlockTemporary: string;
+    /**
+     * 离线密码解锁上报 89
+     */
+    unlockOfflinePd: string;
+    /**
+     * 清空离线密码 88
+     */
+    unlockOfflineClear: string;
+    /**
+     * 清空单个离线密码 87
+     */
+    unlockOfflineClearSingle: string;
+    /**
+     * 远程手机解锁 72
+     */
+    unlockPhoneRemote: string;
+    /**
+     *  远程语音解锁 73
+     */
+    unlockVoiceRemote: string;
+    /**
+     * 关锁记录 62
+     */
+    lockRecord: string;
+    /**
+     * 蓝牙开锁 76
+     */
+    unlockBle: string;
+    /**
+     * 蓝牙模块开启开关
+     */
+    bleControl: string;
+    /**
+     * 虹膜开锁 68
+     */
+    unlockEye: string;
+    /**
+     * 组合开锁 70
+     */
+    unlockDoubleKit: string;
+    /**
+     * 大容量组合开锁 74
+     */
+    unlockDoubleKitW: string;
+    /**
+     * 门从内侧打开 52
+     */
+    openInside: string;
+    /**
+     * 设备操作记录 58
+     */
+    lockLocalRecord: string;
+    /**
+     * 设备本地开锁 75
+     */
+    deviceUnlock: string;
+    /**
+     * 告警提醒 59
+     */
+    alarmReminder: string;
+    /**
+     * 告警 60
+     */
+    alarmLock: string;
+    /**
+     * 门铃 53
+     */
+    doorbell: string;
+    /**
+     * 劫持告警 98
+     */
+    hijack: string;
+    /**
+     * 家人呼叫 99
+     */
+    familyCall: string;
+    /**
+     * 短信通知
+     */
+    message: string;
+    /**
+     * T0 时间
+     */
+    passwordOfflineTime: string;
+    /**
+     * 休眠状态
+     */
+    linkMode: string;
+    wirelessWwake: string;
+    dormantTimeSet: string;
+    dormantSwitch: string;
+    onlineSwitch: string;
+    /**
+     * aov
+     */
+    recordModeAovSwitch: string;
+    /**
+     * sd 卡支持
+     */
+    sdStatus: string;
+    /**
+     * 同步或更新信息
+     */
+    updataInfo: string;
+};
+export declare const latLogDpCodes: string[];
+export default dpCodes;

package/lib/config/dp-code/index.js

@@ -0,0 +1,224 @@
+/**
+ * 门锁支持的 DP
+ */
+const dpCodes = {
+  /**
+   * 远程开程 dp
+   */
+  remoteNoDpKey: "remote_no_dp_key",
+  /**
+   * 密钥配置
+   */
+  remoteNoPdSetkey: "remote_no_pd_setkey",
+  /**
+   * 同步开锁方式 dp
+   */
+  synchMethodW: "synch_method_w",
+  synchMethod: "synch_method",
+  /**
+   * 解锁方式管理 dp
+   */
+  unlockMethodCreateW: "unlock_method_create_w",
+  unlockMethodCreate: "unlock_method_create",
+  unlockMethodDelW: "unlock_method_delete_w",
+  unlockMethodDel: "unlock_method_delete",
+  unlockMethodEditW: "unlock_method_modify_w",
+  unlockMethodEdit: "unlock_method_modify",
+  // 临时密码操作dp
+  tempPwdCreateW: "temporary_password_create_w",
+  tempPwdCreate: "temporary_password_creat",
+  tempPwdDelW: "temporary_password_delete_w",
+  tempPwdDel: "temporary_password_delete",
+  tempPwdEditW: "temporary_password_modify_w",
+  tempPwdEdit: "temporary_password_modify",
+  // 解锁记录dp
+  /**
+   * 普通密码解锁 61
+   */
+  unlockPassword: "unlock_password",
+  /**
+   * 指纹解锁 63
+   */
+  unlockFingerprint: "unlock_fingerprint",
+  /**
+   *  指静脉解锁 67
+   */
+  unlockFingerVein: "unlock_finger_vein",
+  /**
+   * 掌静脉解锁 66
+   */
+  unlockHand: "unlock_hand",
+  /**
+   * 动态密码解锁 90
+   */
+  unlockDynamic: "unlock_dynamic",
+  /**
+   * 钥匙解锁 71
+   */
+  unlockKey: "unlock_key",
+  /**
+   * 卡片解锁 64
+   */
+  unlockCard: "unlock_card",
+  /**
+   * 人脸解锁 65
+   */
+  unlockFace: "unlock_face",
+  /**
+   * 临时密码解锁记录上报 69
+   */
+  unlockTemporary: "unlock_temporary",
+  /**
+   * 离线密码解锁上报 89
+   */
+  unlockOfflinePd: "unlock_offline_pd",
+  /**
+   * 清空离线密码 88
+   */
+  unlockOfflineClear: "unlock_offline_clear",
+  /**
+   * 清空单个离线密码 87
+   */
+  unlockOfflineClearSingle: "unlock_offline_clear_single",
+  /**
+   * 远程手机解锁 72
+   */
+  unlockPhoneRemote: "unlock_phone_remote",
+  /**
+   *  远程语音解锁 73
+   */
+  unlockVoiceRemote: "unlock_voice_remote",
+  /**
+   * 关锁记录 62
+   */
+  lockRecord: "lock_record",
+  /**
+   * 蓝牙开锁 76
+   */
+  unlockBle: "unlock_ble",
+  /**
+   * 蓝牙模块开启开关
+   */
+  bleControl: 'ble_control',
+  /**
+   * 虹膜开锁 68
+   */
+  unlockEye: "unlock_eye",
+  /**
+   * 组合开锁 70
+   */
+  unlockDoubleKit: "unlock_double_kit",
+  /**
+   * 大容量组合开锁 74
+   */
+  unlockDoubleKitW: "unlock_double_kit_w",
+  /**
+   * 门从内侧打开 52
+   */
+  openInside: "open_inside",
+  /**
+   * 设备操作记录 58
+   */
+  lockLocalRecord: "lock_local_record",
+  /**
+   * 设备本地开锁 75
+   */
+  deviceUnlock: "device_unlock",
+  // 告警 相关
+  /**
+   * 告警提醒 59
+   */
+  alarmReminder: "alarm_reminder",
+  /**
+   * 告警 60
+   */
+  alarmLock: "alarm_lock",
+  /**
+   * 门铃 53
+   */
+  doorbell: "doorbell",
+  /**
+   * 劫持告警 98
+   */
+  hijack: "hijack",
+  /**
+   * 家人呼叫 99
+   */
+  familyCall: "family_call",
+  /**
+   * 短信通知
+   */
+  message: "message",
+  /**
+   * T0 时间
+   */
+  passwordOfflineTime: "password_offline_time",
+  /**
+   * 休眠状态
+   */
+  linkMode: "link_mode",
+  wirelessWwake: "wireless_awake",
+  dormantTimeSet: "dormant_time_set",
+  dormantSwitch: "dormant_switch",
+  onlineSwitch: "online_switch",
+  /**
+   * aov
+   */
+  recordModeAovSwitch: "record_mode_aov_switch",
+  /**
+   * sd 卡支持
+   */
+  sdStatus: "sd_status",
+  /**
+   * 同步或更新信息
+   */
+  updataInfo: 'updata_info'
+};
+// 最近一条开门记录数据集合，当收到这些上报时，则刷新数据
+export const latLogDpCodes = [dpCodes.unlockPassword,
+// 61 普通密码解锁
+dpCodes.lockRecord,
+// 62 关锁
+dpCodes.unlockFingerprint,
+// 63
+dpCodes.unlockCard,
+// 64
+dpCodes.unlockFace,
+// 65
+dpCodes.unlockHand,
+// 66
+dpCodes.unlockFingerVein,
+// 67
+dpCodes.unlockBle,
+// 76
+dpCodes.unlockEye,
+// 68
+dpCodes.unlockTemporary,
+// 69
+dpCodes.unlockDoubleKit,
+// 70组合开锁
+dpCodes.unlockDoubleKitW,
+// 74大量组合开锁
+dpCodes.unlockKey,
+// 71
+dpCodes.unlockPhoneRemote,
+// 72
+dpCodes.unlockVoiceRemote,
+// 73
+dpCodes.unlockOfflinePd,
+// 89
+dpCodes.unlockDynamic,
+//90
+dpCodes.alarmLock,
+// 60
+dpCodes.doorbell,
+// 53
+dpCodes.hijack,
+// 98
+dpCodes.unlockOfflineClear,
+// 88
+dpCodes.unlockOfflineClearSingle,
+// 87
+dpCodes.familyCall // 99
+];
+export default dpCodes;