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

package/lib/user.d.ts

@@ -0,0 +1,108 @@
+import { EffectiveConfig, UserInfo } from "./interface";
+interface getUsersParams {
+    /**
+     * 当前页码
+     * @default 1
+     */
+    page?: number;
+    /**
+     * 每页条数
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * 搜索关键字
+     * @default ""
+     */
+    keyword?: string;
+}
+/**
+ * 获取门锁成员列表
+ * @param {getUsersParams} options
+ * @returns
+ */
+export declare const getUsers: (params?: getUsersParams) => Promise<{
+    list: UserInfo[];
+    hasMore: boolean;
+}>;
+interface getUserInfoParams {
+    /**
+     * 用户id
+     */
+    userId: string;
+    /**
+     * 用户昵称
+     */
+    nickName: string;
+}
+/**
+ * 获取用户详细信息
+ * @param {getUserInfoParams} params
+ * @returns
+ */
+export declare const getUserInfo: (params: getUserInfoParams) => Promise<UserInfo>;
+/**
+ * 更新用户的有效性
+ */
+interface updateUserLimitTimeParams {
+    /**
+     * 用户id
+     */
+    userId: string;
+    /**
+     * 锁端用户id
+     */
+    lockUserId: number;
+    /**
+     * 是否永久生效
+     */
+    permanent: boolean;
+    /**
+     * 生效时间配置
+     * 当为非永久生效时，需必传此配置
+     */
+    effective?: EffectiveConfig;
+    /**
+     * 是否支持离线开锁
+     * 仅蓝牙锁支持
+     */
+    offlineUnlock?: boolean;
+}
+/**
+ * 更新用户的时效性
+ * @param {updateUserLimitTimeParams} params
+ * @returns
+ */
+export declare const updateUserLimitTime: (params: updateUserLimitTimeParams) => Promise<boolean>;
+/**
+ * 跳转到添加家庭成员页面
+ * @returns
+ */
+export declare const openAddFamilyUser: () => Promise<unknown>;
+/**
+ * 查看家庭成员信息
+ * 支持编辑
+ * @param {string} userId 成员id
+ */
+export declare const openFamilyUserDetail: (userId: string) => Promise<never>;
+interface AddUserParams {
+    /**
+     * 用户名称
+     */
+    name: string;
+}
+/**
+ * 添加一个普通成员
+ * 注意，如果锁使用了小容量的方案，则不建议使用此 API
+ * @param {AddUserParams} params
+ * @returns
+ */
+export declare const addUser: (params: AddUserParams) => Promise<unknown>;
+/**
+ * 删除一个普通成员
+ * 注意，如果锁使用了小容量的方案，则不建议使用此 API
+ * @param {string} userId 成员id
+ * @returns
+ */
+export declare const removeUser: (userId: string) => Promise<unknown>;
+export {};

package/lib/user.js

