@zowe/cli 7.16.6 → 7.18.0

package/lib/zosfiles/download/uss/UssFile.handler.js

@@ -40,7 +40,8 @@ class UssFileHandler extends ZosFilesBase_handler_1.ZosFilesBaseHandler {
                 encoding: commandParameters.arguments.encoding,
                 file: commandParameters.arguments.file,
                 task,
-                responseTimeout: commandParameters.arguments.responseTimeout
+                responseTimeout: commandParameters.arguments.responseTimeout,
+                overwrite: commandParameters.arguments.overwrite
             });
         });
     }

package/lib/zosfiles/download/uss/UssFile.handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"UssFile.handler.js","sourceRoot":"","sources":["../../../../src/zosfiles/download/uss/UssFile.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;AAEF,qEAAiE;AACjE,iDAAmG;AACnG,yEAA2E;AAE3E;;;GAGG;AACH,MAAqB,cAAe,SAAQ,0CAAmB;IAC9C,kBAAkB,CAAC,iBAAqC,EAAE,OAAwB;;YAC3F,MAAM,IAAI,GAAoB;gBAC1B,eAAe,EAAE,CAAC;gBAClB,aAAa,EAAE,sBAAsB;gBACrC,SAAS,EAAE,sBAAS,CAAC,WAAW;aACnC,CAAC;YACF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC;YACrD,OAAO,iCAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,WAAW,EAAE;gBACtE,MAAM,EAAE,iBAAiB,CAAC,SAAS,CAAC,MAAM;gBAC1C,QAAQ,EAAE,iBAAiB,CAAC,SAAS,CAAC,QAAQ;gBAC9C,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC,IAAI;gBACtC,IAAI;gBACJ,eAAe,EAAE,iBAAiB,CAAC,SAAS,CAAC,eAAe;aAC/D,CAAC,CAAC;QACP,CAAC;KAAA;CACJ;AAhBD,iCAgBC"}
+{"version":3,"file":"UssFile.handler.js","sourceRoot":"","sources":["../../../../src/zosfiles/download/uss/UssFile.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;AAEF,qEAAiE;AACjE,iDAAmG;AACnG,yEAA2E;AAE3E;;;GAGG;AACH,MAAqB,cAAe,SAAQ,0CAAmB;IAC9C,kBAAkB,CAAC,iBAAqC,EAAE,OAAwB;;YAC3F,MAAM,IAAI,GAAoB;gBAC1B,eAAe,EAAE,CAAC;gBAClB,aAAa,EAAE,sBAAsB;gBACrC,SAAS,EAAE,sBAAS,CAAC,WAAW;aACnC,CAAC;YACF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC;YACrD,OAAO,iCAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,WAAW,EAAE;gBACtE,MAAM,EAAE,iBAAiB,CAAC,SAAS,CAAC,MAAM;gBAC1C,QAAQ,EAAE,iBAAiB,CAAC,SAAS,CAAC,QAAQ;gBAC9C,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC,IAAI;gBACtC,IAAI;gBACJ,eAAe,EAAE,iBAAiB,CAAC,SAAS,CAAC,eAAe;gBAC5D,SAAS,EAAE,iBAAiB,CAAC,SAAS,CAAC,SAAS;aACnD,CAAC,CAAC;QACP,CAAC;KAAA;CACJ;AAjBD,iCAiBC"}

package/lib/zosfiles/edit/Edit.definition.d.ts

@@ -0,0 +1,6 @@
+import { ICommandDefinition } from "@zowe/imperative";
+/**
+ * Edit group definition containing its description and children
+ * @type {ICommandDefinition}
+ */
+export declare const EditDefinition: ICommandDefinition;

package/lib/zosfiles/edit/Edit.definition.js

@@ -0,0 +1,33 @@
+"use strict";
+/*
+* This program and the accompanying materials are made available under the terms of the
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright Contributors to the Zowe Project.
+*
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditDefinition = void 0;
+const Dataset_definition_1 = require("./ds/Dataset.definition");
+const USSFile_definition_1 = require("./uss/USSFile.definition");
+// Does not use the import in anticipation of some internationalization work to be done later.
+const strings = require("../-strings-/en").default.EDIT;
+/**
+ * Edit group definition containing its description and children
+ * @type {ICommandDefinition}
+ */
+exports.EditDefinition = {
+    name: "edit",
+    aliases: ["ed"],
+    type: "group",
+    summary: strings.SUMMARY,
+    description: strings.DESCRIPTION,
+    children: [
+        Dataset_definition_1.DatasetDefinition,
+        USSFile_definition_1.USSFileDefinition
+    ],
+};
+//# sourceMappingURL=Edit.definition.js.map

package/lib/zosfiles/edit/Edit.definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Edit.definition.js","sourceRoot":"","sources":["../../../src/zosfiles/edit/Edit.definition.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;AAGF,gEAA0D;AAG1D,iEAA2D;AAE3D,8FAA8F;AAC9F,MAAM,OAAO,GAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAA8B,CAAC,IAAI,CAAC;AAEhF;;;GAGG;AACU,QAAA,cAAc,GAAuB;IAC9C,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,CAAC,IAAI,CAAC;IACf,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,OAAO,CAAC,OAAO;IACxB,WAAW,EAAE,OAAO,CAAC,WAAW;IAChC,QAAQ,EAAE;QACN,sCAAiB;QACjB,sCAAiB;KACpB;CACJ,CAAC"}

package/lib/zosfiles/edit/Edit.handler.d.ts

@@ -0,0 +1,10 @@
+import { AbstractSession, IHandlerParameters } from "@zowe/imperative";
+import { IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
+import { ZosFilesBaseHandler } from "../ZosFilesBase.handler";
+/**
+ * Handler to Edit USS or DS content locally
+ * @export
+ */
+export default class EditHandler extends ZosFilesBaseHandler {
+    processWithSession(commandParameters: IHandlerParameters, session: AbstractSession): Promise<IZosFilesResponse>;
+}

package/lib/zosfiles/edit/Edit.handler.js

@@ -0,0 +1,111 @@
+"use strict";
+/*
+* This program and the accompanying materials are made available under the terms of the
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright Contributors to the Zowe Project.
+*
+*/
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const imperative_1 = require("@zowe/imperative");
+const ZosFilesBase_handler_1 = require("../ZosFilesBase.handler");
+const Edit_utils_1 = require("../edit/Edit.utils");
+/**
+ * Handler to Edit USS or DS content locally
+ * @export
+ */
+class EditHandler extends ZosFilesBase_handler_1.ZosFilesBaseHandler {
+    processWithSession(commandParameters, session) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // Setup - build temp and check for stash
+            let lfFile = {
+                tempPath: null,
+                fileName: (_a = commandParameters.arguments.ussFilePath) !== null && _a !== void 0 ? _a : commandParameters.arguments.dataSetName,
+                fileType: commandParameters.positionals[2].includes('d') ? "ds" : "uss",
+                guiAvail: imperative_1.ProcessUtils.isGuiAvailable() === imperative_1.GuiResult.GUI_AVAILABLE,
+                conflict: false,
+                zosResp: null
+            };
+            lfFile.tempPath = commandParameters.arguments.localFilePath = yield Edit_utils_1.EditUtilities.buildTempPath(lfFile, commandParameters);
+            // Use or override stash if exists
+            const stash = yield Edit_utils_1.EditUtilities.checkForStash(lfFile.tempPath);
+            let useStash, viewDiff = false;
+            if (stash) {
+                useStash = yield Edit_utils_1.EditUtilities.promptUser(Edit_utils_1.Prompt.useStash);
+            }
+            // Retrieve etag & download mf file to edit locally if not using stash
+            try {
+                const task = {
+                    percentComplete: 10,
+                    statusMessage: "Retrieving file",
+                    stageName: imperative_1.TaskStage.IN_PROGRESS
+                };
+                commandParameters.response.progress.startBar({ task });
+                // Retrieve etag AND file contents if not using stash
+                lfFile = yield Edit_utils_1.EditUtilities.localDownload(session, lfFile, useStash);
+                commandParameters.response.progress.endBar();
+                // Show a file comparison for the purpose of seeing the current version of remote compared to past edits
+                if (useStash) {
+                    viewDiff = yield Edit_utils_1.EditUtilities.promptUser(Edit_utils_1.Prompt.viewDiff);
+                    if (viewDiff) {
+                        yield Edit_utils_1.EditUtilities.fileComparison(session, commandParameters, lfFile);
+                    }
+                }
+            }
+            catch (error) {
+                if (error instanceof imperative_1.ImperativeError && error.errorCode === String(imperative_1.RestConstants.HTTP_STATUS_404)) {
+                    throw new imperative_1.ImperativeError({
+                        msg: imperative_1.TextUtils.chalk.red(`File not found on mainframe. Command terminated.`),
+                        causeErrors: error
+                    });
+                }
+                else {
+                    throw error;
+                }
+            }
+            // Edit local copy of mf file (automatically open an editor for user if not in headless linux)
+            commandParameters.response.console.log(imperative_1.TextUtils.chalk.green(`Temp file location: `) +
+                imperative_1.TextUtils.chalk.blue(lfFile.tempPath));
+            const overwrite = yield Edit_utils_1.EditUtilities.makeEdits(lfFile, commandParameters.arguments.editor);
+            if (!overwrite) {
+                return {
+                    success: true,
+                    commandResponse: imperative_1.TextUtils.chalk.green("Exiting now. Temp file persists for editing.")
+                };
+            }
+            // Once done editing, user will provide terminal input. Upload local file with saved etag
+            let uploaded = false;
+            let canceled = false;
+            do {
+                [uploaded, canceled] = yield Edit_utils_1.EditUtilities.uploadEdits(session, commandParameters, lfFile);
+            } while (!uploaded && !canceled);
+            if (!canceled) {
+                return {
+                    success: true,
+                    commandResponse: imperative_1.TextUtils.chalk.green("Successfully uploaded edits to mainframe.")
+                };
+            }
+            else {
+                return {
+                    success: true,
+                    commandResponse: imperative_1.TextUtils.chalk.green("Exiting now. Temp file persists for editing.")
+                };
+            }
+        });
+    }
+}
+exports.default = EditHandler;
+//# sourceMappingURL=Edit.handler.js.map

