worsoft-frontend-codegen-local-mcp 0.1.57 → 0.1.59

package/assets/templates/master_child_jump/api.tpl

@@ -45,3 +45,4 @@ export function putObj(obj?: object) {
     data: obj,
   });
 }
+{{EXTRA_API_FUNCTIONS}}

package/assets/templates/single_table_dialog/api.tpl

@@ -47,3 +47,4 @@ export function putObj(obj?: object) {
 }
 
 {{DICT_API_FUNCTIONS}}
+{{EXTRA_API_FUNCTIONS}}

package/assets/templates/single_table_jump/api.tpl

@@ -45,3 +45,4 @@ export function putObj(obj?: object) {
     data: obj,
   });
 }
+{{EXTRA_API_FUNCTIONS}}

package/mcp_server.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const path = require('path');
 
 const SERVER_NAME = 'worsoft-codegen-local';
-const SERVER_VERSION = '0.1.57';
+const SERVER_VERSION = '0.1.59';
 const PROTOCOL_VERSION = '2024-11-05';
 const TOOL_NAME = 'worsoft_codegen_local_generate_frontend';
 const STYLE_CATALOG_PATH = path.join(__dirname, 'assets', 'style-catalog.json');
@@ -312,11 +312,30 @@ const TOOL_SCHEMA = {
       type: 'string',
       description: 'Explicit relative api module path under src/api without extension, for example admin/iwmSysTrade. When provided, MCP writes the api file directly to this target path.',
     },
