zentao-api 0.6.0 → 0.6.2

package/dist/index.d.ts

@@ -6,4 +6,4 @@ export { defineModuleActions, defineModules, type DefineModulesOptions, type Exp
 export { request, type BuiltinRequestName, type RequestParamsFor, type RequestResultFor, } from './request/index.js';
 export { pickFields, pickFieldsSingle, filterData, searchData, sortData, processData, } from './utils/index.js';
 export { BUILD, VERSION } from './version.js';
-export type { ApiListResponse, ApiResponse, ClientRequestBodyType, ClientRequestOptions, ClientResponseType, DataRecord, DataRecordFilter, DataRecordFilterGroup, GlobalOptions, HttpMethod, ListPagerInfo, LoginResponse, ModuleAction, ModuleActionMethod, ModuleActionName, ModuleActionPagerGetterMap, ModuleActionParam, ModuleActionParamOption, ModuleActionRequest, ModuleActionRequestBody, ModuleActionResponse, ModuleActionResultType, ModuleActionType, ModuleDefinition, ModuleName, Pager, ProcessListOptions, ProcessSingleOptions, RequestOptions, ResponseData, ServerConfig, SortExpr, SortFn, ZentaoProfile, ZentaoProfileConfig, ZentaoProfileRecord, ZentaoProfilesStore, ZentaoClientOptions, } from './types/index.js';
+export type { ApiListResponse, ApiResponse, ClientRequestBodyType, ClientRequestOptions, ClientResponseType, DataRecord, DataRecordFilter, DataRecordFilterGroup, FileCreateParams, FileCreateResult, FileUploadDataInput, FileUploadPathInput, FileUploadSource, GlobalOptions, HttpMethod, ListPagerInfo, LoginResponse, ModuleAction, ModuleActionMethod, ModuleActionName, ModuleActionPagerGetterMap, ModuleActionParam, ModuleActionParamOption, ModuleActionRequest, ModuleActionRequestBody, ModuleActionRequestMediaType, ModuleActionResponse, ModuleActionResultType, ModuleActionType, ModuleDefinition, ModuleName, Pager, ProcessListOptions, ProcessSingleOptions, RequestOptions, ResponseData, ServerConfig, SortExpr, SortFn, ZentaoProfile, ZentaoProfileConfig, ZentaoProfileRecord, ZentaoProfilesStore, ZentaoClientOptions, } from './types/index.js';

package/dist/misc/errors.d.ts

@@ -27,6 +27,11 @@ export declare const ERRORS: {
     readonly E_INVALID_PARAM: "Invalid value for parameter {param}: {value}";
     readonly E_INVALID_REQUEST_NAME: "Request name must use the form \"moduleName\", \"moduleName/methodName\", or \"moduleName/<objectID>\".";
     readonly E_API_FAILED: "ZenTao API returned failure: {message}";
+    readonly E_UPLOAD_PATH_UNSUPPORTED: "Local file paths are not supported in browser runtimes. Pass a File or Blob instead.";
+    readonly E_UPLOAD_FILE_NOT_FOUND: "Upload file not found: {path}";
+    readonly E_UPLOAD_FILE_READ_FAILED: "Failed to read upload file: {path}";
+    readonly E_UPLOAD_FILE_TOO_LARGE: "Upload file is {size} bytes and exceeds the {limit} byte limit.";
+    readonly E_INVALID_UPLOAD_SOURCE: "Invalid upload source for field: {field}";
 };
 /** SDK 已知错误码，对应 {@link ERRORS} 的 key。 */
 export type ErrorCode = keyof typeof ERRORS;

package/dist/misc/errors.js

@@ -27,6 +27,11 @@ export const ERRORS = {
     E_INVALID_PARAM: 'Invalid value for parameter {param}: {value}',
     E_INVALID_REQUEST_NAME: 'Request name must use the form "moduleName", "moduleName/methodName", or "moduleName/<objectID>".',
     E_API_FAILED: 'ZenTao API returned failure: {message}',
+    E_UPLOAD_PATH_UNSUPPORTED: 'Local file paths are not supported in browser runtimes. Pass a File or Blob instead.',
+    E_UPLOAD_FILE_NOT_FOUND: 'Upload file not found: {path}',
+    E_UPLOAD_FILE_READ_FAILED: 'Failed to read upload file: {path}',
+    E_UPLOAD_FILE_TOO_LARGE: 'Upload file is {size} bytes and exceeds the {limit} byte limit.',
+    E_INVALID_UPLOAD_SOURCE: 'Invalid upload source for field: {field}',
 };
 /**
  * SDK 统一错误类型。

package/dist/modules/export.d.ts

@@ -1,7 +1,9 @@
-import type { ModuleAction, ModuleActionParam, ModuleDefinition } from '../types/index.js';
+import type { ModuleAction, ModuleActionParam, ModuleActionRequestMediaType, ModuleDefinition } from '../types/index.js';
 /** 导出的模块动作定义。 */
 export type ExportedModuleAction = Omit<ModuleAction, 'requestBody'> & {
     bodyParams: ModuleActionParam[];
+    /** 请求体媒体类型；省略时为 `application/json`。 */
+    bodyMediaType?: ModuleActionRequestMediaType;
 };
 /** 导出的模块定义。 */
 export type ExportedModuleDefinition = Omit<ModuleDefinition, 'actions'> & {

package/dist/modules/export.js

@@ -30,6 +30,7 @@ export function exportRegistry(options = {}) {
                     const { requestBody, ...exportedAction } = action;
                     return {
                         ...exportedAction,
+                        ...(requestBody?.mediaType ? { bodyMediaType: requestBody.mediaType } : {}),
                         bodyParams: requestBody
                             ? getModuleActionParams(module.name, action.name, { roles: ['body'] })
                             : [],

package/dist/modules/generated.d.ts

@@ -3406,6 +3406,9 @@ export declare const BUILTIN_MODULES: ({
                     name?: undefined;
                     parent?: undefined;
                     comment?: undefined;
+                    deadline?: undefined;
+                    status?: undefined;
+                    mailto?: undefined;
                     resolution?: undefined;
                     resolvedDate?: undefined;
                     resolvedBuild?: undefined;
@@ -3507,6 +3510,9 @@ export declare const BUILTIN_MODULES: ({
                     name?: undefined;
                     parent?: undefined;
                     comment?: undefined;
+                    deadline?: undefined;
+                    status?: undefined;
+                    mailto?: undefined;
                     resolution?: undefined;
                     resolvedDate?: undefined;
                     resolvedBuild?: undefined;
@@ -3558,6 +3564,9 @@ export declare const BUILTIN_MODULES: ({
                     story?: undefined;
                     assignedTo?: undefined;
                     comment?: undefined;
+                    deadline?: undefined;
+                    status?: undefined;
+                    mailto?: undefined;
                     resolution?: undefined;
                     resolvedDate?: undefined;
                     resolvedBuild?: undefined;
@@ -3650,6 +3659,9 @@ export declare const BUILTIN_MODULES: ({
                     story?: undefined;
                     name?: undefined;
                     parent?: undefined;
+                    deadline?: undefined;
+                    status?: undefined;
+                    mailto?: undefined;
                     resolution?: undefined;
                     resolvedDate?: undefined;
                     resolvedBuild?: undefined;
@@ -3697,6 +3709,81 @@ export declare const BUILTIN_MODULES: ({
                     assignedTo?: undefined;
                     name?: undefined;
                     parent?: undefined;
+                    deadline?: undefined;
+                    status?: undefined;
+                    mailto?: undefined;
+                    resolution?: undefined;
+                    resolvedDate?: undefined;
+                    resolvedBuild?: undefined;
+                };
+                required?: undefined;
+            };
+        };
+        pagerGetter?: undefined;
+        resultGetter?: undefined;
+        params?: undefined;
+    } | {
+        name: "confirm";
+        display: string;
+        type: "action";
+        method: "put";
+        path: string;
+        resultType: "text";
+        pathParams: {
+            bugID: string;
+            scope?: undefined;
+            scopeID?: undefined;
+            productID?: undefined;
+            moduleID?: undefined;
+        };
+        requestBody: {
+            required: true;
+            type: "object";
+            schema: {
+                type: string;
+                properties: {
+                    assignedTo: {
+                        type: string;
+                        description: string;
+                    };
+                    type: {
+                        type: string;
+                        description: string;
+                    };
+                    pri: {
+                        type: string;
+                        description: string;
+                        format: string;
+                    };
+                    deadline: {
+                        type: string;
+                        description: string;
+                    };
+                    status: {
+                        type: string;
+                        description: string;
+                    };
+                    mailto: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        description: string;
+                    };
+                    comment: {
+                        type: string;
+                        description: string;
+                    };
+                    productID?: undefined;
+                    title?: undefined;
+                    openedBuild?: undefined;
+                    project?: undefined;
+                    execution?: undefined;
+                    severity?: undefined;
+                    steps?: undefined;
+                    story?: undefined;
+                    name?: undefined;
+                    parent?: undefined;
                     resolution?: undefined;
                     resolvedDate?: undefined;
                     resolvedBuild?: undefined;
@@ -3759,6 +3846,9 @@ export declare const BUILTIN_MODULES: ({
                     story?: undefined;
                     name?: undefined;
                     parent?: undefined;
+                    deadline?: undefined;
+                    status?: undefined;
+                    mailto?: undefined;
                 };
                 required: string[];
             };
@@ -7400,6 +7490,7 @@ export declare const BUILTIN_MODULES: ({
         path: string;
         resultType: "list";
         pagerGetter: string;
+        resultGetter: string;
         pathParams: {
             spaceID: string;
             libID: string;
@@ -7408,7 +7499,6 @@ export declare const BUILTIN_MODULES: ({
             docID?: undefined;
             moduleID?: undefined;
         };
-        resultGetter: string;
         requestBody?: undefined;
     } | {
         name: "productDocs";
@@ -8455,6 +8545,11 @@ export declare const BUILTIN_MODULES: ({
                         type: string;
                         description: string;
                     };
+                    objectID: {
+                        type: string;
+                        description: string;
+                        format: string;
+                    };
                     begin: {
                         type: string;
                         description: string;
@@ -8504,6 +8599,11 @@ export declare const BUILTIN_MODULES: ({
                         type: string;
                         description: string;
                     };
+                    objectID: {
+                        type: string;
+                        description: string;
+                        format: string;
+                    };
                     begin: {
                         type: string;
                         description: string;
@@ -9008,6 +9108,7 @@ export declare const BUILTIN_MODULES: ({
         path: string;
         resultType: "list";
         pagerGetter: string;
+        resultGetter: string;
         params: ({
             name: string;
             required: false;
@@ -9036,7 +9137,6 @@ export declare const BUILTIN_MODULES: ({
             defaultValue?: undefined;
             options?: undefined;
         })[];
-        resultGetter: string;
     } | {
         name: "issues";
         display: string;
@@ -9381,6 +9481,9 @@ export type BuiltinActionMeta = {
         close: {
             resultType: 'text';
         };
+        confirm: {
+            resultType: 'text';
+        };
         resolve: {
             resultType: 'text';
         };

package/dist/modules/generated.js

@@ -2857,7 +2857,7 @@ export const BUILTIN_MODULES = [
     {
         name: 'bug',
         display: 'Bug',
-        description: 'Bug管理，支持获取Bug列表，支持获取项目/产品/执行下的Bug、产品的Bug模块树、创建Bug、获取Bug详情、修改Bug、修改Bug模块、删除Bug、删除Bug模块、激活Bug、关闭Bug、解决Bug',
+        description: 'Bug管理，支持获取Bug列表，支持获取项目/产品/执行下的Bug、产品的Bug模块树、创建Bug、获取Bug详情、修改Bug、修改Bug模块、删除Bug、删除Bug模块、激活Bug、关闭Bug、确认Bug、解决Bug',
         actions: [
             {
                 name: 'list',
@@ -3196,6 +3196,57 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
+            }, {
+                name: 'confirm',
+                display: '确认Bug',
+                type: 'action',
+                method: 'put',
+                path: '/bugs/{bugID}/confirm',
+                resultType: 'text',
+                pathParams: {
+                    bugID: 'Bug ID',
+                },
+                requestBody: {
+                    required: true,
+                    type: 'object',
+                    schema: {
+                        "type": "object",
+                        "properties": {
+                            "assignedTo": {
+                                "type": "string",
+                                "description": "指派给"
+                            },
+                            "type": {
+                                "type": "string",
+                                "description": "Bug类型(codeerror 代码错误 | config 配置相关 | install 安装部署 | security 安全相关 | performance 性能问题 | standard 标准规范 | automation 测试脚本 | designdefect 设计缺陷 | others 其他)"
+                            },
+                            "pri": {
+                                "type": "integer",
+                                "description": "优先级，默认是3",
+                                "format": "int32"
+                            },
+                            "deadline": {
+                                "type": "string",
+                                "description": "截止日期"
+                            },
+                            "status": {
+                                "type": "string",
+                                "description": "状态"
+                            },
+                            "mailto": {
+                                "type": "array",
+                                "items": {
+                                    "type": "string"
+                                },
+                                "description": "抄送给"
+                            },
+                            "comment": {
+                                "type": "string",
+                                "description": "备注"
+                            }
+                        }
+                    },
+                },
             }, {
                 name: 'resolve',
                 display: '解决Bug',
@@ -3885,7 +3936,7 @@ export const BUILTIN_MODULES = [
                             },
                             "assignedTo": {
                                 "type": "string",
-                                "description": "任务名称"
+                                "description": "指派给"
                             },
                             "consumed": {
                                 "type": "number",
@@ -3894,11 +3945,11 @@ export const BUILTIN_MODULES = [
                             },
                             "realStarted": {
                                 "type": "string",
-                                "description": "实际开始"
+                                "description": "实际开始，精确到秒"
                             },
                             "finishedDate": {
                                 "type": "string",
-                                "description": "实际完成"
+                                "description": "实际完成，精确到秒"
                             },
                             "comment": {
                                 "type": "string",
@@ -3934,7 +3985,7 @@ export const BUILTIN_MODULES = [
                             },
                             "realStarted": {
                                 "type": "string",
-                                "description": "实际开始"
+                                "description": "实际开始，精确到秒"
                             },
                             "consumed": {
                                 "type": "number",
@@ -6565,11 +6616,11 @@ export const BUILTIN_MODULES = [
                 path: '/doc/team/spaces/{spaceID}/libs/{libID}/docs',
                 resultType: 'list',
                 pagerGetter: 'pager',
+                resultGetter: 'docs',
                 pathParams: {
                     spaceID: '空间ID',
                     libID: '文档库ID',
                 },
-                resultGetter: 'docs',
             }, {
                 name: 'productDocs',
                 display: '获取产品文档列表',
@@ -6880,7 +6931,7 @@ export const BUILTIN_MODULES = [
                             },
                             "content": {
                                 "type": "string",
-                                "description": "文档内容，支持HTML标签"
+                                "description": "文档正文，使用HTML格式；纯文本可直接传递"
                             }
                         },
                         "required": [
@@ -6917,7 +6968,7 @@ export const BUILTIN_MODULES = [
                             },
                             "content": {
                                 "type": "string",
-                                "description": "文档内容，支持HTML标签"
+                                "description": "文档正文，使用HTML格式；纯文本可直接传递"
                             }
                         },
                         "required": [
@@ -6954,7 +7005,7 @@ export const BUILTIN_MODULES = [
                             },
                             "content": {
                                 "type": "string",
-                                "description": "文档内容，支持HTML标签"
+                                "description": "文档正文，使用HTML格式；纯文本可直接传递"
                             }
                         },
                         "required": [
@@ -6991,7 +7042,7 @@ export const BUILTIN_MODULES = [
                             },
                             "content": {
                                 "type": "string",
-                                "description": "文档内容，支持HTML标签"
+                                "description": "文档正文，使用HTML格式；纯文本可直接传递"
                             }
                         },
                         "required": [
@@ -7023,7 +7074,7 @@ export const BUILTIN_MODULES = [
                             },
                             "parentID": {
                                 "type": "integer",
-                                "description": "父目录",
+                                "description": "父目录ID，必须属于当前文档库",
                                 "format": "int32"
                             }
                         },
@@ -7055,7 +7106,7 @@ export const BUILTIN_MODULES = [
                             },
                             "parentID": {
                                 "type": "integer",
-                                "description": "父目录",
+                                "description": "父目录ID，必须属于当前文档库",
                                 "format": "int32"
                             }
                         },
@@ -7087,7 +7138,7 @@ export const BUILTIN_MODULES = [
                             },
                             "parentID": {
                                 "type": "integer",
-                                "description": "父目录",
+                                "description": "父目录ID，必须属于当前文档库",
                                 "format": "int32"
                             }
                         },
@@ -7119,7 +7170,7 @@ export const BUILTIN_MODULES = [
                             },
                             "parentID": {
                                 "type": "integer",
-                                "description": "父目录",
+                                "description": "父目录ID，必须属于当前文档库",
                                 "format": "int32"
                             }
                         },
@@ -7258,7 +7309,7 @@ export const BUILTIN_MODULES = [
                             },
                             "content": {
                                 "type": "string",
-                                "description": "文档内容，支持HTML标签"
+                                "description": "文档正文，使用HTML格式；纯文本可直接传递。接口不接受块编辑器的JSON快照，修改块编辑器文档后会保存为HTML格式"
                             }
                         },
                         "required": [
@@ -7365,7 +7416,12 @@ export const BUILTIN_MODULES = [
                             },
                             "name": {
                                 "type": "string",
-                                "description": "待办名称"
+                                "description": "待办名称，type为custom时必填；type为非custom时由关联对象的名称或标题自动生成"
+                            },
+                            "objectID": {
+                                "type": "integer",
+                                "description": "关联对象ID，type为非custom时必填，必须是type对应对象的ID",
+                                "format": "int32"
                             },
                             "begin": {
                                 "type": "string",
@@ -7386,8 +7442,7 @@ export const BUILTIN_MODULES = [
                         },
                         "required": [
                             "date",
-                            "type",
-                            "name"
+                            "type"
                         ]
                     },
                 },
@@ -7417,7 +7472,12 @@ export const BUILTIN_MODULES = [
                             },
                             "name": {
                                 "type": "string",
-                                "description": "待办名称"
+                                "description": "待办名称，type为custom时必填；type为非custom时由关联对象的名称或标题自动生成"
+                            },
+                            "objectID": {
+                                "type": "integer",
+                                "description": "关联对象ID，type为非custom时必填，必须是type对应对象的ID",
+                                "format": "int32"
                             },
                             "begin": {
                                 "type": "string",
@@ -7438,8 +7498,7 @@ export const BUILTIN_MODULES = [
                         },
                         "required": [
                             "date",
-                            "type",
-                            "name"
+                            "type"
                         ]
                     },
                 },
@@ -8153,17 +8212,19 @@ export const BUILTIN_MODULES = [
                 path: '/my/meetings',
                 resultType: 'list',
                 pagerGetter: 'pager',
+                resultGetter: 'meetings',
                 params: [
                     {
                         name: 'browseType',
                         required: false,
                         type: 'string',
-                        description: '状态，默认是all',
-                        defaultValue: 'all',
+                        description: '状态，默认是futureMeeting',
+                        defaultValue: 'futureMeeting',
                         options: [
+                            { value: 'futureMeeting', label: '我参加的（未开始）' },
                             { value: 'all', label: '全部' },
                             { value: 'booked', label: '我预约的' },
-                            { value: 'participate', label: '我参加的' },
+                            { value: 'participate', label: '我参加的（全部）' },
                         ],
                     },
                     {
@@ -8193,7 +8254,6 @@ export const BUILTIN_MODULES = [
                         description: '页码，从第1页开始',
                     },
                 ],
-                resultGetter: 'meetings',
             }, {
                 name: 'issues',
                 display: '指派给我的问题',

package/dist/modules/override.js

@@ -166,6 +166,16 @@ export function applyBuiltinOverrides() {
             return action;
         });
     });
+    // OpenAPI 使用 JSON 描述 SDK 的本地文件路径入参，但实际请求仍需转换为 multipart/form-data
+    extendModuleAction('file', 'create', (action) => {
+        if (action.requestBody) {
+            action.requestBody.mediaType = 'multipart/form-data';
+            const properties = action.requestBody.schema?.properties;
+            if (properties?.file)
+                properties.file.format = 'binary';
+        }
+        return action;
+    });
     // 修改 BUG 列表选项
     extendModuleAction('bug', 'list', (action) => {
         const params = action.params;