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

package/lib/api/index.d.ts

@@ -0,0 +1,5 @@
+export declare const sendPhoneVerifyCode: (params: {
+    account: string;
+    devId: string;
+}) => Promise<unknown>;
+export declare const getActiveTime: (devId: string) => Promise<string>;

package/lib/api/index.js

@@ -0,0 +1,18 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+export const sendPhoneVerifyCode = params => {
+  return requestCloud({
+    api: `${THING}.m.device.user.verifycode.send`,
+    version: "1.0",
+    data: params
+  });
+};
+export const getActiveTime = devId => {
+  return requestCloud({
+    api: `${THING}.m.device.active.date`,
+    version: "1.0",
+    data: {
+      devId
+    }
+  });
+};

package/lib/api/linkage.d.ts

@@ -0,0 +1,161 @@
+export interface LinkageRule {
+    background: string;
+    code: string;
+    description: string;
+    displayColor: string;
+    icon: string;
+    order: number;
+    title: string;
+    ruleId?: string;
+    ruleVO?: {
+        actions: {
+            actionExecutor: string;
+            actionStrategy: string;
+            attribute: number;
+            devDelMark: boolean;
+            enabled: boolean;
+            entityId: string;
+            executorProperty: {
+                topic: string;
+                customParameters: Record<string, any>;
+            };
+            extraProperty: {
+                entityName: string;
+                iconUrl: string;
+                statusDescript: string;
+                type: string;
+            };
+            gmtModified: number;
+            id: string;
+            offGwSync: boolean;
+            orderNum: number;
+            ruleId: string;
+            status: boolean;
+        }[];
+        auditStatus: number;
+        boundForPanel: boolean;
+        boundForWiFiPanel: boolean;
+        code: string;
+        commonField: string;
+        conditions: {
+            attribute: number;
+            condType: number;
+            devDelMark: boolean;
+            enabled: boolean;
+            entityId: string;
+            entityName: string;
+            entitySubIds: string;
+            entityType: number;
+            expr: any[];
+            exprDisplay: "远程开锁 : Unlock";
+            extraInfo: Record<string, any>;
+            handleStrategy: string;
+            iconUrl: string;
+            id: string;
+            orderNum: number;
+            ruleId: string;
+            serviceProvider: string;
+            support: number;
+        }[];
+        containDeviceDelete: boolean;
+        coverIcon: string;
+        description: string;
+        disableTime: number;
+        displayColor: string;
+        enabled: boolean;
+        forceCloudTrigger: boolean;
+        gmtCreate: number;
+        gmtModified: number;
+        id: string;
+        iotAutoAlarm: boolean;
+        isAlarmIssue: boolean;
+        isLogicRule: boolean;
+        linkageType: number;
+        localLinkage: boolean;
+        matchType: number;
+        name: string;
+        needCleanGidSid: boolean;
+        needValidOutOfWork: boolean;
+        newLocalScene: false;
+        offGwSync: boolean;
+        offGwSyncSuccess: boolean;
+        orderWeight: number;
+        outOfWork: number;
+        ownerId: string;
+        panelType: number;
+        permissionCode: string;
+        ruleGenre: number;
+        ruleSource: number;
+        ruleType: number;
+        scenarioRule: boolean;
+        status: true;
+        stickyOnTop: false;
+        subMatchType: number;
+    };
+}
+/**
+ * 获取所有的联动规则
+ * @param deviceId
+ * @returns {Promise<LinkageList>}
+ */
+export declare const getLinkageList: (deviceId: string) => Promise<LinkageRule[]>;
+interface LinkageCondition {
+    entityType: number;
+    entityId: string;
+    entitySubIds: "";
+    iconUrl?: string;
+    expr: [];
+    extraInfo: Record<string, any>;
+}
+interface LinkageAction {
+    actionExecutor: string;
+    entityName: string;
+    extraProperty: {
+        topic: string;
+        customParameters: Record<string, any>;
+    };
+    executorProperty: {
+        topic: string;
+        customParameters: Record<string, any>;
+    };
+}
+interface SaveLinkageParams {
+    devId: string;
+    ownerId: string;
+    name: string;
+    enabled: boolean;
+    extraInfo: Record<string, any>;
+    bizType: string;
+    logicRuleList: {
+        id?: string;
+        name: string;
+        matchType: number;
+        enabled: boolean;
+        scenarioRule: boolean;
+        preConditions: LinkageCondition[];
+        coverIcon: string;
+        displayColor: string;
+        background: string;
+        conditions: LinkageCondition[];
+        actions: LinkageAction[];
+    }[];
+}
+/**
+ * 保存联动规则
+ * @param data
+ * @returns
+ */
+export declare const saveLinkage: (data: SaveLinkageParams) => Promise<unknown>;
+export declare const enableLinkage: (ruleId: string) => Promise<unknown>;
+export declare const disableLinkage: (ruleId: string) => Promise<unknown>;
+/**
+ * 获取剩余短信通知次数
+ * @returns
+ */
+export declare const getRemainingMessage: () => Promise<number>;
+/**
+ * 获取剩余语音通知次数
+ * @returns
+ */
+export declare const getRemainingPhone: () => Promise<number>;
+export {};

package/lib/api/linkage.js

@@ -0,0 +1,74 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+/**
+ * 获取所有的联动规则
+ * @param deviceId
+ * @returns {Promise<LinkageList>}
+ */
+export const getLinkageList = deviceId => {
+  return requestCloud({
+    api: `${THING}.m.linkage.doorlock.rule.query`,
+    version: "2.0",
+    data: {
+      devId: deviceId
+    }
+  });
+};
+/**
+ * 保存联动规则
+ * @param data
+ * @returns
+ */
+export const saveLinkage = data => {
+  return requestCloud({
+    api: `${THING}.m.linkage.device.shell.save`,
+    version: "2.0",
+    data: {
+      shellExpr: data
+    }
+  });
+};
+export const enableLinkage = ruleId => {
+  return requestCloud({
+    api: `${THING}.m.linkage.rule.enable`,
+    version: "1.0",
+    data: {
+      ruleId
+    }
+  });
+};
+export const disableLinkage = ruleId => {
+  return requestCloud({
+    api: `${THING}.m.linkage.rule.disable`,
+    version: "1.0",
+    data: {
+      ruleId
+    }
+  });
+};
+
+/**
+ * 获取剩余短信通知次数
+ * @returns
+ */
+export const getRemainingMessage = () => {
+  return requestCloud({
+    api: `${THING}.m.notification.subscribe.info`,
+    version: "1.0",
+    data: {
+      notificationType: "sms_notification"
+    }
+  });
+};
+
+/**
+ * 获取剩余语音通知次数
+ * @returns
+ */
+export const getRemainingPhone = () => {
+  return requestCloud({
+    api: `${THING}.m.mobile.voice.times.count`,
+    version: "1.0",
+    data: {}
+  });
+};

package/lib/api/lock.d.ts

@@ -0,0 +1,195 @@
+/**
+ * 直接通过云端开关锁
+ * @param params
+ * @returns
+ */
+export declare const openDoorByCloud: (deviceId: string, isOpen: boolean) => Promise<unknown>;
+export declare const checkRemoteKey: (deviceId: string) => Promise<{
+    effectiveTime: number;
+    invalidTime: number;
+    password: string;
+}>;
+/**
+ * 获取开锁密钥
+ * @param deviceId
+ * @returns
+ */
+export declare const getDoorKey: (deviceId: string) => Promise<{
+    effectiveTime: number;
+    invalidTime: number;
+    password: string;
+}>;
+interface UnlockMethodDetailParams {
+    devId: string;
+    opModeId: number;
+}
+interface NotifyInfo {
+    /**
+     * 是否开启 App 消息通知
+     */
+    appSend?: boolean;
+    /**
+     * 短信通知手机号，有手机号时，表示开启短信通知
+     */
+    msgPhone?: string;
+    /**
+     * 短信通知国家码
+     */
+    countryCode?: string;
+    /**
+     * 目标用户 id
+     */
+    targetUserId?: number;
+}
+/**
+ * 开锁方式详细信息
+ */
+interface UnlockMethodDetail {
+    /**
+     * 是否为云端绑定的开锁方式
+     */
+    allocateFlag: number;
+    /**
+     * 开锁方式状态
+     */
+    phase: number;
+    /**
+     * 开锁方式对应的 dp id
+     */
+    opmode: string;
+    /**
+     * 是否为特殊开锁方式
+     */
+    unlockAttr: number;
+    /**
+     * 开锁方式名称
+     */
+    unlockName: string;
+    /**
+     * 所属用户 id
+     */
+    userId: string;
+    /**
+     * 开锁方式硬件id
+     */
+    opmodeValue: string;
+    /**
+     * 开锁方式 id
+     */
+    unlockId: string;
+    /**
+     * 锁端用户 id
+     */
+    lockUserId: number;
+    /**
+     * 开锁方式硬件 id
+     */
+    opmodeId: string;
+    voiceAttr: number;
+    /**
+     * 时效配置
+     */
+    userTimeSet: string;
+    /**
+     * 用户类型
+     */
+    userType: number;
+    sourceAttribute: number;
+    /**
+     * 开锁消息通知配置
+     */
+    notifyInfo?: NotifyInfo;
+}
+export declare const getUnlockMethodInfo: (params: UnlockMethodDetailParams) => Promise<UnlockMethodDetail>;
+export declare const fetchCreatePasswordSN: (params: {
+    dpId: number;
+    devId: string;
+}) => Promise<number>;
+interface CreateUnlockMethodParams {
+    devId: string;
+    userId: string;
+    unlockId: string;
+    unlockName?: string;
+    unlockAttr: number;
+    unlockDetail?: string;
+    notifyInfo?: {
+        appSend?: boolean;
+        msgPhone?: string;
+        countryCode?: string;
+        msgPhoneVerifyCode?: string;
+    };
+}
+export declare const createUnlockMethod: (params: CreateUnlockMethodParams) => Promise<{
+    opModeId: number;
+    unlockName: string;
+}>;
+interface EditUnlockMethodParams {
+    devId: string;
+    opModeId: number;
+    unlockName?: string;
+    unlockAttr: number;
+    unlockDetail?: string;
+    notifyInfo?: {
+        appSend?: boolean;
+        msgPhone?: string;
+        countryCode?: string;
+        msgPhoneVerifyCode?: string;
+    };
+}
+export declare const editUnlockMethod: (params: EditUnlockMethodParams) => Promise<unknown>;
+interface RemoveUnlockMethodParams {
+    devId: string;
+    opmodeId: number;
+}
+/**
+ *  删除解锁方式
+ * @param  {RemoveUnlockMethodParams} params
+ * @returns
+ */
+export declare const removeUnlockMethod: (params: RemoveUnlockMethodParams) => Promise<unknown>;
+interface FetchSyncUnlockMethodInfoParams {
+    devId: string;
+    dpIds: string[];
+}
+interface FetchSyncUnlockMethodInfo {
+    ins: string;
+    distributed: boolean;
+}
+export declare const fetchSyncUnlockMethodInfo: (params: FetchSyncUnlockMethodInfoParams) => Promise<FetchSyncUnlockMethodInfo>;
+interface CheckUnbindUnlockMethodParams {
+    devId: string;
+}
+export declare const checkFreeUnlockMethods: (params: CheckUnbindUnlockMethodParams) => Promise<number | boolean>;
+interface FetchFreeUnlockMethodsParams {
+    devId: string;
+}
+export interface UnbindUnlockMethods {
+    opmode: number;
+    standardDp: string;
+    unlockInfo: {
+        opmodeId: number;
+        unlockId: string;
+        unlockName: string;
+        unlockSn: number;
+    }[];
+}
+export declare const fetchFreeUnlockMethods: (params: FetchFreeUnlockMethodsParams) => Promise<UnbindUnlockMethods[]>;
+interface BindUnlockMethodToUserParams {
+    devId: string;
+    userId: string;
+    unlockIds: string[];
+}
+export declare const bindUnlockMethodToUser: (params: BindUnlockMethodToUserParams) => Promise<boolean>;
+interface UnbindMemberUnlockMethodParams {
+    devId: string;
+    userId: string;
+    unlockIds: string[];
+}
+export declare const unbindMemberUnlockMethod: (params: UnbindMemberUnlockMethodParams) => Promise<boolean>;
+interface BindUnlockMethodToUserByRecordParams {
+    devId: string;
+    userId: string;
+    unlockIds: string[];
+}
+export declare const bindUnlockMethodToUserByRecord: (params: BindUnlockMethodToUserByRecordParams) => Promise<boolean>;
+export {};

