@zowe/cli 7.10.4 → 7.11.0

package/lib/zosfiles/compare/CompareBase.handler.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import { AbstractSession, ICommandArguments, IHandlerParameters } from "@zowe/imperative";
+import { IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
+import { ZosFilesBaseHandler } from "../ZosFilesBase.handler";
+import { CompareBaseHelper } from "./CompareBaseHelper";
+/**
+ * This class is used by the various zosfiles-compare handlers as the base class for their implementation.
+ * All handlers within zosfiles-compare should extend this class.
+ *
+ * This class should not be used outside of the zosfiles-compare package.
+ *
+ * @private
+ */
+export declare abstract class CompareBaseHandler extends ZosFilesBaseHandler {
+    /**
+     * This will grab the zosmf profile and create a session before calling the subclass
+     * {@link ZosFilesBaseHandler#processWithSession} method.
+     *
+     * @param {IHandlerParameters} commandParameters Command parameters sent by imperative.
+     *
+     * @returns {Promise<void>}
+     */
+    processWithSession(commandParameters: IHandlerParameters, session: AbstractSession): Promise<IZosFilesResponse>;
+    /**
+     * Abstract method required for compare handlers to determine how they gather the contents of the file/dataset to compare
+     * @param session Gives access to the session object in case the handler needs to submit a request to get the first file
+     * @param args Command arguments required for getting the dataset, filepath, or spool descriptor
+     * @param helper CompareBaseHelper instance to access prepare- functions
+     */
+    abstract getFile1(session: AbstractSession, args: ICommandArguments, helper: CompareBaseHelper): Promise<string | Buffer>;
+    /**
+     * Abstract method required for compare handlers to determine how they gather the contents of the file/dataset to compare
+     * @param session Gives access to the session object in case the handler needs to submit a request to get the contents
+     * @param args Command arguments required for getting the dataset, filepath, or spool descriptor
+     * @param helper CompareBaseHelper instance to access prepare- functions
+     */
+    abstract getFile2(session: AbstractSession, args: ICommandArguments, helper: CompareBaseHelper): Promise<string | Buffer>;
+}

package/lib/zosfiles/compare/CompareBase.handler.js

@@ -0,0 +1,62 @@
+"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 });
+exports.CompareBaseHandler = void 0;
+const imperative_1 = require("@zowe/imperative");
+const ZosFilesBase_handler_1 = require("../ZosFilesBase.handler");
+const CompareBaseHelper_1 = require("./CompareBaseHelper");
+/**
+ * This class is used by the various zosfiles-compare handlers as the base class for their implementation.
+ * All handlers within zosfiles-compare should extend this class.
+ *
+ * This class should not be used outside of the zosfiles-compare package.
+ *
+ * @private
+ */
+class CompareBaseHandler extends ZosFilesBase_handler_1.ZosFilesBaseHandler {
+    /**
+     * This will grab the zosmf profile and create a session before calling the subclass
+     * {@link ZosFilesBaseHandler#processWithSession} method.
+     *
+     * @param {IHandlerParameters} commandParameters Command parameters sent by imperative.
+     *
+     * @returns {Promise<void>}
+     */
+    processWithSession(commandParameters, session) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const helper = new CompareBaseHelper_1.CompareBaseHelper(commandParameters);
+            helper.task = {
+                percentComplete: 0,
+                statusMessage: `Retrieving content for the first file/dataset`,
+                stageName: imperative_1.TaskStage.IN_PROGRESS
+            };
+            commandParameters.response.progress.startBar({ task: helper.task });
+            const fileContent1 = yield this.getFile1(session, commandParameters.arguments, helper);
+            commandParameters.response.progress.endBar();
+            commandParameters.response.progress.startBar({ task: helper.task });
+            helper.task.statusMessage = `Retrieving content for the second file/dataset`;
+            const fileContent2 = yield this.getFile2(session, commandParameters.arguments, helper);
+            return helper.getResponse(helper.prepareContent(fileContent1), helper.prepareContent(fileContent2));
+        });
+    }
+}
+exports.CompareBaseHandler = CompareBaseHandler;
+//# sourceMappingURL=CompareBase.handler.js.map

