@pipedream/salesforce_rest_api 1.12.1 → 1.13.0

package/actions/add-contact-to-campaign/add-contact-to-campaign.mjs

@@ -5,7 +5,7 @@ export default {
   key: "salesforce_rest_api-add-contact-to-campaign",
   name: "Add Contact to Campaign",
   description: "Adds an existing contact to an existing campaign. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_campaignmember.htm)",
-  version: "0.1.4",
+  version: "0.1.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/add-lead-to-campaign/add-lead-to-campaign.mjs

@@ -5,7 +5,7 @@ export default {
   key: "salesforce_rest_api-add-lead-to-campaign",
   name: "Add Lead to Campaign",
   description: "Adds an existing lead to an existing campaign. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_campaignmember.htm)",
-  version: "0.1.4",
+  version: "0.1.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/get-current-user/get-current-user.mjs

@@ -0,0 +1,34 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-get-current-user",
+  name: "Get Current User",
+  description: "Returns the authenticated Salesforce user's ID, name, email, and organization ID. Call this first when the user says 'my leads', 'my opportunities', 'my cases', or any first-person query. Use `user_id` as the OwnerId filter in **SOQL Search** (e.g. `WHERE OwnerId = '{user_id}'`) and `organization_id` to construct Salesforce UI URLs. [See the documentation](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_using_userinfo_endpoint.htm).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    salesforce,
+  },
+  async run({ $ }) {
+    const user = await this.salesforce.getUserInfo(this.salesforce._authToken());
+
+    const summaryName = user.name || user.email || user.user_id;
+    $.export("$summary", `Retrieved user ${summaryName}`);
+
+    return {
+      user_id: user.user_id,
+      name: user.name,
+      email: user.email,
+      organization_id: user.organization_id,
+      username: user.preferred_username,
+      profile: user.profile,
+      locale: user.locale,
+      zoneinfo: user.zoneinfo,
+    };
+  },
+};

package/common/constants.mjs

@@ -32,9 +32,28 @@ export default {
     CONTACT: "Contact",
     CAMPAIGN_MEMBER: "CampaignMember",
     LEAD: "Lead",
+    FEED_ITEM: "FeedItem",
+    FEED_COMMENT: "FeedComment",
   },
   FIELD_NAME: {
     CREATED_DATE: "CreatedDate",
     LAST_MODIFIED_DATE: "LastModifiedDate",
   },
