@ray-js/api 1.5.0-beta.12 → 1.5.1

package/lib/cloud/doorlock/device.md

@@ -0,0 +1,265 @@
+## setDeviceProperties
+
+设置设备属性。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { setDeviceProperties } from '@ray-js/ray'
+```
+
+### 参数
+
+**SetDevicePropertiesParams**
+
+| 属性    | 类型     | 必填 | 说明                                               |
+| ------- | -------- | ---- | -------------------------------------------------- |
+| devId   | `string` | 是   | 设备 ID                                            |
+| propKvs | `string` | 是   | JSON 字符串，例如：`{"LOST_ALERTER_HELPER": true}` |
+
+### 返回
+
+**SetDevicePropertiesResponse**
+
+`boolean`，表示设置是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 设置设备属性
+ */
+export function setDeviceProperties(
+  params: SetDevicePropertiesParams
+): Promise<SetDevicePropertiesResponse>
+```
+
+## getDeviceProperties
+
+查看设置的设备属性。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getDeviceProperties } from '@ray-js/ray'
+```
+
+### 参数
+
+**GetDevicePropertiesParams**
+
+| 属性  | 类型     | 必填 | 说明                                                          |
+| ----- | -------- | ---- | ------------------------------------------------------------- |
+| devId | `string` | 是   | 设备 ID                                                       |
+| props | `string` | 是   | 属性代码字符串，多个代码用逗号隔开，如："LOST_ALERTER_HELPER" |
+
+### 返回
+
+**GetDevicePropertiesResponse**
+
+`Record<string, string>`，返回参数键值对，key 为属性代码，值为对应状态字符串。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查看设置的设备属性
+ */
+export function getDeviceProperties(
+  params: GetDevicePropertiesParams
+): Promise<GetDevicePropertiesResponse>
+```
+
+## getMemberList
+
+获取家庭成员基础信息列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getMemberList } from '@ray-js/ray'
+```
+
+### 参数
+
+**MemberListParams**
+
+| 属性  | 类型     | 必填 | 说明     |
+| ----- | -------- | ---- | -------- |
+| devId | `string` | 是   | 门锁编号 |
+
+### 返回
+
+**MemberListResponse**
+
+`Array<MemberListResponseItem>`，包含家庭成员基础信息列表项。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取家庭成员基础信息列表
+ */
+export function getMemberList(params: MemberListParams): Promise<MemberListResponse>
+```
+
+## syncUnlockMode
+
+解锁方式同步。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { syncUnlockMode } from '@ray-js/ray'
+```
+
+### 参数
+
+**UnlockSyncParams**
+
+| 属性  | 类型            | 必填 | 说明                  |
+| ----- | --------------- | ---- | --------------------- |
+| devId | `string`        | 是   | 门锁编号              |
+| dpIds | `Array<string>` | 是   | 需要同步的解锁方式 dp |
+
+### 返回
+
+**UnlockSyncResponse**
+
+| 属性        | 类型     | 说明                   |
+| ----------- | -------- | ---------------------- |
+| ins         | `string` | 同步指令（仅协议部分） |
+| distributed | `number` | 是否需要下发           |
+| dpId        | `number` | dp 点                  |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 解锁方式同步
+ */
+export function syncUnlockMode(params: UnlockSyncParams): Promise<UnlockSyncResponse>
+```
+
+## queryDateFormat
+
+查询时间对应的格式。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryDateFormat } from '@ray-js/ray'
+```
+
+### 参数
+
+**QueryDateFormatParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+| uiId  | `string` | 是   | 面板 ID |
+
+### 返回
+
+**QueryDateFormatResponse**
+
+`string`，日期格式化格式。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查询时间对应的格式
+ */
+export function queryDateFormat(params: QueryDateFormatParams): Promise<QueryDateFormatResponse>
+```
+
+## queryDeviceActiveDate
+
+用户获取设备自身的激活时间（配网时间）。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryDeviceActiveDate } from '@ray-js/ray'
+```
+
+### 参数
+
+**QueryActiveDateParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**QueryActiveDateResponse**
+
+`string`，64 dp password_offline_time 最新数据。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 用户获取设备自身的激活时间（配网时间）
+ */
+export function queryDeviceActiveDate(
+  params: QueryActiveDateParams
+): Promise<QueryActiveDateResponse>
+```
+
+## queryDeviceTrackDetails
+
+获取设备位置。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryDeviceTrackDetails } from '@ray-js/ray'
+```
+
+### 参数
+
+**QueryTrackDetailsParams**
+
+| 属性      | 类型     | 必填 | 说明     |
+| --------- | -------- | ---- | -------- |
+| devId     | `string` | 是   | 设备 ID  |
+| startTime | `number` | 是   | 开始时间 |
+| stopTime  | `number` | 是   | 结束时间 |
+
+### 返回
+
+**QueryTrackDetailsResponse**
+
+| 属性 | 类型     | 说明 |
+| ---- | -------- | ---- |
+| lat  | `number` | 纬度 |
+| lng  | `number` | 经度 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取设备位置
+ */
+export function queryDeviceTrackDetails(
+  params: QueryTrackDetailsParams
+): Promise<QueryTrackDetailsResponse>
+```

