feat: Data set and USS download commands

packages/zowe-explorer-api/CHANGELOG.md

@@ -24,6 +24,9 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
 - Added support for loading credential manager options from the `imperative.json` file. Added a `credentialManagerOptions` object in the JSON object in `imperative.json` to specify options for the current credential manager. [#3935](https://github.com/zowe/zowe-explorer-vscode/pull/3935)
 - Added support for custom persistence levels for Windows (persist option) to support the credential manager in less permissive environments. For more information on how to configure this option, see the "Troubleshooting Zowe CLI credentials" on [Zowe Docs](https://docs.zowe.org/stable/troubleshoot/cli/troubleshoot-cli-credentials/#secrets-sdk-persistence-level-for-windows). [#3935](https://github.com/zowe/zowe-explorer-vscode/pull/3935)
 - Added a new filesystem helper function named `getApiOrThrowUnavailable` for generalized error handling with API access. When the given API getter fails due to a non-existing profile, an `Unavailable` FileSystemError is thrown with additional context on the encountered error. [#3962](https://github.com/zowe/zowe-explorer-vscode/pull/3962)
+- Added support for `downloadDirectory` to the `MainframeInteraction` namespace. `downloadDirectory` is for downloading the contents of a USS directory based on a number of options and filters. [#3843](https://github.com/zowe/zowe-explorer-vscode/pull/3843)
+- Added support for `downloadAllMembers` to the `MainframeInteraction` namespace. `downloadAllMembers` is for downloading all members of a PDS based on a number of options. [#3843](https://github.com/zowe/zowe-explorer-vscode/pull/3843)
+- Added support for calling `UssApi.fileList` with the `zosfiles.IUSSListOptions` interface, which provides filters for listing USS files. [#3843](https://github.com/zowe/zowe-explorer-vscode/pull/3843)
 
 ### Bug fixes
 

packages/zowe-explorer-api/__tests__/__unit__/profiles/ZoweExplorerZosmfApi.unit.test.ts

@@ -457,6 +457,12 @@ describe("ZosmfUssApi", () => {
             spy: jest.spyOn(zosfiles.Download, "ussFile"),
             args: ["ussPath", fakeProperties],
         },
+        {
+            name: "downloadDirectory",
+            spy: jest.spyOn(zosfiles.Download, "ussDir"),
+            args: ["ussDirectoryPath", fakeProperties, undefined],
+            transform: (args) => [args[0], fakeProperties, args[2]],
+        },
         {
             name: "putContent",
             spy: jest.spyOn(zosfiles.Upload, "fileToUssFile"),
@@ -513,6 +519,11 @@ describe("ZosmfMvsApi", () => {
             spy: jest.spyOn(zosfiles.Download, "dataSet"),
             args: ["dsname", fakeProperties],
         },
+        {
+            name: "downloadAllMembers",
+            spy: jest.spyOn(zosfiles.Download, "allMembers"),
+            args: ["dsname", fakeProperties],
+        },
         {
             name: "putContents",
             spy: jest.spyOn(zosfiles.Upload, "pathToDataSet"),

packages/zowe-explorer-api/src/extend/MainframeInteraction.ts

@@ -96,7 +96,7 @@ export namespace MainframeInteraction {
          *     as well as the list of results in apiResponse.items with
          *     minimal properties name, mode.
          */
-        fileList(ussFilePath: string): Promise<zosfiles.IZosFilesResponse>;
+        fileList(ussFilePath: string, options?: zosfiles.IUSSListOptions): Promise<zosfiles.IZosFilesResponse>;
 
         /**
          * Check th USS chtag to see if a file requires conversion.
@@ -119,9 +119,24 @@ export namespace MainframeInteraction {
          *
          * @param {string} ussFilePath
          * @param {zosfiles.IDownloadOptions} options
+         * @returns {Promise<zosfiles.IZosFilesResponse>}
          */
         getContents(ussFilePath: string, options: zosfiles.IDownloadSingleOptions): Promise<zosfiles.IZosFilesResponse>;
 
+        /**
+         * Download a USS directory to the local file system.
+         *
+         * @param {string} ussDirectoryPath The path of the USS directory to download
+         * @param {zosfiles.IDownloadOptions} fileOptions Download options including local directory path
+         * @param {zosfiles.IUSSListOptions} listOptions Options for listing files in USS
+         * @returns {Promise<zosfiles.IZosFilesResponse>}
+         */
+        downloadDirectory?(
+            ussDirectoryPath: string,
+            fileOptions?: zosfiles.IDownloadOptions,
+            listOptions?: zosfiles.IUSSListOptions
+        ): Promise<zosfiles.IZosFilesResponse>;
+
         /**
          * Uploads a given buffer as the contents of a file on USS.
          * @param {Buffer} buffer
@@ -235,6 +250,15 @@ export namespace MainframeInteraction {
          */
         getContents(dataSetName: string, options?: zosfiles.IDownloadSingleOptions): Promise<zosfiles.IZosFilesResponse>;
 
+        /**
+         * Retrieve all members of a partitioned data set and save them to a directory.
+         *
+         * @param {string} dataSetName
+         * @param {zosfiles.IDownloadOptions} [options]
+         * @returns {Promise<zosfiles.IZosFilesResponse>}
+         */
+        downloadAllMembers?(dataSetName: string, options?: zosfiles.IDownloadOptions): Promise<zosfiles.IZosFilesResponse>;
+
         /**
          * Uploads a given buffer as the contents of a file to a data set or member.
          *

packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts

@@ -114,8 +114,11 @@ import { IDataSetCount } from "../dataset/IDataSetCount";
      * An implementation of the Zowe Explorer USS API interface for zOSMF.
      */
     export class UssApi extends CommonApi implements MainframeInteraction.IUss {
-        public fileList(ussFilePath: string): Promise<zosfiles.IZosFilesResponse> {
-            return zosfiles.List.fileList(this.getSession(), ussFilePath, { responseTimeout: this.profile?.profile?.responseTimeout });
+        public fileList(ussFilePath: string, options?: zosfiles.IUSSListOptions): Promise<zosfiles.IZosFilesResponse> {
+            return zosfiles.List.fileList(this.getSession(), ussFilePath, {
+                responseTimeout: this.profile?.profile?.responseTimeout,
+                ...options,
+            });
         }
 
         public isFileTagBinOrAscii(ussFilePath: string): Promise<boolean> {
@@ -129,6 +132,22 @@ import { IDataSetCount } from "../dataset/IDataSetCount";
             });
         }
 
+        public downloadDirectory(
+            ussDirectoryPath: string,
+            fileOptions?: zosfiles.IDownloadOptions,
+            listOptions?: zosfiles.IUSSListOptions
+        ): Promise<zosfiles.IZosFilesResponse> {
+            return zosfiles.Download.ussDir(
+                this.getSession(),
+                ussDirectoryPath,
+                {
+                    responseTimeout: this.profile?.profile?.responseTimeout,
+                    ...fileOptions,
+                },
+                listOptions
+            );
+        }
+
         public copy(outputPath: string, options?: Omit<object, "request">): Promise<Buffer> {
             return zosfiles.Utilities.putUSSPayload(this.getSession(), outputPath, { ...options, request: "copy" });
         }
@@ -260,6 +279,13 @@ import { IDataSetCount } from "../dataset/IDataSetCount";
             });
         }
 
+        public downloadAllMembers(dataSetName: string, options?: zosfiles.IDownloadOptions): Promise<zosfiles.IZosFilesResponse> {
+            return zosfiles.Download.allMembers(this.getSession(), dataSetName, {
+                responseTimeout: this.profile?.profile?.responseTimeout,
+                ...options,
+            });
+        }
+
         public uploadFromBuffer(buffer: Buffer, dataSetName: string, options?: zosfiles.IUploadOptions): Promise<zosfiles.IZosFilesResponse> {
             return zosfiles.Upload.bufferToDataSet(this.getSession(), buffer, dataSetName, {
                 responseTimeout: this.profile?.profile?.responseTimeout,

packages/zowe-explorer-api/src/tree/IZoweTreeNode.ts

@@ -30,7 +30,11 @@ interface OtherEncoding {
     codepage: string;
 }
 
-export type ZosEncoding = TextEncoding | BinaryEncoding | OtherEncoding;
+interface AutoDetectEncoding {
+    kind: "auto-detect";
+}
+
+export type ZosEncoding = TextEncoding | BinaryEncoding | OtherEncoding | AutoDetectEncoding;
 
 export type EncodingMap = Record<string, ZosEncoding>;
 

packages/zowe-explorer/CHANGELOG.md

@@ -36,6 +36,7 @@ All notable changes to the "vscode-extension-for-zowe" extension will be documen
 - Added support for loading credential manager options from the imperative.json file. Add a `credentialManagerOptions` object in the JSON object in `imperative.json` to specify options for the current credential manager. [#3935](https://github.com/zowe/zowe-explorer-vscode/pull/3935)
 - Added support for custom persistence levels for Windows (persist option) to support the credential manager in less permissive environments. For more information on how to configure this option, refer to the ["Troubleshooting Zowe CLI credentials"](https://docs.zowe.org/stable/troubleshoot/cli/troubleshoot-cli-credentials/#secrets-sdk-persistence-level-for-windows) page on Zowe Docs. [#3935](https://github.com/zowe/zowe-explorer-vscode/pull/3935)
 - Updated minimum VS Code version from 1.79 to 1.90. We are dropping support for VS Code releases that bundle versions of Node.js no longer receiving security updates. [#3684](https://github.com/zowe/zowe-explorer-vscode/issues/3684)
+- Added support for downloading data sets, data set members, USS files, and USS directories. [#3843](https://github.com/zowe/zowe-explorer-vscode/pull/3843)
 
 ### Bug fixes
 

packages/zowe-explorer/__tests__/__mocks__/@zowe/zos-files-for-zowe-sdk.ts

@@ -187,4 +187,9 @@ export class IZosFilesResponse {
     public apiResponse?: any;
 }
 
+export class ZosFilesUtils {
+    public static getDirsFromDataSet = jest.fn().mockReturnValue("test/dataset/path");
+    public static DEFAULT_FILE_EXTENSION = "txt";
+}
+
 export const { Copy } = jest.requireActual("@zowe/zos-files-for-zowe-sdk");

packages/zowe-explorer/__tests__/__mocks__/vscode.ts

@@ -1651,7 +1651,9 @@ export interface TextDocument {
 export class Uri {
     private static _regexp = /^(([^:/?#]+?):)?(\/\/([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?/;
     public static file(path: string): Uri {
-        return Uri.parse(path);
+        const uri = Uri.parse(path);
+        uri.fsPath = path;
+        return uri;
     }
     public static parse(value: string, _strict?: boolean): Uri {
         const match = Uri._regexp.exec(value);

packages/zowe-explorer/__tests__/__unit__/extension.unit.test.ts

@@ -186,6 +186,9 @@ async function createGlobalMocks() {
             "zowe.ds.tableView",
             "zowe.ds.listDataSets",
             "zowe.ds.setDataSetFilter",
+            "zowe.ds.downloadAllMembers",
+            "zowe.ds.downloadMember",
+            "zowe.ds.downloadDataSet",
             "zowe.uss.addSession",
             "zowe.uss.refreshAll",
             "zowe.uss.refresh",
@@ -202,6 +205,8 @@ async function createGlobalMocks() {
             "zowe.uss.uploadDialog",
             "zowe.uss.uploadDialogBinary",
             "zowe.uss.uploadDialogWithEncoding",
+            "zowe.uss.downloadFile",
+            "zowe.uss.downloadDirectory",
             "zowe.uss.copyPath",
             "zowe.uss.editFile",
             "zowe.uss.editAttributes",