@ray-js/api 1.5.4 → 1.5.5

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

@@ -71,6 +71,13 @@ type CookArg = {
     dpCode: string;
     dpValue: string;
 };
+type CustomPropertiesItem = {
+    bizCode: string;
+    name: string;
+    desc: string;
+    fileUrl: string;
+    bizOrder: number;
+};
 /**
  * 自定义食谱信息
  */
@@ -87,6 +94,7 @@ type MenuCustomInfo = {
     cookTime?: number;
     stepInfoParams: StepInfoParam[];
     cookStepParams: CookStepParam[];
+    customProperties?: CustomPropertiesItem[];
 };
 /**
  * AddCustomRecipeParams - 自定义食谱添加请求参数
@@ -140,6 +148,7 @@ type UpdateMenuCustomInfo = {
     cookTime?: number;
     stepInfoParams: UpdateStepInfoParam[];
     cookStepParams: UpdateCookStepParam[];
+    customProperties?: CustomPropertiesItem[];
 };
 /**
  * UpdateCustomRecipeParams - 自定义食谱更新请求参数

package/lib/cloud/recipe/custom.md

@@ -90,31 +90,40 @@ import { addCustomRecipe } from '@ray-js/ray'
 
 **MenuCustomInfo**
 
-| 属性           | 类型              | 说明         |
-| -------------- | ----------------- | ------------ |
-| mainImages     | `string[]`        | 主图数组     |
-| name           | `string`          | 食谱名称     |
-| desc           | `string`          | 食谱简介     |
-| productGroupId | `string`          | 产品组 ID    |
-| isPublish      | `number`          | 是否公开     |
-| cookType       | `number`          | 烹饪类型     |
-| foods          | `string`          | 食材         |
-| information    | `string`          | 相关常识     |
-| xyxk           | `string`          | 相宜相克     |
-| cookTime       | `number`          | 烹饪时间     |
-| stepInfoParams | `StepInfoParam[]` | 图文步骤     |
-| cookStepParams | `CookStepParam[]` | 烹饪步骤信息 |
-
-下面是根据您提供的类型定义生成的表格：
-
-### StepInfoParam
+| 属性             | 类型                     | 可选性 | 说明                                |
+| ---------------- | ------------------------ | ------ | ----------------------------------- |
+| mainImages       | `string[]`               | 必须   | 主图数组                            |
+| name             | `string`                 | 必须   | 食谱名称                            |
+| desc             | `string`                 | 可选   | 食谱简介                            |
+| productGroupId   | `string`                 | 必须   | 产品组 ID                           |
+| isPublish        | `number`                 | 可选   | 是否公开                            |
+| cookType         | `number`                 | 必须   | 烹饪类型                            |
+| foods            | `string`                 | 可选   | 食材                                |
+| information      | `string`                 | 可选   | 相关常识                            |
+| xyxk             | `string`                 | 可选   | 相宜相克                            |
+| cookTime         | `number`                 | 可选   | 烹饪时间                            |
+| stepInfoParams   | `StepInfoParam[]`        | 必须   | 图文步骤                            |
+| cookStepParams   | `CookStepParam[]`        | 必须   | 烹饪步骤信息                        |
+| customProperties | `CustomPropertiesItem[]` | 可选   | 自定义属性 `@ray-js/ray^1.5.5` 新增 |
+
+**CustomPropertiesItem**
+
+| 字段     | 类型   | 可选性 | 描述               |
+| -------- | ------ | ------ | ------------------ |
+| bizCode  | string | 必须   | 自定义属性 code    |
+| name     | string | 必须   | 自定义属性名称     |
+| desc     | string | 必须   | 自定义属性内容     |
+| fileUrl  | string | 必须   | 自定义属性文件 URL |
+| bizOrder | string | 必须   | 自定义属性排序     |
+
+**StepInfoParam**
 
 | 字段    | 类型   | 可选性 | 描述         |
 | ------- | ------ | ------ | ------------ |
 | stepImg | string | 可选   | 步骤图片路径 |
 | desc    | string | 必须   | 步骤描述     |
 
-### CookStepParam 表格
+**CookStepParam**
 
 | 字段       | 类型      | 可选性 | 描述         |
 | ---------- | --------- | ------ | ------------ |
@@ -124,7 +133,7 @@ import { addCustomRecipe } from '@ray-js/ray'
 | finishCtrl | string    | 必须   | 完成执行选项 |
 | cookArgs   | CookArg[] | 必须   | 烹饪参数数组 |
 
-### CookArg 表格
+**CookArg**
 
 | 字段    | 类型   | 可选性 | 描述    |
 | ------- | ------ | ------ | ------- |
@@ -169,23 +178,34 @@ import { updateCustomRecipe } from '@ray-js/ray'
 
 **UpdateMenuCustomInfo**
 
-| 属性           | 类型                    | 说明         |
-| -------------- | ----------------------- | ------------ |
-| id             | `number`                | 食谱 ID      |
-| mainImages     | `string[]`              | 主图数组     |
-| name           | `string`                | 食谱名称     |
-| desc           | `string`                | 食谱简介     |
-| productGroupId | `string`                | 产品组 ID    |
-| isPublish      | `number`                | 是否公开     |
-| cookType       | `number`                | 烹饪类型     |
-| foods          | `string`                | 食材         |
-| information    | `string`                | 相关常识     |
-| xyxk           | `string`                | 相宜相克     |
-| cookTime       | `number`                | 烹饪时间     |
-| stepInfoParams | `UpdateStepInfoParam[]` | 图文步骤     |
-| cookStepParams | `UpdateCookStepParam[]` | 烹饪步骤信息 |
-
-### UpdateStepInfoParam
+| 属性             | 类型                     | 说明         |
+| ---------------- | ------------------------ | ------------ | ----------------------------------- |
+| id               | `number`                 | 食谱 ID      |
+| mainImages       | `string[]`               | 主图数组     |
+| name             | `string`                 | 食谱名称     |
+| desc             | `string`                 | 食谱简介     |
+| productGroupId   | `string`                 | 产品组 ID    |
+| isPublish        | `number`                 | 是否公开     |
+| cookType         | `number`                 | 烹饪类型     |
+| foods            | `string`                 | 食材         |
+| information      | `string`                 | 相关常识     |
+| xyxk             | `string`                 | 相宜相克     |
+| cookTime         | `number`                 | 烹饪时间     |
+| stepInfoParams   | `UpdateStepInfoParam[]`  | 图文步骤     |
+| cookStepParams   | `UpdateCookStepParam[]`  | 烹饪步骤信息 |
+| customProperties | `CustomPropertiesItem[]` | 可选         | 自定义属性 `@ray-js/ray^1.5.5` 新增 |
+
+**CustomPropertiesItem**
+
+| 字段     | 类型   | 可选性 | 描述               |
+| -------- | ------ | ------ | ------------------ |
+| bizCode  | string | 必须   | 自定义属性 code    |
+| name     | string | 必须   | 自定义属性名称     |
+| desc     | string | 必须   | 自定义属性内容     |
+| fileUrl  | string | 必须   | 自定义属性文件 URL |
+| bizOrder | string | 必须   | 自定义属性排序     |
+
+**UpdateStepInfoParam**
 
 | 字段    | 类型   | 可选性 | 描述         |
 | ------- | ------ | ------ | ------------ |
@@ -193,7 +213,7 @@ import { updateCustomRecipe } from '@ray-js/ray'
 | stepImg | string | 可选   | 步骤图片路径 |
 | desc    | string | 必须   | 步骤描述     |
 
-### UpdateCookStepParam 表格
+**UpdateCookStepParam**
 
 | 字段       | 类型      | 可选性 | 描述         |
 | ---------- | --------- | ------ | ------------ |
@@ -203,7 +223,7 @@ import { updateCustomRecipe } from '@ray-js/ray'
 | finishCtrl | string    | 必须   | 完成执行选项 |
 | cookArgs   | CookArg[] | 必须   | 烹饪参数数组 |
 
-### CookArg 表格
+**CookArg**
 
 | 字段    | 类型   | 可选性 | 描述    |
 | ------- | ------ | ------ | ------- |

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

@@ -18,9 +18,14 @@ interface RecipeListQuery {
     pvWeight?: number;
     starCountWeight?: number;
     avgScoreWeight?: number;
+    customInfoQuery?: CustomInfoQueryItem[];
     pageNo: number;
     pageSize: number;
 }
+interface CustomInfoQueryItem {
+    code: string;
+    langValue: string;
+}
 /**
  * RecipeInfo - 食谱信息
  */
