zentao-api 0.3.2 → 0.3.3

package/dist/modules/define.d.ts

@@ -29,10 +29,13 @@ export declare function defineModules(input: ModuleDefinition | ModuleDefinition
  *
  * 不做深度合并：同名动作整体替换，未知动作追加。这避免在 schema、参数数组等字段上出现隐式合并规则。
  *
+ * `method` / `resultType` 可省略：写入时按动作 `type` 自动推导（见 {@link ModuleAction}）。
+ *
  * @param moduleName - 目标模块名（大小写不敏感）。
  * @param input - 单个或一组动作定义。
- * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）或 `E_INVALID_ACTION_DEFINITION`
- *   （动作缺少 `name` / `path` / `method` 等必填字段）。
+ * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）、`E_INVALID_ACTION_DEFINITION`
+ *   （动作缺少 `name` / `path`，或 `method` / `resultType` 类型非法），或
+ *   `E_INDETERMINATE_ACTION_METHOD` / `E_INDETERMINATE_ACTION_RESULT_TYPE`（省略字段且无法按 `type` 推导）。
  */
 export declare function defineModuleActions(moduleName: string, input: ModuleAction | ModuleAction[]): void;
 /**
@@ -48,8 +51,9 @@ export declare function defineModuleActions(moduleName: string, input: ModuleAct
  * @param moduleName - 目标模块名（大小写不敏感）。
  * @param actionName - 目标动作名（大小写不敏感）。
  * @param action - 深度合并的补丁对象，或接收当前动作深克隆并返回完整动作定义的函数。
- * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）、`E_INVALID_ACTION`（动作不存在）
- *   或 `E_INVALID_ACTION_DEFINITION`（合并结果缺少 `name` / `path` / `method` 等必填字段）。
+ * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）、`E_INVALID_ACTION`（动作不存在）、
+ *   `E_INVALID_ACTION_DEFINITION`（合并结果缺少 `name` / `path`，或 `method` / `resultType` 类型非法），
+ *   或 `E_INDETERMINATE_ACTION_METHOD` / `E_INDETERMINATE_ACTION_RESULT_TYPE`（省略字段且无法按 `type` 推导）。
  */
 export declare function extendModuleAction(moduleName: string, actionName: string, action: Partial<ModuleAction> | ((action: ModuleAction) => ModuleAction)): void;
 /**

package/dist/modules/define.js

@@ -37,10 +37,13 @@ export function defineModules(input, options = {}) {
  *
  * 不做深度合并：同名动作整体替换，未知动作追加。这避免在 schema、参数数组等字段上出现隐式合并规则。
  *
+ * `method` / `resultType` 可省略：写入时按动作 `type` 自动推导（见 {@link ModuleAction}）。
+ *
  * @param moduleName - 目标模块名（大小写不敏感）。
  * @param input - 单个或一组动作定义。
- * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）或 `E_INVALID_ACTION_DEFINITION`
- *   （动作缺少 `name` / `path` / `method` 等必填字段）。
+ * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）、`E_INVALID_ACTION_DEFINITION`
+ *   （动作缺少 `name` / `path`，或 `method` / `resultType` 类型非法），或
+ *   `E_INDETERMINATE_ACTION_METHOD` / `E_INDETERMINATE_ACTION_RESULT_TYPE`（省略字段且无法按 `type` 推导）。
  */
 export function defineModuleActions(moduleName, input) {
     const key = moduleName.toLowerCase();
@@ -80,8 +83,9 @@ export function defineModuleActions(moduleName, input) {
  * @param moduleName - 目标模块名（大小写不敏感）。
  * @param actionName - 目标动作名（大小写不敏感）。
  * @param action - 深度合并的补丁对象，或接收当前动作深克隆并返回完整动作定义的函数。
- * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）、`E_INVALID_ACTION`（动作不存在）
- *   或 `E_INVALID_ACTION_DEFINITION`（合并结果缺少 `name` / `path` / `method` 等必填字段）。
+ * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）、`E_INVALID_ACTION`（动作不存在）、
+ *   `E_INVALID_ACTION_DEFINITION`（合并结果缺少 `name` / `path`，或 `method` / `resultType` 类型非法），
+ *   或 `E_INDETERMINATE_ACTION_METHOD` / `E_INDETERMINATE_ACTION_RESULT_TYPE`（省略字段且无法按 `type` 推导）。
  */
 export function extendModuleAction(moduleName, actionName, action) {
     const key = moduleName.toLowerCase();

package/dist/modules/generated.d.ts

@@ -176,7 +176,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly userID: "用户ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "program";
@@ -357,7 +356,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly programID: "项目集ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "product";
@@ -582,7 +580,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly productID: "产品ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "project";
@@ -778,7 +775,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly projectID: "项目ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "execution";
@@ -1031,7 +1027,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly executionID: "执行ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "productplan";
@@ -1234,7 +1229,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly productplanID: "产品计划ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "story";
@@ -1482,7 +1476,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly storyID: "需求ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活需求";
@@ -1510,7 +1503,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "change";
         readonly display: "变更需求";
@@ -1550,7 +1542,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["reviewer"];
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭需求";
@@ -1579,7 +1570,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["closedReason"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "epic";
@@ -1812,7 +1802,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly epicID: "业务需求ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活业务需求";
@@ -1840,7 +1829,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "change";
         readonly display: "变更业务需求";
@@ -1880,7 +1868,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["reviewer"];
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭业务需求";
@@ -1909,7 +1896,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["closedReason"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "requirement";
@@ -2141,7 +2127,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly requirementID: "用户需求ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活用户需求";
@@ -2169,7 +2154,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "change";
         readonly display: "变更用户需求";
@@ -2201,7 +2185,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭用户需求";
@@ -2230,7 +2213,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["closedReason"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "bug";
@@ -2468,7 +2450,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly bugID: "Bug ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活Bug";
@@ -2503,7 +2484,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭Bug";
@@ -2527,7 +2507,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "resolve";
         readonly display: "解决Bug";
@@ -2568,7 +2547,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["resolution"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "testcase";
@@ -2819,7 +2797,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly testcasID: "测试用例ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "task";
@@ -3053,7 +3030,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly taskID: "任务ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活任务";
@@ -3086,7 +3062,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭任务";
@@ -3110,7 +3085,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "finish";
         readonly display: "完成任务";
@@ -3157,7 +3131,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["currentConsumed", "realStarted", "finishedDate"];
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "start";
         readonly display: "启动任务";
@@ -3200,7 +3173,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["realStarted"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "feedback";
@@ -3406,7 +3378,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly feedbackID: "反馈ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活反馈";
@@ -3434,7 +3405,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭反馈";
@@ -3463,7 +3433,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["closedReason"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "ticket";
@@ -3685,7 +3654,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly ticketID: "工单ID";
         };
-        readonly render: "action";
     }, {
         readonly name: "activate";
         readonly display: "激活工单";
@@ -3713,7 +3681,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 };
             };
         };
-        readonly render: "action";
     }, {
         readonly name: "close";
         readonly display: "关闭工单";
@@ -3742,7 +3709,6 @@ export declare const BUILTIN_MODULES: readonly [{
                 readonly required: readonly ["closedReason", "comment"];
             };
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "system";
@@ -3995,7 +3961,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly buildID: "版本ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "testtask";
@@ -4160,7 +4125,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly testtaskID: "测试单ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "release";
@@ -4293,7 +4257,6 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly releasID: "发布ID";
         };
-        readonly render: "action";
     }];
 }, {
     readonly name: "file";
@@ -4330,6 +4293,5 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly pathParams: {
             readonly fileID: "附件ID";
         };
-        readonly render: "action";
     }];
 }];

