@ray-js/lock-sdk 1.0.1 → 1.0.2

package/lib/api/index.js

@@ -1,18 +1,16 @@
 import { THING } from "../utils/constant";
 import { requestCloud } from "../utils/device";
-export const sendPhoneVerifyCode = params => {
-  return requestCloud({
-    api: `${THING}.m.device.user.verifycode.send`,
-    version: "1.0",
-    data: params
-  });
+export const sendPhoneVerifyCode = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.user.verifycode.send`,
+        version: "1.0",
+        data: params,
+    });
+};
+export const getActiveTime = (devId) => {
+    return requestCloud({
+        api: `${THING}.m.device.active.date`,
+        version: "1.0",
+        data: { devId },
+    });
 };
-export const getActiveTime = devId => {
-  return requestCloud({
-    api: `${THING}.m.device.active.date`,
-    version: "1.0",
-    data: {
-      devId
-    }
-  });
-};

package/lib/api/linkage.d.ts

@@ -93,11 +93,6 @@ export interface LinkageRule {
         subMatchType: number;
     };
 }
-/**
- * 获取所有的联动规则
- * @param deviceId
- * @returns {Promise<LinkageList>}
- */
 export declare const getLinkageList: (deviceId: string, homeId: string) => Promise<LinkageRule[]>;
 interface LinkageCondition {
     entityType: number;
@@ -140,22 +135,9 @@ interface SaveLinkageParams {
         actions: LinkageAction[];
     }[];
 }
-/**
- * 保存联动规则
- * @param data
- * @returns
- */
 export declare const saveLinkage: (data: SaveLinkageParams, homeId: string) => Promise<unknown>;
 export declare const enableLinkage: (ruleId: string, homeId: string) => Promise<unknown>;
 export declare const disableLinkage: (ruleId: string, homeId: string) => Promise<unknown>;
-/**
- * 获取剩余短信通知次数
- * @returns
- */
 export declare const getRemainingMessage: (homeId: string) => Promise<number>;
-/**
- * 获取剩余语音通知次数
- * @returns
- */
 export declare const getRemainingPhone: (homeId: string) => Promise<number>;
 export {};

package/lib/api/linkage.js

@@ -1,92 +1,72 @@
 import { THING } from "../utils/constant";
 import { requestCloud } from "../utils/device";
-/**
- * 获取所有的联动规则
- * @param deviceId
- * @returns {Promise<LinkageList>}
- */
 export const getLinkageList = (deviceId, homeId) => {
-  return requestCloud({
-    api: `${THING}.m.linkage.doorlock.rule.query`,
-    version: "2.0",
-    data: {
-      devId: deviceId
-    },
-    extData: {
-      gid: homeId
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.linkage.doorlock.rule.query`,
+        version: "2.0",
+        data: {
+            devId: deviceId,
+        },
+        extData: {
+            gid: homeId,
+        },
+    });
 };
