@sasjs/adapter 3.0.0 → 3.2.0

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'
@@ -21,7 +23,9 @@ export class AuthManager {
     this.logoutUrl =
       this.serverType === ServerType.Sas9
         ? '/SASLogon/logout?'
-        : '/SASLogon/logout.do?'
+        : this.serverType === ServerType.SasViya
+        ? '/SASLogon/logout.do?'
+        : '/SASjsApi/auth/logout'
   }
 
   /**
@@ -79,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.
@@ -178,6 +215,19 @@ 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.
    * @returns - a promise which resolves with an object containing three values
@@ -198,7 +248,8 @@ export class AuthManager {
       //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({
@@ -222,12 +273,12 @@ export class AuthManager {
     isLoggedIn: boolean
     userName: string
   }> {
-    //For VIYA we will send request on API endpoint. Which is faster then pinging SASJobExecution.
-    //For SAS9 we will send request on SASStoredProcess
     const url =
       this.serverType === ServerType.SasViya
         ? `${this.serverUrl}/identities/users/@currentUser`
-        : `${this.serverUrl}/SASStoredProcess`
+        : this.serverType === ServerType.Sas9
+        ? `${this.serverUrl}/SASStoredProcess`
+        : `${this.serverUrl}/SASjsApi/session`
 
     const { result: loginResponse } = await this.requestClient
       .get<string>(url, undefined, 'text/plain')
@@ -256,7 +307,12 @@ export class AuthManager {
           .split(' ')
           .map((name: string) => name.slice(0, 3).toLowerCase())
           .join('')
+
+      case ServerType.Sasjs:
+        return response?.username
+
       default:
+        console.error('Server Type not found in extractUserName function')
         return ''
     }
   }
@@ -304,9 +360,21 @@ export class AuthManager {
 
   /**
    * Logs out of the configured SAS server.
+   * @param accessToken - an optional access token is required for SASjs server type.
    */
