ibm-cloud-sdk-core 4.2.5 → 4.3.1

package/.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-02-27T01:02:51Z",
+  "generated_at": "2024-04-16T16:00:48Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -96,7 +96,7 @@
         "hashed_secret": "bc2f74c22f98f7b6ffbc2f67453dbfa99bce9a32",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 132,
+        "line_number": 146,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -200,7 +200,7 @@
         "hashed_secret": "184ee1f04a018aa3b897e085516a9b657fea0f6b",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 85,
+        "line_number": 86,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -210,7 +210,7 @@
         "hashed_secret": "d5ff02fa48e492fac0a245ad63d1ae608e705c05",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 97,
+        "line_number": 98,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -218,7 +218,7 @@
         "hashed_secret": "8f4bfc22c4fd7cb884f94ec175ff4a3284a174a1",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 98,
+        "line_number": 99,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -226,7 +226,7 @@
         "hashed_secret": "45a15668db917c293f16e8add0f5d801889e5923",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 112,
+        "line_number": 116,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -234,7 +234,7 @@
         "hashed_secret": "65e622227634e8876cfa733000233fb80c6f0473",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 113,
+        "line_number": 117,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -270,7 +270,7 @@
         "hashed_secret": "8f4bfc22c4fd7cb884f94ec175ff4a3284a174a1",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 59,
+        "line_number": 60,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -278,7 +278,7 @@
         "hashed_secret": "0358c67856fb6a21c4767daf02fcb8fe4dc0a318",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 62,
+        "line_number": 63,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -286,7 +286,7 @@
         "hashed_secret": "dbb19b8ae3b78f908e1467721fe4c9f0b0529d9b",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 63,
+        "line_number": 64,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -296,7 +296,7 @@
         "hashed_secret": "8f4bfc22c4fd7cb884f94ec175ff4a3284a174a1",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 78,
+        "line_number": 79,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -304,7 +304,7 @@
         "hashed_secret": "65e622227634e8876cfa733000233fb80c6f0473",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 91,
+        "line_number": 95,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -442,7 +442,7 @@
         "hashed_secret": "1572bd30ac06678a82df42b5913e5e52e27f9a12",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 31,
+        "line_number": 27,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -450,7 +450,7 @@
         "hashed_secret": "16856d955c788df03735a24feb2e3ffefd91f3dc",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 32,
+        "line_number": 28,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -512,7 +512,7 @@
         "hashed_secret": "43ed4c2d8375dfc89e3dc8c917f404b9481d355b",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 29,
+        "line_number": 30,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -522,7 +522,7 @@
         "hashed_secret": "a7ef1be18bb8d37af79f3d87761a203378bf26a2",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 151,
+        "line_number": 169,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -542,7 +542,7 @@
         "hashed_secret": "f2e7745f43b0ef0e2c2faf61d6c6a28be2965750",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 30,
