@things-factory/integration-headless 7.0.48 → 7.0.53

package/server/engine/task/headless-pdf-capture.ts

@@ -1,250 +1,36 @@
-import * as ejs from 'ejs'
 import { TaskRegistry } from '@things-factory/integration-base'
-import { ConnectionManager } from '@things-factory/integration-base'
 import { access } from '@things-factory/utils'
-import { PDFDocument } from 'pdf-lib'
 
-async function HeadlessPDFCapture(step, context) {
-  var { connection: connectionName, params: stepOptions } = step
-  var {
-    accessor,
-    htmlContent,
-    format,
-    width,
-    height,
-    marginTop,
-    marginBottom,
-    marginLeft,
-    marginRight,
-    scale,
-    printBackground,
-    landscape,
-    preferCSSPageSize
-  } = stepOptions || {}
-  var { domain, data, logger, __headless_pdf } = context
+import { PDFCaptureUtil, getCommonParameterSpec } from './pdf-capture-util'
 
-  if (!__headless_pdf) {
-    throw new Error('It requires headless-pdf-open to be performed first')
-  }
-
-  var { pdfDoc, header, footer, watermark } = __headless_pdf
-
-  var headlessPool = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-  let browser
+export async function HeadlessPDFCapture(step, context) {
+  const pdfUtil = new PDFCaptureUtil(context)
+  await pdfUtil.initBrowser(step.connection)
 
   try {
-    browser = await headlessPool.acquire()
-    const page = await browser.newPage()
-
-    const templateInput = access(accessor, data)
-
-    const renderTemplateSafely = (template, data) => {
-      try {
-        return ejs.render(template, data)
-      } catch (error) {
-        logger.warn(`Template rendering error: ${error.message}`)
-        return template
-      }
-    }
-
-    const renderedHtmlContent = renderTemplateSafely(htmlContent, templateInput)
-    await page.setContent(renderedHtmlContent)
-
-    header = renderTemplateSafely(header, __headless_pdf)
-    footer = renderTemplateSafely(footer, __headless_pdf)
-
-    // Apply header, footer, and watermark using Puppeteer
-    if (header || footer || watermark) {
-      await page.evaluate(
-        ({ header, footer, watermark, isLandscape }) => {
-          const setPositioning = (element, position) => {
-            element.style.position = 'fixed'
-            element.style.left = '0'
-            element.style.width = '100%'
-            element.style.textAlign = 'center'
-            element.style.fontSize = '12px'
-            element.style.margin = '0'
-            element.style.padding = '0'
-            if (position === 'header') {
-              element.style.top = '0'
-            } else if (position === 'footer') {
-              element.style.bottom = '0'
-            }
-          }
-
-          if (header) {
-            const headerElement = document.createElement('div')
-            headerElement.innerHTML = header
-            setPositioning(headerElement, 'header')
-            document.body.appendChild(headerElement)
-          }
-
-          if (footer) {
-            const footerElement = document.createElement('div')
-            footerElement.innerHTML = footer
-            setPositioning(footerElement, 'footer')
-            document.body.appendChild(footerElement)
-          }
-
-          if (watermark) {
-            const watermarkElement = document.createElement('div')
-            watermarkElement.innerHTML = watermark
-            watermarkElement.style.position = 'fixed'
-            watermarkElement.style.top = isLandscape ? '40%' : '50%'
-            watermarkElement.style.left = '50%'
-            watermarkElement.style.transform = 'translate(-50%, -50%) rotate(-45deg)'
-            watermarkElement.style.opacity = '0.2'
-            watermarkElement.style.fontSize = '50px'
-            watermarkElement.style.color = 'red'
-            watermarkElement.style.pointerEvents = 'none'
-            watermarkElement.style.zIndex = '9999'
-            document.body.appendChild(watermarkElement)
-          }
-        },
-        { header, footer, watermark, isLandscape: landscape }
-      )
-    }
-
-    if (preferCSSPageSize) {
-      width = undefined
-      height = undefined
-    }
-
-    const pageOptions = {
-      format,
-      width,
-      height,
-      margin: {
-        top: marginTop,
-        right: marginRight,
-        bottom: marginBottom,
-        left: marginLeft
-      },
-      scale,
-      printBackground,
-      landscape,
-      displayHeaderFooter: false, // Handled via Puppeteer directly
-      preferCSSPageSize
-    }
+    const { accessor, htmlContent } = step.params
+    const templateInput = access(accessor, context.data)
 
-    const contentBuffer = await page.pdf(pageOptions)
-    const contentPdfDoc = await PDFDocument.load(contentBuffer)
-    const copiedPages = await pdfDoc.copyPages(contentPdfDoc, contentPdfDoc.getPageIndices())
+    const renderedHtmlContent = pdfUtil.renderTemplate(htmlContent, templateInput)
 
-    copiedPages.forEach(page => pdfDoc.addPage(page))
-
-    __headless_pdf.pageCount += copiedPages.length
-
-    await page.close()
-    headlessPool.release(browser)
+    await pdfUtil.processPageAndGeneratePDF(step.params, renderedHtmlContent)
 
     return {
-      data: __headless_pdf
+      data: context.__headless_pdf
     }
   } catch (error) {
-    if (browser) {
-      await browser.close()
-    }
-
     throw error
+  } finally {
+    await pdfUtil.closeBrowser()
   }
 }
 
 HeadlessPDFCapture.parameterSpec = [
-  {
-    type: 'scenario-step-input',
-    name: 'accessor',
-    label: 'accessor'
-  },
+  ...getCommonParameterSpec(),
   {
     type: 'textarea',
     name: 'htmlContent',
     label: 'html-content'
-  },
-  {
-    type: 'select',
-    name: 'format',
-    label: 'page-format',
-    property: {
-      options: [
-        { display: '', value: '' },
-        { display: 'A4', value: 'A4' },
-        { display: 'A3', value: 'A3' },
-        { display: 'Letter', value: 'Letter' },
-        { display: 'Legal', value: 'Legal' }
-      ]
-    },
-    description: 'Select the paper format for the PDF'
-  },
-  {
-    type: 'string',
-    name: 'width',
-    label: 'page-width',
-    placeholder: '(e.g., "8.5in", "21cm", "600px")',
-    description: 'Specify the width of the page (e.g., "8.5in", "21cm", "600px")'
-  },
-  {
-    type: 'string',
-    name: 'height',
-    label: 'page-height',
-    placeholder: '(e.g., "11in", "29.7cm", "800px")',
-    description: 'Specify the height of the page (e.g., "11in", "29.7cm", "800px")'
-  },
-  {
-    type: 'string',
-    name: 'marginTop',
-    label: 'page-margin-top',
-    placeholder: '(e.g., "0.5in", "1cm", "100px")',
-    description: 'Set the top margin for the page'
-  },
-  {
-    type: 'string',
-    name: 'marginBottom',
-    label: 'page-margin-bottom',
-    placeholder: '(e.g., "0.5in", "1cm", "100px")',
-    description: 'Set the bottom margin for the page'
-  },
-  {
-    type: 'string',
-    name: 'marginLeft',
-    label: 'page-margin-left',
-    placeholder: '(e.g., "0.5in", "1cm", "100px")',
-    description: 'Set the left margin for the page'
-  },
-  {
-    type: 'string',
-    name: 'marginRight',
-    label: 'page-margin-right',
-    placeholder: '(e.g., "0.5in", "1cm", "100px")',
-    description: 'Set the right margin for the page'
-  },
-  {
-    type: 'number',
-    name: 'scale',
-    label: 'page-scale',
-    defaultValue: 1,
-    description: 'Set the scale of the page content (default is 1)'
-  },
-  {
-    type: 'boolean',
-    name: 'printBackground',
-    label: 'print-background',
-    defaultValue: true,
-    description: 'Include background graphics when printing the page'
-  },
-  {
-    type: 'boolean',
-    name: 'landscape',
-    label: 'landscape',
-    defaultValue: false,
-    description: 'Print the PDF in landscape orientation'
-  },
-  {
-    type: 'boolean',
-    name: 'preferCSSPageSize',
-    label: 'prefer-css-page-size',
-    defaultValue: false,
-    description: 'Whether to prefer the CSS-defined page size over the given width and height'
   }
 ]
 

package/server/engine/task/index.ts

@@ -1,4 +1,5 @@
 import './headless-pdf-capture'
+import './headless-pdf-capture-markdown'
 import './headless-pdf-capture-board'
 import './headless-pdf-open'
 import './headless-pdf-save'

package/server/engine/task/pdf-capture-util.ts

@@ -0,0 +1,276 @@
+import * as ejs from 'ejs'
+import { ConnectionManager } from '@things-factory/integration-base'
+import { PDFDocument } from 'pdf-lib'
+import { Browser, Page } from 'puppeteer'
+import { Logger } from 'winston'
+
+interface StepOptions {
+  format?: string
+  width?: string
+  height?: string
+  marginTop?: string
+  marginBottom?: string
+  marginLeft?: string
+  marginRight?: string
+  scale?: number
+  printBackground?: boolean
+  landscape?: boolean
+  preferCSSPageSize?: boolean
+}
+
+interface PDFContext {
+  domain: any
+  data: any
+  logger: Logger
+  __headless_pdf: any
+}
+
+export class PDFCaptureUtil {
+  private context: PDFContext
+  private headlessPool: any
+
+  public browser: Browser | null = null
+
+  constructor(context: PDFContext) {
+    this.context = context
+  }
+
+  async initBrowser(connectionName: string) {
+    const { domain } = this.context
+    this.headlessPool = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
+    this.browser = await this.headlessPool.acquire()
+  }
+
+  async closeBrowser() {
+    if (this.browser) {
+      await this.browser.close()
+      this.headlessPool.release(this.browser)
+    }
+  }
+
+  renderTemplate(template: string, data: any): string {
+    const { logger } = this.context
+    try {
+      return ejs.render(template, data)
+    } catch (error) {
+      logger.warn(`Template rendering error: ${error.message}`)
+      return template
+    }
+  }
+
+  async generatePDFContent(page: Page, htmlContent: string, pageOptions: any): Promise<PDFDocument> {
+    await page.setContent(htmlContent)
+    const contentBuffer = await page.pdf(pageOptions)
+    const contentPdfDoc = await PDFDocument.load(contentBuffer)
+    return contentPdfDoc
+  }
+
+  async appendPDFContentToDocument(pdfDoc: PDFDocument, contentPdfDoc: PDFDocument) {
+    const copiedPages = await pdfDoc.copyPages(contentPdfDoc, contentPdfDoc.getPageIndices())
+    copiedPages.forEach(page => pdfDoc.addPage(page))
+    this.context.__headless_pdf.pageCount += copiedPages.length
+  }
+
+  async processPageAndGeneratePDF(stepOptions: StepOptions, htmlContent: string) {
+    if (!this.browser) throw new Error('Browser not initialized. Call initBrowser() first.')
+
+    const page = await this.browser.newPage()
+
+    const { __headless_pdf } = this.context
+    const { header, footer, watermark, landscape } = __headless_pdf
+
+    if (header || footer || watermark) {
+      await this.applyHeaderFooterWatermark(page, { header, footer, watermark, landscape })
+    }
+
+    const pageOptions = this.buildPageOptions(stepOptions)
+    const contentPdfDoc = await this.generatePDFContent(page, htmlContent, pageOptions)
+    await this.appendPDFContentToDocument(__headless_pdf.pdfDoc, contentPdfDoc)
+    await page.close()
+  }
+
+  buildPageOptions({
+    format,
+    width,
+    height,
+    marginTop,
+    marginBottom,
+    marginLeft,
+    marginRight,
+    scale,
+    printBackground,
+    landscape,
+    preferCSSPageSize
+  }: StepOptions): any {
+    if (preferCSSPageSize) {
+      width = undefined
+      height = undefined
+    }
+
+    return {
+      format,
+      width,
+      height,
+      margin: {
+        top: marginTop,
+        right: marginRight,
+        bottom: marginBottom,
+        left: marginLeft
+      },
+      scale,
+      printBackground,
+      landscape,
+      displayHeaderFooter: false,
+      preferCSSPageSize
+    }
+  }
+
+  async applyHeaderFooterWatermark(
+    page: Page,
+    { header, footer, watermark, landscape }: { header: string; footer: string; watermark: string; landscape: boolean }
+  ) {
+    await page.evaluate(
+      ({ header, footer, watermark, landscape }) => {
+        const setPositioning = (element: HTMLElement, position: 'header' | 'footer') => {
+          element.style.position = 'fixed'
+          element.style.left = '0'
+          element.style.width = '100%'
+          element.style.textAlign = 'center'
+          element.style.fontSize = '12px'
+          element.style.margin = '0'
+          element.style.padding = '0'
+          if (position === 'header') {
+            element.style.top = '0'
+          } else if (position === 'footer') {
+            element.style.bottom = '0'
+          }
+        }
+
+        if (header) {
+          const headerElement = document.createElement('div')
+          headerElement.innerHTML = header
+          setPositioning(headerElement, 'header')
+          document.body.appendChild(headerElement)
+        }
+
+        if (footer) {
+          const footerElement = document.createElement('div')
+          footerElement.innerHTML = footer
+          setPositioning(footerElement, 'footer')
+          document.body.appendChild(footerElement)
+        }
+
+        if (watermark) {
+          const watermarkElement = document.createElement('div')
+          watermarkElement.innerHTML = watermark
+          watermarkElement.style.position = 'fixed'
+          watermarkElement.style.top = landscape ? '40%' : '50%'
+          watermarkElement.style.left = '50%'
+          watermarkElement.style.transform = 'translate(-50%, -50%) rotate(-45deg)'
+          watermarkElement.style.opacity = '0.2'
+          watermarkElement.style.fontSize = '50px'
+          watermarkElement.style.color = 'red'
+          watermarkElement.style.pointerEvents = 'none'
+          watermarkElement.style.zIndex = '9999'
+          document.body.appendChild(watermarkElement)
+        }
+      },
+      { header, footer, watermark, landscape }
+    )
+  }
+}
+
+export function getCommonParameterSpec() {
+  return [
+    {
+      type: 'scenario-step-input',
+      name: 'accessor',
+      label: 'accessor'
+    },
+    {
+      type: 'select',
+      name: 'format',
+      label: 'page-format',
+      property: {
+        options: [
+          { display: '', value: '' },
+          { display: 'A4', value: 'A4' },
+          { display: 'A3', value: 'A3' },
+          { display: 'Letter', value: 'Letter' },
+          { display: 'Legal', value: 'Legal' }
+        ]
+      },
+      description: 'Select the paper format for the PDF'
+    },
+    {
+      type: 'string',
+      name: 'width',
+      label: 'page-width',
+      placeholder: '(e.g., "8.5in", "21cm", "600px")',
+      description: 'Specify the width of the page (e.g., "8.5in", "21cm", "600px")'
+    },
+    {
+      type: 'string',
+      name: 'height',
+      label: 'page-height',
+      placeholder: '(e.g., "11in", "29.7cm", "800px")',
+      description: 'Specify the height of the page (e.g., "11in", "29.7cm", "800px")'
+    },
+    {
+      type: 'string',
+      name: 'marginTop',
+      label: 'page-margin-top',
+      placeholder: '(e.g., "0.5in", "1cm", "100px")',
+      description: 'Set the top margin for the page'
+    },
+    {
+      type: 'string',
+      name: 'marginBottom',
+      label: 'page-margin-bottom',
+      placeholder: '(e.g., "0.5in", "1cm", "100px")',
+      description: 'Set the bottom margin for the page'
+    },
+    {
+      type: 'string',
+      name: 'marginLeft',
+      label: 'page-margin-left',
+      placeholder: '(e.g., "0.5in", "1cm", "100px")',
+      description: 'Set the left margin for the page'
+    },
+    {
+      type: 'string',
+      name: 'marginRight',
+      label: 'page-margin-right',
+      placeholder: '(e.g., "0.5in", "1cm", "100px")',
+      description: 'Set the right margin for the page'
+    },
+    {
+      type: 'number',
+      name: 'scale',
+      label: 'page-scale',
+      defaultValue: 1,
+      description: 'Set the scale of the page content (default is 1)'
+    },
+    {
+      type: 'boolean',
+      name: 'printBackground',
+      label: 'print-background',
+      defaultValue: true,
+      description: 'Include background graphics when printing the page'
+    },
+    {
+      type: 'boolean',
+      name: 'landscape',
+      label: 'landscape',
+      defaultValue: false,
+      description: 'Print the PDF in landscape orientation'
+    },
+    {
+      type: 'boolean',
+      name: 'preferCSSPageSize',
+      label: 'prefer-css-page-size',
+      defaultValue: false,
+      description: 'Whether to prefer the CSS-defined page size over the given width and height'
+    }
+  ]
+}