@things-factory/integration-headless 7.0.37

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@things-factory/integration-headless",
+  "version": "7.0.37",
+  "main": "dist-server/index.js",
+  "things-factory": true,
+  "author": "heartyoh <heartyoh@hatiolab.com>",
+  "description": "Module that provide headless connection on integration engine",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "@things-factory:registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hatiolab/things-factory.git",
+    "directory": "packages/integration-headless"
+  },
+  "scripts": {
+    "build": "npm run build:server",
+    "build:server": "npx tsc --p ./server/tsconfig.json",
+    "clean:server": "npx rimraf dist-server",
+    "clean": "npm run clean:server"
+  },
+  "dependencies": {
+    "@things-factory/integration-base": "^7.0.33",
+    "@things-factory/pdf": "^7.0.37",
+    "ejs": "^3.1.10",
+    "pdf-lib": "^1.17.1"
+  },
+  "gitHead": "28b852bbf7bd1160522195f9db1775db56f18b30"
+}

package/server/engine/connector/headless-connector.ts

@@ -0,0 +1,64 @@
+import { ConnectionManager, Connector } from '@things-factory/integration-base'
+import { createHeadlessPool, destroyHeadlessPool } from './headless-pool'
+
+export class HeadlessConnector implements Connector {
+  async ready(connectionConfigs) {
+    await Promise.all(connectionConfigs.map(this.connect.bind(this)))
+
+    ConnectionManager.logger.info('headless-connector connections are ready')
+  }
+
+  async connect(connection) {
+    var {
+      endpoint: uri = '1',
+      params: { min = 2, max = 10 }
+    } = connection
+
+    const headlessPool = createHeadlessPool({
+      min,
+      max,
+      testOnBorrow: true,
+      acquireTimeoutMillis: 15000
+    })
+
+    ConnectionManager.addConnectionInstance(connection, headlessPool)
+
+    ConnectionManager.logger.info(
+      `headless-connector connection(${connection.name}:${connection.endpoint}) is connected`
+    )
+  }
+
+  async disconnect(connection) {
+    const headlessPool = ConnectionManager.getConnectionInstance(connection)
+    destroyHeadlessPool(headlessPool)
+
+    ConnectionManager.removeConnectionInstance(connection)
+
+    ConnectionManager.logger.info(`headless-connector connection(${connection.name}) is disconnected`)
+  }
+
+  get parameterSpec() {
+    return [
+      {
+        type: 'number',
+        name: 'min',
+        label: 'pool-size-min'
+      },
+      {
+        type: 'number',
+        name: 'max',
+        label: 'pool-size-max'
+      }
+    ]
+  }
+
+  get taskPrefixes() {
+    return ['headless']
+  }
+
+  get description() {
+    return 'Headless Pool Connector'
+  }
+}
+
+ConnectionManager.registerConnector('headless-connector', new HeadlessConnector())

package/server/engine/connector/headless-pool.ts

@@ -0,0 +1,69 @@
+import * as genericPool from 'generic-pool'
+
+import { config, logger } from '@things-factory/env'
+
+try {
+  var puppeteer = require('puppeteer')
+} catch (err) {
+  logger.error(err)
+}
+
+export function createHeadlessPool(options: genericPool.Options) {
+  return genericPool.createPool(
+    {
+      create() {
+        console.log('headless-pool-integration about to create')
+        return initializeChromium()
+      },
+      validate(browser) {
+        return Promise.race([
+          new Promise(res => setTimeout(() => res(false), 1500)),
+          browser
+            //@ts-ignore
+            .version()
+            .then(_ => true)
+            .catch(_ => false)
+        ])
+      },
+      destroy(browser) {
+        //@ts-ignore
+        return browser.close()
+      }
+    } as genericPool.Factory<any>,
+    options
+  )
+}
+
+export async function destroyHeadlessPool(headlessPool: genericPool.Pool<any>) {
+  if (headlessPool) {
+    console.log('headless-pool-integration about to destroy')
+
+    await headlessPool.drain()
+    await headlessPool.clear()
+  }
+}
+
+const CHROMIUM_PATH = config.get('CHROMIUM_PATH')
+
+async function initializeChromium() {
+  try {
+    if (!puppeteer) {
+      return
+    }
+
+    var launchSetting = {
+      args: ['--hide-scrollbars', '--mute-audio', '--no-sandbox', '--use-gl=egl'],
+      headless: 'shell'
+    }
+
+    if (CHROMIUM_PATH) {
+      launchSetting['executablePath'] = CHROMIUM_PATH
+    }
+
+    const browser = await puppeteer.launch(launchSetting)
+
+    return browser
+  } catch (err) {
+    logger.error(err)
+  }
+}

package/server/engine/connector/index.ts

@@ -0,0 +1 @@
+import './headless-connector'

package/server/engine/index.ts

