@pipedream/sharepoint 0.7.1 → 0.8.0

package/actions/create-folder/create-folder.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-create-folder",
   name: "Create Folder",
   description: "Create a new folder in SharePoint. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_post_children?view=odsp-graph-online)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/create-item/create-item.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-create-item",
   name: "Create Item",
   description: "Create a new item in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/listitem-create?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.10",
+  version: "0.0.11",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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.7",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/create-list/create-list.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-create-list",
   name: "Create List",
   description: "Create a new list in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/list-create?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.10",
+  version: "0.0.11",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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.12",
   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/download-files/download-files.mjs

@@ -0,0 +1,88 @@
+import sharepoint from "../../sharepoint.app.mjs";
+import utils from "../../common/utils.mjs";
+import { filePickerMethods } from "../../common/file-picker-base.mjs";
+
+export default {
+  key: "sharepoint-download-files",
+  name: "Download Files",
+  description: "Browse and select files from SharePoint and get their metadata along with pre-authenticated download URLs (valid ~1 hour). [See the documentation](https://learn.microsoft.com/en-us/graph/api/driveitem-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    sharepoint,
+    siteId: {
+      propDefinition: [
+        sharepoint,
+        "siteId",
+      ],
+      withLabel: true,
+    },
+    driveId: {
+      propDefinition: [
+        sharepoint,
+        "driveId",
+        (c) => ({
+          siteId: c.siteId,
+        }),
+      ],
+      withLabel: true,
+    },
+    folderId: {
+      propDefinition: [
+        sharepoint,
+        "folderId",
+        (c) => ({
+          siteId: c.siteId,
+          driveId: c.driveId,
+        }),
+      ],
+      description: "The folder to browse. Leave empty to browse the root of the drive.",
+      optional: true,
+      withLabel: true,
+    },
+    fileIds: {
+      propDefinition: [
+        sharepoint,
+        "fileIds",
+        (c) => ({
+          siteId: c.siteId,
+          driveId: c.driveId,
+          folderId: c.folderId,
+        }),
+      ],
+      label: "Files",
+      description: "Select one or more files to download. **Note:** Only files can be downloaded; folders are not supported.",
+    },
+  },
+  methods: filePickerMethods,
+  async run({ $ }) {
+    // Parse the fileIds (which are JSON strings from the file picker)
+    const selections = utils.parseFileOrFolderList(this.fileIds);
+
+    if (selections.length === 0) {
+      throw new Error("Please select at least one file");
+    }
+
+    const siteId = this.sharepoint.resolveWrappedValue(this.siteId);
+    const driveId = this.sharepoint.resolveWrappedValue(this.driveId);
+
+    // Fetch metadata for all selected files with download URLs
+    const {
+      fileResults,
+      errors,
+    } = await this.fetchFileMetadata($, selections, siteId, driveId, {
+      includeDownloadUrl: true,
+    });
+
+    // Process and return results (no folders to handle)
+    return this.processResults($, fileResults, errors, [], {
+      successVerb: "Retrieved",
+      successNoun: "download URL(s)",
+    });
+  },
+};

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.4",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/find-files-with-metadata/find-files-with-metadata.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Find Files in List with Metadata",
   description:
     "Search and filter items in a SharePoint list based on metadata and custom columns. [See docs here](https://learn.microsoft.com/en-us/graph/api/listitem-list)",
-  version: "0.0.1",
+  version: "0.0.2",
   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.5",
+  version: "0.0.6",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/get-file-by-id/get-file-by-id.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-get-file-by-id",
   name: "Get File by ID",
   description: "Retrieves a file by ID. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/get-site/get-site.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-get-site",
   name: "Get Site",
   description: "Get a site in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/site-get?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-files-in-folder/list-files-in-folder.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-list-files-in-folder",
   name: "List Files in Folder",
   description: "Retrieves a list of the files and/or folders directly within a folder. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_list_children)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-sites/list-sites.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-list-sites",
   name: "List Sites",
   description: "List all sites in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/site-list?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/retrieve-file-metadata/retrieve-file-metadata.mjs

