Pipedream Utils Components (#15925)

* add helper functions

* add formatting

* bump package.json

* pnpm

* fix app file

* fix key

* fix component import

* fix component import

* add missing import

* fixes

* fix import

* fix imports

* pnpm

Author: andrewjschuang

components/pipedream_utils/README.md

@@ -0,0 +1,14 @@
+# Overview
+
+The Pipedream Utils app is a set of pre-built functions that streamline common tasks in your workflows. It acts like a Swiss Army knife for developers, providing essential tools such as format conversion, date manipulation, and text processing. By leveraging these functions, you can reduce the boilerplate code needed for routine operations, speeding up the development of intricate automations. The Helper Functions API can be a game changer when it comes to tasks like parsing dates in user-friendly formats, encoding and decoding data, or generating UUIDs, making them more efficient and less error-prone.
+
+# Example Use Cases
+
+- **Format User Input for Database Storage**
+  In an app where users submit data through forms, the Helper Functions API can be used to sanitize and format user input before it is stored in a database, such as Airtable. This ensures that data is clean and uniform, simplifying retrieval and analysis.
+
+- **Process Webhook Payloads**
+  When dealing with incoming webhooks from apps like GitHub, the Helper Functions API can parse and transform JSON payloads. This allows you to extract specific data points and reformat them for use in other apps like Slack for team notifications or JIRA for creating issues.
+
+- **Automate Content Publication Workflow**
+  A content calendar on Google Sheets can trigger a workflow that uses Helper Functions to parse dates and format post titles. The workflow could then use this data to automatically schedule and publish content on platforms like WordPress or social media apps.

components/pipedream_utils/actions/add-subtract-time/add-subtract-time.mjs

@@ -0,0 +1,91 @@
+import { ConfigurationError } from "@pipedream/platform";
+import pipedream_utils from "../../pipedream_utils.app.mjs";
+import commonDateTime from "../../common/date-time/commonDateTime.mjs";
+import {
+  DATE_FORMAT_PARSE_MAP, DEFAULT_FORMAT_VALUE,
+} from "../../common/date-time/dateFormats.mjs";
+import { DATE_TIME_UNITS } from "../../common/date-time/dateTimeUnits.mjs";
+import sugar from "sugar";
+const OPERATION_OPTIONS = {
+  ADD: "Add",
+  SUBTRACT: "Subtract",
+};
+export default {
+  ...commonDateTime,
+  name: "Formatting - [Date/Time] Add/Subtract Time",
+  description: "Add or subtract time from a given input",
+  key: "pipedream_utils-add-subtract-time",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    ...commonDateTime.props,
+    operation: {
+      label: "Operation",
+      description: "Whether to add or subtract time.",
+      type: "string",
+      options: Object.values(OPERATION_OPTIONS),
+    },
+    duration: {
+      label: "Duration",
+      description: "The duration for the operation. You can use the shorthand duration, for example: `1s`, `1m`, `1h`, `1d`, `1w`, `1y` equal one second, minute, hour, day, week, and year respectively",
+      type: "string",
+    },
+    outputFormat: {
+      propDefinition: [
+        pipedream_utils,
+        "outputFormat",
+      ],
+    },
+  },
+  methods: {
+    ...commonDateTime.methods,
+    getOperationMilliseconds(str) {
+      let result = 0;
+      const {
+        second, minute, hour, day, week, year,
+      } = DATE_TIME_UNITS;
+      Object.entries({
+        s: second,
+        m: minute,
+        h: hour,
+        d: day,
+        w: week,
+        y: year,
+      }).forEach(([
+        identifier,
+        multiplier,
+      ]) => {
+        const substr = str.match(new RegExp(`[0-9]+\\s*${identifier}`))?.[0];
+        if (substr) {
+          const value = Number(substr.match(/[0-9]+/));
+          result += value * multiplier;
+        }
+      });
+      return result;
+    },
+  },
+  async run({ $ }) {
+    const {
+      operation, duration, outputFormat,
+    } = this;
+    const dateObj = this.getDateFromInput();
+    const value = dateObj.valueOf();
+    let amount = this.getOperationMilliseconds(duration);
+    if (operation === OPERATION_OPTIONS.SUBTRACT)
+      amount *= -1;
+    const result = value + amount;
+    const format = outputFormat ?? this.inputFormat ?? DEFAULT_FORMAT_VALUE;
+    try {
+      const { outputFn } = DATE_FORMAT_PARSE_MAP.get(format);
+      const output = outputFn(sugar.Date.create(result));
+      $.export("$summary", `Successfully ${operation === OPERATION_OPTIONS.SUBTRACT
+        ? "subtracted"
+        : "added"} time`);
+      return output;
+    }
+    catch (err) {
+      console.log("Error parsing date", err);
+      throw new ConfigurationError("**Parse error** - check your input and if the selected format is correct.");
+    }
+  },
+};

components/pipedream_utils/actions/base64-decode-string/base64-decode-string.mjs

@@ -0,0 +1,20 @@
+// legacy_hash_id: a_0Mio28
+import pipedream_utils from "../../pipedream_utils.app.mjs";
+
+export default {
+  key: "pipedream_utils-base64-decode-string",
+  name: "Helper Functions - Base64 Decode String",
+  description: "Accepts a base64-encoded string, returns a decoded UTF-8 string",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    pipedream_utils,
+    data: {
+      type: "string",
+    },
+  },
+  async run({ $ }) {
+    const buffer = Buffer.from(this.data, "base64");
+    $.export("data", buffer.toString("utf8"));
+  },
+};

components/pipedream_utils/actions/compare-arrays/compare-arrays.mjs

@@ -0,0 +1,92 @@
+import pipedream_utils from "../../pipedream_utils.app.mjs";
+
+export default {
+  key: "pipedream_utils-compare-arrays",
+  name: "Helper Functions - Compare Arrays",
+  description: "Get the difference, intersection, union, or symetric difference of two arrays/sets.",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    pipedream_utils,
+    array1: {
+      type: "string[]",
+      label: "Array 1",
+      description: "Array to compare to second array",
+      default: [],
+    },
+    array2: {
+      type: "string[]",
+      label: "Array 2",
+      description: "Array to be compared with first array",
+      default: [],
+    },
+    actionType: {
+      type: "string",
+      label: "Compare Action",
+      description: "Type of action to perform on the arrays",
+      options: [
+        "difference",
+        "union",
+        "intersection",
+        "symmetric difference",
+      ],
+    },
+  },
+  methods: {
+    getDifference(set1, set2) {
+      return new Set([
+        ...set1,
+      ].filter((x) => !set2.has(x)));
+    },
+    getIntersection(set1, set2) {
+      return new Set([
+        ...set1,
+      ].filter((x) => set2.has(x)));
+    },
+    getUnion(set1, set2) {
+      for (const elem of set2) {
+        set1.add(elem);
+      }
+      return set1;
+    },
+    getSymmetricDifference(set1, set2) {
+      for (const elem of set2) {
+        if (set1.has(elem)) {
+          set1.delete(elem);
+        } else {
+          set1.add(elem);
+        }
+      }
+      return set1;
+    },
+  },
+  run() {
+    const set1 = new Set(this.array1);
+    const set2 = new Set(this.array2);
+
+    let results;
+
+    switch (this.actionType) {
+    case "difference": {
+      results = this.getDifference(set1, set2);
+      break;
+    }
+    case "union": {
+      results = this.getUnion(set1, set2);
+      break;
+    }
+    case "intersection": {
+      results = this.getIntersection(set1, set2);
+      break;
+    }
+    case "symmetric difference": {
+      results = this.getSymmetricDifference(set1, set2);
+      break;
+    }
+    default:
+      throw new Error(`Unknown action type: ${this.actionType}`);
+    }
+
+    return Array.from(results);
+  },
+};

components/pipedream_utils/actions/compare-dates/compare-dates.mjs

@@ -0,0 +1,63 @@
+import commonDateTime from "../../common/date-time/commonDateTime.mjs";
+import pipedream_utils from "../../pipedream_utils.app.mjs";
+import { DATE_TIME_UNITS } from "../../common/date-time/dateTimeUnits.mjs";
+export default {
+  ...commonDateTime,
+  name: "Formatting - [Date/Time] Compare Dates",
+  description: "Get the duration between two dates in days, hours, minutes, and seconds along with checking if they are the same.",
+  key: "pipedream_utils-compare-dates",
+  version: "0.0.5",
+  type: "action",
+  props: {
+    ...commonDateTime.props,
+    inputDate: {
+      propDefinition: [
+        pipedream_utils,
+        "inputDate",
+      ],
+      label: "Start Date",
+      description: "Enter start date string, in the format defined in `Input Format`. If the start date is after the end date, these dates will be swapped and in the output `datesSwapped` will be set to `true`.",
+    },
+    endDate: {
+      propDefinition: [
+        pipedream_utils,
+        "inputDate",
+      ],
+      label: "End Date",
+      description: "Enter end date string, in the format defined in `Input Format`. Timezone is assumed the same for both dates if not explicitly set.",
+    },
+  },
+  async run({ $ }) {
+    const startDateObj = this.getDateFromInput(this.inputDate);
+    const endDateObj = this.getDateFromInput(this.endDate);
+    const startValue = startDateObj.valueOf();
+    const endValue = endDateObj.valueOf();
+    const datesSwapped = startValue > endValue;
+    let result = "equal";
+    let remainingValue = Math.abs(endValue - startValue);
+    if (remainingValue) {
+      const arrResults = [];
+      const arrUnits = Object.entries(DATE_TIME_UNITS).sort((a, b) => b[1] - a[1]);
+      for (const [
+        word,
+        unit,
+      ] of arrUnits) {
+        const amount = Math.floor(remainingValue / unit);
+        if (amount) {
+          arrResults.push(`${amount} ${amount === 1
+            ? word
+            : `${word}s`}`);
+          remainingValue %= unit;
+          if (!remainingValue)
+            break;
+        }
+      }
+      result = arrResults.join(", ");
+    }
+    $.export("$summary", "Successfully compared dates");
+    return {
+      datesSwapped,
+      result,
+    };
+  },
+};

components/pipedream_utils/actions/convert-currency/convert-currency.mjs

@@ -0,0 +1,70 @@
+import { axios } from "@pipedream/platform";
+import pipedream_utils from "../../pipedream_utils.app.mjs";
+
+export default {
+  key: "pipedream_utils-convert-currency",
+  name: "Helper Functions - Convert Currency",
+  description: "Convert an amount between currencies. [See the documentation](https://www.frankfurter.app/docs/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    pipedream_utils,
+    fromCurrency: {
+      type: "string",
+      label: "From Currency",
+      description: "The currency to convert from",
+      async options() {
+        return this.getCurrencyOptions();
+      },
+    },
+    toCurrency: {
+      type: "string",
+      label: "To Currency",
+      description: "The currency to convert to",
+      async options() {
+        return this.getCurrencyOptions();
+      },
+    },
+    value: {
+      type: "string",
+      label: "Value",
+      description: "The value to convert",
+    },
+  },
+  methods: {
+    async getCurrencyOptions() {
+      const currencies = await this.getCurrencies();
+      const options = [];
+      for (const [
+        key,
+        value,
+      ] of Object.entries(currencies)) {
+        options.push({
+          value: key,
+          label: value,
+        });
+      }
+      return options;
+    },
+    getCurrencies($ = this) {
+      return axios($, {
+        url: "https://api.frankfurter.app/currencies",
+      });
+    },
+    convertCurrency($ = this) {
+      return axios($, {
+        url: "https://api.frankfurter.app/latest",
+        params: {
+          from: this.fromCurrency,
+          to: this.toCurrency,
+          amount: this.value,
+        },
+      });
+    },
+  },
+  async run({ $ }) {
+    const response = await this.convertCurrency($);
+    $.export("$summary", `${this.value} ${this.fromCurrency} = ${response.rates[this.toCurrency]} ${this.toCurrency}`);
+    return response;
+  },
+};

components/pipedream_utils/actions/convert-html-to-markdown/convert-html-to-markdown.mjs

@@ -0,0 +1,26 @@
+import { parseHTML } from "linkedom";
+import showdown from "showdown";
+import pipedream_utils from "../../pipedream_utils.app.mjs";
+export default {
+  name: "Formatting - [Text] Convert HTML to Markdown",
+  description: "Convert valid HTML to Markdown text",
+  key: "pipedream_utils-convert-html-to-markdown",
+  version: "0.0.6",
+  type: "action",
+  props: {
+    pipedream_utils,
+    input: {
+      label: "Input",
+      description: "HTML string to be converted to Markdown",
+      type: "string",
+    },
+  },
+  async run({ $ }) {
+    const { input } = this;
+    const converter = new showdown.Converter();
+    const dom = parseHTML("");
+    const result = converter.makeMarkdown(input, dom.window.document);
+    $.export("$summary", "Successfully converted to Markdown");
+    return result;
+  },
+};