@@ -0,0 +1,361 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["timeScheduleInfo", "unlockDetail"];
+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 "core-js/modules/esnext.iterator.reduce.js";
+import { getUserDetail, getUserList } from "./api/user";
+import config from "./config";
+import { update as updateMap, reportUpdate as reportUpdateMap } from "./config/dp-map/unlock-method";
+import { update as updateMapBig, reportUpdate as reportUpdateMapBig } 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";
+import { getError } from "./utils/errors";
+import { updateUserTimeSchedule, addNormalUser, removeNormalUser } from "./api/user";
+import { validConfigDpMap } from "./config/dp-map/common";
+import { formatTimestampToMilliseconds, formatWeek, isAdmin, parseWeek, unlockMethodConfigs, validateEffectiveConfig } from "./utils";
+import { getCurrentHomeInfo, isSupportShortLink } from "./utils/device";
+import { LoopTypes } from "./utils/constant";
+import { getCurrentUser } from "./state";
+/**
+ * 追加用户列表
+ * @param list
+ * @param result
+ * @returns
+ */
+const concactUserList = (list, result) => {
+  return list.reduce((acc, item) => {
+    const {
+        timeScheduleInfo,
+        unlockDetail
+      } = item,
+      rest = _objectWithoutProperties(item, _excluded);
+    // 处理时效配置
+
+    if (!item.timeScheduleInfo.permanent && item.timeScheduleInfo.scheduleDetails && item.timeScheduleInfo.scheduleDetails.length > 0) {
+      // 如果不是永久有效，且有时间配置
+      Object.assign(timeScheduleInfo, {
+        effectiveTime: formatTimestampToMilliseconds(item.timeScheduleInfo.effectiveTime || 0),
+        expiredTime: formatTimestampToMilliseconds(item.timeScheduleInfo.expiredTime || 0),
+        scheduleDetails: {
+          repeat: !item.timeScheduleInfo.scheduleDetails[0].allDay,
+          effectiveTime: item.timeScheduleInfo.scheduleDetails[0].effectiveTime,
+          invalidTime: item.timeScheduleInfo.scheduleDetails[0].invalidTime,
+          timeZoneId: item.timeScheduleInfo.scheduleDetails[0].timeZoneId,
+          weeks: parseWeek(item.timeScheduleInfo.scheduleDetails[0].workingDay)
+        }
+      });
+    }
+    // 处理开锁方式
+    let unlockDetails = unlockDetail.map(detail => {
+      // 处理开锁方式的名称
+      const unlockList = detail.unlockList.map(unlockItem => {
+        return {
+          unlockId: unlockItem.unlockId.split("-")[1],
+          unlockName: unlockItem.unlockName,
+          id: unlockItem.opModeId,
+          isBound: unlockItem.allocateFlag === 1,
+          photoUnlock: unlockItem.photoUnlock,
+          isSpecial: unlockItem.unlockAttr === 1
+        };
+      });
+      const unlockMethodConfig = unlockMethodConfigs.find(item => item.code === detail.dpCode);
+      return {
+        count: unlockList.length,
+        dpCode: detail.dpCode,
+        dpId: detail.dpId,
+        type: unlockMethodConfig.type,
+        unlockList
+      };
+    });
+    acc.push(_objectSpread(_objectSpread({}, rest), {}, {
+      timeScheduleInfo: {
+        permanent: true // 默认永久有效
+      },
+      unlockDetails,
+      isAccountUser: item.userListType === "group_user"
+    }));
+    return acc;
+  }, result);
+};
+
+/**
+ * 获取门锁成员列表
+ * @param {getUsersParams} options
+ * @returns
+ */
+export const getUsers = async params => {
+  const {
+    page = 1,
+    pageSize = 10,
+    keyword = ""
+  } = params || {};
+  const currentUser = await getCurrentUser();
+  const dps = [];
+  if (currentUser.allOpenDps) {
+    currentUser.allOpenDps.split(",").reduce((acc, cur) => {
+      const code = config.codesById[cur];
+      if (code) {
+        acc.push(code);
+      }
+      return acc;
+    }, dps);
+  }
+  const res = await getUserList({
+    dpCodes: dps.join(","),
+    devId: config.devInfo.devId,
+    offset: (page - 1) * pageSize,
+    limit: pageSize,
+    keyword
+  });
+  let list = [];
+  if (res.admin && res.admin.length > 0) {
+    concactUserList(res.admin, list);
+  }
+  if (res.user && res.user.length > 0) {
+    concactUserList(res.user, list);
+  }
+  return {
+    list,
+    hasMore: res.hasNext
+  };
+};
+/**
+ * 获取用户详细信息
+ * @param {getUserInfoParams} params
+ * @returns
+ */
+export const getUserInfo = async params => {
+  const data = await getUsers({
+    keyword: params.nickName
+  });
+  const res = data.list.find(item => item.userId === params.userId);
+  if (res) {
+    return res;
+  }
+  throw getError(1048);
+};
+
+/**
+ * 更新用户的有效性
+ */
+
+/**
+ * 更新用户的时效性
+ * @param {updateUserLimitTimeParams} params
+ * @returns
+ */
+export const updateUserLimitTime = async params => {
+  const {
+    userId,
+    lockUserId,
+    permanent,
+    effective
+  } = params;
+
+  // 数据验证
+  if (!permanent) {
+    validateEffectiveConfig(effective);
+  }
+  const {
+    userType
+  } = await getUserDetail({
+    devId: config.devInfo.devId,
+    userId
+  });
+  if (isAdmin(userType)) {
+    // 如果是管理员，则不允许修改时效性
+    throw getError(1049);
+  }
+  const {
+    repeat,
+    effectiveTime = 0,
+    expiredTime = 1439
+  } = effective || {};
+
+  // 循环方式
+  const loopType = repeat ?
+  // @ts-expect-error
+  LoopTypes[repeat.toUpperCase()] : LoopTypes.NONE;
+
+  // 组装数据下发
+  const dpValue = {
+    type: 0,
+    stage: 0,
+    admin: false,
+    memberId: lockUserId,
+    unlockId: 255,
+    validNum: 0,
+    pwdLength: 0,
+    pwd: [],
+    validConfig: {
+      startTime: Math.floor(permanent ? +new Date() / 1000 : effective.effectiveDate),
+      // 如果是永久生效，则设置为 100 年后失效
+      endTime: Math.floor(permanent ? (+new Date() + 3153600000000) / 1000 : effective.expiredDate),
+      loop: permanent ? LoopTypes.NONE : loopType,
+      loopConfig: 0,
+      weeks: permanent || (effective === null || effective === void 0 ? void 0 : effective.repeat) !== "week" || (effective === null || effective === void 0 ? void 0 : effective.weeks) === undefined ? [0, 0, 0, 0, 0, 0, 0] : effective.weeks,
+      days: [],
+      startHour: permanent ? 0 : Math.floor(effectiveTime / 60),
+      startMinute: permanent ? 0 : effectiveTime % 60,
+      endHour: permanent ? 0 : Math.floor(expiredTime / 60),
+      endMinute: permanent ? 0 : expiredTime % 60
+    }
+  };
+  const dpCode = config.supportBigData ? dpCodes.unlockMethodEditW : dpCodes.unlockMethodEdit;
+
+  // 下发数据
+  const res = await publishDps({
+    [dpCode]: DpUtils.format(dpValue, config.supportBigData ? updateMapBig : updateMap)
+  }, {
+    checkReport: dps => {
+      if (typeof dps[dpCode] !== "undefined") {
+        const result = DpUtils.parse(dps[dpCode], config.supportBigData ? reportUpdateMapBig : reportUpdateMap);
+        console.log("reportUpdate result", result);
+        if (result.type === 0) {
+          if (result.memberId === lockUserId) {
+            return result;
+          } else {
+            // 提示可能返回了一个错误的成员id
+            console.warn("An incorrect member id was returned");
+          }
+        }
+      }
+      return false;
+    }
+  });
+  if (res.status !== 255) {
+    throw getError(1011);
+  }
+  // 更新云端数据
+  try {
+    console.log("dpValue.validConfig", dpValue.validConfig);
+    await updateUserTimeSchedule({
+      devId: config.devInfo.devId,
+      userId: userId,
+      timeScheduleInfo: {
+        permanent,
+        userTimeSet: DpUtils.format(dpValue.validConfig,
+        // @ts-expect-error
+        validConfigDpMap.childMap),
+        effectiveTime: dpValue.validConfig.startTime,
+        expiredTime: dpValue.validConfig.endTime,
+        scheduleDetails: [{
+          allDay: loopType === LoopTypes.NONE,
+          effectiveTime: permanent ? 0 : effectiveTime,
+          invalidTime: permanent ? 0 : expiredTime,
+          workingDay: permanent ? 0 : formatWeek(dpValue.validConfig.weeks)
+        }]
+      }
+    });
+  } catch (e) {
+    // 更新云端数据失败
+    throw getError(1012);
+  }
+  return true;
+};
+
+/**
+ * 跳转到添加家庭成员页面
+ * @returns
+ */
+export const openAddFamilyUser = async () => {
+  const homeInfo = await getCurrentHomeInfo();
+  let link = await isSupportShortLink("tysh_family_add_member_rn");
+  if (!link) {
+    link = await isSupportShortLink("thingsh_family_add_member_rn");
+  }
+  if (link) {
+    const url = `tuyaSmart://${link}?homeId=${homeInfo.homeId}`;
+    return new Promise((resolve, reject) => {
+      ty.router({
+        url: url,
+        success: () => {
+          resolve(true);
+        },
+        fail: e => {
+          reject(e);
+        }
+      });
+    });
+  }
+
+  // 不支持跳转
+  return Promise.reject(getError(1013));
+};
+const userTypeMap = {
+  "10": 1,
+  "20": 0,
+  "40": -1,
+  "50": 2
+};
+
+/**
+ * 查看家庭成员信息
+ * 支持编辑
+ * @param {string} userId 成员id
+ */
+export const openFamilyUserDetail = async userId => {
+  const homeId = await getCurrentHomeInfo();
+  const {
+    userType: currentUserType
+  } = await getCurrentUser();
+  const role = userTypeMap[currentUserType];
+  let link = await isSupportShortLink("member_info");
+  if (link) {
+    ty.canIUseRouter({
+      url: "member_info",
+      success: res => {
+        if (res !== null && res !== void 0 && res.result) {
+          ty.router({
+            url: `tuyaSmart://member_info?homeId=${homeId}&memberId=${userId}&role=${role}`,
+            success: () => {
+              console.log("跳转成员详情页成功");
+            },
+            fail: e => {
+              console.log("跳转成员详情页失败", e);
+            }
+          });
+        }
+      },
+      fail: err => {
+        console.log(err);
+      }
+    });
+  }
+
+  // 不支持跳转
+  return Promise.reject(getError(1013));
+};
+/**
+ * 添加一个普通成员
+ * 注意，如果锁使用了小容量的方案，则不建议使用此 API
+ * @param {AddUserParams} params
+ * @returns
+ */
+export const addUser = async params => {
+  if (!params.name) {
+    throw getError(1009, "name");
+  }
+  return addNormalUser({
+    devId: config.devInfo.devId,
+    name: params.name
+  });
+};
+
+/**
+ * 删除一个普通成员
+ * 注意，如果锁使用了小容量的方案，则不建议使用此 API
+ * @param {string} userId 成员id
+ * @returns
+ */
+export const removeUser = async userId => {
+  return removeNormalUser({
+    devId: config.devInfo.devId,
+    userId,
+    shouldDeleteUnlockInfo: true,
+    issueDp: true
+  });
+};

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

