ibm-cloud-sdk-core 3.2.0 → 3.2.2-beta

package/{es → dist/es}/lib/request-wrapper.js

@@ -25,13 +25,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
  */
 import axios from 'axios';
 import * as rax from 'retry-axios';
-import axiosCookieJarSupport from 'axios-cookiejar-support';
+import { wrapper as axiosCookieJarSupport } from 'axios-cookiejar-support';
 import extend from 'extend';
 import FormData from 'form-data';
 import { Agent } from 'https';
 import isStream from 'isstream';
 import { stringify } from 'querystring';
 import { gzipSync } from 'zlib';
+import { CookieJar } from 'tough-cookie';
 import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata, stripTrailingSlash, } from './helper';
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
@@ -73,8 +74,15 @@ export class RequestWrapper {
         // if a cookie jar is provided, wrap the axios instance and update defaults
         if (axiosOptions.jar) {
             axiosCookieJarSupport(this.axiosInstance);
-            this.axiosInstance.defaults.withCredentials = true;
-            this.axiosInstance.defaults.jar = axiosOptions.jar;
+            // axios-cookiejar-support < 2.x accepted a boolean
+            // some SDKs might be using that, so create a default
+            // CookieJar if detecting true.
+            if (axiosOptions.jar === true) {
+                this.axiosInstance.defaults.jar = new CookieJar();
+            }
+            else {
+                this.axiosInstance.defaults.jar = axiosOptions.jar;
+            }
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {
@@ -130,29 +138,27 @@ export class RequestWrapper {
             const multipartForm = new FormData();
             // Form params
             if (formData) {
-                Object.keys(formData).forEach((key) => {
-                    const values = Array.isArray(formData[key]) ? formData[key] : [formData[key]];
+                for (const key of Object.keys(formData)) { // eslint-disable-line
+                    let values = Array.isArray(formData[key]) ? formData[key] : [formData[key]];
                     // Skip keys with undefined/null values or empty object value
-                    values
-                        .filter((v) => v != null && !isEmptyObject(v))
-                        .forEach((value) => __awaiter(this, void 0, void 0, function* () {
-                        // Special case of empty file object
-                        if (Object.prototype.hasOwnProperty.call(value, 'contentType') &&
-                            !Object.prototype.hasOwnProperty.call(value, 'data')) {
-                            return;
-                        }
-                        if (isFileWithMetadata(value)) {
-                            const fileObj = yield buildRequestFileObject(value);
-                            multipartForm.append(key, fileObj.value, fileObj.options);
-                        }
-                        else {
-                            if (typeof value === 'object' && !isFileData(value)) {
-                                value = JSON.stringify(value);
+                    values = values.filter((v) => v != null && !isEmptyObject(v));
+                    for (let value of values) { // eslint-disable-line
+                        // Ignore special case of empty file object
+                        if (!Object.prototype.hasOwnProperty.call(value, 'contentType') ||
+                            Object.prototype.hasOwnProperty.call(value, 'data')) {
+                            if (isFileWithMetadata(value)) {
+                                const fileObj = yield buildRequestFileObject(value); // eslint-disable-line
+                                multipartForm.append(key, fileObj.value, fileObj.options);
+                            }
+                            else {
+                                if (typeof value === 'object' && !isFileData(value)) {
+                                    value = JSON.stringify(value);
+                                }
+                                multipartForm.append(key, value);
                             }
-                            multipartForm.append(key, value);
                         }
-                    }));
-                });
+                    }
+                }
             }
             // Path params
             url = parsePath(url, path);
@@ -195,7 +201,7 @@ export class RequestWrapper {
                 data,
                 raxConfig: this.raxConfig,
                 responseType: options.responseType || 'json',
-                paramsSerializer: (params) => stringify(params),
+                paramsSerializer: { serialize: (params) => stringify(params) },
             };
             return this.axiosInstance(requestParams).then((res) => {
                 // sometimes error responses will still trigger the `then` block - escape that behavior here
@@ -299,7 +305,7 @@ export class RequestWrapper {
             instance: axiosInstance,
             backoffType: 'exponential',
             checkRetryAfter: true,
-            maxRetryDelay: 30 * 1000,
+            maxRetryDelay: 30 * 1000, // default to 30 sec max delay
         };
         if (retryOptions) {
             if (typeof retryOptions.maxRetries === 'number') {

package/dist/index.js

@@ -0,0 +1,63 @@
+"use strict";
+/**
+ * (C) Copyright IBM Corp. 2019, 2021.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * 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;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNewLogger = exports.unitTestUtils = exports.contentType = exports.qs = exports.BaseService = void 0;
+/**
+ * @module ibm-cloud-sdk-core
+ */
+var unitTestUtils = __importStar(require("./lib/sdk-test-helpers"));
+exports.unitTestUtils = unitTestUtils;
+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);
+var querystring_1 = require("./lib/querystring");
+Object.defineProperty(exports, "qs", { enumerable: true, get: function () { return __importDefault(querystring_1).default; } });
+var content_type_1 = require("./lib/content-type");
+Object.defineProperty(exports, "contentType", { enumerable: true, get: function () { return __importDefault(content_type_1).default; } });
+__exportStar(require("./lib/stream-to-promise"), exports);
+var get_new_logger_1 = require("./lib/get-new-logger");
+Object.defineProperty(exports, "getNewLogger", { enumerable: true, get: function () { return get_new_logger_1.getNewLogger; } });

package/{lib → dist/lib}/base-service.js

@@ -29,6 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseService = void 0;
 var auth_1 = require("../auth");
 var helper_1 = require("./helper");
 var logger_1 = __importDefault(require("./logger"));
@@ -56,7 +57,7 @@ var BaseService = /** @class */ (function () {
     function BaseService(userOptions) {
         if (!(this instanceof BaseService)) {
             var err = 'the "new" keyword is required to create service instances';
-            logger_1.default.error("Error creating an instance of BaseService: " + err);
+            logger_1.default.error("Error creating an instance of BaseService: ".concat(err));
             throw new Error(err);
         }
         var baseServiceOptions = {};
@@ -66,10 +67,10 @@ var BaseService = /** @class */ (function () {
             options.serviceUrl = options.url;
         }
         if (options.serviceUrl) {
-            baseServiceOptions.serviceUrl = helper_1.stripTrailingSlash(options.serviceUrl);
+            baseServiceOptions.serviceUrl = (0, helper_1.stripTrailingSlash)(options.serviceUrl);
         }
         // check serviceUrl for common user errors
-        var credentialProblems = auth_1.checkCredentials(options, ['serviceUrl']);
+        var credentialProblems = (0, auth_1.checkCredentials)(options, ['serviceUrl']);
         if (credentialProblems) {
             logger_1.default.error(credentialProblems.message);
             throw credentialProblems;
@@ -103,7 +104,7 @@ var BaseService = /** @class */ (function () {
      */
     BaseService.prototype.setServiceUrl = function (url) {
         if (url) {
-            this.baseOptions.serviceUrl = helper_1.stripTrailingSlash(url);
+            this.baseOptions.serviceUrl = (0, helper_1.stripTrailingSlash)(url);
         }
     };
     /**
@@ -201,7 +202,7 @@ var BaseService = /** @class */ (function () {
     // eslint-disable-next-line class-methods-use-this
     BaseService.prototype.readOptionsFromExternalConfig = function (serviceName) {
         var results = {};
-        var properties = auth_1.readExternalSources(serviceName);
+        var properties = (0, auth_1.readExternalSources)(serviceName);
         if (properties !== null) {
             // the user can define the following client-level variables in the credentials file:
             // - url
@@ -209,7 +210,7 @@ var BaseService = /** @class */ (function () {
             // - enableGzip
             var url = properties.url, disableSsl = properties.disableSsl, enableGzip = properties.enableGzip, enableRetries = properties.enableRetries, maxRetries = properties.maxRetries, retryInterval = properties.retryInterval;
             if (url) {
-                results.serviceUrl = helper_1.stripTrailingSlash(url);
+                results.serviceUrl = (0, helper_1.stripTrailingSlash)(url);
             }
             if (disableSsl === true) {
                 results.disableSslVerification = disableSsl;

package/{lib → dist/lib}/content-type.js

@@ -62,7 +62,7 @@ var fromHeader = function (buffer) {
  * @return {String|undefined}
  */
 var fromFilename = function (file) {
-    var ext = path_1.extname(
+    var ext = (0, path_1.extname)(
     // eslint-disable-next-line @typescript-eslint/dot-notation
     (typeof file === 'string' && file) || file['name'] || '');
     return filenameContentTypes[ext];

package/{lib → dist/lib}/get-new-logger.js

@@ -18,6 +18,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNewLogger = void 0;
 var debug_1 = __importDefault(require("debug"));
 /**
  * Return a new logger, formatted with a particular name. The logging functions, in
@@ -35,11 +36,11 @@ var debug_1 = __importDefault(require("debug"));
  * @returns {SDKLogger} the new logger
  */
 function getNewLogger(moduleName) {
-    var debug = debug_1.default(moduleName + ":debug");
-    var error = debug_1.default(moduleName + ":error");
-    var info = debug_1.default(moduleName + ":info");
-    var verbose = debug_1.default(moduleName + ":verbose");
-    var warn = debug_1.default(moduleName + ":warning");
+    var debug = (0, debug_1.default)("".concat(moduleName, ":debug"));
+    var error = (0, debug_1.default)("".concat(moduleName, ":error"));
+    var info = (0, debug_1.default)("".concat(moduleName, ":info"));
+    var verbose = (0, debug_1.default)("".concat(moduleName, ":verbose"));
+    var warn = (0, debug_1.default)("".concat(moduleName, ":warning"));
     // enable loggers if axios flag is set & mimic log levels severity
     if (process.env.NODE_DEBUG === 'axios') {
         debug.enabled = true;

package/{lib → dist/lib}/helper.js

@@ -50,17 +50,20 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-var __spreadArrays = (this && this.__spreadArrays) || function () {
-    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
-    for (var r = Array(s), k = 0, i = 0; i < il; i++)
-        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
-            r[k] = a[j];
-    return r;
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 };
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructServiceUrl = exports.toLowerKeys = exports.buildRequestFileObject = exports.getFormat = exports.isHTML = exports.validateParams = exports.getMissingParams = exports.getQueryParam = exports.stripTrailingSlash = exports.getContentType = exports.isEmptyObject = exports.isFileData = exports.isFileWithMetadata = void 0;
 var isstream_1 = require("isstream");
 var mime_types_1 = require("mime-types");
 var path_1 = require("path");
@@ -71,14 +74,14 @@ function isFileObject(obj) {
     return Boolean(obj && obj.value);
 }
 function isFileStream(obj) {
-    return Boolean(obj && isstream_1.isReadable(obj) && obj.path);
+    return Boolean(obj && (0, isstream_1.isReadable)(obj) && obj.path);
 }
 function isFileWithMetadata(obj) {
     return Boolean(obj && obj.data && isFileData(obj.data));
 }
 exports.isFileWithMetadata = isFileWithMetadata;
 function isFileData(obj) {
-    return Boolean(obj && (isstream_1.isReadable(obj) || Buffer.isBuffer(obj)));
+    return Boolean(obj && ((0, isstream_1.isReadable)(obj) || Buffer.isBuffer(obj)));
 }
 exports.isFileData = isFileData;
 function isEmptyObject(obj) {
@@ -98,7 +101,7 @@ function getContentType(inputData) {
                 case 0:
                     contentType = null;
                     if (!isFileStream(inputData)) return [3 /*break*/, 1];
-                    mimeType = mime_types_1.lookup(inputData.path);
+                    mimeType = (0, mime_types_1.lookup)(inputData.path);
                     contentType = { mime: mimeType || null };
                     return [3 /*break*/, 3];
                 case 1:
@@ -162,7 +165,7 @@ function getMissingParams(params, requires) {
         });
     }
     return missing.length > 0
-        ? new Error("Missing required parameters: " + missing.join(', '))
+        ? new Error("Missing required parameters: ".concat(missing.join(', ')))
         : null;
 }
 exports.getMissingParams = getMissingParams;
@@ -210,10 +213,10 @@ function validateParams(params, requiredParams, allParams) {
     // Return an Error object identifying the errors we found.
     var errorMsg = 'Parameter validation errors:';
     if (missing.length > 0) {
-        errorMsg += "\n  Missing required parameters: " + missing.join(', ');
+        errorMsg += "\n  Missing required parameters: ".concat(missing.join(', '));
     }
     if (invalid.length > 0) {
-        errorMsg += "\n  Found invalid parameters: " + invalid.join(', ');
+        errorMsg += "\n  Found invalid parameters: ".concat(invalid.join(', '));
     }
     return new Error(errorMsg);
 }
@@ -234,7 +237,7 @@ function isMissing(value) {
  * @returns {boolean} true if 'text' has html tags
  */
 function isHTML(text) {
-    logger_1.default.debug("Determining if the text " + text + " is HTML.");
+    logger_1.default.debug("Determining if the text ".concat(text, " is HTML."));
     return /<[a-z][\s\S]*>/i.test(text);
 }
 exports.isHTML = isHTML;
@@ -300,7 +303,7 @@ function buildRequestFileObject(fileParam) {
                         filename = fileObj.value.path;
                     }
                     // toString handles the case when path is a buffer
-                    fileObj.options.filename = filename ? path_1.basename(filename.toString()) : '_';
+                    fileObj.options.filename = filename ? (0, path_1.basename)(filename.toString()) : '_';
                     if (!(!fileObj.options.contentType && isFileData(fileObj.value))) return [3 /*break*/, 2];
                     _a = fileObj.options;
                     return [4 /*yield*/, getContentType(fileObj.value)];
@@ -323,12 +326,12 @@ exports.buildRequestFileObject = buildRequestFileObject;
 function toLowerKeys(obj) {
     var lowerCaseObj = {};
     if (obj) {
-        lowerCaseObj = Object.assign.apply(Object, __spreadArrays([{}], Object.keys(obj).map(function (key) {
+        lowerCaseObj = Object.assign.apply(Object, __spreadArray([{}], Object.keys(obj).map(function (key) {
             var _a;
             return (_a = {},
                 _a[key.toLowerCase()] = obj[key],
                 _a);
-        })));
+        }), false));
     }
     return lowerCaseObj;
 }
@@ -353,7 +356,7 @@ function constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlV
     // Verify the provided variable names.
     providedUrlVariables.forEach(function (_, name) {
         if (!defaultUrlVariables.has(name)) {
-            throw new Error("'" + name + "' is an invalid variable name.\n      Valid variable names: [" + Array.from(defaultUrlVariables.keys()).sort() + "].");
+            throw new Error("'".concat(name, "' is an invalid variable name.\n      Valid variable names: [").concat(Array.from(defaultUrlVariables.keys()).sort(), "]."));
         }
     });
     // Format the URL with provided or default variable values.
@@ -362,7 +365,7 @@ function constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlV
         // Use the default variable value if none was provided.
         var providedValue = providedUrlVariables.get(name);
         var formatValue = providedValue !== undefined ? providedValue : defaultValue;
-        formattedUrl = formattedUrl.replace("{" + name + "}", formatValue);
+        formattedUrl = formattedUrl.replace("{".concat(name, "}"), formatValue);
     });
     return formattedUrl;
 }

package/{lib → dist/lib}/logger.js

@@ -16,4 +16,4 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 var get_new_logger_1 = require("./get-new-logger");
-exports.default = get_new_logger_1.getNewLogger('ibm-cloud-sdk-core');
+exports.default = (0, get_new_logger_1.getNewLogger)('ibm-cloud-sdk-core');

package/{lib → dist/lib}/querystring.js

@@ -23,7 +23,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 var stringify = function (queryParams) {
     return Object.keys(queryParams)
-        .map(function (key) { return key + "=" + encodeURIComponent(queryParams[key]); })
+        .map(function (key) { return "".concat(key, "=").concat(encodeURIComponent(queryParams[key])); })
         .join('&');
 };
 exports.default = {