@trayio/commons 4.42.0 → 4.44.0

package/dist/file/NodeFsFileStorage.d.ts

@@ -1,11 +1,13 @@
 /// <reference types="node" />
 import * as TE from 'fp-ts/lib/TaskEither';
 import { Dirent } from 'fs';
+import * as O from 'fp-ts/Option';
 import { File, FileStorage, SharedUrl } from './File';
+import { DynamicObject } from '../dynamictype/DynamicType';
 export declare class NodeFsFileStorage implements FileStorage {
     private basePath;
     constructor(basePath?: string);
-    write(file: File): TE.TaskEither<Error, File>;
+    write(file: File, writeOptions?: O.Option<DynamicObject>): TE.TaskEither<Error, File>;
     read(key: string, name?: string): TE.TaskEither<Error, File>;
     getSharedUrl(key: string): TE.TaskEither<Error, SharedUrl>;
     delete(key: string): TE.TaskEither<Error, undefined>;

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

@@ -1 +1 @@
-{"version":3,"file":"NodeFsFileStorage.d.ts","sourceRoot":"","sources":["../../src/file/NodeFsFileStorage.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAG3C,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,WAAW,EAAgB,SAAS,EAAE,MAAM,QAAQ,CAAC;AAGpE,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,IAAI,CAAC;IAa7C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,MAAY,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAkBjE,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAW1D,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAYpD,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAY7D,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;CAW1D"}
+{"version":3,"file":"NodeFsFileStorage.d.ts","sourceRoot":"","sources":["../../src/file/NodeFsFileStorage.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAG3C,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAgB,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEpE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,qBAAa,iBAAkB,YAAW,WAAW;IACxC,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,MAAe;IAE7C,KAAK,CACJ,IAAI,EAAE,IAAI,EACV,YAAY,GAAE,CAAC,CAAC,MAAM,CAAC,aAAa,CAAU,GAC5C,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAkB7B,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,MAAY,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAkBjE,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAW1D,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAYpD,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAY7D,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;CAW1D"}

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

@@ -1,7 +1,87 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const stream_1 = require("stream");
+const uuid_1 = require("uuid");
+const O = __importStar(require("fp-ts/Option"));
+const E = __importStar(require("fp-ts/Either"));
 const FileStorage_abstract_test_1 = require("./FileStorage.abstract.test");
 const NodeFsFileStorage_1 = require("./NodeFsFileStorage");
 describe('NodeFsFileStorage Tests', () => {
-    (0, FileStorage_abstract_test_1.fileStorageTest)(new NodeFsFileStorage_1.NodeFsFileStorage());
+    const fileStorage = new NodeFsFileStorage_1.NodeFsFileStorage();
+    (0, FileStorage_abstract_test_1.fileStorageTest)(fileStorage);
+    it('should write, append, read and delete the file', async () => {
+        const fileContent = 'This is the initial text.';
+        const readableStream = new stream_1.Readable({
+            read() {
+                this.push(Buffer.from(fileContent));
+                this.push(null);
+            },
+        });
+        const fileName = `test-${(0, uuid_1.v4)()}.txt`;
+        const file = {
+            key: fileName,
+            metadata: {
+                name: fileName,
+            },
+            content: readableStream,
+        };
+        const writtenFile = await fileStorage.write(file, O.none)();
+        expect(writtenFile).toEqual(E.right(file));
+        const secondFileContent = ' And we continue to write.';
+        const appendReadableStream = new stream_1.Readable({
+            read() {
+                this.push(Buffer.from(secondFileContent));
+                this.push(null);
+            },
+        });
+        const appendFile = {
+            key: fileName,
+            metadata: {
+                name: fileName,
+            },
+            content: appendReadableStream,
+        };
+        const appendedFile = await fileStorage.write(appendFile, O.some({ flag: 'a' }))();
+        expect(appendedFile).toEqual(E.right(appendFile));
+        // When reading the full contents.
+        const read = await fileStorage.read(file.key)();
+        const readResponse = E.getOrElse(() => {
+            throw new Error('Expected right');
+        })(read);
+        let data = '';
+        await new Promise((resolve) => {
+            readResponse.content.on('data', (chunk) => {
+                data += chunk;
+            });
+            readResponse.content.on('end', () => {
+                resolve(undefined);
+            });
+        });
+        expect(Buffer.from(data).toString()).toStrictEqual(`${fileContent}${secondFileContent}`);
+        const deleted = await fileStorage.delete(file.key)();
+        expect(deleted).toEqual(E.right(undefined));
+    });
 });

package/dist/file/NodeFsFileStorage.js

@@ -28,15 +28,17 @@ const fs = __importStar(require("fs/promises"));
 const path = __importStar(require("path"));
 const TE = __importStar(require("fp-ts/lib/TaskEither"));
 const function_1 = require("fp-ts/lib/function");
+const O = __importStar(require("fp-ts/Option"));
 const Task_1 = require("../task/Task");
 class NodeFsFileStorage {
     basePath;
     constructor(basePath = '/tmp') {
         this.basePath = basePath;
     }
-    write(file) {
+    write(file, writeOptions = O.none) {
         const filePath = `${this.basePath}/${file.key}`;
-        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.writeFile(filePath, file.content));
+        const uploadOptions = O.toNullable(writeOptions);
+        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.writeFile(filePath, file.content, uploadOptions?.flag ? { flag: uploadOptions.flag } : {}));
         return (0, function_1.pipe)(result, TE.map(() => file));
     }
     read(key, name = key) {

package/dist/logging/Logging.d.ts

@@ -7,4 +7,16 @@ export interface Logging {
 export interface ObservabilityContext {
     [key: string]: string | number | Record<string, string>;
 }
+export declare class ConsoleLogger implements Logging {
+    info(message: string, octx: ObservabilityContext): void;
+    debug(message: string, octx: ObservabilityContext): void;
+    error(message: string, octx: ObservabilityContext): void;
+    warning(message: string, octx: ObservabilityContext): void;
+}
+export declare class NoOpLogger implements Logging {
+    info(message: string, octx: ObservabilityContext): void;
+    debug(message: string, octx: ObservabilityContext): void;
+    error(message: string, octx: ObservabilityContext): void;
+    warning(message: string, octx: ObservabilityContext): void;
+}
 //# sourceMappingURL=Logging.d.ts.map

package/dist/logging/Logging.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Logging.d.ts","sourceRoot":"","sources":["../../src/logging/Logging.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACvB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAExD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEzD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEzD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;CAC3D;AAED,MAAM,WAAW,oBAAoB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxD"}
+{"version":3,"file":"Logging.d.ts","sourceRoot":"","sources":["../../src/logging/Logging.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACvB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAExD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEzD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEzD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;CAC3D;AAED,MAAM,WAAW,oBAAoB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxD;AAED,qBAAa,aAAc,YAAW,OAAO;IAC5C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAIvD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAIxD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAIxD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;CAG1D;AAED,qBAAa,UAAW,YAAW,OAAO;IACzC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAEvD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAExD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAExD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,IAAI;CAC1D"}

package/dist/logging/Logging.js

@@ -1,2 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoOpLogger = exports.ConsoleLogger = void 0;
+class ConsoleLogger {
+    info(message, octx) {
+        console.info(message, octx);
+    }
+    debug(message, octx) {
+        console.debug(message, octx);
+    }
+    error(message, octx) {
+        console.error(message, octx);
+    }
+    warning(message, octx) {
+        console.warn(message, octx);
+    }
+}
+exports.ConsoleLogger = ConsoleLogger;
+class NoOpLogger {
+    info(message, octx) { }
+    debug(message, octx) { }
+    error(message, octx) { }
+    warning(message, octx) { }
+}
+exports.NoOpLogger = NoOpLogger;

package/package.json

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