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

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

@@ -0,0 +1,177 @@
+/**
+ * CustomRecipeQuery - 自定义食谱列表查询条件
+ */
+type CustomRecipeQuery = {
+    pageNo?: number;
+    pageSize?: number;
+};
+/**
+ * GetCustomRecipeListParams - 自定义食谱列表请求参数
+ */
+type GetCustomRecipeListParams = {
+    query: CustomRecipeQuery;
+    devId: string;
+};
+/**
+ * CustomRecipeInfo - 食谱信息
+ */
+type CustomRecipeInfo = {
+    id: number;
+    mainImgs: string[];
+    lang: number;
+    langDesc: string;
+    cookType: number;
+    sourceType: number;
+    name: string;
+    gmtCreate: number;
+    gmtModified: number;
+};
+/**
+ * CustomRecipeListResult - 自定义食谱列表返回结果
+ */
+type CustomRecipeListResult = {
+    totalCount: number;
+    pageNo: number;
+    pageSize: number;
+    hasNext: boolean;
+    data: CustomRecipeInfo[];
+};
+/**
+ * GetCustomRecipeListResponse - 自定义食谱列表响应
+ */
+type GetCustomRecipeListResponse = CustomRecipeListResult;
+/**
+ * 获取自定义食谱列表
+ * @param {GetCustomRecipeListParams} params - 自定义食谱列表请求参数
+ * @returns {Promise<GetCustomRecipeListResponse>} - 自定义食谱列表响应的 Promise
+ */
+export declare const getCustomRecipeList: (params: GetCustomRecipeListParams) => Promise<GetCustomRecipeListResponse>;
+/**
+ * 图文步骤参数
+ */
+type StepInfoParam = {
+    step: number;
+    stepImg?: string;
+    desc: string;
+};
+/**
+ * 烹饪步骤信息参数
+ */
+type CookStepParam = {
+    step: number;
+    stepImg?: string;
+    desc?: string;
+    finishCtrl: string;
+    cookArgs: CookArg[];
+};
+/**
+ * 烹饪参数
+ */
+type CookArg = {
+    dpCode: string;
+    dpValue: string;
+};
+/**
+ * 自定义食谱信息
+ */
+type MenuCustomInfo = {
+    mainImages: string[];
+    name: string;
+    desc?: string;
+    productGroupId: string;
+    isPublish?: number;
+    cookType: number;
+    foods?: string;
+    information?: string;
+    xyxk?: string;
+    cookTime?: number;
+    stepInfoParams: StepInfoParam[];
+    cookStepParams: CookStepParam[];
+};
+/**
+ * AddCustomRecipeParams - 自定义食谱添加请求参数
+ */
+type AddCustomRecipeParams = {
+    menuCustom: MenuCustomInfo;
+    devId: string;
+};
+/**
+ * AddCustomRecipeResponse - 自定义食谱添加响应
+ */
+type AddCustomRecipeResponse = boolean;
+/**
+ * 自定义食谱添加
+ * @param {AddCustomRecipeParams} params - 自定义食谱添加请求参数
+ * @returns {Promise<AddCustomRecipeResponse>} - 自定义食谱添加响应的 Promise
+ */
+export declare const addCustomRecipe: (params: AddCustomRecipeParams) => Promise<AddCustomRecipeResponse>;
+/**
+ * 图文步骤参数
+ */
+type UpdateStepInfoParam = {
+    step: number;
+    stepImg?: string;
+    desc: string;
+};
+/**
+ * 烹饪步骤信息参数
+ */
+type UpdateCookStepParam = {
+    step: number;
+    stepImg?: string;
+    desc?: string;
+    finishCtrl: string;
+    cookArgs: CookArg[];
+};
+/**
+ * 自定义食谱信息
+ */
+type UpdateMenuCustomInfo = {
+    id: number;
+    mainImages: string[];
+    name: string;
+    desc?: string;
+    productGroupId: string;
+    isPublish?: number;
+    cookType: number;
+    foods?: string;
+    information?: string;
+    xyxk?: string;
+    cookTime?: number;
+    stepInfoParams: UpdateStepInfoParam[];
+    cookStepParams: UpdateCookStepParam[];
+};
+/**
+ * UpdateCustomRecipeParams - 自定义食谱更新请求参数
+ */
+type UpdateCustomRecipeParams = {
+    menuCustom: UpdateMenuCustomInfo;
+    devId: string;
+};
+/**
+ * UpdateCustomRecipeResponse - 自定义食谱更新响应
+ */
+type UpdateCustomRecipeResponse = boolean;
+/**
+ * 自定义食谱更新
+ * @param {UpdateCustomRecipeParams} params - 自定义食谱更新请求参数
+ * @returns {Promise<UpdateCustomRecipeResponse>} - 自定义食谱更新响应的 Promise
+ */
+export declare const updateCustomRecipe: (params: UpdateCustomRecipeParams) => Promise<UpdateCustomRecipeResponse>;
+/**
+ * DeleteCustomRecipeParams - 自定义食谱删除请求参数
+ */
+type DeleteCustomRecipeParams = {
+    menuId: number;
+};
+/**
+ * DeleteCustomRecipeResponse - 自定义食谱删除响应
+ */
+type DeleteCustomRecipeResponse = boolean;
+/**
+ * 删除自定义食谱
+ * @param {DeleteCustomRecipeParams} params - 自定义食谱删除请求参数
+ * @returns {Promise<DeleteCustomRecipeResponse>} - 自定义食谱删除响应的 Promise
+ */
+export declare const deleteCustomRecipe: (params: DeleteCustomRecipeParams) => Promise<DeleteCustomRecipeResponse>;
+export {};