@@ -0,0 +1,55 @@
+import utils from "../../common/utils.mjs";
+import {
+  filePickerProps,
+  filePickerMethods,
+} from "../../common/file-picker-base.mjs";
+
+export default {
+  key: "sharepoint-retrieve-file-metadata",
+  name: "Retrieve File Metadata",
+  description: "Browse and select files from SharePoint to retrieve their metadata (name, size, dates, etc.) without download URLs. [See the documentation](https://learn.microsoft.com/en-us/graph/api/driveitem-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: filePickerProps,
+  methods: filePickerMethods,
+  async run({ $ }) {
+    const selections = utils.parseFileOrFolderList(this.fileOrFolderIds);
+
+    if (selections.length === 0) {
+      throw new Error("Please select at least one file or folder");
+    }
+
+    const siteId = this.sharepoint.resolveWrappedValue(this.siteId);
+    const driveId = this.sharepoint.resolveWrappedValue(this.driveId);
+
+    // Separate files and folders
+    const {
+      files,
+      folders,
+    } = this.categorizeSelections(selections);
+
+    // If only folders selected, return folder info
+    if (files.length === 0 && folders.length > 0) {
+      return this.handleFolderOnlySelection($, folders);
+    }
+
+    // Fetch metadata for all selected files WITHOUT download URLs
+    const {
+      fileResults,
+      errors,
+    } = await this.fetchFileMetadata($, files, siteId, driveId, {
+      includeDownloadUrl: false,
+    });
+
+    // Process and return results
+    return this.processResults($, fileResults, errors, folders, {
+      successVerb: "Retrieved",
+      successNoun: "metadata",
+    });
+  },
+};

package/actions/search-and-filter-files/search-and-filter-files.mjs

@@ -6,7 +6,7 @@ export default {
   name: "Search and Filter Files",
   description:
     "Search and filter SharePoint files based on metadata and custom columns. This action allows you to query files using SharePoint's custom properties, managed metadata, and other column values. [See the documentation](https://learn.microsoft.com/en-us/graph/api/listitem-list)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/search-files/search-files.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-search-files",
   name: "Search Files",
   description: "Search for files in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/search-query?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/search-sites/search-sites.mjs

@@ -4,7 +4,7 @@ export default {
   key: "sharepoint-search-sites",
   name: "Search Sites",
   description: "Search for sites in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/site-search?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/update-item/update-item.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sharepoint-update-item",
   name: "Update Item",
   description: "Updates an existing item in Microsoft Sharepoint. [See the documentation](https://learn.microsoft.com/en-us/graph/api/listitem-update?view=graph-rest-1.0&tabs=http)",
-  version: "0.0.10",
+  version: "0.0.11",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/upload-file/upload-file.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sharepoint-upload-file",
   name: "Upload File",
   description: "Upload a file to OneDrive. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_put_content?view=odsp-graph-online)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,

package/common/constants.mjs

@@ -1,3 +1,21 @@
+/**
+ * Microsoft Graph subscription constants for SharePoint webhooks.
+ * https://learn.microsoft.com/en-us/graph/api/subscription-post-subscriptions
+ */
+
+/**
+ * Maximum subscription lifetime for driveItem resources is 42,300 minutes (~29.4 days).
+ * We use 29 days in milliseconds to stay safely within the limit.
+ */
+const WEBHOOK_SUBSCRIPTION_EXPIRATION_TIME_MILLISECONDS = 29 * 24 * 60 * 60 * 1000;
+
+/**
+ * Renewal interval at 95% of max lifetime to ensure renewal before expiration.
+ * 29 days * 0.95 = 27.55 days = 2,380,320 seconds
+ */
+const WEBHOOK_SUBSCRIPTION_RENEWAL_SECONDS =
+  (WEBHOOK_SUBSCRIPTION_EXPIRATION_TIME_MILLISECONDS * 0.95) / 1000;
+
 const SHARING_LINK_TYPE_OPTIONS = [
   {
     label: "Create a read-only link to the DriveItem",
@@ -24,6 +42,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",
@@ -39,8 +102,15 @@ const RETURN_CONTENT_TYPE_OPTIONS = [
   },
 ];
 
+export {
+  WEBHOOK_SUBSCRIPTION_EXPIRATION_TIME_MILLISECONDS,
+  WEBHOOK_SUBSCRIPTION_RENEWAL_SECONDS,
+};
+
 export default {
   SHARING_LINK_TYPE_OPTIONS,
   SHARING_LINK_SCOPE_OPTIONS,
+  PDF_CONVERTIBLE_FORMATS,
+  HTML_CONVERTIBLE_FORMATS,
   RETURN_CONTENT_TYPE_OPTIONS,
 };