Merge pull request #1577 from automatisch/AUT-641

feat(jotform): add jotform integration

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

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" class="jff-logo-img" width="53" height="59" viewBox="0 0 53 59" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M14.4509 55.1332C15.5462 56.1951 14.7721 58.0143 13.2168 58.0143H3.4831C1.56265 58.0143 0 56.4995 0 54.6377V45.2017C0 43.6939 1.87664 42.9436 2.97195 44.0054L14.4509 55.1332Z" fill="#0A1551"></path><path d="M29.6655 55.8676C26.7843 53.0052 26.7843 48.3642 29.6655 45.5018L40.0638 35.1713C42.945 32.3089 47.6164 32.3089 50.4976 35.1713C53.3788 38.0338 53.3788 42.6747 50.4976 45.5371L40.0993 55.8676C37.2181 58.73 32.5468 58.73 29.6655 55.8676Z" fill="#FFB629"></path><path d="M2.1968 29.9101C-0.684414 27.0476 -0.684413 22.4067 2.1968 19.5443L19.696 2.14685C22.5772 -0.71559 27.2486 -0.715594 30.1298 2.14685C33.011 5.00929 33.011 9.65022 30.1298 12.5127L12.6306 29.9101C9.74937 32.7725 5.078 32.7725 2.1968 29.9101Z" fill="#0099FF"></path><path d="M16.5015 42.3095C13.6203 39.4471 13.6203 34.8062 16.5015 31.9437L40.1461 8.45322C43.0273 5.59079 47.6986 5.59079 50.5798 8.45322C53.4611 11.3157 53.4611 15.9566 50.5798 18.819L26.9353 42.3095C24.0541 45.1719 19.3827 45.1719 16.5015 42.3095Z" fill="#FF6100"></path></svg>

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

@@ -0,0 +1,30 @@
+import verifyCredentials from './verify-credentials.js';
+import isStillVerified from './is-still-verified.js';
+
+export default {
+  fields: [
+    {
+      key: 'apiUrl',
+      label: 'API URL',
+      type: 'string',
+      required: false,
+      readOnly: false,
+      value: 'https://api.jotform.com',
+      placeholder: 'https://${subdomain}.jotform.com/api',
+      clickToCopy: true,
+    },
+    {
+      key: 'apiKey',
+      label: 'API Key',
+      type: 'string',
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      clickToCopy: false,
+    },
+  ],
+
+  verifyCredentials,
+  isStillVerified,
+};

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

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

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

@@ -0,0 +1,12 @@
+import getCurrentUser from '../common/get-current-user.js';
+
+const verifyCredentials = async ($) => {
+  const user = await getCurrentUser($);
+
+  await $.auth.set({
+    screenName: user.name,
+    apiKey: $.auth.data.apiKey,
+  });
+};
+
+export default verifyCredentials;

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

@@ -0,0 +1,9 @@
+const addAuthHeader = ($, requestConfig) => {
+  if ($.auth.data?.apiKey) {
+    requestConfig.headers['APIKEY'] = `${$.auth.data.apiKey}`;
+  }
+
+  return requestConfig;
+};
+
+export default addAuthHeader;

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

@@ -0,0 +1,7 @@
+const getCurrentUser = async ($) => {
+  const response = await $.http.get('/user');
+  const currentUser = response.data.content;
+  return currentUser;
+};
+
+export default getCurrentUser;

packages/backend/src/apps/jotform/common/set-base-url.js

@@ -0,0 +1,11 @@
+const setBaseUrl = ($, requestConfig) => {
+  if ($.auth.data.apiUrl) {
+    requestConfig.baseURL = $.auth.data.apiUrl;
+  } else if ($.app.apiBaseUrl) {
+    requestConfig.baseURL = $.app.apiBaseUrl;
+  }
+
+  return requestConfig;
+};
+
+export default setBaseUrl;

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

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

packages/backend/src/apps/jotform/dynamic-data/list-forms/index.js