package/lib/cloud/recipe/custom.js

@@ -0,0 +1,171 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["query"],
+  _excluded2 = ["menuCustom"],
+  _excluded3 = ["menuCustom"];
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// #region 自定义食谱列表
+
+/**
+ * CustomRecipeQuery - 自定义食谱列表查询条件
+ */
+
+/**
+ * GetCustomRecipeListParams - 自定义食谱列表请求参数
+ */
+
+/**
+ * CustomRecipeInfo - 食谱信息
+ */
+
+/**
+ * CustomRecipeListResult - 自定义食谱列表返回结果
+ */
+
+/**
+ * GetCustomRecipeListResponse - 自定义食谱列表响应
+ */
+
+// 返回结果
+
+/**
+ * 获取自定义食谱列表
+ * @param {GetCustomRecipeListParams} params - 自定义食谱列表请求参数
+ * @returns {Promise<GetCustomRecipeListResponse>} - 自定义食谱列表响应的 Promise
+ */
+export const getCustomRecipeList = params => {
+  const {
+      query
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.custom.lang.list"),
+    version: '1.0',
+    data: _objectSpread({
+      queryJson: JSON.stringify(query)
+    }, rest)
+  });
+};
+
+// #endregion
+
+// #region 自定义食谱添加
+
+/**
+ * 图文步骤参数
+ */
+
+/**
+ * 烹饪步骤信息参数
+ */
+
+/**
+ * 烹饪参数
+ */
+
+/**
+ * 自定义食谱信息
+ */
+
+/**
+ * AddCustomRecipeParams - 自定义食谱添加请求参数
+ */
+
+/**
+ * AddCustomRecipeResponse - 自定义食谱添加响应
+ */
+
+// 返回结果
+
+/**
+ * 自定义食谱添加
+ * @param {AddCustomRecipeParams} params - 自定义食谱添加请求参数
+ * @returns {Promise<AddCustomRecipeResponse>} - 自定义食谱添加响应的 Promise
+ */
+export const addCustomRecipe = params => {
+  const {
+      menuCustom
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded2);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.diy.add"),
+    version: '2.0',
+    data: _objectSpread({
+      menuCustomJson: JSON.stringify(menuCustom)
+    }, rest)
+  });
+};
+
+// #endregion
+
+// #region 自定义食谱更新
+/**
+ * 图文步骤参数
+ */
+
+/**
+ * 烹饪步骤信息参数
+ */
+
+/**
+ * 自定义食谱信息
+ */
+
+/**
+ * UpdateCustomRecipeParams - 自定义食谱更新请求参数
+ */
+
+/**
+ * UpdateCustomRecipeResponse - 自定义食谱更新响应
+ */
+
+// 返回结果
+
+/**
+ * 自定义食谱更新
+ * @param {UpdateCustomRecipeParams} params - 自定义食谱更新请求参数
+ * @returns {Promise<UpdateCustomRecipeResponse>} - 自定义食谱更新响应的 Promise
+ */
+export const updateCustomRecipe = params => {
+  const {
+      menuCustom
+    } = params,
+    rest = _objectWithoutProperties(params, _excluded3);
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.diy.update"),
+    version: '2.0',
+    data: _objectSpread({
+      menuCustomJson: JSON.stringify(menuCustom)
+    }, rest)
+  });
+};
+
+// #endregion
+
+// #region 自定义食谱删除
+
+/**
+ * DeleteCustomRecipeParams - 自定义食谱删除请求参数
+ */
+
+/**
+ * DeleteCustomRecipeResponse - 自定义食谱删除响应
+ */
+
+// 返回结果
+
+/**
+ * 删除自定义食谱
+ * @param {DeleteCustomRecipeParams} params - 自定义食谱删除请求参数
+ * @returns {Promise<DeleteCustomRecipeResponse>} - 自定义食谱删除响应的 Promise
+ */
+export const deleteCustomRecipe = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.menu.diy.delete"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// #endregion

package/lib/cloud/recipe/custom.md

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

@@ -0,0 +1,8 @@
+export * from './basket';
+export * from './record';
+export * from './score';
+export * from './star';
+export * from './menu';
+export * from './query';
+export * from './category-list';
+export * from './custom';

package/lib/cloud/recipe/index.js

@@ -0,0 +1,8 @@
+export * from './basket';
+export * from './record';
+export * from './score';
+export * from './star';
+export * from './menu';
+export * from './query';
+export * from './category-list';
+export * from './custom';