@pipedream/salesforce_rest_api 1.6.1 → 1.8.0

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

@@ -0,0 +1,43 @@
+import common from "../common/common-updated-record.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  type: "source",
+  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.2",
+  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,
+      },
+    },
+    fieldsToObtain: {
+      propDefinition: [
+        common.props.salesforce,
+        "fieldsToObtain",
+        () => ({
+          objType: "KnowledgeArticle",
+        }),
+      ],
+      optional: true,
+      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "KnowledgeArticle";
+    },
+  },
+};

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

@@ -0,0 +1,43 @@
+import common from "../common/common-new-record.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  type: "source",
+  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.2",
+  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,
+      },
+    },
+    fieldsToObtain: {
+      propDefinition: [
+        common.props.salesforce,
+        "fieldsToObtain",
+        () => ({
+          objType: "Case",
+        }),
+      ],
+      optional: true,
+      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Case";
+    },
+  },
+};

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

@@ -0,0 +1,43 @@
+import common from "../common/common-new-record.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  type: "source",
+  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.2",
+  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,
+      },
+    },
+    fieldsToObtain: {
+      propDefinition: [
+        common.props.salesforce,
+        "fieldsToObtain",
+        () => ({
+          objType: "EmailTemplate",
+        }),
+      ],
+      optional: true,
+      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "EmailTemplate";
+    },
+  },
+};

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

@@ -0,0 +1,43 @@
+import common from "../common/common-new-record.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  type: "source",
+  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.2",
+  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,
+      },
+    },
+    fieldsToObtain: {
+      propDefinition: [
+        common.props.salesforce,
+        "fieldsToObtain",
+        () => ({
+          objType: "KnowledgeArticle",
+        }),
+      ],
+      optional: true,
+      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "KnowledgeArticle";
+    },
+  },
+};

package/sources/new-outbound-message/new-outbound-message.mjs

