add: onlinecheckwriter, pandadoc, pdf4me

Author: GTFalcao

components/onlinecheckwriter/actions/mail-pdf-document/mail-pdf-document.mjs

@@ -1,13 +1,12 @@
-import fs from "fs";
 import FormData from "form-data";
-import { ConfigurationError } from "@pipedream/platform";
+import { getFileStream } from "@pipedream/platform";
 import app from "../../onlinecheckwriter.app.mjs";
 
 export default {
   key: "onlinecheckwriter-mail-pdf-document",
   name: "Mail PDF Document",
   description: "Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     app,
@@ -19,8 +18,8 @@ export default {
     },
     filePath: {
       type: "string",
-      label: "File Path",
-      description: "The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
+      label: "File Path or URL",
+      description: "The PDF file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
     },
     shippingTypeId: {
       optional: false,
@@ -167,12 +166,8 @@ export default {
       destinationEmail,
     } = this;
 
-    if (!filePath?.startsWith("/tmp/")) {
-      throw new ConfigurationError("The file path must start with `/tmp/`.");
-    }
-
     const data = new FormData();
-    const file = fs.createReadStream(filePath);
+    const file = await getFileStream(filePath);
     data.append("document_details[file]", file);
     data.append("document_details[title]", documentTitle || "");
     data.append("shipping[shippingTypeId]", shippingTypeId || "");

components/onlinecheckwriter/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/onlinecheckwriter",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pipedream OnlineCheckWriter Components",
   "main": "onlinecheckwriter.app.mjs",
   "keywords": [
@@ -13,7 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "3.0.3",
+    "@pipedream/platform": "^3.1.0",
     "form-data": "^4.0.0"
   }
 }

components/pandadoc/actions/create-document-attachment/create-document-attachment.mjs

@@ -1,15 +1,13 @@
 import app from "../../pandadoc.app.mjs";
-import { ConfigurationError } from "@pipedream/platform";
-import fs from "fs";
-import path from "path";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import FormData from "form-data";
 
 export default {
   key: "pandadoc-create-document-attachment",
   name: "Create Document Attachment",
   description: "Adds an attachment to a document. [See the documentation here](https://developers.pandadoc.com/reference/create-document-attachment)",
   type: "action",
-  version: "0.0.7",
+  version: "0.1.0",
   props: {
     app,
     documentId: {
@@ -31,39 +29,17 @@ export default {
     },
   },
   methods: {
-    isValidFile(filePath) {
-      const filePathWithTmp = `/tmp/${filePath}`;
-      if (fs.existsSync(filePathWithTmp)) {
-        return filePathWithTmp;
-      } else if (fs.existsSync(filePath)) {
-        return filePath;
-      }
-      return false;
-    },
-    getFileStream(filePath) {
-      return fs.createReadStream(filePath);
-    },
-    getFileMeta(filePath) {
-      const stats = fs.statSync(filePath);
-      return {
-        name: path.basename(filePath),
-        size: stats.size,
-      };
-    },
-    getFormData(file, fileName) {
-      const fileValidation = this.isValidFile(file);
-      if (!fileValidation) {
-        throw new ConfigurationError("`file` must be a valid file path!");
-      }
-
-      const fileMeta = this.getFileMeta(fileValidation);
-      const fileContent = this.getFileStream(fileValidation);
+    async getFormData(file, fileName) {
+      const {
+        stream, metadata: {
+          name, size,
+        },
+      } = await getFileStreamAndMetadata(file);
       const data = new FormData();
-      if (fileName) data.append("name", fileName);
-      data.append("file", fileContent, {
-        knownLength: fileMeta.size,
+      data.append("name", fileName || name);
+      data.append("file", stream, {
+        knownLength: size,
       });
-
       return data;
     },
   },
@@ -74,7 +50,7 @@ export default {
       fileName,
     } = this;
 
-    const data = this.getFormData(file, fileName);
+    const data = await this.getFormData(file, fileName);
 
     const response = await this.app.createDocumentAttachments({
       $,

components/pandadoc/actions/create-document-from-file/create-document-from-file.mjs

@@ -7,7 +7,7 @@ export default {
   name: "Create Document From File",
   description: "Create a document from a file or public file URL. [See the documentation here](https://developers.pandadoc.com/reference/create-document-from-pdf)",
   type: "action",
-  version: "0.0.8",
+  version: "1.0.0",
   props: {
     app,
     name: {
@@ -27,13 +27,6 @@ export default {
         app,
         "file",
       ],
-      optional: true,
-    },
-    fileUrl: {
-      type: "string",
-      label: "File URL",
-      description: "A public file URL to use instead of a local file.",
-      optional: true,
     },
     documentFolderId: {
       propDefinition: [
@@ -55,7 +48,6 @@ export default {
       name,
       recipients,
       file,
-      fileUrl,
       documentFolderId,
     } = this;
 
@@ -66,7 +58,7 @@ export default {
       throw new ConfigurationError("**Error parsing recipients** - each must be a valid JSON-stringified object");
     }
 
-    let data, contentType, json = {
+    const json = {
       name,
       recipients: parsedRecipients,
       folder_uuid: documentFolderId,
@@ -78,15 +70,9 @@ export default {
         : this.fields;
     }
 
-    if (fileUrl) {
-      data = json;
-      contentType = "application/json";
-      data.url = fileUrl;
-    } else {
-      data = this.getFormData(file);
-      contentType = `multipart/form-data; boundary=${data._boundary}`;
-      data.append("data", JSON.stringify(json));
-    }
+    const data = this.getFormData(file);
+    const contentType = `multipart/form-data; boundary=${data._boundary}`;
+    data.append("data", JSON.stringify(json));
 
     const response = await this.app.createDocument({
       $,

components/pandadoc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/pandadoc",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "Pipedream PandaDoc Components",
   "main": "pandadoc.app.mjs",
   "keywords": [
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.6.0",
+    "@pipedream/platform": "^3.1.0",
     "form-data": "^4.0.0"
   }
 }

components/pandadoc/pandadoc.app.mjs

@@ -88,8 +88,8 @@ export default {
     },
     file: {
       type: "string",
-      label: "File",
-      description: "The file to upload from the `/tmp` folder. [See the docs here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp) on how to upload a file to `/tmp`.",
+      label: "File Path or URL",
+      description: "The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
     },
     name: {
       type: "string",

components/pdf4me/actions/compress-pdf/compress-pdf.mjs

@@ -1,12 +1,11 @@
 import pdf4me from "../../pdf4me.app.mjs";
 import utils from "../../common/utils.mjs";
-import fs from "fs";
 
 export default {
   key: "pdf4me-compress-pdf",
   name: "Compress PDF",
   description: "Compress a PDF file to reduce its size. [See the documentation](https://dev.pdf4me.com/apiv2/documentation/actions/compress-pdf/)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     pdf4me,
@@ -41,10 +40,7 @@ export default {
   },
   async run({ $ }) {
     const filename = utils.checkForExtension(this.filename, "pdf");
-    const filePath = utils.normalizeFilePath(this.filePath);
-    const fileContent = fs.readFileSync(filePath, {
-      encoding: "base64",
-    });
+    const fileContent = await utils.getBase64File(this.filePath);
 
     const response = await this.pdf4me.compressPdf({
       $,

components/pdf4me/actions/convert-to-pdf/convert-to-pdf.mjs

@@ -1,12 +1,11 @@
 import pdf4me from "../../pdf4me.app.mjs";
 import utils from "../../common/utils.mjs";
-import fs from "fs";
 
 export default {
   key: "pdf4me-convert-to-pdf",
   name: "Convert to PDF",
   description: "Convert a document (e.g., DOCX, XLSX, PPTX) to PDF. [See the documentation](https://dev.pdf4me.com/apiv2/documentation/actions/convert-to-pdf/)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     pdf4me,
@@ -25,10 +24,7 @@ export default {
     },
   },
   async run({ $ }) {
-    const filePath = utils.normalizeFilePath(this.filePath);
-    const fileContent = fs.readFileSync(filePath, {
-      encoding: "base64",
-    });
+    const fileContent = await utils.getBase64File(this.filePath);
 
     const response = await this.pdf4me.convertToPdf({
       $,

components/pdf4me/actions/merge-pdfs/merge-pdfs.mjs

@@ -1,19 +1,18 @@
 import pdf4me from "../../pdf4me.app.mjs";
 import utils from "../../common/utils.mjs";
-import fs from "fs";
 
 export default {
   key: "pdf4me-merge-pdfs",
   name: "Merge PDF Files",
   description: "Merge multiple PDF files into a single PDF. [See the documentation](https://dev.pdf4me.com/apiv2/documentation/actions/merge/)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     pdf4me,
     filePaths: {
       type: "string[]",
-      label: "File Paths",
-      description: "An array of paths to a PDF files in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      label: "File Paths or URLs",
+      description: "The files to process. For each entry, provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
     },
     filename: {
       propDefinition: [
@@ -24,10 +23,8 @@ export default {
   },
   async run({ $ }) {
     const filename = utils.checkForExtension(this.filename, "pdf");
-    const filePaths = this.filePaths.map((path) => utils.normalizeFilePath(path));
-    const fileContents = filePaths.map((path) => fs.readFileSync(path, {
-      encoding: "base64",
-    }));
+    const promises = await Promise.allSettled(this.filePaths.map((p) => utils.getBase64File(p)));
+    const fileContents = promises.map((prom) => prom.value);
 
     const response = await this.pdf4me.mergePdfs({
       $,

components/pdf4me/common/utils.mjs

@@ -1,18 +1,14 @@
 import fs from "fs";
-import { ConfigurationError } from "@pipedream/platform";
+import {
+  ConfigurationError, getFileStream,
+} from "@pipedream/platform";
 
 function normalizeFilePath(path) {
   return path.startsWith("/tmp/")
     ? path
     : `/tmp/${path}`;
 }
 
-function checkForExtension(filename, ext = "pdf") {
-  return filename.endsWith(`.${ext}`)
-    ? filename
-    : `${filename}.${ext}`;
-}
-
 function downloadToTmp(response, filename) {
   const rawcontent = response.toString("base64");
   const buffer = Buffer.from(rawcontent, "base64");
@@ -41,9 +37,17 @@ function handleErrorMessage(error) {
   throw new ConfigurationError(errorMessage);
 }
 
+async function getBase64File(filePath) {
+  const stream = await getFileStream(filePath);
+  const chunks = [];
+  for await (const chunk of stream) {
+    chunks.push(chunk);
+  }
+  return Buffer.concat(chunks).toString("base64");
+}
+
 export default {
-  normalizeFilePath,
-  checkForExtension,
   downloadToTmp,
   handleErrorMessage,
+  getBase64File,
 };