ibm-cloud-sdk-core 2.17.3 → 2.17.4

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.17.4](https://github.com/IBM/node-sdk-core/compare/v2.17.3...v2.17.4) (2021-12-16)
+
+
+### Bug Fixes
+
+* don't always convert bytes to text in streamToPromise ([#182](https://github.com/IBM/node-sdk-core/issues/182)) ([7fe261b](https://github.com/IBM/node-sdk-core/commit/7fe261b20f934cd3fde45acc69b9d4888836aa69))
+
 ## [2.17.3](https://github.com/IBM/node-sdk-core/compare/v2.17.2...v2.17.3) (2021-12-13)
 
 

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

@@ -54,7 +54,7 @@
 |  [readCrTokenFile(filepath)](./ibm-cloud-sdk-core.readcrtokenfile.md) |  |
 |  [readExternalSources(serviceName)](./ibm-cloud-sdk-core.readexternalsources.md) | Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.<!-- -->Only one source will be used at a time. |
 |  [removeSuffix(str, suffix)](./ibm-cloud-sdk-core.removesuffix.md) | Remove a given suffix if it exists. |
-|  [streamToPromise(stream)](./ibm-cloud-sdk-core.streamtopromise.md) | Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text Essentially a smaller version of concat-stream wrapped in a promise |
+|  [streamToPromise(stream)](./ibm-cloud-sdk-core.streamtopromise.md) | Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise |
 |  [stripTrailingSlash(url)](./ibm-cloud-sdk-core.striptrailingslash.md) |  |
 |  [toLowerKeys(obj)](./ibm-cloud-sdk-core.tolowerkeys.md) | This function converts an object's keys to lower case. note: does not convert nested keys |
 |  [validateInput(options, requiredOptions)](./ibm-cloud-sdk-core.validateinput.md) |  |

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

@@ -4,7 +4,7 @@
 
 ## streamToPromise() function
 
-Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text Essentially a smaller version of concat-stream wrapped in a promise
+Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise
 
 <b>Signature:</b>
 

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

@@ -5139,7 +5139,7 @@
         {
           "kind": "Function",
           "canonicalReference": "ibm-cloud-sdk-core!streamToPromise:function(1)",
-          "docComment": "/**\n * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - Optional stream param for when not bound to an existing stream instance.  @return {Promise}\n */\n",
+          "docComment": "/**\n * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - Optional stream param for when not bound to an existing stream instance.  @return {Promise}\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/es/lib/request-wrapper.js

@@ -360,7 +360,8 @@ export class RequestWrapper {
             let reqBuffer;
             try {
                 if (isStream(data)) {
-                    reqBuffer = Buffer.from(yield streamToPromise(data));
+                    const streamData = yield streamToPromise(data);
+                    reqBuffer = Buffer.isBuffer(streamData) ? streamData : Buffer.from(streamData);
                 }
                 else if (data.toString && data.toString() !== '[object Object]' && !Array.isArray(data)) {
                     // this handles pretty much any primitive that isnt a JSON object or array

package/es/lib/stream-to-promise.d.ts

@@ -16,7 +16,8 @@
 /// <reference types="node" />
 import { Stream } from 'stream';
 /**
- * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text
+ * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
+ * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
  * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.

package/es/lib/stream-to-promise.js

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 /**
- * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text
+ * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
+ * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
  * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.
@@ -29,7 +30,7 @@ export function streamToPromise(stream) {
             results.push(result);
         })
             .on('end', () => {
-            resolve(Buffer.isBuffer(results[0]) ? Buffer.concat(results).toString() : results);
+            resolve(Buffer.isBuffer(results[0]) ? Buffer.concat(results) : results);
         })
             .on('error', reject);
     });

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

@@ -1228,7 +1228,8 @@ export declare class BaseService {
                                         }
 
                                         /**
-                                         * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text
+                                         * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
+                                         * or array of text chunks
                                          * Essentially a smaller version of concat-stream wrapped in a promise
                                          *
                                          * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.

package/lib/request-wrapper.js

@@ -411,22 +411,22 @@ var RequestWrapper = /** @class */ (function () {
     };
     RequestWrapper.prototype.gzipRequestBody = function (data, headers) {
         return __awaiter(this, void 0, void 0, function () {
-            var contentSetToGzip, reqBuffer, _a, _b, err_1;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var contentSetToGzip, reqBuffer, streamData, err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
                         contentSetToGzip = headers['Content-Encoding'] && headers['Content-Encoding'].toString().includes('gzip');
                         if (!data || contentSetToGzip) {
                             return [2 /*return*/, data];
                         }
-                        _c.label = 1;
+                        _a.label = 1;
                     case 1:
-                        _c.trys.push([1, 5, , 6]);
+                        _a.trys.push([1, 5, , 6]);
                         if (!isstream_1.default(data)) return [3 /*break*/, 3];
-                        _b = (_a = Buffer).from;
                         return [4 /*yield*/, stream_to_promise_1.streamToPromise(data)];
                     case 2:
-                        reqBuffer = _b.apply(_a, [_c.sent()]);
+                        streamData = _a.sent();
+                        reqBuffer = Buffer.isBuffer(streamData) ? streamData : Buffer.from(streamData);
                         return [3 /*break*/, 4];
                     case 3:
                         if (data.toString && data.toString() !== '[object Object]' && !Array.isArray(data)) {
@@ -436,10 +436,10 @@ var RequestWrapper = /** @class */ (function () {
                         else {
                             reqBuffer = Buffer.from(JSON.stringify(data));
                         }
-                        _c.label = 4;
+                        _a.label = 4;
                     case 4: return [3 /*break*/, 6];
                     case 5:
-                        err_1 = _c.sent();
+                        err_1 = _a.sent();
                         logger_1.default.error('Error converting request body to a buffer - data will not be compressed.');
                         logger_1.default.debug(err_1);
                         return [2 /*return*/, data];

package/lib/stream-to-promise.d.ts

@@ -16,7 +16,8 @@
 /// <reference types="node" />
 import { Stream } from 'stream';
 /**
- * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text
+ * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
+ * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
  * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.

package/lib/stream-to-promise.js

@@ -16,7 +16,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text
+ * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
+ * or array of text chunks
  * Essentially a smaller version of concat-stream wrapped in a promise
  *
  * @param {Stream} stream Optional stream param for when not bound to an existing stream instance.
@@ -31,7 +32,7 @@ function streamToPromise(stream) {
             results.push(result);
         })
             .on('end', function () {
-            resolve(Buffer.isBuffer(results[0]) ? Buffer.concat(results).toString() : results);
+            resolve(Buffer.isBuffer(results[0]) ? Buffer.concat(results) : results);
         })
             .on('error', reject);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "2.17.3",
+  "version": "2.17.4",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "module": "./es/index.js",

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

@@ -5139,7 +5139,7 @@
         {
           "kind": "Function",
           "canonicalReference": "ibm-cloud-sdk-core!streamToPromise:function(1)",
-          "docComment": "/**\n * Helper method that can be bound to a stream - it sets the output to utf-8, captures all of the results, and returns a promise that resolves to the final text Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - Optional stream param for when not bound to an existing stream instance.  @return {Promise}\n */\n",
+          "docComment": "/**\n * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise\n *\n * @param stream - Optional stream param for when not bound to an existing stream instance.  @return {Promise}\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",