5htp-core 0.5.0-9 → 0.5.1-1

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "5htp-core",
 	"description": "Convenient TypeScript framework designed for Performance and Productivity.",
-	"version": "0.5.0-9",
+	"version": "0.5.1-1",
 	"author": "Gaetan Le Gac (https://github.com/gaetanlegac)",
 	"repository": "git://github.com/gaetanlegac/5htp-core.git",
 	"license": "MIT",

package/src/common/router/index.ts

@@ -80,6 +80,7 @@ export type TRouteOptions = {
     accept?: string,
     raw?: boolean, // true to return raw data
     auth?: TUserRole | boolean,
+    canonicalParams?: string[],
 
     // Rendering
     static?: boolean,

package/src/common/validation/validators.ts

@@ -417,6 +417,7 @@ export class SchemaValidators {
             try {
                 val = JSON.parse(val);
             } catch (error) {
+                console.error("Failed to parse rich text json:", error, val);
                 throw new InputError("Invalid rich text format.");
             }
 

package/src/server/services/router/index.ts

@@ -12,6 +12,7 @@
 // Node
 // Npm
 import type express from 'express';
+import type { Request, Response, NextFunction } from 'express';
 import { v4 as uuid } from 'uuid';
 import type { GlobImportedWithMetas } from 'babel-plugin-glob-import';
 
@@ -265,7 +266,31 @@ export default class ServerRouter<
     public post = (...args: TApiRegisterArgs<this>) => this.registerApi('POST', ...args);
     public put = (...args: TApiRegisterArgs<this>) => this.registerApi('PUT', ...args);
     public patch = (...args: TApiRegisterArgs<this>) => this.registerApi('PATCH', ...args);
-    public delete = (...args: TApiRegisterArgs<this>) => this.registerApi('DELETE', ...args)
+    public delete = (...args: TApiRegisterArgs<this>) => this.registerApi('DELETE', ...args);
+
+    public express( 
+        middleware: (
+            req: Request,
+            res: Response,
+            next: NextFunction,
+            requestContext: TRouterContext
+        ) => void
+    ) {
+        return (context: TRouterContext) => new Promise((resolve) => {
+            
+            context.request.res.on('finish', function() {
+                //console.log('the response has been sent', request.res.statusCode);
+                resolve(true);
+            });
+    
+            middleware(
+                context.request.req, 
+                context.request.res, 
+                () => { resolve(true); }, 
+                context
+            )
+        })
+    }
 
     protected registerApi(method: TRouteHttpMethod, ...args: TApiRegisterArgs<this>): this {
 
@@ -432,12 +457,16 @@ declare type Routes = {
                 response = await this.handleError(e, request);
             }
 
-            // Status
-            res.status(response.statusCode);
-            // Headers
-            res.header(response.headers);
-            // Data
-            res.send(response.data);
+            if (!res.headersSent) {
+                // Status
+                res.status(response.statusCode);
+                // Headers
+                res.header(response.headers);
+                // Data
+                res.send(response.data);
+            } else if (response.data !== 'true') {
+                throw new Error("Can't return data from the controller since response has already been sent via express.");
+            }
 
         });
     }
@@ -490,7 +519,6 @@ declare type Routes = {
 
                 // Run on resolution hooks. Ex: authentication check
                 await this.runHook('resolved', route);
-
                 const timeEndResolving = Date.now();
 
                 // Create response

package/src/server/services/router/response/index.ts

@@ -82,6 +82,7 @@ export default class ServerResponse<
     public headers: {[cle: string]: string} = {}
     public cookie: express.Response["cookie"];
     public clearCookie: express.Response["clearCookie"];
+    public canonicalUrl: URL;
 
     // If data was provided by at lead one controller
     public wasProvided = false;
@@ -95,12 +96,18 @@ export default class ServerResponse<
 
         this.router = request.router;
         this.app = this.router.app;
+
+        this.canonicalUrl = new URL(request.url);
+        this.canonicalUrl.search = '';
     }
 
     public async runController( route: TAnyRoute, additionnalData: {} = {} ) {
 
         this.route = route;
 
+        // Update canonical url
+        this.updateCanonicalUrl(route);
+
         // Create response context for controllers
         const context = await this.createContext(route);
 
@@ -140,6 +147,18 @@ export default class ServerResponse<
             this.router.cache[ chunkId ] = this.data;
     }
 
+    private updateCanonicalUrl( route: TAnyRoute ) {
+
+        if (!route.options.canonicalParams)
+            return;
+
+        for (const key of route.options.canonicalParams) {
+            const paramValue = this.request.data[ key ];
+            if (paramValue !== undefined)
+                this.canonicalUrl.searchParams.set(key, paramValue);
+        }
+    }
+
     /*----------------------------------
     - INTERNAL
     ----------------------------------*/

package/src/server/services/router/response/page/document.tsx

@@ -57,9 +57,6 @@ export default class DocumentRenderer<TRouter extends Router> {
 
     public async page( html: string, page: Page, response: ServerResponse<TRouter> ) {
 
-        // TODO: can be customized via page / route config
-        const canonicalUrl = response.request.url;
-
         let attrsBody = {
             className: [...page.bodyClass].join(' '),
         };
@@ -94,7 +91,7 @@ export default class DocumentRenderer<TRouter extends Router> {
                     {/* Page */}
                     <title>{page.title}</title>
                     <meta content={page.description} name="description" />
-                    <link rel="canonical" href={canonicalUrl} />
+                    <link rel="canonical" href={response.canonicalUrl} />
 
                     {/* SEO, social medias, OG tags, ...  */}
                     {page.head.map(({ $, ...attrs }) => (