feat(zendesk): add zendesk integration (#1385)

* feat(zendesk): add zendesk integration

* Add Zendesk connection documentation

* docs(zendesk/connection): add missing steps

* feat(zendesk): add more auth scopes for planned triggers/actions

* fix(zendesk): fix instanceUrl

---------

Co-authored-by: Ali BARIN <ali.barin53@gmail.com>

packages/backend/src/apps/zendesk/auth/generate-auth-url.ts

@@ -0,0 +1,23 @@
+import { IField, IGlobalVariable } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+import authScope from '../common/auth-scope';
+
+export default async function generateAuthUrl($: IGlobalVariable) {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field: IField) => field.key == 'oAuthRedirectUrl'
+  );
+
+  const redirectUri = oauthRedirectUrlField.value as string;
+  const searchParams = new URLSearchParams({
+    response_type: 'code',
+    redirect_uri: redirectUri,
+    client_id: $.auth.data.clientId as string,
+    scope: authScope.join(' '),
+  });
+
+  await $.auth.set({
+    url: `${
+      $.auth.data.instanceUrl
+    }/oauth/authorizations/new?${searchParams.toString()}`,
+  });
+}

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

@@ -0,0 +1,55 @@
+import generateAuthUrl from './generate-auth-url';
+import verifyCredentials from './verify-credentials';
+import isStillVerified from './is-still-verified';
+
+export default {
+  fields: [
+    {
+      key: 'oAuthRedirectUrl',
+      label: 'OAuth Redirect URL',
+      type: 'string' as const,
+      required: true,
+      readOnly: true,
+      value: '{WEB_APP_URL}/app/zendesk/connections/add',
+      placeholder: null,
+      description: '',
+      clickToCopy: true,
+    },
+    {
+      key: 'instanceUrl',
+      label: 'Zendesk Subdomain Url',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: 'https://{{subdomain}}.zendesk.com',
+      clickToCopy: false,
+    },
+    {
+      key: 'clientId',
+      label: 'Client ID',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+    {
+      key: 'clientSecret',
+      label: 'Client Secret',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+  ],
+
+  generateAuthUrl,
+  verifyCredentials,
+  isStillVerified,
+};

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

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

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

@@ -0,0 +1,56 @@
+import { IGlobalVariable, IJSONValue, IField } from '@automatisch/types';
+import getCurrentUser from '../common/get-current-user';
+import scopes from '../common/auth-scope';
+
+const verifyCredentials = async ($: IGlobalVariable) => {
+  await getAccessToken($);
+
+  const user = await getCurrentUser($);
+  const subdomain = extractSubdomain($.auth.data.instanceUrl);
+  const name = user.name as string;
+  const screenName = [name, subdomain].filter(Boolean).join(' @ ');
+
+  await $.auth.set({
+    screenName,
+    apiToken: $.auth.data.apiToken,
+    instanceUrl: $.auth.data.instanceUrl,
+    email: $.auth.data.email,
+  });
+};
+
+const getAccessToken = async ($: IGlobalVariable) => {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field: IField) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value as string;
+
+  const response = await $.http.post(`/oauth/tokens`, {
+    redirect_uri: redirectUri,
+    code: $.auth.data.code,
+    grant_type: 'authorization_code',
+    scope: scopes.join(' '),
+    client_id: $.auth.data.clientId as string,
+    client_secret: $.auth.data.clientSecret as string,
+  });
+
+  const data = response.data;
+
+  $.auth.data.accessToken = data.access_token;
+
+  await $.auth.set({
+    clientId: $.auth.data.clientId,
+    clientSecret: $.auth.data.clientSecret,
+    accessToken: data.access_token,
+    tokenType: data.token_type,
+  });
+};
+
+function extractSubdomain(url: IJSONValue) {
+  const match = (url as string).match(/https:\/\/(.*?)\.zendesk\.com/);
+  if (match && match[1]) {
+    return match[1];
+  }
+  return null;
+}
+
+export default verifyCredentials;