@@ -0,0 +1,2 @@
+import './connector'
+import './task'

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

@@ -0,0 +1,222 @@
+import * as ejs from 'ejs'
+import { PDFDocument, rgb, degrees } from 'pdf-lib'
+
+import { TaskRegistry } from '@things-factory/integration-base'
+import { ConnectionManager } from '@things-factory/integration-base'
+
+async function HeadlessPDFCapture(step, context) {
+  var { connection: connectionName, params: stepOptions } = step
+  var {
+    htmlContent,
+    format,
+    width,
+    height,
+    margin,
+    scale,
+    printBackground,
+    landscape,
+    displayHeaderFooter,
+    headerTemplate,
+    footerTemplate,
+    preferCSSPageSize
+  } = stepOptions || {}
+  var { domain, data, __headless_pdf } = context
+
+  if (!__headless_pdf) {
+    throw new Error('it requires headless-pdf-open to be performed first')
+  }
+
+  var {
+    pdf,
+    header: headerTemplateFromContext,
+    footer: footerTemplateFromContext,
+    watermark,
+    pageCount
+  } = __headless_pdf
+
+  var headlessPool = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
+  let browser
+
+  try {
+    // Puppeteer를 사용하여 브라우저와 페이지 인스턴스를 생성
+    browser = await headlessPool.acquire()
+    const page = await browser.newPage()
+
+    // 설정된 HTML 콘텐츠를 페이지에 설정
+    await page.setContent(htmlContent)
+
+    // PDF 페이지 생성 옵션 설정
+    if (preferCSSPageSize) {
+      width = undefined
+      height = undefined
+    }
+
+    const pageOptions = {
+      format,
+      width,
+      height,
+      margin,
+      scale,
+      printBackground,
+      landscape,
+      displayHeaderFooter,
+      headerTemplate: displayHeaderFooter ? headerTemplate : undefined,
+      footerTemplate: displayHeaderFooter ? footerTemplate : undefined,
+      preferCSSPageSize
+    }
+
+    // 페이지를 PDF로 변환
+    const pageBuffer = await page.pdf(pageOptions)
+
+    // PDF-lib을 사용하여 PDF를 로드하고 추가 조작
+    const pdfDoc = await PDFDocument.load(pageBuffer)
+    const pages = await pdf.copyPages(pdfDoc, pdfDoc.getPageIndices())
+
+    pages.forEach((newPage, index) => {
+      const currentPageNumber = pageCount + index + 1
+
+      // 헤더와 푸터 렌더링 (페이지 번호 및 총 페이지 수 포함)
+      if (displayHeaderFooter && (headerTemplateFromContext || footerTemplateFromContext)) {
+        const renderedHeader = headerTemplateFromContext
+          ? ejs.render(headerTemplateFromContext, {
+              ...data,
+              pageNumber: currentPageNumber,
+              totalPages: pageCount + pages.length
+            })
+          : ''
+        const renderedFooter = footerTemplateFromContext
+          ? ejs.render(footerTemplateFromContext, {
+              ...data,
+              pageNumber: currentPageNumber,
+              totalPages: pageCount + pages.length
+            })
+          : ''
+
+        // Header/Footer 그리기
+        if (renderedHeader) {
+          newPage.drawText(renderedHeader, { x: 50, y: newPage.getHeight() - 30, size: 12, color: rgb(0, 0, 0) })
+        }
+        if (renderedFooter) {
+          newPage.drawText(renderedFooter, { x: 50, y: 30, size: 12, color: rgb(0, 0, 0) })
+        }
+      }
+
+      // 워터마크 추가
+      if (watermark) {
+        const fontSize = 50
+        const pageWidth = newPage.getWidth()
+        const pageHeight = newPage.getHeight()
+
+        newPage.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.addPage(newPage)
+    })
+
+    // 페이지 카운트 업데이트
+    __headless_pdf.pageCount += pages.length
+
+    await page.close()
+    headlessPool.release(browser)
+
+    return {
+      data: __headless_pdf
+    }
+  } catch (error) {
+    if (browser) {
+      await browser.close()
+    }
+
+    throw error
+  }
+}
+
+HeadlessPDFCapture.parameterSpec = [
+  {
+    type: 'string',
+    name: 'htmlContent',
+    label: 'html-content'
+  },
+  {
+    type: 'select',
+    name: 'format',
+    label: 'page-format',
+    options: [
+      { label: 'A4', value: 'A4' },
+      { label: 'A3', value: 'A3' },
+      { label: 'Letter', value: 'Letter' },
+      { label: 'Legal', value: 'Legal' }
+    ],
+    description: 'Select the paper format for the PDF'
+  },
+  {
+    type: 'string',
+    name: 'width',
+    label: 'page-width',
+    description: 'Specify the width of the page (e.g., "8.5in", "21cm", "600px")'
+  },
+  {
+    type: 'string',
+    name: 'height',
+    label: 'page-height',
+    description: 'Specify the height of the page (e.g., "11in", "29.7cm", "800px")'
+  },
+  {
+    type: 'json',
+    name: 'margin',
+    label: 'page-margins',
+    fields: [
+      { type: 'string', name: 'top', label: 'Top Margin', description: 'Top margin (e.g., "1in")' },
+      { type: 'string', name: 'right', label: 'Right Margin', description: 'Right margin (e.g., "1in")' },
+      { type: 'string', name: 'bottom', label: 'Bottom Margin', description: 'Bottom margin (e.g., "1in")' },
+      { type: 'string', name: 'left', label: 'Left Margin', description: 'Left margin (e.g., "1in")' }
+    ],
+    description: 'Set the margins for the page'
+  },
+  {
+    type: 'number',
+    name: 'scale',
+    label: '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: 'displayHeaderFooter',
+    label: 'display-header/footer',
+    defaultValue: false,
+    description: 'Display header and footer in the PDF'
+  },
+  {
+    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'
+  }
+]
+
+HeadlessPDFCapture.help = 'integration/task/headless-pdf-capture'
+
+TaskRegistry.registerTaskHandler('headless-pdf-capture', HeadlessPDFCapture)

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

@@ -0,0 +1,75 @@
+import * as ejs from 'ejs'
+import { PDFDocument } from 'pdf-lib'
+
+import { TaskRegistry } from '@things-factory/integration-base'
+import { ConnectionManager } from '@things-factory/integration-base'
+
+async function HeadlessPDFOpen(step, context) {
+  var { connection: connectionName, params: stepOptions } = step
+  var {
+    coverPage,
+    lastPage,
+    header,
+    footer,
+    watermark,
+    fileName // 추가된 파일 이름
+  } = stepOptions || {}
+
+  // var { domain, data, variables } = context
+  // var headlessPool = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
+
+  const pdf = await PDFDocument.create()
+
+  const data = {
+    pdf,
+    coverPage,
+    lastPage,
+    header,
+    footer,
+    watermark,
+    fileName, // 파일 이름을 context.data에 저장
+    pageCount: 0 // 페이지 카운트를 초기화하여 context에 저장
+  }
+
+  context.__headless_pdf = data
+
+  return {
+    data
+  }
+}
+
+HeadlessPDFOpen.parameterSpec = [
+  {
+    type: 'string',
+    name: 'coverPage',
+    label: 'pdf-cover-page'
+  },
+  {
+    type: 'string',
+    name: 'lastPage',
+    label: 'pdf-last-page'
+  },
+  {
+    type: 'string',
+    name: 'header',
+    label: 'header' // header template
+  },
+  {
+    type: 'string',
+    name: 'footer',
+    label: 'footer' // footer template
+  },
+  {
+    type: 'string',
+    name: 'watermark',
+    label: 'watermark' // watermark
+  },
+  {
+    type: 'string',
+    name: 'fileName',
+    label: 'filename' // 파일 이름 지정
+  }
+]
+HeadlessPDFOpen.help = 'integration/task/headless-open'
+
+TaskRegistry.registerTaskHandler('headless-open', HeadlessPDFOpen)

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

@@ -0,0 +1,84 @@
+import * as fs from 'fs'
+import * as path from 'path'
+import { PDFDocument, rgb, degrees } from 'pdf-lib'
+
+import { TaskRegistry } from '@things-factory/integration-base'
+
+async function HeadlessPDFSave(step, context) {
+  var { params: stepOptions } = step
+  var { outputPath } = stepOptions || {}
+  var { pdf, coverPage, lastPage, header, footer, watermark } = context.data
+
+  // 파일 이름이 설정되지 않았을 경우 기본 파일 이름 생성
+  const finalFileName = context.data.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()
+
+      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 (lastPage) {
+    const lastPageDoc = await PDFDocument.load(lastPage)
+    const [last] = await pdf.copyPages(lastPageDoc, [0])
+
+    // 마지막 페이지에 워터마크 추가
+    if (watermark) {
+      const fontSize = 50
+      const pageWidth = last.getWidth()
+      const pageHeight = last.getHeight()
+
+      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
+      })
+    }
+
+    pdf.addPage(last)
+  }
+
+  // PDF 파일로 저장
+  const pdfBytes = await pdf.save()
+  fs.writeFileSync(savePath, pdfBytes)
+
+  return {
+    data: {
+      link: savePath // 저장된 PDF 파일의 경로를 반환
+    }
+  }
+}
+
+HeadlessPDFSave.parameterSpec = [
+  {
+    type: 'string',
+    name: 'outputPath',
+    label: 'output-path' // PDF를 저장할 경로
+  }
+]
+
+HeadlessPDFSave.help = 'integration/task/headless-pdf-save'
+
+TaskRegistry.registerTaskHandler('headless-pdf-save', HeadlessPDFSave)

