@axway/axway-central-cli 3.8.0 → 3.9.0-rc.0

package/README.md

@@ -450,20 +450,26 @@ Update resources from a file
 
 APPLY OPTIONS:
   --account [value]     Override your default account config
-  --no-cache            Do not use cache when communicating with the server
   -f, --file [path]     Filename to use to create or update the resources. One of: yaml | json
+  --language [langCode] Only update language portion. One of: fr-fr | en-us | de-de | pt-br
+  --no-cache            Do not use cache when communicating with the server
   -o, --output [value]  Additional output formats. One of: yaml | json
   --region [value]      Override your region config
+  --subresource [name]  Name of the 1 subresource to update. Will prevent main resource and all other subresources from being updated.
   -y, --yes             Automatically reply "yes" to any command prompts.
 ```
 
 ### apply examples
 
 ```bash
-# create multiple resources from file
+# create or update multiple resources from file
 axway central apply -f ./some/folder/resources.yaml
-# create multiple resources from file and output results in YAML format
+# create or update multiple resources from file and output results in YAML format
 axway central apply -f ./some/folder/resources.json -o yaml
+# only update 1 language "en-us" for multiple resources from file
+axway central apply -f ./some/folder/resources.yaml --language en-us
+# only update 1 subresource named "state" for multiple resources from file
+axway central apply -f ./some/folder/resources.yaml --subresource state
 ```
 
 ---

package/dist/commands/get/index.js

@@ -16,14 +16,15 @@ 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, langDef) => {
+const getListOrByName = async (resourceDef, client, scopeName, resourceName, scopeDef, query, progressListener, expand, langDef, fieldSet) => {
   return resourceName ? await client.getResourceByName({
     resourceDef,
     resourceName,
     scopeDef,
     scopeName,
     expand,
-    langDef
+    langDef,
+    fieldSet
   }) : await client.getResourcesList({
     resourceDef,
     scopeDef,
@@ -31,7 +32,8 @@ const getListOrByName = async (resourceDef, client, scopeName, resourceName, sco
     query,
     progressListener,
     expand,
-    langDef
+    langDef,
+    fieldSet
   });
 };
 const get = exports.get = {
@@ -159,7 +161,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, languageDefinition),
+            response: await getListOrByName(defs.resource, client, scope.name, resourceName, defs.scope, query, progressListener, languageExpand, languageDefinition, argv.output ? undefined : getFieldSetFromDefinitionColumns(defs)),
             cli: defs.cli
           })));
           results.forEach(({
@@ -179,7 +181,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, languageDefinition),
+            response: await getListOrByName(defs.resource, client, undefined, resourceName, undefined, query, progressListener, languageExpand, languageDefinition, argv.output ? undefined : getFieldSetFromDefinitionColumns(defs)),
             cli: defs.cli
           })));
           results.forEach(({
@@ -248,4 +250,23 @@ ${defsManager.getDefsTableForHelpMsg()}`);
       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}`
     }
   }
-};
+};
+
+/**
+ * Gets the resource field names to be shown when outputting the resource as a table.
+ * These names are to be assigned to the api-server HTTP GET request's "fields" query param.
+ * @param def The resource definition providing the columns to be shown in the outputed table.
+ * @returns Returns a set set of field names.
+ */
+function getFieldSetFromDefinitionColumns(def) {
+  var _def$cli, _def$cli$spec, _def$cli$spec$columns;
+  const fieldSet = new Set();
+  (_def$cli = def.cli) === null || _def$cli === void 0 ? void 0 : (_def$cli$spec = _def$cli.spec) === null || _def$cli$spec === void 0 ? void 0 : (_def$cli$spec$columns = _def$cli$spec.columns) === null || _def$cli$spec$columns === void 0 ? void 0 : _def$cli$spec$columns.forEach(column => {
+    let fieldName = column.jsonPath;
+    if (fieldName.startsWith('.')) {
+      fieldName = fieldName.substring(1);
+    }
+    fieldSet.add(fieldName);
+  });
+  return fieldSet;
+}

package/dist/common/ApiServerClient.js

@@ -59,8 +59,9 @@ class ApiServerClient {
   /**
    * Build resource url based on its ResourceDefinition and passed scope def and name.
    * Note that for scope url part both name and def needed.
+   * The returned URL path is expected to be appended to the base URL.
    */
-  buildResourceBaseUrl({
+  buildResourceUrlPath({
     resourceDef,
     resourceName,
     scopeDef,
@@ -68,60 +69,51 @@ class ApiServerClient {
     version = ApiServerVersions.v1alpha1,
     forceDelete = false,
     expand,
-    langDef
+    langDef,
+    fieldSet
   }) {
     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}` : '';
