@sasjs/adapter 3.5.0 → 3.7.0

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

@@ -0,0 +1,10 @@
+import { AuthConfig, ExtraResponseAttributes, ServerType } from '@sasjs/utils/types';
+import { RequestClient } from '../request/RequestClient';
+import { BaseJobExecutor } from './JobExecutor';
+export declare class SasJsJobExecutor extends BaseJobExecutor {
+    private jobsPath;
+    private requestClient;
+    constructor(serverUrl: string, serverType: ServerType, jobsPath: string, requestClient: RequestClient);
+    execute(sasJob: string, data: any, config: any, loginRequiredCallback?: any, authConfig?: AuthConfig, extraResponseAttributes?: ExtraResponseAttributes[]): Promise<unknown>;
+    private getRequestParams;
+}

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

@@ -1,6 +1,7 @@
 export * from './ComputeJobExecutor';
+export * from './FileUploader';
 export * from './JesJobExecutor';
 export * from './JobExecutor';
 export * from './Sas9JobExecutor';
+export * from './SasJsJobExecutor';
 export * from './WebJobExecutor';
-export * from './FileUploader';

package/node/request/RequestClient.d.ts

@@ -35,10 +35,11 @@ export interface HttpClient {
 export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
     private requests;
+    private requestsLimit;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;

package/node/types/SASjsConfig.d.ts

@@ -16,7 +16,7 @@ export declare class SASjsConfig {
      * The location of the STP Process Web Application.  By default the adapter
      * will use '/SASjsApi/stp/execute' on SAS JS.
      */
-    pathSASJS?: string;
+    pathSASJS: string;
     /**
      * The location of the Stored Process Web Application.  By default the adapter
      * will use '/SASStoredProcess/do' on SAS 9.
@@ -60,7 +60,7 @@ export declare class SASjsConfig {
      */
     useComputeApi: boolean | null;
     /**
-     * Optional settings to configure HTTPS Agent.
+     * Optional setting to configure HTTPS Agent.
      * By providing `key`, `cert`, `ca` to connect with server
      * Other options can be set `rejectUnauthorized` and `requestCert`
      */
@@ -69,6 +69,11 @@ export declare class SASjsConfig {
      * Supported login mechanisms are - Redirected and Default
      */
     loginMechanism: LoginMechanism;
+    /**
+     * Optional setting to configure request history limit. Increasing this limit
+     * may affect browser performance, especially with debug (logs) enabled.
+     */
+    requestHistoryLimit?: number;
 }
 export declare enum LoginMechanism {
     Default = "Default",

package/node/utils/convertToCsv.d.ts

@@ -2,7 +2,7 @@
  * Converts the given JSON object array to a CSV string.
  * @param data - the array of JSON objects to convert.
  */
-export declare const convertToCSV: (data: any, sasFormats?: {
+export declare const convertToCSV: (data: any[], sasFormats?: {
     formats: {
         [key: string]: string;
     };

package/package.json

@@ -75,10 +75,10 @@
   "dependencies": {
     "@sasjs/utils": "2.35.0",
     "axios": "0.26.0",
-    "axios-cookiejar-support": "2.0.3",
+    "axios-cookiejar-support": "1.0.1",
     "form-data": "4.0.0",
     "https": "1.0.0",
     "tough-cookie": "4.0.0"
   },
-  "version": "3.5.0"
+  "version": "3.7.0"
 }

package/request/RequestClient.d.ts

@@ -35,10 +35,11 @@ export interface HttpClient {
 export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
     private requests;
+    private requestsLimit;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;

package/src/SASjs.ts

@@ -27,6 +27,7 @@ import {
   ComputeJobExecutor,
   JesJobExecutor,
   Sas9JobExecutor,
+  SasJsJobExecutor,
   FileUploader
 } from './job-execution'
 import { ErrorResponse } from './types/errors'
@@ -62,6 +63,7 @@ export default class SASjs {
   private computeJobExecutor: JobExecutor | null = null
   private jesJobExecutor: JobExecutor | null = null
   private sas9JobExecutor: JobExecutor | null = null
+  private sasJsJobExecutor: JobExecutor | null = null
 
   constructor(config?: Partial<SASjsConfig>) {
     this.sasjsConfig = {
@@ -76,6 +78,12 @@ export default class SASjs {
     return this.requestClient?.getCsrfToken(type)
   }
 
+  /**
+   * Executes the sas code against SAS9 server
+   * @param linesOfCode - lines of sas code from the file to run.
+   * @param username - a string representing the username.
+   * @param password - a string representing the password.
+   */
   public async executeScriptSAS9(
     linesOfCode: string[],
     userName: string,
@@ -90,6 +98,38 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Executes the sas code against SASViya server
+   * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
+   * @param linesOfCode - lines of sas code from the file to run.
+   * @param contextName - context name on which code will be run on the server.
+   * @param authConfig - (optional) the access token, refresh token, client and secret for authorizing the request.
+   * @param debug - (optional) if true, global debug config will be overriden
+   */
+  public async executeScriptSASViya(
+    fileName: string,
+    linesOfCode: string[],
+    contextName: string,
+    authConfig?: AuthConfig,
+    debug?: boolean
+  ) {
+    this.isMethodSupported('executeScriptSASViya', [ServerType.SasViya])
+    if (!contextName) {
+      throw new Error(
+        'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
+      )
+    }
+
+    return await this.sasViyaApiClient!.executeScript(
+      fileName,
+      linesOfCode,
+      contextName,
+      authConfig,
+      null,
+      debug ? debug : this.sasjsConfig.debug
+    )
+  }
+
   /**
    * Gets compute contexts.
    * @param accessToken - an access token for an authorized user.
@@ -253,38 +293,6 @@ export default class SASjs {
     return await this.sasViyaApiClient!.createSession(contextName, accessToken)
   }
 
-  /**
-   * Executes the sas code against given sas server
-   * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
-   * @param linesOfCode - lines of sas code from the file to run.
-   * @param contextName - context name on which code will be run on the server.
-   * @param authConfig - (optional) the access token, refresh token, client and secret for authorizing the request.
-   * @param debug - (optional) if true, global debug config will be overriden
-   */
-  public async executeScriptSASViya(
-    fileName: string,
-    linesOfCode: string[],
-    contextName: string,
-    authConfig?: AuthConfig,
-    debug?: boolean
-  ) {
-    this.isMethodSupported('executeScriptSASViya', [ServerType.SasViya])
-    if (!contextName) {
-      throw new Error(
-        'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
-      )
-    }
-
-    return await this.sasViyaApiClient!.executeScript(
-      fileName,
-      linesOfCode,
-      contextName,
-      authConfig,
-      null,
-      debug ? debug : this.sasjsConfig.debug
-    )
-  }
-
   /**
    * Creates a folder in the logical SAS folder tree
    * @param folderName - name of the folder to be created.
@@ -675,7 +683,16 @@ export default class SASjs {
     const validationResult = this.validateInput(data)
 
     if (validationResult.status) {
-      if (
+      if (config.serverType === ServerType.Sasjs) {
+        return await this.sasJsJobExecutor!.execute(
+          sasJob,
+          data,
+          config,
+          loginRequiredCallback,
+          authConfig,
+          extraResponseAttributes
+        )
+      } else if (
         config.serverType !== ServerType.Sas9 &&
         config.useComputeApi !== undefined &&
         config.useComputeApi !== null
@@ -1017,7 +1034,8 @@ export default class SASjs {
           : RequestClient
       this.requestClient = new RequestClientClass(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.httpsAgentOptions
+        this.sasjsConfig.httpsAgentOptions,
+        this.sasjsConfig.requestHistoryLimit
       )
     } else {
       this.requestClient.setConfig(
@@ -1031,7 +1049,7 @@ export default class SASjs {
         ? this.sasjsConfig.pathSASViya
         : this.sasjsConfig.serverType === ServerType.Sas9
         ? this.sasjsConfig.pathSAS9
-        : this.sasjsConfig.pathSASJS || ''
+        : this.sasjsConfig.pathSASJS
 
     this.authManager = new AuthManager(
       this.sasjsConfig.serverUrl,
@@ -1096,6 +1114,13 @@ export default class SASjs {
       this.sasViyaApiClient!
     )
 
+    this.sasJsJobExecutor = new SasJsJobExecutor(
+      this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
+      this.jobsPath,
+      this.requestClient
+    )
+
     this.sas9JobExecutor = new Sas9JobExecutor(
       this.sasjsConfig.serverUrl,
       this.sasjsConfig.serverType!,

package/src/file/generateFileUploadForm.ts

@@ -5,8 +5,11 @@ export const generateFileUploadForm = (
   data: any
 ): FormData => {
   for (const tableName in data) {
+    if (!Array.isArray(data[tableName])) continue
+
     const name = tableName
     const csv = convertToCSV(data[tableName])
+
     if (csv === 'ERROR: LARGE STRING LENGTH') {
       throw new Error(
         'The max length of a string value in SASjs is 32765 characters.'

package/src/job-execution/SasJsJobExecutor.ts

@@ -0,0 +1,123 @@
+import {
+  AuthConfig,
+  ExtraResponseAttributes,
+  ServerType
+} from '@sasjs/utils/types'
+import {
+  ErrorResponse,
+  JobExecutionError,
+  LoginRequiredError
+} from '../types/errors'
+import { RequestClient } from '../request/RequestClient'
+import {
+  isRelativePath,
+  appendExtraResponseAttributes,
+  getValidJson
+} from '../utils'
+import { BaseJobExecutor } from './JobExecutor'
+import { parseWeboutResponse } from '../utils/parseWeboutResponse'
+
+export class SasJsJobExecutor extends BaseJobExecutor {
+  constructor(
+    serverUrl: string,
+    serverType: ServerType,
+    private jobsPath: string,
+    private requestClient: RequestClient
+  ) {
+    super(serverUrl, serverType)
+  }
+
+  async execute(
+    sasJob: string,
+    data: any,
+    config: any,
+    loginRequiredCallback?: any,
+    authConfig?: AuthConfig,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
+  ) {
+    const loginCallback = loginRequiredCallback || (() => Promise.resolve())
+    const program = isRelativePath(sasJob)
+      ? config.appLoc
+        ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
+        : sasJob
+      : sasJob
+    let apiUrl = `${config.serverUrl}${this.jobsPath}/?${'_program=' + program}`
+
+    const requestParams = this.getRequestParams(config)
+
+    const requestPromise = new Promise((resolve, reject) => {
+      this.requestClient!.post(
+        apiUrl,
+        { ...requestParams, ...data },
+        authConfig?.access_token
+      )
+        .then(async (res: any) => {
+          const resObj = {
+            result: res.result._webout,
+            log: res.result.log
+          }
+          this.requestClient!.appendRequest(resObj, sasJob, config.debug)
+
+          let jsonResponse = res.result
+
+          if (config.debug) {
+            const webout = parseWeboutResponse(res.result._webout, apiUrl)
+            jsonResponse = getValidJson(webout)
+          } else {
+            jsonResponse = getValidJson(res.result._webout)
+          }
+
+          const responseObject = appendExtraResponseAttributes(
+            { result: jsonResponse },
+            extraResponseAttributes
+          )
+          resolve(responseObject)
+        })
+        .catch(async (e: Error) => {
+          if (e instanceof JobExecutionError) {
+            this.requestClient!.appendRequest(e, sasJob, config.debug)
+            reject(new ErrorResponse(e?.message, e))
+          }
+
+          if (e instanceof LoginRequiredError) {
+            this.appendWaitingRequest(() => {
+              return this.execute(
+                sasJob,
+                data,
+                config,
+                loginRequiredCallback,
+                authConfig,
+                extraResponseAttributes
+              ).then(
+                (res: any) => {
+                  resolve(res)
+                },
+                (err: any) => {
+                  reject(err)
+                }
+              )
+            })
+
+            await loginCallback()
+          } else {
+            reject(new ErrorResponse(e?.message, e))
+          }
+        })
+    })
+
+    return requestPromise
+  }
+
+  private getRequestParams(config: any): any {
+    const requestParams: any = {}
+
+    if (config.debug) {
+      requestParams['_omittextlog'] = 'false'
+      requestParams['_omitsessionresults'] = 'false'
+
+      requestParams['_debug'] = 131
+    }
+
+    return requestParams
+  }
+}

package/src/job-execution/index.ts

@@ -1,6 +1,7 @@
 export * from './ComputeJobExecutor'
+export * from './FileUploader'
 export * from './JesJobExecutor'
 export * from './JobExecutor'
 export * from './Sas9JobExecutor'
+export * from './SasJsJobExecutor'
 export * from './WebJobExecutor'
-export * from './FileUploader'

package/src/request/RequestClient.ts

@@ -56,6 +56,7 @@ export interface HttpClient {
 
 export class RequestClient implements HttpClient {
   private requests: SASjsRequest[] = []
+  private requestsLimit: number = 10
 
   protected csrfToken: CsrfToken = { headerName: '', value: '' }
   protected fileUploadCsrfToken: CsrfToken | undefined
@@ -63,9 +64,11 @@ export class RequestClient implements HttpClient {
 
   constructor(
     protected baseUrl: string,
-    httpsAgentOptions?: https.AgentOptions
+    httpsAgentOptions?: https.AgentOptions,
+    requestsLimit?: number
   ) {
     this.createHttpClient(baseUrl, httpsAgentOptions)
+    if (requestsLimit) this.requestsLimit = requestsLimit
   }
 
   public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
@@ -149,7 +152,7 @@ export class RequestClient implements HttpClient {
       SASWORK: sasWork
     })
 
-    if (this.requests.length > 20) {
+    if (this.requests.length > this.requestsLimit) {
       this.requests.splice(0, 1)
     }
   }

package/src/request/Sas9RequestClient.ts

@@ -1,6 +1,6 @@
 import * as https from 'https'
 import { AxiosRequestConfig } from 'axios'
-import * as axiosCookieJarSupport from 'axios-cookiejar-support'
+import axiosCookieJarSupport from 'axios-cookiejar-support'
 import * as tough from 'tough-cookie'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient, throwIfError } from './RequestClient'
@@ -17,7 +17,7 @@ export class Sas9RequestClient extends RequestClient {
       status >= 200 && status < 303
 
     if (axiosCookieJarSupport) {
-      axiosCookieJarSupport.wrapper(this.httpClient)
+      axiosCookieJarSupport(this.httpClient)
       this.httpClient.defaults.jar = new tough.CookieJar()
     }
   }

package/src/types/SASjsConfig.ts

@@ -16,7 +16,7 @@ export class SASjsConfig {
    * The location of the STP Process Web Application.  By default the adapter
    * will use '/SASjsApi/stp/execute' on SAS JS.
    */
-  pathSASJS?: string = ''
+  pathSASJS: string = ''
   /**
    * The location of the Stored Process Web Application.  By default the adapter
    * will use '/SASStoredProcess/do' on SAS 9.
@@ -60,7 +60,7 @@ export class SASjsConfig {
    */
   useComputeApi: boolean | null = null
   /**
-   * Optional settings to configure HTTPS Agent.
+   * Optional setting to configure HTTPS Agent.
    * By providing `key`, `cert`, `ca` to connect with server
    * Other options can be set `rejectUnauthorized` and `requestCert`
    */
@@ -69,6 +69,11 @@ export class SASjsConfig {
    * Supported login mechanisms are - Redirected and Default
    */
   loginMechanism: LoginMechanism = LoginMechanism.Default
+  /**
+   * Optional setting to configure request history limit. Increasing this limit
+   * may affect browser performance, especially with debug (logs) enabled.
+   */
+  requestHistoryLimit?: number = 10
 }
 
 export enum LoginMechanism {

package/src/utils/convertToCsv.ts

@@ -3,7 +3,7 @@
  * @param data - the array of JSON objects to convert.
  */
 export const convertToCSV = (
-  data: any,
+  data: any[],
   sasFormats?: { formats: { [key: string]: string } }
 ) => {
   let formats = sasFormats?.formats
@@ -76,7 +76,7 @@ export const convertToCSV = (
               return byteSize
             }
           })
-          .sort((a: number, b: number) => b - a)[0]
+          .sort((a: any, b: any) => b - a)[0]
 
         if (longestValueForField && longestValueForField > 32765) {
           invalidString = true

package/types/SASjsConfig.d.ts

@@ -16,7 +16,7 @@ export declare class SASjsConfig {
      * The location of the STP Process Web Application.  By default the adapter
      * will use '/SASjsApi/stp/execute' on SAS JS.
      */
-    pathSASJS?: string;
+    pathSASJS: string;
     /**
      * The location of the Stored Process Web Application.  By default the adapter
      * will use '/SASStoredProcess/do' on SAS 9.
@@ -60,7 +60,7 @@ export declare class SASjsConfig {
      */
     useComputeApi: boolean | null;
     /**
-     * Optional settings to configure HTTPS Agent.
+     * Optional setting to configure HTTPS Agent.
      * By providing `key`, `cert`, `ca` to connect with server
      * Other options can be set `rejectUnauthorized` and `requestCert`
      */
@@ -69,6 +69,11 @@ export declare class SASjsConfig {
      * Supported login mechanisms are - Redirected and Default
      */
     loginMechanism: LoginMechanism;
+    /**
+     * Optional setting to configure request history limit. Increasing this limit
+     * may affect browser performance, especially with debug (logs) enabled.
+     */
+    requestHistoryLimit?: number;
 }
 export declare enum LoginMechanism {
     Default = "Default",

package/utils/convertToCsv.d.ts

@@ -2,7 +2,7 @@
  * Converts the given JSON object array to a CSV string.
  * @param data - the array of JSON objects to convert.
  */
-export declare const convertToCSV: (data: any, sasFormats?: {
+export declare const convertToCSV: (data: any[], sasFormats?: {
     formats: {
         [key: string]: string;
     };