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

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

@@ -0,0 +1,170 @@
+type GetRecipeListParams = {
+    query: RecipeListQuery;
+};
+/**
+ * RecipeListQuery - 食谱列表查询条件
+ */
+interface RecipeListQuery {
+    productId: string;
+    name?: string;
+    categoryIds?: number[];
+    cookTimeMin?: number;
+    cookTimeMax?: number;
+    easyLevelIds?: number[];
+    foodTypeIds?: number[];
+    allergenIds?: number[];
+    isFoodChannel?: number;
+    orderType?: number;
+    pvWeight?: number;
+    starCountWeight?: number;
+    avgScoreWeight?: number;
+    pageNo: number;
+    pageSize: number;
+}
+/**
+ * RecipeInfo - 食谱信息
+ */
+interface RecipeInfo {
+    id: number;
+    mainImgs: string[];
+    lang: number;
+    langDesc: string;
+    desc: string;
+    cookType: number;
+    sourceType: number;
+    isMainShow: number;
+    isShowControl: number;
+    isControl: number;
+    name: string;
+    easyLevel: string;
+    easyLevelDesc: string;
+    taste: string;
+    tasteDesc: string;
+    foodType: string;
+    foodTypeDesc: string;
+    cookTime: number;
+    eatCount: number;
+    avgScore: number;
+    isStar: boolean;
+    gmtCreate: number;
+    gmtModified: number;
+}
+/**
+ * RecipeListResult - 食谱列表返回结果
+ */
+interface RecipeListResult {
+    totalCount: number;
+    pageNo: number;
+    pageSize: number;
+    hasNext: boolean;
+    data: RecipeInfo[];
+}
+/**
+ * RecipeListResponse - 食谱列表响应参数
+ */
+type RecipeListResponse = RecipeListResult;
+/**
+ * 获取食谱列表
+ * @param {RecipeListQuery} query - 食谱列表查询条件
+ * @returns {Promise<RecipeListResponse>} - 食谱列表响应的 Promise
+ */
+export declare const getRecipeList: (params: GetRecipeListParams) => Promise<RecipeListResponse>;
+interface RecipeDetailParams {
+    menuId: number;
+    devId: string;
+}
+interface AllergenInfo {
+    id: number;
+    name: string;
+}
+interface LangInfo {
+    lang: string;
+    stepImg?: string;
+    origStepImg?: string;
+    desc: string;
+}
+interface MenuStepInfoVO {
+    id: number;
+    menuId: number;
+    step: number;
+    langInfos: LangInfo[];
+    gmtCreate: number;
+    gmtModified: number;
+}
+interface CookStepInfoVO {
+    id: number;
+    menuId: number;
+    isCookArgs: number;
+    step: number;
+    stepImg?: string;
+    origStepImg?: string;
+    finishCtrl?: string;
+    cookArgs?: any[];
+    langInfos: LangInfo[];
+    gmtCreate: number;
+    gmtModified: number;
+}
+interface FoodInfoVO {
+    id: number;
+    name: string;
+    lang: string;
+    image: string;
+    desc: string;
+    menuFoodRelationVO: any;
+    foodNutritionVOList: any[];
+    gmtCreate: number;
+    gmtModified: number;
+}
+interface CustomLangInfo {
+    lang: string;
+    name: string;
+    desc: string;
+    fileUrl?: string;
+}
+interface CustomInfo {
+    code: string;
+    langInfos: CustomLangInfo[];
+}
+interface RecipeDetailResult {
+    id: number;
+    name: string;
+    desc: string;
+    information: string;
+    xyxk: string;
+    foods?: string;
+    mainImgs: string[];
+    origMainImgs?: string[];
+    lang: number;
+    langDesc: string;
+    preVideo?: string;
+    stepVideo?: string;
+    isMainShow: number;
+    isControl: number;
+    isShowControl: number;
+    sourceType: number;
+    cookType: number;
+    extInfo?: string;
+    cookTime: number;
+    useFoodLib: number;
+    eatCount: number;
+    isFoodChannel: number;
+    easyLevel: string;
+    easyLevelDesc: string;
+    taste: string;
+    tasteDesc: string;
+    foodType: string;
+    foodTypeDesc: string;
+    allergens: AllergenInfo[];
+    author: string;
+    pv: number;
+    avgScore: number;
+    menuStepInfoVOList: MenuStepInfoVO[];
+    cookStepInfoVOList: CookStepInfoVO[];
+    foodInfoVOList: FoodInfoVO[];
+    customInfoList: CustomInfo[];
+    gmtCreate: number;
+    gmtModified: number;
+}
+type RecipeDetailResponse = RecipeDetailResult;
+export declare const getRecipeDetail: (params: RecipeDetailParams) => Promise<RecipeDetailResponse>;
+export {};

