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

package/lib/cloud/recipe/query.md

@@ -0,0 +1,112 @@
+## getAllLanguages
+
+获取食谱所支持的所有语言信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getAllLanguages } from '@ray-js/ray'
+```
+
+**参数**
+
+无参数。
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取食谱所支持的所有语言信息
+ * @returns {Promise<GetAllLanguagesResponse>} - 返回获取所有语言信息结果的 Promise 对象
+ */
+export function getAllLanguages(): Promise<GetAllLanguagesResponse>
+```
+
+---
+
+## getSearchModel
+
+获取 C 端用户搜索模型。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getSearchModel } from '@ray-js/ray'
+```
+
+**参数**
+
+**GetSearchModelParams params**
+
+封装了获取搜索模型的参数对象。
+
+**参数属性 GetSearchModelParams**
+
+| 属性      | 类型     | 默认值 | 必填 | 说明    |
+| --------- | -------- | ------ | ---- | ------- |
+| productId | `string` |        | 是   | 产品 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取 C 端用户搜索模型
+ * @param {GetSearchModelParams} params - 封装了获取搜索模型的参数对象
+ * @returns {Promise<SearchModelResponse>} - 返回获取搜索模型结果的 Promise 对象
+ */
+export function getSearchModel(params: GetSearchModelParams): Promise<SearchModelResponse>
+```
+
+---
+
+## getCookingTimeCondition
+
+获取已上线食谱的最小、最大烹饪时间。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getCookingTimeCondition } from '@ray-js/ray'
+```
+
+**参数**
+
+**GetCookingTimeConditionParams params**
+
+封装了获取烹饪时间筛选条件的参数对象。
+
+**参数属性 GetCookingTimeConditionParams**
+
+| 属性  | 类型                   | 默认值 | 必填 | 说明     |
+| ----- | ---------------------- | ------ | ---- | -------- |
+| query | `CookingTimeCondition` |        | 是   | 查询条件 |
+| devId | `string`               |        | 是   | 设备 ID  |
+
+### CookingTimeCondition
+
+烹饪时间筛选条件。
+
+| 属性        | 类型       | 默认值 | 必填 | 说明     |
+| ----------- | ---------- | ------ | ---- | -------- |
+| sourceType  | `number`   |        | 是   | 食谱类型 |
+| name        | `string`   |        | 否   | 食谱名称 |
+| categoryIds | `number[]` |        | 否   | 分类 IDs |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取已上线食谱的最小、最大烹饪时间
+ * @param {GetCookingTimeConditionParams} params - 封装了获取烹饪时间筛选条件的参数对象
+ * @returns {Promise<CookingTimeConditionResponse>} - 返回获取烹饪时间筛选条件结果的 Promise 对象
+ */
+export function getCookingTimeCondition(
+  params: GetCookingTimeConditionParams
+): Promise<CookingTimeConditionResponse>
+```

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

@@ -0,0 +1,54 @@
+/**
+ * SearchHistoryListParams - 搜索记录列表参数
+ */
+type SearchHistoryListParams = {
+    devId: string;
+};
+/**
+ * SearchHistory - 搜索记录
+ */
+type SearchHistory = string;
+/**
+ * SearchHistoryListResponse - 搜索记录列表响应
+ */
+type SearchHistoryListResponse = SearchHistory[];
+/**
+ * 获取搜索历史记录列表
+ * @param params - 搜索记录列表参数
+ * @returns 获取搜索记录列表结果的 Promise
+ */
+export declare function getSearchHistoryList(params: SearchHistoryListParams): Promise<SearchHistoryListResponse>;
+/**
+ * DeleteSearchHistoryParams - 搜索记录单条删除参数
+ */
+type DeleteSearchHistoryParams = {
+    name: string;
+    devId: string;
+};
+/**
+ * DeleteSearchHistoryResponse - 搜索记录单条删除响应
+ */
+type DeleteSearchHistoryResponse = boolean;
+/**
+ * 删除单条搜索历史记录
+ * @param params - 搜索记录单条删除参数
+ * @returns 删除单条搜索历史记录结果的 Promise
+ */
+export declare function deleteSearchHistory(params: DeleteSearchHistoryParams): Promise<DeleteSearchHistoryResponse>;
+/**
+ * CleanSearchHistoryParams - 搜索记录清空参数
+ */
+type CleanSearchHistoryParams = {
+    devId: string;
+};
+/**
+ * CleanSearchHistoryResponse - 搜索记录清空响应
+ */
+type CleanSearchHistoryResponse = boolean;
+/**
+ * 清空搜索历史记录
+ * @param params - 搜索记录清空参数
+ * @returns 清空搜索历史记录结果的 Promise
+ */
+export declare function cleanSearchHistory(params: CleanSearchHistoryParams): Promise<CleanSearchHistoryResponse>;
+export {};

