@pipedream/salesforce_rest_api 1.0.1 → 1.0.2

package/README.md

@@ -1,13 +1,21 @@
 # Getting Started
 
-You can install the Pipedream Salesforce app in the [Accounts](https://pipedream.com/accounts) section of your account, or directly in a workflow.
+You can install the Pipedream Salesforce app in the [Accounts](https://pipedream.com/accounts) section of your Pipedream account, or directly in a workflow.
 
-## Configuring Webhook Sources in Salesforce
+## Prerequisite: Salesforce Edition with API Access
 
-The following three permissions must be configured on your Salesforce user in order to use the Salesforce Instant (webhook) triggers:
-1. Apex REST Services
-2. API Enabled
-3. Author Apex (which adds in additional permissions.)
+In order to use this application, you must be on a Salesforce Edition that has API Access, and API Access must be enabled. See [here](https://help.salesforce.com/s/articleView?id=000385436&type=1) for more details. 
+
+**Salesforce Editions with API Access**
+* Enterprise Edition
+* Unlimited Edition
+* Developer Edition
+* Performance Edition
+* Professional Edition (API access available as an add-on) 
+
+### Enabling API Access on Salesforce
+
+Your Salesforce user needs a **System Administrator** profile in order to enable API access. If you don't have this on your Salesforce Profile, ask your System Administrator to enable API Access for your user.
 
 The most straightforward way to add these permissions is to create a new Permission Set in Salesforce, and to add it to the user once created.
 
@@ -18,13 +26,10 @@ Here is a step-by-step on how to do this:
 1. Navigate to your Salesforce instance, and click the Setup wheel in the top-right corner.
 2. Under the Administration tab on the lefthand sidebar, click Users --> Permission Sets.
 3. On the Permissions Set page, click New.
-4. Create a new permission set, give it a label, API name, and description. Example:
+4. Create a new permission set, give it a label, API name, and description. Example: <br>
 **Label**: Pipedream API Access
 **API Name**: Pipedream
-**Description**: Adds a set of permissions required for Pipedream sources:
-- Apex REST Services
-- API Enabled
-- Author Apex
+**Description**: Adds a set of permissions required for Pipedream. 
 
  <img src="https://res.cloudinary.com/dpenc2lit/image/upload/v1702598220/Screenshot_2023-12-14_at_2.57.21_PM_dfgsrw.png" width=500>
 
@@ -36,13 +41,18 @@ Here is a step-by-step on how to do this:
 6. From System Permissions, click Edit.
 <img src="https://res.cloudinary.com/dpenc2lit/image/upload/v1702598417/Screenshot_2023-12-14_at_3.01.38_PM_pvbopv.png" width=500>
 
-7. Select the following permissions, and click Save.
-- Apex REST Services
+7. Select the following permission, and click Save.
 - API Enabled
-- Author Apex (which adds in additional permissions.)
+
+If you'd like to utilize Pipedream's webhook triggers, you will need to add the following permissions to the permissions set as well:
+- Apex REST Services
+- Author Apex
+- View Roles and Role Hierarchy
+- Modify Metadata Through Metadata API Functions
+- View Setup and Configuration
 <img src="https://res.cloudinary.com/dpenc2lit/image/upload/v1702598514/Screenshot_2023-12-14_at_3.48.50_PM_pcychy.png" width=500>
 
-8. The list of added permissions should look like this, and click save again.
+8. The list of added permissions (6) should look like this, and click save again.
 <img src="https://res.cloudinary.com/dpenc2lit/image/upload/v1702598417/Screenshot_2023-12-14_at_3.10.17_PM_urgge8.png" width=500>
 
 **Add Permission Set to User**
@@ -53,7 +63,8 @@ Here is a step-by-step on how to do this:
 10. Select the user you'd like to assign this permission set to, and click Assign. The user should now show up under Current Assignments.
 <img src="https://res.cloudinary.com/dpenc2lit/image/upload/v1702598514/Screenshot_2023-12-14_at_3.52.42_PM_w4ge4p.png" width=500>
 
-11. You should now be able to use any of the Salesforce (Instant) Triggers on Pipedream!
+11. You should now be able to use the Salesforce integration along with the webhook triggers if you configured the required permissions above.
+
 
 # Troubleshooting
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/salesforce_rest_api",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Pipedream Salesforce (REST API) Components",
   "main": "salesforce_rest_api.app.mjs",
   "keywords": [

package/sources/common.mjs

@@ -51,6 +51,19 @@ export default {
     processEvent() {
       throw new Error("processEvent is not implemented");
     },
+    chunkArray(array, chunkSize = 25) {
+      return array.reduce((chunks, item, index) => {
+        const chunkIndex = Math.floor(index / chunkSize);
+
+        if (!chunks[chunkIndex]) {
+          chunks[chunkIndex] = [];
+        }
+
+        chunks[chunkIndex].push(item);
+
+        return chunks;
+      }, []);
+    },
     getRelativeObjectUrl(id, historyObjectType) {
       const {
         salesforce,
@@ -73,6 +86,38 @@ export default {
         ...args,
       });
     },
+    makeChunkBatchRequests({
+      ids, objectType, ...args
+    } = {}) {
+      const {
+        batchRequest,
+        chunkArray,
+      } = this;
+
+      const chunks = chunkArray(ids);
+      const promises = chunks.map((ids) => batchRequest({
+        data: {
+          batchRequests: this.getBatchRequests(ids, objectType),
+          ...args?.data,
+        },
+        ...args,
+      }));
+      return Promise.all(promises);
+    },
+    getChunkBatchResults(responses) {
+      return responses.reduce((acc, { results }) => [
+        ...acc,
+        ...results,
+      ], []);
+    },
+    async makeChunkBatchRequestsAndGetResults(args) {
+      const {
+        makeChunkBatchRequests,
+        getChunkBatchResults,
+      } = this;
+      const responses = await makeChunkBatchRequests(args);
+      return getChunkBatchResults(responses);
+    },
   },
   async run(event) {
     const startTimestamp = this.getLatestDateCovered();

package/sources/new-record/new-record.mjs

@@ -8,7 +8,7 @@ export default {
   name: "New Record (of Selectable Type)",
   key: "salesforce_rest_api-new-record",
   description: "Emit new event (at regular intervals) when a record of arbitrary object type (selected as an input parameter by the user) is created. See [the docs](https://sforce.co/3yPSJZy) for more information.",
-  version: "0.0.2",
+  version: "0.0.3",
   methods: {
     ...common.methods,
     isItemRelevant(item, startTimestamp, endTimestamp) {
@@ -37,6 +37,16 @@ export default {
       };
     },
     async processEvent(eventData) {
+      const {
+        salesforce,
+        objectType,
+        setLatestDateCovered,
+        makeChunkBatchRequestsAndGetResults,
+        isItemRelevant,
+        generateMeta,
+        $emit: emit,
+      } = this;
+
       const {
         startTimestamp,
         endTimestamp,
@@ -44,21 +54,19 @@ export default {
       const {
         ids,
         latestDateCovered,
-      } = await this.salesforce.getUpdatedForObjectType(
-        this.objectType,
+      } = await salesforce.getUpdatedForObjectType(
+        objectType,
         startTimestamp,
         endTimestamp,
       );
-      this.setLatestDateCovered(latestDateCovered);
+      setLatestDateCovered(latestDateCovered);
 
       if (!ids?.length) {
         return console.log("No batch requests to send");
       }
 
-      const { results } = await this.batchRequest({
-        data: {
-          batchRequests: this.getBatchRequests(ids),
-        },
+      const results = await makeChunkBatchRequestsAndGetResults({
+        ids,
       });
 
       results
@@ -66,10 +74,10 @@ export default {
           statusCode, result: item,
         }) =>
           statusCode === 200
-          && this.isItemRelevant(item, startTimestamp, endTimestamp))
+          && isItemRelevant(item, startTimestamp, endTimestamp))
         .forEach(({ result: item }) => {
-          const meta = this.generateMeta(item);
-          this.$emit(item, meta);
+          const meta = generateMeta(item);
+          emit(item, meta);
         });
     },
   },

package/sources/object-updated/object-updated.mjs

@@ -8,7 +8,7 @@ export default {
   name: "New Updated Object (of Selectable Type)",
   key: "salesforce_rest_api-object-updated",
   description: "Emit new event (at regular intervals) when an object of arbitrary type (selected as an input parameter by the user) is updated. [See the docs](https://sforce.co/3yPSJZy) for more information.",
-  version: "0.1.7",
+  version: "0.1.8",
   methods: {
     ...common.methods,
     generateMeta(item) {
@@ -29,35 +29,43 @@ export default {
       };
     },
     async processEvent(eventData) {
+      const {
+        salesforce,
+        objectType,
+        setLatestDateCovered,
+        makeChunkBatchRequestsAndGetResults,
+        generateMeta,
+        $emit: emit,
+      } = this;
+
       const {
         startTimestamp,
         endTimestamp,
       } = eventData;
+
       const {
         ids,
         latestDateCovered,
-      } = await this.salesforce.getUpdatedForObjectType(
-        this.objectType,
+      } = await salesforce.getUpdatedForObjectType(
+        objectType,
         startTimestamp,
         endTimestamp,
       );
-      this.setLatestDateCovered(latestDateCovered);
+      setLatestDateCovered(latestDateCovered);
 
       if (!ids?.length) {
         return console.log("No batch requests to send");
       }
 
-      const { results } = await this.batchRequest({
-        data: {
-          batchRequests: this.getBatchRequests(ids),
-        },
+      const results = await makeChunkBatchRequestsAndGetResults({
+        ids,
       });
 
       results
         .filter(({ statusCode }) => statusCode === 200)
         .forEach(({ result: item }) => {
-          const meta = this.generateMeta(item);
-          this.$emit(item, meta);
+          const meta = generateMeta(item);
+          emit(item, meta);
         });
     },
   },

package/sources/updated-field-on-record/updated-field-on-record.mjs

@@ -15,7 +15,7 @@ export default {
   name: "New Updated Field on Record (of Selectable Type)",
   key: "salesforce_rest_api-updated-field-on-record",
   description: "Emit new event (at regular intervals) when a field of your choosing is updated on any record of a specified Salesforce object. Field history tracking must be enabled for the chosen field. See the docs on [field history tracking](https://sforce.co/3mtj0rF) and [history objects](https://sforce.co/3Fn4lWB) for more information.",
-  version: "0.1.7",
+  version: "0.1.8",
   props: {
     ...common.props,
     objectType: {
@@ -130,8 +130,7 @@ export default {
         salesforce,
         _getHistoryObjectType,
         setLatestDateCovered,
-        batchRequest,
-        getBatchRequests,
+        makeChunkBatchRequestsAndGetResults,
         isRelevant,
         getUniqueParentIds,
         _getParentId,
@@ -154,11 +153,10 @@ export default {
       setLatestDateCovered((new Date(latestDateCovered)).toISOString());
 
       if (ids?.length) {
-        ({ results: historyItemRetrievals } = await batchRequest({
-          data: {
-            batchRequests: getBatchRequests(ids, historyObjectType),
-          },
-        }));
+        historyItemRetrievals = await makeChunkBatchRequestsAndGetResults({
+          ids,
+          objectType: historyObjectType,
+        });
       }
 
       const historyItems = historyItemRetrievals
@@ -170,11 +168,9 @@ export default {
       const parentIds = getUniqueParentIds(historyItems);
 
       if (parentIds.length) {
-        ({ results: itemRetrievals } = await batchRequest({
-          data: {
-            batchRequests: getBatchRequests(parentIds),
-          },
-        }));
+        itemRetrievals = await makeChunkBatchRequestsAndGetResults({
+          ids: parentIds,
+        });
       }
 
       const itemsById = itemRetrievals