Gmail - Usability Audit (#13724)

* updates

* pnpm-lock.yaml

* create new topic names

* pnpm-lock.yaml

* updates to reduce latency

* verify-client-id

* updates

* remove console.log

* update alert props

* update topicType label

* updates

* parse attachments

Author: michelle0927

components/gmail/actions/add-label-to-email/add-label-to-email.mjs

@@ -1,34 +1,41 @@
-import common from "../../common/verify-client-id.mjs";
+import gmail from "../../gmail.app.mjs";
 
 export default {
-  ...common,
   key: "gmail-add-label-to-email",
   name: "Add Label to Email",
-  description: "Add a label to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
-  version: "0.0.3",
+  description: "Add label(s) to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
+  version: "0.0.4",
   type: "action",
   props: {
-    ...common.props,
+    gmail,
     message: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "message",
       ],
     },
-    label: {
+    addLabelIds: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "label",
       ],
-      withLabel: true,
+      type: "string[]",
+      label: "Labels",
     },
   },
   async run({ $ }) {
-    const response = await this.gmail.addLabelToEmail({
-      message: this.message,
-      label: this.label.value,
+    const {
+      gmail,
+      message,
+      addLabelIds = [],
+    } = this;
+
+    const response = await gmail.updateLabels({
+      message,
+      addLabelIds,
     });
-    $.export("$summary", `Successfully added ${this.label.label} label to email`);
+
+    $.export("$summary", `Successfully added ${addLabelIds.length} label(s)`);
     return response;
   },
 };

components/gmail/actions/create-draft/create-draft.mjs

@@ -1,71 +1,58 @@
-import common from "../../common/verify-client-id.mjs";
+import gmail from "../../gmail.app.mjs";
 
 export default {
-  ...common,
   key: "gmail-create-draft",
   name: "Create Draft",
   description: "Create a draft from your Google Workspace email account. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
-    ...common.props,
+    gmail,
     to: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "to",
       ],
     },
     cc: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "cc",
       ],
     },
     bcc: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "bcc",
       ],
     },
-    fromName: {
-      propDefinition: [
-        common.props.gmail,
-        "fromName",
-      ],
-    },
-    replyTo: {
-      propDefinition: [
-        common.props.gmail,
-        "replyTo",
-      ],
-    },
     subject: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "subject",
       ],
     },
     body: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "body",
       ],
     },
     bodyType: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "bodyType",
       ],
     },
     attachments: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "attachments",
       ],
     },
     inReplyTo: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "message",
       ],
       label: "In Reply To",
@@ -74,7 +61,7 @@ export default {
     },
     mimeType: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "mimeType",
       ],
     },

components/gmail/actions/download-attachment/download-attachment.mjs

@@ -1,50 +1,60 @@
-import common from "../../common/verify-client-id.mjs";
+import gmail from "../../gmail.app.mjs";
 import fs from "fs";
 import path from "path";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
-  ...common,
   key: "gmail-download-attachment",
-  name: "Download Attachement",
+  name: "Download Attachment",
   description: "Download an attachment by attachmentId to the /tmp directory. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.messages.attachments/get)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
-    ...common.props,
+    gmail,
     messageId: {
       propDefinition: [
-        common.props.gmail,
-        "message",
+        gmail,
+        "messageWithAttachments",
       ],
     },
     attachmentId: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "attachmentId",
         ({ messageId }) => ({
           messageId,
         }),
       ],
+      withLabel: true,
     },
     filename: {
       type: "string",
       label: "Filename",
       description: "Name of the new file. Example: `test.jpg`",
+      optional: true,
     },
   },
   async run({ $ }) {
+    const attachmentId = this.attachmentId.value || this.attachmentId;
+
     const attachment = await this.gmail.getAttachment({
       messageId: this.messageId,
-      attachmentId: this.attachmentId,
+      attachmentId,
     });
 
-    const filePath = path.join("/tmp", this.filename);
+    const filename = this.filename || this.attachmentId.label;
+    if (!filename) {
+      throw new ConfigurationError("Please enter a filename to save the downloaded file as in the `/tmp` directory.");
+    }
+
+    const filePath = path.join("/tmp", filename);
     const buffer = Buffer.from(attachment.data, "base64");
     fs.writeFileSync(filePath, buffer);
 
-    $.export("$summary", `Successfully created file ${this.filename} in \`/tmp\` directory`);
+    $.export("$summary", `Successfully created file ${filename} in \`/tmp\` directory`);
 
     return {
+      filename,
       filePath,
     };
   },

components/gmail/actions/find-email/find-email.mjs