package/lib/cloud/doorlock/index.d.ts

@@ -0,0 +1,10 @@
+export * from './old';
+export * from './auth';
+export * from './device';
+export * from './log';
+export * from './member-opmode';
+export * from './member';
+export * from './offline-pwd';
+export * from './temp-pwd';
+export * from './unlock';
+export * from './unlock-method';

package/lib/cloud/doorlock/index.js

@@ -0,0 +1,20 @@
+export * from './old';
+
+// 授权相关
+export * from './auth';
+// 设备相关
+export * from './device';
+// 日志相关
+export * from './log';
+// 成员解锁相关
+export * from './member-opmode';
+// 用户相关
+export * from './member';
+// 离线临时密码相关
+export * from './offline-pwd';
+// 临时开锁相关
+export * from './temp-pwd';
+// 解锁相关
+export * from './unlock';
+// 解锁方式分配相关
+export * from './unlock-method';

package/lib/cloud/doorlock/log.d.ts

@@ -0,0 +1,113 @@
+type LatestLogParams = {
+    devId: string;
+};
+type UnionUnlockInfo = {
+    userName?: string;
+    opMode?: string;
+    unlockName?: string;
+    currentUser?: boolean;
+    sn?: number;
+};
+type LatestLogResponse = {
+    exist: boolean;
+    logId: number;
+    logCategory: string;
+    logType: string;
+    recordType?: number;
+    unlockNameRosettaKey?: string;
+    currentUser?: boolean;
+    userId?: string;
+    userName?: string;
+    unlockName?: string;
+    time: number;
+    relateDevName?: string;
+    relateOpMode?: string;
+    unionUnlockInfo?: UnionUnlockInfo;
+    data?: string;
+    unReadCount?: number;
+};
+/**
+ * 查询最近一条日志记录
+ * @param   {LatestLogParams} params  - 包含设备Id的参数
+ * @returns {Promise<LatestLogResponse>} - 包含请求结果和状态的响应
+ */
+export declare const getLatestLog: (params: LatestLogParams) => Promise<LatestLogResponse>;
+type UserAction = {
+    userType: number;
+    userId: number;
+    operClassify: number;
+    operType: number;
+    operDetail: string;
+    toUserType: number;
+    toUserId: number;
+};
+type MediaInfo = {
+    fileUrl: string;
+    fileKey: string;
+    mediaPath: string;
+    mediaBucket: string;
+    mediaKey: string;
+};
+type LogRecord = {
+    logId: number;
+    logCategory: number;
+    logType: string;
+    recordType?: number;
+    unlockNameRosettaKey?: string;
+    currentUser?: boolean;
+    userId?: string;
+    userName?: string;
+    memberBindableFlag: boolean;
+    unlockName?: string;
+    time: number;
+    relateDevName?: string;
+    relateOpMode?: string;
+    unionUnlockInfo?: string;
+    mediaInfoList?: MediaInfo[];
+    localOperateRecordInfo?: UserAction;
+};
+type QueryLogRecordParams = {
+    devId: string;
+    logCategories?: string[];
+    userIds?: string[];
+    onlyShowMediaRecord: boolean;
+    startTime?: number;
+    endTime?: number;
+    lastRowKey?: string;
+    limit: number;
+};
+type QueryLogRecordResponse = LogRecord[];
+/**
+ *  查询日志记录
+ * @param  {QueryLogRecordParams} params
+ * @returns  {Promise<QueryLogRecordResponse>} - 包含请求结果和状态的响应
+ */
+export declare const queryLogRecord: (params: QueryLogRecordParams) => Promise<QueryLogRecordResponse>;
+type UploadLogRecordResult = boolean;
+type UploadLogRecordParams = {
+    devId: string;
+    logType: string;
+    data: string[];
+};
+/**
+ *  上报操作日志记录
+ * @param  {UploadLogRecordParams} params
+ * @returns  {Promise<UploadLogRecordResult>}
+ */
+export declare const uploadLogRecord: (params: UploadLogRecordParams) => Promise<UploadLogRecordResult>;
+type QueryAlbumRecordParams = {
+    devId: string;
+    offset: number;
+    limit: number;
+};
+type QueryAlbumRecordResponse = {
+    eventTypes: string;
+    albumList: any[];
+};
+/**
+ * 分页获取获取可以查看的相册列表
+ * @param  {QueryAlbumRecordParams} params
+ * @returns  {Promise<QueryAlbumRecordResponse>}
+ */
+export declare const queryAlbumRecord: (params: QueryAlbumRecordParams) => Promise<QueryAlbumRecordResponse>;
+export {};

