ibm-cloud-sdk-core 3.2.1 → 3.2.2-beta-1

package/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 = {

package/lib/request-wrapper.js

@@ -11,6 +11,29 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+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 __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) {
@@ -50,14 +73,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestWrapper = void 0;
 /**
  * (C) Copyright IBM Corp. 2014, 2021.
  *
@@ -75,13 +92,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 var axios_1 = __importDefault(require("axios"));
 var rax = __importStar(require("retry-axios"));
-var axios_cookiejar_support_1 = __importDefault(require("axios-cookiejar-support"));
+var axios_cookiejar_support_1 = require("axios-cookiejar-support");
 var extend_1 = __importDefault(require("extend"));
 var form_data_1 = __importDefault(require("form-data"));
 var https_1 = require("https");
 var isstream_1 = __importDefault(require("isstream"));
 var querystring_1 = require("querystring");
 var zlib_1 = require("zlib");
+var tough_cookie_1 = require("tough-cookie");
 var helper_1 = require("./helper");
 var logger_1 = __importDefault(require("./logger"));
 var stream_to_promise_1 = require("./stream-to-promise");
@@ -96,7 +114,7 @@ var RequestWrapper = /** @class */ (function () {
             maxBodyLength: Infinity,
         };
         // merge axios config into default
-        extend_1.default(true, axiosConfig, axiosOptions);
+        (0, extend_1.default)(true, axiosConfig, axiosOptions);
         // if the user explicitly sets `disableSslVerification` to true,
         // `rejectUnauthorized` must be set to false in the https agent
         if (axiosOptions.disableSslVerification === true) {
@@ -123,9 +141,16 @@ var RequestWrapper = /** @class */ (function () {
         });
         // if a cookie jar is provided, wrap the axios instance and update defaults
         if (axiosOptions.jar) {
-            axios_cookiejar_support_1.default(this.axiosInstance);
-            this.axiosInstance.defaults.withCredentials = true;
-            this.axiosInstance.defaults.jar = axiosOptions.jar;
+            (0, axios_cookiejar_support_1.wrapper)(this.axiosInstance);
+            // 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 tough_cookie_1.CookieJar();
+            }
+            else {
+                this.axiosInstance.defaults.jar = axiosOptions.jar;
+            }
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {
@@ -180,7 +205,7 @@ var RequestWrapper = /** @class */ (function () {
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        options = extend_1.default(true, {}, parameters.defaultOptions, parameters.options);
+                        options = (0, extend_1.default)(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 form_data_1.default();
@@ -192,7 +217,7 @@ var RequestWrapper = /** @class */ (function () {
                         key = _a[_i];
                         values = Array.isArray(formData[key]) ? formData[key] : [formData[key]];
                         // Skip keys with undefined/null values or empty object value
-                        values = values.filter(function (v) { return v != null && !helper_1.isEmptyObject(v); });
+                        values = values.filter(function (v) { return v != null && !(0, helper_1.isEmptyObject)(v); });
                         _b = 0, values_1 = values;
                         _c.label = 2;
                     case 2:
@@ -200,14 +225,14 @@ var RequestWrapper = /** @class */ (function () {
                         value = values_1[_b];
                         if (!(!Object.prototype.hasOwnProperty.call(value, 'contentType') ||
                             Object.prototype.hasOwnProperty.call(value, 'data'))) return [3 /*break*/, 5];
-                        if (!helper_1.isFileWithMetadata(value)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, helper_1.buildRequestFileObject(value)];
+                        if (!(0, helper_1.isFileWithMetadata)(value)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, (0, helper_1.buildRequestFileObject)(value)];
                     case 3:
                         fileObj = _c.sent();
                         multipartForm.append(key, fileObj.value, fileObj.options);
                         return [3 /*break*/, 5];
                     case 4:
-                        if (typeof value === 'object' && !helper_1.isFileData(value)) {
+                        if (typeof value === 'object' && !(0, helper_1.isFileData)(value)) {
                             value = JSON.stringify(value);
                         }
                         multipartForm.append(key, value);
@@ -233,18 +258,18 @@ var RequestWrapper = /** @class */ (function () {
                         }
                         // Add service default endpoint if options.url start with /
                         if (url && url.charAt(0) === '/') {
-                            url = helper_1.stripTrailingSlash(serviceUrl) + url;
+                            url = (0, helper_1.stripTrailingSlash)(serviceUrl) + url;
                         }
-                        url = helper_1.stripTrailingSlash(url);
+                        url = (0, helper_1.stripTrailingSlash)(url);
                         data = body;
                         if (form) {
-                            data = querystring_1.stringify(form);
+                            data = (0, querystring_1.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_1.default(true, {}, headers, multipartForm.getHeaders());
+                            headers = (0, extend_1.default)(true, {}, headers, multipartForm.getHeaders());
                         }
                         // accept gzip encoded responses if Accept-Encoding is not already set
                         headers['Accept-Encoding'] = headers['Accept-Encoding'] || 'gzip';
@@ -262,7 +287,7 @@ var RequestWrapper = /** @class */ (function () {
                             data: data,
                             raxConfig: this.raxConfig,
                             responseType: options.responseType || 'json',
-                            paramsSerializer: function (params) { return querystring_1.stringify(params); },
+                            paramsSerializer: { serialize: function (params) { return (0, querystring_1.stringify)(params); } },
                         };
                         return [2 /*return*/, this.axiosInstance(requestParams).then(function (res) {
                                 // sometimes error responses will still trigger the `then` block - escape that behavior here
@@ -321,7 +346,7 @@ var RequestWrapper = /** @class */ (function () {
                 // ignore the error, use the object, and tack on a warning
                 errorBody = axiosError.data;
                 errorBody.warning = 'Body contains circular reference';
-                logger_1.default.error("Failed to stringify axiosError: " + e);
+                logger_1.default.error("Failed to stringify axiosError: ".concat(e));
             }
             error.body = errorBody;
             // attach headers to error object
@@ -368,7 +393,7 @@ var RequestWrapper = /** @class */ (function () {
             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') {
@@ -410,8 +435,8 @@ var RequestWrapper = /** @class */ (function () {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 5, , 6]);
-                        if (!isstream_1.default(data)) return [3 /*break*/, 3];
-                        return [4 /*yield*/, stream_to_promise_1.streamToPromise(data)];
+                        if (!(0, isstream_1.default)(data)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, (0, stream_to_promise_1.streamToPromise)(data)];
                     case 2:
                         streamData = _a.sent();
                         reqBuffer = Buffer.isBuffer(streamData) ? streamData : Buffer.from(streamData);
@@ -436,7 +461,7 @@ var RequestWrapper = /** @class */ (function () {
                         return [2 /*return*/, data];
                     case 6:
                         try {
-                            data = zlib_1.gzipSync(reqBuffer);
+                            data = (0, zlib_1.gzipSync)(reqBuffer);
                             // update the headers by reference - only if the data was actually compressed
                             headers['Content-Encoding'] = 'gzip';
                         }
@@ -466,7 +491,7 @@ function parsePath(path, params) {
     }
     return Object.keys(params).reduce(function (parsedPath, param) {
         var value = encodeURIComponent(params[param]);
-        return parsedPath.replace(new RegExp("{" + param + "}"), value);
+        return parsedPath.replace(new RegExp("{".concat(param, "}")), value);
     }, path);
 }
 /**
@@ -537,6 +562,6 @@ function parseServiceErrorMessage(response) {
     else if (hasStringProperty(response, 'errorMessage')) {
         message = response.errorMessage;
     }
-    logger_1.default.info("Parsing service error message: " + message);
+    logger_1.default.info("Parsing service error message: ".concat(message));
     return message;
 }

package/lib/sdk-test-helpers.browser.js

@@ -1,6 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-unused-vars */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
 /**
  * Copyright 2021 IBM Corp. All Rights Reserved.
  *

package/lib/sdk-test-helpers.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.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
 var expect_1 = __importDefault(require("expect"));
 /**
  * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
@@ -34,8 +35,8 @@ var expect_1 = __importDefault(require("expect"));
  * @returns {void}
  */
 function checkUrlAndMethod(options, url, method) {
-    expect_1.default(options.url).toEqual(url);
-    expect_1.default(options.method).toEqual(method);
+    (0, expect_1.default)(options.url).toEqual(url);
+    (0, expect_1.default)(options.method).toEqual(method);
 }
 exports.checkUrlAndMethod = checkUrlAndMethod;
 /**
@@ -50,8 +51,8 @@ exports.checkUrlAndMethod = checkUrlAndMethod;
  */
 function checkMediaHeaders(createRequestMock, accept, contentType) {
     var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
-    expect_1.default(headers.Accept).toEqual(accept);
-    expect_1.default(headers['Content-Type']).toEqual(contentType);
+    (0, expect_1.default)(headers.Accept).toEqual(accept);
+    (0, expect_1.default)(headers['Content-Type']).toEqual(contentType);
 }
 exports.checkMediaHeaders = checkMediaHeaders;
 /**
@@ -66,7 +67,7 @@ exports.checkMediaHeaders = checkMediaHeaders;
  */
 function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) {
     var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
-    expect_1.default(headers[userHeaderName]).toEqual(userHeaderValue);
+    (0, expect_1.default)(headers[userHeaderName]).toEqual(userHeaderValue);
 }
 exports.checkUserHeader = checkUserHeader;
 /**
@@ -78,7 +79,7 @@ exports.checkUserHeader = checkUserHeader;
  */
 function checkForSuccessfulExecution(createRequestMock) {
     var sdkParams = createRequestMock.mock.calls[0][0];
-    expect_1.default(typeof sdkParams).toEqual('object');
+    (0, expect_1.default)(typeof sdkParams).toEqual('object');
 }
 exports.checkForSuccessfulExecution = checkForSuccessfulExecution;
 /**
@@ -101,6 +102,6 @@ exports.getOptions = getOptions;
  * @returns {void}
  */
 function expectToBePromise(sdkPromise) {
-    expect_1.default(typeof sdkPromise.then).toBe('function');
+    (0, expect_1.default)(typeof sdkPromise.then).toBe('function');
 }
 exports.expectToBePromise = expectToBePromise;

package/lib/stream-to-promise.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamToPromise = void 0;
 /**
  * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
  * or array of text chunks

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "3.2.1",
+  "version": "3.2.2-beta-1",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
-  "main": "index.js",
+  "main": "./index.js",
   "typings": "./es/index.d.ts",
   "sideEffects": false,
   "repository": {
@@ -37,13 +37,47 @@
   "bugs": {
     "url": "https://github.com/IBM/node-sdk-core/issues"
   },
+  "devDependencies": {
+    "@commitlint/cli": "^12.0.1",
+    "@commitlint/config-conventional": "^7.0.1",
+    "@masterodin/publisher": "^0.10.0",
+    "@microsoft/api-documenter": "^7.17.0",
+    "@microsoft/api-extractor": "^7.20.0",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@types/debug": "^4.1.7",
+    "@types/extend": "^3.0.1",
+    "@types/lodash.isempty": "^4.4.6",
+    "@types/mime-types": "^2.1.1",
+    "@typescript-eslint/eslint-plugin": "^4.24.0",
+    "@typescript-eslint/parser": "^4.24.0",
+    "dependency-lint": "~5.0.1",
+    "eslint": "^7.26.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-airbnb-typescript": "^12.3.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.2",
+    "eslint-plugin-jest": "^24.3.6",
+    "eslint-plugin-jsdoc": "^34.6.3",
+    "eslint-plugin-node": "^9.0.0",
+    "eslint-plugin-prettier": "^3.0.1",
+    "jest": "^29.3.1",
+    "nock": "^13.1.2",
+    "npm-run-all": "^4.1.5",
+    "object.assign": "~4.1.0",
+    "package-json-reducer": "^1.0.18",
+    "prettier": "~2.3.0",
+    "rimraf": "^3.0.2",
+    "semantic-release": "19.0.3",
+    "typescript": "4.8.4"
+  },
   "dependencies": {
     "@types/file-type": "~5.2.1",
     "@types/isstream": "^0.1.0",
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
-    "axios": "^0.26.1",
-    "axios-cookiejar-support": "^1.0.0",
+    "axios": "1.2.0",
+    "axios-cookiejar-support": "4.0.3",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",
     "dotenv": "^6.2.0",
@@ -66,7 +100,7 @@
     "./lib/sdk-test-helpers": "./lib/sdk-test-helpers.browser"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "scripts": {
     "clean": "rm -fr node_modules",
@@ -97,4 +131,4 @@
     "coverageDirectory": "./coverage/",
     "testEnvironment": "node"
   }
-}
+}

package/.cra/.cveignore

@@ -1,2 +0,0 @@
-[
-]