@@ -0,0 +1,41 @@
+export default {
+  name: 'List forms',
+  key: 'listForms',
+
+  async run($) {
+    const forms = {
+      data: [],
+    };
+    let hasMore = false;
+
+    const params = {
+      limit: 1000,
+      offset: 0,
+      orderby: 'created_at',
+    };
+
+    do {
+      const { data } = await $.http.get('/user/forms', { params });
+      params.offset = params.offset + params.limit;
+
+      if (data.content?.length) {
+        for (const form of data.content) {
+          if (form.status === 'ENABLED') {
+            forms.data.push({
+              value: form.id,
+              name: form.title,
+            });
+          }
+        }
+      }
+
+      if (data.resultSet.count >= data.resultSet.limit) {
+        hasMore = true;
+      } else {
+        hasMore = false;
+      }
+    } while (hasMore);
+
+    return forms;
+  },
+};

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

@@ -0,0 +1,21 @@
+import defineApp from '../../helpers/define-app.js';
+import addAuthHeader from './common/add-auth-header.js';
+import auth from './auth/index.js';
+import setBaseUrl from './common/set-base-url.js';
+import triggers from './triggers/index.js';
+import dynamicData from './dynamic-data/index.js';
+
+export default defineApp({
+  name: 'Jotform',
+  key: 'jotform',
+  iconUrl: '{BASE_URL}/apps/jotform/assets/favicon.svg',
+  authDocUrl: 'https://automatisch.io/docs/apps/jotform/connection',
+  supportsConnections: true,
+  baseUrl: 'https://www.jotform.com',
+  apiBaseUrl: 'https://api.jotform.com',
+  primaryColor: 'FF6100',
+  beforeRequest: [setBaseUrl, addAuthHeader],
+  auth,
+  triggers,
+  dynamicData,
+});

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

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

packages/backend/src/apps/jotform/triggers/new-submissions/index.js