package/lib/api/lock.js

@@ -0,0 +1,129 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+
+/**
+ * 直接通过云端开关锁
+ * @param params
+ * @returns
+ */
+export const openDoorByCloud = (deviceId, isOpen) => {
+  return requestCloud({
+    api: `${THING}.m.zigbee.lock.remotepwd.execute`,
+    version: "1.0",
+    data: {
+      devId: deviceId,
+      open: isOpen
+    }
+  });
+};
+export const checkRemoteKey = async deviceId => {
+  return requestCloud({
+    api: "m.lock.ble.remote.unlock.check",
+    version: "1.0",
+    data: {
+      devId: deviceId
+    }
+  });
+};
+
+/**
+ * 获取开锁密钥
+ * @param deviceId
+ * @returns
+ */
+export const getDoorKey = deviceId => {
+  return requestCloud({
+    api: "m.lock.ble.remote.unlock.get",
+    version: "1.0",
+    data: {
+      devId: deviceId
+    }
+  });
+};
+
+/**
+ * 开锁方式详细信息
+ */
+
+export const getUnlockMethodInfo = params => {
+  return requestCloud({
+    api: `${THING}.m.device.member.opmode.detail`,
+    version: "1.0",
+    data: params
+  });
+};
+export const fetchCreatePasswordSN = params => {
+  return requestCloud({
+    api: `${THING}.m.device.dp.sn.get`,
+    version: "1.0",
+    data: params
+  });
+};
+export const createUnlockMethod = params => {
+  return requestCloud({
+    api: `${THING}.m.device.member.opmode.add`,
+    version: "5.0",
+    data: params
+  });
+};
+export const editUnlockMethod = params => {
+  return requestCloud({
+    api: `${THING}.m.device.member.opmode.update`,
+    version: "5.0",
+    data: params
+  });
+};
+/**
+ *  删除解锁方式
+ * @param  {RemoveUnlockMethodParams} params
+ * @returns
+ */
+export const removeUnlockMethod = params => {
+  return requestCloud({
+    api: `${THING}.m.device.member.opmode.remove`,
+    version: "2.0",
+    data: params
+  });
+};
+export const fetchSyncUnlockMethodInfo = params => {
+  return requestCloud({
+    api: `${THING}.m.device.opmode.sync.rise`,
+    version: "2.0",
+    data: params
+  });
+};
+export const checkFreeUnlockMethods = params => {
+  return requestCloud({
+    api: `${THING}.m.device.unlock.waitassign`,
+    version: "1.0",
+    data: params
+  });
+};
+export const fetchFreeUnlockMethods = params => {
+  return requestCloud({
+    api: `${THING}.m.device.unlock.assignlist`,
+    version: "1.0",
+    data: params
+  });
+};
+export const bindUnlockMethodToUser = params => {
+  return requestCloud({
+    api: `${THING}.m.device.user.unlock.allocate`,
+    version: "1.0",
+    data: params
+  });
+};
+export const unbindMemberUnlockMethod = params => {
+  return requestCloud({
+    api: `${THING}.m.device.user.unlock.unbind`,
+    version: "1.0",
+    data: params
+  });
+};
+export const bindUnlockMethodToUserByRecord = params => {
+  return requestCloud({
+    api: `${THING}.m.device.user.unlock.bind`,
+    version: "1.0",
+    data: params
+  });
+};