⚡️ Fixing request initialization

- Added validation for strategies
- Fixed Endpoint interface

Author: Artem Shteltser

src/endpoint/types.ts

@@ -43,7 +43,7 @@ export interface Endpoint {
   DEFAULTS: EndpointDefaults
   defaults(endpointOptions: EndpointParams): Endpoint
   merge(
-    endpointRoute: string,
+    endpointRoute: string | EndpointOptions,
     endpointOptions?: EndpointParams
   ): EndpointDefaults
   merge(endpointOptions: EndpointParams): EndpointDefaults

src/plugins/auth/OAuth/get-oauth-access-token.ts

@@ -4,38 +4,38 @@ import getOAuthRoutes from './routes'
 import { request as Request } from '../../../request'
 
 type AuthState = import('./types').AuthPluginState
+type EndpointOptions = import('./types').EndpointOptions
 
 const routes = getOAuthRoutes(oAuth2Spec).getToken
 export const getOAuthAccessToken = async (state: AuthState): Promise<any> => {
   const { auth: authState } = state
-  const grantType = authState.grant_type
-
-  let headers
-  if (authState.grant_type === 'bitbucketCloudJWTGrant') {
-    headers = {
-      authorization: `JWT ${btoa(`${authState.jwt_token}`)}`,
-    }
-  } else {
-    headers = {
-      authorization: `Basic ${btoa(
-        `${authState.client_id}:${authState.client_secret}`
-      )}`,
-    }
+  const { grant_type: grantType } = authState
+  const { accepts, url, method, grant_type } = routes[grantType]
+
+  const endpointOptions: EndpointOptions = {
+    accepts,
+    url,
+    method,
+    headers: {},
+    request: {},
+    grant_type,
   }
 
-  const requestOptions = Object.assign(routes[grantType], {
-    headers,
-    request: {},
-  })
+  endpointOptions.headers!.authorization =
+    authState.grant_type === 'bitbucketCloudJWTGrant'
+      ? `JWT ${btoa(`${authState.jwt_token}`)}`
+      : `Basic ${btoa(`${authState.client_id}:${authState.client_secret}`)}`
 
-  const request = Request.defaults(requestOptions)
-  const response = await request(
-    requestOptions,
-    Object.assign(authState, {
-      grant_type: routes[grantType].grant_type,
-    })
-  )
+  if (authState.grant_type === 'authorizationCodeGrant') {
+    endpointOptions.code = authState.code
+  }
+
+  if (authState.grant_type === 'resourceOwnerPasswordCredentialsGrant') {
+    endpointOptions.username = authState.username
+    endpointOptions.password = authState.password
+  }
 
+  const response = await Request(endpointOptions)
   const { data } = response
 
   const newToken = {

src/plugins/auth/OAuth/routes.ts

@@ -7,21 +7,12 @@ const getOAuthRoutes = (info: SpecType): any => ({
       grant_type: 'authorization_code',
       method: 'POST',
       params: {
-        client_id: {
-          in: '_body',
-          required: true,
-          type: 'string',
-        },
-        client_secret: {
+        grant_type: {
           in: '_body',
           required: true,
           type: 'string',
         },
         code: {
-          required: true,
-          type: 'string',
-        },
-        grant_type: {
           in: '_body',
           required: true,
           type: 'string',
@@ -34,16 +25,6 @@ const getOAuthRoutes = (info: SpecType): any => ({
       grant_type: 'password',
       method: 'POST',
       params: {
-        client_id: {
-          in: '_body',
-          required: true,
-          type: 'string',
-        },
-        client_secret: {
-          in: '_body',
-          required: true,
-          type: 'string',
-        },
         grant_type: {
           in: '_body',
           required: true,
@@ -67,16 +48,6 @@ const getOAuthRoutes = (info: SpecType): any => ({
       grant_type: 'client_credentials',
       method: 'POST',
       params: {
-        client_id: {
-          in: '_body',
-          required: true,
-          type: 'string',
-        },
-        client_secret: {
-          in: '_body',
-          required: true,
-          type: 'string',
-        },
         grant_type: {
           in: '_body',
           required: true,
@@ -95,11 +66,6 @@ const getOAuthRoutes = (info: SpecType): any => ({
           required: true,
           type: 'string',
         },
-        jwtToken: {
-          in: 'headers.authorization:JWT',
-          required: true,
-          type: 'string',
-        },
       },
       url: `${info.tokenUrl}`,
     },

src/plugins/auth/OAuth/types.ts

@@ -1,7 +1,7 @@
 export type APIClient = import('../../../client/types').APIClient
 export type Options = import('../../../client/types').Options
-export type RequestOptions = import('../../../endpoint/types').RequestOptions
 export type AuthOptions = import('../types').OAuthOptions
+export type EndpointOptions = import('../../../endpoint/types').EndpointOptions
 
 export type AuthPluginState = {
   authStrategy: string

src/plugins/auth/OAuth/validate-options.ts

@@ -1,14 +1,31 @@
 type AuthOptions = import('./types').AuthOptions
 
 export function validateOptions(auth: AuthOptions): void {
+  if (!auth.grant_type) {
+    throw new Error(`Specify grant_type`)
+  }
+
   if (
     auth.grant_type !== 'bitbucketCloudJWTGrant' &&
     (!auth.client_id || !auth.client_secret)
   ) {
-    throw new Error(`Specify client id and client secret for authentication`)
+    throw new Error(`Specify client_id and client_secret for authentication`)
   }
 
-  if (!auth.grant_type) {
-    throw new Error(`Specify grant type`)
+  if (auth.grant_type === 'authorizationCodeGrant' && !auth.code) {
+    throw new Error(`code is required for Code Grant Authorization`)
+  }
+
+  if (
+    auth.grant_type === 'resourceOwnerPasswordCredentialsGrant' &&
+    (!auth.username || auth.password)
+  ) {
+    throw new Error(
+      `Both username and password are required for Resource Owner Password Credentials Grant`
+    )
+  }
+
+  if (auth.grant_type === 'bitbucketCloudJWTGrant' && !auth.jwt_token) {
+    throw new Error(`jwt_token is required for Bitbucket Cloud JWT Grant`)
   }
 }