@pipedream/salesforce_rest_api 1.2.0 → 1.3.0

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

@@ -1,13 +1,13 @@
 import startCase from "lodash/startCase.js";
-import common from "../common-instant.mjs";
+import common from "../common.mjs";
 
 export default {
   ...common,
   type: "source",
   name: "New Record (Instant, of Selectable Type)",
   key: "salesforce_rest_api-new-record-instant",
-  description: "Emit new event immediately after a record of arbitrary object type (selected as an input parameter by the user) is created",
-  version: "0.0.4",
+  description: "Emit new event when a record of the selected object type is created. [See the documentation](https://sforce.co/3yPSJZy)",
+  version: "0.1.0",
   hooks: {
     ...common.hooks,
     async deploy() {
@@ -15,7 +15,7 @@ export default {
       const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
       this.setNameField(nameField);
 
-      // emit hisorical events
+      // emit historical events
       const { recentItems } = await this.salesforce.listSObjectTypeIds(objectType);
       const ids = recentItems.map((item) => item.Id);
       for (const id of ids.slice(-25)) {
@@ -26,13 +26,29 @@ export default {
             "UserId": id,
           },
         };
-        this.processEvent(event);
+        this.processWebhookEvent(event);
       }
     },
   },
   methods: {
     ...common.methods,
-    generateMeta(data) {
+    generateTimerMeta(item, fieldName) {
+      const { objectType } = this;
+      const {
+        CreatedDate: createdDate,
+        [fieldName]: name,
+        Id: id,
+      } = item;
+      const entityType = startCase(objectType);
+      const summary = `New ${entityType} created: ${name}`;
+      const ts = Date.parse(createdDate);
+      return {
+        id,
+        summary,
+        ts,
+      };
+    },
+    generateWebhookMeta(data) {
       const nameField = this.getNameField();
       const { New: newObject } = data.body;
       const {
@@ -52,5 +68,60 @@ export default {
     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;
+
+      const { fields } = await getObjectTypeDescription(objectType);
+      const columns = fields.map(({ name }) => name);
+
+      setObjectTypeColumns(columns);
+    },
   },
 };

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

@@ -1,17 +1,16 @@
 import startCase from "lodash/startCase.js";
-
-import common from "../common-instant.mjs";
+import common from "../common.mjs";
 
 export default {
   ...common,
   type: "source",
   name: "New Deleted Record (Instant, of Selectable Type)",
   key: "salesforce_rest_api-record-deleted-instant",
-  description: "Emit new event immediately after a record of arbitrary object type (selected as an input parameter by the user) is deleted",
-  version: "0.0.4",
+  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",
   methods: {
     ...common.methods,
-    generateMeta(data) {
+    generateWebhookMeta(data) {
       const nameField = this.getNameField();
       const { Old: oldObject } = data.body;
       const {
@@ -29,8 +28,44 @@ export default {
         ts,
       };
     },
+    generateTimerMeta(item) {
+      const {
+        id,
+        deletedDate,
+      } = item;
+      const entityType = startCase(this.objectType);
+      const summary = `${entityType} deleted: ${id}`;
+      const ts = Date.parse(deletedDate);
+      return {
+        id,
+        summary,
+        ts,
+      };
+    },
     getEventType() {
       return "deleted";
     },
+    async processTimerEvent(eventData) {
+      const {
+        startTimestamp,
+        endTimestamp,
+      } = eventData;
+      const {
+        deletedRecords,
+        latestDateCovered,
+      } = await this.salesforce.getDeletedForObjectType(
+        this.objectType,
+        startTimestamp,
+        endTimestamp,
+      );
+      this.setLatestDateCovered(latestDateCovered);
+
+      // When a record is deleted, the `getDeleted` API only shows the ID of the
+      // deleted item and the date in which it was deleted.
+      deletedRecords.forEach((item) => {
+        const meta = this.generateTimerMeta(item);
+        this.$emit(item, meta);
+      });
+    },
   },
 };

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

@@ -0,0 +1,168 @@
+import startCase from "lodash/startCase.js";
+import common from "../common.mjs";
+import constants from "../../common/constants.mjs";
+const { salesforce } = common.props;
+
+export default {
+  ...common,
+  type: "source",
+  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",
+  props: {
+    ...common.props,
+    fields: {
+      propDefinition: [
+        salesforce,
+        "field",
+        ({ objectType }) => ({
+          objectType,
+          filter: ({ updateable }) => updateable,
+        }),
+      ],
+      label: "Fields To Watch",
+      type: "string[]",
+      optional: true,
+      description: "If specified, events will only be emitted if at least one of the selected fields is updated. This filter is only available when a webhook is created successfully.",
+    },
+  },
+  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);
+    },
+  },
+};

package/actions/common/base.mjs

@@ -1,18 +0,0 @@
-import salesforce from "../../salesforce_rest_api.app.mjs";
-
-export default {
-  props: {
-    salesforce,
-  },
-  methods: {
-    additionalProps(selector, sobject) {
-      if (!selector || !sobject) {
-        return {};
-      }
-      return selector.reduce((props, prop) => ({
-        ...props,
-        [prop]: sobject[prop],
-      }), {});
-    },
-  },
-};

package/actions/find-create-record/find-create-record.mjs

@@ -1,89 +0,0 @@
-import { ConfigurationError } from "@pipedream/platform";
-import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
-
-export default {
-  key: "salesforce_rest_api-find-create-record",
-  name: "Get Field Values from Object Record and optionally create one is none is found. ",
-  description:
-    "Finds a specified Salesforce record by a field. Optionally, create one if none is found. [API Docs](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
-  version: "0.1.5",
-  type: "action",
-  props: {
-    salesForceRestApi,
-    sobjectType: {
-      propDefinition: [
-        salesForceRestApi,
-        "objectType",
-      ],
-    },
-    sobjectId: {
-      propDefinition: [
-        salesForceRestApi,
-        "sobjectId",
-        (c) => ({
-          objectType: c.sobjectType,
-        }),
-      ],
-      description:
-        "ID of the Salesforce standard object to get field values from.",
-    },
-    sobjectFields: {
-      type: "string[]",
-      label: "Fields to get values from",
-      description:
-        "list of the Salesforce standard object's fields to get values from.",
-    },
-    createIfNotFound: {
-      type: "boolean",
-      label: "Create new object",
-      description: "Create a new object if none is found",
-      reloadProps: true,
-    },
-  },
-  async additionalProps() {
-    return {
-      sobject: {
-        type: "object",
-        label: "Salesforce standard object",
-        description: `Data of the Salesforce standard object record to create.
-          Salesforce standard objects are described in [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_list.htm) section of the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm).`,
-      },
-    };
-  },
-  async run({ $ }) {
-    const {
-      sobjectType,
-      sobjectId,
-      sobjectFields,
-      sobject,
-      createIfNotFound,
-    } = this;
-    let data;
-    try {
-      data = await this.salesForceRestApi.getSObject(
-        sobjectType,
-        sobjectId,
-        sobjectFields && {
-          fields: sobjectFields.join(","),
-        },
-      );
-    } catch (error) {
-      if (!createIfNotFound) throw new ConfigurationError("Record not found");
-    }
-
-    if (createIfNotFound && !data) {
-      const response = await this.salesForceRestApi.createObject(
-        sobjectType,
-        sobject,
-      );
-      response && $.export(
-        "$summary", "Record successfully created",
-      );
-      return response;
-    }
-    if (data) {
-      $.export("$summary", "Record found!");
-    }
-    return data;
-  },
-};

package/actions/get-sobject-fields-values/get-sobject-fields-values.mjs

@@ -1,57 +0,0 @@
-import salesforce from "../../salesforce_rest_api.app.mjs";
-import { toSingleLineString } from "../../common/utils.mjs";
-
-export default {
-  key: "salesforce_rest_api-get-sobject-fields-values",
-  name: "Get Field Values from a Standard Object Record",
-  description: toSingleLineString(`
-    Retrieve field values from a record. You can specify the fields you want to retrieve.
-    See [docs](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_get_field_values.htm)
-  `),
-  version: "0.2.7",
-  type: "action",
-  props: {
-    salesforce,
-    objectType: {
-      propDefinition: [
-        salesforce,
-        "objectType",
-      ],
-    },
-    sobjectId: {
-      propDefinition: [
-        salesforce,
-        "sobjectId",
-        (c) => ({
-          objectType: c.objectType,
-        }),
-      ],
-    },
-    fields: {
-      type: "string[]",
-      label: "SObject Fields",
-      description: "List of fields of the Standard object to get values from",
-      propDefinition: [
-        salesforce,
-        "field",
-        (c) => ({
-          objectType: c.objectType,
-        }),
-      ],
-      optional: true,
-    },
-  },
-  async run({ $ }) {
-    const params = {};
-    if (this.fields?.length > 0) {
-      params.fields = this.fields.join(",");
-    }
-    const response = await this.salesforce.getRecordFieldValues(this.objectType, {
-      $,
-      id: this.sobjectId,
-      params,
-    });
-    $.export("$summary", `Retrieved ${this.objectType} field values`);
-    return response;
-  },
-};

package/common/utils.mjs

@@ -1,51 +0,0 @@
-/**
- * A utility function that accepts a string as an argument and reformats it in
- * order to remove newline characters and consecutive spaces. Useful when
- * dealing with very long templated strings that are split into multiple lines.
- *
- * @example
- * // returns "This is a much cleaner string"
- * toSingleLineString(`
- *   This is a much
- *   cleaner string
- * `);
- *
- * @param {string}  multiLineString the input string to reformat
- * @returns a formatted string based on the content of the input argument,
- * without newlines and multiple spaces
- * Source: {@linkcode ../aws/sources/common/utils.mjs utils.mjs}
- */
-function toSingleLineString(multiLineString) {
-  return multiLineString
-    .trim()
-    .replace(/\n/g, " ")
-    .replace(/\s{2,}/g, " ");
-}
-
-const removeNullEntries = (obj) =>
-  obj && Object.entries(obj).reduce((acc, [
-    key,
-    value,
-  ]) => {
-    const isNumber = typeof value === "number";
-    const isBoolean = typeof value === "boolean";
-    const isNotEmpyString = typeof value === "string" && value.trim() !== "";
-    const isNotEmptyArray = Array.isArray(value) && value.length;
-    const isNotEmptyObject =
-      typeof value === "object" &&
-      value !== null &&
-      !Array.isArray(value) &&
-      Object.keys(value).length !== 0;
-    isNotEmptyObject && (value = removeNullEntries(value));
-    return ((value || value === false) &&
-      (isNotEmpyString || isNotEmptyArray || isNotEmptyObject || isBoolean || isNumber))
-      ? {
-        ...acc,
-        [key]: value,
-      }
-      : acc;
-  }, {});
-
-export {
-  toSingleLineString, removeNullEntries,
-};