@trayio/commons 4.62.0 → 4.63.0

package/dist/buffer/BufferExtensions.d.ts

@@ -2,7 +2,7 @@
 import { Readable } from 'stream';
 import * as TE from 'fp-ts/TaskEither';
 export interface BufferExtensionsInterface {
-    readableToArrayBuffer: (stream: Readable) => TE.TaskEither<Error, ArrayBuffer>;
+    readableToArrayBuffer: (stream: Readable, size?: number) => TE.TaskEither<Error, ArrayBuffer>;
     arrayBufferToReadable: (arrayBuffer: ArrayBuffer) => Readable;
 }
 export declare const BufferExtensions: BufferExtensionsInterface;

package/dist/buffer/BufferExtensions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BufferExtensions.d.ts","sourceRoot":"","sources":["../../src/buffer/BufferExtensions.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,MAAM,WAAW,yBAAyB;IACzC,qBAAqB,EAAE,CACtB,MAAM,EAAE,QAAQ,KACZ,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACvC,qBAAqB,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,QAAQ,CAAC;CAC9D;AAED,eAAO,MAAM,gBAAgB,EAAE,yBAiB9B,CAAC"}
+{"version":3,"file":"BufferExtensions.d.ts","sourceRoot":"","sources":["../../src/buffer/BufferExtensions.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,MAAM,WAAW,yBAAyB;IACzC,qBAAqB,EAAE,CACtB,MAAM,EAAE,QAAQ,EAChB,IAAI,CAAC,EAAE,MAAM,KACT,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACvC,qBAAqB,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,QAAQ,CAAC;CAC9D;AAED,eAAO,MAAM,gBAAgB,EAAE,yBAsB9B,CAAC"}

package/dist/buffer/BufferExtensions.js

@@ -27,12 +27,17 @@ exports.BufferExtensions = void 0;
 const stream_1 = require("stream");
 const TE = __importStar(require("fp-ts/TaskEither"));
 exports.BufferExtensions = {
-    readableToArrayBuffer: (stream) => TE.tryCatch(async () => {
+    readableToArrayBuffer: (stream, size) => TE.tryCatch(async () => {
         const chunks = [];
         for await (const chunk of stream) {
             chunks.push(chunk);
+            if (size && chunks.length > size)
+                break;
         }
         const buffer = Buffer.concat(chunks);
+        if (size) {
+            return Uint8Array.from(buffer).buffer.slice(0, size);
+        }
         return Uint8Array.from(buffer).buffer;
     }, (error) => error),
     arrayBufferToReadable: (arrayBuffer) => stream_1.Readable.from(Buffer.from(arrayBuffer)),

package/dist/buffer/BufferExtensions.unit.test.js

@@ -35,4 +35,28 @@ describe('Buffer Tests', () => {
         })(bufferResult);
         expect(buffer).toEqual(new util_1.TextEncoder().encode('test').buffer);
     });
+    it('should collect the initial bytes of the stream if size is passed', async () => {
+        const readableStream = BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new util_1.TextEncoder().encode('test').buffer);
+        const bufferResult = await BufferExtensions_1.BufferExtensions.readableToArrayBuffer(readableStream, 2)();
+        const buffer = E.getOrElse((error) => {
+            throw new Error(error.message);
+        })(bufferResult);
+        expect(buffer).toEqual(new util_1.TextEncoder().encode('te').buffer);
+    });
+    it('should collect the entire bytes of the stream if size is smaller than buffer', async () => {
+        const readableStream = BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new util_1.TextEncoder().encode('test').buffer);
+        const bufferResult = await BufferExtensions_1.BufferExtensions.readableToArrayBuffer(readableStream, 100000)();
+        const buffer = E.getOrElse((error) => {
+            throw new Error(error.message);
+        })(bufferResult);
+        expect(buffer).toEqual(new util_1.TextEncoder().encode('test').buffer);
+    });
+    it('should return 0 bytes of the stream if size is 0', async () => {
+        const readableStream = BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new util_1.TextEncoder().encode('test').buffer);
+        const bufferResult = await BufferExtensions_1.BufferExtensions.readableToArrayBuffer(readableStream, 0)();
+        const buffer = E.getOrElse((error) => {
+            throw new Error(error.message);
+        })(bufferResult);
+        expect(buffer).toEqual(new util_1.TextEncoder().encode('').buffer);
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/commons",
-  "version": "4.62.0",
+  "version": "4.63.0",
   "description": "Extensions to the standard/core libraries and basic features",
   "exports": {
     "./*": "./dist/*.js"