@things-factory/integration-headless 7.0.40 → 7.0.41

package/helps/integration/task/headless-pdf-save.zh.md

@@ -0,0 +1,23 @@
+### 无头PDF保存任务 (Headless PDF Save Task)
+
+**无头PDF保存任务**是将先前生成的PDF文档保存为文件的任务。此任务将PDF文档保存为附件，并返回保存文件的元数据。
+
+#### 主要功能
+
+- **保存PDF文档**: 保存由`headless-pdf-open`、`headless-pdf-capture`和`headless-pdf-capture-board`任务生成的PDF文档。文档将以指定的文件名保存，并返回文件的路径和元数据。
+- **添加最后一页**: 如果在`headless-pdf-open`任务中指定了最后一页，则在保存之前将最后一页添加到PDF文档中。
+- **保存为附件**: 将生成的PDF文档保存为附件，并将文件元数据记录到数据库中。保存的文件将作为`Attachment`记录进行管理。
+
+#### 返回数据
+
+- **id**: 保存的附件的唯一ID。
+- **name**: 附件的名称。
+- **path**: 附件的路径。
+- **mimetype**: 文件的MIME类型（例如：`application/pdf`）。
+- **refBy**: 引用信息（此任务中为`pdf-published`）。
+- **fullpath**: 文件的完整路径。
+
+#### 使用注意事项
+
+- **必须先执行`headless-pdf-open`和`headless-pdf-capture`任务**: `headless-pdf-save`任务必须在执行了`headless-pdf-open`和必要的`headless-pdf-capture`任务后运行，否则会因为没有PDF文档可保存而导致错误。
+- **文件名设置**: PDF文档的文件名默认设置为`document-<时间戳>.pdf`，如有需要，可以在`headless-pdf-open`中设置自定义文件名。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-headless",
-  "version": "7.0.40",
+  "version": "7.0.41",
   "main": "dist-server/index.js",
   "things-factory": true,
   "author": "heartyoh <heartyoh@hatiolab.com>",
@@ -22,11 +22,12 @@
     "clean": "npm run clean:server"
   },
   "dependencies": {
-    "@things-factory/board-service": "^7.0.40",
+    "@things-factory/attachment-base": "^7.0.41",
+    "@things-factory/board-service": "^7.0.41",
     "@things-factory/integration-base": "^7.0.38",
-    "@things-factory/pdf": "^7.0.37",
+    "@things-factory/shell": "^7.0.33",
     "ejs": "^3.1.10",
     "pdf-lib": "^1.17.1"
   },
-  "gitHead": "59ccd4873d87a1b38df8387809a68c958076d264"
+  "gitHead": "9d9bd55f0ab565cf41cdc33fdaf416f7e5c26f5c"
 }

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

@@ -59,6 +59,10 @@ export class HeadlessConnector implements Connector {
   get description() {
     return 'Headless Pool Connector'
   }
+
+  get help() {
+    return 'integration/connector/headless-connector'
+  }
 }
 
 ConnectionManager.registerConnector('headless-connector', new HeadlessConnector())

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

@@ -267,7 +267,7 @@ HeadlessPDFCaptureBoard.parameterSpec = [
   {
     type: 'boolean',
     name: 'draft',
-    label: 'draft',
+    label: 'board-draft',
     defaultValue: false,
     description: 'Set whether to get the current working version or the last released version'
   },

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

@@ -1,12 +1,12 @@
-import * as fs from 'fs'
-import * as path from 'path'
-import { TaskRegistry } from '@things-factory/integration-base'
 import { PDFDocument } from 'pdf-lib'
+const { Readable } = require('stream')
+
+import { TaskRegistry } from '@things-factory/integration-base'
+import { Attachment, createAttachment } from '@things-factory/attachment-base'
+import { getRepository } from '@things-factory/shell'
 
 async function HeadlessPDFSave(step, context) {
-  var { params: stepOptions } = step
-  var { outputPath } = stepOptions || {}
-  var { __headless_pdf } = context
+  var { domain, user, __headless_pdf } = context
 
   if (!__headless_pdf || !__headless_pdf.pdfDoc) {
     throw new Error(
@@ -26,26 +26,49 @@ async function HeadlessPDFSave(step, context) {
   const pdfBytes = await pdfDoc.save()
 
   const finalFileName = __headless_pdf.fileName || `document-${Date.now()}.pdf`
-  const savePath = path.join(outputPath || './attachments', finalFileName)
 
-  // Save the final PDF to the specified path
-  fs.writeFileSync(savePath, pdfBytes)
+  const saved = await createAttachment(
+    null,
+    {
+      attachment: {
+        file: {
+          createReadStream: () =>
+            new Readable({
+              read() {
+                this.push(pdfBytes)
+                this.push(null)
+              }
+            }),
+          filename: finalFileName,
+          mimetype: 'application/pdf',
+          encoding: 'binary'
+        },
+        refType: 'headless-pdf-save',
+        refBy: 'pdf-published'
+      }
+    },
+    {
+      state: { domain, user }
+    }
+  )
+
+  const attachment = await getRepository(Attachment).findOne({
+    where: { id: saved.id }
+  })
 
   return {
     data: {
-      link: savePath
+      id: attachment.id,
+      name: attachment.name,
+      path: attachment.path,
+      mimetype: attachment.mimetype,
+      refBy: attachment.refBy,
+      fullpath: attachment.fullpath
     }
   }
 }
 
-HeadlessPDFSave.parameterSpec = [
-  {
-    type: 'string',
-    name: 'outputPath',
-    label: 'output-path',
-    description: 'The directory path where the PDF should be saved. Defaults to "./attachments".'
-  }
-]
+HeadlessPDFSave.parameterSpec = []
 
 HeadlessPDFSave.help = 'integration/task/headless-pdf-save'
 

package/translations/en.json

@@ -1,5 +1,6 @@
 {
   "label.display-header/footer": "display header/footer",
+  "label.board-draft": "draft board",
   "label.filename": "filename",
   "label.footer": "footer template",
   "label.header": "header template",

package/translations/ko.json

@@ -1,5 +1,6 @@
 {
   "label.display-header/footer": "머릿글/바닥글 표시여부",
+  "label.board-draft": "편집본 대상",
   "label.filename": "파일이름",
   "label.footer": "바닥글 템플릿",
   "label.header": "머릿글 템플릿",