npm - @ray-js/api - Versions diffs - 1.5.4 → 1.6.0-beta.1 - Mend

@ray-js/api 1.5.4 → 1.6.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/lib/cloud/recipe/custom.d.ts +9 -0
package/lib/cloud/recipe/menu.d.ts +26 -0
package/lib/cloud/recipe/menu.js +29 -1
package/package.json +5 -5
package/lib/cloud/recipe/basket.md +0 -431
package/lib/cloud/recipe/category-list.md +0 -132
package/lib/cloud/recipe/custom.md +0 -265
package/lib/cloud/recipe/menu.md +0 -276
package/lib/cloud/recipe/query.md +0 -112
package/lib/cloud/recipe/record.md +0 -115
package/lib/cloud/recipe/score.md +0 -112
package/lib/cloud/recipe/star.md +0 -196

package/lib/cloud/recipe/custom.md DELETED Viewed

@@ -1,265 +0,0 @@
-## getCustomRecipeList
-获取自定义食谱列表功能。
-### 引入
-> @ray-js/ray^1.5.0 以上版本可使用
-```js
-import { getCustomRecipeList } from '@ray-js/ray'
-```
-### 参数
-**GetCustomRecipeListParams**
-| 属性  | 类型                | 说明     |
-| ----- | ------------------- | -------- |
-| query | `CustomRecipeQuery` | 查询条件 |
-| devId | `string`            | 设备 ID  |
-**CustomRecipeQuery**
-| 属性     | 类型     | 说明                |
-| -------- | -------- | ------------------- |
-| pageNo   | `number` | 分页页号，默认为 0  |
-| pageSize | `number` | 分页大小，默认为 10 |
-### 返回
-**GetCustomRecipeListResponse**
-`CustomRecipeListResult`，自定义食谱列表返回结果。
-**CustomRecipeListResult**
-| 属性       | 类型                 | 说明           |
-| ---------- | -------------------- | -------------- |
-| totalCount | `number`             | 总记录条数     |
-| pageNo     | `number`             | 分页页号       |
-| pageSize   | `number`             | 分页大小       |
-| hasNext    | `boolean`            | 是否还有下一页 |
-| data       | `CustomRecipeInfo[]` | 食谱信息数组   |
-**CustomRecipeInfo**
-| 属性        | 类型       | 说明       |
-| ----------- | ---------- | ---------- |
-| id          | `number`   | 食谱 ID    |
-| mainImgs    | `string[]` | 主图数组   |
-| lang        | `number`   | 语言       |
-| langDesc    | `string`   | 语言信息   |
-| cookType    | `number`   | 烹饪类型   |
-| sourceType  | `number`   | 食谱类型   |
-| name        | `string`   | 食谱名称   |
-| gmtCreate   | `number`   | 创建时间戳 |
-| gmtModified | `number`   | 修改时间戳 |
-### 函数定义示例
-```typescript
-/**
- * 获取自定义食谱列表
- */
-export const getCustomRecipeList: (
-  params: GetCustomRecipeListParams
-) => Promise<GetCustomRecipeListResponse>
-```
-## addCustomRecipe
-自定义食谱添加功能。
-### 引入
-> @ray-js/ray^1.5.0 以上版本可使用
-```js
-import { addCustomRecipe } from '@ray-js/ray'
-```
-### 参数
-**AddCustomRecipeParams**
-| 属性       | 类型             | 说明     |
-| ---------- | ---------------- | -------- |
-| menuCustom | `MenuCustomInfo` | 食谱信息 |
-| devId      | `string`         | 设备 ID  |
-**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
-| 字段    | 类型   | 可选性 | 描述         |
-| ------- | ------ | ------ | ------------ |
-| stepImg | string | 可选   | 步骤图片路径 |
-| desc    | string | 必须   | 步骤描述     |
-### CookStepParam 表格
-| 字段       | 类型      | 可选性 | 描述         |
-| ---------- | --------- | ------ | ------------ |
-| step       | number    | 必须   | 步骤序号     |
-| stepImg    | string    | 可选   | 步骤详图     |
-| desc       | string    | 可选   | 步骤描述信息 |
-| finishCtrl | string    | 必须   | 完成执行选项 |
-| cookArgs   | CookArg[] | 必须   | 烹饪参数数组 |
-### CookArg 表格
-| 字段    | 类型   | 可选性 | 描述    |
-| ------- | ------ | ------ | ------- |
-| dpCode  | string | 必须   | DP Code |
-| dpValue | string | 必须   | DP 值   |
-### 返回
-**AddCustomRecipeResponse**
-`boolean`，添加成功与否的返回结果。
-### 函数定义示例
-```typescript
-/**
- * 自定义食谱添加
- */
-export const addCustomRecipe: (params: AddCustomRecipeParams) => Promise<AddCustomRecipeResponse>
-```
-## updateCustomRecipe
-自定义食谱更新功能。
-### 引入
-> @ray-js/ray^1.5.0 以上版本可使用
-```js
-import { updateCustomRecipe } from '@ray-js/ray'
-```
-### 参数
-**UpdateCustomRecipeParams**
-| 属性       | 类型                   | 说明     |
-| ---------- | ---------------------- | -------- |
-| menuCustom | `UpdateMenuCustomInfo` | 食谱信息 |
-| devId      | `string`               | 设备 ID  |
-**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
-| 字段    | 类型   | 可选性 | 描述         |
-| ------- | ------ | ------ | ------------ |
-| step    | number | 必须   | 步骤         |
-| stepImg | string | 可选   | 步骤图片路径 |
-| desc    | string | 必须   | 步骤描述     |
-### UpdateCookStepParam 表格
-| 字段       | 类型      | 可选性 | 描述         |
-| ---------- | --------- | ------ | ------------ |
-| step       | number    | 必须   | 步骤序号     |
-| stepImg    | string    | 可选   | 步骤详图     |
-| desc       | string    | 可选   | 步骤描述信息 |
-| finishCtrl | string    | 必须   | 完成执行选项 |
-| cookArgs   | CookArg[] | 必须   | 烹饪参数数组 |
-### CookArg 表格
-| 字段    | 类型   | 可选性 | 描述    |
-| ------- | ------ | ------ | ------- |
-| dpCode  | string | 必须   | DP Code |
-| dpValue | string | 必须   | DP 值   |
-### 返回
-**UpdateCustomRecipeResponse**
-`boolean`，更新成功与否的返回结果。
-### 函数定义示例
-```typescript
-/**
- * 自定义食谱更新
- */
-export const updateCustomRecipe: (
-  params: UpdateCustomRecipeParams
-) => Promise<UpdateCustomRecipeResponse>
-```
-## deleteCustomRecipe
-自定义食谱删除功能。
-### 引入
-> @ray-js/ray^1.5.0 以上版本可使用
-```js
-import { deleteCustomRecipe } from '@ray-js/ray'
-```
-### 参数
-**DeleteCustomRecipeParams**
-| 属性   | 类型     | 说明    |
-| ------ | -------- | ------- |
-| menuId | `number` | 食谱 ID |
-### 返回
-**DeleteCustomRecipeResponse**
-`boolean`，删除成功与否的返回结果。
-### 函数定义示例
-```typescript
-/**
- * 删除自定义食谱
- */
-export const deleteCustomRecipe: (
-  params: DeleteCustomRecipeParams
-) => Promise<DeleteCustomRecipeResponse>
-```

package/lib/cloud/recipe/menu.md DELETED Viewed

@@ -1,276 +0,0 @@
-## 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.md DELETED Viewed

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