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

package/lib/utils/device.d.ts

@@ -0,0 +1,207 @@
+/***
+ * 统一重新封装 TTT 能力api
+ * 以便于以后支持跨端能力
+ */
+import { DeviceInfo, DpData, ParamType } from "../interface";
+export declare const getDeviceInfo: (devId: string) => Promise<DeviceInfo>;
+export declare const getDeviceProperties: (devId: string) => Promise<Record<string, any>>;
+export declare const setDeviceProperty: (devId: string, code: string, value: string | number | Record<string, any>) => Promise<boolean>;
+export declare const publishDeviceDps: (params: {
+    deviceId: string;
+    dps: Record<string, boolean | number | string>;
+}) => Promise<unknown>;
+export declare const registerDevice: (devIds: string[]) => void;
+export declare const registerBleStatus: (devId: string) => void;
+export declare const onDpDataChange: (func: ParamType<typeof ty.device.onDpDataChange>) => void;
+export declare const offDpDataChange: (func: ParamType<typeof ty.device.offDpDataChange>) => void;
+export declare const onDeviceInfoUpdated: (func: (data: {
+    deviceId: string;
+    dps?: DpData;
+}) => void) => void;
+export declare const offDeviceInfoUpdated: (func: (data: {
+    deviceId: string;
+    dps?: DpData;
+}) => void) => void;
+export declare const onOnlineChange: (func: ParamType<typeof ty.device.onDeviceOnlineStatusUpdate>) => void;
+export declare const offOnlineChange: (func: ParamType<typeof ty.device.offDeviceOnlineStatusUpdate>) => void;
+export declare const onBleChange: (func: ParamType<typeof ty.device.onBLEConnectStatusChange>) => void;
+export declare const offBleChange: (func: ParamType<typeof ty.device.offBLEConnectStatusChange>) => void;
+export declare const getSystemInfo: () => any;
+export declare const showModal: (options: ParamType<typeof ty.showModal>) => any;
+export declare const showToast: (options: ParamType<typeof ty.showToast>) => any;
+export declare const api: <T>(options: {
+    url: string;
+    data: Record<string, any>;
+    version: string;
+}) => Promise<unknown>;
+export declare const getDeviceOnlineType: (deviceId: string) => Promise<number>;
+export declare const requestCloud: <T>(options: {
+    api: string;
+    version: string;
+    data: Record<string, any>;
+}) => Promise<T>;
+export declare const getLaunchOptionsSync: () => any;
+export declare function encrypt(deviceId: string, plaintext: string): Promise<string>;
+export declare function decrypt(deviceId: string, plaintext: string): Promise<string>;
+export declare const getCurrentHomeInfo: () => Promise<{
+    /** 家庭名称 */
+    homeName: string;
+    /** 家庭id */
+    homeId: string;
+    /** 经度 */
+    longitude: string;
+    /** 维度 */
+    latitude: string;
+    /** 详细地址 */
+    address: string;
+    /**
+     * 是否是管理员
+     * true 是管理员; false 非管理员
+     */
+    admin: boolean;
+}>;
+export declare const isSupportShortLink: (link: string) => Promise<unknown>;
+export declare const onBackgroundFetchData: (fetchApiKeys: string[], cb: (data: {
+    fetchedData: Record<string, {
+        fetchedData: any;
+        timeStamp: number;
+    }>;
+}) => void) => void;
+export declare const getBackgroundFetchData: (fetchApiKeys: string[]) => Promise<{
+    fetchedData: Record<string, {
+        fetchedData: any;
+        timeStamp: number;
+    }>;
+} | null>;
+interface SendMqttMessageParams {
+    /** 消息内容 */
+    message: Record<string, {}>;
+    /** 设备id */
+    deviceId: string;
+    /** 协议号 */
+    protocol: number;
+}
+/**
+ * 发送 MQTT 消息
+ * @param params
+ * @returns
+ */
+export declare const sendMqttMessage: (params: SendMqttMessageParams) => Promise<{
+    fetchedData: Record<string, {
+        fetchedData: any;
+        timeStamp: number;
+    }>;
+} | null>;
+type MqttResponse = {
+    /** 设备 id */
+    deviceId?: string;
+    /** 原始消息数据 */
+    message: any;
+    /** 双端抹平后的消息数据 */
+    messageData: any;
+    /** 消息类型 */
+    type: string;
+    /** 协议号 */
+    protocol: number;
+    /** topic */
+    topic?: string;
+};
+type MqttMessageListener = (data: MqttResponse) => void;
+export declare const onMqttMessage: (cb: MqttMessageListener) => void;
+export declare const offMqttMessage: (cb: MqttMessageListener) => void;
+export declare const registerMQTTDeviceListener: (deviceId: string) => void;
+export declare const registerMQTTProtocolListener: (protocol: number) => void;
+export declare const openPanel: (params: ParamType<typeof ty.openPanel>) => any;
+export declare const openNativeRouter: (name: string, params: Record<string, any>) => Promise<unknown>;
+export type SceneAction = {
+    /** 条件 ID */
+    id?: string;
+    /** 场景 ID */
+    ruleId?: string;
+    /** 场景 ID */
+    orderNum?: number;
+    /** 条件为设备类型时，表示设备 ID */
+    entityId: string;
+    /** 设备名称 */
+    entityName?: string;
+    /**
+     * 动作类型。枚举：
+     * ruleTrigger：触发场景
+     * ruleEnable：启用场景
+     * ruleDisable：禁用场景
+     * appPushTrigger：推送消息
+     * mobileVoiceSend：电话服务
+     * smsSend：短信服务
+     * deviceGroupDpIssue：执行群组
+     * irIssue：执行红外设备
+     * dpIssue：执行普通设备
+     * delay：延时
+     * irIssueVii：执行红外设备，执行参数为真实的红外控制码
+     * toggle：执行切换开关动作
+     * dpStep：执行步进动作
+     */
+    actionExecutor: string;
+    /** 动作执行信息 */
+    executorProperty: any;
+    /** 动作额外信息 */
+    extraProperty: any;
+    /** 设备是否在线 */
+    isDevOnline?: boolean;
+    /** 条件为设备类型时，表示设备是否被移除 */
+    devDelMark?: boolean;
+    /** 条件为设备类型时，表示设备被删除时的图标 */
+    deleteDevIcon?: string;
+    /** 条件为设备类型时，设备的图标 */
+    devIcon?: string;
+    /** 动作的策略 */
+    actionStrategy?: string;
+    /** 设备产品 ID */
+    pid?: string;
+    /** 设备产品 ID */
+    productId?: string;
+    /** 条件为设备类型时，表示设备产品图片 */
+    productPic?: string;
+    /** 条件默认图标 */
+    defaultIconUrl?: string;
+    /** 动作展示信息 */
+    actionDisplay?: string;
+    /** 动作展示信息 */
+    actionDisplayNew?: any;
+    /** 执行状态 */
+    status?: boolean;
+    /** 批量控制设备的数据 */
+    relationGroup?: any;
+};
+export declare const createAction: (params: {
+    /**
+     * 动作类型:device,smart,remind,delay
+     * device:设备
+     * smart:操作某个智能（执行智能、开关自动化）
+     * remind:提醒
+     * delay:延时
+     */
+    createType: string;
+    /**
+     * 智能类型：scene,auto
+     * scene:一键执行
+     * auto：自动化
+     */
+    smartType: string;
+}) => Promise<SceneAction[]>;
+export declare const editAction: (params: {
+    /** 当前编辑的actionIndex */
+    editIndex: number;
+    /** 智能类型 */
+    smartType: string;
+    /** 动作列表 */
+    actionArray: SceneAction[];
+}) => Promise<SceneAction[]>;
+export declare const getHomeInfo: () => Promise<{
+    homeName: string;
+    homeId: string;
+    longitude: string;
+    latitude: string;
+    address: string;
+    admin: boolean;
+}>;
+export {};

