海牛工作流SDK

海牛SDK包括两个版本，工程化版本和js版本。工程化版本可通过pnpm run build 生成manatee-workflow-sdk.js文件，引入海牛工作台即可。

js版本存放在sdk-js目录中，可直接修改manatee-workflow-sdk.js文件，然后引入海牛工作台。

SDK 功能

配置

| 名称 | 默认 | 描述 | | ---- | ---- | ---- | | enable | false | 是否启用SDK功能，true: 启动; false: 不启动SDK功能，默认使用海牛工作台的用户接口 |

方法列表

| 方法名 | 参数 | 输出 | | ---- | ---- | ---- | | getUserList | (pagination: Pagination, filter?: UserItem) => {} | Promise<{ data: UserItem[], total: number}> | | getRoleList | (pagination: Pagination) => {} | Promise<{ data: RoleItem[], total: number}> | | getUserNameByIds | (ids: string[]) => {} | Promise<string[]> | | getRoleNameByIds | (ids: string[]) => {} | Promise<string[]> |

类型定义

| 类型 | 参数 | | ---- | ---- | | Pagination | { page = 1, size = 10 } | | UserItem | { id: string | number, name: string} | | RoleItem | { id: string | number, name: string} |

目录介绍

• src: SDK工程化版本相关代码, 可通过pnpm run build编译
• playground: 测试工程。可通过pnpm run dev启动
• sdk-js: js版本的SDK，可直接修改js，然后把文件引入海牛工作台

工程化版本介绍

工程化版本最好使用pnpm管理工具, 因为使用了pnpm workspace功能，将playground和工程代码放在了相同仓库中

开始

1. 安装依赖
pnpm i

2. 测试SDK
pnpm run dev

3. 打包SDK，输出(dist/manatee-workflow-sdk.js)
pnpm run build