@sasjs/cli 4.4.2 → 4.5.0

package/build/commands/compile/internal/compileTestFile.d.ts

@@ -1,5 +1,5 @@
-import { CompileTree, Configuration, Target } from '@sasjs/utils';
+import { CompileTree, Target } from '@sasjs/utils';
 import { TestFlow } from '../../../types';
 export declare function compileTestFile(target: Target, filePath: string, testVar: string | undefined, saveToRoot: boolean | undefined, removeOriginalFile: boolean | undefined, compileTree: CompileTree, destinationPath?: string): Promise<void>;
 export declare function copyTestMacroFiles(folderAbsolutePath: string): Promise<void>;
-export declare const compileTestFlow: (target: Target, config?: Configuration) => Promise<TestFlow | undefined>;
+export declare const compileTestFlow: (target: Target) => Promise<TestFlow | undefined>;

package/build/commands/compile/internal/compileTestFile.js

@@ -160,8 +160,8 @@ function copyTestMacroFiles(folderAbsolutePath) {
     });
 }
 exports.copyTestMacroFiles = copyTestMacroFiles;
-var compileTestFlow = function (target, config) { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, buildDestinationFolder, buildDestinationTestFolder, testFiles, config_2, testFlow, testSetUp, testTearDown, testSetUpFileName_1, testTearDownFileName_1;
+var compileTestFlow = function (target) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, buildDestinationFolder, buildDestinationTestFolder, testFiles, config, testFlow, testSetUp, testTearDown, testSetUpFileName_1, testTearDownFileName_1;
     var _b, _c, _d, _e;
     return __generator(this, function (_f) {
         switch (_f.label) {
@@ -177,10 +177,10 @@ var compileTestFlow = function (target, config) { return __awaiter(void 0, void
                 return [4 /*yield*/, (0, utils_1.listFilesAndSubFoldersInFolder)(buildDestinationTestFolder)];
             case 2:
                 testFiles = (_f.sent()).map(function (file) { return path_1.default.join('tests', file); });
-                config_2 = process.sasjsConfig;
+                config = process.sasjsConfig;
                 testFlow = { tests: [] };
-                testSetUp = ((_b = target.testConfig) === null || _b === void 0 ? void 0 : _b.testSetUp) || ((_c = config_2.testConfig) === null || _c === void 0 ? void 0 : _c.testSetUp);
-                testTearDown = ((_d = target.testConfig) === null || _d === void 0 ? void 0 : _d.testTearDown) || ((_e = config_2.testConfig) === null || _e === void 0 ? void 0 : _e.testTearDown);
+                testSetUp = ((_b = target.testConfig) === null || _b === void 0 ? void 0 : _b.testSetUp) || ((_c = config.testConfig) === null || _c === void 0 ? void 0 : _c.testSetUp);
+                testTearDown = ((_d = target.testConfig) === null || _d === void 0 ? void 0 : _d.testTearDown) || ((_e = config.testConfig) === null || _e === void 0 ? void 0 : _e.testTearDown);
                 if (testFiles.length) {
                     if (testSetUp) {
                         testSetUpFileName_1 = getFileName(testSetUp);

package/build/commands/compile/internal/spec/compileTestFile.spec.js

@@ -306,7 +306,7 @@ describe('compileTestFile', function () {
                 jest.spyOn(process.logger, 'warn');
                 (0, __1.compileTestFlow)(testTarget);
                 expect(process.logger.warn).toHaveBeenCalledWith(expectedWarn);
-                (0, __1.compileTestFlow)(testTarget, testConfig);
+                (0, __1.compileTestFlow)(testTarget);
                 expect(process.logger.warn).toHaveBeenCalledWith(expectedWarn);
                 return [2 /*return*/];
             });

package/build/commands/help/help.js

@@ -267,14 +267,14 @@ function printHelpText() {
                     description: [
                         "performs operations on jobs.",
                         "[2spaces]* ".concat(chalk_1.default.cyanBright('execute'), " - triggers job for execution."),
-                        "[2spaces]command example: sasjs job execute /Public/job -t targetName --output ./outputFolder/output.json --returnStatusOnly --ignoreWarnings",
-                        "[2spaces]command example: sasjs job execute /Public/job -t targetName --wait --log ./logFolder/log.json -r -i",
+                        "[2spaces]command example: sasjs job execute /Public/job -t targetName --output ./outputFolder/output.json --ignoreWarnings --verbose",
+                        "[2spaces]command example: sasjs job execute /Public/job -t targetName --wait --log ./logFolder/log.json -i -v",
                         "",
                         "[2spaces]NOTE: Providing wait flag (--wait or -w) is optional. If present, CLI will wait for job completion.",
                         "[2spaces]NOTE: Providing output flag (--output or -o) is optional. If present, CLI will immediately print out the response JSON. If value is provided, it will be treated as file path to save the response JSON.",
                         "[2spaces]NOTE: Providing log flag (--log or -l) is optional. If present, CLI will fetch and save job log to local file.",
-                        "[2spaces]NOTE: Providing return status only (--returnStatusOnly or -r) flag is optional. If present and wait flag is provided, CLI will job status only (0 = success, 1 = warning, 2 = error).",
-                        "[2spaces]NOTE: Providing ignore warnings (--ignoreWarnings or -i) flag is optional. If present and return status only is provided, CLI will return status '0', when the job state is warning."
+                        "[2spaces]NOTE: Providing ignore warnings (--ignoreWarnings or -i) flag is optional. If present, CLI will return status '0', when the job state is warning.",
+                        "[2spaces]NOTE: Providing verbose (--verbose or -v) flag is optional. If present, CLI will log summary of every HTTP response."
                     ]
                 },
                 {

package/build/commands/job/internal/execute/sas9.js

@@ -56,34 +56,44 @@ function executeJobSas9(sasjs, config, jobPath, logFile, output, source) {
                 case 0:
                     macroVars = null;
                     if (!source) return [3 /*break*/, 2];
-                    return [4 /*yield*/, (0, parseSourceFile_1.parseSourceFile)(source)];
+                    return [4 /*yield*/, (0, parseSourceFile_1.parseSourceFile)(source)
+                        // timestamp of the execution start
+                    ];
                 case 1:
                     macroVars = _a.sent();
                     _a.label = 2;
                 case 2:
                     startTime = new Date().getTime();
-                    return [4 /*yield*/, sasjs.request(jobPath, macroVars, config)];
+                    return [4 /*yield*/, sasjs.request(jobPath, macroVars, config)
+                        // timestamp of the execution end
+                    ];
                 case 3:
                     result = _a.sent();
                     endTime = new Date().getTime();
-                    if (!result) return [3 /*break*/, 7];
-                    if (!(result.status === 200)) return [3 /*break*/, 6];
+                    if (!result) return [3 /*break*/, 9];
+                    if (!(result.status === 200)) return [3 /*break*/, 8];
+                    // handle success
                     process.logger.success("Job executed successfully! in ".concat((endTime - startTime) / 1000, " seconds"));
                     if (!(!!logFile && result.log)) return [3 /*break*/, 5];
-                    return [4 /*yield*/, (0, utils_1.saveLog)(result.log, logFile, jobPath, false)];
+                    return [4 /*yield*/, (0, utils_1.saveLog)(result.log, logFile, jobPath)
+                        // save output if it is present
+                    ];
                 case 4:
                     _a.sent();
                     _a.label = 5;
                 case 5:
-                    if (!!output && result.result) {
-                        (0, utils_1.saveOutput)(result.result, output, false);
-                    }
-                    return [3 /*break*/, 7];
+                    if (!(!!output && result.result)) return [3 /*break*/, 7];
+                    return [4 /*yield*/, (0, utils_1.saveOutput)(result.result, output)];
                 case 6:
+                    _a.sent();
+                    _a.label = 7;
+                case 7: return [3 /*break*/, 9];
+                case 8:
+                    // handle failure
                     process.logger.error(result.message);
                     process.logger.error(JSON.stringify(result.error, null, 2));
-                    _a.label = 7;
-                case 7: return [2 /*return*/, result];
+                    _a.label = 9;
+                case 9: return [2 /*return*/, result];
             }
         });
     });

package/build/commands/job/internal/execute/sasjs.d.ts

@@ -1,4 +1,12 @@
 import { Target } from '@sasjs/utils';
+/**
+ * Triggers existing job for execution on SASJS server.
+ * @param target - SASJS server configuration.
+ * @param jobPath - location of the job.
+ * @param logFile - flag indicating if CLI should fetch and save log to provided file path. If filepath wasn't provided, {job}.log file will be created in current folder.
+ * @param output - flag indicating if CLI should save output to provided file path.
+ * @returns - promise that resolves into an object with log and output.
+ */
 export declare function executeJobSasjs(target: Target, jobPath: string, logFile?: string, output?: string): Promise<{
     result: any;
     log: any;

package/build/commands/job/internal/execute/sasjs.js

@@ -40,6 +40,14 @@ exports.executeJobSasjs = void 0;
 var node_1 = require("@sasjs/adapter/node");
 var utils_1 = require("../../../../utils");
 var utils_2 = require("../utils");
+/**
+ * Triggers existing job for execution on SASJS server.
+ * @param target - SASJS server configuration.
+ * @param jobPath - location of the job.
+ * @param logFile - flag indicating if CLI should fetch and save log to provided file path. If filepath wasn't provided, {job}.log file will be created in current folder.
+ * @param output - flag indicating if CLI should save output to provided file path.
+ * @returns - promise that resolves into an object with log and output.
+ */
 function executeJobSasjs(target, jobPath, logFile, output) {
     var _a;
     return __awaiter(this, void 0, void 0, function () {
@@ -65,15 +73,18 @@ function executeJobSasjs(target, jobPath, logFile, output) {
                 case 5:
                     response = _c.sent();
                     if (!response) return [3 /*break*/, 9];
+                    // handle success
                     (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success('Job executed successfully!');
                     if (!(!!logFile && response.log)) return [3 /*break*/, 7];
-                    return [4 /*yield*/, (0, utils_2.saveLog)(response.log, logFile, jobPath, false)];
+                    return [4 /*yield*/, (0, utils_2.saveLog)(response.log, logFile, jobPath)
+                        // save output if it is present
+                    ];
                 case 6:
                     _c.sent();
                     _c.label = 7;
                 case 7:
                     if (!(!!output && response.result)) return [3 /*break*/, 9];
-                    return [4 /*yield*/, (0, utils_2.saveOutput)(response.result, output, false)];
+                    return [4 /*yield*/, (0, utils_2.saveOutput)(response.result, output)];
                 case 8:
                     _c.sent();
                     _c.label = 9;

package/build/commands/job/internal/execute/viya.d.ts

@@ -1,7 +1,7 @@
 import SASjs from '@sasjs/adapter/node';
 import { Target, AuthConfig } from '@sasjs/utils';
 /**
- * Triggers existing job for execution.
+ * Triggers existing job for execution on Viya server.
  * @param {object} sasjs - configuration object of SAS adapter.
  * @param {string} accessToken - an access token for an authorized user.
  * @param {string} jobPath - location of the job on SAS Drive.
@@ -10,10 +10,15 @@ import { Target, AuthConfig } from '@sasjs/utils';
  * @param {boolean | string} output - flag indicating if CLI should print out job output. If string was provided, it will be treated as file path to store output. If filepath wasn't provided, output.json file will be created in current folder.
  * @param {string | undefined} logFile - flag indicating if CLI should fetch and save log to provided file path. If filepath wasn't provided, {job}.log file will be created in current folder.
  * @param {string | undefined} statusFile - flag indicating if CLI should fetch and save status to the local file. If filepath wasn't provided, it will only print on console.
- * @param {boolean} returnStatusOnly - flag indicating if CLI should return status only (0 = success, 1 = warning, 3 = error).
  * @param {boolean} ignoreWarnings - flag indicating if CLI should return status '0', when the job state is warning.
  * @param {string | undefined} source - an optional path to a JSON file containing macro variables.
  * @param {boolean} streamLog - a flag indicating if the logs should be streamed to the supplied log path during job execution. This is useful for getting feedback on long running jobs.
+ * @param {boolean} verbose - enables verbose mode that logs summary of every HTTP response.
  */
-export declare function executeJobViya(sasjs: SASjs, authConfig: AuthConfig, jobPath: string, target: Target, waitForJob: boolean, output: string | boolean, logFile: string | undefined, statusFile: string | undefined, returnStatusOnly: boolean, ignoreWarnings: boolean, source: string | undefined, streamLog: boolean): Promise<any>;
-export declare function getContextName(target: Target, returnStatusOnly?: boolean): string;
+export declare function executeJobViya(sasjs: SASjs, authConfig: AuthConfig, jobPath: string, target: Target, waitForJob: boolean, output: string | boolean, logFile: string | undefined, statusFile: string | undefined, ignoreWarnings: boolean, source: string | undefined, streamLog: boolean, verbose: boolean): Promise<any>;
+/**
+ * Gets job execution context name.
+ * @param target - SAS server configuration.
+ * @returns - job execution context name.
+ */
+export declare function getContextName(target: Target): string;

package/build/commands/job/internal/execute/viya.js

@@ -50,7 +50,7 @@ var utils_2 = require("../../../../utils/");
 var command_1 = require("../../../../types/command");
 var utils_3 = require("../utils");
 /**
- * Triggers existing job for execution.
+ * Triggers existing job for execution on Viya server.
  * @param {object} sasjs - configuration object of SAS adapter.
  * @param {string} accessToken - an access token for an authorized user.
  * @param {string} jobPath - location of the job on SAS Drive.
@@ -59,15 +59,15 @@ var utils_3 = require("../utils");
  * @param {boolean | string} output - flag indicating if CLI should print out job output. If string was provided, it will be treated as file path to store output. If filepath wasn't provided, output.json file will be created in current folder.
  * @param {string | undefined} logFile - flag indicating if CLI should fetch and save log to provided file path. If filepath wasn't provided, {job}.log file will be created in current folder.
  * @param {string | undefined} statusFile - flag indicating if CLI should fetch and save status to the local file. If filepath wasn't provided, it will only print on console.
- * @param {boolean} returnStatusOnly - flag indicating if CLI should return status only (0 = success, 1 = warning, 3 = error).
  * @param {boolean} ignoreWarnings - flag indicating if CLI should return status '0', when the job state is warning.
  * @param {string | undefined} source - an optional path to a JSON file containing macro variables.
  * @param {boolean} streamLog - a flag indicating if the logs should be streamed to the supplied log path during job execution. This is useful for getting feedback on long running jobs.
+ * @param {boolean} verbose - enables verbose mode that logs summary of every HTTP response.
  */
-function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output, logFile, statusFile, returnStatusOnly, ignoreWarnings, source, streamLog) {
+function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output, logFile, statusFile, ignoreWarnings, source, streamLog, verbose) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var pollOptions, result, startTime, contextName, macroVars, submittedJob, endTime, sessionLink, outputJson, currentDirPath, outputPath, folderPath, parentFolderPath, logObj, logUrl, logCount, logData, error_1;
+        var pollOptions, result, startTime, contextName, macroVars, submittedJob, endTime, outputJson, currentDirPath, outputPath, folderPath, parentFolderPath, logObj, logUrl, logCount, logData, error_1;
         var _this = this;
         return __generator(this, function (_c) {
             switch (_c.label) {
@@ -79,16 +79,14 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                         logFolderPath: logFile
                     };
                     startTime = new Date().getTime();
-                    if (!(statusFile && !returnStatusOnly)) return [3 /*break*/, 2];
+                    if (!statusFile) return [3 /*break*/, 2];
                     return [4 /*yield*/, displayStatus({ state: 'Initiating' }, statusFile)];
                 case 1:
                     _c.sent();
                     _c.label = 2;
                 case 2:
-                    if (!returnStatusOnly) {
-                        (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success("Job located at ".concat(jobPath, " has been submitted for execution..."));
-                    }
-                    contextName = getContextName(target, returnStatusOnly);
+                    (_a = process.logger) === null || _a === void 0 ? void 0 : _a.success("Job located at ".concat(jobPath, " has been submitted for execution..."));
+                    contextName = getContextName(target);
                     if (!source) return [3 /*break*/, 5];
                     if (!(0, file_1.isJsonFile)(source))
                         throw 'Source file has to be JSON.';
@@ -108,7 +106,7 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                     }
                     _c.label = 5;
                 case 5: return [4 /*yield*/, sasjs
-                        .startComputeJob(jobPath, null, { contextName: contextName }, authConfig, waitForJob || !!logFile, pollOptions, true, macroVars === null || macroVars === void 0 ? void 0 : macroVars.macroVars)
+                        .startComputeJob(jobPath, null, { contextName: contextName }, authConfig, waitForJob || !!logFile, pollOptions, true, macroVars === null || macroVars === void 0 ? void 0 : macroVars.macroVars, verbose || undefined)
                         .catch(function (err) { return __awaiter(_this, void 0, void 0, function () {
                         var logData;
                         var _a;
@@ -117,32 +115,38 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                                 case 0:
                                     if (!(err instanceof node_1.NoSessionStateError)) return [3 /*break*/, 4];
                                     if (!(err === null || err === void 0 ? void 0 : err.logUrl)) return [3 /*break*/, 3];
-                                    return [4 /*yield*/, (0, fetchLogFileContent_1.fetchLogFileContent)(sasjs, authConfig.access_token, err.logUrl, 100000)];
+                                    return [4 /*yield*/, (0, fetchLogFileContent_1.fetchLogFileContent)(sasjs, authConfig.access_token, err.logUrl, 100000)
+                                        // save log
+                                    ];
                                 case 1:
                                     logData = _b.sent();
-                                    return [4 /*yield*/, (0, utils_3.saveLog)(logData, logFile, jobPath, returnStatusOnly)];
+                                    // save log
+                                    return [4 /*yield*/, (0, utils_3.saveLog)(logData, logFile, jobPath)];
                                 case 2:
+                                    // save log
                                     _b.sent();
                                     _b.label = 3;
                                 case 3:
                                     (0, displayResult_1.displayError)(err);
+                                    // terminate process with status code 2
                                     (0, utils_2.terminateProcess)(2);
                                     _b.label = 4;
                                 case 4:
                                     if (!(err === null || err === void 0 ? void 0 : err.log)) return [3 /*break*/, 6];
-                                    return [4 /*yield*/, (0, utils_3.saveLog)(err.log, logFile, jobPath, returnStatusOnly)];
+                                    return [4 /*yield*/, (0, utils_3.saveLog)(err.log, logFile, jobPath)
+                                        // handle use case when job wasn't found
+                                    ];
                                 case 5:
                                     _b.sent();
                                     _b.label = 6;
                                 case 6:
-                                    if (returnStatusOnly)
-                                        (0, utils_2.terminateProcess)(2);
+                                    // handle use case when job wasn't found
                                     if ((err === null || err === void 0 ? void 0 : err.name) === 'NotFoundError') {
                                         throw new Error("Job located at '".concat(jobPath, "' was not found."));
                                     }
-                                    result = returnStatusOnly
-                                        ? command_1.ReturnCode.InternalError
-                                        : typeof err === 'object' && Object.keys(err).length
+                                    // get additional information about error if it is present
+                                    result =
+                                        typeof err === 'object' && Object.keys(err).length
                                             ? JSON.stringify({ state: (_a = err.job) === null || _a === void 0 ? void 0 : _a.state })
                                             : "".concat(err);
                                     if (err.job) {
@@ -151,17 +155,21 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                                     return [2 /*return*/];
                             }
                         });
-                    }); })];
+                    }); })
+                    // job execution end time
+                ];
                 case 6:
                     submittedJob = _c.sent();
                     endTime = new Date().getTime();
-                    if (result && !returnStatusOnly) {
+                    if (result) {
                         (0, displayResult_1.displayError)(result, 'An error has occurred when executing a job.');
                     }
                     if (submittedJob && submittedJob.job)
                         submittedJob = submittedJob.job;
-                    if (!(statusFile && !returnStatusOnly)) return [3 /*break*/, 8];
-                    return [4 /*yield*/, displayStatus(submittedJob, statusFile, result, true)];
+                    if (!statusFile) return [3 /*break*/, 8];
+                    return [4 /*yield*/, displayStatus(submittedJob, statusFile, result, true)
+                        // job execution completed successfully
+                    ];
                 case 7:
                     _c.sent();
                     _c.label = 8;
@@ -169,7 +177,6 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                     if (!(submittedJob && submittedJob.links)) return [3 /*break*/, 21];
                     if (!result)
                         result = true;
-                    sessionLink = submittedJob.links.find(function (l) { return l.method === 'GET' && l.rel === 'self'; }).href;
                     if (!(output || logFile)) return [3 /*break*/, 20];
                     _c.label = 9;
                 case 9:
@@ -195,13 +202,13 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                 case 12: return [4 /*yield*/, (0, utils_1.createFile)(outputPath, outputJson)];
                 case 13:
                     _c.sent();
-                    if (!returnStatusOnly)
-                        (0, displayResult_1.displaySuccess)("Output saved to: ".concat(outputPath));
+                    (0, displayResult_1.displaySuccess)("Output saved to: ".concat(outputPath));
                     return [3 /*break*/, 15];
                 case 14:
                     if (output) {
-                        if (!returnStatusOnly)
-                            (process.logger || console).log(outputJson);
+                        // log job object to the console
+                        ;
+                        (process.logger || console).log(outputJson);
                     }
                     _c.label = 15;
                 case 15:
@@ -213,7 +220,7 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                     return [4 /*yield*/, (0, fetchLogFileContent_1.fetchLogFileContent)(sasjs, authConfig.access_token, logUrl, logCount)];
                 case 16:
                     logData = _c.sent();
-                    return [4 /*yield*/, (0, utils_3.saveLog)(logData, logFile, jobPath, returnStatusOnly)];
+                    return [4 /*yield*/, (0, utils_3.saveLog)(logData, logFile, jobPath)];
                 case 17:
                     _c.sent();
                     _c.label = 18;
@@ -222,17 +229,19 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                     return [3 /*break*/, 20];
                 case 19:
                     error_1 = _c.sent();
+                    // handle use case when submitted job can't be parsed
                     result = false;
-                    if (!returnStatusOnly) {
-                        (0, displayResult_1.displayError)(null, 'An error has occurred when parsing an output of the job.');
-                    }
+                    (0, displayResult_1.displayError)(null, 'An error has occurred when parsing an output of the job.');
                     return [3 /*break*/, 20];
                 case 20:
-                    if (waitForJob && returnStatusOnly && submittedJob.state) {
+                    // wait for job state and return status(0,1,2) based on it
+                    if (waitForJob && submittedJob.state) {
                         switch (submittedJob.state) {
                             case 'completed':
                                 (0, utils_2.terminateProcess)(0);
                             case 'warning':
+                                // if ignoreWarnings flag is present, process will be terminated with
+                                // status code 0, otherwise status code will be 1
                                 (0, utils_2.terminateProcess)(ignoreWarnings ? 0 : 1);
                             case 'error':
                                 (0, utils_2.terminateProcess)(2);
@@ -242,14 +251,12 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
                     }
                     return [3 /*break*/, 22];
                 case 21:
-                    if (returnStatusOnly && result === 2) {
-                        (0, utils_2.terminateProcess)(2);
+                    if (result) {
+                        (0, utils_2.terminateProcess)(command_1.ReturnCode.InternalError);
                     }
                     _c.label = 22;
                 case 22:
-                    if (!returnStatusOnly) {
-                        (_b = process.logger) === null || _b === void 0 ? void 0 : _b.info("This job was executed in ".concat((endTime - startTime) / 1000, " seconds"));
-                    }
+                    (_b = process.logger) === null || _b === void 0 ? void 0 : _b.info("This job was executed in ".concat((endTime - startTime) / 1000, " seconds"));
                     return [2 /*return*/, result];
             }
         });
@@ -257,18 +264,29 @@ function executeJobViya(sasjs, authConfig, jobPath, target, waitForJob, output,
 }
 exports.executeJobViya = executeJobViya;
 // REFACTOR: should be a utility
-function getContextName(target, returnStatusOnly) {
+/**
+ * Gets job execution context name.
+ * @param target - SAS server configuration.
+ * @returns - job execution context name.
+ */
+function getContextName(target) {
     var _a;
-    if (returnStatusOnly === void 0) { returnStatusOnly = false; }
+    // default execution context of @sasjs/cli
     var defaultContextName = utils_2.contextName;
+    // get gontext name from target
     if (target === null || target === void 0 ? void 0 : target.contextName)
         return target.contextName;
-    if (!returnStatusOnly) {
-        (_a = process.logger) === null || _a === void 0 ? void 0 : _a.warn("`contextName` was not provided in your target configuration. Falling back to context ".concat(defaultContextName));
-    }
+    (_a = process.logger) === null || _a === void 0 ? void 0 : _a.warn("`contextName` was not provided in your target configuration. Falling back to context ".concat(defaultContextName));
     return defaultContextName;
 }
 exports.getContextName = getContextName;
+/**
+ * Logs to the console or writes job status to the file.
+ * @param submittedJob - job submitted fro execution.
+ * @param statusFile - file path to the status file.
+ * @param error - error generated during job execution.
+ * @param displayStatusFilePath - boolean indicating if file path to the status file should be logged.
+ */
 function displayStatus(submittedJob, statusFile, error, displayStatusFilePath) {
     if (error === void 0) { error = ''; }
     if (displayStatusFilePath === void 0) { displayStatusFilePath = false; }
@@ -283,10 +301,14 @@ function displayStatus(submittedJob, statusFile, error, displayStatusFilePath) {
                     status = adapterStatus === 'Not Available'
                         ? "Job Status: ".concat(adapterStatus, "\nDetails: ").concat(error, "\n")
                         : "Job Status: ".concat(adapterStatus);
-                    if (adapterStatus === 'Initiating' || adapterStatus === 'completed')
+                    // handle job states 'Initiating' and 'completed'
+                    if (adapterStatus === 'Initiating' || adapterStatus === 'completed') {
                         (0, displayResult_1.displaySuccess)(status);
-                    else
+                    }
+                    // display an job status as an error
+                    else {
                         (0, displayResult_1.displayError)({}, status);
+                    }
                     if (!statusFile) return [3 /*break*/, 5];
                     folderPath = statusFile.split(path_1.default.sep);
                     folderPath.pop();
@@ -298,9 +320,12 @@ function displayStatus(submittedJob, statusFile, error, displayStatusFilePath) {
                 case 2:
                     _a.sent();
                     _a.label = 3;
-                case 3: return [4 /*yield*/, (0, utils_1.createFile)(statusFile, status)];
+                case 3: return [4 /*yield*/, (0, utils_1.createFile)(statusFile, status)
+                    // display file path to status file
+                ];
                 case 4:
                     _a.sent();
+                    // display file path to status file
                     if (displayStatusFilePath)
                         (0, displayResult_1.displaySuccess)("Status saved to: ".concat(statusFile));
                     _a.label = 5;

package/build/commands/job/internal/utils.d.ts

@@ -1,2 +1,13 @@
-export declare const saveLog: (logData: any, logFile: string | undefined, jobPath: string, returnStatusOnly: boolean) => Promise<void>;
-export declare const saveOutput: (outputData: any, outputFile: string, returnStatusOnly: boolean) => Promise<void>;
+/**
+ * Saves log to a file.
+ * @param logData - log content.
+ * @param logFile - file path to log file.
+ * @param jobPath - file path to the job submitted for execution.
+ */
+export declare const saveLog: (logData: any, logFile: string | undefined, jobPath: string) => Promise<void>;
+/**
+ * Saves job output to the file.
+ * @param outputData - job output.
+ * @param outputFile - file path to output file.
+ */
+export declare const saveOutput: (outputData: any, outputFile: string) => Promise<void>;

package/build/commands/job/internal/utils.js

@@ -44,14 +44,23 @@ var path_1 = __importDefault(require("path"));
 var utils_1 = require("@sasjs/utils");
 var utils_2 = require("../../../utils/utils");
 var displayResult_1 = require("../../../utils/displayResult");
-var saveLog = function (logData, logFile, jobPath, returnStatusOnly) { return __awaiter(void 0, void 0, void 0, function () {
+/**
+ * Saves log to a file.
+ * @param logData - log content.
+ * @param logFile - file path to log file.
+ * @param jobPath - file path to the job submitted for execution.
+ */
+var saveLog = function (logData, logFile, jobPath) { return __awaiter(void 0, void 0, void 0, function () {
     var logPath, folderPath, parentFolderPath, logLines;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
+                // use provide file path to log file
                 if (logFile) {
                     logPath = logFile;
                 }
+                // use file path based on job file path
+                // the same file name will be used, but with *.log extension
                 else {
                     logPath = path_1.default.join(process.projectDir, "".concat(jobPath.split(path_1.default.sep).slice(-1).pop(), ".log"));
                 }
@@ -70,18 +79,23 @@ var saveLog = function (logData, logFile, jobPath, returnStatusOnly) { return __
                 return [4 /*yield*/, (0, utils_1.createFile)(logPath, logLines)];
             case 4:
                 _a.sent();
-                if (!returnStatusOnly)
-                    (0, displayResult_1.displaySuccess)("Log saved to ".concat(logPath));
+                (0, displayResult_1.displaySuccess)("Log saved to ".concat(logPath));
                 return [2 /*return*/];
         }
     });
 }); };
 exports.saveLog = saveLog;
-var saveOutput = function (outputData, outputFile, returnStatusOnly) { return __awaiter(void 0, void 0, void 0, function () {
+/**
+ * Saves job output to the file.
+ * @param outputData - job output.
+ * @param outputFile - file path to output file.
+ */
+var saveOutput = function (outputData, outputFile) { return __awaiter(void 0, void 0, void 0, function () {
     var currentDirPath, outputPath, folderPath, parentFolderPath;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
+                // try to convert job output into a string
                 try {
                     outputData = JSON.stringify(outputData, null, 2);
                 }
@@ -105,8 +119,7 @@ var saveOutput = function (outputData, outputFile, returnStatusOnly) { return __
             case 3: return [4 /*yield*/, (0, utils_1.createFile)(outputPath, outputData)];
             case 4:
                 _a.sent();
-                if (!returnStatusOnly)
-                    (0, displayResult_1.displaySuccess)("Output saved to: ".concat(outputPath));
+                (0, displayResult_1.displaySuccess)("Output saved to: ".concat(outputPath));
                 return [2 /*return*/];
         }
     });

package/build/commands/job/jobCommand.d.ts

@@ -4,8 +4,27 @@ import { TargetCommand } from '../../types/command/targetCommand';
 export declare class JobCommand extends TargetCommand {
     private jobSubCommands;
     constructor(args: string[]);
+    /**
+     * Method responsible for command execution.
+     * @returns - promise that resolves into return code.
+     */
     execute(): Promise<ReturnCode>;
+    /**
+     * Executes job on SASJS server.
+     * @param target - SASJS server configuration.
+     * @returns - promise that resolves into return code.
+     */
     executeJobSasjs(target: Target): Promise<ReturnCode>;
+    /**
+     * Executes job on SAS9 server.
+     * @param target - SAS9 server configuration.
+     * @returns - promise that resolves into return code.
+     */
     executeJobSas9(target: Target): Promise<ReturnCode>;
+    /**
+     * Executes job on Viya server.
+     * @param target - Viya server configuration.
+     * @returns - promise that resolves into return code.
+     */
     executeJobViya(target: Target): Promise<ReturnCode>;
 }