package/lib/utils/device.js

@@ -0,0 +1,353 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.reduce.js";
+/***
+ * 统一重新封装 TTT 能力api
+ * 以便于以后支持跨端能力
+ */
+
+export const getDeviceInfo = devId => {
+  return new Promise((resolve, reject) => {
+    ty.device.getDeviceInfo({
+      deviceId: devId,
+      success: res => resolve(res),
+      fail: reject
+    });
+  });
+};
+export const getDeviceProperties = async devId => {
+  return new Promise((resolve, reject) => {
+    ty.device.getDeviceProperty({
+      deviceId: devId,
+      success: _ref => {
+        let {
+          properties
+        } = _ref;
+        const result = Object.keys(properties).reduce((res, cur) => {
+          const value = properties[cur];
+          try {
+            res[cur] = JSON.parse(value);
+          } catch {
+            res[cur] = value;
+          }
+          return res;
+        }, {});
+        resolve(result);
+      },
+      fail: reject
+    });
+  });
+};
+export const setDeviceProperty = async (devId, code, value) => {
+  return new Promise((resolve, reject) => {
+    ty.device.setDeviceProperty({
+      deviceId: devId,
+      code,
+      value: JSON.stringify(value),
+      success: () => {
+        resolve(true);
+      },
+      fail: reject
+    });
+  });
+};
+export const publishDeviceDps = params => {
+  return new Promise((resolve, reject) => {
+    ty.device.publishDps(_objectSpread(_objectSpread({
+      mode: 2,
+      pipelines: [],
+      options: {}
+    }, params), {}, {
+      success: resolve,
+      fail: reject
+    }));
+  });
+};
+export const registerDevice = devIds => {
+  ty.device.registerDeviceListListener({
+    deviceIdList: devIds
+  });
+};
+export const registerBleStatus = devId => {
+  ty.device.subscribeBLEConnectStatus({
+    deviceId: devId
+  });
+};
+export const onDpDataChange = func => {
+  ty.device.onDpDataChange(func);
+};
+export const offDpDataChange = func => {
+  // 由于 小程序底层删除为同步删除，如果在 onDpDataChange 回调中删除监听函数，可能会导致某些回调无法被触发，所以这里使用异步删除
+  setTimeout(() => {
+    ty.device.offDpDataChange(func);
+  }, 0);
+};
+
+// 设备信息变化
+export const onDeviceInfoUpdated = func => {
+  ty.device.onDeviceInfoUpdated(func);
+};
+export const offDeviceInfoUpdated = func => {
+  ty.device.offDeviceInfoUpdated(func);
+};
+// 设备在离线变更
+export const onOnlineChange = func => {
+  ty.device.onDeviceOnlineStatusUpdate(func);
+};
+export const offOnlineChange = func => {
+  ty.device.offDeviceOnlineStatusUpdate(func);
+};
+
+// 蓝牙连接状态变更
+export const onBleChange = func => {
+  ty.device.onBLEConnectStatusChange(func);
+};
+export const offBleChange = func => {
+  ty.device.offBLEConnectStatusChange(func);
+};
+export const getSystemInfo = () => ty.getSystemInfoSync();
+export const showModal = options => {
+  return ty.showModal(options);
+};
+export const showToast = options => {
+  return ty.showToast(options);
+};
+export const api = options => {
+  return new Promise((resolve, reject) => {
+    ty.apiRequestByAtop({
+      api: options.url,
+      postData: options.data,
+      version: options.version,
+      success: d => {
+        resolve(d);
+      },
+      fail: err => {
+        reject(err);
+      }
+    });
+  });
+};
+export const getDeviceOnlineType = deviceId => {
+  return new Promise((resolve, reject) => {
+    ty.device.getDeviceOnlineType({
+      deviceId,
+      success: d => {
+        resolve(d.onlineType);
+      },
+      fail: err => {
+        reject(err);
+      }
+    });
+  });
+};
+export const requestCloud = options => {
+  return new Promise((resolve, reject) => {
+    ty.requestCloud({
+      api: options.api,
+      version: options.version,
+      data: options.data,
+      success: d => {
+        resolve(d);
+      },
+      fail: err => {
+        var _err$innerError;
+        reject((_err$innerError = err.innerError) !== null && _err$innerError !== void 0 ? _err$innerError : err);
+      }
+    });
+  });
+};
+export const getLaunchOptionsSync = () => {
+  return ty.getLaunchOptionsSync();
+};
+
+// 加密函数（ECB 模式）
+export async function encrypt(deviceId, plaintext) {
+  return new Promise((resolve, reject) => {
+    // @ts-expect-error
+    ty.device.aes128EncryptedStringWithPassword({
+      deviceId,
+      password: plaintext,
+      success: res => {
+        resolve(res.toUpperCase());
+      },
+      fail: reject
+    });
+  });
+}
+
+// 解密函数（ECB 模式）
+export async function decrypt(deviceId, plaintext) {
+  return new Promise((resolve, reject) => {
+    // @ts-expect-error
+    ty.device.aes128DecryptedStringWithPassword({
+      deviceId,
+      password: plaintext,
+      success: res => {
+        resolve(res);
+      },
+      fail: reject
+    });
+  });
+}
+
+// 获取当前家庭信息
+export const getCurrentHomeInfo = async () => {
+  return new Promise((resolve, reject) => {
+    ty.home.getCurrentHomeInfo({
+      success: res => resolve(res),
+      fail: reject
+    });
+  });
+};
+export const isSupportShortLink = async link => {
+  return new Promise(resolve => {
+    ty.canIUseRouter({
+      url: link,
+      success: res => {
+        if (res !== null && res !== void 0 && res.result) {
+          resolve(link);
+        } else {
+          resolve("");
+        }
+      },
+      fail: () => {
+        resolve("");
+      }
+    });
+  });
+};
+export const onBackgroundFetchData = (fetchApiKeys, cb) => {
+  // @ts-expect-error
+  if (ty.onBackgroundFetchData) {
+    // @ts-expect-error
+    ty.onBackgroundFetchData({
+      fetchApiKeys,
+      success: data => {
+        cb(data);
+      },
+      fail: () => {
+        // 不处理
+      }
+    });
+  }
+};
+export const getBackgroundFetchData = async fetchApiKeys => {
+  // @ts-expect-error
+  if (ty.getBackgroundFetchData) {
+    return new Promise(resolve => {
+      // @ts-expect-error
+      ty.getBackgroundFetchData({
+        fetchType: "periodic",
+        fetchApiKeys,
+        success: res => {
+          resolve(res);
+        },
+        fail: () => {
+          resolve(null);
+        }
+      });
+    });
+  }
+  return null;
+};
+/**
+ * 发送 MQTT 消息
+ * @param params
+ * @returns
+ */
+export const sendMqttMessage = async params => {
+  return new Promise((resolve, reject) => {
+    ty.device.sendMqttMessage(_objectSpread(_objectSpread({}, params), {}, {
+      options: {},
+      success: res => {
+        resolve(res);
+      },
+      fail: err => {
+        reject(err);
+      }
+    }));
+  });
+};
+export const onMqttMessage = cb => {
+  ty.device.onMqttMessageReceived(cb);
+};
+export const offMqttMessage = cb => {
+  ty.device.offMqttMessageReceived(cb);
+};
+export const registerMQTTDeviceListener = deviceId => {
+  ty.device.registerMQTTDeviceListener({
+    deviceId
+  });
+};
+export const registerMQTTProtocolListener = protocol => {
+  ty.device.registerMQTTProtocolListener({
+    protocol
+  });
+};
+export const openPanel = params => {
+  return ty.openPanel(params);
+};
+export const openNativeRouter = (name, params) => {
+  const query = Object.entries(params).reduce((acc, _ref2) => {
+    let [key, value] = _ref2;
+    if (typeof value !== "undefined") {
+      acc.push(`${key}=${value}`);
+    }
+    return acc;
+  }, []).join("&");
+  return new Promise((resolve, reject) => {
+    ty.canIUseRouter({
+      url: name,
+      success: res => {
+        if (res !== null && res !== void 0 && res.result) {
+          ty.router({
+            url: `thingSmart://${name}?${query}`,
+            success: () => {
+              resolve(true);
+            },
+            fail: e => {
+              reject(e);
+            }
+          });
+        }
+      },
+      fail: err => {
+        reject(err);
+      }
+    });
+  });
+};
+export const createAction = params => {
+  return new Promise((resolve, reject) => {
+    ty.device.createAction(_objectSpread(_objectSpread({}, params), {}, {
+      actionArray: [],
+      success: res => {
+        resolve(res.actionArray);
+      },
+      fail: err => {
+        reject(err);
+      }
+    }));
+  });
+};
+export const editAction = params => {
+  return new Promise((resolve, reject) => {
+    // @ts-expect-error
+    ty.device.editAction(_objectSpread(_objectSpread({}, params), {}, {
+      success: res => {
+        resolve(res.actionArray);
+      },
+      fail: err => {
+        reject(err);
+      }
+    }));
+  });
+};
+export const getHomeInfo = async () => {
+  return new Promise((resolve, reject) => {
+    ty.home.getCurrentHomeInfo({
+      success: res => resolve(res),
+      fail: reject
+    });
+  });
+};

