ibm-cloud-sdk-core 4.0.9 → 4.1.1

package/.nvmrc

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

package/Authentication.md

@@ -147,7 +147,7 @@ authenticator type is intended for situations in which the application will be m
 token itself in terms of initial acquisition and refreshing as needed.
 
 
-## Identity and Access Management Authentication (IAM)
+## Identity and Access Management (IAM) Authentication
 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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.1.1](https://github.com/IBM/node-sdk-core/compare/v4.1.0...v4.1.1) (2023-09-20)
+
+
+### Bug Fixes
+
+* process cookies in failed responses ([#251](https://github.com/IBM/node-sdk-core/issues/251)) ([52f758b](https://github.com/IBM/node-sdk-core/commit/52f758bc5700b3ccd283e39cca7401ee8dcb60d9))
+
+# [4.1.0](https://github.com/IBM/node-sdk-core/compare/v4.0.9...v4.1.0) (2023-07-06)
+
+
+### Features
+
+* add logic for serializing/deserializing model objects ([#247](https://github.com/IBM/node-sdk-core/issues/247)) ([2397eae](https://github.com/IBM/node-sdk-core/commit/2397eaef56c247a2720396c7d1444b2331ae5a73))
+
 ## [4.0.9](https://github.com/IBM/node-sdk-core/compare/v4.0.8...v4.0.9) (2023-06-22)
 
 

package/build/docs/ibm-cloud-sdk-core.baseservice.convertmodel.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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [convertModel](./ibm-cloud-sdk-core.baseservice.convertmodel.md)
+
+## BaseService.convertModel() method
+
+Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.
+
+**Signature:**
+
+```typescript
+static convertModel(input: any, converterFn: any, isMap?: boolean): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  input | any | the input model object |
+|  converterFn | any | the function that is applied on the input object |
+|  isMap | boolean | _(Optional)_ is <code>true</code> when the input object should be handled as a map |
+
+**Returns:**
+
+any
+

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

@@ -0,0 +1,28 @@
+<!-- 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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [createRequestAndDeserializeResponse](./ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md)
+
+## BaseService.createRequestAndDeserializeResponse() method
+
+Wrapper around `createRequest` that enforces arrived response to be deserialized.
+
+**Signature:**
+
+```typescript
+protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  parameters | any | see <code>parameters</code> in <code>createRequest</code> |
+|  deserializerFn | (any: any) =&gt; any | the deserializer function that is applied on the response object |
+|  isMap | boolean | _(Optional)_ is <code>true</code> when the response object should be handled as a map |
+
+**Returns:**
+
+Promise&lt;any&gt;
+
+a Promise
+

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

@@ -33,7 +33,9 @@ export declare class BaseService
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [configureService(serviceName)](./ibm-cloud-sdk-core.baseservice.configureservice.md) | <code>protected</code> | Configure the service using external configuration |
+|  [convertModel(input, converterFn, isMap)](./ibm-cloud-sdk-core.baseservice.convertmodel.md) | <code>static</code> | Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter. |
 |  [createRequest(parameters)](./ibm-cloud-sdk-core.baseservice.createrequest.md) | <code>protected</code> | Wrapper around <code>sendRequest</code> that enforces the request will be authenticated. |
+|  [createRequestAndDeserializeResponse(parameters, deserializerFn, isMap)](./ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md) | <code>protected</code> | Wrapper around <code>createRequest</code> that enforces arrived response to be deserialized. |
 |  [disableRetries()](./ibm-cloud-sdk-core.baseservice.disableretries.md) |  | Disables retries. |
 |  [enableRetries(retryOptions)](./ibm-cloud-sdk-core.baseservice.enableretries.md) |  | Enable retries for unfulfilled requests. |
 |  [getAuthenticator()](./ibm-cloud-sdk-core.baseservice.getauthenticator.md) |  | Get the instance of the authenticator set on the service. |

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.36.0",
+    "toolVersion": "7.36.1",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -892,6 +892,86 @@
               "isAbstract": false,
               "name": "configureService"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService.convertModel:member(1)",
+              "docComment": "/**\n * Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.\n *\n * @param input - the input model object\n *\n * @param converterFn - the function that is applied on the input object\n *\n * @param isMap - is `true` when the input object should be handled as a map\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static convertModel(input: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", converterFn: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", isMap?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": true,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "input",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "converterFn",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "isMap",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "convertModel"
+            },
             {
               "kind": "Method",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequest:member(1)",
@@ -945,6 +1025,91 @@
               "isAbstract": false,
               "name": "createRequest"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequestAndDeserializeResponse:member(1)",
+              "docComment": "/**\n * Wrapper around `createRequest` that enforces arrived response to be deserialized.\n *\n * @param parameters - see `parameters` in `createRequest`\n *\n * @param deserializerFn - the deserializer function that is applied on the response object\n *\n * @param isMap - is `true` when the response object should be handled as a map\n *\n * @returns a Promise\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected createRequestAndDeserializeResponse(parameters: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", deserializerFn: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(any: any) => any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", isMap?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "parameters",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "deserializerFn",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "isMap",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "createRequestAndDeserializeResponse"
+            },
             {
               "kind": "Property",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService.DEFAULT_SERVICE_NAME:member",

package/es/lib/base-service.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.
@@ -113,6 +113,16 @@ export declare class BaseService {
      * Disables retries.
      */
     disableRetries(): void;
+    /**
+     * Applies a given modifier function on a model object.
+     * Since the model object can be a map, or an array, or a model,
+     * these types needs different handling.
+     * Considering whether the input object is a map happens with an explicit parameter.
+     * @param input - the input model object
+     * @param converterFn - the function that is applied on the input object
+     * @param isMap - is `true` when the input object should be handled as a map
+     */
+    static convertModel(input: any, converterFn: any, isMap?: boolean): any;
     /**
      * Configure the service using external configuration
      *
@@ -142,5 +152,15 @@ export declare class BaseService {
      * @returns a Promise
      */
     protected createRequest(parameters: any): Promise<any>;
+    /**
+     * Wrapper around `createRequest` that enforces arrived response to be deserialized.
+     * @param parameters - see `parameters` in `createRequest`
+     * @param deserializerFn - the deserializer function that is applied on the response object
+     * @param isMap - is `true` when the response object should be handled as a map
+     * @returns a Promise
+     */
+    protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
     private readOptionsFromExternalConfig;
+    private static convertArray;
+    private static convertMap;
 }

package/es/lib/base-service.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.
@@ -132,6 +132,28 @@ export class BaseService {
     disableRetries() {
         this.requestWrapperInstance.disableRetries();
     }
+    /**
+     * Applies a given modifier function on a model object.
+     * Since the model object can be a map, or an array, or a model,
+     * these types needs different handling.
+     * Considering whether the input object is a map happens with an explicit parameter.
+     * @param input - the input model object
+     * @param converterFn - the function that is applied on the input object
+     * @param isMap - is `true` when the input object should be handled as a map
+     */
+    static convertModel(input, converterFn, isMap) {
+        if (input == null || typeof input === 'string') {
+            // no need for conversation
+            return input;
+        }
+        if (Array.isArray(input)) {
+            return BaseService.convertArray(input, converterFn, isMap);
+        }
+        else if (isMap === true) {
+            return BaseService.convertMap(input, converterFn);
+        }
+        return converterFn(input);
+    }
     /**
      * Configure the service using external configuration
      *
@@ -179,6 +201,25 @@ export class BaseService {
         // resolve() handles rejection as well, so resolving the result of sendRequest should allow for proper handling later
         this.requestWrapperInstance.sendRequest(parameters));
     }
+    /**
+     * Wrapper around `createRequest` that enforces arrived response to be deserialized.
+     * @param parameters - see `parameters` in `createRequest`
+     * @param deserializerFn - the deserializer function that is applied on the response object
+     * @param isMap - is `true` when the response object should be handled as a map
+     * @returns a Promise
+     */
+    createRequestAndDeserializeResponse(parameters, deserializerFn, isMap) {
+        return new Promise((resolve, reject) => {
+            this.createRequest(parameters)
+                .then((r) => {
+                if (r !== undefined && r.result !== undefined) {
+                    r.result = BaseService.convertModel(r.result, deserializerFn, isMap);
+                }
+                resolve(r);
+            })
+                .catch((err) => reject(err));
+        });
+    }
     // eslint-disable-next-line class-methods-use-this
     readOptionsFromExternalConfig(serviceName) {
         const results = {};
@@ -210,4 +251,18 @@ export class BaseService {
         }
         return results;
     }
+    static convertArray(arrayInput, converterFn, isMap) {
+        const serializedList = [];
+        arrayInput.forEach((element) => {
+            serializedList.push(this.convertModel(element, converterFn, isMap));
+        });
+        return serializedList;
+    }
+    static convertMap(mapInput, converterFn) {
+        const serializedMap = {};
+        Object.keys(mapInput).forEach((key) => {
+            serializedMap[key] = BaseService.convertModel(mapInput[key], converterFn);
+        });
+        return serializedMap;
+    }
 }

package/es/lib/cookie-support.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2022.
+ * (C) Copyright IBM Corp. 2022, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,11 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { InternalAxiosRequestConfig, AxiosResponse } from 'axios';
+import { Axios } from 'axios';
 import { CookieJar } from 'tough-cookie';
-export declare class CookieInterceptor {
-    private readonly cookieJar;
-    constructor(cookieJar: CookieJar | boolean);
-    requestInterceptor(config: InternalAxiosRequestConfig): Promise<InternalAxiosRequestConfig<any>>;
-    responseInterceptor(response: AxiosResponse): Promise<AxiosResponse<any, any>>;
-}
+export declare const createCookieInterceptor: (cookieJar: CookieJar | boolean) => (axios: Axios) => void;

package/es/lib/cookie-support.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2022.
+ * (C) Copyright IBM Corp. 2022, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,31 +22,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { isAxiosError } from 'axios';
 import extend from 'extend';
 import { CookieJar } from 'tough-cookie';
 import logger from './logger';
-export class CookieInterceptor {
-    constructor(cookieJar) {
-        if (cookieJar) {
-            if (cookieJar === true) {
-                logger.debug('CookieInterceptor: creating new CookieJar');
-                this.cookieJar = new CookieJar();
-            }
-            else {
-                logger.debug('CookieInterceptor: using supplied CookieJar');
-                this.cookieJar = cookieJar;
-            }
-        }
-        else {
-            throw new Error('Must supply a cookie jar or true.');
-        }
-    }
-    requestInterceptor(config) {
+const internalCreateCookieInterceptor = (cookieJar) => {
+    /**
+     * This is called by Axios when a request is about to be sent in order to
+     * copy the cookie string from the URL to a request header.
+     *
+     * @param config the Axios request config
+     * @returns the request config
+     */
+    function requestInterceptor(config) {
         return __awaiter(this, void 0, void 0, function* () {
             logger.debug('CookieInterceptor: intercepting request');
             if (config && config.url) {
                 logger.debug(`CookieInterceptor: getting cookies for: ${config.url}`);
-                const cookieHeaderValue = yield this.cookieJar.getCookieString(config.url);
+                const cookieHeaderValue = yield cookieJar.getCookieString(config.url);
                 if (cookieHeaderValue) {
                     logger.debug('CookieInterceptor: setting cookie header');
                     const cookieHeader = { cookie: cookieHeaderValue };
@@ -62,25 +55,65 @@ export class CookieInterceptor {
             return config;
         });
     }
-    responseInterceptor(response) {
+    /**
+     * This is called by Axios when a 2xx response has been received.
+     * We'll invoke the configured cookie jar's setCookie() method to handle
+     * the "set-cookie" header.
+     * @param response the Axios response object
+     * @returns the response object
+     */
+    function responseInterceptor(response) {
         return __awaiter(this, void 0, void 0, function* () {
-            logger.debug('CookieInterceptor: intercepting response.');
-            if (response && response.headers) {
-                logger.debug('CookieInterceptor: checking for set-cookie headers.');
-                const cookies = response.headers['set-cookie'];
-                if (cookies) {
-                    logger.debug(`CookieInterceptor: setting cookies in jar for URL ${response.config.url}.`);
-                    // Write cookies sequentially by chaining the promises in a reduce
-                    yield cookies.reduce((cookiePromise, cookie) => cookiePromise.then(() => this.cookieJar.setCookie(cookie, response.config.url)), Promise.resolve(null));
-                }
-                else {
-                    logger.debug('CookieInterceptor: no set-cookie headers.');
-                }
+            logger.debug('CookieInterceptor: intercepting response to check for set-cookie headers.');
+            const cookies = response.headers['set-cookie'];
+            if (cookies) {
+                logger.debug(`CookieInterceptor: setting cookies in jar for URL ${response.config.url}.`);
+                // Write cookies sequentially by chaining the promises in a reduce
+                yield cookies.reduce((cookiePromise, cookie) => cookiePromise.then(() => cookieJar.setCookie(cookie, response.config.url)), Promise.resolve(null));
             }
             else {
-                logger.debug('CookieInterceptor: no response headers.');
+                logger.debug('CookieInterceptor: no set-cookie headers.');
             }
             return response;
         });
     }
-}
+    /**
+     * This is called by Axios when a non-2xx response has been received.
+     * We'll simply invoke the "responseFulfilled" method since we want to
+     * do the same cookie handler as for a success response.
+     * @param error the Axios error object that describes the non-2xx response
+     * @returns the error object
+     */
+    function responseRejected(error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.debug('CookieIntercepter: intercepting error response');
+            if (isAxiosError(error)) {
+                logger.debug('CookieIntercepter: delegating to responseInterceptor()');
+                yield responseInterceptor(error.response);
+            }
+            else {
+                logger.debug('CookieInterceptor: no response field in error object, skipping...');
+            }
+            return Promise.reject(error);
+        });
+    }
+    return (axios) => {
+        axios.interceptors.request.use(requestInterceptor);
+        axios.interceptors.response.use(responseInterceptor, responseRejected);
+    };
+};
+export const createCookieInterceptor = (cookieJar) => {
+    if (cookieJar) {
+        if (cookieJar === true) {
+            logger.debug('CookieInterceptor: creating new CookieJar');
+            return internalCreateCookieInterceptor(new CookieJar());
+        }
+        else {
+            logger.debug('CookieInterceptor: using supplied CookieJar');
+            return internalCreateCookieInterceptor(cookieJar);
+        }
+    }
+    else {
+        throw new Error('Must supply a cookie jar or true.');
+    }
+};

package/es/lib/request-wrapper.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.

package/es/lib/request-wrapper.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 /**
- * (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.
@@ -34,7 +34,7 @@ import { gzipSync } from 'zlib';
 import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata, isJsonMimeType, stripTrailingSlash, } from './helper';
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
-import { CookieInterceptor } from './cookie-support';
+import { createCookieInterceptor } from './cookie-support';
 import { chainError } from './chain-error';
 export class RequestWrapper {
     constructor(axiosOptions) {
@@ -71,13 +71,9 @@ export class RequestWrapper {
         ['post', 'put', 'patch'].forEach((op) => {
             this.axiosInstance.defaults.headers[op]['Content-Type'] = 'application/json';
         });
-        // if a cookie jar is provided, wrap the axios instance and update defaults
+        // if a cookie jar is provided, register our cookie interceptors with axios
         if (axiosOptions.jar) {
-            const cookieInterceptor = new CookieInterceptor(axiosOptions.jar);
-            const requestCookieInterceptor = (config) => cookieInterceptor.requestInterceptor(config);
-            const responseCookieInterceptor = (response) => cookieInterceptor.responseInterceptor(response);
-            this.axiosInstance.interceptors.request.use(requestCookieInterceptor);
-            this.axiosInstance.interceptors.response.use(responseCookieInterceptor);
+            createCookieInterceptor(axiosOptions.jar)(this.axiosInstance);
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {

package/es/tsdoc-metadata.json

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

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

@@ -55,7 +55,9 @@ export class BaseService {
     // (undocumented)
     protected baseOptions: BaseServiceOptions;
     protected configureService(serviceName: string): void;
+    static convertModel(input: any, converterFn: any, isMap?: boolean): any;
     protected createRequest(parameters: any): Promise<any>;
+    protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
     // (undocumented)
     static DEFAULT_SERVICE_NAME: string;
     // (undocumented)

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

@@ -178,6 +178,16 @@ export declare class BaseService {
      * Disables retries.
      */
     disableRetries(): void;
+    /**
+     * Applies a given modifier function on a model object.
+     * Since the model object can be a map, or an array, or a model,
+     * these types needs different handling.
+     * Considering whether the input object is a map happens with an explicit parameter.
+     * @param input - the input model object
+     * @param converterFn - the function that is applied on the input object
+     * @param isMap - is `true` when the input object should be handled as a map
+     */
+    static convertModel(input: any, converterFn: any, isMap?: boolean): any;
     /**
      * Configure the service using external configuration
      *
@@ -207,7 +217,17 @@ export declare class BaseService {
      * @returns a Promise
      */
     protected createRequest(parameters: any): Promise<any>;
+    /**
+     * Wrapper around `createRequest` that enforces arrived response to be deserialized.
+     * @param parameters - see `parameters` in `createRequest`
+     * @param deserializerFn - the deserializer function that is applied on the response object
+     * @param isMap - is `true` when the response object should be handled as a map
+     * @returns a Promise
+     */
+    protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
     private readOptionsFromExternalConfig;
+    private static convertArray;
+    private static convertMap;
 }
 
 /**

package/lib/base-service.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.
@@ -113,6 +113,16 @@ export declare class BaseService {
      * Disables retries.
      */
     disableRetries(): void;
+    /**
+     * Applies a given modifier function on a model object.
+     * Since the model object can be a map, or an array, or a model,
+     * these types needs different handling.
+     * Considering whether the input object is a map happens with an explicit parameter.
+     * @param input - the input model object
+     * @param converterFn - the function that is applied on the input object
+     * @param isMap - is `true` when the input object should be handled as a map
+     */
+    static convertModel(input: any, converterFn: any, isMap?: boolean): any;
     /**
      * Configure the service using external configuration
      *
@@ -142,5 +152,15 @@ export declare class BaseService {
      * @returns a Promise
      */
     protected createRequest(parameters: any): Promise<any>;
+    /**
+     * Wrapper around `createRequest` that enforces arrived response to be deserialized.
+     * @param parameters - see `parameters` in `createRequest`
+     * @param deserializerFn - the deserializer function that is applied on the response object
+     * @param isMap - is `true` when the response object should be handled as a map
+     * @returns a Promise
+     */
+    protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
     private readOptionsFromExternalConfig;
+    private static convertArray;
+    private static convertMap;
 }

package/lib/base-service.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.
@@ -149,6 +149,28 @@ var BaseService = /** @class */ (function () {
     BaseService.prototype.disableRetries = function () {
         this.requestWrapperInstance.disableRetries();
     };
+    /**
+     * Applies a given modifier function on a model object.
+     * Since the model object can be a map, or an array, or a model,
+     * these types needs different handling.
+     * Considering whether the input object is a map happens with an explicit parameter.
+     * @param input - the input model object
+     * @param converterFn - the function that is applied on the input object
+     * @param isMap - is `true` when the input object should be handled as a map
+     */
+    BaseService.convertModel = function (input, converterFn, isMap) {
+        if (input == null || typeof input === 'string') {
+            // no need for conversation
+            return input;
+        }
+        if (Array.isArray(input)) {
+            return BaseService.convertArray(input, converterFn, isMap);
+        }
+        else if (isMap === true) {
+            return BaseService.convertMap(input, converterFn);
+        }
+        return converterFn(input);
+    };
     /**
      * Configure the service using external configuration
      *
@@ -198,6 +220,26 @@ var BaseService = /** @class */ (function () {
             return _this.requestWrapperInstance.sendRequest(parameters);
         });
     };
+    /**
+     * Wrapper around `createRequest` that enforces arrived response to be deserialized.
+     * @param parameters - see `parameters` in `createRequest`
+     * @param deserializerFn - the deserializer function that is applied on the response object
+     * @param isMap - is `true` when the response object should be handled as a map
+     * @returns a Promise
+     */
+    BaseService.prototype.createRequestAndDeserializeResponse = function (parameters, deserializerFn, isMap) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            _this.createRequest(parameters)
+                .then(function (r) {
+                if (r !== undefined && r.result !== undefined) {
+                    r.result = BaseService.convertModel(r.result, deserializerFn, isMap);
+                }
+                resolve(r);
+            })
+                .catch(function (err) { return reject(err); });
+        });
+    };
     // eslint-disable-next-line class-methods-use-this
     BaseService.prototype.readOptionsFromExternalConfig = function (serviceName) {
         var results = {};
@@ -229,6 +271,21 @@ var BaseService = /** @class */ (function () {
         }
         return results;
     };
+    BaseService.convertArray = function (arrayInput, converterFn, isMap) {
+        var _this = this;
+        var serializedList = [];
+        arrayInput.forEach(function (element) {
+            serializedList.push(_this.convertModel(element, converterFn, isMap));
+        });
+        return serializedList;
+    };
+    BaseService.convertMap = function (mapInput, converterFn) {
+        var serializedMap = {};
+        Object.keys(mapInput).forEach(function (key) {
+            serializedMap[key] = BaseService.convertModel(mapInput[key], converterFn);
+        });
+        return serializedMap;
+    };
     return BaseService;
 }());
 exports.BaseService = BaseService;

package/lib/cookie-support.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2022.
+ * (C) Copyright IBM Corp. 2022, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,11 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { InternalAxiosRequestConfig, AxiosResponse } from 'axios';
+import { Axios } from 'axios';
 import { CookieJar } from 'tough-cookie';
-export declare class CookieInterceptor {
-    private readonly cookieJar;
-    constructor(cookieJar: CookieJar | boolean);
-    requestInterceptor(config: InternalAxiosRequestConfig): Promise<InternalAxiosRequestConfig<any>>;
-    responseInterceptor(response: AxiosResponse): Promise<AxiosResponse<any, any>>;
-}
+export declare const createCookieInterceptor: (cookieJar: CookieJar | boolean) => (axios: Axios) => void;

package/lib/cookie-support.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2022.
+ * (C) Copyright IBM Corp. 2022, 2023.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -54,27 +54,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CookieInterceptor = void 0;
+exports.createCookieInterceptor = void 0;
+var axios_1 = require("axios");
 var extend_1 = __importDefault(require("extend"));
 var tough_cookie_1 = require("tough-cookie");
 var logger_1 = __importDefault(require("./logger"));
-var CookieInterceptor = /** @class */ (function () {
-    function CookieInterceptor(cookieJar) {
-        if (cookieJar) {
-            if (cookieJar === true) {
-                logger_1.default.debug('CookieInterceptor: creating new CookieJar');
-                this.cookieJar = new tough_cookie_1.CookieJar();
-            }
-            else {
-                logger_1.default.debug('CookieInterceptor: using supplied CookieJar');
-                this.cookieJar = cookieJar;
-            }
-        }
-        else {
-            throw new Error('Must supply a cookie jar or true.');
-        }
-    }
-    CookieInterceptor.prototype.requestInterceptor = function (config) {
+var internalCreateCookieInterceptor = function (cookieJar) {
+    /**
+     * This is called by Axios when a request is about to be sent in order to
+     * copy the cookie string from the URL to a request header.
+     *
+     * @param config the Axios request config
+     * @returns the request config
+     */
+    function requestInterceptor(config) {
         return __awaiter(this, void 0, void 0, function () {
             var cookieHeaderValue, cookieHeader;
             return __generator(this, function (_a) {
@@ -83,7 +76,7 @@ var CookieInterceptor = /** @class */ (function () {
                         logger_1.default.debug('CookieInterceptor: intercepting request');
                         if (!(config && config.url)) return [3 /*break*/, 2];
                         logger_1.default.debug("CookieInterceptor: getting cookies for: ".concat(config.url));
-                        return [4 /*yield*/, this.cookieJar.getCookieString(config.url)];
+                        return [4 /*yield*/, cookieJar.getCookieString(config.url)];
                     case 1:
                         cookieHeaderValue = _a.sent();
                         if (cookieHeaderValue) {
@@ -102,23 +95,27 @@ var CookieInterceptor = /** @class */ (function () {
                 }
             });
         });
-    };
-    CookieInterceptor.prototype.responseInterceptor = function (response) {
+    }
+    /**
+     * This is called by Axios when a 2xx response has been received.
+     * We'll invoke the configured cookie jar's setCookie() method to handle
+     * the "set-cookie" header.
+     * @param response the Axios response object
+     * @returns the response object
+     */
+    function responseInterceptor(response) {
         return __awaiter(this, void 0, void 0, function () {
             var cookies;
-            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        logger_1.default.debug('CookieInterceptor: intercepting response.');
-                        if (!(response && response.headers)) return [3 /*break*/, 4];
-                        logger_1.default.debug('CookieInterceptor: checking for set-cookie headers.');
+                        logger_1.default.debug('CookieInterceptor: intercepting response to check for set-cookie headers.');
                         cookies = response.headers['set-cookie'];
                         if (!cookies) return [3 /*break*/, 2];
                         logger_1.default.debug("CookieInterceptor: setting cookies in jar for URL ".concat(response.config.url, "."));
                         // Write cookies sequentially by chaining the promises in a reduce
                         return [4 /*yield*/, cookies.reduce(function (cookiePromise, cookie) {
-                                return cookiePromise.then(function () { return _this.cookieJar.setCookie(cookie, response.config.url); });
+                                return cookiePromise.then(function () { return cookieJar.setCookie(cookie, response.config.url); });
                             }, Promise.resolve(null))];
                     case 1:
                         // Write cookies sequentially by chaining the promises in a reduce
@@ -127,15 +124,56 @@ var CookieInterceptor = /** @class */ (function () {
                     case 2:
                         logger_1.default.debug('CookieInterceptor: no set-cookie headers.');
                         _a.label = 3;
-                    case 3: return [3 /*break*/, 5];
-                    case 4:
-                        logger_1.default.debug('CookieInterceptor: no response headers.');
-                        _a.label = 5;
-                    case 5: return [2 /*return*/, response];
+                    case 3: return [2 /*return*/, response];
                 }
             });
         });
+    }
+    /**
+     * This is called by Axios when a non-2xx response has been received.
+     * We'll simply invoke the "responseFulfilled" method since we want to
+     * do the same cookie handler as for a success response.
+     * @param error the Axios error object that describes the non-2xx response
+     * @returns the error object
+     */
+    function responseRejected(error) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger_1.default.debug('CookieIntercepter: intercepting error response');
+                        if (!(0, axios_1.isAxiosError)(error)) return [3 /*break*/, 2];
+                        logger_1.default.debug('CookieIntercepter: delegating to responseInterceptor()');
+                        return [4 /*yield*/, responseInterceptor(error.response)];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        logger_1.default.debug('CookieInterceptor: no response field in error object, skipping...');
+                        _a.label = 3;
+                    case 3: return [2 /*return*/, Promise.reject(error)];
+                }
+            });
+        });
+    }
+    return function (axios) {
+        axios.interceptors.request.use(requestInterceptor);
+        axios.interceptors.response.use(responseInterceptor, responseRejected);
     };
-    return CookieInterceptor;
-}());
-exports.CookieInterceptor = CookieInterceptor;
+};
+var createCookieInterceptor = function (cookieJar) {
+    if (cookieJar) {
+        if (cookieJar === true) {
+            logger_1.default.debug('CookieInterceptor: creating new CookieJar');
+            return internalCreateCookieInterceptor(new tough_cookie_1.CookieJar());
+        }
+        else {
+            logger_1.default.debug('CookieInterceptor: using supplied CookieJar');
+            return internalCreateCookieInterceptor(cookieJar);
+        }
+    }
+    else {
+        throw new Error('Must supply a cookie jar or true.');
+    }
+};
+exports.createCookieInterceptor = createCookieInterceptor;

package/lib/request-wrapper.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.

package/lib/request-wrapper.js

@@ -76,7 +76,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestWrapper = void 0;
 /**
- * (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.
@@ -139,15 +139,9 @@ var RequestWrapper = /** @class */ (function () {
         ['post', 'put', 'patch'].forEach(function (op) {
             _this.axiosInstance.defaults.headers[op]['Content-Type'] = 'application/json';
         });
-        // if a cookie jar is provided, wrap the axios instance and update defaults
+        // if a cookie jar is provided, register our cookie interceptors with axios
         if (axiosOptions.jar) {
-            var cookieInterceptor_1 = new cookie_support_1.CookieInterceptor(axiosOptions.jar);
-            var requestCookieInterceptor = function (config) { return cookieInterceptor_1.requestInterceptor(config); };
-            var responseCookieInterceptor = function (response) {
-                return cookieInterceptor_1.responseInterceptor(response);
-            };
-            this.axiosInstance.interceptors.request.use(requestCookieInterceptor);
-            this.axiosInstance.interceptors.response.use(responseCookieInterceptor);
+            (0, cookie_support_1.createCookieInterceptor)(axiosOptions.jar)(this.axiosInstance);
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "4.0.9",
+  "version": "4.1.1",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -55,7 +55,10 @@
     "lodash.isempty": "^4.4.0",
     "mime-types": "~2.1.18",
     "retry-axios": "^2.6.0",
-    "tough-cookie": "^4.0.0"
+    "tough-cookie": "^4.1.3"
+  },
+  "overrides": {
+    "semver": "^7.5.3"
   },
   "browser": {
     "./auth/utils/read-credentials-file": "./auth/utils/read-credentials-file.browser",

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.36.0",
+    "toolVersion": "7.36.1",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -892,6 +892,86 @@
               "isAbstract": false,
               "name": "configureService"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService.convertModel:member(1)",
+              "docComment": "/**\n * Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.\n *\n * @param input - the input model object\n *\n * @param converterFn - the function that is applied on the input object\n *\n * @param isMap - is `true` when the input object should be handled as a map\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static convertModel(input: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", converterFn: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", isMap?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": true,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "input",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "converterFn",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "isMap",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "convertModel"
+            },
             {
               "kind": "Method",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequest:member(1)",
@@ -945,6 +1025,91 @@
               "isAbstract": false,
               "name": "createRequest"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService#createRequestAndDeserializeResponse:member(1)",
+              "docComment": "/**\n * Wrapper around `createRequest` that enforces arrived response to be deserialized.\n *\n * @param parameters - see `parameters` in `createRequest`\n *\n * @param deserializerFn - the deserializer function that is applied on the response object\n *\n * @param isMap - is `true` when the response object should be handled as a map\n *\n * @returns a Promise\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected createRequestAndDeserializeResponse(parameters: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", deserializerFn: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(any: any) => any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", isMap?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "parameters",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "deserializerFn",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "isMap",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "createRequestAndDeserializeResponse"
+            },
             {
               "kind": "Property",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService.DEFAULT_SERVICE_NAME:member",

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

@@ -55,7 +55,9 @@ export class BaseService {
     // (undocumented)
     protected baseOptions: BaseServiceOptions;
     protected configureService(serviceName: string): void;
+    static convertModel(input: any, converterFn: any, isMap?: boolean): any;
     protected createRequest(parameters: any): Promise<any>;
+    protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
     // (undocumented)
     static DEFAULT_SERVICE_NAME: string;
     // (undocumented)