refactor(web): fix types

packages/backend/src/apps/twitter/auth/create-auth-data.ts

@@ -0,0 +1,35 @@
+import generateRequest from '../common/generate-request';
+import { IJSONObject, IField, IGlobalVariable } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+
+export default async function createAuthData($: IGlobalVariable) {
+  try {
+    const oauthRedirectUrlField = $.app.auth.fields.find(
+      (field: IField) => field.key == 'oAuthRedirectUrl'
+    );
+
+    const callbackUrl = oauthRedirectUrlField.value;
+
+    const response = await generateRequest($, {
+      requestPath: '/oauth/request_token',
+      method: 'POST',
+      data: { oauth_callback: callbackUrl },
+    });
+
+    const responseData = Object.fromEntries(new URLSearchParams(response.data));
+
+    await $.auth.set({
+      url: `${$.app.baseUrl}/oauth/authorize?oauth_token=${responseData.oauth_token}`,
+      accessToken: responseData.oauth_token,
+      accessSecret: responseData.oauth_token_secret,
+    });
+  } catch (error) {
+    const errorMessages = error.response.data.errors
+      .map((error: IJSONObject) => error.message)
+      .join(' ');
+
+    throw new Error(
+      `Error occured while verifying credentials: ${errorMessages}`
+    );
+  }
+}

packages/backend/src/apps/twitter/auth/index.ts

