ibm-cloud-sdk-core 4.2.5 → 4.3.0

package/es/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.41.0"
+      "packageVersion": "7.43.1"
     }
   ]
 }

package/etc/ibm-cloud-sdk-core.api.md

@@ -426,6 +426,8 @@ export class TokenManager {
     setHeaders(headers: OutgoingHttpHeaders): void;
     // (undocumented)
     protected url: string;
+    // (undocumented)
+    protected userAgent: string;
 }
 
 // @public

package/ibm-cloud-sdk-core.d.ts

@@ -127,6 +127,7 @@ export declare class BaseService {
     protected baseOptions: BaseServiceOptions;
     private authenticator;
     private requestWrapperInstance;
+    private defaultUserAgent;
     /**
      * Configuration values for a service.
      *
@@ -1257,7 +1258,7 @@ export declare const qs: {
 };
 
 /**
- * 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.
@@ -1379,6 +1380,7 @@ export declare function stripTrailingSlash(url: string): string;
  */
 export declare class TokenManager {
     protected url: string;
+    protected userAgent: string;
     protected disableSslVerification: boolean;
     protected headers: OutgoingHttpHeaders;
     protected requestWrapperInstance: RequestWrapper;

package/lib/base-service.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2023.
+ * (C) Copyright IBM Corp. 2014, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -61,6 +61,7 @@ export declare class BaseService {
     protected baseOptions: BaseServiceOptions;
     private authenticator;
     private requestWrapperInstance;
+    private defaultUserAgent;
     /**
      * Configuration values for a service.
      *

package/lib/base-service.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2014, 2023.
+ * (C) Copyright IBM Corp. 2014, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,10 +30,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseService = void 0;
+var extend_1 = __importDefault(require("extend"));
 var auth_1 = require("../auth");
 var helper_1 = require("./helper");
 var logger_1 = __importDefault(require("./logger"));
 var request_wrapper_1 = require("./request-wrapper");
+var build_user_agent_1 = require("./build-user-agent");
 /**
  * Common functionality shared by generated service classes.
  *
@@ -87,6 +89,7 @@ var BaseService = /** @class */ (function () {
             throw new Error('Authenticator must be set.');
         }
         this.authenticator = options.authenticator;
+        this.defaultUserAgent = (0, build_user_agent_1.buildUserAgent)();
     }
     /**
      * Get the instance of the authenticator set on the service.
@@ -215,6 +218,11 @@ var BaseService = /** @class */ (function () {
         if (!serviceUrl || typeof serviceUrl !== 'string') {
             return Promise.reject(new Error('The service URL is required'));
         }
+        // make sure the outbound request contains a User-Agent header
+        var userAgent = {
+            'User-Agent': this.defaultUserAgent,
+        };
+        parameters.defaultOptions.headers = (0, extend_1.default)(true, {}, userAgent, parameters.defaultOptions.headers);
         return this.authenticator.authenticate(parameters.defaultOptions).then(function () {
             // resolve() handles rejection as well, so resolving the result of sendRequest should allow for proper handling later
             return _this.requestWrapperInstance.sendRequest(parameters);

package/lib/build-user-agent.d.ts

@@ -0,0 +1,21 @@
+/**
+ * (C) Copyright IBM Corp. 2024.
+ *
+ * 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.
+ */
+/**
+ * Returns a string suitable as a value for the User-Agent header
+ * @param componentName optional name of a component to be included in the returned string
+ * @returns the user agent header value
+ */
+export declare function buildUserAgent(componentName?: string): string;

package/lib/build-user-agent.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * (C) Copyright IBM Corp. 2024.
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUserAgent = void 0;
+var os = require('os');
+var version = require('../package.json').version;
+/**
+ * Returns a string suitable as a value for the User-Agent header
+ * @param componentName optional name of a component to be included in the returned string
+ * @returns the user agent header value
+ */
+function buildUserAgent(componentName) {
+    if (componentName === void 0) { componentName = null; }
+    var subComponent = componentName ? "/".concat(componentName) : '';
+    var userAgent = "ibm-node-sdk-core".concat(subComponent, "-").concat(version, " os.name=").concat(os.platform(), " os.version=").concat(os.release(), " node.version=").concat(process.version);
+    return userAgent;
+}
+exports.buildUserAgent = buildUserAgent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "4.2.5",
+  "version": "4.3.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -40,17 +40,16 @@
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
     "axios": "1.6.8",
-    "camelcase": "^5.3.1",
+    "camelcase": "^6.3.0",
     "debug": "^4.3.4",
-    "dotenv": "^6.2.0",
-    "expect": "^26.1.0",
-    "extend": "^3.0.2",
+    "dotenv": "^16.4.5",
+    "expect": "^27.5.1",
+    "extend": "3.0.2",
     "file-type": "16.5.4",
-    "form-data": "^2.3.3",
-    "isstream": "~0.1.2",
-    "jsonwebtoken": "^9.0.0",
-    "lodash.isempty": "^4.4.0",
-    "mime-types": "^2.1.35",
+    "form-data": "4.0.0",
+    "isstream": "0.1.2",
+    "jsonwebtoken": "^9.0.2",
+    "mime-types": "2.1.35",
     "retry-axios": "^2.6.0",
     "tough-cookie": "^4.1.3"
   },

package/temp/ibm-cloud-sdk-core.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.41.0",
+    "toolVersion": "7.43.1",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -6951,6 +6951,36 @@
               "isStatic": false,
               "isProtected": true,
               "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "ibm-cloud-sdk-core!TokenManager#userAgent:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected userAgent: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "userAgent",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
             }
           ],
           "implementsTokenRanges": []

package/temp/ibm-cloud-sdk-core.api.md

@@ -426,6 +426,8 @@ export class TokenManager {
     setHeaders(headers: OutgoingHttpHeaders): void;
     // (undocumented)
     protected url: string;
+    // (undocumented)
+    protected userAgent: string;
 }
 
 // @public

package/.nvmrc

@@ -1 +0,0 @@
-v16.20.2