package/lib/cloud/recipe/record.js

@@ -0,0 +1,87 @@
+// #region 搜索记录列表
+
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+/**
+ * SearchHistoryListParams - 搜索记录列表参数
+ */
+
+/**
+ * SearchHistory - 搜索记录
+ */
+
+/**
+ * SearchHistoryListResponse - 搜索记录列表响应
+ */
+
+// 返回结果
+
+/**
+ * 获取搜索历史记录列表
+ * @param params - 搜索记录列表参数
+ * @returns 获取搜索记录列表结果的 Promise
+ */
+export function getSearchHistoryList(params) {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.query.history.list"),
+    version: '1.0',
+    data: params
+  });
+}
+
+// #endregion
+
+// #region 搜索记录单条删除
+
+/**
+ * DeleteSearchHistoryParams - 搜索记录单条删除参数
+ */
+
+/**
+ * DeleteSearchHistoryResponse - 搜索记录单条删除响应
+ */
+
+// 返回结果，是否删除成功
+
+/**
+ * 删除单条搜索历史记录
+ * @param params - 搜索记录单条删除参数
+ * @returns 删除单条搜索历史记录结果的 Promise
+ */
+export function deleteSearchHistory(params) {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.query.history.delete"),
+    version: '1.0',
+    data: params
+  });
+}
+
+// #endregion
+
+// #region 搜索记录清空
+
+/**
+ * CleanSearchHistoryParams - 搜索记录清空参数
+ */
+
+/**
+ * CleanSearchHistoryResponse - 搜索记录清空响应
+ */
+
+// 返回结果，是否清空成功
+
+/**
+ * 清空搜索历史记录
+ * @param params - 搜索记录清空参数
+ * @returns 清空搜索历史记录结果的 Promise
+ */
+export function cleanSearchHistory(params) {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.query.history.clean"),
+    version: '1.0',
+    data: params
+  });
+}
+
+// #endregion

package/lib/cloud/recipe/record.md

@@ -0,0 +1,115 @@
+## getSearchHistoryList
+
+获取搜索历史记录列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getSearchHistoryList } from '@ray-js/ray'
+```
+
+**参数**
+
+**SearchHistoryListParams params**
+
+封装了获取搜索记录列表的参数对象。
+
+**参数属性 SearchHistoryListParams**
+
+| 属性  | 类型     | 默认值 | 必填 | 说明    |
+| ----- | -------- | ------ | ---- | ------- |
+| devId | `string` |        | 是   | 设备 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取搜索历史记录列表
+ * @param {SearchHistoryListParams} params - 搜索记录列表参数
+ * @returns {Promise<SearchHistoryListResponse>} - 返回获取搜索记录列表结果的 Promise 对象
+ */
+export function getSearchHistoryList(
+  params: SearchHistoryListParams
+): Promise<SearchHistoryListResponse>
+```
+
+---
+
+## deleteSearchHistory
+
+删除单条搜索历史记录。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { deleteSearchHistory } from '@ray-js/ray'
+```
+
+**参数**
+
+**DeleteSearchHistoryParams params**
+
+封装了删除单条搜索历史记录的参数对象。
+
+**参数属性 DeleteSearchHistoryParams**
+
+| 属性  | 类型     | 默认值 | 必填 | 说明         |
+| ----- | -------- | ------ | ---- | ------------ |
+| name  | `string` |        | 是   | 历史记录名称 |
+| devId | `string` |        | 是   | 设备 ID      |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 删除单条搜索历史记录
+ * @param {DeleteSearchHistoryParams} params - 搜索记录单条删除参数
+ * @returns {Promise<DeleteSearchHistoryResponse>} - 返回删除单条搜索历史记录结果的 Promise 对象
+ */
+export function deleteSearchHistory(
+  params: DeleteSearchHistoryParams
+): Promise<DeleteSearchHistoryResponse>
+```
+
+---
+
+## cleanSearchHistory
+
+清空搜索历史记录。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { cleanSearchHistory } from '@ray-js/ray'
+```
+
+**参数**
+
+**CleanSearchHistoryParams params**
+
+封装了清空搜索历史记录的参数对象。
+
+**参数属性 CleanSearchHistoryParams**
+
+| 属性  | 类型     | 默认值 | 必填 | 说明    |
+| ----- | -------- | ------ | ---- | ------- |
+| devId | `string` |        | 是   | 设备 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 清空搜索历史记录
+ * @param {CleanSearchHistoryParams} params - 搜索记录清空参数
+ * @returns {Promise<CleanSearchHistoryResponse>} - 返回清空搜索历史记录结果的 Promise 对象
+ */
+export function cleanSearchHistory(
+  params: CleanSearchHistoryParams
+): Promise<CleanSearchHistoryResponse>
+```

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

