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

package/lib/cloud/recipe/star.d.ts

@@ -0,0 +1,131 @@
+/**
+ * GetRecipeCollectionListQuery - 获取食谱收藏列表查询条件
+ */
+type GetRecipeCollectionListQuery = {
+    pageNo?: number;
+    pageSize?: number;
+};
+/**
+ * GetRecipeCollectionListParams - 获取食谱收藏列表请求参数
+ */
+type GetRecipeCollectionListParams = {
+    query: GetRecipeCollectionListQuery;
+    devId: string;
+};
+/**
+ * RecipeInfo - 食谱信息
+ */
+type RecipeInfo = {
+    id: number;
+    mainImg: string;
+    lang: number;
+    langDesc: string;
+    desc: string;
+    cookType: number;
+    extInfo: string;
+    sourceType: number;
+    isMainShow: number;
+    isShowControl: number;
+    isControl: number;
+    name: string;
+    easyLevel: string;
+    easyLevelDesc: string;
+    taste: string;
+    tasteDesc: string;
+    foodType: string;
+    foodTypeDesc: string;
+    gmtCreate: number;
+    gmtModified: number;
+};
+/**
+ * GetRecipeCollectionListResult - 获取食谱收藏列表返回结果
+ */
+type GetRecipeCollectionListResult = {
+    totalCount: number;
+    pageNo: number;
+    pageSize: number;
+    hasNext: boolean;
+    data: RecipeInfo[];
+};
+/**
+ * GetRecipeCollectionListResponse - 获取食谱收藏列表响应
+ */
+type GetRecipeCollectionListResponse = GetRecipeCollectionListResult;
+/**
+ * 获取食谱收藏列表
+ * @param {GetRecipeCollectionListParams} params - 获取食谱收藏列表请求参数
+ * @returns {Promise<GetRecipeCollectionListResponse>} - 获取食谱收藏列表响应的 Promise
+ */
+export declare const getRecipeCollectionList: (params: GetRecipeCollectionListParams) => Promise<GetRecipeCollectionListResponse>;
+/**
+ * AddRecipeToFavoritesParams - 添加食谱收藏参数
+ */
+type AddRecipeToFavoritesParams = {
+    menuId: number;
+    devId: string;
+};
+/**
+ * AddRecipeToFavoritesResponse - 添加食谱收藏响应
+ */
+type AddRecipeToFavoritesResponse = boolean;
+/**
+ * 添加食谱收藏
+ * @param {AddRecipeToFavoritesParams} params - 添加食谱收藏参数
+ * @returns {Promise<AddRecipeToFavoritesResponse>} - 添加食谱收藏结果的 Promise
+ */
+export declare const addRecipeToFavorites: (params: AddRecipeToFavoritesParams) => Promise<AddRecipeToFavoritesResponse>;
+/**
+ * RemoveRecipeFromFavoritesParams - 取消食谱收藏参数
+ */
+type RemoveRecipeFromFavoritesParams = {
+    menuId: number;
+    devId: string;
+};
+/**
+ * RemoveRecipeFromFavoritesResponse - 取消食谱收藏响应
+ */
+type RemoveRecipeFromFavoritesResponse = boolean;
+/**
+ * 取消食谱收藏
+ * @param {RemoveRecipeFromFavoritesParams} params - 取消食谱收藏参数
+ * @returns {Promise<RemoveRecipeFromFavoritesResponse>} - 取消食谱收藏结果的 Promise
+ */
+export declare const removeRecipeFromFavorites: (params: RemoveRecipeFromFavoritesParams) => Promise<RemoveRecipeFromFavoritesResponse>;
+/**
+ * CheckRecipeIsStarredParams - 查询食谱是否收藏参数
+ */
+type CheckRecipeIsStarredParams = {
+    menuId: number;
+    devId: string;
+};
+/**
+ * CheckRecipeIsStarredResponse - 查询食谱是否收藏响应
+ */
+type CheckRecipeIsStarredResponse = {
+    isStar: boolean;
+};
+/**
+ * 查询食谱是否收藏
+ * @param {CheckRecipeIsStarredParams} params - 查询食谱是否收藏参数
+ * @returns {Promise<CheckRecipeIsStarredResponse>} - 查询食谱是否收藏结果的 Promise
+ */
+export declare const checkRecipeIsStarred: (params: CheckRecipeIsStarredParams) => Promise<CheckRecipeIsStarredResponse>;
+/**
+ * GetRecipeStarCountParams - 查询食谱收藏数量参数
+ */
+type GetRecipeStarCountParams = {
+    devId: string;
+};
+/**
+ * GetRecipeStarCountResponse - 查询食谱收藏数量响应
+ */
+type GetRecipeStarCountResponse = {
+    count: number;
+};
+/**
+ * 查询用户已收藏的食谱数量
+ * @param {GetRecipeStarCountParams} params - 查询食谱收藏数量参数
+ * @returns {Promise<GetRecipeStarCountResponse>} - 查询食谱收藏数量结果的 Promise
+ */
+export declare const getRecipeStarCount: (params: GetRecipeStarCountParams) => Promise<GetRecipeStarCountResponse>;
+export {};