package/server/engine/task/index.ts

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

package/server/index.ts

@@ -0,0 +1 @@
+import './engine'

package/server/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig-base.json",
+  "compilerOptions": {
+    "strict": false,
+    "module": "commonjs",
+    "outDir": "../dist-server",
+    "baseUrl": "./"
+  },
+  "include": ["./**/*"]
+}

package/things-factory.config.js

@@ -0,0 +1 @@
+export default {}

package/translations/en.json

@@ -0,0 +1,19 @@
+{
+  "label.display-header/footer": "display header/footer",
+  "label.filename": "filename",
+  "label.footer": "footer template",
+  "label.header": "header template",
+  "label.html-content": "html content",
+  "label.landscape": "landscape",
+  "label.output-path": "output path",
+  "label.page-format": "page format",
+  "label.page-height": "page height",
+  "label.page-margins": "page margins",
+  "label.page-width": "page width",
+  "label.pdf-cover-page": "cover page template",
+  "label.pdf-last-page": "last page template",
+  "label.prefer-css-page-size": "prefer css page size",
+  "label.print-background": "print background",
+  "label.scale": "scale",
+  "label.watermark": "watermark"
+}

package/translations/ja.json

@@ -0,0 +1,19 @@
+{
+  "label.display-header/footer": "ヘッダー/フッターを表示",
+  "label.filename": "ファイル名",
+  "label.footer": "フッターテンプレート",
+  "label.header": "ヘッダーテンプレート",
+  "label.html-content": "html コンテンツ",
+  "label.landscape": "横向き",
+  "label.output-path": "出力パス",
+  "label.page-format": "ページ形式",
+  "label.page-height": "ページ高さ",
+  "label.page-margins": "ページ余白",
+  "label.page-width": "ページ幅",
+  "label.pdf-cover-page": "表紙テンプレート",
+  "label.pdf-last-page": "最終ページテンプレート",
+  "label.prefer-css-page-size": "cssページサイズを優先",
+  "label.print-background": "背景を印刷",
+  "label.scale": "スケール",
+  "label.watermark": "透かし"
+}

package/translations/ko.json

@@ -0,0 +1,19 @@
+{
+  "label.display-header/footer": "머릿글/바닥글 표시여부",
+  "label.filename": "파일이름",
+  "label.footer": "바닥글 템플릿",
+  "label.header": "머릿글 템플릿",
+  "label.html-content": "본문 템플릿",
+  "label.landscape": "가로 여부",
+  "label.output-path": "출력 패스",
+  "label.page-format": "페이지 형식",
+  "label.page-height": "페이지 높이",
+  "label.page-margins": "페이지 여백",
+  "label.page-width": "페이지 폭",
+  "label.pdf-cover-page": "표지 템플릿",
+  "label.pdf-last-page": "뒷표지 템플릿",
+  "label.prefer-css-page-size": "선호 CSS 페이지 크기",
+  "label.print-background": "배경 포함여부",
+  "label.scale": "페이지 비율",
+  "label.watermark": "워터마크"
+}

package/translations/ms.json

@@ -0,0 +1,19 @@
+{
+  "label.display-header/footer": "papar pengepala/pengaki",
+  "label.filename": "nama fail",
+  "label.footer": "templat pengaki",
+  "label.header": "templat pengepala",
+  "label.html-content": "kandungan html",
+  "label.landscape": "melintang",
+  "label.output-path": "laluan output",
+  "label.page-format": "format halaman",
+  "label.page-height": "tinggi halaman",
+  "label.page-margins": "margin halaman",
+  "label.page-width": "lebar halaman",
+  "label.pdf-cover-page": "templat muka surat depan",
+  "label.pdf-last-page": "templat muka surat terakhir",
+  "label.prefer-css-page-size": "utamakan saiz halaman css",
+  "label.print-background": "cetak latar belakang",
+  "label.scale": "skala",
+  "label.watermark": "tanda air"
+}

package/translations/zh.json

@@ -0,0 +1,19 @@
+{
+  "label.display-header/footer": "显示页眉/页脚",
+  "label.filename": "文件名",
+  "label.footer": "页脚模板",
+  "label.header": "页眉模板",
+  "label.html-content": "html 内容",
+  "label.landscape": "横向",
+  "label.output-path": "输出路径",
+  "label.page-format": "页面格式",
+  "label.page-height": "页面高度",
+  "label.page-margins": "页面边距",
+  "label.page-width": "页面宽度",
+  "label.pdf-cover-page": "封面模板",
+  "label.pdf-last-page": "尾页模板",
+  "label.prefer-css-page-size": "偏好 css 页面大小",
+  "label.print-background": "打印背景",
+  "label.scale": "缩放",
+  "label.watermark": "水印"
+}