@@ -0,0 +1,69 @@
+/**
+ * 用户评分信息
+ */
+type ScoreInfo = {
+    menuId: number;
+    score: number;
+};
+/**
+ * AddRecipeScoreParams - 用户添加评分参数
+ */
+type AddRecipeScoreParams = {
+    scoreInfo: ScoreInfo;
+};
+/**
+ * AddRecipeScoreResponse - 用户添加评分响应
+ */
+type AddRecipeScoreResponse = boolean;
+/**
+ * 用户添加评分
+ * @param {AddRecipeScoreParams} params - 用户添加评分参数
+ * @returns {Promise<AddRecipeScoreResponse>} - 用户添加评分结果的 Promise
+ */
+export declare const addRecipeScore: (params: AddRecipeScoreParams) => Promise<AddRecipeScoreResponse>;
+/**
+ * GetRecipeScoreByMenuIdParams - 用户通过食谱 ID 获取评分信息参数
+ */
+type GetRecipeScoreByMenuIdParams = {
+    menuId: number;
+};
+/**
+ * 评分结果
+ */
+type ScoreResult = {
+    score: number;
+    menuId: number;
+};
+/**
+ * GetRecipeScoreByMenuIdResponse - 用户通过食谱 ID 获取评分信息响应
+ */
+type GetRecipeScoreByMenuIdResponse = ScoreResult;
+/**
+ * 用户通过食谱 ID 获取评分信息
+ * @param {GetRecipeScoreByMenuIdParams} params - 用户获取评分信息参数
+ * @returns {Promise<GetRecipeScoreByMenuIdResponse>} - 用户获取评分信息结果的 Promise
+ */
+export declare const getRecipeScoreByMenuId: (params: GetRecipeScoreByMenuIdParams) => Promise<GetRecipeScoreByMenuIdResponse>;
+/**
+ * QueryCondition - 查询条件
+ */
+type QueryCondition = {
+    menuIds: number[];
+};
+/**
+ * GetRecipeScoresByMenuIdsParams - 用户通过食谱 IDs 获取评分信息参数
+ */
+type GetRecipeScoresByMenuIdsParams = {
+    query: QueryCondition;
+};
+/**
+ * GetRecipeScoresByMenuIdsResponse - 用户通过食谱 IDs 获取评分信息响应
+ */
+type GetRecipeScoresByMenuIdsResponse = ScoreResult[];
+/**
+ * 用户通过食谱 IDs 获取评分信息
+ * @param {GetRecipeScoresByMenuIdsParams} params - 用户获取评分信息参数
+ * @returns {Promise<GetRecipeScoresByMenuIdsResponse>} - 用户获取评分信息结果的 Promise
+ */
+export declare const getRecipeScoresByMenuIds: (params: GetRecipeScoresByMenuIdsParams) => Promise<GetRecipeScoresByMenuIdsResponse>;
+export {};

package/lib/cloud/recipe/score.js

