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

package/lib/cloud/recipe/basket.md

@@ -0,0 +1,431 @@
+## 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.d.ts

@@ -0,0 +1,71 @@
+/**
+ * GetRecipePrimaryCategoryListParams - 获取食谱一级分类列表参数
+ */
+type GetRecipePrimaryCategoryListParams = {
+    productId: string;
+};
+/**
+ * GetRecipePrimaryCategoryListResponse - 获取食谱一级分类列表响应
+ */
+type GetRecipePrimaryCategoryListResponse = RecipePrimaryCategory[];
+/**
+ * 食谱分类
+ */
+type RecipePrimaryCategory = {
+    gmtCreate: number;
+    gmtModified: number;
+    id: number;
+    imageUrl: string;
+    langInfo: LangInfo[];
+    name: string;
+};
+/**
+ * 获取食谱一级分类列表
+ * @param {GetRecipePrimaryCategoryListParams} params - 获取食谱一级分类列表参数
+ * @returns {Promise<GetRecipePrimaryCategoryListResponse>} - 获取食谱一级分类列表响应的 Promise
+ */
+export declare const getRecipePrimaryCategoryList: (params: GetRecipePrimaryCategoryListParams) => Promise<GetRecipePrimaryCategoryListResponse>;
+/**
+ * GetRecipeCategoryListParams - 获取食谱分类列表参数
+ */
+type GetRecipeCategoryListParams = {
+    productId: string;
+};
+/**
+ * GetRecipeCategoryListResponse - 获取食谱分类列表响应
+ */
+type GetRecipeCategoryListResponse = RecipeCategory[];
+/**
+ * 食谱分类
+ */
+type RecipeCategory = {
+    id: number;
+    imageUrl: string;
+    name: string;
+    parentId: number;
+    level: number;
+    langInfo: LangInfo[];
+    subMenuCategories: SubMenuCategory[];
+    gmtCreate: number;
+    gmtModified: number;
+};
+/**
+ * 二级分类信息
+ */
+type SubMenuCategory = {
+    id: number;
+    imageUrl: string;
+    name: string;
+    parentId: number;
+    level: number;
+    langInfo: LangInfo[];
+    gmtCreate: number;
+    gmtModified: number;
+};
+/**
+ * 获取食谱分类列表
+ * @param {GetRecipeCategoryListParams} params - 获取食谱分类列表参数
+ * @returns {Promise<GetRecipeCategoryListResponse>} - 获取食谱分类列表响应的 Promise
+ */
+export declare const getRecipeCategoryList: (params: GetRecipeCategoryListParams) => Promise<GetRecipeCategoryListResponse>;
+export {};

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

@@ -0,0 +1,65 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// #region 获取食谱一级分类列表
+
+/**
+ * GetRecipePrimaryCategoryListParams - 获取食谱一级分类列表参数
+ */
+
+/**
+ * GetRecipePrimaryCategoryListResponse - 获取食谱一级分类列表响应
+ */
+// 分类信息
+
+/**
+ * 食谱分类
+ */
+
+/**
+ * 获取食谱一级分类列表
+ * @param {GetRecipePrimaryCategoryListParams} params - 获取食谱一级分类列表参数
+ * @returns {Promise<GetRecipePrimaryCategoryListResponse>} - 获取食谱一级分类列表响应的 Promise
+ */
+export const getRecipePrimaryCategoryList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.category.list"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+// #region 获取食谱分类列表
+
+/**
+ * GetRecipeCategoryListParams - 获取食谱分类列表参数
+ */
+
+/**
+ * GetRecipeCategoryListResponse - 获取食谱分类列表响应
+ */
+// 分类信息
+
+/**
+ * 食谱分类
+ */
+
+/**
+ * 二级分类信息
+ */
+
+/**
+ * 获取食谱分类列表
+ * @param {GetRecipeCategoryListParams} params - 获取食谱分类列表参数
+ * @returns {Promise<GetRecipeCategoryListResponse>} - 获取食谱分类列表响应的 Promise
+ */
+export const getRecipeCategoryList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.category.list"),
+    version: '2.0',
+    data: params
+  });
+};
+
+//#endregion

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

@@ -0,0 +1,132 @@
+## 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>
+```