zentao-api 0.3.3 → 0.4.0

package/dist/modules/generated.d.ts

@@ -1037,19 +1037,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取产品计划列表，支持获取产品下的产品计划";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/productplans";
+        readonly path: "/products/{productID}/productplans";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "productplans";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "产品计划范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -1245,7 +1238,7 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly resultGetter: "stories";
         readonly pathParams: {
             readonly scope: {
-                readonly description: "需求范围";
+                readonly description: "需求所属范围";
                 readonly options: readonly [{
                     readonly value: "products";
                     readonly label: "产品";
@@ -1257,7 +1250,7 @@ export declare const BUILTIN_MODULES: readonly [{
                     readonly label: "执行";
                 }];
             };
-            readonly scopeID: "范围ID";
+            readonly scopeID: "所属范围ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -1580,19 +1573,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取业务需求列表，支持获取产品下的业务需求";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/epics";
+        readonly path: "/products/{productID}/epics";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "epics";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "业务需求范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -1906,19 +1892,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取用户需求列表，支持获取产品下的用户需求";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/requirements";
+        readonly path: "/products/{productID}/requirements";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "requirements";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "用户需求范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -2229,7 +2208,7 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly resultGetter: "bugs";
         readonly pathParams: {
             readonly scope: {
-                readonly description: "Bug范围";
+                readonly description: "Bug所属范围";
                 readonly options: readonly [{
                     readonly value: "products";
                     readonly label: "产品";
@@ -2241,7 +2220,7 @@ export declare const BUILTIN_MODULES: readonly [{
                     readonly label: "执行";
                 }];
             };
-            readonly scopeID: "范围ID";
+            readonly scopeID: "所属范围ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -2563,7 +2542,7 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly resultGetter: "testcases";
         readonly pathParams: {
             readonly scope: {
-                readonly description: "测试用例范围";
+                readonly description: "测试用例所属范围";
                 readonly options: readonly [{
                     readonly value: "products";
                     readonly label: "产品";
@@ -2575,7 +2554,7 @@ export declare const BUILTIN_MODULES: readonly [{
                     readonly label: "执行";
                 }];
             };
-            readonly scopeID: "范围ID";
+            readonly scopeID: "所属范围ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -2807,19 +2786,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取任务列表，支持获取执行下的任务";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/tasks";
+        readonly path: "/executions/{executionID}/tasks";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "tasks";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "任务范围";
-                readonly options: readonly [{
-                    readonly value: "executions";
-                    readonly label: "执行";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly executionID: "所属执行ID";
         };
         readonly params: readonly [{
             readonly name: "status";
@@ -3183,19 +3155,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取反馈列表，支持获取产品下的反馈";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/feedbacks";
+        readonly path: "/products/{productID}/feedbacks";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "feedbacks";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "反馈范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -3443,19 +3408,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取工单列表，支持获取产品下的工单";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/tickets";
+        readonly path: "/products/{productID}/tickets";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "tickets";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "工单范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
         readonly params: readonly [{
             readonly name: "browseType";
@@ -3719,18 +3677,11 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取应用列表，支持获取产品下的应用";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/systems";
+        readonly path: "/products/{productID}/systems";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "应用范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
     }, {
         readonly name: "create";
@@ -3825,7 +3776,7 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly resultGetter: "builds";
         readonly pathParams: {
             readonly scope: {
-                readonly description: "版本范围";
+                readonly description: "版本所属范围";
                 readonly options: readonly [{
                     readonly value: "projects";
                     readonly label: "项目";
@@ -3834,7 +3785,7 @@ export declare const BUILTIN_MODULES: readonly [{
                     readonly label: "执行";
                 }];
             };
-            readonly scopeID: "范围ID";
+            readonly scopeID: "所属范围ID";
         };
     }, {
         readonly name: "create";
@@ -3977,7 +3928,7 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly resultGetter: "testtasks";
         readonly pathParams: {
             readonly scope: {
-                readonly description: "测试单范围";
+                readonly description: "测试单所属范围";
                 readonly options: readonly [{
                     readonly value: "products";
                     readonly label: "产品";
@@ -3989,7 +3940,7 @@ export declare const BUILTIN_MODULES: readonly [{
                     readonly label: "执行";
                 }];
             };
-            readonly scopeID: "范围ID";
+            readonly scopeID: "所属范围ID";
         };
     }, {
         readonly name: "create";
@@ -4135,19 +4086,12 @@ export declare const BUILTIN_MODULES: readonly [{
         readonly display: "获取发布列表，支持获取产品下的发布";
         readonly type: "list";
         readonly method: "get";
-        readonly path: "/{scope}/{scopeID}/releases";
+        readonly path: "/products/{productID}/releases";
         readonly resultType: "list";
         readonly pagerGetter: "pager";
         readonly resultGetter: "releases";
         readonly pathParams: {
-            readonly scope: {
-                readonly description: "发布范围";
-                readonly options: readonly [{
-                    readonly value: "products";
-                    readonly label: "产品";
-                }];
-            };
-            readonly scopeID: "范围ID";
+            readonly productID: "所属产品ID";
         };
     }, {
         readonly name: "create";

package/dist/modules/generated.js

@@ -1016,13 +1016,12 @@ export const BUILTIN_MODULES = [
                 display: '获取产品计划列表，支持获取产品下的产品计划',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/productplans',
+                path: '/products/{productID}/productplans',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'productplans',
                 pathParams: {
-                    scope: { description: '产品计划范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
                 params: [
                     {
@@ -1207,8 +1206,8 @@ export const BUILTIN_MODULES = [
                 pagerGetter: 'pager',
                 resultGetter: 'stories',
                 pathParams: {
-                    scope: { description: '需求范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
-                    scopeID: '范围ID',
+                    scope: { description: '需求所属范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
+                    scopeID: '所属范围ID',
                 },
                 params: [
                     {
@@ -1529,13 +1528,12 @@ export const BUILTIN_MODULES = [
                 display: '获取业务需求列表，支持获取产品下的业务需求',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/epics',
+                path: '/products/{productID}/epics',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'epics',
                 pathParams: {
-                    scope: { description: '业务需求范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
                 params: [
                     {
@@ -1847,13 +1845,12 @@ export const BUILTIN_MODULES = [
                 display: '获取用户需求列表，支持获取产品下的用户需求',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/requirements',
+                path: '/products/{productID}/requirements',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'requirements',
                 pathParams: {
-                    scope: { description: '用户需求范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
                 params: [
                     {
@@ -2159,8 +2156,8 @@ export const BUILTIN_MODULES = [
                 pagerGetter: 'pager',
                 resultGetter: 'bugs',
                 pathParams: {
-                    scope: { description: 'Bug范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
-                    scopeID: '范围ID',
+                    scope: { description: 'Bug所属范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
+                    scopeID: '所属范围ID',
                 },
                 params: [
                     {
@@ -2476,8 +2473,8 @@ export const BUILTIN_MODULES = [
                 pagerGetter: 'pager',
                 resultGetter: 'testcases',
                 pathParams: {
-                    scope: { description: '测试用例范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
-                    scopeID: '范围ID',
+                    scope: { description: '测试用例所属范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
+                    scopeID: '所属范围ID',
                 },
                 params: [
                     {
@@ -2707,13 +2704,12 @@ export const BUILTIN_MODULES = [
                 display: '获取任务列表，支持获取执行下的任务',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/tasks',
+                path: '/executions/{executionID}/tasks',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'tasks',
                 pathParams: {
-                    scope: { description: '任务范围', options: [{ value: 'executions', label: '执行' }] },
-                    scopeID: '范围ID',
+                    executionID: '所属执行ID',
                 },
                 params: [
                     {
@@ -3073,13 +3069,12 @@ export const BUILTIN_MODULES = [
                 display: '获取反馈列表，支持获取产品下的反馈',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/feedbacks',
+                path: '/products/{productID}/feedbacks',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'feedbacks',
                 pathParams: {
-                    scope: { description: '反馈范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
                 params: [
                     {
@@ -3320,13 +3315,12 @@ export const BUILTIN_MODULES = [
                 display: '获取工单列表，支持获取产品下的工单',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/tickets',
+                path: '/products/{productID}/tickets',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'tickets',
                 pathParams: {
-                    scope: { description: '工单范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
                 params: [
                     {
@@ -3579,12 +3573,11 @@ export const BUILTIN_MODULES = [
                 display: '获取应用列表，支持获取产品下的应用',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/systems',
+                path: '/products/{productID}/systems',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 pathParams: {
-                    scope: { description: '应用范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
             }, {
                 name: 'create',
@@ -3690,8 +3683,8 @@ export const BUILTIN_MODULES = [
                 pagerGetter: 'pager',
                 resultGetter: 'builds',
                 pathParams: {
-                    scope: { description: '版本范围', options: [{ value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
-                    scopeID: '范围ID',
+                    scope: { description: '版本所属范围', options: [{ value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
+                    scopeID: '所属范围ID',
                 },
             }, {
                 name: 'create',
@@ -3851,8 +3844,8 @@ export const BUILTIN_MODULES = [
                 pagerGetter: 'pager',
                 resultGetter: 'testtasks',
                 pathParams: {
-                    scope: { description: '测试单范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
-                    scopeID: '范围ID',
+                    scope: { description: '测试单所属范围', options: [{ value: 'products', label: '产品' }, { value: 'projects', label: '项目' }, { value: 'executions', label: '执行' }] },
+                    scopeID: '所属范围ID',
                 },
             }, {
                 name: 'create',
@@ -4013,13 +4006,12 @@ export const BUILTIN_MODULES = [
                 display: '获取发布列表，支持获取产品下的发布',
                 type: 'list',
                 method: 'get',
-                path: '/{scope}/{scopeID}/releases',
+                path: '/products/{productID}/releases',
                 resultType: 'list',
                 pagerGetter: 'pager',
                 resultGetter: 'releases',
                 pathParams: {
-                    scope: { description: '发布范围', options: [{ value: 'products', label: '产品' }] },
-                    scopeID: '范围ID',
+                    productID: '所属产品ID',
                 },
             }, {
                 name: 'create',

package/dist/modules/query.d.ts

@@ -1,4 +1,4 @@
-import type { ModuleAction, ModuleDefinition } from '../types/index.js';
+import type { ModuleAction, ModuleActionParam, ModuleActionParamRole, ModuleDefinition } from '../types/index.js';
 /**
  * 获取模块定义。
  *
@@ -27,6 +27,18 @@ export declare function getModule(moduleName: string): ModuleDefinition;
  * @throws {ZentaoError} `E_INVALID_MODULE`（模块未注册）或 `E_INVALID_ACTION`（动作不存在）。
  */
 export declare function getModuleAction(moduleName: string, actionName: string): ModuleAction;
+/**
+ * 获取指定模块下的某个动作的参数。
+ *
+ * @param moduleName - 模块名（大小写不敏感）。
+ * @param actionName - 动作名（大小写不敏感）；支持 `ls` 作为 `list` 的别名。
+ * @param options - 选项。
+ * @param options.roles - 角色，可选 `path`、`query`、`body`。
+ * @returns 动作参数。
+ */
+export declare function getModuleActionParams(moduleName: string, actionName: string, options?: {
+    roles?: ModuleActionParamRole[];
+}): ModuleActionParam[];
 /**
  * 返回当前运行时注册表中的所有模块名。
  *

package/dist/modules/query.js

@@ -47,6 +47,65 @@ export function getModuleAction(moduleName, actionName) {
     }
     throw new ZentaoError('E_INVALID_ACTION', { module: moduleName, action: actionName });
 }
+/**
+ * 获取指定模块下的某个动作的参数。
+ *
+ * @param moduleName - 模块名（大小写不敏感）。
+ * @param actionName - 动作名（大小写不敏感）；支持 `ls` 作为 `list` 的别名。
+ * @param options - 选项。
+ * @param options.roles - 角色，可选 `path`、`query`、`body`。
+ * @returns 动作参数。
+ */
+export function getModuleActionParams(moduleName, actionName, options) {
+    const { roles } = options ?? {};
+    const params = [];
+    const action = getModuleAction(moduleName, actionName);
+    if (!action) {
+        return [];
+    }
+    if (action.pathParams && (!roles || roles.includes('path'))) {
+        Object.entries(action.pathParams).forEach(([name, param]) => {
+            if (typeof param === 'string') {
+                param = {
+                    description: param,
+                };
+            }
+            params.push({
+                name,
+                role: 'path',
+                required: true,
+                ...param,
+            });
+        });
+    }
+    if (action.params && (!roles || roles.includes('query'))) {
+        params.push(...action.params.map(x => ({ ...x, role: 'query' })));
+    }
+    const schema = action.requestBody?.schema;
+    if (schema && (!roles || roles.includes('body'))) {
+        if (schema.type === 'object') {
+            const requiredSet = new Set(schema.required ? schema.required.map(x => x.toLowerCase()) : []);
+            Object.entries(schema.properties).forEach(([name, property]) => {
+                params.push({
+                    name,
+                    role: 'body',
+                    required: property.required ?? requiredSet.has(name.toLowerCase()),
+                    type: (property.type === 'integer' ? 'number' : property.type) ?? 'string',
+                    ...property,
+                });
+            });
+        }
+        else {
+            params.push({
+                name: 'data',
+                role: 'body',
+                required: true,
+                type: schema.type,
+            });
+        }
+    }
+    return params;
+}
 /**
  * 返回当前运行时注册表中的所有模块名。
  *