proteum 1.0.2 → 2.0.0-1

package/common/data/markdown.ts

@@ -1,28 +1,29 @@
 import markdownIt from 'markdown-it';
 const md = markdownIt({
-    html: false,                // Enable HTML tags in source
-    xhtmlOut: false,            // Use '/' to close single tags (<br />). This is only for full CommonMark compatibility.
-    breaks: true,              // Convert '\n' in paragraphs into <br>
-    langPrefix: 'language-',    // CSS language prefix for fenced blocks. Can be useful for external highlighters.
-    linkify: false,             // Autoconvert URL-like text to links
+    html: false, // Enable HTML tags in source
+    xhtmlOut: false, // Use '/' to close single tags (<br />). This is only for full CommonMark compatibility.
+    breaks: true, // Convert '\n' in paragraphs into <br>
+    langPrefix: 'language-', // CSS language prefix for fenced blocks. Can be useful for external highlighters.
+    linkify: false, // Autoconvert URL-like text to links
 });
 
 const rules = md.renderer.rules;
 
 // ------------------------
 
-var link_open_default = rules.link_open || function (tokens, idx, options, env, self) {
-    return self.renderToken(tokens, idx, options);
-};
+var link_open_default =
+    rules.link_open ||
+    function (tokens, idx, options, env, self) {
+        return self.renderToken(tokens, idx, options);
+    };
 
 // Target = _blank
 rules.link_open = function (tokens, idx, options, env, self) {
-
     const aIndex = tokens[idx].attrIndex('target');
     if (aIndex < 0) {
         tokens[idx].attrPush(['target', '_blank']);
-    } else {
-        tokens[idx].attrs[ aIndex ][1] = '_blank';
+    } else if (tokens[idx].attrs) {
+        tokens[idx].attrs[aIndex][1] = '_blank';
     }
 
     return link_open_default(tokens, idx, options, env, self);
@@ -30,44 +31,46 @@ rules.link_open = function (tokens, idx, options, env, self) {
 
 // ------------------------
 
-var image_default = rules.image || function (tokens, idx, options, env, self) {
-    return self.renderToken(tokens, idx, options);
-};
+var image_default =
+    rules.image ||
+    function (tokens, idx, options, env, self) {
+        return self.renderToken(tokens, idx, options);
+    };
 
 // img => figure
 rules.image = function (tokens, idx, options, env, self) {
-
     const rendu = image_default(tokens, idx, options, env, self);
 
-    return `<figure>${rendu}</figure>`
+    return `<figure>${rendu}</figure>`;
 };
 
 // ------------------------
 
-md.block.ruler.after('list', 'test', (state, startLine, endLine, silent) => {
-    
-    for (const token of state.tokens) {
-        if (token.type === 'bullet_list_open') {
-
-            const aIndex = token.attrIndex('class');
-            if (aIndex < 0) {
-                token.attrPush(['class', 'liste']); // add new attribute
-            } else {
-                token.attrs[ aIndex ][1] = 'liste';    // replace value of existing attr
+md.block.ruler.after(
+    'list',
+    'test',
+    (state, startLine, endLine, silent) => {
+        for (const token of state.tokens) {
+            if (token.type === 'bullet_list_open') {
+                const aIndex = token.attrIndex('class');
+                if (aIndex < 0) {
+                    token.attrPush(['class', 'liste']); // add new attribute
+                } else if (token.attrs) {
+                    token.attrs[aIndex][1] = 'liste'; // replace value of existing attr
+                }
+            } else if (token.type === 'ordered_list_open') {
+                const aIndex = token.attrIndex('class');
+                if (aIndex < 0) {
+                    token.attrPush(['class', 'steps']); // add new attribute
+                } else if (token.attrs) {
+                    token.attrs[aIndex][1] = 'steps'; // replace value of existing attr
+                }
             }
-
-        } else if (token.type === 'ordered_list_open') {
-            
-            const aIndex = token.attrIndex('class');
-            if (aIndex < 0) {
-                token.attrPush(['class', 'steps']); // add new attribute
-            } else {
-                token.attrs[ aIndex ][1] = 'steps';    // replace value of existing attr
-            }
-
         }
-    }
 
-}, { alt: ['paragraph', 'reference', 'blockquote'] })
+        return false;
+    },
+    { alt: ['paragraph', 'reference', 'blockquote'] },
+);
 
-export default md;
+export default md;

package/common/dev/serverHotReload.ts

@@ -0,0 +1,26 @@
+export const serverHotReloadMessageType = {
+    request: 'proteum:router-reload',
+    succeeded: 'proteum:router-reload-succeeded',
+    failed: 'proteum:router-reload-failed',
+} as const;
+
+export type TServerHotReloadRequest = { type: typeof serverHotReloadMessageType.request; changedFiles: string[] };
+
+export type TServerHotReloadResult = {
+    type: typeof serverHotReloadMessageType.succeeded | typeof serverHotReloadMessageType.failed;
+    changedFiles: string[];
+    error?: string;
+};
+
+export const isServerHotReloadRequest = (value: unknown): value is TServerHotReloadRequest =>
+    typeof value === 'object' &&
+    value !== null &&
+    (value as TServerHotReloadRequest).type === serverHotReloadMessageType.request &&
+    Array.isArray((value as TServerHotReloadRequest).changedFiles);
+
+export const isServerHotReloadResult = (value: unknown): value is TServerHotReloadResult =>
+    typeof value === 'object' &&
+    value !== null &&
+    ((value as TServerHotReloadResult).type === serverHotReloadMessageType.succeeded ||
+        (value as TServerHotReloadResult).type === serverHotReloadMessageType.failed) &&
+    Array.isArray((value as TServerHotReloadResult).changedFiles);

package/common/errors/index.tsx

@@ -1,7 +1,5 @@
-import React from 'react';
 import type { ComponentChild } from 'preact';
 
-import type { TJsonLog } from '@server/app/container/console';
 import type ServerRequest from '@server/services/router/request';
 import type { TBasicUser } from '@server/services/auth';
 
@@ -9,64 +7,59 @@ import type { TBasicUser } from '@server/services/auth';
 - TYPES
 ----------------------------------*/
 
-export type TListeErreursSaisie<TClesDonnees extends string = string> = {[champ in TClesDonnees]: string[]}
+export type TListeErreursSaisie<TClesDonnees extends string = string> = { [champ in TClesDonnees]: string[] };
 
 export type TJsonError = {
-    code: number,
-    origin?: string,
-    message: string,
+    code: number;
+    origin?: string;
+    message: string;
     // Form fields
-    errors?: TListeErreursSaisie
-} & TErrorDetails
+    errors?: TListeErreursSaisie;
+} & TErrorDetails;
 
 type TErrorDetails = {
-
     // Allow to identify the error catched (ex: displaying custop content, running custom actions, ...)
-    id?: string,
-    data?: {},
+    id?: string;
+    data?: {};
 
-    cta?: {
-        label: string,
-        link: string,
-    },
+    cta?: { label: string; link: string };
 
     // For debugging
-    stack?: string,
-    origin?: string,
-}
+    stack?: string;
+    origin?: string;
+};
 
 /*----------------------------------
 - TYPES: BUG REPORT
 ----------------------------------*/
 
 export type ServerBug = {
-
     // Context
-    hash: string,
-    isDuplicate: boolean,
-    date: Date, // Timestamp
-    channelType?: string, 
-    channelId?: string,
+    hash: string;
+    isDuplicate: boolean;
+    date: Date; // Timestamp
+    channelType?: string;
+    channelId?: string;
 
     // User
-    user?: TBasicUser | null,
-    ip?: string | null,
+    user?: TBasicUser | null;
+    ip?: string | null;
 
     // Request
     request?: {
-        method: ServerRequest["method"],
-        url: ServerRequest["url"],
-        data: ServerRequest["data"],
-        validatedData: ServerRequest["validatedData"],
-        headers: ServerRequest["headers"],
-        cookies: ServerRequest["cookies"],
-    },
-    
+        method: ServerRequest['method'];
+        url: ServerRequest['url'];
+        data: ServerRequest['data'];
+        validatedData: ServerRequest['validatedData'];
+        headers: ServerRequest['headers'];
+        cookies: ServerRequest['cookies'];
+    };
+
     // Error
-    title?: string,
-    stacktraces: string[],
-    context: object[],
-}
+    title?: string;
+    stacktraces: string[];
+    context: object[];
+};
 
 export type TCatchedError = Error | CoreError | Anomaly;
 
