ibm-cloud-sdk-core 5.0.0 → 5.0.1

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [5.0.1](https://github.com/IBM/node-sdk-core/compare/v5.0.0...v5.0.1) (2024-08-14)
+
+
+### Bug Fixes
+
+* **deps:** update axios to resolve vulnerability ([#282](https://github.com/IBM/node-sdk-core/issues/282)) ([83d9473](https://github.com/IBM/node-sdk-core/commit/83d9473dc88a288398fa307703f626ca3ebf8bd5))
+* **deps:** update axios to resolve vulnerability ([#283](https://github.com/IBM/node-sdk-core/issues/283)) ([3500bf2](https://github.com/IBM/node-sdk-core/commit/3500bf22d1e321e54614c3c97186779266b9f264))
+
 # [5.0.0](https://github.com/IBM/node-sdk-core/compare/v4.3.3...v5.0.0) (2024-06-18)
 
 

package/README.md

@@ -13,8 +13,7 @@ This project contains core functionality required by Node.js code generated by t
 ```
 
 ## Prerequisites
-- Node.js version 14 or newer
-- Note that v14 is technically *supported* but not officially *guaranteed* as we only test on v16 and higher
+- Node.js version 18 or newer
 
 ## Usage
 This package exports a single object containing a number of modules as top level properties.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -37,7 +37,7 @@
     "@types/debug": "^4.1.12",
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
-    "axios": "1.6.8",
+    "axios": "1.7.4",
     "camelcase": "^6.3.0",
     "debug": "^4.3.4",
     "dotenv": "^16.4.5",
@@ -81,7 +81,8 @@
     "copy:doc": "mkdir -p dist/docs && cp \"temp/ibm-cloud-sdk-core.api.json\" dist/docs",
     "copy:pkg": "package-json-reducer -s \"config devDependencies directories scripts jestSonar jest\" -o ./dist/package.json package.json",
     "postversion": "publisher --no-checks --dry-run",
-    "all": "npm-run-all build test lint"
+    "all": "npm-run-all build test lint",
+    "semantic-release": "semantic-release"
   },
   "jest": {
     "collectCoverage": true,

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

@@ -1,71 +0,0 @@
-<!-- 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; [atLeastOne](./ibm-cloud-sdk-core.atleastone.md)
-
-## atLeastOne() function
-
-Checks for at least one of two elements being defined.
-
-**Signature:**
-
-```typescript
-export declare function atLeastOne(a: any, b: any): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-a
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the first object
-
-
-</td></tr>
-<tr><td>
-
-b
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the second object
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-boolean
-
-true if a or b is defined; false if both are undefined
-

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

@@ -1,71 +0,0 @@
-<!-- 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; [atMostOne](./ibm-cloud-sdk-core.atmostone.md)
-
-## atMostOne() function
-
-Verifies that both properties are not specified.
-
-**Signature:**
-
-```typescript
-export declare function atMostOne(a: any, b: any): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-a
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The first object
-
-
-</td></tr>
-<tr><td>
-
-b
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The second object
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-boolean
-
-false if a and b are both defined, true otherwise
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.authenticator._constructor_.md)
-
-## Authenticator.(constructor)
-
-Create a new Authenticator instance.
-
-**Signature:**
-
-```typescript
-constructor();
-```
-
-## Exceptions
-
-Error: the "new" keyword was not used to construct the authenticator.
-

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

@@ -1,57 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticator.authenticate.md)
-
-## Authenticator.authenticate() method
-
-Augment the request with authentication information.
-
-**Signature:**
-
-```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-requestOptions
-
-
-</td><td>
-
-AuthenticateOptions
-
-
-</td><td>
-
-The request to augment with authentication information.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-Promise&lt;void&gt;
-
-## Exceptions
-
-Error: The authenticate method was not implemented by a subclass.
-

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

@@ -1,19 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
-
-## Authenticator.authenticationType() method
-
-Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
-
-**Signature:**
-
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-
-string
-
-a string that indicates the authenticator's type
-

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

@@ -1,13 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
-
-## Authenticator.AUTHTYPE\_BASIC property
-
-Constants that define the various authenticator types.
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_BASIC: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
-
-## Authenticator.AUTHTYPE\_BEARERTOKEN property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_BEARERTOKEN: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
-
-## Authenticator.AUTHTYPE\_CONTAINER property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_CONTAINER: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
-
-## Authenticator.AUTHTYPE\_CP4D property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_CP4D: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
-
-## Authenticator.AUTHTYPE\_IAM property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_IAM: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
-
-## Authenticator.AUTHTYPE\_MCSP property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_MCSP: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
-
-## Authenticator.AUTHTYPE\_NOAUTH property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_NOAUTH: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
-
-## Authenticator.AUTHTYPE\_UNKNOWN property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_UNKNOWN: string;
-```

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

@@ -1,11 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)
-
-## Authenticator.AUTHTYPE\_VPC property
-
-**Signature:**
-
-```typescript
-static AUTHTYPE_VPC: string;
-```

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

@@ -1,294 +0,0 @@
-<!-- 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; [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
-
-## Authenticator class
-
-Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.
-
-**Signature:**
-
-```typescript
-export declare class Authenticator implements AuthenticatorInterface 
-```
-**Implements:** [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new Authenticator instance.
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Constants that define the various authenticator types.
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Augment the request with authentication information.
-
-
-</td></tr>
-<tr><td>
-
-[authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
-
-
-</td></tr>
-</tbody></table>