@@ -0,0 +1,219 @@
+import createAuthData from './create-auth-data';
+import verifyCredentials from './verify-credentials';
+import isStillVerified from './is-still-verified';
+
+export default {
+  fields: [
+    {
+      key: 'oAuthRedirectUrl',
+      label: 'OAuth Redirect URL',
+      type: 'string',
+      required: true,
+      readOnly: true,
+      value: '{WEB_APP_URL}/app/twitter/connections/add',
+      placeholder: null,
+      description:
+        'When asked to input an OAuth callback or redirect URL in Twitter OAuth, enter the URL above.',
+      clickToCopy: true,
+    },
+    {
+      key: 'consumerKey',
+      label: 'API Key',
+      type: 'string',
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+    {
+      key: 'consumerSecret',
+      label: 'API Secret',
+      type: 'string',
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+  ],
+  authenticationSteps: [
+    {
+      step: 1,
+      type: 'mutation',
+      name: 'createConnection',
+      arguments: [
+        {
+          name: 'key',
+          value: '{key}',
+        },
+        {
+          name: 'formattedData',
+          value: null,
+          properties: [
+            {
+              name: 'consumerKey',
+              value: '{fields.consumerKey}',
+            },
+            {
+              name: 'consumerSecret',
+              value: '{fields.consumerSecret}',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      step: 2,
+      type: 'mutation',
+      name: 'createAuthData',
+      arguments: [
+        {
+          name: 'id',
+          value: '{createConnection.id}',
+        },
+      ],
+    },
+    {
+      step: 3,
+      type: 'openWithPopup',
+      name: 'openAuthPopup',
+      arguments: [
+        {
+          name: 'url',
+          value: '{createAuthData.url}',
+        },
+      ],
+    },
+    {
+      step: 4,
+      type: 'mutation',
+      name: 'updateConnection',
+      arguments: [
+        {
+          name: 'id',
+          value: '{createConnection.id}',
+        },
+        {
+          name: 'formattedData',
+          value: null,
+          properties: [
+            {
+              name: 'oauthVerifier',
+              value: '{openAuthPopup.oauth_verifier}',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      step: 5,
+      type: 'mutation',
+      name: 'verifyConnection',
+      arguments: [
+        {
+          name: 'id',
+          value: '{createConnection.id}',
+        },
+      ],
+    },
+  ],
+  reconnectionSteps: [
+    {
+      step: 1,
+      type: 'mutation',
+      name: 'resetConnection',
+      arguments: [
+        {
+          name: 'id',
+          value: '{connection.id}',
+        },
+      ],
+    },
+    {
+      step: 2,
+      type: 'mutation',
+      name: 'updateConnection',
+      arguments: [
+        {
+          name: 'id',
+          value: '{connection.id}',
+        },
+        {
+          name: 'formattedData',
+          value: null,
+          properties: [
+            {
+              name: 'consumerKey',
+              value: '{fields.consumerKey}',
+            },
+            {
+              name: 'consumerSecret',
+              value: '{fields.consumerSecret}',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      step: 3,
+      type: 'mutation',
+      name: 'createAuthData',
+      arguments: [
+        {
+          name: 'id',
+          value: '{connection.id}',
+        },
+      ],
+    },
+    {
+      step: 4,
+      type: 'openWithPopup',
+      name: 'openAuthPopup',
+      arguments: [
+        {
+          name: 'url',
+          value: '{createAuthData.url}',
+        },
+      ],
+    },
+    {
+      step: 5,
+      type: 'mutation',
+      name: 'updateConnection',
+      arguments: [
+        {
+          name: 'id',
+          value: '{connection.id}',
+        },
+        {
+          name: 'formattedData',
+          value: null,
+          properties: [
+            {
+              name: 'oauthVerifier',
+              value: '{openAuthPopup.oauth_verifier}',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      step: 6,
+      type: 'mutation',
+      name: 'verifyConnection',
+      arguments: [
+        {
+          name: 'id',
+          value: '{connection.id}',
+        },
+      ],
+    },
+  ],
+
+  createAuthData,
+  verifyCredentials,
+  isStillVerified,
+};

packages/backend/src/apps/twitter/auth/is-still-verified.ts

@@ -0,0 +1,13 @@
+import { IGlobalVariable } from '@automatisch/types';
+import getCurrentUser from '../common/get-current-user';
+
+const isStillVerified = async ($: IGlobalVariable) => {
+  try {
+    await getCurrentUser($);
+    return true;
+  } catch (error) {
+    return false;
+  }
+};
+
+export default isStillVerified;

packages/backend/src/apps/twitter/auth/verify-credentials.ts

@@ -0,0 +1,24 @@
+import { IGlobalVariable } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+
+const verifyCredentials = async ($: IGlobalVariable) => {
+  try {
+    const response = await $.http.post(
+      `/oauth/access_token?oauth_verifier=${$.auth.data.oauthVerifier}&oauth_token=${$.auth.data.accessToken}`,
+      null
+    );
+
+    const responseData = Object.fromEntries(new URLSearchParams(response.data));
+
+    await $.auth.set({
+      accessToken: responseData.oauth_token,
+      accessSecret: responseData.oauth_token_secret,
+      userId: responseData.user_id,
+      screenName: responseData.screen_name,
+    });
+  } catch (error) {
+    throw new Error(error.response.data);
+  }
+};
+
+export default verifyCredentials;

packages/backend/src/apps/twitter/common/generate-request.ts

@@ -0,0 +1,39 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+import oauthClient from './oauth-client';
+import { Token } from 'oauth-1.0a';
+
+type IGenereateRequestOptons = {
+  requestPath: string;
+  method: string;
+  data?: IJSONObject;
+};
+
+const generateRequest = async (
+  $: IGlobalVariable,
+  options: IGenereateRequestOptons
+) => {
+  const { requestPath, method, data } = options;
+
+  const token: Token = {
+    key: $.auth.data.accessToken as string,
+    secret: $.auth.data.accessSecret as string,
+  };
+
+  const requestData = {
+    url: `${$.app.baseUrl}${requestPath}`,
+    method,
+    data,
+  };
+
+  const authHeader = oauthClient($).toHeader(
+    oauthClient($).authorize(requestData, token)
+  );
+
+  const response = await $.http.post(`/oauth/request_token`, null, {
+    headers: { ...authHeader },
+  });
+
+  return response;
+};
+
+export default generateRequest;

packages/backend/src/apps/twitter/common/get-current-user.ts

@@ -0,0 +1,14 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+import generateRequest from './generate-request';
+
+const getCurrentUser = async ($: IGlobalVariable): Promise<IJSONObject> => {
+  const response = await generateRequest($, {
+    requestPath: '/2/users/me',
+    method: 'GET',
+  });
+
+  const currentUser = response.data.data;
+  return currentUser;
+};
+
+export default getCurrentUser;

packages/backend/src/apps/twitter/common/get-user-by-username.ts

@@ -0,0 +1,22 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+import generateRequest from './generate-request';
+
+const getUserByUsername = async ($: IGlobalVariable, username: string) => {
+  const response = await generateRequest($, {
+    requestPath: `/2/users/by/username/${username}`,
+    method: 'GET',
+  });
+
+  if (response.data.errors) {
+    const errorMessages = response.data.errors
+      .map((error: IJSONObject) => error.detail)
+      .join(' ');
+
+    throw new Error(`Error occured while fetching user data: ${errorMessages}`);
+  }
+
+  const user = response.data.data;
+  return user;
+};
+
+export default getUserByUsername;

packages/backend/src/apps/twitter/common/get-user-followers.ts

@@ -0,0 +1,59 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+import { omitBy, isEmpty } from 'lodash';
+import generateRequest from './generate-request';
+
+type GetUserFollowersOptions = {
+  userId: string;
+  lastInternalId?: string;
+};
+
+const getUserFollowers = async (
+  $: IGlobalVariable,
+  options: GetUserFollowersOptions
+) => {
+  let response;
+  const followers: IJSONObject[] = [];
+
+  do {
+    const params: IJSONObject = {
+      pagination_token: response?.data?.meta?.next_token,
+    };
+
+    const queryParams = new URLSearchParams(omitBy(params, isEmpty));
+
+    const requestPath = `/2/users/${options.userId}/followers${
+      queryParams.toString() ? `?${queryParams.toString()}` : ''
+    }`;
+
+    response = await generateRequest($, {
+      requestPath,
+      method: 'GET',
+    });
+
+    if (response.data.meta.result_count > 0) {
+      response.data.data.forEach((tweet: IJSONObject) => {
+        if (
+          !options.lastInternalId ||
+          Number(tweet.id) > Number(options.lastInternalId)
+        ) {
+          followers.push(tweet);
+        } else {
+          return;
+        }
+      });
+    }
+  } while (response.data.meta.next_token && options.lastInternalId);
+
+  if (response.data?.errors) {
+    const errorMessages = response.data.errors
+      .map((error: IJSONObject) => error.detail)
+      .join(' ');
+
+    throw new Error(`Error occured while fetching user data: ${errorMessages}`);
+  }
+
+  return followers;
+};
+
+export default getUserFollowers;

packages/backend/src/apps/twitter/common/get-user-tweets.ts

@@ -0,0 +1,75 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+import omitBy from 'lodash/omitBy';
+import isEmpty from 'lodash/isEmpty';
+import generateRequest from './generate-request';
+import getCurrentUser from './get-current-user';
+import getUserByUsername from './get-user-by-username';
+
+type IGetUserTweetsOptions = {
+  currentUser: boolean;
+  userId?: string;
+  lastInternalId?: string;
+};
+
+const getUserTweets = async (
+  $: IGlobalVariable,
+  options: IGetUserTweetsOptions
+) => {
+  let username: string;
+
+  if (options.currentUser) {
+    const currentUser = await getCurrentUser($);
+    username = currentUser.username as string;
+  } else {
+    username = $.db.step.parameters.username as string;
+  }
+
+  const user = await getUserByUsername($, username);
+
+  let response;
+  const tweets: IJSONObject[] = [];
+
+  do {
+    const params: IJSONObject = {
+      since_id: options.lastInternalId,
+      pagination_token: response?.data?.meta?.next_token,
+    };
+
+    const queryParams = new URLSearchParams(omitBy(params, isEmpty));
+
+    const requestPath = `/2/users/${user.id}/tweets${
+      queryParams.toString() ? `?${queryParams.toString()}` : ''
+    }`;
+
+    response = await generateRequest($, {
+      requestPath,
+      method: 'GET',
+    });
+
+    if (response.data.meta.result_count > 0) {
+      response.data.data.forEach((tweet: IJSONObject) => {
+        if (
+          !options.lastInternalId ||
+          Number(tweet.id) > Number(options.lastInternalId)
+        ) {
+          tweets.push(tweet);
+        } else {
+          return;
+        }
+      });
+    }
+  } while (response.data.meta.next_token && options.lastInternalId);
+
+  if (response.data.errors) {
+    const errorMessages = response.data.errors
+      .map((error: IJSONObject) => error.detail)
+      .join(' ');
+
+    throw new Error(`Error occured while fetching user data: ${errorMessages}`);
+  }
+
+  return tweets;
+};
+
+export default getUserTweets;

packages/backend/src/apps/twitter/common/oauth-client.ts

@@ -0,0 +1,23 @@
+import { IGlobalVariable } from '@automatisch/types';
+import crypto from 'crypto';
+import OAuth from 'oauth-1.0a';
+
+const oauthClient = ($: IGlobalVariable) => {
+  const consumerData = {
+    key: $.auth.data.consumerKey as string,
+    secret: $.auth.data.consumerSecret as string,
+  };
+
+  return new OAuth({
+    consumer: consumerData,
+    signature_method: 'HMAC-SHA1',
+    hash_function(base_string, key) {
+      return crypto
+        .createHmac('sha1', key)
+        .update(base_string)
+        .digest('base64');
+    },
+  });
+};
+
+export default oauthClient;

packages/backend/src/apps/twitter/index.ts

@@ -0,0 +1,8 @@
+export default {
+  name: 'Twitter',
+  key: 'twitter',
+  iconUrl: './assets/favicon.svg',
+  authDocUrl: 'https://automatisch.io/docs/connections/twitter',
+  supportsConnections: true,
+  baseUrl: 'https://api.twitter.com',
+};

packages/backend/src/apps/twitter/triggers/my-tweets/index.ts

@@ -0,0 +1,30 @@
+import { IGlobalVariable } from '@automatisch/types';
+import getUserTweets from '../../common/get-user-tweets';
+
+export default {
+  name: 'My Tweets',
+  key: 'myTweets',
+  pollInterval: 15,
+  description: 'Will be triggered when you tweet something new.',
+  substeps: [
+    {
+      key: 'chooseConnection',
+      name: 'Choose connection',
+    },
+    {
+      key: 'testStep',
+      name: 'Test trigger',
+    },
+  ],
+
+  async run($: IGlobalVariable) {
+    return await getUserTweets($, {
+      currentUser: true,
+      lastInternalId: $.db.flow.lastInternalId,
+    });
+  },
+
+  async testRun($: IGlobalVariable) {
+    return await getUserTweets($, { currentUser: true });
+  },
+};

packages/backend/src/apps/twitter/triggers/new-follower-of-me/index.ts

@@ -0,0 +1,27 @@
+import { IGlobalVariable } from '@automatisch/types';
+import myFollowers from './my-followers';
+
+export default {
+  name: 'New follower of me',
+  key: 'myFollowers',
+  pollInterval: 15,
+  description: 'Will be triggered when you have a new follower.',
+  substeps: [
+    {
+      key: 'chooseConnection',
+      name: 'Choose connection',
+    },
+    {
+      key: 'testStep',
+      name: 'Test trigger',
+    },
+  ],
+
+  async run($: IGlobalVariable) {
+    return await myFollowers($, $.db.flow.lastInternalId);
+  },
+
+  async testRun($: IGlobalVariable) {
+    return await myFollowers($);
+  },
+};

packages/backend/src/apps/twitter/triggers/new-follower-of-me/my-followers.ts

@@ -0,0 +1,17 @@
+import { IGlobalVariable } from '@automatisch/types';
+import getCurrentUser from '../../common/get-current-user';
+import getUserByUsername from '../../common/get-user-by-username';
+import getUserFollowers from '../../common/get-user-followers';
+
+const myFollowers = async ($: IGlobalVariable, lastInternalId?: string) => {
+  const { username } = await getCurrentUser($);
+  const user = await getUserByUsername($, username as string);
+
+  const tweets = await getUserFollowers($, {
+    userId: user.id,
+    lastInternalId,
+  });
+  return tweets;
+};
+
+export default myFollowers;

packages/backend/src/apps/twitter/triggers/search-tweets/index.ts

@@ -0,0 +1,45 @@
+import { IGlobalVariable } from '@automatisch/types';
+import searchTweets from './search-tweets';
+
+export default {
+  name: 'Search Tweets',
+  key: 'searchTweets',
+  pollInterval: 15,
+  description:
+    'Will be triggered when any user tweet something containing a specific keyword, phrase, username or hashtag.',
+  substeps: [
+    {
+      key: 'chooseConnection',
+      name: 'Choose connection',
+    },
+    {
+      key: 'chooseTrigger',
+      name: 'Set up a trigger',
+      arguments: [
+        {
+          label: 'Search Term',
+          key: 'searchTerm',
+          type: 'string',
+          required: true,
+        },
+      ],
+    },
+    {
+      key: 'testStep',
+      name: 'Test trigger',
+    },
+  ],
+
+  async run($: IGlobalVariable) {
+    return await searchTweets($, {
+      searchTerm: $.db.step.parameters.searchTerm as string,
+      lastInternalId: $.db.flow.lastInternalId,
+    });
+  },
+
+  async testRun($: IGlobalVariable) {
+    return await searchTweets($, {
+      searchTerm: $.db.step.parameters.searchTerm as string,
+    });
+  },
+};

packages/backend/src/apps/twitter/triggers/search-tweets/search-tweets.ts

@@ -0,0 +1,65 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+import qs from 'qs';
+import generateRequest from '../../common/generate-request';
+import { omitBy, isEmpty } from 'lodash';
+
+type ISearchTweetsOptions = {
+  searchTerm: string;
+  lastInternalId?: string;
+};
+
+const searchTweets = async (
+  $: IGlobalVariable,
+  options: ISearchTweetsOptions
+) => {
+  let response;
+
+  const tweets: {
+    data: IJSONObject[];
+    error: IJSONObject | null;
+  } = {
+    data: [],
+    error: null,
+  };
+
+  do {
+    const params: IJSONObject = {
+      query: options.searchTerm,
+      since_id: options.lastInternalId,
+      pagination_token: response?.data?.meta?.next_token,
+    };
+
+    const queryParams = qs.stringify(omitBy(params, isEmpty));
+
+    const requestPath = `/2/tweets/search/recent${
+      queryParams.toString() ? `?${queryParams.toString()}` : ''
+    }`;
+
+    response = await generateRequest($, {
+      requestPath,
+      method: 'GET',
+    });
+
+    if (response.integrationError) {
+      tweets.error = response.integrationError;
+      return tweets;
+    }
+
+    if (response.data.meta.result_count > 0) {
+      response.data.data.forEach((tweet: IJSONObject) => {
+        if (
+          !options.lastInternalId ||
+          Number(tweet.id) > Number(options.lastInternalId)
+        ) {
+          tweets.data.push(tweet);
+        } else {
+          return;
+        }
+      });
+    }
+  } while (response.data.meta.next_token && options.lastInternalId);
+
+  return tweets;
+};
+
+export default searchTweets;

packages/backend/src/apps/twitter/triggers/user-tweets/index.ts

@@ -0,0 +1,46 @@
+import { IGlobalVariable } from '@automatisch/types';
+import getUserTweets from '../../common/get-user-tweets';
+
+export default {
+  name: 'User Tweets',
+  key: 'userTweets',
+  pollInterval: 15,
+  description: 'Will be triggered when a specific user tweet something new.',
+  substeps: [
+    {
+      key: 'chooseConnection',
+      name: 'Choose connection',
+    },
+    {
+      key: 'chooseTrigger',
+      name: 'Set up a trigger',
+      arguments: [
+        {
+          label: 'Username',
+          key: 'username',
+          type: 'string',
+          required: true,
+        },
+      ],
+    },
+    {
+      key: 'testStep',
+      name: 'Test trigger',
+    },
+  ],
+
+  async run($: IGlobalVariable) {
+    return await getUserTweets($, {
+      currentUser: false,
+      userId: $.db.step.parameters.username as string,
+      lastInternalId: $.db.flow.lastInternalId,
+    });
+  },
+
+  async testRun($: IGlobalVariable) {
+    return await getUserTweets($, {
+      currentUser: false,
+      userId: $.db.step.parameters.username as string,
+    });
+  },
+};