diff --git a/packages/backend/src/apps/clickup/assets/favicon.svg b/packages/backend/src/apps/clickup/assets/favicon.svg new file mode 100644 index 00000000..98943260 --- /dev/null +++ b/packages/backend/src/apps/clickup/assets/favicon.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/backend/src/apps/clickup/auth/generate-auth-url.js b/packages/backend/src/apps/clickup/auth/generate-auth-url.js new file mode 100644 index 00000000..0b38be11 --- /dev/null +++ b/packages/backend/src/apps/clickup/auth/generate-auth-url.js @@ -0,0 +1,21 @@ +import { URLSearchParams } from 'url'; + +export default async function generateAuthUrl($) { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + const state = Math.random().toString(); + const searchParams = new URLSearchParams({ + client_id: $.auth.data.clientId, + redirect_uri: redirectUri, + state, + }); + + const url = `https://app.clickup.com/api?${searchParams.toString()}`; + + await $.auth.set({ + url, + originalState: state, + }); +} diff --git a/packages/backend/src/apps/clickup/auth/index.js b/packages/backend/src/apps/clickup/auth/index.js new file mode 100644 index 00000000..d4ff5f86 --- /dev/null +++ b/packages/backend/src/apps/clickup/auth/index.js @@ -0,0 +1,46 @@ +import generateAuthUrl from './generate-auth-url.js'; +import verifyCredentials from './verify-credentials.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/clickup/connections/add', + placeholder: null, + description: + 'When asked to input a redirect URL in ClickUp, 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, +}; diff --git a/packages/backend/src/apps/clickup/auth/is-still-verified.js b/packages/backend/src/apps/clickup/auth/is-still-verified.js new file mode 100644 index 00000000..08962895 --- /dev/null +++ b/packages/backend/src/apps/clickup/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.id; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/clickup/auth/verify-credentials.js b/packages/backend/src/apps/clickup/auth/verify-credentials.js new file mode 100644 index 00000000..39302f2d --- /dev/null +++ b/packages/backend/src/apps/clickup/auth/verify-credentials.js @@ -0,0 +1,31 @@ +import getCurrentUser from '../common/get-current-user.js'; + +const verifyCredentials = async ($) => { + if ($.auth.data.originalState !== $.auth.data.state) { + throw new Error(`The 'state' parameter does not match.`); + } + + const { data } = await $.http.post('/v2/oauth/token', { + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + code: $.auth.data.code, + }); + + await $.auth.set({ + accessToken: data.access_token, + tokenType: data.token_type, + }); + + const currentUser = await getCurrentUser($); + const screenName = [currentUser.username, currentUser.email] + .filter(Boolean) + .join(' @ '); + + await $.auth.set({ + clientId: $.auth.data.clientId, + clientSecret: $.auth.data.clientSecret, + screenName, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/clickup/common/add-auth-header.js b/packages/backend/src/apps/clickup/common/add-auth-header.js new file mode 100644 index 00000000..02477aa4 --- /dev/null +++ b/packages/backend/src/apps/clickup/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; diff --git a/packages/backend/src/apps/clickup/common/get-current-user.js b/packages/backend/src/apps/clickup/common/get-current-user.js new file mode 100644 index 00000000..d6119e3d --- /dev/null +++ b/packages/backend/src/apps/clickup/common/get-current-user.js @@ -0,0 +1,6 @@ +const getCurrentUser = async ($) => { + const { data } = await $.http.get('/v2/user'); + return data.user; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/clickup/index.js b/packages/backend/src/apps/clickup/index.js new file mode 100644 index 00000000..a9dd3268 --- /dev/null +++ b/packages/backend/src/apps/clickup/index.js @@ -0,0 +1,16 @@ +import defineApp from '../../helpers/define-app.js'; +import addAuthHeader from './common/add-auth-header.js'; +import auth from './auth/index.js'; + +export default defineApp({ + name: 'ClickUp', + key: 'clickup', + baseUrl: 'https://clickup.com', + apiBaseUrl: 'https://api.clickup.com/api', + iconUrl: '{BASE_URL}/apps/clickup/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/clickup/connection', + primaryColor: 'FD71AF', + supportsConnections: true, + beforeRequest: [addAuthHeader], + auth, +}); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index ad681517..beef4aa8 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -77,6 +77,12 @@ export default defineConfig({ { text: 'Connection', link: '/apps/datastore/connection' }, ], }, + { + text: 'ClickUp', + collapsible: true, + collapsed: true, + items: [{ text: 'Connection', link: '/apps/clickup/connection' }], + }, { text: 'DeepL', collapsible: true, diff --git a/packages/docs/pages/apps/clickup/connection.md b/packages/docs/pages/apps/clickup/connection.md new file mode 100644 index 00000000..d1e6702d --- /dev/null +++ b/packages/docs/pages/apps/clickup/connection.md @@ -0,0 +1,17 @@ +# ClickUp + +:::info +This page explains the steps you need to follow to set up the ClickUp +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Login to your ClickUp account: [https://app.clickup.com/login](https://app.clickup.com/login). +2. Go to **Settings** page. +3. Click on the **ClickUp API** tab on the left. +4. Click on the **Create an App** button. +5. Fill the name field. +6. Copy **OAuth Redirect URL** from Automatisch to **Redirect URL(s)** field. +7. Copy **Client ID** to **Client ID** field on Automatisch. +8. Copy **Client Secret** to **Client Secret** field on Automatisch. +9. Click **Submit** button on Automatisch. +10. Congrats! Start using your new ClickUp connection within the flows. diff --git a/packages/docs/pages/public/favicons/clickup.svg b/packages/docs/pages/public/favicons/clickup.svg new file mode 100644 index 00000000..98943260 --- /dev/null +++ b/packages/docs/pages/public/favicons/clickup.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +