@pipedream/sharepoint 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Microsoft SharePoint Online API opens up a world of possibilities for integrating your SharePoint content with other services and automating tasks. With Pipedream, you can harness this API to create powerful workflows that trigger on events in SharePoint, manipulate data, and connect with countless other apps. Create custom automations for document management, team notifications, content moderation, and more, without the need to manage infrastructure.
+
+# Example Use Cases
+
+- **Automate Document Approval Workflows**: Trigger a workflow in Pipedream whenever a new document is uploaded to a SharePoint library. Use the API to send approval requests via email using an app like SendGrid. Once approved, update the document's metadata in SharePoint to reflect the change.
+
+- **Sync SharePoint Lists with External Databases**: Keep a SharePoint list in sync with an external database, such as MySQL or PostgreSQL. Use scheduled Pipedream workflows to fetch records from the database and update the corresponding SharePoint list items, or vice versa.
+
+- **Aggregate SharePoint Analytics**: Collect and aggregate analytics from SharePoint, like page views or document downloads. Send this data to a service like Google Sheets or Data Studio for advanced reporting and visualization.

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.1",
+  version: "0.0.3",
   type: "action",
   props: {
     sharepoint,

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.1",
+  version: "0.0.3",
   type: "action",
   props: {
     sharepoint,

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

@@ -0,0 +1,61 @@
+import sharepoint from "../../sharepoint.app.mjs";
+import fs from "fs";
+
+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.1",
+  type: "action",
+  props: {
+    sharepoint,
+    siteId: {
+      propDefinition: [
+        sharepoint,
+        "siteId",
+      ],
+    },
+    driveId: {
+      propDefinition: [
+        sharepoint,
+        "driveId",
+        (c) => ({
+          siteId: c.siteId,
+        }),
+      ],
+    },
+    fileId: {
+      propDefinition: [
+        sharepoint,
+        "fileId",
+        (c) => ({
+          siteId: c.siteId,
+          driveId: c.driveId,
+        }),
+      ],
+    },
+    filename: {
+      type: "string",
+      label: "Filename",
+      description: "The filename to save the downloaded file as in the `/tmp` directory",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.sharepoint.getFile({
+      $,
+      siteId: this.siteId,
+      fileId: this.fileId,
+      responseType: "arraybuffer",
+    });
+
+    const rawcontent = response.toString("base64");
+    const buffer = Buffer.from(rawcontent, "base64");
+    const downloadedFilepath = `/tmp/${this.filename}`;
+    fs.writeFileSync(downloadedFilepath, buffer);
+
+    return {
+      filename: this.filename,
+      downloadedFilepath,
+    };
+  },
+};

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

@@ -0,0 +1,80 @@
+import sharepoint from "../../sharepoint.app.mjs";
+import utils from "../../common/utils.mjs";
+
+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.2",
+  type: "action",
+  props: {
+    sharepoint,
+    siteId: {
+      propDefinition: [
+        sharepoint,
+        "siteId",
+      ],
+    },
+    listId: {
+      propDefinition: [
+        sharepoint,
+        "listId",
+        (c) => ({
+          siteId: c.siteId,
+        }),
+      ],
+      reloadProps: true,
+    },
+    itemId: {
+      propDefinition: [
+        sharepoint,
+        "itemId",
+        (c) => ({
+          siteId: c.siteId,
+          listId: c.listId,
+        }),
+      ],
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    const { value: columns } = await this.sharepoint.listColumns({
+      siteId: this.siteId,
+      listId: this.listId,
+    });
+    const editableColumns = columns?.filter(({ readOnly }) => !readOnly) || [];
+    for (const column of editableColumns) {
+      props[column.name] = {
+        type: "string",
+        label: column.name,
+        optional: true,
+      };
+    }
+    return props;
+  },
+  async run({ $ }) {
+    const {
+      sharepoint,
+      siteId,
+      listId,
+      itemId,
+      ...otherProps
+    } = this;
+
+    const data = utils.cleanObject(otherProps);
+
+    const response = await sharepoint.updateItem({
+      siteId,
+      listId,
+      itemId,
+      data,
+      $,
+    });
+
+    if (response?.id) {
+      $.export("$summary", `Successfully updated item with ID ${response.id}.`);
+    }
+
+    return response;
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,10 @@
+export default {
+  cleanObject(o) {
+    for (var k in o || {}) {
+      if (typeof o[k] === "undefined") {
+        delete o[k];
+      }
+    }
+    return o;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/sharepoint",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Pipedream Microsoft Sharepoint Online Components",
   "main": "sharepoint.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1"
+    "@pipedream/platform": "^3.0.3"
   }
 }

package/sharepoint.app.mjs

@@ -87,6 +87,97 @@ export default {
         };
       },
     },
+    itemId: {
+      type: "string",
+      label: "Item",
+      description: "Identifier of an item",
+      async options({
+        prevContext, siteId, listId,
+      }) {
+        if (!siteId) {
+          return [];
+        }
+        const args = {
+          siteId,
+          listId,
+        };
+        if (prevContext?.nextLink) {
+          args.url = prevContext.nextLink;
+        }
+        const response = await this.listItems(args);
+        const options = response.value?.map(({ id: value }) => ({
+          value,
+          label: `Item ${value}`,
+        })) || [];
+        return {
+          options,
+          context: {
+            nextLink: response["@odata.nextLink"],
+          },
+        };
+      },
+    },
+    driveId: {
+      type: "string",
+      label: "Drive ID",
+      description: "Identifier of a drive within a site",
+      async options({
+        prevContext, siteId,
+      }) {
+        if (!siteId) {
+          return [];
+        }
+        const args = {
+          siteId,
+        };
+        if (prevContext?.nextLink) {
+          args.url = prevContext.nextLink;
+        }
+        const response = await this.listSiteDrives(args);
+        const options = response.value?.map(({
+          id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+        return {
+          options,
+          context: {
+            nextLink: response["@odata.nextLink"],
+          },
+        };
+      },
+    },
+    fileId: {
+      type: "string",
+      label: "File ID",
+      description: "The file to download. You can either search for the file here or provide a custom *File ID*.",
+      useQuery: true,
+      async options({
+        query, siteId, driveId,
+      }) {
+        const response = query
+          ? await this.searchDriveItems({
+            siteId,
+            query,
+            params: {
+              select: "folder,name,id",
+            },
+          })
+          : await this.listDriveItems({
+            siteId,
+            driveId,
+          });
+        const values = response.value.filter(({ folder }) => !folder);
+        return values
+          .map(({
+            name, id,
+          }) => ({
+            label: name,
+            value: id,
+          }));
+      },
+    },
   },
   methods: {
     _baseUrl() {
@@ -138,6 +229,38 @@ export default {
         ...args,
       });
     },
+    listSiteDrives({
+      siteId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/drives`,
+        ...args,
+      });
+    },
+    listDriveItems({
+      siteId, driveId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/drives/${driveId}/items/root/children`,
+        ...args,
+      });
+    },
+    searchDriveItems({
+      siteId, query, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/drive/root/search(q='${query}')`,
+        ...args,
+      });
+    },
+    getFile({
+      siteId, fileId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/drive/items/${fileId}/content`,
+        ...args,
+      });
+    },
     createList({
       siteId, ...args
     }) {
@@ -156,6 +279,15 @@ export default {
         ...args,
       });
     },
+    updateItem({
+      siteId, listId, itemId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/lists/${listId}/items/${itemId}/fields`,
+        method: "PATCH",
+        ...args,
+      });
+    },
     async *paginate({
       fn, args,
     }) {

package/sources/new-list-item/new-list-item.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sharepoint-new-list-item",
   name: "New List Item",
   description: "Emit new event when a new list is created in Microsoft Sharepoint.",
-  version: "0.0.1",
+  version: "0.0.3",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/updated-list-item/updated-list-item.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sharepoint-updated-list-item",
   name: "Updated List Item",
   description: "Emit new event when a list is updated in Microsoft Sharepoint.",
-  version: "0.0.1",
+  version: "0.0.3",
   type: "source",
   dedupe: "unique",
   props: {