@sasjs/adapter 4.11.2 → 4.12.0

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

@@ -1,6 +1,6 @@
 import { AuthConfig, ServerType } from '@sasjs/utils/types';
 import { ExtraResponseAttributes } from '@sasjs/utils/types';
-export declare type ExecuteFunction = () => Promise<any>;
+export type ExecuteFunction = () => Promise<any>;
 export interface JobExecutor {
     execute: (sasJob: string, data: any, config: any, loginRequiredCallback?: any, authConfig?: AuthConfig, extraResponseAttributes?: ExtraResponseAttributes[]) => Promise<any>;
     resendWaitingRequests: () => Promise<void>;

package/node/request/RequestClient.d.ts

@@ -42,6 +42,13 @@ export declare class RequestClient implements HttpClient {
         etag: string;
         status: number;
     }>;
+    /**
+     * @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.
+     */
     post<T>(url: string, data: any, accessToken: string | undefined, contentType?: string, overrideHeaders?: {
         [key: string]: string | number;
     }, additionalSettings?: {
@@ -79,7 +86,9 @@ export declare class RequestClient implements HttpClient {
      * @returns - formatted string.
      */
     private parseInterceptedBody;
-    private defaultInterceptionCallBack;
+    private handleAxiosResponse;
+    private handleAxiosError;
+    private formatHeaders;
     /**
      * Sets verbose mode.
      * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
@@ -90,7 +99,7 @@ export declare class RequestClient implements HttpClient {
      * @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**.
      */
-    enableVerboseMode: (successCallBack?: (axiosResponse: AxiosResponse | AxiosError) => AxiosResponse<any, any> | AxiosError<unknown, any>, errorCallBack?: (axiosResponse: AxiosResponse | AxiosError) => AxiosResponse<any, any> | AxiosError<unknown, any>) => void;
+    enableVerboseMode: (successCallBack?: (response: AxiosResponse) => AxiosResponse<any, any>, errorCallBack?: (error: AxiosError) => AxiosError<unknown, any>) => void;
     /**
      * Turns off verbose mode to log every HTTP response.
      */

package/node/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/node/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/node/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/node/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/node/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/package.json

@@ -45,18 +45,21 @@
   "license": "ISC",
   "devDependencies": {
     "@cypress/webpack-preprocessor": "5.9.1",
+    "@types/cors": "^2.8.17",
     "@types/express": "4.17.13",
-    "@types/jest": "27.4.0",
+    "@types/jest": "29.5.14",
     "@types/mime": "2.0.3",
     "@types/pem": "1.9.6",
     "@types/tough-cookie": "4.0.2",
     "copyfiles": "2.4.1",
+    "cors": "^2.8.5",
     "cp": "0.2.0",
     "cypress": "7.7.0",
     "dotenv": "16.0.0",
     "express": "4.17.3",
-    "jest": "27.4.7",
-    "jest-extended": "2.0.0",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-extended": "4.0.2",
     "node-polyfill-webpack-plugin": "1.1.4",
     "path": "0.12.7",
     "pem": "1.14.5",
@@ -64,24 +67,24 @@
     "process": "0.11.10",
     "semantic-release": "19.0.3",
     "terser-webpack-plugin": "5.3.6",
-    "ts-jest": "27.1.3",
+    "ts-jest": "29.2.6",
     "ts-loader": "9.4.0",
     "tslint": "6.1.3",
     "tslint-config-prettier": "1.18.0",
     "typedoc": "0.23.24",
     "typedoc-plugin-rename-defaults": "0.6.4",
-    "typescript": "4.8.3",
+    "typescript": "4.9.5",
     "webpack": "5.76.2",
     "webpack-cli": "4.9.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^3.5.1",
-    "axios": "0.27.2",
-    "axios-cookiejar-support": "1.0.1",
+    "@sasjs/utils": "3.5.2",
+    "axios": "1.8.2",
+    "axios-cookiejar-support": "5.0.5",
     "form-data": "4.0.0",
     "https": "1.0.0",
     "tough-cookie": "4.1.3"
   },
-  "version": "4.11.2"
+  "version": "4.12.0"
 }

package/request/RequestClient.d.ts

@@ -42,6 +42,13 @@ export declare class RequestClient implements HttpClient {
         etag: string;
         status: number;
     }>;
+    /**
+     * @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.
+     */
     post<T>(url: string, data: any, accessToken: string | undefined, contentType?: string, overrideHeaders?: {
         [key: string]: string | number;
     }, additionalSettings?: {
@@ -79,7 +86,9 @@ export declare class RequestClient implements HttpClient {
      * @returns - formatted string.
      */
     private parseInterceptedBody;
-    private defaultInterceptionCallBack;
+    private handleAxiosResponse;
+    private handleAxiosError;
+    private formatHeaders;
     /**
      * Sets verbose mode.
      * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
@@ -90,7 +99,7 @@ export declare class RequestClient implements HttpClient {
      * @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**.
      */
-    enableVerboseMode: (successCallBack?: (axiosResponse: AxiosResponse | AxiosError) => AxiosResponse<any, any> | AxiosError<unknown, any>, errorCallBack?: (axiosResponse: AxiosResponse | AxiosError) => AxiosResponse<any, any> | AxiosError<unknown, any>) => void;
+    enableVerboseMode: (successCallBack?: (response: AxiosResponse) => AxiosResponse<any, any>, errorCallBack?: (error: AxiosError) => AxiosError<unknown, any>) => void;
     /**
      * Turns off verbose mode to log every HTTP response.
      */

package/spec/SAS9ApiClient.spec.d.ts

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

package/spec/SASjsApiClient.spec.d.ts

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

package/src/SAS9ApiClient.ts

@@ -1,6 +1,6 @@
 import * as https from 'https'
 import { generateTimestamp } from '@sasjs/utils/time'
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import { Sas9RequestClient } from './request/Sas9RequestClient'
 import { isUrl } from './utils'
 

package/src/SASViyaApiClient.ts

@@ -1,5 +1,5 @@
 import { isRelativePath, isUri, isUrl } from './utils'
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import {
   Job,
   Session,
@@ -28,6 +28,7 @@ import { uploadTables } from './api/viya/uploadTables'
 import { executeOnComputeApi } from './api/viya/executeOnComputeApi'
 import { getAccessTokenForViya } from './auth/getAccessTokenForViya'
 import { refreshTokensForViya } from './auth/refreshTokensForViya'
+import { FileResource } from './types/FileResource'
 
 interface JobExecutionResult {
   result?: { result: object }
@@ -311,6 +312,84 @@ export class SASViyaApiClient {
     )
   }
 
+  /**
+   * Fetches the file content for a file in the specified folder.
+   *
+   * @param folderPath - the full path to the folder containing the file. eg: /Public/folder1/folder2
+   * @param fileName - the name of the file in the `folderPath`
+   * @param accessToken - an access token for authorizing the request
+   */
+  public async getFileContent(
+    folderPath: string,
+    fileName: string,
+    accessToken?: string
+  ) {
+    const fileUri = await this.getFileUri(
+      folderPath,
+      fileName,
+      accessToken
+    ).catch((err) => {
+      throw prefixMessage(
+        err,
+        `Error while getting file URI for: ${fileName} in folder: ${folderPath}. `
+      )
+    })
+
+    return await this.requestClient
+      .get<string>(`${this.serverUrl}${fileUri}/content`, accessToken)
+      .then((res) => res.result)
+  }
+
+  /**
+   * Updates the file content for a file in the specified folder.
+   *
+   * @param folderPath - the full path to the folder containing the file. eg: /Public/folder1/folder2
+   * @param fileName - the name of the file in the `folderPath`
+   * @param content - the new content to be written to the file
+   * @param accessToken - an access token for authorizing the request
+   */
+  public async updateFileContent(
+    folderPath: string,
+    fileName: string,
+    content: string,
+    accessToken?: string
+  ) {
+    const fileUri = await this.getFileUri(
+      folderPath,
+      fileName,
+      accessToken
+    ).catch((err) => {
+      throw prefixMessage(
+        err,
+        `Error while getting file URI for: ${fileName} in folder: ${folderPath}. `
+      )
+    })
+
+    // Fetch the file resource details to get the Etag and content type
+    const { result: originalFileResource, etag } =
+      await this.requestClient.get<FileResource>(
+        `${this.serverUrl}${fileUri}`,
+        accessToken
+      )
+
+    if (!originalFileResource || !etag)
+      throw new Error(
+        `File ${fileName} does not have an ETag, or request failed.`
+      )
+
+    return await this.requestClient
+      .put<FileResource>(
+        `${this.serverUrl}${fileUri}/content`,
+        content,
+        accessToken,
+        {
+          'If-Match': etag,
+          'Content-Type': originalFileResource.contentType
+        }
+      )
+      .then((res) => res.result)
+  }
+
   /**
    * Fetches a folder. Path to the folder is required.
    * @param folderPath - the absolute path to the folder.
@@ -941,6 +1020,7 @@ export class SASViyaApiClient {
       })
 
     if (!folder) return undefined
+
     return folder
   }
 
@@ -952,6 +1032,30 @@ export class SASViyaApiClient {
     return `/folders/folders/${folderDetails.id}`
   }
 
+  private async getFileUri(
+    folderPath: string,
+    fileName: string,
+    accessToken?: string
+  ): Promise<string> {
+    const folderMembers = await this.listFolder(folderPath, accessToken, 1000, {
+      returnDetails: true
+    }).catch((err) => {
+      throw prefixMessage(err, `Error while listing folder: ${folderPath}. `)
+    })
+
+    if (!folderMembers || !folderMembers.length)
+      throw new Error(`No members found in folder: ${folderPath}`)
+
+    const fileUri = folderMembers.find(
+      (member) => member.name === fileName
+    )?.uri
+
+    if (!fileUri)
+      throw new Error(`File ${fileName} not found in folder: ${folderPath}`)
+
+    return fileUri
+  }
+
   private async getRecycleBinUri(accessToken?: string) {
     const url = '/folders/folders/@myRecycleBin'
 
@@ -999,14 +1103,19 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Lists children folders for given Viya folder.
+   * Lists children folders/files for given Viya folder.
    * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder listed. Providing URI instead of path will save one extra request.
    * @param accessToken - an access token for authorizing the request.
+   * @param {Object} [options] - Additional options.
+   * @param {boolean} [options.returnDetails=false] - when set to true, the function will return an array of objects with member details, otherwise it will return an array of member names.
    */
   public async listFolder(
     sourceFolder: string,
     accessToken?: string,
-    limit: number = 20
+    limit: number = 20,
+    options?: {
+      returnDetails?: boolean
+    }
   ) {
     // checks if 'sourceFolder' is already a URI
     const sourceFolderUri = isUri(sourceFolder)
@@ -1018,11 +1127,20 @@ export class SASViyaApiClient {
       accessToken
     )
 
+    let membersToReturn = []
+
     if (members && members.items) {
-      return members.items.map((item: any) => item.name)
-    } else {
-      return []
+      // If returnDetails is true, return full member details
+      if (options?.returnDetails) {
+        membersToReturn = members.items
+      } else {
+        // If returnDetails is false, return only member names
+        membersToReturn = members.items.map((item: any) => item.name)
+      }
     }
+
+    // Return members without Etag
+    return membersToReturn
   }
 
   /**

package/src/SASjs.ts

@@ -411,6 +411,51 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Fetches the file content for a file in the specified folder.
+   *
+   * @param folderPath - the full path to the folder containing the file. eg: /Public/folder1/folder2
+   * @param fileName - the name of the file in the `folderPath`
+   * @param accessToken - an access token for authorizing the request
+   */
+  public async getFileContent(
+    folderPath: string,
+    fileName: string,
+    accessToken?: string
+  ) {
+    this.isMethodSupported('getFileContent', [ServerType.SasViya])
+
+    return await this.sasViyaApiClient!.getFileContent(
+      folderPath,
+      fileName,
+      accessToken
+    )
+  }
+
+  /**
+   * Updates the file content for a file in the specified folder.
+   *
+   * @param folderPath - the full path to the folder containing the file. eg: /Public/folder1/folder2
+   * @param fileName - the name of the file in the `folderPath`
+   * @param content - the new content to be written to the file
+   * @param accessToken - an access token for authorizing the request
+   */
+  public async updateFileContent(
+    folderPath: string,
+    fileName: string,
+    content: string,
+    accessToken?: string
+  ) {
+    this.isMethodSupported('updateFileContent', [ServerType.SasViya])
+
+    return await this.sasViyaApiClient!.updateFileContent(
+      folderPath,
+      fileName,
+      content,
+      accessToken
+    )
+  }
+
   /**
    * Fetches a folder from the SAS file system.
    * @param folderPath - path of the folder to be fetched.
@@ -436,18 +481,23 @@ export default class SASjs {
    * Lists children folders for given Viya folder.
    * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder listed. Providing URI instead of path will save one extra request.
    * @param accessToken - an access token for authorizing the request.
+   * @param returnDetails - when set to true, the function will return an array of objects with member details, otherwise it will return an array of member names.
    */
   public async listFolder(
     sourceFolder: string,
     accessToken?: string,
-    limit?: number
+    limit?: number,
+    returnDetails = false
   ) {
     this.isMethodSupported('listFolder', [ServerType.SasViya])
 
     return await this.sasViyaApiClient?.listFolder(
       sourceFolder,
       accessToken,
-      limit
+      limit,
+      {
+        returnDetails
+      }
     )
   }
 
@@ -1170,8 +1220,8 @@ export default class SASjs {
    * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
    */
   public enableVerboseMode(
-    successCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse,
-    errorCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse
+    successCallBack?: (response: AxiosResponse) => AxiosResponse,
+    errorCallBack?: (response: AxiosError) => AxiosError
   ) {
     this.requestClient?.enableVerboseMode(successCallBack, errorCallBack)
   }

package/src/SASjsApiClient.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import { AuthConfig, ServerType, ServicePackSASjs } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import { ExecutionQuery } from './types'

package/src/api/viya/writeStream.ts

@@ -3,9 +3,14 @@ import { WriteStream } from '../../types'
 export const writeStream = async (
   stream: WriteStream,
   content: string
-): Promise<void> =>
-  stream.write(content + '\n', (e: any) => {
-    if (e) return Promise.reject(e)
-
-    return Promise.resolve()
+): Promise<boolean> => {
+  return new Promise((resolve, reject) => {
+    stream.write(content + '\n', (err: Error | null | undefined) => {
+      if (err) {
+        reject(err) // Reject on write error
+      } else {
+        resolve(true) // Resolve on successful write
+      }
+    })
   })
+}

package/src/auth/refreshTokensForViya.ts

@@ -1,6 +1,6 @@
 import { SasAuthResponse, ServerType } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import { RequestClient } from '../request/RequestClient'
 import { isNode } from '../utils'
 import { getTokenRequestErrorPrefix } from './getTokenRequestErrorPrefix'

package/src/file/generateFileUploadForm.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import { convertToCSV } from '../utils/convertToCsv'
 import { isNode } from '../utils'
 

package/src/file/generateTableUploadForm.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import { convertToCSV, isFormatsTable } from '../utils/convertToCsv'
 import { splitChunks } from '../utils/splitChunks'
 

package/src/job-execution/Sas9JobExecutor.ts

@@ -1,6 +1,6 @@
 import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import { ErrorResponse } from '../types/errors'
 import { convertToCSV, isRelativePath } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'

package/src/job-execution/SasjsJobExecutor.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import {
   AuthConfig,
   ExtraResponseAttributes,
@@ -73,8 +73,10 @@ export class SasjsJobExecutor extends BaseJobExecutor {
     /* The NodeFormData object does not set the request header - so, set it */
     const contentType =
       formData instanceof NodeFormData && typeof FormData === 'undefined'
-        ? `multipart/form-data; boundary=${formData.getBoundary()}`
-        : undefined
+        ? `multipart/form-data; boundary=${
+            formData.getHeaders()['content-type']
+          }`
+        : 'multipart/form-data'
 
     const requestPromise = new Promise((resolve, reject) => {
       this.requestClient!.post(

package/src/job-execution/WebJobExecutor.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data'
+import NodeFormData from 'form-data'
 import {
   AuthConfig,
   ExtraResponseAttributes,
@@ -150,8 +150,10 @@ export class WebJobExecutor extends BaseJobExecutor {
     /* The NodeFormData object does not set the request header - so, set it */
     const contentType =
       formData instanceof NodeFormData && typeof FormData === 'undefined'
-        ? `multipart/form-data; boundary=${formData.getBoundary()}`
-        : undefined
+        ? `multipart/form-data; boundary=${
+            formData.getHeaders()['content-type']
+          }`
+        : 'multipart/form-data'
 
     const requestPromise = new Promise((resolve, reject) => {
       this.requestClient!.post(