package/dist/modules/generated.js

@@ -174,7 +174,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     userID: '用户ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -344,7 +343,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     programID: '项目集ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -562,7 +560,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     productID: '产品ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -757,7 +754,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     projectID: '项目ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -1006,7 +1002,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     executionID: '执行ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -1193,7 +1188,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     productplanID: '产品计划ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -1423,7 +1417,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     storyID: '需求ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活需求',
@@ -1451,7 +1444,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'change',
                 display: '变更需求',
@@ -1493,7 +1485,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭需求',
@@ -1524,7 +1515,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -1745,7 +1735,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     epicID: '业务需求ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活业务需求',
@@ -1773,7 +1762,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'change',
                 display: '变更业务需求',
@@ -1815,7 +1803,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭业务需求',
@@ -1846,7 +1833,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -2066,7 +2052,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     requirementID: '用户需求ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活用户需求',
@@ -2094,7 +2079,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'change',
                 display: '变更用户需求',
@@ -2126,7 +2110,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭用户需求',
@@ -2157,7 +2140,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -2376,7 +2358,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     bugID: 'Bug ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活Bug',
@@ -2411,7 +2392,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭Bug',
@@ -2435,7 +2415,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'resolve',
                 display: '解决Bug',
@@ -2478,7 +2457,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -2715,7 +2693,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     testcasID: '测试用例ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -2933,7 +2910,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     taskID: '任务ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活任务',
@@ -2966,7 +2942,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭任务',
@@ -2990,7 +2965,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'finish',
                 display: '完成任务',