@@ -120,9 +125,11 @@ interface CustomLangInfo {
     name: string;
     desc: string;
     fileUrl?: string;
+    origFileUrl: string;
 }
 interface CustomInfo {
     code: string;
+    fileUrl: string;
     langInfos: CustomLangInfo[];
 }
 interface RecipeDetailResult {
@@ -162,9 +169,28 @@ interface RecipeDetailResult {
     cookStepInfoVOList: CookStepInfoVO[];
     foodInfoVOList: FoodInfoVO[];
     customInfoList: CustomInfo[];
+    likes: number;
+    isLike: boolean;
     gmtCreate: number;
     gmtModified: number;
 }
 type RecipeDetailResponse = RecipeDetailResult;
 export declare const getRecipeDetail: (params: RecipeDetailParams) => Promise<RecipeDetailResponse>;
+type OperateRecipeLikeParams = {
+    like: RecipeLike;
+};
+type RecipeLike = {
+    menuId: number;
+    devId: string;
+};
+/**
+ * OperateRecipeLikeResponse - 食谱点赞响应参数
+ */
+type OperateRecipeLikeResponse = boolean;
+/**
+ * 食谱点赞 1.5.5 新增
+ * @param {OperateRecipeLikeParams} params - 食谱点赞信息
+ * @returns {Promise<OperateRecipeLikeResponse>} - 食谱点赞响应 Promise
+ */
+export declare const operateRecipeLike: (params: OperateRecipeLikeParams) => Promise<OperateRecipeLikeResponse>;
 export {};

package/lib/cloud/recipe/menu.js

@@ -1,6 +1,7 @@
 import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
-const _excluded = ["query"];
+const _excluded = ["query"],
+  _excluded2 = ["like"];
 import { THING } from '../../constants';
 import requestCloud from '../../requestCloud';
 // #region 食谱列表
@@ -73,4 +74,31 @@ export const getRecipeDetail = params => {
   });
 };
 
