@trayio/express 5.35.0-unstable.fd7158a → 6.0.0

package/dist/http/ExpressHttpController.d.ts

@@ -1,13 +1,13 @@
-import { Option } from 'effect';
+import * as O from 'fp-ts/Option';
 import { Router } from 'express-serve-static-core';
 import { HttpController } from '@trayio/commons/http/HttpController';
 import { Logging } from '@trayio/commons/logging/Logging';
 export declare class ExpressHttpController {
     protected controller: HttpController;
     protected baseTmpPathForUploadedFiles: string;
-    protected logger: Option.Option<Logging>;
+    protected logger: O.Option<Logging>;
     protected maxFiles: number;
-    constructor(controller: HttpController, baseTmpPathForUploadedFiles: string | undefined, logger: Option.Option<Logging>, maxFiles?: number);
+    constructor(controller: HttpController, baseTmpPathForUploadedFiles: string, logger: O.Option<Logging>, maxFiles?: number);
     private addRoute;
     addRoutes: (router: Router) => Router;
     private parseRequestBody;

package/dist/http/ExpressHttpController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpressHttpController.d.ts","sourceRoot":"","sources":["../../src/http/ExpressHttpController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,MAAM,EAAQ,MAAM,QAAQ,CAAC;AAEtD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AASnD,OAAO,EACN,cAAc,EAEd,MAAM,qCAAqC,CAAC;AAG7C,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAW1D,qBAAa,qBAAqB;IAEhC,SAAS,CAAC,UAAU,EAAE,cAAc;IACpC,SAAS,CAAC,2BAA2B,EAAE,MAAM;IAC7C,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;IACxC,SAAS,CAAC,QAAQ,EAAE,MAAM;gBAHhB,UAAU,EAAE,cAAc,EAC1B,2BAA2B,EAAE,MAAM,YAAS,EAC5C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAC9B,QAAQ,GAAE,MAAU;IAG/B,OAAO,CAAC,QAAQ,CAgGd;IAEF,SAAS,GAAI,QAAQ,MAAM,YAKzB;IAEF,OAAO,CAAC,gBAAgB,CAiBtB;IAGF,OAAO,CAAC,uBAAuB,CAI7B;IAEF,OAAO,CAAC,sBAAsB,CAmC1B;IAEJ,OAAO,CAAC,aAAa,CAenB;IAEF,OAAO,CAAC,YAAY,CAkBlB;IAEF,OAAO,CAAC,+BAA+B,CAWpC;CACH"}
+{"version":3,"file":"ExpressHttpController.d.ts","sourceRoot":"","sources":["../../src/http/ExpressHttpController.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AASnD,OAAO,EACN,cAAc,EAEd,MAAM,qCAAqC,CAAC;AAG7C,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAW1D,qBAAa,qBAAqB;IAEhC,SAAS,CAAC,UAAU,EAAE,cAAc;IACpC,SAAS,CAAC,2BAA2B,EAAE,MAAM;IAC7C,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACnC,SAAS,CAAC,QAAQ,EAAE,MAAM;gBAHhB,UAAU,EAAE,cAAc,EAC1B,2BAA2B,EAAE,MAAe,EAC5C,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EACzB,QAAQ,GAAE,MAAU;IAG/B,OAAO,CAAC,QAAQ,CA8Fd;IAEF,SAAS,WAAY,MAAM,YAKzB;IAEF,OAAO,CAAC,gBAAgB,CAoBtB;IAGF,OAAO,CAAC,uBAAuB,CAI7B;IAEF,OAAO,CAAC,sBAAsB,CAmC3B;IAEH,OAAO,CAAC,aAAa,CAenB;IAEF,OAAO,CAAC,YAAY,CAkBlB;IAEF,OAAO,CAAC,+BAA+B,CAWpC;CACH"}

package/dist/http/ExpressHttpController.js

@@ -1,10 +1,35 @@
 "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;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpressHttpController = void 0;
-const effect_1 = require("effect");
+const TE = __importStar(require("fp-ts/TaskEither"));
+const E = __importStar(require("fp-ts/Either"));
+const O = __importStar(require("fp-ts/Option"));
 const Http_1 = require("@trayio/commons/http/Http");
 const BufferExtensions_1 = require("@trayio/commons/buffer/BufferExtensions");
 const formidable_1 = __importDefault(require("formidable"));
@@ -35,7 +60,7 @@ class ExpressHttpController {
                 requestBody = await this.parseRequestBody(req);
             }
             catch (err) {
-                if (effect_1.Option.isSome(this.logger)) {
+                if (O.isSome(this.logger)) {
                     this.logger.value.warning(`Issue in the request: ${err.message}`, {
                         path: req.path,
                     });
@@ -50,13 +75,13 @@ class ExpressHttpController {
                     error: `Invalid request: ${err.message}`,
                 });
             }
-            const httpResponse = await effect_1.Effect.runPromise(endpoint.execute(this.logger)(Http_1.HttpRequest.create({
+            const httpResponse = await endpoint.execute(this.logger)(Http_1.HttpRequest.create({
                 headers,
                 pathParams: req.params,
                 queryString: req.query,
                 body: requestBody,
-                clientIp: effect_1.Option.fromNullable(clientIp),
-            })));
+                clientIp: O.fromNullable(clientIp),
+            }))();
             const sanitizeHeaderValue = (value) => {
                 let processedValue = value;
                 if (Array.isArray(value)) {
@@ -105,7 +130,11 @@ class ExpressHttpController {
     parseRequestBody = async (req) => {
         const contentType = req.headers['content-type'];
         if (contentType && contentType.startsWith('multipart/form-data')) {
-            return effect_1.Effect.runPromise(effect_1.Effect.mapError(this.parseMultipartFormData(req), (error) => new Error(error.message)));
+            const multiPartResponse = await this.parseMultipartFormData(req)();
+            const multiPartBody = E.getOrElse((error) => {
+                throw new Error(error.message);
+            })(multiPartResponse);
+            return multiPartBody;
         }
         return this.parseGeneralRequestBody(req);
     };
@@ -114,37 +143,34 @@ class ExpressHttpController {
         const body = Object.keys(req.body).length === 0 ? new ArrayBuffer(0) : req.body;
         return BufferExtensions_1.BufferExtensions.arrayBufferToReadable(body);
     };
-    parseMultipartFormData = (req) => effect_1.Effect.tryPromise({
-        try: () => new Promise((resolve, reject) => {
-            /*
-             * NOTE: inorder to use any other underlying file storage other than node fs, we would have to use
-             * formidable's fileWriteStreamHandler option that enables formidable to write a file to a stream.
-             * When used the fileWriteStreamHandler option with passThrough stream, we ran into errors that we didn't have
-             * time to solve, but ideally, we would be using the FileStorage interface instead of letting formidable
-             * write to the file system directly.
-             */
-            const form = (0, formidable_1.default)({
-                maxFiles: this.maxFiles,
-                maxFileSize: 100 * 1024 * 1024, // 100MB
-                minFileSize: 0,
-                allowEmptyFiles: true,
-                uploadDir: this.baseTmpPathForUploadedFiles,
-            });
-            form.parse(req, (err, fields, files) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    const body = {
-                        fields: this.flattenFields(fields),
-                        files: this.flattenFiles(files),
-                    };
-                    resolve(body);
-                }
-            });
-        }),
-        catch: (error) => new Error(error.message),
-    });
+    parseMultipartFormData = (req) => TE.tryCatch(() => new Promise((resolve, reject) => {
+        /*
+         * NOTE: inorder to use any other underlying file storage other than node fs, we would have to use
+         * formidable's fileWriteStreamHandler option that enables formidable to write a file to a stream.
+         * When used the fileWriteStreamHandler option with passThrough stream, we ran into errors that we didn't have
+         * time to solve, but ideally, we would be using the FileStorage interface instead of letting formidable
+         * write to the file system directly.
+         */
+        const form = (0, formidable_1.default)({
+            maxFiles: this.maxFiles,
+            maxFileSize: 100 * 1024 * 1024,
+            minFileSize: 0,
+            allowEmptyFiles: true,
+            uploadDir: this.baseTmpPathForUploadedFiles,
+        });
+        form.parse(req, (err, fields, files) => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                const body = {
+                    fields: this.flattenFields(fields),
+                    files: this.flattenFiles(files),
+                };
+                resolve(body);
+            }
+        });
+    }), (error) => new Error(error.message));
     flattenFields = (fields) => {
         const flattenedFields = {};
         Object.entries(fields).forEach(([key, value]) => {

package/dist/http/ExpressHttpController.unit.test.js

@@ -1,7 +1,31 @@
 "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 effect_1 = require("effect");
 const Http_1 = require("@trayio/commons/http/Http");
+const O = __importStar(require("fp-ts/Option"));
+const T = __importStar(require("fp-ts/Task"));
 const stream_1 = require("stream");
 const ExpressHttpController_1 = require("./ExpressHttpController");
 describe('ExpressHttpController', () => {
@@ -18,7 +42,7 @@ describe('ExpressHttpController', () => {
         mockHttpController = {
             getEndpoints: jest.fn().mockReturnValue([mockEndpoint]),
         };
-        expressHttpController = new ExpressHttpController_1.ExpressHttpController(mockHttpController, '/tmp', effect_1.Option.none());
+        expressHttpController = new ExpressHttpController_1.ExpressHttpController(mockHttpController, '/tmp', O.none);
         mockRouter = {
             get: jest.fn(),
             post: jest.fn(),
@@ -82,7 +106,7 @@ describe('ExpressHttpController', () => {
                 headers: {},
                 body: mockResponse,
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             expressHttpController.addRoutes(mockRouter);
             // eslint-disable-next-line prefer-destructuring
             routeHandler = mockRouter.get.mock.calls[0][1];
@@ -99,7 +123,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value_with_control_chars');
         });
@@ -115,7 +139,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value_with_line__breaks');
         });
@@ -131,7 +155,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value"with\\quotes');
         });
@@ -147,7 +171,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value with spaces');
         });
@@ -163,7 +187,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value1,value2,value3');
         });
@@ -179,7 +203,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('content-length', '123');
         });
