Merge pull request #600 from sasjs/sasjs-server-access-refresh-tokens

feat: get access token & refresh tokens for server type SASJS

.github/workflows/build.yml

@@ -13,14 +13,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [15.x]
+        node-version: [lts/fermium]
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
+          cache: npm
       - name: Install Dependencies
         run: npm ci
       - name: Check code style

.gitignore

@@ -5,4 +5,4 @@ build
 
 /coverage
 
-.DS_Store
+.DS_Store

.npmignore

@@ -3,3 +3,4 @@ docs/
 .github/
 *.md
 *.spec.ts
+.all-contributorsrc

package.json

@@ -41,35 +41,39 @@
   "license": "ISC",
   "devDependencies": {
     "@types/axios": "^0.14.0",
+    "@types/express": "^4.17.13",
     "@types/form-data": "^2.5.0",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^27.0.2",
     "@types/mime": "^2.0.3",
+    "@types/pem": "^1.9.6",
     "@types/tough-cookie": "^4.0.1",
     "copyfiles": "^2.4.1",
     "cp": "^0.2.0",
     "dotenv": "^10.0.0",
+    "express": "^4.17.1",
     "jest": "^27.2.0",
     "jest-extended": "^0.11.5",
     "node-polyfill-webpack-plugin": "^1.1.4",
     "path": "^0.12.7",
+    "pem": "^1.14.4",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.4.7",
+    "semantic-release": "^18.0.0",
     "terser-webpack-plugin": "^5.2.4",
     "ts-jest": "^27.0.3",
-    "ts-loader": "^9.2.2",
+    "ts-loader": "^9.2.6",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.22.3",
+    "typedoc": "0.19.2",
     "typedoc-neo-theme": "^1.1.1",
     "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "4.3.5",
-    "webpack": "^5.52.1",
+    "webpack": "^5.56.0",
     "webpack-cli": "^4.7.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.30.0",
+    "@sasjs/utils": "^2.32.0",
     "axios": "^0.21.4",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",

sasjs-tests/package.json

@@ -5,7 +5,7 @@
   "private": true,
   "dependencies": {
     "@sasjs/adapter": "file:../build/sasjs-adapter-5.0.0.tgz",
-    "@sasjs/test-framework": "^1.4.0",
+    "@sasjs/test-framework": "^1.4.2",
     "@types/jest": "^26.0.20",
     "@types/node": "^14.14.41",
     "@types/react": "^17.0.1",

sasjs-tests/src/testSuites/Basic.ts

@@ -13,7 +13,6 @@ const defaultConfig: SASjsConfig = {
   debug: false,
   contextName: 'SAS Job Execution compute context',
   useComputeApi: false,
-  allowInsecureRequests: false,
   loginMechanism: LoginMechanism.Default
 }
 

src/SAS9ApiClient.ts

@@ -1,3 +1,4 @@
+import * as https from 'https'
 import { generateTimestamp } from '@sasjs/utils/time'
 import * as NodeFormData from 'form-data'
 import { Sas9RequestClient } from './request/Sas9RequestClient'
@@ -13,10 +14,10 @@ export class SAS9ApiClient {
   constructor(
     private serverUrl: string,
     private jobsPath: string,
-    allowInsecureRequests: boolean
+    httpsAgentOptions?: https.AgentOptions
   ) {
     if (serverUrl) isUrl(serverUrl)
-    this.requestClient = new Sas9RequestClient(serverUrl, allowInsecureRequests)
+    this.requestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
   }
 
   /**

src/SASViyaApiClient.ts

@@ -22,8 +22,8 @@ import { pollJobState } from './api/viya/pollJobState'
 import { getTokens } from './auth/getTokens'
 import { uploadTables } from './api/viya/uploadTables'
 import { executeScript } from './api/viya/executeScript'
-import { getAccessToken } from './auth/getAccessToken'
-import { refreshTokens } from './auth/refreshTokens'
+import { getAccessTokenForViya } from './auth/getAccessTokenForViya'
+import { refreshTokensForViya } from './auth/refreshTokensForViya'
 
 /**
  * A client for interfacing with the SAS Viya REST API.
@@ -534,21 +534,26 @@ export class SASViyaApiClient {
     clientSecret: string,
     authCode: string
   ): Promise<SasAuthResponse> {
-    return getAccessToken(this.requestClient, clientId, clientSecret, authCode)
+    return getAccessTokenForViya(
+      this.requestClient,
+      clientId,
+      clientSecret,
+      authCode
+    )
   }
 
   /**
    * Exchanges the refresh token for an access token for the given 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.
    */
   public async refreshTokens(
     clientId: string,
     clientSecret: string,
     refreshToken: string
   ) {
-    return refreshTokens(
+    return refreshTokensForViya(
       this.requestClient,
       clientId,
       clientSecret,

src/SASjs.ts

@@ -4,18 +4,24 @@ import {
   UploadFile,
   EditContextInput,
   PollOptions,
-  LoginMechanism
+  LoginMechanism,
+  FolderMember,
+  ServiceMember,
+  ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
+import { SASjsApiClient, SASjsAuthResponse } from './SASjsApiClient'
 import { AuthManager } from './auth'
 import {
   ServerType,
   MacroVar,
   AuthConfig,
-  ExtraResponseAttributes
+  ExtraResponseAttributes,
+  SasAuthResponse
 } from '@sasjs/utils/types'
 import { RequestClient } from './request/RequestClient'
+import { SasjsRequestClient } from './request/SasjsRequestClient'
 import {
   JobExecutor,
   WebJobExecutor,
@@ -29,6 +35,7 @@ import { LoginOptions, LoginResult } from './types/Login'
 
 const defaultConfig: SASjsConfig = {
   serverUrl: '',
+  pathSASJS: '/SASjsApi/stp/execute',
   pathSAS9: '/SASStoredProcess/do',
   pathSASViya: '/SASJobExecution',
   appLoc: '/Public/seedapp',
@@ -36,7 +43,6 @@ const defaultConfig: SASjsConfig = {
   debug: false,
   contextName: 'SAS Job Execution compute context',
   useComputeApi: null,
-  allowInsecureRequests: false,
   loginMechanism: LoginMechanism.Default
 }
 
@@ -49,6 +55,7 @@ export default class SASjs {
   private jobsPath: string = ''
   private sasViyaApiClient: SASViyaApiClient | null = null
   private sas9ApiClient: SAS9ApiClient | null = null
+  private sasJSApiClient: SASjsApiClient | null = null
   private fileUploader: FileUploader | null = null
   private authManager: AuthManager | null = null
   private requestClient: RequestClient | null = null
@@ -57,7 +64,7 @@ export default class SASjs {
   private jesJobExecutor: JobExecutor | null = null
   private sas9JobExecutor: JobExecutor | null = null
 
-  constructor(config?: any) {
+  constructor(config?: Partial<SASjsConfig>) {
     this.sasjsConfig = {
       ...defaultConfig,
       ...config
@@ -75,7 +82,7 @@ export default class SASjs {
     userName: string,
     password: string
   ) {
-    this.isMethodSupported('executeScriptSAS9', ServerType.Sas9)
+    this.isMethodSupported('executeScriptSAS9', [ServerType.Sas9])
 
     return await this.sas9ApiClient?.executeScript(
       linesOfCode,
@@ -89,7 +96,7 @@ export default class SASjs {
    * @param accessToken - an access token for an authorized user.
    */
   public async getComputeContexts(accessToken: string) {
-    this.isMethodSupported('getComputeContexts', ServerType.SasViya)
+    this.isMethodSupported('getComputeContexts', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.getComputeContexts(accessToken)
   }
@@ -99,7 +106,7 @@ export default class SASjs {
    * @param accessToken - an access token for an authorized user.
    */
   public async getLauncherContexts(accessToken: string) {
-    this.isMethodSupported('getLauncherContexts', ServerType.SasViya)
+    this.isMethodSupported('getLauncherContexts', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.getLauncherContexts(accessToken)
   }
@@ -108,7 +115,7 @@ export default class SASjs {
    * Gets default(system) launcher contexts.
    */
   public getDefaultComputeContexts() {
-    this.isMethodSupported('getDefaultComputeContexts', ServerType.SasViya)
+    this.isMethodSupported('getDefaultComputeContexts', [ServerType.SasViya])
 
     return this.sasViyaApiClient!.getDefaultComputeContexts()
   }
@@ -118,7 +125,7 @@ export default class SASjs {
    * @param authConfig - an access token, refresh token, client and secret for an authorized user.
    */
   public async getExecutableContexts(authConfig: AuthConfig) {
-    this.isMethodSupported('getExecutableContexts', ServerType.SasViya)
+    this.isMethodSupported('getExecutableContexts', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.getExecutableContexts(authConfig)
   }
@@ -140,7 +147,7 @@ export default class SASjs {
     accessToken: string,
     authorizedUsers?: string[]
   ) {
-    this.isMethodSupported('createComputeContext', ServerType.SasViya)
+    this.isMethodSupported('createComputeContext', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.createComputeContext(
       contextName,
@@ -165,7 +172,7 @@ export default class SASjs {
     launchType: string,
     accessToken: string
   ) {
-    this.isMethodSupported('createLauncherContext', ServerType.SasViya)
+    this.isMethodSupported('createLauncherContext', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.createLauncherContext(
       contextName,
@@ -186,7 +193,7 @@ export default class SASjs {
     editedContext: EditContextInput,
     accessToken?: string
   ) {
-    this.isMethodSupported('editComputeContext', ServerType.SasViya)
+    this.isMethodSupported('editComputeContext', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.editComputeContext(
       contextName,
@@ -201,7 +208,7 @@ export default class SASjs {
    * @param accessToken - an access token for an authorized user.
    */
   public async deleteComputeContext(contextName: string, accessToken?: string) {
-    this.isMethodSupported('deleteComputeContext', ServerType.SasViya)
+    this.isMethodSupported('deleteComputeContext', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.deleteComputeContext(
       contextName,
@@ -219,7 +226,7 @@ export default class SASjs {
     contextName: string,
     accessToken?: string
   ) {
-    this.isMethodSupported('getComputeContextByName', ServerType.SasViya)
+    this.isMethodSupported('getComputeContextByName', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.getComputeContextByName(
       contextName,
@@ -233,7 +240,7 @@ export default class SASjs {
    * @param accessToken - an access token for an authorized user.
    */
   public async getComputeContextById(contextId: string, accessToken?: string) {
-    this.isMethodSupported('getComputeContextById', ServerType.SasViya)
+    this.isMethodSupported('getComputeContextById', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.getComputeContextById(
       contextId,
@@ -242,7 +249,7 @@ export default class SASjs {
   }
 
   public async createSession(contextName: string, accessToken: string) {
-    this.isMethodSupported('createSession', ServerType.SasViya)
+    this.isMethodSupported('createSession', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.createSession(contextName, accessToken)
   }
@@ -262,7 +269,7 @@ export default class SASjs {
     authConfig?: AuthConfig,
     debug?: boolean
   ) {
-    this.isMethodSupported('executeScriptSASViya', ServerType.SasViya)
+    this.isMethodSupported('executeScriptSASViya', [ServerType.SasViya])
     if (!contextName) {
       throw new Error(
         'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
@@ -352,7 +359,7 @@ export default class SASjs {
    * @param accessToken - the access token to authorize the request.
    */
   public async getFolder(folderPath: string, accessToken?: string) {
-    this.isMethodSupported('getFolder', ServerType.SasViya)
+    this.isMethodSupported('getFolder', [ServerType.SasViya])
     return await this.sasViyaApiClient!.getFolder(folderPath, accessToken)
   }
 
@@ -362,7 +369,7 @@ export default class SASjs {
    * @param accessToken - an access token for authorizing the request.
    */
   public async deleteFolder(folderPath: string, accessToken: string) {
-    this.isMethodSupported('deleteFolder', ServerType.SasViya)
+    this.isMethodSupported('deleteFolder', [ServerType.SasViya])
 
     return await this.sasViyaApiClient?.deleteFolder(folderPath, accessToken)
   }
@@ -377,7 +384,7 @@ export default class SASjs {
     accessToken?: string,
     limit?: number
   ) {
-    this.isMethodSupported('listFolder', ServerType.SasViya)
+    this.isMethodSupported('listFolder', [ServerType.SasViya])
 
     return await this.sasViyaApiClient?.listFolder(
       sourceFolder,
@@ -399,7 +406,7 @@ export default class SASjs {
     targetFolderName: string,
     accessToken: string
   ) {
-    this.isMethodSupported('moveFolder', ServerType.SasViya)
+    this.isMethodSupported('moveFolder', [ServerType.SasViya])
 
     return await this.sasViyaApiClient?.moveFolder(
       sourceFolder,
@@ -417,7 +424,7 @@ export default class SASjs {
     accessToken?: string,
     sasApiClient?: SASViyaApiClient
   ) {
-    this.isMethodSupported('createJobDefinition', ServerType.SasViya)
+    this.isMethodSupported('createJobDefinition', [ServerType.SasViya])
 
     if (sasApiClient)
       return await sasApiClient!.createJobDefinition(
@@ -437,7 +444,7 @@ export default class SASjs {
   }
 
   public async getAuthCode(clientId: string) {
-    this.isMethodSupported('getAuthCode', ServerType.SasViya)
+    this.isMethodSupported('getAuthCode', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.getAuthCode(clientId)
   }
@@ -452,8 +459,14 @@ export default class SASjs {
     clientId: string,
     clientSecret: string,
     authCode: string
-  ) {
-    this.isMethodSupported('getAccessToken', ServerType.SasViya)
+  ): Promise<SasAuthResponse | SASjsAuthResponse> {
+    this.isMethodSupported('getAccessToken', [
+      ServerType.SasViya,
+      ServerType.Sasjs
+    ])
+
+    if (this.sasjsConfig.serverType === ServerType.Sasjs)
+      return await this.sasJSApiClient!.getAccessToken(clientId, authCode)
 
     return await this.sasViyaApiClient!.getAccessToken(
       clientId,
@@ -462,12 +475,24 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Exchanges the refresh token for an access token for the given client.
+   * @param clientId - the client ID to authenticate with.
+   * @param clientSecret - the client secret to authenticate with.
+   * @param refreshToken - the refresh token received from the server.
+   */
   public async refreshTokens(
     clientId: string,
     clientSecret: string,
     refreshToken: string
-  ) {
-    this.isMethodSupported('refreshTokens', ServerType.SasViya)
+  ): Promise<SasAuthResponse | SASjsAuthResponse> {
+    this.isMethodSupported('refreshTokens', [
+      ServerType.SasViya,
+      ServerType.Sasjs
+    ])
+
+    if (this.sasjsConfig.serverType === ServerType.Sasjs)
+      return await this.sasJSApiClient!.refreshTokens(refreshToken)
 
     return await this.sasViyaApiClient!.refreshTokens(
       clientId,
@@ -477,7 +502,7 @@ export default class SASjs {
   }
 
   public async deleteClient(clientId: string, accessToken: string) {
-    this.isMethodSupported('deleteClient', ServerType.SasViya)
+    this.isMethodSupported('deleteClient', [ServerType.SasViya])
 
     return await this.sasViyaApiClient!.deleteClient(clientId, accessToken)
   }
@@ -533,18 +558,29 @@ export default class SASjs {
    * 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.
    */
   public async logIn(
     username?: string,
     password?: string,
+    clientId?: string,
     options: LoginOptions = {}
   ): Promise<LoginResult> {
     if (this.sasjsConfig.loginMechanism === LoginMechanism.Default) {
-      if (!username || !password) {
+      if (!username || !password)
         throw new Error(
           'A username and password are required when using the default login mechanism.'
         )
+
+      if (this.sasjsConfig.serverType === ServerType.Sasjs) {
+        if (!clientId)
+          throw new Error(
+            'A username, password and clientId are required when using the default login mechanism with server type SASJS.'
+          )
+
+        return this.authManager!.logInSasjs(username, password, clientId)
       }
+
       return this.authManager!.logIn(username, password)
     }
 
@@ -770,7 +806,7 @@ export default class SASjs {
     accessToken?: string,
     isForced = false
   ) {
-    this.isMethodSupported('deployServicePack', ServerType.SasViya)
+    this.isMethodSupported('deployServicePack', [ServerType.SasViya])
 
     let sasApiClient: any = null
     if (serverUrl || appLoc) {
@@ -792,7 +828,7 @@ export default class SASjs {
         sasApiClient = new SAS9ApiClient(
           serverUrl,
           this.jobsPath,
-          this.sasjsConfig.allowInsecureRequests
+          this.sasjsConfig.httpsAgentOptions
         )
       }
     } else {
@@ -824,6 +860,14 @@ export default class SASjs {
     )
   }
 
+  public async deployToSASjs(members: [FolderMember, ServiceMember]) {
+    return await this.sasJSApiClient?.deploy(members, this.sasjsConfig.appLoc)
+  }
+
+  public async executeJobSASjs(query: ExecutionQuery) {
+    return await this.sasJSApiClient?.executeJob(query)
+  }
+
   /**
    * Kicks off execution of the given job via the compute API.
    * @returns an object representing the compute session created for the given job.
@@ -857,7 +901,7 @@ export default class SASjs {
       ...config
     }
 
-    this.isMethodSupported('startComputeJob', ServerType.SasViya)
+    this.isMethodSupported('startComputeJob', [ServerType.SasViya])
     if (!config.contextName) {
       throw new Error(
         'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
@@ -949,21 +993,27 @@ export default class SASjs {
     }
 
     if (!this.requestClient) {
-      this.requestClient = new RequestClient(
+      const RequestClientClass =
+        this.sasjsConfig.serverType === ServerType.Sasjs
+          ? SasjsRequestClient
+          : RequestClient
+      this.requestClient = new RequestClientClass(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.allowInsecureRequests
+        this.sasjsConfig.httpsAgentOptions
       )
     } else {
       this.requestClient.setConfig(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.allowInsecureRequests
+        this.sasjsConfig.httpsAgentOptions
       )
     }
 
     this.jobsPath =
       this.sasjsConfig.serverType === ServerType.SasViya
         ? this.sasjsConfig.pathSASViya
-        : this.sasjsConfig.pathSAS9
+        : this.sasjsConfig.serverType === ServerType.Sas9
+        ? this.sasjsConfig.pathSAS9
+        : this.sasjsConfig.pathSASJS || ''
 
     this.authManager = new AuthManager(
       this.sasjsConfig.serverUrl,
@@ -973,30 +1023,44 @@ export default class SASjs {
     )
 
     if (this.sasjsConfig.serverType === ServerType.SasViya) {
-      if (this.sasViyaApiClient)
+      if (this.sasViyaApiClient) {
         this.sasViyaApiClient!.setConfig(
           this.sasjsConfig.serverUrl,
           this.sasjsConfig.appLoc
         )
-      else
+      } else {
         this.sasViyaApiClient = new SASViyaApiClient(
           this.sasjsConfig.serverUrl,
           this.sasjsConfig.appLoc,
           this.sasjsConfig.contextName,
           this.requestClient
         )
+      }
 
       this.sasViyaApiClient.debug = this.sasjsConfig.debug
     }
+
     if (this.sasjsConfig.serverType === ServerType.Sas9) {
-      if (this.sas9ApiClient)
+      if (this.sas9ApiClient) {
         this.sas9ApiClient!.setConfig(this.sasjsConfig.serverUrl)
-      else
+      } else {
         this.sas9ApiClient = new SAS9ApiClient(
           this.sasjsConfig.serverUrl,
           this.jobsPath,
-          this.sasjsConfig.allowInsecureRequests
+          this.sasjsConfig.httpsAgentOptions
         )
+      }
+    }
+
+    if (this.sasjsConfig.serverType === ServerType.Sasjs) {
+      if (this.sasJSApiClient) {
+        this.sasJSApiClient.setConfig(this.sasjsConfig.serverUrl)
+      } else {
+        this.sasJSApiClient = new SASjsApiClient(
+          this.sasjsConfig.serverUrl,
+          this.requestClient
+        )
+      }
     }
 
     this.fileUploader = new FileUploader(
@@ -1018,7 +1082,8 @@ export default class SASjs {
       this.sasjsConfig.serverUrl,
       this.sasjsConfig.serverType!,
       this.jobsPath,
-      this.sasjsConfig.allowInsecureRequests
+      this.requestClient,
+      this.sasjsConfig.httpsAgentOptions
     )
 
     this.computeJobExecutor = new ComputeJobExecutor(
@@ -1085,12 +1150,15 @@ export default class SASjs {
     })
   }
 
-  private isMethodSupported(method: string, serverType: string) {
-    if (this.sasjsConfig.serverType !== serverType) {
+  private isMethodSupported(method: string, serverTypes: ServerType[]) {
+    if (
+      !this.sasjsConfig.serverType ||
+      !serverTypes.includes(this.sasjsConfig.serverType)
+    ) {
       throw new Error(
-        `Method '${method}' is only supported on ${
-          serverType === ServerType.Sas9 ? 'SAS9' : 'SAS Viya'
-        } servers.`
+        `Method '${method}' is only supported on ${serverTypes.join(
+          ', '
+        )} servers.`
       )
     }
   }

src/SASjsApiClient.ts

@@ -0,0 +1,82 @@
+import { FolderMember, ServiceMember, ExecutionQuery } from './types'
+import { RequestClient } from './request/RequestClient'
+import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
+import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
+import { getAuthCodeForSasjs } from './auth/getAuthCodeForSasjs'
+
+export class SASjsApiClient {
+  constructor(
+    private serverUrl: string,
+    private requestClient: RequestClient
+  ) {}
+
+  public setConfig(serverUrl: string) {
+    if (serverUrl) this.serverUrl = serverUrl
+  }
+
+  public async deploy(members: [FolderMember, ServiceMember], appLoc: string) {
+    const { result } = await this.requestClient.post<{
+      status: string
+      message: string
+      example?: {}
+    }>(
+      'SASjsApi/drive/deploy',
+      { fileTree: members, appLoc: appLoc },
+      undefined
+    )
+
+    return Promise.resolve(result)
+  }
+
+  public async executeJob(query: ExecutionQuery) {
+    const { result } = await this.requestClient.post<{
+      status: string
+      message: string
+      log?: string
+      logPath?: string
+      error?: {}
+    }>('SASjsApi/stp/execute', query, undefined)
+
+    return Promise.resolve(result)
+  }
+
+  /**
+   * Exchanges the auth code for an access token for the given client.
+   * @param clientId - the client ID to authenticate with.
+   * @param authCode - the auth code received from the server.
+   */
+  public async getAccessToken(
+    clientId: string,
+    authCode: string
+  ): Promise<SASjsAuthResponse> {
+    return getAccessTokenForSasjs(this.requestClient, clientId, authCode)
+  }
+
+  /**
+   * Exchanges the refresh token for an access token.
+   * @param refreshToken - the refresh token received from the server.
+   */
+  public async refreshTokens(refreshToken: string): Promise<SASjsAuthResponse> {
+    return refreshTokensForSasjs(this.requestClient, refreshToken)
+  }
+
+  /**
+   * Performs a login authenticate and returns an auth code for the given client.
+   * @param username - a string representing the username.
+   * @param password - a string representing the password.
+   * @param clientId - the client ID to authenticate with.
+   */
+  public async getAuthCode(
+    username: string,
+    password: string,
+    clientId: string
+  ) {
+    return getAuthCodeForSasjs(this.requestClient, username, password, clientId)
+  }
+}
+
+// todo move to sasjs/utils
+export interface SASjsAuthResponse {
+  access_token: string
+  refresh_token: string
+}

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,6 +307,13 @@ 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 ''
     }
   }
 
@@ -302,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)
   }
 }

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. ')
+    })
+}

src/auth/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,
@@ -46,7 +46,7 @@ export async function getAccessToken(
     )
     .then((res) => res.result as SasAuthResponse)
     .catch((err) => {
-      throw prefixMessage(err, 'Error while getting access token')
+      throw prefixMessage(err, 'Error while getting access token. ')
     })
 
   return authResponse

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
+}

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

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
+}

src/auth/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,

src/auth/spec/getAccessTokenForSasjs.spec.ts

@@ -0,0 +1,65 @@
+import { AuthConfig } from '@sasjs/utils'
+import { generateToken, mockSasjsAuthResponse } from './mockResponses'
+import { RequestClient } from '../../request/RequestClient'
+import { getAccessTokenForSasjs } from '../getAccessTokenForSasjs'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('getAccessTokenForSasjs', () => {
+  it('should attempt to refresh tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() =>
+        Promise.resolve({ result: mockSasjsAuthResponse, etag: '' })
+      )
+
+    await getAccessTokenForSasjs(
+      requestClient,
+      authConfig.client,
+      authConfig.refresh_token
+    )
+
+    expect(requestClient.post).toHaveBeenCalledWith(
+      '/SASjsApi/auth/token',
+      { clientId: authConfig.client, code: authConfig.refresh_token },
+      undefined
+    )
+  })
+
+  it('should handle errors while refreshing tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() => Promise.reject('Token Error'))
+
+    const error = await getAccessTokenForSasjs(
+      requestClient,
+      authConfig.client,
+      authConfig.refresh_token
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while getting access token')
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../request/RequestClient')
+}

src/auth/spec/getAccessTokenForViya.spec.ts

@@ -2,11 +2,11 @@ import { AuthConfig } from '@sasjs/utils'
 import * as NodeFormData from 'form-data'
 import { generateToken, mockAuthResponse } from './mockResponses'
 import { RequestClient } from '../../request/RequestClient'
-import { getAccessToken } from '../getAccessToken'
+import { getAccessTokenForViya } from '../getAccessTokenForViya'
 
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
 
-describe('getAccessToken', () => {
+describe('getAccessTokenForViya', () => {
   it('should attempt to refresh tokens', async () => {
     setupMocks()
     const access_token = generateToken(30)
@@ -26,7 +26,7 @@ describe('getAccessToken', () => {
       authConfig.client + ':' + authConfig.secret
     ).toString('base64')
 
-    await getAccessToken(
+    await getAccessTokenForViya(
       requestClient,
       authConfig.client,
       authConfig.secret,
@@ -58,7 +58,7 @@ describe('getAccessToken', () => {
       .spyOn(requestClient, 'post')
       .mockImplementation(() => Promise.reject('Token Error'))
 
-    const error = await getAccessToken(
+    const error = await getAccessTokenForViya(
       requestClient,
       authConfig.client,
       authConfig.secret,

src/auth/spec/getTokens.spec.ts

@@ -1,5 +1,5 @@
 import { AuthConfig } from '@sasjs/utils'
-import * as refreshTokensModule from '../refreshTokens'
+import * as refreshTokensModule from '../refreshTokensForViya'
 import { generateToken, mockAuthResponse } from './mockResponses'
 import { getTokens } from '../getTokens'
 import { RequestClient } from '../../request/RequestClient'
@@ -20,7 +20,7 @@ describe('getTokens', () => {
 
     await getTokens(requestClient, authConfig)
 
-    expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
+    expect(refreshTokensModule.refreshTokensForViya).toHaveBeenCalledWith(
       requestClient,
       authConfig.client,
       authConfig.secret,
@@ -41,7 +41,7 @@ describe('getTokens', () => {
 
     await getTokens(requestClient, authConfig)
 
-    expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
+    expect(refreshTokensModule.refreshTokensForViya).toHaveBeenCalledWith(
       requestClient,
       authConfig.client,
       authConfig.secret,
@@ -71,9 +71,9 @@ describe('getTokens', () => {
 const setupMocks = () => {
   jest.restoreAllMocks()
   jest.mock('../../request/RequestClient')
-  jest.mock('../refreshTokens')
+  jest.mock('../refreshTokensForViya')
 
   jest
-    .spyOn(refreshTokensModule, 'refreshTokens')
+    .spyOn(refreshTokensModule, 'refreshTokensForViya')
     .mockImplementation(() => Promise.resolve(mockAuthResponse))
 }