feat(gmail): add new emails trigger

packages/backend/package.json

@@ -46,7 +46,6 @@
     "graphql-shield": "^7.5.0",
     "graphql-tools": "^8.2.0",
     "handlebars": "^4.7.7",
-    "he": "^1.2.0",
     "http-errors": "~1.6.3",
     "http-proxy-agent": "^7.0.0",
     "https-proxy-agent": "^7.0.1",

packages/backend/src/apps/formatter/actions/text/index.js

@@ -2,7 +2,6 @@ import defineAction from '../../../../helpers/define-action.js';
 
 import base64ToString from './transformers/base64-to-string.js';
 import capitalize from './transformers/capitalize.js';
-import decodeHtmlEntities from './transformers/decode-html-entities.js';
 import extractEmailAddress from './transformers/extract-email-address.js';
 import extractNumber from './transformers/extract-number.js';
 import htmlToMarkdown from './transformers/html-to-markdown.js';
@@ -17,7 +16,6 @@ import useDefaultValue from './transformers/use-default-value.js';
 const transformers = {
   base64ToString,
   capitalize,
-  decodeHtmlEntities,
   extractEmailAddress,
   extractNumber,
   htmlToMarkdown,
@@ -45,7 +43,6 @@ export default defineAction({
       options: [
         { label: 'Base64 to String', value: 'base64ToString' },
         { label: 'Capitalize', value: 'capitalize' },
-        { label: 'Decode HTML Entities', value: 'decodeHtmlEntities' },
         { label: 'Convert HTML to Markdown', value: 'htmlToMarkdown' },
         { label: 'Convert Markdown to HTML', value: 'markdownToHtml' },
         { label: 'Extract Email Address', value: 'extractEmailAddress' },

packages/backend/src/apps/formatter/actions/text/transformers/decode-html-entities.js

@@ -1,8 +0,0 @@
-import he from 'he';
-
-const decodeHtmlEntities = ($) => {
-  const input = $.step.parameters.input;
-  return he.decode(input);
-};
-
-export default decodeHtmlEntities;

packages/backend/src/apps/formatter/dynamic-fields/list-transform-options/index.js

@@ -1,6 +1,5 @@
 import base64ToString from './text/base64-to-string.js';
 import capitalize from './text/capitalize.js';
-import decodeHtmlEntities from './text/decode-html-entities.js';
 import extractEmailAddress from './text/extract-email-address.js';
 import extractNumber from './text/extract-number.js';
 import htmlToMarkdown from './text/html-to-markdown.js';
@@ -20,7 +19,6 @@ import formatDateTime from './date-time/format-date-time.js';
 const options = {
   base64ToString,
   capitalize,
-  decodeHtmlEntities,
   extractEmailAddress,
   extractNumber,
   htmlToMarkdown,

packages/backend/src/apps/formatter/dynamic-fields/list-transform-options/text/decode-html-entities.js

@@ -1,12 +0,0 @@
-const decodeHtmlEntities = [
-  {
-    label: 'Input',
-    key: 'input',
-    type: 'string',
-    required: true,
-    description: 'Text that will be decoded.',
-    variables: true,
-  },
-];
-
-export default decodeHtmlEntities;

packages/backend/src/apps/gmail/assets/favicon.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 49.4 512 399.42">
+  <g fill="none" fill-rule="evenodd">
+    <g fill-rule="nonzero">
+      <path fill="#4285f4" d="M34.91 448.818h81.454V251L0 163.727V413.91c0 19.287 15.622 34.91 34.91 34.91z"/>
+      <path fill="#34a853" d="M395.636 448.818h81.455c19.287 0 34.909-15.622 34.909-34.909V163.727L395.636 251z"/>
+      <path fill="#fbbc04" d="M395.636 99.727V251L512 163.727v-46.545c0-43.142-49.25-67.782-83.782-41.891z"/>
+    </g>
+    <path fill="#ea4335" d="M116.364 251V99.727L256 204.455 395.636 99.727V251L256 355.727z"/>
+    <path fill="#c5221f" fill-rule="nonzero" d="M0 117.182v46.545L116.364 251V99.727L83.782 75.291C49.25 49.4 0 74.04 0 117.18z"/>
+  </g>
+</svg>

packages/backend/src/apps/gmail/auth/generate-auth-url.js

@@ -0,0 +1,23 @@
+import { URLSearchParams } from 'url';
+import authScope from '../common/auth-scope.js';
+
+export default async function generateAuthUrl($) {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value;
+  const searchParams = new URLSearchParams({
+    client_id: $.auth.data.clientId,
+    redirect_uri: redirectUri,
+    prompt: 'select_account',
+    scope: authScope.join(' '),
+    response_type: 'code',
+    access_type: 'offline',
+  });
+
+  const url = `https://accounts.google.com/o/oauth2/v2/auth?${searchParams.toString()}`;
+
+  await $.auth.set({
+    url,
+  });
+}

packages/backend/src/apps/gmail/auth/index.js

@@ -0,0 +1,48 @@
+import generateAuthUrl from './generate-auth-url.js';
+import verifyCredentials from './verify-credentials.js';
+import refreshToken from './refresh-token.js';
+import isStillVerified from './is-still-verified.js';
+
+export default {
+  fields: [
+    {
+      key: 'oAuthRedirectUrl',
+      label: 'OAuth Redirect URL',
+      type: 'string',
+      required: true,
+      readOnly: true,
+      value: '{WEB_APP_URL}/app/gmail/connections/add',
+      placeholder: null,
+      description:
+        'When asked to input a redirect URL in Google Cloud, enter the URL above.',
+      clickToCopy: true,
+    },
+    {
+      key: 'clientId',
+      label: 'Client ID',
+      type: 'string',
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+    {
+      key: 'clientSecret',
+      label: 'Client Secret',
+      type: 'string',
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+  ],
+
+  generateAuthUrl,
+  verifyCredentials,
+  isStillVerified,
+  refreshToken,
+};

packages/backend/src/apps/gmail/auth/is-still-verified.js

@@ -0,0 +1,8 @@
+import getCurrentUser from '../common/get-current-user.js';
+
+const isStillVerified = async ($) => {
+  const currentUser = await getCurrentUser($);
+  return !!currentUser.resourceName;
+};
+
+export default isStillVerified;

packages/backend/src/apps/gmail/auth/refresh-token.js

@@ -0,0 +1,26 @@
+import { URLSearchParams } from 'node:url';
+
+import authScope from '../common/auth-scope.js';
+
+const refreshToken = async ($) => {
+  const params = new URLSearchParams({
+    client_id: $.auth.data.clientId,
+    client_secret: $.auth.data.clientSecret,
+    grant_type: 'refresh_token',
+    refresh_token: $.auth.data.refreshToken,
+  });
+
+  const { data } = await $.http.post(
+    'https://oauth2.googleapis.com/token',
+    params.toString()
+  );
+
+  await $.auth.set({
+    accessToken: data.access_token,
+    expiresIn: data.expires_in,
+    scope: authScope.join(' '),
+    tokenType: data.token_type,
+  });
+};
+
+export default refreshToken;

packages/backend/src/apps/gmail/auth/verify-credentials.js

@@ -0,0 +1,43 @@
+import getCurrentUser from '../common/get-current-user.js';
+
+const verifyCredentials = async ($) => {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value;
+  const { data } = await $.http.post(`https://oauth2.googleapis.com/token`, {
+    client_id: $.auth.data.clientId,
+    client_secret: $.auth.data.clientSecret,
+    code: $.auth.data.code,
+    grant_type: 'authorization_code',
+    redirect_uri: redirectUri,
+  });
+
+  await $.auth.set({
+    accessToken: data.access_token,
+    tokenType: data.token_type,
+  });
+
+  const currentUser = await getCurrentUser($);
+
+  const { displayName } = currentUser.names.find(
+    (name) => name.metadata.primary
+  );
+  const { value: email } = currentUser.emailAddresses.find(
+    (emailAddress) => emailAddress.metadata.primary
+  );
+
+  await $.auth.set({
+    clientId: $.auth.data.clientId,
+    clientSecret: $.auth.data.clientSecret,
+    scope: $.auth.data.scope,
+    idToken: data.id_token,
+    expiresIn: data.expires_in,
+    refreshToken: data.refresh_token,
+    resourceName: currentUser.resourceName,
+    screenName: `${displayName} - ${email}`,
+    userId: email,
+  });
+};
+
+export default verifyCredentials;

packages/backend/src/apps/gmail/common/add-auth-header.js

@@ -0,0 +1,9 @@
+const addAuthHeader = ($, requestConfig) => {
+  if ($.auth.data?.accessToken) {
+    requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`;
+  }
+
+  return requestConfig;
+};
+
+export default addAuthHeader;

packages/backend/src/apps/gmail/common/auth-scope.js

@@ -0,0 +1,8 @@
+const authScope = [
+  'https://www.googleapis.com/auth/gmail.compose',
+  'https://www.googleapis.com/auth/gmail.modify',
+  'https://www.googleapis.com/auth/userinfo.email',
+  'https://www.googleapis.com/auth/userinfo.profile',
+];
+
+export default authScope;

packages/backend/src/apps/gmail/common/get-current-user.js

@@ -0,0 +1,8 @@
+const getCurrentUser = async ($) => {
+  const { data: currentUser } = await $.http.get(
+    'https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses'
+  );
+  return currentUser;
+};
+
+export default getCurrentUser;

packages/backend/src/apps/gmail/dynamic-data/index.js

@@ -0,0 +1,3 @@
+import listLabels from './list-labels/index.js';
+
+export default [listLabels];

packages/backend/src/apps/gmail/dynamic-data/list-labels/index.js

@@ -0,0 +1,22 @@
+export default {
+  name: 'List labels',
+  key: 'listLabels',
+
+  async run($) {
+    const labels = {
+      data: [],
+    };
+    const userId = $.auth.data.userId;
+
+    const { data } = await $.http.get(`/gmail/v1/users/${userId}/labels`);
+
+    for (const label of data.labels) {
+      labels.data.push({
+        value: label.id,
+        name: label.name,
+      });
+    }
+
+    return labels;
+  },
+};

packages/backend/src/apps/gmail/index.js

@@ -0,0 +1,20 @@
+import defineApp from '../../helpers/define-app.js';
+import addAuthHeader from './common/add-auth-header.js';
+import auth from './auth/index.js';
+import triggers from './triggers/index.js';
+import dynamicData from './dynamic-data/index.js';
+
+export default defineApp({
+  name: 'Gmail',
+  key: 'gmail',
+  baseUrl: 'https://mail.google.com',
+  apiBaseUrl: 'https://gmail.googleapis.com',
+  iconUrl: '{BASE_URL}/apps/gmail/assets/favicon.svg',
+  authDocUrl: 'https://automatisch.io/docs/apps/gmail/connection',
+  primaryColor: 'ea4335',
+  supportsConnections: true,
+  beforeRequest: [addAuthHeader],
+  auth,
+  triggers,
+  dynamicData,
+});

packages/backend/src/apps/gmail/triggers/index.js

@@ -0,0 +1,3 @@
+import newEmails from './new-emails/index.js';
+
+export default [newEmails];

packages/backend/src/apps/gmail/triggers/new-emails/index.js

@@ -0,0 +1,68 @@
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New emails',
+  key: 'newEmails',
+  pollInterval: 15,
+  description:
+    'Triggers when a new email is received in the specified mailbox.',
+  arguments: [
+    {
+      label: 'Label',
+      key: 'labelId',
+      type: 'dropdown',
+      required: false,
+      description:
+        "If you don't choose a label, this Zap will trigger for all emails, including Drafts.",
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listLabels',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const userId = $.auth.data.userId;
+    const labelId = $.step.parameters.labelId;
+
+    const params = {
+      maxResults: 500,
+      pageToken: undefined,
+    };
+
+    if (labelId) {
+      params.labelIds = labelId;
+    }
+
+    do {
+      const { data } = await $.http.get(`/gmail/v1/users/${userId}/messages`, {
+        params,
+      });
+      params.pageToken = data.nextPageToken;
+
+      if (!data?.messages?.length) {
+        return;
+      }
+
+      for (const message of data.messages) {
+        const { data: messageData } = await $.http.get(
+          `/gmail/v1/users/${userId}/messages/${message.id}`
+        );
+
+        $.pushTriggerItem({
+          raw: messageData,
+          meta: {
+            internalId: messageData.id,
+          },
+        });
+      }
+    } while (params.pageToken);
+  },
+});

packages/docs/pages/.vitepress/config.js

@@ -141,6 +141,12 @@ export default defineConfig({
             { text: 'Connection', link: '/apps/gitlab/connection' },
           ],
         },
+        {
+          text: 'Gmail',
+          collapsible: true,
+          collapsed: true,
+          items: [{ text: 'Connection', link: '/apps/gmail/connection' }],
+        },
         {
           text: 'Google Calendar',
           collapsible: true,

packages/docs/pages/apps/gmail/connection.md

@@ -0,0 +1,28 @@
+# Gmail
+
+:::info
+This page explains the steps you need to follow to set up the Gmail
+connection in Automatisch. If any of the steps are outdated, please let us know!
+:::
+
+1. Go to the [Google Cloud Console](https://console.cloud.google.com) to create a project.
+2. Click on the project drop-down menu at the top of the page, and click on the **New Project** button.
+3. Enter a name for your project and click on the **Create** button.
+4. Go to [API Library](https://console.cloud.google.com/apis/library) in Google Cloud console.
+5. Search for **People API** in the search bar and click on it.
+6. Click on the **Enable** button to enable the API.
+7. Repeat steps 5 and 6 for the **Gmail API**
+8. Go to [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) in Google Cloud console.
+9. Select **External** here for starting your app in testing mode at first. Click on the **Create** button.
+10. Fill **App Name**, **User Support Email**, and **Developer Contact Information**. Click on the **Save and Continue** button.
+11. Skip adding or removing scopes and click on the **Save and Continue** button.
+12. Click on the **Add Users** button and add a test email because only test users can access the app while publishing status is set to "Testing".
+13. Click on the **Save and Continue** button and now you have configured the consent screen.
+14. Go to [Credentials](https://console.cloud.google.com/apis/credentials) in Google Cloud console.
+15. Click on the **Create Credentials** button and select the **OAuth client ID** option.
+16. Select the application type as **Web application** and fill the **Name** field.
+17. Copy **OAuth Redirect URL** from Automatisch to **Authorized redirect URIs** field, and click on the **Create** button.
+18. Copy the **Your Client ID** value from the following popup to the `Client ID` field on Automatisch.
+19. Copy the **Your Client Secret** value from the following popup to the `Client Secret` field on Automatisch.
+20. Click **Submit** button on Automatisch.
+21. Congrats! Start using your new Gmail connection within the flows.

packages/docs/pages/apps/gmail/triggers.md

@@ -0,0 +1,12 @@
+---
+favicon: /favicons/gmail.svg
+items:
+  - name: New emails
+    desc: Triggers when a new email is received in the specified mailbox.
+---
+
+<script setup>
+  import CustomListing from '../../components/CustomListing.vue'
+</script>
+
+<CustomListing />

packages/docs/pages/guide/available-apps.md

@@ -14,6 +14,7 @@ The following integrations are currently supported by Automatisch.
 - [Ghost](/apps/ghost/triggers)
 - [GitHub](/apps/github/triggers)
 - [GitLab](/apps/gitlab/triggers)
+- [Gmail](/apps/gmail/triggers)
 - [Google Calendar](/apps/google-calendar/triggers)
 - [Google Drive](/apps/google-drive/triggers)
 - [Google Forms](/apps/google-forms/triggers)

packages/docs/pages/public/favicons/gmail.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 49.4 512 399.42">
+  <g fill="none" fill-rule="evenodd">
+    <g fill-rule="nonzero">
+      <path fill="#4285f4" d="M34.91 448.818h81.454V251L0 163.727V413.91c0 19.287 15.622 34.91 34.91 34.91z"/>
+      <path fill="#34a853" d="M395.636 448.818h81.455c19.287 0 34.909-15.622 34.909-34.909V163.727L395.636 251z"/>
+      <path fill="#fbbc04" d="M395.636 99.727V251L512 163.727v-46.545c0-43.142-49.25-67.782-83.782-41.891z"/>
+    </g>
+    <path fill="#ea4335" d="M116.364 251V99.727L256 204.455 395.636 99.727V251L256 355.727z"/>
+    <path fill="#c5221f" fill-rule="nonzero" d="M0 117.182v46.545L116.364 251V99.727L83.782 75.291C49.25 49.4 0 74.04 0 117.18z"/>
+  </g>
+</svg>

yarn.lock

@@ -8973,16 +8973,11 @@ has@^1.0.3:
   dependencies:
     function-bind "^1.1.1"
 
-he@1.2.0:
+he@1.2.0, he@^1.2.0:
   version "1.2.0"
   resolved "https://registry.npmjs.org/he/-/he-1.2.0.tgz"
   integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==
 
-he@^1.2.0:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f"
-  integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==
-
 hexoid@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/hexoid/-/hexoid-1.0.0.tgz#ad10c6573fb907de23d9ec63a711267d9dc9bc18"