ibm-cloud-sdk-core 4.0.0 → 4.0.1

package/.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2022-04-04T16:42:23Z",
+  "generated_at": "2022-12-20T17:56:56Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -91,32 +91,32 @@
         "verified_result": null
       }
     ],
-    "MIGRATION-V1.md": [
+    "README.md": [
       {
-        "hashed_secret": "a00eada80f974d9446d54719567f67349cdc2d34",
+        "hashed_secret": "32e8612d8ca77c7ea8374aa7918db8e5df9252ed",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 19,
+        "line_number": 61,
         "type": "Secret Keyword",
         "verified_result": null
       }
     ],
-    "README.md": [
+    "auth/authenticators/authenticator.ts": [
       {
-        "hashed_secret": "32e8612d8ca77c7ea8374aa7918db8e5df9252ed",
+        "hashed_secret": "fdee05598fdd57ff8e9ae29e92c25a04f2c52fa6",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 61,
+        "line_number": 39,
         "type": "Secret Keyword",
         "verified_result": null
       }
     ],
-    "auth/authenticators/authenticator.ts": [
+    "auth/authenticators/basic-authenticator.ts": [
       {
-        "hashed_secret": "fdee05598fdd57ff8e9ae29e92c25a04f2c52fa6",
+        "hashed_secret": "bbccdf2efb33b52e6c9d0a14dd70b2d415fbea6e",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 39,
+        "line_number": 52,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -162,7 +162,7 @@
         "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 91,
+        "line_number": 89,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -170,7 +170,7 @@
         "hashed_secret": "99833a8b234b57b886a9aef1dba187fdd7ceece8",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 93,
+        "line_number": 91,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -224,7 +224,7 @@
         "hashed_secret": "f84f793e0af9ade37c8b927bc5091e98f35bf821",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 83,
+        "line_number": 84,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -232,7 +232,7 @@
         "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 120,
+        "line_number": 118,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -240,7 +240,7 @@
         "hashed_secret": "99833a8b234b57b886a9aef1dba187fdd7ceece8",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 122,
+        "line_number": 120,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -250,7 +250,7 @@
         "hashed_secret": "8f4bfc22c4fd7cb884f94ec175ff4a3284a174a1",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 58,
+        "line_number": 59,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -258,7 +258,7 @@
         "hashed_secret": "0358c67856fb6a21c4767daf02fcb8fe4dc0a318",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 61,
+        "line_number": 62,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -266,7 +266,7 @@
         "hashed_secret": "dbb19b8ae3b78f908e1467721fe4c9f0b0529d9b",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 62,
+        "line_number": 63,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -296,21 +296,11 @@
         "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 273,
+        "line_number": 278,
         "type": "Secret Keyword",
         "verified_result": null
       }
     ],
-    "scripts/jsdoc/generate_index_html.sh": [
-      {
-        "hashed_secret": "973f71aa51bf4dcef6aa10f52089747a85c64a73",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 19,
-        "type": "Base64 High Entropy String",
-        "verified_result": null
-      }
-    ],
     "test/resources/ibm-credentials.env": [
       {
         "hashed_secret": "5c5a15a8b0b3e154d77746945e563ba40100681b",
@@ -534,7 +524,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.47.dss",
+  "version": "0.13.1+ibm.55.dss",
   "word_list": {
     "file": null,
     "hash": null

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.0.1](https://github.com/IBM/node-sdk-core/compare/v4.0.0...v4.0.1) (2022-12-29)
+
+
+### Bug Fixes
+
+* **auth:** migrate to secure usage of jwt for token authentication ([#225](https://github.com/IBM/node-sdk-core/issues/225)) ([10e0728](https://github.com/IBM/node-sdk-core/commit/10e07283cec2205eb6bda5723e63e5403d9b23f6))
+
 # [4.0.0](https://github.com/IBM/node-sdk-core/compare/v3.2.1...v4.0.0) (2022-12-20)
 
 
@@ -19,15 +26,13 @@
 ### BREAKING CHANGES
 
 * **deps-dev:** Minimum typescript version is 4.
-
 Upgrade to typescript 4.x.
 
-Signed-off-by: Rich Ellis <ricellis@users.noreply.github.com>
 * Minimum Node.js version is 14.
-
 Upgrade to at least Node.js 14.
 
-Signed-off-by: Rich Ellis <ricellis@users.noreply.github.com>
+* **For assistance migrating to v4** - see the [migration guide](https://github.com/IBM/node-sdk-core/blob/main/MIGRATION-V4.md).
+
 
 ## [3.2.1](https://github.com/IBM/node-sdk-core/compare/v3.2.0...v3.2.1) (2022-10-21)
 

package/MIGRATION-V4.md

@@ -0,0 +1,54 @@
+# Migration Guide for v4
+
+## Breaking Changes
+
+### Node Version
+Node versions 12 is longer supported - 14 is the minimum version supported.
+
+### TypeScript Version
+The `typescript` development dependnecy is now required to be at least version 4.
+
+Run `npm install -D typescript@4` to upgrade to version 4.
+
+Code produced by the IBM OpenAPI SDK Generator should already be compliant with TypeScript v4.
+
+Additionally, you may need to upgrade `@typescript-eslint/eslint-plugin` and `@typescript-eslint/parser` to
+v5 to be compatible with the new version of TypeScript. This upgrade should be safe and compatible.
+
+Run `npm i -D '@typescript-eslint/eslint-plugin@latest' '@typescript-eslint/parser@latest'` to upgrade.
+
+### Jest Version
+The `jest` development dependency is now required to be at least version 29.
+
+Run `npm install -D jest@29` to upgrade to version 29.
+
+Code produced by the IBM OpenAPI Generator should already be compliant with Jest v29.
+
+Note: Ensure your test code does not contain the anti-pattern of using a `done` callback with an `async` function.
+This is no longer permitted in Jest 29, whereas it was discouraged but permitted in previous versions. An old version of the IBM OpenAPI SDK Generator included a bug that generated this pattern. If your generated test code has not been updated since then, you may run into this issue.
+
+Example diff showing proper resolution:
+```
+diff --git a/test/integration/example.v1.test.js b/test/integration/example.v1.test.js
+index be0bec3..62f03f8 100644
+--- a/test/integration/example.v1.test.js
++++ b/test/integration/example.v1.test.js
+@@ -38,7 +38,7 @@ describe('ExampleV1_integration', () => {
+   jest.setTimeout(timeout);
+   let example;
+ 
+-  beforeAll(async (done) => {
++  beforeAll(async () => {
+     example = ExampleV1.newInstance({});
+ 
+     const config = readExternalSources(ExampleV1.DEFAULT_SERVICE_NAME);
+@@ -58,8 +58,6 @@ describe('ExampleV1_integration', () => {
+ 
+     log(`Service URL: ${example.baseOptions.serviceUrl}`);
+     log('Finished setup.');
+-
+-    done();
+   });
+ 
+   test('getSomething()', async () => {
+```

package/auth/authenticators/authenticator-interface.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.
@@ -34,9 +34,8 @@ export interface AuthenticatorInterface {
     /**
      * Add authentication information to the specified request.
      *
-     * @param {object} requestOptions The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers The headers the
-     *   authentication information will be added to.
+     * @param requestOptions - The request to which authentication information is added
+     * (in the headers field).
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**

package/auth/authenticators/authenticator-interface.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.

package/auth/authenticators/authenticator.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.
@@ -33,25 +33,21 @@ export declare class Authenticator implements AuthenticatorInterface {
     /**
      * Create a new Authenticator instance.
      *
-     * @throws {Error} The `new` keyword was not used to create construct the
-     *   authenticator.
+     * @throws Error: the "new" keyword was not used to construct the authenticator.
      */
     constructor();
     /**
      * Augment the request with authentication information.
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
-     * @throws {Error} - The authenticate method was not implemented by a
-     *   subclass.
+     * @param requestOptions - The request to augment with authentication information.
+     * @throws Error: The authenticate method was not implemented by a subclass.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Retrieves the authenticator's type.
      * The returned value will be the same string that is used
      * when configuring an instance of the authenticator with the
-     * "<service_name>_AUTH_TYPE" configuration property
+     * \<service_name\>_AUTH_TYPE configuration property
      * (e.g. "basic", "iam", etc.).
      * This function should be overridden in each authenticator
      * implementation class that extends this class.

package/auth/authenticators/authenticator.js

@@ -10,8 +10,7 @@ var Authenticator = /** @class */ (function () {
     /**
      * Create a new Authenticator instance.
      *
-     * @throws {Error} The `new` keyword was not used to create construct the
-     *   authenticator.
+     * @throws Error: the "new" keyword was not used to construct the authenticator.
      */
     function Authenticator() {
         if (!(this instanceof Authenticator)) {
@@ -21,11 +20,8 @@ var Authenticator = /** @class */ (function () {
     /**
      * Augment the request with authentication information.
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
-     * @throws {Error} - The authenticate method was not implemented by a
-     *   subclass.
+     * @param requestOptions - The request to augment with authentication information.
+     * @throws Error: The authenticate method was not implemented by a subclass.
      */
     Authenticator.prototype.authenticate = function (requestOptions) {
         var error = new Error('Should be implemented by subclass!');
@@ -35,7 +31,7 @@ var Authenticator = /** @class */ (function () {
      * Retrieves the authenticator's type.
      * The returned value will be the same string that is used
      * when configuring an instance of the authenticator with the
-     * "<service_name>_AUTH_TYPE" configuration property
+     * \<service_name\>_AUTH_TYPE configuration property
      * (e.g. "basic", "iam", etc.).
      * This function should be overridden in each authenticator
      * implementation class that extends this class.

package/auth/authenticators/basic-authenticator.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.
@@ -28,7 +28,7 @@ export type Options = {
  *
  * Basic Authorization will be sent as an Authorization header in the form:
  *
- *     Authorization: Basic <encoded username and password>
+ *     Authorization: Basic \<encoded username and password\>
  *
  */
 export declare class BasicAuthenticator extends Authenticator {
@@ -39,21 +39,21 @@ export declare class BasicAuthenticator extends Authenticator {
     /**
      * Create a new BasicAuthenticator instance.
      *
-     * @param {object} options Configuration options for basic authentication.
-     * @param {string} options.username The username portion of basic authentication.
-     * @param {string} options.password The password portion of basic authentication.
-     * @throws {Error} The configuration options are not valid.
+     * @param options - Configuration options for basic authentication.
+     * This should be an object containing these fields:
+     * - username: the username portion of basic authentication
+     * - password: the password portion of basic authentication
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
     /**
-     * Add basic authentication information to `request`. The basic authentication information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add basic authentication information to `requestOptions`. The basic authentication information
+     * will be set in the Authorization property of `requestOptions.headers` in the form:
      *
-     *     Authorization: Basic <encoded username and password>
+     *     Authorization: Basic \<encoded username and password\>
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**

package/auth/authenticators/basic-authenticator.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.
@@ -43,7 +43,7 @@ var authenticator_1 = require("./authenticator");
  *
  * Basic Authorization will be sent as an Authorization header in the form:
  *
- *     Authorization: Basic <encoded username and password>
+ *     Authorization: Basic \<encoded username and password\>
  *
  */
 var BasicAuthenticator = /** @class */ (function (_super) {
@@ -51,10 +51,12 @@ var BasicAuthenticator = /** @class */ (function (_super) {
     /**
      * Create a new BasicAuthenticator instance.
      *
-     * @param {object} options Configuration options for basic authentication.
-     * @param {string} options.username The username portion of basic authentication.
-     * @param {string} options.password The password portion of basic authentication.
-     * @throws {Error} The configuration options are not valid.
+     * @param options - Configuration options for basic authentication.
+     * This should be an object containing these fields:
+     * - username: the username portion of basic authentication
+     * - password: the password portion of basic authentication
+     *
+     * @throws Error: the configuration options are not valid.
      */
     function BasicAuthenticator(options) {
         var _this = _super.call(this) || this;
@@ -66,14 +68,12 @@ var BasicAuthenticator = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Add basic authentication information to `request`. The basic authentication information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add basic authentication information to `requestOptions`. The basic authentication information
+     * will be set in the Authorization property of `requestOptions.headers` in the form:
      *
-     *     Authorization: Basic <encoded username and password>
+     *     Authorization: Basic \<encoded username and password\>
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
+     * @param requestOptions - The request to augment with authentication information.
      */
     BasicAuthenticator.prototype.authenticate = function (requestOptions) {
         var _this = this;

package/auth/authenticators/bearer-token-authenticator.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.
@@ -26,7 +26,7 @@ export type Options = {
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class BearerTokenAuthenticator extends Authenticator {
     protected requiredOptions: string[];
@@ -34,29 +34,26 @@ export declare class BearerTokenAuthenticator extends Authenticator {
     /**
      * Create a new BearerTokenAuthenticator instance.
      *
-     * @param {object} options Configuration options for bearer authentication.
-     * @param {string} options.bearerToken The bearer token to be added
-     *   to requests.
-     * @throws {Error} The configuration bearerToken is not valid, or unspecified.
+     * @param options - Configuration options for bearer authentication.
+     * This should be an object containing the "bearerToken" field.
+     *
+     * @throws Error: the options.bearerToken field is not valid, or unspecified
      */
     constructor(options: Options);
     /**
      * Set a new bearer token to be sent in subsequent requests.
      *
-     * @param {string} bearerToken The bearer token that will be sent in service
+     * @param bearerToken - The bearer token that will be sent in service
      *   requests.
      */
     setBearerToken(bearerToken: string): void;
     /**
-     * Add a bearer token to the `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add a bearer token to `requestOptions`. The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *      Authorization: Bearer <bearer-token>
+     *      Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added to.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**

package/auth/authenticators/bearer-token-authenticator.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.
@@ -43,17 +43,17 @@ var authenticator_1 = require("./authenticator");
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 var BearerTokenAuthenticator = /** @class */ (function (_super) {
     __extends(BearerTokenAuthenticator, _super);
     /**
      * Create a new BearerTokenAuthenticator instance.
      *
-     * @param {object} options Configuration options for bearer authentication.
-     * @param {string} options.bearerToken The bearer token to be added
-     *   to requests.
-     * @throws {Error} The configuration bearerToken is not valid, or unspecified.
+     * @param options - Configuration options for bearer authentication.
+     * This should be an object containing the "bearerToken" field.
+     *
+     * @throws Error: the options.bearerToken field is not valid, or unspecified
      */
     function BearerTokenAuthenticator(options) {
         var _this = _super.call(this) || this;
@@ -65,22 +65,19 @@ var BearerTokenAuthenticator = /** @class */ (function (_super) {
     /**
      * Set a new bearer token to be sent in subsequent requests.
      *
-     * @param {string} bearerToken The bearer token that will be sent in service
+     * @param bearerToken - The bearer token that will be sent in service
      *   requests.
      */
     BearerTokenAuthenticator.prototype.setBearerToken = function (bearerToken) {
         this.bearerToken = bearerToken;
     };
     /**
-     * Add a bearer token to the `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add a bearer token to `requestOptions`. The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *      Authorization: Bearer <bearer-token>
+     *      Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added to.
+     * @param requestOptions - The request to augment with authentication information.
      */
     BearerTokenAuthenticator.prototype.authenticate = function (requestOptions) {
         var _this = this;

package/auth/authenticators/cloud-pak-for-data-authenticator.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.
@@ -27,12 +27,12 @@ export interface Options extends BaseOptions {
     url: string;
 }
 /**
- * The [[CloudPakForDataAuthenticator]] will either use a username/password pair or a username/apikey pair to obtain
+ * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
  * a bearer token from a token server.  When the bearer token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
     protected requiredOptions: string[];
@@ -41,19 +41,19 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
     private password;
     private apikey;
     /**
-     * Create a new [[CloudPakForDataAuthenticator]] instance.
+     * Create a new CloudPakForDataAuthenticator instance.
      *
-     * @param {object} options Configuration options for CloudPakForData authentication.
-     * @param {string} options.url For HTTP token requests.
-     * @param {string} options.username The username used to obtain a bearer token.
-     * @param {string} [options.password] The password used to obtain a bearer token [required if apikey not specified].
-     * @param {string} [options.apikey] The API key used to obtain a bearer token [required if password not specified].
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {object<string, string>} [options.headers] to be sent with every.
-     * @throws `Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token
-     *   requests.
+     * @param options - Configuration options for CloudPakForData authentication.
+     * This should be an object containing these fields:
+     * - url: (required) the endpoint URL for the CloudPakForData token service
+     * - username: (required) the username used to obtain a bearer token
+     * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
+     * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     *
+     * @throws Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
      */
     constructor(options: Options);
     /**