package/lib/zosfiles/edit/Edit.handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Edit.handler.js","sourceRoot":"","sources":["../../../src/zosfiles/edit/Edit.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;AAEF,iDACkH;AAElH,kEAA8D;AAC9D,mDAAgF;AAEhF;;;GAGG;AACH,MAAqB,WAAY,SAAQ,0CAAmB;IAC3C,kBAAkB,CAAC,iBAAqC,EAAE,OAAwB;;;YAC3F,yCAAyC;YACzC,IAAI,MAAM,GAAe;gBACrB,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,MAAA,iBAAiB,CAAC,SAAS,CAAC,WAAW,mCAAI,iBAAiB,CAAC,SAAS,CAAC,WAAW;gBAC5F,QAAQ,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;gBACvE,QAAQ,EAAE,yBAAY,CAAC,cAAc,EAAE,KAAK,sBAAS,CAAC,aAAa;gBACnE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,IAAI;aAChB,CAAC;YACF,MAAM,CAAC,QAAQ,GAAG,iBAAiB,CAAC,SAAS,CAAC,aAAa,GAAG,MAAM,0BAAK,CAAC,aAAa,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;YAEnH,kCAAkC;YAClC,MAAM,KAAK,GAAY,MAAM,0BAAK,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAClE,IAAI,QAAQ,EAAE,QAAQ,GAAY,KAAK,CAAC;YACxC,IAAI,KAAK,EAAE;gBACP,QAAQ,GAAG,MAAM,0BAAK,CAAC,UAAU,CAAC,mBAAM,CAAC,QAAQ,CAAC,CAAC;aACtD;YAED,sEAAsE;YACtE,IAAG;gBACC,MAAM,IAAI,GAAoB;oBAC1B,eAAe,EAAE,EAAE;oBACnB,aAAa,EAAE,iBAAiB;oBAChC,SAAS,EAAE,sBAAS,CAAC,WAAW;iBACnC,CAAC;gBACF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC;gBAErD,qDAAqD;gBACrD,MAAM,GAAG,MAAM,0BAAK,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAC9D,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAE7C,wGAAwG;gBACxG,IAAI,QAAQ,EAAC;oBACT,QAAQ,GAAG,MAAM,0BAAK,CAAC,UAAU,CAAC,mBAAM,CAAC,QAAQ,CAAC,CAAC;oBACnD,IAAI,QAAQ,EAAC;wBACT,MAAM,0BAAK,CAAC,cAAc,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,CAAC,CAAC;qBAClE;iBACJ;aAEJ;YAAA,OAAM,KAAK,EAAC;gBACT,IAAI,KAAK,YAAY,4BAAe,IAAI,KAAK,CAAC,SAAS,KAAK,MAAM,CAAC,0BAAa,CAAC,eAAe,CAAC,EAAE;oBAC/F,MAAM,IAAI,4BAAe,CAAC;wBACtB,GAAG,EAAE,sBAAS,CAAC,KAAK,CAAC,GAAG,CAAC,kDAAkD,CAAC;wBAC5E,WAAW,EAAE,KAAK;qBACrB,CAAC,CAAC;iBACN;qBAAM;oBACH,MAAM,KAAK,CAAC;iBACf;aACJ;YAED,8FAA8F;YAC9F,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC;gBACpF,sBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAEvC,MAAM,SAAS,GAAG,MAAM,0BAAK,CAAC,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAEpF,IAAI,CAAC,SAAS,EAAC;gBACX,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,eAAe,EAAE,sBAAS,CAAC,KAAK,CAAC,KAAK,CAClC,8CAA8C,CACjD;iBACJ,CAAC;aACL;YAED,yFAAyF;YACzF,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,GAAG;gBACC,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,0BAAK,CAAC,WAAW,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,CAAC,CAAC;aACtF,QAAQ,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACjC,IAAI,CAAC,QAAQ,EAAC;gBACV,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,eAAe,EAAE,sBAAS,CAAC,KAAK,CAAC,KAAK,CAClC,2CAA2C,CAC9C;iBACJ,CAAC;aACL;iBAAM;gBACH,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,eAAe,EAAE,sBAAS,CAAC,KAAK,CAAC,KAAK,CAClC,8CAA8C,CACjD;iBACJ,CAAC;aACL;;KAEJ;CACJ;AA1FD,8BA0FC"}

