@sasjs/adapter 4.11.2 → 4.12.0

package/SASViyaApiClient.d.ts

@@ -2,6 +2,7 @@
 import { Job, Session, Context, ContextAllAttributes, Folder, File, EditContextInput, PollOptions } from './types';
 import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types';
 import { RequestClient } from './request/RequestClient';
+import { FileResource } from './types/FileResource';
 interface JobExecutionResult {
     result?: {
         result: object;
@@ -138,6 +139,23 @@ export declare class SASViyaApiClient {
      * @param variables - an object that represents macro variables.
      */
     executeScript(jobPath: string, linesOfCode: string[], contextName: string, authConfig?: AuthConfig, data?: null, debug?: boolean, expectWebout?: boolean, waitForResult?: boolean, pollOptions?: PollOptions, printPid?: boolean, variables?: MacroVar): Promise<any>;
+    /**
+     * 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
+     */
+    getFileContent(folderPath: string, fileName: string, accessToken?: string): Promise<string>;
+    /**
+     * 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
+     */
+    updateFileContent(folderPath: string, fileName: string, content: string, accessToken?: string): Promise<FileResource>;
     /**
      * Fetches a folder. Path to the folder is required.
      * @param folderPath - the absolute path to the folder.
@@ -232,6 +250,7 @@ export declare class SASViyaApiClient {
     private uploadTables;
     private getFolderDetails;
     private getFolderUri;
+    private getFileUri;
     private getRecycleBinUri;
     /**
      * Returns a JSON representation of a compute context.
@@ -247,11 +266,15 @@ export declare class SASViyaApiClient {
      */
     getComputeContextById(contextId: string, accessToken?: string): Promise<ContextAllAttributes>;
     /**
-     * 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.
      */
-    listFolder(sourceFolder: string, accessToken?: string, limit?: number): Promise<any[]>;
+    listFolder(sourceFolder: string, accessToken?: string, limit?: number, options?: {
+        returnDetails?: boolean;
+    }): Promise<any[]>;
     /**
      * Moves Viya folder to a new location.  The folder may be renamed at the same time.
      * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.

package/SASjs.d.ts

@@ -157,6 +157,23 @@ export default class SASjs {
      * @param sasApiClient - a client for interfacing with SAS API.
      */
     createFile(fileName: string, content: Buffer, parentFolderPath: string, parentFolderUri?: string, accessToken?: string, sasApiClient?: SASViyaApiClient): Promise<import("./types").File>;
+    /**
+     * 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
+     */
+    getFileContent(folderPath: string, fileName: string, accessToken?: string): Promise<string>;
+    /**
+     * 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
+     */
+    updateFileContent(folderPath: string, fileName: string, content: string, accessToken?: string): Promise<import("./types/FileResource").FileResource>;
     /**
      * Fetches a folder from the SAS file system.
      * @param folderPath - path of the folder to be fetched.
@@ -173,8 +190,9 @@ 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.
      */
-    listFolder(sourceFolder: string, accessToken?: string, limit?: number): Promise<any[] | undefined>;
+    listFolder(sourceFolder: string, accessToken?: string, limit?: number, returnDetails?: boolean): Promise<any[] | undefined>;
     /**
      * Moves folder to a new location.  The folder may be renamed at the same time.
      * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.
@@ -343,7 +361,7 @@ export default class SASjs {
      * @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?: (response: AxiosResponse | AxiosError) => AxiosResponse, errorCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse): void;
+    enableVerboseMode(successCallBack?: (response: AxiosResponse) => AxiosResponse, errorCallBack?: (response: AxiosError) => AxiosError): void;
     /**
      * Turns off verbose mode to log every HTTP response.
      */

package/api/viya/writeStream.d.ts

@@ -1,2 +1,2 @@
 import { WriteStream } from '../../types';
-export declare const writeStream: (stream: WriteStream, content: string) => Promise<void>;
+export declare const writeStream: (stream: WriteStream, content: string) => Promise<boolean>;

package/auth/getTokenRequestErrorPrefix.d.ts

@@ -1,6 +1,6 @@
 import { ServerType } from '@sasjs/utils/types';
-declare type Server = ServerType.SasViya | ServerType.Sasjs;
-declare type Operation = 'fetching access token' | 'refreshing tokens';
+type Server = ServerType.SasViya | ServerType.Sasjs;
+type Operation = 'fetching access token' | 'refreshing tokens';
 /**
  * Forms error prefix for requests related to token operations.
  * @param operation - string describing operation ('fetching access token' or 'refreshing tokens').

package/file/generateFileUploadForm.d.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data';
+import NodeFormData from 'form-data';
 /**
  * One of the approaches SASjs takes to send tables-formatted JSON (see README)
  * to SAS is as multipart form data, where each table is provided as a specially

package/file/generateTableUploadForm.d.ts

@@ -1,4 +1,4 @@
-import * as NodeFormData from 'form-data';
+import NodeFormData from 'form-data';
 export declare const generateTableUploadForm: (formData: FormData | NodeFormData, data: any) => {
     formData: NodeFormData | FormData;
     requestParams: any;