@@ -0,0 +1,106 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["scoreInfo"],
+  _excluded2 = ["query"];
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// #region 用户添加评分
+
+/**
+ * 用户评分信息
+ */
+
+/**
+ * AddRecipeScoreParams - 用户添加评分参数
+ */
+
+/**
+ * AddRecipeScoreResponse - 用户添加评分响应
+ */
+
+// 返回结果
+
+/**
+ * 用户添加评分
+ * @param {AddRecipeScoreParams} params - 用户添加评分参数
+ * @returns {Promise<AddRecipeScoreResponse>} - 用户添加评分结果的 Promise
+ */
+export const addRecipeScore = params => {
+  const {
+      scoreInfo
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.score.add"),
+    version: '1.0',
+    data: _objectSpread({
+      scoreJson: JSON.stringify(scoreInfo)
+    }, rest)
+  });
+};
+
+// #endregion
+
+// #region 用户通过食谱 ID 获取评分信息
+
+/**
+ * GetRecipeScoreByMenuIdParams - 用户通过食谱 ID 获取评分信息参数
+ */
+
+/**
+ * 评分结果
+ */
+
+/**
+ * GetRecipeScoreByMenuIdResponse - 用户通过食谱 ID 获取评分信息响应
+ */
+
+/**
+ * 用户通过食谱 ID 获取评分信息
+ * @param {GetRecipeScoreByMenuIdParams} params - 用户获取评分信息参数
+ * @returns {Promise<GetRecipeScoreByMenuIdResponse>} - 用户获取评分信息结果的 Promise
+ */
+export const getRecipeScoreByMenuId = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.score.get"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion
+
+// #region 用户通过食谱 IDs 获取评分信息
+
+/**
+ * QueryCondition - 查询条件
+ */
+
+/**
+ * GetRecipeScoresByMenuIdsParams - 用户通过食谱 IDs 获取评分信息参数
+ */
+
+/**
+ * GetRecipeScoresByMenuIdsResponse - 用户通过食谱 IDs 获取评分信息响应
+ */
+
+/**
+ * 用户通过食谱 IDs 获取评分信息
+ * @param {GetRecipeScoresByMenuIdsParams} params - 用户获取评分信息参数
+ * @returns {Promise<GetRecipeScoresByMenuIdsResponse>} - 用户获取评分信息结果的 Promise
+ */
+export const getRecipeScoresByMenuIds = params => {
+  const {
+      query
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded2);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.score.bat.get"),
+    version: '1.0',
+    data: _objectSpread({
+      queryJson: JSON.stringify(query)
+    }, rest)
+  });
+};
+
+// #endregion

package/lib/cloud/recipe/score.md

@@ -0,0 +1,112 @@
+## addRecipeScore
+
+用户添加评分。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { addRecipeScore } from '@ray-js/ray'
+```
+
+**参数**
+
+**AddRecipeScoreParams params**
+
+封装了用户添加评分的参数对象。
+
+**参数属性 AddRecipeScoreParams**
+
+| 属性      | 类型        | 默认值 | 必填 | 说明     |
+| --------- | ----------- | ------ | ---- | -------- |
+| scoreInfo | `ScoreInfo` |        | 是   | 评分信息 |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 用户添加评分
+ * @param {AddRecipeScoreParams} params - 用户添加评分参数
+ * @returns {Promise<AddRecipeScoreResponse>} - 用户添加评分结果的 Promise 对象
+ */
+export const addRecipeScore: (params: AddRecipeScoreParams) => Promise<AddRecipeScoreResponse>
+```
+
+---
+
+## getRecipeScoreByMenuId
+
+用户通过食谱 ID 获取评分信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRecipeScoreByMenuId } from '@ray-js/ray'
+```
+
+**参数**
+
+**GetRecipeScoreByMenuIdParams params**
+
+封装了用户通过食谱 ID 获取评分信息的参数对象。
+
+**参数属性 GetRecipeScoreByMenuIdParams**
+
+| 属性   | 类型     | 默认值 | 必填 | 说明    |
+| ------ | -------- | ------ | ---- | ------- |
+| menuId | `number` |        | 是   | 食谱 ID |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 用户通过食谱 ID 获取评分信息
+ * @param {GetRecipeScoreByMenuIdParams} params - 用户获取评分信息参数
+ * @returns {Promise<GetRecipeScoreByMenuIdResponse>} - 用户获取评分信息结果的 Promise 对象
+ */
+export const getRecipeScoreByMenuId: (
+  params: GetRecipeScoreByMenuIdParams
+) => Promise<GetRecipeScoreByMenuIdResponse>
+```
+
+---
+
+## getRecipeScoresByMenuIds
+
+用户通过食谱 IDs 获取评分信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRecipeScoresByMenuIds } from '@ray-js/ray'
+```
+
+**参数**
+
+**GetRecipeScoresByMenuIdsParams params**
+
+封装了用户通过食谱 IDs 获取评分信息的参数对象。
+
+**参数属性 GetRecipeScoresByMenuIdsParams**
+
+| 属性  | 类型             | 默认值 | 必填 | 说明     |
+| ----- | ---------------- | ------ | ---- | -------- |
+| query | `QueryCondition` |        | 是   | 查询条件 |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 用户通过食谱 IDs 获取评分信息
+ * @param {GetRecipeScoresByMenuIdsParams} params - 用户获取评分信息参数
+ * @returns {Promise<GetRecipeScoresByMenuIdsResponse>} - 用户获取评分信息结果的 Promise 对象
+ */
+export const getRecipeScoresByMenuIds: (
+  params: GetRecipeScoresByMenuIdsParams
+) => Promise<GetRecipeScoresByMenuIdsResponse>
+```