@deepkit/http 1.0.1-alpha.16 → 1.0.1-alpha.160

package/src/static-serving.ts

@@ -8,54 +8,65 @@
  * You should have received a copy of the MIT License along with this program.
  */
 
-import { http } from './decorator';
+import { http } from './decorator.js';
 import { join } from 'path';
 import { readFileSync, stat } from 'fs';
-import { HtmlResponse, httpWorkflow } from './http';
+import { HtmlResponse, httpWorkflow } from './http.js';
 import { AppModule } from '@deepkit/app';
-import { normalizeDirectory } from './utils';
-import { ClassType } from '@deepkit/core';
-import { injectable } from '@deepkit/injector';
-import { HttpRequest, HttpResponse } from './model';
+import { normalizeDirectory } from './utils.js';
+import { ClassType, urlJoin } from '@deepkit/core';
+import { HttpRequest, HttpResponse } from './model.js';
 import send from 'send';
 import { eventDispatcher } from '@deepkit/event';
-import { RouteConfig } from './router';
+import { HttpRouter, RouteConfig } from './router.js';
 
-export function serveStaticListener(path: string, localPath: string = path): ClassType {
-    @injectable()
-    class HttpRequestStaticServingListener {
-        serve(path: string, request: HttpRequest, response: HttpResponse) {
-            return new Promise(resolve => {
-                const res = send(request, path, { root: localPath })
-                response.once('finish', resolve);
-                res.pipe(response);
-            });
-        }
+export function staticServe(
+    localPath: string,
+    path: string,
+    request: HttpRequest,
+    response: HttpResponse,
+) {
+    return new Promise((resolve, reject) => {
+        const res = send(request, path, { root: localPath });
+        res.pipe(response);
+        res.on('end', resolve);
+    });
+}
+
+export async function staticOnRoute(
+    event: typeof httpWorkflow.onRoute.event,
+    path: string,
+    localPath: string,
+) {
+    if (event.sent) return;
+    if (event.route) return;
 
+    if (!event.request.url?.startsWith(path)) return;
+
+    const relativePath = urlJoin('/', event.url.substr(path.length));
+    const finalLocalPath = join(localPath, relativePath);
+
+    return new Promise(resolve => {
+        stat(finalLocalPath, (err, stat) => {
+            if (stat && stat.isFile()) {
+                event.routeFound(
+                    new RouteConfig('static', ['GET'], event.url, {
+                        type: 'function',
+                        fn: staticServe,
+                    }),
+                    () => ({ arguments: [localPath, relativePath, event.request, event.response], parameters: {} }),
+                );
+            }
+            resolve(undefined);
+        });
+    });
+}
+
+export function serveStaticListener(module: AppModule<any>, path: string, localPath: string = path): ClassType {
+    class HttpRequestStaticServingListener {
         @eventDispatcher.listen(httpWorkflow.onRoute, 101) //after default route listener at 100
         onRoute(event: typeof httpWorkflow.onRoute.event) {
-            if (event.sent) return;
-            if (event.route) return;
-
-            if (!event.request.url?.startsWith(path)) return;
-
-            const relativePath = join('/', event.url.substr(path.length));
-            const finalLocalPath = join(localPath, relativePath);
-
-            return new Promise(resolve => {
-                stat(finalLocalPath, (err, stat) => {
-                    if (stat && stat.isFile()) {
-                        event.routeFound(
-                            new RouteConfig('static', 'GET', event.url, {
-                                controller: HttpRequestStaticServingListener,
-                                methodName: 'serve'
-                            }),
-                            () => [relativePath, event.request, event.response]
-                        );
-                    }
-                    resolve(undefined);
-                });
-            });
+            return staticOnRoute(event, path, localPath);
         }
     }
 
@@ -72,23 +83,82 @@ function loadHtml(localPath: string, path: string): string {
     }
 }
 
+export interface StaticHttpOptions {
+    /**
+     * The public URL path.
+     */
+    path: string;
+
+    /**
+     * The local path from the file system. Either relative or absolute.
+     */
+    localPath: string;
+
+    groups?: string[];
+
+    /**
+     * The controller name of the registered controller class. Is per default `StaticController`.
+     */
+    controllerName?: string;
+
+    /**
+     * Replaces strings in the served index.html file.
+     */
+    indexReplace?: { [name: string]: string };
+}
+
 /**
- * Serves files from a local directory at `path`. All paths without . are redirected to
- * ${localPath}/index.html.
+ * Serves an index file and allows to load asset files from the same folder. Can be used to serve an angular application
+ *
+ * All paths like <path>/*.* that don't match a file are redirected to ${localPath}/index.html.
+ * All paths like <path>/*.* that match a file resolve to the file.
  */
-export function registerStaticHttpController(module: AppModule<any, any>, path: string, localPath: string): void {
-    path = normalizeDirectory(path);
+export function registerStaticHttpController(module: AppModule<any>, options: StaticHttpOptions): void {
     let indexHtml = '';
 
-    @http.controller(path)
-    class HttpDebugController {
-        @http.GET(':any').regexp('any', '[^\.]*')
-        serviceApp(any: string) {
-            if (!indexHtml) indexHtml = loadHtml(localPath, path);
+    const groups = options.groups || [];
+
+    class StaticController {
+        @(http.GET().group(...groups))
+        serveIndex(request: HttpRequest, response: HttpResponse) {
+            if (!indexHtml) {
+                indexHtml = loadHtml(options.localPath, normalizeDirectory(options.path));
+                if (options.indexReplace) {
+                    for (const [k, v] of Object.entries(options.indexReplace)) {
+                        indexHtml = indexHtml.replace(k, v);
+                    }
+                }
+            }
             return indexHtml ? new HtmlResponse(indexHtml) : new HtmlResponse('Index not found', 404);
         }
     }
 
-    module.addController(HttpDebugController);
-    module.addListener(serveStaticListener(path, localPath));
+    if (options.controllerName) {
+        Object.defineProperty(StaticController, 'name', { value: options.controllerName, writable: true });
+    }
+
+    const path = normalizeDirectory(options.path);
+
+    const route1 = new RouteConfig('static', ['GET'], path, {
+        type: 'controller',
+        controller: StaticController,
+        module,
+        methodName: 'serveIndex',
+    });
+    route1.groups = groups;
+    module.configureProvider<HttpRouter>(router => router.addRoute(route1), { global: true });
+
+    if (path !== '/') {
+        const route2 = new RouteConfig('static', ['GET'], path.slice(0, -1), {
+            type: 'controller',
+            controller: StaticController,
+            module,
+            methodName: 'serveIndex',
+        });
+        route2.groups = groups;
+        module.configureProvider<HttpRouter>(router => router.addRoute(route2), { global: true });
+    }
+
+    module.addProvider(StaticController);
+    module.addListener(serveStaticListener(module, normalizeDirectory(options.path), options.localPath));
 }

package/src/utils.ts

@@ -1,5 +1,3 @@
-
-
 export function normalizeDirectory(path: string): string {
     if (path[0] !== '/') path = '/' + path;
     if (path[path.length - 1] !== '/') path = path + '/';

package/tsconfig.esm.json

@@ -6,31 +6,31 @@
   },
   "references": [
     {
-      "path": "../type/tsconfig.esm.json"
+      "path": "../app/tsconfig.esm.json"
     },
     {
-      "path": "../event/tsconfig.esm.json"
+      "path": "../core/tsconfig.esm.json"
     },
     {
-      "path": "../app/tsconfig.esm.json"
+      "path": "../event/tsconfig.esm.json"
     },
     {
       "path": "../injector/tsconfig.esm.json"
     },
     {
-      "path": "../workflow/tsconfig.esm.json"
+      "path": "../logger/tsconfig.esm.json"
     },
     {
-      "path": "../logger/tsconfig.esm.json"
+      "path": "../stopwatch/tsconfig.esm.json"
     },
     {
       "path": "../template/tsconfig.esm.json"
     },
     {
-      "path": "../stopwatch/tsconfig.esm.json"
+      "path": "../type/tsconfig.esm.json"
     },
     {
-      "path": "../core/tsconfig.esm.json"
+      "path": "../workflow/tsconfig.esm.json"
     }
   ]
 }

package/tsconfig.json

@@ -8,45 +8,52 @@
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "moduleResolution": "node",
-    "target": "es2018",
+    "target": "es2020",
     "module": "CommonJS",
     "esModuleInterop": true,
     "outDir": "./dist/cjs",
     "declaration": true,
-    "composite": true
+    "composite": true,
+    "types": [
+      "node",
+      "send"
+    ]
   },
+  "reflection": true,
   "include": [
     "src",
-    "tests",
     "index.ts"
   ],
+  "exclude": [
+    "tests"
+  ],
   "references": [
     {
-      "path": "../type/tsconfig.json"
+      "path": "../app/tsconfig.json"
     },
     {
-      "path": "../event/tsconfig.json"
+      "path": "../core/tsconfig.json"
     },
     {
-      "path": "../app/tsconfig.json"
+      "path": "../event/tsconfig.json"
     },
     {
       "path": "../injector/tsconfig.json"
     },
     {
-      "path": "../workflow/tsconfig.json"
+      "path": "../logger/tsconfig.json"
     },
     {
-      "path": "../logger/tsconfig.json"
+      "path": "../stopwatch/tsconfig.json"
     },
     {
       "path": "../template/tsconfig.json"
     },
     {
-      "path": "../stopwatch/tsconfig.json"
+      "path": "../type/tsconfig.json"
     },
     {
-      "path": "../core/tsconfig.json"
+      "path": "../workflow/tsconfig.json"
     }
   ]
-}
+}

package/tsconfig.spec.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "src",
+    "index.ts",
+    "tests"
+  ]
+}

package/dist/cjs/tests/router.spec.d.ts

@@ -1 +0,0 @@
-import 'reflect-metadata';