@axway/axway-central-cli 3.3.0 → 3.4.0

package/dist/commands/apply/index.js

@@ -27,7 +27,8 @@ const action = async ({
     output,
     region,
     cache,
-    yes
+    yes,
+    language
   } = argv;
   let isCmdError = false;
 
@@ -74,7 +75,7 @@ const action = async ({
       render.startSpin('Creating or updating resource(s)');
     }
     const sortedKindsMap = defsManager.getSortedKindsMap();
-    results = await client.bulkCreateOrUpdate(docs, sortedKindsMap);
+    results = await client.bulkCreateOrUpdate(docs, sortedKindsMap, language);
     render.bulkCreateOrUpdateResult(results, 'has successfully been created.', 'has successfully been updated.', 'was created with an autogenerated logical name.');
     isCmdError = results.created.error.length > 0 || results.updated.error.length > 0;
   } catch (e) {
@@ -104,6 +105,10 @@ const apply = exports.apply = {
       desc: `Filename to use to create or update the resources. One of: yaml | json`,
       type: 'string'
     },
-    '-y, --yes': 'Automatically reply "yes" to any command prompts.'
+    '-y, --yes': 'Automatically reply "yes" to any command prompts.',
+    '--language=[langCode]': {
+      desc: `Language Codes. One of: Comma Separated values of ${_types.LanguageTypes.French} | ${_types.LanguageTypes.US} | ${_types.LanguageTypes.German} | ${_types.LanguageTypes.Portugese}`,
+      type: 'string'
+    }
   }
 };

package/dist/commands/get/index.js

@@ -16,20 +16,22 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 const {
   log
 } = (0, _snooplogg.default)('central: get');
-const getListOrByName = async (resourceDef, client, scopeName, resourceName, scopeDef, query, progressListener, expand) => {
+const getListOrByName = async (resourceDef, client, scopeName, resourceName, scopeDef, query, progressListener, expand, langDef) => {
   return resourceName ? await client.getResourceByName({
     resourceDef,
     resourceName,
     scopeDef,
     scopeName,
-    expand
+    expand,
+    langDef
   }) : await client.getResourcesList({
     resourceDef,
     scopeDef,
     scopeName,
     query,
     progressListener,
-    expand
+    expand,
+    langDef
   });
 };
 const get = exports.get = {
@@ -73,8 +75,16 @@ const get = exports.get = {
       const defsManager = await new _DefinitionsManager.DefinitionsManager(client).init();
       const scope = (0, _utils.parseScopeParam)(argv.scope);
       let languageExpand = argv.language;
+      const languageDefinition = argv.languageDefinition;
       const formattedFilter = (0, _utils.transformSimpleFilters)(title, attribute, tag);
       const query = argv.query ? argv.query : formattedFilter;
+      // verify either "--language" or "--languageDefinition" argument is passed and error when both are passed
+      if (languageExpand && languageDefinition) {
+        throw Error('You must specify either of the "--language" or "--languageDefinition" argument and not both.');
+      }
+      if (languageDefinition && !argv.output) {
+        throw Error('The "--languageDefinition" argument can only be used with output(-o,--output) argument');
+      }
       if (languageExpand) {
         // when "*" is provided, expand all supported languages
         let lang = "";
@@ -149,7 +159,7 @@ ${defsManager.getDefsTableForHelpMsg()}`);
          */
         if (scope) {
           const results = await Promise.all(defs.filter(defs => !scope.kind || !defs.scope || defs.scope.spec.kind === scope.kind).map(async defs => ({
-            response: await getListOrByName(defs.resource, client, scope.name, resourceName, defs.scope, query, progressListener, languageExpand),
+            response: await getListOrByName(defs.resource, client, scope.name, resourceName, defs.scope, query, progressListener, languageExpand, languageDefinition),
             cli: defs.cli
           })));
           results.forEach(({
@@ -169,7 +179,7 @@ ${defsManager.getDefsTableForHelpMsg()}`);
             }
           });
           const results = await Promise.all(Object.values(defsMatchingGroup).map(async defs => ({
-            response: await getListOrByName(defs.resource, client, undefined, resourceName, undefined, query, progressListener, languageExpand),
+            response: await getListOrByName(defs.resource, client, undefined, resourceName, undefined, query, progressListener, languageExpand, languageDefinition),
             cli: defs.cli
           })));
           results.forEach(({
@@ -191,7 +201,7 @@ ${defsManager.getDefsTableForHelpMsg()}`);
 
       // considering the command successful if at least 1 response found
       isCmdError = !getResults.filter(res => res.response.data !== null).length;
-      renderer.renderGetResults(getResults, 'Resource(s) successfully retrieved');
+      renderer.renderGetResults(getResults, 'Resource(s) successfully retrieved', languageDefinition);
     } catch (e) {
       log('command error', e);
       isCmdError = true;
@@ -231,8 +241,11 @@ ${defsManager.getDefsTableForHelpMsg()}`);
     },
     '--team [guid|name]': 'The team name or guid to use',
     '--no-owner': 'Returns resources which do not have an owner',
-    '--language [langCode]': {
+    '--language=[langCode]': {
       desc: `Show the language detail of the retruned object. One of: * | Comma Separated values of ${_types.LanguageTypes.French} | ${_types.LanguageTypes.US} | ${_types.LanguageTypes.German} | ${_types.LanguageTypes.Portugese}`
+    },
+    '--languageDefinition=[langCode]': {
+      desc: `Show the language definition constraint of the returned object. One of: Comma Separated values of ${_types.LanguageTypes.French} | ${_types.LanguageTypes.US} | ${_types.LanguageTypes.German} | ${_types.LanguageTypes.Portugese}`
     }
   }
 };

