@pipedream/sharepoint 0.7.0 → 0.7.2

package/actions/create-link/create-link.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sharepoint-create-link",
   name: "Create Link",
   description: "Create a sharing link for a DriveItem. [See the documentation](https://docs.microsoft.com/en-us/graph/api/driveitem-createlink?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.5",
+  version: "0.0.6",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/download-file/download-file.mjs

@@ -1,11 +1,14 @@
 import sharepoint from "../../sharepoint.app.mjs";
 import fs from "fs";
+import path from "path";
+import { ConfigurationError } from "@pipedream/platform";
+import constants from "../../common/constants.mjs";
 
 export default {
   key: "sharepoint-download-file",
   name: "Download File",
   description: "Download a Microsoft Sharepoint file to the /tmp directory. [See the documentation](https://learn.microsoft.com/en-us/graph/api/driveitem-get-content?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.10",
+  version: "0.0.11",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
@@ -44,31 +47,114 @@ export default {
       label: "Filename",
       description: "The filename to save the downloaded file as in the `/tmp` directory",
     },
+    convertToFormat: {
+      type: "string",
+      label: "Convert To Format",
+      description: "The format to convert the file to. See the [Format Options](https://learn.microsoft.com/en-us/graph/api/driveitem-get-content-format?view=graph-rest-1.0&tabs=http#format-options) for supported source formats",
+      options: [
+        "pdf",
+        "html",
+      ],
+      optional: true,
+    },
     syncDir: {
       type: "dir",
       accessMode: "write",
       sync: true,
     },
   },
+  methods: {
+    async getOriginalFileData($) {
+      const { name: originalFilename } = await this.sharepoint.getDriveItem({
+        $,
+        driveId: this.driveId,
+        siteId: this.siteId,
+        fileId: this.fileId,
+      });
+      const originalExtension = path.extname(originalFilename).slice(1)
+        .toLowerCase() || undefined;
+      return {
+        originalFilename,
+        originalExtension,
+      };
+    },
+    formatNewFilename(originalExtension) {
+      const parsed = path.parse(this.filename);
+      if (this.convertToFormat) {
+        const base = parsed.ext
+          ? parsed.name
+          : this.filename;
+        return `${base}.${this.convertToFormat.toLowerCase()}`;
+      }
+      if (parsed.ext) {
+        return this.filename;
+      }
+      return originalExtension
+        ? `${this.filename}.${originalExtension}`
+        : this.filename;
+    },
+    validateConversionFormat(originalExtension) {
+      const supportedFormats = this.convertToFormat === "pdf"
+        ? constants.PDF_CONVERTIBLE_FORMATS
+        : this.convertToFormat === "html"
+          ? constants.HTML_CONVERTIBLE_FORMATS
+          : [];
+      if (!supportedFormats.includes(originalExtension)) {
+        throw new ConfigurationError(`The file extension "${originalExtension}" is not supported for conversion to "${this.convertToFormat}". Supported formats are: ${supportedFormats.join(", ")}`);
+      }
+    },
+  },
   async run({ $ }) {
-    const response = await this.sharepoint.getFile({
+    const {
+      originalFilename, originalExtension,
+    } = await this.getOriginalFileData($);
+
+    // ensure filename has an extension
+    const filename = this.formatNewFilename(originalExtension);
+
+    if (this.convertToFormat) {
+      this.validateConversionFormat(originalExtension);
+    }
+
+    let response;
+    let args = {
       $,
       driveId: this.driveId,
       fileId: this.fileId,
-      responseType: "arraybuffer",
-    });
+      params: {
+        format: this.convertToFormat,
+      },
+    };
+    try {
+      response = await this.sharepoint.getFile({
+        ...args,
+        responseType: "arraybuffer",
+      });
+    } catch {
+      // throw error without buffer encoding
+      await this.sharepoint.getFile(args);
+    }
 
     const rawcontent = response.toString("base64");
     const buffer = Buffer.from(rawcontent, "base64");
     // Since the filepath is not returned as one of the standard keys (filePath
     // or path), save the file to STASH_DIR, if defined, so it is synced at the
     // end of execution.
-    const downloadedFilepath = `${process.env.STASH_DIR || "/tmp"}/${this.filename}`;
+    const downloadedFilepath = `${process.env.STASH_DIR || "/tmp"}/${filename}`;
     fs.writeFileSync(downloadedFilepath, buffer);
 
-    return {
-      filename: this.filename,
+    const data = {
+      filename,
+      fileSize: `${buffer.length} bytes`,
+      extension: this.convertToFormat || originalExtension,
       downloadedFilepath,
     };
+
+    if (this.convertToFormat) {
+      data.originalFilename = originalFilename;
+      data.originalExtension = originalExtension;
+    }
+
+    return data;
   },
 };

package/actions/find-file-by-name/find-file-by-name.mjs

@@ -6,7 +6,7 @@ export default {
   key: "sharepoint-find-file-by-name",
   name: "Find File by Name",
   description: "Search for a file or folder by name. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_search)",
-  version: "0.1.2",
+  version: "0.1.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/get-excel-table/get-excel-table.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-get-excel-table",
   name: "Get Excel Table",
   description: "Retrieve a table from an Excel spreadsheet stored in Sharepoint [See the documentation](https://learn.microsoft.com/en-us/graph/api/table-range?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -13,11 +13,10 @@ export default {
   },
   props: {
     sharepoint,
+    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
     alert: {
       type: "alert",
       alertType: "info",
-      label: "Excel Table Information",
-      description: "Information about selecting Excel tables",
       content: `Note: The table must exist within the Excel spreadsheet.
         \nSee Microsoft's documentation on how to [Create and Format a Table](https://support.microsoft.com/en-us/office/create-and-format-tables-e81aa349-b006-4f8a-9806-5af9df0ac664)
       `,

package/common/constants.mjs

@@ -24,6 +24,51 @@ const SHARING_LINK_SCOPE_OPTIONS = [
   },
 ];
 
+const PDF_CONVERTIBLE_FORMATS = [
+  "doc",
+  "docx",
+  "dot",
+  "dotx",
+  "dotm",
+  "dsn",
+  "dwg",
+  "eml",
+  "epub",
+  "fluidframework",
+  "form",
+  "htm",
+  "html",
+  "loop",
+  "loot",
+  "markdown",
+  "md",
+  "msg",
+  "note",
+  "odp",
+  "ods",
+  "odt",
+  "page",
+  "pps",
+  "ppsx",
+  "ppt",
+  "pptx",
+  "pulse",
+  "rtf",
+  "task",
+  "tif",
+  "tiff",
+  "wbtx",
+  "whiteboard",
+  "xls",
+  "xlsm",
+  "xlsx",
+];
+
+const HTML_CONVERTIBLE_FORMATS = [
+  "loop",
+  "fluid",
+  "wbtx",
+];
 const RETURN_CONTENT_TYPE_OPTIONS = [
   {
     label: "Only Files",
@@ -42,5 +87,7 @@ const RETURN_CONTENT_TYPE_OPTIONS = [
 export default {
   SHARING_LINK_TYPE_OPTIONS,
   SHARING_LINK_SCOPE_OPTIONS,
+  PDF_CONVERTIBLE_FORMATS,
+  HTML_CONVERTIBLE_FORMATS,
   RETURN_CONTENT_TYPE_OPTIONS,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/sharepoint",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "Pipedream Microsoft Sharepoint Online Components",
   "main": "sharepoint.app.mjs",
   "keywords": [