diff --git a/packages/backend/src/apps/spotify/assets/favicon.svg b/packages/backend/src/apps/spotify/assets/favicon.svg new file mode 100644 index 00000000..f84a03c6 --- /dev/null +++ b/packages/backend/src/apps/spotify/assets/favicon.svg @@ -0,0 +1,6 @@ + + Spotify + + + + \ No newline at end of file diff --git a/packages/backend/src/apps/spotify/auth/generate-auth-url.ts b/packages/backend/src/apps/spotify/auth/generate-auth-url.ts new file mode 100644 index 00000000..022e063e --- /dev/null +++ b/packages/backend/src/apps/spotify/auth/generate-auth-url.ts @@ -0,0 +1,27 @@ +import { IField, IGlobalVariable } from '@automatisch/types'; +import { URLSearchParams } from 'url'; +import scopes from '../common/scopes'; + +export default async function generateAuthUrl($: IGlobalVariable) { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field: IField) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value as string; + const state = Math.random().toString() as string; + + const searchParams = new URLSearchParams({ + client_id: $.auth.data.clientId as string, + client_secret: $.auth.data.clientSecret as string, + grant_type: 'client_credentials', + redirect_uri: redirectUri, + response_type: 'code', + scope: scopes.join(','), + state: state, + }); + + const url = `https://accounts.spotify.com/authorize?${searchParams}`; + + await $.auth.set({ + url, + }); +} diff --git a/packages/backend/src/apps/spotify/auth/index.ts b/packages/backend/src/apps/spotify/auth/index.ts new file mode 100644 index 00000000..e1a93927 --- /dev/null +++ b/packages/backend/src/apps/spotify/auth/index.ts @@ -0,0 +1,45 @@ +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/spotify/connections/add', + placeholder: null, + description: + 'When asked to input an OAuth callback or redirect URL in Spotify OAuth, 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, +}; diff --git a/packages/backend/src/apps/spotify/auth/is-still-verified.ts b/packages/backend/src/apps/spotify/auth/is-still-verified.ts new file mode 100644 index 00000000..befb7694 --- /dev/null +++ b/packages/backend/src/apps/spotify/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 user = await getCurrentUser($); + return !!user.id; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/spotify/auth/verify-credentials.ts b/packages/backend/src/apps/spotify/auth/verify-credentials.ts new file mode 100644 index 00000000..079c472d --- /dev/null +++ b/packages/backend/src/apps/spotify/auth/verify-credentials.ts @@ -0,0 +1,53 @@ +import { IGlobalVariable } from '@automatisch/types'; +import getCurrentUser from '../common/get-current-user'; +import { URLSearchParams } from 'url'; + +const verifyCredentials = async ($: IGlobalVariable) => { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value as string; + const params = new URLSearchParams({ + code: $.auth.data.code as string, + redirect_uri: redirectUri, + grant_type: 'authorization_code', + }); + + const headers = { + Authorization: `Basic ${Buffer.from( + $.auth.data.clientId + ':' + $.auth.data.clientSecret + ).toString('base64')}`, + 'Content-Type': 'application/x-www-form-urlencoded', + }; + + const response = await $.http.post( + 'https://accounts.spotify.com/api/token', + params.toString(), + { headers } + ); + + const { + access_token: accessToken, + refresh_token: refreshToken, + expires_in: expiresIn, + scope: scope, + token_type: tokenType, + } = response.data; + + await $.auth.set({ + accessToken, + refreshToken, + expiresIn, + scope, + tokenType, + }); + + const user = await getCurrentUser($); + + await $.auth.set({ + userId: user.id, + screenName: user.display_name, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/spotify/common/add-auth-header.ts b/packages/backend/src/apps/spotify/common/add-auth-header.ts new file mode 100644 index 00000000..d650c915 --- /dev/null +++ b/packages/backend/src/apps/spotify/common/add-auth-header.ts @@ -0,0 +1,12 @@ +import { TBeforeRequest } from '@automatisch/types'; + +const addAuthHeader: TBeforeRequest = ($, requestConfig) => { + if ($.auth.data?.accessToken) { + const authorizationHeader = `Bearer ${$.auth.data.accessToken}`; + requestConfig.headers.Authorization = authorizationHeader; + } + + return requestConfig; +}; + +export default addAuthHeader; diff --git a/packages/backend/src/apps/spotify/common/get-current-user.ts b/packages/backend/src/apps/spotify/common/get-current-user.ts new file mode 100644 index 00000000..0ccdf282 --- /dev/null +++ b/packages/backend/src/apps/spotify/common/get-current-user.ts @@ -0,0 +1,10 @@ +import { IGlobalVariable, IJSONObject } from '@automatisch/types'; + +const getCurrentUser = async ($: IGlobalVariable): Promise => { + const response = await $.http.get('/v1/me'); + const currentUser = response.data; + + return currentUser; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/spotify/common/scopes.ts b/packages/backend/src/apps/spotify/common/scopes.ts new file mode 100644 index 00000000..66360c40 --- /dev/null +++ b/packages/backend/src/apps/spotify/common/scopes.ts @@ -0,0 +1,13 @@ +const scopes = [ + 'user-follow-read', + 'playlist-read-private', + 'playlist-read-collaborative', + 'user-library-read', + 'playlist-modify-public', + 'playlist-modify-private', + 'user-library-modify', + 'user-follow-modify', + 'user-follow-read', +]; + +export default scopes; diff --git a/packages/backend/src/apps/spotify/index.ts b/packages/backend/src/apps/spotify/index.ts new file mode 100644 index 00000000..c09a59e9 --- /dev/null +++ b/packages/backend/src/apps/spotify/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: 'Spotify', + key: 'spotify', + iconUrl: '{BASE_URL}/apps/spotify/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/spotify/connection', + supportsConnections: true, + baseUrl: 'https://spotify.com', + apiBaseUrl: 'https://api.spotify.com', + primaryColor: '000000', + beforeRequest: [addAuthHeader], + auth, +});