package/dist/common/ApiServerClient.js

@@ -12,6 +12,7 @@ var _CacheController = require("./CacheController");
 var _dataService = require("./dataService");
 var _types = require("./types");
 var _utils = require("./utils");
+var _chalk = _interopRequireDefault(require("chalk"));
 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 + ""; }
@@ -65,14 +66,60 @@ class ApiServerClient {
     scopeDef,
     scopeName,
     version = ApiServerVersions.v1alpha1,
-    expand
+    expand,
+    langDef
   }) {
     const groupUrl = `/${resourceDef.metadata.scope.name}/${version}`;
     const scopeUrl = scopeName && scopeDef ? `/${scopeDef.spec.plural}/${encodeURIComponent(scopeName)}` : '';
     const resourceUrl = `/${resourceDef.spec.plural}`;
     const nameUrl = resourceName ? `/${encodeURIComponent(resourceName)}` : '';
     const expandUrl = expand ? `?expand=${expand}` : '';
-    return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}${expandUrl}`;
+    const langDefUrl = langDef ? this.buildLanguageDefinitionUrl({
+      langCode: langDef
+    }) : '';
+    if (expand) {
+      return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}${expandUrl}`;
+    } else if (langDef) {
+      return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}${langDefUrl}`;
+    } else {
+      return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}`;
+    }
+  }
+
+  /**
+   * Build language definition url based on the language code.
+   */
+  buildLanguageDefinitionUrl({
+    langCode
+  }) {
+    let langDefUrl = '';
+    let i = 0;
+    let embed = '?embed=';
+    let expand = '&expand=languages,';
+    let fields = '&fields=languages,group,apiVersion,name,kind,metadata,';
+    const langCodeArr = langCode.split(',');
+    let languageTypesArr = [];
+    Object.keys(_types.LanguageTypes).forEach(key => languageTypesArr.push((0, _utils.ValueFromKey)(_types.LanguageTypes, key)));
+    langCodeArr.forEach(code => {
+      if (code.trim() != '') {
+        if (!languageTypesArr.includes(code)) {
+          console.log(_chalk.default.yellow(`\n\'${code}\' language code is not supported. Allowed language codes: ${_types.LanguageTypes.French} | ${_types.LanguageTypes.German} | ${_types.LanguageTypes.US} | ${_types.LanguageTypes.Portugese}.'`));
+        } else {
+          if (i < langCodeArr.length - 1) {
+            embed = embed + `languages-${code.trim()}.resource` + ",";
+            expand = expand + `languages-${code.trim()}` + ",";
+            fields = fields + `languages-${code.trim()}.values` + ",";
+          } else {
+            embed = embed + `languages-${code.trim()}.resource`;
+            expand = expand + `languages-${code.trim()}`;
+            fields = fields + `languages-${code.trim()}.values`;
+          }
+        }
+      }
+      i++;
+    });
+    langDefUrl = `${embed}${expand}${fields}`;
+    return langDefUrl;
   }
 
   /**
@@ -94,7 +141,9 @@ class ApiServerClient {
     resourceDef,
     scopeDef,
     scopeName,
-    version = ApiServerVersions.v1alpha1
+    version = ApiServerVersions.v1alpha1,
+    createAction,
+    language
   }) {
     var _resourceDef$spec$sub, _resourceDef$spec$sub2;
     const service = await (0, _dataService.dataService)({
@@ -112,6 +161,28 @@ class ApiServerClient {
     });
     const knownSubResourcesNames = (_resourceDef$spec$sub = (_resourceDef$spec$sub2 = resourceDef.spec.subResources) === null || _resourceDef$spec$sub2 === void 0 ? void 0 : _resourceDef$spec$sub2.names) !== null && _resourceDef$spec$sub !== void 0 ? _resourceDef$spec$sub : [];
     const foundSubResources = (0, _pickBy.default)(resource, (_, key) => key.startsWith('x-') || knownSubResourcesNames.includes(key));
+    if (language) {
+      const langSubResourcesNames = (0, _utils.createLanguageSubresourceNames)(language);
+      langSubResourcesNames.forEach(name => {
+        if (!Object.keys(foundSubResources).includes(name) && name !== "languages") {
+          console.log(_chalk.default.yellow(`\n\'${name}\' subresource definition not found, hence create/update cannot be performed on \'${name}\' subresource.`));
+        }
+      });
+      Object.keys(foundSubResources).forEach(subRes => {
+        if (!langSubResourcesNames.includes(subRes)) {
+          // For create, only delete the language subresources that are not passed in the 'language' argument.
+          if (createAction) {
+            if (subRes.includes('languages')) {
+              delete foundSubResources[subRes];
+            }
+          }
+          // For update, delete all the subresources except the ones passed in the 'language' argument.
+          else {
+            delete foundSubResources[subRes];
+          }
+        }
+      });
+    }
     return (0, _isEmpty.default)(foundSubResources) ? null : Object.keys(foundSubResources).map(key => {
       return () => service.put(`${baseUrl}/${key}?fields=${key}`, {
         [key]: foundSubResources[key]
@@ -206,7 +277,8 @@ class ApiServerClient {
     scopeDef,
     scopeName,
     version = ApiServerVersions.v1alpha1,
-    withSubResources = true
+    withSubResources = true,
+    language
   }) {
     log(`createResource, spec.kind = ${resourceDef.spec.kind}, name = ${resource.name}, withSubResources = ${withSubResources}`);
     const result = {
@@ -239,7 +311,9 @@ class ApiServerClient {
         resourceDef,
         scopeDef,
         scopeName,
-        version
+        version,
+        createAction: true,
+        language
       });
       log(`createResource, pendingSubResources = ${pendingSubResources === null || pendingSubResources === void 0 ? void 0 : pendingSubResources.length}`);
       if (withSubResources) {
@@ -275,7 +349,8 @@ class ApiServerClient {
     scopeDef,
     scopeName,
     version = ApiServerVersions.v1alpha1,
-    withSubResources = true
+    withSubResources = true,
+    language
   }) {
     log(`updateResource, spec.kind = ${resourceDef.spec.kind}, name = ${resource.name}`);
     const result = {
@@ -290,32 +365,53 @@ class ApiServerClient {
         account: this.account,
         team: this.team
       });
-      const url = this.buildResourceBaseUrl({
-        resourceDef,
-        resourceName: resource.name,
-        scopeDef,
-        scopeName,
-        version
-      });
-      const response = await service.put(url, (0, _utils.sanitizeMetadata)(resource));
-      const pendingSubResources = await this.generateSubResourcesRequests({
-        resource,
-        resourceName: response.name,
-        resourceDef,
-        scopeDef,
-        scopeName,
-        version
-      });
-      if (withSubResources) {
-        const {
-          data: subResData,
-          error: subResError
-        } = await this.resolveSubResourcesRequests(response, pendingSubResources);
-        result.data = subResData;
-        result.error = subResError;
-      } else {
-        result.data = response;
+      let pendingSubResources;
+      if (language) {
+        pendingSubResources = await this.generateSubResourcesRequests({
+          resource,
+          resourceName: resource.name,
+          resourceDef,
+          scopeDef,
+          scopeName,
+          version,
+          createAction: false,
+          language
+        });
+        result.data = (0, _utils.buildGenericResource)({
+          resourceName: resource.name,
+          resourceDef: resourceDef,
+          scopeName: scopeName
+        });
         result.pending = pendingSubResources;
+      } else {
+        const url = this.buildResourceBaseUrl({
+          resourceDef,
+          resourceName: resource.name,
+          scopeDef,
+          scopeName,
+          version
+        });
+        const response = await service.put(url, (0, _utils.sanitizeMetadata)(resource));
+        pendingSubResources = await this.generateSubResourcesRequests({
+          resource,
+          resourceName: response.name,
+          resourceDef,
+          scopeDef,
+          scopeName,
+          createAction: false,
+          version
+        });
+        if (withSubResources) {
+          const {
+            data: subResData,
+            error: subResError
+          } = await this.resolveSubResourcesRequests(response, pendingSubResources);
+          result.data = subResData;
+          result.error = subResError;
+        } else {
+          result.data = response;
+          result.pending = pendingSubResources;
+        }
       }
     } catch (e) {
       log('updateResource, error', e);
@@ -476,7 +572,8 @@ class ApiServerClient {
     version = ApiServerVersions.v1alpha1,
     query,
     progressListener,
-    expand
+    expand,
+    langDef
   }) {
     log(`getResourcesList, spec.kind = ${resourceDef.spec.kind}`);
     const result = {
@@ -495,7 +592,8 @@ class ApiServerClient {
         scopeDef,
         scopeName,
         version,
-        expand
+        expand,
+        langDef
       });
       const response = await service.getWithPagination(url, query, 50, {}, progressListener);
       result.data = response;
@@ -526,7 +624,8 @@ class ApiServerClient {
     scopeDef,
     scopeName,
     version = ApiServerVersions.v1alpha1,
-    expand
+    expand,
+    langDef
   }) {
     log(`getResourceByName, spec.kind = ${resourceDef.spec.kind}, name = ${resourceName}`);
     const result = {
@@ -546,7 +645,8 @@ class ApiServerClient {
         scopeDef,
         scopeName,
         version,
-        expand
+        expand,
+        langDef
       });
       const response = await service.get(url);
       result.data = response;
@@ -717,7 +817,7 @@ class ApiServerClient {
    * sorting of the array of resources with "compareResourcesByKindAsc".
    * @param resources array of resources to create
    */
