@axway/axway-central-cli 4.5.0 → 4.6.0-rc.0

package/dist/common/CacheController.js

@@ -1,146 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CacheController = void 0;
-var _dayjs = _interopRequireDefault(require("dayjs"));
-var _fsExtra = require("fs-extra");
-var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
-var _nodeCache = _interopRequireDefault(require("node-cache"));
-var _os = require("os");
-var _path = _interopRequireDefault(require("path"));
-var _snooplogg = _interopRequireDefault(require("snooplogg"));
-var _types = require("./types");
-var _utils = require("./utils");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-const {
-  log
-} = (0, _snooplogg.default)('central: CacheController');
-/**
- * Note: this file intentionally exporting only a single instance of CacheController,
- * since its possible to face a race condition when multiple instances will try to read/write file at the same time
- * Please do not use this class directly or rework the logic before.
- */
-class CacheControllerClass {
-  constructor() {
-    _defineProperty(this, "cacheFilePath", _path.default.join((0, _os.homedir)(), '.axway', 'central', 'cache.json'));
-    _defineProperty(this, "cache", new _nodeCache.default());
-    // note: init cache fire only once since using only a single instance of the class, remove if this will change
-    this.initCacheFile();
-    this.readFromFile();
-  }
-
-  /**
-   * Inits and validate cache file, should run once before using this class in the code (initialized in cli.ts currently)
-   * An empty JSON file will be created if it is not exists of the file size is more than some value.
-   */
-  initCacheFile() {
-    try {
-      if ((0, _fsExtra.pathExistsSync)(this.cacheFilePath)) {
-        log(`init, cache file found at ${this.cacheFilePath}`);
-        const stats = (0, _fsExtra.lstatSync)(this.cacheFilePath);
-        log(`init, cache file size: ${Math.round(stats.size / 1000)} kb`);
-        if (stats.size >= _types.MAX_CACHE_FILE_SIZE) {
-          // validating the size
-          log(`init, cache size is exceeding the max allowed size of ${Math.round(_types.MAX_CACHE_FILE_SIZE / 1000)} kb, resetting the file`);
-          (0, _fsExtra.outputJsonSync)(this.cacheFilePath, {});
-        } else if (!(0, _utils.isValidJson)((0, _fsExtra.readFileSync)(this.cacheFilePath, 'utf8'))) {
-          // validating the content
-          log('init, cache content is invalid, resetting the file ');
-          (0, _fsExtra.outputJsonSync)(this.cacheFilePath, {});
-        }
-      } else {
-        log(`init, cache file not found, creating an empty one at ${this.cacheFilePath}`);
-        (0, _fsExtra.outputJsonSync)(this.cacheFilePath, {});
-      }
-    } catch (e) {
-      log(`cannot initialize cache file`, e);
-    }
-  }
-
-  /**
-   * Set the key in memory cache.
-   * @param key cache key to set
-   * @param value value to set, note that setting "undefined" value will result in "null" value stored
-   * @returns CacheController instance
-   */
-  set(key, value) {
-    this.cache.set(key, value);
-    return this;
-  }
-
-  /**
-   * Returns the key value from the memory cache.
-   * @param key key to get
-   * @returns key value
-   */
-  get(key) {
-    return this.cache.get(key);
-  }
-
-  /**
-   * Load stored cache from the file into memory and checks its timestamp.
-   * If the timestamp is more than X days old it will reset the file without any changes to cache.
-   * Note: using this method before writeToFile() will override keys in memory cache with the same name.
-   * @returns CacheController instance
-   */
-  readFromFile() {
-    try {
-      log('reading cache from the file');
-      const jsonData = (0, _fsExtra.readFileSync)(this.cacheFilePath, 'utf8');
-      const storedCache = JSON.parse(jsonData);
-
-      // validate values stored in the cache, reset the content of the file if its not empty already.
-      if (storedCache.data && storedCache.metadata && storedCache.metadata.modifyTimestamp && (0, _dayjs.default)().diff(storedCache.metadata.modifyTimestamp, 'milliseconds') < _types.CACHE_FILE_TTL_MILLISECONDS) {
-        for (const [key, val] of Object.entries(storedCache.data)) {
-          if (storedCache.data.hasOwnProperty(key)) {
-            this.cache.set(key, val);
-          }
-        }
-      } else if (!(0, _isEmpty.default)(storedCache)) {
-        log('timestamp or content is not valid and file is not empty, resetting the cache file');
-        (0, _fsExtra.outputJsonSync)(this.cacheFilePath, {});
-      }
-    } catch (e) {
-      log('cannot read cache from the file', e);
-    } finally {
-      return this;
-    }
-  }
-
-  /**
-   * Writes current set of keys to the json file with following structure:
-   * {
-   * 	metadata: {
-   *     modifyTimestamp: current timestamp, used on read for TTL validation
-   *     schemaVersion: indicates the version of cache file structure, can be used later on if changing it.
-   *   },
-   *   data: {} key-value cache data
-   * }
-   * @returns CacheController instance
-   */
-  writeToFile() {
-    try {
-      log('writing cache to the file');
-      const keys = this.cache.keys();
-      const cachedData = this.cache.mget(keys);
-      const dataToStore = {
-        metadata: {
-          modifyTimestamp: Date.now(),
-          schemaVersion: '1'
-        },
-        data: cachedData
-      };
-      (0, _utils.writeToFile)(this.cacheFilePath, JSON.stringify(dataToStore));
-    } catch (e) {
-      log('cannot write cache to the file', e);
-    } finally {
-      return this;
-    }
-  }
-}
-const CacheController = exports.CacheController = new CacheControllerClass();

