ibm-cloud-sdk-core 4.0.2 → 4.0.4

package/.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2022-12-20T17:56:56Z",
+  "generated_at": "2023-01-19T23:27:48Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -91,6 +91,16 @@
         "verified_result": null
       }
     ],
+    "CHANGELOG.md": [
+      {
+        "hashed_secret": "bc2f74c22f98f7b6ffbc2f67453dbfa99bce9a32",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 20,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
     "README.md": [
       {
         "hashed_secret": "32e8612d8ca77c7ea8374aa7918db8e5df9252ed",
@@ -484,7 +494,7 @@
         "hashed_secret": "a7ef1be18bb8d37af79f3d87761a203378bf26a2",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 145,
+        "line_number": 146,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -524,7 +534,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.55.dss",
+  "version": "0.13.1+ibm.56.dss",
   "word_list": {
     "file": null,
     "hash": null

package/Authentication.md

@@ -6,15 +6,15 @@ The node-sdk-core project supports the following types of authentication:
 - Container Authentication
 - VPC Instance Authentication
 - Cloud Pak for Data Authentication
-- No Authentication
+- No Authentication (for testing)
 
-The SDK user configures the appropriate type of authentication for use with service instances.  
+The SDK user configures the appropriate type of authentication for use with service instances.
 The authentication types that are appropriate for a particular service may vary from service to service,
 so it is important for the SDK user to consult with the appropriate service documentation to understand
 which authentication types are supported for that service.
 
 The node-sdk-core allows an authenticator to be specified in one of two ways:
-1. programmatically - the SDK user invokes the appropriate function(s) to create an instance of the 
+1. programmatically - the SDK user invokes the appropriate function(s) to create an instance of the
 desired authenticator and then passes the authenticator instance when constructing an instance of the service.
 2. configuration - the SDK user provides external configuration information (in the form of environment variables
 or a credentials file) to indicate the type of authenticator, along with the configuration of the necessary properties
@@ -143,15 +143,15 @@ const service = ExampleServiceV1.newInstance(options);
 Note that the use of external configuration is not as useful with the `BearerTokenAuthenticator` as it
 is for other authenticator types because bearer tokens typically need to be obtained and refreshed
 programmatically since they normally have a relatively short lifespan before they expire.  This
-authenticator type is intended for situations in which the application will be managing the bearer 
+authenticator type is intended for situations in which the application will be managing the bearer
 token itself in terms of initial acquisition and refreshing as needed.
 
 
 ## Identity and Access Management Authentication (IAM)
 The `IamAuthenticator` will accept a user-supplied api key and will perform
 the necessary interactions with the IAM token service to obtain a suitable
-bearer token for the specified api key.  The authenticator will also obtain 
-a new bearer token when the current token expires.  The bearer token is 
+bearer token for the specified api key.  The authenticator will also obtain
+a new bearer token when the current token expires.  The bearer token is
 then added to each outbound request in the `Authorization` header in the
 form:
 ```
@@ -276,15 +276,15 @@ However, if your application is using an instance of a service in the "staging"
 then you would also need to configure the authenticator to use the IAM token service "staging"
 endpoint as well (`https://iam.test.cloud.ibm.com`).
 
-- clientId/clientSecret: (optional) The `clientId` and `clientSecret` fields are used to form a 
-"basic auth" Authorization header for interactions with the IAM token service. If neither field 
-is specified, then no Authorization header will be sent with token server requests.  These fields 
+- clientId/clientSecret: (optional) The `clientId` and `clientSecret` fields are used to form a
+"basic auth" Authorization header for interactions with the IAM token service. If neither field
+is specified, then no Authorization header will be sent with token server requests.  These fields
 are optional, but must be specified together.
 
 - scope: (optional) the scope to be associated with the IAM access token.
 If not specified, then no scope will be associated with the access token.
 
-- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL 
+- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL
 certificate should be disabled or not. The default value is `false`.
 
 - headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests
@@ -358,8 +358,9 @@ The IAM access token is added to each outbound request in the `Authorization` he
 
 - iamProfileId: (optional) the id of the linked trusted IAM profile to be used when obtaining the IAM access token.
 
-- url: (optional) The VPC Instance Metadata Service's base URL.  
-The default value of this property is `http://169.254.169.254`, and should not need to be specified in normal situations.
+- url: (optional) The VPC Instance Metadata Service's base URL.
+The default value of this property is `http://169.254.169.254`.  However, if the VPC Instance Metadata Service is configured
+with the HTTP Secure Protocol setting (`https`), then you should configure this property to be `https://api.metadata.cloud.ibm.com`.
 
 Usage Notes:
 1. At most one of `iamProfileCrn` or `iamProfileId` may be specified.  The specified value must map
@@ -367,7 +368,7 @@ to a trusted IAM profile that has been linked to the compute resource (virtual s
 
 2. If both `iamProfileCrn` and `iamProfileId` are specified, then an error occurs.
 
-3. If neither `iamProfileCrn` nor `iamProfileId` are specified, then the default trusted profile linked to the 
+3. If neither `iamProfileCrn` nor `iamProfileId` are specified, then the default trusted profile linked to the
 compute resource will be used to perform the IAM token exchange.
 If no default trusted profile is defined for the compute resource, then an error occurs.
 
@@ -412,7 +413,7 @@ const service = ExampleServiceV1.newInstance(options);
 
 ##  Cloud Pak for Data Authentication
 The `CloudPakForDataAuthenticator` will accept a user-supplied username value, along with either a
-password or apikey, and will 
+password or apikey, and will
 perform the necessary interactions with the Cloud Pak for Data token service to obtain a suitable
 bearer token.  The authenticator will also obtain a new bearer token when the current token expires.
 The bearer token is then added to each outbound request in the `Authorization` header in the
@@ -433,7 +434,7 @@ Exactly one of password or apikey should be specified.
 - url: (required) The URL representing the Cloud Pak for Data token service endpoint's base URL string.
 This value should not include the `/v1/authorize` path portion.
 
-- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL 
+- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL
 certificate should be disabled or not. The default value is `false`.
 
 - headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.0.4](https://github.com/IBM/node-sdk-core/compare/v4.0.3...v4.0.4) (2023-02-27)
+
+
+### Bug Fixes
+
+* return json error response body as object ([#238](https://github.com/IBM/node-sdk-core/issues/238)) ([6f201b7](https://github.com/IBM/node-sdk-core/commit/6f201b798df234510a6abf6baac96b81c72636bf))
+
+## [4.0.3](https://github.com/IBM/node-sdk-core/compare/v4.0.2...v4.0.3) (2023-01-09)
+
+
+### Bug Fixes
+
+* **VpcInstanceAuthenticator:** use correct version string ([4a1411a](https://github.com/IBM/node-sdk-core/commit/4a1411a76a09e9b1ade2c94bd98e63f79d845494))
+
 ## [4.0.2](https://github.com/IBM/node-sdk-core/compare/v4.0.1...v4.0.2) (2022-12-30)
 
 

package/MIGRATION-V4.md

@@ -3,7 +3,7 @@
 ## Breaking Changes
 
 ### Node Version
-Node versions 12 is longer supported - 14 is the minimum version supported.
+Node version 12 is no longer supported - 14 is the minimum version supported.
 
 ### TypeScript Version
 The `typescript` development dependnecy is now required to be at least version 4.

package/README.md

@@ -27,13 +27,14 @@ class YourSDK extends BaseService { ... }
 ```
 
 ## Authentication
-This library provides a set of Authenticators used to authenticate requests from an SDK. There are authenticators for the following authentication schemes:
-- No Auth
-- Basic
-- Bearer Token
-- IAM
-- CP4D
-- Container
+The node-sdk-core project supports the following types of authentication:
+- Basic Authentication
+- Bearer Token Authentication
+- Identity and Access Management (IAM) Authentication
+- Container Authentication
+- VPC Instance Authentication
+- Cloud Pak for Data Authentication
+- No Authentication (for testing)
 
 There are two ways to create an authenticator:
 1. Creating an instance and providing credentials programmatically

package/appscan-config.xml

@@ -2,6 +2,7 @@
   <Targets>
     <Target path=".">
       <Exclude>scripts/</Exclude>
+      <Exclude>test/</Exclude>
     </Target>
   </Targets>
-</Configuration>
+</Configuration>

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

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2021, 2022.
+ * (C) Copyright IBM Corp. 2021, 2023.
  *
  * 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/vpc-instance-token-manager.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2021, 2022.
+ * (C) Copyright IBM Corp. 2021, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -74,7 +74,7 @@ var logger_1 = __importDefault(require("../../lib/logger"));
 var utils_1 = require("../utils");
 var jwt_token_manager_1 = require("./jwt-token-manager");
 var DEFAULT_IMS_ENDPOINT = 'http://169.254.169.254';
-var METADATA_SERVICE_VERSION = '2021-09-20';
+var METADATA_SERVICE_VERSION = '2022-03-01';
 /**
  * Token Manager for VPC Instance Authentication.
  */

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

@@ -4,7 +4,7 @@
 
 ## FileObject interface
 
-(C) Copyright IBM Corp. 2014, 2022.
+(C) Copyright IBM Corp. 2014, 2023.
 
 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
 

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [isJsonMimeType](./ibm-cloud-sdk-core.isjsonmimetype.md)
+
+## isJsonMimeType() function
+
+Returns true if and only if "mimeType" is a "JSON-like" mime type (e.g. "application/json; charset=utf-8").
+
+<b>Signature:</b>
+
+```typescript
+export declare function isJsonMimeType(mimeType: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  mimeType | string | the mimeType string |
+
+<b>Returns:</b>
+
+boolean
+
+true if "mimeType" represents a JSON media type and false otherwise
+

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

@@ -50,6 +50,7 @@
 |  [isFileData(obj)](./ibm-cloud-sdk-core.isfiledata.md) |  |
 |  [isFileWithMetadata(obj)](./ibm-cloud-sdk-core.isfilewithmetadata.md) |  |
 |  [isHTML(text)](./ibm-cloud-sdk-core.ishtml.md) | Return true if 'text' is html |
+|  [isJsonMimeType(mimeType)](./ibm-cloud-sdk-core.isjsonmimetype.md) | Returns true if and only if "mimeType" is a "JSON-like" mime type (e.g. "application/json; charset=utf-8"). |
 |  [onlyOne(a, b)](./ibm-cloud-sdk-core.onlyone.md) | Checks for only one of two elements being defined. Returns true if a is defined and b is undefined, or vice versa. Returns false if both are defined or both are undefined. |
 |  [readCredentialsFile()](./ibm-cloud-sdk-core.readcredentialsfile.md) | Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: <code>IBM_CREDENTIALS_FILE</code>. |
 |  [readCrTokenFile(filepath)](./ibm-cloud-sdk-core.readcrtokenfile.md) |  |
@@ -66,7 +67,7 @@
 |  Interface | Description |
 |  --- | --- |
 |  [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | This interface defines the common methods associated with an Authenticator implementation. |
-|  [FileObject](./ibm-cloud-sdk-core.fileobject.md) | <p>(C) Copyright IBM Corp. 2014, 2022.</p><p>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</p><p>http://www.apache.org/licenses/LICENSE-2.0</p><p>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.</p> |
+|  [FileObject](./ibm-cloud-sdk-core.fileobject.md) | <p>(C) Copyright IBM Corp. 2014, 2023.</p><p>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</p><p>http://www.apache.org/licenses/LICENSE-2.0</p><p>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.</p> |
 |  [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) |  |
 |  [FileStream](./ibm-cloud-sdk-core.filestream.md) |  |
 |  [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) |  |

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

@@ -2934,7 +2934,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface",
-          "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2022.\n *\n * 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\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * 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.\n */\n",
+          "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2023.\n *\n * 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\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * 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.\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -4864,6 +4864,51 @@
           ],
           "name": "isHTML"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "ibm-cloud-sdk-core!isJsonMimeType:function(1)",
+          "docComment": "/**\n * Returns true if and only if \"mimeType\" is a \"JSON-like\" mime type (e.g. \"application/json; charset=utf-8\").\n *\n * @param mimeType - the mimeType string\n *\n * @returns true if \"mimeType\" represents a JSON media type and false otherwise\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isJsonMimeType(mimeType: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/es/lib/helper.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "mimeType",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isJsonMimeType"
+        },
         {
           "kind": "Class",
           "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class",

package/es/auth/token-managers/vpc-instance-token-manager.d.ts

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

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

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2021, 2022.
+ * (C) Copyright IBM Corp. 2021, 2023.
  *
  * 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 @@ import logger from '../../lib/logger';
 import { atMostOne } from '../utils';
 import { JwtTokenManager } from './jwt-token-manager';
 const DEFAULT_IMS_ENDPOINT = 'http://169.254.169.254';
-const METADATA_SERVICE_VERSION = '2021-09-20';
+const METADATA_SERVICE_VERSION = '2022-03-01';
 /**
  * Token Manager for VPC Instance Authentication.
  */

package/es/lib/helper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -117,3 +117,10 @@ export declare function toLowerKeys(obj: Object): Object;
  * @returns the formatted URL with all variable placeholders replaced by values.
  */
 export declare function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
+/**
+ * Returns true if and only if "mimeType" is a "JSON-like" mime type
+ * (e.g. "application/json; charset=utf-8").
+ * @param mimeType - the mimeType string
+ * @returns true if "mimeType" represents a JSON media type and false otherwise
+ */
+export declare function isJsonMimeType(mimeType: string): boolean;

package/es/lib/helper.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -293,3 +293,13 @@ export function constructServiceUrl(parameterizedUrl, defaultUrlVariables, provi
     });
     return formattedUrl;
 }
+/**
+ * Returns true if and only if "mimeType" is a "JSON-like" mime type
+ * (e.g. "application/json; charset=utf-8").
+ * @param mimeType - the mimeType string
+ * @returns true if "mimeType" represents a JSON media type and false otherwise
+ */
+export function isJsonMimeType(mimeType) {
+    logger.debug(`Determining if the mime type '${mimeType}' specifies JSON content.`);
+    return !!mimeType && /^application\/json(\s*;.*)?$/i.test(mimeType);
+}

package/es/lib/request-wrapper.js

@@ -31,7 +31,7 @@ import { Agent } from 'https';
 import isStream from 'isstream';
 import { stringify } from 'querystring';
 import { gzipSync } from 'zlib';
-import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata, stripTrailingSlash, } from './helper';
+import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata, isJsonMimeType, stripTrailingSlash, } from './helper';
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
 import { CookieInterceptor } from './cookie-support';
@@ -207,7 +207,7 @@ export class RequestWrapper {
                 delete res.request;
                 // the other sdks use the interface `result` for the body
                 // eslint-disable-next-line @typescript-eslint/dot-notation
-                res['result'] = res.data;
+                res['result'] = ensureJSONResponseBodyIsObject(res);
                 delete res.data;
                 // return another promise that resolves with 'res' to be handled in generated code
                 return res;
@@ -239,20 +239,19 @@ export class RequestWrapper {
             error.status = axiosError.status;
             error.code = axiosError.status; // ** deprecated **
             error.message = parseServiceErrorMessage(axiosError.data) || axiosError.statusText;
-            // some services bury the useful error message within 'data'
-            // adding it to the error under the key 'body' as a string or object
+            // attach the error response body to the error
             let errorBody;
             try {
-                // try/catch to handle objects with circular references
+                // try/catch to detect objects with circular references
                 errorBody = JSON.stringify(axiosError.data);
             }
             catch (e) {
-                // ignore the error, use the object, and tack on a warning
+                logger.warn('Error field `result` contains circular reference(s)');
+                logger.debug(`Failed to stringify error response body: ${e}`);
                 errorBody = axiosError.data;
-                errorBody.warning = 'Body contains circular reference';
-                logger.error(`Failed to stringify axiosError: ${e}`);
             }
-            error.body = errorBody;
+            error.result = ensureJSONResponseBodyIsObject(axiosError);
+            error.body = errorBody; // ** deprecated **
             // attach headers to error object
             error.headers = axiosError.headers;
             // print a more descriptive error message for auth issues
@@ -452,3 +451,33 @@ function parseServiceErrorMessage(response) {
     logger.info(`Parsing service error message: ${message}`);
     return message;
 }
+/**
+ * Check response for a JSON content type and a string-formatted body. If those
+ * conditions are met, we want to return an object for the body to the user. If
+ * the JSON string coming from the service is invalid, we want to raise an
+ * exception.
+ *
+ * @param response - incoming response object
+ * @returns response body - as either an object or a string
+ * @throws error - if the content is meant as JSON but is malformed
+ */
+function ensureJSONResponseBodyIsObject(response) {
+    if (typeof response.data !== 'string' || !isJsonMimeType(response.headers['content-type'])) {
+        return response.data;
+    }
+    // If the content is supposed to be JSON but axios gave us a string, it is most
+    // likely due to the fact that the service sent malformed JSON, which is an error.
+    //
+    // We'll try to parse the string and return a proper object to the user but if
+    // it fails, we'll log an error and raise an exception.
+    let dataAsObject = response.data;
+    try {
+        dataAsObject = JSON.parse(response.data);
+    }
+    catch (e) {
+        logger.error('Response body was supposed to have JSON content but JSON parsing failed.');
+        logger.error(`Malformed JSON string: ${response.data}`);
+        throw e;
+    }
+    return dataAsObject;
+}

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

@@ -309,6 +309,9 @@ export function isFileWithMetadata(obj: any): obj is FileWithMetadata;
 // @public
 export function isHTML(text: string): boolean;
 
+// @public
+export function isJsonMimeType(mimeType: string): boolean;
+
 // @public
 export class JwtTokenManager extends TokenManager {
     constructor(options: JwtTokenManagerOptions);

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

@@ -615,7 +615,7 @@ declare function expectToBePromise(sdkPromise: any): void;
 export declare function fileExistsAtPath(filepath: string): boolean;
 
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -964,6 +964,14 @@ export declare function isFileWithMetadata(obj: any): obj is FileWithMetadata;
  */
 export declare function isHTML(text: string): boolean;
 
+/**
+ * Returns true if and only if "mimeType" is a "JSON-like" mime type
+ * (e.g. "application/json; charset=utf-8").
+ * @param mimeType - the mimeType string
+ * @returns true if "mimeType" represents a JSON media type and false otherwise
+ */
+export declare function isJsonMimeType(mimeType: string): boolean;
+
 /**
  * A class for shared functionality for parsing, storing, and requesting
  * JWT tokens. Intended to be used as a parent to be extended for token

package/lib/helper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -117,3 +117,10 @@ export declare function toLowerKeys(obj: Object): Object;
  * @returns the formatted URL with all variable placeholders replaced by values.
  */
 export declare function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
+/**
+ * Returns true if and only if "mimeType" is a "JSON-like" mime type
+ * (e.g. "application/json; charset=utf-8").
+ * @param mimeType - the mimeType string
+ * @returns true if "mimeType" represents a JSON media type and false otherwise
+ */
+export declare function isJsonMimeType(mimeType: string): boolean;

package/lib/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2014, 2022.
+ * (C) Copyright IBM Corp. 2014, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -63,7 +63,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructServiceUrl = exports.toLowerKeys = exports.buildRequestFileObject = exports.getFormat = exports.isHTML = exports.validateParams = exports.getMissingParams = exports.getQueryParam = exports.stripTrailingSlash = exports.getContentType = exports.isEmptyObject = exports.isFileData = exports.isFileWithMetadata = void 0;
+exports.isJsonMimeType = exports.constructServiceUrl = exports.toLowerKeys = exports.buildRequestFileObject = exports.getFormat = exports.isHTML = exports.validateParams = exports.getMissingParams = exports.getQueryParam = exports.stripTrailingSlash = exports.getContentType = exports.isEmptyObject = exports.isFileData = exports.isFileWithMetadata = void 0;
 var isstream_1 = require("isstream");
 var mime_types_1 = require("mime-types");
 var path_1 = require("path");
@@ -363,3 +363,14 @@ function constructServiceUrl(parameterizedUrl, defaultUrlVariables, providedUrlV
     return formattedUrl;
 }
 exports.constructServiceUrl = constructServiceUrl;
+/**
+ * Returns true if and only if "mimeType" is a "JSON-like" mime type
+ * (e.g. "application/json; charset=utf-8").
+ * @param mimeType - the mimeType string
+ * @returns true if "mimeType" represents a JSON media type and false otherwise
+ */
+function isJsonMimeType(mimeType) {
+    logger_1.default.debug("Determining if the mime type '".concat(mimeType, "' specifies JSON content."));
+    return !!mimeType && /^application\/json(\s*;.*)?$/i.test(mimeType);
+}
+exports.isJsonMimeType = isJsonMimeType;

package/lib/request-wrapper.js

@@ -295,7 +295,7 @@ var RequestWrapper = /** @class */ (function () {
                                 delete res.request;
                                 // the other sdks use the interface `result` for the body
                                 // eslint-disable-next-line @typescript-eslint/dot-notation
-                                res['result'] = res.data;
+                                res['result'] = ensureJSONResponseBodyIsObject(res);
                                 delete res.data;
                                 // return another promise that resolves with 'res' to be handled in generated code
                                 return res;
@@ -329,20 +329,19 @@ var RequestWrapper = /** @class */ (function () {
             error.status = axiosError.status;
             error.code = axiosError.status; // ** deprecated **
             error.message = parseServiceErrorMessage(axiosError.data) || axiosError.statusText;
-            // some services bury the useful error message within 'data'
-            // adding it to the error under the key 'body' as a string or object
+            // attach the error response body to the error
             var errorBody = void 0;
             try {
-                // try/catch to handle objects with circular references
+                // try/catch to detect objects with circular references
                 errorBody = JSON.stringify(axiosError.data);
             }
             catch (e) {
-                // ignore the error, use the object, and tack on a warning
+                logger_1.default.warn('Error field `result` contains circular reference(s)');
+                logger_1.default.debug("Failed to stringify error response body: ".concat(e));
                 errorBody = axiosError.data;
-                errorBody.warning = 'Body contains circular reference';
-                logger_1.default.error("Failed to stringify axiosError: ".concat(e));
             }
-            error.body = errorBody;
+            error.result = ensureJSONResponseBodyIsObject(axiosError);
+            error.body = errorBody; // ** deprecated **
             // attach headers to error object
             error.headers = axiosError.headers;
             // print a more descriptive error message for auth issues
@@ -555,3 +554,33 @@ function parseServiceErrorMessage(response) {
     logger_1.default.info("Parsing service error message: ".concat(message));
     return message;
 }
+/**
+ * Check response for a JSON content type and a string-formatted body. If those
+ * conditions are met, we want to return an object for the body to the user. If
+ * the JSON string coming from the service is invalid, we want to raise an
+ * exception.
+ *
+ * @param response - incoming response object
+ * @returns response body - as either an object or a string
+ * @throws error - if the content is meant as JSON but is malformed
+ */
+function ensureJSONResponseBodyIsObject(response) {
+    if (typeof response.data !== 'string' || !(0, helper_1.isJsonMimeType)(response.headers['content-type'])) {
+        return response.data;
+    }
+    // If the content is supposed to be JSON but axios gave us a string, it is most
+    // likely due to the fact that the service sent malformed JSON, which is an error.
+    //
+    // We'll try to parse the string and return a proper object to the user but if
+    // it fails, we'll log an error and raise an exception.
+    var dataAsObject = response.data;
+    try {
+        dataAsObject = JSON.parse(response.data);
+    }
+    catch (e) {
+        logger_1.default.error('Response body was supposed to have JSON content but JSON parsing failed.');
+        logger_1.default.error("Malformed JSON string: ".concat(response.data));
+        throw e;
+    }
+    return dataAsObject;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",

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

@@ -2934,7 +2934,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface",
-          "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2022.\n *\n * 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\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * 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.\n */\n",
+          "docComment": "/**\n * (C) Copyright IBM Corp. 2014, 2023.\n *\n * 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\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * 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.\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -4864,6 +4864,51 @@
           ],
           "name": "isHTML"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "ibm-cloud-sdk-core!isJsonMimeType:function(1)",
+          "docComment": "/**\n * Returns true if and only if \"mimeType\" is a \"JSON-like\" mime type (e.g. \"application/json; charset=utf-8\").\n *\n * @param mimeType - the mimeType string\n *\n * @returns true if \"mimeType\" represents a JSON media type and false otherwise\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isJsonMimeType(mimeType: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "dist/es/lib/helper.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "mimeType",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isJsonMimeType"
+        },
         {
           "kind": "Class",
           "canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class",

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

@@ -309,6 +309,9 @@ export function isFileWithMetadata(obj: any): obj is FileWithMetadata;
 // @public
 export function isHTML(text: string): boolean;
 
+// @public
+export function isJsonMimeType(mimeType: string): boolean;
+
 // @public
 export class JwtTokenManager extends TokenManager {
     constructor(options: JwtTokenManagerOptions);