package/lib/utils/errors.d.ts

@@ -0,0 +1,2 @@
+import { ErrorData } from "../interface";
+export declare const getError: (code: number, ...places: string[]) => ErrorData;

package/lib/utils/errors.js

@@ -0,0 +1,125 @@
+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"
+};
+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]);
+      }
+    }
+    return {
+      errorCode: code,
+      errorMsg: desc
+    };
+  }
+  return {
+    errorCode: code,
+    errorMsg: "unknow error"
+  };
+};

package/lib/utils/event.d.ts

@@ -0,0 +1,23 @@
+type Callback<T> = (args: T) => void;
+declare function createEmitter(): {
+    on: <T>(type: string, cb: Callback<T>) => void;
+    off: <T>(type: string, cb: Callback<T>) => void;
+    once: <T>(type: string, cb: Callback<T>) => void;
+    emit: <T>(type: string, data: T) => void;
+    clear: () => void;
+    hasListener: (type: string) => boolean;
+    cache: <T>(type: string, data: T) => void;
+    clearCache: (type: string) => void;
+};
+export { createEmitter };
+declare const _default: {
+    on: <T>(type: string, cb: Callback<T>) => void;
+    off: <T>(type: string, cb: Callback<T>) => void;
+    once: <T>(type: string, cb: Callback<T>) => void;
+    emit: <T>(type: string, data: T) => void;
+    clear: () => void;
+    hasListener: (type: string) => boolean;
+    cache: <T>(type: string, data: T) => void;
+    clearCache: (type: string) => void;
+};
+export default _default;