@pipedream/sharepoint 0.7.2 → 0.8.1

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.6",
+  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

@@ -8,7 +8,7 @@ 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.11",
+  version: "0.0.12",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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.3",
+  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",
@@ -84,6 +102,11 @@ 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,

package/common/file-picker-base.mjs

@@ -0,0 +1,308 @@
+import sharepoint from "../sharepoint.app.mjs";
+
+/**
+ * Shared prop definitions for file picker actions.
+ * These props provide a consistent file/folder browsing experience across actions.
+ */
+export const filePickerProps = {
+  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,
+      }),
+    ],
+    label: "Folder",
+    description: "The folder to browse. Leave empty to browse the root of the drive.",
+    optional: true,
+    withLabel: true,
+  },
+  fileOrFolderIds: {
+    propDefinition: [
+      sharepoint,
+      "fileOrFolderId",
+      (c) => ({
+        siteId: c.siteId,
+        driveId: c.driveId,
+        folderId: c.folderId,
+      }),
+    ],
+    type: "string[]",
+    label: "Files or Folders",
+    description: "Select one or more files, or select a folder and click 'Refresh Fields' to browse into it",
+    withLabel: true,
+  },
+};
+
+/**
+ * Shared methods for file picker actions.
+ * Provides common functionality for parsing selections, fetching metadata,
+ * and handling folder-only selections.
+ */
+export const filePickerMethods = {
+  /**
+   * Categorizes selections into files and folders based on isFolder property.
+   *
+   * @param {Array<{id: string, name: string, isFolder: boolean}>} selections
+   *   Array of parsed file/folder objects
+   * @returns {{files: Array, folders: Array}}
+   *   Object with separate files and folders arrays
+   * @example
+   * const { files, folders } = this.categorizeSelections([
+   *   { id: "1", name: "report.pdf", isFolder: false },
+   *   { id: "2", name: "Documents", isFolder: true }
+   * ]);
+   * // files: [{ id: "1", name: "report.pdf", isFolder: false }]
+   * // folders: [{ id: "2", name: "Documents", isFolder: true }]
+   */
+  categorizeSelections(selections) {
+    return {
+      folders: selections.filter((s) => s.isFolder),
+      files: selections.filter((s) => !s.isFolder),
+    };
+  },
+
+  /**
+   * Handles the case where only folders are selected
+   * @param {Object} $ - Pipedream step context
+   * @param {Array} folders - Array of folder objects
+   * @returns {Object} Response object with folder information
+   */
+  handleFolderOnlySelection($, folders) {
+    const folderNames = folders.map((f) => f.name).join(", ");
+    $.export("$summary", `Selected ${folders.length} folder(s): ${folderNames}. Set one as the Folder ID and refresh to browse its contents.`);
+    return {
+      type: "folders",
+      folders: folders.map((f) => ({
+        id: f.id,
+        name: f.name,
+      })),
+      message: "To browse a folder, set it as the folderId and reload props",
+    };
+  },
+
+  /**
+   * Constructs a SharePoint library view URL that opens the file in the
+   * document library context. This is useful for providing users with a
+   * link to view the file in SharePoint's web interface.
+   *
+   * @param {string} fileWebUrl - The file's webUrl from Microsoft Graph API
+   * @returns {string|null} SharePoint AllItems.aspx URL with file location,
+   *   or null if construction fails
+   * @example
+   * // Input: "https://contoso.sharepoint.com/sites/Marketing/..."
+   * // Output: "https://contoso.sharepoint.com/sites/Marketing/...aspx?..."
+   */
+  constructSharePointViewUrl(fileWebUrl) {
+    if (!fileWebUrl) return null;
+
+    try {
+      // Parse webUrl to extract components
+      // Example: https://tenant.sharepoint.com/sites/sitename/LibraryName/folder/file.ext
+      const url = new URL(fileWebUrl);
+
+      // Extract library path from webUrl (e.g., "Shared%20Documents")
+      // Match pattern: /sites/{sitename}/{libraryname}/...
+      const libraryMatch = fileWebUrl.match(/\/sites\/[^/]+\/([^/]+)/);
+      if (!libraryMatch) return null;
+
+      const libraryUrlPart = libraryMatch[1]; // This keeps the original encoding from webUrl
+
+      // Construct site URL
+      const siteUrlMatch = fileWebUrl.match(/(https:\/\/[^/]+\/sites\/[^/]+)/);
+      if (!siteUrlMatch) return null;
+
+      const siteUrl = siteUrlMatch[1];
+
+      // Construct the full file path (decode the pathname to get raw path)
+      const filePath = decodeURIComponent(url.pathname);
+
+      // Construct parent path by removing the filename
+      const parentPath = filePath.substring(0, filePath.lastIndexOf("/"));
+
+      // Build the AllItems.aspx URL - don't re-encode the library name in path
+      return `${siteUrl}/${libraryUrlPart}/Forms/AllItems.aspx?id=${encodeURIComponent(filePath)}&parent=${encodeURIComponent(parentPath)}`;
+    } catch (error) {
+      console.error("Error constructing SharePoint view URL:", error);
+      return null;
+    }
+  },
+
+  /**
+   * Fetches metadata for multiple files in parallel with individual error
+   * handling. Uses Promise.allSettled to ensure partial failures don't
+   * block successful fetches.
+   *
+   * @param {Object} $ - Pipedream step context for API calls
+   * @param {Array<{id: string, name: string}>} files
+   *   Array of file objects with id property
+   * @param {string} siteId - SharePoint site ID
+   * @param {string} driveId - Drive ID within the site
+   * @param {Object} [options={}] - Configuration options
+   * @param {boolean} [options.includeDownloadUrl=true]
+   *   Whether to include temporary downloadUrl in response
+   * @returns {Promise<{fileResults: Array, errors: Array}>}
+   *   Object with successful results and errors
+   * @example
+   * const { fileResults, errors } = await this.fetchFileMetadata(
+   *   $, files, siteId, driveId, { includeDownloadUrl: true }
+   * );
+   */
+  async fetchFileMetadata($, files, siteId, driveId, options = {}) {
+    const { includeDownloadUrl = true } = options;
+
+    // Fetch metadata for all selected files in parallel, handling individual failures
+    const settledResults = await Promise.allSettled(
+      files.map(async (selected) => {
+        // When includeDownloadUrl is true, omit $select to get @microsoft.graph.downloadUrl
+        // (Graph API excludes downloadUrl when using $select)
+        const params = includeDownloadUrl
+          ? {}
+          : {
+            $select: "id,name,size,webUrl,createdDateTime,lastModifiedDateTime,createdBy,lastModifiedBy,parentReference,file,folder,image,video,audio,photo,shared,fileSystemInfo,cTag,eTag,sharepointIds",
+          };
+
+        const file = await this.sharepoint.getDriveItem({
+          $,
+          siteId,
+          driveId,
+          fileId: selected.id,
+          params,
+        });
+
+        // Construct SharePoint library view URL
+        const sharepointViewUrl = this.constructSharePointViewUrl(file.webUrl);
+
+        const result = {
+          ...file,
+          ...(sharepointViewUrl && {
+            sharepointViewUrl,
+          }),
+          _meta: {
+            siteId,
+            driveId,
+            fileId: selected.id,
+          },
+        };
+
+        // Remove the Graph API property name from spread
+        delete result["@microsoft.graph.downloadUrl"];
+
+        // Conditionally include downloadUrl based on options
+        if (includeDownloadUrl) {
+          result.downloadUrl = file["@microsoft.graph.downloadUrl"];
+        }
+
+        return result;
+      }),
+    );
+
+    // Separate successful and failed results
+    const fileResults = [];
+    const errors = [];
+
+    settledResults.forEach((result, index) => {
+      if (result.status === "fulfilled") {
+        fileResults.push(result.value);
+      } else {
+        const selected = files[index];
+        const errorMessage = result.reason?.message || String(result.reason);
+        console.error(`Failed to fetch file ${selected.id} (${selected.name}): ${errorMessage}`);
+        errors.push({
+          fileId: selected.id,
+          fileName: selected.name,
+          error: errorMessage,
+        });
+      }
+    });
+
+    return {
+      fileResults,
+      errors,
+    };
+  },
+
+  /**
+   * Processes and formats the final results with user-friendly summary
+   * export. Handles single file vs. multiple files formatting for UX.
+   *
+   * @param {Object} $ - Pipedream step context for exports
+   * @param {Array} fileResults - Successfully fetched file metadata
+   * @param {Array} errors - Failed file fetches with error details
+   * @param {Array} folders
+   *   Selected folders (for informational purposes)
+   * @param {Object} [options={}] - Configuration options
+   * @param {string} [options.successVerb="Retrieved"]
+   *   Verb for summary (e.g., "Retrieved", "Downloaded")
+   * @param {string} [options.successNoun="file(s)"]
+   *   Noun for summary (e.g., "download URL(s)", "metadata")
+   * @returns {Object|Array} Single file object if one file, otherwise
+   *   object with files/errors/folders arrays
+   * @throws {Error} If all file fetches failed
+   * @example
+   * return this.processResults($, fileResults, errors, folders, {
+   *   successVerb: "Retrieved",
+   *   successNoun: "download URL(s)"
+   * });
+   */
+  processResults($, fileResults, errors, folders, options = {}) {
+    const {
+      successVerb = "Retrieved",
+      successNoun = "file(s)",
+    } = options;
+
+    // If all files failed, throw an error
+    if (fileResults.length === 0 && errors.length > 0) {
+      throw new Error(`Failed to fetch all selected files: ${errors.map((e) => e.fileName).join(", ")}`);
+    }
+
+    // If single file, return it directly for backwards compatibility
+    if (fileResults.length === 1 && folders.length === 0 && errors.length === 0) {
+      $.export("$summary", `${successVerb} ${successNoun} for: ${fileResults[0].name}`);
+      return fileResults[0];
+    }
+
+    // Multiple files: return as object with metadata
+    const fileNames = fileResults.map((f) => f.name).join(", ");
+    const summaryParts = [
+      `${successVerb} ${successNoun} for ${fileResults.length} file(s): ${fileNames}`,
+    ];
+    if (errors.length > 0) {
+      summaryParts.push(`Failed to fetch ${errors.length} file(s): ${errors.map((e) => e.fileName).join(", ")}`);
+    }
+    $.export("$summary", summaryParts.join(". "));
+
+    return {
+      files: fileResults,
+      ...(errors.length > 0 && {
+        errors,
+      }),
+      ...(folders.length > 0 && {
+        folders: folders.map((f) => ({
+          id: f.id,
+          name: f.name,
+        })),
+      }),
+    };
+  },
+};