Part 2 - applying File URL or Path improvements (#17091)

* pnpm

* Updating _2markdown and mapbox

* Akeneo and LLMWhisperer apps

* pnpm

* add: askyourpdf

* add: fileforge

* adjusting existing descriptions and platform versions

* Description updates

* add: microsoft_onedrive, mistral_ai, onlyoffice_docspace

* add: slack

* add: stannp, zamzar, zoho_desk

* add box upload-file

* add: monday, nyckel

* add: ocrspace

* add: onlinecheckwriter, pandadoc, pdf4me

* Onedrive adjustment

* pnpm

* adjusting Slack and Pandadoc

* updates to include metadata in all formdatas

* pnpm

* fix

* pnpm

* CodeRabbit fixes

* Fixing box and nyckel

* fix mapbox

* add: autodesk, cradl_ai, docsbot_ai

* pnpm

* add: egnyte, flippingbook

* add: happy_scribe, ilovepdf

* add: lokalise, podio, zoho_crm

* add: openai, imagga

* add: google_drive

* add: openai (remaining actions)

* add: airparser, alttext_ai

* add: azure_storage, boldsign

* add: canva

* add: claid_ai

* update package.json

* pdf4me: readding std filename check to action

* Adjusting zoho_desk formdata building

* Merge branch 'master' into 16977-applying-fileurl-paths-improvement

* pnpm

* fix: alttext_ai, box

* description improvements: docsbot_ai, lokalise

* fix: openai

* Improving OpenAI image handling

* openai-chat fixes

Author: GTFalcao

components/_2markdown/_2markdown.app.mjs

@@ -6,8 +6,8 @@ export default {
   propDefinitions: {
     filePath: {
       type: "string",
-      label: "File Path",
-      description: "The path to an HTML file 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 Path or URL",
+      description: "An HTML file. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.html`)",
     },
   },
   methods: {

components/_2markdown/actions/html-file-to-markdown/html-file-to-markdown.mjs

@@ -1,12 +1,12 @@
 import _2markdown from "../../_2markdown.app.mjs";
-import fs from "fs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import FormData from "form-data";
 
 export default {
   key: "_2markdown-html-file-to-markdown",
   name: "HTML File to Markdown",
   description: "Convert an HTML file to Markdown format. [See the documentation](https://2markdown.com/docs#file2md)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     _2markdown,
@@ -20,9 +20,14 @@ export default {
   async run({ $ }) {
     const form = new FormData();
 
-    form.append("document", fs.createReadStream(this.filePath.includes("tmp/")
-      ? this.filePath
-      : `/tmp/${this.filePath}`));
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.filePath);
+    form.append("document", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
 
     const response = await this._2markdown.htmlFileToMarkdown({
       $,

components/_2markdown/actions/pdf-to-markdown/pdf-to-markdown.mjs

@@ -1,12 +1,12 @@
 import _2markdown from "../../_2markdown.app.mjs";
-import fs from "fs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import FormData from "form-data";
 
 export default {
   key: "_2markdown-pdf-to-markdown",
   name: "PDF to Markdown",
   description: "Convert a PDF document to Markdown format. [See the documentation](https://2markdown.com/docs#pdf2md)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     _2markdown,
@@ -15,7 +15,7 @@ export default {
         _2markdown,
         "filePath",
       ],
-      description: "The path to a PDF file 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)",
+      description: "A PDF file. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
     },
     waitForCompletion: {
       type: "boolean",
@@ -27,9 +27,14 @@ export default {
   async run({ $ }) {
     const form = new FormData();
 
-    form.append("document", fs.createReadStream(this.filePath.includes("tmp/")
-      ? this.filePath
-      : `/tmp/${this.filePath}`));
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.filePath);
+    form.append("document", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
 
     let response = await this._2markdown.pdfToMarkdown({
       $,

components/_2markdown/package.json

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

components/airparser/actions/upload-document-parse/upload-document-parse.mjs

@@ -1,12 +1,12 @@
 import airparser from "../../airparser.app.mjs";
-import fs from "fs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import FormData from "form-data";
 
 export default {
   key: "airparser-upload-document-parse",
   name: "Upload Document and Parse",
   description: "Uploads a document into the inbox for data extraction. [See the documentation](https://help.airparser.com/public-api/public-api)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     airparser,
@@ -18,8 +18,8 @@ export default {
     },
     filePath: {
       type: "string",
-      label: "File Path",
-      description: "The path to a file 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 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`)",
     },
     metadata: {
       type: "object",
@@ -29,11 +29,15 @@ export default {
     },
   },
   async run({ $ }) {
-    const fileStream = fs.createReadStream(this.filePath.includes("tmp/")
-      ? this.filePath
-      : `/tmp/${this.filePath}`);
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.filePath);
     const data = new FormData();
-    data.append("file", fileStream);
+    data.append("file", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
     if (this.metadata) {
       data.append("meta", JSON.stringify(this.metadata));
     }

components/airparser/package.json

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

components/akeneo/actions/create-a-new-product-media-file/create-a-new-product-media-file.mjs

@@ -1,13 +1,13 @@
 import app from "../../akeneo.app.mjs";
-import utils from "../../common/utils.mjs";
-import { ConfigurationError } from "@pipedream/platform";
+import {
+  ConfigurationError, getFileStreamAndMetadata,
+} from "@pipedream/platform";
 import FormData from "form-data";
-import fs from "fs";
 
 export default {
   type: "action",
   key: "akeneo-create-a-new-product-media-file",
-  version: "0.0.1",
+  version: "0.1.0",
   name: "Create A New Product Media File",
   description: "Allows you to create a new media file and associate it to an attribute value of a given product or product model. [See the docs](https://api.akeneo.com/api-reference.html#post_media_files)",
   props: {
@@ -32,18 +32,15 @@ export default {
     },
     filename: {
       type: "string",
-      label: "File",
-      description: "The file to be uploaded, please provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc [here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      label: "File Path or URL",
+      description: "The file to be uploaded. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
     },
   },
   async run ({ $ }) {
     if (!this.productId && !this.productModelCode) {
       throw new ConfigurationError("Either `Product Identifier` or `Product Model Code` should be set!");
     }
-    const path = utils.checkTmp(this.filename);
-    if (!fs.existsSync(path)) {
-      throw new ConfigurationError("File does not exist!");
-    }
+
     const payload = {
       attribute: this.mediaFileAttributeCode,
       scope: null,
@@ -57,9 +54,15 @@ export default {
       payload.code = this.productModelCode;
       data.append("product_model", JSON.stringify(payload));
     }
-    const file = fs.readFileSync(path);
-    const fileParts = path.split("/");
-    data.append("file", file, fileParts[fileParts.length - 1]);
+
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.filename);
+    data.append("file", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
     const contentLength = data.getLengthSync();
     await this.app.createProductMediaFile({
       $,

components/akeneo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/akeneo",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Pipedream Akeneo Components",
   "main": "akeneo.app.mjs",
   "keywords": [
@@ -10,7 +10,7 @@
   "homepage": "https://pipedream.com/apps/akeneo",
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "dependencies": {
-    "@pipedream/platform": "^1.3.0",
+    "@pipedream/platform": "^3.1.0",
     "form-data": "^4.0.0"
   },
   "publishConfig": {

components/alttext_ai/actions/generate-alt-text/generate-alt-text.mjs

@@ -1,36 +1,35 @@
 import alttextAi from "../../alttext_ai.app.mjs";
-import fs from "fs";
+import {
+  ConfigurationError, getFileStream,
+} from "@pipedream/platform";
 import { LANGUAGE_OPTIONS } from "../../commons/constants.mjs";
-import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   key: "alttext_ai-generate-alt-text",
   name: "Generate Alt Text",
   description:
     "Generates a descriptive alt text for a given image. [See the documentation](https://alttext.ai/apidocs#tag/Images/operation/create-image)",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     alttextAi,
+    fileInfo: {
+      type: "alert",
+      alertType: "warning",
+      content: "Either `Image Data` or `Image File Path or URL` should be provided. If both are provided, `Image Data` will be used.",
+    },
     imageData: {
       type: "string",
       label: "Image Data",
       description:
-        "The image data in base64 format. Only one of `Image Data`, `Image File Path` or `Image URL` should be specified.",
-      optional: true,
-    },
-    imageUrl: {
-      type: "string",
-      label: "Image URL",
-      description:
-        "The public URL to an image. Only one of `Image URL`, `Image Data` or `Image File Path` should be specified.",
+        "The image data in base64 format",
       optional: true,
     },
     imageFilePath: {
       type: "string",
-      label: "Image File Path",
+      label: "Image File Path or URL",
       description:
-        "The path to an image file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#the-tmp-directory). Only one of `Image File Path`, `Image URL` or `Image Data` should be specified.",
+        "The image to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myImage.jpg`)",
       optional: true,
     },
     keywords: {
@@ -64,31 +63,29 @@ export default {
     },
   },
   async run({ $ }) {
-    if (
-      (!this.imageData && !this.imageFilePath && !this.imageUrl)
-      || (this.imageData && this.imageFilePath)
-      || (this.imageData && this.imageUrl)
-      || (this.imageFilePath && this.imageUrl)
-    ) {
-      throw new ConfigurationError("Only one of `Image Data`, `Image File Path` or `Image URL` should be specified.");
+    const {
+      imageData, imageFilePath,
+    } = this;
+    if (!imageData && !imageFilePath) {
+      throw new ConfigurationError("Either `Image Data` or `Image File Path or URL` should be specified.");
+    }
+
+    let rawData = imageData;
+    if (!rawData) {
+      const stream = await getFileStream(imageFilePath);
+      const chunks = [];
+      for await (const chunk of stream) {
+        chunks.push(chunk);
+      }
+      const buffer = Buffer.concat(chunks);
+      rawData = buffer.toString("base64");
     }
 
     const response = await this.alttextAi.generateAltText({
       $,
       data: {
         image: {
-          url: this.imageUrl,
-          raw:
-            this.imageData ??
-            (this.imageFilePath &&
-              fs.readFileSync(
-                this.imageFilePath.includes("tmp/")
-                  ? this.imageFilePath
-                  : `/tmp/${this.imageFilePath}`,
-                {
-                  encoding: "base64",
-                },
-              )),
+          raw: rawData,
         },
         keywords: this.keywords,
         negative_keywords: this.negativeKeywords,

components/alttext_ai/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/alttext_ai",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pipedream AltText.ai Components",
   "main": "alttext_ai.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1"
+    "@pipedream/platform": "^3.1.0"
   }
 }

components/askyourpdf/actions/add-document-via-file-upload/add-document-via-file-upload.mjs

@@ -6,13 +6,13 @@ export default {
   name: "Add Document Via File Upload",
   description: "Add a document via file upload. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#2.-adding-document-via-file-upload)",
   type: "action",
-  version: "0.0.2",
+  version: "0.1.0",
   props: {
     app,
     file: {
       type: "string",
-      label: "File Path",
-      description: "File path of a file previously downloaded in Pipedream E.g. (`/tmp/my-file.txt`). [Download a file to the `/tmp` directory](https://pipedream.com/docs/code/nodejs/http-requests/#download-a-file-to-the-tmp-directory)",
+      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`)",
     },
   },
   methods: {

components/askyourpdf/askyourpdf.app.mjs

@@ -27,12 +27,12 @@ export default {
         ...headers,
       };
     },
-    getConfig({
+    async getConfig({
       headers, data: preData, ...args
     } = {}) {
       const contentType = constants.CONTENT_TYPE_KEY_HEADER;
       const hasMultipartHeader = utils.hasMultipartHeader(headers);
-      const data = hasMultipartHeader && utils.getFormData(preData) || preData;
+      const data = hasMultipartHeader && await utils.getFormData(preData) || preData;
       const currentHeaders = this.getHeaders(headers);
 
       return {
@@ -49,7 +49,7 @@ export default {
     async makeRequest({
       step = this, path, headers, data, summary, ...args
     } = {}) {
-      const config = this.getConfig({
+      const config = await this.getConfig({
         url: this.getUrl(path),
         headers,
         data,