@trayio/commons 1.10.0 → 1.11.0

package/dist/error/Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/error/Error.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,KAQvC,CAAC"}
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/error/Error.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,KASvC,CAAC"}

package/dist/file/File.d.ts

@@ -1,13 +1,14 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
 import { TaskEither } from 'fp-ts/TaskEither';
 import * as t from 'io-ts';
 export type FileMetadata = {
     key: string;
-    size: number;
 };
 export declare const fileMetadataDescriptor: t.Type<FileMetadata, unknown>;
 export type File = {
     metadata: FileMetadata;
-    content: ArrayBuffer;
+    content: Readable;
 };
 export interface FileStorage {
     write(file: File): TaskEither<Error, undefined>;

package/dist/file/File.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../src/file/File.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,MAAM,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAMhE,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IAClB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF,MAAM,WAAW,WAAW;IAC3B,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;CAClD"}
+{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../src/file/File.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,MAAM,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAKhE,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IAClB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,QAAQ,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,WAAW;IAC3B,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;CAClD"}

package/dist/file/File.js

@@ -27,5 +27,4 @@ exports.fileMetadataDescriptor = void 0;
 const t = __importStar(require("io-ts"));
 exports.fileMetadataDescriptor = t.type({
     key: t.string,
-    size: t.number,
 }, 'FileMetadata');

package/dist/file/FileStorage.abstract.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FileStorage.abstract.test.d.ts","sourceRoot":"","sources":["../../src/file/FileStorage.abstract.test.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAQ,MAAM,QAAQ,CAAC;AAE3C,eAAO,MAAM,eAAe,gBAAiB,WAAW,SAiDvD,CAAC"}
+{"version":3,"file":"FileStorage.abstract.test.d.ts","sourceRoot":"","sources":["../../src/file/FileStorage.abstract.test.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAQ,MAAM,QAAQ,CAAC;AAE3C,eAAO,MAAM,eAAe,gBAAiB,WAAW,SAyEvD,CAAC"}

package/dist/file/FileStorage.abstract.test.js

@@ -35,6 +35,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fileStorageTest = void 0;
 const E = __importStar(require("fp-ts/Either"));
 const uuid_1 = require("uuid");
+const stream_1 = require("stream");
 const JsonSerialization_1 = require("../serialization/JsonSerialization");
 const fileStorageTest = (fileStorage) => {
     describe('FileStorage Tests', () => {
@@ -42,13 +43,18 @@ const fileStorageTest = (fileStorage) => {
             describe("when it's successful", () => {
                 it('should write a file, read the file then delete the file', () => __awaiter(void 0, void 0, void 0, function* () {
                     const serialization = new JsonSerialization_1.JsonSerialization();
-                    const fileContent = Buffer.from(serialization.serialize({ test: 'someValue' }));
+                    const fileContent = { test: 'someValue' };
+                    const readableStream = new stream_1.Readable({
+                        read() {
+                            this.push(Buffer.from(serialization.serialize(fileContent)));
+                            this.push(null);
+                        },
+                    });
                     const file = {
                         metadata: {
                             key: `test-${(0, uuid_1.v4)()}.json`,
-                            size: fileContent.byteLength,
                         },
-                        content: fileContent,
+                        content: readableStream,
                     };
                     const writtenFile = yield fileStorage.write(file)();
                     expect(writtenFile).toEqual(E.right(undefined));
@@ -56,7 +62,20 @@ const fileStorageTest = (fileStorage) => {
                     const readResponse = E.getOrElse(() => {
                         throw new Error('Expected right');
                     })(read);
-                    expect(fileContent).toEqual(readResponse.content);
+                    let data = '';
+                    yield new Promise((resolve) => {
+                        readResponse.content.on('data', (chunk) => {
+                            data += chunk;
+                        });
+                        readResponse.content.on('end', () => {
+                            resolve(undefined);
+                        });
+                    });
+                    const deserializedData = serialization.deserialize(Buffer.from(data));
+                    if (E.isLeft(deserializedData)) {
+                        throw new Error('failed to deserialise stream contents');
+                    }
+                    expect(deserializedData.right).toStrictEqual(fileContent);
                     const deleted = yield fileStorage.delete(file.metadata.key)();
                     expect(deleted).toEqual(E.right(undefined));
                 }));

package/dist/file/NodeFsFileStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NodeFsFileStorage.d.ts","sourceRoot":"","sources":["../../src/file/NodeFsFileStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAG3C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAG3C,qBAAa,iBAAkB,YAAW,WAAW;IACxC,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,MAAe;IAE7C,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAalD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAkB7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;CAWpD"}
+{"version":3,"file":"NodeFsFileStorage.d.ts","sourceRoot":"","sources":["../../src/file/NodeFsFileStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAG3C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAG3C,qBAAa,iBAAkB,YAAW,WAAW;IACxC,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,MAAe;IAE7C,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAalD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAgB7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;CAWpD"}

package/dist/file/NodeFsFileStorage.integration.test.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const FileStorage_abstract_test_1 = require("@trayio/commons/src/file/FileStorage.abstract.test");
+const FileStorage_abstract_test_1 = require("./FileStorage.abstract.test");
 const NodeFsFileStorage_1 = require("./NodeFsFileStorage");
 (0, FileStorage_abstract_test_1.fileStorageTest)(new NodeFsFileStorage_1.NodeFsFileStorage());

package/dist/file/NodeFsFileStorage.js

@@ -22,6 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeFsFileStorage = void 0;
 const TE = __importStar(require("fp-ts/lib/TaskEither"));
@@ -34,19 +43,19 @@ class NodeFsFileStorage {
     }
     write(file) {
         const path = `${this.basePath}/${file.metadata.key}`;
-        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.writeFile(path, Buffer.from(file.content)));
+        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.writeFile(path, file.content));
         return (0, function_1.pipe)(result, TE.map(() => undefined));
     }
     read(key) {
         const filePath = `${this.basePath}/${key}`;
-        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.readFile(filePath));
-        return (0, function_1.pipe)(result, TE.map((content) => ({
-            metadata: {
+        return TE.tryCatch(() => __awaiter(this, void 0, void 0, function* () {
+            const fileHandle = yield fs.open(filePath, 'r');
+            const stream = fileHandle.createReadStream();
+            const metadata = {
                 key,
-                size: content.byteLength,
-            },
-            content,
-        })));
+            };
+            return { metadata, content: stream };
+        }), (reason) => new Error(String(reason)));
     }
     delete(key) {
         const filePath = `${this.basePath}/${key}`;

package/dist/http/HttpClient.abstract.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpClient.abstract.test.d.ts","sourceRoot":"","sources":["../../src/http/HttpClient.abstract.test.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,wBAAgB,cAAc,CAAC,UAAU,EAAE,UAAU,QAgdpD"}
+{"version":3,"file":"HttpClient.abstract.test.d.ts","sourceRoot":"","sources":["../../src/http/HttpClient.abstract.test.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,wBAAgB,cAAc,CAAC,UAAU,EAAE,UAAU,QAwcpD"}

package/dist/http/HttpClient.abstract.test.js

@@ -37,6 +37,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.httpClientTest = void 0;
 const E = __importStar(require("fp-ts/Either"));
+const stream_1 = require("stream");
 const function_1 = require("fp-ts/function");
 const t = __importStar(require("io-ts"));
 const http_1 = require("http");
@@ -62,7 +63,6 @@ function httpClientTest(httpClient) {
         fields: t.record(t.string, t.string),
         files: t.record(t.string, t.type({
             key: t.string,
-            size: t.number,
         })),
     }));
     const testInputCodec = TypeCodec_1.TypeCodec.fromDescriptor(t.type({
@@ -137,7 +137,6 @@ function httpClientTest(httpClient) {
         var _a;
         return ({
             key: (_a = file.originalFilename) !== null && _a !== void 0 ? _a : '',
-            size: file.size,
         });
     };
     const requestListener = (req, res) => __awaiter(this, void 0, void 0, function* () {
@@ -236,16 +235,14 @@ function httpClientTest(httpClient) {
             const file1 = yield fileStorage.write({
                 metadata: {
                     key: 'file1',
-                    size: 123,
                 },
-                content: Buffer.from('file 1 content'),
+                content: stream_1.Readable.from('file 1 content'),
             })();
             const file2 = yield fileStorage.write({
                 metadata: {
                     key: 'file2',
-                    size: 456,
                 },
-                content: Buffer.from('file 2 content'),
+                content: stream_1.Readable.from('file 2 content'),
             })();
             if (file1._tag === 'Left') {
                 throw file1.left;
@@ -261,11 +258,9 @@ function httpClientTest(httpClient) {
                 files: {
                     file1: {
                         key: 'file1',
-                        size: 123,
                     },
                     file2: {
                         key: 'file2',
-                        size: 456,
                     },
                 },
             };
@@ -284,11 +279,9 @@ function httpClientTest(httpClient) {
                 files: expect.objectContaining({
                     file1: expect.objectContaining({
                         key: 'file1',
-                        size: expect.any(Number),
                     }),
                     file2: expect.objectContaining({
                         key: 'file2',
-                        size: expect.any(Number),
                     }),
                 }),
             })));

package/package.json

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