ibm-cloud-sdk-core 2.17.14 → 3.0.1

package/CHANGELOG.md

@@ -1,3 +1,34 @@
+## [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)
+
+
+### Bug Fixes
+
+* ensure dist/docs is a directory during build ([#202](https://github.com/IBM/node-sdk-core/issues/202)) ([1b3ef62](https://github.com/IBM/node-sdk-core/commit/1b3ef621e3cbfe0586d433269f63acf77dfa7251))
+
 ## [2.17.14](https://github.com/IBM/node-sdk-core/compare/v2.17.13...v2.17.14) (2022-05-02)
 
 

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.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 → 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,
@@ -1280,16 +1262,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -1300,7 +1273,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1639,11 +1612,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 +1637,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 7
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -2589,8 +2575,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Buffer",
-              "canonicalReference": "!Buffer:interface"
+              "text": "FileObject",
+              "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
             },
             {
               "kind": "Content",
@@ -2607,8 +2593,8 @@
             },
             {
               "kind": "Reference",
-              "text": "FileObject",
-              "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
+              "text": "Buffer",
+              "canonicalReference": "!Buffer:interface"
             },
             {
               "kind": "Content",
@@ -3185,9 +3171,14 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
             {
               "kind": "Content",
-              "text": "string"
+              "text": "<string>"
             },
             {
               "kind": "Content",
@@ -3196,7 +3187,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 5,
-            "endIndex": 6
+            "endIndex": 7
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -5892,16 +5883,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -5912,7 +5894,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/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

package/es/lib/helper.js

@@ -13,11 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import fileType from 'file-type';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { isReadable } from 'isstream';
 import { lookup } from 'mime-types';
 import { basename } from 'path';
 import logger from './logger';
+const FileType = require('file-type');
 // custom type guards
 function isFileObject(obj) {
     return Boolean(obj && obj.value);
@@ -40,17 +49,19 @@ export function isEmptyObject(obj) {
  * @returns {string} the content type of the input.
  */
 export function getContentType(inputData) {
-    let contentType = null;
-    if (isFileStream(inputData)) {
-        // if the inputData is a NodeJS.ReadableStream
-        const mimeType = lookup(inputData.path); // TODO: cleue quick hack, per type definition path could also be a Buffer
-        contentType = { mime: mimeType || null };
-    }
-    else if (Buffer.isBuffer(inputData)) {
-        // if the inputData is a Buffer
-        contentType = fileType(inputData);
-    }
-    return contentType ? contentType.mime : null;
+    return __awaiter(this, void 0, void 0, function* () {
+        let contentType = null;
+        if (isFileStream(inputData)) {
+            // if the inputData is a NodeJS.ReadableStream
+            const mimeType = lookup(inputData.path); // TODO: cleue quick hack, per type definition path could also be a Buffer
+            contentType = { mime: mimeType || null };
+        }
+        else if (Buffer.isBuffer(inputData)) {
+            // if the inputData is a Buffer
+            contentType = yield FileType.fromBuffer(inputData);
+        }
+        return contentType ? contentType.mime : null;
+    });
 }
 /**
  *
@@ -198,44 +209,47 @@ export function getFormat(params, formats) {
  * @returns {FileObject}
  */
 export function buildRequestFileObject(fileParam) {
-    let fileObj;
-    if (isFileObject(fileParam.data)) {
-        // For backward compatibility, we allow the data to be a FileObject.
-        fileObj = { value: fileParam.data.value, options: {} };
-        if (fileParam.data.options) {
-            fileObj.options = {
-                filename: fileParam.filename || fileParam.data.options.filename,
-                contentType: fileParam.contentType || fileParam.data.options.contentType,
+    return __awaiter(this, void 0, void 0, function* () {
+        let fileObj;
+        if (isFileObject(fileParam.data)) {
+            // For backward compatibility, we allow the data to be a FileObject.
+            fileObj = { value: fileParam.data.value, options: {} };
+            if (fileParam.data.options) {
+                fileObj.options = {
+                    filename: fileParam.filename || fileParam.data.options.filename,
+                    contentType: fileParam.contentType || fileParam.data.options.contentType,
+                };
+            }
+        }
+        else {
+            fileObj = {
+                value: fileParam.data,
+                options: {
+                    filename: fileParam.filename,
+                    contentType: fileParam.contentType,
+                },
             };
         }
-    }
-    else {
-        fileObj = {
-            value: fileParam.data,
-            options: {
-                filename: fileParam.filename,
-                contentType: fileParam.contentType,
-            },
-        };
-    }
-    // Also for backward compatibility, we allow data to be a string
-    if (typeof fileObj.value === 'string') {
-        fileObj.value = Buffer.from(fileObj.value);
-    }
-    // build filename
-    // eslint-disable-next-line prefer-destructuring
-    let filename = fileObj.options.filename;
-    if (!filename && isFileStream(fileObj.value)) {
-        // if readable stream with path property
-        filename = fileObj.value.path;
-    }
-    // toString handles the case when path is a buffer
-    fileObj.options.filename = filename ? basename(filename.toString()) : '_';
-    // build contentType
-    if (!fileObj.options.contentType && isFileData(fileObj.value)) {
-        fileObj.options.contentType = getContentType(fileObj.value) || 'application/octet-stream';
-    }
-    return fileObj;
+        // Also for backward compatibility, we allow data to be a string
+        if (typeof fileObj.value === 'string') {
+            fileObj.value = Buffer.from(fileObj.value);
+        }
+        // build filename
+        // eslint-disable-next-line prefer-destructuring
+        let filename = fileObj.options.filename;
+        if (!filename && isFileStream(fileObj.value)) {
+            // if readable stream with path property
+            filename = fileObj.value.path;
+        }
+        // toString handles the case when path is a buffer
+        fileObj.options.filename = filename ? basename(filename.toString()) : '_';
+        // build contentType
+        if (!fileObj.options.contentType && isFileData(fileObj.value)) {
+            fileObj.options.contentType =
+                (yield getContentType(fileObj.value)) || 'application/octet-stream';
+        }
+        return fileObj;
+    });
 }
 /**
  * This function converts an object's keys to lower case.

package/es/lib/request-wrapper.js

@@ -135,14 +135,14 @@ export class RequestWrapper {
                     // Skip keys with undefined/null values or empty object value
                     values
                         .filter((v) => v != null && !isEmptyObject(v))
-                        .forEach((value) => {
+                        .forEach((value) => __awaiter(this, void 0, void 0, function* () {
                         // Special case of empty file object
                         if (Object.prototype.hasOwnProperty.call(value, 'contentType') &&
                             !Object.prototype.hasOwnProperty.call(value, 'data')) {
                             return;
                         }
                         if (isFileWithMetadata(value)) {
-                            const fileObj = buildRequestFileObject(value);
+                            const fileObj = yield buildRequestFileObject(value);
                             multipartForm.append(key, fileObj.value, fileObj.options);
                         }
                         else {
@@ -151,7 +151,7 @@ export class RequestWrapper {
                             }
                             multipartForm.append(key, value);
                         }
-                    });
+                    }));
                 });
             }
             // Path params