ibm-cloud-sdk-core 2.17.15 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,34 @@
+# [3.1.0](https://github.com/IBM/node-sdk-core/compare/v3.0.1...v3.1.0) (2022-07-28)
+
+
+### Features
+
+* add `setDefaultHeaders` method on base service class ([#207](https://github.com/IBM/node-sdk-core/issues/207)) ([29bec13](https://github.com/IBM/node-sdk-core/commit/29bec13b67ea08071be488af62b919899f21ec50))
+
+## [3.0.1](https://github.com/IBM/node-sdk-core/compare/v3.0.0...v3.0.1) (2022-07-28)
+
+
+### Bug Fixes
+
+* correct AuthenticatorInterface type ([#206](https://github.com/IBM/node-sdk-core/issues/206)) ([31dc7bd](https://github.com/IBM/node-sdk-core/commit/31dc7bd1e744a071cdabc2b5bf1e9513024079ac)), closes [#176](https://github.com/IBM/node-sdk-core/issues/176)
+
+# [3.0.0](https://github.com/IBM/node-sdk-core/compare/v2.17.15...v3.0.0) (2022-07-28)
+
+
+### Bug Fixes
+
+* update file-type to resolve vulnerability ([#205](https://github.com/IBM/node-sdk-core/issues/205)) ([843e66d](https://github.com/IBM/node-sdk-core/commit/843e66d10aeb43dc5a0f7c9583f93ce6a5dbaa7e)), closes [#204](https://github.com/IBM/node-sdk-core/issues/204)
+
+
+### BREAKING CHANGES
+
+* two synchronous public functions are now asynchronous
+
+The function `getContentType` formerly returned a string but now returns a
+Promise that resolves to a string. The function `buildRequestFileObject`
+formerly returned a `FileObject` but now returns a Promise that resolves to
+a `FileObject`.
+
 ## [2.17.15](https://github.com/IBM/node-sdk-core/compare/v2.17.14...v2.17.15) (2022-07-05)
 
 

package/auth/authenticators/authenticator-interface.d.ts

@@ -38,7 +38,7 @@ export interface AuthenticatorInterface {
      * @param {object.<string, string>} requestOptions.headers The headers the
      *   authentication information will be added to.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Returns a string that indicates the authentication type.
      */

package/auth/authenticators/authenticator.d.ts

@@ -46,7 +46,7 @@ export declare class Authenticator implements AuthenticatorInterface {
      * @throws {Error} - The authenticate method was not implemented by a
      *   subclass.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Retrieves the authenticator's type.
      * The returned value will be the same string that is used

package/auth/authenticators/basic-authenticator.d.ts

@@ -55,7 +55,7 @@ export declare class BasicAuthenticator extends Authenticator {
      * @param {object.<string, string>} requestOptions.headers - The headers the
      *   authentication information will be added too.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Returns the authenticator's type ('basic').
      *

package/auth/authenticators/token-request-based-authenticator.d.ts

@@ -87,5 +87,5 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
      *   authentication information will be added too. Overrides default headers
      *   where there's conflict.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 }

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

@@ -9,7 +9,7 @@ Augment the request with authentication information.
 <b>Signature:</b>
 
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
 
 <b>Returns:</b>
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 
 ## Exceptions
 

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

@@ -9,7 +9,7 @@ Add authentication information to the specified request.
 <b>Signature:</b>
 
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
 
 <b>Returns:</b>
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 

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

@@ -38,6 +38,7 @@ export declare class BaseService
 |  [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. |
 |  [getHttpClient()](./ibm-cloud-sdk-core.baseservice.gethttpclient.md) |  | Get the Axios instance set on the service. All requests will be made using this instance. |
+|  [setDefaultHeaders(headers)](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md) |  | Set the HTTP headers to be sent in every request. |
 |  [setEnableGzipCompression(setting)](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md) |  | Turn request body compression on or off. |
 |  [setServiceUrl(url)](./ibm-cloud-sdk-core.baseservice.setserviceurl.md) |  | Set the service URL to send requests to. |
 

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

@@ -0,0 +1,24 @@
+<!-- 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; [setDefaultHeaders](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md)
+
+## BaseService.setDefaultHeaders() method
+
+Set the HTTP headers to be sent in every request.
+
+<b>Signature:</b>
+
+```typescript
+setDefaultHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headers | OutgoingHttpHeaders | The map of headers to include in requests. |
+
+<b>Returns:</b>
+
+void
+

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

@@ -11,7 +11,7 @@ Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
 <b>Signature:</b>
 
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
 
 ## Parameters
@@ -22,5 +22,5 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
 
 <b>Returns:</b>
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 

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

@@ -9,7 +9,7 @@ This function builds a `form-data` object for each file parameter.
 <b>Signature:</b>
 
 ```typescript
-export declare function buildRequestFileObject(fileParam: FileWithMetadata): FileObject;
+export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ export declare function buildRequestFileObject(fileParam: FileWithMetadata): Fil
 
 <b>Returns:</b>
 
-[FileObject](./ibm-cloud-sdk-core.fileobject.md)
+Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;
 
 {<!-- -->FileObject<!-- -->}
 

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

@@ -8,7 +8,7 @@
 
 ```typescript
 _default: {
-    fromFilename: (file: String | File | Buffer | NodeJS.ReadableStream | FileObject) => string;
+    fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
     fromHeader: (buffer: Buffer) => string;
 }
 ```

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

@@ -9,7 +9,7 @@ This function retrieves the content type of the input.
 <b>Signature:</b>
 
 ```typescript
-export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): string;
+export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer
 
 <b>Returns:</b>
 
-string
+Promise&lt;string&gt;
 
 {<!-- -->string<!-- -->} the content type of the input.
 

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

@@ -11,7 +11,7 @@ Authorization: Bearer <bearer-token>
 <b>Signature:</b>
 
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
 
 ## Parameters
@@ -22,5 +22,5 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
 
 <b>Returns:</b>
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 

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

@@ -350,16 +350,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -370,7 +361,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -677,16 +668,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -696,7 +678,7 @@
               "isOptional": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1106,6 +1088,53 @@
               "parameters": [],
               "name": "getHttpClient"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)",
+              "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - The map of headers to include in requests.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDefaultHeaders(headers: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OutgoingHttpHeaders",
+                  "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "headers",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "setDefaultHeaders"
+            },
             {
               "kind": "Method",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService#setEnableGzipCompression:member(1)",
@@ -1280,16 +1309,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -1300,7 +1320,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1639,11 +1659,24 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
             {
               "kind": "Reference",
               "text": "FileObject",
               "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
             },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
             {
               "kind": "Content",
               "text": ";"
@@ -1651,7 +1684,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 7
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -2589,8 +2622,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Buffer",
-              "canonicalReference": "!Buffer:interface"
+              "text": "FileObject",
+              "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
             },
             {
               "kind": "Content",
@@ -2607,8 +2640,8 @@
             },
             {
               "kind": "Reference",
-              "text": "FileObject",
-              "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
+              "text": "Buffer",
+              "canonicalReference": "!Buffer:interface"
             },
             {
               "kind": "Content",
@@ -3185,9 +3218,14 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
             {
               "kind": "Content",
-              "text": "string"
+              "text": "<string>"
             },
             {
               "kind": "Content",
@@ -3196,7 +3234,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 5,
-            "endIndex": 6
+            "endIndex": 7
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -5892,16 +5930,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -5912,7 +5941,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,

package/es/auth/authenticators/authenticator-interface.d.ts

@@ -38,7 +38,7 @@ export interface AuthenticatorInterface {
      * @param {object.<string, string>} requestOptions.headers The headers the
      *   authentication information will be added to.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Returns a string that indicates the authentication type.
      */

package/es/auth/authenticators/authenticator.d.ts

@@ -46,7 +46,7 @@ export declare class Authenticator implements AuthenticatorInterface {
      * @throws {Error} - The authenticate method was not implemented by a
      *   subclass.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Retrieves the authenticator's type.
      * The returned value will be the same string that is used

package/es/auth/authenticators/basic-authenticator.d.ts

@@ -55,7 +55,7 @@ export declare class BasicAuthenticator extends Authenticator {
      * @param {object.<string, string>} requestOptions.headers - The headers the
      *   authentication information will be added too.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Returns the authenticator's type ('basic').
      *

package/es/auth/authenticators/token-request-based-authenticator.d.ts

@@ -87,5 +87,5 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
      *   authentication information will be added too. Overrides default headers
      *   where there's conflict.
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 }

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

@@ -87,6 +87,12 @@ export declare class BaseService {
      * @param {string} url The base URL for the service.
      */
     setServiceUrl(url: string): void;
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     /**
      * Turn request body compression on or off.
      *

package/es/lib/base-service.js

@@ -90,6 +90,18 @@ export class BaseService {
             this.baseOptions.serviceUrl = stripTrailingSlash(url);
         }
     }
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    setDefaultHeaders(headers) {
+        if (typeof headers !== 'object') {
+            // do nothing, for now
+            return;
+        }
+        this.baseOptions.headers = headers;
+    }
     /**
      * Turn request body compression on or off.
      *

package/es/lib/content-type.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { FileObject } from "./helper";
 declare const _default: {
-    fromFilename: (file: String | File | Buffer | NodeJS.ReadableStream | FileObject) => string;
+    fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
     fromHeader: (buffer: Buffer) => string;
 };
 export default _default;

package/es/lib/helper.d.ts

@@ -38,7 +38,7 @@ export declare function isEmptyObject(obj: any): boolean;
  * @param {NodeJS.ReadableStream|Buffer} inputData - The data to retrieve content type for.
  * @returns {string} the content type of the input.
  */
-export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): string;
+export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
 /**
  *
  * @param {string} url - the url string.
@@ -104,7 +104,7 @@ export declare function getFormat(params: {
  * @param {string} fileParam.contentType The content type of the file.
  * @returns {FileObject}
  */
-export declare function buildRequestFileObject(fileParam: FileWithMetadata): FileObject;
+export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
 /**
  * This function converts an object's keys to lower case.
  * note: does not convert nested keys