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

package/lib/cloud/doorlock/unlock.js

@@ -0,0 +1,76 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 1.1. RemoteOpenParams - 远程免密开门的参数类型
+
+// RemoteOpenResponse - 远程免密开门的响应类型
+
+/**
+ * 远程免密开门
+ * @param {RemoteOpenParams} params - 包含设备Id和开门状态的参数
+ * @returns {Promise<RemoteOpenResponse>} - 包含执行结果和状态的响应
+ */
+export const remoteOpenDoor = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.zigbee.lock.remotepwd.execute"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 1.2. Unlock - 远程免密开门的参数和响应类型
+
+/**
+ * 远程免密解锁
+ * @param {UnlockParams} params - 包含设备Id、开门状态和确认状态的参数
+ * @returns {Promise<UnlockResponse>} - 包含请求结果和状态的响应
+ */
+export const remoteUnlockDoor = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.unlock"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 1.3. 判断用户是否可以远程开门
+
+/**
+ * 判断用户是否可以远程开门
+ * @param {CanUnlockRemoteResponse} params - 包含设备Id的参数
+ * @returns {Promise<CanUnlockRemoteResponse>} - 包含请求结果和状态的响应
+ */
+export const checkCanRemoteUnlock = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.unlock.available"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ * 获取最近一条记录的信息
+ * @param   {GetLatestRecordInfoParams} params  - 包含设备Id的参数
+ * @returns {Promise<GetLatestRecordInfoResponse>} - 包含请求结果和状态的响应
+ */
+export const getLatestUnlockRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.history.latest"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 1.5. 查询开门记录
+
+/**
+ * 查询开门记录
+ * @param { QueryRecordInfoParams} params -  包含设备Id的参数
+ * @returns {Promise<QueryRecordInfoResponse[]>} - 包含请求结果和状态的响应
+ */
+export const queryUnlockRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.history.list"),
+    version: '2.0',
+    data: params
+  });
+};

package/lib/cloud/doorlock/unlock.md

@@ -0,0 +1,222 @@
+## remoteOpenDoor
+
+远程免密开门功能。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { remoteOpenDoor } from '@ray-js/ray'
+```
+
+### 参数
+
+**RemoteOpenParams**
+
+| 属性  | 类型      | 必填 | 说明     |
+| ----- | --------- | ---- | -------- |
+| devId | `string`  | 是   | 设备 Id  |
+| open  | `boolean` | 是   | 是否开门 |
+
+### 返回
+
+**RemoteOpenResponse**
+
+`boolean`，远程免密开门的响应结果。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 远程免密开门
+ */
+export function remoteOpenDoor(params: RemoteOpenParams): Promise<RemoteOpenResponse>
+```
+
+## remoteUnlockDoor
+
+远程免密解锁功能。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { remoteUnlockDoor } from '@ray-js/ray'
+```
+
+### 参数
+
+**UnlockParams**
+
+| 属性    | 类型      | 必填 | 说明                           |
+| ------- | --------- | ---- | ------------------------------ |
+| devId   | `string`  | 是   | 设备 Id                        |
+| open    | `boolean` | 是   | 是否开门                       |
+| confirm | `boolean` | 是   | 是否确认，蓝牙门锁固定传 false |
+
+### 返回
+
+**UnlockResponse**
+
+`boolean`，远程免密解锁的响应结果。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 远程免密解锁
+ */
+export function remoteUnlockDoor(params: UnlockParams): Promise<UnlockResponse>
+```
+
+## checkCanRemoteUnlock
+
+判断用户是否可以远程开门功能。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { checkCanRemoteUnlock } from '@ray-js/ray'
+```
+
+### 参数
+
+**CanUnlockRemoteParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 Id |
+
+### 返回
+
+**CanUnlockRemoteResponse**
+
+`boolean`，判断用户是否可以远程开门的响应结果。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 判断用户是否可以远程开门
+ */
+export function checkCanRemoteUnlock(
+  params: CanUnlockRemoteParams
+): Promise<CanUnlockRemoteResponse>
+```
+
+## getLatestUnlockRecord
+
+获取最近一条记录的信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getLatestUnlockRecord } from '@ray-js/ray'
+```
+
+### 参数
+
+**GetLatestRecordInfoParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 Id |
+
+### 返回
+
+**GetLatestRecordInfoResponse**
+
+| 属性            | 类型             | 说明              |
+| --------------- | ---------------- | ----------------- |
+| dpId            | `number`         | 类型(门锁端 dpId) |
+| dpValue         | `string`         | dp 值             |
+| recordType      | `number`         | 记录类型          |
+| userName        | `string`         | 用户名称          |
+| time            | `number`         | 时间              |
+| unionUnlockInfo | `UnlockRecord[]` | 组合开锁信息      |
+| unReadCount     | `number`         | 未读记录数        |
+
+**UnlockRecord**
+
+| 属性       | 类型     | 说明                   |
+| ---------- | -------- | ---------------------- |
+| userName   | `string` | 组合开锁的用户名称     |
+| opMode     | `string` | 组合开锁的解锁方式     |
+| unlockName | `string` | 组合开锁的解锁方式名称 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取最近一条记录的信息
+ */
+export function getLatestUnlockRecord(
+  params: GetLatestRecordInfoParams
+): Promise<GetLatestRecordInfoResponse>
+```
+
+## queryUnlockRecord
+
+查询开门记录功能。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryUnlockRecord } from '@ray-js/ray'
+```
+
+### 参数
+
+**QueryRecordInfoParams**
+
+| 属性      | 类型       | 必填 | 说明                 |
+| --------- | ---------- | ---- | -------------------- |
+| devId     | `string`   | 是   | 门锁编号             |
+| dpIds     | `string[]` | 是   | dpId 列表            |
+| offset    | `number`   | 否   | 起始页               |
+| limit     | `number`   | 否   | 每页数据大小         |
+| startTime | `number`   | 否   | 开始时间             |
+| endTime   | `number`   | 否   | 结束时间             |
+| nameless  | `boolean`  | 否   | 是否仅查询匿名的记录 |
+
+### 返回
+
+**QueryRecordInfoResponse**
+
+| 属性            | 类型                  | 说明                 |
+| --------------- | --------------------- | -------------------- |
+| id              | `number`              | 绑定的编号           |
+| dpId            | `number`              | 类型(门锁端 dpId)    |
+| userId          | `string`              | 开门的用户编号       |
+| unlockName      | `string`              | 解锁方式名称(如果有) |
+| userName        | `string`              | 用户名称             |
+| avatarUrl       | `string`              | 用户头像             |
+| time            | `number`              | 时间                 |
+| relateDevName   | `string`              | 关联设备的名称       |
+| relateOpMode    | `number`              | 关联设备的解锁方式   |
+| unionUnlockInfo | `QueryUnlockRecord[]` | 组合开锁信息         |
+
+**QueryUnlockRecord**
+
+| 属性       | 类型     | 说明                   |
+| ---------- | -------- | ---------------------- |
+| userName   | `string` | 组合开锁的用户名称     |
+| opMode     | `string` | 组合开锁的解锁方式     |
+| unlockName | `string` | 组合开锁的解锁方式名称 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查询开门记录
+ */
+export function queryUnlockRecord(params: QueryRecordInfoParams): Promise<QueryRecordInfoResponse[]>
+```

