@webtypen/webframez-core 0.1.0 → 0.1.2

package/dev/app.ts

@@ -32,6 +32,11 @@ app.boot({
             });
         });
 
+        Route.get("/download", async (req: Request, res: Response) => {
+            const file = path.join(__dirname, "uploads", "2024-06-09_test.zip");
+            return await res.download(file);
+        });
+
         Route.post("/fileupload", (req: Request, res: Response) => {
             if (!req.message) {
                 throw Error("Missing IncomingMessage ...");

package/dist/Router/Request.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { IncomingMessage } from "http";
 export declare class Request {
+    [key: string]: any;
     method: string;
     url: string;
     headers: any;

package/dist/Router/Request.js

@@ -1,19 +1,4 @@
 "use strict";
-// export type Request = {
-//   [key: string]: any;
-//   body?: any;
-//   bodyPlain?: any;
-//   params: object;
-//   httpVersionMajor: any;
-//   httpVersionMinor: any;
-//   httpVersion: any;
-//   headers: object;
-//   rawHeaders: object;
-//   url: string;
-//   method: string;
-//   on?: any;
-//   request?: any;
-// };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Request = void 0;
 class Request {

package/dist/Router/Response.d.ts

@@ -42,6 +42,7 @@ export declare class Response {
      * @returns Response
      */
     send(content: any): this;
+    download(filepath: string, options?: any): Promise<unknown>;
     end(): this;
     registerEvent(eventKey: string, func: any): Promise<void>;
     /**

package/dist/Router/Response.js

@@ -8,8 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Response = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const mime_types_1 = __importDefault(require("mime-types"));
 class Response {
     constructor(options) {
         this.statusCode = 200;
@@ -67,22 +73,58 @@ class Response {
      * @returns Response
      */
     send(content) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         this.content = content;
         if (this.mode === "aws-lambda") {
             // Do nothing ... Store content in variable and use it later ...
         }
         else {
             if (typeof content === "object" && !Buffer.isBuffer(content)) {
-                (_a = this.res) === null || _a === void 0 ? void 0 : _a.setHeader("Content-Type", "application/json");
-                (_b = this.res) === null || _b === void 0 ? void 0 : _b.write(JSON.stringify(content));
+                if (!((_a = this.res) === null || _a === void 0 ? void 0 : _a.headersSent)) {
+                    (_b = this.res) === null || _b === void 0 ? void 0 : _b.setHeader("Content-Type", "application/json");
+                }
+                (_c = this.res) === null || _c === void 0 ? void 0 : _c.write(JSON.stringify(content));
             }
             else {
-                (_c = this.res) === null || _c === void 0 ? void 0 : _c.write(content);
+                (_d = this.res) === null || _d === void 0 ? void 0 : _d.write(content);
             }
         }
         return this;
     }
+    download(filepath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                if (!this.res) {
+                    return reject("Cannot download: Original response object is missing");
+                }
+                if (!fs_1.default.existsSync(filepath)) {
+                    return reject("Cannot download: File '" + filepath + "' does not exist");
+                }
+                let mimeType = options && options.contentType ? options.contentType : "application/octet-stream";
+                if (options && options.inline) {
+                    let tempMime = mime_types_1.default.lookup(filepath);
+                    if (tempMime) {
+                        mimeType = tempMime;
+                    }
+                }
+                const stats = fs_1.default.lstatSync(filepath);
+                this.header("Content-Disposition", (options && options.inline ? "inline" : "attachment") +
+                    "; filename=" +
+                    (options && options.filename ? options.filename : path_1.default.basename(filepath)));
+                this.header("Content-Type", mimeType);
+                this.header("Content-Length", stats.size.toString());
+                const readStream = fs_1.default.createReadStream(filepath);
+                readStream.pipe(this.res);
+                readStream.on("close", () => {
+                    resolve();
+                });
+                readStream.on("error", (streamErr) => {
+                    console.error(streamErr);
+                    reject(streamErr);
+                });
+            });
+        });
+    }
     end() {
         var _a;
         (_a = this.res) === null || _a === void 0 ? void 0 : _a.end();

package/dist/Router/Router.d.ts

@@ -4,7 +4,9 @@ import { Response } from "./Response";
 import { Request } from "./Request";
 type RouteObject = {
     path: string;
-    component: any;
+    component?: any;
+    controller?: any;
+    method_name?: string;
     options: {
         [key: string]: any;
     };
@@ -69,9 +71,17 @@ declare class RouterFacade {
     };
     /**
      * Load the application-routes
-     *
      */
     init(options?: any): void;
+    /**
+     * Dissolves 'MyController@myFunction'
+     *
+     * @param str
+     */
+    dissolveStringComponent(str: string, path: string): {
+        controller: any;
+        method_name: string;
+    };
     /**
      * Register a route
      *

package/dist/Router/Router.js

@@ -50,7 +50,6 @@ class RouterFacade {
     }
     /**
      * Load the application-routes
-     *
      */
     init(options) {
         this.basename = options && options.basename ? options.basename : null;
@@ -64,6 +63,25 @@ class RouterFacade {
             require(process.cwd() + "/app/routes");
         }
     }
+    /**
+     * Dissolves 'MyController@myFunction'
+     *
+     * @param str
+     */
+    dissolveStringComponent(str, path) {
+        const split = str.split("@");
+        if (!split || !split[0] || split[0].trim() === "" || !split[1] || split[1].trim() === "") {
+            throw new Error("Missing Controller Route for '" + path + "'");
+        }
+        const controller = this.kernel.controller[split[0]];
+        if (!controller) {
+            throw new Error("Could not dissvole Controller '" + split[0] + "' from route ' +  path+ '");
+        }
+        return {
+            controller: controller,
+            method_name: split[1],
+        };
+    }
     /**
      * Register a route
      *
@@ -76,33 +94,29 @@ class RouterFacade {
         if (this.basename) {
             path = this.basename + path;
         }
+        let routeConf = {
+            path: path,
+            options: options,
+        };
+        if (typeof component === "string") {
+            const stringComponent = this.dissolveStringComponent(component, path);
+            routeConf.controller = stringComponent.controller;
+            routeConf.method_name = stringComponent.method_name;
+        }
+        else {
+            routeConf.component = component;
+        }
         if (type === "GET") {
-            this.routesGET[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesGET[path] = routeConf;
         }
         else if (type === "POST") {
-            this.routesPOST[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesPOST[path] = routeConf;
         }
         else if (type === "PUT") {
-            this.routesPUT[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesPUT[path] = routeConf;
         }
         else if (type === "DELETE") {
-            this.routesDELETE[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesDELETE[path] = routeConf;
         }
     }
     /**
@@ -209,7 +223,7 @@ class RouterFacade {
             if (!route) {
                 return this.handleError(request, response, 404, "Not found ...");
             }
-            if (!route.component) {
+            if (!(route.component && typeof route.component === "function") && !(route.controller && route.method_name)) {
                 return this.handleError(request, response, 404, "Missing route function ...");
             }
             try {
@@ -217,7 +231,17 @@ class RouterFacade {
                 if (request.method === "OPTIONS" && !request.skipOptionsForward) {
                     return this.handleReturn(request, response, "");
                 }
-                const result = yield route.component(request, response);
+                let result = null;
+                if (route.controller && route.method_name) {
+                    const controllerInstance = new route.controller();
+                    if (!controllerInstance[route.method_name]) {
+                        return this.handleError(request, response, 404, "Unknown method '" + route.method_name + "'.");
+                    }
+                    result = yield controllerInstance[route.method_name].bind(controllerInstance)(request, response);
+                }
+                else {
+                    result = yield route.component(request, response);
+                }
                 this.handleReturn(request, response, result);
             }
             catch (e) {
@@ -289,7 +313,8 @@ class RouterFacade {
                     // Content-Type Verarbeitung
                     if (contentType.includes("application/json")) {
                         try {
-                            resolve({ plain: body, parsed: JSON.parse(body.toString()) });
+                            const text = body.toString();
+                            resolve({ plain: body, parsed: text && text.trim() !== "" ? JSON.parse(text) : {} });
                         }
                         catch (e) {
                             reject(new Error("Invalid JSON"));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@webtypen/webframez-core",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "description": "The core package of the typescript based webframez (web-framework) by webtypen.de",
     "homepage": "https://webtypen.de/",
     "license": "MIT",
@@ -19,11 +19,13 @@
     },
     "scripts": {
         "build": "tsc",
-        "build:check": "tsc --noEmit"
+        "build:check": "tsc --noEmit",
+        "dev": "PORT=3210 ts-node ./dev/app.ts"
     },
     "devDependencies": {
         "@types/busboy": "^1.5.4",
         "@types/lodash": "^4.14.190",
+        "@types/mime-types": "^2.1.4",
         "@types/node": "^18.11.9",
         "@types/qs": "^6.9.7",
         "ts-node": "^10.9.1",
@@ -34,6 +36,7 @@
         "commander": "^9.4.1",
         "dotenv": "^8.2.0",
         "lodash": "^4.17.20",
+        "mime-types": "^2.1.35",
         "qs": "^6.11.0",
         "querystring": "^0.2.1"
     }

package/src/Router/Request.ts

@@ -1,22 +1,7 @@
-// export type Request = {
-//   [key: string]: any;
-//   body?: any;
-//   bodyPlain?: any;
-//   params: object;
-//   httpVersionMajor: any;
-//   httpVersionMinor: any;
-//   httpVersion: any;
-//   headers: object;
-//   rawHeaders: object;
-//   url: string;
-//   method: string;
-//   on?: any;
-//   request?: any;
-// };
-
 import { IncomingMessage } from "http";
 
 export class Request {
+    [key: string]: any;
     method: string = "GET";
     url: string = "";
     headers: any = {};

package/src/Router/Response.ts

@@ -1,3 +1,6 @@
+import fs from "fs";
+import path from "path";
+import mime from "mime-types";
 import { ServerResponse } from "http";
 
 export class Response {
@@ -75,7 +78,9 @@ export class Response {
             // Do nothing ... Store content in variable and use it later ...
         } else {
             if (typeof content === "object" && !Buffer.isBuffer(content)) {
-                this.res?.setHeader("Content-Type", "application/json");
+                if (!this.res?.headersSent) {
+                    this.res?.setHeader("Content-Type", "application/json");
+                }
                 this.res?.write(JSON.stringify(content));
             } else {
                 this.res?.write(content);
@@ -84,6 +89,48 @@ export class Response {
         return this;
     }
 
+    async download(filepath: string, options?: any) {
+        return new Promise((resolve: Function, reject: Function) => {
+            if (!this.res) {
+                return reject("Cannot download: Original response object is missing");
+            }
+
+            if (!fs.existsSync(filepath)) {
+                return reject("Cannot download: File '" + filepath + "' does not exist");
+            }
+
+            let mimeType = options && options.contentType ? options.contentType : "application/octet-stream";
+            if (options && options.inline) {
+                let tempMime = mime.lookup(filepath);
+                if (tempMime) {
+                    mimeType = tempMime;
+                }
+            }
+
+            const stats = fs.lstatSync(filepath);
+            this.header(
+                "Content-Disposition",
+                (options && options.inline ? "inline" : "attachment") +
+                    "; filename=" +
+                    (options && options.filename ? options.filename : path.basename(filepath))
+            );
+            this.header("Content-Type", mimeType);
+            this.header("Content-Length", stats.size.toString());
+
+            const readStream = fs.createReadStream(filepath);
+            readStream.pipe(this.res);
+
+            readStream.on("close", () => {
+                resolve();
+            });
+
+            readStream.on("error", (streamErr) => {
+                console.error(streamErr);
+                reject(streamErr);
+            });
+        });
+    }
+
     end() {
         this.res?.end();
         return this;

package/src/Router/Router.ts

@@ -5,7 +5,9 @@ import querystring from "querystring";
 
 type RouteObject = {
     path: string;
-    component: any;
+    component?: any;
+    controller?: any;
+    method_name?: string;
     options: { [key: string]: any };
     params: object;
 };
@@ -76,7 +78,6 @@ class RouterFacade {
 
     /**
      * Load the application-routes
-     *
      */
     init(options?: any) {
         this.basename = options && options.basename ? options.basename : null;
@@ -91,6 +92,29 @@ class RouterFacade {
         }
     }
 
+    /**
+     * Dissolves 'MyController@myFunction'
+     *
+     * @param str
+     */
+    dissolveStringComponent(str: string, path: string) {
+        const split = str.split("@");
+
+        if (!split || !split[0] || split[0].trim() === "" || !split[1] || split[1].trim() === "") {
+            throw new Error("Missing Controller Route for '" + path + "'");
+        }
+
+        const controller = this.kernel.controller[split[0]];
+        if (!controller) {
+            throw new Error("Could not dissvole Controller '" + split[0] + "' from route ' +  path+ '");
+        }
+
+        return {
+            controller: controller,
+            method_name: split[1],
+        };
+    }
+
     /**
      * Register a route
      *
@@ -104,30 +128,27 @@ class RouterFacade {
             path = this.basename + path;
         }
 
+        let routeConf: any = {
+            path: path,
+            options: options,
+        };
+
+        if (typeof component === "string") {
+            const stringComponent = this.dissolveStringComponent(component, path);
+            routeConf.controller = stringComponent.controller;
+            routeConf.method_name = stringComponent.method_name;
+        } else {
+            routeConf.component = component;
+        }
+
         if (type === "GET") {
-            this.routesGET[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesGET[path] = routeConf;
         } else if (type === "POST") {
-            this.routesPOST[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesPOST[path] = routeConf;
         } else if (type === "PUT") {
-            this.routesPUT[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesPUT[path] = routeConf;
         } else if (type === "DELETE") {
-            this.routesDELETE[path] = {
-                path: path,
-                component: component,
-                options: options,
-            };
+            this.routesDELETE[path] = routeConf;
         }
     }
 
@@ -238,7 +259,7 @@ class RouterFacade {
             return this.handleError(request, response, 404, "Not found ...");
         }
 
-        if (!route.component) {
+        if (!(route.component && typeof route.component === "function") && !(route.controller && route.method_name)) {
             return this.handleError(request, response, 404, "Missing route function ...");
         }
 
@@ -249,7 +270,18 @@ class RouterFacade {
                 return this.handleReturn(request, response, "");
             }
 
-            const result = await route.component(request, response);
+            let result = null;
+            if (route.controller && route.method_name) {
+                const controllerInstance = new route.controller();
+
+                if (!controllerInstance[route.method_name]) {
+                    return this.handleError(request, response, 404, "Unknown method '" + route.method_name + "'.");
+                }
+
+                result = await controllerInstance[route.method_name].bind(controllerInstance)(request, response);
+            } else {
+                result = await route.component(request, response);
+            }
             this.handleReturn(request, response, result);
         } catch (e: any) {
             return this.handleError(request, response, 500, e);
@@ -320,7 +352,8 @@ class RouterFacade {
                 // Content-Type Verarbeitung
                 if (contentType.includes("application/json")) {
                     try {
-                        resolve({ plain: body, parsed: JSON.parse(body.toString()) });
+                        const text = body.toString();
+                        resolve({ plain: body, parsed: text && text.trim() !== "" ? JSON.parse(text) : {} });
                     } catch (e) {
                         reject(new Error("Invalid JSON"));
                     }