@@ -195,7 +219,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value_with__"multiple\\issues"');
         });
@@ -211,7 +235,7 @@ describe('ExpressHttpController', () => {
                     },
                 }),
             };
-            mockEndpoint.execute.mockReturnValue(() => effect_1.Effect.succeed(httpResponse));
+            mockEndpoint.execute.mockReturnValue(() => T.of(httpResponse));
             await routeHandler(mockReq, mockRes);
             expect(mockRes.setHeader).toHaveBeenCalledWith('test-header', 'value_with_em_dash');
         });
@@ -233,7 +257,7 @@ describe('ExpressHttpController', () => {
                 status: jest.fn().mockReturnThis(),
                 json: jest.fn().mockReturnThis(),
             };
-            expressHttpController = new ExpressHttpController_1.ExpressHttpController(mockHttpController, '/tmp', effect_1.Option.some({
+            expressHttpController = new ExpressHttpController_1.ExpressHttpController(mockHttpController, '/tmp', O.some({
                 warning: jest.fn(),
             }));
             expressHttpController.addRoutes(mockRouter);

package/dist/http/ExpressHttpServer.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import http = require('http');
 import { Server } from 'node:http';
 import { ExpressHttpController } from './ExpressHttpController';

package/dist/http/ExpressHttpServer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpressHttpServer.d.ts","sourceRoot":"","sources":["../../src/http/ExpressHttpServer.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,GAAG,QAAQ,MAAM,CAAC,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,UAAU,oBAAoB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,CACpB,MAAM,EAAE,MAAM,CAAC,OAAO,IAAI,CAAC,eAAe,EAAE,OAAO,IAAI,CAAC,cAAc,CAAC,KACnE,SAAS,CAAC;CACf;AAED,eAAO,MAAM,WAAW,GACvB,aAAa,qBAAqB,EAAE,EACpC,SAAS,oBAAoB,yEA6D7B,CAAC"}
+{"version":3,"file":"ExpressHttpServer.d.ts","sourceRoot":"","sources":["../../src/http/ExpressHttpServer.ts"],"names":[],"mappings":";AAEA,OAAO,IAAI,GAAG,QAAQ,MAAM,CAAC,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,UAAU,oBAAoB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,CACpB,MAAM,EAAE,MAAM,CAAC,OAAO,IAAI,CAAC,eAAe,EAAE,OAAO,IAAI,CAAC,cAAc,CAAC,KACnE,SAAS,CAAC;CACf;AAED,eAAO,MAAM,WAAW,gBACV,qBAAqB,EAAE,WAC3B,oBAAoB,yEA6D7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/express",
-  "version": "5.35.0-unstable.fd7158a",
+  "version": "6.0.0",
   "description": "Express extensions and implementations",
   "exports": {
     "./*": "./dist/*.js"
@@ -14,12 +14,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@trayio/commons": "5.35.0-unstable.fd7158a",
+    "@trayio/commons": "6.0.0",
     "@types/express-serve-static-core": "4.17.41",
     "cors": "2.8.5",
-    "effect": "3.22.2",
     "express": "4.20.0",
-    "formidable": "3.5.1"
+    "formidable": "3.5.1",
+    "fp-ts": "2.12.3"
   },
   "devDependencies": {
     "@types/cors": "2.8.17",