package/lib/cloud/recipe/star.js

@@ -0,0 +1,151 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["query"];
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// #region 获取食谱收藏列表
+
+/**
+ * GetRecipeCollectionListQuery - 获取食谱收藏列表查询条件
+ */
+
+/**
+ * GetRecipeCollectionListParams - 获取食谱收藏列表请求参数
+ */
+
+/**
+ * RecipeInfo - 食谱信息
+ */
+
+/**
+ * GetRecipeCollectionListResult - 获取食谱收藏列表返回结果
+ */
+
+/**
+ * GetRecipeCollectionListResponse - 获取食谱收藏列表响应
+ */
+
+/**
+ * 获取食谱收藏列表
+ * @param {GetRecipeCollectionListParams} params - 获取食谱收藏列表请求参数
+ * @returns {Promise<GetRecipeCollectionListResponse>} - 获取食谱收藏列表响应的 Promise
+ */
+export const getRecipeCollectionList = params => {
+  const {
+      query
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.star.list"),
+    version: '2.0',
+    data: _objectSpread({
+      queryJson: JSON.stringify(query)
+    }, rest)
+  });
+};
+
+// #endregion
+
+// #region 添加食谱收藏
+
+/**
+ * AddRecipeToFavoritesParams - 添加食谱收藏参数
+ */
+
+/**
+ * AddRecipeToFavoritesResponse - 添加食谱收藏响应
+ */
+
+// 返回结果，是否添加成功
+
+/**
+ * 添加食谱收藏
+ * @param {AddRecipeToFavoritesParams} params - 添加食谱收藏参数
+ * @returns {Promise<AddRecipeToFavoritesResponse>} - 添加食谱收藏结果的 Promise
+ */
+export const addRecipeToFavorites = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.star.add"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion
+
+// #region 取消食谱收藏
+
+/**
+ * RemoveRecipeFromFavoritesParams - 取消食谱收藏参数
+ */
+
+/**
+ * RemoveRecipeFromFavoritesResponse - 取消食谱收藏响应
+ */
+
+// 返回结果，是否取消成功
+
+/**
+ * 取消食谱收藏
+ * @param {RemoveRecipeFromFavoritesParams} params - 取消食谱收藏参数
+ * @returns {Promise<RemoveRecipeFromFavoritesResponse>} - 取消食谱收藏结果的 Promise
+ */
+export const removeRecipeFromFavorites = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.star.delete"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion
+
+// #region 食谱是否收藏
+
+/**
+ * CheckRecipeIsStarredParams - 查询食谱是否收藏参数
+ */
+
+/**
+ * CheckRecipeIsStarredResponse - 查询食谱是否收藏响应
+ */
+
+/**
+ * 查询食谱是否收藏
+ * @param {CheckRecipeIsStarredParams} params - 查询食谱是否收藏参数
+ * @returns {Promise<CheckRecipeIsStarredResponse>} - 查询食谱是否收藏结果的 Promise
+ */
+export const checkRecipeIsStarred = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.star.check"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion
+
+// #region 食谱收藏数量
+
+/**
+ * GetRecipeStarCountParams - 查询食谱收藏数量参数
+ */
+
+/**
+ * GetRecipeStarCountResponse - 查询食谱收藏数量响应
+ */
+
+/**
+ * 查询用户已收藏的食谱数量
+ * @param {GetRecipeStarCountParams} params - 查询食谱收藏数量参数
+ * @returns {Promise<GetRecipeStarCountResponse>} - 查询食谱收藏数量结果的 Promise
+ */
+export const getRecipeStarCount = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.star.count"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion

package/lib/cloud/recipe/star.md