package/lib/zosfiles/compare/CompareBase.handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompareBase.handler.js","sourceRoot":"","sources":["../../../src/zosfiles/compare/CompareBase.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;;AAEF,iDAAqG;AAErG,kEAA8D;AAC9D,2DAAwD;AAExD;;;;;;;GAOG;AACH,MAAsB,kBAAmB,SAAQ,0CAAmB;IAChE;;;;;;;OAOG;IACU,kBAAkB,CAAC,iBAAqC,EAAE,OAAwB;;YAC3F,MAAM,MAAM,GAAG,IAAI,qCAAiB,CAAC,iBAAiB,CAAC,CAAC;YACxD,MAAM,CAAC,IAAI,GAAG;gBACV,eAAe,EAAE,CAAC;gBAClB,aAAa,EAAE,+CAA+C;gBAC9D,SAAS,EAAE,sBAAS,CAAC,WAAW;aACnC,CAAC;YAEF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAEpE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACvF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC7C,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAEpE,MAAM,CAAC,IAAI,CAAC,aAAa,GAAG,gDAAgD,CAAC;YAC7E,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAEvF,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;QACxG,CAAC;KAAA;CAyBJ;AApDD,gDAoDC"}

package/lib/zosfiles/compare/CompareBaseHelper.d.ts