package/lib/cloud/index.d.ts

@@ -4,3 +4,7 @@ export * from './alarm';
 export * from './statistic';
 export * from './device';
 export * from './linkage';
+export * from './remoteGroup';
+export * from './outdoor';
+export * from './doorlock';
+export * from './recipe';

package/lib/cloud/index.js

@@ -3,4 +3,13 @@ export * from './timer';
 export * from './alarm';
 export * from './statistic';
 export * from './device';
-export * from './linkage';
+export * from './linkage';
+export * from './remoteGroup';
+
+// 仅用于出行产品
+export * from './outdoor';
+
+// 门锁
+export * from './doorlock';
+// 菜谱
+export * from './recipe';

package/lib/cloud/interface.d.ts

@@ -581,6 +581,14 @@ export interface IGetWeathersResponse {
          * 二氧化氮
          */
         tlow: number;
+        /**
+         * 降雨概率，单位%
+         */
+        pop: number;
+        /**
+         * 降水量，单位毫米
+         */
+        qpf: number;
         /**
          * 日落时间戳
          */
@@ -903,8 +911,10 @@ export interface IBindRuleResponse {
 }
 export interface IGetBindRuleList {
     bizDomain: string;
-    sourceEntityId: string;
+    devId: string;
+    sourceEntityId?: string;
     entityType: number;
+    gid: string;
 }
 export type IGetBindRuleListResponse = Array<{
     associativeEntityId: string;
@@ -914,7 +924,8 @@ export type IGetBindRuleListResponse = Array<{
 }>;
 export interface IRemoveRule {
     bizDomain: string;
-    sourceEntityId: string;
+    sourceEntityId?: string;
+    devId: string;
     associativeEntityId: string;
     associativeEntityValue: string;
 }
@@ -958,3 +969,29 @@ export interface DeviceProperty {
     value: string;
 }
 export type ISaveDevPropertyResponse = boolean;
+export interface IGetZigbeeLocalGroupRelation {
+    /**
+     * 遥控器设备 ID
+     */
+    devId: string;
+}
+export interface IGetZigbeeLocalGroupDeviceList {
+    /**
+     * 遥控器的设备 ID
+     */
+    devId: string;
+    /**
+     * 遥控器的网关 id
+     */
+    meshId: string;
+    /**
+     * 分组 Code，遥控器可支持多个群组，与 localId 匹配范围为 7001-7008；
+     * localId 为云端分配，步长为 8，因此一个遥控器内部最多支持关联 8 个群组，localId 为初始值依次+1，与之匹配的 categoryCode 从 7001 依次 +1。
+     * 可以通过 getZigbeeLocalGroupRelation 获取
+     */
+    categoryCode: string;
+    /**
+     * 家庭 id，可以通过 getCurrentHomeInfo 获取
+     */
+    homeId: string;
+}

package/lib/cloud/linkage.d.ts

@@ -6,17 +6,20 @@ import { IGetLinkageDeviceList, IBindRule, IGetBindRuleList, IRemoveRule, IGetLi
  */
 declare const getLinkageDeviceList: (params: IGetLinkageDeviceList) => Promise<IGetLinkageDeviceListResponse>;
 /**
- * 查询一键执行场景列表
+ * 查询家庭下一键执行场景列表
  * @param {number} devId 设备id
+ * @param {number} gid 家庭Id
  */
-declare const getSceneList: ({ devId }: {
+declare const getSceneList: ({ devId, gid }: {
     devId: string;
+    gid: string;
 }) => Promise<IGetSceneListResponse>;
 /**
- * 查询已绑定的列表
+ * 查询家庭下已绑定的列表
  * @param {string} bizDomain 业务范围
- * @param {string} sourceEntityId 设备id
+ * @param {string} devId 设备id
  * @param {number} entityType 实体类型
+ * @param {string} gid 家庭Id
  */
 declare const getBindRuleList: (params: IGetBindRuleList) => Promise<IGetBindRuleListResponse>;
 /**
@@ -32,7 +35,7 @@ declare const bindRule: ({ devId, associativeEntityId, ruleId, entitySubIds, exp
 /**
  * 解除联动
  * @param {string} bizDomain 业务范围
- * @param {string} sourceEntityId 设备id
+ * @param {string} devId 设备id
  * @param {string} associativeEntityId 关联dp组合
  * @param {string} associativeEntityValue 规则id
  */

package/lib/cloud/linkage.js

@@ -1,4 +1,6 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
 import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+const _excluded = ["gid", "devId", "sourceEntityId"];
 import { requestCloud } from '../';
 import { THING } from '../constants';
 /**
@@ -8,41 +10,60 @@ import { THING } from '../constants';
  */
 const getLinkageDeviceList = params => {
   return requestCloud({
-    api: `${THING}.m.linkage.dev.list`,
+    api: "".concat(THING, ".m.linkage.dev.list"),
     version: '3.0',
-    data: _objectSpread({}, params)
+    data: _objectSpread({}, params),
+    extData: {
+      gid: params.gid
+    }
   });
 };
 
 /**
- * 查询一键执行场景列表
+ * 查询家庭下一键执行场景列表
  * @param {number} devId 设备id
+ * @param {number} gid 家庭Id
  */
 const getSceneList = _ref => {
   let {
-    devId
+    devId,
+    gid
   } = _ref;
   return requestCloud({
-    api: `${THING}.m.linkage.rule.brief.query`,
+    api: "".concat(THING, ".m.linkage.rule.brief.query"),
     version: '1.0',
     data: {
       devId
+    },
+    extData: {
+      gid
     }
   });
 };
 
 /**
- * 查询已绑定的列表
+ * 查询家庭下已绑定的列表
  * @param {string} bizDomain 业务范围
- * @param {string} sourceEntityId 设备id
+ * @param {string} devId 设备id
  * @param {number} entityType 实体类型
+ * @param {string} gid 家庭Id
  */
-
-const getBindRuleList = params => {
+const getBindRuleList = async params => {
+  const {
+      gid,
+      devId,
+      sourceEntityId
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded);
   return requestCloud({
-    api: `${THING}.m.linkage.associative.entity.id.category.query`,
+    api: "".concat(THING, ".m.linkage.associative.entity.id.category.query"),
     version: '1.0',
-    data: _objectSpread({}, params)
+    data: _objectSpread(_objectSpread({}, rest), {}, {
+      sourceEntityId: sourceEntityId || devId
+    }),
+    extData: {
+      gid
+    }
   });
 };
 
@@ -65,7 +86,7 @@ const bindRule = _ref2 => {
     bizDomain
   } = _ref2;
   return requestCloud({
-    api: `${THING}.m.linkage.associative.entity.bind`,
+    api: "".concat(THING, ".m.linkage.associative.entity.bind"),
     version: '1.0',
     data: {
       relationExpr: {
@@ -96,13 +117,13 @@ const bindRule = _ref2 => {
 /**
  * 解除联动
  * @param {string} bizDomain 业务范围
- * @param {string} sourceEntityId 设备id
+ * @param {string} devId 设备id
  * @param {string} associativeEntityId 关联dp组合
  * @param {string} associativeEntityValue 规则id
  */
 const removeRule = params => {
   return requestCloud({
-    api: `${THING}.m.linkage.associative.entity.remove`,
+    api: "".concat(THING, ".m.linkage.associative.entity.remove"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -117,7 +138,7 @@ const triggerRule = _ref3 => {
     ruleId
   } = _ref3;
   return requestCloud({
-    api: `${THING}.m.linkage.rule.trigger`,
+    api: "".concat(THING, ".m.linkage.rule.trigger"),
     version: '1.0',
     data: {
       ruleId
@@ -134,7 +155,7 @@ const enableRule = _ref4 => {
     ruleId
   } = _ref4;
   return requestCloud({
-    api: `${THING}.m.linkage.rule.enable`,
+    api: "".concat(THING, ".m.linkage.rule.enable"),
     version: '1.0',
     data: {
       ruleId
@@ -151,7 +172,7 @@ const disableRule = _ref5 => {
     ruleId
   } = _ref5;
   return requestCloud({
-    api: `${THING}.m.linkage.rule.disable`,
+    api: "".concat(THING, ".m.linkage.rule.disable"),
     version: '1.0',
     data: {
       ruleId

package/lib/cloud/outdoor.d.ts

@@ -0,0 +1,15 @@
+type ProductIconVOMap = {
+    [productId: string]: {
+        icon: string;
+        smallIcon: string;
+    };
+};
+/**
+ * 根据设备ids获取出行产品图片
+ * @param params {deviceIds: string[]}
+ * @returns ProductIconVOMap
+ */
+export declare const getOutdoorDeviceIcon: (params: {
+    deviceIds: string[];
+}) => Promise<ProductIconVOMap>;
+export {};

package/lib/cloud/outdoor.js

@@ -0,0 +1,25 @@
+import { THING } from '../constants';
+import requestCloud from '../requestCloud';
+/**
+ * 根据设备ids获取出行产品图片
+ * @param params {deviceIds: string[]}
+ * @returns ProductIconVOMap
+ */
+export const getOutdoorDeviceIcon = params => {
+  return new Promise((resolve, reject) => {
+    requestCloud({
+      api: "".concat(THING, ".m.trip.outdoors.device.icon.get"),
+      version: '1.0',
+      data: {
+        deviceIds: params.deviceIds.join(',')
+      },
+      success(res) {
+        // @ts-ignore
+        resolve(res.productIconVOMap);
+      },
+      fail(err) {
+        reject(err);
+      }
+    });
+  });
+};

package/lib/cloud/recipe/README.md

@@ -0,0 +1,36 @@
+```
+let apis = [
+  `tuya.m.menu.basket.status`,
+  `tuya.m.menu.basket.list`,
+  `tuya.m.menu.basket.food.add`,
+  `tuya.m.menu.basket.food.update`,
+  `tuya.m.menu.basket.food.delete`,
+  `tuya.m.menu.basket.food.own`,
+  `tuya.m.menu.basket.food.want`,
+  `tuya.m.menu.basket.food.clean`,
+  `tuya.m.menu.basket.food.nutrition`,
+  `tuya.m.menu.basket.menu.exist`,
+  `tuya.m.menu.category.list`,
+  `tuya.m.menu.category.list`,
+  `tuya.m.menu.custom.lang.list`,
+  `tuya.m.menu.diy.add`,
+  `tuya.m.menu.diy.update`,
+  `tuya.m.menu.diy.delete`,
+  `tuya.m.menu.lang.list`,
+  `tuya.m.menu.get`,
+  `tuya.m.cookbook.all.lang`,
+  `tuya.m.menu.query.model.list`,
+  `tuya.m.menu.search.condition`,
+  `tuya.m.menu.query.history.list`,
+  `tuya.m.menu.query.history.delete`,
+  `tuya.m.menu.query.history.clean`,
+  `tuya.m.menu.score.add`,
+  `tuya.m.menu.score.get`,
+  `tuya.m.menu.score.bat.get`,
+  `tuya.m.menu.star.list`,
+  `tuya.m.menu.star.add`,
+  `tuya.m.menu.star.delete`,
+  `tuya.m.menu.star.check`,
+  `tuya.m.menu.star.count`,
+]
+```