ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/lib/request-wrapper.js

@@ -190,9 +190,8 @@ var RequestWrapper = /** @class */ (function () {
      * 2. Checks for missing parameters
      * 3. Encode path and query parameters
      * 4. Call the api
-     * @private
-     * @returns {ReadableStream|undefined}
-     * @throws {Error}
+     * @returns ReadableStream|undefined
+     * @throws Error
      */
     RequestWrapper.prototype.sendRequest = function (parameters) {
         return __awaiter(this, void 0, void 0, function () {
@@ -310,9 +309,8 @@ var RequestWrapper = /** @class */ (function () {
     };
     /**
      * Format error returned by axios
-     * @param  {object} the object returned by axios via rejection
-     * @private
-     * @returns {Error}
+     * @param axiosError - the object returned by axios via rejection
+     * @returns the Error object
      */
     RequestWrapper.prototype.formatError = function (axiosError) {
         // return an actual error object,
@@ -476,10 +474,10 @@ var RequestWrapper = /** @class */ (function () {
 }());
 exports.RequestWrapper = RequestWrapper;
 /**
- * @private
- * @param {string} path
- * @param {Object} params
- * @returns {string}
+ * Parses the path.
+ * @param path - the path
+ * @param params - the params
+ * @returns the parsed path
  */
 function parsePath(path, params) {
     if (!path || !params) {
@@ -492,9 +490,8 @@ function parsePath(path, params) {
 }
 /**
  * Determine if the error is due to bad credentials
- * @private
- * @param {Object} error - error object returned from axios
- * @returns {boolean} true if error is due to authentication
+ * @param error - error object returned from axios
+ * @returns true if error is due to authentication
  */
 function isAuthenticationError(error) {
     var isAuthErr = false;
@@ -509,9 +506,8 @@ function isAuthenticationError(error) {
 }
 /**
  * Determine if the error is due to a bad self signed certificate
- * @private
- * @param {Object} error - error object returned from axios
- * @returns {boolean} true if error is due to an SSL error
+ * @param error - error object returned from axios
+ * @returnstrue if error is due to an SSL error
  */
 function isSelfSignedCertificateError(error) {
     var result = false;
@@ -526,10 +522,9 @@ function isSelfSignedCertificateError(error) {
 }
 /**
  * Return true if object has a specified property that is a string
- * @private
- * @param {Object} obj - object to look for property in
- * @param {string} property - name of the property to look for
- * @returns {boolean} true if property exists and is string
+ * @param obj - object to look for property in
+ * @param property - name of the property to look for
+ * @returns true if property exists and is string
  */
 function hasStringProperty(obj, property) {
     return Boolean(obj[property] && typeof obj[property] === 'string');
@@ -538,9 +533,8 @@ function hasStringProperty(obj, property) {
  * Look for service error message in common places, by priority
  * first look in `errors[0].message`, then in `error`, then in
  * `message`, then in `errorMessage`
- * @private
- * @param {Object} response - error response body received from service
- * @returns {string | undefined} the error message if is was found, undefined otherwise
+ * @param response - error response body received from service
+ * @returns the error message if is was found, undefined otherwise
  */
 function parseServiceErrorMessage(response) {
     var message;

package/lib/sdk-test-helpers.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,10 +22,9 @@
  * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
  * were set to their correct values.
  *
- * @param {Object} options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param {String} url - The URL path of the service endpoint, from the paths section of the API definition
- * @param {String} string - The HTTP method for the request, from the API definition
- * @returns {void}
+ * @param options - the options object put together by the SDK, retrieved from the createRequest mock
+ * @param url - The URL path of the service endpoint, from the paths section of the API definition
+ * @param method - The HTTP method for the request, from the API definition
  */
 export declare function checkUrlAndMethod(options: any, url: string, method: any): void;
 /**
@@ -33,10 +32,9 @@ export declare function checkUrlAndMethod(options: any, url: string, method: any
  * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
  * the correct values in the code.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} accept - the expected value for the `Accept` header
- * @param {String} contentType - the expected value for the `Content-Type` header
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param accept - the expected value for the `Accept` header
+ * @param contentType - the expected value for the `Content-Type` header
  */
 export declare function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
 /**
@@ -44,18 +42,16 @@ export declare function checkMediaHeaders(createRequestMock: any, accept: string
  * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
  * parameters and sends them as headers in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param {String} userHeaderValue - the expected value for the header passed by the user
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
+ * @param userHeaderValue - the expected value for the header passed by the user
  */
 export declare function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
 /**
  * This method simply ensures that the method executed without any issues by extracting
  * the argument from the mock object for the `createRequest` method and verifying that it is an object.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
  */
 export declare function checkForSuccessfulExecution(createRequestMock: any): void;
 /**
@@ -63,15 +59,14 @@ export declare function checkForSuccessfulExecution(createRequestMock: any): voi
  * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
  * This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {Object}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @returns Object
  */
 export declare function getOptions(createRequestMock: any): any;
 /**
  * This method simply ensures that the SDK methods return Promises by checking for
  * the `then` function - common way to assess whether or not an object is a Promise.
  *
- * @param {Promise<any>} sdkPromise - the Promise returned by an SDK method
- * @returns {void}
+ * @param sdkPromise - the Promise returned by an SDK method
  */
 export declare function expectToBePromise(sdkPromise: any): void;

package/lib/sdk-test-helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,10 +29,9 @@ var expect_1 = __importDefault(require("expect"));
  * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
  * were set to their correct values.
  *
- * @param {Object} options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param {String} url - The URL path of the service endpoint, from the paths section of the API definition
- * @param {String} string - The HTTP method for the request, from the API definition
- * @returns {void}
+ * @param options - the options object put together by the SDK, retrieved from the createRequest mock
+ * @param url - The URL path of the service endpoint, from the paths section of the API definition
+ * @param method - The HTTP method for the request, from the API definition
  */
 function checkUrlAndMethod(options, url, method) {
     (0, expect_1.default)(options.url).toEqual(url);
@@ -44,10 +43,9 @@ exports.checkUrlAndMethod = checkUrlAndMethod;
  * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
  * the correct values in the code.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} accept - the expected value for the `Accept` header
- * @param {String} contentType - the expected value for the `Content-Type` header
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param accept - the expected value for the `Accept` header
+ * @param contentType - the expected value for the `Content-Type` header
  */
 function checkMediaHeaders(createRequestMock, accept, contentType) {
     var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
@@ -60,10 +58,9 @@ exports.checkMediaHeaders = checkMediaHeaders;
  * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
  * parameters and sends them as headers in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param {String} userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param {String} userHeaderValue - the expected value for the header passed by the user
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
+ * @param userHeaderValue - the expected value for the header passed by the user
  */
 function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) {
     var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
@@ -74,8 +71,7 @@ exports.checkUserHeader = checkUserHeader;
  * This method simply ensures that the method executed without any issues by extracting
  * the argument from the mock object for the `createRequest` method and verifying that it is an object.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {void}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
  */
 function checkForSuccessfulExecution(createRequestMock) {
     var sdkParams = createRequestMock.mock.calls[0][0];
@@ -87,8 +83,8 @@ exports.checkForSuccessfulExecution = checkForSuccessfulExecution;
  * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
  * This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
  *
- * @param {Object} createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns {Object}
+ * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
+ * @returns Object
  */
 function getOptions(createRequestMock) {
     return createRequestMock.mock.calls[0][0].options;
@@ -98,8 +94,7 @@ exports.getOptions = getOptions;
  * This method simply ensures that the SDK methods return Promises by checking for
  * the `then` function - common way to assess whether or not an object is a Promise.
  *
- * @param {Promise<any>} sdkPromise - the Promise returned by an SDK method
- * @returns {void}
+ * @param sdkPromise - the Promise returned by an SDK method
  */
 function expectToBePromise(sdkPromise) {
     (0, expect_1.default)(typeof sdkPromise.then).toBe('function');

package/lib/stream-to-promise.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ import { Stream } from 'stream';
  * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
- * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.
- * @return {Promise}
+ * @param stream - optional stream param for when not bound to an existing stream instance.
+ * @returns Promise
  */
 export declare function streamToPromise(stream: Stream): Promise<any>;

package/lib/stream-to-promise.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,8 +21,8 @@ exports.streamToPromise = void 0;
  * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
- * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.
- * @return {Promise}
+ * @param stream - optional stream param for when not bound to an existing stream instance.
+ * @returns Promise
  */
 function streamToPromise(stream) {
     stream = stream || this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -51,7 +51,7 @@
     "file-type": "16.5.4",
     "form-data": "^2.3.3",
     "isstream": "~0.1.2",
-    "jsonwebtoken": "^8.5.1",
+    "jsonwebtoken": "^9.0.0",
     "lodash.isempty": "^4.4.0",
     "mime-types": "~2.1.18",
     "object.omit": "~3.0.0",