@ray-js/api 1.5.4 → 1.5.6

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.5.4",
+  "version": "1.5.6",
   "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.6",
+    "@ray-js/router": "1.5.6",
     "@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.6",
     "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": "7b31d04a85a4ac4d5ff3a3714e4e9698fddf87c8"
 }

package/lib/cloud/recipe/basket.md

@@ -1,431 +0,0 @@
-## getBasketStatus
-
-获取菜篮子开关状态功能。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getBasketStatus } from '@ray-js/ray'
-```
-
-### 参数
-
-无参数。
-
-### 返回
-
-**GetBasketStatusResponse**
-
-| 属性         | 类型     | 说明                                  |
-| ------------ | -------- | ------------------------------------- |
-| appId        | `number` | appId                                 |
-| basketStatus | `string` | 菜篮子状态，`true`-开启；`false`-关闭 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取菜篮子开关状态
- */
-export function getBasketStatus(): Promise<GetBasketStatusResponse>
-```
-
-## getBasketList
-
-获取菜篮子列表。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getBasketList } from '@ray-js/ray'
-```
-
-### 参数
-
-无参数。
-
-### 返回
-
-**GetBasketListResponse**
-
-`BasketInfo[]`，菜篮子信息数组。
-
-**BasketInfo**
-
-| 属性        | 类型     | 说明                     |
-| ----------- | -------- | ------------------------ |
-| menuId      | `number` | 食谱 ID                  |
-| name        | `string` | 食谱名称                 |
-| tagId       | `number` | 食材标签 ID              |
-| tagName     | `string` | 食材标签名称             |
-| foodId      | `number` | 食材 ID                  |
-| foodImage   | `string` | 食材图片                 |
-| foodName    | `string` | 食材名称                 |
-| foodDesc    | `string` | 食材备注                 |
-| amount      | `string` | 食材数量（默认单位：克） |
-| secAmount   | `string` | 第二单位数量             |
-| secUnit     | `string` | 第二单位 ID              |
-| secUnitCode | `string` | 第二单位 Code            |
-| secUnitDesc | `string` | 第二单位描述             |
-| ownStatus   | `number` | 持有状态                 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取菜篮子列表
- */
-export function getBasketList(): Promise<GetBasketListResponse>
-```
-
-## addFoodToBasket
-
-添加食材到菜篮子。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { addFoodToBasket } from '@ray-js/ray'
-```
-
-### 参数
-
-**AddFoodToBasketParams**
-
-| 属性     | 类型              | 必填 | 说明         |
-| -------- | ----------------- | ---- | ------------ |
-| foodList | `FoodInfoToAdd[]` | 是   | 食材信息列表 |
-
-**FoodInfoToAdd**
-
-| 属性      | 类型     | 必填 | 说明                     |
-| --------- | -------- | ---- | ------------------------ |
-| menuId    | `number` | 是   | 食谱 ID                  |
-| tagId     | `number` | 否   | 食材标签 ID              |
-| foodId    | `number` | 是   | 食材 ID                  |
-| amount    | `string` | 是   | 食材数量（默认单位：克） |
-| secAmount | `string` | 否   | 第二单位数量             |
-| secUnit   | `string` | 否   | 第二单位 ID              |
-
-### 返回
-
-**AddFoodToBasketResponse**
-
-`boolean`，表示添加成功或失败。
-
-### 函数定义示例
-
-```typescript
-/**
- * 添加食材到菜篮子
- */
-export function addFoodToBasket(params: AddFoodToBasketParams): Promise<AddFoodToBasketResponse>
-```
-
-## updateFoodInBasket
-
-编辑菜篮子中的食材。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { updateFoodInBasket } from '@ray-js/ray'
-```
-
-### 参数
-
-**UpdateFoodInBasketParams**
-
-| 属性     | 类型               | 必填 | 说明     |
-| -------- | ------------------ | ---- | -------- |
-| foodInfo | `FoodInfoToUpdate` | 是   | 食材信息 |
-
-**FoodInfoToUpdate**
-
-| 属性       | 类型       | 必填 | 说明        |
-| ---------- | ---------- | ---- | ----------- |
-| foodId     | `number`   | 是   | 食材 ID     |
-| tagId      | `number`   | 否   | 食材标签 ID |
-| dataType   | `number`   | 是   | 数据维度    |
-| amountType | `number`   | 是   | 数量类型    |
-| menuIds    | `number[]` | 是   | 食谱 IDs    |
-| amount     | `string`   | 否   | 食材数量    |
-| secUnit    | `string`   | 否   | 第二单位 ID |
-
-### 返回
-
-**UpdateFoodInBasketResponse**
-
-`boolean`，表示编辑成功或失败。
-
-### 函数定义示例
-
-```typescript
-/**
- * 编辑菜篮子中的食材
- */
-export function updateFoodInBasket(
-  params: UpdateFoodInBasketParams
-): Promise<UpdateFoodInBasketResponse>
-```
-
-## deleteFoodFromBasket
-
-删除菜篮子中的食材。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { deleteFoodFromBasket } from '@ray-js/ray'
-```
-
-### 参数
-
-**DeleteFoodFromBasketParams**
-
-| 属性     | 类型                 | 必填 | 说明         |
-| -------- | -------------------- | ---- | ------------ |
-| foodList | `FoodInfoToDelete[]` | 是   | 食材信息列表 |
-
-**FoodInfoToDelete**
-
-| 属性      | 类型     | 必填 | 说明        |
-| --------- | -------- | ---- | ----------- |
-| menuId    | `number` | 是   | 食谱 ID     |
-| tagId     | `number` | 否   | 食材标签 ID |
-| foodId    | `number` | 是   | 食材 ID     |
-| secUnit   | `string` | 否   | 第二单位 ID |
-| ownStatus | `number` | 是   | 持有状态    |
-
-### 返回
-
-**DeleteFoodFromBasketResponse**
-
-`boolean`，表示删除成功或失败。
-
-### 函数定义示例
-
-```typescript
-/**
- * 删除菜篮子中的食材
- */
-export function deleteFoodFromBasket(
-  params: DeleteFoodFromBasketParams
-): Promise<DeleteFoodFromBasketResponse>
-```
-
-## ownFoodInBasket
-
-将菜篮子中的食材变为已持有。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { ownFoodInBasket } from '@ray-js/ray'
-```
-
-### 参数
-
-**OwnFoodInBasketParams**
-
-| 属性     | 类型              | 必填 | 说明         |
-| -------- | ----------------- | ---- | ------------ |
-| foodList | `FoodInfoToOwn[]` | 是   | 食材信息列表 |
-
-**FoodInfoToOwn**
-
-| 属性    | 类型     | 必填 | 说明        |
-| ------- | -------- | ---- | ----------- |
-| menuId  | `number` | 是   | 食谱 ID     |
-| tagId   | `number` | 否   | 食材标签 ID |
-| foodId  | `number` | 是   | 食材 ID     |
-| secUnit | `string` | 否   | 第二单位 ID |
-
-### 返回
-
-**OwnFoodInBasketResponse**
-
-`boolean`，表示持有成功或失败。
-
-### 函数定义示例
-
-```typescript
-/**
- * 将菜篮子中的食材变为已持有
- */
-export function ownFoodInBasket(params: OwnFoodInBasketParams): Promise<OwnFoodInBasketResponse>
-```
-
-## wantFoodInBasket
-
-将菜篮子中的食材变为未持有状态。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { wantFoodInBasket } from '@ray-js/ray'
-```
-
-**参数**
-
-`WantFoodInBasketParams` - 菜篮子食材未持有参数对象。
-
-| 属性     | 类型               | 必填 | 说明         |
-| -------- | ------------------ | ---- | ------------ |
-| foodList | `FoodInfoToWant[]` | 是   | 食材信息列表 |
-
-**FoodInfoToWant**
-
-未持有的食材信息。
-
-| 属性    | 类型     | 必填 | 说明                          |
-| ------- | -------- | ---- | ----------------------------- |
-| menuId  | `number` | 是   | 食谱 ID                       |
-| tagId   | `number` | 否   | 食材标签 ID                   |
-| foodId  | `number` | 是   | 食材 ID                       |
-| secUnit | `string` | 否   | 替换食材第二单位（元数据 ID） |
-
-**返回**
-
-**WantFoodInBasketResponse**
-
-`boolean`，表示将菜篮子中的食材变为未持有结果的成功或失败。
-
-**函数定义示例**
-
-```typescript
-/**
- * 将菜篮子中的食材变为未持有
- * @param params - 菜篮子食材未持有参数
- * @returns 将菜篮子中的食材变为未持有结果的 Promise
- */
-export function wantFoodInBasket(params: WantFoodInBasketParams): Promise<WantFoodInBasketResponse>
-```
-
----
-
-## cleanBasket
-
-清空菜篮子中所有食材。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { cleanBasket } from '@ray-js/ray'
-```
-
-**参数**
-
-无
-
-**返回**
-
-**CleanBasketResponse**
-
-`boolean`，表示清空菜篮子中所有食材结果的成功或失败。
-
-**函数定义示例**
-
-```typescript
-/**
- * 清空菜篮子中所有食材
- * @returns 清空菜篮子中所有食材结果的 Promise
- */
-export function cleanBasket(): Promise<boolean>
-```
-
----
-
-## getNutritionOfBasket
-
-获取菜篮子中未持有状态食材的营养成分。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getNutritionOfBasket } from '@ray-js/ray'
-```
-
-**参数**
-
-无
-
-**返回**
-
-**NutritionInfo**
-
-营养成分信息。
-
-| 属性  | 类型     | 说明          |
-| ----- | -------- | ------------- |
-| code  | `string` | 营养成分 Code |
-| value | `string` | 营养成分值    |
-
-**函数定义示例**
-
-```typescript
-/**
- * 获取菜篮子中未持有状态食材的营养成分
- * @returns 获取菜篮子中未持有状态食材的营养成分结果的 Promise
- */
-export function getNutritionOfBasket(): Promise<NutritionInfo[]>
-```
-
----
-
-## checkMenuExistInBasket
-
-判断食谱中是否有添加过食材至菜篮子。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { checkMenuExistInBasket } from '@ray-js/ray'
-```
-
-**参数**
-
-`CheckMenuExistInBasketParams` - 食谱是否有食材添加至菜篮子参数对象。
-
-| 属性   | 类型     | 必填 | 说明    |
-| ------ | -------- | ---- | ------- |
-| menuId | `number` | 是   | 食谱 ID |
-
-**返回**
-
-**CheckMenuExistInBasketResponse**
-
-`boolean`，表示判断食谱中是否有添加过食材至菜篮子结果。
-
-**函数定义示例**
-
-```typescript
-/**
- * 判断食谱中是否有添加过食材至菜篮子
- * @param params - 食谱是否有食材添加至菜篮子参数
- * @returns 的 Promise
- */
-export function checkMenuExistInBasket(
-  params: CheckMenuExistInBasketParams
-): Promise<CheckMenuExistInBasketResponse>
-```