package/lib/cloud/recipe/menu.js

@@ -0,0 +1,76 @@
+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 食谱列表
+
+/**
+ * RecipeListQuery - 食谱列表查询条件
+ */
+
+/**
+ * RecipeInfo - 食谱信息
+ */
+
+/**
+ * RecipeListResult - 食谱列表返回结果
+ */
+
+/**
+ * RecipeListResponse - 食谱列表响应参数
+ */
+
+/**
+ * 获取食谱列表
+ * @param {RecipeListQuery} query - 食谱列表查询条件
+ * @returns {Promise<RecipeListResponse>} - 食谱列表响应的 Promise
+ */
+export const getRecipeList = params => {
+  const {
+      query
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.lang.list"),
+    version: '2.0',
+    data: _objectSpread({
+      queryJson: JSON.stringify(query)
+    }, rest)
+  });
+};
+
+//#endregion
+
+// #region 获取食谱详情的函数
+// 请求参数接口
+
+// 过敏原信息接口
+
+// 多语言信息接口
+
+// 图文步骤接口
+
+// 烹饪步骤接口
+
+// 食材信息接口
+
+// 自定义属性多语言信息接口
+
+// 自定义属性接口
+
+// 食谱详情响应结果中的 result 接口
+
+// 食谱详情响应接口
+
+// 获取食谱详情的函数
+export const getRecipeDetail = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.get"),
+    version: '1.0',
+    // 假设使用 GET 方法
+    data: params
+  });
+};
+
+//#endregion

package/lib/cloud/recipe/menu.md

@@ -0,0 +1,276 @@
+## getRecipeList
+
+获取食谱列表
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRecipeList } from '@ray-js/ray'
+```
+
+**参数**
+
+`GetRecipeListParams` 对象，包含以下属性：
+
+| 属性  | 类型              | 默认值 | 必填 | 说明             |
+| ----- | ----------------- | ------ | ---- | ---------------- |
+| query | `RecipeListQuery` |        | 是   | 食谱列表查询条件 |
+
+`RecipeListQuery` 包含以下属性：
+
+| 属性            | 类型       | 默认值 | 必填 | 说明             |
+| --------------- | ---------- | ------ | ---- | ---------------- |
+| productId       | `string`   |        | 是   | 产品 ID          |
+| name            | `string`   |        | 否   | 食谱名称         |
+| categoryIds     | `number[]` |        | 否   | 分类 ID 数组     |
+| cookTimeMin     | `number`   |        | 否   | 最小烹饪时间     |
+| cookTimeMax     | `number`   |        | 否   | 最大烹饪时间     |
+| easyLevelIds    | `number[]` |        | 否   | 难易等级 ID 数组 |
+| foodTypeIds     | `number[]` |        | 否   | 食品类型 ID 数组 |
+| allergenIds     | `number[]` |        | 否   | 过敏原 ID 数组   |
+| isFoodChannel   | `number`   |        | 否   | 是否为食品频道   |
+| orderType       | `number`   |        | 否   | 排序类型         |
+| pvWeight        | `number`   |        | 否   | 浏览量权重       |
+| starCountWeight | `number`   |        | 否   | 收藏数权重       |
+| avgScoreWeight  | `number`   |        | 否   | 平均评分权重     |
+| pageNo          | `number`   |        | 是   | 页码             |
+| pageSize        | `number`   |        | 是   | 每页显示数量     |
+
+**返回结果 RecipeListResponse**
+
+| 属性       | 类型           | 说明         |
+| ---------- | -------------- | ------------ |
+| totalCount | `number`       | 总记录数     |
+| pageNo     | `number`       | 当前页码     |
+| pageSize   | `number`       | 每页记录数   |
+| hasNext    | `boolean`      | 是否有下一页 |
+| data       | `RecipeInfo[]` | 食谱信息数组 |
+
+**RecipeInfo**
+
+| 属性          | 类型       | 说明         |
+| ------------- | ---------- | ------------ |
+| id            | `number`   | 食谱 ID      |
+| mainImgs      | `string[]` | 主图数组     |
+| lang          | `number`   | 语言类型     |
+| langDesc      | `string`   | 语言描述     |
+| desc          | `string`   | 描述         |
+| cookType      | `number`   | 烹饪方式     |
+| sourceType    | `number`   | 来源类型     |
+| isMainShow    | `number`   | 是否主显示   |
+| isShowControl | `number`   | 是否显示控制 |
+| isControl     | `number`   | 是否受控     |
+| name          | `string`   | 名称         |
+| easyLevel     | `string`   | 难易等级     |
+| easyLevelDesc | `string`   | 难易等级描述 |
+| taste         | `string`   | 口味         |
+| tasteDesc     | `string`   | 口味描述     |
+| foodType      | `string`   | 食品类型     |
+| foodTypeDesc  | `string`   | 食品类型描述 |
+| cookTime      | `number`   | 烹饪时间     |
+| eatCount      | `number`   | 用餐人数     |
+| avgScore      | `number`   | 平均评分     |
+| isStar        | `boolean`  | 是否加星     |
+| gmtCreate     | `number`   | 创建时间     |
+| gmtModified   | `number`   | 修改时间     |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取食谱列表
+ * @param {GetRecipeListParams} params - 包含查询条件的对象
+ * @returns {Promise<RecipeListResponse>} - 返回食谱列表响应的 Promise
+ */
+export function getRecipeList(params: GetRecipeListParams): Promise<RecipeListResponse>
+```
+
+## getRecipeDetail
+
+获取食谱详情
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getRecipeDetail } from '@ray-js/ray'
+```
+
+**参数**
+
+`RecipeDetailParams` 对象，包含以下属性：
+
+| 属性   | 类型     | 默认值 | 必填 | 说明    |
+| ------ | -------- | ------ | ---- | ------- |
+| menuId | `number` |        | 是   | 食谱 ID |
+| devId  | `string` |        | 是   | 设备 ID |
+
+### `getRecipeList` 返回结果
+
+`RecipeListResponse` 对象，包含以下属性：
+
+| 属性       | 类型           | 说明         |
+| ---------- | -------------- | ------------ |
+| totalCount | `number`       | 总记录数     |
+| pageNo     | `number`       | 当前页码     |
+| pageSize   | `number`       | 每页记录数   |
+| hasNext    | `boolean`      | 是否有下一页 |
+| data       | `RecipeInfo[]` | 食谱信息数组 |
+
+`RecipeInfo` 对象，包含以下属性：
+
+| 属性          | 类型       | 说明         |
+| ------------- | ---------- | ------------ |
+| id            | `number`   | 食谱 ID      |
+| mainImgs      | `string[]` | 主图数组     |
+| lang          | `number`   | 语言类型     |
+| langDesc      | `string`   | 语言描述     |
+| desc          | `string`   | 描述         |
+| cookType      | `number`   | 烹饪方式     |
+| sourceType    | `number`   | 来源类型     |
+| isMainShow    | `number`   | 是否主显示   |
+| isShowControl | `number`   | 是否显示控制 |
+| isControl     | `number`   | 是否受控     |
+| name          | `string`   | 名称         |
+| easyLevel     | `string`   | 难易等级     |
+| easyLevelDesc | `string`   | 难易等级描述 |
+| taste         | `string`   | 口味         |
+| tasteDesc     | `string`   | 口味描述     |
+| foodType      | `string`   | 食品类型     |
+| foodTypeDesc  | `string`   | 食品类型描述 |
+| cookTime      | `number`   | 烹饪时间     |
+| eatCount      | `number`   | 用餐人数     |
+| avgScore      | `number`   | 平均评分     |
+| isStar        | `boolean`  | 是否加星     |
+| gmtCreate     | `number`   | 创建时间     |
+| gmtModified   | `number`   | 修改时间     |
+
+**返回结果 RecipeDetailResponse**
+
+| 属性               | 类型               | 说明               |
+| ------------------ | ------------------ | ------------------ |
+| id                 | `number`           | 食谱 ID            |
+| name               | `string`           | 名称               |
+| desc               | `string`           | 描述               |
+| information        | `string`           | 信息               |
+| xyxk               | `string`           | 食谱相关信息       |
+| foods              | `string`           | 食材               |
+| mainImgs           | `string[]`         | 主图数组           |
+| origMainImgs       | `string[]`         | 原始主图数组       |
+| lang               | `number`           | 语言类型           |
+| langDesc           | `string`           | 语言描述           |
+| preVideo           | `string`           | 准备视频           |
+| stepVideo          | `string`           | 步骤视频           |
+| isMainShow         | `number`           | 是否主显示         |
+| isControl          | `number`           | 是否受控           |
+| isShowControl      | `number`           | 是否显示控制       |
+| sourceType         | `number`           | 来源类型           |
+| cookType           | `number`           | 烹饪方式           |
+| extInfo            | `string`           | 扩展信息           |
+| cookTime           | `number`           | 烹饪时间           |
+| useFoodLib         | `number`           | 使用食材库         |
+| eatCount           | `number`           | 用餐人数           |
+| isFoodChannel      | `number`           | 是否为食品频道     |
+| easyLevel          | `string`           | 难易等级           |
+| easyLevelDesc      | `string`           | 难易等级描述       |
+| taste              | `string`           | 口味               |
+| tasteDesc          | `string`           | 口味描述           |
+| foodType           | `string`           | 食品类型           |
+| foodTypeDesc       | `string`           | 食品类型描述       |
+| allergens          | `AllergenInfo[]`   | 过敏原信息数组     |
+| author             | `string`           | 作者               |
+| pv                 | `number`           | 浏览量             |
+| avgScore           | `number`           | 平均评分           |
+| menuStepInfoVOList | `MenuStepInfoVO[]` | 图文步骤信息数组   |
+| cookStepInfoVOList | `CookStepInfoVO[]` | 烹饪步骤信息数组   |
+| foodInfoVOList     | `FoodInfoVO[]`     | 食材信息数组       |
+| customInfoList     | `CustomInfo[]`     | 自定义属性信息数组 |
+| gmtCreate          | `number`           | 创建时间           |
+| gmtModified        | `number`           | 修改时间           |
+
+**AllergenInfo**
+
+| 属性 | 类型     | 说明       |
+| ---- | -------- | ---------- |
+| id   | `number` | 过敏原 ID  |
+| name | `string` | 过敏原名称 |
+
+**LangInfo**
+
+| 属性        | 类型     | 说明                 |
+| ----------- | -------- | -------------------- |
+| lang        | `string` | 语言标识             |
+| stepImg     | `string` | 步骤图片（可选）     |
+| origStepImg | `string` | 原始步骤图片（可选） |
+| desc        | `string` | 描述                 |
+
+**MenuStepInfoVO**
+
+| 属性        | 类型         | 说明           |
+| ----------- | ------------ | -------------- |
+| id          | `number`     | 步骤 ID        |
+| menuId      | `number`     | 菜单 ID        |
+| step        | `number`     | 步骤编号       |
+| langInfos   | `LangInfo[]` | 多语言信息数组 |
+| gmtCreate   | `number`     | 创建时间       |
+| gmtModified | `number`     | 修改时间       |
+
+**CookStepInfoVO**
+
+| 属性        | 类型         | 说明                 |
+| ----------- | ------------ | -------------------- |
+| id          | `number`     | 步骤 ID              |
+| menuId      | `number`     | 菜单 ID              |
+| isCookArgs  | `number`     | 是否为烹饪参数       |
+| step        | `number`     | 步骤编号             |
+| stepImg     | `string`     | 步骤图片（可选）     |
+| origStepImg | `string`     | 原始步骤图片（可选） |
+| finishCtrl  | `string`     | 完成控制（可选）     |
+| cookArgs    | `any[]`      | 烹饪参数（可选）     |
+| langInfos   | `LangInfo[]` | 多语言信息数组       |
+| gmtCreate   | `number`     | 创建时间             |
+| gmtModified | `number`     | 修改时间             |
+
+**FoodInfoVO**
+
+| 属性                | 类型     | 说明             |
+| ------------------- | -------- | ---------------- |
+| id                  | `number` | 食材 ID          |
+| name                | `string` | 食材名称         |
+| lang                | `string` | 语言标识         |
+| image               | `string` | 食材图片         |
+| desc                | `string` | 食材描述         |
+| menuFoodRelationVO  | `any`    | 菜单食材关系对象 |
+| foodNutritionVOList | `any[]`  | 食材营养信息数组 |
+| gmtCreate           | `number` | 创建时间         |
+| gmtModified         | `number` | 修改时间         |
+
+**CustomLangInfo**
+
+| 属性    | 类型     | 说明             |
+| ------- | -------- | ---------------- |
+| lang    | `string` | 语言标识         |
+| name    | `string` | 名称             |
+| desc    | `string` | 描述             |
+| fileUrl | `string` | 文件 URL（可选） |
+
+**CustomInfo**
+
+| 属性      | 类型               | 说明           |
+| --------- | ------------------ | -------------- |
+| code      | `string`           | 自定义属性编码 |
+| langInfos | `CustomLangInfo[]` | 多语言信息数组 |
+
+**函数定义示例**
+
+```typescript
+/**
+ * 获取食谱详情
+ * @param {RecipeDetailParams} params - 包含食谱 ID 和设备 ID 的对象
+ * @returns {Promise<RecipeDetailResponse>} - 返回食谱详情响应的 Promise
+ */
+export function getRecipeDetail(params: RecipeDetailParams): Promise<RecipeDetailResponse>
+```

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

@@ -0,0 +1,87 @@
+/**
+ * LanguageDescription - 语言描述信息
+ */
+type LanguageDescription = {
+    enDesc: string;
+    cnDesc: string;
+    code: string;
+    orderNum: number;
+};
+/**
+ * GetAllLanguagesResponse - 获取食谱所有语言响应
+ */
+type GetAllLanguagesResponse = LanguageDescription[];
+/**
+ * 获取食谱所支持的所有语言信息
+ * @returns {Promise<GetAllLanguagesResponse>} - 获取所有语言信息结果的 Promise
+ */
+export declare const getAllLanguages: () => Promise<GetAllLanguagesResponse>;
+/**
+ * GetSearchModelParams - 获取搜索模型参数
+ */
+type GetSearchModelParams = {
+    productId: string;
+};
+/**
+ * SearchModelResponse - 获取搜索模型响应
+ */
+type SearchModelResponse = {
+    metadata: Metadata[];
+    productGroup: ProductGroup[];
+};
+/**
+ * Metadata - 元数据信息
+ */
+type Metadata = {
+    gmtModified: number;
+    code: string;
+    id: number;
+    gmtCreate: number;
+    value: string;
+    langInfos: LangInfo[];
+    key: string;
+};
+/**
+ * ProductGroup - 产品组信息
+ */
+type ProductGroup = {
+    gmtModified: number;
+    name: string;
+    id: number;
+    gmtCreate: number;
+};
+/**
+ * 获取 C 端用户搜索模型
+ * @param {GetSearchModelParams} params - 获取搜索模型参数
+ * @returns {Promise<SearchModelResponse>} - 获取搜索模型结果的 Promise
+ */
+export declare const getSearchModel: (params: GetSearchModelParams) => Promise<SearchModelResponse>;
+/**
+ * CookingTimeCondition - 烹饪时间筛选条件
+ */
+type CookingTimeCondition = {
+    sourceType: number;
+    name?: string;
+    categoryIds?: number[];
+};
+/**
+ * GetCookingTimeConditionParams - 获取烹饪时间筛选条件参数
+ */
+type GetCookingTimeConditionParams = {
+    query: CookingTimeCondition;
+    devId: string;
+};
+/**
+ * CookingTimeConditionResponse - 获取烹饪时间筛选条件响应
+ */
+type CookingTimeConditionResponse = {
+    minCookTime: number;
+    maxCookTime: number;
+};
+/**
+ * 获取已上线食谱的最小、最大烹饪时间
+ * @param {GetCookingTimeConditionParams} params - 获取烹饪时间筛选条件参数
+ * @returns {Promise<CookingTimeConditionResponse>} - 获取烹饪时间筛选条件结果的 Promise
+ */
+export declare const getCookingTimeCondition: (params: GetCookingTimeConditionParams) => Promise<CookingTimeConditionResponse>;
+export {};

package/lib/cloud/recipe/query.js

@@ -0,0 +1,101 @@
+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 获取食谱所有语言
+
+/**
+ * GetAllLanguagesParams - 获取食谱所有语言参数
+ */
+
+/**
+ * LanguageDescription - 语言描述信息
+ */
+
+/**
+ * GetAllLanguagesResponse - 获取食谱所有语言响应
+ */
+
+/**
+ * 获取食谱所支持的所有语言信息
+ * @returns {Promise<GetAllLanguagesResponse>} - 获取所有语言信息结果的 Promise
+ */
+export const getAllLanguages = () => {
+  return requestCloud({
+    api: "".concat(THING, ".m.cookbook.all.lang"),
+    version: '1.0',
+    data: {}
+  });
+};
+
+// #endregion
+
+// #region 获取搜索模型
+
+/**
+ * GetSearchModelParams - 获取搜索模型参数
+ */
+
+/**
+ * SearchModelResponse - 获取搜索模型响应
+ */
+
+/**
+ * Metadata - 元数据信息
+ */
+
+/**
+ * ProductGroup - 产品组信息
+ */
+
+/**
+ * 获取 C 端用户搜索模型
+ * @param {GetSearchModelParams} params - 获取搜索模型参数
+ * @returns {Promise<SearchModelResponse>} - 获取搜索模型结果的 Promise
+ */
+export const getSearchModel = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.query.model.list"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion
+
+// #region 获取烹饪时间筛选条件
+
+/**
+ * CookingTimeCondition - 烹饪时间筛选条件
+ */
+
+/**
+ * GetCookingTimeConditionParams - 获取烹饪时间筛选条件参数
+ */
+
+/**
+ * CookingTimeConditionResponse - 获取烹饪时间筛选条件响应
+ */
+
+/**
+ * 获取已上线食谱的最小、最大烹饪时间
+ * @param {GetCookingTimeConditionParams} params - 获取烹饪时间筛选条件参数
+ * @returns {Promise<CookingTimeConditionResponse>} - 获取烹饪时间筛选条件结果的 Promise
+ */
+export const getCookingTimeCondition = params => {
+  const {
+      query
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.search.condition"),
+    version: '1.0',
+    data: _objectSpread({
+      queryJson: JSON.stringify(query)
+    }, rest)
+  });
+};
+
+// #endregion