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

package/lib/interface.js

@@ -0,0 +1 @@
+export {};

package/lib/linkage.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 获取剩余通知次数
+ * @returns {Promise<{message: number, phone: number}>}
+ */
+export declare const getRemainingInfo: () => Promise<{
+    message: number;
+    phone: number;
+}>;
+/**
+ * 获取门铃通知服务信息
+ * @returns {Promise<boolean>}
+ */
+export declare const getDoorbellService: () => Promise<import("./api/linkage").LinkageRule | undefined>;
+/**
+ * 启用门铃通知服务
+ * 注意： 首次开通时，会先进入创建动作的页面，创建完成后，会自动启用门铃通知服务
+ */
+export declare const enableDoorbellService: () => Promise<void>;
+/**
+ * 禁用门铃通知服务
+ */
+export declare const disableDoorbellService: () => Promise<never>;
+/**
+ * 去配置门铃通知服务
+ */
+export declare const toSetDoorbellService: () => Promise<void>;

package/lib/linkage.js

@@ -0,0 +1,175 @@
+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 { disableLinkage, enableLinkage, getLinkageList, getRemainingMessage, getRemainingPhone, saveLinkage } from "./api/linkage";
+import config from "./config";
+import { getHomeInfo } from "./utils";
+import { createAction, editAction } from "./utils/device";
+import { getError } from "./utils/errors";
+const DOORBELL_RING_TYPE = "doorbell_ring";
+const TARGET_KEY = "appPushTrigger"; // 用于从筛选出的配置对象中 筛选出需要的规则
+const ACTION_TYPE = "kafkaSend"; // 新增的action类型
+const MOBILE_TYPE = "mobileVoiceSend"; // actions对象的actionExecutor属性的类型
+const MESSAGE_TYPE = "smsSend"; // actions对象的actionExecutor属性的类型
+
+/**
+ * 获取剩余通知次数
+ * @returns {Promise<{message: number, phone: number}>}
+ */
+export const getRemainingInfo = async () => {
+  const [message, phone] = await Promise.all([getRemainingMessage(), getRemainingPhone()]);
+  return {
+    message,
+    phone
+  };
+};
+
+/**
+ * 获取门铃通知服务信息
+ * @returns {Promise<boolean>}
+ */
+export const getDoorbellService = async () => {
+  const list = await getLinkageList(config.devInfo.devId);
+  return list.find(item => item.code === DOORBELL_RING_TYPE && item.ruleId);
+};
+const createDoorbellService = async () => {
+  const actions = await createAction({
+    createType: "auto",
+    smartType: "remind"
+  });
+  console.log("actions", actions);
+  await saveDoorbellService(actions);
+};
+const saveDoorbellService = async actions => {
+  const homeInfo = await getHomeInfo();
+  // 保存配置
+  saveLinkage({
+    devId: config.devInfo.devId,
+    ownerId: homeInfo.homeId,
+    name: "",
+    enabled: true,
+    extraInfo: {},
+    bizType: DOORBELL_RING_TYPE,
+    logicRuleList: [{
+      name: "",
+      // 规则名称
+      matchType: 2,
+      // MatchType枚举，1:任意条件触发，2:全部条件满足触发，3:通过expr来判断整个条件的匹配情况
+      enabled: true,
+      // 规则启用/禁用
+      scenarioRule: false,
+      // 是否在场景列表中展示
+      preConditions: [],
+      coverIcon: "",
+      displayColor: "",
+      background: "",
+      conditions: [{
+        entityType: 23,
+        // entityType=23,表示kafka 消息触发类型
+        entityId: config.devInfo.devId,
+        // 可以是设备ID,或者产品id等,根据实际的业务需求来
+        entitySubIds: "",
+        // 无 根据实际的需求来 可以是dpIds
+        iconUrl: "",
+        // 图片
+        expr: [],
+        // 为空 传递JSONArray
+        extraInfo: {
+          businessType: DOORBELL_RING_TYPE // 门铃呼叫的43协议
+        }
+      }],
+      actions: actions.map(item => {
+        // 电话提醒处理
+        if ((item === null || item === void 0 ? void 0 : item.actionExecutor) === MOBILE_TYPE) {
+          const executorProperty = {
+            topic: 1,
+            customParameters: {
+              type: 1
+            }
+          };
+          return {
+            actionExecutor: ACTION_TYPE,
+            entityName: "notify_phone",
+            // 根据实际的业务来,作为面板展示使用
+            extraProperty: executorProperty,
+            executorProperty
+          };
+        }
+        // 短信提醒处理
+        if ((item === null || item === void 0 ? void 0 : item.actionExecutor) === MESSAGE_TYPE) {
+          const executorProperty = {
+            topic: 2,
+            customParameters: {
+              type: 2
+            }
+          };
+          return {
+            actionExecutor: ACTION_TYPE,
+            entityName: "notify_message",
+            // 根据实际的业务来,作为面板展示使用
+            extraProperty: executorProperty,
+            executorProperty
+          };
+        }
+        return item;
+      })
+    }]
+  });
+};
+
+/**
+ * 启用门铃通知服务
+ * 注意： 首次开通时，会先进入创建动作的页面，创建完成后，会自动启用门铃通知服务
+ */
+export const enableDoorbellService = async () => {
+  const service = await getDoorbellService();
+  if (service && service.ruleId) {
+    await enableLinkage(service.ruleId);
+  } else {
+    await createDoorbellService();
+  }
+};
+
+/**
+ * 禁用门铃通知服务
+ */
+export const disableDoorbellService = async () => {
+  const service = await getDoorbellService();
+  if (service && service.ruleId) {
+    await disableLinkage(service.ruleId);
+  }
+  throw getError(1059);
+};
+
+/**
+ * 去配置门铃通知服务
+ */
+export const toSetDoorbellService = async () => {
+  const service = await getDoorbellService();
+  if (service && service.ruleId && service.ruleVO) {
+    const findIndex = service.ruleVO.actions.findIndex(item => item.actionExecutor === TARGET_KEY || item.actionExecutor === ACTION_TYPE);
+    // 去编辑
+    const actions = await editAction({
+      editIndex: findIndex > -1 ? findIndex : 0,
+      smartType: "auto",
+      actionArray: service.ruleVO.actions.map(item => {
+        if (item.actionExecutor === ACTION_TYPE) {
+          const {
+            customParameters: {
+              type
+            }
+          } = item.executorProperty;
+          const actionType = type === 1 ? MOBILE_TYPE : MESSAGE_TYPE;
+          // eslint-disable-next-line no-param-reassign
+          item.actionExecutor = actionType;
+        }
+        return item;
+      })
+    });
+    console.log("actions", actions);
+    await saveDoorbellService(actions);
+  } else {
+    // 去创建
+    await createDoorbellService();
+  }
+};