@@ -0,0 +1,92 @@
+/// <reference types="node" />
+import { IHandlerParameters, ITaskWithStatus } from "@zowe/imperative";
+import { IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
+import { ICompareFileOptions } from "./doc/ICompareFileOptions";
+/**
+ * Base helper for compare command to handle common operations through the comparison
+ * @export
+ */
+export declare class CompareBaseHelper {
+    /**
+     * file compare option for file1
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    file1Options: ICompareFileOptions;
+    /**
+     * file compare option for file2
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    file2Options: ICompareFileOptions;
+    /**
+     * responseTimeout option
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    responseTimeout: number;
+    /**
+     * seqnum option
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    seqnum: boolean;
+    /**
+     * contextLines option
+     * @private
+     * @memberof CompareBaseHelper
+     */
+    contextLines: number;
+    /**
+     * browserView option
+     * @private
+     * @memberof CompareBaseHelper
+     */
+    browserView: boolean;
+    /**
+     * task
+     * @private
+     * @memberof CompareBaseHelper
+     */
+    task: ITaskWithStatus;
+    /**
+     * Creates an instance of CompareBaseHelper
+     * @param {IHandlerParameters} commandParameters Command parameters sent to the handler
+     * @memberof CompareBaseHelper
+     */
+    constructor(commandParameters: IHandlerParameters);
+    /**
+     * Parse the spool description and split them into individual properties
+     * @param spoolDescription Colon-separated (:) spool descriptor
+     * @returns Object containing the name, job id, and spool id
+     */
+    prepareSpoolDescriptor(spoolDescription: string): {
+        jobName: string;
+        jobId: string;
+        spoolId: number;
+    };
+    /**
+     * Helper function that compare-related handlers will use to get the contents of a local file
+     * @param filePath Path to the file to compate against
+     * @returns Buffer with the contents of the file
+     */
+    prepareLocalFile(filePath: string): Buffer;
+    /**
+     * This method will prepare the strings for comparison ready
+     * @param {string | Buffer } content - Content string or buffer of file 1
+     * @param {string | Buffer } content2 - - Content string or buffer of file 2
+     * @returns
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    prepareContent(content: string | Buffer): string;
+    /**
+     * To get the difference string in ternninal or in browser
+     * @param {string} string1 - string of file 1 comtent
+     * @param  {string} string2 - string of file 2 comtent
+     * @returns {IZosFilesResponse}
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    getResponse(string1: string, string2: string): Promise<IZosFilesResponse>;
+}

package/lib/zosfiles/compare/CompareBaseHelper.js

@@ -0,0 +1,173 @@
+"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 });
+exports.CompareBaseHelper = void 0;
+const path = require("path");
+const fs = require("fs");
+const imperative_1 = require("@zowe/imperative");
+/**
+ * Base helper for compare command to handle common operations through the comparison
+ * @export
+ */
+class CompareBaseHelper {
+    /**
+     * Creates an instance of CompareBaseHelper
+     * @param {IHandlerParameters} commandParameters Command parameters sent to the handler
+     * @memberof CompareBaseHelper
+     */
+    constructor(commandParameters) {
+        var _a;
+        /**
+         * file compare option for file1
+         * @public
+         * @memberof CompareBaseHelper
+         */
+        this.file1Options = {};
+        /**
+         * file compare option for file2
+         * @public
+         * @memberof CompareBaseHelper
+         */
+        this.file2Options = {};
+        this.file1Options.binary = commandParameters.arguments.binary;
+        this.file2Options.binary = commandParameters.arguments.binary2;
+        this.file1Options.encoding = commandParameters.arguments.encoding;
+        this.file2Options.encoding = commandParameters.arguments.encoding2;
+        this.file1Options.record = commandParameters.arguments.record;
+        this.file2Options.record = commandParameters.arguments.record2;
+        this.file1Options.volumeSerial = commandParameters.arguments.volumeSerial;
+        this.file2Options.volumeSerial = commandParameters.arguments.volumeSerial2;
+        if (((_a = this.file2Options) === null || _a === void 0 ? void 0 : _a.binary) == null) {
+            this.file2Options.binary = this.file1Options.binary;
+        }
+        if (this.file2Options.encoding == null) {
+            this.file2Options.encoding = this.file1Options.encoding;
+        }
+        if (this.file2Options.record == null) {
+            this.file2Options.record = this.file1Options.record;
+        }
+        this.seqnum = commandParameters.arguments.seqnum;
+        this.browserView = commandParameters.arguments.browserView;
+        this.contextLines = commandParameters.arguments.contextLines;
+        this.responseTimeout = commandParameters.arguments.responseTimeout;
+        this.file1Options.responseTimeout = this.responseTimeout;
+        this.file2Options.responseTimeout = this.responseTimeout;
+        // Clear undefined properties
+        this.file1Options = JSON.parse(JSON.stringify(this.file1Options));
+        this.file2Options = JSON.parse(JSON.stringify(this.file2Options));
+    }
+    /**
+     * Parse the spool description and split them into individual properties
+     * @param spoolDescription Colon-separated (:) spool descriptor
+     * @returns Object containing the name, job id, and spool id
+     */
+    prepareSpoolDescriptor(spoolDescription) {
+        const descriptionSeperator = ":";
+        const spoolDescArr = spoolDescription.split(descriptionSeperator);
+        const jobName = spoolDescArr[0];
+        const jobId = spoolDescArr[1];
+        const spoolId = Number(spoolDescArr[2]);
+        return { jobName, jobId, spoolId };
+    }
+    /**
+     * Helper function that compare-related handlers will use to get the contents of a local file
+     * @param filePath Path to the file to compate against
+     * @returns Buffer with the contents of the file
+     */
+    prepareLocalFile(filePath) {
+        const localFile = path.isAbsolute(filePath) ? filePath : path.resolve(filePath);
+        let lfContentBuf;
+        let localFileHandle;
+        try {
+            try {
+                // check if the path given is of a file or not
+                localFileHandle = fs.openSync(localFile, 'r');
+                if (!fs.fstatSync(localFileHandle).isFile()) {
+                    throw new imperative_1.ImperativeError({
+                        msg: 'Path is not of a file. Please check the path and try again'
+                    });
+                }
+            }
+            catch (error) {
+                if (error instanceof imperative_1.ImperativeError)
+                    throw error;
+                throw new imperative_1.ImperativeError({
+                    msg: 'Path not found. Please check the path and try again'
+                });
+            }
+            // reading local file as buffer
+            lfContentBuf = fs.readFileSync(localFileHandle);
+        }
+        finally {
+            if (localFileHandle != null)
+                fs.closeSync(localFileHandle);
+        }
+        return lfContentBuf;
+    }
+    /**
+     * This method will prepare the strings for comparison ready
+     * @param {string | Buffer } content - Content string or buffer of file 1
+     * @param {string | Buffer } content2 - - Content string or buffer of file 2
+     * @returns
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    prepareContent(content) {
+        let contentString = content.toString();
+        if (this.seqnum === false) {
+            const seqnumlen = 8;
+            contentString = content.toString().split("\n").map((line) => line.slice(0, -seqnumlen)).join("\n");
+        }
+        return contentString;
+    }
+    /**
+     * To get the difference string in ternninal or in browser
+     * @param {string} string1 - string of file 1 comtent
+     * @param  {string} string2 - string of file 2 comtent
+     * @returns {IZosFilesResponse}
+     * @public
+     * @memberof CompareBaseHelper
+     */
+    getResponse(string1, string2) {
+        return __awaiter(this, void 0, void 0, function* () {
+            //  CHECHKING IIF THE BROWSER VIEW IS TRUE, OPEN UP THE DIFFS IN BROWSER
+            if (this.browserView) {
+                yield imperative_1.DiffUtils.openDiffInbrowser(string1, string2);
+                return {
+                    success: true,
+                    commandResponse: "Launching data-sets diffs in browser...",
+                    apiResponse: {}
+                };
+            }
+            const jsonDiff = yield imperative_1.DiffUtils.getDiffString(string1, string2, {
+                outputFormat: 'terminal',
+                contextLinesArg: this.contextLines
+            });
+            return {
+                success: true,
+                commandResponse: jsonDiff,
+                apiResponse: {}
+            };
+        });
+    }
+}
+exports.CompareBaseHelper = CompareBaseHelper;
+//# sourceMappingURL=CompareBaseHelper.js.map

package/lib/zosfiles/compare/CompareBaseHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompareBaseHelper.js","sourceRoot":"","sources":["../../../src/zosfiles/compare/CompareBaseHelper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;;AAEF,6BAA6B;AAC7B,yBAAyB;AACzB,iDAAmG;AAInG;;;GAGG;AACH,MAAa,iBAAiB;IAmD1B;;;;OAIG;IACH,YAAY,iBAAqC;;QAtDjD;;;;WAIG;QACI,iBAAY,GAAwB,EAAE,CAAC;QAE9C;;;;WAIG;QACI,iBAAY,GAAwB,EAAE,CAAC;QA2C1C,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC;QAC9D,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC;QAC/D,IAAI,CAAC,YAAY,CAAC,QAAQ,GAAG,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC;QAClE,IAAI,CAAC,YAAY,CAAC,QAAQ,GAAG,iBAAiB,CAAC,SAAS,CAAC,SAAS,CAAC;QACnE,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC;QAC9D,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC;QAC/D,IAAI,CAAC,YAAY,CAAC,YAAY,GAAG,iBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC;QAC1E,IAAI,CAAC,YAAY,CAAC,YAAY,GAAG,iBAAiB,CAAC,SAAS,CAAC,aAAa,CAAC;QAE3E,IAAI,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,MAAM,KAAI,IAAI,EAAE;YACnC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;SACvD;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,IAAI,IAAI,EAAE;YACpC,IAAI,CAAC,YAAY,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;SAC3D;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,EAAE;YAClC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;SACvD;QAED,IAAI,CAAC,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAAC,WAAW,CAAC;QAC3D,IAAI,CAAC,YAAY,GAAG,iBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC;QAC7D,IAAI,CAAC,eAAe,GAAG,iBAAiB,CAAC,SAAS,CAAC,eAAe,CAAC;QACnE,IAAI,CAAC,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QACzD,IAAI,CAAC,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAEzD,6BAA6B;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,gBAAwB;QAClD,MAAM,oBAAoB,GAAW,GAAG,CAAC;QACzC,MAAM,YAAY,GAAG,gBAAgB,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAClE,MAAM,OAAO,GAAW,YAAY,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,KAAK,GAAW,YAAY,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,OAAO,GAAW,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAgB;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChF,IAAI,YAAoB,CAAC;QACzB,IAAI,eAAuB,CAAC;QAC5B,IAAI;YACA,IAAI;gBACA,8CAA8C;gBAC9C,eAAe,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;gBAC9C,IAAG,CAAC,EAAE,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,EAAC;oBACvC,MAAM,IAAI,4BAAe,CAAC;wBACtB,GAAG,EAAE,4DAA4D;qBACpE,CAAC,CAAC;iBACN;aACJ;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,KAAK,YAAY,4BAAe;oBAAE,MAAM,KAAK,CAAC;gBAClD,MAAM,IAAI,4BAAe,CAAC;oBACtB,GAAG,EAAE,qDAAqD;iBAC7D,CAAC,CAAC;aACN;YACD,+BAA+B;YAC/B,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;SACnD;gBAAS;YACN,IAAI,eAAe,IAAI,IAAI;gBAAE,EAAE,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;SAC9D;QACD,OAAO,YAAY,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,cAAc,CAAC,OAAwB;QAC1C,IAAI,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAG,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE;YACtB,MAAM,SAAS,GAAG,CAAC,CAAC;YACpB,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACtG;QACD,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACU,WAAW,CAAC,OAAe,EAAE,OAAe;;YACrD,wEAAwE;YACxE,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClB,MAAM,sBAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACpD,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,eAAe,EAAE,yCAAyC;oBAC1D,WAAW,EAAE,EAAE;iBAClB,CAAC;aACL;YAED,MAAM,QAAQ,GAAG,MAAM,sBAAS,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE;gBAC7D,YAAY,EAAE,UAAU;gBACxB,eAAe,EAAE,IAAI,CAAC,YAAY;aACrC,CAAC,CAAC;YACH,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,eAAe,EAAE,QAAQ;gBACzB,WAAW,EAAE,EAAE;aAClB,CAAC;QACN,CAAC;KAAA;CACJ;AApLD,8CAoLC"}

package/lib/zosfiles/compare/doc/ICompareFileOptions.d.ts

@@ -0,0 +1,14 @@
+import { IZosFilesOptions } from "@zowe/zos-files-for-zowe-sdk";
+/**
+ * These are the options to be used in file comaparison to handle the
+ *  binary, encoding, record and volumeSerial operations in the comparison process
+ *
+ * @exports
+ * @interface ICompareFileOptions
+ */
+export interface ICompareFileOptions extends IZosFilesOptions {
+    binary?: boolean;
+    encoding?: string;
+    record?: boolean;
+    volumeSerial?: string;
+}

package/lib/zosfiles/compare/doc/ICompareFileOptions.js

@@ -0,0 +1,13 @@
+"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 });
+//# sourceMappingURL=ICompareFileOptions.js.map

package/lib/zosfiles/compare/doc/ICompareFileOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICompareFileOptions.js","sourceRoot":"","sources":["../../../../src/zosfiles/compare/doc/ICompareFileOptions.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE"}

package/lib/zosfiles/compare/ds/Dataset.handler.d.ts

@@ -1,10 +1,12 @@
-import { AbstractSession, IHandlerParameters } from "@zowe/imperative";
-import { IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
-import { ZosFilesBaseHandler } from "../../ZosFilesBase.handler";
+/// <reference types="node" />
+import { AbstractSession, ICommandArguments } from "@zowe/imperative";
+import { CompareBaseHandler } from "../CompareBase.handler";
+import { CompareBaseHelper } from '../CompareBaseHelper';
 /**
  * Handler to view a data set's content
  * @export
  */
-export default class DatasetHandler extends ZosFilesBaseHandler {
-    processWithSession(commandParameters: IHandlerParameters, session: AbstractSession): Promise<IZosFilesResponse>;
+export default class DatasetHandler extends CompareBaseHandler {
+    getFile1(session: AbstractSession, args: ICommandArguments, helper: CompareBaseHelper): Promise<string | Buffer>;
+    getFile2(session: AbstractSession, args: ICommandArguments, helper: CompareBaseHelper): Promise<string | Buffer>;
 }

package/lib/zosfiles/compare/ds/Dataset.handler.js

@@ -19,92 +19,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const imperative_1 = require("@zowe/imperative");
 const zos_files_for_zowe_sdk_1 = require("@zowe/zos-files-for-zowe-sdk");
-const ZosFilesBase_handler_1 = require("../../ZosFilesBase.handler");
+const CompareBase_handler_1 = require("../CompareBase.handler");
 /**
  * Handler to view a data set's content
  * @export
  */
-class DatasetHandler extends ZosFilesBase_handler_1.ZosFilesBaseHandler {
-    processWithSession(commandParameters, session) {
+class DatasetHandler extends CompareBase_handler_1.CompareBaseHandler {
+    getFile1(session, args, helper) {
         return __awaiter(this, void 0, void 0, function* () {
-            const task = {
-                percentComplete: 0,
-                statusMessage: "Retrieving first dataset",
-                stageName: imperative_1.TaskStage.IN_PROGRESS
-            };
-            // RETRIEVING THE FIRST DATA-SET
-            commandParameters.response.progress.startBar({ task });
-            const dsContentBuf1 = yield zos_files_for_zowe_sdk_1.Get.dataSet(session, commandParameters.arguments.dataSetName1, {
-                binary: commandParameters.arguments.binary,
-                encoding: commandParameters.arguments.encoding,
-                record: commandParameters.arguments.record,
-                volume: commandParameters.arguments.volumeSerial,
-                responseTimeout: commandParameters.arguments.responseTimeout,
-                task: task
-            });
-            commandParameters.response.progress.endBar();
-            // RETRIEVING THE DATA-SET TO COMPARE
-            task.statusMessage = "Retrieving second dataset";
-            commandParameters.response.progress.startBar({ task });
-            let binary2 = commandParameters.arguments.binary2;
-            let encoding2 = commandParameters.arguments.encoding2;
-            let record2 = commandParameters.arguments.record2;
-            const volumeSerial2 = commandParameters.arguments.volumeSerial2;
-            if (binary2 == undefined) {
-                binary2 = commandParameters.arguments.binary;
-            }
-            if (encoding2 == undefined) {
-                encoding2 = commandParameters.arguments.encoding;
-            }
-            if (record2 == undefined) {
-                record2 = commandParameters.arguments.record;
-            }
-            const dsContentBuf2 = yield zos_files_for_zowe_sdk_1.Get.dataSet(session, commandParameters.arguments.dataSetName2, {
-                binary: binary2,
-                encoding: encoding2,
-                record: record2,
-                volume: volumeSerial2,
-                responseTimeout: commandParameters.arguments.responseTimeout,
-                task: task
-            });
-            commandParameters.response.progress.endBar();
-            //CHECKING IF NEEDING TO SPLIT CONTENT STRINGS FOR SEQNUM OPTION
-            let dsContentString1 = "";
-            let dsContentString2 = "";
-            const seqnumlen = 8;
-            if (commandParameters.arguments.seqnum === false) {
-                dsContentString1 = dsContentBuf1.toString().split("\n")
-                    .map((line) => line.slice(0, -seqnumlen))
-                    .join("\n");
-                dsContentString2 = dsContentBuf2.toString().split("\n")
-                    .map((line) => line.slice(0, -seqnumlen))
-                    .join("\n");
-            }
-            else {
-                dsContentString1 = dsContentBuf1.toString();
-                dsContentString2 = dsContentBuf2.toString();
-            }
-            // CHECK TO OPEN UP DIFF IN BROWSER WINDOW
-            if (commandParameters.arguments.browserView) {
-                yield imperative_1.DiffUtils.openDiffInbrowser(dsContentString1, dsContentString2);
-                return {
-                    success: true,
-                    commandResponse: "Launching data-sets diffs in browser...",
-                    apiResponse: {}
-                };
-            }
-            // RETURNING DIFF
-            const jsonDiff = yield imperative_1.DiffUtils.getDiffString(dsContentString1, dsContentString2, {
-                outputFormat: 'terminal',
-                contextLinesArg: commandParameters.arguments.contextLines
-            });
-            return {
-                success: true,
-                commandResponse: jsonDiff,
-                apiResponse: {}
-            };
+            return yield zos_files_for_zowe_sdk_1.Get.dataSet(session, args.dataSetName1, Object.assign(Object.assign({}, helper.file1Options), { task: helper.task }));
+        });
+    }
+    getFile2(session, args, helper) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield zos_files_for_zowe_sdk_1.Get.dataSet(session, args.dataSetName2, Object.assign(Object.assign({}, helper.file2Options), { task: helper.task }));
         });
     }
 }

package/lib/zosfiles/compare/ds/Dataset.handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"Dataset.handler.js","sourceRoot":"","sources":["../../../../src/zosfiles/compare/ds/Dataset.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;AAEF,iDAA8G;AAC9G,yEAAsE;AACtE,qEAAiE;AACjE;;;GAGG;AACH,MAAqB,cAAe,SAAQ,0CAAmB;IAC9C,kBAAkB,CAAC,iBAAqC,EAAE,OAAwB;;YAC3F,MAAM,IAAI,GAAoB;gBAC1B,eAAe,EAAE,CAAC;gBAClB,aAAa,EAAE,0BAA0B;gBACzC,SAAS,EAAE,sBAAS,CAAC,WAAW;aACnC,CAAC;YAEF,gCAAgC;YAChC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,MAAM,aAAa,GAAG,MAAM,4BAAG,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,YAAY,EACrF;gBACI,MAAM,EAAE,iBAAiB,CAAC,SAAS,CAAC,MAAM;gBAC1C,QAAQ,EAAE,iBAAiB,CAAC,SAAS,CAAC,QAAQ;gBAC9C,MAAM,EAAE,iBAAiB,CAAC,SAAS,CAAC,MAAM;gBAC1C,MAAM,EAAE,iBAAiB,CAAC,SAAS,CAAC,YAAY;gBAChD,eAAe,EAAE,iBAAiB,CAAC,SAAS,CAAC,eAAe;gBAC5D,IAAI,EAAE,IAAI;aACb,CACJ,CAAC;YACF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAG7C,qCAAqC;YACrC,IAAI,CAAC,aAAa,GAAG,2BAA2B,CAAC;YACjD,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,IAAI,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC;YAClD,IAAI,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC,SAAS,CAAC;YACtD,IAAI,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC;YAClD,MAAM,aAAa,GAAG,iBAAiB,CAAC,SAAS,CAAC,aAAa,CAAC;YAChE,IAAI,OAAO,IAAI,SAAS,EAAE;gBACtB,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC;aAChD;YACD,IAAI,SAAS,IAAI,SAAS,EAAE;gBACxB,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC;aACpD;YACD,IAAI,OAAO,IAAI,SAAS,EAAE;gBACtB,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC;aAChD;YACD,MAAM,aAAa,GAAG,MAAM,4BAAG,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,YAAY,EACrF;gBACI,MAAM,EAAE,OAAO;gBACf,QAAQ,EAAE,SAAS;gBACnB,MAAM,EAAE,OAAO;gBACf,MAAM,EAAE,aAAa;gBACrB,eAAe,EAAE,iBAAiB,CAAC,SAAS,CAAC,eAAe;gBAC5D,IAAI,EAAE,IAAI;aACb,CACJ,CAAC;YACF,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAG7C,gEAAgE;YAChE,IAAI,gBAAgB,GAAG,EAAE,CAAC;YAC1B,IAAI,gBAAgB,GAAG,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,CAAC,CAAC;YACpB,IAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,EAAC;gBAC5C,gBAAgB,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;qBAClD,GAAG,CAAC,CAAC,IAAI,EAAC,EAAE,CAAA,IAAI,CAAC,KAAK,CAAC,CAAC,EAAC,CAAC,SAAS,CAAC,CAAC;qBACrC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAChB,gBAAgB,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;qBAClD,GAAG,CAAC,CAAC,IAAI,EAAC,EAAE,CAAA,IAAI,CAAC,KAAK,CAAC,CAAC,EAAC,CAAC,SAAS,CAAC,CAAC;qBACrC,IAAI,CAAC,IAAI,CAAC,CAAC;aACnB;iBACI;gBACD,gBAAgB,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;gBAC5C,gBAAgB,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;aAC/C;YAGD,0CAA0C;YAC1C,IAAI,iBAAiB,CAAC,SAAS,CAAC,WAAW,EAAE;gBACzC,MAAM,sBAAS,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;gBACtE,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,eAAe,EAAE,yCAAyC;oBAC1D,WAAW,EAAE,EAAE;iBAClB,CAAC;aACL;YAGD,iBAAiB;YACjB,MAAM,QAAQ,GAAG,MAAM,sBAAS,CAAC,aAAa,CAAC,gBAAgB,EAAE,gBAAgB,EAAE;gBAC/E,YAAY,EAAE,UAAU;gBACxB,eAAe,EAAE,iBAAiB,CAAC,SAAS,CAAC,YAAY;aAC5D,CAAC,CAAC;YACH,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,eAAe,EAAE,QAAQ;gBACzB,WAAW,EAAE,EAAE;aAClB,CAAC;QACN,CAAC;KAAA;CACJ;AA5FD,iCA4FC"}
+{"version":3,"file":"Dataset.handler.js","sourceRoot":"","sources":["../../../../src/zosfiles/compare/ds/Dataset.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;AAGF,yEAAmD;AACnD,gEAA4D;AAE5D;;;GAGG;AACH,MAAqB,cAAe,SAAQ,wCAAkB;IAC7C,QAAQ,CAAC,OAAwB,EAAE,IAAuB,EAAE,MAAyB;;YAC9F,OAAO,MAAM,4BAAG,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,kCAAO,MAAM,CAAC,YAAY,KAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAG,CAAC;QACxG,CAAC;KAAA;IACY,QAAQ,CAAC,OAAwB,EAAE,IAAuB,EAAE,MAAyB;;YAC9F,OAAO,MAAM,4BAAG,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,kCAAO,MAAM,CAAC,YAAY,KAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAG,CAAC;QACxG,CAAC;KAAA;CACJ;AAPD,iCAOC"}

package/lib/zosfiles/compare/lf-ds/LocalfileDataset.handler.d.ts

@@ -1,10 +1,12 @@
-import { AbstractSession, IHandlerParameters } from "@zowe/imperative";
-import { IZosFilesResponse } from "@zowe/zos-files-for-zowe-sdk";
-import { ZosFilesBaseHandler } from "../../ZosFilesBase.handler";
+/// <reference types="node" />
+import { AbstractSession, ICommandArguments } from "@zowe/imperative";
+import { CompareBaseHelper } from '../CompareBaseHelper';
+import { CompareBaseHandler } from '../CompareBase.handler';
 /**
- * Handler to view a data set's content
+ * Handler to compare a localfile and a dataset content
  * @export
  */
-export default class LocalfileDatasetHandler extends ZosFilesBaseHandler {
-    processWithSession(commandParameters: IHandlerParameters, session: AbstractSession): Promise<IZosFilesResponse>;
+export default class LocalfileDatasetHandler extends CompareBaseHandler {
+    getFile1(session: AbstractSession, args: ICommandArguments, helper: CompareBaseHelper): Promise<Buffer>;
+    getFile2(session: AbstractSession, args: ICommandArguments, helper: CompareBaseHelper): Promise<Buffer>;
 }