@sasjs/adapter 4.7.0 → 4.9.0

package/node/request/RequestClient.d.ts

@@ -2,45 +2,17 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
 import * as https from 'https';
 import { CsrfToken } from '..';
-import { SASjsRequest } from '../types';
-export interface HttpClient {
-    get<T>(url: string, accessToken: string | undefined, contentType: string, overrideHeaders: {
-        [key: string]: string | number;
-    }): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    post<T>(url: string, data: any, accessToken: string | undefined, contentType: string, overrideHeaders: {
-        [key: string]: string | number;
-    }): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    put<T>(url: string, data: any, accessToken: string | undefined, overrideHeaders: {
-        [key: string]: string | number;
-    }): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    delete<T>(url: string, accessToken: string | undefined): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined;
-    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
-    clearCsrfTokens(): void;
-    clearLocalStorageTokens(): void;
-    getBaseUrl(): string;
-}
+import { SASjsRequest, HttpClient, VerboseMode } from '../types';
 export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
     private requests;
     private requestsLimit;
     private httpInterceptor?;
+    private verboseMode;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number, verboseMode?: VerboseMode);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
@@ -96,6 +68,7 @@ export declare class RequestClient implements HttpClient {
     authorize: (response: string) => Promise<any>;
     /**
      * Adds colors to the string.
+     * If verboseMode is set to 'bleached', colors should be disabled
      * @param str - string to be prettified.
      * @returns - prettified string
      */
@@ -107,6 +80,11 @@ export declare class RequestClient implements HttpClient {
      */
     private parseInterceptedBody;
     private defaultInterceptionCallBack;
+    /**
+     * Sets verbose mode.
+     * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+     */
+    setVerboseMode: (verboseMode: VerboseMode) => void;
     /**
      * Turns on verbose mode to log every HTTP response.
      * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.

package/node/request/SasjsRequestClient.d.ts

@@ -1,12 +1,6 @@
 import { RequestClient } from './RequestClient';
 import { AxiosResponse } from 'axios';
-export interface SasjsParsedResponse<T> {
-    result: T;
-    log: string;
-    etag: string;
-    status: number;
-    printOutput?: string;
-}
+import { SasjsParsedResponse } from '../types';
 /**
  * Specific request client for SASJS.
  * Append tokens in headers.

package/node/types/RequestClient.d.ts

@@ -0,0 +1,46 @@
+import { CsrfToken } from '..';
+export interface HttpClient {
+    get<T>(url: string, accessToken: string | undefined, contentType: string, overrideHeaders: {
+        [key: string]: string | number;
+    }): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    post<T>(url: string, data: any, accessToken: string | undefined, contentType: string, overrideHeaders: {
+        [key: string]: string | number;
+    }): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    put<T>(url: string, data: any, accessToken: string | undefined, overrideHeaders: {
+        [key: string]: string | number;
+    }): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    delete<T>(url: string, accessToken: string | undefined): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined;
+    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
+    clearCsrfTokens(): void;
+    clearLocalStorageTokens(): void;
+    getBaseUrl(): string;
+}
+export interface SASjsRequest {
+    serviceLink: string;
+    timestamp: Date;
+    sourceCode: string;
+    generatedCode: string;
+    logFile: string;
+    SASWORK: any;
+}
+export interface SasjsParsedResponse<T> {
+    result: T;
+    log: string;
+    etag: string;
+    status: number;
+    printOutput?: string;
+}
+export declare type VerboseMode = boolean | 'bleached';

package/node/types/SASjsConfig.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import * as https from 'https';
 import { ServerType } from '@sasjs/utils/types';
+import { VerboseMode } from '../types';
 /**
  * Specifies the configuration for the SASjs instance - eg where and how to
  * connect to SAS.
@@ -45,6 +46,10 @@ export declare class SASjsConfig {
      * Set to `true` to enable additional debugging.
      */
     debug: boolean;
+    /**
+     * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
+     */
+    verbose?: VerboseMode;
     /**
      * The name of the compute context to use when calling the Viya services directly.
      * Example value: 'SAS Job Execution compute context'

package/node/types/index.d.ts

@@ -6,10 +6,12 @@ export * from './Job';
 export * from './JobDefinition';
 export * from './JobResult';
 export * from './Link';
+export * from './Login';
 export * from './SASjsConfig';
-export * from './SASjsRequest';
+export * from './RequestClient';
 export * from './Session';
 export * from './UploadFile';
 export * from './PollOptions';
 export * from './WriteStream';
 export * from './ExecuteScript';
+export * from './errors';

package/node/utils/compareTimestamps.d.ts

@@ -1,4 +1,4 @@
-import { SASjsRequest } from '../types/SASjsRequest';
+import { SASjsRequest } from '../types';
 /**
  * Comparator for SASjs request timestamps.
  *

package/package.json

@@ -84,5 +84,5 @@
     "https": "1.0.0",
     "tough-cookie": "4.1.3"
   },
-  "version": "4.7.0"
+  "version": "4.9.0"
 }

package/request/RequestClient.d.ts

@@ -2,45 +2,17 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
 import * as https from 'https';
 import { CsrfToken } from '..';
-import { SASjsRequest } from '../types';
-export interface HttpClient {
-    get<T>(url: string, accessToken: string | undefined, contentType: string, overrideHeaders: {
-        [key: string]: string | number;
-    }): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    post<T>(url: string, data: any, accessToken: string | undefined, contentType: string, overrideHeaders: {
-        [key: string]: string | number;
-    }): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    put<T>(url: string, data: any, accessToken: string | undefined, overrideHeaders: {
-        [key: string]: string | number;
-    }): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    delete<T>(url: string, accessToken: string | undefined): Promise<{
-        result: T;
-        etag: string;
-    }>;
-    getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined;
-    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
-    clearCsrfTokens(): void;
-    clearLocalStorageTokens(): void;
-    getBaseUrl(): string;
-}
+import { SASjsRequest, HttpClient, VerboseMode } from '../types';
 export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
     private requests;
     private requestsLimit;
     private httpInterceptor?;
+    private verboseMode;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number, verboseMode?: VerboseMode);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
@@ -96,6 +68,7 @@ export declare class RequestClient implements HttpClient {
     authorize: (response: string) => Promise<any>;
     /**
      * Adds colors to the string.
+     * If verboseMode is set to 'bleached', colors should be disabled
      * @param str - string to be prettified.
      * @returns - prettified string
      */
@@ -107,6 +80,11 @@ export declare class RequestClient implements HttpClient {
      */
     private parseInterceptedBody;
     private defaultInterceptionCallBack;
+    /**
+     * Sets verbose mode.
+     * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+     */
+    setVerboseMode: (verboseMode: VerboseMode) => void;
     /**
      * Turns on verbose mode to log every HTTP response.
      * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.

package/request/SasjsRequestClient.d.ts

@@ -1,12 +1,6 @@
 import { RequestClient } from './RequestClient';
 import { AxiosResponse } from 'axios';
-export interface SasjsParsedResponse<T> {
-    result: T;
-    log: string;
-    etag: string;
-    status: number;
-    printOutput?: string;
-}
+import { SasjsParsedResponse } from '../types';
 /**
  * Specific request client for SASJS.
  * Append tokens in headers.

package/src/SASjs.ts

@@ -4,7 +4,12 @@ import {
   UploadFile,
   EditContextInput,
   PollOptions,
-  LoginMechanism
+  LoginMechanism,
+  VerboseMode,
+  ErrorResponse,
+  LoginOptions,
+  LoginResult,
+  ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
@@ -29,8 +34,7 @@ import {
   Sas9JobExecutor,
   FileUploader
 } from './job-execution'
-import { ErrorResponse } from './types/errors'
-import { LoginOptions, LoginResult } from './types/Login'
+import { AxiosResponse } from 'axios'
 
 interface ExecuteScriptParams {
   linesOfCode: string[]
@@ -157,6 +161,23 @@ export default class SASjs {
     }
   }
 
+  /**
+   * Executes job on SASJS server.
+   * @param query - an object containing job path and debug level.
+   * @param appLoc - an application path.
+   * @param authConfig - an object for authentication.
+   * @returns a promise that resolves into job execution result and log.
+   */
+  public async executeJob(
+    query: ExecutionQuery,
+    appLoc: string,
+    authConfig?: AuthConfig
+  ) {
+    this.isMethodSupported('executeScript', [ServerType.Sasjs])
+
+    return await this.sasJSApiClient?.executeJob(query, appLoc, authConfig)
+  }
+
   /**
    * Gets compute contexts.
    * @param accessToken - an access token for an authorised user.
@@ -854,7 +875,7 @@ export default class SASjs {
    * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
    * @param variables - an object that represents macro variables.
-   * @param verboseMode - boolean to enable verbose mode (log every HTTP response).
+   * @param verboseMode - boolean or a string equal to 'bleached' to enable verbose mode (log every HTTP response).
    */
   public async startComputeJob(
     sasJob: string,
@@ -865,7 +886,7 @@ export default class SASjs {
     pollOptions?: PollOptions,
     printPid = false,
     variables?: MacroVar,
-    verboseMode?: boolean
+    verboseMode?: VerboseMode
   ) {
     config = {
       ...this.sasjsConfig,
@@ -879,8 +900,10 @@ export default class SASjs {
       )
     }
 
-    if (verboseMode) this.requestClient?.enableVerboseMode()
-    else this.requestClient?.disableVerboseMode()
+    if (verboseMode) {
+      this.requestClient?.setVerboseMode(verboseMode)
+      this.requestClient?.enableVerboseMode()
+    } else if (verboseMode === false) this.requestClient?.disableVerboseMode()
 
     return this.sasViyaApiClient?.executeComputeJob(
       sasJob,
@@ -975,7 +998,8 @@ export default class SASjs {
       this.requestClient = new RequestClientClass(
         this.sasjsConfig.serverUrl,
         this.sasjsConfig.httpsAgentOptions,
-        this.sasjsConfig.requestHistoryLimit
+        this.sasjsConfig.requestHistoryLimit,
+        this.sasjsConfig.verbose
       )
     } else {
       this.requestClient.setConfig(
@@ -1139,4 +1163,31 @@ export default class SASjs {
       )
     }
   }
+
+  /**
+   * Enables verbose mode that will log a summary of every HTTP response.
+   * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+   * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+   */
+  public enableVerboseMode(
+    successCallBack?: (response: AxiosResponse) => AxiosResponse,
+    errorCallBack?: (response: AxiosResponse) => AxiosResponse
+  ) {
+    this.requestClient?.enableVerboseMode(successCallBack, errorCallBack)
+  }
+
+  /**
+   * Turns off verbose mode to log every HTTP response.
+   */
+  public disableVerboseMode() {
+    this.requestClient?.disableVerboseMode()
+  }
+
+  /**
+   * Sets verbose mode.
+   * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+   */
+  public setVerboseMode = (verboseMode: VerboseMode) => {
+    this.requestClient?.setVerboseMode(verboseMode)
+  }
 }

package/src/minified/sas9/SASjs.ts

@@ -233,7 +233,8 @@ export default class SASjs {
       this.requestClient = new RequestClient(
         this.sasjsConfig.serverUrl,
         this.sasjsConfig.httpsAgentOptions,
-        this.sasjsConfig.requestHistoryLimit
+        this.sasjsConfig.requestHistoryLimit,
+        this.sasjsConfig.verbose
       )
     } else {
       this.requestClient.setConfig(

package/src/minified/sas9/WebJobExecutor.ts

@@ -11,7 +11,6 @@ import {
 import { RequestClient } from '../../request/RequestClient'
 import {
   isRelativePath,
-  parseSasViyaDebugResponse,
   appendExtraResponseAttributes,
   convertToCSV
 } from '../../utils'

package/src/request/RequestClient.ts

@@ -10,7 +10,7 @@ import {
   JobExecutionError,
   CertificateError
 } from '../types/errors'
-import { SASjsRequest } from '../types'
+import { SASjsRequest, HttpClient, VerboseMode } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
@@ -22,45 +22,11 @@ import {
 import { InvalidSASjsCsrfError } from '../types/errors/InvalidSASjsCsrfError'
 import { inspect } from 'util'
 
-export interface HttpClient {
-  get<T>(
-    url: string,
-    accessToken: string | undefined,
-    contentType: string,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  post<T>(
-    url: string,
-    data: any,
-    accessToken: string | undefined,
-    contentType: string,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  put<T>(
-    url: string,
-    data: any,
-    accessToken: string | undefined,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  delete<T>(
-    url: string,
-    accessToken: string | undefined
-  ): Promise<{ result: T; etag: string }>
-
-  getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
-  saveLocalStorageToken(accessToken: string, refreshToken: string): void
-  clearCsrfTokens(): void
-  clearLocalStorageTokens(): void
-  getBaseUrl(): string
-}
-
 export class RequestClient implements HttpClient {
   private requests: SASjsRequest[] = []
   private requestsLimit: number = 10
   private httpInterceptor?: number
+  private verboseMode: VerboseMode = false
 
   protected csrfToken: CsrfToken = { headerName: '', value: '' }
   protected fileUploadCsrfToken: CsrfToken | undefined
@@ -69,11 +35,17 @@ export class RequestClient implements HttpClient {
   constructor(
     protected baseUrl: string,
     httpsAgentOptions?: https.AgentOptions,
-    requestsLimit?: number
+    requestsLimit?: number,
+    verboseMode?: VerboseMode
   ) {
     this.createHttpClient(baseUrl, httpsAgentOptions)
 
     if (requestsLimit) this.requestsLimit = requestsLimit
+
+    if (verboseMode) {
+      this.setVerboseMode(verboseMode)
+      this.enableVerboseMode()
+    }
   }
 
   public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
@@ -395,10 +367,12 @@ export class RequestClient implements HttpClient {
 
   /**
    * Adds colors to the string.
+   * If verboseMode is set to 'bleached', colors should be disabled
    * @param str - string to be prettified.
    * @returns - prettified string
    */
-  private prettifyString = (str: any) => inspect(str, { colors: true })
+  private prettifyString = (str: any) =>
+    inspect(str, { colors: this.verboseMode !== 'bleached' })
 
   /**
    * Formats HTTP request/response body.
@@ -468,6 +442,17 @@ ${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
     return response
   }
 
+  /**
+   * Sets verbose mode.
+   * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+   */
+  public setVerboseMode = (verboseMode: VerboseMode) => {
+    this.verboseMode = verboseMode
+
+    if (this.verboseMode) this.enableVerboseMode()
+    else this.disableVerboseMode()
+  }
+
   /**
    * Turns on verbose mode to log every HTTP response.
    * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.

package/src/request/SasjsRequestClient.ts

@@ -1,19 +1,11 @@
 import { RequestClient } from './RequestClient'
 import { AxiosResponse } from 'axios'
-
-export interface SasjsParsedResponse<T> {
-  result: T
-  log: string
-  etag: string
-  status: number
-  printOutput?: string
-}
+import { SasjsParsedResponse } from '../types'
 
 /**
  * Specific request client for SASJS.
  * Append tokens in headers.
  */
-
 export class SasjsRequestClient extends RequestClient {
   getHeaders = (accessToken: string | undefined, contentType: string) => {
     const headers: any = {}

package/src/types/RequestClient.ts

@@ -0,0 +1,55 @@
+import { CsrfToken } from '..'
+
+export interface HttpClient {
+  get<T>(
+    url: string,
+    accessToken: string | undefined,
+    contentType: string,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  post<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    contentType: string,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  put<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  delete<T>(
+    url: string,
+    accessToken: string | undefined
+  ): Promise<{ result: T; etag: string }>
+
+  getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
+  saveLocalStorageToken(accessToken: string, refreshToken: string): void
+  clearCsrfTokens(): void
+  clearLocalStorageTokens(): void
+  getBaseUrl(): string
+}
+
+export interface SASjsRequest {
+  serviceLink: string
+  timestamp: Date
+  sourceCode: string
+  generatedCode: string
+  logFile: string
+  SASWORK: any
+}
+
+export interface SasjsParsedResponse<T> {
+  result: T
+  log: string
+  etag: string
+  status: number
+  printOutput?: string
+}
+
+export type VerboseMode = boolean | 'bleached'

package/src/types/SASjsConfig.ts

@@ -1,5 +1,6 @@
 import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
+import { VerboseMode } from '../types'
 
 /**
  * Specifies the configuration for the SASjs instance - eg where and how to
@@ -45,6 +46,10 @@ export class SASjsConfig {
    * Set to `true` to enable additional debugging.
    */
   debug: boolean = true
+  /**
+   * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
+   */
+  verbose?: VerboseMode = true
   /**
    * The name of the compute context to use when calling the Viya services directly.
    * Example value: 'SAS Job Execution compute context'

package/src/types/index.ts

@@ -6,10 +6,12 @@ export * from './Job'
 export * from './JobDefinition'
 export * from './JobResult'
 export * from './Link'
+export * from './Login'
 export * from './SASjsConfig'
-export * from './SASjsRequest'
+export * from './RequestClient'
 export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
 export * from './WriteStream'
 export * from './ExecuteScript'
+export * from './errors'

package/src/utils/compareTimestamps.ts

@@ -1,4 +1,4 @@
-import { SASjsRequest } from '../types/SASjsRequest'
+import { SASjsRequest } from '../types'
 
 /**
  * Comparator for SASjs request timestamps.

package/types/RequestClient.d.ts

@@ -0,0 +1,46 @@
+import { CsrfToken } from '..';
+export interface HttpClient {
+    get<T>(url: string, accessToken: string | undefined, contentType: string, overrideHeaders: {
+        [key: string]: string | number;
+    }): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    post<T>(url: string, data: any, accessToken: string | undefined, contentType: string, overrideHeaders: {
+        [key: string]: string | number;
+    }): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    put<T>(url: string, data: any, accessToken: string | undefined, overrideHeaders: {
+        [key: string]: string | number;
+    }): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    delete<T>(url: string, accessToken: string | undefined): Promise<{
+        result: T;
+        etag: string;
+    }>;
+    getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined;
+    saveLocalStorageToken(accessToken: string, refreshToken: string): void;
+    clearCsrfTokens(): void;
+    clearLocalStorageTokens(): void;
+    getBaseUrl(): string;
+}
+export interface SASjsRequest {
+    serviceLink: string;
+    timestamp: Date;
+    sourceCode: string;
+    generatedCode: string;
+    logFile: string;
+    SASWORK: any;
+}
+export interface SasjsParsedResponse<T> {
+    result: T;
+    log: string;
+    etag: string;
+    status: number;
+    printOutput?: string;
+}
+export declare type VerboseMode = boolean | 'bleached';