@pipedream/twilio 0.3.3 → 0.3.4

package/utils.mjs

@@ -0,0 +1,147 @@
+/**
+ * Format a number of seconds into a time elapsed string
+ *
+ * @example
+ * // returns "15s"
+ * formatTimeElapsed(15);
+ *
+ * @example
+ * // returns "35min"
+ * formatTimeElapsed(60 * 35.5);
+ *
+ * @param {Number} seconds - the number of seconds
+ * @returns the formatted time elapsed string
+ */
+function formatTimeElapsed(seconds) {
+  var interval = seconds / 31536000;
+
+  if (interval > 1) {
+    return Math.floor(interval) + " years";
+  }
+  interval = seconds / 2592000;
+  if (interval > 1) {
+    return Math.floor(interval) + " months";
+  }
+  interval = seconds / 86400;
+  if (interval > 1) {
+    return Math.floor(interval) + "d";
+  }
+  interval = seconds / 3600;
+  if (interval > 1) {
+    return Math.floor(interval) + "h";
+  }
+  interval = seconds / 60;
+  if (interval > 1) {
+    return Math.floor(interval) + "min";
+  }
+  return Math.floor(seconds) + "s";
+}
+
+/**
+ * Get the time between two dates as a time-elapsed string
+ *
+ * @param {Date} date1 the earlier date
+ * @param {Date} date2 the later date
+ * @returns the time elapsed between two dates
+ */
+function timeBetween(date1, date2) {
+  var seconds = Math.floor((date2 - date1) / 1000);
+
+  return formatTimeElapsed(seconds);
+}
+
+/**
+ * Return a copy of `obj` with properties omitted whose value is an empty string
+ *
+ * @param {Object} obj - the base object
+ * @returns the new object
+ */
+function omitEmptyStringValues(obj) {
+  return Object.fromEntries(
+    Object.entries(obj).filter((kVpair) => kVpair[1] !== ""),
+  );
+}
+
+/**
+ * Return `value` if `condition` or an empty string otherwise
+ *
+ * @param {*} condition - the condition
+ * @param {*} value - the value to conditionally return
+ * @returns the value, if the condition is true, and empty string otherwise
+ */
+function valueOrEmptyString(condition, value) {
+  return condition
+    ? value
+    : "";
+}
+
+/**
+ * Format a date as a human-readable string
+ *
+ * @example
+ * // returns "2021-10-01"
+ * formatDateString("2021-10-01T01:06:45.000Z");
+ *
+ * @param {Date|String} date - the date to format
+ * @returns the formatted date string
+ */
+function formatDateString(date) {
+  const dateObj = new Date(date);
+  return dateObj.toISOString().split("T")[0];
+}
+
+/**
+ * Format a [Twilio Call object]{@link https://www.twilio.com/docs/voice/api/call-resource} as a
+ * string
+ *
+ * @param {Object} call - The Twilio Call object
+ * @returns the string representing a call
+ */
+function callToString(call) {
+  const fromPart = valueOrEmptyString(call.fromFormatted, call.fromFormatted);
+  const toPart = valueOrEmptyString(call.toFormatted, ` to ${call.toFormatted}`);
+  const datePart = valueOrEmptyString(call.startTime, ` on ${formatDateString(call.startTime)}`);
+  const durationPart = valueOrEmptyString(call.duration, ` for ${formatTimeElapsed(call.duration)}`);
+  return fromPart + toPart + datePart + durationPart;
+}
+
+/**
+ * Format a [Twilio Message object]{@link https://www.twilio.com/docs/sms/api/message-resource} as a
+ * string
+ *
+ * @param {Object} call - The Twilio Message object
+ * @returns the string representing a message
+ */
+function messageToString(message) {
+  const MAX_LENGTH = 30;
+  const messageText = message.body.length > MAX_LENGTH
+    ? `${message.body.slice(0, MAX_LENGTH)}...`
+    : message.body; // truncate long text
+  const messageDate = message.dateSent || message.dateCreated;
+  const dateString = formatDateString(messageDate);
+  return `${message.from} to ${message.to} on ${dateString}: ${messageText}`;
+}
+
+/**
+ * Format a [Twilio Recording object]{@link https://www.twilio.com/docs/voice/api/recording} as a
+ * string
+ *
+ * @param {Object} call - The Twilio Recording object
+ * @returns the string representing a recording
+ */
+function recordingToString(recording) {
+  const datePart = valueOrEmptyString(recording.startTime, ` ${formatDateString(recording.startTime)}`);
+  const durationPart = valueOrEmptyString(recording.duration, ` - ${formatTimeElapsed(recording.duration)}`);
+  return datePart + durationPart;
+}
+
+export {
+  formatTimeElapsed,
+  timeBetween,
+  omitEmptyStringValues,
+  valueOrEmptyString,
+  formatDateString,
+  callToString,
+  messageToString,
+  recordingToString,
+};