package/lib/cloud/recipe/category-list.md

@@ -1,132 +0,0 @@
-## getRecipePrimaryCategoryList
-
-获取食谱一级分类列表功能。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getRecipePrimaryCategoryList } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetRecipePrimaryCategoryListParams**
-
-| 属性      | 类型     | 说明    |
-| --------- | -------- | ------- |
-| productId | `string` | 产品 ID |
-
-### 返回
-
-**GetRecipePrimaryCategoryListResponse**
-
-`RecipePrimaryCategory[]`，食谱一级分类信息数组。
-
-**RecipePrimaryCategory**
-
-| 属性        | 类型         | 说明       |
-| ----------- | ------------ | ---------- |
-| gmtCreate   | `number`     | 创建时间戳 |
-| gmtModified | `number`     | 修改时间戳 |
-| id          | `number`     | 分类 ID    |
-| imageUrl    | `string`     | 分类图片   |
-| langInfo    | `LangInfo[]` | 多语言信息 |
-| name        | `string`     | 分类名称   |
-
-**LangInfo**
-
-| 属性 | 类型     | 说明 |
-| ---- | -------- | ---- |
-| lang | `string` | 语言 |
-| name | `string` | 名称 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取食谱一级分类列表
- */
-export const getRecipePrimaryCategoryList: (
-  params: GetRecipePrimaryCategoryListParams
-) => Promise<GetRecipePrimaryCategoryListResponse>
-```
-
-## getRecipeCategoryList
-
-获取食谱分类列表，包括一级分类和二级分类信息。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getRecipeCategoryList } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetRecipeCategoryListParams**
-
-| 属性      | 类型     | 说明    |
-| --------- | -------- | ------- |
-| productId | `string` | 产品 ID |
-
-### 返回
-
-**GetRecipeCategoryListResponse**
-
-`RecipeCategory[]`，食谱分类信息数组。
-
-**RecipeCategory**
-
-| 属性              | 类型                | 说明         |
-| ----------------- | ------------------- | ------------ |
-| id                | `number`            | 分类 ID      |
-| imageUrl          | `string`            | 分类图片     |
-| name              | `string`            | 分类名称     |
-| parentId          | `number`            | 上级分类 ID  |
-| level             | `number`            | 分类层级     |
-| langInfo          | `LangInfo[]`        | 多语言信息   |
-| subMenuCategories | `SubMenuCategory[]` | 二级分类信息 |
-| gmtCreate         | `number`            | 创建时间戳   |
-| gmtModified       | `number`            | 修改时间戳   |
-
-**LangInfo**
-
-| 属性 | 类型     | 说明 |
-| ---- | -------- | ---- |
-| lang | `string` | 语言 |
-| name | `string` | 名称 |
-
-**SubMenuCategory**
-
-| 属性        | 类型         | 说明        |
-| ----------- | ------------ | ----------- |
-| id          | `number`     | 分类 ID     |
-| imageUrl    | `string`     | 分类图片    |
-| name        | `string`     | 分类名称    |
-| parentId    | `number`     | 上级分类 ID |
-| level       | `number`     | 分类层级    |
-| langInfo    | `LangInfo[]` | 多语言信息  |
-| gmtCreate   | `number`     | 创建时间戳  |
-| gmtModified | `number`     | 修改时间戳  |
-
-**LangInfo**
-
-| 属性 | 类型     | 说明 |
-| ---- | -------- | ---- |
-| lang | `string` | 语言 |
-| name | `string` | 名称 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取食谱分类列表
- */
-export const getRecipeCategoryList: (
-  params: GetRecipeCategoryListParams
-) => Promise<GetRecipeCategoryListResponse>
-```