@meet-im/lxcli 0.0.5 → 0.0.7

package/dist/commands/generate-skills.js

@@ -4,7 +4,7 @@ import * as path from 'path';
 import { outputCliError } from '../core/error.js';
 import { logger } from '../core/logger.js';
 import { PARAM_DEFS, METHOD_DESCRIPTIONS } from './services/kb/descriptions.js';
-import { METHOD_SKILL_METADATA } from './services/kb/skill-metadata.js';
+import { METHOD_SHORTCUT_PARAMS, METHOD_SKILL_METADATA } from './services/kb/skill-metadata.js';
 const API_ROOT = path.resolve('api');
 const DEFAULT_SKILLS_DIR = path.resolve('api/skills');
 const DEFAULT_OUTPUT = 'api/docs/skills.md';
@@ -155,41 +155,51 @@ async function readPackageVersion() {
     const packageJson = JSON.parse(await fs.readFile(PACKAGE_JSON_PATH, 'utf-8'));
     return packageJson.version || '1.0.0';
 }
+function buildParamsExample(params) {
+    const paramsExample = {};
+    for (const p of params) {
+        if (p.type === 'array<integer>') {
+            paramsExample[p.name] = [1, 2];
+        }
+        else if (p.type === 'array<string>') {
+            paramsExample[p.name] = ['id1', 'id2'];
+        }
+        else if (p.type === 'integer') {
+            paramsExample[p.name] = 123;
+        }
+        else if (p.type === 'object') {
+            paramsExample[p.name] = {};
+        }
+        else {
+            paramsExample[p.name] = 'value';
+        }
+    }
+    return paramsExample;
+}
 function renderSkillMd(method, version) {
     const description = METHOD_DESCRIPTIONS[method];
     const params = PARAM_DEFS[method] || [];
     const metadata = METHOD_SKILL_METADATA[method];
     const skillName = `lxcli-kb-${method}`;
     const hasParams = params.length > 0;
-    // 快捷参数列表
-    const shortcuts = params.filter(p => p.required).map(p => `--${p.name} <${p.type === 'integer' ? 'ID' : 'VALUE'}>`);
+    // 快捷参数列表（显式配置，不从 required 自动推断）
+    const shortcutParams = METHOD_SHORTCUT_PARAMS[method] || [];
+    const shortcuts = shortcutParams.map((name) => {
+        const param = params.find((p) => p.name === name);
+        if (!param) {
+            return `--${name} <VALUE>`;
+        }
+        return `--${param.name} <${param.type === 'integer' ? 'ID' : 'VALUE'}>`;
+    });
     const shortcutUsage = shortcuts.length > 0 ? `lxcli kb ${method} ${shortcuts.join(' ')}` : '';
+    const paramsUsage = hasParams ? `lxcli kb ${method} --params '${JSON.stringify(buildParamsExample(params))}'` : '';
     // Usage 部分
     const usageLines = ['## Usage', '', '```bash'];
     if (hasParams) {
         if (shortcutUsage) {
             usageLines.push(shortcutUsage);
         }
-        // 生成 --params 示例
-        const paramsExample = {};
-        for (const p of params) {
-            if (p.type === 'array<integer>') {
-                paramsExample[p.name] = [1, 2];
-            }
-            else if (p.type === 'array<string>') {
-                paramsExample[p.name] = ['id1', 'id2'];
-            }
-            else if (p.type === 'integer') {
-                paramsExample[p.name] = 123;
-            }
-            else if (p.type === 'object') {
-                paramsExample[p.name] = {};
-            }
-            else {
-                paramsExample[p.name] = 'value';
-            }
-        }
-        usageLines.push(`lxcli kb ${method} --params '${JSON.stringify(paramsExample)}'`);
+        usageLines.push(paramsUsage);
     }
     else {
         usageLines.push(`lxcli kb ${method}`);
@@ -224,7 +234,7 @@ metadata:
     if (hasParams) {
         lines.push(renderParamsTable(params));
     }
-    lines.push('## Examples', '', '```bash', shortcutUsage || `lxcli kb ${method}`, '```', '');
+    lines.push('## Examples', '', '```bash', shortcutUsage || paramsUsage || `lxcli kb ${method}`, '```', '');
     if (metadata?.notes?.length) {
         lines.push('## Notes', '', ...metadata.notes.map((note) => `- ${note}`), '');
     }

package/dist/commands/services/kb/descriptions.js

@@ -11,12 +11,14 @@ export const METHOD_DESCRIPTIONS = {
     getTask: '获取需求/bug 明细',
     queryUsers: '获取用户信息',
     searchTasks: '搜索需求/bug 列表',
+    searchSubtasks: '搜索子任务列表',
     getAllActiveIterations: '获取启用迭代列表',
     getAllCategories: '获取项目分类列表',
     createTask: '创建需求/bug',
     createSubtask: '创建子任务',
     updateTask: '修改需求',
     updateSubtask: '更新子任务',
+    moveTaskPosition: '移动需求状态列',
     getAllComments: '获取评论列表',
     createComment: '对需求增加评论',
     createProjectFile: '上传附件到项目',

package/dist/commands/services/kb/handler.d.ts

@@ -4,10 +4,12 @@ export interface KbCommandOptions {
     task_id?: string;
     title?: string;
     project_id?: string;
+    iteration_id?: string;
     file_id?: string;
     owner_id?: string;
     category_id?: string;
     query?: string;
+    page?: string;
     user_id?: string;
     content?: string;
     user?: string;

package/dist/commands/services/kb/handler.js

@@ -105,6 +105,34 @@ export function createKbAction(method) {
             }
             params = { project_id: projectId, query: options.query };
         }
+        else if (method === 'searchSubtasks' && (options.project_id || options.iteration_id || options.user_id || options.page)) {
+            const projectId = options.project_id === undefined ? undefined : parseTaskId(options.project_id);
+            const iterationId = options.iteration_id === undefined ? undefined : parseTaskId(options.iteration_id);
+            const userId = options.user_id === undefined ? undefined : options.user_id === '0' ? 0 : parseTaskId(options.user_id);
+            const page = options.page === undefined ? undefined : parseTaskId(options.page);
+            if (projectId === null) {
+                outputCliError('PARAM_INVALID', '--project_id must be a positive integer');
+                return;
+            }
+            if (iterationId === null) {
+                outputCliError('PARAM_INVALID', '--iteration_id must be a positive integer');
+                return;
+            }
+            if (userId === null) {
+                outputCliError('PARAM_INVALID', '--user_id must be a non-negative integer');
+                return;
+            }
+            if (page === null) {
+                outputCliError('PARAM_INVALID', '--page must be a positive integer');
+                return;
+            }
+            params = {
+                ...(projectId !== undefined ? { project_id: projectId } : {}),
+                ...(iterationId !== undefined ? { iteration_id: iterationId } : {}),
+                ...(userId !== undefined ? { user_id: userId } : {}),
+                ...(page !== undefined ? { page } : {}),
+            };
+        }
         else if (method === 'getAllActiveIterations' && options.project_id) {
             const projectId = parseTaskId(options.project_id);
             if (projectId === null) {
@@ -199,6 +227,7 @@ export function createKbAction(method) {
                 getTask: '--task_id',
                 createTask: '--title, --project_id, --owner_id and --category_id',
                 searchTasks: '--project_id and --query',
+                searchSubtasks: '--project_id, --iteration_id, --user_id, --page',
                 getAllActiveIterations: '--project_id',
                 getAllCategories: '--project_id',
                 getAllComments: '--task_id',

package/dist/commands/services/kb/index.js

@@ -60,6 +60,18 @@ const kbService = {
             .option('--user <user>', 'Specify user')
             .option('--gateway <url>', 'Override kanboard gateway')
             .action(createKbAction('searchTasks'));
+        // searchSubtasks 支持快捷参数 --project_id / --user_id / --page
+        cmd
+            .command('searchSubtasks')
+            .description(METHOD_DESCRIPTIONS.searchSubtasks)
+            .option('--params <json>', 'JSON/JSON5 params; CLI fills jsonrpc/method/id')
+            .option('--project_id <id>', 'Project ID (shortcut)')
+            .option('--iteration_id <id>', 'Iteration ID (shortcut)')
+            .option('--user_id <id>', 'User ID (shortcut)')
+            .option('--page <page>', 'Page number (shortcut)')
+            .option('--user <user>', 'Specify user')
+            .option('--gateway <url>', 'Override kanboard gateway')
+            .action(createKbAction('searchSubtasks'));
         // getAllActiveIterations 支持快捷参数 --project_id
         cmd
             .command('getAllActiveIterations')
@@ -103,6 +115,7 @@ const kbService = {
             item !== 'getTask' &&
             item !== 'createTask' &&
             item !== 'searchTasks' &&
+            item !== 'searchSubtasks' &&
             item !== 'getAllActiveIterations' &&
             item !== 'getAllCategories' &&
             item !== 'getAllComments' &&

package/dist/commands/services/kb/params.js

@@ -19,6 +19,12 @@ export const PARAM_DEFS = {
         { name: 'project_id', type: 'integer', required: true, description: '项目 ID。接口按项目检查查看权限。' },
         { name: 'query', type: 'string', required: true, description: 'Kanboard 搜索表达式，例如 iteration:456 status:1' },
     ],
+    searchSubtasks: [
+        { name: 'project_id', type: 'integer', required: false, description: '项目 ID。传入后仅返回该项目下的子任务，并按项目检查查看权限；不传时仅在当前用户有权限查看的启用项目中查找。' },
+        { name: 'iteration_id', type: 'integer', required: false, description: '迭代 ID。传入后仅返回所属需求在该迭代下的子任务；不传表示不限制迭代。' },
+        { name: 'user_id', type: 'integer', required: false, description: '处理人 ID。传入后仅返回该处理人的子任务；不传或传 0 表示不限制处理人。' },
+        { name: 'page', type: 'integer', required: false, description: '页码，从 1 开始，默认 1。每页固定最多 30 条，按页翻取。' },
+    ],
     getAllActiveIterations: [
         { name: 'project_id', type: 'integer', required: true, description: '项目 ID' },
     ],
@@ -90,4 +96,11 @@ export const PARAM_DEFS = {
     downloadTaskFile: [
         { name: 'file_id', type: 'integer', required: true, description: '需求附件 ID' },
     ],
+    moveTaskPosition: [
+        { name: 'project_id', type: 'integer', required: true, description: '项目 ID。必须是任务所属项目。' },
+        { name: 'task_id', type: 'integer', required: true, description: '需求/bug ID' },
+        { name: 'column_id', type: 'integer', required: false, description: '目标状态列 ID。未传时保留当前状态列' },
+        { name: 'position', type: 'integer', required: false, description: '目标列内排序位置，必须 >= 1。未传时保留当前排序值' },
+        { name: 'swimlane_id', type: 'integer', required: false, description: '目标泳道 ID。未传或传 0 保留当前泳道' },
+    ],
 };

package/dist/commands/services/kb/rpc.js

@@ -20,7 +20,7 @@ export async function jsonRpcCall(gateway, method, params, pat) {
         throwOnError: false,
     });
     // HTTP 层错误
-    if (result.error) {
+    if (!result.ok) {
         outputCliError('NETWORK_ERROR', result.error.message, {
             code: result.error.code,
             details: result.error.details,

package/dist/commands/services/kb/skill-metadata.d.ts

@@ -2,4 +2,5 @@ import type { Method } from './descriptions.js';
 export interface MethodSkillMetadata {
     notes?: string[];
 }
+export declare const METHOD_SHORTCUT_PARAMS: Partial<Record<Method, string[]>>;
 export declare const METHOD_SKILL_METADATA: Partial<Record<Method, MethodSkillMetadata>>;

package/dist/commands/services/kb/skill-metadata.js

@@ -1,3 +1,17 @@
+export const METHOD_SHORTCUT_PARAMS = {
+    getTask: ['task_id'],
+    createTask: ['title', 'project_id', 'owner_id', 'category_id'],
+    searchTasks: ['project_id', 'query'],
+    searchSubtasks: ['project_id', 'iteration_id', 'user_id', 'page'],
+    getAllActiveIterations: ['project_id'],
+    getAllCategories: ['project_id'],
+    getAllComments: ['task_id'],
+    createComment: ['task_id', 'user_id', 'content'],
+    createProjectFile: ['file', 'project_id'],
+    downloadProjectFile: ['project_id', 'file_id'],
+    createTaskFile: ['file', 'task_id', 'project_id'],
+    downloadTaskFile: ['file_id'],
+};
 export const METHOD_SKILL_METADATA = {
     downloadProjectFile: {
         notes: [

package/dist/core/http.d.ts

@@ -1,16 +1,19 @@
-export interface RequestResult<T> {
-    /** HTTP 状态码 */
+export interface RequestSuccessResult<T> {
+    ok: true;
     status: number;
-    /** 响应数据（成功时） */
-    data?: T;
-    /** 错误信息（失败时） */
-    error?: {
+    data: T;
+}
+export interface RequestErrorResult {
+    ok: false;
+    status: number;
+    error: {
         code: number;
         message: string;
         details?: unknown;
     };
 }
-export interface RequestOptionsWithThrow {
+export type RequestResult<T> = RequestSuccessResult<T> | RequestErrorResult;
+interface RequestOptionsBase {
     /** gateway 地址（必填） */
     gateway: string;
     /** 请求路径（不含域名） */
@@ -27,29 +30,15 @@ export interface RequestOptionsWithThrow {
     userAgent?: string;
     /** 最大重试次数，默认 3 */
     maxRetries?: number;
-    /** 错误时抛出异常而非直接退出，默认 true */
-    throwOnError?: true;
 }
-export interface RequestOptionsWithoutThrow {
-    /** gateway 地址（必填） */
-    gateway: string;
-    /** 请求路径（不含域名） */
-    path: string;
-    /** HTTP 方法，默认 GET */
-    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    /** URL query 参数 */
-    query?: Record<string, string | number | boolean>;
-    /** 请求体 */
-    body?: Record<string, unknown>;
-    /** 自定义 headers（会覆盖默认 headers） */
-    headers?: Record<string, string>;
-    /** User-Agent，默认 lxcli/版本号 */
-    userAgent?: string;
-    /** 最大重试次数，默认 3 */
-    maxRetries?: number;
+export type RequestOptionsWithThrow = RequestOptionsBase & {
+    /** 错误时调用 outputApiError 退出进程，默认 true */
+    throwOnError?: true;
+};
+export type RequestOptionsWithoutThrow = RequestOptionsBase & {
     /** 错误时返回 RequestResult 而非退出 */
     throwOnError: false;
-}
+};
 export type RequestOptions = RequestOptionsWithThrow | RequestOptionsWithoutThrow;
 /**
  * 通用请求函数
@@ -64,3 +53,4 @@ export type RequestOptions = RequestOptionsWithThrow | RequestOptionsWithoutThro
  */
 export declare function request<T>(options: RequestOptionsWithThrow): Promise<T>;
 export declare function request<T>(options: RequestOptionsWithoutThrow): Promise<RequestResult<T>>;
+export {};

package/dist/core/http.js

@@ -56,12 +56,16 @@ export async function request(options) {
     };
     const requestBody = body ? JSON.stringify(body) : undefined;
     let lastError = null;
-    // 辅助函数：处理错误响应
-    const makeErrorResult = (status, code, message, details) => {
+    // 辅助函数：构造错误结果
+    const errorResult = (status, code, message, details) => {
+        return { ok: false, status, error: { code, message, details } };
+    };
+    // 辅助函数：处理错误（throwOnError 时退出，否则返回错误结果）
+    const handleError = (result) => {
         if (throwOnError) {
-            outputApiError(code, message, details, status);
+            outputApiError(result.error.code, result.error.message, result.error.details, result.status);
         }
-        return { status, error: { code, message, details } };
+        return result;
     };
     // 发送请求（带重试）
     for (let attempt = 0; attempt < maxRetries; attempt++) {
@@ -92,32 +96,22 @@ export async function request(options) {
                     await sleep(delay);
                     continue;
                 }
-                const result = makeErrorResult(response.status, errorResponse?.error?.code || response.status, errorResponse?.error?.message || 'Request failed', errorResponse?.error?.details);
-                if (!throwOnError)
-                    return result;
-                // throwOnError 为 true 时 makeErrorResult 已经调用 outputApiError 退出了
+                return handleError(errorResult(response.status, errorResponse?.error?.code || response.status, errorResponse?.error?.message || 'Request failed', errorResponse?.error?.details));
             }
             let responseData;
             try {
                 responseData = parseJsonResponse(responseText);
             }
             catch {
-                const result = makeErrorResult(response.status, response.status, `Invalid JSON response: ${responseText}`);
-                if (!throwOnError)
-                    return result;
-                // throwOnError 为 true 时 makeErrorResult 已经调用 outputApiError 退出了
+                return handleError(errorResult(response.status, response.status, `Invalid JSON response: ${responseText}`));
             }
             logger.debug('Response', { status: response.status, data: responseData, attempt });
             if (!response.ok) {
-                const errorResponse = responseData;
-                const result = makeErrorResult(response.status, errorResponse?.error?.code || response.status, errorResponse?.error?.message || 'Request failed', errorResponse?.error?.details);
-                if (!throwOnError)
-                    return result;
-                // throwOnError 为 true 时 makeErrorResult 已经调用 outputApiError 退出了
+                const errResp = responseData;
+                return handleError(errorResult(response.status, errResp?.error?.code || response.status, errResp?.error?.message || 'Request failed', errResp?.error?.details));
             }
-            // throwOnError 为 false 时返回完整结果
             if (!throwOnError) {
-                return { status: response.status, data: responseData };
+                return { ok: true, status: response.status, data: responseData };
             }
             return responseData;
         }
@@ -136,9 +130,7 @@ export async function request(options) {
             }
             if (isNetworkError) {
                 logger.error('Request failed', error);
-                const result = makeErrorResult(500, 500, error.message);
-                if (!throwOnError)
-                    return result;
+                return handleError(errorResult(500, 500, error.message));
             }
             throw error;
         }
@@ -146,9 +138,7 @@ export async function request(options) {
     // 所有重试都失败了
     if (lastError) {
         logger.error('All retries failed', lastError);
-        const result = makeErrorResult(500, 500, lastError.message);
-        if (!throwOnError)
-            return result;
+        return handleError(errorResult(500, 500, lastError.message));
     }
     // 不应该到达这里，但 TypeScript 需要返回值
     throw new Error('Request failed after all retries');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meet-im/lxcli",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "连续科技命令行工具",
   "type": "module",
   "main": "dist/index.js",