@ray-js/lock-sdk 1.0.1 → 1.0.3-beta-1

package/lib/utils/errors.js

@@ -1,127 +1,80 @@
 const errors = {
-  // 设备离线
-  1001: "Device offline",
-  // 操作超时
-  1002: "Operation timeout",
-  // 远程开锁失败
-  1003: "Remote unlocking failure",
-  // 设备报告远程开锁失败
-  1004: "Device reports that remote unlocking failed",
-  // 远程开锁失效
-  1005: "Remote unlocking failure",
-  // 秘钥次数使用完
-  1006: "Secret key times has been used up",
-  // 秘钥不在有效期内
-  1007: "Secret key is not valid",
-  // 秘钥比对错误
-  1008: "Secret key is wrong",
-  // 缺少必要属性
-  1009: "Missing required attribute: {0}",
-  // 生效起始时间不能大于生效结束时间
-  1010: "The effective time cannot be greater than the valid time",
-  // 更新设备侧成员时效失败
-  1011: "Failed to update device side member validity",
-  // 更新成员时效失败
-  1012: "Failed to update member validity",
-  // App不支持该功能
-  1013: "App not support the function",
-  // 设备不支持该功能
-  1014: "Device does not support the function",
-  1015: "Timeout when entering unlocking method",
-  1016: "Failed to enter unlocking method",
-  1017: "Repeated entry when entering unlocking method",
-  1018: "Hardware ID allocation completed when entering unlocking method",
-  1019: "Error in adding password, field is non-numeric (backup)",
-  1020: "Error in adding password, password length",
-  1021: "Unsupported unlocking method type",
-  1022: "Currently entering fingerprint",
-  1023: "Currently binding door card",
-  1024: "Currently binding face",
-  1025: "Password is too simple",
-  1026: "Parameter error, such as repeated message sequence number",
-  1027: "Start add Unlock method failure",
-  // 删除失败
-  1028: "Delete failed",
-  // 硬件 ID 不能删除
-  1029: "Hardware ID cannot be deleted",
-  // 仅支持数字密码
-  1030: "Only numeric passwords are supported",
-  // 密码名称长度不能大于20个字符
-  1031: "Password name length cannot exceed 20 characters",
-  // 未配置时效
-  1032: "Validity not configured",
-  // 未配置时效生效日期
-  1033: "Validity start date not configured",
-  // 未配置时效失效日期
-  1034: "Validity end date not configured",
-  // 时效配置周重复时未设置周配置
-  1035: "Weekly repeat validity configuration not set",
-  // 时效配置月重复时未设置天配置
-  1036: "Monthly repeat validity configuration not set",
-  // 密码已存在
-  1037: "Password already exists",
-  // 密码名称重复
-  1038: "Password name is duplicated",
-  // 密码生效时间与结束时间不正确
-  1039: "Password effective time and end time are incorrect",
-  // 临时密码 id 不存在
-  1040: "Temporary password ID does not exist",
-  // 设备无硬件 ID 可用
-  1041: "Device has no hardware ID available",
-  // 添加临时密码失败
-  1042: "Failed to add temporary password",
-  // 临时密码添加失败，未获取到云端预分配的编号
-  1043: "Temporary password addition failed, pre-allocated number not obtained from cloud",
-  // 清空单个密码时，缺少传入 unlockBindingId
-  1044: "When clearing a single password, missing unlockBindingId",
-  // 功能不支持
-  1045: "Function not supported",
-  // 远程开关门未开启
-  1046: "Remote door opening and closing function is not enabled",
-  // 无权限远程开关门
-  1047: "Remote door opening and closing without permission",
-  // 无此用户
-  1048: "No such user",
-  // 不支持修改管理员时效
-  1049: "Does not support modifying administrator validity period",
-  // 开锁方式未存在绑定关系
-  1050: "Unlock method does not have a binding relationship",
-  // 无效数据
-  1051: "Invalid data",
-  // 操作正式执行，请稍后
-  1052: "Operation is being executed, please wait",
-  // 同步添加云端开锁方式失败
-  1053: "Failed to synchronize and add cloud unlocking method",
-  // 密码不能为空
-  1054: "Password cannot be empty",
-  // 特殊开锁方式使用短信通知时，验证码不能为空
-  1055: "Verification code cannot be empty",
-  // 特殊开锁方式使用短信通知时，国家码不能为空
-  1056: "Country code cannot be empty",
-  // 特殊开锁方式 app 消息通知必须开启
-  1057: "Special unlock method app message notification must be enabled",
-  // 特殊开锁方式 app 消息或手机短信必须开启一个
-  1058: "Special unlock method app message notification or phone SMS must be enabled",
-  // 门铃通知服务未开通
-  1059: "Doorbell notification service not enabled",
-  // 不支持添加普通成员
-  1060: "Does not support adding normal members"
+    1001: "Device offline",
+    1002: "Operation timeout",
+    1003: "Remote unlocking failure",
+    1004: "Device reports that remote unlocking failed",
+    1005: "Remote unlocking failure",
+    1006: "Secret key times has been used up",
+    1007: "Secret key is not valid",
+    1008: "Secret key is wrong",
+    1009: "Missing required attribute: {0}",
+    1010: "The effective time cannot be greater than the valid time",
+    1011: "Failed to update device side member validity",
+    1012: "Failed to update member validity",
+    1013: "App not support the function",
+    1014: "Device does not support the function",
+    1015: "Timeout when entering unlocking method",
+    1016: "Failed to enter unlocking method",
+    1017: "Repeated entry when entering unlocking method",
+    1018: "Hardware ID allocation completed when entering unlocking method",
+    1019: "Error in adding password, field is non-numeric (backup)",
+    1020: "Error in adding password, password length",
+    1021: "Unsupported unlocking method type",
+    1022: "Currently entering fingerprint",
+    1023: "Currently binding door card",
+    1024: "Currently binding face",
+    1025: "Password is too simple",
+    1026: "Parameter error, such as repeated message sequence number",
+    1027: "Start add Unlock method failure",
+    1028: "Delete failed",
+    1029: "Hardware ID cannot be deleted",
+    1030: "Only numeric passwords are supported",
+    1031: "Password name length cannot exceed 20 characters",
+    1032: "Validity not configured",
+    1033: "Validity start date not configured",
+    1034: "Validity end date not configured",
+    1035: "Weekly repeat validity configuration not set",
+    1036: "Monthly repeat validity configuration not set",
+    1037: "Password already exists",
+    1038: "Password name is duplicated",
+    1039: "Password effective time and end time are incorrect",
+    1040: "Temporary password ID does not exist",
+    1041: "Device has no hardware ID available",
+    1042: "Failed to add temporary password",
+    1043: "Temporary password addition failed, pre-allocated number not obtained from cloud",
+    1044: "When clearing a single password, missing unlockBindingId",
+    1045: "Function not supported",
+    1046: "Remote door opening and closing function is not enabled",
+    1047: "Remote door opening and closing without permission",
+    1048: "No such user",
+    1049: "Does not support modifying administrator validity period",
+    1050: "Unlock method does not have a binding relationship",
+    1051: "Invalid data",
+    1052: "Operation is being executed, please wait",
+    1053: "Failed to synchronize and add cloud unlocking method",
+    1054: "Password cannot be empty",
+    1055: "Verification code cannot be empty",
+    1056: "Country code cannot be empty",
+    1057: "Special unlock method app message notification must be enabled",
+    1058: "Special unlock method app message notification or phone SMS must be enabled",
+    1059: "Doorbell notification service not enabled",
+    1060: "Does not support adding normal members",
 };