package/sources/new-incoming-sms/new-incoming-sms.js

@@ -1,86 +0,0 @@
-const twilio = require("../../twilio.app.js");
-const MessagingResponse = require("twilio").twiml.MessagingResponse;
-const twilioClient = require("twilio");
-
-module.exports = {
-  key: "twilio-new-incoming-sms",
-  name: "New Incoming SMS",
-  description:
-    "Configures a webhook in Twilio, tied to an incoming phone number, and emits an event each time an SMS is sent to that number",
-  version: "0.0.4",
-  dedupe: "unique",
-  props: {
-    twilio,
-    incomingPhoneNumber: { propDefinition: [twilio, "incomingPhoneNumber"] },
-    authToken: { propDefinition: [twilio, "authToken"] },
-    responseMessage: { propDefinition: [twilio, "responseMessage"] },
-    http: {
-      type: "$.interface.http",
-      customResponse: true,
-    },
-  },
-  hooks: {
-    async activate() {
-      console.log(
-        `Creating webhook for phone number ${this.incomingPhoneNumber}`
-      );
-      const createWebhookResp = await this.twilio.setIncomingSMSWebhookURL(
-        this.incomingPhoneNumber,
-        this.http.endpoint
-      );
-      console.log(createWebhookResp);
-    },
-    async deactivate() {
-      console.log(
-        `Removing webhook from phone number ${this.incomingPhoneNumber}`
-      );
-      const deleteWebhookResp = await this.twilio.setIncomingSMSWebhookURL(
-        this.incomingPhoneNumber,
-        "" // remove the webhook URL
-      );
-      console.log(deleteWebhookResp);
-    },
-  },
-  async run(event) {
-    const { body, headers } = event;
-    const twiml = new MessagingResponse();
-
-    // https://support.twilio.com/hc/en-us/articles/223134127-Receive-SMS-and-MMS-Messages-without-Responding
-    let responseBody = "<Response></Response>";
-    if (this.responseMessage) {
-      twiml.message(this.responseMessage);
-      responseBody = twiml.toString();
-    }
-
-    this.http.respond({
-      status: 200,
-      headers: { "Content-Type": "text/xml" },
-      body: responseBody,
-    });
-
-    const twilioSignature = headers["x-twilio-signature"];
-    if (!twilioSignature) {
-      console.log("No x-twilio-signature header in request. Exiting.");
-      return;
-    }
-
-    // See https://www.twilio.com/docs/usage/webhooks/webhooks-security
-    if (
-      !twilioClient.validateRequest(
-        this.authToken,
-        twilioSignature,
-        `${this.http.endpoint}/`, // This must match the incoming URL exactly, which contains a /
-        body
-      )
-    ) {
-      throw new Error(
-        "Computed Twilio signature doesn't match signature received in header"
-      );
-    }
-
-    this.$emit(body, {
-      summary: body.Body, // the content of the text message
-      id: headers["i-twilio-idempotency-token"], // if Twilio retries a message, but we've already emitted, dedupe
-    });
-  },
-};

package/twilio.app.js

@@ -1,52 +0,0 @@
-const twilioClient = require("twilio");
-
-module.exports = {
-  type: "app",
-  app: "twilio",
-  propDefinitions: {
-    authToken: {
-      type: "string",
-      secret: true,
-      label: "Twilio Auth Token",
-      description:
-        "Your Twilio auth token, found [in your Twilio console](https://www.twilio.com/console). Required for validating Twilio events.",
-    },
-    incomingPhoneNumber: {
-      type: "string",
-      label: "Incoming Phone Number",
-      description:
-        "The Twilio phone number where you'll receive messages. This source creates a webhook tied to this incoming phone number, **overwriting any existing webhook URL**.",
-      async options() {
-        return await this.listIncomingPhoneNumbers();
-      },
-    },
-    responseMessage: {
-      type: "string",
-      optional: true,
-      label: "SMS Response Message",
-      description:
-        "The message you want to send in response to incoming messages. Leave this blank if you don't need to issue a response.",
-    },
-  },
-  methods: {
-    getClient() {
-      return twilioClient(this.$auth.Sid, this.$auth.Secret, {
-        accountSid: this.$auth.AccountSid,
-      });
-    },
-    async setIncomingSMSWebhookURL(phoneNumberSid, url) {
-      const client = this.getClient();
-      return await client.incomingPhoneNumbers(phoneNumberSid).update({
-        smsMethod: "POST",
-        smsUrl: url,
-      });
-    },
-    async listIncomingPhoneNumbers() {
-      const client = this.getClient();
-      const numbers = await client.incomingPhoneNumbers.list();
-      return numbers.map((number) => {
-        return { label: number.friendlyName, value: number.sid };
-      });
-    },
-  },
-};