@@ -0,0 +1,196 @@
+## getRecipeCollectionList
+
+获取食谱收藏列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRecipeCollectionList } from '@ray-js/ray'
+```
+
+**参数**
+
+**GetRecipeCollectionListParams params**
+
+封装了获取食谱收藏列表的查询条件和设备 ID。
+
+**参数属性 GetRecipeCollectionListParams**
+
+| 属性  | 类型                           | 默认值 | 必填 | 说明     |
+| ----- | ------------------------------ | ------ | ---- | -------- |
+| query | `GetRecipeCollectionListQuery` |        | 是   | 查询条件 |
+| devId | `string`                       |        | 是   | 设备 ID  |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取食谱收藏列表
+ * @param {GetRecipeCollectionListParams} params - 获取食谱收藏列表请求参数
+ * @returns {Promise<GetRecipeCollectionListResponse>} - 获取食谱收藏列表响应的 Promise 对象
+ */
+export const getRecipeCollectionList: (
+  params: GetRecipeCollectionListParams
+) => Promise<GetRecipeCollectionListResponse>
+```
+
+---
+
+## addRecipeToFavorites
+
+添加食谱收藏。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { addRecipeToFavorites } from '@ray-js/ray'
+```
+
+**参数**
+
+**AddRecipeToFavoritesParams params**
+
+封装了食谱 ID 和设备 ID。
+
+**参数属性 AddRecipeToFavoritesParams**
+
+| 属性   | 类型     | 默认值 | 必填 | 说明    |
+| ------ | -------- | ------ | ---- | ------- |
+| menuId | `number` |        | 是   | 食谱 ID |
+| devId  | `string` |        | 是   | 设备 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 添加食谱收藏
+ * @param {AddRecipeToFavoritesParams} params - 添加食谱收藏参数
+ * @returns {Promise<AddRecipeToFavoritesResponse>} - 添加食谱收藏结果的 Promise 对象
+ */
+export const addRecipeToFavorites: (
+  params: AddRecipeToFavoritesParams
+) => Promise<AddRecipeToFavoritesResponse>
+```
+
+---
+
+## removeRecipeFromFavorites
+
+取消食谱收藏。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { removeRecipeFromFavorites } from '@ray-js/ray'
+```
+
+**参数**
+
+**RemoveRecipeFromFavoritesParams params**
+
+封装了食谱 ID 和设备 ID。
+
+**参数属性 RemoveRecipeFromFavoritesParams**
+
+| 属性   | 类型     | 默认值 | 必填 | 说明    |
+| ------ | -------- | ------ | ---- | ------- |
+| menuId | `number` |        | 是   | 食谱 ID |
+| devId  | `string` |        | 是   | 设备 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 取消食谱收藏
+ * @param {RemoveRecipeFromFavoritesParams} params - 取消食谱收藏参数
+ * @returns {Promise<RemoveRecipeFromFavoritesResponse>} - 取消食谱收藏结果的 Promise 对象
+ */
+export const removeRecipeFromFavorites: (
+  params: RemoveRecipeFromFavoritesParams
+) => Promise<RemoveRecipeFromFavoritesResponse>
+```
+
+---
+
+## checkRecipeIsStarred
+
+查询食谱是否收藏。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { checkRecipeIsStarred } from '@ray-js/ray'
+```
+
+**参数**
+
+**CheckRecipeIsStarredParams params**
+
+封装了食谱 ID 和设备 ID。
+
+**参数属性 CheckRecipeIsStarredParams**
+
+| 属性   | 类型     | 默认值 | 必填 | 说明    |
+| ------ | -------- | ------ | ---- | ------- |
+| menuId | `number` |        | 是   | 食谱 ID |
+| devId  | `string` |        | 是   | 设备 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 查询食谱是否收藏
+ * @param {CheckRecipeIsStarredParams} params - 查询食谱是否收藏参数
+ * @returns {Promise<CheckRecipeIsStarredResponse>} - 查询食谱是否收藏结果的 Promise 对象
+ */
+export const checkRecipeIsStarred: (
+  params: CheckRecipeIsStarredParams
+) => Promise<CheckRecipeIsStarredResponse>
+```
+
+---
+
+## getRecipeStarCount
+
+查询用户已收藏的食谱数量。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRecipeStarCount } from '@ray-js/ray'
+```
+
+**参数**
+
+**GetRecipeStarCountParams params**
+
+封装了设备 ID。
+
+**参数属性 GetRecipeStarCountParams**
+
+| 属性  | 类型     | 默认值 | 必填 | 说明    |
+| ----- | -------- | ------ | ---- | ------- |
+| devId | `string` |        | 是   | 设备 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 查询用户已收藏的食谱数量
+ * @param {GetRecipeStarCountParams} params - 查询食谱收藏数量参数
+ * @returns {Promise<GetRecipeStarCountResponse>} - 查询食谱收藏数量结果的 Promise 对象
+ */
+export const getRecipeStarCount: (
+  params: GetRecipeStarCountParams
+) => Promise<GetRecipeStarCountResponse>
+```