package/dist/common/CliConfigManager.js

@@ -1,76 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CliConfigManager = exports.CliConfigKeys = void 0;
-var _fsExtra = require("fs-extra");
-var _unset2 = _interopRequireDefault(require("lodash/unset"));
-var _os = require("os");
-var _path = require("path");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-let CliConfigKeys = exports.CliConfigKeys = /*#__PURE__*/function (CliConfigKeys) {
-  CliConfigKeys["APIC_DEPLOYMENT"] = "apic-deployment";
-  CliConfigKeys["BASE_URL"] = "base-url";
-  CliConfigKeys["ACCOUNT"] = "account";
-  CliConfigKeys["REGION"] = "region";
-  CliConfigKeys["PLATFORM"] = "platform";
-  CliConfigKeys["EXTENSIONS"] = "extensions";
-  CliConfigKeys["CLIENT_ID"] = "client-id";
-  return CliConfigKeys;
-}({});
-class CliConfigManager {
-  saveToFile(values) {
-    (0, _fsExtra.outputJsonSync)(CliConfigManager.configFilePath, values, {
-      spaces: '\t'
-    });
-  }
-
-  /**
-   * Temporary validator for config file content. Needed only to cleanup some values from config files for a couple of
-   * versions, remove it after some time.
-   */
-  validateSavedConfigKeys() {
-    const deprecatedKeys = [
-    // TODO: a few other configs might be getting deprecated: https://jira.axway.com/browse/APIGOV-19737
-    // CliConfigKeys.PLATFORM,
-    CliConfigKeys.CLIENT_ID];
-    const keysToRemove = Object.keys(this.getAll()).filter(key => deprecatedKeys.includes(key));
-    if (keysToRemove.length) {
-      throw Error(`Following Axway Central CLI config keys has been deprecated and no longer needed: ${keysToRemove.join(', ')}
-Please unset by running:
-${keysToRemove.map(key => `axway central config unset ${key}`).join('\n')}
-			`);
-    }
-  }
-
-  // Note: current validation is good for "unset" but for "set" its needed to validate the value for "extensions" (should be non-empty)
-  validate(key) {
-    // validate 'extensions' keys - should alway have dot in the mid: extensions.abc
-    if (key.startsWith(`${CliConfigKeys.EXTENSIONS}`)) {
-      if (!key.includes('.')) throw Error(`invalid "${CliConfigKeys.EXTENSIONS}" key format.`);
-    } else if (!Object.values(CliConfigKeys).includes(key)) {
-      throw Error(`central configuration doesn't support the "${key}" key.`);
-    }
-  }
-  getAll() {
-    return (0, _fsExtra.existsSync)(CliConfigManager.configFilePath) ? (0, _fsExtra.readJsonSync)(CliConfigManager.configFilePath) : {};
-  }
-  get(key) {
-    return this.getAll()[key];
-  }
-
-  // TODO
-  // set(key: CentralConfigKeys) {}
-
-  unset(key) {
-    const config = this.getAll();
-    (0, _unset2.default)(config, key);
-    this.saveToFile(config);
-  }
-}
-exports.CliConfigManager = CliConfigManager;
-_defineProperty(CliConfigManager, "configFilePath", (0, _path.join)((0, _os.homedir)(), '.axway', 'central.json'));

