@sasjs/adapter 4.3.2 → 4.3.4

package/node/request/SasjsRequestClient.d.ts

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

package/package.json

@@ -60,7 +60,7 @@
     "node-polyfill-webpack-plugin": "1.1.4",
     "path": "0.12.7",
     "pem": "1.14.5",
-    "prettier": "2.7.1",
+    "prettier": "2.8.7",
     "process": "0.11.10",
     "rimraf": "3.0.2",
     "semantic-release": "19.0.3",
@@ -84,5 +84,5 @@
     "https": "1.0.0",
     "tough-cookie": "4.0.0"
   },
-  "version": "4.3.2"
+  "version": "4.3.4"
 }

package/request/SasjsRequestClient.d.ts

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

package/src/SASViyaApiClient.ts

@@ -378,12 +378,14 @@ export class SASViyaApiClient {
     isForced?: boolean
   ): Promise<Folder> {
     const logger = process.logger || console
+
     if (!parentFolderPath && !parentFolderUri) {
       throw new Error('Path or URI of the parent folder is required.')
     }
 
     if (!parentFolderUri && parentFolderPath) {
       parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
+
       if (!parentFolderUri) {
         logger.info(
           `Parent folder at path '${parentFolderPath}' is not present.`
@@ -394,6 +396,7 @@ export class SASViyaApiClient {
           parentFolderPath.lastIndexOf('/')
         )
         const newFolderName = `${parentFolderPath.split('/').pop()}`
+
         if (newParentFolderPath === '') {
           throw new RootFolderNotFoundError(
             parentFolderPath,
@@ -401,20 +404,24 @@ export class SASViyaApiClient {
             accessToken
           )
         }
+
         logger.info(
           `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`
         )
+
         const parentFolder = await this.createFolder(
           newFolderName,
           newParentFolderPath,
           undefined,
           accessToken
         )
+
         logger.info(
           `Parent folder '${newFolderName}' has been successfully created.`
         )
+
         parentFolderUri = `/folders/folders/${parentFolder.id}`
-      } else if (isForced && accessToken) {
+      } else if (isForced) {
         const folderPath = parentFolderPath + '/' + folderName
         const folderUri = await this.getFolderUri(folderPath, accessToken)
 
@@ -427,8 +434,8 @@ export class SASViyaApiClient {
       }
     }
 
-    const { result: createFolderResponse } =
-      await this.requestClient.post<Folder>(
+    const { result: createFolderResponse } = await this.requestClient
+      .post<Folder>(
         `/folders/folders?parentFolderUri=${parentFolderUri}`,
         {
           name: folderName,
@@ -436,12 +443,34 @@ export class SASViyaApiClient {
         },
         accessToken
       )
+      .catch((err) => {
+        const { message, response } = err
+
+        if (message && response && response.data && response.data.message) {
+          const { status } = response
+          const { message: responseMessage } = response.data
+          const messages = [message, responseMessage].map((mes: string) =>
+            /\.$/.test(mes) ? mes : `${mes}.`
+          )
+
+          if (!isForced && status === 409) {
+            messages.push(`To override, please set "isForced" to "true".`)
+          }
+
+          const errMessage = messages.join(' ')
+
+          throw errMessage
+        }
+
+        throw err
+      })
 
     // update folder map with newly created folder.
     await this.populateFolderMap(
       `${parentFolderPath}/${folderName}`,
       accessToken
     )
+
     return createFolderResponse
   }
 
@@ -900,7 +929,7 @@ export class SASViyaApiClient {
     return `/folders/folders/${folderDetails.id}`
   }
 
-  private async getRecycleBinUri(accessToken: string) {
+  private async getRecycleBinUri(accessToken?: string) {
     const url = '/folders/folders/@myRecycleBin'
 
     const { result: folder } = await this.requestClient
@@ -984,7 +1013,7 @@ export class SASViyaApiClient {
     sourceFolder: string,
     targetParentFolder: string,
     targetFolderName: string,
-    accessToken: string
+    accessToken?: string
   ) {
     // If target path is an existing folder, than keep source folder name, othervise rename it with given target folder name
     const sourceFolderName = sourceFolder.split('/').pop() as string
@@ -1051,7 +1080,7 @@ export class SASViyaApiClient {
    * @param folderPath - the full path (eg `/Public/example/deleteThis`) of the folder to be deleted.
    * @param accessToken - an access token for authorizing the request.
    */
-  public async deleteFolder(folderPath: string, accessToken: string) {
+  public async deleteFolder(folderPath: string, accessToken?: string) {
     const recycleBinUri = await this.getRecycleBinUri(accessToken)
     const folderName = folderPath.split('/').pop() || ''
     const date = new Date()

package/src/SASjs.ts

@@ -337,13 +337,16 @@ export default class SASjs {
     sasApiClient?: SASViyaApiClient,
     isForced?: boolean
   ) {
-    if (sasApiClient)
+    if (sasApiClient) {
       return await sasApiClient.createFolder(
         folderName,
         parentFolderPath,
         parentFolderUri,
-        accessToken
+        accessToken,
+        isForced
       )
+    }
+
     return await this.sasViyaApiClient!.createFolder(
       folderName,
       parentFolderPath,
@@ -783,13 +786,11 @@ export default class SASjs {
     this.isMethodSupported('deployServicePack', [ServerType.SasViya])
 
     let sasApiClient: any = null
+
     if (serverUrl || appLoc) {
-      if (!serverUrl) {
-        serverUrl = this.sasjsConfig.serverUrl
-      }
-      if (!appLoc) {
-        appLoc = this.sasjsConfig.appLoc
-      }
+      if (!serverUrl) serverUrl = this.sasjsConfig.serverUrl
+      if (!appLoc) appLoc = this.sasjsConfig.appLoc
+
       if (this.sasjsConfig.serverType === ServerType.SasViya) {
         sasApiClient = new SASViyaApiClient(
           serverUrl,
@@ -807,11 +808,13 @@ export default class SASjs {
       }
     } else {
       let sasClientConfig: any = null
+
       if (this.sasjsConfig.serverType === ServerType.SasViya) {
         sasClientConfig = this.sasViyaApiClient!.getConfig()
       } else if (this.sasjsConfig.serverType === ServerType.Sas9) {
         sasClientConfig = this.sas9ApiClient!.getConfig()
       }
+
       serverUrl = sasClientConfig.serverUrl
       appLoc = sasClientConfig.rootFolderName as string
     }

package/src/SASjsApiClient.ts

@@ -1,11 +1,24 @@
 import * as NodeFormData from 'form-data'
 import { AuthConfig, ServerType, ServicePackSASjs } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
 import { ExecutionQuery } from './types'
 import { RequestClient } from './request/RequestClient'
 import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
 import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
 import { getTokens } from './auth/getTokens'
 
+// TODO: move to sasjs/utils
+export interface SASjsAuthResponse {
+  access_token: string
+  refresh_token: string
+}
+
+export interface ScriptExecutionResult {
+  log: string
+  webout?: string
+  printOutput?: string
+}
+
 export class SASjsApiClient {
   constructor(private requestClient: RequestClient) {}
 
@@ -118,18 +131,28 @@ export class SASjsApiClient {
     code: string,
     runTime: string = 'sas',
     authConfig?: AuthConfig
-  ) {
+  ): Promise<ScriptExecutionResult> {
     const access_token = await this.getAccessTokenForRequest(authConfig)
-
-    let parsedSasjsServerLog = ''
+    const executionResult: ScriptExecutionResult = { log: '' }
 
     await this.requestClient
       .post('SASjsApi/code/execute', { code, runTime }, access_token)
       .then((res: any) => {
-        if (res.log) parsedSasjsServerLog = res.log
+        const { log, printOutput, result: webout } = res
+
+        executionResult.log = log
+
+        if (printOutput) executionResult.printOutput = printOutput
+        if (webout) executionResult.webout = webout
+      })
+      .catch((err) => {
+        throw prefixMessage(
+          err,
+          'Error while sending POST request to execute code. '
+        )
       })
 
-    return parsedSasjsServerLog
+    return executionResult
   }
 
   /**
@@ -152,9 +175,3 @@ export class SASjsApiClient {
     return refreshTokensForSasjs(this.requestClient, refreshToken)
   }
 }
-
-// todo move to sasjs/utils
-export interface SASjsAuthResponse {
-  access_token: string
-  refresh_token: string
-}

package/src/job-execution/SasjsJobExecutor.ts

@@ -13,7 +13,11 @@ import { generateFileUploadForm } from '../file/generateFileUploadForm'
 
 import { RequestClient } from '../request/RequestClient'
 
-import { isRelativePath, appendExtraResponseAttributes } from '../utils'
+import {
+  isRelativePath,
+  appendExtraResponseAttributes,
+  getValidJson
+} from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 
 export class SasjsJobExecutor extends BaseJobExecutor {
@@ -89,12 +93,16 @@ export class SasjsJobExecutor extends BaseJobExecutor {
             )
           }
 
+          const { result } = res.result
+          if (result && result.trim()) res.result = getValidJson(result)
+
           this.requestClient!.appendRequest(res, sasJob, config.debug)
 
           const responseObject = appendExtraResponseAttributes(
             res,
             extraResponseAttributes
           )
+
           resolve(responseObject)
         })
         .catch(async (e: Error) => {

package/src/request/SasjsRequestClient.ts

@@ -1,6 +1,14 @@
 import { RequestClient } from './RequestClient'
 import { AxiosResponse } from 'axios'
-import { SASJS_LOGS_SEPARATOR, getValidJson } from '../utils'
+import { SASJS_LOGS_SEPARATOR } from '../utils'
+
+interface SasjsParsedResponse<T> {
+  result: T
+  log: string
+  etag: string
+  status: number
+  printOutput?: string
+}
 
 /**
  * Specific request client for SASJS.
@@ -27,7 +35,7 @@ export class SasjsRequestClient extends RequestClient {
   protected parseResponse<T>(response: AxiosResponse<any>) {
     const etag = response?.headers ? response.headers['etag'] : ''
     let parsedResponse = {}
-    let log
+    let webout, log, printOutput
 
     try {
       if (typeof response.data === 'string') {
@@ -38,17 +46,26 @@ export class SasjsRequestClient extends RequestClient {
     } catch {
       if (response.data.includes(SASJS_LOGS_SEPARATOR)) {
         const splittedResponse = response.data.split(SASJS_LOGS_SEPARATOR)
+
+        webout = splittedResponse[0]
+        if (webout) parsedResponse = webout
+
         log = splittedResponse[1]
-        if (splittedResponse[0].trim())
-          parsedResponse = getValidJson(splittedResponse[0])
-      } else parsedResponse = response.data
+        printOutput = splittedResponse[2]
+      } else {
+        parsedResponse = response.data
+      }
     }
 
-    return {
+    const returnResult: SasjsParsedResponse<T> = {
       result: parsedResponse as T,
       log,
       etag,
       status: response.status
     }
+
+    if (printOutput) returnResult.printOutput = printOutput
+
+    return returnResult
   }
 }

package/src/utils/getValidJson.ts

@@ -17,6 +17,7 @@ export const getValidJson = (str: string | object): object => {
     return JSON.parse(str)
   } catch (e: any) {
     if (e instanceof JsonParseArrayError) throw e
+
     throw new InvalidJsonError()
   }
 }