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

package/lib/api/setting.d.ts

@@ -1,14 +1,3 @@
-/**
- * 获取设备某些属性
- * @param params
- * @returns
- */
 declare const getDeviceProperties: (deviceId: string, props: string[]) => Promise<Record<string, any>>;
-/**
- * 设置设备属性，支持同时设置多个属性
- * @param devId
- * @param data
- * @returns
- */
 declare const setDeviceProperties: (devId: string, data: Record<string, any>) => Promise<void>;
 export { setDeviceProperties, getDeviceProperties };

package/lib/api/setting.js

@@ -1,36 +1,23 @@
 import { THING } from "../utils/constant";
 import { requestCloud } from "../utils/device";
-
-/**
- * 获取设备某些属性
- * @param params
- * @returns
- */
 const getDeviceProperties = (deviceId, props) => {
-  return requestCloud({
-    api: `${THING}.m.device.props.fetch`,
-    version: "1.0",
-    data: {
-      devId: deviceId,
-      props: props.join(",")
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.device.props.fetch`,
+        version: "1.0",
+        data: {
+            devId: deviceId,
+            props: props.join(","),
+        },
+    });
 };
-
-/**
- * 设置设备属性，支持同时设置多个属性
- * @param devId
- * @param data
- * @returns
- */
 const setDeviceProperties = (devId, data) => {
-  return requestCloud({
-    api: `${THING}.m.device.props.save`,
-    version: "1.0",
-    data: {
-      devId,
-      propKvs: data
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.device.props.save`,
+        version: "1.0",
+        data: {
+            devId,
+            propKvs: data,
+        },
+    });
 };
-export { setDeviceProperties, getDeviceProperties };
+export { setDeviceProperties, getDeviceProperties };

package/lib/api/temp.d.ts

@@ -20,11 +20,6 @@ export interface CreateTempPasswordResult {
     name: string;
     tyNum?: number;
 }
-/**
- * 创建临时密码
- * @param {CreateTempPasswordParams} params - 创建临时密码参数
- * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
- */
 export declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
 export interface ValidateTempPwdParams {
     password: string;
@@ -39,11 +34,6 @@ export interface ValidateTempPwdParams {
         workingDay: number;
     }[];
 }
-/**
- * 临时密码参数检验
- * @param {ValidateTempPwdProps} params - 临时密码验证参数
- * @returns {Promise<{ valid: boolean; errorCode?: number }>} - 验证结果的 Promise
- */
 export declare const validateTempPwd: (params: ValidateTempPwdParams) => Promise<{
     valid: boolean;
     errorCode?: string;
@@ -64,11 +54,6 @@ interface UpdateTempPasswordParams {
         workingDay: number;
     }[];
 }
-/**
- * 更新临时密码相关的信息
- * @param {UpdateTempPasswordParams} params - 更新临时密码参数
- * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
- */
 export declare const updateTemporaryPassword: (params: UpdateTempPasswordParams) => Promise<boolean>;
 interface GetTempPasswordParams {
     devId: string;
@@ -92,46 +77,18 @@ export interface CreateOfflinePasswordParams {
     mobile?: string;
 }
 export interface OfflinePwdResult {
-    /**
-     * 离线密码失效时间戳，单位为秒
-     */
     gmtExpired: number;
-    /**
-     * 离线密码生效时间戳，单位为秒
-     */
     gmtStart: number;
-    /**
-     * 密码内容
-     */
     pwd: string;
-    /**
-     * 密码 ID
-     */
     pwdId: string;
-    /**
-     * 密码名称
-     */
     pwdName: string;
-    /**
-     * 解锁绑定 ID
-     */
     unlockBindingId: string;
 }
-/**
- * 获取离线临时密码
- * @param {CreateOfflinePasswordParams} params - 请求参数
- * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
- */
 export declare const createOfflinePassword: (params: CreateOfflinePasswordParams) => Promise<OfflinePwdResult>;
 interface GetDynapwdParams {
     devId: string;
     adminPwd?: string;
 }
-/**
- * 获取动态密码
- * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
- * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
- */
 export declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<{
     dynamicPassword: string;
 }>;
@@ -140,11 +97,6 @@ interface RevokeOfflinePasswordParams {
     unlockBindingId: string;
     name?: string;
 }
-/**
- * 删除离线临时密码
- * @param {RevokeOfflinePasswordParams} params - 请求参数
- * @returns {Promise<string>} - 响应结果的 Promise
- */
 export declare const revokeOfflinePassword: (params: RevokeOfflinePasswordParams) => Promise<OfflinePwdResult>;
 interface EffectiveListParams {
     devId: string;

package/lib/api/temp.js

@@ -1,130 +1,100 @@
 import { requestCloud } from "../utils/device";
 import { THING } from "../utils/constant";
-/**
- * 创建临时密码
- * @param {CreateTempPasswordParams} params - 创建临时密码参数
- * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
- */
-export const createTemporaryPassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.temppwd.create`,
-    version: "8.0",
-    data: params
-  });
+export const createTemporaryPassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.temppwd.create`,
+        version: "8.0",
+        data: params,
+    });
 };
-/**
- * 临时密码参数检验
- * @param {ValidateTempPwdProps} params - 临时密码验证参数
- * @returns {Promise<{ valid: boolean; errorCode?: number }>} - 验证结果的 Promise
- */
-export const validateTempPwd = async params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.temppwd.validate`,
-    version: "3.0",
-    data: params
-  });
+export const validateTempPwd = async (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.temppwd.validate`,
+        version: "3.0",
+        data: params,
+    });
 };