-  async bulkCreateOrUpdate(resources, sortedDefsMap, version) {
+  async bulkCreateOrUpdate(resources, sortedDefsMap, language, version) {
     log(`bulk create or update`);
     // sort() is modifying the existing array so cloning it before use.
     const sortedDefsArray = Array.from(sortedDefsMap.values());
@@ -781,7 +881,8 @@ class ApiServerClient {
           scopeDef,
           scopeName,
           version,
-          withSubResources: false
+          withSubResources: false,
+          language
         });
         if (res.data && !res.error) {
           // note: bulk operation requires creation of sub-resources after all main resources created
@@ -815,7 +916,8 @@ class ApiServerClient {
           scopeDef,
           scopeName,
           version,
-          withSubResources: false
+          withSubResources: false,
+          language
         });
         if (res.data && !res.error) {
           if (!!res.pending) {

package/dist/common/Renderer.js

@@ -178,7 +178,7 @@ class Renderer {
       bulkResult.updated.success.forEach(r => this.success(`${this.resourceAndScopeKinds(r)} ${updateSuccessMsg}`));
     }
   }
-  renderGetResults(bulkResultsArray, successMsg) {
+  renderGetResults(bulkResultsArray, successMsg, langDef) {
     // sort all results by success / error
     // IMPORTANT: mind the response.data! non-null assertion later on, should be covered by this loop
     const sortedResults = bulkResultsArray.reduce((a, c) => {
@@ -209,6 +209,9 @@ class Renderer {
           return a;
         }, []);
       }
+      if (langDef) {
+        dataToRender = this.formatLanguageDefinitionGetResults(dataToRender);
+      }
       (0, _resultsRenderers.renderResponse)(this._console, dataToRender, this.output);
     } else {
       // stop spinner and render a table for each successful request
@@ -232,6 +235,32 @@ class Renderer {
     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
+   * @param prefixMsg a string to put before the error details (works only for api-server / known errors)
+   * @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.
+   */
+  formatLanguageDefinitionGetResults(data) {
+    let dataArr = [];
+    if (!Array.isArray(data)) {
+      dataArr.push(data);
+    } else {
+      dataArr = data;
+    }
+    dataArr.forEach(data => {
+      var _data$metadata, _data$metadata2, _data$metadata3, _data$metadata4, _data$metadata5, _data$metadata5$scope, _data$languages;
+      data === null || data === void 0 ? true : (_data$metadata = data.metadata) === null || _data$metadata === void 0 ? true : delete _data$metadata.audit;
+      data === null || data === void 0 ? true : (_data$metadata2 = data.metadata) === null || _data$metadata2 === void 0 ? true : delete _data$metadata2.acl;
+      data === null || data === void 0 ? true : (_data$metadata3 = data.metadata) === null || _data$metadata3 === void 0 ? true : delete _data$metadata3.accessRights;
+      data === null || data === void 0 ? true : (_data$metadata4 = data.metadata) === null || _data$metadata4 === void 0 ? true : delete _data$metadata4.references;
+      data === null || data === void 0 ? true : (_data$metadata5 = data.metadata) === null || _data$metadata5 === void 0 ? true : (_data$metadata5$scope = _data$metadata5.scope) === null || _data$metadata5$scope === void 0 ? true : delete _data$metadata5$scope.title;
+      data === null || data === void 0 ? true : (_data$languages = data.languages) === null || _data$languages === void 0 ? true : delete _data$languages.metadata;
+    });
+    return dataArr;
+  }
+
   /**
    * Render any kind of error
    * @param error error or ApiServer error to render

package/dist/common/utils.js

@@ -5,7 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FormatString = FormatString;
 exports.KeyValueMapToNameValueArray = KeyValueMapToNameValueArray;
-exports.parseScopeParam = exports.loadAndVerifySpecs = exports.loadAndVerifyApigeeXCredentialFile = exports.isWindows = exports.isValidJson = exports.isApiServerErrorType = exports.isApiServerErrorResponseType = exports.hbsCompare = exports.getConfig = exports.configFile = exports.compareResourcesByKindDesc = exports.compareResourcesByKindAsc = exports.buildTemplate = exports.buildGenericResource = void 0;
+exports.ValueFromKey = ValueFromKey;
+exports.parseScopeParam = exports.loadAndVerifySpecs = exports.loadAndVerifyApigeeXCredentialFile = exports.isWindows = exports.isValidJson = exports.isApiServerErrorType = exports.isApiServerErrorResponseType = exports.hbsCompare = exports.getConfig = exports.createLanguageSubresourceNames = exports.configFile = exports.compareResourcesByKindDesc = exports.compareResourcesByKindAsc = exports.buildTemplate = exports.buildGenericResource = void 0;
 exports.sanitizeMetadata = sanitizeMetadata;
 exports.writeToFile = exports.writeTemplates = exports.verifyScopeParam = exports.verifyFile = exports.transformSimpleFilters = void 0;
 var _fsExtra = require("fs-extra");
@@ -15,6 +16,7 @@ var _os = require("os");
 var _path = require("path");
 var _CompositeError = require("./CompositeError");
 var _types = require("./types");
+var _chalk = _interopRequireDefault(require("chalk"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const isWindows = exports.isWindows = /^win/.test(process.platform);
 const configFile = exports.configFile = (0, _path.join)((0, _os.homedir)(), '.axway', 'central.json');
@@ -389,4 +391,27 @@ function KeyValueMapToNameValueArray(m) {
     return undefined;
   }
   return array;
+}
+const createLanguageSubresourceNames = langCode => {
+  const langCodeArr = langCode.split(',');
+  let langSubresourceNamesArr = ['languages'];
+  let languageTypesArr = [];
+  Object.keys(_types.LanguageTypes).forEach(key => languageTypesArr.push(ValueFromKey(_types.LanguageTypes, key)));
+  langCodeArr.forEach(langCode => {
+    if (langCode.trim() != '') {
+      if (!languageTypesArr.includes(langCode)) {
+        console.log(_chalk.default.yellow(`\n\'${langCode}\' language code is not supported, hence create/update cannot be performed on \'languages-${langCode}\. Allowed language codes: ${_types.LanguageTypes.French} | ${_types.LanguageTypes.German} | ${_types.LanguageTypes.US} | ${_types.LanguageTypes.Portugese}.'`));
+      } else {
+        langSubresourceNamesArr.push(`languages-${langCode.trim()}`);
+      }
+    }
+  });
+  return langSubresourceNamesArr;
+};
+exports.createLanguageSubresourceNames = createLanguageSubresourceNames;
+function ValueFromKey(stringEnum, key) {
+  for (const k of Object.values(stringEnum)) {
+    if (k === stringEnum[key]) return k;
+  }
+  return undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axway/axway-central-cli",
-	"version": "3.3.0",
+	"version": "3.4.0",
 	"description": "Manage APIs, services and publish to the Amplify Marketplace",
 	"homepage": "https://platform.axway.com",
 	"author": {