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

package/lib/temporary.js

@@ -0,0 +1,637 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.find.js";
+import "core-js/modules/esnext.iterator.map.js";
+import { clearInvalidTempList, createOfflinePassword, createTemporaryPassword, deleteTempPassword, fetchEffectiveList, fetchInvalidList, getDynamicPassword, reNameOffline, reNameTemporary, revokeOfflinePassword, updateTemporaryPassword, validateTempPwd } from "./api/temp";
+import config from "./config";
+import { formatWeek, isUseNearChannel, parallelOnly, parseOfflinePassword, parseWeek, validateEffectiveConfig } from "./utils";
+import { LoopTypes } from "./utils/constant";
+import { encrypt } from "./utils/device";
+import { getError } from "./utils/errors";
+import { addTempPwd as addTempPwdDpMap, reportAddTempPwd as reportAddTempPwdDpMap } from "./config/dp-map/unlock-method";
+import { addTempPwd as addTempPwdBigDpMap, reportAddTempPwd as reportAddTempPwdDBigpMap } from "./config/dp-map/unlock-method-big";
+import { publishDps } from "./utils/publishDps";
+import dpCodes from "./config/dp-code";
+import dpUtils from "@ray-js/tuya-dp-transform";
+const PASSWORD_REGEX = /^[0-9]+$/;
+const handleError = cloudError => {
+  switch (cloudError.errorCode) {
+    case "USER_PWD_ALREADY_EXIST":
+      throw getError(1037);
+    case "LOCK_PWD_NAME_REPEAT":
+      throw getError(1038);
+    case "START_END_DATE_NOT_RIGHT":
+      throw getError(1039);
+    case "RECORD_NOT_EXIST":
+      throw getError(1040);
+    default:
+      throw cloudError;
+  }
+};
+const isValidPassword = async params => {
+  // 首先验证密码有效性
+  const validateResult = await validateTempPwd(params);
+  if (!validateResult.valid) {
+    handleError(validateResult);
+  }
+  return true;
+};
+
+/**
+ * 创建自定义临时密码
+ * @param {CreateCustomParams} params - 创建临时密码的参数
+ * @returns {Promise<boolean>} - 返回创建结果
+ * @throws {ErrorData} - 如果创建失败，将抛出错误
+ */
+export const createTempCustom = parallelOnly(async params => {
+  var _effective$repeat, _effective$weeks;
+  const {
+    password,
+    name,
+    effective
+  } = params;
+  // 密码的校验，仅做简单的数字校验
+  if (!PASSWORD_REGEX.test(password)) {
+    throw getError(1030);
+  }
+  // 名称的校验，长度不能超过20个字符
+  if (name && name.length > 20) {
+    throw getError(1031);
+  }
+
+  // 时效校验
+  validateEffectiveConfig(effective);
+  const {
+    effectiveTime = 0,
+    expiredTime = 1439
+  } = effective;
+  const useNear = isUseNearChannel();
+  const aesPwd = await encrypt(config.devInfo.devId, password);
+  // 循环方式
+  const loopType = effective !== null && effective !== void 0 && effective.repeat ?
+  // @ts-ignore
+  LoopTypes[effective === null || effective === void 0 || (_effective$repeat = effective.repeat) === null || _effective$repeat === void 0 ? void 0 : _effective$repeat.toUpperCase()] : LoopTypes.NONE;
+  const schedule = [{
+    allDay: loopType === LoopTypes.NONE,
+    effectiveTime,
+    invalidTime: expiredTime,
+    workingDay: formatWeek((_effective$weeks = effective === null || effective === void 0 ? void 0 : effective.weeks) !== null && _effective$weeks !== void 0 ? _effective$weeks : [0])
+  }];
+  const baseData = {
+    devId: config.devInfo.devId,
+    effectiveTime: effective.effectiveDate,
+    invalidTime: effective.expiredDate,
+    name: name,
+    password: aesPwd,
+    schedule
+  };
+  if (useNear) {
+    var _effective$weeks2;
+    // 走蓝牙通道
+    await isValidPassword(baseData);
+    const {
+      tyNum,
+      name
+    } = await createTemporaryPassword(_objectSpread(_objectSpread({}, baseData), {}, {
+      sn: 0,
+      availTime: 0,
+      symbolic: false,
+      dpTunnel: 2
+    }));
+    if (!tyNum) {
+      throw getError(1043);
+    }
+
+    // 下发dp
+    const dpData = {
+      cloudNo: tyNum,
+      valid: true,
+      validConfig: {
+        startTime: effective.effectiveDate,
+        endTime: effective.expiredDate,
+        loop: loopType,
+        loopConfig: 0,
+        weeks: (_effective$weeks2 = effective.weeks) !== null && _effective$weeks2 !== void 0 ? _effective$weeks2 : [0, 0, 0, 0, 0, 0, 0],
+        days: [],
+        startHour: Math.floor(effectiveTime / 60),
+        startMinute: effectiveTime % 60,
+        endHour: Math.floor(expiredTime / 60),
+        endMinute: expiredTime % 60
+      },
+      validNum: 0,
+      pwdLength: params.password.length,
+      pwd: params.password.split("").map(Number)
+    };
+    const targetDpCode = config.supportBigData ? dpCodes.tempPwdCreateW : dpCodes.tempPwdCreate;
+    const result = await publishDps({
+      [targetDpCode]: dpUtils.format(dpData, config.supportBigData ? addTempPwdBigDpMap : addTempPwdDpMap)
+    }, {
+      checkReport: dpData => {
+        const reportData = dpData[targetDpCode];
+        if (reportData) {
+          const data = dpUtils.parse(dpData[targetDpCode], config.supportBigData ? reportAddTempPwdDBigpMap : reportAddTempPwdDpMap);
+          if (data.cloudNo === tyNum) {
+            return data;
+          }
+        }
+        return false;
+      }
+    });
+    if (result.status === 0) {
+      return {
+        type: "custom",
+        name: name,
+        password: password,
+        unlockBindingId: result.unlockBindingId,
+        effectiveConfig: effective
+      };
+    }
+    throw getError(result.status === 2 ? 1041 : 1042);
+  } else {
+    // 走云端
+    try {
+      const res = await createTemporaryPassword(_objectSpread(_objectSpread({}, baseData), {}, {
+        sn: 0,
+        availTime: 0,
+        symbolic: false,
+        dpTunnel: 2
+      }));
+      return {
+        type: "custom",
+        name: res.name,
+        password: password,
+        unlockBindingId: res.unlockBindingId,
+        effectiveConfig: effective
+      };
+    } catch (error) {
+      throw handleError(error);
+    }
+  }
+});
+/**
+ * 删除自定义密码
+ * @param {RemoveCustomProps} params
+ * @returns
+ */
+export const removeTempCustom = async params => {
+  try {
+    return deleteTempPassword({
+      devId: config.devInfo.devId,
+      unlockBindingId: params.unlockBindingId,
+      symbolic: false,
+      dpTunnel: 2
+    });
+  } catch (e) {
+    handleError(e);
+  }
+};
+/**
+ * 更新自定义临时密码
+ * 注意，当前只支持更新名称和时效配置，且只支持走云端更新。
+ * @param {UpdateTempPasswordParams} params 更新临时密码的参数
+ * @returns {Promise<void>} - 返回更新结果
+ * @throws {ErrorData} - 如果更新失败，将抛出错误
+ */
+export const updateTempCustom = async params => {
+  var _effective$repeat2, _effective$effectiveT, _effective$expiredTim, _effective$weeks3;
+  const {
+    unlockBindingId,
+    name,
+    effective
+  } = params;
+
+  // 名称的校验，长度不能超过20个字符
+  if (name && name.length > 20) {
+    throw getError(1031);
+  }
+
+  // 时效校验
+  validateEffectiveConfig(effective);
+  // 循环方式
+  const loopType = effective !== null && effective !== void 0 && effective.repeat ?
+  // @ts-ignore
+  LoopTypes[effective === null || effective === void 0 || (_effective$repeat2 = effective.repeat) === null || _effective$repeat2 === void 0 ? void 0 : _effective$repeat2.toUpperCase()] : LoopTypes.NONE;
+  const schedule = [{
+    allDay: loopType === LoopTypes.NONE,
+    effectiveTime: (_effective$effectiveT = effective === null || effective === void 0 ? void 0 : effective.effectiveTime) !== null && _effective$effectiveT !== void 0 ? _effective$effectiveT : 0,
+    invalidTime: (_effective$expiredTim = effective === null || effective === void 0 ? void 0 : effective.expiredTime) !== null && _effective$expiredTim !== void 0 ? _effective$expiredTim : 0,
+    workingDay: formatWeek((_effective$weeks3 = effective === null || effective === void 0 ? void 0 : effective.weeks) !== null && _effective$weeks3 !== void 0 ? _effective$weeks3 : [0])
+  }];
+  try {
+    return updateTemporaryPassword({
+      devId: config.devInfo.devId,
+      effectiveTime: effective.effectiveDate,
+      invalidTime: effective.expiredDate,
+      name: name,
+      schedule,
+      unlockBindingId,
+      symbolic: false,
+      dpTunnel: 2
+    });
+  } catch (error) {
+    handleError(error);
+  }
+};
+const getOfflinePassword = async params => {
+  try {
+    // 获取密码
+    const res = await createOfflinePassword(params);
+    return _objectSpread(_objectSpread({}, res), {}, {
+      pwd: parseOfflinePassword(res.pwd)
+    });
+  } catch (error) {
+    throw handleError(error);
+  }
+};
+
+/**
+ * 创建临时限时密码
+ */
+export const createTempLimit = async params => {
+  const {
+    name,
+    effectiveTime,
+    invalidTime
+  } = params;
+  // 名称的校验，长度不能超过20个字符
+  if (name && name.length > 20) {
+    throw getError(1031);
+  }
+  // 生效时间校验
+  if (effectiveTime >= invalidTime) {
+    throw getError(1010);
+  }
+  const res = await getOfflinePassword({
+    devId: config.devInfo.devId,
+    pwdType: "0",
+    pwdName: name,
+    gmtStart: effectiveTime,
+    gmtExpired: invalidTime
+  });
+  return {
+    type: "limit",
+    name: res.pwdName,
+    password: parseOfflinePassword(res.pwd),
+    unlockBindingId: res.unlockBindingId,
+    effectiveConfig: {
+      effectiveDate: res.gmtStart,
+      expiredDate: res.gmtExpired
+    }
+  };
+};
+/**
+ * 创建一次性密码
+ * @param {CreateOnceParams} params - 创建一次性密码的参数
+ * @returns {Promise<OfflinePwdResult>} - 返回创建结果
+ * @throws {ErrorData} - 如果创建失败，将抛出错误
+ */
+export const createTempOnce = async params => {
+  const {
+    name
+  } = params;
+  // 名称的校验，长度不能超过20个字符
+  if (name && name.length > 20) {
+    throw getError(1031);
+  }
+  const res = await getOfflinePassword({
+    devId: config.devInfo.devId,
+    pwdType: "1",
+    pwdName: name,
+    gmtStart: 0,
+    gmtExpired: 0
+  });
+  return {
+    type: "once",
+    name: res.pwdName,
+    password: parseOfflinePassword(res.pwd),
+    unlockBindingId: res.unlockBindingId,
+    effectiveConfig: {
+      effectiveDate: res.gmtStart,
+      expiredDate: res.gmtExpired
+    }
+  };
+};
+
+/**
+ * 创建动态密码
+ */
+export const createTempDynamic = async () => {
+  const {
+    dynamicPassword
+  } = await getDynamicPassword({
+    devId: config.devInfo.devId
+  });
+  const now = Math.floor(Date.now() / 1000);
+  return {
+    type: "dynamic",
+    name: "",
+    // 动态密码无名称
+    password: parseOfflinePassword(dynamicPassword),
+    unlockBindingId: "",
+    // 动态密码无解锁绑定 ID
+    effectiveConfig: {
+      effectiveDate: now,
+      // 动态密码生效时间为当前时间
+      expiredDate: now + 5 * 60 // 动态密码有效期为5分钟
+    }
+  };
+};
+/**
+ * 生成清除密码
+ * 可支持清除所有或某个限时密码
+ * @param {CreateClearParams} params
+ * @returns {Promise<OfflinePwdResult>} - 返回清除密码结果
+ * @throws {ErrorData} - 如果生成清除密码失败，将抛出错误
+ */
+export const createTempClear = async params => {
+  const {
+    name,
+    unlockBindingId,
+    clearAll
+  } = params;
+  if (name && name.length > 20) {
+    throw getError(1031);
+  }
+  if (!clearAll && !unlockBindingId) {
+    throw getError(1044);
+  }
+  let res;
+  if (clearAll) {
+    res = await getOfflinePassword({
+      devId: config.devInfo.devId,
+      pwdType: "9",
+      pwdName: name,
+      gmtStart: 0,
+      gmtExpired: 0
+    });
+  } else {
+    res = await revokeOfflinePassword({
+      devId: config.devInfo.devId,
+      name,
+      unlockBindingId: unlockBindingId
+    });
+  }
+  return {
+    type: clearAll ? "clear" : "clearOne",
+    name: res.pwdName,
+    password: parseOfflinePassword(res.pwd),
+    unlockBindingId: res.unlockBindingId,
+    effectiveConfig: {
+      effectiveDate: res.gmtStart,
+      expiredDate: res.gmtExpired
+    }
+  };
+};
+
+/**
+ * 临时密码的状态
+ * effective - 生效
+ * toBeEffective - 待生效
+ * expired - 已失效
+ * frozen - 冻结
+ * freezing - 冻结中
+ * synchronizing - 同步中
+ * synchronized - 已同步
+ * deleted - 已删除
+ * toBeDeleted - 待删除
+ * synchronizationFailed - 同步失败
+ */
+
+/**
+ *密码的无效原因
+ * synchronizationFailed - 同步失败
+ * passwordFull - 密码已满
+ * deleted - 已删除
+ */
+
+const passwordTypeMap = {
+  "1-0": "custom",
+  "3-1": "once",
+  "3-0": "limit",
+  "3-8": "clearOne",
+  "3-9": "clear"
+};
+
+/**
+ * 获取有效的临时密码列表
+ */
+export const getTempEffectiveList = async () => {
+  const res = await fetchEffectiveList({
+    devId: config.devInfo.devId,
+    authTypes: ["LOCK_OFFLINE_TEMP_PWD", "LOCK_TEMP_PWD"]
+  });
+  return res.map(item => {
+    var _item$scheduleDetails, _item$opModeInfo;
+    // 类型
+    const type = passwordTypeMap[`${item.opModeType}-${item.opModeSubType}`] || "custom";
+    // 状态
+    let status = "toBeEffective"; // 默认状态为未生效
+    if (item.effective !== 1) {
+      switch (item.phase) {
+        case 1:
+          status = "effective"; // 生效中
+          break;
+        case 2:
+          status = "synchronizing"; // 同步中
+          break;
+        case 3:
+          status = "frozen"; // 已冻结
+          break;
+        case 4:
+          status = "freezing"; // 冻结中
+          break;
+        case 9:
+          status = "toBeDeleted"; // 待删除
+          break;
+        case 10:
+          status = "synchronizing"; // 同步中
+          break;
+      }
+    }
+    const effectiveConfig = {
+      effectiveDate: item.effectiveTime,
+      expiredDate: item.invalidTime
+    };
+    if ((_item$scheduleDetails = item.scheduleDetails) !== null && _item$scheduleDetails !== void 0 && _item$scheduleDetails.length) {
+      const scheduleDetail = item.scheduleDetails[0];
+      effectiveConfig.repeat = scheduleDetail.allDay === false ? "week" : "none";
+      if (effectiveConfig.repeat === "week") {
+        effectiveConfig.weeks = parseWeek(scheduleDetail.workingDay);
+        effectiveConfig.effectiveTime = scheduleDetail.effectiveTime;
+        effectiveConfig.expiredTime = scheduleDetail.invalidTime;
+      }
+    }
+    const data = {
+      unlockBindingId: item.unlockBindingId,
+      name: item.name,
+      status,
+      type,
+      sn: item.sn,
+      hasClearPwd: ((_item$opModeInfo = item.opModeInfo) === null || _item$opModeInfo === void 0 ? void 0 : _item$opModeInfo.hasClearPwd) === true,
+      effectiveConfig
+    };
+    if (data.type === "clearOne") {
+      var _item$opModeInfo2, _item$opModeInfo3, _item$opModeInfo4;
+      data.clearInfo = {
+        name: ((_item$opModeInfo2 = item.opModeInfo) === null || _item$opModeInfo2 === void 0 ? void 0 : _item$opModeInfo2.revokedPwdName) || "",
+        effectiveConfig: {
+          effectiveDate: ((_item$opModeInfo3 = item.opModeInfo) === null || _item$opModeInfo3 === void 0 ? void 0 : _item$opModeInfo3.revokedPwdEffectiveTime) || 0,
+          expiredDate: ((_item$opModeInfo4 = item.opModeInfo) === null || _item$opModeInfo4 === void 0 ? void 0 : _item$opModeInfo4.revokedPwdInvalidTime) || 0
+        }
+      };
+    }
+    return data;
+  });
+};
+export const getTempInvalidList = async params => {
+  const res = await fetchInvalidList({
+    devId: config.devInfo.devId,
+    offset: ((params === null || params === void 0 ? void 0 : params.page) || 1) - 1,
+    limit: (params === null || params === void 0 ? void 0 : params.pageSize) || 200
+  });
+  const list = res.datas.map(item => {
+    var _item$scheduleDetails2, _item$opModeInfo5;
+    // 类型
+    const type = passwordTypeMap[`${item.opModeType}-${item.opModeSubType}`] || "custom";
+    // 状态
+
+    // 默认状态为未生效
+    let invalidReason = "synchronizationFailed"; // 默认失败原因为已删除
+    if (item.phase === 8) {
+      invalidReason = "deleted"; // 已删除
+    }
+    if (item.failReason) {
+      switch (item.phase) {
+        case 1:
+          invalidReason = "synchronizationFailed"; // 生效中
+          break;
+        case 2:
+          invalidReason = "passwordFull"; // 密码已满
+          break;
+      }
+    }
+    const effectiveConfig = {
+      effectiveDate: item.effectiveTime,
+      expiredDate: item.invalidTime
+    };
+    if ((_item$scheduleDetails2 = item.scheduleDetails) !== null && _item$scheduleDetails2 !== void 0 && _item$scheduleDetails2.length) {
+      const scheduleDetail = item.scheduleDetails[0];
+      effectiveConfig.repeat = scheduleDetail.allDay === false ? "week" : "none";
+      if (effectiveConfig.repeat === "week") {
+        effectiveConfig.weeks = parseWeek(scheduleDetail.workingDay);
+        effectiveConfig.effectiveTime = scheduleDetail.effectiveTime;
+        effectiveConfig.expiredTime = scheduleDetail.invalidTime;
+      }
+    }
+    const data = {
+      unlockBindingId: item.unlockBindingId,
+      name: item.name,
+      invalidReason,
+      status: "expired",
+      type,
+      sn: item.sn,
+      hasClearPwd: ((_item$opModeInfo5 = item.opModeInfo) === null || _item$opModeInfo5 === void 0 ? void 0 : _item$opModeInfo5.hasClearPwd) === true,
+      effectiveConfig
+    };
+    if (data.type === "clearOne") {
+      var _item$opModeInfo6, _item$opModeInfo7, _item$opModeInfo8;
+      data.clearInfo = {
+        name: ((_item$opModeInfo6 = item.opModeInfo) === null || _item$opModeInfo6 === void 0 ? void 0 : _item$opModeInfo6.revokedPwdName) || "",
+        effectiveConfig: {
+          effectiveDate: ((_item$opModeInfo7 = item.opModeInfo) === null || _item$opModeInfo7 === void 0 ? void 0 : _item$opModeInfo7.revokedPwdEffectiveTime) || 0,
+          expiredDate: ((_item$opModeInfo8 = item.opModeInfo) === null || _item$opModeInfo8 === void 0 ? void 0 : _item$opModeInfo8.revokedPwdInvalidTime) || 0
+        }
+      };
+    }
+    return data;
+  });
+  return {
+    list,
+    hasMore: res.hasNext,
+    total: res.totalCount
+  };
+};
+
+/**
+ * 清空无效的临时密码列表
+ */
+export const clearTempInvalidList = async () => {
+  return clearInvalidTempList({
+    devId: config.devInfo.devId
+  });
+};
+const changePasswordPhase = async (unlockBindingId, phase) => {
+  const list = await fetchEffectiveList({
+    devId: config.devInfo.devId,
+    authTypes: ["LOCK_OFFLINE_TEMP_PWD", "LOCK_TEMP_PWD"]
+  });
+  const password = list.find(item => item.unlockBindingId === unlockBindingId);
+  if (!password) {
+    throw getError(1051);
+  }
+  try {
+    await updateTemporaryPassword({
+      unlockBindingId: unlockBindingId,
+      schedule: password.scheduleDetails,
+      effectiveTime: password.effectiveTime,
+      invalidTime: password.invalidTime,
+      name: password.name,
+      phase,
+      symbolic: false,
+      dpTunnel: 2,
+      devId: config.devInfo.devId
+    });
+  } catch (e) {
+    handleError(e);
+  }
+  return true;
+};
+
+/**
+ * 冻结临时密码
+ * @param params
+ * @returns
+ */
+export const freezeTemp = async params => {
+  return changePasswordPhase(params.unlockBindingId, 4);
+};
+
+/**
+ * 解冻临时密码
+ * @param params
+ * @returns
+ */
+export const unfreezeTemp = async params => {
+  return changePasswordPhase(params.unlockBindingId, 2);
+};
+/**
+ * 重命名密码名称
+ * @param {RenameParams} params
+ */
+export const renameTemp = async params => {
+  const list = await fetchEffectiveList({
+    devId: config.devInfo.devId,
+    authTypes: ["LOCK_OFFLINE_TEMP_PWD", "LOCK_TEMP_PWD"]
+  });
+  const password = list.find(item => item.unlockBindingId === params.unlockBindingId);
+  if (!password) {
+    throw getError(1051);
+  }
+  try {
+    if (password.opModeType === 1) {
+      await reNameTemporary({
+        devId: config.devInfo.devId,
+        unlockBindingId: params.unlockBindingId,
+        name: params.name
+      });
+    } else {
+      await reNameOffline({
+        devId: config.devInfo.devId,
+        unlockBindingId: params.unlockBindingId,
+        pwdName: params.name
+      });
+    }
+  } catch (e) {
+    handleError(e);
+  }
+};