diff --git a/packages/backend/src/apps/youtube/assets/favicon.svg b/packages/backend/src/apps/youtube/assets/favicon.svg new file mode 100644 index 00000000..e54d503d --- /dev/null +++ b/packages/backend/src/apps/youtube/assets/favicon.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/packages/backend/src/apps/youtube/auth/generate-auth-url.ts b/packages/backend/src/apps/youtube/auth/generate-auth-url.ts new file mode 100644 index 00000000..ba34918c --- /dev/null +++ b/packages/backend/src/apps/youtube/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, + response_type: 'code', + scope: authScope.join(' '), + access_type: 'offline', + prompt: 'select_account', + }); + + const url = `https://accounts.google.com/o/oauth2/v2/auth?${searchParams.toString()}`; + + await $.auth.set({ + url, + }); +} diff --git a/packages/backend/src/apps/youtube/auth/index.ts b/packages/backend/src/apps/youtube/auth/index.ts new file mode 100644 index 00000000..f560270b --- /dev/null +++ b/packages/backend/src/apps/youtube/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/youtube/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/youtube/auth/is-still-verified.ts b/packages/backend/src/apps/youtube/auth/is-still-verified.ts new file mode 100644 index 00000000..c46fa18b --- /dev/null +++ b/packages/backend/src/apps/youtube/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/youtube/auth/refresh-token.ts b/packages/backend/src/apps/youtube/auth/refresh-token.ts new file mode 100644 index 00000000..17d0c4cc --- /dev/null +++ b/packages/backend/src/apps/youtube/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/youtube/auth/verify-credentials.ts b/packages/backend/src/apps/youtube/auth/verify-credentials.ts new file mode 100644 index 00000000..124e73c1 --- /dev/null +++ b/packages/backend/src/apps/youtube/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/youtube/common/add-auth-header.ts b/packages/backend/src/apps/youtube/common/add-auth-header.ts new file mode 100644 index 00000000..8e7798b8 --- /dev/null +++ b/packages/backend/src/apps/youtube/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/youtube/common/auth-scope.ts b/packages/backend/src/apps/youtube/common/auth-scope.ts new file mode 100644 index 00000000..c04b848b --- /dev/null +++ b/packages/backend/src/apps/youtube/common/auth-scope.ts @@ -0,0 +1,9 @@ +const authScope: string[] = [ + 'https://www.googleapis.com/auth/youtube', + 'https://www.googleapis.com/auth/youtube.readonly', + 'https://www.googleapis.com/auth/youtube.upload', + 'https://www.googleapis.com/auth/userinfo.email', + 'https://www.googleapis.com/auth/userinfo.profile', +]; + +export default authScope; diff --git a/packages/backend/src/apps/youtube/common/get-current-user.ts b/packages/backend/src/apps/youtube/common/get-current-user.ts new file mode 100644 index 00000000..724fe1ac --- /dev/null +++ b/packages/backend/src/apps/youtube/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/youtube/index.d.ts b/packages/backend/src/apps/youtube/index.d.ts new file mode 100644 index 00000000..e69de29b diff --git a/packages/backend/src/apps/youtube/index.ts b/packages/backend/src/apps/youtube/index.ts new file mode 100644 index 00000000..e95b147b --- /dev/null +++ b/packages/backend/src/apps/youtube/index.ts @@ -0,0 +1,16 @@ +import defineApp from '../../helpers/define-app'; +import addAuthHeader from './common/add-auth-header'; +import auth from './auth'; + +export default defineApp({ + name: 'Youtube', + key: 'youtube', + baseUrl: 'https://www.youtube.com/', + apiBaseUrl: 'https://www.googleapis.com/youtube', + iconUrl: '{BASE_URL}/apps/youtube/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/youtube/connection', + primaryColor: 'FF0000', + supportsConnections: true, + beforeRequest: [addAuthHeader], + auth, +}); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 674a7315..c768a220 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -411,6 +411,12 @@ export default defineConfig({ { text: 'Connection', link: '/apps/wordpress/connection' }, ], }, + { + text: 'Youtube', + collapsible: true, + collapsed: true, + items: [{ text: 'Connection', link: '/apps/youtube/connection' }], + }, ], '/': [ { diff --git a/packages/docs/pages/apps/youtube/connection.md b/packages/docs/pages/apps/youtube/connection.md new file mode 100644 index 00000000..3f3f7cde --- /dev/null +++ b/packages/docs/pages/apps/youtube/connection.md @@ -0,0 +1,28 @@ +# Youtube + +:::info +This page explains the steps you need to follow to set up the Youtube +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Go to the [Google Cloud Console](https://console.cloud.google.com) to create a project. +2. Click on the project drop-down menu at the top of the page, and click on the **New Project** button. +3. Enter a name for your project and click on the **Create** button. +4. Go to [API Library](https://console.cloud.google.com/apis/library) in Google Cloud console. +5. Search for **Youtube Data API** in the search bar and click on it. +6. Click on the **Enable** button to enable the API. +7. Repeat steps 5 and 6 for the **People API**. +8. Go to [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) in Google Cloud console. +9. Select **External** here for starting your app in testing mode at first. Click on the **Create** button. +10. Fill **App Name**, **User Support Email**, and **Developer Contact Information**. Click on the **Save and Continue** button. +11. Skip adding or removing scopes and click on the **Save and Continue** button. +12. Click on the **Add Users** button and add a test email because only test users can access the app while publishing status is set to "Testing". +13. Click on the **Save and Continue** button and now you have configured the consent screen. +14. Go to [Credentials](https://console.cloud.google.com/apis/credentials) in Google Cloud console. +15. Click on the **Create Credentials** button and select the **OAuth client ID** option. +16. Select the application type as **Web application** and fill the **Name** field. +17. Copy **OAuth Redirect URL** from Automatisch to **Authorized redirect URIs** field, and click on the **Create** button. +18. Copy the **Your Client ID** value from the following popup to the `Client ID` field on Automatisch. +19. Copy the **Your Client Secret** value from the following popup to the `Client Secret` field on Automatisch. +20. Click **Submit** button on Automatisch. +21. Congrats! Start using your new Youtube connection within the flows. diff --git a/packages/docs/pages/public/favicons/youtube.svg b/packages/docs/pages/public/favicons/youtube.svg new file mode 100644 index 00000000..e54d503d --- /dev/null +++ b/packages/docs/pages/public/favicons/youtube.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file