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

package/lib/api/log.d.ts

@@ -0,0 +1,166 @@
+import { DpValue, LocalOperateRecordInfo, MediaInfo } from "../interface";
+interface UnionUnlockInfo {
+    userId: string;
+    userName: string;
+    unlockName: string;
+    sn: number;
+    opMode: "unlock_fingerprint" | "unlock_password" | "unlock_card" | "unlock_face" | "unlock_finger_vein" | "unlock_hand" | "unlock_eye";
+}
+interface LatestLogs {
+    unReadCount: number;
+    operateRecordVOList: {
+        currentUser?: boolean;
+        dpId: number;
+        logCategory: "alarm_record" | "close_record" | "unlock_record" | "operation";
+        logId: string;
+        logType: string;
+        memberBindableFlag: boolean;
+        recordType: number;
+        time: number;
+        unlockName: string;
+        userId: string;
+        userName: string;
+        mediaInfoList?: MediaInfo[];
+        unionUnlockInfo?: UnionUnlockInfo[];
+        unlockNameRosettaKey?: string;
+        data: boolean | number | string;
+    }[];
+}
+export declare const getLatest2Log: (devId: string) => Promise<LatestLogs>;
+interface GetRecordListParams {
+    devId: string;
+    dpIds: number[];
+    limit: number;
+    offset: number;
+}
+interface LogInfo {
+    aitypes: string[];
+    avatar: string;
+    devId: string;
+    dpId: number;
+    dpValue: any;
+    dps: Record<number, any>[];
+    gmtCreate: number;
+    historyId: number;
+    mediaInfoList?: MediaInfo[];
+    memberBindableFlag: 0 | 1;
+    recordId: string;
+    recordType: string;
+    status: number;
+    tags: number;
+    unlockName: string;
+    userId: string;
+    userName: string;
+    uuid: string;
+    data?: string;
+    unionUnlockInfo?: UnionUnlockInfo[];
+    localOperateRecordInfo?: LocalOperateRecordInfo;
+}
+export interface LogsResult {
+    datas: LogInfo[];
+    hasNext: boolean;
+    totalCount: number;
+}
+export declare const getRecordList: (params: GetRecordListParams) => Promise<LogsResult>;
+interface AlarmData {
+    aitypes: string[];
+    avatar: string;
+    devId: string;
+    dpId: number;
+    dpValue: DpValue;
+    dps: Record<number, any>[];
+    gmtCreate: number;
+    historyId: number;
+    recordId: string;
+    recordType: string;
+    status: number;
+    tags: number;
+    unlockName: string;
+    userId: string;
+    userName: string;
+    mediaInfoList?: MediaInfo[];
+}
+interface GetAlarmListResult {
+    datas: AlarmData[];
+    hasNext: boolean;
+    totalCount: number;
+}
+export declare const getAlarmList: (params: GetRecordListParams) => Promise<GetAlarmListResult>;
+interface GetAlbumMessagesParams {
+    devId: string;
+    limit: number;
+    offset: number;
+    safeMode: boolean;
+    picInclude: boolean;
+    startTime: number;
+    endTime: number;
+}
+interface AlbumItem {
+    /**
+     * AI 检测结果
+     */
+    aiDetectResults: {
+        bizId: number;
+        aiType: number;
+        desc: string;
+        eventTypeDesc: string;
+        happenTime: number;
+        missStep: boolean;
+    }[];
+    /**
+     *  AI 检测结果类型
+     */
+    aiTypes: number[];
+    /**
+     * 消息描述
+     */
+    describe: string;
+    /**
+     * 消息类型
+     */
+    eventType: number;
+    /**
+     * 上传时间，单位毫秒
+     */
+    uploadMilTime: number;
+    /**
+     * 媒体路径
+     */
+    mediaPath: string;
+    /**
+     * 图片 id
+     */
+    fileId: string;
+    /**
+     * 图片 key
+     */
+    fileKey: string;
+    /**
+     * 图片 url
+     */
+    fileUrl: string;
+    /**
+     * 媒体桶
+     */
+    mediaBucket: string;
+    /**
+     * 媒体 key
+     */
+    mediaKey: string;
+}
+export declare const getAlbumMessages: (params: GetAlbumMessagesParams) => Promise<{
+    hasNext: boolean;
+    albumList: AlbumItem[];
+    allAitypes: number[];
+    eventTypes: number[];
+    eventLangMap: string[];
+}>;
+interface GetMediaUrlParams {
+    devId: string;
+    mediaPath: string;
+    mediaBucket: string;
+}
+export declare const getMediaUrl: (params: GetMediaUrlParams) => Promise<{
+    mediaUrl: string;
+}>;
+export {};

package/lib/api/log.js