@@ -0,0 +1 @@
+export default function base64ToHex(base64: string): string;

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

@@ -0,0 +1,12 @@
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.reduce.js";
+import { Base64 } from 'js-base64';
+export default function base64ToHex(base64) {
+  if (!base64) {
+    return '';
+  }
+  return Base64.toUint8Array(base64).reduce((res, cur) => {
+    res.push(cur.toString(16).padStart(2, '0'));
+    return res;
+  }, []).join('');
+}

package/lib/utils/byte.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 大端格式 字节数组转为无符号位数据
+ *
+ * @param data
+ * @returns
+ */
+export declare function bytesToUint(data: Uint8Array): number;
+/**
+ * 大端格式 字节转为16进制字符串
+ * @param data
+ * @returns
+ */
+export declare function bytesToHex(data: Uint8Array): string;
+/**
+ * 字符串转为字节
+ * @param str
+ * @returns
+ */
+export declare function stringToBytes(str: string): Uint8Array<ArrayBuffer>;

package/lib/utils/byte.js

@@ -0,0 +1,74 @@
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.reduce.js";
+/**
+ * 大端格式 字节数组转为无符号位数据
+ *
+ * @param data
+ * @returns
+ */
+export function bytesToUint(data) {
+  const view = new DataView(data.buffer);
+  switch (data.length) {
+    case 0:
+      throw new Error("data of Uint8Array is empty");
+    case 1:
+      return view.getUint8(0);
+    case 2:
+      return view.getUint16(0);
+    case 3:
+      return data.reduce((res, value) => {
+        return res << 8 | value;
+      }, 0);
+    case 4:
+      return view.getUint32(0);
+    default:
+      return parseInt(bytesToHex(data), 16);
+  }
+}
+
+/**
+ * 大端格式 字节转为16进制字符串
+ * @param data
+ * @returns
+ */
+export function bytesToHex(data) {
+  if (!data.length) {
+    return "";
+  }
+  if (data.length <= 4) {
+    return bytesToUint(data).toString(16).padStart(data.length * 2, "0").toUpperCase();
+  }
+  return data.reduce((res, value) => {
+    res.push(value.toString(16).padStart(2, "0"));
+    return res;
+  }, []).join("").toUpperCase();
+}
+
+/**
+ * 字符串转为字节
+ * @param str
+ * @returns
+ */
+export function stringToBytes(str) {
+  const bytes = [];
+  const len = str.length;
+  for (let i = 0; i < len; i++) {
+    const c = str.charCodeAt(i);
+    if (c >= 0x010000 && c <= 0x10ffff) {
+      bytes.push(c >> 18 & 0x07 | 0xf0);
+      bytes.push(c >> 12 & 0x3f | 0x80);
+      bytes.push(c >> 6 & 0x3f | 0x80);
+      bytes.push(c & 0x3f | 0x80);
+    } else if (c >= 0x000800 && c <= 0x00ffff) {
+      bytes.push(c >> 12 & 0x0f | 0xe0);
+      bytes.push(c >> 6 & 0x3f | 0x80);
+      bytes.push(c & 0x3f | 0x80);
+    } else if (c >= 0x000080 && c <= 0x0007ff) {
+      bytes.push(c >> 6 & 0x1f | 0xc0);
+      bytes.push(c & 0x3f | 0x80);
+    } else {
+      bytes.push(c & 0xff);
+    }
+  }
+  return new Uint8Array(bytes);
+}