package/lib/log.d.ts

@@ -0,0 +1,91 @@
+import { AlbumMessage, LogData, UnlockMethodType } from "./interface";
+/**
+ * 开锁 DP 映射开锁类型
+ */
+export declare const unlockDp2Type: Record<string, UnlockMethodType>;
+/**
+ * 获取最近2条记录
+ */
+export declare const getLatestLogs: () => Promise<{
+    data: LogData[];
+    unreadCount: number;
+}>;
+/**
+ * 注册通知可刷新日志事件
+ * @param cb
+ */
+export declare const onLogsRefresh: (cb: () => void) => void;
+/**
+ * 注销通知可刷新日志事件
+ * @param cb
+ */
+export declare const offLogsRefresh: (cb: () => void) => void;
+interface GetLogsParams {
+    /**
+     * 页码，默认 1
+     */
+    page?: number;
+    /**
+     * 每页数量，默认为 50
+     */
+    pageSize?: number;
+}
+export declare const openDps: string[];
+/**
+ * 获取日志记录列表
+ * @param {GetLogsParams} params
+ */
+export declare const getLogs: (params?: GetLogsParams) => Promise<{
+    list: LogData[];
+    hasMore: boolean;
+    total: number;
+}>;
+interface GetAlarmsParams {
+    /**
+     * 页码，默认 1
+     */
+    page?: number;
+    /**
+     * 页码，默认 50
+     */
+    pageSize?: number;
+}
+/**
+ * 获取告警列表
+ * @param {GetAlarmsParams} params
+ */
+export declare const getAlarms: (params?: GetAlarmsParams) => Promise<{
+    list: LogData[];
+    hasMore: boolean;
+    total: number;
+}>;
+interface GetAlbumsParams {
+    /**
+     * 页码，默认 1
+     */
+    page?: number;
+    /**
+     * 每页数量，默认为 20
+     */
+    pageSize?: number;
+    /**
+     * 开始时间，单位为毫秒
+     */
+    startTime?: number;
+    /**
+     * 结束时间，单位为毫秒
+     */
+    endTime?: number;
+}
+/**
+ * 获取相册日志
+ * 仅支持视对讲设备
+ */
+export declare const getAlbums: (params?: GetAlbumsParams) => Promise<{
+    hasMore: boolean;
+    list: AlbumMessage[];
+    allAitypes: number[];
+    types: number[];
+    langMap: string[];
+}>;
+export {};