@@ -74,11 +67,10 @@ export type TCatchedError = Error | CoreError | Anomaly;
 - ERREURS
 ----------------------------------*/
 export abstract class CoreError extends Error {
-    
     public static msgDefaut: string;
 
     public abstract http: number;
-    public title: string = "Uh Oh ...";
+    public title: string = 'Uh Oh ...';
     public message: string;
     public details: TErrorDetails = {};
 
@@ -87,25 +79,17 @@ export abstract class CoreError extends Error {
     //public stack?: string;
 
     public constructor(message?: string, details?: TErrorDetails) {
-
         super(message);
 
         this.message = message || (this.constructor as typeof CoreError).msgDefaut;
-        this.details = details || {}; 
+        this.details = details || {};
 
         // Inject stack
-        if (details !== undefined)
-            this.stack = details.stack;
-
+        if (details !== undefined) this.stack = details.stack;
     }
 
     public json(): TJsonError {
-
-        return {
-            code: this.http,
-            message: this.message,
-            ...this.details
-        }
+        return { code: this.http, message: this.message, ...this.details };
     }
 
     public toString() {
@@ -117,191 +101,175 @@ export abstract class CoreError extends Error {
 
 export class InputError extends CoreError {
     public http = 400;
-    public title = "Bad Request";
-    public static msgDefaut = "Bad Request.";
+    public title = 'Bad Request';
+    public static msgDefaut = 'Bad Request.';
 }
 
 export class InputErrorSchema extends CoreError {
-
     public http = 400;
-    public title = "Bad Request";
-    public static msgDefaut = "Bad Request.";
+    public title = 'Bad Request';
+    public static msgDefaut = 'Bad Request.';
 
     private static listeToString(liste: TListeErreursSaisie) {
-        let chaines: string[] = []
-        for (const champ in liste)
-            chaines.push(champ + ': ' + liste[champ].join('. '));
+        let chaines: string[] = [];
+        for (const champ in liste) chaines.push(champ + ': ' + liste[champ].join('. '));
         return chaines.join('; ');
     }
 
-    public constructor( public errors: TListeErreursSaisie, details?: TErrorDetails) {
-
-        super( InputErrorSchema.listeToString(errors), details );
-
+    public constructor(
+        public errors: TListeErreursSaisie,
+        details?: TErrorDetails,
+    ) {
+        super(InputErrorSchema.listeToString(errors), details);
     }
 
     public json(): TJsonError {
-        return {
-            ...super.json(),
-            errors: this.errors,
-        }
+        return { ...super.json(), errors: this.errors };
     }
 
     public render(): ComponentChild {
         return (
             <ul class="col al-left">
-                {Object.keys(this.errors).map( champ => (
-                    <li>{champ}: {this.errors[champ].join('. ')}</li>
+                {Object.keys(this.errors).map((champ) => (
+                    <li>
+                        {champ}: {this.errors[champ].join('. ')}
+                    </li>
                 ))}
             </ul>
-        )
+        );
     }
 }
 
 export class AuthRequired<FeatureKeys extends string> extends CoreError {
     public http = 401;
-    public title = "Authentication Required";
-    public static msgDefaut = "Please Login to Continue.";
+    public title = 'Authentication Required';
+    public static msgDefaut = 'Please Login to Continue.';
 
-    public constructor( 
-        message: string, 
+    public constructor(
+        message: string,
         public feature: FeatureKeys,
         public action: string,
-        details?: TErrorDetails
+        details?: TErrorDetails,
     ) {
         super(message, details);
     }
 
-    public json(): TJsonError & { feature: string, action: string } {
-        return {
-            ...super.json(),
-            feature: this.feature,
-            action: this.action,
-        }
+    public json(): TJsonError & { feature: string; action: string } {
+        return { ...super.json(), feature: this.feature, action: this.action };
     }
 }
 
 export class UpgradeRequired<FeatureKeys extends string> extends CoreError {
     public http = 402;
-    public title = "Upgrade Required";
-    public static msgDefaut = "Please Upgrade to Continue.";
+    public title = 'Upgrade Required';
+    public static msgDefaut = 'Please Upgrade to Continue.';
 
-    public constructor( 
-        message: string, 
+    public constructor(
+        message: string,
         public feature: FeatureKeys,
         public action: string,
-        details?: TErrorDetails
+        details?: TErrorDetails,
     ) {
         super(message, details);
     }
 
-    public json(): TJsonError & { feature: string, action: string } {
-        return {
-            ...super.json(),
-            feature: this.feature,
-            action: this.action,
-        }
+    public json(): TJsonError & { feature: string; action: string } {
+        return { ...super.json(), feature: this.feature, action: this.action };
     }
 }
 
 export class Forbidden extends CoreError {
     public http = 403;
-    public title = "Access Denied";
-    public static msgDefaut = "You do not have sufficient permissions to access this content.";
+    public title = 'Access Denied';
+    public static msgDefaut = 'You do not have sufficient permissions to access this content.';
 }
 
 export class NotFound extends CoreError {
     public http = 404;
-    public title = "Not Found";
-    public static msgDefaut = "The resource you asked for was not found.";
+    public title = 'Not Found';
+    public static msgDefaut = 'The resource you asked for was not found.';
 }
 
 export class Gone extends CoreError {
     public http = 410;
-    public title = "Gone";
-    public static msgDefaut = "The resource you asked for has been removed.";
+    public title = 'Gone';
+    public static msgDefaut = 'The resource you asked for has been removed.';
 }
 
 export class RateLimit extends CoreError {
     public http = 429;
     public title = "You're going too fast";
-    public static msgDefaut = "Please slow down a bit and retry again later.";
+    public static msgDefaut = 'Please slow down a bit and retry again later.';
 }
 
 export class Anomaly extends CoreError {
-
     public http = 500;
-    public title = "Technical Error";
-    public static msgDefaut = "A technical error has occurred. A notification has just been sent to the admin.";
+    public title = 'Technical Error';
+    public static msgDefaut = 'A technical error has occurred. A notification has just been sent to the admin.';
 
-    public constructor( 
-        message: string, 
+    public constructor(
+        message: string,
         public dataForDebugging?: object,
-        public originalError?: Error, 
+        public originalError?: Error,
     ) {
         super(message);
     }
 }
 
 export class NotAvailable extends CoreError {
-
     // TODO: page erreur pour code 503
     public http = 404;
-    public title = "Not Available";
-    public static msgDefaut = "Sorry, the service is currently not available.";
+    public title = 'Not Available';
+    public static msgDefaut = 'Sorry, the service is currently not available.';
 }
 
 export class NetworkError extends Error {
-    public title = "Network Error";
+    public title = 'Network Error';
 }
 
-
-export const viaHttpCode = (
-    code: number, 
-    message: string, 
-    details?: TErrorDetails
-): CoreError => {
-    return fromJson({
-        code,
-        message,
-        ...details
-    });
-}
+export const viaHttpCode = (code: number, message: string, details?: TErrorDetails): CoreError => {
+    return fromJson({ code, message, ...details });
+};
 
 export const toJson = (e: Error | CoreError): TJsonError => {
+    if ('json' in e && typeof e.json === 'function') return e.json();
 
-    if (('json' in e) && typeof e.json === 'function')
-        return e.json();
-
-    const details = ('details' in e) 
-        ? e.details
-        : { stack: e.stack };
+    const details = 'details' in e ? e.details : { stack: e.stack };
 
-    return { code: 500, message: e.message, ...details }
-}
+    return { code: 500, message: e.message, ...details };
+};
 
 export const fromJson = ({ code, message, ...details }: TJsonError) => {
+    const errorDetails = details as Record<string, unknown>;
 
     switch (code) {
-        case 400: 
-            if (details.errors)
-                return new InputErrorSchema( details.errors, details );
-            else
-                return new InputError( message, details );
+        case 400:
+            if (details.errors) return new InputErrorSchema(details.errors, details);
+            else return new InputError(message, details);
 
-        case 401: return new AuthRequired( message, details["feature"], details["action"], details );
+        case 401:
+            return new AuthRequired(message, errorDetails.feature as FeatureKeys, errorDetails.action as string, details);
 
-        case 402: return new UpgradeRequired( message, details["feature"], details["action"], details );
+        case 402:
+            return new UpgradeRequired(
+                message,
+                errorDetails.feature as FeatureKeys,
+                errorDetails.action as string,
+                details,
+            );
 
-        case 403: return new Forbidden( message, details );
+        case 403:
+            return new Forbidden(message, details);
 
-        case 404: return new NotFound( message, details );
+        case 404:
+            return new NotFound(message, details);
 
-        case 429: return new RateLimit( message, details );
+        case 429:
+            return new RateLimit(message, details);
 
-        default: return new Anomaly( message, details );
+        default:
+            return new Anomaly(message, details);
     }
-
-}
+};
 
 export default CoreError;

package/common/router/contracts.ts

@@ -0,0 +1,29 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// Core
+import type { TFrontRenderer, TPageSetup } from './response/page';
+import type { TRouteOptions } from '.';
+
+/*----------------------------------
+- PUBLIC API
+----------------------------------*/
+
+// Supported `Router.page(...)` registration signatures shared by client and compiler code.
+export type TRegisterPageArgs<TProvidedData extends {} = {}, TPageOptions extends {} = TRouteOptions> =
+    | [path: string, renderer: TFrontRenderer<TProvidedData>]
+    | [path: string, setup: TPageSetup<TProvidedData>, renderer: TFrontRenderer<TProvidedData>]
+    | [path: string, options: Partial<TPageOptions>, renderer: TFrontRenderer<TProvidedData>]
+    | [
+          path: string,
+          options: Partial<TPageOptions>,
+          setup: TPageSetup<TProvidedData>,
+          renderer: TFrontRenderer<TProvidedData>,
+      ];
+
+// Serialized SSR route description exchanged between build output and runtime.
+export type TSsrUnresolvedRoute<TKey = number | string> = { chunk: string } & (
+    | { regex: string; keys: TKey[] }
+    | { code: number }
+);