package/lib/cloud/doorlock/log.js

@@ -0,0 +1,53 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+/**
+ * 查询最近一条日志记录
+ * @param   {LatestLogParams} params  - 包含设备Id的参数
+ * @returns {Promise<LatestLogResponse>} - 包含请求结果和状态的响应
+ */
+export const getLatestLog = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.latest"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ *  查询日志记录
+ * @param  {QueryLogRecordParams} params
+ * @returns  {Promise<QueryLogRecordResponse>} - 包含请求结果和状态的响应
+ */
+export const queryLogRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.list"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ *  上报操作日志记录
+ * @param  {UploadLogRecordParams} params
+ * @returns  {Promise<UploadLogRecordResult>}
+ */
+export const uploadLogRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.upload"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 2.4. m.lock.album.media.list
+
+/**
+ * 分页获取获取可以查看的相册列表
+ * @param  {QueryAlbumRecordParams} params
+ * @returns  {Promise<QueryAlbumRecordResponse>}
+ */
+export const queryAlbumRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.lock.album.media.list"),
+    version: '2.0',
+    data: params
+  });
+};

package/lib/cloud/doorlock/log.md

@@ -0,0 +1,153 @@
+## getLatestLog
+
+查询最近一条日志记录。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getLatestLog } from '@ray-js/ray'
+```
+
+### 参数
+
+**LatestLogParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**LatestLogResponse**
+
+结构包含日志记录的各种详细信息。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查询最近一条日志记录
+ */
+export function getLatestLog(params: LatestLogParams): Promise<LatestLogResponse>
+```
+
+## queryLogRecord
+
+查询日志记录。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryLogRecord } from '@ray-js/ray'
+```
+
+### 参数
+
+**QueryLogRecordParams**
+
+| 属性                | 类型       | 必填 | 说明                         |
+| ------------------- | ---------- | ---- | ---------------------------- |
+| devId               | `string`   | 是   | 设备 ID                      |
+| logCategories       | `string[]` | 否   | 日志大类                     |
+| userIds             | `string[]` | 否   | 用户 ID 列表                 |
+| onlyShowMediaRecord | `boolean`  | 是   | 是否仅显示带图片或视频的记录 |
+| startTime           | `number`   | 否   | 开始时间                     |
+| endTime             | `number`   | 否   | 结束时间                     |
+| lastRowKey          | `string`   | 否   | 上一页的数据 key             |
+| limit               | `number`   | 是   | 每页数据个数                 |
+
+### 返回
+
+**QueryLogRecordResponse**
+
+`Array<LogRecord>`，包含日志记录的数组。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查询日志记录
+ */
+export function queryLogRecord(params: QueryLogRecordParams): Promise<QueryLogRecordResponse>
+```
+
+## uploadLogRecord
+
+上报操作日志记录。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { uploadLogRecord } from '@ray-js/ray'
+```
+
+### 参数
+
+**UploadLogRecordParams**
+
+| 属性    | 类型       | 必填 | 说明     |
+| ------- | ---------- | ---- | -------- |
+| devId   | `string`   | 是   | 设备 ID  |
+| logType | `string`   | 是   | 日志类型 |
+| data    | `string[]` | 是   | 业务参数 |
+
+### 返回
+
+**UploadLogRecordResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 上报操作日志记录
+ */
+export function uploadLogRecord(params: UploadLogRecordParams): Promise<UploadLogRecordResult>
+```
+
+## queryAlbumRecord
+
+分页获取可以查看的相册列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryAlbumRecord } from '@ray-js/ray'
+```
+
+### 参数
+
+**QueryAlbumRecordParams**
+
+| 属性   | 类型     | 必填 | 说明         |
+| ------ | -------- | ---- | ------------ |
+| devId  | `string` | 是   | 设备 ID      |
+| offset | `number` | 是   | 起始页       |
+| limit  | `number` | 是   | 每页数据个数 |
+
+### 返回
+
+**QueryAlbumRecordResponse**
+
+| 属性       | 类型     | 说明         |
+| ---------- | -------- | ------------ |
+| eventTypes | `string` | 事件类型     |
+| albumList  | `any[]`  | 相册信息数组 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 分页获取可以查看的相册列表
+ */
+export function queryAlbumRecord(params: QueryAlbumRecordParams): Promise<QueryAlbumRecordResponse>
+```