+        "line_number": 26,
         "type": "Secret Keyword",
         "verified_result": null
       }

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.3.1](https://github.com/IBM/node-sdk-core/compare/v4.3.0...v4.3.1) (2024-05-21)
+
+
+### Bug Fixes
+
+* **deps:** bump `braces` and `micromatch` to avoid vulnerabilities ([#274](https://github.com/IBM/node-sdk-core/issues/274)) ([1ecac01](https://github.com/IBM/node-sdk-core/commit/1ecac01847dbcef18747c0400e5e36f9a981b936))
+
+# [4.3.0](https://github.com/IBM/node-sdk-core/compare/v4.2.5...v4.3.0) (2024-04-17)
+
+
+### Features
+
+* send user-agent header with auth token requests ([#272](https://github.com/IBM/node-sdk-core/issues/272)) ([a558274](https://github.com/IBM/node-sdk-core/commit/a558274d3c19a2d0d453b8e9f5bc233f201ebb85))
+
 ## [4.2.5](https://github.com/IBM/node-sdk-core/compare/v4.2.4...v4.2.5) (2024-03-29)
 
 

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021, 2023 IBM Corp. All Rights Reserved.
+ * (C) Copyright IBM Corp. 2021, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Copyright 2021, 2023 IBM Corp. All Rights Reserved.
+ * (C) Copyright IBM Corp. 2021, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -69,6 +69,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContainerTokenManager = void 0;
 var helpers_1 = require("../utils/helpers");
 var file_reading_helpers_1 = require("../utils/file-reading-helpers");
+var build_user_agent_1 = require("../../lib/build-user-agent");
 var iam_request_based_token_manager_1 = require("./iam-request-based-token-manager");
 var DEFAULT_CR_TOKEN_FILEPATH1 = '/var/run/secrets/tokens/vault-token';
 var DEFAULT_CR_TOKEN_FILEPATH2 = '/var/run/secrets/tokens/sa-token';
@@ -118,6 +119,7 @@ var ContainerTokenManager = /** @class */ (function (_super) {
         }
         // construct form data for the cr token use case of iam token management
         _this.formData.grant_type = 'urn:ibm:params:oauth:grant-type:cr-token';
+        _this.userAgent = (0, build_user_agent_1.buildUserAgent)('container-authenticator');
         return _this;
     }
     /**

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

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2023.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2023.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cp4dTokenManager = void 0;
 var extend_1 = __importDefault(require("extend"));
 var helpers_1 = require("../utils/helpers");
+var build_user_agent_1 = require("../../lib/build-user-agent");
 var jwt_token_manager_1 = require("./jwt-token-manager");
 /**
  * Token Manager of CloudPak for data.
@@ -76,12 +77,14 @@ var Cp4dTokenManager = /** @class */ (function (_super) {
         _this.username = options.username;
         _this.password = options.password;
         _this.apikey = options.apikey;
+        _this.userAgent = (0, build_user_agent_1.buildUserAgent)('cp4d-authenticator');
         return _this;
     }
     Cp4dTokenManager.prototype.requestToken = function () {
         // these cannot be overwritten
         var requiredHeaders = {
             'Content-Type': 'application/json',
+            'User-Agent': this.userAgent,
         };
         var parameters = {
             options: {

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

@@ -149,7 +149,8 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
     IamRequestBasedTokenManager.prototype.requestToken = function () {
         // these cannot be overwritten
         var requiredHeaders = {
-            'Content-type': 'application/x-www-form-urlencoded',
+            'Content-Type': 'application/x-www-form-urlencoded',
+            'User-Agent': this.userAgent,
         };
         // If both the clientId and secret were specified by the user, then use them.
         if (this.clientId && this.clientSecret) {

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

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2023.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2023.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,6 +32,7 @@ var __extends = (this && this.__extends) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IamTokenManager = void 0;
 var helpers_1 = require("../utils/helpers");
+var build_user_agent_1 = require("../../lib/build-user-agent");
 var iam_request_based_token_manager_1 = require("./iam-request-based-token-manager");
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
@@ -68,6 +69,7 @@ var IamTokenManager = /** @class */ (function (_super) {
         _this.formData.apikey = _this.apikey;
         _this.formData.grant_type = 'urn:ibm:params:oauth:grant-type:apikey';
         _this.formData.response_type = 'cloud_iam';
+        _this.userAgent = (0, build_user_agent_1.buildUserAgent)('iam-authenticator');
         return _this;
     }
     return IamTokenManager;

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

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2023, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2023.
+ * (C) Copyright IBM Corp. 2023, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.McspTokenManager = void 0;
 var extend_1 = __importDefault(require("extend"));
 var helpers_1 = require("../utils/helpers");
+var build_user_agent_1 = require("../../lib/build-user-agent");
 var jwt_token_manager_1 = require("./jwt-token-manager");
 /**
  * This is the path associated with the operation used to obtain
@@ -69,12 +70,14 @@ var McspTokenManager = /** @class */ (function (_super) {
         _this.tokenName = 'token';
         (0, helpers_1.validateInput)(options, _this.requiredOptions);
         _this.apikey = options.apikey;
+        _this.userAgent = (0, build_user_agent_1.buildUserAgent)('mcsp-authenticator');
         return _this;
     }
     McspTokenManager.prototype.requestToken = function () {
         var requiredHeaders = {
             Accept: 'application/json',
             'Content-Type': 'application/json',
+            'User-Agent': this.userAgent,
         };
         var parameters = {
             options: {

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

@@ -39,6 +39,7 @@ export type TokenManagerOptions = {
  */
 export declare class TokenManager {
     protected url: string;
+    protected userAgent: string;
     protected disableSslVerification: boolean;
     protected headers: OutgoingHttpHeaders;
     protected requestWrapperInstance: RequestWrapper;

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

@@ -72,6 +72,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VpcInstanceTokenManager = void 0;
 var logger_1 = __importDefault(require("../../lib/logger"));
 var helpers_1 = require("../utils/helpers");
+var build_user_agent_1 = require("../../lib/build-user-agent");
 var jwt_token_manager_1 = require("./jwt-token-manager");
 var DEFAULT_IMS_ENDPOINT = 'http://169.254.169.254';
 var METADATA_SERVICE_VERSION = '2022-03-01';
@@ -109,6 +110,7 @@ var VpcInstanceTokenManager = /** @class */ (function (_super) {
         if (options.iamProfileId) {
             _this.iamProfileId = options.iamProfileId;
         }
+        _this.userAgent = (0, build_user_agent_1.buildUserAgent)('vpc-instance-authenticator');
         return _this;
     }
     /**
@@ -153,6 +155,7 @@ var VpcInstanceTokenManager = /** @class */ (function (_super) {
                                 method: 'POST',
                                 headers: {
                                     'Content-Type': 'application/json',
+                                    'User-Agent': this.userAgent,
                                     Accept: 'application/json',
                                     Authorization: "Bearer ".concat(instanceIdentityToken),
                                 },
@@ -182,6 +185,7 @@ var VpcInstanceTokenManager = /** @class */ (function (_super) {
                                 method: 'PUT',
                                 headers: {
                                     'Content-Type': 'application/json',
+                                    'User-Agent': this.userAgent,
                                     Accept: 'application/json',
                                     'Metadata-Flavor': 'ibm',
                                 },

package/auth/utils/file-reading-helpers.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021, 2023 IBM Corp. All Rights Reserved.
+ * Copyright 2021, 2024 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/auth/utils/file-reading-helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Copyright 2021, 2023 IBM Corp. All Rights Reserved.
+ * Copyright 2021, 2024 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -6,7 +6,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readExternalSources = void 0;
 /**
- * (C) Copyright IBM Corp. 2019, 2022.
+ * (C) Copyright IBM Corp. 2019, 2024.
  *
  * 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.readExternalSources = void 0;
  * limitations under the License.
  */
 var camelcase_1 = __importDefault(require("camelcase"));
-var lodash_isempty_1 = __importDefault(require("lodash.isempty"));
 var logger_1 = __importDefault(require("../../lib/logger"));
+var helper_1 = require("../../lib/helper");
 var file_reading_helpers_1 = require("./file-reading-helpers");
 /**
  * Read properties stored in external sources like Environment Variables,
@@ -49,10 +49,10 @@ function getProperties(serviceName) {
     // only get properties from one source, return null if none found
     var properties = null;
     properties = filterPropertiesByServiceName((0, file_reading_helpers_1.readCredentialsFile)(), serviceName);
-    if ((0, lodash_isempty_1.default)(properties)) {
+    if ((0, helper_1.isEmptyObject)(properties)) {
         properties = filterPropertiesByServiceName(process.env, serviceName);
     }
-    if ((0, lodash_isempty_1.default)(properties)) {
+    if ((0, helper_1.isEmptyObject)(properties)) {
         properties = getPropertiesFromVCAP(serviceName);
     }
     return properties;

package/build/docs/ibm-cloud-sdk-core.atleastone.md

@@ -14,11 +14,55 @@ export declare function atLeastOne(a: any, b: any): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  a | any | the first object |
-|  b | any | the second object |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+a
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the first object
+
+
+</td></tr>
+<tr><td>
+
+b
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the second object
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 boolean

package/build/docs/ibm-cloud-sdk-core.atmostone.md

@@ -14,11 +14,55 @@ export declare function atMostOne(a: any, b: any): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  a | any | The first object |
-|  b | any | The second object |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+a
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+The first object
+
+
+</td></tr>
+<tr><td>
+
+b
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+The second object
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 boolean

package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md

@@ -14,10 +14,39 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+requestOptions
+
+
+</td><td>
+
+AuthenticateOptions
+
+
+</td><td>
+
+The request to augment with authentication information.
+
+
+</td></tr>
+</tbody></table>
 **Returns:**
 
 Promise&lt;void&gt;