@cnbcool/cnb-api-generate 2.7.3 → 2.7.5

package/built/utils/flatten-tool-options.js

@@ -84,9 +84,12 @@ function flattenToolOptions(toolInfo) {
                 ? (0, clean_array_desc_1.cleanArrayDesc)((0, trim_summary_1.trimSummary)(prop.description || ''))
                 : (0, trim_summary_1.trimSummary)(prop.description || '');
             const arrayHint = isArray ? ' (可多次传入)' : '';
+            const fileRefHint = !isArray && prop.type === 'string' && key === 'body'
+                ? ' (支持 @file 引用)'
+                : '';
             const desc = isRequired
-                ? `[必填] ${rawDesc}${arrayHint}`
-                : `${rawDesc}${arrayHint}`;
+                ? `[必填] ${rawDesc}${arrayHint}${fileRefHint}`
+                : `${rawDesc}${arrayHint}${fileRefHint}`;
             const opt = {
                 optKey,
                 valuePlaceholder,

package/client/lib/build-tool-params.ts

@@ -0,0 +1,62 @@
+import { getToolParamDefs } from './format-params';
+
+/**
+ * 根据 formatParams 的产物构造调用 toolFunction 的位置参数列表。
+ *
+ * 关键约定（与代码生成器 generate-function-params-ast-node.ts 编译期一致）：
+ *   - swagger pathParams.length > 1 || queryParams.length > 0  → 第 1 形参是对象
+ *     `{ ...path, ...query }`
+ *   - 否则                                                     → 第 1 形参是标量（path 字段值），
+ *     或没有第 1 形参（pathParams.length === 0）
+ *
+ * 这是编译期 swagger 决定的形态，**与运行期 query 是否传值无关**。
+ * 例：`GET /{repo}/-/issues?state=open` 即便用户没传 --state，toolFunction
+ * 仍期望 `{ repo, state? }` 对象，绝不能把 path 拆成标量。
+ *
+ * 历史 bug：误把单 path 的 tool 包成对象传入，模板字符串 `${对象}` 渲染成
+ * `[object Object]`，URL encode 后变 `[object%20Object]`，触发 404。
+ */
+export function buildToolParams(formattedParams: {
+  module?: string;
+  tool?: string;
+  path?: Record<string, any>;
+  query?: Record<string, any>;
+  data?: any;
+}): any[] {
+  const { module: moduleName, tool, path, query, data } = formattedParams;
+  const queryHasValue =
+    !!query && typeof query === 'object' && Object.keys(query).length > 0;
+
+  // 1) 决定第 1 形参形态。优先用 swagger 定义；拿不到时按运行期信号兜底（旧行为）。
+  let isObjectShape: boolean;
+  const defs = moduleName && tool ? getToolParamDefs(moduleName, tool) : null;
+  if (defs) {
+    const pathDefCount = defs.path ? Object.keys(defs.path).length : 0;
+    const queryDefCount = defs.query ? Object.keys(defs.query).length : 0;
+    isObjectShape = pathDefCount > 1 || queryDefCount > 0;
+  } else {
+    // 兜底：path 多于 1 个、或运行期 query 真有值，则按对象形态合并
+    const pathKeyCount = path ? Object.keys(path).length : 0;
+    isObjectShape = pathKeyCount > 1 || queryHasValue;
+  }
+
+  // 2) 按形态构造第 1 个参数
+  let firstParam: Record<string, any> | string | null = null;
+  if (isObjectShape) {
+    // 对象形态：合并 path 与运行期 query；任一为空都允许，toolFunction 内部解构是可选的
+    if (path || queryHasValue) {
+      firstParam = { ...(path ?? {}), ...(query ?? {}) };
+    }
+  } else if (path) {
+    // 标量形态：仅当 path 恰好 1 个字段时拆出值；其它情形（含异常的多字段）不构造，
+    // 避免悄悄把不该传的字段塞给 toolFunction
+    const keys = Object.keys(path);
+    if (keys.length === 1) firstParam = path[keys[0]];
+  }
+
+  // 3) 组装最终位置参数列表（与历史行为一致：firstParam 真值才 push；data 真值才 push）
+  const toolsParam: any[] = [];
+  if (firstParam) toolsParam.push(firstParam);
+  if (data) toolsParam.push(data);
+  return toolsParam;
+}

package/client/lib/execute-action.ts

@@ -5,6 +5,7 @@ import { diagnoseBuild } from './build-diagnostics';
 import { analyzeBuildTiming } from './build-timing';
 import { formatParams } from './format-params';
 import { formatOutput } from './format-output';
+import { buildToolParams } from './build-tool-params';
 // @ts-ignore
 import {getLoader} from '../../loader';
 /**
@@ -116,38 +117,7 @@ export async function executeAction(
 
   const toolFunction = loadToolFunction(formattedParams.module, formattedParams.tool);
 
-  const toolsParam: any[] = [];
-  let pathAndQueryParams: Record<string, any> | string | null = null;
-
-  if (
-    formattedParams.path &&
-    Object.keys(formattedParams.path).length === 1 &&
-    !formattedParams.query
-  ) {
-    pathAndQueryParams =
-      formattedParams.path[Object.keys(formattedParams.path)[0]];
-  } else {
-    if (formattedParams.path) {
-      pathAndQueryParams = { ...formattedParams.path };
-    }
-
-    if (formattedParams.query) {
-      pathAndQueryParams = {
-        ...(pathAndQueryParams && typeof pathAndQueryParams === 'object'
-          ? pathAndQueryParams
-          : {}),
-        ...formattedParams.query,
-      };
-    }
-  }
-
-  if (pathAndQueryParams) {
-    toolsParam.push(pathAndQueryParams);
-  }
-
-  if (formattedParams.data) {
-    toolsParam.push(formattedParams.data);
-  }
+  const toolsParam = buildToolParams(formattedParams);
   const data = await toolFunction(...toolsParam);
 
   const toolKey = `${formattedParams.module}/${formattedParams.tool}`;

package/client/lib/format-params.ts

@@ -51,6 +51,32 @@ export function formatParams(
       'module', 'tool', 'help', 'short', 'verbose', 'h', 'v',
     ]);
 
+    // --data 是 CLI 通用 fallback 选项（见 flatten-tool-options.ts，仅在 tool 有 body 时注册），
+    // 接收 JSON 字符串（或 @file 引用）作为 body 整体。
+    // 仅当 'data' 不是该 tool 真实的 path/query/body 字段名时才启用 fallback 语义，
+    // 否则按 swagger 定义当业务字段处理（保留 commit 120d557 引入的能力）。
+    //
+    // 与 swagger body schema 类型对齐：
+    //   - object body（默认）：parsed 必须是 object，作为 body base，逐个 body flag（如 --event）覆盖同名字段
+    //   - array body（如 BatchPinDashboardStar）：parsed 必须是 array，直接整体替换 body
+    //   类型不匹配（如 object body 接口收到 array）静默忽略，避免破坏 flag 已写入的字段
+    const dataIsFallback =
+      !!paramDefs.body && !pathDef.data && !queryDef.data && !bodyProps.data;
+    const bodyIsArrayType = paramDefs.body?.schema?.type === 'array';
+    let dataBaseFromFlag: Record<string, any> | undefined;
+    let dataArrayFromFlag: any[] | undefined;
+    if (dataIsFallback) {
+      reservedKeys.add('data');
+      if (typeof params.data === 'string' && params.data.length > 0) {
+        const parsed = tryParseJSON(tryReadFileRef(params.data));
+        if (bodyIsArrayType && Array.isArray(parsed)) {
+          dataArrayFromFlag = parsed;
+        } else if (!bodyIsArrayType && parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
+          dataBaseFromFlag = parsed as Record<string, any>;
+        }
+      }
+    }
+
     // 收集 array<object> 展开字段的临时存储：{ arrayName: { propName: string[] } }
     const arrayObjectCollector: Record<string, Record<string, string[]>> = {};
 
@@ -252,18 +278,19 @@ export function formatParams(
       if (!formatted.data) formatted.data = {};
       formatted.data[objectKey] = subProps;
     }
-  }
 
-  // 当没有传递 query 时，要判断当前 tool 是否支持 query
-  if (formatted.query === undefined) {
-    const paramDefs2 = getToolParamDefs(
-      formatted.module,
-      formatted.tool,
-    );
-    if (paramDefs2?.query) {
-      formatted.query = {};
+    // 合并 --data 提供的 body：
+    //   - 数组 body：整体替换 formatted.data（数组 body 接口没有逐字段 flag，直接覆盖）
+    //   - 对象 body：作为 base，逐个 body flag（如 --event）已写入 formatted.data，flag 优先
+    if (dataArrayFromFlag) {
+      formatted.data = dataArrayFromFlag;
+    } else if (dataBaseFromFlag) {
+      formatted.data = { ...dataBaseFromFlag, ...(formatted.data || {}) };
     }
   }
 
+  // formatted.query 仅在用户真传了 query 值时才存在；toolFunction 第 1 形参形态
+  // 由 buildToolParams 通过 swagger 定义判定，不依赖运行期 query 是否有值。
+
   return formatted;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cnbcool/cnb-api-generate",
-  "version": "2.7.3",
+  "version": "2.7.5",
   "main": "./built/index.js",
   "module": "./src/index.ts",
   "types": "./src/index.ts",