@sasjs/adapter 4.11.2 → 4.12.0

package/src/request/RequestClient.ts

@@ -2,9 +2,9 @@ import {
   AxiosError,
   AxiosInstance,
   AxiosRequestConfig,
+  AxiosRequestHeaders,
   AxiosResponse
 } from 'axios'
-import axios from 'axios'
 import * as https from 'https'
 import { CsrfToken } from '..'
 import { isAuthorizeFormRequired, isLogInRequired } from '../auth'
@@ -160,7 +160,7 @@ export class RequestClient implements HttpClient {
     const requestConfig: AxiosRequestConfig = {
       headers,
       responseType: contentType === 'text/plain' ? 'text' : 'json',
-      withCredentials: true
+      withXSRFToken: true
     }
 
     if (contentType === 'text/plain') {
@@ -191,6 +191,13 @@ export class RequestClient implements HttpClient {
       })
   }
 
+  /**
+   * @param contentType  Newer version of Axios is more strict so if you don't
+   * set the contentType to `form data` while sending a FormData object
+   * application/json will be used by default, axios won’t treat it as FormData.
+   * Instead, it serializes data as JSON—resulting in a payload like
+   * {"sometable":{}} and we lose the multipart/form-data formatting.
+   */
   public async post<T>(
     url: string,
     data: any,
@@ -207,7 +214,7 @@ export class RequestClient implements HttpClient {
     return this.httpClient
       .post<T>(url, data, {
         headers,
-        withCredentials: true,
+        withXSRFToken: true,
         ...additionalSettings
       })
       .then((response) => {
@@ -234,7 +241,7 @@ export class RequestClient implements HttpClient {
     }
 
     return this.httpClient
-      .put<T>(url, data, { headers, withCredentials: true })
+      .put<T>(url, data, { headers, withXSRFToken: true })
       .then((response) => {
         throwIfError(response)
         return this.parseResponse<T>(response)
@@ -253,7 +260,7 @@ export class RequestClient implements HttpClient {
     const headers = this.getHeaders(accessToken, 'application/json')
 
     return this.httpClient
-      .delete<T>(url, { headers, withCredentials: true })
+      .delete<T>(url, { headers, withXSRFToken: true })
       .then((response) => {
         throwIfError(response)
         return this.parseResponse<T>(response)
@@ -271,7 +278,7 @@ export class RequestClient implements HttpClient {
     const headers = this.getHeaders(accessToken, 'application/json')
 
     return this.httpClient
-      .patch<T>(url, data, { headers, withCredentials: true })
+      .patch<T>(url, data, { headers, withXSRFToken: true })
       .then((response) => {
         throwIfError(response)
         return this.parseResponse<T>(response)
@@ -413,95 +420,67 @@ export class RequestClient implements HttpClient {
     return bodyLines.join('\n')
   }
 
-  private defaultInterceptionCallBack = (
-    axiosResponse: AxiosResponse | AxiosError
-  ) => {
+  private handleAxiosResponse = (response: AxiosResponse) => {
+    const { status, config, request, data } = response
+
+    const reqHeaders = request?._header ?? 'Not provided\n'
+    const rawHeaders = request?.res?.rawHeaders ?? ['Not provided']
+
+    const resHeaders = this.formatHeaders(rawHeaders)
+    const parsedResBody = this.parseInterceptedBody(data)
+
+    process.logger?.info(`HTTP Request (first 50 lines):
+${reqHeaders}${this.parseInterceptedBody(config.data)}
+
+HTTP Response Code: ${this.prettifyString(status)}
+
+HTTP Response (first 50 lines):
+${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
+`)
+
+    return response
+  }
+
+  private handleAxiosError = (error: AxiosError) => {
     // Message indicating absent value.
     const noValueMessage = 'Not provided'
+    const { response, request, config } = error
 
     // Fallback request object that can be safely used to form request summary.
-    type FallbackRequest = { _header?: string; res: { rawHeaders: string[] } }
     // _header is not present in responses with status 1**
     // rawHeaders are not present in responses with status 1**
-    let fallbackRequest: FallbackRequest = {
+    let fallbackRequest = {
       _header: `${noValueMessage}\n`,
       res: { rawHeaders: [noValueMessage] }
     }
 
-    // Fallback response object that can be safely used to form response summary.
-    type FallbackResponse = {
-      status?: number | string
-      request?: FallbackRequest
-      config: { data?: string }
-      data?: unknown
-    }
-    let fallbackResponse: FallbackResponse = axiosResponse
-
-    if (axios.isAxiosError(axiosResponse)) {
-      const { response, request, config } = axiosResponse
-
-      // Try to use axiosResponse.response to form response summary.
-      if (response) {
-        fallbackResponse = response
-      } else {
-        // Try to use axiosResponse.request to form request summary.
-        if (request) {
-          const { _header, _currentRequest } = request
-
-          // Try to use axiosResponse.request._header to form request summary.
-          if (_header) {
-            fallbackRequest._header = _header
-          }
-          // Try to use axiosResponse.request._currentRequest._header to form request summary.
-          else if (_currentRequest && _currentRequest._header) {
-            fallbackRequest._header = _currentRequest._header
-          }
-
-          const { res } = request
-
-          // Try to use axiosResponse.request.res.rawHeaders to form request summary.
-          if (res && res.rawHeaders) {
-            fallbackRequest.res.rawHeaders = res.rawHeaders
-          }
-        }
-
-        // Fallback config that can be safely used to form response summary.
-        const fallbackConfig = { data: noValueMessage }
-
-        fallbackResponse = {
-          status: noValueMessage,
-          request: fallbackRequest,
-          config: config || fallbackConfig,
-          data: noValueMessage
-        }
+    if (request) {
+      fallbackRequest = {
+        _header:
+          request._header ?? request._currentRequest?._header ?? noValueMessage,
+        res: { rawHeaders: request.res?.rawHeaders ?? [noValueMessage] }
       }
     }
 
-    const { status, config, request, data: resData } = fallbackResponse
-    const { data: reqData } = config
-    const { _header: reqHeaders, res } = request || fallbackRequest
-    const { rawHeaders } = res
-
-    // Converts an array of strings into a single string with the following format:
-    // <headerName>: <headerValue>
-    const resHeaders = rawHeaders.reduce(
-      (acc: string, value: string, i: number) => {
-        if (i % 2 === 0) {
-          acc += `${i === 0 ? '' : '\n'}${value}`
-        } else {
-          acc += `: ${value}`
-        }
-
-        return acc
+    // Fallback response object that can be safely used to form response summary.
+    let fallbackResponse = response || {
+      status: noValueMessage,
+      request: fallbackRequest,
+      config: config || {
+        data: noValueMessage,
+        headers: {} as AxiosRequestHeaders
       },
-      ''
-    )
+      data: noValueMessage
+    }
+
+    const { status, request: req, data: resData } = fallbackResponse
+    const { _header: reqHeaders, res } = req
 
+    const resHeaders = this.formatHeaders(res.rawHeaders)
     const parsedResBody = this.parseInterceptedBody(resData)
 
-    // HTTP response summary.
     process.logger?.info(`HTTP Request (first 50 lines):
-${reqHeaders}${this.parseInterceptedBody(reqData)}
+${reqHeaders}${this.parseInterceptedBody(config?.data)}
 
 HTTP Response Code: ${this.prettifyString(status)}
 
@@ -509,7 +488,20 @@ HTTP Response (first 50 lines):
 ${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
 `)
 
-    return axiosResponse
+    return error
+  }
+
+  // Converts an array of strings into a single string with the following format:
+  // <headerName>: <headerValue>
+  private formatHeaders = (rawHeaders: string[]): string => {
+    return rawHeaders.reduce((acc, value, i) => {
+      if (i % 2 === 0) {
+        acc += `${i === 0 ? '' : '\n'}${value}`
+      } else {
+        acc += `: ${value}`
+      }
+      return acc
+    }, '')
   }
 
   /**
@@ -529,8 +521,8 @@ ${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
    * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
    */
   public enableVerboseMode = (
-    successCallBack = this.defaultInterceptionCallBack,
-    errorCallBack = this.defaultInterceptionCallBack
+    successCallBack = this.handleAxiosResponse,
+    errorCallBack = this.handleAxiosError
   ) => {
     this.httpInterceptor = this.httpClient.interceptors.response.use(
       successCallBack,
@@ -645,7 +637,7 @@ ${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
       // Fetching root and creating CSRF cookie
       await this.httpClient
         .get('/', {
-          withCredentials: true
+          withXSRFToken: true
         })
         .then((response) => {
           const cookie =

package/src/request/Sas9RequestClient.ts

@@ -1,6 +1,6 @@
 import * as https from 'https'
 import { AxiosRequestConfig } from 'axios'
-import axiosCookieJarSupport from 'axios-cookiejar-support'
+import { wrapper } from 'axios-cookiejar-support'
 import * as tough from 'tough-cookie'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient, throwIfError } from './RequestClient'
@@ -17,8 +17,8 @@ export class Sas9RequestClient extends RequestClient {
     this.httpClient.defaults.validateStatus = (status) =>
       status >= 200 && status < 303
 
-    if (axiosCookieJarSupport) {
-      axiosCookieJarSupport(this.httpClient)
+    if (wrapper) {
+      wrapper(this.httpClient)
       this.httpClient.defaults.jar = new tough.CookieJar()
     }
   }
@@ -50,7 +50,7 @@ export class Sas9RequestClient extends RequestClient {
     const requestConfig: AxiosRequestConfig = {
       headers,
       responseType: contentType === 'text/plain' ? 'text' : 'json',
-      withCredentials: true
+      withXSRFToken: true
     }
     if (contentType === 'text/plain') {
       requestConfig.transformResponse = undefined
@@ -103,7 +103,7 @@ export class Sas9RequestClient extends RequestClient {
     }
 
     return this.httpClient
-      .post<T>(url, data, { headers, withCredentials: true })
+      .post<T>(url, data, { headers, withXSRFToken: true })
       .then(async (response) => {
         if (response.status === 302) {
           return await this.get(

package/src/test/SAS_server_app.ts

@@ -1,7 +1,15 @@
 import express = require('express')
+import cors from 'cors'
 
 export const app = express()
 
+app.use(
+  cors({
+    origin: 'http://localhost', // Allow requests only from this origin
+    credentials: true // Allow credentials (cookies, auth headers, etc.)
+  })
+)
+
 export const mockedAuthResponse = {
   access_token: 'access_token',
   token_type: 'bearer',
@@ -12,11 +20,11 @@ export const mockedAuthResponse = {
   jti: 'jti'
 }
 
-app.get('/', function (req: any, res: any) {
+app.get('/', (req: any, res: any) => {
   res.send('Hello World')
 })
 
-app.post('/SASLogon/oauth/token', function (req: any, res: any) {
+app.post('/SASLogon/oauth/token', (req: any, res: any) => {
   let valid = true
 
   // capture the encoded form data

package/src/types/FileResource.ts

@@ -0,0 +1,33 @@
+export interface FileResource {
+  creationTimeStamp: string
+  modifiedTimeStamp: string
+  createdBy: string
+  modifiedBy: string
+  id: string
+  properties: Properties
+  contentDisposition: string
+  contentType: string
+  encoding: string
+  links: Link[]
+  name: string
+  size: number
+  searchable: boolean
+  fileStatus: string
+  fileVersion: number
+  typeDefName: string
+  version: number
+  virusDetected: boolean
+  urlDetected: boolean
+  quarantine: boolean
+}
+
+export interface Link {
+  method: string
+  rel: string
+  href: string
+  uri: string
+  type?: string
+  responseType?: string
+}
+
+export interface Properties {}

package/src/types/WriteStream.ts

@@ -1,4 +1,10 @@
-export interface WriteStream {
-  write: (content: string, callback: (err?: Error) => any) => void
-  path: string
+import { WriteStream as FsWriteStream } from 'fs'
+
+export interface WriteStream extends FsWriteStream {
+  write(
+    chunk: any,
+    encoding?: BufferEncoding | ((error: Error | null | undefined) => void),
+    cb?: (error: Error | null | undefined) => void
+  ): boolean
+  path: string | Buffer
 }

package/src/utils/convertToCsv.ts

@@ -10,10 +10,14 @@ export const convertToCSV = (
   tableName: string
 ) => {
   if (!data[tableName]) {
-    throw prefixMessage(
+    const error = prefixMessage(
       'No table provided to be converted to CSV.',
       'Error while converting to CSV. '
     )
+
+    if (typeof error === 'string') throw new Error(error)
+
+    throw error
   }
 
   const table = data[tableName]

package/src/utils/getFormData.ts

@@ -1,5 +1,5 @@
 import { isNode } from './'
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 
-export const getFormData = () =>
+export const getFormData = (): NodeFormData | FormData =>
   isNode() ? new NodeFormData() : new FormData()

package/src/utils/validateInput.ts

@@ -52,19 +52,22 @@ export const validateInput = (
       }
     }
 
-    for (const item of data[key]) {
-      if (getType(item) !== 'object') {
-        return {
-          status: false,
-          msg: `Table ${key} contains invalid structure. ${MORE_INFO}`
-        }
-      } else {
-        const attributes = Object.keys(item)
-        for (const attribute of attributes) {
-          if (item[attribute] === undefined) {
-            return {
-              status: false,
-              msg: `A row in table ${key} contains invalid value. Can't assign undefined to ${attribute}.`
+    // ES6 is stricter so we had to include the check for the array
+    if (Array.isArray(data[key])) {
+      for (const item of data[key]) {
+        if (getType(item) !== 'object') {
+          return {
+            status: false,
+            msg: `Table ${key} contains invalid structure. ${MORE_INFO}`
+          }
+        } else {
+          const attributes = Object.keys(item)
+          for (const attribute of attributes) {
+            if (item[attribute] === undefined) {
+              return {
+                status: false,
+                msg: `A row in table ${key} contains invalid value. Can't assign undefined to ${attribute}.`
+              }
             }
           }
         }

package/types/FileResource.d.ts

@@ -0,0 +1,32 @@
+export interface FileResource {
+    creationTimeStamp: string;
+    modifiedTimeStamp: string;
+    createdBy: string;
+    modifiedBy: string;
+    id: string;
+    properties: Properties;
+    contentDisposition: string;
+    contentType: string;
+    encoding: string;
+    links: Link[];
+    name: string;
+    size: number;
+    searchable: boolean;
+    fileStatus: string;
+    fileVersion: number;
+    typeDefName: string;
+    version: number;
+    virusDetected: boolean;
+    urlDetected: boolean;
+    quarantine: boolean;
+}
+export interface Link {
+    method: string;
+    rel: string;
+    href: string;
+    uri: string;
+    type?: string;
+    responseType?: string;
+}
+export interface Properties {
+}

package/types/PollOptions.d.ts

@@ -5,4 +5,4 @@ export interface PollOptions {
     streamLog?: boolean;
     logFolderPath?: string;
 }
-export declare type PollStrategy = PollOptions[];
+export type PollStrategy = PollOptions[];

package/types/RequestClient.d.ts

@@ -43,4 +43,4 @@ export interface SasjsParsedResponse<T> {
     status: number;
     printOutput?: string;
 }
-export declare type VerboseMode = boolean | 'bleached';
+export type VerboseMode = boolean | 'bleached';

package/types/WriteStream.d.ts

@@ -1,4 +1,7 @@
-export interface WriteStream {
-    write: (content: string, callback: (err?: Error) => any) => void;
-    path: string;
+/// <reference types="node" />
+/// <reference types="node" />
+import { WriteStream as FsWriteStream } from 'fs';
+export interface WriteStream extends FsWriteStream {
+    write(chunk: any, encoding?: BufferEncoding | ((error: Error | null | undefined) => void), cb?: (error: Error | null | undefined) => void): boolean;
+    path: string | Buffer;
 }

package/types/errors/spec/SAS9AuthError.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/utils/getFormData.d.ts

@@ -1,2 +1,2 @@
-import * as NodeFormData from 'form-data';
+import NodeFormData from 'form-data';
 export declare const getFormData: () => NodeFormData | FormData;

package/utils/spec/parseSasViyaLog.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/utils/spec/parseViyaDebugResponse.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/index-dev.js.LICENSE.txt

@@ -1,110 +0,0 @@
-/*!
- * Copyright (c) 2015, Salesforce.com, Inc.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * 3. Neither the name of Salesforce.com nor the names of its contributors may
- * be used to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-
-/*!
- * Copyright (c) 2015-2020, Salesforce.com, Inc.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * 3. Neither the name of Salesforce.com nor the names of its contributors may
- * be used to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-
-/*!
- * Copyright (c) 2018, Salesforce.com, Inc.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * 3. Neither the name of Salesforce.com nor the names of its contributors may
- * be used to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-
-/*!
- * The buffer module from node.js, for the browser.
- *
- * @author   Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
- * @license  MIT
- */
-
-/*!
- * The buffer module from node.js, for the browser.
- *
- * @author   Feross Aboukhadijeh <https://feross.org>
- * @license  MIT
- */
-
-/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
-
-/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */