@sasjs/adapter 4.11.3 → 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;
@@ -54,12 +55,6 @@ export declare class SASViyaApiClient {
      * @param accessToken - an access token for an authorized user.
      */
     getComputeContexts(accessToken?: string): Promise<{
-        /**
-         * A helper method used to call appendRequest method of RequestClient
-         * @param response - response from sasjs request
-         * @param program - name of program
-         * @param debug - a boolean that indicates whether debug was enabled or not
-         */
         createdBy: any;
         id: any;
         name: any;
@@ -144,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.
@@ -238,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.
@@ -253,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.