-export const getError = function (code) {
-  if (errors[code]) {
-    let desc = errors[code];
-    if ((arguments.length <= 1 ? 0 : arguments.length - 1) > 0) {
-      for (let i = 0; i < (arguments.length <= 1 ? 0 : arguments.length - 1); i++) {
-        desc = desc.replace(`{${i}}`, i + 1 < 1 || arguments.length <= i + 1 ? undefined : arguments[i + 1]);
-      }
+export const getError = (code, ...places) => {
+    if (errors[code]) {
+        let desc = errors[code];
+        if (places.length > 0) {
+            for (let i = 0; i < places.length; i++) {
+                desc = desc.replace(`{${i}}`, places[i]);
+            }
+        }
+        return {
+            errorCode: code,
+            errorMsg: desc,
+        };
     }
     return {
-      errorCode: code,
-      errorMsg: desc
+        errorCode: code,
+        errorMsg: "unknow error",
     };
-  }
-  return {
-    errorCode: code,
-    errorMsg: "unknow error"
-  };
-};
+};

package/lib/utils/event.js

@@ -1,144 +1,88 @@
-import "core-js/modules/esnext.iterator.constructor.js";
-import "core-js/modules/esnext.iterator.for-each.js";
-import "core-js/modules/esnext.iterator.some.js";
 function createEmitter() {
-  let listeners = {};
-  let cachedEvents = {};
-  function addEvent(type, cb, emitType) {
-    if (!listeners[type]) {
-      listeners[type] = [];
+    let listeners = {};
+    let cachedEvents = {};
+    function addEvent(type, cb, emitType) {
+        if (!listeners[type]) {
+            listeners[type] = [];
+        }
+        const index = listeners[type].findIndex((item) => item.cb === cb);
+        if (index === -1) {
+            listeners[type].push({
+                type: emitType,
+                cb,
+            });
+        }
+        else {
+            if (listeners[type][index].type !== emitType) {
+                listeners[type][index].type = emitType;
+            }
+        }
+    }
+    function on(type, cb) {
+        addEvent(type, cb, "on");
+        if (cachedEvents[type] && cachedEvents[type].length > 0) {
+            cachedEvents[type].forEach((data) => {
+                emit(type, data);
+            });
+            clearCache(type);
+        }
     }
-    // 确认一个事件只注册一次
-    const index = listeners[type].findIndex(item => item.cb === cb);
-    if (index === -1) {
-      listeners[type].push({
-        type: emitType,
-        cb
-      });
-    } else {
-      // 执行类型是否变更
-      if (listeners[type][index].type !== emitType) {
-        listeners[type][index].type = emitType;
-      }
+    function once(type, cb) {
+        addEvent(type, cb, "once");
     }
-  }
-
-  /**
-   * 注册事件监听
-   * @param type
-   * @param cb
-   */
-
-  /**
-   * 注册事件监听
-   * 事件只会执行一次
-   * @param type
-   * @param cb
-   */
-
-  /**
-   * 是否有事件监听
-   * @param type
-   * @returns
-   */
-  function hasListener(type) {
-    return !!listeners[type] && listeners[type].length > 0;
-  }
-
-  /**
-   * 缓存事件，当有监听器时直接执行
-   * 事件会被缓存，直到有监听器时才会执行
-   * @param type
-   */
-
-  /**
-   * 清除缓存事件
-   * @param type
-   */
-  function clearCache(type) {
-    cachedEvents[type] = [];
-  }
-
-  /**
-   * 移除事件监听
-   * @param type
-   * @param cb
-   * @returns
-   */
-  function off(type, cb) {
-    if (!listeners[type]) {
-      return;
+    function hasListener(type) {
+        return !!listeners[type] && listeners[type].length > 0;
     }
-    listeners[type].some((item, i) => {
-      if (item.cb === cb) {
-        listeners[type].splice(i, 1);
-        return true;
-      }
-      return false;
-    });
-  }
-
-  /**
-   * 执行事件
-   * @param type
-   * @param data
-   */
-  function emit(type, data) {
-    if (listeners[type]) {
-      // 取得事件列表的副本进行操作，以保证所有事件被执行
-      const list = [...listeners[type]];
-      const count = list.length;
-      for (let i = 0; i < count; i++) {
-        const {
-          cb,
-          type: cbType
-        } = list[i];
-        if (cbType === "once") {
-          listeners[type].splice(i, 1);
+    function cache(type, data) {
+        cachedEvents[type] = cachedEvents[type] || [];
+        cachedEvents[type].push(data);
+    }
+    function clearCache(type) {
+        cachedEvents[type] = [];
+    }
+    function off(type, cb) {
+        if (!listeners[type]) {
+            return;
         }
-        try {
-          cb(data);
-        } catch (e) {
-          // 监听事件执行不影响同步任务
-          console.warn(e);
+        listeners[type].some((item, i) => {
+            if (item.cb === cb) {
+                listeners[type].splice(i, 1);
+                return true;
+            }
+            return false;
+        });
+    }
+    function emit(type, data) {
+        if (listeners[type]) {
+            const list = [...listeners[type]];
+            const count = list.length;
+            for (let i = 0; i < count; i++) {
+                const { cb, type: cbType } = list[i];
+                if (cbType === "once") {
+                    listeners[type].splice(i, 1);
+                }
+                try {
+                    cb(data);
+                }
+                catch (e) {
+                    console.warn(e);
+                }
+            }
         }
-      }
     }
-  }
-
-  /**
-   * 清除事件监听
-   */
-
-  return {
-    on: function on(type, cb) {
-      addEvent(type, cb, "on");
-
-      // 是否有缓存事件数据
-      if (cachedEvents[type] && cachedEvents[type].length > 0) {
-        // 执行缓存事件
-        cachedEvents[type].forEach(data => {
-          emit(type, data);
-        });
-        // 清除缓存事件
-        clearCache(type);
-      }
-    },
-    off,
-    once: function once(type, cb) {
-      addEvent(type, cb, "once");
-    },
-    emit,
-    clear: () => {
-      listeners = {};
-    },
-    hasListener,
-    cache: function cache(type, data) {
-      cachedEvents[type] = cachedEvents[type] || [];
-      cachedEvents[type].push(data);
-    },
-    clearCache
-  };
+    const clear = () => {
+        listeners = {};
+    };
+    return {
+        on,
+        off,
+        once,
+        emit,
+        clear,
+        hasListener,
+        cache,
+        clearCache,
+    };
 }
 export { createEmitter };
-export default createEmitter();
+export default createEmitter();

package/lib/utils/hex-to-base64.js

@@ -1,8 +1,8 @@
 import { Base64 } from 'js-base64';
 import hexToBytes from './hex-to-bytes';
 export default function hexToBase64(value) {
-  if (!value) {
-    return '';
-  }
-  return Base64.fromUint8Array(hexToBytes(value));
-}
+    if (!value) {
+        return '';
+    }
+    return Base64.fromUint8Array(hexToBytes(value));
+}

package/lib/utils/hex-to-bytes.d.ts

@@ -1,6 +1 @@
-/**
- * 将 hex 字符串转为字节数据
- * @param value
- * @returns
- */
 export default function hexToBytes(value: string): Uint8Array<ArrayBuffer>;

package/lib/utils/hex-to-bytes.js

@@ -1,16 +1,11 @@
-/**
- * 将 hex 字符串转为字节数据
- * @param value
- * @returns
- */
 export default function hexToBytes(value) {
-  if (value.length % 2 !== 0) {
-    throw new Error('hex length error');
-  }
-  const len = value.length / 2;
-  const data = new Uint8Array(len);
-  for (let i = 0; i < len; i++) {
-    data[i] = parseInt(value.slice(i * 2, i * 2 + 2), 16);
-  }
-  return data;
-}
+    if (value.length % 2 !== 0) {
+        throw new Error('hex length error');
+    }
+    const len = value.length / 2;
+    const data = new Uint8Array(len);
+    for (let i = 0; i < len; i++) {
+        data[i] = parseInt(value.slice(i * 2, i * 2 + 2), 16);
+    }
+    return data;
+}

package/lib/utils/index.d.ts

@@ -1,26 +1,10 @@
 import { UserType } from "../constant";
 import { EffectiveConfig, UnlockMethodConfig, Week } from "../interface";
 import { LoopTypes } from "./constant";
-/**
- * 格式化为24时间格式
- * @param time
- * @returns
- */
 export declare const get24Time: (time: number) => number[];
 export declare const getNowTime: () => number;
-/**
- * 判断设备在线类型
- * @param onlineType 设备的通道在线数据
- * @param type 待检测的通道类型，0为wifi，1为局域网，2为蓝牙，3为Mesh,  4为 beacon
- * @returns
- */
 export declare const isOnlineByType: (onlineType: number, type: number) => boolean;
 export declare function isCapability(capability: number, id: number): boolean;
-/**
- * 获取产品支持的通讯能力
- * @param capability 产品能力值
- * @returns
- */
 export declare function getCapabilities(capability: number): ({
     readonly id: 0;
     readonly name: "wifi";
@@ -104,10 +88,6 @@ export declare function getCapabilities(capability: number): ({
 })[];
 export declare const formatWeek: (value: number[]) => number;
 export declare const parseWeek: (value: number) => Week;
-/**
- * 获取一个永久生效的设置
- * @returns
- */
 export declare const getPermanentSetting: () => {
     startTime: number;
     endTime: number;
@@ -122,36 +102,14 @@ export declare const getPermanentSetting: () => {
 };
 export declare const isAdmin: (userType: UserType) => boolean;
 export declare const validateEffectiveConfig: (effective?: EffectiveConfig) => void;
-/**
- * 是否使用近场通道，一般为蓝牙
- * @returns
- */
 export declare const isUseNearChannel: () => boolean;
 export declare const parseOfflinePassword: (value: string) => string;
-/**
- * 格式化时间戳为毫秒
- * 注意此方法只支持 2010 年之后的时间戳
- * @param timestamp 时间戳
- */
 export declare const formatTimestampToMilliseconds: (timestamp: number) => number;
-/**
- * 开锁方式配置数据
- */
 export declare const unlockMethodConfigs: UnlockMethodConfig[];
 export declare const getUnlockMethodTypeByDpCode: (dpCode: string) => UnlockMethodConfig;
 export declare const getUnlockMethodTypeById: (id: number) => UnlockMethodConfig;
 export declare const getUnlockMethodTypeByType: (type: string) => UnlockMethodConfig;
-/**
- * 针对异常函数，当函数在短时间内被多次调用时，只保留最先一次调用，并统一返回结果
- * @param cb 回调函数
- * @returns
- */
 export declare const parallelMerge: <T extends (...args: any[]) => Promise<any>>(cb: T) => (...args: Parameters<T>) => ReturnType<T>;
-/**
- * 针对异常函数，当函数在短时间内被多次调用时，只允许函数在短时间内执行一次
- * @param cb 回调函数
- * @returns
- */
 export declare const parallelOnly: <T extends (...args: any[]) => Promise<any>>(cb: T) => (...args: Parameters<T>) => ReturnType<T>;
 declare const preFetchKeys: readonly ["getRotate", "getCurrentUser", "getDeviceProperties"];
 type PreFetchKey = (typeof preFetchKeys)[number];