+  FEED_ITEM_MIN_FIELDS: Object.freeze([
+    "Id",
+    "Type",
+    "Body",
+    "ParentId",
+    "CreatedById",
+    "CreatedDate",
+  ]),
+  FEED_COMMENT_MIN_FIELDS: Object.freeze([
+    "Id",
+    "CommentBody",
+    "ParentId",
+    "FeedItemId",
+    "CreatedById",
+    "CreatedDate",
+  ]),
+  DEPLOY_HISTORICAL_LIMIT: 25,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/salesforce_rest_api",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Pipedream Salesforce (REST API) Components",
   "main": "salesforce_rest_api.app.mjs",
   "keywords": [
@@ -11,9 +11,9 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "dependencies": {
     "@pipedream/platform": "^3.1.1",
-    "fast-xml-parser": "^5.5.7",
+    "fast-xml-parser": "^5.7.0",
     "handlebars": "^4.7.9",
-    "lodash": "^4.17.23",
+    "lodash": "^4.18.1",
     "lodash-es": "^4.18.1",
     "salesforce-webhooks": "^1.1.11",
     "uuid": "^9.0.1"

package/sources/case-updated-instant/case-updated-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "Case Updated (Instant, of Selectable Type)",
   key: "salesforce_rest_api-case-updated-instant",
   description: "Emit new event when a case is updated. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.0.8",
+  version: "0.0.9",
   props: {
     salesforce: common.props.salesforce,
     db: "$.service.db",

package/sources/common/common-feed.mjs

@@ -0,0 +1,179 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import common from "./common-new-record.mjs";
+import constants from "../../common/constants.mjs";
+
+const {
+  DEPLOY_HISTORICAL_LIMIT,
+  FIELD_NAME,
+} = constants;
+
+export default {
+  ...common,
+  props: {
+    salesforce: common.props.salesforce,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    timer: {
+      type: "$.interface.timer",
+      description: "The timer is only used as a fallback if instant event delivery (webhook) is not available.",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    parentObjectType: {
+      type: "string",
+      label: "Parent Object Type",
+      description: "Optional. The Salesforce SObject API name of the parent record to filter by, e.g. `Case` or `Opportunity`. When set, appends `AND Parent.Type = '<value>'` to the SOQL WHERE clause (traversal of the polymorphic `ParentId`). Leave blank to emit events on any parent object.",
+      optional: true,
+    },
+    excludeSelf: {
+      type: "boolean",
+      label: "Exclude Self",
+      description: "Optional. When `true`, appends `AND CreatedById != '<authenticatedUserId>'` to filter out events created by the connected user. The user ID is resolved at runtime via the userinfo endpoint and cached in db.",
+      optional: true,
+    },
+  },
+  hooks: {
+    ...common.hooks,
+    async deploy() {
+      const objectType = this.getObjectType();
+      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
+      this.setNameField(nameField);
+
+      const extraConditions = await this._buildExtraConditions();
+      const { records } = await this.query({
+        query: `SELECT Id FROM ${objectType} WHERE Id != null ${extraConditions} ORDER BY CreatedDate DESC LIMIT ${DEPLOY_HISTORICAL_LIMIT}`,
+      });
+
+      // Emit oldest-first so historical events are delivered chronologically,
+      // matching the timer polling path.
+      for (const record of [
+        ...records,
+      ].reverse()) {
+        const object = await this.salesforce.getSObject(objectType, record.Id);
+        const event = {
+          body: {
+            "New": object,
+            "UserId": record.Id,
+          },
+        };
+        await this.processWebhookEvent(event);
+      }
+    },
+  },
+  methods: {
+    ...common.methods,
+    getMinFields() {
+      throw new Error("getMinFields is not implemented");
+    },
+    _getAuthenticatedUserId() {
+      return this.db.get("authenticatedUserId");
+    },
+    _setAuthenticatedUserId(userId) {
+      this.db.set("authenticatedUserId", userId);
+    },
+    async _resolveAuthenticatedUserId() {
+      let userId = this._getAuthenticatedUserId();
+      if (!userId) {
+        const userInfo = await this.salesforce.getUserInfo(this.salesforce._authToken());
+        userId = userInfo.user_id;
+        this._setAuthenticatedUserId(userId);
+      }
+      return userId;
+    },
+    async _buildExtraConditions() {
+      const conditions = [];
+      if (this.parentObjectType) {
+        conditions.push(`AND Parent.Type = '${this.parentObjectType}'`);
+      }
+      if (this.excludeSelf) {
+        const userId = await this._resolveAuthenticatedUserId();
+        conditions.push(`AND CreatedById != '${userId}'`);
+      }
+      return conditions.join(" ");
+    },
+    async processWebhookEvent(event) {
+      // Instant/webhook deliveries can't filter on Parent.Type (the pushed
+      // payload has ParentId but not the parent's object type), so
+      // parentObjectType is only enforced on the polling/deploy SOQL queries.
+      // excludeSelf is enforced here to prevent self-trigger loops.
+      if (this.excludeSelf) {
+        const userId = await this._resolveAuthenticatedUserId();
+        if (event.body?.New?.CreatedById === userId) {
+          return;
+        }
+      }
+      const meta = this.generateWebhookMeta(event);
+      this.$emit(event.body, meta);
+    },
+    async processTimerEvent(eventData) {
+      const {
+        startTimestamp,
+        endTimestamp,
+      } = eventData;
+
+      const fieldName = this.getNameField();
+      let columns = this.getObjectTypeColumns();
+      if (!columns.length) {
+        columns = [
+          ...this.getMinFields(),
+        ];
+      }
+
+      const extraConditions = await this._buildExtraConditions();
+      const objectType = this.getObjectType();
+      const dateFieldName = FIELD_NAME.CREATED_DATE;
+
+      const events = await this.paginate({
+        fn: ({
+          limit,
+          offset,
+        }) => this.query({
+          query: `
+            SELECT ${columns.join(", ")}
+              FROM ${objectType}
+                WHERE ${dateFieldName} > ${startTimestamp}
+                AND ${dateFieldName} <= ${endTimestamp}
+                ${extraConditions}
+                ORDER BY ${dateFieldName} DESC
+                LIMIT ${limit} OFFSET ${offset}
+          `,
+        }),
+      });
+
+      const [
+        latestEvent,
+      ] = events;
+
+      let latestDateCovered = new Date(latestEvent?.CreatedDate || endTimestamp);
+      if (isNaN(latestDateCovered.getMilliseconds())) {
+        latestDateCovered = new Date();
+      }
+      latestDateCovered.setSeconds(0);
+      this.setLatestDateCovered(latestDateCovered.toISOString());
+
+      Array.from(events)
+        .reverse()
+        .forEach((item) => {
+          const meta = this.generateTimerMeta(item, fieldName);
+          this.$emit(item, meta);
+        });
+    },
+    async timerActivateHook() {
+      let columns;
+      try {
+        const { fields } = await this.getObjectTypeDescription(this.getObjectType());
+        columns = fields.map(({ name }) => name);
+      } catch (err) {
+        console.log(`Error fetching ${this.getObjectType()} description, falling back to minimum fields:`, err);
+        columns = [
+          ...this.getMinFields(),
+        ];
+      }
+      this.setObjectTypeColumns(columns);
+    },
+  },
+};

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

@@ -63,7 +63,7 @@ export default {
   methods: {
     ...common.methods,
     generateTimerMeta(item, fieldName) {
-      const { objectType } = this;
+      const objectType = this.getObjectType();
       const {
         CreatedDate: createdDate,
         [fieldName]: name,

package/sources/email-template-updated-instant/email-template-updated-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "Email Template Updated (Instant, of Selectable Type)",
   key: "salesforce_rest_api-email-template-updated-instant",
   description: "Emit new event when an email template is updated. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.0.8",
+  version: "0.0.9",
   props: {
     salesforce: common.props.salesforce,
     db: "$.service.db",

package/sources/knowledge-article-updated-instant/knowledge-article-updated-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "Knowledge Article Updated (Instant, of Selectable Type)",
   key: "salesforce_rest_api-knowledge-article-updated-instant",
   description: "Emit new event when a knowledge article is updated. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.0.8",
+  version: "0.0.9",
   props: {
     salesforce: common.props.salesforce,
     db: "$.service.db",

package/sources/new-case-instant/new-case-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Case (Instant, of Selectable Type)",
   key: "salesforce_rest_api-new-case-instant",
   description: "Emit new event when a case is created. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.0.8",
+  version: "0.0.9",
   props: {
     salesforce: common.props.salesforce,
     db: "$.service.db",

package/sources/new-email-template-instant/new-email-template-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Email Template (Instant, of Selectable Type)",
   key: "salesforce_rest_api-new-email-template-instant",
   description: "Emit new event when an email template is created. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.0.8",
+  version: "0.0.9",
   props: {
     salesforce: common.props.salesforce,
     db: "$.service.db",

package/sources/new-feed-comment/new-feed-comment.mjs

@@ -0,0 +1,36 @@
+import common from "../common/common-feed.mjs";
+import constants from "../../common/constants.mjs";
+
+const {
+  FEED_COMMENT_MIN_FIELDS,
+  OBJECT_TYPE,
+} = constants;
+
+export default {
+  ...common,
+  type: "source",
+  name: "New Chatter Feed Comment (Instant or Polling)",
+  key: "salesforce_rest_api-new-feed-comment",
+  description: "Emit new events for each Chatter FeedComment (reply) created in Salesforce, polling `FeedComment` via SOQL on `CreatedDate`. Use this to react to comments on Chatter posts, since Chatter activity does not update the parent record's `LastModifiedDate`. The payload includes both `ParentId` (a polymorphic reference to the feed's parent - either a record feed, e.g. a Case ID starting with `500`, or a User feed) and `FeedItemId` (the ID of the FeedItem the comment belongs to) - these are distinct fields; do not confuse them. Set `parentObjectType` to a parent object API name (e.g. `Case`) to append `AND Parent.Type = '<value>'` to the SOQL WHERE clause. Set `excludeSelf` to `true` to drop comments authored by the connected integration user. Note: querying FeedComment without a parent filter requires the `View All Data` permission on the connected user. Attempts instant delivery via webhook and falls back to timer polling automatically. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feedcomment.htm)",
+  version: "0.0.1",
+  props: {
+    ...common.props,
+    parentObjectType: {
+      ...common.props.parentObjectType,
+      description: "Optional. The Salesforce SObject API name of the parent business record to filter by, e.g. `Case`. When set, appends `AND Parent.Type = '<value>'` to the SOQL WHERE clause (traversal of the polymorphic `FeedComment.ParentId`). Leave blank to emit comments on any parent object (requires `View All Data` permission).",
+    },
+    excludeSelf: {
+      ...common.props.excludeSelf,
+      description: "Optional. When `true`, appends `AND CreatedById != '<authenticatedUserId>'` to filter out comments created by the connected user. The user ID is resolved at runtime via the userinfo endpoint and cached in db.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return OBJECT_TYPE.FEED_COMMENT;
+    },
+    getMinFields() {
+      return FEED_COMMENT_MIN_FIELDS;
+    },
+  },
+};

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

@@ -0,0 +1,36 @@
+import common from "../common/common-feed.mjs";
+import constants from "../../common/constants.mjs";
+
+const {
+  FEED_ITEM_MIN_FIELDS,
+  OBJECT_TYPE,
+} = constants;
+
+export default {
+  ...common,
+  type: "source",
+  name: "New Chatter Feed Item (Instant or Polling)",
+  key: "salesforce_rest_api-new-feed-item",
+  description: "Emit new events for each Chatter FeedItem (post) created in Salesforce, polling `FeedItem` via SOQL on `CreatedDate`. Use this to react to Chatter posts on Cases and other records, since Chatter activity does not update the parent record's `LastModifiedDate` (so **New Record (Instant, of Selectable Type)** and **New Case (Instant, of Selectable Type)** never emit for it). Set `parentObjectType` to the parent object's API name (e.g. `Case`, `Opportunity`) to only emit posts whose parent record is of that type. Set `excludeSelf` to `true` to drop posts authored by the connected integration user. Note: `Body` is null for system-generated post types (e.g. `TrackedChange`). Attempts instant delivery via webhook and falls back to timer polling automatically when the Streaming API does not support this object. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_feeditem.htm)",
+  version: "0.0.1",
+  props: {
+    ...common.props,
+    parentObjectType: {
+      ...common.props.parentObjectType,
+      description: "Optional. The Salesforce SObject API name of the parent record to filter by, e.g. `Case` or `Opportunity`. When set, appends `AND Parent.Type = '<value>'` to the SOQL WHERE clause (traversal of the polymorphic `FeedItem.ParentId`). Leave blank to emit posts on any parent object.",
+    },
+    excludeSelf: {
+      ...common.props.excludeSelf,
+      description: "Optional. When `true`, appends `AND CreatedById != '<authenticatedUserId>'` to filter out posts created by the connected user. The user ID is resolved at runtime via the userinfo endpoint and cached in db.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return OBJECT_TYPE.FEED_ITEM;
+    },
+    getMinFields() {
+      return FEED_ITEM_MIN_FIELDS;
+    },
+  },
+};

package/sources/new-knowledge-article-instant/new-knowledge-article-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Knowledge Article (Instant, of Selectable Type)",
   key: "salesforce_rest_api-new-knowledge-article-instant",
   description: "Emit new event when a knowledge article is created. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.0.8",
+  version: "0.0.9",
   props: {
     salesforce: common.props.salesforce,
     db: "$.service.db",

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

@@ -6,7 +6,7 @@ export default {
   name: "New Record (Instant, of Selectable Type)",
   key: "salesforce_rest_api-new-record-instant",
   description: "Emit new event when a record of the selected object type is created. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.2.8",
+  version: "0.2.9",
   props: {
     ...common.props,
     fieldsToObtain: {

package/sources/record-deleted-instant/record-deleted-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Deleted Record (Instant, of Selectable Type)",
   key: "salesforce_rest_api-record-deleted-instant",
   description: "Emit new event when a record of the selected object type is deleted. [See the documentation](https://sforce.co/3msDDEE)",
-  version: "0.1.7",
+  version: "0.1.8",
   methods: {
     ...common.methods,
     generateWebhookMeta(data) {

package/sources/record-updated-instant/record-updated-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Updated Record (Instant, of Selectable Type)",
   key: "salesforce_rest_api-record-updated-instant",
   description: "Emit new event when a record of the selected type is updated. [See the documentation](https://sforce.co/3yPSJZy)",
-  version: "0.2.8",
+  version: "0.2.9",
   props: {
     ...common.props,
     fields: {