ibm-cloud-sdk-core 2.17.8 → 2.17.11

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [2.17.11](https://github.com/IBM/node-sdk-core/compare/v2.17.10...v2.17.11) (2022-03-16)
+
+
+### Bug Fixes
+
+* update axios to remove vulnerability ([90e0417](https://github.com/IBM/node-sdk-core/commit/90e04179a14409ae209e80e4341779b61e45c772))
+* use correct type for cookie jar option ([59a440a](https://github.com/IBM/node-sdk-core/commit/59a440a66f96279b5842d1e6d2b1d48b0b0c2fe8))
+
+## [2.17.10](https://github.com/IBM/node-sdk-core/compare/v2.17.9...v2.17.10) (2022-02-10)
+
+
+### Bug Fixes
+
+* bump follow-redirects to avoid vuln ([#191](https://github.com/IBM/node-sdk-core/issues/191)) ([8a69d8e](https://github.com/IBM/node-sdk-core/commit/8a69d8e3e525c39cf1b9dcd17dc911df769702a1))
+
+## [2.17.9](https://github.com/IBM/node-sdk-core/compare/v2.17.8...v2.17.9) (2022-01-19)
+
+
+### Bug Fixes
+
+* bump version of follow-redirects to avoid vulnerability ([#189](https://github.com/IBM/node-sdk-core/issues/189)) ([b88c67a](https://github.com/IBM/node-sdk-core/commit/b88c67a52cd5129cc12228266c2499cbd1fefeec))
+
 ## [2.17.8](https://github.com/IBM/node-sdk-core/compare/v2.17.7...v2.17.8) (2022-01-18)
 
 

package/README.md

@@ -80,7 +80,7 @@ The debug logger can be configured to be used for more than one library. In exam
 ``DEBUG=ibm-cloud-sdk-core:debug,other-lib:debug``
 
 ## Cookie Jar Support
-By default, cookies are not supported in the SDK requests.  If your SDK would benefit from this functionality, simply edit your code to instantiate a cookie jar (or instruct your users to do so) and pass it in the object containing configuration options to the `BaseService` class, as shown below.
+By default, cookies are not supported in the SDK requests.  If your SDK would benefit from this functionality, simply edit your code to instantiate a cookie jar (or instruct your users to do so) and pass it in the object containing configuration options to the `BaseService` class, as shown below. If the Boolean value `true` is given for the `jar` field, the SDK core will create a default instance of a [Tough Cookie](https://www.npmjs.com/package/tough-cookie).
 
 ```ts
 import tough = require('tough-cookie');
@@ -95,8 +95,6 @@ class MyClass extends BaseService {
 }
 ```
 
-The example above uses [Tough Cookie](https://www.npmjs.com/package/tough-cookie) to provide these capabilities, but other cookie jar libraries can be used.
-
 ## Issues
 If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/node-sdk-core/issues).
 Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.

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

@@ -9,5 +9,5 @@ Set your own cookie jar object
 <b>Signature:</b>
 
 ```typescript
-jar?: any;
+jar?: CookieJar | boolean;
 ```

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

@@ -19,7 +19,7 @@ export interface UserOptions
 |  [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) | [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | <i>(Optional)</i> The Authenticator object used to authenticate requests to the service |
 |  [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) | boolean | <i>(Optional)</i> Set to <code>true</code> to allow unauthorized requests - not recommended for production use. |
 |  [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) | OutgoingHttpHeaders | <i>(Optional)</i> Default headers that shall be included with every request to the service. |
-|  [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) | any | <i>(Optional)</i> Set your own cookie jar object |
+|  [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) | CookieJar \| boolean | <i>(Optional)</i> Set your own cookie jar object |
 |  [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) | string | <i>(Optional)</i> The base url to use when contacting the service. The base url may differ between IBM Cloud regions. |
 |  [url?](./ibm-cloud-sdk-core.useroptions.url.md) | string | <i>(Optional)</i> Deprecated. Use <code>serviceUrl</code> instead. |
 |  [version?](./ibm-cloud-sdk-core.useroptions.version.md) | string | <i>(Optional)</i> The API version date to use with the service, in "YYYY-MM-DD" format. |

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

@@ -6606,9 +6606,14 @@
                   "kind": "Content",
                   "text": "jar?: "
                 },
+                {
+                  "kind": "Reference",
+                  "text": "CookieJar",
+                  "canonicalReference": "@types/tough-cookie!CookieJar:class"
+                },
                 {
                   "kind": "Content",
-                  "text": "any"
+                  "text": " | boolean"
                 },
                 {
                   "kind": "Content",
@@ -6620,7 +6625,7 @@
               "name": "jar",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               }
             },
             {

package/es/lib/base-service.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 /// <reference types="node" />
+import type { CookieJar } from 'tough-cookie';
 import { OutgoingHttpHeaders } from 'http';
 import { AuthenticatorInterface } from '../auth';
 import { RetryOptions } from './request-wrapper';
@@ -32,7 +33,7 @@ export interface UserOptions {
     /** Set to `true` to allow unauthorized requests - not recommended for production use. */
     disableSslVerification?: boolean;
     /** Set your own cookie jar object */
-    jar?: any;
+    jar?: CookieJar | boolean;
     /** Deprecated. Use `serviceUrl` instead. */
     url?: string;
     /** Allow additional request config parameters */

package/es/lib/request-wrapper.js

@@ -39,24 +39,10 @@ export class RequestWrapper {
     constructor(axiosOptions) {
         axiosOptions = axiosOptions || {};
         this.compressRequestData = Boolean(axiosOptions.enableGzipCompression);
-        // override several axios defaults
-        // axios sets the default Content-Type for `post`, `put`, and `patch` operations
-        // to 'application/x-www-form-urlencoded'. This causes problems, so overriding the
-        // defaults here
+        // override a couple axios defaults
         const axiosConfig = {
             maxContentLength: -1,
             maxBodyLength: Infinity,
-            headers: {
-                post: {
-                    'Content-Type': 'application/json',
-                },
-                put: {
-                    'Content-Type': 'application/json',
-                },
-                patch: {
-                    'Content-Type': 'application/json',
-                },
-            },
         };
         // merge axios config into default
         extend(true, axiosConfig, axiosOptions);
@@ -78,6 +64,12 @@ export class RequestWrapper {
             }
         }
         this.axiosInstance = axios.create(axiosConfig);
+        // axios sets the default Content-Type for `post`, `put`, and `patch` operations
+        // to 'application/x-www-form-urlencoded'. This causes problems, so overriding the
+        // defaults here
+        ['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 (axiosOptions.jar) {
             axiosCookieJarSupport(this.axiosInstance);

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

@@ -1,463 +1,464 @@
-## API Report File for "ibm-cloud-sdk-core"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-/// <reference types="node" />
-
-import { AxiosInstance } from 'axios';
-import { OutgoingHttpHeaders } from 'http';
-import { Stream } from 'stream';
-
-// @public
-export function atLeastOne(a: any, b: any): boolean;
-
-// @public
-export function atMostOne(a: any, b: any): boolean;
-
-// @public
-export class Authenticator implements AuthenticatorInterface {
-    constructor();
-    // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
-    authenticationType(): string;
-    static AUTHTYPE_BASIC: string;
-    // (undocumented)
-    static AUTHTYPE_BEARERTOKEN: string;
-    // (undocumented)
-    static AUTHTYPE_CONTAINER: string;
-    // (undocumented)
-    static AUTHTYPE_CP4D: string;
-    // (undocumented)
-    static AUTHTYPE_IAM: string;
-    // (undocumented)
-    static AUTHTYPE_NOAUTH: string;
-    // (undocumented)
-    static AUTHTYPE_UNKNOWN: string;
-    // (undocumented)
-    static AUTHTYPE_VPC: string;
-}
-
-// @public
-export interface AuthenticatorInterface {
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
-    authenticationType(): string;
-}
-
-// @public
-export class BaseService {
-    constructor(userOptions: UserOptions);
-    // Warning: (ae-forgotten-export) The symbol "BaseServiceOptions" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    protected baseOptions: BaseServiceOptions;
-    protected configureService(serviceName: string): void;
-    protected createRequest(parameters: any): Promise<any>;
-    // (undocumented)
-    static DEFAULT_SERVICE_NAME: string;
-    // (undocumented)
-    static DEFAULT_SERVICE_URL: string;
-    disableRetries(): void;
-    // Warning: (ae-forgotten-export) The symbol "RetryOptions" needs to be exported by the entry point index.d.ts
-    enableRetries(retryOptions?: RetryOptions): void;
-    getAuthenticator(): any;
-    getHttpClient(): AxiosInstance;
-    setEnableGzipCompression(setting: boolean): void;
-    setServiceUrl(url: string): void;
-}
-
-// @public
-export class BasicAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
-    authenticationType(): string;
-    // (undocumented)
-    protected authHeader: {
-        Authorization: string;
-    };
-    // (undocumented)
-    protected requiredOptions: string[];
-}
-
-// @public
-export class BearerTokenAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_2);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-    authenticationType(): string;
-    // (undocumented)
-    protected requiredOptions: string[];
-    setBearerToken(bearerToken: string): void;
-}
-
-// @public
-export function buildRequestFileObject(fileParam: FileWithMetadata): FileObject;
-
-// @public
-export function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
-
-// @public
-function checkForSuccessfulExecution(createRequestMock: any): void;
-
-// @public
-function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
-
-// @public
-function checkUrlAndMethod(options: any, url: string, method: any): void;
-
-// @public
-function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
-
-// @public
-export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_4);
-    authenticationType(): string;
-    // (undocumented)
-    protected requiredOptions: string[];
-    // (undocumented)
-    protected tokenManager: Cp4dTokenManager;
-}
-
-// @public
-export function computeBasicAuthHeader(username: string, password: string): string;
-
-// @public (undocumented)
-export function constructFilepath(filepath: string): string;
-
-// @public
-export function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
-
-// @public
-export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_8);
-    authenticationType(): string;
-    setCrTokenFilename(crTokenFilename: string): void;
-    setIamProfileId(iamProfileId: string): void;
-    setIamProfileName(iamProfileName: string): void;
-    // (undocumented)
-    protected tokenManager: ContainerTokenManager;
-}
-
-// @public
-export class ContainerTokenManager extends IamRequestBasedTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_7);
-    protected requestToken(): Promise<any>;
-    setCrTokenFilename(crTokenFilename: string): void;
-    setIamProfileId(iamProfileId: string): void;
-    setIamProfileName(iamProfileName: string): void;
-}
-
-// @public (undocumented)
-export const contentType: {
-    fromFilename: (file: String | File | Buffer | NodeJS.ReadableStream | FileObject) => string;
-    fromHeader: (buffer: Buffer) => string;
-};
-
-// @public
-export class Cp4dTokenManager extends JwtTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_3);
-    // (undocumented)
-    protected requestToken(): Promise<any>;
-    // (undocumented)
-    protected requiredOptions: string[];
-}
-
-// @public
-function expectToBePromise(sdkPromise: any): void;
-
-// @public (undocumented)
-export function fileExistsAtPath(filepath: string): boolean;
-
-// @public
-export interface FileObject {
-    // (undocumented)
-    options?: FileOptions;
-    // (undocumented)
-    value: NodeJS.ReadableStream | Buffer | string;
-}
-
-// @public (undocumented)
-export interface FileOptions {
-    // (undocumented)
-    contentType?: string;
-    // (undocumented)
-    filename?: string;
-}
-
-// @public (undocumented)
-export interface FileStream extends NodeJS.ReadableStream {
-    // (undocumented)
-    path: string | Buffer;
-}
-
-// @public (undocumented)
-export interface FileWithMetadata {
-    // (undocumented)
-    contentType: string;
-    // (undocumented)
-    data: NodeJS.ReadableStream | Buffer;
-    // (undocumented)
-    filename: string;
-}
-
-// @public
-export function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
-
-// @public
-export function getContentType(inputData: NodeJS.ReadableStream | Buffer): string;
-
-// @public
-export function getCurrentTime(): number;
-
-// @public
-export function getFormat(params: {
-    [key: string]: any;
-}, formats: string[]): string;
-
-// @public
-export function getMissingParams(params: {
-    [key: string]: any;
-}, requires: string[]): null | Error;
-
-// @public
-function getOptions(createRequestMock: any): any;
-
-// @public
-export function getQueryParam(urlStr: string, param: string): string;
-
-// @public
-export class IamAuthenticator extends IamRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_6);
-    authenticationType(): string;
-    // (undocumented)
-    protected requiredOptions: string[];
-    // (undocumented)
-    protected tokenManager: IamTokenManager;
-}
-
-// @public
-export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions" needs to be exported by the entry point index.d.ts
-    constructor(options: IamRequestOptions_2);
-    // (undocumented)
-    protected clientId: string;
-    // (undocumented)
-    protected clientSecret: string;
-    getRefreshToken(): string;
-    // (undocumented)
-    protected scope: string;
-    setClientIdAndSecret(clientId: string, clientSecret: string): void;
-    setScope(scope: string): void;
-    // (undocumented)
-    protected tokenManager: IamRequestBasedTokenManager;
-}
-
-// @public
-export class IamRequestBasedTokenManager extends JwtTokenManager {
-    constructor(options: IamRequestOptions);
-    // (undocumented)
-    protected formData: any;
-    getRefreshToken(): string;
-    // (undocumented)
-    protected refreshToken: string;
-    protected requestToken(): Promise<any>;
-    protected saveTokenInfo(tokenResponse: any): void;
-    setClientIdAndSecret(clientId: string, clientSecret: string): void;
-    setScope(scope: string): void;
-}
-
-// @public
-export interface IamRequestOptions extends JwtTokenManagerOptions {
-    // (undocumented)
-    clientId?: string;
-    // (undocumented)
-    clientSecret?: string;
-    // (undocumented)
-    scope?: string;
-}
-
-// @public
-export class IamTokenManager extends IamRequestBasedTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_5);
-    // (undocumented)
-    protected requiredOptions: string[];
-}
-
-// @public (undocumented)
-export function isEmptyObject(obj: any): boolean;
-
-// @public (undocumented)
-export function isFileData(obj: any): obj is NodeJS.ReadableStream | Buffer;
-
-// @public (undocumented)
-export function isFileWithMetadata(obj: any): obj is FileWithMetadata;
-
-// @public
-export function isHTML(text: string): boolean;
-
-// @public
-export class JwtTokenManager extends TokenManager {
-    constructor(options: JwtTokenManagerOptions);
-    protected requestToken(): Promise<any>;
-    protected saveTokenInfo(tokenResponse: any): void;
-    // (undocumented)
-    protected tokenInfo: any;
-    // (undocumented)
-    protected tokenName: string;
-}
-
-// @public
-export type JwtTokenManagerOptions = TokenManagerOptions;
-
-// @public
-export class NoAuthAuthenticator extends Authenticator {
-    // (undocumented)
-    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-    authenticationType(): string;
-}
-
-// @public
-export function onlyOne(a: any, b: any): boolean;
-
-// @public
-export const qs: {
-    stringify: (queryParams: Object) => string;
-};
-
-// @public
-export function readCredentialsFile(): any;
-
-// @public (undocumented)
-export function readCrTokenFile(filepath: string): string;
-
-// @public
-export function readExternalSources(serviceName: string): any;
-
-// @public
-export function removeSuffix(str: string, suffix: string): string;
-
-// @public
-export function streamToPromise(stream: Stream): Promise<any>;
-
-// @public (undocumented)
-export function stripTrailingSlash(url: string): string;
-
-// @public
-export class TokenManager {
-    constructor(options: TokenManagerOptions);
-    // (undocumented)
-    protected accessToken: string;
-    // (undocumented)
-    protected disableSslVerification: boolean;
-    // (undocumented)
-    protected expireTime: number;
-    getToken(): Promise<any>;
-    // (undocumented)
-    protected headers: OutgoingHttpHeaders;
-    protected pacedRequestToken(): Promise<any>;
-    // (undocumented)
-    protected refreshTime: number;
-    protected requestToken(): Promise<any>;
-    // Warning: (ae-forgotten-export) The symbol "RequestWrapper" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    protected requestWrapperInstance: RequestWrapper;
-    protected saveTokenInfo(tokenResponse: any): void;
-    setDisableSslVerification(value: boolean): void;
-    setHeaders(headers: OutgoingHttpHeaders): void;
-    // (undocumented)
-    protected url: string;
-}
-
-// @public
-export type TokenManagerOptions = {
-    url?: string;
-    headers?: OutgoingHttpHeaders;
-    disableSslVerification?: boolean;
-    [propName: string]: any;
-};
-
-// @public
-export class TokenRequestBasedAuthenticator extends Authenticator {
-    // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
-    constructor(options: BaseOptions);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
-    // (undocumented)
-    protected disableSslVerification: boolean;
-    // (undocumented)
-    protected headers: OutgoingHttpHeaders;
-    setDisableSslVerification(value: boolean): void;
-    setHeaders(headers: OutgoingHttpHeaders): void;
-    // (undocumented)
-    protected tokenManager: JwtTokenManager;
-    // (undocumented)
-    protected url: string;
-}
-
-// @public
-export function toLowerKeys(obj: Object): Object;
-
-declare namespace unitTestUtils {
-    export {
-        checkUrlAndMethod,
-        checkMediaHeaders,
-        checkUserHeader,
-        checkForSuccessfulExecution,
-        getOptions,
-        expectToBePromise
-    }
-}
-export { unitTestUtils }
-
-// @public
-export interface UserOptions {
-    [propName: string]: any;
-    authenticator?: AuthenticatorInterface;
-    disableSslVerification?: boolean;
-    headers?: OutgoingHttpHeaders;
-    jar?: any;
-    serviceUrl?: string;
-    url?: string;
-    version?: string;
-}
-
-// @public (undocumented)
-export function validateInput(options: any, requiredOptions: string[]): void;
-
-// @public
-export function validateParams(params: {
-    [key: string]: any;
-}, requiredParams: string[], allParams: string[]): null | Error;
-
-// @public
-export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_10);
-    authenticationType(): string;
-    setIamProfileCrn(iamProfileCrn: string): void;
-    setIamProfileId(iamProfileId: string): void;
-    // (undocumented)
-    protected tokenManager: VpcInstanceTokenManager;
-}
-
-// @public
-export class VpcInstanceTokenManager extends JwtTokenManager {
-    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
-    constructor(options: Options_9);
-    // (undocumented)
-    protected requestToken(): Promise<any>;
-    setIamProfileCrn(iamProfileCrn: string): void;
-    setIamProfileId(iamProfileId: string): void;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```
+## API Report File for "ibm-cloud-sdk-core"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="node" />
+
+import { AxiosInstance } from 'axios';
+import type { CookieJar } from 'tough-cookie';
+import { OutgoingHttpHeaders } from 'http';
+import { Stream } from 'stream';
+
+// @public
+export function atLeastOne(a: any, b: any): boolean;
+
+// @public
+export function atMostOne(a: any, b: any): boolean;
+
+// @public
+export class Authenticator implements AuthenticatorInterface {
+    constructor();
+    // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
+    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticationType(): string;
+    static AUTHTYPE_BASIC: string;
+    // (undocumented)
+    static AUTHTYPE_BEARERTOKEN: string;
+    // (undocumented)
+    static AUTHTYPE_CONTAINER: string;
+    // (undocumented)
+    static AUTHTYPE_CP4D: string;
+    // (undocumented)
+    static AUTHTYPE_IAM: string;
+    // (undocumented)
+    static AUTHTYPE_NOAUTH: string;
+    // (undocumented)
+    static AUTHTYPE_UNKNOWN: string;
+    // (undocumented)
+    static AUTHTYPE_VPC: string;
+}
+
+// @public
+export interface AuthenticatorInterface {
+    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticationType(): string;
+}
+
+// @public
+export class BaseService {
+    constructor(userOptions: UserOptions);
+    // Warning: (ae-forgotten-export) The symbol "BaseServiceOptions" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    protected baseOptions: BaseServiceOptions;
+    protected configureService(serviceName: string): void;
+    protected createRequest(parameters: any): Promise<any>;
+    // (undocumented)
+    static DEFAULT_SERVICE_NAME: string;
+    // (undocumented)
+    static DEFAULT_SERVICE_URL: string;
+    disableRetries(): void;
+    // Warning: (ae-forgotten-export) The symbol "RetryOptions" needs to be exported by the entry point index.d.ts
+    enableRetries(retryOptions?: RetryOptions): void;
+    getAuthenticator(): any;
+    getHttpClient(): AxiosInstance;
+    setEnableGzipCompression(setting: boolean): void;
+    setServiceUrl(url: string): void;
+}
+
+// @public
+export class BasicAuthenticator extends Authenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options);
+    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticationType(): string;
+    // (undocumented)
+    protected authHeader: {
+        Authorization: string;
+    };
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
+// @public
+export class BearerTokenAuthenticator extends Authenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_2);
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    setBearerToken(bearerToken: string): void;
+}
+
+// @public
+export function buildRequestFileObject(fileParam: FileWithMetadata): FileObject;
+
+// @public
+export function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
+
+// @public
+function checkForSuccessfulExecution(createRequestMock: any): void;
+
+// @public
+function checkMediaHeaders(createRequestMock: any, accept: string, contentType: string): void;
+
+// @public
+function checkUrlAndMethod(options: any, url: string, method: any): void;
+
+// @public
+function checkUserHeader(createRequestMock: any, userHeaderName: string, userHeaderValue: string): void;
+
+// @public
+export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_4);
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    // (undocumented)
+    protected tokenManager: Cp4dTokenManager;
+}
+
+// @public
+export function computeBasicAuthHeader(username: string, password: string): string;
+
+// @public (undocumented)
+export function constructFilepath(filepath: string): string;
+
+// @public
+export function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
+
+// @public
+export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_8);
+    authenticationType(): string;
+    setCrTokenFilename(crTokenFilename: string): void;
+    setIamProfileId(iamProfileId: string): void;
+    setIamProfileName(iamProfileName: string): void;
+    // (undocumented)
+    protected tokenManager: ContainerTokenManager;
+}
+
+// @public
+export class ContainerTokenManager extends IamRequestBasedTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_7);
+    protected requestToken(): Promise<any>;
+    setCrTokenFilename(crTokenFilename: string): void;
+    setIamProfileId(iamProfileId: string): void;
+    setIamProfileName(iamProfileName: string): void;
+}
+
+// @public (undocumented)
+export const contentType: {
+    fromFilename: (file: String | File | Buffer | NodeJS.ReadableStream | FileObject) => string;
+    fromHeader: (buffer: Buffer) => string;
+};
+
+// @public
+export class Cp4dTokenManager extends JwtTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_3);
+    // (undocumented)
+    protected requestToken(): Promise<any>;
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
+// @public
+function expectToBePromise(sdkPromise: any): void;
+
+// @public (undocumented)
+export function fileExistsAtPath(filepath: string): boolean;
+
+// @public
+export interface FileObject {
+    // (undocumented)
+    options?: FileOptions;
+    // (undocumented)
+    value: NodeJS.ReadableStream | Buffer | string;
+}
+
+// @public (undocumented)
+export interface FileOptions {
+    // (undocumented)
+    contentType?: string;
+    // (undocumented)
+    filename?: string;
+}
+
+// @public (undocumented)
+export interface FileStream extends NodeJS.ReadableStream {
+    // (undocumented)
+    path: string | Buffer;
+}
+
+// @public (undocumented)
+export interface FileWithMetadata {
+    // (undocumented)
+    contentType: string;
+    // (undocumented)
+    data: NodeJS.ReadableStream | Buffer;
+    // (undocumented)
+    filename: string;
+}
+
+// @public
+export function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
+
+// @public
+export function getContentType(inputData: NodeJS.ReadableStream | Buffer): string;
+
+// @public
+export function getCurrentTime(): number;
+
+// @public
+export function getFormat(params: {
+    [key: string]: any;
+}, formats: string[]): string;
+
+// @public
+export function getMissingParams(params: {
+    [key: string]: any;
+}, requires: string[]): null | Error;
+
+// @public
+function getOptions(createRequestMock: any): any;
+
+// @public
+export function getQueryParam(urlStr: string, param: string): string;
+
+// @public
+export class IamAuthenticator extends IamRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_6);
+    authenticationType(): string;
+    // (undocumented)
+    protected requiredOptions: string[];
+    // (undocumented)
+    protected tokenManager: IamTokenManager;
+}
+
+// @public
+export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "IamRequestOptions" needs to be exported by the entry point index.d.ts
+    constructor(options: IamRequestOptions_2);
+    // (undocumented)
+    protected clientId: string;
+    // (undocumented)
+    protected clientSecret: string;
+    getRefreshToken(): string;
+    // (undocumented)
+    protected scope: string;
+    setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setScope(scope: string): void;
+    // (undocumented)
+    protected tokenManager: IamRequestBasedTokenManager;
+}
+
+// @public
+export class IamRequestBasedTokenManager extends JwtTokenManager {
+    constructor(options: IamRequestOptions);
+    // (undocumented)
+    protected formData: any;
+    getRefreshToken(): string;
+    // (undocumented)
+    protected refreshToken: string;
+    protected requestToken(): Promise<any>;
+    protected saveTokenInfo(tokenResponse: any): void;
+    setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    setScope(scope: string): void;
+}
+
+// @public
+export interface IamRequestOptions extends JwtTokenManagerOptions {
+    // (undocumented)
+    clientId?: string;
+    // (undocumented)
+    clientSecret?: string;
+    // (undocumented)
+    scope?: string;
+}
+
+// @public
+export class IamTokenManager extends IamRequestBasedTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_5);
+    // (undocumented)
+    protected requiredOptions: string[];
+}
+
+// @public (undocumented)
+export function isEmptyObject(obj: any): boolean;
+
+// @public (undocumented)
+export function isFileData(obj: any): obj is NodeJS.ReadableStream | Buffer;
+
+// @public (undocumented)
+export function isFileWithMetadata(obj: any): obj is FileWithMetadata;
+
+// @public
+export function isHTML(text: string): boolean;
+
+// @public
+export class JwtTokenManager extends TokenManager {
+    constructor(options: JwtTokenManagerOptions);
+    protected requestToken(): Promise<any>;
+    protected saveTokenInfo(tokenResponse: any): void;
+    // (undocumented)
+    protected tokenInfo: any;
+    // (undocumented)
+    protected tokenName: string;
+}
+
+// @public
+export type JwtTokenManagerOptions = TokenManagerOptions;
+
+// @public
+export class NoAuthAuthenticator extends Authenticator {
+    // (undocumented)
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+    authenticationType(): string;
+}
+
+// @public
+export function onlyOne(a: any, b: any): boolean;
+
+// @public
+export const qs: {
+    stringify: (queryParams: Object) => string;
+};
+
+// @public
+export function readCredentialsFile(): any;
+
+// @public (undocumented)
+export function readCrTokenFile(filepath: string): string;
+
+// @public
+export function readExternalSources(serviceName: string): any;
+
+// @public
+export function removeSuffix(str: string, suffix: string): string;
+
+// @public
+export function streamToPromise(stream: Stream): Promise<any>;
+
+// @public (undocumented)
+export function stripTrailingSlash(url: string): string;
+
+// @public
+export class TokenManager {
+    constructor(options: TokenManagerOptions);
+    // (undocumented)
+    protected accessToken: string;
+    // (undocumented)
+    protected disableSslVerification: boolean;
+    // (undocumented)
+    protected expireTime: number;
+    getToken(): Promise<any>;
+    // (undocumented)
+    protected headers: OutgoingHttpHeaders;
+    protected pacedRequestToken(): Promise<any>;
+    // (undocumented)
+    protected refreshTime: number;
+    protected requestToken(): Promise<any>;
+    // Warning: (ae-forgotten-export) The symbol "RequestWrapper" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    protected requestWrapperInstance: RequestWrapper;
+    protected saveTokenInfo(tokenResponse: any): void;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
+    // (undocumented)
+    protected url: string;
+}
+
+// @public
+export type TokenManagerOptions = {
+    url?: string;
+    headers?: OutgoingHttpHeaders;
+    disableSslVerification?: boolean;
+    [propName: string]: any;
+};
+
+// @public
+export class TokenRequestBasedAuthenticator extends Authenticator {
+    // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
+    constructor(options: BaseOptions);
+    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    // (undocumented)
+    protected disableSslVerification: boolean;
+    // (undocumented)
+    protected headers: OutgoingHttpHeaders;
+    setDisableSslVerification(value: boolean): void;
+    setHeaders(headers: OutgoingHttpHeaders): void;
+    // (undocumented)
+    protected tokenManager: JwtTokenManager;
+    // (undocumented)
+    protected url: string;
+}
+
+// @public
+export function toLowerKeys(obj: Object): Object;
+
+declare namespace unitTestUtils {
+    export {
+        checkUrlAndMethod,
+        checkMediaHeaders,
+        checkUserHeader,
+        checkForSuccessfulExecution,
+        getOptions,
+        expectToBePromise
+    }
+}
+export { unitTestUtils }
+
+// @public
+export interface UserOptions {
+    [propName: string]: any;
+    authenticator?: AuthenticatorInterface;
+    disableSslVerification?: boolean;
+    headers?: OutgoingHttpHeaders;
+    jar?: CookieJar | boolean;
+    serviceUrl?: string;
+    url?: string;
+    version?: string;
+}
+
+// @public (undocumented)
+export function validateInput(options: any, requiredOptions: string[]): void;
+
+// @public
+export function validateParams(params: {
+    [key: string]: any;
+}, requiredParams: string[], allParams: string[]): null | Error;
+
+// @public
+export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_10);
+    authenticationType(): string;
+    setIamProfileCrn(iamProfileCrn: string): void;
+    setIamProfileId(iamProfileId: string): void;
+    // (undocumented)
+    protected tokenManager: VpcInstanceTokenManager;
+}
+
+// @public
+export class VpcInstanceTokenManager extends JwtTokenManager {
+    // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+    constructor(options: Options_9);
+    // (undocumented)
+    protected requestToken(): Promise<any>;
+    setIamProfileCrn(iamProfileCrn: string): void;
+    setIamProfileId(iamProfileId: string): void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

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

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 
 import { AxiosInstance } from 'axios';
+import type { CookieJar } from 'tough-cookie';
 import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
@@ -1448,7 +1449,7 @@ export declare class BaseService {
                                                      /** Set to `true` to allow unauthorized requests - not recommended for production use. */
                                                      disableSslVerification?: boolean;
                                                      /** Set your own cookie jar object */
-                                                     jar?: any;
+                                                     jar?: CookieJar | boolean;
                                                      /** Deprecated. Use `serviceUrl` instead. */
                                                      url?: string;
                                                      /** Allow additional request config parameters */

package/lib/base-service.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 /// <reference types="node" />
+import type { CookieJar } from 'tough-cookie';
 import { OutgoingHttpHeaders } from 'http';
 import { AuthenticatorInterface } from '../auth';
 import { RetryOptions } from './request-wrapper';
@@ -32,7 +33,7 @@ export interface UserOptions {
     /** Set to `true` to allow unauthorized requests - not recommended for production use. */
     disableSslVerification?: boolean;
     /** Set your own cookie jar object */
-    jar?: any;
+    jar?: CookieJar | boolean;
     /** Deprecated. Use `serviceUrl` instead. */
     url?: string;
     /** Allow additional request config parameters */

package/lib/request-wrapper.js

@@ -87,26 +87,13 @@ var logger_1 = __importDefault(require("./logger"));
 var stream_to_promise_1 = require("./stream-to-promise");
 var RequestWrapper = /** @class */ (function () {
     function RequestWrapper(axiosOptions) {
+        var _this = this;
         axiosOptions = axiosOptions || {};
         this.compressRequestData = Boolean(axiosOptions.enableGzipCompression);
-        // override several axios defaults
-        // axios sets the default Content-Type for `post`, `put`, and `patch` operations
-        // to 'application/x-www-form-urlencoded'. This causes problems, so overriding the
-        // defaults here
+        // override a couple axios defaults
         var axiosConfig = {
             maxContentLength: -1,
             maxBodyLength: Infinity,
-            headers: {
-                post: {
-                    'Content-Type': 'application/json',
-                },
-                put: {
-                    'Content-Type': 'application/json',
-                },
-                patch: {
-                    'Content-Type': 'application/json',
-                },
-            },
         };
         // merge axios config into default
         extend_1.default(true, axiosConfig, axiosOptions);
@@ -128,6 +115,12 @@ var RequestWrapper = /** @class */ (function () {
             }
         }
         this.axiosInstance = axios_1.default.create(axiosConfig);
+        // axios sets the default Content-Type for `post`, `put`, and `patch` operations
+        // to 'application/x-www-form-urlencoded'. This causes problems, so overriding the
+        // defaults here
+        ['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 (axiosOptions.jar) {
             axios_cookiejar_support_1.default(this.axiosInstance);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "2.17.8",
+  "version": "2.17.11",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -42,7 +42,7 @@
     "@types/isstream": "^0.1.0",
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
-    "axios": "^0.21.4",
+    "axios": "^0.26.1",
     "axios-cookiejar-support": "^1.0.0",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",
@@ -69,6 +69,7 @@
     "node": ">=10"
   },
   "scripts": {
+    "clean": "rm -fr node_modules",
     "commitmsg": "commitlint -E GIT_PARAMS",
     "eslint:config": "eslint --print-config .eslintrc.js | eslint-config-prettier-check",
     "eslint:fix": "eslint . --fix",

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

@@ -6606,9 +6606,14 @@
                   "kind": "Content",
                   "text": "jar?: "
                 },
+                {
+                  "kind": "Reference",
+                  "text": "CookieJar",
+                  "canonicalReference": "@types/tough-cookie!CookieJar:class"
+                },
                 {
                   "kind": "Content",
-                  "text": "any"
+                  "text": " | boolean"
                 },
                 {
                   "kind": "Content",
@@ -6620,7 +6625,7 @@
               "name": "jar",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               }
             },
             {

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

@@ -7,6 +7,7 @@
 /// <reference types="node" />
 
 import { AxiosInstance } from 'axios';
+import type { CookieJar } from 'tough-cookie';
 import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
@@ -423,7 +424,7 @@ export interface UserOptions {
     authenticator?: AuthenticatorInterface;
     disableSslVerification?: boolean;
     headers?: OutgoingHttpHeaders;
-    jar?: any;
+    jar?: CookieJar | boolean;
     serviceUrl?: string;
     url?: string;
     version?: string;