-  public logOut() {
+  public async logOut() {
+    if (this.serverType === ServerType.Sasjs) {
+      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/Sas9JobExecutor.ts

@@ -5,6 +5,7 @@ import { ErrorResponse } from '../types/errors'
 import { convertToCSV, isRelativePath } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { Sas9RequestClient } from '../request/Sas9RequestClient'
+import { RequestClient } from '../request/RequestClient'
 
 /**
  * Job executor for SAS9 servers for use in Node.js environments.
@@ -13,15 +14,16 @@ import { Sas9RequestClient } from '../request/Sas9RequestClient'
  * job execution requests.
  */
 export class Sas9JobExecutor extends BaseJobExecutor {
-  private requestClient: Sas9RequestClient
+  private sas9RequestClient: Sas9RequestClient
   constructor(
     serverUrl: string,
     serverType: ServerType,
     private jobsPath: string,
+    private requestClient: RequestClient,
     httpsAgentOptions?: https.AgentOptions
   ) {
     super(serverUrl, serverType)
-    this.requestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
+    this.sas9RequestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
   }
 
   async execute(sasJob: string, data: any, config: any) {
@@ -37,6 +39,8 @@ export class Sas9JobExecutor extends BaseJobExecutor {
         : ''
     }`
 
+    apiUrl = `${apiUrl}${config.debug ? '&_debug=131' : ''}`
+
     let requestParams = {
       ...this.getRequestParams(config)
     }
@@ -49,6 +53,8 @@ export class Sas9JobExecutor extends BaseJobExecutor {
       } catch (e: any) {
         return Promise.reject(new ErrorResponse(e?.message, e))
       }
+    } else {
+      data = ''
     }
 
     for (const key in requestParams) {
@@ -57,16 +63,18 @@ export class Sas9JobExecutor extends BaseJobExecutor {
       }
     }
 
-    await this.requestClient.login(
+    await this.sas9RequestClient.login(
       config.username,
       config.password,
       this.jobsPath
     )
+
     const contentType =
       data && Object.keys(data).length
         ? 'multipart/form-data; boundary=' + (formData as any)._boundary
         : 'text/plain'
-    return await this.requestClient!.post(
+
+    return await this.sas9RequestClient!.post(
       apiUrl,
       formData,
       undefined,
@@ -76,6 +84,28 @@ export class Sas9JobExecutor extends BaseJobExecutor {
         Connection: 'Keep-Alive'
       }
     )
+      .then((res: any) => {
+        let resString = res
+
+        if (typeof res === 'object') {
+          resString = JSON.stringify(res)
+        }
+
+        this.requestClient!.appendRequest(resString, sasJob, config.debug)
+
+        return res
+      })
+      .catch((err: any) => {
+        let errString = err
+
+        if (typeof err === 'object') {
+          errString = JSON.stringify(errString)
+        }
+
+        this.requestClient!.appendRequest(errString, sasJob, config.debug)
+
+        return err
+      })
   }
 
   private getRequestParams(config: any): any {

package/src/job-execution/WebJobExecutor.ts

@@ -15,7 +15,8 @@ import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   isRelativePath,
   parseSasViyaDebugResponse,
-  appendExtraResponseAttributes
+  appendExtraResponseAttributes,
+  getValidJson
 } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
@@ -113,6 +114,7 @@ export class WebJobExecutor extends BaseJobExecutor {
       const stringifiedData = JSON.stringify(data)
       if (
         config.serverType === ServerType.Sas9 ||
+        config.serverType === ServerType.Sasjs ||
         stringifiedData.length > 500000 ||
         stringifiedData.includes(';')
       ) {
@@ -142,12 +144,24 @@ export class WebJobExecutor extends BaseJobExecutor {
     }
 
     const requestPromise = new Promise((resolve, reject) => {
-      this.requestClient!.post(apiUrl, formData, undefined)
+      this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
         .then(async (res: any) => {
-          this.requestClient!.appendRequest(res, sasJob, config.debug)
+          const resObj =
+            this.serverType === ServerType.Sasjs
+              ? {
+                  result: res.result._webout,
+                  log: res.result.log
+                }
+              : res
+          this.requestClient!.appendRequest(resObj, sasJob, config.debug)
 
           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:

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 || ''

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)
+      accessToken = localStorage.getItem('accessToken') ?? undefined
+
+    if (accessToken) headers.Authorization = `Bearer ${accessToken}`
+
+    return headers
+  }
+}

package/src/types/SASjsConfig.ts

@@ -12,6 +12,11 @@ export class SASjsConfig {
    * streamed.
    */
   serverUrl: string = ''
+  /**
+   * The location of the STP Process Web Application.  By default the adapter
+   * will use '/SASjsApi/stp/execute' on SAS JS.
+   */
+  pathSASJS?: string = ''
   /**
    * The location of the Stored Process Web Application.  By default the adapter
    * will use '/SASStoredProcess/do' on SAS 9.

package/src/utils/getValidJson.ts

@@ -4,7 +4,7 @@ import { JsonParseArrayError, InvalidJsonError } from '../types/errors'
  * if string passed then parse the string to json else if throw error for all other types unless it is not a valid json object.
  * @param str - string to check.
  */
-export const getValidJson = (str: string | object) => {
+export const getValidJson = (str: string | object): object => {
   try {
     if (str === null || str === undefined) throw new InvalidJsonError()
 

package/src/utils/parseWeboutResponse.ts

@@ -1,6 +1,6 @@
 import { WeboutResponseError } from '../types/errors'
 
-export const parseWeboutResponse = (response: string, url?: string) => {
+export const parseWeboutResponse = (response: string, url?: string): string => {
   let sasResponse = ''
 
   if (response.includes('>>weboutBEGIN<<')) {

package/types/SASjsConfig.d.ts

@@ -12,6 +12,11 @@ export declare class SASjsConfig {
      * streamed.
      */
     serverUrl: string;
+    /**
+     * The location of the STP Process Web Application.  By default the adapter
+     * will use '/SASjsApi/stp/execute' on SAS JS.
+     */
+    pathSASJS?: string;
     /**
      * The location of the Stored Process Web Application.  By default the adapter
      * will use '/SASStoredProcess/do' on SAS 9.

package/utils/getValidJson.d.ts

@@ -2,4 +2,4 @@
  * if string passed then parse the string to json else if throw error for all other types unless it is not a valid json object.
  * @param str - string to check.
  */
-export declare const getValidJson: (str: string | object) => any;
+export declare const getValidJson: (str: string | object) => object;

package/utils/parseViyaDebugResponse.d.ts

@@ -9,4 +9,4 @@ import { RequestClient } from '../request/RequestClient';
  * @param serverUrl
  * @returns
  */
-export declare const parseSasViyaDebugResponse: (response: string, requestClient: RequestClient, serverUrl: string) => Promise<any>;
+export declare const parseSasViyaDebugResponse: (response: string, requestClient: RequestClient, serverUrl: string) => Promise<object>;