package/lib/zosfiles/edit/Edit.options.d.ts

@@ -0,0 +1,7 @@
+import { ICommandOptionDefinition } from "@zowe/imperative";
+/**
+ * Object containing all options to be used by the Edit API
+ */
+export declare const EditOptions: {
+    [key: string]: ICommandOptionDefinition;
+};

package/lib/zosfiles/edit/Edit.options.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+* This program and the accompanying materials are made available under the terms of the
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright Contributors to the Zowe Project.
+*
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditOptions = void 0;
+// Does not use the import in anticipation of some internationalization work to be done later.
+const strings = require("../-strings-/en").default.EDIT.OPTIONS;
+/**
+ * Object containing all options to be used by the Edit API
+ */
+exports.EditOptions = {
+    /**
+     * The option to set a default editor
+     * @type {ICommandOptionDefinition}
+     */
+    editor: {
+        name: "editor",
+        aliases: ["ed"],
+        description: strings.EDITOR,
+        type: "string",
+        required: false
+    },
+    extension: {
+        name: "extension",
+        aliases: ["ext"],
+        description: strings.EXTENSION,
+        type: "string",
+        required: false
+    },
+};
+//# sourceMappingURL=Edit.options.js.map

package/lib/zosfiles/edit/Edit.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Edit.options.js","sourceRoot":"","sources":["../../../src/zosfiles/edit/Edit.options.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;AAMF,8FAA8F;AAC9F,MAAM,OAAO,GAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAA8B,CAAC,IAAI,CAAC,OAAO,CAAC;AAExF;;GAEG;AACU,QAAA,WAAW,GAAgD;IAEpE;;;OAGG;IACH,MAAM,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,IAAI,CAAC;QACf,WAAW,EAAE,OAAO,CAAC,MAAM;QAC3B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;KAClB;IACD,SAAS,EAAE;QACP,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,CAAC,KAAK,CAAC;QAChB,WAAW,EAAE,OAAO,CAAC,SAAS;QAC9B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;KAClB;CACJ,CAAC"}