-    targetI18nKey: {
-      type: 'string',
-      description: 'Explicit zh-cn i18n namespace, for example admin.iwmSysTrade. When provided, MCP writes zh-cn content to the matching file path and namespace instead of deriving them from moduleName and functionName.',
-    },
-    writeToDisk: { type: 'boolean', default: true, description: 'Whether to write generated files.' },
+    targetI18nKey: {
+      type: 'string',
+      description: 'Explicit zh-cn i18n namespace, for example admin.iwmSysTrade. When provided, MCP writes zh-cn content to the matching file path and namespace instead of deriving them from moduleName and functionName.',
+    },
+    extraApis: {
+      type: 'array',
+      description: 'Additional API methods parsed from the API document and belonging to the current targetApiModule. Each method is rendered to api.ts with a purpose comment for later task-split usage.',
+      items: {
+        type: 'object',
+        properties: {
+          functionName: { type: 'string', description: 'Exported frontend API function name, for example getCurrentCountByTradeDictId.' },
+          description: { type: 'string', description: 'API purpose comment. It must exactly match the API document interface title text after removing the section number and "接口N：" prefix; do not summarize or rewrite it.' },
+          url: { type: 'string', description: 'Request URL. Absolute backend path is preferred, for example /admin/xxx/count.' },
+          method: { type: 'string', enum: ['get', 'post', 'put', 'delete'], description: 'HTTP method.' },
+          requestType: { type: 'string', enum: ['params', 'data'], description: 'Whether arguments are sent as query params or request body.' },
+          targetApiModule: { type: 'string', description: 'Optional target api module. If provided, it must equal the current targetApiModule.' },
+          source: { type: 'string', description: 'Source note from API doc or PRD.' },
+          usedBy: { type: 'string', description: 'Optional downstream usage hint for task-split.' },
+        },
+        required: ['functionName', 'description', 'url', 'method'],
+        additionalProperties: false,
+      },
+    },
+    writeToDisk: { type: 'boolean', default: true, description: 'Whether to write generated files.' },
     overwrite: { type: 'boolean', default: true, description: 'Whether to overwrite existing files. If false, existing files are skipped.' },
     writeSupportFiles: {
       type: 'boolean',
@@ -1398,15 +1417,78 @@ function hasRuntimeSupport(stylePreset) {
   return Boolean(stylePreset.runtime && stylePreset.runtime.supported && stylePreset.runtime.templateDir);
 }
 
-function normalizeFields(parsed) {
-  return parsed.fields.map((field) => ({ ...field, formType: field.formType || mapFieldType(field), isAudit: isAuditField(field.fieldName) }));
-}
-
-function ensureFieldExists(fields, fieldName, tableName, role) {
-  const field = fields.find((item) => item.fieldName === fieldName);
-  if (!field) throw new Error(role + ' field "' + fieldName + '" was not found on table ' + tableName);
-  return field;
-}
+function normalizeFields(parsed) {
+  return parsed.fields.map((field) => ({ ...field, formType: field.formType || mapFieldType(field), isAudit: isAuditField(field.fieldName) }));
+}
+
+function sanitizeIdentifier(value, label) {
+  const name = String(value || '').trim();
+  if (!/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name)) {
+    throw new Error(label + ' must be a valid JavaScript identifier');
+  }
+  return name;
+}
+
+function normalizeExtraApis(inputExtraApis, currentTargetApiModule) {
+  if (inputExtraApis === undefined || inputExtraApis === null) return [];
+  if (!Array.isArray(inputExtraApis)) {
+    throw new Error('extraApis must be an array');
+  }
+
+  const seen = new Set();
+  return inputExtraApis.map((item, index) => {
+    if (!item || typeof item !== 'object') {
+      throw new Error('extraApis[' + index + '] must be an object');
+    }
+    const functionName = sanitizeIdentifier(item.functionName, 'extraApis[' + index + '].functionName');
+    if (seen.has(functionName)) {
+      throw new Error('Duplicate extra API functionName found: ' + functionName);
+    }
+    seen.add(functionName);
+
+    const method = String(item.method || '').trim().toLowerCase();
+    if (!['get', 'post', 'put', 'delete'].includes(method)) {
+      throw new Error('extraApis[' + index + '].method must be one of get, post, put, delete');
+    }
+    const url = String(item.url || '').trim();
+    if (!url) {
+      throw new Error('extraApis[' + index + '].url is required');
+    }
+    const description = String(item.description || '').trim();
+    if (!description) {
+      throw new Error('extraApis[' + index + '].description is required');
+    }
+    const targetApiModule = item.targetApiModule ? normalizeModuleName(String(item.targetApiModule)) : '';
+    if (targetApiModule && currentTargetApiModule && targetApiModule !== currentTargetApiModule) {
+      throw new Error(
+        'extraApis[' +
+          index +
+          '].targetApiModule must equal current targetApiModule. Cross-module extra API generation is blocked to avoid overwriting other API files.'
+      );
+    }
+    const requestType = item.requestType ? String(item.requestType).trim() : method === 'get' || method === 'delete' ? 'params' : 'data';
+    if (!['params', 'data'].includes(requestType)) {
+      throw new Error('extraApis[' + index + '].requestType must be params or data');
+    }
+
+    return {
+      functionName,
+      description,
+      url: url.startsWith('/') ? url : '/' + url,
+      method,
+      requestType,
+      targetApiModule,
+      source: item.source ? String(item.source).trim() : '',
+      usedBy: item.usedBy ? String(item.usedBy).trim() : '',
+    };
+  });
+}
+
+function ensureFieldExists(fields, fieldName, tableName, role) {
+  const field = fields.find((item) => item.fieldName === fieldName);
+  if (!field) throw new Error(role + ' field "' + fieldName + '" was not found on table ' + tableName);
+  return field;
+}
 
 function detectStatusField(fields, explicitName) {
   if (explicitName) {
@@ -1518,9 +1600,10 @@ function buildMultiLevelDictModel(safeArgs) {
     targetI18nKey: resolvedTargets.targetI18nKey,
     frontendPath: normalizeFrontendRootPath(safeArgs.frontendPath),
     style: safeArgs.style,
-    levels: builtLevels,
-    modules: allModules,
-    dictTypes,
+    levels: builtLevels,
+    modules: allModules,
+    extraApis: normalizeExtraApis(safeArgs.extraApis, resolvedTargets.targetApiModule),
+    dictTypes,
     pk: parentModule.pk,
     fields: parentModule.fields,
     optionFields: parentModule.optionFields,
@@ -1591,11 +1674,11 @@ function buildModel(safeArgs) {
 
   const derivedFunctionName = toCamelCase(safeArgs.tableName);
   const apiPath = safeArgs.apiPath || derivedFunctionName;
-  const resolvedTargets = resolveGenerationTargets({
-    moduleName: safeArgs.moduleName,
-    functionName: derivedFunctionName,
-    apiPath,
-    targetViewDir: safeArgs.targetViewDir,
+  const resolvedTargets = resolveGenerationTargets({
+    moduleName: safeArgs.moduleName,
+    functionName: derivedFunctionName,
+    apiPath,
+    targetViewDir: safeArgs.targetViewDir,
     targetApiModule: safeArgs.targetApiModule,
     targetI18nKey: safeArgs.targetI18nKey,
   });
@@ -1622,9 +1705,10 @@ function buildModel(safeArgs) {
     dictTypes,
     frontendPath: normalizeFrontendRootPath(safeArgs.frontendPath),
     style: safeArgs.style,
+    extraApis: normalizeExtraApis(safeArgs.extraApis, resolvedTargets.targetApiModule),
     children,
   };
-}
+}
 
 function renderTemplate(templateText, replacements) {
   let output = templateText;
@@ -2228,9 +2312,10 @@ function renderMultiLevelApiTs(model) {
       "import request from '/@/utils/request';",
       '',
       model.modules.map(renderMultiLevelApiFunctions).join('\n\n'),
-      '',
-    ].join('\n');
-  }
+      renderExtraApiFunctions(model),
+      '',
+    ].join('\n');
+  }
 
 function renderMultiLevelFormField(field) {
   const labelExpr = `getFieldLabel('${field.attrName}')`;
@@ -2968,6 +3053,39 @@ function renderBusinessStatusHelpers(model) {
     ].join('\n');
   }
 
+function sanitizeComment(value) {
+  return String(value || '').replace(/\*\//g, '* /').replace(/\r?\n/g, ' ').trim();
+}
+
+function renderExtraApiFunctions(model) {
+  if (!Array.isArray(model.extraApis) || !model.extraApis.length) return '';
+  return model.extraApis
+    .map((api) => {
+      const requestField = api.requestType === 'data' ? 'data' : 'params';
+      const lines = [
+        '',
+        `// 额外接口：${sanitizeComment(api.description)}`,
+      ];
+      if (api.usedBy) {
+        lines.push(`// 使用场景：${sanitizeComment(api.usedBy)}`);
+      }
+      if (api.source) {
+        lines.push(`// 来源说明：${sanitizeComment(api.source)}`);
+      }
+      lines.push(
+        `export function ${api.functionName}(payload?: any) {`,
+        '  return request({',
+        `    url: '${api.url}',`,
+        `    method: '${api.method}',`,
+        `    ${requestField}: payload,`,
+        '  });',
+        '}'
+      );
+      return lines.join('\n');
+    })
+    .join('\n');
+}
+
 function buildReplacements(model, sharedSupport) {
   const menuBaseId = Date.now();
   const apiModulePath = model.targetApiModule || `${model.moduleName}/${model.functionName}`;
@@ -2998,6 +3116,7 @@ function buildReplacements(model, sharedSupport) {
     BUSINESS_STATUS_IMPORTS: renderBusinessStatusImports(model),
     BUSINESS_EDIT_IF: hasBusinessBillStateEditControl(model) ? ' v-if="showEditAction(row)"' : '',
     BUSINESS_STATUS_HELPERS: renderBusinessStatusHelpers(model),
+    EXTRA_API_FUNCTIONS: renderExtraApiFunctions(model),
     CUSTOM_QUERY_FIELDS_EXPR: model.pageType === 'dict' ? '[]' : 'queryableDictOptions.value',
     SHOW_RIGHT_TOOLS: model.pageType === 'dict' ? 'false' : 'true',
     MENU_BASE_ID: menuBaseId,
@@ -3097,8 +3216,9 @@ function ensureArguments(input) {
     moduleName: input.moduleName ? String(input.moduleName) : 'admin/test',
     targetViewDir: input.targetViewDir ? String(input.targetViewDir) : '',
     targetApiModule: input.targetApiModule ? String(input.targetApiModule) : '',
-    targetI18nKey: input.targetI18nKey ? String(input.targetI18nKey) : '',
-    writeToDisk: input.writeToDisk === undefined ? true : Boolean(input.writeToDisk),
+    targetI18nKey: input.targetI18nKey ? String(input.targetI18nKey) : '',
+    extraApis: input.extraApis === undefined ? [] : input.extraApis,
+    writeToDisk: input.writeToDisk === undefined ? true : Boolean(input.writeToDisk),
     overwrite: input.overwrite === undefined ? true : Boolean(input.overwrite),
     writeSupportFiles: input.writeSupportFiles === undefined ? true : Boolean(input.writeSupportFiles),
     mergeI18nZh: input.mergeI18nZh === undefined ? true : Boolean(input.mergeI18nZh),
@@ -3163,11 +3283,12 @@ function buildManifest(model, safeArgs, stylePreset, files, note) {
               disableApi: buildApiRoutePath(model.moduleName, moduleModel.disableApi).replace(/^\/+/, ''),
           })),
         })),
-      summary: {
-        totalLevels: model.levels.length,
-        totalModules: model.modules.length,
-        dictFields: model.modules.flatMap((moduleModel) => moduleModel.optionFields.filter((field) => field.dictType).map((field) => `${moduleModel.key}.${field.attrName}`)),
-      },
+      summary: {
+        totalLevels: model.levels.length,
+        totalModules: model.modules.length,
+        extraApis: model.extraApis.map((api) => ({ functionName: api.functionName, description: api.description, url: api.url, method: api.method })),
+        dictFields: model.modules.flatMap((moduleModel) => moduleModel.optionFields.filter((field) => field.dictType).map((field) => `${moduleModel.key}.${field.attrName}`)),
+      },
       note,
     };
   }
@@ -3228,8 +3349,9 @@ function buildManifest(model, safeArgs, stylePreset, files, note) {
       listVisibleFields: model.listFields.length,
       dictFields: model.optionFields.filter((field) => field.dictType).map((field) => field.attrName),
       skippedAuditFields: model.fields.filter((field) => field.isAudit).map((field) => field.fieldName),
-      childCount: model.children.length,
-      childTables: model.children.map((childModel) => childModel.tableName),
+      childCount: model.children.length,
+      extraApis: model.extraApis.map((api) => ({ functionName: api.functionName, description: api.description, url: api.url, method: api.method })),
+      childTables: model.children.map((childModel) => childModel.tableName),
       childPayloadFields: model.children.map((childModel) => ({ childTableName: childModel.tableName, payloadField: childModel.payloadField || childModel.listName })),
       childVisibleFields: model.children.reduce((sum, childModel) => sum + childModel.visibleFields.length, 0),
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "worsoft-frontend-codegen-local-mcp",
-  "version": "0.1.57",
+  "version": "0.1.59",
   "description": "Worsoft frontend local-template code generation MCP server.",
   "license": "UNLICENSED",
   "author": "worsoft <sw@worsoft.vip>",