-    const langDefUrl = langDef ? this.buildLanguageDefinitionUrl({
-      langCode: langDef
-    }) : '';
-    const forceDeleteUrl = forceDelete ? `?forceDelete=${forceDelete}` : '';
-    if (expand) {
-      return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}${expandUrl}`;
-    } else if (langDef) {
-      return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}${langDefUrl}`;
-    } else {
-      return `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}${forceDeleteUrl}`;
-    }
-  }
-
-  /**
-   * 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)) {
+    const embedSet = new Set();
+    const expandSet = new Set(expand === null || expand === void 0 ? void 0 : expand.split(','));
+    if (langDef) {
+      var _fieldSet;
+      (_fieldSet = fieldSet) !== null && _fieldSet !== void 0 ? _fieldSet : fieldSet = new Set();
+      fieldSet.add('languages').add('group').add('apiVersion').add('name').add('kind').add('metadata');
+      expandSet.add('languages');
+      let languageTypesArr = [];
+      Object.keys(_types.LanguageTypes).forEach(key => languageTypesArr.push((0, _utils.ValueFromKey)(_types.LanguageTypes, key)));
+      langDef.split(',').forEach(code => {
+        if (languageTypesArr.includes(code)) {
+          embedSet.add(`languages-${code.trim()}.resource`);
+          expandSet.add(`languages-${code.trim()}`);
+          fieldSet.add(`languages-${code.trim()}.values`);
+        } else if (code.trim().length > 0) {
           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`;
-          }
         }
+      });
+    }
+    let url = `${groupUrl}${scopeUrl}${resourceUrl}${nameUrl}`;
+    if (forceDelete || embedSet.size || expandSet.size || fieldSet) {
+      const queryParams = [];
+      if (forceDelete) {
+        queryParams.push('forceDelete=true');
       }
-      i++;
-    });
-    langDefUrl = `${embed}${expand}${fields}`;
-    return langDefUrl;
+      if (embedSet.size) {
+        queryParams.push('embed=' + [...embedSet].join(','));
+      }
+      if (expandSet.size) {
+        queryParams.push('expand=' + [...expandSet].join(','));
+      }
+      if (fieldSet) {
+        // If field set is empty, then return no fields. This is intentional.
+        queryParams.push('fields=' + [...fieldSet].join(','));
+      }
+      url += '?' + queryParams.join('&');
+    }
+    return url;
   }
 
   /**
@@ -156,7 +148,7 @@ class ApiServerClient {
       account: this.account,
       team: this.team
     });
-    const baseUrl = this.buildResourceBaseUrl({
+    const urlPath = this.buildResourceUrlPath({
       resourceDef,
       resourceName,
       scopeDef,
@@ -195,7 +187,7 @@ class ApiServerClient {
     return (0, _isEmpty.default)(foundSubResources) ? null : Object.keys(foundSubResources).map(key => {
       return {
         name: key,
-        operation: () => service.put(`${baseUrl}/${key}?fields=${key}`, {
+        operation: () => service.put(`${urlPath}/${key}?fields=${key}`, {
           [key]: foundSubResources[key]
         }).catch(err => Promise.reject({
           name: key,
@@ -314,13 +306,13 @@ class ApiServerClient {
         account: this.account,
         team: this.team
       });
-      const url = this.buildResourceBaseUrl({
+      const urlPath = this.buildResourceUrlPath({
         resourceDef,
         scopeDef,
         scopeName,
         version
       });
-      const response = await service.post(url, (0, _utils.sanitizeMetadata)(resource));
+      const response = await service.post(urlPath, (0, _utils.sanitizeMetadata)(resource));
       if (!resource.name) {
         log('createResource, resource does not have a logical name');
         result.warning = true;
@@ -389,14 +381,14 @@ class ApiServerClient {
           account: this.account,
           team: this.team
         });
-        const url = this.buildResourceBaseUrl({
+        const urlPath = this.buildResourceUrlPath({
           resourceDef,
           resourceName: resource.name,
           scopeDef,
           scopeName,
           version
         });
-        result.data = await service.put(url, (0, _utils.sanitizeMetadata)(resource));
+        result.data = await service.put(urlPath, (0, _utils.sanitizeMetadata)(resource));
       } catch (e) {
         log('updateResource, error', e);
         // expecting only a valid ApiServer error response here
@@ -469,14 +461,14 @@ class ApiServerClient {
       const knownSubResourcesNames = (_resourceDef$spec$sub3 = (_resourceDef$spec$sub4 = resourceDef.spec.subResources) === null || _resourceDef$spec$sub4 === void 0 ? void 0 : _resourceDef$spec$sub4.names) !== null && _resourceDef$spec$sub3 !== void 0 ? _resourceDef$spec$sub3 : [];
       const foundSubResources = (0, _pickBy.default)(resource, (_, key) => subResourceName == key && knownSubResourcesNames.includes(key));
       const resourceName = resource.name;
-      const baseUrl = this.buildResourceBaseUrl({
+      const urlPath = this.buildResourceUrlPath({
         resourceDef,
         resourceName,
         scopeDef,
         scopeName,
         version
       });
-      service.put(`${baseUrl}/${subResourceName}?fields=${subResourceName}`, {
+      service.put(`${urlPath}/${subResourceName}?fields=${subResourceName}`, {
         [subResourceName]: foundSubResources[subResourceName]
       });
     } catch (e) {
@@ -523,7 +515,7 @@ class ApiServerClient {
         account: this.account,
         team: this.team
       });
-      const url = this.buildResourceBaseUrl({
+      const urlPath = this.buildResourceUrlPath({
         resourceDef,
         resourceName,
         scopeDef,
@@ -531,7 +523,7 @@ class ApiServerClient {
         version,
         forceDelete
       });
-      const response = await service.delete(url);
+      const response = await service.delete(urlPath);
       // note: delete "response" value from api-server is translated to an empty string currently.
       // If its true, constructing a simple representation from provided data (definition, name, scope name)
       // and manually set it as the "data" key.
@@ -589,7 +581,8 @@ class ApiServerClient {
     query,
     progressListener,
     expand,
-    langDef
+    langDef,
+    fieldSet
   }) {
     log(`getResourcesList, spec.kind = ${resourceDef.spec.kind}`);
     const result = {
@@ -603,15 +596,16 @@ class ApiServerClient {
         account: this.account,
         team: this.team
       });
-      const url = this.buildResourceBaseUrl({
+      const urlPath = this.buildResourceUrlPath({
         resourceDef,
         scopeDef,
         scopeName,
         version,
         expand,
-        langDef
+        langDef,
+        fieldSet
       });
-      const response = await service.getWithPagination(url, query, 50, {}, progressListener);
+      const response = await service.getWithPagination(urlPath, query, 50, {}, progressListener);
       result.data = response;
     } catch (e) {
       log('getResourcesList, error: ', e);
@@ -641,7 +635,8 @@ class ApiServerClient {
     scopeName,
     version = ApiServerVersions.v1alpha1,
     expand,
-    langDef
+    langDef,
+    fieldSet
   }) {
     log(`getResourceByName, spec.kind = ${resourceDef.spec.kind}, name = ${resourceName}`);
     const result = {
@@ -655,16 +650,17 @@ class ApiServerClient {
         account: this.account,
         team: this.team
       });
-      const url = this.buildResourceBaseUrl({
+      const urlPath = this.buildResourceUrlPath({
         resourceDef,
         resourceName,
         scopeDef,
         scopeName,
         version,
         expand,
-        langDef
+        langDef,
+        fieldSet
       });
-      const response = await service.get(url);
+      const response = await service.get(urlPath);
       result.data = response;
     } catch (e) {
       log('getResourceByName, error: ', e);

package/dist/common/dataService.js

@@ -126,7 +126,7 @@ const dataService = async ({
     clientId,
     team
   });
-  const url = await getBaseUrl(baseUrl, basePath, region, orgRegion);
+  baseUrl = await getBaseUrl(baseUrl, basePath, region, orgRegion);
   const defaultHeaders = getDefaultHeaders({
     orgId,
     token
@@ -158,8 +158,8 @@ const dataService = async ({
   };
   return {
     postFormData: (route, body, headers = {}) => {
-      log(`POST (from data): ${url + route}`);
-      return fetch('post', url + route, {
+      log(`POST (from data): ${baseUrl + route}`);
+      return fetch('post', baseUrl + route, {
         headers: {
           ...defaultHeaders,
           ...body.getHeaders(),
@@ -169,9 +169,9 @@ const dataService = async ({
       }).then(handleResponse);
     },
     post: (route, data, headers = {}) => {
-      log(`POST: ${url + route}`);
+      log(`POST: ${baseUrl + route}`);
       log(data);
-      return fetch('post', url + route, {
+      return fetch('post', baseUrl + route, {
         headers: {
           ...defaultHeaders,
           ...headers
@@ -180,8 +180,8 @@ const dataService = async ({
       }).then(handleResponse);
     },
     put: (route, data, headers = {}) => {
-      log(`PUT: ${url + route}`);
-      return fetch('put', url + route, {
+      log(`PUT: ${baseUrl + route}`);
+      return fetch('put', baseUrl + route, {
         headers: {
           ...defaultHeaders,
           ...headers
@@ -194,8 +194,8 @@ const dataService = async ({
         ...defaultHeaders,
         ...headers
       };
-      log(`GET: ${url + route}`, h);
-      return fetch('get', url + route, {
+      log(`GET: ${baseUrl + route}`, h);
+      return fetch('get', baseUrl + route, {
         headers: h
       }).then(handleResponse);
     },
@@ -210,7 +210,10 @@ const dataService = async ({
      * @param progressListener invoked multiple times where argument is assigned progress value 0-100
      */
     getWithPagination: async function (route, queryParams = '', pageSize = 50, headers = {}, progressListener) {
-      const fullUrl = queryParams ? new _url.URL(url + route + '?query=' + queryParams) : new _url.URL(url + route);
+      const fullUrl = new _url.URL(baseUrl + route);
+      if (queryParams) {
+        fullUrl.searchParams.set('query', queryParams);
+      }
       fullUrl.searchParams.set('pageSize', `${pageSize}`);
       log(`GET (with auto-pagination): ${fullUrl.href}`);
       const response = await fetch('get', fullUrl.toString(), {
@@ -241,9 +244,9 @@ const dataService = async ({
         for (let pageIndex = 1; pageIndex < totalPages; pageIndex++) {
           const thisPageIndex = pageIndex;
           fullUrl.searchParams.set('page', `${thisPageIndex + 1}`);
-          const thisPageUrl = `${route}?${fullUrl.searchParams.toString()}`;
+          const nextRoute = fullUrl.href.substring(baseUrl.length);
           otherPagesCalls.push(limit(async () => {
-            allPages[thisPageIndex] = await this.get(thisPageUrl, headers);
+            allPages[thisPageIndex] = await this.get(nextRoute, headers);
             pageDownloadCount++;
             updateProgress();
           }));
@@ -253,8 +256,8 @@ const dataService = async ({
       return (0, _flatten.default)(allPages);
     },
     delete: (route, headers = {}) => {
-      log(`DELETE: ${url + route}`);
-      return fetch('delete', url + route, {
+      log(`DELETE: ${baseUrl + route}`);
+      return fetch('delete', baseUrl + route, {
         headers: {
           ...defaultHeaders,
           ...headers
@@ -264,8 +267,8 @@ const dataService = async ({
     download: async route => {
       try {
         return await new Promise((resolve, reject) => {
-          log(`DOWNLOAD: ${url + route}`);
-          const stream = got.stream(url + route, {
+          log(`DOWNLOAD: ${baseUrl + route}`);
+          const stream = got.stream(baseUrl + route, {
             retry: 0,
             timeout: _types.ABORT_TIMEOUT
           });

package/package.json

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