[Components] fileforge #13975

Actions
 - Generate PDF

Author: luancazarine

components/fileforge/actions/generate-pdf/generate-pdf.mjs

@@ -1,79 +1,85 @@
-import fileforge from "../../fileforge.app.mjs";
-import { axios } from "@pipedream/platform";
 import FormData from "form-data";
 import fs from "fs";
-import stream from "stream";
-import { promisify } from "util";
-
-const pipeline = promisify(stream.pipeline);
+import {
+  checkTmp,
+  parseObject,
+} from "../../common/utils.mjs";
+import fileforge from "../../fileforge.app.mjs";
 
 export default {
   key: "fileforge-generate-pdf",
   name: "Generate PDF",
   description: "Generate a PDF from provided HTML. [See the documentation](https://docs.fileforge.com/api-reference/api-reference/pdf/generate)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     fileforge,
+    alert: {
+      type: "alert",
+      alertType: "warning",
+      content: `An **\`index.html\`** file is required, and will be used as the main document.
+      Other documents may also be attached, such as stylesheets or images.
+      The path in the **\`filename\`** part of the multipart attachement will be respected during generation.
+      **Important notice:** during generation, the **\`index.html\`** file will be processed to include the base URL of the document.
+      This is required for assets to be loaded correctly.
+      To link your assets from the HTML file, you should not use a leading slash in the URL.
+      For example, use **\`<img src="image.jpg" />\`** instead of **\`<img src="/image.jpg" />\`**.`,
+    },
     files: {
-      propDefinition: [
-        fileforge,
-        "files",
-      ],
+      type: "string[]",
+      label: "HTML Files",
+      description: "The HTML files to convert to PDF. Each file should be a valid path to an HTML file.",
     },
     test: {
-      propDefinition: [
-        fileforge,
-        "test",
-      ],
-    },
-    host: {
-      propDefinition: [
-        fileforge,
-        "host",
-      ],
+      type: "boolean",
+      label: "Test",
+      description: "Generate a test document instead of a production document. The generated document will contain a watermark. Defaults to true.",
+      optional: true,
     },
-    expiresat: {
-      propDefinition: [
-        fileforge,
-        "expiresat",
-      ],
+    expiresAt: {
+      type: "string",
+      label: "Expires At",
+      description: "The expiration timestamp for the PDF in ISO 8601 format",
+      optional: true,
     },
-    filename: {
-      propDefinition: [
-        fileforge,
-        "filename",
-      ],
+    fileName: {
+      type: "string",
+      label: "Filename",
+      description: "The desired filename for the generated PDF.",
+      optional: true,
     },
-    allowviewing: {
-      propDefinition: [
-        fileforge,
-        "allowviewing",
-      ],
+    allowViewing: {
+      type: "boolean",
+      label: "Allow Viewing",
+      description: "Specifies whether viewing is allowed.",
+      optional: true,
     },
   },
   async run({ $ }) {
-    const response = await this.fileforge.generatePDF({
-      files: this.files,
-      test: this.test,
-      host: this.host,
-      expiresat: this.expiresat,
-      filename: this.filename,
-      allowviewing: this.allowviewing,
-    });
+    const {
+      fileforge,
+      files,
+      ...data
+    } = this;
+
+    const formData = new FormData();
+    const parsedFiles = parseObject(files);
 
-    const pdfPath = "/tmp/generated.pdf";
-    const pdfStream = await axios($, {
-      method: "GET",
-      url: response.url,
-      responseType: "stream",
+    for (const file of parsedFiles) {
+      formData.append("files", fs.createReadStream(checkTmp(file)));
+    }
+
+    formData.append("options", JSON.stringify(data), {
+      contentType: "application/json",
     });
 
-    await pipeline(pdfStream, fs.createWriteStream(pdfPath));
+    const response = await fileforge.generatePDF({
+      $,
+      data: formData,
+      headers: formData.getHeaders(),
+    });
 
-    $.export("$summary", `Successfully generated PDF at ${pdfPath}`);
-    return {
-      pdfPath,
-    };
+    $.export("$summary", "Successfully generated the PDF file.");
+    return response;
   },
 };

components/fileforge/common/utils.mjs

@@ -0,0 +1,31 @@
+export const parseObject = (obj) => {
+  if (!obj) return undefined;
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => {
+      if (typeof item === "string") {
+        try {
+          return JSON.parse(item);
+        } catch (e) {
+          return item;
+        }
+      }
+      return item;
+    });
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+  }
+  return obj;
+};
+
+export const checkTmp = (filename) => {
+  if (!filename.startsWith("/tmp")) {
+    return `/tmp/${filename}`;
+  }
+  return filename;
+};

components/fileforge/fileforge.app.mjs

@@ -3,102 +3,30 @@ import { axios } from "@pipedream/platform";
 export default {
   type: "app",
   app: "fileforge",
-  propDefinitions: {
-    files: {
-      type: "string[]",
-      label: "HTML Files",
-      description: "The HTML files to convert to PDF. Each file should be a valid URL or path to an HTML file.",
-    },
-    test: {
-      type: "boolean",
-      label: "Test",
-      description: "Enable test mode",
-      optional: true,
-    },
-    host: {
-      type: "string",
-      label: "Host",
-      description: "Specifies the host for the PDF generation.",
-      optional: true,
-    },
-    expiresat: {
-      type: "string",
-      label: "Expires At",
-      description: "The expiration timestamp for the PDF in ISO 8601 format",
-      optional: true,
-    },
-    filename: {
-      type: "string",
-      label: "Filename",
-      description: "The desired filename for the generated PDF.",
-      optional: true,
-    },
-    allowviewing: {
-      type: "boolean",
-      label: "Allow Viewing",
-      description: "Specifies whether viewing is allowed.",
-      optional: true,
-    },
-  },
   methods: {
-    authKeys() {
-      console.log(Object.keys(this.$auth));
-    },
     _baseUrl() {
       return "https://api.fileforge.com";
     },
-    async _makeRequest(opts = {}) {
-      const {
-        $ = this, method = "POST", path, headers, ...otherOpts
-      } = opts;
+    _headers(headers = {}) {
+      return {
+        "X-API-Key": this.$auth.api_key,
+        ...headers,
+      };
+    },
+    _makeRequest({
+      $ = this, path, headers, ...opts
+    }) {
       return axios($, {
-        ...otherOpts,
-        method,
         url: this._baseUrl() + path,
-        headers: {
-          ...headers,
-          "X-API-Key": this.$auth.api_key,
-          "Content-Type": "multipart/form-data",
-        },
+        headers: this._headers(headers),
+        ...opts,
       });
     },
-    async generatePDF({
-      files, test, host, expiresat, filename, allowviewing,
-    }) {
-      const formData = new FormData();
-
-      // Append files
-      files.forEach((file, index) => {
-        formData.append("files", file, `file${index}.html`);
-      });
-
-      // Construct options object
-      const options = {
-        ...(test !== undefined && {
-          test,
-        }),
-        ...(host && {
-          host,
-        }),
-        ...(expiresat && {
-          expiresat,
-        }),
-        ...(filename && {
-          filename,
-        }),
-        ...(allowviewing !== undefined && {
-          allowviewing,
-        }),
-      };
-
-      formData.append("options", JSON.stringify(options));
-
+    generatePDF(opts = {}) {
       return this._makeRequest({
+        method: "POST",
         path: "/pdf/generate/",
-        data: formData,
-        headers: {
-          Accept: "application/pdf",
-        },
+        ...opts,
       });
     },
   },

components/fileforge/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/fileforge",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Fileforge Components",
   "main": "fileforge.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.1"
   }
 }