package/lib/cloud/recipe/types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 多语言信息
+ */
+declare type LangInfo = {
+    lang: string;
+    name: string;
+};

package/lib/cloud/remoteGroup.d.ts

@@ -0,0 +1,10 @@
+import { IGetZigbeeLocalGroupDeviceList, IGetZigbeeLocalGroupRelation } from './interface';
+/**
+ * 获取 Zigbee 遥控器群组 localId 列表
+ */
+declare const getZigbeeLocalGroupRelation: (params: IGetZigbeeLocalGroupRelation) => Promise<string>;
+/**
+ * 获取可以加入 Zigbee 遥控器群组的设备列表
+ */
+declare const getZigbeeLocalGroupDeviceList: (params: IGetZigbeeLocalGroupDeviceList) => Promise<string>;
+export { getZigbeeLocalGroupRelation, getZigbeeLocalGroupDeviceList };

package/lib/cloud/remoteGroup.js

@@ -0,0 +1,31 @@
+// 遥控器群组接口
+import { requestCloud } from '../';
+import { THING } from '../constants';
+/**
+ * 获取 Zigbee 遥控器群组 localId 列表
+ */
+const getZigbeeLocalGroupRelation = params => {
+  return requestCloud({
+    api: "".concat(THING, ".p.remote.local.relation.get"),
+    version: '1.0',
+    data: {
+      devId: params.devId,
+      type: 0
+    }
+  });
+};
+
+/**
+ * 获取可以加入 Zigbee 遥控器群组的设备列表
+ */
+const getZigbeeLocalGroupDeviceList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.group.dev.list"),
+    version: '1.0',
+    data: params,
+    extData: {
+      gid: params.homeId
+    }
+  });
+};
+export { getZigbeeLocalGroupRelation, getZigbeeLocalGroupDeviceList };

package/lib/cloud/statistic.js

@@ -14,7 +14,7 @@ import { THING } from '../constants';
  */
 const getLogInSpecifiedTime = params => {
   return requestCloud({
-    api: `${THING}.m.smart.operate.all.log`,
+    api: "".concat(THING, ".m.smart.operate.all.log"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -62,7 +62,7 @@ const getLogUserAction = params => {
  */
 const getDpLogDays = params => {
   return requestCloud({
-    api: `${THING}.m.dp.stat.days.list`,
+    api: "".concat(THING, ".m.dp.stat.days.list"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -76,7 +76,7 @@ const getDpLogDays = params => {
  */
 const getDpResultByMonth = params => {
   return requestCloud({
-    api: `${THING}.m.dp.stat.month.list`,
+    api: "".concat(THING, ".m.dp.stat.month.list"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -93,7 +93,7 @@ const getDpResultByMonth = params => {
  */
 const getDpResultByHour = params => {
   return requestCloud({
-    api: `${THING}.m.dp.rang.stat.hour.list`,
+    api: "".concat(THING, ".m.dp.rang.stat.hour.list"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -111,7 +111,7 @@ const getDpResultByHour = params => {
  */
 const getDataWithSpecified = params => {
   return requestCloud({
-    api: `${THING}.m.dp.rang.stat.day.list`,
+    api: "".concat(THING, ".m.dp.rang.stat.day.list"),
     version: '2.0',
     data: _objectSpread({}, params)
   });
@@ -127,7 +127,7 @@ const getDataWithSpecified = params => {
  */
 const getWeekWithSpecified = params => {
   return requestCloud({
-    api: `${THING}.m.dp.rang.stat.week.list`,
+    api: "".concat(THING, ".m.dp.rang.stat.week.list"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -145,7 +145,7 @@ const getWeekWithSpecified = params => {
  */
 const getMonthWithSpecified = params => {
   return requestCloud({
-    api: `${THING}.m.dp.rang.stat.month.list`,
+    api: "".concat(THING, ".m.dp.rang.stat.month.list"),
     version: '2.0',
     data: _objectSpread({}, params)
   });
@@ -159,7 +159,7 @@ const getMonthWithSpecified = params => {
  */
 const getDpAllStatistResult = params => {
   return requestCloud({
-    api: `${THING}.m.dp.stat.total`,
+    api: "".concat(THING, ".m.dp.stat.total"),
     version: '1.0',
     data: _objectSpread({}, params)
   });
@@ -179,7 +179,7 @@ const getDpAllStatistResult = params => {
  */
 const getMultiDpsAllResult = params => {
   return requestCloud({
-    api: `${THING}.m.device.query.device.log`,
+    api: "".concat(THING, ".m.device.query.device.log"),
     version: '1.0',
     data: _objectSpread({}, params)
   });