@axway/axway-central-cli 2.17.0-rc.5 → 2.17.0

package/dist/common/Renderer.js

@@ -4,75 +4,86 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+
 var _cliKit = require("cli-kit");
+
 var _ora = _interopRequireDefault(require("ora"));
+
 var _CompositeError = require("./CompositeError");
+
 var _resultsRenderers = require("./resultsRenderers");
+
 var _types = require("./types");
+
 var _utils = require("./utils");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+
 var _createApiServerErrorMessage = /*#__PURE__*/new WeakSet();
+
 class Renderer {
   constructor(console, output) {
-    /**
-     * Creates an error message for the given ApiResponseError title and detail strings.
-     * @param prefix String to be prefixed to the message.
-     * @param title Optional title such as "Validation error", "Forbidden error", etc.
-     * @param detail Optional error detail explaining exactly what went wrong.
-     * @returns Returns an error message to be outputted to the console.
-     */
     _classPrivateMethodInitSpec(this, _createApiServerErrorMessage);
+
     _defineProperty(this, "spinner", void 0);
+
     _defineProperty(this, "_console", void 0);
+
     _defineProperty(this, "output", void 0);
+
     this.spinner = process.env['DEBUG'] || !!output ? null : (0, _ora.default)({
       spinner: 'dots3'
     });
     this._console = console;
     this.output = output;
   }
-
   /**
    * Start the spinner and return self
    * @param text text to display near the spinner
    */
+
+
   startSpin(text) {
     this.spinner && this.spinner.start(text);
     return this;
   }
-
   /**
    * Stop the spinner
    */
+
+
   stopSpin() {
     this.spinner && this.spinner.stop();
     return this;
   }
-
   /**
    * Replaces the text shown by startSpin(). Intended to show progress.
    * @param text The text to displayed next to the spinner.
    */
+
+
   updateSpinText(text) {
     if (this.spinner) {
       this.spinner.text = text;
     }
   }
-
   /**
    * Print simple text to console
    * @param text text to render
    */
+
+
   console(text) {
     this._console.log(text);
   }
-
   /**
    * Render success message. If output param has been provided use simple console
    * otherwise use spinner.
@@ -80,10 +91,11 @@ class Renderer {
    * @param spinnerOnly optional, if its true message will be rendered
    * only when spinner is in use (which mean no output param has been provided)
    */
+
+
   success(text, spinnerOnly = false) {
     this.output && !spinnerOnly ? this.console(text) : this.spinner && this.spinner.succeed((0, _cliKit.chalk)`{greenBright ${text}}`);
   }
-
   /**
    * Render warning message. If output param has been provided use simple console
    * otherwise use spinner.
@@ -91,10 +103,11 @@ class Renderer {
    * @param spinnerOnly optional, if its true message will be rendered
    * only when spinner is in use (which mean no output param has been provided)
    */
+
+
   warning(text, spinnerOnly = false) {
     this.output && !spinnerOnly ? this.console(text) : this.spinner && this.spinner.warn((0, _cliKit.chalk)`{yellow ${text}}`);
   }
-
   /**
    * Render error message. If output param has been provided use simple console
    * otherwise use spinner.
@@ -102,48 +115,57 @@ class Renderer {
    * @param spinnerOnly optional, if true message will be rendered
    * only when spinner is in use (which mean no output param has been provided)
    */
+
+
   error(text, spinnerOnly = false) {
     this.output && !spinnerOnly ? this.console(text) : this.spinner && this.spinner.fail((0, _cliKit.chalk)`{red ${text}}`);
   }
-
   /**
    * A helper returning `"<resource kind>/<resource name>" in the scope "<scope kind>/<scope name>"`
    * string used to print bulk results (in "bulkResult" or "bulkCreateOrUpdateResult") or individually (see the "delete" cmd)
    * @param {GenericResource} resource resource for witch the string should be created
    * @returns {string}
    */
+
+
   resourceAndScopeKinds(resource) {
     var _resource$metadata;
+
     // prettier-ignore
     return `"${resource.kind}/${resource.name}"${!!((_resource$metadata = resource.metadata) !== null && _resource$metadata !== void 0 && _resource$metadata.scope) ? ` in the scope "${resource.metadata.scope.kind}/${resource.metadata.scope.name}"` : ``}`;
   }
-
   /**
    * Render bulk call result.
    * If error is happening - render as simple output (even if "output" param has been provided)
    * @param bulkResult bulk response from ApiServerClient
    * @param simpleSuccessMsg message to display for each created "kind/name"
    */
+
+
   bulkResult(bulkResult, simpleSuccessMsg) {
     if (bulkResult.error.length) {
       var _bulkResult$warning;
+
       (_bulkResult$warning = bulkResult.warning) === null || _bulkResult$warning === void 0 ? void 0 : _bulkResult$warning.forEach(r => this.warning(`${this.resourceAndScopeKinds(r)} was created with an autogenerated logical name.`));
       bulkResult.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${simpleSuccessMsg}`));
       bulkResult.error.forEach(r => this.anyError(r.error, `"${r.kind}/${r.name}" `, true));
     } else if (this.output) {
       var _bulkResult$warning2;
+
       let results = bulkResult.success;
+
       if ((_bulkResult$warning2 = bulkResult.warning) !== null && _bulkResult$warning2 !== void 0 && _bulkResult$warning2.length) {
         results = bulkResult.warning.concat(results);
       }
+
       (0, _resultsRenderers.renderResponse)(this._console, results, this.output);
     } else {
       var _bulkResult$warning3;
+
       (_bulkResult$warning3 = bulkResult.warning) === null || _bulkResult$warning3 === void 0 ? void 0 : _bulkResult$warning3.forEach(r => this.warning(`${this.resourceAndScopeKinds(r)} was created with an autogenerated logical name.`));
       bulkResult.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${simpleSuccessMsg}`));
     }
   }
-
   /**
    * Render bulk "apply" result (with different success messages).
    * If error is happening - render as simple output (even if "output" param has been provided)
@@ -151,6 +173,8 @@ class Renderer {
    * @param createSuccessMsg message to display for each created "kind/name"
    * @param updateSuccessMsg message to display for each updated "kind/name"
    */
+
+
   bulkCreateOrUpdateResult(bulkResult, createSuccessMsg, updateSuccessMsg, createWarningMsg) {
     // if array passed, combine in a single ApiServerClientBulkResult, else use as-is
     const bulkResultCombined = {
@@ -158,26 +182,33 @@ class Renderer {
       error: [...bulkResult.created.error, ...bulkResult.updated.error],
       warning: [bulkResult.created.warning]
     };
+
     if (bulkResultCombined.error.length) {
       var _bulkResult$created$w;
+
       (_bulkResult$created$w = bulkResult.created.warning) === null || _bulkResult$created$w === void 0 ? void 0 : _bulkResult$created$w.forEach(r => this.warning(`${this.resourceAndScopeKinds(r)} ${createWarningMsg}`));
       bulkResult.created.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${createSuccessMsg}`));
       bulkResult.updated.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${updateSuccessMsg}`));
       bulkResultCombined.error.forEach(r => this.anyError(r.error, `"${r.kind}/${r.name}" `, true));
     } else if (this.output) {
       var _bulkResult$created$w2;
+
       let results = bulkResultCombined.success;
+
       if ((_bulkResult$created$w2 = bulkResult.created.warning) !== null && _bulkResult$created$w2 !== void 0 && _bulkResult$created$w2.length) {
         results = bulkResult.created.warning.concat(results);
       }
+
       (0, _resultsRenderers.renderResponse)(this._console, results, this.output);
     } else {
       var _bulkResult$created$w3;
+
       (_bulkResult$created$w3 = bulkResult.created.warning) === null || _bulkResult$created$w3 === void 0 ? void 0 : _bulkResult$created$w3.forEach(r => this.warning(`${this.resourceAndScopeKinds(r)} ${createWarningMsg}`));
       bulkResult.created.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${createSuccessMsg}`));
       bulkResult.updated.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${updateSuccessMsg}`));
     }
   }
+
   renderGetResults(bulkResultsArray, successMsg) {
     // sort all results by success / error
     // IMPORTANT: mind the response.data! non-null assertion later on, should be covered by this loop
@@ -188,6 +219,7 @@ class Renderer {
       success: [],
       error: []
     });
+
     if (this.output) {
       /**
        * IF bulkResultsArray.length === 1 this means user query only for a single resource (entire list or by name,
@@ -196,8 +228,10 @@ class Renderer {
        * dataToRender to first "success" element (sortedResults will also include only one element in this case).
        */
       let dataToRender = [];
+
       if (bulkResultsArray.length === 1) {
         var _sortedResults$succes, _sortedResults$succes2;
+
         dataToRender = ((_sortedResults$succes = sortedResults.success[0]) === null || _sortedResults$succes === void 0 ? void 0 : (_sortedResults$succes2 = _sortedResults$succes.response) === null || _sortedResults$succes2 === void 0 ? void 0 : _sortedResults$succes2.data) || {};
       } else {
         /**
@@ -209,6 +243,7 @@ class Renderer {
           return a;
         }, []);
       }
+
       (0, _resultsRenderers.renderResponse)(this._console, dataToRender, this.output);
     } else {
       // stop spinner and render a table for each successful request
@@ -219,19 +254,19 @@ class Renderer {
       }, {
         empty: [],
         notEmpty: []
-      });
-      // if all results are empty, render just once, otherwise render only successful results
+      }); // if all results are empty, render just once, otherwise render only successful results
+
       if (!sortedSuccess.notEmpty.length && sortedSuccess.empty.length) {
         (0, _resultsRenderers.renderResponse)(this._console, sortedSuccess.empty[0].response.data, this.output, sortedSuccess.empty[0].columns);
       } else {
         sortedSuccess.notEmpty.forEach(v => (0, _resultsRenderers.renderResponse)(this._console, v.response.data, this.output, v.columns));
       }
-    }
-    // rendering errors only if there are zero successful results,
+    } // rendering errors only if there are zero successful results,
     // also assuming only first (and only) error will be in api-server error response in case of 404
+
+
     if (!sortedResults.success.length) sortedResults.error.forEach(v => v.response.error && this.error(`Error: ${v.response.error[0].detail || v.response.error[0].title}`));
   }
-
   /**
    * Render any kind of error
    * @param error error or ApiServer error to render
@@ -239,11 +274,15 @@ class Renderer {
    * @param ignoreOutputParam if provided as true will ignore the output param and always render
    * the error message as set of strings. Currently used in bulk result renderers in case of any errors.
    */
+
+
   anyError(error, prefixMsg = '', ignoreOutputParam = false) {
     var _error$errors;
+
     if ((this.output === _types.OutputTypes.json || this.output === _types.OutputTypes.yaml) && !ignoreOutputParam) {
       // Output given error to a JSON or YAML format.
       let response;
+
       if ((0, _utils.isApiServerErrorType)(error) || (0, _utils.isApiServerErrorResponseType)(error)) {
         if (error instanceof Error && error.name === 'HTTPError' && error.errors) {
           // The HTTP response has an errors array. Only log that part.
@@ -259,6 +298,7 @@ class Renderer {
           message: error === null || error === void 0 ? void 0 : error.message
         };
       }
+
       (0, _resultsRenderers.renderResponse)(this._console, response, this.output);
     } else if (error instanceof _CompositeError.CompositeError) {
       // A hierarchy of nested errors was provided. Log it with appropriate indentation.
@@ -266,6 +306,7 @@ class Renderer {
         const indentation = this.output ? '' : '  ';
         this.error(compositeError.toNestedMessageArray().join(`\n${indentation}`));
       };
+
       if (error.message) {
         // Root error has a message. Log entire error hierarchy as a single error.
         logCompositeError(error);
@@ -292,6 +333,7 @@ class Renderer {
       // ELSE this is ApiServer error or ApiServer error response
       // using just first error from api response since all bulk operations executed one-by-one for now
       const err = error;
+
       switch (err.status) {
         // TODO: some pasta here: 401 thrown manually on data service, fix it?
         // https://jira.axway.com/browse/APIGOV-20818
@@ -302,10 +344,12 @@ class Renderer {
           this.console('Or if using a service account:');
           this.console((0, _cliKit.chalk)`{cyan axway auth login --client-id <Service Account Client ID> --secret-file <Private Key>}`);
           break;
+
         case 400:
           this.error(_classPrivateMethodGet(this, _createApiServerErrorMessage, _createApiServerErrorMessage2).call(this, prefixMsg, err.title, err.detail));
           if (err.source) this.console(_cliKit.chalk.gray(`Caused by: ${JSON.stringify(err.source)}`));
           break;
+
         case 403:
         case 404:
         case 409:
@@ -314,6 +358,7 @@ class Renderer {
           // status 0 used for internal errors (see ApiServerClient.deleteSingleResource wait logic)
           this.error(_classPrivateMethodGet(this, _createApiServerErrorMessage, _createApiServerErrorMessage2).call(this, prefixMsg, err.title, err.detail));
           break;
+
         default:
           // rare case, should almost never happen.
           if (error instanceof Error) {
@@ -321,22 +366,39 @@ class Renderer {
           } else {
             this.error(`An unknown error occurred, try different output formats (for ex.: "-o ${_types.OutputTypes.json}") to find out more details.`);
           }
+
       }
     }
   }
+  /**
+   * Creates an error message for the given ApiResponseError title and detail strings.
+   * @param prefix String to be prefixed to the message.
+   * @param title Optional title such as "Validation error", "Forbidden error", etc.
+   * @param detail Optional error detail explaining exactly what went wrong.
+   * @returns Returns an error message to be outputted to the console.
+   */
+
+
 }
+
 exports.default = Renderer;
+
 function _createApiServerErrorMessage2(prefix, title, detail) {
   let message = prefix;
+
   if (message.length > 0 && !message.endsWith(' ')) {
     message += ' ';
   }
+
   message += title || 'Error';
+
   if (detail) {
     if (!message.endsWith(':') && !message.endsWith('.') && !message.endsWith('!')) {
       message += ':';
     }
+
     message += ' ' + detail;
   }
+
   return message;
 }

package/dist/common/TmpFile.js

@@ -4,19 +4,27 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+
 var _fs = require("fs");
+
 var _snooplogg = _interopRequireDefault(require("snooplogg"));
+
 var _tmp = _interopRequireDefault(require("tmp"));
+
 var _resultsRenderers = require("../common/resultsRenderers");
+
 var _utils = require("../common/utils");
+
 var _bashCommands = require("./bashCommands");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 const {
   log
 } = (0, _snooplogg.default)('central:class.TmpFile');
+
 class TmpFile {
   /**
    * Init temporary file if "data" is provided - write data to file (as YAML at the moment)
@@ -24,46 +32,50 @@ class TmpFile {
    */
   constructor(data) {
     _defineProperty(this, "file", void 0);
+
     _defineProperty(this, "path", void 0);
-    log('crating a new file');
-    // discardDescriptor = true is required for windows (fixes "file is open by another process" error).
+
+    log('crating a new file'); // discardDescriptor = true is required for windows (fixes "file is open by another process" error).
+
     this.file = _tmp.default.fileSync({
       discardDescriptor: true,
       prefix: 'axway-central-edit-',
       postfix: '.yaml'
     });
     this.path = this.file.name;
-    log(`file created at: ${this.path}`);
-    // if data is provided write it to the file as YAML
+    log(`file created at: ${this.path}`); // if data is provided write it to the file as YAML
+
     data && this.write((0, _resultsRenderers.parseAsYaml)(data));
   }
-
   /**
    * Delete tmp file
    */
+
+
   delete() {
     log(`removing: ${this.path}`);
     this.file.removeCallback();
   }
-
   /**
    * Write to file
    * @param {string} data data to write
    */
+
+
   write(data) {
     log(`writing to: ${this.path}`);
     (0, _fs.writeFileSync)(this.path, data);
   }
-
   /**
    * Read file as string (as is)
    * @return {string} data from file
    */
+
+
   read() {
     log(`reading from: ${this.path}`);
     return (0, _fs.readFileSync)(this.path, 'utf8');
   }
-
   /**
    * Open file in editor and return promise with flags indicating if edit was successful or not
    * (process killed, vim q! happened etc. ), and if file content has been changed or not.
@@ -72,12 +84,15 @@ class TmpFile {
    * isComplete: editor process completed successfully
    * isUpdated: content of the file changed
    */
+
+
   async edit() {
     log(`editing: ${this.path}`);
     const editorToUse = _utils.isWindows ? 'notepad' : process.env.EDITOR || 'vi';
     const contentBeforeEdit = Buffer.from(this.read());
     const editorExitCode = await (0, _bashCommands.editor)(editorToUse, this.path);
     const isUpdated = !contentBeforeEdit.equals(Buffer.from(this.read()));
+
     if (editorExitCode === 0) {
       log('file edit has been successful');
       return {
@@ -92,5 +107,7 @@ class TmpFile {
       };
     }
   }
+
 }
+
 exports.default = TmpFile;

package/dist/common/bashCommands.js

@@ -4,21 +4,26 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.openssl = exports.isOpenSslInstalled = exports.editor = exports.createTlsCert = exports.createKeyPair = void 0;
+
 var _child_process = require("child_process");
+
 var _path = _interopRequireDefault(require("path"));
+
 var _snooplogg = _interopRequireDefault(require("snooplogg"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 /* istanbul ignore file */
 // note: mocking/stubbing spawn is not a trivial task and causes some problems
 // if done incorrectly. Need to find a good way to test it.
-
 const {
   log
-} = (0, _snooplogg.default)('central: bashCommands');
+} = (0, _snooplogg.default)('central: bashCommands'); // mask / unmask used in file paths for preventing incorrect params split in "openssl" function
 
-// mask / unmask used in file paths for preventing incorrect params split in "openssl" function
 const maskSpaces = str => str.replace(/ /g, '<SPACE_REPLACEMENT>');
+
 const unmaskSpaces = str => str.replace(/<SPACE_REPLACEMENT>/g, ' ');
+
 const openssl = (params, showStdio = false) => {
   const parsedParams = params.split(' ').map(unmaskSpaces);
   const process = (0, _child_process.spawn)('openssl', parsedParams, {
@@ -49,18 +54,25 @@ const openssl = (params, showStdio = false) => {
     });
   });
 };
+
 exports.openssl = openssl;
+
 const isOpenSslInstalled = async () => await openssl('version').then(res => {
   if (res && !res.isComplete) {
     throw Error('OpenSSL is not installed, and must be installed to proceed with TLS certificate creation. Please install OpenSSL and try again.');
   }
+
   return true;
 });
+
 exports.isOpenSslInstalled = isOpenSslInstalled;
+
 const createKeyPair = async () => {
   // note: space in file name is not supported
   let privateKey = _path.default.join(process.cwd(), 'private_key.pem');
+
   let publicKey = _path.default.join(process.cwd(), 'public_key.pem');
+
   const privKeyRes = await openssl(`genpkey -algorithm RSA -out ${maskSpaces(privateKey)} -pkeyopt rsa_keygen_bits:2048`);
   if (privKeyRes.code === 1) throw new Error('OpenSSL failed to create the private key');
   const pubKeyRes = await openssl(`rsa -pubout -in ${maskSpaces(privateKey)} -out ${maskSpaces(publicKey)}`);
@@ -70,11 +82,15 @@ const createKeyPair = async () => {
     privateKey
   };
 };
+
 exports.createKeyPair = createKeyPair;
+
 const createTlsCert = async (secretName, domain) => {
   // note: space in file name is not supported
   const cert = _path.default.join(process.cwd(), `${secretName}.crt`);
+
   const privateKey = _path.default.join(process.cwd(), `${secretName}.key`);
+
   const output = await openssl(`req -new -newkey rsa:4096 -days 3650 -nodes -x509 -subj /C=US/ST=AZ/L=Phoenix/O=Axway/CN=${domain} -keyout ${maskSpaces(privateKey)} -out ${maskSpaces(cert)}`);
   if (output.code === 1) throw new Error('OpenSSL failed to create the certificate');
   return {
@@ -82,7 +98,9 @@ const createTlsCert = async (secretName, domain) => {
     privateKey
   };
 };
+
 exports.createTlsCert = createTlsCert;
+
 const editor = (editor, filePath) => {
   log(`editor ${filePath}`);
   return new Promise(resolve => {
@@ -94,4 +112,5 @@ const editor = (editor, filePath) => {
     });
   });
 };
+
 exports.editor = editor;