feat: Add filename parameter to markdownTransform tool (#316)

Author: FinleyGe

modules/tool/packages/markdownTransform/bun.lock

@@ -1,5 +1,6 @@
 {
   "lockfileVersion": 1,
+  "configVersion": 0,
   "workspaces": {
     "": {
       "name": "fastgpt-tools-markdownTransform",

modules/tool/packages/markdownTransform/config.ts

@@ -13,6 +13,51 @@ export default defineTool({
     en: 'Convert Markdown to specified format file, return the file link please download it in time.'
   },
   versionList: [
+    {
+      value: '0.2.0',
+      description: '支持自定义文件名',
+      inputs: [
+        {
+          key: 'markdown',
+          label: 'Markdown 内容',
+          description: '要转换的 Markdown 内容',
+          toolDescription: '要转换的 Markdown 内容',
+          required: true,
+          renderTypeList: [FlowNodeInputTypeEnum.input, FlowNodeInputTypeEnum.reference],
+          valueType: WorkflowIOValueTypeEnum.string
+        },
+        {
+          key: 'format',
+          label: '转换格式',
+          description: '需要转换的格式，支持 xlsx 和 docx 和 pptx',
+          toolDescription: '需要转换的格式，支持 xlsx 和 docx 和 pptx',
+          required: true,
+          renderTypeList: [FlowNodeInputTypeEnum.select, FlowNodeInputTypeEnum.reference],
+          valueType: WorkflowIOValueTypeEnum.string,
+          list: [
+            { label: 'xlsx', value: 'xlsx' },
+            { label: 'docx', value: 'docx' },
+            { label: 'pptx', value: 'pptx' }
+          ]
+        },
+        {
+          key: 'filename',
+          label: '文件名',
+          description: '自定义文件名（不包含扩展名）',
+          toolDescription: '自定义文件名（不包含扩展名）',
+          required: false,
+          renderTypeList: [FlowNodeInputTypeEnum.input, FlowNodeInputTypeEnum.reference],
+          valueType: WorkflowIOValueTypeEnum.string
+        }
+      ],
+      outputs: [
+        {
+          valueType: WorkflowIOValueTypeEnum.string,
+          key: 'url',
+          label: '文件链接'
+        }
+      ]
+    },
     {
       value: '0.1.0',
       description: 'Default version',

modules/tool/packages/markdownTransform/src/docx.ts

@@ -23,7 +23,8 @@ import {
 } from './shared';
 
 export const InputType = z.object({
-  markdown: z.string().describe('Markdown content to convert')
+  markdown: z.string().describe('Markdown content to convert'),
+  filename: z.string().optional().describe('Custom filename without extension')
 });
 
 function createTextRun(
@@ -361,7 +362,8 @@ async function parseMarkdownToParagraphs(markdown: string): Promise<(Paragraph |
 }
 
 export async function docxTool({
-  markdown
+  markdown,
+  filename
 }: z.infer<typeof InputType>): Promise<z.infer<typeof OutputType>> {
   const elements = await parseMarkdownToParagraphs(markdown);
 
@@ -375,12 +377,12 @@ export async function docxTool({
   });
 
   const docBuffer = await Packer.toBuffer(doc);
-  const filename = `markdown-to-docx.docx`;
+  const finalFilename = filename ? `${filename}.docx` : `markdown-to-docx.docx`;
   const buf = Buffer.from(new Uint8Array(docBuffer));
 
   const result = await uploadFile({
     buffer: buf,
-    defaultFilename: filename
+    defaultFilename: finalFilename
   });
 
   if (!result.accessUrl) {

modules/tool/packages/markdownTransform/src/index.ts

@@ -6,21 +6,23 @@ import { OutputType } from './type';
 
 export const InputType = z.object({
   format: z.enum(['xlsx', 'docx', 'pptx']),
-  markdown: z.string()
+  markdown: z.string(),
+  filename: z.string().optional()
 });
 
 export async function tool({
   format,
-  markdown
+  markdown,
+  filename
 }: z.infer<typeof InputType>): Promise<z.infer<typeof OutputType>> {
   if (format === 'xlsx') {
-    return xlsxTool({ markdown });
+    return xlsxTool({ markdown, filename });
   }
   if (format === 'docx') {
-    return docxTool({ markdown });
+    return docxTool({ markdown, filename });
   }
   if (format === 'pptx') {
-    return pptxTool({ markdown });
+    return pptxTool({ markdown, filename });
   }
   return Promise.reject('Invalid format');
 }

modules/tool/packages/markdownTransform/src/pptx.ts

@@ -11,7 +11,8 @@ import {
 } from './shared';
 
 export const InputType = z.object({
-  markdown: z.string().describe('Markdown content to convert')
+  markdown: z.string().describe('Markdown content to convert'),
+  filename: z.string().optional().describe('Custom filename without extension')
 });
 
 // slide styles config
@@ -444,12 +445,12 @@ async function parseMarkdownToPptx(markdown: string): Promise<Buffer> {
 export async function pptxTool(
   input: z.infer<typeof InputType>
 ): Promise<z.infer<typeof OutputType>> {
-  const { markdown } = input;
+  const { markdown, filename } = input;
   const pptxBuffer = await parseMarkdownToPptx(markdown);
-  const filename = `markdown-to-pptx.pptx`;
+  const finalFilename = filename ? `${filename}.pptx` : `markdown-to-pptx.pptx`;
   const result = await uploadFile({
     buffer: pptxBuffer,
-    defaultFilename: filename
+    defaultFilename: finalFilename
   });
   if (!result.accessUrl) {
     return Promise.reject('Upload failed: No access URL in result');

modules/tool/packages/markdownTransform/src/xlsx.ts

@@ -20,7 +20,8 @@ function getExcelImageExtension(url: string): 'png' | 'jpeg' | 'gif' {
 }
 
 export const InputType = z.object({
-  markdown: z.string().describe('Markdown content to convert')
+  markdown: z.string().describe('Markdown content to convert'),
+  filename: z.string().optional().describe('Custom filename without extension')
 });
 
 async function processLineWithImages(
@@ -331,12 +332,13 @@ async function createExcelFromMarkdown(markdown: string): Promise<Buffer> {
 export async function xlsxTool(
   input: z.infer<typeof InputType>
 ): Promise<z.infer<typeof OutputType>> {
-  const { markdown } = input;
+  const { markdown, filename } = input;
   try {
     const xlsxBuffer = await createExcelFromMarkdown(markdown);
+    const finalFilename = filename ? `${filename}.xlsx` : `markdown-to-excel.xlsx`;
     const result = await uploadFile({
       buffer: xlsxBuffer,
-      defaultFilename: `markdown-to-excel.xlsx`
+      defaultFilename: finalFilename
     });
 
     return { url: result.accessUrl };