@sasjs/adapter 3.0.1 → 3.2.1

package/node/job-execution/Sas9JobExecutor.d.ts

@@ -2,6 +2,7 @@
 import * as https from 'https';
 import { ServerType } from '@sasjs/utils/types';
 import { BaseJobExecutor } from './JobExecutor';
+import { RequestClient } from '../request/RequestClient';
 /**
  * Job executor for SAS9 servers for use in Node.js environments.
  * Initiates login with the provided username and password from the config
@@ -11,10 +12,8 @@ import { BaseJobExecutor } from './JobExecutor';
 export declare class Sas9JobExecutor extends BaseJobExecutor {
     private jobsPath;
     private requestClient;
-    constructor(serverUrl: string, serverType: ServerType, jobsPath: string, httpsAgentOptions?: https.AgentOptions);
-    execute(sasJob: string, data: any, config: any): Promise<{
-        result: unknown;
-        etag: string;
-    }>;
+    private sas9RequestClient;
+    constructor(serverUrl: string, serverType: ServerType, jobsPath: string, requestClient: RequestClient, httpsAgentOptions?: https.AgentOptions);
+    execute(sasJob: string, data: any, config: any): Promise<any>;
     private getRequestParams;
 }

package/node/request/RequestClient.d.ts

@@ -27,7 +27,9 @@ export interface HttpClient {
         etag: string;
     }>;
     getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined;
+    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     clearCsrfTokens(): void;
+    clearLocalStorageTokens(): void;
     getBaseUrl(): string;
 }
 export declare class RequestClient implements HttpClient {
@@ -38,8 +40,10 @@ export declare class RequestClient implements HttpClient {
     protected httpClient: AxiosInstance;
     constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
+    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
     clearCsrfTokens(): void;
+    clearLocalStorageTokens(): void;
     getBaseUrl(): string;
     /**
      * this method returns all requests, an array of SASjsRequest type

package/node/request/SasjsRequestClient.d.ts

@@ -0,0 +1,8 @@
+import { RequestClient } from './RequestClient';
+/**
+ * Specific request client for SASJS.
+ * Append tokens in headers.
+ */
+export declare class SasjsRequestClient extends RequestClient {
+    getHeaders: (accessToken: string | undefined, contentType: string) => any;
+}

package/node/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/node/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/node/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>;

package/package.json

@@ -64,7 +64,7 @@
     "ts-loader": "^9.2.6",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.22.4",
+    "typedoc": "0.19.2",
     "typedoc-neo-theme": "^1.1.1",
     "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "4.3.5",
@@ -80,5 +80,5 @@
     "https": "^1.0.0",
     "tough-cookie": "^4.0.0"
   },
-  "version": "3.0.1"
+  "version": "3.2.1"
 }

package/request/RequestClient.d.ts

@@ -27,7 +27,9 @@ export interface HttpClient {
         etag: string;
     }>;
     getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined;
+    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     clearCsrfTokens(): void;
+    clearLocalStorageTokens(): void;
     getBaseUrl(): string;
 }
 export declare class RequestClient implements HttpClient {
@@ -38,8 +40,10 @@ export declare class RequestClient implements HttpClient {
     protected httpClient: AxiosInstance;
     constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
+    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
     clearCsrfTokens(): void;
+    clearLocalStorageTokens(): void;
     getBaseUrl(): string;
     /**
      * this method returns all requests, an array of SASjsRequest type

package/request/SasjsRequestClient.d.ts

@@ -0,0 +1,8 @@
+import { RequestClient } from './RequestClient';
+/**
+ * Specific request client for SASJS.
+ * Append tokens in headers.
+ */
+export declare class SasjsRequestClient extends RequestClient {
+    getHeaders: (accessToken: string | undefined, contentType: string) => any;
+}

package/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,

package/src/SASjs.ts

@@ -11,15 +11,17 @@ import {
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
-import { SASjsApiClient } from './SASjsApiClient'
+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,
@@ -33,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',
@@ -52,7 +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 sasJSApiClient: SASjsApiClient | null = null
   private fileUploader: FileUploader | null = null
   private authManager: AuthManager | null = null
   private requestClient: RequestClient | null = null
@@ -79,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,
@@ -93,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)
   }
@@ -103,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)
   }
@@ -112,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()
   }
@@ -122,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)
   }
@@ -144,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,
@@ -169,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,
@@ -190,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,
@@ -205,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,
@@ -223,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,
@@ -237,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,
@@ -246,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)
   }
@@ -266,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.'
@@ -356,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)
   }
 
@@ -366,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)
   }
@@ -381,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,
@@ -403,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,
@@ -421,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(
@@ -441,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)
   }
@@ -456,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,
@@ -466,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,
@@ -481,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)
   }
@@ -537,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)
     }
 
@@ -774,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) {
@@ -829,11 +861,11 @@ export default class SASjs {
   }
 
   public async deployToSASjs(members: [FolderMember, ServiceMember]) {
-    return await this.SASjsApiClient?.deploy(members, this.sasjsConfig.appLoc)
+    return await this.sasJSApiClient?.deploy(members, this.sasjsConfig.appLoc)
   }
 
   public async executeJobSASjs(query: ExecutionQuery) {
-    return await this.SASjsApiClient?.executeJob(query)
+    return await this.sasJSApiClient?.executeJob(query)
   }
 
   /**
@@ -869,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.'
@@ -961,7 +993,11 @@ 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.httpsAgentOptions
       )
@@ -975,7 +1011,9 @@ export default class SASjs {
     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,
@@ -1015,10 +1053,10 @@ export default class SASjs {
     }
 
     if (this.sasjsConfig.serverType === ServerType.Sasjs) {
-      if (this.SASjsApiClient) {
-        this.SASjsApiClient.setConfig(this.sasjsConfig.serverUrl)
+      if (this.sasJSApiClient) {
+        this.sasJSApiClient.setConfig(this.sasjsConfig.serverUrl)
       } else {
-        this.SASjsApiClient = new SASjsApiClient(
+        this.sasJSApiClient = new SASjsApiClient(
           this.sasjsConfig.serverUrl,
           this.requestClient
         )
@@ -1044,6 +1082,7 @@ export default class SASjs {
       this.sasjsConfig.serverUrl,
       this.sasjsConfig.serverType!,
       this.jobsPath,
+      this.requestClient,
       this.sasjsConfig.httpsAgentOptions
     )
 
@@ -1111,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.`
       )
     }
   }

package/src/SASjsApiClient.ts

@@ -1,5 +1,8 @@
 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(
@@ -36,4 +39,44 @@ export class SASjsApiClient {
 
     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
 }