package/lib/log.js

@@ -0,0 +1,314 @@
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.map.js";
+import "core-js/modules/esnext.iterator.some.js";
+import { getAlarmList, getAlbumMessages, getLatest2Log, getRecordList } from "./api/log";
+import config from "./config";
+import dpCodes from "./config/dp-code";
+import { getCurrentUser } from "./state";
+import base64ToHex from "./utils/base64-to-hex";
+import { LOGCHANGE } from "./utils/constant";
+import emitter from "./utils/event";
+import { handleLocalOperation } from "./utils/log";
+
+/**
+ * 开锁 DP 映射开锁类型
+ */
+export const unlockDp2Type = {
+  [dpCodes.unlockFingerprint]: "finger",
+  [dpCodes.unlockPassword]: "password",
+  [dpCodes.unlockCard]: "card",
+  [dpCodes.unlockFace]: "face",
+  [dpCodes.unlockFingerVein]: "fingerVein",
+  [dpCodes.unlockHand]: "hand",
+  [dpCodes.unlockEye]: "eye"
+};
+
+/**
+ * 获取最近2条记录
+ */
+export const getLatestLogs = async () => {
+  const data = await getLatest2Log(config.devInfo.devId);
+  //   TODO 处理统一日志格式
+  if (data.operateRecordVOList && data.operateRecordVOList.length) {
+    const list = data.operateRecordVOList.map(item => {
+      var _item$unionUnlockInfo, _item$unlockNameRoset;
+      let type = item.logCategory;
+      if (type === "operation" && item.logType === "dev_bind") {
+        type = "dev_bind";
+      }
+      const dpCode = config.codesById[item.dpId];
+      const dpSchema = config.dpSchema[dpCode];
+      let itemData = item.data || "";
+      if ((dpSchema === null || dpSchema === void 0 ? void 0 : dpSchema.type) === "raw") {
+        itemData = base64ToHex(item.data);
+      }
+      if (typeof itemData === "string" && itemData.includes("[")) {
+        try {
+          itemData = JSON.parse(itemData)[0];
+        } catch {
+          //
+        }
+      }
+      return {
+        type,
+        logId: item.logId,
+        dpId: item.dpId,
+        dpCode,
+        data: itemData,
+        userId: item.userId,
+        userName: item.userName,
+        unlockName: item.unlockName,
+        mediaInfo: item.mediaInfoList,
+        unionUnlockInfo: (_item$unionUnlockInfo = item.unionUnlockInfo) === null || _item$unionUnlockInfo === void 0 ? void 0 : _item$unionUnlockInfo.map(item1 => {
+          return {
+            userId: item1.userId,
+            userName: item1.userName,
+            unlockName: item.unlockName,
+            sn: item1.sn,
+            type: unlockDp2Type[item1.opMode]
+          };
+        }),
+        closeValue: (_item$unlockNameRoset = item.unlockNameRosettaKey) === null || _item$unlockNameRoset === void 0 ? void 0 : _item$unlockNameRoset.replace("HISTORY_LOCK_", ""),
+        time: item.time,
+        currentUser: !!item.currentUser,
+        bindable: item.memberBindableFlag
+      };
+    });
+    return {
+      data: list,
+      unreadCount: data.unReadCount
+    };
+  }
+  return {
+    data: [],
+    unreadCount: 0
+  };
+};
+
+/**
+ * 注册通知可刷新日志事件
+ * @param cb
+ */
+export const onLogsRefresh = cb => {
+  emitter.on(LOGCHANGE, cb);
+};
+
+/**
+ * 注销通知可刷新日志事件
+ * @param cb
+ */
+export const offLogsRefresh = cb => {
+  emitter.off(LOGCHANGE, cb);
+};
+// 开门记录dpID合集
+export const openDps = [dpCodes.openInside, dpCodes.lockLocalRecord, dpCodes.unlockPassword, dpCodes.lockRecord, dpCodes.unlockFingerprint, dpCodes.unlockCard, dpCodes.unlockFace, dpCodes.unlockHand, dpCodes.unlockFingerVein, dpCodes.unlockEye, dpCodes.unlockTemporary, dpCodes.unlockDoubleKit, dpCodes.unlockKey, dpCodes.unlockPhoneRemote, dpCodes.unlockVoiceRemote, dpCodes.unlockDoubleKitW, dpCodes.unlockBle, dpCodes.unlockOfflinePd, dpCodes.unlockDynamic
+// dpCodes.unlockOfflineClear,
+// dpCodes.unlockOfflineClearSingle,
+];
+
+/**
+ * 0-未定义xx关锁
+ * 1-手机远程关锁
+ * 2-语音远程关锁
+ * 3-地理围栏关锁
+ * 4-app长按关锁
+ * 5-配件关锁
+ * 6-自动落锁
+ * 7-本地手动落锁
+ */
+const closeTypes = ["UNDEFINED", "APP_REMOTE", "VOICE_REMOTE", "GEO_FENCE", "APP", "FITTINGS", "AUTO", "LOCAL_MANUAL"];
+
+/**
+ * 获取日志记录列表
+ * @param {GetLogsParams} params
+ */
+export const getLogs = async params => {
+  const {
+    page = 1,
+    pageSize = 50
+  } = params || {};
+  const currentUser = await getCurrentUser();
+  const data = await getRecordList({
+    devId: config.devInfo.devId,
+    dpIds: openDps.reduce((res, item) => {
+      if (config.idsByCode[item]) {
+        res.push(config.idsByCode[item]);
+      }
+      return res;
+    }, []),
+    offset: (page - 1) * pageSize,
+    limit: pageSize
+  });
+
+  // 封装数据
+  if (data.datas.length) {
+    const result = data.datas.map(record => {
+      var _record$unionUnlockIn;
+      let closeValue = undefined;
+      let dpValue = record.dpValue;
+      const dpCode = config.codesById[record.dpId];
+      let type = dpCode === dpCodes.lockRecord ? "close_record" : "unlock_record";
+      const dpSchema = config.dpSchema[dpCode];
+      if (dpSchema.type === "raw") {
+        dpValue = base64ToHex(dpValue);
+      }
+      if (type === "close_record") {
+        const closeType = parseInt(dpValue.slice(0, 2), 16);
+        closeValue = closeTypes[closeType] || closeTypes[0];
+      }
+
+      // 设备本地操作记录处理
+      if (dpCode === dpCodes.lockLocalRecord) {
+        type = "local_operation";
+      }
+      return {
+        type,
+        logId: record.historyId.toString(),
+        userId: record.userId,
+        dpId: record.dpId,
+        data: dpValue,
+        dpCode,
+        userName: record.userName,
+        unlockName: record.unlockName,
+        mediaInfo: record.mediaInfoList,
+        unionUnlockInfo: (_record$unionUnlockIn = record.unionUnlockInfo) === null || _record$unionUnlockIn === void 0 ? void 0 : _record$unionUnlockIn.map(item => ({
+          userId: item.userId,
+          userName: item.userName,
+          unlockName: item.unlockName,
+          sn: item.sn,
+          type: unlockDp2Type[item.opMode]
+        })),
+        closeValue,
+        time: record.gmtCreate,
+        currentUser: +record.userId === +currentUser.userId,
+        bindable: record.memberBindableFlag === 1,
+        unlockMethod: type === "unlock_record" ? unlockDp2Type[dpCode] : undefined,
+        localRecord: handleLocalOperation(record.localOperateRecordInfo)
+      };
+    });
+    return {
+      list: result,
+      hasMore: data.hasNext,
+      total: data.totalCount
+    };
+  }
+  return {
+    list: [],
+    hasMore: false,
+    total: 0
+  };
+};
+const alarmDps = [dpCodes.doorbell, dpCodes.familyCall, dpCodes.alarmReminder, dpCodes.alarmLock, dpCodes.unlockOfflineClear, dpCodes.unlockOfflineClearSingle, dpCodes.hijack];
+/**
+ * 获取告警列表
+ * @param {GetAlarmsParams} params
+ */
+export const getAlarms = async params => {
+  const {
+    page = 1,
+    pageSize = 50
+  } = params || {};
+  const currentUser = await getCurrentUser();
+  const data = await getAlarmList({
+    devId: config.devInfo.devId,
+    dpIds: alarmDps.reduce((res, item) => {
+      if (config.idsByCode[item]) {
+        res.push(config.idsByCode[item]);
+      }
+      return res;
+    }, []),
+    offset: (page - 1) * pageSize,
+    limit: pageSize
+  });
+  // 封装数据
+  if (data.datas.length) {
+    const result = data.datas.map(record => {
+      var _record$dps;
+      let dpId = record.dpId;
+      let dpValue = record.dpValue;
+      let dpCode = config.codesById[dpId];
+      const dpSchema = config.dpSchema[dpCode];
+      if (dpSchema.type === "raw") {
+        dpValue = base64ToHex(dpValue);
+      }
+      // 处理劫持告警情况
+      const isHijack = (_record$dps = record.dps) === null || _record$dps === void 0 ? void 0 : _record$dps.some(item => Object.keys(item)[0] === "98");
+      return {
+        type: "alarm_record",
+        logId: record.historyId.toString(),
+        userId: record.userId,
+        dpId: record.dpId,
+        data: dpValue,
+        dpCode,
+        userName: record.userName,
+        unlockName: record.unlockName,
+        mediaInfo: record.mediaInfoList,
+        time: record.gmtCreate,
+        currentUser: +record.userId === +currentUser.userId,
+        bindable: false,
+        isHijack
+      };
+    });
+    return {
+      list: result,
+      hasMore: data.hasNext,
+      total: data.totalCount
+    };
+  }
+  return {
+    list: [],
+    hasMore: false,
+    total: 0
+  };
+};
+/**
+ * 获取相册日志
+ * 仅支持视对讲设备
+ */
+export const getAlbums = async params => {
+  const now = Date.now();
+  // 一年前
+
+  const {
+    page = 1,
+    pageSize = 20,
+    startTime = now - 365 * 24 * 60 * 60 * 1000,
+    endTime = now
+  } = params || {};
+  const data = await getAlbumMessages({
+    devId: config.devInfo.devId,
+    limit: pageSize,
+    offset: (page - 1) * pageSize,
+    safeMode: false,
+    picInclude: true,
+    startTime,
+    endTime
+  });
+  // 格式化数据
+  return {
+    hasMore: data.hasNext,
+    list: data.albumList.map(item => ({
+      id: item.fileId,
+      mediaPath: item.mediaPath,
+      fileKey: item.fileKey,
+      fileUrl: item.fileUrl,
+      mediaBucket: item.mediaBucket,
+      mediaKey: item.mediaKey,
+      aiTypes: item.aiTypes,
+      describe: item.describe,
+      aiInfos: item.aiDetectResults.map(x => ({
+        id: x.bizId,
+        type: x.aiType,
+        name: x.eventTypeDesc,
+        desc: x.desc,
+        happenTime: x.happenTime,
+        isCorrected: x.missStep
+      })),
+      type: item.eventType,
+      createTime: item.uploadMilTime
+    })),
+    allAitypes: data.allAitypes,
+    types: data.eventTypes,
+    langMap: data.eventLangMap
+  };
+};

package/lib/media.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 多媒体相关接口
+ */
+/**
+ * 获取视频的实际播放地址参数
+ */
+interface GetMediaUrlParams {
+    /**
+     * 媒体路径
+     */
+    mediaPath: string;
+    /**
+     * 媒体桶
+     */
+    mediaBucket: string;
+}
+interface MediaUrlResult {
+    mediaUrl: string;
+}
+/**
+ * 获取视频的实际播放地址
+ * @param params
+ * @returns
+ */
+export declare const getMediaUrl: (params: GetMediaUrlParams) => Promise<MediaUrlResult>;
+/**
+ * 跳转到本地相册页面
+ */
+export declare const goToLocalAlbum: (params?: {
+    theme?: "dark" | "light";
+}) => Promise<unknown>;
+/**
+ * 跳转到回放页面
+ * @param params { theme?: "dark" | "light" }
+ * @returns Promise<boolean>
+ */
+export declare const goToPlayback: (params?: {
+    theme?: "dark" | "light";
+}) => Promise<unknown>;
+export declare const openCameraSettings: (params?: {
+    theme?: "dark" | "light";
+}) => Promise<unknown>;
+export {};