package/lib/zosfiles/edit/Edit.utils.d.ts

@@ -0,0 +1,118 @@
+import { IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
+import { AbstractSession, IHandlerParameters } from "@zowe/imperative";
+/**
+ * enum of prompts to be used as input to {@link EditUtilities.promptUser} during the file editing process
+ * @export
+ * @enum
+ */
+export declare enum Prompt {
+    useStash = 0,
+    viewDiff = 1,
+    overwriteRemote = 2,
+    viewUpdatedRemote = 3,
+    continueToUpload = 4
+}
+/**
+ * Type indicates which file system is being used for storage on mainframe {@link ILocalFile}
+ * @export
+ * @type
+ */
+export declare type EditFileType = "uss" | "ds";
+/**
+ * A class to hold pertinent information about the local file during the editing process
+ * @export
+ * @interface
+ */
+export interface ILocalFile {
+    tempPath: string | null;
+    fileName: string;
+    fileType: EditFileType;
+    guiAvail: boolean;
+    zosResp: IZosFilesResponse | null;
+    conflict: boolean;
+    encoding?: string | null;
+}
+/**
+ * A shared utility class that uss and ds handlers use for local file editing
+ * @export
+ * @class
+ */
+export declare class EditUtilities {
+    /**
+     * Builds a temp path where local file will be saved. If uss file, file name will be hashed
+     * to prevent any conflicts with file naming. A given filename will always result in the
+     * same unique file path.
+     * @param {ILocalFile} lfFile - object containing pertinent information about the local file during the editing process
+     * @returns {Promise<string>} - returns unique file path for temp file
+     * @memberof EditUtilities
+     */
+    static buildTempPath(lfFile: ILocalFile, commandParameters: IHandlerParameters): Promise<string>;
+    /**
+     * Check for temp path's existence (check if previously 'stashed'/temp edits exist)
+     * @param {string} tempPath - unique file path for local file (stash/temp file)
+     * @returns {Promise<boolean>} - promise that resolves to true if stash exists or false if doesn't
+     * @memberof EditUtilities
+     */
+    static checkForStash(tempPath: string): Promise<boolean>;
+    /**
+     * Collection of prompts to be used at different points in editing process
+     * @param {Prompt} prompt - selected prompt from {@link Prompt} (enum object)
+     * @param {Boolean} conflict - optional. true if detected conflict between local and remote files
+     * @returns {Promise<boolean>} - promise whose resolution depends on user input
+     * @memberof EditUtilities
+     */
+    static promptUser(prompt: Prompt, conflict?: boolean): Promise<boolean>;
+    /**
+     * Download file and determine if downloading just to get etag (useStash) or to save file locally & get etag (!useStash)
+     * @param {AbstractSession} session - the session object generated from the connected profile
+     * @param {ILocalFile} lfFile - object containing pertinent information about the local file during the editing process
+     * @param {boolean} useStash - should be true if don't want to overwrite local file when refreshing etag
+     * @returns {ILocalFile}
+     */
+    static localDownload(session: AbstractSession, lfFile: ILocalFile, useStash: boolean): Promise<ILocalFile>;
+    /**
+     * Performs appropriate file comparison (either in browser or as a terminal diff) between local file and remote
+     * Local file (lf) will then be opened in default editor
+     * @param {AbstractSession} session - the session object generated from the connected profile
+     * @param {IHandlerParameters} commandParameters - parameters supplied by args
+     * @param {ILocalFile} lfFile - object containing pertinent information about the local file during the editing process
+     * @param {boolean} promptUser - optional. if there are changes then prompt user to show diff, otherwise return
+     * @returns {Promise<IZosFilesResponse>} - the response generated by {@link CompareBaseHelper.getResponse}
+     * @memberof EditUtilities
+     */
+    static fileComparison(session: AbstractSession, commandParameters: IHandlerParameters, lfFile: ILocalFile, promptUser?: boolean): Promise<IZosFilesResponse>;
+    /**
+     * Enable user to make their edits and wait for user input to indicate editing is complete
+     * @param {ILocalFile} lfFile - object containing pertinent information about the local file during the editing process
+     * @param {string} editor - optional parameter originally supplied by args
+     * @memberof EditUtilities
+     */
+    static makeEdits(lfFile: ILocalFile, editor?: string): Promise<boolean>;
+    /**
+     * Upload temp file with saved etag
+     *  - if matching etag: successful upload, destroy stash/temp -> END
+     *  - if non-matching etag: unsuccessful upload -> refresh etag -> perform file comparison/edit -> re-attempt upload
+     * @param {AbstractSession} session - the session object generated from the connected profile
+     * @param {IHandlerParameters} commandParameters - parameters supplied by args
+     * @param {ILocalFile} lfFile - object containing pertinent information about the local file during the editing process
+     * @returns {Promise<[boolean, boolean]>} - [resolves to true if uploading was successful and
+     * false if not, resolves to true if user wishes to cancel command and false if not]
+     * @memberof EditUtilities
+     */
+    static uploadEdits(session: AbstractSession, commandParameters: IHandlerParameters, lfFile: ILocalFile): Promise<[boolean, boolean]>;
+    /**
+     * When changes occur in the remote file, user will have to overwrite remote or account for the discrepancy between files
+     * @param {AbstractSession} session - the session object generated from the connected profile
+     * @param {IHandlerParameters} commandParameters - parameters supplied by args
+     * @param {ILocalFile} lfFile - object containing pertinent information about the local file during the editing process
+     * @returns {Promise<boolean>} - returns a boolean where true means command is canceled and false means continue
+     * @memberof EditUtilities
+     */
+    static etagMismatch(session: AbstractSession, commandParameters: IHandlerParameters, lfFile: ILocalFile): Promise<[boolean, boolean]>;
+    /**
+     * Destroy path of temporary local file (remove stash)
+     * @param {string} tempPath - unique file path for local file (stash)
+     * @memberof EditUtilities
+     */
+    static destroyTempFile(tempPath: string): Promise<void>;
+}