@@ -6,7 +6,7 @@ export default {
   name: "New Outbound Message (Instant)",
   key: "salesforce_rest_api-new-outbound-message",
   description: "Emit new event when a new outbound message is received in Salesforce.",
-  version: "0.1.7",
+  version: "0.1.8",
   dedupe: "unique",
   props: {
     db: "$.service.db",

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

@@ -1,5 +1,4 @@
-import startCase from "lodash/startCase.js";
-import common from "../common.mjs";
+import common from "../common/common-new-record.mjs";
 
 export default {
   ...common,
@@ -7,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.0",
+  version: "0.2.2",
   props: {
     ...common.props,
     fieldsToObtain: {
@@ -22,123 +21,10 @@ export default {
       description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
     },
   },
-  hooks: {
-    ...common.hooks,
-    async deploy() {
-      const objectType = this.objectType;
-      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
-      this.setNameField(nameField);
-
-      // emit historical events
-      const { recentItems } = await this.salesforce.listSObjectTypeIds(objectType);
-      const ids = recentItems.map((item) => item.Id);
-      for (const id of ids.slice(-25)) {
-        const object = await this.salesforce.getSObject(objectType, id);
-        const event = {
-          body: {
-            "New": object,
-            "UserId": id,
-          },
-        };
-        this.processWebhookEvent(event);
-      }
-    },
-  },
   methods: {
     ...common.methods,
-    generateTimerMeta(item, fieldName) {
-      const { objectType } = this;
-      const {
-        CreatedDate: createdDate,
-        [fieldName]: name,
-        Id: id,
-      } = item;
-      const entityType = startCase(objectType);
-      const summary = `New ${entityType} created: ${name ?? id}`;
-      const ts = Date.parse(createdDate);
-      return {
-        id,
-        summary,
-        ts,
-      };
-    },
-    generateWebhookMeta(data) {
-      const nameField = this.getNameField();
-      const { New: newObject } = data.body;
-      const {
-        CreatedDate: createdDate,
-        Id: id,
-        [nameField]: name,
-      } = newObject;
-      const entityType = startCase(this.objectType).toLowerCase();
-      const summary = `New ${entityType} created: ${name ?? id}`;
-      const ts = Date.parse(createdDate);
-      return {
-        id,
-        summary,
-        ts,
-      };
-    },
-    getEventType() {
-      return "new";
-    },
-    async processTimerEvent(eventData) {
-      const {
-        paginate,
-        objectType,
-        setLatestDateCovered,
-        getObjectTypeColumns,
-        getNameField,
-        generateTimerMeta,
-        $emit: emit,
-      } = this;
-
-      const {
-        startTimestamp,
-        endTimestamp,
-      } = eventData;
-
-      const fieldName = getNameField();
-      const columns = getObjectTypeColumns();
-
-      const events = await paginate({
-        objectType,
-        startTimestamp,
-        endTimestamp,
-        columns,
-      });
-
-      const [
-        latestEvent,
-      ] = events;
-
-      if (latestEvent?.CreatedDate) {
-        const latestDateCovered = new Date(latestEvent.CreatedDate);
-        latestDateCovered.setSeconds(0);
-        setLatestDateCovered(latestDateCovered.toISOString());
-      }
-
-      Array.from(events)
-        .reverse()
-        .forEach((item) => {
-          const meta = generateTimerMeta(item, fieldName);
-          emit(item, meta);
-        });
-    },
-    async timerActivateHook() {
-      const {
-        objectType,
-        getObjectTypeDescription,
-        setObjectTypeColumns,
-      } = this;
-
-      let columns = this.fieldsToObtain;
-      if (!columns?.length) {
-        const { fields } = await getObjectTypeDescription(objectType);
-        columns = fields.map(({ name }) => name);
-      }
-
-      setObjectTypeColumns(columns);
+    getObjectType() {
+      return this.objectType;
     },
   },
 };

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

@@ -1,5 +1,5 @@
 import startCase from "lodash/startCase.js";
-import common from "../common.mjs";
+import common from "../common/common.mjs";
 
 export default {
   ...common,
@@ -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.0",
+  version: "0.1.2",
   methods: {
     ...common.methods,
     generateWebhookMeta(data) {

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

@@ -1,6 +1,4 @@
-import startCase from "lodash/startCase.js";
-import common from "../common.mjs";
-import constants from "../../common/constants.mjs";
+import common from "../common/common-updated-record.mjs";
 const { salesforce } = common.props;
 
 export default {
@@ -9,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.0",
+  version: "0.2.2",
   props: {
     ...common.props,
     fields: {
@@ -29,140 +27,8 @@ export default {
   },
   methods: {
     ...common.methods,
-    generateWebhookMeta(data) {
-      const nameField = this.getNameField();
-      const { New: newObject } = data.body;
-      const {
-        LastModifiedDate: lastModifiedDate,
-        Id: id,
-        [nameField]: name,
-      } = newObject;
-      const entityType = startCase(this.objectType);
-      const summary = `${entityType} updated: ${name}`;
-      const ts = Date.parse(lastModifiedDate);
-      const compositeId = `${id}-${ts}`;
-      return {
-        id: compositeId,
-        summary,
-        ts,
-      };
-    },
-    generateTimerMeta(item, fieldName) {
-      const { objectType } = this;
-
-      const {
-        LastModifiedDate: lastModifiedDate,
-        [fieldName]: name,
-        Id: id,
-      } = item;
-
-      const entityType = startCase(objectType);
-      const summary = `${entityType} updated: ${name}`;
-      const ts = Date.parse(lastModifiedDate);
-      return {
-        id: `${id}-${ts}`,
-        summary,
-        ts,
-      };
-    },
-    getEventType() {
-      return "updated";
-    },
-    isEventRelevant(changedFields) {
-      const { fields } = this;
-      return fields?.length
-        ? Object.keys(changedFields).some((key) => fields.includes(key))
-        : true;
-    },
-    getChangedFields(body) {
-      return Object.entries(body.New).filter(([
-        key,
-        value,
-      ]) => {
-        const oldValue = body.Old[key];
-        return (
-          value !== undefined
-          && oldValue !== undefined
-          && JSON.stringify(value) !== JSON.stringify(oldValue)
-        );
-      })
-        .reduce((obj, [
-          key,
-          value,
-        ]) => {
-          obj[key] = {
-            old: body.Old[key],
-            new: value,
-          };
-          return obj;
-        }, {});
-    },
-    processWebhookEvent(event) {
-      const { body } = event;
-      const changedFields = this.getChangedFields(body);
-      if (this.isEventRelevant(changedFields)) {
-        const meta = this.generateWebhookMeta(event);
-        this.$emit({
-          ...body,
-          changedFields,
-        }, meta);
-      }
-    },
-    async processTimerEvent(eventData) {
-      const {
-        getNameField,
-        getObjectTypeColumns,
-        paginate,
-        objectType,
-        setLatestDateCovered,
-        generateTimerMeta,
-        $emit: emit,
-      } = this;
-
-      const {
-        startTimestamp,
-        endTimestamp,
-      } = eventData;
-
-      const fieldName = getNameField();
-      const columns = getObjectTypeColumns();
-
-      const events = await paginate({
-        objectType,
-        startTimestamp,
-        endTimestamp,
-        columns,
-        dateFieldName: constants.FIELD_NAME.LAST_MODIFIED_DATE,
-      });
-
-      const [
-        latestEvent,
-      ] = events;
-
-      if (latestEvent?.LastModifiedDate) {
-        const latestDateCovered = new Date(latestEvent.LastModifiedDate);
-        latestDateCovered.setSeconds(0);
-        setLatestDateCovered(latestDateCovered.toISOString());
-      }
-
-      Array.from(events)
-        .reverse()
-        .forEach((item) => {
-          const meta = generateTimerMeta(item, fieldName);
-          emit(item, meta);
-        });
-    },
-    async timerActivateHook() {
-      const {
-        objectType,
-        getObjectTypeDescription,
-        setObjectTypeColumns,
-      } = this;
-
-      const { fields } = await getObjectTypeDescription(objectType);
-      const columns = fields.map(({ name }) => name);
-
-      setObjectTypeColumns(columns);
+    getObjectType() {
+      return this.objectType;
     },
   },
 };