@@ -0,0 +1,109 @@
+import Crypto from 'crypto';
+import { URLSearchParams } from 'url';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New submissions',
+  key: 'newSubmissions',
+  type: 'webhook',
+  description:
+    'Triggers when a new submission has been added to a specific form.',
+  arguments: [
+    {
+      label: 'Form',
+      key: 'formId',
+      type: 'dropdown',
+      required: true,
+      description: '',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listForms',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const sampleEventData = {
+      ip: '127.0.0.1',
+      type: 'WEB',
+      appID: '',
+      event: '',
+      action: '',
+      formID: Crypto.randomUUID(),
+      parent: '',
+      pretty: 'Name:test, E-mail:user@automatisch.io',
+      teamID: '',
+      unread: '',
+      product: '',
+      subject: '',
+      isSilent: '',
+      username: 'username',
+      deviceIDs: 'Array',
+      formTitle: 'Opt-In Form-Get Free Email Updates!',
+      fromTable: '',
+      customBody: '',
+      documentID: '',
+      rawRequest: '',
+      webhookURL: '',
+      customTitle: '',
+      trackAction: 'Array',
+      customParams: '',
+      submissionID: Crypto.randomUUID(),
+      customBodyParams: 'Array',
+      customTitleParams: 'Array',
+    };
+
+    const dataItem = {
+      raw: sampleEventData,
+      meta: {
+        internalId: sampleEventData.submissionID,
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async registerHook($) {
+    const formId = $.step.parameters.formId;
+
+    const params = new URLSearchParams({
+      webhookURL: $.webhookUrl,
+    });
+
+    const { data } = await $.http.post(
+      `/form/${formId}/webhooks`,
+      params.toString()
+    );
+
+    await $.flow.setRemoteWebhookId(data.content[0]);
+  },
+
+  async unregisterHook($) {
+    const formId = $.step.parameters.formId;
+
+    const { data } = await $.http.get(`/form/${formId}/webhooks`);
+
+    const webhookURLs = Object.values(data.content);
+    const webhookId = webhookURLs.findIndex((url) => url === $.webhookUrl);
+
+    await $.http.delete(`/form/${formId}/webhooks/${webhookId}`);
+  },
+});

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

@@ -252,6 +252,15 @@ export default defineConfig({
             { text: 'Connection', link: '/apps/invoice-ninja/connection' },
           ],
         },
+        {
+          text: 'Jotform',
+          collapsible: true,
+          collapsed: true,
+          items: [
+            { text: 'Triggers', link: '/apps/jotform/triggers' },
+            { text: 'Connection', link: '/apps/jotform/connection' },
+          ],
+        },
         {
           text: 'Mailchimp',
           collapsible: true,

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

@@ -0,0 +1,15 @@
+# Jotform
+
+:::info
+This page explains the steps you need to follow to set up the Jotform
+connection in Automatisch. If any of the steps are outdated, please let us know!
+:::
+
+1. Login to your Jotform account: [https://www.jotform.com/](https://www.jotform.com/).
+2. Click on your account image and go to **Settings**.
+3. Click on the **API** tab on the left.
+4. Click on the **Create New Key** button.
+5. Give "Full Access" permission to the created API key.
+6. Copy the **API key** from the page to the `API Key` field on Automatisch.
+7. Enter your API URL in the respective field if it's different than the default value. For EU, it's https://eu-api.jotform.com. For HIPAA, it's https://hipaa-api.jotform.com. For the Jotform Enterprise customers, it should be the API URL of your Jotform Enterprise instance, e.g. https://subdomain.jotform.com/API or https://your-domain.com/API. More information may be found on the [Jotform API documentation](https://api.jotform.com/docs/).
+8. Now, you can start using the Jotform connection with Automatisch.

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

@@ -0,0 +1,12 @@
+---
+favicon: /favicons/jotform.svg
+items:
+  - name: New submissions
+    desc: Triggers when a new submission has been added to a specific form.
+---
+
+<script setup>
+  import CustomListing from '../../components/CustomListing.vue'
+</script>
+
+<CustomListing />

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

@@ -25,6 +25,7 @@ The following integrations are currently supported by Automatisch.
 - [HTTP Request](/apps/http-request/actions)
 - [HubSpot](/apps/hubspot/actions)
 - [Invoice Ninja](/apps/invoice-ninja/triggers)
+- [Jotform](/apps/jotform/triggers)
 - [Mailchimp](/apps/mailchimp/triggers)
 - [MailerLite](/apps/mailerlite/triggers)
 - [Mattermost](/apps/mattermost/actions)

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

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" class="jff-logo-img" width="53" height="59" viewBox="0 0 53 59" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M14.4509 55.1332C15.5462 56.1951 14.7721 58.0143 13.2168 58.0143H3.4831C1.56265 58.0143 0 56.4995 0 54.6377V45.2017C0 43.6939 1.87664 42.9436 2.97195 44.0054L14.4509 55.1332Z" fill="#0A1551"></path><path d="M29.6655 55.8676C26.7843 53.0052 26.7843 48.3642 29.6655 45.5018L40.0638 35.1713C42.945 32.3089 47.6164 32.3089 50.4976 35.1713C53.3788 38.0338 53.3788 42.6747 50.4976 45.5371L40.0993 55.8676C37.2181 58.73 32.5468 58.73 29.6655 55.8676Z" fill="#FFB629"></path><path d="M2.1968 29.9101C-0.684414 27.0476 -0.684413 22.4067 2.1968 19.5443L19.696 2.14685C22.5772 -0.71559 27.2486 -0.715594 30.1298 2.14685C33.011 5.00929 33.011 9.65022 30.1298 12.5127L12.6306 29.9101C9.74937 32.7725 5.078 32.7725 2.1968 29.9101Z" fill="#0099FF"></path><path d="M16.5015 42.3095C13.6203 39.4471 13.6203 34.8062 16.5015 31.9437L40.1461 8.45322C43.0273 5.59079 47.6986 5.59079 50.5798 8.45322C53.4611 11.3157 53.4611 15.9566 50.5798 18.819L26.9353 42.3095C24.0541 45.1719 19.3827 45.1719 16.5015 42.3095Z" fill="#FF6100"></path></svg>