@sasjs/adapter 3.1.0 → 3.3.1

package/src/auth/AuthManager.ts

@@ -2,6 +2,8 @@ import { ServerType } from '@sasjs/utils/types'
 import { RequestClient } from '../request/RequestClient'
 import { LoginOptions, LoginResult } from '../types/Login'
 import { serialize } from '../utils'
+import { getAccessTokenForSasjs } from './getAccessTokenForSasjs'
+import { getAuthCodeForSasjs } from './getAuthCodeForSasjs'
 import { openWebPage } from './openWebPage'
 import { verifySas9Login } from './verifySas9Login'
 import { verifySasViyaLogin } from './verifySasViyaLogin'
@@ -81,6 +83,39 @@ export class AuthManager {
     return { isLoggedIn: false, userName: '' }
   }
 
+  /**
+   * Logs into the SAS server with the supplied credentials.
+   * @param userName - a string representing the username.
+   * @param password - a string representing the password.
+   * @param clientId - a string representing the client ID.
+   * @returns - a boolean `isLoggedin` and a string `username`
+   */
+  public async logInSasjs(
+    username: string,
+    password: string,
+    clientId: string
+  ): Promise<LoginResult> {
+    const isLoggedIn = await this.sendLoginRequestSasjs(
+      username,
+      password,
+      clientId
+    )
+      .then((res) => {
+        this.userName = username
+        this.requestClient.saveLocalStorageToken(
+          res.access_token,
+          res.refresh_token
+        )
+        return true
+      })
+      .catch(() => false)
+
+    return {
+      isLoggedIn,
+      userName: this.userName
+    }
+  }
+
   /**
    * Logs into the SAS server with the supplied credentials.
    * @param username - a string representing the username.
@@ -180,28 +215,41 @@ export class AuthManager {
     return loginResponse
   }
 
+  private async sendLoginRequestSasjs(
+    username: string,
+    password: string,
+    clientId: string
+  ) {
+    const authCode = await getAuthCodeForSasjs(
+      this.requestClient,
+      username,
+      password,
+      clientId
+    )
+    return getAccessTokenForSasjs(this.requestClient, clientId, authCode)
+  }
   /**
    * Checks whether a session is active, or login is required.
-   * @param accessToken - an optional access token is required for SASjs server type.
    * @returns - a promise which resolves with an object containing three values
    *  - a boolean `isLoggedIn`
    *  - a string `userName` and
    *  - a form `loginForm` if not loggedin.
    */