@@ -1,23 +1,22 @@
-import common from "../../common/verify-client-id.mjs";
+import gmail from "../../gmail.app.mjs";
 
 export default {
-  ...common,
   key: "gmail-find-email",
   name: "Find Email",
   description: "Find an email using Google's Search Engine. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   props: {
-    ...common.props,
+    gmail,
     q: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "q",
       ],
     },
     labels: {
       propDefinition: [
-        common.props.gmail,
+        gmail,
         "label",
       ],
       type: "string[]",
@@ -32,31 +31,27 @@ export default {
       optional: true,
       default: false,
     },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.",
+      default: 100,
+      optional: true,
+    },
   },
   async run({ $ }) {
-    const messageIds = [];
-    let pageToken;
-
-    do {
-      const {
-        messages = [],
-        nextPageToken,
-      } = await this.gmail.listMessages({
-        q: this.q,
-        labelIds: this.labels,
-        includeSpamTrash: this.includeSpamTrash,
-        pageToken,
-      });
-      messageIds.push(...messages.map(({ id }) => id));
-      pageToken = nextPageToken;
-    } while (pageToken);
-
-    const messages = await this.gmail.getMessages(messageIds);
-
-    const suffix = messages.length === 1
+    const { messages = [] } = await this.gmail.listMessages({
+      q: this.q,
+      labelIds: this.labels,
+      includeSpamTrash: this.includeSpamTrash,
+      maxResults: this.maxResults,
+    });
+    const messageIds = messages.map(({ id }) => id);
+    const messagesToEmit = await this.gmail.getMessages(messageIds);
+    const suffix = messagesToEmit.length === 1
       ? ""
       : "s";
-    $.export("$summary", `Successfully found ${messages.length} message${suffix}`);
-    return messages;
+    $.export("$summary", `Successfully found ${messagesToEmit.length} message${suffix}`);
+    return messagesToEmit;
   },
 };

components/gmail/actions/remove-label-from-email/remove-label-from-email.mjs

@@ -0,0 +1,42 @@
+import gmail from "../../gmail.app.mjs";
+
+export default {
+  key: "gmail-remove-label-from-email",
+  name: "Remove Label from Email",
+  description: "Remove label(s) from an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    gmail,
+    message: {
+      propDefinition: [
+        gmail,
+        "message",
+      ],
+    },
+    removeLabelIds: {
+      propDefinition: [
+        gmail,
+        "label",
+      ],
+      type: "string[]",
+      label: "Labels",
+      description: "The labels to remove from the email",
+    },
+  },
+  async run({ $ }) {
+    const {
+      gmail,
+      message,
+      removeLabelIds = [],
+    } = this;
+
+    const response = await gmail.updateLabels({
+      message,
+      removeLabelIds,
+    });
+
+    $.export("$summary", `Successfully removed ${removeLabelIds.length} label(s)`);
+    return response;
+  },
+};

components/gmail/actions/send-email/send-email.mjs

@@ -4,7 +4,7 @@ export default {
   key: "gmail-send-email",
   name: "Send Email",
   description: "Send an email from your Google Workspace email account. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send)",
-  version: "0.1.3",
+  version: "0.1.4",
   type: "action",
   props: {
     gmail,

components/gmail/actions/update-org-signature/update-org-signature.mjs

@@ -1,17 +1,17 @@
 import googleCloud from "../../../google_cloud/google_cloud.app.mjs";
 import base from "../update-primary-signature/update-primary-signature.mjs";
-import verifyClient from "../../common/verify-client-id.mjs";
+import gmail from "../../gmail.app.mjs";
 
 export default {
   ...base,
   key: "gmail-update-org-signature",
   name: "Update Signature for Email in Organization",
   description: `Update the signature for a specific email address in an organization.
     A Google Cloud service account with delegated domain-wide authority is required for this action. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/update)`,
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
-    ...verifyClient.props,
+    gmail,
     googleCloud,
     signature: base.props.signature,
     email: {

components/gmail/actions/update-primary-signature/update-primary-signature.mjs

@@ -1,22 +1,20 @@
-import common from "../../common/verify-client-id.mjs";
+import gmail from "../../gmail.app.mjs";
 
 export default {
-  ...common,
   key: "gmail-update-primary-signature",
   name: "Update Signature for Primary Email Address",
   description: "Update the signature for the primary email address. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/update)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
-    ...common.props,
+    gmail,
     signature: {
       type: "string",
       label: "Signature",
       description: "The new signature.",
     },
   },
   methods: {
-    ...common.methods,
     async createOpts() {
       const { email } = await this.gmail.userInfo();
       return {