package/lib/utils/constant.d.ts

@@ -0,0 +1,11 @@
+declare const THING: string;
+export { THING };
+export declare const DPCHANGE = "dpChange";
+export declare const LOGCHANGE = "logChange";
+export declare const UNLOCK_METHOD_EVENT = "UMEvent";
+export declare enum LoopTypes {
+    NONE = 0,
+    DAY = 1,
+    WEEK = 2,
+    MONTH = 3
+}

package/lib/utils/constant.js

@@ -0,0 +1,17 @@
+import { Base64 } from "js-base64";
+const THING = Base64.decode("dHV5YQ==");
+export { THING };
+export const DPCHANGE = "dpChange";
+export const LOGCHANGE = "logChange";
+export const UNLOCK_METHOD_EVENT = "UMEvent";
+export let LoopTypes = /*#__PURE__*/function (LoopTypes) {
+  // 不循环
+  LoopTypes[LoopTypes["NONE"] = 0] = "NONE";
+  // 天循环
+  LoopTypes[LoopTypes["DAY"] = 1] = "DAY";
+  // 周循环
+  LoopTypes[LoopTypes["WEEK"] = 2] = "WEEK";
+  // 月循环
+  LoopTypes[LoopTypes["MONTH"] = 3] = "MONTH";
+  return LoopTypes;
+}({});