ibm-cloud-sdk-core 2.4.4 → 2.7.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [2.7.0](https://github.com/IBM/node-sdk-core/compare/v2.6.0...v2.7.0) (2020-10-06)
+
+
+### Features
+
+* add support for compressing request bodies ([#111](https://github.com/IBM/node-sdk-core/issues/111)) ([7692d71](https://github.com/IBM/node-sdk-core/commit/7692d710fc2fb4f2c1cdfb3045d943c15d13bf1d))
+
+# [2.6.0](https://github.com/IBM/node-sdk-core/compare/v2.5.0...v2.6.0) (2020-09-25)
+
+
+### Features
+
+* upgrade axios and re-enable gzipping responses ([#110](https://github.com/IBM/node-sdk-core/issues/110)) ([9e94251](https://github.com/IBM/node-sdk-core/commit/9e94251fd23cb60517022455017ed34d3a419362))
+
+# [2.5.0](https://github.com/IBM/node-sdk-core/compare/v2.4.5...v2.5.0) (2020-09-18)
+
+
+### Features
+
+* **IAM Authenticator:** add support for optional 'scope' property ([#109](https://github.com/IBM/node-sdk-core/issues/109)) ([1c258b7](https://github.com/IBM/node-sdk-core/commit/1c258b71470c0228e021c959984cc887d849887b))
+
+## [2.4.5](https://github.com/IBM/node-sdk-core/compare/v2.4.4...v2.4.5) (2020-08-12)
+
+
+### Bug Fixes
+
+* pin typescript dependency to 3.8.3 ([#107](https://github.com/IBM/node-sdk-core/issues/107)) ([ef27bc9](https://github.com/IBM/node-sdk-core/commit/ef27bc94b7626880cb4ab21c5c711bb98b34272d))
+
 ## [2.4.4](https://github.com/IBM/node-sdk-core/compare/v2.4.3...v2.4.4) (2020-08-06)
 
 

package/auth/authenticators/authenticator.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Authenticator = void 0;
 /**
  * Base Authenticator class for other Authenticators to extend. Not intended
  * to be used as a stand-alone authenticator.

package/auth/authenticators/basic-authenticator.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasicAuthenticator = void 0;
 var extend = require("extend");
 var utils_1 = require("../utils");
 var authenticator_1 = require("./authenticator");

package/auth/authenticators/bearer-token-authenticator.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BearerTokenAuthenticator = void 0;
 var extend = require("extend");
 var utils_1 = require("../utils");
 var authenticator_1 = require("./authenticator");

package/auth/authenticators/cloud-pak-for-data-authenticator.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloudPakForDataAuthenticator = void 0;
 var token_managers_1 = require("../token-managers");
 var utils_1 = require("../utils");
 var token_request_based_authenticator_1 = require("./token-request-based-authenticator");

package/auth/authenticators/iam-authenticator.d.ts

@@ -29,6 +29,10 @@ export interface Options extends BaseOptions {
      * authorization header for IAM token requests.
      */
     clientSecret?: string;
+    /**
+     * The "scope" parameter to use when fetching the bearer token from the IAM token server.
+     */
+    scope?: string;
 }
 /**
  * The [[IamAuthenticator]] will use the user-supplied `apikey`
@@ -47,6 +51,7 @@ export declare class IamAuthenticator extends TokenRequestBasedAuthenticator {
     private apikey;
     private clientId;
     private clientSecret;
+    private scope;
     /**
      *
      * Create a new [[IamAuthenticator]] instance.
@@ -62,6 +67,8 @@ export declare class IamAuthenticator extends TokenRequestBasedAuthenticator {
      *   authorization header for IAM token requests.
      * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
      *   authorization header for IAM token requests.
+     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
+     *   IAM token server.
      * @throws {Error} When the configuration options are not valid.
      */
     constructor(options: Options);
@@ -73,4 +80,9 @@ export declare class IamAuthenticator extends TokenRequestBasedAuthenticator {
      *   authorization header for IAM token requests.
      */
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    /**
+     * Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
+     * @param {string} scope A space seperated string that makes up the scope parameter
+     */
+    setScope(scope: string): void;
 }

package/auth/authenticators/iam-authenticator.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IamAuthenticator = void 0;
 var token_managers_1 = require("../token-managers");
 var utils_1 = require("../utils");
 var token_request_based_authenticator_1 = require("./token-request-based-authenticator");
@@ -60,6 +59,8 @@ var IamAuthenticator = /** @class */ (function (_super) {
      *   authorization header for IAM token requests.
      * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
      *   authorization header for IAM token requests.
+     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
+     *   IAM token server.
      * @throws {Error} When the configuration options are not valid.
      */
     function IamAuthenticator(options) {
@@ -69,6 +70,7 @@ var IamAuthenticator = /** @class */ (function (_super) {
         _this.apikey = options.apikey;
         _this.clientId = options.clientId;
         _this.clientSecret = options.clientSecret;
+        _this.scope = options.scope;
         // the param names are shared between the authenticator and the token
         // manager so we can just pass along the options object
         _this.tokenManager = new token_managers_1.IamTokenManager(options);
@@ -87,6 +89,15 @@ var IamAuthenticator = /** @class */ (function (_super) {
         // update properties in token manager
         this.tokenManager.setClientIdAndSecret(clientId, clientSecret);
     };
+    /**
+     * Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
+     * @param {string} scope A space seperated string that makes up the scope parameter
+     */
+    IamAuthenticator.prototype.setScope = function (scope) {
+        this.scope = scope;
+        // update properties in token manager
+        this.tokenManager.setScope(scope);
+    };
     return IamAuthenticator;
 }(token_request_based_authenticator_1.TokenRequestBasedAuthenticator));
 exports.IamAuthenticator = IamAuthenticator;

package/auth/authenticators/index.js

@@ -16,16 +16,16 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 var authenticator_1 = require("./authenticator");
-Object.defineProperty(exports, "Authenticator", { enumerable: true, get: function () { return authenticator_1.Authenticator; } });
+exports.Authenticator = authenticator_1.Authenticator;
 var basic_authenticator_1 = require("./basic-authenticator");
-Object.defineProperty(exports, "BasicAuthenticator", { enumerable: true, get: function () { return basic_authenticator_1.BasicAuthenticator; } });
+exports.BasicAuthenticator = basic_authenticator_1.BasicAuthenticator;
 var bearer_token_authenticator_1 = require("./bearer-token-authenticator");
-Object.defineProperty(exports, "BearerTokenAuthenticator", { enumerable: true, get: function () { return bearer_token_authenticator_1.BearerTokenAuthenticator; } });
+exports.BearerTokenAuthenticator = bearer_token_authenticator_1.BearerTokenAuthenticator;
 var cloud_pak_for_data_authenticator_1 = require("./cloud-pak-for-data-authenticator");
-Object.defineProperty(exports, "CloudPakForDataAuthenticator", { enumerable: true, get: function () { return cloud_pak_for_data_authenticator_1.CloudPakForDataAuthenticator; } });
+exports.CloudPakForDataAuthenticator = cloud_pak_for_data_authenticator_1.CloudPakForDataAuthenticator;
 var iam_authenticator_1 = require("./iam-authenticator");
-Object.defineProperty(exports, "IamAuthenticator", { enumerable: true, get: function () { return iam_authenticator_1.IamAuthenticator; } });
+exports.IamAuthenticator = iam_authenticator_1.IamAuthenticator;
 var no_auth_authenticator_1 = require("./no-auth-authenticator");
-Object.defineProperty(exports, "NoAuthAuthenticator", { enumerable: true, get: function () { return no_auth_authenticator_1.NoAuthAuthenticator; } });
+exports.NoAuthAuthenticator = no_auth_authenticator_1.NoAuthAuthenticator;
 var token_request_based_authenticator_1 = require("./token-request-based-authenticator");
-Object.defineProperty(exports, "TokenRequestBasedAuthenticator", { enumerable: true, get: function () { return token_request_based_authenticator_1.TokenRequestBasedAuthenticator; } });
+exports.TokenRequestBasedAuthenticator = token_request_based_authenticator_1.TokenRequestBasedAuthenticator;

package/auth/authenticators/no-auth-authenticator.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoAuthAuthenticator = void 0;
 var authenticator_1 = require("./authenticator");
 /**
  * NoAuthAuthenticator is a placeholder authenticator implementation which

package/auth/authenticators/token-request-based-authenticator.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenRequestBasedAuthenticator = void 0;
 var extend = require("extend");
 var token_managers_1 = require("../token-managers");
 var authenticator_1 = require("./authenticator");

package/auth/index.js

@@ -14,17 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-};
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./authenticators"), exports);
-__exportStar(require("./token-managers"), exports);
-__exportStar(require("./utils"), exports);
+__export(require("./authenticators"));
+__export(require("./token-managers"));
+__export(require("./utils"));

package/auth/token-managers/cp4d-token-manager.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cp4dTokenManager = void 0;
 var extend = require("extend");
 var utils_1 = require("../utils");
 var jwt_token_manager_1 = require("./jwt-token-manager");

package/auth/token-managers/iam-token-manager.d.ts

@@ -19,6 +19,7 @@ interface Options extends JwtTokenManagerOptions {
     apikey: string;
     clientId?: string;
     clientSecret?: string;
+    scope?: string;
 }
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
@@ -30,6 +31,7 @@ export declare class IamTokenManager extends JwtTokenManager {
     private apikey;
     private clientId;
     private clientSecret;
+    private scope;
     /**
      *
      * Create a new [[IamTokenManager]] instance.
@@ -49,6 +51,15 @@ export declare class IamTokenManager extends JwtTokenManager {
      * @constructor
      */
     constructor(options: Options);
+    /**
+     * Set the IAM `scope` value.
+     * This value is the form parameter to use when fetching the bearer token
+     * from the IAM token server.
+     *
+     * @param {string} scope - A space seperated string that makes up the scope parameter.
+     * @returns {void}
+     */
+    setScope(scope: string): void;
     /**
      * Set the IAM `clientId` and `clientSecret` values.
      * These values are used to compute the Authorization header used

package/auth/token-managers/iam-token-manager.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IamTokenManager = void 0;
 var extend = require("extend");
 var logger_1 = require("../../lib/logger");
 var utils_1 = require("../utils");
@@ -47,6 +46,7 @@ function onlyOne(a, b) {
     return Boolean((a && !b) || (b && !a));
 }
 var CLIENT_ID_SECRET_WARNING = 'Warning: Client ID and Secret must BOTH be given, or the header will not be included.';
+var SCOPE = 'scope';
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
  * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
@@ -84,12 +84,26 @@ var IamTokenManager = /** @class */ (function (_super) {
         if (options.clientSecret) {
             _this.clientSecret = options.clientSecret;
         }
+        if (options.scope) {
+            _this.scope = options.scope;
+        }
         if (onlyOne(options.clientId, options.clientSecret)) {
             // tslint:disable-next-line
             logger_1.default.warn(CLIENT_ID_SECRET_WARNING);
         }
         return _this;
     }
+    /**
+     * Set the IAM `scope` value.
+     * This value is the form parameter to use when fetching the bearer token
+     * from the IAM token server.
+     *
+     * @param {string} scope - A space seperated string that makes up the scope parameter.
+     * @returns {void}
+     */
+    IamTokenManager.prototype.setScope = function (scope) {
+        this.scope = scope;
+    };
     /**
      * Set the IAM `clientId` and `clientSecret` values.
      * These values are used to compute the Authorization header used
@@ -136,6 +150,9 @@ var IamTokenManager = /** @class */ (function (_super) {
                 rejectUnauthorized: !this.disableSslVerification,
             }
         };
+        if (this.scope) {
+            parameters.options.form[SCOPE] = this.scope;
+        }
         return this.requestWrapperInstance.sendRequest(parameters);
     };
     return IamTokenManager;

package/auth/token-managers/index.js

@@ -31,10 +31,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *   JwtTokenManager: A class for shared functionality for parsing, storing, and requesting JWT tokens.
  */
 var iam_token_manager_1 = require("./iam-token-manager");
-Object.defineProperty(exports, "IamTokenManager", { enumerable: true, get: function () { return iam_token_manager_1.IamTokenManager; } });
+exports.IamTokenManager = iam_token_manager_1.IamTokenManager;
 var cp4d_token_manager_1 = require("./cp4d-token-manager");
-Object.defineProperty(exports, "Cp4dTokenManager", { enumerable: true, get: function () { return cp4d_token_manager_1.Cp4dTokenManager; } });
+exports.Cp4dTokenManager = cp4d_token_manager_1.Cp4dTokenManager;
 var jwt_token_manager_1 = require("./jwt-token-manager");
-Object.defineProperty(exports, "JwtTokenManager", { enumerable: true, get: function () { return jwt_token_manager_1.JwtTokenManager; } });
+exports.JwtTokenManager = jwt_token_manager_1.JwtTokenManager;
 var token_manager_1 = require("./token-manager");
-Object.defineProperty(exports, "TokenManager", { enumerable: true, get: function () { return token_manager_1.TokenManager; } });
+exports.TokenManager = token_manager_1.TokenManager;

package/auth/token-managers/jwt-token-manager.js

@@ -28,7 +28,6 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JwtTokenManager = void 0;
 var jwt = require("jsonwebtoken");
 var logger_1 = require("../../lib/logger");
 var token_manager_1 = require("./token-manager");

package/auth/token-managers/token-manager.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenManager = void 0;
 var helper_1 = require("../../lib/helper");
 var logger_1 = require("../../lib/logger");
 var request_wrapper_1 = require("../../lib/request-wrapper");

package/auth/utils/get-authenticator-from-environment.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAuthenticatorFromEnvironment = void 0;
 var authenticators_1 = require("../authenticators");
 var read_external_sources_1 = require("./read-external-sources");
 /**

package/auth/utils/helpers.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCurrentTime = exports.validateInput = exports.checkCredentials = exports.computeBasicAuthHeader = void 0;
 var helper_1 = require("../../lib/helper");
 /**
  * Compute and return a Basic Authorization header from a username and password.

package/auth/utils/index.js

@@ -14,16 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-};
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * @module utils
@@ -33,9 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *   getAuthenticatorFromEnvironment: Get authenticator from external sources.
  *   readExternalSources: Get config object from external sources.
  */
-__exportStar(require("./helpers"), exports);
-__exportStar(require("./read-credentials-file"), exports);
+__export(require("./helpers"));
+__export(require("./read-credentials-file"));
 var get_authenticator_from_environment_1 = require("./get-authenticator-from-environment");
-Object.defineProperty(exports, "getAuthenticatorFromEnvironment", { enumerable: true, get: function () { return get_authenticator_from_environment_1.getAuthenticatorFromEnvironment; } });
+exports.getAuthenticatorFromEnvironment = get_authenticator_from_environment_1.getAuthenticatorFromEnvironment;
 var read_external_sources_1 = require("./read-external-sources");
-Object.defineProperty(exports, "readExternalSources", { enumerable: true, get: function () { return read_external_sources_1.readExternalSources; } });
+exports.readExternalSources = read_external_sources_1.readExternalSources;

package/auth/utils/read-credentials-file.browser.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readCredentialsFile = void 0;
 // Dummy for browser
 function readCredentialsFile() {
     return {};

package/auth/utils/read-credentials-file.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructFilepath = exports.fileExistsAtPath = exports.readCredentialsFile = void 0;
 var dotenv = require("dotenv");
 var fs = require("fs");
 var os = require("os");

package/auth/utils/read-external-sources.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readExternalSources = void 0;
 var camelcase = require("camelcase");
 var isEmpty = require("lodash.isempty");
 var logger_1 = require("../../lib/logger");
@@ -73,13 +72,16 @@ function filterPropertiesByServiceName(envObj, serviceName) {
             credentials[propName] = envObj[key];
         }
     });
-    // all env variables are parsed as strings, convert disable ssl vars to boolean
+    // all env variables are parsed as strings, convert boolean vars as needed
     if (typeof credentials.disableSsl === 'string') {
         credentials.disableSsl = credentials.disableSsl === 'true';
     }
     if (typeof credentials.authDisableSsl === 'string') {
         credentials.authDisableSsl = credentials.authDisableSsl === 'true';
     }
+    if (typeof credentials.enableGzip === 'string') {
+        credentials.enableGzip = credentials.enableGzip === 'true';
+    }
     return credentials;
 }
 /**

package/index.js

@@ -14,29 +14,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-};
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unitTestUtils = void 0;
 /**
  * @module ibm-cloud-sdk-core
  */
 var base_service_1 = require("./lib/base-service");
-Object.defineProperty(exports, "BaseService", { enumerable: true, get: function () { return base_service_1.BaseService; } });
-__exportStar(require("./auth"), exports);
-__exportStar(require("./lib/helper"), exports);
+exports.BaseService = base_service_1.BaseService;
+__export(require("./auth"));
+__export(require("./lib/helper"));
 var querystring_1 = require("./lib/querystring");
-Object.defineProperty(exports, "qs", { enumerable: true, get: function () { return querystring_1.default; } });
+exports.qs = querystring_1.default;
 var content_type_1 = require("./lib/content-type");
-Object.defineProperty(exports, "contentType", { enumerable: true, get: function () { return content_type_1.default; } });
-__exportStar(require("./lib/stream-to-promise"), exports);
+exports.contentType = content_type_1.default;
+__export(require("./lib/stream-to-promise"));
 var unitTestUtils = require("./lib/sdk-test-helpers");
 exports.unitTestUtils = unitTestUtils;

package/lib/base-service.d.ts

@@ -82,6 +82,12 @@ export declare class BaseService {
      * @param {string} url The base URL for the service.
      */
     setServiceUrl(url: string): void;
+    /**
+     * Turn request body compression on or off.
+     *
+     * @param {boolean} setting Will turn it on if 'true', off if 'false'.
+     */
+    setEnableGzipCompression(setting: boolean): void;
     /**
      * Configure the service using external configuration
      *

package/lib/base-service.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseService = void 0;
 var auth_1 = require("../auth");
 var helper_1 = require("./helper");
 var logger_1 = require("./logger");
@@ -93,6 +92,14 @@ var BaseService = /** @class */ (function () {
             this.baseOptions.serviceUrl = helper_1.stripTrailingSlash(url);
         }
     };
+    /**
+     * Turn request body compression on or off.
+     *
+     * @param {boolean} setting Will turn it on if 'true', off if 'false'.
+     */
+    BaseService.prototype.setEnableGzipCompression = function (setting) {
+        this.requestWrapperInstance.compressRequestData = setting;
+    };
     /**
      * Configure the service using external configuration
      *
@@ -146,14 +153,20 @@ var BaseService = /** @class */ (function () {
         var results = {};
         var properties = auth_1.readExternalSources(serviceName);
         if (properties !== null) {
-            // the user can define two client-level variables in the credentials file: url and disableSsl
-            var url = properties.url, disableSsl = properties.disableSsl;
+            // the user can define the following client-level variables in the credentials file:
+            // - url
+            // - disableSsl
+            // - enableGzip
+            var url = properties.url, disableSsl = properties.disableSsl, enableGzip = properties.enableGzip;
             if (url) {
                 results.serviceUrl = helper_1.stripTrailingSlash(url);
             }
             if (disableSsl === true) {
                 results.disableSslVerification = disableSsl;
             }
+            if (enableGzip === true) {
+                results.enableGzipCompression = enableGzip;
+            }
         }
         return results;
     };

package/lib/helper.js

@@ -22,7 +22,6 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
     return r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toLowerKeys = exports.buildRequestFileObject = exports.getFormat = exports.isHTML = exports.getMissingParams = exports.stripTrailingSlash = exports.getContentType = exports.isEmptyObject = exports.isFileData = exports.isFileWithMetadata = void 0;
 var fileType = require("file-type");
 var isstream_1 = require("isstream");
 var mime_types_1 = require("mime-types");

package/lib/request-wrapper.d.ts

@@ -15,6 +15,7 @@
  */
 export declare class RequestWrapper {
     private axiosInstance;
+    private compressRequestData;
     constructor(axiosOptions?: any);
     /**
      * Creates the request.
@@ -34,4 +35,5 @@ export declare class RequestWrapper {
      * @returns {Error}
      */
     formatError(axiosError: any): Error;
+    private gzipRequestBody;
 }

package/lib/request-wrapper.js

@@ -14,21 +14,60 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestWrapper = void 0;
 var axios_1 = require("axios");
 var axios_cookiejar_support_1 = require("axios-cookiejar-support");
 var extend = require("extend");
 var FormData = require("form-data");
 var https = require("https");
+var isStream = require("isstream");
 var querystring = require("querystring");
+var zlib = require("zlib");
 var helper_1 = require("./helper");
 var logger_1 = require("./logger");
+var stream_to_promise_1 = require("./stream-to-promise");
 var isBrowser = typeof window === 'object';
 var globalTransactionId = 'x-global-transaction-id';
 var RequestWrapper = /** @class */ (function () {
     function RequestWrapper(axiosOptions) {
         axiosOptions = axiosOptions || {};
+        this.compressRequestData = Boolean(axiosOptions.enableGzipCompression);
         // override several axios defaults
         // axios sets the default Content-Type for `post`, `put`, and `patch` operations
         // to 'application/x-www-form-urlencoded'. This causes problems, so overriding the
@@ -126,90 +165,102 @@ var RequestWrapper = /** @class */ (function () {
      * @throws {Error}
      */
     RequestWrapper.prototype.sendRequest = function (parameters) {
-        var _this = this;
-        var options = extend(true, {}, parameters.defaultOptions, parameters.options);
-        var path = options.path, body = options.body, form = options.form, formData = options.formData, qs = options.qs, method = options.method, serviceUrl = options.serviceUrl;
-        var headers = options.headers, url = options.url;
-        var multipartForm = new FormData();
-        // Form params
-        if (formData) {
-            Object.keys(formData).forEach(function (key) {
-                var values = Array.isArray(formData[key]) ? formData[key] : [formData[key]];
-                // Skip keys with undefined/null values or empty object value
-                values.filter(function (v) { return v != null && !helper_1.isEmptyObject(v); }).forEach(function (value) {
-                    // Special case of empty file object
-                    if (value.hasOwnProperty('contentType') && !value.hasOwnProperty('data')) {
-                        return;
-                    }
-                    if (helper_1.isFileWithMetadata(value)) {
-                        var fileObj = helper_1.buildRequestFileObject(value);
-                        multipartForm.append(key, fileObj.value, fileObj.options);
-                    }
-                    else {
-                        if (typeof value === 'object' && !helper_1.isFileData(value)) {
-                            value = JSON.stringify(value);
+        return __awaiter(this, void 0, void 0, function () {
+            var options, path, body, form, formData, qs, method, serviceUrl, headers, url, multipartForm, data, requestParams;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        options = extend(true, {}, parameters.defaultOptions, parameters.options);
+                        path = options.path, body = options.body, form = options.form, formData = options.formData, qs = options.qs, method = options.method, serviceUrl = options.serviceUrl;
+                        headers = options.headers, url = options.url;
+                        multipartForm = new FormData();
+                        // Form params
+                        if (formData) {
+                            Object.keys(formData).forEach(function (key) {
+                                var values = Array.isArray(formData[key]) ? formData[key] : [formData[key]];
+                                // Skip keys with undefined/null values or empty object value
+                                values.filter(function (v) { return v != null && !helper_1.isEmptyObject(v); }).forEach(function (value) {
+                                    // Special case of empty file object
+                                    if (value.hasOwnProperty('contentType') && !value.hasOwnProperty('data')) {
+                                        return;
+                                    }
+                                    if (helper_1.isFileWithMetadata(value)) {
+                                        var fileObj = helper_1.buildRequestFileObject(value);
+                                        multipartForm.append(key, fileObj.value, fileObj.options);
+                                    }
+                                    else {
+                                        if (typeof value === 'object' && !helper_1.isFileData(value)) {
+                                            value = JSON.stringify(value);
+                                        }
+                                        multipartForm.append(key, value);
+                                    }
+                                });
+                            });
                         }
-                        multipartForm.append(key, value);
-                    }
-                });
+                        // Path params
+                        url = parsePath(url, path);
+                        // Headers
+                        options.headers = Object.assign({}, options.headers);
+                        // Convert array-valued query params to strings
+                        if (qs && Object.keys(qs).length > 0) {
+                            Object.keys(qs).forEach(function (key) { return Array.isArray(qs[key]) && (qs[key] = qs[key].join(',')); });
+                        }
+                        // Add service default endpoint if options.url start with /
+                        if (url && url.charAt(0) === '/') {
+                            url = helper_1.stripTrailingSlash(serviceUrl) + url;
+                        }
+                        url = helper_1.stripTrailingSlash(url);
+                        data = body;
+                        if (form) {
+                            data = querystring.stringify(form);
+                            headers['Content-type'] = 'application/x-www-form-urlencoded';
+                        }
+                        if (formData) {
+                            data = multipartForm;
+                            // form-data generates headers that MUST be included or the request will fail
+                            headers = extend(true, {}, headers, multipartForm.getHeaders());
+                        }
+                        // accept gzip encoded responses if Accept-Encoding is not already set
+                        headers['Accept-Encoding'] = headers['Accept-Encoding'] || 'gzip';
+                        if (!this.compressRequestData) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.gzipRequestBody(data, headers)];
+                    case 1:
+                        data = _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        requestParams = {
+                            url: url,
+                            method: method,
+                            headers: headers,
+                            params: qs,
+                            data: data,
+                            responseType: options.responseType || 'json',
+                            paramsSerializer: function (params) {
+                                return querystring.stringify(params);
+                            },
+                        };
+                        return [2 /*return*/, this.axiosInstance(requestParams).then(function (res) {
+                                // sometimes error responses will still trigger the `then` block - escape that behavior here
+                                if (!res) {
+                                    return;
+                                }
+                                ;
+                                // these objects contain circular json structures and are not always relevant to the user
+                                // if the user wants them, they can be accessed through the debug properties
+                                delete res.config;
+                                delete res.request;
+                                // the other sdks use the interface `result` for the body
+                                res.result = res.data;
+                                delete res.data;
+                                // return another promise that resolves with 'res' to be handled in generated code
+                                return res;
+                            }, function (err) {
+                                // return another promise that rejects with 'err' to be handled in generated code
+                                throw _this.formatError(err);
+                            })];
+                }
             });
-        }
-        // Path params
-        url = parsePath(url, path);
-        // Headers
-        options.headers = Object.assign({}, options.headers);
-        // Convert array-valued query params to strings
-        if (qs && Object.keys(qs).length > 0) {
-            Object.keys(qs).forEach(function (key) { return Array.isArray(qs[key]) && (qs[key] = qs[key].join(',')); });
-        }
-        // Add service default endpoint if options.url start with /
-        if (url && url.charAt(0) === '/') {
-            url = helper_1.stripTrailingSlash(serviceUrl) + url;
-        }
-        url = helper_1.stripTrailingSlash(url);
-        var data = body;
-        if (form) {
-            data = querystring.stringify(form);
-            headers['Content-type'] = 'application/x-www-form-urlencoded';
-        }
-        if (formData) {
-            data = multipartForm;
-            // form-data generates headers that MUST be included or the request will fail
-            headers = extend(true, {}, headers, multipartForm.getHeaders());
-        }
-        // TEMPORARY: Disabling gzipping due to bug in axios until fix is released:
-        // https://github.com/axios/axios/pull/1129
-        // accept gzip encoded responses if Accept-Encoding is not already set
-        // headers['Accept-Encoding'] = headers['Accept-Encoding'] || 'gzip';
-        var requestParams = {
-            url: url,
-            method: method,
-            headers: headers,
-            params: qs,
-            data: data,
-            responseType: options.responseType || 'json',
-            paramsSerializer: function (params) {
-                return querystring.stringify(params);
-            },
-        };
-        return this.axiosInstance(requestParams).then(function (res) {
-            // sometimes error responses will still trigger the `then` block - escape that behavior here
-            if (!res) {
-                return;
-            }
-            ;
-            // these objects contain circular json structures and are not always relevant to the user
-            // if the user wants them, they can be accessed through the debug properties
-            delete res.config;
-            delete res.request;
-            // the other sdks use the interface `result` for the body
-            res.result = res.data;
-            delete res.data;
-            // return another promise that resolves with 'res' to be handled in generated code
-            return res;
-        }, function (err) {
-            // return another promise that rejects with 'err' to be handled in generated code
-            throw _this.formatError(err);
         });
     };
     /**
@@ -275,6 +326,58 @@ var RequestWrapper = /** @class */ (function () {
         }
         return error;
     };
+    RequestWrapper.prototype.gzipRequestBody = function (data, headers) {
+        return __awaiter(this, void 0, void 0, function () {
+            var contentSetToGzip, reqBuffer, _a, _b, err_1;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        contentSetToGzip = headers['Content-Encoding'] &&
+                            headers['Content-Encoding'].toString().includes('gzip');
+                        if (!data || contentSetToGzip) {
+                            return [2 /*return*/, data];
+                        }
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 5, , 6]);
+                        if (!isStream(data)) return [3 /*break*/, 3];
+                        _b = (_a = Buffer).from;
+                        return [4 /*yield*/, stream_to_promise_1.streamToPromise(data)];
+                    case 2:
+                        reqBuffer = _b.apply(_a, [_c.sent()]);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        if (data.toString && data.toString() !== '[object Object]' && !Array.isArray(data)) {
+                            // this handles pretty much any primitive that isnt a JSON object or array
+                            reqBuffer = Buffer.from(data.toString());
+                        }
+                        else {
+                            reqBuffer = Buffer.from(JSON.stringify(data));
+                        }
+                        _c.label = 4;
+                    case 4: return [3 /*break*/, 6];
+                    case 5:
+                        err_1 = _c.sent();
+                        logger_1.default.error('Error converting request body to a buffer - data will not be compressed.');
+                        logger_1.default.debug(err_1);
+                        return [2 /*return*/, data];
+                    case 6:
+                        try {
+                            data = zlib.gzipSync(reqBuffer);
+                            // update the headers by reference - only if the data was actually compressed
+                            headers['Content-Encoding'] = 'gzip';
+                        }
+                        catch (err) {
+                            // if an exception is caught, `data` will still be in its original form
+                            // we can just proceed with the request uncompressed
+                            logger_1.default.error('Error compressing request body - data will not be compressed.');
+                            logger_1.default.debug(err);
+                        }
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
     return RequestWrapper;
 }());
 exports.RequestWrapper = RequestWrapper;

package/lib/sdk-test-helpers.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
 var expect = require("expect");
 /**
  * This module provides a set of helper methods used to reduce code duplication in the generated unit tests

package/lib/stream-to-promise.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamToPromise = void 0;
 /**
  * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text
  * Essentially a smaller version of concat-stream wrapped in a promise

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "2.4.4",
+  "version": "2.7.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI 3 SDK Generator.",
   "main": "index",
   "repository": {
@@ -33,7 +33,7 @@
     "@types/isstream": "^0.1.0",
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
-    "axios": "^0.18.1",
+    "axios": "^0.20.0",
     "axios-cookiejar-support": "^1.0.0",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",