-/**
- * 保存联动规则
- * @param data
- * @returns
- */
 export const saveLinkage = (data, homeId) => {
-  return requestCloud({
-    api: `${THING}.m.linkage.device.shell.save`,
-    version: "2.0",
-    data: {
-      shellExpr: data
-    },
-    extData: {
-      gid: homeId
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.linkage.device.shell.save`,
+        version: "2.0",
+        data: {
+            shellExpr: data,
+        },
+        extData: {
+            gid: homeId,
+        },
+    });
 };
 export const enableLinkage = (ruleId, homeId) => {
-  return requestCloud({
-    api: `${THING}.m.linkage.rule.enable`,
-    version: "1.0",
-    data: {
-      ruleId
-    },
-    extData: {
-      gid: homeId
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.linkage.rule.enable`,
+        version: "1.0",
+        data: {
+            ruleId,
+        },
+        extData: {
+            gid: homeId,
+        },
+    });
 };
 export const disableLinkage = (ruleId, homeId) => {
-  return requestCloud({
-    api: `${THING}.m.linkage.rule.disable`,
-    version: "1.0",
-    data: {
-      ruleId
-    },
-    extData: {
-      gid: homeId
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.linkage.rule.disable`,
+        version: "1.0",
+        data: {
+            ruleId,
+        },
+        extData: {
+            gid: homeId,
+        },
+    });
 };
-
-/**
- * 获取剩余短信通知次数
- * @returns
- */
-export const getRemainingMessage = homeId => {
-  return requestCloud({
-    api: `${THING}.m.notification.subscribe.info`,
-    version: "1.0",
-    data: {
-      notificationType: "sms_notification"
-    },
-    extData: {
-      gid: homeId
-    }
-  });
+export const getRemainingMessage = (homeId) => {
+    return requestCloud({
+        api: `${THING}.m.notification.subscribe.info`,
+        version: "1.0",
+        data: {
+            notificationType: "sms_notification",
+        },
+        extData: {
+            gid: homeId,
+        },
+    });
+};
+export const getRemainingPhone = (homeId) => {
+    return requestCloud({
+        api: `${THING}.m.mobile.voice.times.count`,
+        version: "1.0",
+        data: {},
+        extData: {
+            gid: homeId,
+        },
+    });
 };
-
-/**
- * 获取剩余语音通知次数
- * @returns
- */
-export const getRemainingPhone = homeId => {
-  return requestCloud({
-    api: `${THING}.m.mobile.voice.times.count`,
-    version: "1.0",
-    data: {},
-    extData: {
-      gid: homeId
-    }
-  });
-};

package/lib/api/lock.d.ts

@@ -1,19 +1,9 @@
-/**
- * 直接通过云端开关锁
- * @param params
- * @returns
- */
 export declare const openDoorByCloud: (deviceId: string, isOpen: boolean) => Promise<unknown>;
 export declare const checkRemoteKey: (deviceId: string) => Promise<{
     effectiveTime: number;
     invalidTime: number;
     password: string;
 }>;
-/**
- * 获取开锁密钥
- * @param deviceId
- * @returns
- */
 export declare const getDoorKey: (deviceId: string) => Promise<{
     effectiveTime: number;
     invalidTime: number;
@@ -24,80 +14,26 @@ interface UnlockMethodDetailParams {
     opModeId: number;
 }
 interface NotifyInfo {
-    /**
-     * 是否开启 App 消息通知
-     */
     appSend?: boolean;
-    /**
-     * 短信通知手机号，有手机号时，表示开启短信通知
-     */
     msgPhone?: string;
-    /**
-     * 短信通知国家码
-     */
     countryCode?: string;
-    /**
-     * 目标用户 id
-     */
     targetUserId?: number;
 }
-/**
- * 开锁方式详细信息
- */
 interface UnlockMethodDetail {
-    /**
-     * 是否为云端绑定的开锁方式
-     */
     allocateFlag: number;
-    /**
-     * 开锁方式状态
-     */
     phase: number;
-    /**
-     * 开锁方式对应的 dp id
-     */
     opmode: string;
-    /**
-     * 是否为特殊开锁方式
-     */
     unlockAttr: number;
-    /**
-     * 开锁方式名称
-     */
     unlockName: string;
-    /**
-     * 所属用户 id
-     */
     userId: string;
-    /**
-     * 开锁方式硬件id
-     */
     opmodeValue: string;
-    /**
-     * 开锁方式 id
-     */
     unlockId: string;
-    /**
-     * 锁端用户 id
-     */
     lockUserId: number;
-    /**
-     * 开锁方式硬件 id
-     */
     opmodeId: string;
     voiceAttr: number;
-    /**
-     * 时效配置
-     */
     userTimeSet: string;
-    /**
-     * 用户类型
-     */
     userType: number;
     sourceAttribute: number;
-    /**
-     * 开锁消息通知配置
-     */
     notifyInfo?: NotifyInfo;
 }
 export declare const getUnlockMethodInfo: (params: UnlockMethodDetailParams) => Promise<UnlockMethodDetail>;
@@ -141,11 +77,6 @@ interface RemoveUnlockMethodParams {
     devId: string;
     opmodeId: number;
 }
-/**
- *  删除解锁方式
- * @param  {RemoveUnlockMethodParams} params
- * @returns
- */
 export declare const removeUnlockMethod: (params: RemoveUnlockMethodParams) => Promise<unknown>;
 interface FetchSyncUnlockMethodInfoParams {
     devId: string;

package/lib/api/lock.js

@@ -1,129 +1,107 @@
 import { THING } from "../utils/constant";
 import { requestCloud } from "../utils/device";
-
-/**
- * 直接通过云端开关锁
- * @param params
- * @returns
- */
 export const openDoorByCloud = (deviceId, isOpen) => {
-  return requestCloud({
-    api: `${THING}.m.zigbee.lock.remotepwd.execute`,
-    version: "1.0",
-    data: {
-      devId: deviceId,
-      open: isOpen
-    }
-  });
+    return requestCloud({
+        api: `${THING}.m.zigbee.lock.remotepwd.execute`,
+        version: "1.0",
+        data: {
+            devId: deviceId,
+            open: isOpen,
+        },
+    });
 };
-export const checkRemoteKey = async deviceId => {
-  return requestCloud({
-    api: "m.lock.ble.remote.unlock.check",
-    version: "1.0",
-    data: {
-      devId: deviceId
-    }
-  });
+export const checkRemoteKey = async (deviceId) => {
+    return requestCloud({
+        api: "m.lock.ble.remote.unlock.check",
+        version: "1.0",
+        data: {
+            devId: deviceId,
+        },
+    });
 };
-
-/**
- * 获取开锁密钥
- * @param deviceId
- * @returns
- */
-export const getDoorKey = deviceId => {
-  return requestCloud({
-    api: "m.lock.ble.remote.unlock.get",
-    version: "1.0",
-    data: {
-      devId: deviceId
-    }
-  });
+export const getDoorKey = (deviceId) => {
+    return requestCloud({
+        api: "m.lock.ble.remote.unlock.get",
+        version: "1.0",
+        data: {
+            devId: deviceId,
+        },
+    });
 };
-
-/**
- * 开锁方式详细信息
- */
-
-export const getUnlockMethodInfo = params => {
-  return requestCloud({
-    api: `${THING}.m.device.member.opmode.detail`,
-    version: "1.0",
-    data: params
-  });
+export const getUnlockMethodInfo = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.member.opmode.detail`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const fetchCreatePasswordSN = params => {
-  return requestCloud({
-    api: `${THING}.m.device.dp.sn.get`,
-    version: "1.0",
-    data: params
-  });
+export const fetchCreatePasswordSN = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.dp.sn.get`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const createUnlockMethod = params => {
-  return requestCloud({
-    api: `${THING}.m.device.member.opmode.add`,
-    version: "5.0",
-    data: params
-  });
+export const createUnlockMethod = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.member.opmode.add`,
+        version: "5.0",
+        data: params,
+    });
 };
-export const editUnlockMethod = params => {
-  return requestCloud({
-    api: `${THING}.m.device.member.opmode.update`,
-    version: "5.0",
-    data: params
-  });
+export const editUnlockMethod = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.member.opmode.update`,
+        version: "5.0",
+        data: params,
+    });
 };
-/**
- *  删除解锁方式
- * @param  {RemoveUnlockMethodParams} params
- * @returns
- */
-export const removeUnlockMethod = params => {
-  return requestCloud({
-    api: `${THING}.m.device.member.opmode.remove`,
-    version: "2.0",
-    data: params
-  });
+export const removeUnlockMethod = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.member.opmode.remove`,
+        version: "2.0",
+        data: params,
+    });
 };
-export const fetchSyncUnlockMethodInfo = params => {
-  return requestCloud({
-    api: `${THING}.m.device.opmode.sync.rise`,
-    version: "2.0",
-    data: params
-  });
+export const fetchSyncUnlockMethodInfo = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.opmode.sync.rise`,
+        version: "2.0",
+        data: params,
+    });
 };
-export const checkFreeUnlockMethods = params => {
-  return requestCloud({
-    api: `${THING}.m.device.unlock.waitassign`,
-    version: "1.0",
-    data: params
-  });
+export const checkFreeUnlockMethods = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.unlock.waitassign`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const fetchFreeUnlockMethods = params => {
-  return requestCloud({
-    api: `${THING}.m.device.unlock.assignlist`,
-    version: "1.0",
-    data: params
-  });
+export const fetchFreeUnlockMethods = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.unlock.assignlist`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const bindUnlockMethodToUser = params => {
-  return requestCloud({
-    api: `${THING}.m.device.user.unlock.allocate`,
-    version: "1.0",
-    data: params
-  });
+export const bindUnlockMethodToUser = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.user.unlock.allocate`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const unbindMemberUnlockMethod = params => {
-  return requestCloud({
-    api: `${THING}.m.device.user.unlock.unbind`,
-    version: "1.0",
-    data: params
-  });
+export const unbindMemberUnlockMethod = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.user.unlock.unbind`,
+        version: "1.0",
+        data: params,
+    });
+};
+export const bindUnlockMethodToUserByRecord = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.user.unlock.bind`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const bindUnlockMethodToUserByRecord = params => {
-  return requestCloud({
-    api: `${THING}.m.device.user.unlock.bind`,
-    version: "1.0",
-    data: params
-  });
-};

package/lib/api/log.d.ts

@@ -96,9 +96,6 @@ interface GetAlbumMessagesParams {
     endTime: number;
 }
 interface AlbumItem {
-    /**
-     * AI 检测结果
-     */
     aiDetectResults: {
         bizId: number;
         aiType: number;
@@ -107,45 +104,15 @@ interface AlbumItem {
         happenTime: number;
         missStep: boolean;
     }[];
-    /**
-     *  AI 检测结果类型
-     */
     aiTypes: number[];
-    /**
-     * 消息描述
-     */
     describe: string;
-    /**
-     * 消息类型
-     */
     eventType: number;
-    /**
-     * 上传时间，单位毫秒
-     */
     uploadMilTime: number;
-    /**
-     * 媒体路径
-     */
     mediaPath: string;
-    /**
-     * 图片 id
-     */
     fileId: string;
-    /**
-     * 图片 key
-     */
     fileKey: string;
-    /**
-     * 图片 url
-     */
     fileUrl: string;
-    /**
-     * 媒体桶
-     */
     mediaBucket: string;
-    /**
-     * 媒体 key
-     */
     mediaKey: string;
 }
 export declare const getAlbumMessages: (params: GetAlbumMessagesParams) => Promise<{

package/lib/api/log.js

@@ -1,44 +1,39 @@
 import { THING } from "../utils/constant";
 import { requestCloud } from "../utils/device";
-/*
- * 获取最近两条数据
- * @devId 设备id
- * @returns {Promise<ResLatestLog>}
- */
-export const getLatest2Log = devId => {
-  return requestCloud({
-    api: "m.lock.log.latest2",
-    version: "1.0",
-    data: {
-      devId
-    }
-  });
+export const getLatest2Log = (devId) => {
+    return requestCloud({
+        api: "m.lock.log.latest2",
+        version: "1.0",
+        data: {
+            devId,
+        },
+    });
 };
-export const getRecordList = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.history.list`,
-    version: "1.0",
-    data: params
-  });
+export const getRecordList = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.history.list`,
+        version: "1.0",
+        data: params,
+    });
 };
-export const getAlarmList = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.alarm.list`,
-    version: "3.0",
-    data: params
-  });
+export const getAlarmList = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.alarm.list`,
+        version: "3.0",
+        data: params,
+    });
 };
-export const getAlbumMessages = params => {
-  return requestCloud({
-    api: "m.lock.album.media.list",
-    version: "3.0",
-    data: params
-  });
+export const getAlbumMessages = (params) => {
+    return requestCloud({
+        api: "m.lock.album.media.list",
+        version: "3.0",
+        data: params,
+    });
+};
+export const getMediaUrl = (params) => {
+    return requestCloud({
+        api: `${THING}.m.device.lock.media.path`,
+        version: "2.0",
+        data: params,
+    });
 };
-export const getMediaUrl = params => {
-  return requestCloud({
-    api: `${THING}.m.device.lock.media.path`,
-    version: "2.0",
-    data: params
-  });
-};