@@ -0,0 +1,44 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+/*
+ * 获取最近两条数据
+ * @devId 设备id
+ * @returns {Promise<ResLatestLog>}
+ */
+export const getLatest2Log = devId => {
+  return requestCloud({
+    api: "m.lock.log.latest2",
+    version: "1.0",
+    data: {
+      devId
+    }
+  });
+};
+export const getRecordList = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.history.list`,
+    version: "1.0",
+    data: params
+  });
+};
+export const getAlarmList = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.alarm.list`,
+    version: "3.0",
+    data: params
+  });
+};
+export const getAlbumMessages = params => {
+  return requestCloud({
+    api: "m.lock.album.media.list",
+    version: "3.0",
+    data: params
+  });
+};
+export const getMediaUrl = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.media.path`,
+    version: "2.0",
+    data: params
+  });
+};

package/lib/api/setting.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 获取设备某些属性
+ * @param params
+ * @returns
+ */
+declare const getDeviceProperties: (deviceId: string, props: string[]) => Promise<Record<string, any>>;
+/**
+ * 设置设备属性，支持同时设置多个属性
+ * @param devId
+ * @param data
+ * @returns
+ */
+declare const setDeviceProperties: (devId: string, data: Record<string, any>) => Promise<void>;
+export { setDeviceProperties, getDeviceProperties };

package/lib/api/setting.js

@@ -0,0 +1,36 @@
+import { THING } from "../utils/constant";
+import { requestCloud } from "../utils/device";
+
+/**
+ * 获取设备某些属性
+ * @param params
+ * @returns
+ */
+const getDeviceProperties = (deviceId, props) => {
+  return requestCloud({
+    api: `${THING}.m.device.props.fetch`,
+    version: "1.0",
+    data: {
+      devId: deviceId,
+      props: props.join(",")
+    }
+  });
+};
+
+/**
+ * 设置设备属性，支持同时设置多个属性
+ * @param devId
+ * @param data
+ * @returns
+ */
+const setDeviceProperties = (devId, data) => {
+  return requestCloud({
+    api: `${THING}.m.device.props.save`,
+    version: "1.0",
+    data: {
+      devId,
+      propKvs: data
+    }
+  });
+};
+export { setDeviceProperties, getDeviceProperties };

package/lib/api/temp.d.ts

@@ -0,0 +1,211 @@
+interface CreateTempPasswordParams {
+    devId: string;
+    sn: number;
+    effectiveTime: number;
+    invalidTime: number;
+    availTime?: number;
+    name?: string;
+    password?: string;
+    symbolic: boolean;
+    dpTunnel?: number;
+    schedule?: {
+        allDay: boolean;
+        effectiveTime: number;
+        invalidTime: number;
+        workingDay: number;
+    }[];
+}
+export interface CreateTempPasswordResult {
+    unlockBindingId: string;
+    name: string;
+    tyNum?: number;
+}
+/**
+ * 创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
+export interface ValidateTempPwdParams {
+    password: string;
+    devId: string;
+    name?: string;
+    effectiveTime: number;
+    invalidTime: number;
+    schedule: {
+        allDay: boolean;
+        effectiveTime: number;
+        invalidTime: number;
+        workingDay: number;
+    }[];
+}
+/**
+ * 临时密码参数检验
+ * @param {ValidateTempPwdProps} params - 临时密码验证参数
+ * @returns {Promise<{ valid: boolean; errorCode?: number }>} - 验证结果的 Promise
+ */
+export declare const validateTempPwd: (params: ValidateTempPwdParams) => Promise<{
+    valid: boolean;
+    errorCode?: string;
+}>;
+interface UpdateTempPasswordParams {
+    unlockBindingId: string;
+    devId: string;
+    effectiveTime?: number;
+    invalidTime?: number;
+    name?: string;
+    phase?: number;
+    symbolic: boolean;
+    dpTunnel: number;
+    schedule: {
+        allDay: boolean;
+        effectiveTime: number;
+        invalidTime: number;
+        workingDay: number;
+    }[];
+}
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export declare const updateTemporaryPassword: (params: UpdateTempPasswordParams) => Promise<boolean>;
+interface GetTempPasswordParams {
+    devId: string;
+    pwdId?: string;
+}
+export declare const getTempPassword: (params: GetTempPasswordParams) => Promise<EffectivePasswrodItem>;
+interface DeleteTempPasswordParams {
+    unlockBindingId: string;
+    devId: string;
+    symbolic: boolean;
+    dpTunnel: number;
+}
+export declare const deleteTempPassword: (params: DeleteTempPasswordParams) => Promise<unknown>;
+export interface CreateOfflinePasswordParams {
+    devId: string;
+    pwdType: string;
+    gmtStart: number;
+    gmtExpired: number;
+    pwdName?: string;
+    countryCode?: string;
+    mobile?: string;
+}
+export interface OfflinePwdResult {
+    /**
+     * 离线密码失效时间戳，单位为秒
+     */
+    gmtExpired: number;
+    /**
+     * 离线密码生效时间戳，单位为秒
+     */
+    gmtStart: number;
+    /**
+     * 密码内容
+     */
+    pwd: string;
+    /**
+     * 密码 ID
+     */
+    pwdId: string;
+    /**
+     * 密码名称
+     */
+    pwdName: string;
+    /**
+     * 解锁绑定 ID
+     */
+    unlockBindingId: string;
+}
+/**
+ * 获取离线临时密码
+ * @param {CreateOfflinePasswordParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export declare const createOfflinePassword: (params: CreateOfflinePasswordParams) => Promise<OfflinePwdResult>;
+interface GetDynapwdParams {
+    devId: string;
+    adminPwd?: string;
+}
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<{
+    dynamicPassword: string;
+}>;
+interface RevokeOfflinePasswordParams {
+    devId: string;
+    unlockBindingId: string;
+    name?: string;
+}
+/**
+ * 删除离线临时密码
+ * @param {RevokeOfflinePasswordParams} params - 请求参数
+ * @returns {Promise<string>} - 响应结果的 Promise
+ */
+export declare const revokeOfflinePassword: (params: RevokeOfflinePasswordParams) => Promise<OfflinePwdResult>;
+interface EffectiveListParams {
+    devId: string;
+    authTypes: string[];
+}
+interface EffectivePasswrodItem {
+    effective: number;
+    unlockBindingId: string;
+    effectiveTime: number;
+    failReason: number;
+    invalidTime: number;
+    name: string;
+    phase: number;
+    scheduleDetails: {
+        allDay: boolean;
+        effectiveTime: number;
+        invalidTime: number;
+        timeZoneId: string;
+        workingDay: number;
+    }[];
+    opModeType: number;
+    opModeSubType: number;
+    sn: number;
+    opModeInfo?: {
+        hasClearPwd?: boolean;
+        revokedPwdName?: string;
+        revokedPwdEffectiveTime?: number;
+        revokedPwdInvalidTime?: number;
+    };
+}
+export declare const fetchEffectiveList: (params: EffectiveListParams) => Promise<EffectivePasswrodItem[]>;
+interface fetchInvalidListParams {
+    devId: string;
+    offset: number;
+    limit: number;
+}
+export declare const fetchInvalidList: (params: fetchInvalidListParams) => Promise<{
+    datas: EffectivePasswrodItem[];
+    hasNext: boolean;
+    totalCount: number;
+}>;
+export declare const clearInvalidTempList: (params: {
+    devId: string;
+}) => Promise<boolean>;
+interface ReNameTemporaryParams {
+    devId: string;
+    name: string;
+    unlockBindingId: string;
+}
+export declare const reNameTemporary: (params: ReNameTemporaryParams) => Promise<unknown>;
+interface ReNameOfflineParams {
+    devId: string;
+    pwdName: string;
+    unlockBindingId: string;
+}
+export declare const reNameOffline: (params: ReNameOfflineParams) => Promise<unknown>;
+interface GetSyncTempPasswordsParams {
+    devId: string;
+    isUpt: boolean;
+}
+export declare const getSyncTempPasswords: (params: GetSyncTempPasswordsParams) => Promise<{
+    pwdList: any[];
+}>;
+export {};

package/lib/api/temp.js

@@ -0,0 +1,130 @@
+import { requestCloud } from "../utils/device";
+import { THING } from "../utils/constant";
+/**
+ * 创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export const createTemporaryPassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.temppwd.create`,
+    version: "8.0",
+    data: params
+  });
+};
+/**
+ * 临时密码参数检验
+ * @param {ValidateTempPwdProps} params - 临时密码验证参数
+ * @returns {Promise<{ valid: boolean; errorCode?: number }>} - 验证结果的 Promise
+ */
+export const validateTempPwd = async params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.temppwd.validate`,
+    version: "3.0",
+    data: params
+  });
+};
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export const updateTemporaryPassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.temppwd.update`,
+    version: "4.0",
+    data: params
+  });
+};
+export const getTempPassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.temppwd.detail`,
+    version: "1.0",
+    data: params
+  });
+};
+export const deleteTempPassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.temppwd.remove`,
+    version: "2.0",
+    data: params
+  });
+};
+/**
+ * 获取离线临时密码
+ * @param {CreateOfflinePasswordParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export const createOfflinePassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.offlinepwd.get`,
+    version: "3.0",
+    data: params
+  });
+};
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export const getDynamicPassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.dynapwd.get`,
+    version: "3.0",
+    data: params
+  });
+};
+/**
+ * 删除离线临时密码
+ * @param {RevokeOfflinePasswordParams} params - 请求参数
+ * @returns {Promise<string>} - 响应结果的 Promise
+ */
+export const revokeOfflinePassword = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.offlinepwd.revoke`,
+    version: "2.0",
+    data: params
+  });
+};
+export const fetchEffectiveList = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.auth.list`,
+    version: "1.0",
+    data: params
+  });
+};
+export const fetchInvalidList = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.auth.list.invalid`,
+    version: "1.0",
+    data: params
+  });
+};
+export const clearInvalidTempList = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.auth.list.clear`,
+    version: "1.0",
+    data: params
+  });
+};
+export const reNameTemporary = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.temppwd.name`,
+    version: "1.0",
+    data: params
+  });
+};
+export const reNameOffline = params => {
+  return requestCloud({
+    api: `${THING}.m.device.lock.offlinepwd.name.update`,
+    version: "2.0",
+    data: params
+  });
+};
+export const getSyncTempPasswords = params => {
+  return requestCloud({
+    api: "m.lock.device.lock.tempwd.sync",
+    version: "1.0",
+    data: params
+  });
+};