@things-factory/integration-headless 7.0.38 → 7.0.40

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

@@ -2,39 +2,208 @@ import * as ejs from 'ejs'
 import { PDFDocument } from 'pdf-lib'
 import { TaskRegistry } from '@things-factory/integration-base'
 import { ConnectionManager } from '@things-factory/integration-base'
+import { access } from '@things-factory/utils'
 
 async function HeadlessPDFOpen(step, context) {
   var { connection: connectionName, params: stepOptions } = step
   var {
+    accessor,
     coverPage,
     lastPage,
     header,
     footer,
     watermark,
-    fileName // 추가된 파일 이름
+    fileName,
+    format,
+    width,
+    height,
+    marginTop,
+    marginBottom,
+    marginLeft,
+    marginRight,
+    scale,
+    printBackground,
+    landscape,
+    preferCSSPageSize
   } = stepOptions || {}
-
-  const pdf = await PDFDocument.create()
+  const { data, logger } = context
 
   const headlessPool = ConnectionManager.getConnectionInstanceByName(context.domain, connectionName)
   let browser
 
+  // Create a new PDF document using pdf-lib
+  const pdfDoc = await PDFDocument.create()
+
   try {
     browser = await headlessPool.acquire()
     const page = await browser.newPage()
 
-    // Cover Page를 PDF로 변환
+    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
+      }
+    }
+
+    // Convert Cover Page to PDF and add it to the document (if provided)
     if (coverPage) {
-      await page.setContent(coverPage)
-      const coverPageBuffer = await page.pdf()
-      coverPage = coverPageBuffer
+      const renderedCoverPage = renderTemplateSafely(coverPage, templateInput)
+
+      await page.setContent(renderedCoverPage)
+
+      // Apply header, footer, and watermark using Puppeteer
+      // 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'
+              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 }
+        )
+      }
+
+      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 coverPageBuffer = await page.pdf(pageOptions)
+      const coverPageDoc = await PDFDocument.load(coverPageBuffer)
+      const coverPages = await pdfDoc.copyPages(coverPageDoc, coverPageDoc.getPageIndices())
+      coverPages.forEach(page => pdfDoc.addPage(page))
     }
 
-    // Last Page를 PDF로 변환
+    var lastPageBuffer
+
+    // Process Last Page (if provided) but add it later in the save task
     if (lastPage) {
-      await page.setContent(lastPage)
-      const lastPageBuffer = await page.pdf()
-      lastPage = lastPageBuffer
+      const renderedLastPage = renderTemplateSafely(lastPage, templateInput)
+      await page.setContent(renderedLastPage)
+
+      // 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'
+              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 }
+        )
+      }
+
+      const pageOptions = {
+        format,
+        width,
+        height,
+        margin: {
+          top: marginTop,
+          right: marginRight,
+          bottom: marginBottom,
+          left: marginLeft
+        },
+        scale,
+        printBackground,
+        landscape,
+        displayHeaderFooter: false, // Handled via Puppeteer directly
+        preferCSSPageSize
+      }
+
+      lastPageBuffer = await page.pdf(pageOptions)
     }
 
     await page.close()
@@ -46,25 +215,29 @@ async function HeadlessPDFOpen(step, context) {
     throw error
   }
 
