@trayio/commons 4.73.0 → 4.75.0

package/dist/file/NodeFsFileStorage.d.ts

@@ -13,5 +13,6 @@ export declare class NodeFsFileStorage implements FileStorage {
     delete(key: string): TE.TaskEither<Error, undefined>;
     createDirectory(key: string): TE.TaskEither<Error, undefined>;
     readDirectory(key: string): TE.TaskEither<Error, Dirent[]>;
+    deleteDirectory(key: string): TE.TaskEither<Error, undefined>;
 }
 //# sourceMappingURL=NodeFsFileStorage.d.ts.map

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,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EACN,IAAI,EACJ,WAAW,EAEX,SAAS,EAET,MAAM,QAAQ,CAAC;AAEhB,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,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAuB7C,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,EACN,IAAI,EACJ,WAAW,EAEX,SAAS,EAET,MAAM,QAAQ,CAAC;AAEhB,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,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;IAuB7C,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;IAY1D,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;CAY7D"}

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

@@ -86,4 +86,36 @@ describe('NodeFsFileStorage Tests', () => {
         const deleted = await fileStorage.delete(file.reference.key)();
         expect(deleted).toEqual(E.right(undefined));
     });
+    it('should create, read  and remove a folder', async () => {
+        const fileContent = 'This is the initial text.';
+        const readableStream = new stream_1.Readable({
+            read() {
+                this.push(Buffer.from(fileContent));
+                this.push(null);
+            },
+        });
+        const folderName = `folder`;
+        const fileName = `test-${(0, uuid_1.v4)()}.txt`;
+        const createdFolderResult = await fileStorage.createDirectory(folderName)();
+        expect(createdFolderResult).toEqual(E.right(undefined));
+        const file = {
+            reference: {
+                _tag: 'FileDescriptor',
+                key: `${folderName}/${fileName}`,
+                metadata: { name: fileName },
+            },
+            content: readableStream,
+        };
+        const writtenFile = await fileStorage.write(file, O.none)();
+        expect(writtenFile).toEqual(E.right(file));
+        const readFolderResult = await fileStorage.readDirectory(folderName)();
+        const contents = E.getOrElse(() => {
+            throw new Error('Expected right');
+        })(readFolderResult);
+        expect(contents.length).toEqual(1);
+        const deleteFolderResult = await fileStorage.deleteDirectory(folderName)();
+        expect(deleteFolderResult).toEqual(E.right(undefined));
+        const readFolderResult2 = await fileStorage.readDirectory(folderName)();
+        expect(readFolderResult2).toEqual(E.left(new Error("Error: ENOENT: no such file or directory, scandir '/tmp/folder'")));
+    });
 });

package/dist/file/NodeFsFileStorage.js

@@ -71,16 +71,21 @@ class NodeFsFileStorage {
         return (0, function_1.pipe)(result, TE.map(() => undefined));
     }
     createDirectory(key) {
-        const filePath = `${this.basePath}/${key}`;
-        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.mkdir(filePath, { recursive: true }));
+        const dirPath = `${this.basePath}/${key}`;
+        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.mkdir(dirPath, { recursive: true }));
         return (0, function_1.pipe)(result, TE.map(() => undefined));
     }
     readDirectory(key) {
-        const filePath = `${this.basePath}/${key}`;
+        const dirPath = `${this.basePath}/${key}`;
         return TE.tryCatch(async () => {
-            const files = await fs.readdir(filePath, { withFileTypes: true });
+            const files = await fs.readdir(dirPath, { withFileTypes: true });
             return files;
         }, (reason) => new Error(String(reason)));
     }
+    deleteDirectory(key) {
+        const dirPath = `${this.basePath}/${key}`;
+        const result = (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => fs.rm(dirPath, { recursive: true, force: true }));
+        return (0, function_1.pipe)(result, TE.map(() => undefined));
+    }
 }
 exports.NodeFsFileStorage = NodeFsFileStorage;

package/dist/uuid/Uuid.d.ts

@@ -0,0 +1,17 @@
+import * as t from 'io-ts';
+import * as E from 'fp-ts/Either';
+import { Codec } from '../codec/Codec';
+declare const uuidTypeDescriptor: t.BrandC<t.StringC, UuidBrand>;
+export type Uuid = t.TypeOf<typeof uuidTypeDescriptor>;
+export interface UuidBrand {
+    readonly Uuid: unique symbol;
+}
+export interface UuidInterface {
+    typeDescriptor: t.BrandC<t.StringC, UuidBrand>;
+    typeCodec: Codec<Uuid>;
+    fromString: (value: string) => E.Either<Error, Uuid>;
+    decodeBinary: (value: Uuid) => ArrayBuffer;
+}
+export declare const Uuid: UuidInterface;
+export {};
+//# sourceMappingURL=Uuid.d.ts.map

package/dist/uuid/Uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Uuid.d.ts","sourceRoot":"","sources":["../../src/uuid/Uuid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAC3B,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAQvC,QAAA,MAAM,kBAAkB,gCAIvB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAIvD,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,IAAI,EAAE,OAAO,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC7B,cAAc,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC/C,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACvB,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACrD,YAAY,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,WAAW,CAAC;CAC3C;AAED,eAAO,MAAM,IAAI,EAAE,aAalB,CAAC"}

package/dist/uuid/Uuid.js

@@ -0,0 +1,43 @@
+"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 });
+exports.Uuid = void 0;
+const t = __importStar(require("io-ts"));
+const TypeCodec_1 = require("../codec/TypeCodec");
+const isUuid = (s) => {
+    const exp = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+    return exp.test(s);
+};
+const uuidTypeDescriptor = t.brand(t.string, (input) => isUuid(input), 'Uuid');
+const uuidTypeCodec = TypeCodec_1.TypeCodec.fromDescriptor(uuidTypeDescriptor);
+exports.Uuid = {
+    typeDescriptor: uuidTypeDescriptor,
+    typeCodec: uuidTypeCodec,
+    fromString: (value) => uuidTypeCodec.decode(value),
+    decodeBinary: (value) => {
+        const binary = Buffer.from(uuidTypeCodec.encode(value), 'utf-8');
+        return binary.buffer.slice(binary.byteOffset, binary.byteOffset + binary.byteLength);
+    },
+};

package/dist/uuid/Uuid.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Uuid.unit.test.d.ts.map

package/dist/uuid/Uuid.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Uuid.unit.test.d.ts","sourceRoot":"","sources":["../../src/uuid/Uuid.unit.test.ts"],"names":[],"mappings":""}

package/dist/uuid/Uuid.unit.test.js

@@ -0,0 +1,42 @@
+"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 E = __importStar(require("fp-ts/Either"));
+const Uuid_1 = require("./Uuid");
+describe('Uuid', () => {
+    test('should create uuid type for valid string', () => {
+        const testValue = '3fa04423-4a2c-462f-8032-8cdd6f1cd5cd';
+        const uuidResult = Uuid_1.Uuid.fromString(testValue);
+        const uuid = E.getOrElse((error) => {
+            throw new Error('This is not a valid UUID');
+        })(uuidResult);
+        expect(uuid.toString()).toStrictEqual(testValue);
+    });
+    test('should fail when string is invalid', () => {
+        const testValue = 'some-invalid-uuid';
+        const uuidResult = Uuid_1.Uuid.fromString(testValue);
+        expect(E.isLeft(uuidResult)).toBe(true);
+    });
+});

package/package.json

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