package/dist/common/CompositeError.js

@@ -1,95 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CompositeError = void 0;
-function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
-function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
-function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
-function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
-function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
-var _nestedErrors = /*#__PURE__*/new WeakMap();
-/** This type is returnd by the CompositeError.toDictionary() method. Intended to be outputted to JSON or YAML. */
-
-/** Error object which can provide nested errors to indicated if multiple errors have occurred. */
-class CompositeError extends Error {
-  /**
-   * Creates a new error wrapping the given array of errors.
-   * @param errors Array of errors to be owned by this composite error. Can contain CompositeError instances.
-   * @param message Optional error message to be displayed by this root error object.
-   */
-  constructor(errors, message) {
-    super(message);
-    /** Array of errors wrapped by this error object. */
-    _classPrivateFieldInitSpec(this, _nestedErrors, void 0);
-    _classPrivateFieldSet(_nestedErrors, this, errors);
-  }
-
-  /** Gets the name of this error type. */
-  get name() {
-    return 'CompositeError';
-  }
-
-  /** Gets an array of error objects owned by this composite error. */
-  get nestedErrors() {
-    return _classPrivateFieldGet(_nestedErrors, this);
-  }
-
-  /**
-   * Creates a dictionary providing the name, message, and array of all errors nested under this error object.
-   * Intended to be outputted to JSON or YAML.
-   * @returns Returns a dictionary of this error object and all nested error objects.
-   */
-  toDictionary() {
-    const dictionary = {
-      name: this.name,
-      message: this.message,
-      nestedErrors: []
-    };
-    for (const nextError of _classPrivateFieldGet(_nestedErrors, this)) {
-      if (nextError instanceof CompositeError) {
-        dictionary.nestedErrors.push(nextError.toDictionary());
-      } else {
-        dictionary.nestedErrors.push({
-          name: nextError.name,
-          message: nextError.message
-        });
-      }
-    }
-    return dictionary;
-  }
-
-  /**
-   * Creates an array of strings providing this object's error message and all of its nested error messages.
-   * Each error object's message is added to its own array entry and will be indented according to nested position.
-   * @returns Returns an array of all error messages that are indented according to their nested position.
-   */
-  toNestedMessageArray() {
-    const messageLines = [];
-    if (this.message) {
-      messageLines.push(this.message);
-    }
-    for (const nextError of _classPrivateFieldGet(_nestedErrors, this)) {
-      if (nextError instanceof CompositeError) {
-        for (const nextLine of nextError.toNestedMessageArray()) {
-          const prefix = nextLine.startsWith('-') ? '  ' : '* ';
-          messageLines.push(prefix + nextLine);
-        }
-      } else {
-        messageLines.push(`- ${nextError.message || 'Unknown error'}`);
-      }
-    }
-    return messageLines;
-  }
-
-  /**
-   * Creates an error message containing this object's message and all nested error messages separated by newlines
-   * and indented according to their nested position.
-   * @returns Returns a single string containing all nested error messages separated by newlines.
-   */
-  toNestedMessageString() {
-    return this.toNestedMessageArray().join('\n');
-  }
-}
-exports.CompositeError = CompositeError;

package/dist/common/CoreConfigController.js