@@ -3041,7 +3015,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }, {
                 name: 'start',
                 display: '启动任务',
@@ -3086,7 +3059,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -3277,7 +3249,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     feedbackID: '反馈ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活反馈',
@@ -3305,7 +3276,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭反馈',
@@ -3336,7 +3306,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -3538,7 +3507,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     ticketID: '工单ID',
                 },
-                render: 'action',
             }, {
                 name: 'activate',
                 display: '激活工单',
@@ -3566,7 +3534,6 @@ export const BUILTIN_MODULES = [
                         }
                     },
                 },
-                render: 'action',
             }, {
                 name: 'close',
                 display: '关闭工单',
@@ -3598,7 +3565,6 @@ export const BUILTIN_MODULES = [
                         ]
                     },
                 },
-                render: 'action',
             }
         ],
     },
@@ -3866,7 +3832,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     buildID: '版本ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -4034,7 +3999,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     testtaskID: '测试单ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -4176,7 +4140,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     releasID: '发布ID',
                 },
-                render: 'action',
             }
         ],
     },
@@ -4219,7 +4182,6 @@ export const BUILTIN_MODULES = [
                 pathParams: {
                     fileID: '附件ID',
                 },
-                render: 'action',
             }
         ],
     }

package/dist/modules/registry-store.d.ts

@@ -10,6 +10,14 @@ export declare function deepClone<T>(value: T): T;
 export declare function deepMerge<T>(base: T, patch: unknown): T;
 export declare function cloneBuiltinModules(): ModuleDefinition[];
 export declare function deepFreeze<T>(value: T): T;
+/**
+ * 按 {@link ModuleAction.type} 就地补齐省略的 `method` / `resultType`。
+ *
+ * 已显式声明的字段保持不变；当 `type` 无法推导出对应默认值时抛错，提示显式指定。
+ *
+ * @throws {ZentaoError} `E_INDETERMINATE_ACTION_METHOD` / `E_INDETERMINATE_ACTION_RESULT_TYPE`
+ */
+export declare function normalizeAction(action: ModuleAction): ModuleAction;
 export declare function freezeAction(action: ModuleAction): ModuleAction;
 export declare function freezeModule(module: ModuleDefinition): ModuleDefinition;
 export declare function freezeModules(source: ModuleDefinition[]): ModuleDefinition[];