-  public async checkSession(accessToken?: string): Promise<{
+  public async checkSession(): Promise<{
     isLoggedIn: boolean
     userName: string
     loginForm?: any
   }> {
-    const { isLoggedIn, userName } = await this.fetchUserName(accessToken)
+    const { isLoggedIn, userName } = await this.fetchUserName()
     let loginForm = null
 
-    if (!isLoggedIn && this.serverType !== ServerType.Sasjs) {
+    if (!isLoggedIn) {
       //We will logout to make sure cookies are removed and login form is presented
       //Residue can happen in case of session expiration
       await this.logOut()
 
-      loginForm = await this.getNewLoginForm()
+      if (this.serverType !== ServerType.Sasjs)
+        loginForm = await this.getNewLoginForm()
     }
 
     return Promise.resolve({
@@ -221,7 +269,7 @@ export class AuthManager {
     return await this.getLoginForm(formResponse)
   }
 
-  private async fetchUserName(accessToken?: string): Promise<{
+  private async fetchUserName(): Promise<{
     isLoggedIn: boolean
     userName: string
   }> {
@@ -232,9 +280,8 @@ export class AuthManager {
         ? `${this.serverUrl}/SASStoredProcess`
         : `${this.serverUrl}/SASjsApi/session`
 
-    // Access token is required for server type `SASjs`
     const { result: loginResponse } = await this.requestClient
-      .get<string>(url, accessToken, 'text/plain')
+      .get<string>(url, undefined, 'text/plain')
       .catch((err: any) => {
         return { result: 'authErr' }
       })
@@ -315,11 +362,19 @@ export class AuthManager {
    * Logs out of the configured SAS server.
    * @param accessToken - an optional access token is required for SASjs server type.
    */
-  public logOut(accessToken?: string) {
+  public async logOut() {
     if (this.serverType === ServerType.Sasjs) {
-      return this.requestClient.post(this.logoutUrl, undefined, accessToken)
+      return this.requestClient
+        .delete(this.logoutUrl)
+        .catch(() => true)
+        .finally(() => {
+          this.requestClient.clearLocalStorageTokens()
+          return true
+        })
     }
+
     this.requestClient.clearCsrfTokens()
+
     return this.requestClient.get(this.logoutUrl, undefined).then(() => true)
   }
 }

package/src/auth/getAccessTokenForSasjs.ts

@@ -0,0 +1,36 @@
+import { prefixMessage } from '@sasjs/utils/error'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Exchanges the auth code for an access token for the given client.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param clientId - the client ID to authenticate with.
+ * @param authCode - the auth code received from the server.
+ */
+export async function getAccessTokenForSasjs(
+  requestClient: RequestClient,
+  clientId: string,
+  authCode: string
+) {
+  const url = '/SASjsApi/auth/token'
+  const data = {
+    clientId,
+    code: authCode
+  }
+
+  return await requestClient
+    .post(url, data, undefined)
+    .then((res) => {
+      const sasAuth = res.result as {
+        accessToken: string
+        refreshToken: string
+      }
+      return {
+        access_token: sasAuth.accessToken,
+        refresh_token: sasAuth.refreshToken
+      }
+    })
+    .catch((err) => {
+      throw prefixMessage(err, 'Error while getting access token. ')
+    })
+}

package/src/auth/{getAccessToken.ts → getAccessTokenForViya.ts}

@@ -10,7 +10,7 @@ import { RequestClient } from '../request/RequestClient'
  * @param clientSecret - the client secret to authenticate with.
  * @param authCode - the auth code received from the server.
  */
-export async function getAccessToken(
+export async function getAccessTokenForViya(
   requestClient: RequestClient,
   clientId: string,
   clientSecret: string,

package/src/auth/getAuthCodeForSasjs.ts

@@ -0,0 +1,31 @@
+import { prefixMessage } from '@sasjs/utils/error'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Performs a login authenticate and returns an auth code for the given client.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param username - a string representing the username.
+ * @param password - a string representing the password.
+ * @param clientId - the client ID to authenticate with.
+ */
+export const getAuthCodeForSasjs = async (
+  requestClient: RequestClient,
+  username: string,
+  password: string,
+  clientId: string
+) => {
+  const url = '/SASjsApi/auth/authorize'
+  const data = { username, password, clientId }
+
+  const { code: authCode } = await requestClient
+    .post<{ code: string }>(url, data, undefined)
+    .then((res) => res.result)
+    .catch((err) => {
+      throw prefixMessage(
+        err,
+        'Error while authenticating with provided username, password and clientId. '
+      )
+    })
+
+  return authCode
+}

package/src/auth/getTokens.ts

@@ -3,18 +3,21 @@ import {
   isRefreshTokenExpiring,
   hasTokenExpired
 } from '@sasjs/utils/auth'
-import { AuthConfig } from '@sasjs/utils/types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import { RequestClient } from '../request/RequestClient'
-import { refreshTokens } from './refreshTokens'
+import { refreshTokensForViya } from './refreshTokensForViya'
+import { refreshTokensForSasjs } from './refreshTokensForSasjs'
 
 /**
  * Returns the auth configuration, refreshing the tokens if necessary.
  * @param requestClient - the pre-configured HTTP request client
  * @param authConfig - an object containing a client ID, secret, access token and refresh token
+ * @param serverType - server type for which refreshing the tokens, defaults to SASVIYA
  */
 export async function getTokens(
   requestClient: RequestClient,
-  authConfig: AuthConfig
+  authConfig: AuthConfig,
+  serverType: ServerType = ServerType.SasViya
 ): Promise<AuthConfig> {
   const logger = process.logger || console
   let { access_token, refresh_token, client, secret } = authConfig
@@ -29,12 +32,16 @@ export async function getTokens(
       throw new Error(error)
     }
     logger.info('Refreshing access and refresh tokens.')
-    ;({ access_token, refresh_token } = await refreshTokens(
-      requestClient,
-      client,
-      secret,
-      refresh_token
-    ))
+    const tokens =
+      serverType === ServerType.SasViya
+        ? await refreshTokensForViya(
+            requestClient,
+            client,
+            secret,
+            refresh_token
+          )
+        : await refreshTokensForSasjs(requestClient, refresh_token)
+    ;({ access_token, refresh_token } = tokens)
   }
   return { access_token, refresh_token, client, secret }
 }

package/src/auth/refreshTokensForSasjs.ts

@@ -0,0 +1,35 @@
+import { prefixMessage } from '@sasjs/utils/error'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Exchanges the refresh token for an access token for the given client.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param refreshToken - the refresh token received from the server.
+ */
+export async function refreshTokensForSasjs(
+  requestClient: RequestClient,
+  refreshToken: string
+) {
+  const url = '/SASjsApi/auth/refresh'
+  const headers = {
+    Authorization: 'Bearer ' + refreshToken
+  }
+
+  const authResponse = await requestClient
+    .post(url, undefined, undefined, undefined, headers)
+    .then((res) => {
+      const sasAuth = res.result as {
+        accessToken: string
+        refreshToken: string
+      }
+      return {
+        access_token: sasAuth.accessToken,
+        refresh_token: sasAuth.refreshToken
+      }
+    })
+    .catch((err) => {
+      throw prefixMessage(err, 'Error while refreshing tokens')
+    })
+
+  return authResponse
+}

package/src/auth/{refreshTokens.ts → refreshTokensForViya.ts}

@@ -8,9 +8,9 @@ import { RequestClient } from '../request/RequestClient'
  * @param requestClient - the pre-configured HTTP request client
  * @param clientId - the client ID to authenticate with.
  * @param clientSecret - the client secret to authenticate with.
- * @param authCode - the refresh token received from the server.
+ * @param refreshToken - the refresh token received from the server.
  */
-export async function refreshTokens(
+export async function refreshTokensForViya(
   requestClient: RequestClient,
   clientId: string,
   clientSecret: string,

package/src/auth/spec/mockResponses.ts

@@ -13,6 +13,11 @@ export const mockAuthResponse: SasAuthResponse = {
   jti: 'test'
 }
 
+export const mockSasjsAuthResponse = {
+  access_token: 'acc355',
+  refresh_token: 'r3fr35h'
+}
+
 export const generateToken = (timeToLiveSeconds: number): string => {
   const exp =
     new Date(new Date().getTime() + timeToLiveSeconds * 1000).getTime() / 1000

package/src/job-execution/WebJobExecutor.ts

@@ -144,7 +144,6 @@ export class WebJobExecutor extends BaseJobExecutor {
     }
 
     const requestPromise = new Promise((resolve, reject) => {
-      // Access token is required for server type `SASjs`
       this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
         .then(async (res: any) => {
           const resObj =
@@ -158,11 +157,6 @@ export class WebJobExecutor extends BaseJobExecutor {
 
           let jsonResponse = res.result
 
-          if (this.serverType === ServerType.Sasjs) {
-            const webout = parseWeboutResponse(res.result._webout, apiUrl)
-            jsonResponse = getValidJson(webout)
-          }
-
           if (config.debug) {
             switch (this.serverType) {
               case ServerType.SasViya:
@@ -178,7 +172,13 @@ export class WebJobExecutor extends BaseJobExecutor {
                     ? parseWeboutResponse(res.result, apiUrl)
                     : res.result
                 break
+              case ServerType.Sasjs:
+                const webout = parseWeboutResponse(res.result._webout, apiUrl)
+                jsonResponse = getValidJson(webout)
+                break
             }
+          } else if (this.serverType === ServerType.Sasjs) {
+            jsonResponse = getValidJson(res.result._webout)
           }
 
           const responseObject = appendExtraResponseAttributes(

package/src/request/RequestClient.ts

@@ -48,7 +48,9 @@ export interface HttpClient {
   ): Promise<{ result: T; etag: string }>
 
   getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
+  saveLocalStorageToken(accessToken: string, refreshToken: string): void
   clearCsrfTokens(): void
+  clearLocalStorageTokens(): void
   getBaseUrl(): string
 }
 
@@ -70,6 +72,11 @@ export class RequestClient implements HttpClient {
     this.createHttpClient(baseUrl, httpsAgentOptions)
   }
 
+  public saveLocalStorageToken(accessToken: string, refreshToken: string) {
+    localStorage.setItem('accessToken', accessToken)
+    localStorage.setItem('refreshToken', refreshToken)
+  }
+
   public getCsrfToken(type: 'general' | 'file' = 'general') {
     return type === 'file' ? this.fileUploadCsrfToken : this.csrfToken
   }
@@ -78,6 +85,10 @@ export class RequestClient implements HttpClient {
     this.csrfToken = { headerName: '', value: '' }
     this.fileUploadCsrfToken = { headerName: '', value: '' }
   }
+  public clearLocalStorageTokens() {
+    localStorage.setItem('accessToken', '')
+    localStorage.setItem('refreshToken', '')
+  }
 
   public getBaseUrl() {
     return this.httpClient.defaults.baseURL || ''
@@ -184,9 +195,7 @@ export class RequestClient implements HttpClient {
               }
             ),
           debug
-        ).catch((err) => {
-          throw prefixMessage(err, 'Error while handling error. ')
-        })
+        )
       })
   }
 
@@ -206,6 +215,7 @@ export class RequestClient implements HttpClient {
       .post<T>(url, data, { headers, withCredentials: true })
       .then((response) => {
         throwIfError(response)
+
         return this.parseResponse<T>(response)
       })
       .catch(async (e) => {
@@ -455,6 +465,8 @@ export class RequestClient implements HttpClient {
 
     if (e instanceof LoginRequiredError) {
       this.clearCsrfTokens()
+
+      throw e
     }
 
     if (response?.status === 403 || response?.status === 449) {
@@ -477,7 +489,8 @@ export class RequestClient implements HttpClient {
       else return
     }
 
-    throw e
+    if (e.message) throw e
+    else throw prefixMessage(e, 'Error while handling error. ')
   }
 
   protected parseResponse<T>(response: AxiosResponse<any>) {
@@ -529,8 +542,9 @@ export class RequestClient implements HttpClient {
 
     this.httpClient = createAxiosInstance(baseUrl, httpsAgent)
 
-    this.httpClient.defaults.validateStatus = (status) =>
-      status >= 200 && status < 401
+    this.httpClient.defaults.validateStatus = (status) => {
+      return status >= 200 && status <= 401
+    }
   }
 }
 

package/src/request/Sas9RequestClient.ts

@@ -87,7 +87,7 @@ export class Sas9RequestClient extends RequestClient {
       })
   }
 
-  public post<T>(
+  public async post<T>(
     url: string,
     data: any,
     accessToken: string | undefined,

package/src/request/SasjsRequestClient.ts

@@ -0,0 +1,23 @@
+import { RequestClient } from './RequestClient'
+
+/**
+ * Specific request client for SASJS.
+ * Append tokens in headers.
+ */
+export class SasjsRequestClient extends RequestClient {
+  getHeaders = (accessToken: string | undefined, contentType: string) => {
+    const headers: any = {}
+
+    if (contentType !== 'application/x-www-form-urlencoded')
+      headers['Content-Type'] = contentType
+
+    headers.Accept = contentType === 'application/json' ? contentType : '*/*'
+
+    if (!accessToken && typeof window !== 'undefined')
+      accessToken = localStorage.getItem('accessToken') ?? undefined
+
+    if (accessToken) headers.Authorization = `Bearer ${accessToken}`
+
+    return headers
+  }
+}

package/src/test/SAS_server_app.ts

@@ -18,6 +18,7 @@ app.get('/', function (req: any, res: any) {
 
 app.post('/SASLogon/oauth/token', function (req: any, res: any) {
   let valid = true
+
   // capture the encoded form data
   req.on('data', (data: any) => {
     const resData = data.toString()