+//#endregion
+
+// #region 食谱点赞
+
+/**
+ * OperateRecipeLikeResponse - 食谱点赞响应参数
+ */
+
+/**
+ * 食谱点赞 1.5.5 新增
+ * @param {OperateRecipeLikeParams} params - 食谱点赞信息
+ * @returns {Promise<OperateRecipeLikeResponse>} - 食谱点赞响应 Promise
+ */
+export const operateRecipeLike = params => {
+  const {
+      like
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded2);
+  return requestCloud({
+    api: "m.ha.recipe.operate.like",
+    version: '1.0',
+    data: _objectSpread({
+      likeJson: JSON.stringify(like)
+    }, rest)
+  });
+};
+
 //#endregion

package/lib/cloud/recipe/menu.md

@@ -20,23 +20,31 @@ import { getRecipeList } from '@ray-js/ray'
 
 `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`   |        | 是   | 每页显示数量     |
+| 属性 | 类型 | 默认值 | 必填 | 说明 |
+| --- | --- | --- | --- | --- |
+| 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` |  | 否 | 平均评分权重 |
+| customInfoQuery | `CustomInfoQueryItem[]` |  | 否 | 自定义属性查询 `@ray-js/ray^1.5.5` 新增 |
+| pageNo | `number` |  | 是 | 页码 |
+| pageSize | `number` |  | 是 | 每页显示数量 |
+
+**CustomInfoQueryItem**
+
+| 属性      | 类型     | 默认值 | 必填 | 说明             |
+| --------- | -------- | ------ | ---- | ---------------- |
+| code      | `string` |        | 是   | 自定义属性 code  |
+| langValue | `string` |        | 是   | 自定义属性 value |
 
 **返回结果 RecipeListResponse**
 
@@ -150,46 +158,48 @@ import { getRecipeDetail } from '@ray-js/ray'
 
 **返回结果 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`           | 修改时间           |
+| 属性               | 类型               | 说明                             |
+| ------------------ | ------------------ | -------------------------------- |
+| 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[]`     | 自定义属性信息数组               |
+| likes              | `number`           | 点赞次数 `@ray-js/ray^1.5.5`新增 |
+| isLike             | `boolean`          | 是否点赞 `@ray-js/ray^1.5.5`新增 |
+| gmtCreate          | `number`           | 创建时间                         |
+| gmtModified        | `number`           | 修改时间                         |
 
 **AllergenInfo**
 
@@ -250,19 +260,21 @@ import { getRecipeDetail } from '@ray-js/ray'
 
 **CustomLangInfo**
 
-| 属性    | 类型     | 说明             |
-| ------- | -------- | ---------------- |
-| lang    | `string` | 语言标识         |
-| name    | `string` | 名称             |
-| desc    | `string` | 描述             |
-| fileUrl | `string` | 文件 URL（可选） |
+| 属性        | 类型     | 说明             |
+| ----------- | -------- | ---------------- |
+| lang        | `string` | 语言标识         |
+| name        | `string` | 名称             |
+| desc        | `string` | 描述             |
+| fileUrl     | `string` | 文件 URL         |
+| origFileUrl | `string` | 自定义食谱才会有 |
 
 **CustomInfo**
 
-| 属性      | 类型               | 说明           |
-| --------- | ------------------ | -------------- |
-| code      | `string`           | 自定义属性编码 |
-| langInfos | `CustomLangInfo[]` | 多语言信息数组 |
+| 属性      | 类型               | 说明               |
+| --------- | ------------------ | ------------------ |
+| code      | `string`           | 自定义属性编码     |
+| fileUrl   | `string`           | 自定义属性文件 URL |
+| langInfos | `CustomLangInfo[]` | 多语言信息数组     |
 
 **函数定义示例**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.5.4",
+  "version": "1.5.5",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,14 +29,14 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.5.4",
-    "@ray-js/router": "1.5.4",
+    "@ray-js/framework": "1.5.5",
+    "@ray-js/router": "1.5.5",
     "@ray-js/wechat": "^0.2.9",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.5.4",
+    "@ray-js/cli": "1.5.5",
     "art-template": "^4.13.2",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.2",
@@ -46,5 +46,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "gitHead": "4c6d2df39c428c48f7b04018df0359b5ecdc4c04"
+  "gitHead": "3e915fc6eb55c48b0829cfbe32d9a0c6dee1852b"
 }