zentao-api
Classes
| Class | Description |
|---|---|
| ZentaoClient | 禅道 API 客户端，封装一次次原始 HTTP 调用。 |
| ZentaoError | SDK 统一错误类型。 |
Interfaces
| Interface | Description |
|---|---|
| ApiListResponse | 禅道 API 列表响应结构。 |
| ApiResponse | 禅道 API 通用响应结构，允许携带任意业务字段。 |
| ClientRequestOptions | ZentaoClient.request() 的单次请求选项。 |
| DataRecordFilter | 单条过滤条件，字段名支持 . 访问子字段。 |
| DataRecordFilterGroup | 一组过滤条件，组内按 operator 组合；多组之间按 AND 组合。 |
| DefineModulesOptions | defineModules 的选项。 |
| GlobalOptions | SDK 进程级全局默认选项，供高阶 request 调用复用。 |
| LoginResponse | 登录接口响应结构。 |
| ModuleAction | 禅道模块中的单个 API 动作定义。 |
| ModuleActionPagerGetterMap | 从原始响应中提取分页字段时使用的字段映射。 |
| ModuleActionParam | 模块动作的查询参数定义。 |
| ModuleActionRequestBody | 模块动作请求体定义。 |
| ModuleActionResponse | 模块动作响应定义。 |
| ModuleDefinition | 禅道模块定义，由多个动作组成。 |
| Pager | 禅道 API 原始分页结构。 |
| ProcessListOptions | processData 处理列表时的选项；执行顺序为 过滤 → 搜索 → 排序 → 限制数量 → 摘取。 |
| ProcessSingleOptions | processData 处理单条对象时的选项。 |
| RequestOptions | 高阶 request("moduleName/methodName") 的单次调用选项。 |
| ResolvedModuleCommand | 将模块动作和参数解析后的可执行请求描述。 |
| ResponseData | 高阶 request() 归一化后的返回数据。 |
| ServerConfig | 禅道 ?mode=getconfig 返回的服务端配置。 |
| ZentaoClientOptions | 创建 ZentaoClient 时使用的配置。 |
| ZentaoProfile | 本地持久化的禅道账号 profile。 |
| ZentaoProfileConfig | 保存到本地 profile 中的客户端偏好配置。 |
| ZentaoProfileRecord | 运行时返回的 profile，会额外带上 account@server 形式的 key。 |
| ZentaoProfilesStore | 本地 profile 存储文件或浏览器 localStorage 中的 JSON 结构。 |
Type Aliases
| Type Alias | Description |
|---|---|
| DataRecord | 本地数据处理的基础记录类型，对应一条对象数据。 |
| ErrorCode | SDK 已知错误码，对应 ERRORS 的 key。 |
| HttpMethod | SDK 支持的 HTTP 方法。 |
| ListPagerInfo | 列表分页信息别名。 |
| ModuleActionMethod | 模块动作使用的 HTTP 方法；兼容生成定义中的小写方法。 |
| ModuleActionName | 模块动作名称，允许除基础动作外的自定义名称。 |
| ModuleActionParamOption | 模块动作参数可选项。 |
| ModuleActionResultRender | 模块动作自定义渲染函数类型；SDK 本身不直接渲染终端输出。 |
| ModuleActionResultRenderType | 模块动作渲染目标类型；保留给 CLI 等上层应用使用。 |
| ModuleActionResultType | 模块动作结果形态。 |
| ModuleActionType | 模块动作类型：基础 CRUD 或自定义动作。 |
| ModuleName | 内置模块名称，同时允许用户扩展自定义模块名。 |
| SortExpr | 排序表达式，格式为 `字段:asc |
| SortFn | 自定义排序比较函数。 |
Variables
| Variable | Description |
|---|---|
| BUILD | 构建标识，由构建脚本通过 __ZENTAO_API_BUILD__ 注入。 |
| ERRORS | SDK 已知错误码到默认消息的映射表。 |
| VERSION | SDK 版本号，由构建脚本通过 __ZENTAO_API_VERSION__ 注入。 |
| ZENTAO_PROFILES_STORAGE_KEY | 浏览器环境下用于在 localStorage 中保存 profile 数据的 key。 |
Functions
| Function | Description |
|---|---|
| addProfile | 添加或覆盖一个本地 profile，并把它设置为当前使用的 profile。 |
| defineModuleActions | 为已存在的模块追加或覆盖动作。 |
| defineModules | 注册或扩展模块定义。 |
| deleteProfile | 删除指定 profile。 |
| filterData | 按条件组过滤列表，多组之间按 AND 组合。 |
| getAllProfiles | 列出本地保存的所有 profile。 |
| getGlobalOptions | 获取当前全局选项的快照。 |
| getModule | 获取模块定义。 |
| getModuleAction | 获取指定模块下的某个动作。 |
| getModuleNames | 返回当前运行时注册表中的所有模块名。 |
| getProfile | 获取指定 profile。 |
| getProfileKey | 根据 profile 的账号和禅道站点地址生成稳定 key。 |
| pickFields | 对列表中的每条对象摘取指定字段。 |
| pickFieldsSingle | 从单条对象中摘取指定字段，支持通过 . 访问子字段，保留嵌套结构。 |
| processData | 处理单条对象：仅支持字段摘取。 |
| request | 按模块动作名请求禅道 API。 |
| searchData | 对列表做大小写不敏感的模糊匹配。 |
| setGlobalOptions | 以浅合并的方式更新全局选项。 |
| sortData | 对列表排序，返回新数组（不修改入参）。 |
| switchProfile | 切换当前使用的 profile，并刷新其 lastUsedTime。 |