diff --git a/packages/backend/src/apps/google-drive/assets/favicon.svg b/packages/backend/src/apps/google-drive/assets/favicon.svg new file mode 100644 index 00000000..a8cefd5b --- /dev/null +++ b/packages/backend/src/apps/google-drive/assets/favicon.svg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/packages/backend/src/apps/google-drive/auth/generate-auth-url.ts b/packages/backend/src/apps/google-drive/auth/generate-auth-url.ts new file mode 100644 index 00000000..ea89f8a4 --- /dev/null +++ b/packages/backend/src/apps/google-drive/auth/generate-auth-url.ts @@ -0,0 +1,24 @@ +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({ + client_id: $.auth.data.clientId as string, + 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, + }); +} diff --git a/packages/backend/src/apps/google-drive/auth/index.ts b/packages/backend/src/apps/google-drive/auth/index.ts new file mode 100644 index 00000000..8d826632 --- /dev/null +++ b/packages/backend/src/apps/google-drive/auth/index.ts @@ -0,0 +1,48 @@ +import generateAuthUrl from './generate-auth-url'; +import verifyCredentials from './verify-credentials'; +import refreshToken from './refresh-token'; +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/google-drive/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' 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, + refreshToken, +}; diff --git a/packages/backend/src/apps/google-drive/auth/is-still-verified.ts b/packages/backend/src/apps/google-drive/auth/is-still-verified.ts new file mode 100644 index 00000000..c46fa18b --- /dev/null +++ b/packages/backend/src/apps/google-drive/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) => { + const currentUser = await getCurrentUser($); + return !!currentUser.resourceName; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/google-drive/auth/refresh-token.ts b/packages/backend/src/apps/google-drive/auth/refresh-token.ts new file mode 100644 index 00000000..17d0c4cc --- /dev/null +++ b/packages/backend/src/apps/google-drive/auth/refresh-token.ts @@ -0,0 +1,26 @@ +import { URLSearchParams } from 'node:url'; +import { IGlobalVariable } from '@automatisch/types'; +import authScope from '../common/auth-scope'; + +const refreshToken = async ($: IGlobalVariable) => { + const params = new URLSearchParams({ + client_id: $.auth.data.clientId as string, + client_secret: $.auth.data.clientSecret as string, + grant_type: 'refresh_token', + refresh_token: $.auth.data.refreshToken as string, + }); + + 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; diff --git a/packages/backend/src/apps/google-drive/auth/verify-credentials.ts b/packages/backend/src/apps/google-drive/auth/verify-credentials.ts new file mode 100644 index 00000000..124e73c1 --- /dev/null +++ b/packages/backend/src/apps/google-drive/auth/verify-credentials.ts @@ -0,0 +1,57 @@ +import { IField, IGlobalVariable } from '@automatisch/types'; +import getCurrentUser from '../common/get-current-user'; + +type TUser = { + displayName: string; + metadata: { + primary: boolean; + }; +}; + +type TEmailAddress = { + value: string; + metadata: { + primary: boolean; + }; +}; + +const verifyCredentials = async ($: IGlobalVariable) => { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field: IField) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value as string; + 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: TUser) => name.metadata.primary + ); + const { value: email } = currentUser.emailAddresses.find( + (emailAddress: TEmailAddress) => 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}`, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/google-drive/common/add-auth-header.ts b/packages/backend/src/apps/google-drive/common/add-auth-header.ts new file mode 100644 index 00000000..8e7798b8 --- /dev/null +++ b/packages/backend/src/apps/google-drive/common/add-auth-header.ts @@ -0,0 +1,11 @@ +import { TBeforeRequest } from '@automatisch/types'; + +const addAuthHeader: TBeforeRequest = ($, 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/google-drive/common/auth-scope.ts b/packages/backend/src/apps/google-drive/common/auth-scope.ts new file mode 100644 index 00000000..059f38ea --- /dev/null +++ b/packages/backend/src/apps/google-drive/common/auth-scope.ts @@ -0,0 +1,7 @@ +const authScope: string[] = [ + 'https://www.googleapis.com/auth/drive', + 'https://www.googleapis.com/auth/userinfo.email', + 'https://www.googleapis.com/auth/userinfo.profile', +]; + +export default authScope; diff --git a/packages/backend/src/apps/google-drive/common/get-current-user.ts b/packages/backend/src/apps/google-drive/common/get-current-user.ts new file mode 100644 index 00000000..724fe1ac --- /dev/null +++ b/packages/backend/src/apps/google-drive/common/get-current-user.ts @@ -0,0 +1,10 @@ +import { IGlobalVariable } from '@automatisch/types'; + +const getCurrentUser = async ($: IGlobalVariable) => { + const { data: currentUser } = await $.http.get( + 'https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses' + ); + return currentUser; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/google-drive/index.d.ts b/packages/backend/src/apps/google-drive/index.d.ts new file mode 100644 index 00000000..e69de29b diff --git a/packages/backend/src/apps/google-drive/index.ts b/packages/backend/src/apps/google-drive/index.ts new file mode 100644 index 00000000..d97b8884 --- /dev/null +++ b/packages/backend/src/apps/google-drive/index.ts @@ -0,0 +1,18 @@ +import defineApp from '../../helpers/define-app'; +import addAuthHeader from './common/add-auth-header'; +import auth from './auth'; +import triggers from './triggers'; + +export default defineApp({ + name: 'Google Drive', + key: 'google-drive', + baseUrl: 'https://drive.google.com', + apiBaseUrl: 'https://www.googleapis.com/drive', + iconUrl: '{BASE_URL}/apps/google-drive/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/google-drive/connection', + primaryColor: '1FA463', + supportsConnections: true, + beforeRequest: [addAuthHeader], + auth, + triggers, +}); diff --git a/packages/backend/src/apps/google-drive/triggers/index.ts b/packages/backend/src/apps/google-drive/triggers/index.ts new file mode 100644 index 00000000..a2de71ae --- /dev/null +++ b/packages/backend/src/apps/google-drive/triggers/index.ts @@ -0,0 +1,3 @@ +import newFiles from './new-files'; + +export default [newFiles]; diff --git a/packages/backend/src/apps/google-drive/triggers/new-files/index.ts b/packages/backend/src/apps/google-drive/triggers/new-files/index.ts new file mode 100644 index 00000000..e3d5835d --- /dev/null +++ b/packages/backend/src/apps/google-drive/triggers/new-files/index.ts @@ -0,0 +1,13 @@ +import defineTrigger from '../../../../helpers/define-trigger'; +import newFiles from './new-files'; + +export default defineTrigger({ + name: 'New Files', + key: 'newFiles', + pollInterval: 15, + description: 'Triggers when any new file is added (inside of any folder).', + + async run($) { + await newFiles($); + }, +}); diff --git a/packages/backend/src/apps/google-drive/triggers/new-files/new-files.ts b/packages/backend/src/apps/google-drive/triggers/new-files/new-files.ts new file mode 100644 index 00000000..885c5ec1 --- /dev/null +++ b/packages/backend/src/apps/google-drive/triggers/new-files/new-files.ts @@ -0,0 +1,29 @@ +import { IGlobalVariable } from '@automatisch/types'; + +const newFiles = async ($: IGlobalVariable) => { + const params = { + pageToken: undefined as unknown as string, + orderBy: 'createdTime desc', + q: `mimeType!='application/vnd.google-apps.folder'`, + fields: '*', + pageSize: 1000, + }; + + do { + const { data } = await $.http.get('/v3/files', { params }); + params.pageToken = data.nextPageToken; + + if (data.files?.length) { + for (const file of data.files) { + $.pushTriggerItem({ + raw: file, + meta: { + internalId: file.id, + }, + }); + } + } + } while (params.pageToken); +}; + +export default newFiles;