@@ -1,174 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CoreConfigController = exports.AccountRole = void 0;
-var _amplifyCliUtils = require("@axway/amplify-cli-utils");
-var _snooplogg = _interopRequireDefault(require("snooplogg"));
-var _CliConfigManager = require("./CliConfigManager");
-var _types = require("./types");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-const {
-  log
-} = (0, _snooplogg.default)('central: CoreConfigController');
-
-// TODO: https://jira.axway.com/browse/APIGOV-20520
-// interface AuthenticationError extends Error {
-// 	errors?: Array<object>;
-// }
-let AccountRole = exports.AccountRole = /*#__PURE__*/function (AccountRole) {
-  AccountRole["AnalyticsSpecialist"] = "analytics_specialist";
-  AccountRole["ApiCentralAdmin"] = "api_central_admin";
-  AccountRole["FileTransferServicesAdmin"] = "fts_admin";
-  AccountRole["FlowCentralAccessManager"] = "fc_access_manager";
-  AccountRole["FlowCentralIntegration"] = "fc_integration";
-  AccountRole["FlowCentralITAdmin"] = "fc_it_admin";
-  AccountRole["FlowCentralProductsAdmin"] = "fc_products_admin";
-  AccountRole["FlowCentralSpecOps"] = "fc_spec_ops";
-  AccountRole["FlowCentralSubscriptionApprover"] = "fc_subscriptionapprover";
-  AccountRole["FlowCentralSubscriptionSpecialist"] = "fc_subscriptionspecialist";
-  AccountRole["FlowCentralTemplatePublisher"] = "fc_templatepublisher";
-  AccountRole["FlowCentralCftAdmin"] = "fc_cft_admin";
-  AccountRole["PlatformAdmin"] = "administrator";
-  AccountRole["PlatformAuditor"] = "auditor";
-  AccountRole["PlatformCollaborator"] = "collaborator";
-  AccountRole["PlatformConsumer"] = "consumer";
-  AccountRole["PlatformDeveloper"] = "developer";
-  AccountRole["PlatformReadOnly"] = "read_only";
-  AccountRole["RuntimeServicesAdmin"] = "ars_admin";
-  return AccountRole;
-}({});
-class CoreConfigController {
-  /**
-   * Get authentication info
-   * @param {String} clientId client id to use
-   * @param {String} [team] The team name or guid to use, otherwise fallsback to the default from
-   * the Axway CLI config.
-   * @returns object containing token and orgId. For service accounts orgId is undefined.
-   * @throws 401 if no authenticated account found.
-   */
-  async getAuthInfo({
-    account,
-    clientId,
-    team,
-    forceGetAuthInfo
-  } = {}) {
-    var _devOpsAccount, _devOpsAccount$org, _devOpsAccount$org$id, _devOpsAccount$org2;
-    const configCtrl = new _CliConfigManager.CliConfigManager();
-    const config = (0, _amplifyCliUtils.loadConfig)();
-
-    // note: remove this validator after couple of versions
-    configCtrl.validateSavedConfigKeys();
-    log(`getAuthInfo, received clientId = ${clientId}, account = ${account}, team = ${team}`);
-    const baseUrl = process.env.AXWAY_CENTRAL_BASE_URL || configCtrl.get(_CliConfigManager.CliConfigKeys.BASE_URL);
-
-    // environment defined by using central cli "base-url" or axway "env" configs if set,
-    // otherwise its undefined (equals to prod)
-    const environment = !baseUrl || baseUrl === _types.ProdBaseUrls.US || baseUrl === _types.ProdBaseUrls.EU || baseUrl === _types.ProdBaseUrls.AP ? config.get('env') : 'staging';
-    log(`getAuthInfo, baseUrl = ${baseUrl}, environment = ${environment}`);
-    const {
-      sdk
-    } = (0, _amplifyCliUtils.initSDK)({
-      env: environment
-    }, config);
-    let {
-      devOpsAccount
-    } = CoreConfigController;
-    if (forceGetAuthInfo) {
-      devOpsAccount = null;
-    }
-    if (!devOpsAccount || account && devOpsAccount.name !== account) {
-      log(`getAuthInfo, no cached devOpsAccount found, or account name does not match`);
-      if (clientId) {
-        // TODO: client-id is a legacy option used only by proxies promote/create, should be removed
-        // https://jira.axway.com/browse/APIGOV-20818
-        log(`getAuthInfo, clientId value passed, trying to find a matching account`);
-        const list = await sdk.auth.list({
-          validate: true
-        });
-        const matchingAccount = list.find(a => a.auth.clientId === clientId);
-        if (matchingAccount) {
-          devOpsAccount = await sdk.auth.find(matchingAccount.name);
-        }
-      } else if (account) {
-        // ELSE IF: account name passed - ignoring defaultAccount and other accounts
-        log(`getAuthInfo, account value passed, trying to find a matching account`);
-        devOpsAccount = await sdk.auth.find(account);
-      } else {
-        // ELSE: trying to get any authenticated account
-        log(`getAuthInfo, account value not passed, trying to find default/any match`);
-        const list = await sdk.auth.list({
-          validate: true
-        });
-        log(`getAuthInfo, authenticated accounts found: ${list.length}`);
-        if (list.length === 1) {
-          log(`getAuthInfo, using a single account found with name: ${list[0].name}`);
-          devOpsAccount = list[0];
-        } else if (list.length > 1) {
-          // try to find the default account
-          devOpsAccount = list.find(a => a.name === config.get('auth.defaultAccount')) || list.find(a => a.default) || list[0];
-        }
-      }
-      if (!devOpsAccount) {
-        // TODO: piece of old logic here, move throwing out of the method?
-        // temporary commenting out the new functionality and reverting back to the old one, will be fixed with:
-        // https://jira.axway.com/browse/APIGOV-20520
-        log(`getAuthInfo, no devOpsAccount set after all, throwing 401`);
-        // const title: string = accountName
-        // 	? `Account "${accountName}" cannot be found`
-        // 	: 'No authenticated accounts found.';
-        // const err: AuthenticationError = new Error(title);
-        // err.errors = [{ status: 401, title }];
-        // throw err;
-        throw {
-          errors: [{
-            status: 401,
-            title: account ? `Account "${account}" cannot be found` : 'No authenticated accounts found.'
-          }]
-        };
-      }
-      CoreConfigController.devOpsAccount = devOpsAccount;
-    }
-    const result = {
-      orgId: (_devOpsAccount = devOpsAccount) === null || _devOpsAccount === void 0 ? void 0 : (_devOpsAccount$org = _devOpsAccount.org) === null || _devOpsAccount$org === void 0 ? void 0 : (_devOpsAccount$org$id = _devOpsAccount$org.id) === null || _devOpsAccount$org$id === void 0 ? void 0 : _devOpsAccount$org$id.toString(),
-      orgRegion: (_devOpsAccount$org2 = devOpsAccount.org) === null || _devOpsAccount$org2 === void 0 ? void 0 : _devOpsAccount$org2.region,
-      token: process.env.AXWAY_CENTRAL_AUTH_TOKEN || config.get('central.authToken', devOpsAccount.auth.tokens.access_token)
-    };
-
-    // now that we have resolved the account, we can validate the team
-    if (team) {
-      const {
-        teams
-      } = await sdk.team.list(devOpsAccount);
-      const teamObj = teams.find(t => {
-        return t.guid.toLowerCase() === team.toLowerCase() || t.name.toLowerCase() === team.toLowerCase();
-      });
-      if (!teamObj) {
-        throw new Error(`Unable to find team "${team}" in the "${devOpsAccount.org.name}" organization`);
-      }
-      result.teamGuid = teamObj.guid;
-    } else if (team === null) {
-      result.teamGuid = null;
-    }
-    log(`getAuthInfo, returning account = ${devOpsAccount.name}`);
-    log(`getAuthInfo, returning token = ${result.token.substring(0, 5)}*****${result.token.substring(result.token.length - 5)}`);
-    log(`getAuthInfo, returning orgId = ${result.orgId}`);
-    log(`getAuthInfo, returning orgRegion = ${result.orgRegion}`);
-    log(`getAuthInfo, returning teamGuid = ${result.teamGuid}`);
-    return result;
-  }
-  static getEnv() {
-    var _CoreConfigController2, _CoreConfigController3;
-    return ((_CoreConfigController2 = CoreConfigController.devOpsAccount) === null || _CoreConfigController2 === void 0 ? void 0 : (_CoreConfigController3 = _CoreConfigController2.auth) === null || _CoreConfigController3 === void 0 ? void 0 : _CoreConfigController3.env) || _types.Platforms.prod;
-  }
-  static getAuthUrl() {
-    var _CoreConfigController4, _CoreConfigController5;
-    return ((_CoreConfigController4 = CoreConfigController.devOpsAccount) === null || _CoreConfigController4 === void 0 ? void 0 : (_CoreConfigController5 = _CoreConfigController4.auth) === null || _CoreConfigController5 === void 0 ? void 0 : _CoreConfigController5.baseUrl) || _types.AuthUrls.Prod;
-  }
-}
-exports.CoreConfigController = CoreConfigController;
-_defineProperty(CoreConfigController, "devOpsAccount", null);