zentao-api 0.6.8 → 0.7.0

package/dist/modules/generated.d.ts

@@ -507,9 +507,6 @@ export declare const BUILTIN_MODULES: ({
                     };
                     desc: {
                         type: string;
-                        items: {
-                            type: string;
-                        };
                         description: string;
                     };
                     QD: {
@@ -824,9 +821,6 @@ export declare const BUILTIN_MODULES: ({
                     };
                     desc: {
                         type: string;
-                        items: {
-                            type: string;
-                        };
                         description: string;
                     };
                     QD: {

package/dist/modules/generated.js

@@ -582,10 +582,7 @@ export const BUILTIN_MODULES = [
                                 "description": "评审人"
                             },
                             "desc": {
-                                "type": "array",
-                                "items": {
-                                    "type": "string"
-                                },
+                                "type": "string",
                                 "description": "产品描述"
                             },
                             "QD": {
@@ -802,10 +799,7 @@ export const BUILTIN_MODULES = [
                                 "description": "评审人"
                             },
                             "desc": {
-                                "type": "array",
-                                "items": {
-                                    "type": "string"
-                                },
+                                "type": "string",
                                 "description": "产品描述"
                             },
                             "QD": {

package/dist/modules/override.js

@@ -2,6 +2,27 @@ import { extendModuleAction, defineModuleActions } from './define.js';
 import { extractResult } from './resolve.js';
 import { snapshotToMarkdown } from '../utils/doc-helper/markdown.js';
 import { isRecord } from '../utils/index.js';
+import { request } from '../request/index.js';
+import { ZentaoError } from '../misc/errors.js';
+/** 这些内置写接口要求 JSON，不能把 HTTP 200 的 PHP/SQL 错误文本视为成功。 */
+const requestJSON = async ({ request: command, body, bodyType, client, timeout, insecure }) => {
+    const response = await client.request(command.path, {
+        method: command.action.method.toUpperCase(),
+        query: command.query, body, bodyType, timeout, insecure, responseType: 'response',
+    });
+    const responseText = await response.text();
+    try {
+        return JSON.parse(responseText);
+    }
+    catch {
+        return {
+            status: 'fail',
+            message: `Invalid JSON response from ${command.module}/${command.action.name}.`,
+            httpStatus: response.status,
+            responseText,
+        };
+    }
+};
 /**
  * 内置覆盖 / 扩展定义。
  *
@@ -64,6 +85,9 @@ import { isRecord } from '../utils/index.js';
  * @internal
  */
 export function applyBuiltinOverrides() {
+    for (const [moduleName, actionName] of [['product', 'create'], ['product', 'update'], ['feedback', 'close']]) {
+        extendModuleAction(moduleName, actionName, { request: requestJSON });
+    }
     // 创建执行时，需要添加产品字段
     extendModuleAction('execution', 'create', (action) => {
         const required = action.requestBody.schema?.required;
@@ -92,6 +116,79 @@ export function applyBuiltinOverrides() {
         }
         return action;
     });
+    // 需求创建和变更时，根据评审人决定是否进入评审流程。
+    ['story', 'requirement', 'epic'].forEach((moduleName) => {
+        ['create', 'change'].forEach((actionName) => {
+            extendModuleAction(moduleName, actionName, (action) => {
+                const schema = action.requestBody.schema;
+                // 补齐 requirement/change 的评审人字段，并允许未传评审人时执行回调。
+                schema.properties.reviewer ??= {
+                    type: 'array',
+                    items: { type: 'string' },
+                };
+                schema.properties.reviewer.description = '评审人员，如果无需评审则不传';
+                if (schema.required) {
+                    schema.required = schema.required.filter(name => name !== 'reviewer');
+                }
+                action.beforeRequest = async ({ data = {} }) => {
+                    const hasReviewer = Array.isArray(data.reviewer)
+                        && data.reviewer.some(reviewer => typeof reviewer === 'string' && reviewer.trim() !== '');
+                    if (hasReviewer) {
+                        data.status = 'reviewing';
+                    }
+                    else {
+                        data.needNotReview = '1';
+                    }
+                    return { data };
+                };
+                return action;
+            });
+        });
+    });
+    // confirmClose 是控制器参数，留在 JSON body 中会被误当成反馈表字段。
+    extendModuleAction('feedback', 'close', {
+        beforeRequest: async (command) => {
+            const data = { ...command.data };
+            const query = { ...command.query };
+            if (Object.hasOwn(data, 'confirmClose')) {
+                query.confirmClose = data.confirmClose;
+                delete data.confirmClose;
+            }
+            return { data, query };
+        },
+    });
+    // 确认表单会重置缺省字段；仅补齐可写字段，不回传详情中的其他属性。
+    extendModuleAction('bug', 'confirm', {
+        request: async ({ request: command, body, bodyType, client, timeout, insecure, options }) => {
+            const data = { ...body };
+            const fields = ['status', 'assignedTo', 'type', 'pri', 'deadline', 'mailto'];
+            const missing = fields.filter(field => data[field] === undefined);
+            if (missing.length) {
+                const response = await request('bug/get', { id: command.id }, {
+                    client, timeout, insecure, throwOnFail: true,
+                    forceRefreshConfig: options.forceRefreshConfig,
+                    skipVersionCheckOnConfigError: options.skipVersionCheckOnConfigError,
+                });
+                const current = response.data;
+                if (!isRecord(current) || missing.some(field => current[field] === undefined)) {
+                    throw new ZentaoError('E_API_FAILED', { message: 'Bug details are incomplete; confirmation was not sent.' });
+                }
+                for (const field of missing) {
+                    data[field] = field === 'mailto' && typeof current[field] === 'string'
+                        ? current[field].split(',').filter(Boolean)
+                        : current[field];
+                }
+            }
+            if (typeof data.status !== 'string' || !data.status.trim()) {
+                throw new ZentaoError('E_INVALID_PARAM', { param: 'status', value: String(data.status) });
+            }
+            // 已关闭 Bug 的指派人是特殊标记，API 会把它当成账号校验，需调用方明确指定。
+            if (data.assignedTo === 'closed') {
+                throw new ZentaoError('E_INVALID_PARAM', { param: 'assignedTo', value: 'closed' });
+            }
+            return requestJSON({ request: command, body: data, bodyType, client, timeout, insecure, options });
+        },
+    });
     // 修改 acl 字段默认值为 open
     [
         ['product', 'create'],

package/dist/modules/registry-store.js

@@ -156,6 +156,9 @@ export function validateAction(action) {
     if (action.resultType !== undefined && typeof action.resultType !== 'string') {
         throw new ZentaoError('E_INVALID_ACTION_DEFINITION');
     }
+    if (action.beforeRequest !== undefined && typeof action.beforeRequest !== 'function') {
+        throw new ZentaoError('E_INVALID_ACTION_DEFINITION');
+    }
     if (action.request !== undefined && typeof action.request !== 'function') {
         throw new ZentaoError('E_INVALID_ACTION_DEFINITION');
     }

package/dist/request/index.d.ts

@@ -25,6 +25,7 @@ export type RequestResultFor<Name extends BuiltinRequestName> = ActionMetaOf<Nam
  * 按模块名或模块动作名请求禅道 API。
  *
  * 选项优先级为：本次调用 options > 全局 options > 客户端默认值。
+ * 动作的 beforeRequest 在参数解析后、请求体准备前执行，返回值浅合并到解析后的请求描述中。
  * 当响应 `status` 为 `"fail"` 时，默认按原样返回；若 `options.throwOnFail`
  * 或全局 `throwOnFail` 为真，则改为抛出 `E_API_FAILED`。
  * 请求前按 Action 的 `minVersion` 检查服务器版本；全局 `version` 可避免配置探测，

package/dist/request/index.js

@@ -231,6 +231,9 @@ async function requestInternal(name, params, options, version) {
         ? await autoFillUpdateParams(module, action, mergedParams, { ...options, client }, version)
         : mergedParams;
     const command = resolveActionRequest(module, actionName, finalParams);
+    if (command.action.beforeRequest) {
+        Object.assign(command, await command.action.beforeRequest(command));
+    }
     const preparedBody = await prepareActionBody(command, {
         maxUploadBytes: options.maxUploadBytes,
     });

package/dist/types/module.d.ts

@@ -87,6 +87,14 @@ export type ModuleActionResultFieldMap = Readonly<Record<string, string>>;
  * @param options 本次请求的数据处理选项；直接调用 getter 时可以省略。
  */
 export type ModuleActionGetterFn<T, O = RequestProcessOptions> = (data: unknown, params: Record<string, unknown>, options?: O) => T;
+/**
+ * 请求发送前的回调，在版本检查、autoFill 和参数解析完成后、请求体准备前调用。
+ * 可直接修改本次请求，或返回 `path`、`query`、`data`、`params`、`id` 的部分字段作为补丁。
+ * 返回值浅合并到解析后的请求描述中，同名字段以返回值为准；对象字段整体替换。
+ * 合并后的请求用于请求体准备、请求发送和响应处理，不会重新执行版本检查、autoFill 或参数解析。
+ * 回调抛出或拒绝时终止本次请求，错误原样传递。
+ */
+export type ModuleActionBeforeRequestCallback = (request: ModuleActionRequest) => Promise<Partial<Omit<ModuleActionRequest, 'module' | 'action'>>>;
 /**
  * 自定义动作的请求发送逻辑，在版本检查、参数解析和请求体准备完成后调用。
  * 返回原始响应数据，后续仍按动作定义提取结果、分页并应用请求选项；抛出的错误原样传递。
@@ -149,6 +157,8 @@ export interface ModuleAction {
      * 字符串为字段路径（支持 `a.b` 嵌套）、对象为字段映射、函数则接收原始响应与调用参数。
      */
     resultGetter?: string | ModuleActionResultFieldMap | ModuleActionGetterFn<unknown>;
+    /** 请求体准备前执行的回调，可修改解析后的请求并返回请求描述的部分字段作为补丁。 */
+    beforeRequest?: ModuleActionBeforeRequestCallback;
     /** 自定义请求回调；省略时通过 ZentaoClient.request 发送请求，返回值沿用相同的响应处理流程。 */
     request?: ModuleActionRequestCallback;
 }

package/dist/version.js

@@ -1,5 +1,5 @@
-const fallbackBuild = "2026-09-06T14:52:03.785Z";
-const fallbackVersion = "0.6.8";
+const fallbackBuild = "2026-09-15T08:27:14.702Z";
+const fallbackVersion = "0.7.0";
 /**
  * 构建标识，由构建脚本通过 `__ZENTAO_API_BUILD__` 注入。
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zentao-api",
-  "version": "0.6.8",
+  "version": "0.7.0",
   "type": "module",
   "description": "Browser and Node.js SDK for ZenTao API",
   "license": "MIT",