从你的编辑器导出 .docx

npm i @tiptap-pro/extension-export-docx

import { ExportDocx } from '@tiptap-pro/extension-export-docx'

// 导入 ExportDocx 扩展
import { ExportDocx } from '@tiptap-pro/extension-export-docx'

const editor = new Editor({
  extensions: [
    // 其他扩展 ...
    ExportDocx.configure({
      onCompleteExport: (result: string | Buffer<ArrayBufferLike> | Blob | Stream) => void, // 必需
      exportType: 'blob', // 可选。默认值：'blob'
      customNodes: [], // 可选。默认值：[]
      styleOverrides: {}, // 可选。默认值：{}
      paragraphOverrides: {}, // 可选。默认值：{}
      textRunOverrides: {}, // 可选。默认值：{}
      tableOverrides: {}, // 可选。默认值：{}
      tableRowOverrides: {}, // 可选。默认值：{}
      tableCellOverrides: {}, // 可选。默认值：{}
      imageOverrides: {}, // 可选。默认值：{}
      numberingFormats: undefined, // 可选。默认值：undefined
      headerFooterOverrides: undefined, // 可选。默认值：undefined
      fonts: undefined, // 可选。默认值：undefined
      embedFonts: false, // 可选。默认值：false
      token: undefined, // 可选。默认值：undefined
      endpoint: undefined, // 可选。默认值：undefined
    }),
    // 其他扩展 ...
  ],
  // 其他编辑器设置 ...
})

/**
 * 将当前文档导出为 .docx 文件
 *
 * 注意：`buffer` 和 `stream` 导出类型仅在服务器环境中可用，
 * 因为它们分别使用 Node Buffer 和 Stream API
 *
 * @param onCompleteExport - 处理导出文件的回调函数
 * @param options - 导出选项
 * @param customNodes - 自定义节点定义，用于确保正确转换
 * @param styleOverrides - 应用于导出文档的自定义样式
 * @example editor.commands.exportDocx((result) => {}, { exportType: 'buffer' }, [])
 *
 */
exportDocx: (options?: ExportDocxOptions) =>
  Promise<string | Buffer<ArrayBufferLike> | Blob | Stream>

// 导入 ExportDocx 扩展
import { ExportDocx } from '@tiptap-pro/extension-export-docx'

// 设置你的编辑器
const editor = new Editor({
  extensions: [
    // 其他扩展 ...
    ExportDocx.configure({
      onCompleteExport: (result: string | Buffer<ArrayBufferLike> | Blob | Stream) => {}, // 必需
      exportType: 'blob', // 可选。默认值：'blob'
      customNodes: [], // 可选。默认值：[]
      styleOverrides: {}, // 可选。默认值：{}
      paragraphOverrides: {}, // 可选。默认值：{}
      textRunOverrides: {}, // 可选。默认值：{}
      tableOverrides: {}, // 可选。默认值：{}
      tableRowOverrides: {}, // 可选。默认值：{}
      tableCellOverrides: {}, // 可选。默认值：{}
      imageOverrides: {}, // 可选。默认值：{}
      headerFooterOverrides: undefined, // 可选。默认值：undefined
      fonts: undefined, // 可选。默认值：undefined
      embedFonts: false, // 可选。默认值：false
      token: undefined, // 可选。默认值：undefined
      endpoint: undefined, // 可选。默认值：undefined
    }),
    // 其他扩展 ...
  ],
  // 其他编辑器设置 ...
})

// 声明一些函数，它们将调用你编辑器中的 exportDocx 方法

function handleExportDocx() {
  // 调用你编辑器的 exportDocx 方法
  editor
    .chain()
    // 不带任何覆盖地调用方法
    // 它将采用 configure 方法中设置的配置
    .exportDocx()
    .run()
}

function handleExportDocxBuffer() {
  // 调用你编辑器的 exportDocx 方法
  editor
    .chain()
    // 带有一些覆盖地调用方法
    .exportDocx({
      // 覆盖 onCompleteExport 回调，以处理被覆盖后的导出类型
      onCompleteExport: (result: Buffer) => {
        // 以 buffer 格式处理导出的文件
      },
      // 覆盖导出类型
      exportType: 'Buffer',
    })
    .run()
}

// 在应用中的任意位置调用这些函数
handleExportDocx()
handleExportDocxBuffer()

/**
 * 将当前文档导出为 .docx 文件
 *
 * 注释：`buffer` 和 `stream` 导出类型仅在服务器环境中可用
 * 因为它们分别使用 Node 的 Buffer 和 Stream API
 *
 * @param options.document - 文档的 JSON 表示
 * @param options.exportType - 要执行的导出类型
 * @param options.customNodes - 自定义节点定义
 * @param options.styleOverrides - 导出文档的样式覆盖项
 * @param options.paragraphOverrides - 所有段落的基础默认值
 * @param options.textRunOverrides - 所有文本运行的基础默认值
 * @param options.tableOverrides - 表格级属性覆盖项
 * @param options.tableRowOverrides - 所有表格行的基础默认值
 * @param options.tableCellOverrides - 所有表格单元格的基础默认值
 * @param options.imageOverrides - 图像属性覆盖项
 * @example exportDocx({ document: editor.getJSON(), exportType: 'blob', customNodes: [], styleOverrides: {} })
 */
async function exportDocx({
  document,
  exportType,
  customNodes,
  styleOverrides,
  paragraphOverrides,
  textRunOverrides,
  tableOverrides,
  tableRowOverrides,
  tableCellOverrides,
  imageOverrides,
}: ExportDocxOptions) {}

import { exportDocx } from '@tiptap-pro/extension-export-docx'
import express from 'express'

const app = express()

app.post('/export-docx', async (req, res) => {
  try {
    // 从请求或数据库中获取 Tiptap JSON 内容
    const { content } = req.body

    // 将 Tiptap JSON 转换为 DOCX
    const docxBuffer = await exportDocx({ document: content })

    // 以可下载文件的形式发送
    res.setHeader(
      'Content-Type',
      'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
    )
    res.setHeader('Content-Disposition', 'attachment; filename="document.docx"')
    res.send(docxBuffer)
  } catch (error) {
    res.status(500).json({ error: error.message })
  }
})