-  const data = {
-    pdf,
-    coverPage,
-    lastPage,
+  const pdfInfo = {
+    pdfDoc,
+    lastPageBuffer,
     header,
     footer,
     watermark,
     fileName,
-    pageCount: 0
+    pageCount: pdfDoc.getPageCount()
   }
 
-  context.__headless_pdf = data
+  context.__headless_pdf = pdfInfo
 
   return {
-    data
+    data: pdfInfo
   }
 }
 
 HeadlessPDFOpen.parameterSpec = [
+  {
+    type: 'scenario-step-input',
+    name: 'accessor',
+    label: 'accessor'
+  },
   {
     type: 'textarea',
     name: 'coverPage',
@@ -76,26 +249,114 @@ HeadlessPDFOpen.parameterSpec = [
     label: 'pdf-last-page'
   },
   {
-    type: 'textarea',
+    type: 'string',
     name: 'header',
-    label: 'header' // header template
+    label: 'header',
+    placeholder: 'Page <%= pageNumber %> of <%= totalPages %>'
   },
   {
-    type: 'textarea',
+    type: 'string',
     name: 'footer',
-    label: 'footer' // footer template
+    label: 'footer',
+    placeholder: 'Page <%= pageNumber %> of <%= totalPages %>'
   },
   {
-    type: 'textarea',
+    type: 'string',
     name: 'watermark',
-    label: 'watermark' // watermark
+    label: 'watermark'
   },
   {
     type: 'string',
     name: 'fileName',
-    label: 'filename' // 파일 이름 지정
+    label: 'filename'
+  },
+  {
+    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'
   }
 ]
+
 HeadlessPDFOpen.help = 'integration/task/headless-pdf-open'
 
 TaskRegistry.registerTaskHandler('headless-pdf-open', HeadlessPDFOpen)

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

@@ -1,74 +1,39 @@
 import * as fs from 'fs'
 import * as path from 'path'
-import { PDFDocument, rgb, degrees } from 'pdf-lib'
-
 import { TaskRegistry } from '@things-factory/integration-base'
+import { PDFDocument } from 'pdf-lib'
 
 async function HeadlessPDFSave(step, context) {
   var { params: stepOptions } = step
   var { outputPath } = stepOptions || {}
-  var { domain, data, __headless_pdf } = context
-
-  var { pdf, coverPage, lastPage, watermark, fileName } = __headless_pdf
-
-  // 파일 이름이 설정되지 않았을 경우 기본 파일 이름 생성
-  const finalFileName = fileName || `document-${Date.now()}.pdf`
-  const savePath = path.join(outputPath || '/path/to/default/storage', finalFileName)
-
-  // PDF 문서에 coverPage 및 lastPage 추가
-  if (coverPage) {
-    const coverPageDoc = await PDFDocument.load(coverPage)
-    const [cover] = await pdf.copyPages(coverPageDoc, [0])
-
-    // 커버 페이지에 워터마크 추가
-    if (watermark) {
-      const fontSize = 50
-      const pageWidth = cover.getWidth()
-      const pageHeight = cover.getHeight()
+  var { __headless_pdf } = context
 
-      cover.drawText(watermark, {
-        x: pageWidth / 2 - (fontSize * watermark.length) / 4,
-        y: pageHeight / 2 - fontSize / 2,
-        size: fontSize,
-        color: rgb(0.75, 0.75, 0.75),
-        rotate: degrees(-45),
-        opacity: 0.5
-      })
-    }
-
-    pdf.insertPage(0, cover)
+  if (!__headless_pdf || !__headless_pdf.pdfDoc) {
+    throw new Error(
+      'No PDF document found. Ensure that headless-pdf-open and headless-pdf-capture tasks are executed before saving.'
+    )
   }
 
-  if (lastPage) {
-    const lastPageDoc = await PDFDocument.load(lastPage)
-    const [last] = await pdf.copyPages(lastPageDoc, [0])
+  const pdfDoc = __headless_pdf.pdfDoc
 
-    // 마지막 페이지에 워터마크 추가
-    if (watermark) {
-      const fontSize = 50
-      const pageWidth = last.getWidth()
-      const pageHeight = last.getHeight()
+  // Add last page if it exists
+  if (__headless_pdf.lastPageBuffer) {
+    const lastPageDoc = await PDFDocument.load(__headless_pdf.lastPageBuffer)
+    const copiedLastPages = await pdfDoc.copyPages(lastPageDoc, lastPageDoc.getPageIndices())
+    copiedLastPages.forEach(page => pdfDoc.addPage(page))
+  }
 
-      last.drawText(watermark, {
-        x: pageWidth / 2 - (fontSize * watermark.length) / 4,
-        y: pageHeight / 2 - fontSize / 2,
-        size: fontSize,
-        color: rgb(0.75, 0.75, 0.75),
-        rotate: degrees(-45),
-        opacity: 0.5
-      })
-    }
+  const pdfBytes = await pdfDoc.save()
 
-    pdf.addPage(last)
-  }
+  const finalFileName = __headless_pdf.fileName || `document-${Date.now()}.pdf`
+  const savePath = path.join(outputPath || './attachments', finalFileName)
 
-  // PDF 파일로 저장
-  const pdfBytes = await pdf.save()
+  // Save the final PDF to the specified path
   fs.writeFileSync(savePath, pdfBytes)
 
   return {
     data: {
-      link: savePath // 저장된 PDF 파일의 경로를 반환
+      link: savePath
     }
   }
 }
@@ -77,7 +42,8 @@ HeadlessPDFSave.parameterSpec = [
   {
     type: 'string',
     name: 'outputPath',
-    label: 'output-path' // PDF를 저장할 경로
+    label: 'output-path',
+    description: 'The directory path where the PDF should be saved. Defaults to "./attachments".'
   }
 ]
 

package/server/engine/task/index.ts

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

package/translations/en.json

@@ -8,7 +8,10 @@
   "label.output-path": "output path",
   "label.page-format": "page format",
   "label.page-height": "page height",
-  "label.page-margins": "page margins",
+  "label.page-margin-top": "page margin top",
+  "label.page-margin-bottom": "page margin bottom",
+  "label.page-margin-left": "page margin left",
+  "label.page-margin-right": "page margins right",
   "label.page-width": "page width",
   "label.pdf-cover-page": "cover page template",
   "label.pdf-last-page": "last page template",
@@ -16,6 +19,6 @@
   "label.pool-size-min": "minimum pool size",
   "label.prefer-css-page-size": "prefer css page size",
   "label.print-background": "print background",
-  "label.scale": "scale",
+  "label.page-scale": "scale",
   "label.watermark": "watermark"
 }

package/translations/ja.json

@@ -8,7 +8,10 @@
   "label.output-path": "出力パス",
   "label.page-format": "ページ形式",
   "label.page-height": "ページ高さ",
-  "label.page-margins": "ページ余白",
+  "label.page-margin-top": "ページ上余白",
+  "label.page-margin-bottom": "ページ下余白",
+  "label.page-margin-left": "ページ左余白",
+  "label.page-margin-right": "ページ右余白",
   "label.page-width": "ページ幅",
   "label.pdf-cover-page": "表紙テンプレート",
   "label.pdf-last-page": "最終ページテンプレート",
@@ -16,6 +19,6 @@
   "label.pool-size-min": "最小プールサイズ",
   "label.prefer-css-page-size": "cssページサイズを優先",
   "label.print-background": "背景を印刷",
-  "label.scale": "スケール",
+  "label.page-scale": "スケール",
   "label.watermark": "透かし"
 }

package/translations/ko.json

@@ -8,7 +8,10 @@
   "label.output-path": "출력 패스",
   "label.page-format": "페이지 형식",
   "label.page-height": "페이지 높이",
-  "label.page-margins": "페이지 여백",
+  "label.page-margin-top": "페이지 여백 (위쪽)",
+  "label.page-margin-bottom": "페이지 여백 (아래쪽)",
+  "label.page-margin-left": "페이지 여백 (왼쪽)",
+  "label.page-margin-right": "페이지 여백 (오른쪽)",
   "label.page-width": "페이지 폭",
   "label.pdf-cover-page": "표지 템플릿",
   "label.pdf-last-page": "뒷표지 템플릿",
@@ -16,6 +19,6 @@
   "label.pool-size-min": "최대 풀(Pool) 사이즈",
   "label.prefer-css-page-size": "선호 CSS 페이지 크기",
   "label.print-background": "배경 포함여부",
-  "label.scale": "페이지 비율",
+  "label.page-scale": "페이지 비율",
   "label.watermark": "워터마크"
 }

package/translations/ms.json

@@ -8,7 +8,10 @@
   "label.output-path": "laluan output",
   "label.page-format": "format halaman",
   "label.page-height": "tinggi halaman",
-  "label.page-margins": "margin halaman",
+  "label.page-margin-top": "margin atas halaman",
+  "label.page-margin-bottom": "margin bawah halaman",
+  "label.page-margin-left": "margin kiri halaman",
+  "label.page-margin-right": "margin kanan halaman",
   "label.page-width": "lebar halaman",
   "label.pdf-cover-page": "templat muka surat depan",
   "label.pdf-last-page": "templat muka surat terakhir",
@@ -16,6 +19,6 @@
   "label.pool-size-min": "saiz pool minimum",
   "label.prefer-css-page-size": "utamakan saiz halaman css",
   "label.print-background": "cetak latar belakang",
-  "label.scale": "skala",
+  "label.page-scale": "skala",
   "label.watermark": "tanda air"
 }

package/translations/zh.json

@@ -8,7 +8,10 @@
   "label.output-path": "输出路径",
   "label.page-format": "页面格式",
   "label.page-height": "页面高度",
-  "label.page-margins": "页面边距",
+  "label.page-margin-top": "页面上边距",
+  "label.page-margin-bottom": "页面下边距",
+  "label.page-margin-left": "页面左边距",
+  "label.page-margin-right": "页面右边距",
   "label.page-width": "页面宽度",
   "label.pdf-cover-page": "封面模板",
   "label.pdf-last-page": "尾页模板",
@@ -16,6 +19,6 @@
   "label.pool-size-min": "最小池大小",
   "label.prefer-css-page-size": "偏好 css 页面大小",
   "label.print-background": "打印背景",
-  "label.scale": "缩放",
+  "label.page-scale": "缩放",
   "label.watermark": "水印"
 }