-/**
- * 更新临时密码相关的信息
- * @param {UpdateTempPasswordParams} params - 更新临时密码参数
- * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
- */
-export const updateTemporaryPassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.temppwd.update`,
-    version: "4.0",
-    data: params
-  });
+export const updateTemporaryPassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.temppwd.update`,
+        version: "4.0",
+        data: params,
+    });
 };
-export const getTempPassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.temppwd.detail`,
-    version: "1.0",
-    data: params
-  });
+export const getTempPassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.temppwd.detail`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const deleteTempPassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.temppwd.remove`,
-    version: "2.0",
-    data: params
-  });
+export const deleteTempPassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.temppwd.remove`,
+        version: "2.0",
+        data: params,
+    });
 };
-/**
- * 获取离线临时密码
- * @param {CreateOfflinePasswordParams} params - 请求参数
- * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
- */
-export const createOfflinePassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.offlinepwd.get`,
-    version: "3.0",
-    data: params
-  });
+export const createOfflinePassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.offlinepwd.get`,
+        version: "3.0",
+        data: params,
+    });
 };
-/**
- * 获取动态密码
- * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
- * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
- */
-export const getDynamicPassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.dynapwd.get`,
-    version: "3.0",
-    data: params
-  });
+export const getDynamicPassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.dynapwd.get`,
+        version: "3.0",
+        data: params,
+    });
 };
-/**
- * 删除离线临时密码
- * @param {RevokeOfflinePasswordParams} params - 请求参数
- * @returns {Promise<string>} - 响应结果的 Promise
- */
-export const revokeOfflinePassword = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.offlinepwd.revoke`,
-    version: "2.0",
-    data: params
-  });
+export const revokeOfflinePassword = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.offlinepwd.revoke`,
+        version: "2.0",
+        data: params,
+    });
 };
-export const fetchEffectiveList = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.auth.list`,
-    version: "1.0",
-    data: params
-  });
+export const fetchEffectiveList = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.auth.list`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const fetchInvalidList = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.auth.list.invalid`,
-    version: "1.0",
-    data: params
-  });
+export const fetchInvalidList = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.auth.list.invalid`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const clearInvalidTempList = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.auth.list.clear`,
-    version: "1.0",
-    data: params
-  });
+export const clearInvalidTempList = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.auth.list.clear`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const reNameTemporary = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.temppwd.name`,
-    version: "1.0",
-    data: params
-  });
+export const reNameTemporary = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.temppwd.name`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const reNameOffline = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.offlinepwd.name.update`,
-    version: "2.0",
-    data: params
-  });
+export const reNameOffline = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.offlinepwd.name.update`,
+        version: "2.0",
+        data: params,
+    });
+};
+export const getSyncTempPasswords = (params) => {
+    return requestCloud({
+        api: "m.lock.device.lock.tempwd.sync",
+        version: "1.0",
+        data: params,
+    });
 };
-export const getSyncTempPasswords = params => {
-  return requestCloud({
-    api: "m.lock.device.lock.tempwd.sync",
-    version: "1.0",
-    data: params
-  });
-};

package/lib/api/user.d.ts

@@ -1,9 +1,4 @@
 import { CurrentUser } from "../interface";
-/**
- * 获取当前登录用户信息
- * @param deviceId
- * @returns
- */
 export declare const getCurrentUserInfo: (deviceId: string) => Promise<CurrentUser>;
 interface UserTimeScheduleParams {
     devId: string;
@@ -26,14 +21,17 @@ interface AddNormalUserParams {
     devId: string;
     name: string;
 }
-export declare const addNormalUser: (params: AddNormalUserParams) => Promise<unknown>;
+export interface AddNormalUserResponse {
+    userId: string;
+}
+export declare const addNormalUser: (params: AddNormalUserParams) => Promise<AddNormalUserResponse>;
 interface RemoveNormalUserParams {
     devId: string;
     userId: string;
     shouldDeleteUnlockInfo: boolean;
     issueDp: boolean;
 }
-export declare const removeNormalUser: (params: RemoveNormalUserParams) => Promise<unknown>;
+export declare const removeNormalUser: (params: RemoveNormalUserParams) => Promise<void>;
 interface getUserListParams {
     devId: string;
     dpCodes: string;
@@ -42,41 +40,17 @@ interface getUserListParams {
     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;
@@ -85,25 +59,10 @@ export interface UserListItem {
             workingDay: number;
         }[];
     };
-    /**
-     * 开锁方式列表
-     */
     unlockDetail: {
-        /**
-         * 本类开锁方式的数量
-         */
         count: number;
-        /**
-         * 对应的开锁方式dp code
-         */
         dpCode: string;
-        /**
-         * 对应的开锁方式dp id
-         */
         dpId: number;
-        /**
-         * 本类开锁方式详细列表
-         */
         unlockList: {
             unlockId: string;
             opModeId: number;
@@ -114,18 +73,10 @@ export interface UserListItem {
             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[];

package/lib/api/user.js

@@ -1,59 +1,47 @@
 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 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 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 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
-  });
+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
-  });
+export const getUserList = (params) => {
+    return requestCloud({
+        api: "m.lock.member.family.panel.all.list",
+        version: "1.0",
+        data: params,
+    });
+};
+export const getUserDetail = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.member.detail`,
+        version: "4.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

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

package/lib/api/video.js

@@ -1,17 +1,11 @@
 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
-    }
-  });
-};
+export const getRotateInfo = (deviceId) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.media.rotate.get`,
+        version: "1.0",
+        data: {
+            devId: deviceId,
+        },
+    });
+};