@sasjs/adapter 2.11.4 → 3.0.2

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

@@ -1,5 +1,8 @@
+/// <reference types="node" />
+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
@@ -9,10 +12,8 @@ import { BaseJobExecutor } from './JobExecutor';
 export declare class Sas9JobExecutor extends BaseJobExecutor {
     private jobsPath;
     private requestClient;
-    constructor(serverUrl: string, serverType: ServerType, jobsPath: string, allowInsecureRequests: boolean);
-    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

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { AxiosInstance, AxiosResponse } from 'axios';
+import * as https from 'https';
 import { CsrfToken } from '..';
 import { SASjsRequest } from '../types';
 export interface HttpClient {
@@ -34,8 +36,8 @@ export declare class RequestClient implements HttpClient {
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, allowInsecure?: boolean);
-    setConfig(baseUrl: string, allowInsecure?: boolean): void;
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
+    setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
     clearCsrfTokens(): void;
     getBaseUrl(): string;

package/node/request/Sas9RequestClient.d.ts

@@ -1,10 +1,12 @@
+/// <reference types="node" />
+import * as https from 'https';
 import { RequestClient } from './RequestClient';
 /**
  * Specific request client for SAS9 in Node.js environments.
  * Handles redirects and cookie management.
  */
 export declare class Sas9RequestClient extends RequestClient {
-    constructor(baseUrl: string, allowInsecure?: boolean);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
     login(username: string, password: string, jobsPath: string): Promise<void>;
     get<T>(url: string, accessToken: string | undefined, contentType?: string, overrideHeaders?: {
         [key: string]: string | number;

package/node/types/ExecuteScript.d.ts

@@ -0,0 +1,4 @@
+export interface ExecutionQuery {
+    _program: string;
+    _debug?: number;
+}

package/node/types/FileTree.d.ts

@@ -0,0 +1,18 @@
+export interface FileTree {
+    members: [FolderMember, ServiceMember];
+}
+export declare enum MemberType {
+    folder = "folder",
+    service = "service"
+}
+export interface FolderMember {
+    name: string;
+    type: MemberType.folder;
+    members: [FolderMember, ServiceMember];
+}
+export interface ServiceMember {
+    name: string;
+    type: MemberType.service;
+    code: string;
+}
+export declare const isFileTree: (arg: any) => arg is FileTree;

package/node/types/SASjsConfig.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import * as https from 'https';
 import { ServerType } from '@sasjs/utils/types';
 /**
  * Specifies the configuration for the SASjs instance - eg where and how to
@@ -53,11 +55,11 @@ export declare class SASjsConfig {
      */
     useComputeApi: boolean | null;
     /**
-     * Defaults to `false`.
-     * When set to `true`, the adapter will allow requests to SAS servers that use a self-signed SSL certificate.
-     * Changing this setting is not recommended.
+     * Optional settings to configure HTTPS Agent.
+     * By providing `key`, `cert`, `ca` to connect with server
+     * Other options can be set `rejectUnauthorized` and `requestCert`
      */
-    allowInsecureRequests: boolean;
+    httpsAgentOptions?: https.AgentOptions;
     /**
      * Supported login mechanisms are - Redirected and Default
      */

package/node/types/index.d.ts

@@ -12,3 +12,5 @@ export * from './Session';
 export * from './UploadFile';
 export * from './PollOptions';
 export * from './WriteStream';
+export * from './FileTree';
+export * from './ExecuteScript';

package/node/utils/createAxiosInstance.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import * as https from 'https';
+export declare const createAxiosInstance: (baseURL: string, httpsAgent?: https.Agent | undefined) => import("axios").AxiosInstance;

package/node/utils/index.d.ts

@@ -1,6 +1,7 @@
 export * from './asyncForEach';
 export * from './compareTimestamps';
 export * from './convertToCsv';
+export * from './createAxiosInstance';
 export * from './delay';
 export * from './isNode';
 export * from './isRelativePath';

package/package.json

@@ -41,40 +41,44 @@
   "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",
     "https": "^1.0.0",
     "tough-cookie": "^4.0.0"
   },
-  "version": "2.11.4"
+  "version": "3.0.2"
 }

package/request/RequestClient.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { AxiosInstance, AxiosResponse } from 'axios';
+import * as https from 'https';
 import { CsrfToken } from '..';
 import { SASjsRequest } from '../types';
 export interface HttpClient {
@@ -34,8 +36,8 @@ export declare class RequestClient implements HttpClient {
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, allowInsecure?: boolean);
-    setConfig(baseUrl: string, allowInsecure?: boolean): void;
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
+    setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
     clearCsrfTokens(): void;
     getBaseUrl(): string;

package/request/Sas9RequestClient.d.ts

@@ -1,10 +1,12 @@
+/// <reference types="node" />
+import * as https from 'https';
 import { RequestClient } from './RequestClient';
 /**
  * Specific request client for SAS9 in Node.js environments.
  * Handles redirects and cookie management.
  */
 export declare class Sas9RequestClient extends RequestClient {
-    constructor(baseUrl: string, allowInsecure?: boolean);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions);
     login(username: string, password: string, jobsPath: string): Promise<void>;
     get<T>(url: string, accessToken: string | undefined, contentType?: string, overrideHeaders?: {
         [key: string]: string | number;

package/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)
   }
 
   /**

package/src/SASjs.ts

@@ -4,10 +4,14 @@ import {
   UploadFile,
   EditContextInput,
   PollOptions,
-  LoginMechanism
+  LoginMechanism,
+  FolderMember,
+  ServiceMember,
+  ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
+import { SASjsApiClient } from './SASjsApiClient'
 import { AuthManager } from './auth'
 import {
   ServerType,
@@ -36,7 +40,6 @@ const defaultConfig: SASjsConfig = {
   debug: false,
   contextName: 'SAS Job Execution compute context',
   useComputeApi: null,
-  allowInsecureRequests: false,
   loginMechanism: LoginMechanism.Default
 }
 
@@ -49,6 +52,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 +61,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
@@ -792,7 +796,7 @@ export default class SASjs {
         sasApiClient = new SAS9ApiClient(
           serverUrl,
           this.jobsPath,
-          this.sasjsConfig.allowInsecureRequests
+          this.sasjsConfig.httpsAgentOptions
         )
       }
     } else {
@@ -824,6 +828,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.
@@ -951,12 +963,12 @@ export default class SASjs {
     if (!this.requestClient) {
       this.requestClient = new RequestClient(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.allowInsecureRequests
+        this.sasjsConfig.httpsAgentOptions
       )
     } else {
       this.requestClient.setConfig(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.allowInsecureRequests
+        this.sasjsConfig.httpsAgentOptions
       )
     }
 
@@ -973,30 +985,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 +1044,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(

package/src/SASjsApiClient.ts

@@ -0,0 +1,39 @@
+import { FolderMember, ServiceMember, ExecutionQuery } from './types'
+import { RequestClient } from './request/RequestClient'
+
+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)
+  }
+}

package/src/auth/AuthManager.ts

@@ -256,6 +256,10 @@ export class AuthManager {
           .split(' ')
           .map((name: string) => name.slice(0, 3).toLowerCase())
           .join('')
+
+      default:
+        console.error('Server Type not found in extractUserName function')
+        return ''
     }
   }
 

package/src/auth/getAccessToken.ts

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

package/src/job-execution/Sas9JobExecutor.ts

@@ -1,9 +1,11 @@
+import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
 import * as NodeFormData from 'form-data'
 import { ErrorResponse } from '../types/errors'
 import { convertToCSV, isRelativePath } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { Sas9RequestClient } from '../request/Sas9RequestClient'
+import { RequestClient } from '../request/RequestClient'
 
 /**
  * Job executor for SAS9 servers for use in Node.js environments.
@@ -12,15 +14,16 @@ import { Sas9RequestClient } from '../request/Sas9RequestClient'
  * job execution requests.
  */
 export class Sas9JobExecutor extends BaseJobExecutor {
-  private requestClient: Sas9RequestClient
+  private sas9RequestClient: Sas9RequestClient
   constructor(
     serverUrl: string,
     serverType: ServerType,
     private jobsPath: string,
-    allowInsecureRequests: boolean
+    private requestClient: RequestClient,
+    httpsAgentOptions?: https.AgentOptions
   ) {
     super(serverUrl, serverType)
-    this.requestClient = new Sas9RequestClient(serverUrl, allowInsecureRequests)
+    this.sas9RequestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
   }
 
   async execute(sasJob: string, data: any, config: any) {
@@ -36,6 +39,8 @@ export class Sas9JobExecutor extends BaseJobExecutor {
         : ''
     }`
 
+    apiUrl = `${apiUrl}${config.debug ? '&_debug=131' : ''}`
+
     let requestParams = {
       ...this.getRequestParams(config)
     }
@@ -48,6 +53,8 @@ export class Sas9JobExecutor extends BaseJobExecutor {
       } catch (e: any) {
         return Promise.reject(new ErrorResponse(e?.message, e))
       }
+    } else {
+      data = ''
     }
 
     for (const key in requestParams) {
@@ -56,16 +63,18 @@ export class Sas9JobExecutor extends BaseJobExecutor {
       }
     }
 
-    await this.requestClient.login(
+    await this.sas9RequestClient.login(
       config.username,
       config.password,
       this.jobsPath
     )
+
     const contentType =
       data && Object.keys(data).length
         ? 'multipart/form-data; boundary=' + (formData as any)._boundary
         : 'text/plain'
-    return await this.requestClient!.post(
+
+    return await this.sas9RequestClient!.post(
       apiUrl,
       formData,
       undefined,
@@ -75,6 +84,28 @@ export class Sas9JobExecutor extends BaseJobExecutor {
         Connection: 'Keep-Alive'
       }
     )
+      .then((res: any) => {
+        let resString = res
+
+        if (typeof res === 'object') {
+          resString = JSON.stringify(res)
+        }
+
+        this.requestClient!.appendRequest(resString, sasJob, config.debug)
+
+        return res
+      })
+      .catch((err: any) => {
+        let errString = err
+
+        if (typeof err === 'object') {
+          errString = JSON.stringify(errString)
+        }
+
+        this.requestClient!.appendRequest(errString, sasJob, config.debug)
+
+        return err
+      })
   }
 
   private getRequestParams(config: any): any {

package/src/request/RequestClient.ts

@@ -1,4 +1,5 @@
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
+import * as https from 'https'
 import { CsrfToken } from '..'
 import { isAuthorizeFormRequired, isLogInRequired } from '../auth'
 import {
@@ -12,7 +13,11 @@ import { SASjsRequest } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
-import { parseGeneratedCode, parseSourceCode } from '../utils'
+import {
+  parseGeneratedCode,
+  parseSourceCode,
+  createAxiosInstance
+} from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -54,12 +59,15 @@ export class RequestClient implements HttpClient {
   protected fileUploadCsrfToken: CsrfToken | undefined
   protected httpClient!: AxiosInstance
 
-  constructor(protected baseUrl: string, allowInsecure = false) {
-    this.createHttpClient(baseUrl, allowInsecure)
+  constructor(
+    protected baseUrl: string,
+    httpsAgentOptions?: https.AgentOptions
+  ) {
+    this.createHttpClient(baseUrl, httpsAgentOptions)
   }
 
-  public setConfig(baseUrl: string, allowInsecure = false) {
-    this.createHttpClient(baseUrl, allowInsecure)
+  public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
+    this.createHttpClient(baseUrl, httpsAgentOptions)
   }
 
   public getCsrfToken(type: 'general' | 'file' = 'general') {
@@ -511,23 +519,18 @@ export class RequestClient implements HttpClient {
     return responseToReturn
   }
 
-  private createHttpClient(baseUrl: string, allowInsecure = false) {
-    const https = require('https')
-    if (allowInsecure && https.Agent) {
-      this.httpClient = axios.create({
-        baseURL: baseUrl,
-        httpsAgent: new https.Agent({
-          rejectUnauthorized: !allowInsecure
-        })
-      })
-    } else {
-      this.httpClient = axios.create({
-        baseURL: baseUrl
-      })
-    }
+  private createHttpClient(
+    baseUrl: string,
+    httpsAgentOptions?: https.AgentOptions
+  ) {
+    const httpsAgent = httpsAgentOptions
+      ? new https.Agent(httpsAgentOptions)
+      : undefined
+
+    this.httpClient = createAxiosInstance(baseUrl, httpsAgent)
 
     this.httpClient.defaults.validateStatus = (status) =>
-      status >= 200 && status < 305
+      status >= 200 && status < 401
   }
 }
 

package/src/request/Sas9RequestClient.ts

@@ -1,3 +1,4 @@
+import * as https from 'https'
 import { AxiosRequestConfig } from 'axios'
 import axiosCookieJarSupport from 'axios-cookiejar-support'
 import * as tough from 'tough-cookie'
@@ -9,8 +10,8 @@ import { RequestClient, throwIfError } from './RequestClient'
  * Handles redirects and cookie management.
  */
 export class Sas9RequestClient extends RequestClient {
-  constructor(baseUrl: string, allowInsecure = false) {
-    super(baseUrl, allowInsecure)
+  constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
+    super(baseUrl, httpsAgentOptions)
     this.httpClient.defaults.maxRedirects = 0
     this.httpClient.defaults.validateStatus = (status) =>
       status >= 200 && status < 303

package/src/test/SAS_server_app.ts

@@ -0,0 +1,38 @@
+import express = require('express')
+
+export const app = express()
+
+export const mockedAuthResponse = {
+  access_token: 'access_token',
+  token_type: 'bearer',
+  id_token: 'id_token',
+  refresh_token: 'refresh_token',
+  expires_in: 43199,
+  scope: 'openid',
+  jti: 'jti'
+}
+
+app.get('/', function (req: any, res: any) {
+  res.send('Hello World')
+})
+
+app.post('/SASLogon/oauth/token', function (req: any, res: any) {
+  let valid = true
+  // capture the encoded form data
+  req.on('data', (data: any) => {
+    const resData = data.toString()
+
+    if (resData.includes('incorrect')) valid = false
+  })
+
+  // send a response when finished reading
+  // the encoded form data
+  req.on('end', () => {
+    if (valid) res.status(200).send(mockedAuthResponse)
+    else
+      res.status(401).send({
+        error: 'unauthorized',
+        error_description: 'Bad credentials'
+      })
+  })
+})

package/src/types/ExecuteScript.ts

@@ -0,0 +1,4 @@
+export interface ExecutionQuery {
+  _program: string
+  _debug?: number
+}