proteum 1.0.0 → 1.0.2

package/cli/utils/keyboard.ts

@@ -0,0 +1,78 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// npm
+import readline, { Key } from 'readline';
+
+/*----------------------------------
+- TYPES
+----------------------------------*/
+
+type TKeyboardCommand = {
+    remove?: boolean,
+    run: (str: string, chunk: string, key: Key) => void
+}
+
+/*----------------------------------
+- METHODS
+----------------------------------*/
+class KeyboardCommands {
+
+    private commands: { [input: string]: TKeyboardCommand } = {}
+
+    public constructor() {
+        this.listen();
+    }
+
+    private listen() {
+
+        readline.emitKeypressEvents(process.stdin);
+        process.stdin.setRawMode(true);
+        process.stdin.on('keypress', async (chunk: string, key: Key) => {
+
+            let str = key.name;
+            if (!str) return;
+            if (str === 'return') str = 'enter';
+
+            if (key.ctrl) str = 'ctrl+' + str;
+            if (key.shift) str = 'shift+' + str;
+            if (key.meta) str = 'meta+' + str;
+
+            const kCommand = this.commands[str] || this.commands.fallback;
+            if (kCommand) {
+
+                kCommand.run(str, chunk, key);
+
+                if (kCommand.remove)
+                    delete this.commands[str];
+            }
+
+            if (str === 'ctrl+c') {
+
+                console.log(`Exiting ...`);
+                process.exit(0);
+
+            } 
+
+
+        });
+    }
+
+
+    public input(str: string, run: TKeyboardCommand["run"], options: Omit<TKeyboardCommand, 'run'> = {}) {
+        this.commands[str] = { run, ...options }
+    }
+
+    public waitForInput(str: string): Promise<void> {
+        return new Promise((resolve) => {
+            this.commands[str] = {
+                run: () => resolve(),
+                remove: true
+            }
+        });
+    }
+
+}
+
+export default new KeyboardCommands

package/client/app/index.ts

@@ -120,6 +120,8 @@ export default abstract class Application {
     }
 
     public abstract handleError( error: CoreError | Error );
+    
+    public abstract handleUpdate(): void;
 
     // TODO: move on app side
     public reportBug = (infos: TBugReportInfos) => fetch('/feedback/bug/ui', {

package/client/components/Dialog/Manager.tsx

@@ -12,8 +12,6 @@ import { blurable, deepContains, focusContent } from '@client/utils/dom';
 
 // Specific
 import type Application from '../../app';
-import Card, { Props as CardInfos } from './card';
-import Button from '../Button';
 
 /*----------------------------------
 - TYPES: IMPORTATIONS
@@ -67,8 +65,6 @@ type DialogActions = {
 
     show: (...args: TDialogShowArgs ) => TDialogControls,
 
-    confirm: (title: string, content: string | ComponentChild, defaultBtn: 'Yes'|'No') => TDialogControls,
-
     loading: (title: string) => TDialogControls,
 
     info: (...[title, content, boutons, options]: TToastShortcutArgs) => TDialogControls,
@@ -137,34 +133,11 @@ export const createDialog = (app: Application, isToast: boolean): DialogActions
                     content: Content
                 }
             }
-
-            // modal.show({ title: 'supprimer', content: <>...</> })
-            if (Content.constructor === Object) {
-
-                const { content: CardContent, data = {}, ...propsToast } = Content as TOptsToast;
-                
-                let cardContent: ComponentChild;
-                if (typeof CardContent === 'function') {
-                    cardContent = <CardContent {...propsRendu} {...data} />
-                    propsToast.boutons = null; // Component content = advanced content = should include buttons
-                } else {
-                    cardContent = CardContent;
-                }
-                
-                render = (
-                    <Card {...propsRendu} {...propsToast} isToast={isToast}>
-                        {cardContent}
-                    </Card>
-                )
-
             // modal.show( ToastSupprimer )
             //  -> Content is a component rendering a Card
-            } else {
-
-                render = (
-                    <Content {...propsRendu} isToast={isToast} />
-                )
-            }
+            render = (
+                <Content {...propsRendu} isToast={isToast} />
+            )
 
             // Chargeur de données
             /*if (('data' in ComposantCharge) && typeof ComposantCharge.data === 'function') {
@@ -202,25 +175,6 @@ export const createDialog = (app: Application, isToast: boolean): DialogActions
         setToasts: undefined as unknown as DialogActions["setToasts"],
         setModals: undefined as unknown as DialogActions["setModals"],
 
-        confirm: (title: string, content: string | ComponentChild, defaultBtn: 'Yes'|'No' = 'No') => show<boolean>(({ close }) => (
-            <div class="card col">
-                <header>
-                    <h2>{title}</h2>
-                </header>
-                {typeof content === 'string' ? <p>{content}</p> : content}
-                <footer class="row fill">
-                    <Button type={defaultBtn === 'Yes' ? 'primary' : undefined}
-                        onClick={() => close(true)}>
-                        Yes
-                    </Button>
-                    <Button type={defaultBtn === 'No' ? 'primary' : undefined}
-                        onClick={() => close(false)}>
-                        No
-                    </Button>
-                </footer>
-            </div>
-        )),
-
         loading: (title: string) => show({
             title: title,
             type: 'loading'

package/client/components/Dialog/index.less

@@ -1,6 +1,8 @@
-@import (reference) "@/client/assets/vars.less";
 
+@c1: #6c5dd3; // Should be darker than c1
+@spacing: 1.2em;
 @toast-zindex: 200;
+@radius: 1rem;
 
 #modals, 
 #toasts {

package/client/components/index.ts

@@ -1,2 +1 @@
-export { Link } from '../services/router/components/Link';
-export { default as Button } from './Button';
+export { Link } from '../services/router/components/Link';

package/client/services/router/index.tsx

@@ -10,7 +10,8 @@ import ReactDOM from 'react-dom';
 import type {
     default as ServerRouter,
     Request as ServerRequest,
-    Response as ServerResponse
+    Response as ServerResponse,
+    TAnyRouter
 } from '@server/services/router';
 import type { TBasicSSrData } from '@server/services/router/response';
 
@@ -23,7 +24,6 @@ import { getLayout } from '@common/router/layouts';
 import { getRegisterPageArgs, buildRegex } from '@common/router/register';
 import { TFetcherList } from '@common/router/request/api';
 import type { TFrontRenderer } from '@common/router/response/page';
-import Button from '../../components/Button';
 
 import App from '@client/app/component';
 import type ClientApplication from '@client/app';
@@ -56,11 +56,11 @@ const LogPrefix = '[router]'
 // Client router can handle Client requests AND Server requests (for pages only)
 export type { default as ClientResponse, TRouterContext } from "./response";
 
-export type Router = ClientRouter | ServerRouter;
+export type Router = ClientRouter | TAnyRouter;
 
-export type Request = ClientRequest<ClientRouter> | ServerRequest<ServerRouter>;
+export type Request = ClientRequest<ClientRouter> | ServerRequest<TAnyRouter>;
 
-export type Response = ClientResponse<ClientRouter> | ServerResponse<ServerRouter>;
+export type Response = ClientResponse<ClientRouter> | ServerResponse<TAnyRouter>;
 
 /*----------------------------------
 - TYPES: ROUTES LOADING
@@ -360,17 +360,7 @@ export default class ClientRouter<
             } catch (e) {
                 console.error(`Failed to fetch the route ${route.chunk}`, e);
                 try {
-                    this.context.modal.show(() => (
-                        <div class="card col bg white w-3">
-                            <h2>New Update Available!</h2>
-                            <p>
-                                A new version of the website is available. Please refresh the page to continue.
-                            </p>
-                            <Button type="primary" onClick={() => window.location.reload()}>
-                                Reload
-                            </Button>
-                        </div>
-                    ));
+                    this.app.handleUpdate();
                 } catch (error) {}
                 throw new Error("A new version of the website is available. Please refresh the page.");
             }

package/common/errors/index.tsx

@@ -35,27 +35,6 @@ type TErrorDetails = {
     origin?: string,
 }
 
-/*----------------------------------
-- TYPES: AUTH REQUIRED FEATURE
-----------------------------------*/
-
-/**
- * Global, augmentable feature catalog used to constrain the `feature` argument
- * of `AuthRequired`.
- *
- * Default behavior (no augmentation): `feature` stays a free-form string.
- * App behavior (augmentation provided by the host app): `feature` becomes a
- * curated union of feature keys.
- */
-declare global {
-    interface TAuthRequiredFeatureCatalog {}
-}
-
-type TAuthRequiredFeatureKey = Extract<keyof TAuthRequiredFeatureCatalog, string>;
-type TAuthRequiredFeature = [TAuthRequiredFeatureKey] extends [never]
-    ? string
-    : TAuthRequiredFeatureKey;
-
 /*----------------------------------
 - TYPES: BUG REPORT
 ----------------------------------*/
@@ -179,46 +158,48 @@ export class InputErrorSchema extends CoreError {
     }
 }
 
-export class AuthRequired extends CoreError {
+export class AuthRequired<FeatureKeys extends string> extends CoreError {
     public http = 401;
     public title = "Authentication Required";
     public static msgDefaut = "Please Login to Continue.";
 
-    public constructor(message: string, feature?: TAuthRequiredFeature);
-    public constructor(message: string, motivation: string | undefined, details: TErrorDetails | undefined);
     public constructor( 
         message: string, 
-        public feature?: string,
+        public feature: FeatureKeys,
+        public action: string,
         details?: TErrorDetails
     ) {
         super(message, details);
     }
 
-    public json(): TJsonError & { feature?: string } {
+    public json(): TJsonError & { feature: string, action: string } {
         return {
             ...super.json(),
             feature: this.feature,
+            action: this.action,
         }
     }
 }
 
-export class UpgradeRequired extends CoreError {
+export class UpgradeRequired<FeatureKeys extends string> extends CoreError {
     public http = 402;
     public title = "Upgrade Required";
     public static msgDefaut = "Please Upgrade to Continue.";
 
     public constructor( 
         message: string, 
-        public feature: string,
+        public feature: FeatureKeys,
+        public action: string,
         details?: TErrorDetails
     ) {
         super(message, details);
     }
 
-    public json(): TJsonError & { feature: string } {
+    public json(): TJsonError & { feature: string, action: string } {
         return {
             ...super.json(),
             feature: this.feature,
+            action: this.action,
         }
     }
 }
@@ -308,9 +289,9 @@ export const fromJson = ({ code, message, ...details }: TJsonError) => {
             else
                 return new InputError( message, details );
 
-        case 401: return new AuthRequired( message, (details as any).feature, details );
+        case 401: return new AuthRequired( message, details["feature"], details["action"], details );
 
-        case 402: return new UpgradeRequired( message, details.feature, details );
+        case 402: return new UpgradeRequired( message, details["feature"], details["action"], details );
 
         case 403: return new Forbidden( message, details );
 

package/doc/TODO.md

@@ -34,7 +34,7 @@ abstract class Controller<
 
 ```typescript
 //? /headhunter/missions/suggested'
-class Missions extends Controller<CrossPath["router"]> {
+class Missions extends Controller<UniqueDomains["router"]> {
 
     auth = 'USER';
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "proteum",
 	"description": "Convenient TypeScript framework designed for Performance and Productivity.",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"author": "Gaetan Le Gac (https://github.com/gaetanlegac)",
 	"repository": "git://github.com/gaetanlegac/proteum.git",
 	"license": "MIT",
@@ -12,74 +12,105 @@
 	"keywords": [
 		"framework"
 	],
+	"bin": {
+		"proteum": "cli/bin.js"
+	},
 	"dependencies": {
-		"@lexical/file": "^0.19.0",
-		"@lexical/headless": "^0.18.0",
-		"@lexical/html": "^0.18.0",
+		"@babel/cli": "^7.15.4",
+		"@babel/plugin-proposal-class-properties": "^7.14.5",
+		"@babel/plugin-proposal-decorators": "^7.25.9",
+		"@babel/plugin-proposal-private-methods": "^7.14.5",
+		"@babel/plugin-proposal-private-property-in-object": "^7.15.4",
+		"@babel/plugin-transform-react-constant-elements": "^7.14.5",
+		"@babel/preset-env": "^7.15.6",
+		"@babel/preset-react": "^7.14.5",
+		"@babel/preset-typescript": "^7.15.0",
 		"@lexical/react": "^0.18.0",
+		"@prefresh/webpack": "^3.3.2",
 		"@prisma/client": "^6.5.0",
+		"@tailwindcss/postcss": "^4.1.17",
 		"accepts": "^1.3.7",
-		"activity-detector": "^3.0.0",
 		"ansi-to-html": "^0.7.1",
-		"array-move": "^3.0.1",
+		"autoprefixer": "^10.4.21",
 		"aws-sdk": "^2.1415.0",
+		"babel-loader": "^10.0.0",
+		"babel-plugin-glob-import": "^0.0.9-1",
+		"babel-plugin-transform-imports": "^2.0.0",
+		"babel-plugin-transform-react-remove-prop-types": "^0.4.24",
+		"babel-plugin-transform-remove-console": "^6.9.4",
 		"bowser": "^2.11.0",
-		"chart.js": "^3.6.2",
+		"brotli-webpack-plugin": "^1.1.0",
+		"browser-sync": "^2.27.5",
 		"cli-highlight": "^2.1.11",
 		"compression": "^1.7.4",
+		"compression-webpack-plugin": "^8.0.1",
 		"cookie-parser": "^1.4.5",
 		"core-js": "^3.18.1",
 		"cors": "^2.8.5",
 		"cron-parser": "^4.0.0",
+		"css-loader": "^6.2.0",
+		"css-minimizer-webpack-plugin": "^7.0.4",
 		"dayjs": "^1.11.5",
-		"deep-extend": "^0.6.0",
 		"dottie": "^2.0.2",
 		"escape-regexp": "^0.0.1",
 		"express": "^4.17.1",
 		"express-csp-header": "^5.0.0",
 		"express-fileupload": "^1.2.1",
 		"fast-safe-stringify": "^2.1.1",
-		"file-type": "^16.5.3",
-		"formattor": "^0.0.2",
+		"favicons": "^7.2.0",
 		"fs-extra": "^10.1.0",
 		"got": "^11.8.3",
-		"handlebars": "^4.7.7",
 		"helmet": "^4.6.0",
 		"history": "^5.0.1",
 		"hpp": "^0.2.3",
 		"human-interval": "^2.0.1",
+		"image-minimizer-webpack-plugin": "^4.1.4",
+		"imagemin": "^9.0.1",
+		"imagemin-svgo": "^10.0.0",
+		"imagemin-webp": "^6.0.0",
 		"intl": "^1.2.5",
 		"iso-639-1": "^2.1.9",
-		"js-cookie": "^3.0.1",
-		"jsdom": "^25.0.1",
+		"json5": "^2.2.0",
 		"jsonwebtoken": "^8.5.1",
+		"less-loader": "^10.0.1",
 		"lexical": "^0.18.0",
 		"load-script": "^2.0.0",
 		"locale": "^0.1.0",
 		"markdown-it": "^13.0.1",
 		"md5": "^2.3.0",
 		"mime-types": "^2.1.35",
+		"mini-css-extract-plugin": "^2.2.2",
 		"module-alias": "^2.2.2",
 		"mysql2": "^2.3.0",
+		"node-cmd": "^5.0.0",
+		"null-loader": "^4.0.1",
 		"object-sizeof": "^1.6.3",
 		"path-to-regexp": "^6.2.0",
-		"picomatch": "^2.3.1",
+		"postcss-loader": "^8.2.0",
 		"preact": "^10.27.1",
 		"preact-render-to-string": "^6.6.1",
 		"prettier": "^3.3.3",
-		"react-scrollbars-custom": "^4.0.27",
-		"react-slider": "^2.0.1",
-		"react-textarea-autosize": "^8.5.9",
+		"prompts": "^2.4.2",
+		"react-dev-utils": "^11.0.4",
 		"regenerator-runtime": "^0.13.9",
+		"replace-once": "^1.0.0",
 		"request": "^2.88.2",
+		"responsive-loader": "^3.1.2",
+		"serialize-javascript": "^6.0.2",
+		"sharp": "^0.34.3",
 		"slugify": "^1.6.6",
 		"source-map-support": "^0.5.21",
-		"sql-formatter": "^4.0.2",
 		"stopword": "^3.1.1",
+		"tailwindcss": "^4.1.17",
+		"terser-webpack-plugin": "^5.2.4",
+		"ts-alias": "^0.0.7",
+		"ts-node": "^10.9.1",
 		"tslog": "^4.9.1",
 		"uuid": "^8.3.2",
-		"uuid-by-string": "^3.0.4",
 		"validator": "^13.7.0",
+		"webpack": "^5.104.1",
+		"webpack-assets-manifest": "^5.0.6",
+		"webpack-bundle-analyzer": "^4.4.2",
 		"ws": "^8.2.2",
 		"yaml": "^1.10.2",
 		"yargs-parser": "^21.1.1",
@@ -88,18 +119,25 @@
 		"zod": "^4.1.5"
 	},
 	"devDependencies": {
+		"@types/babel__core": "^7.1.16",
+		"@types/babel__preset-env": "^7.9.6",
 		"@types/cookie": "^0.4.1",
 		"@types/express": "^4.17.13",
+		"@types/favicons": "^6.2.2",
 		"@types/fs-extra": "^9.0.12",
 		"@types/markdown-it": "^12.2.3",
 		"@types/mime-types": "^2.1.1",
 		"@types/node": "^16.9.1",
 		"@types/nodemailer": "^6.4.4",
+		"@types/pg": "^8.6.1",
+		"@types/pg-escape": "^0.2.1",
+		"@types/prompts": "^2.0.14",
 		"@types/sharp": "^0.31.1",
 		"@types/universal-analytics": "^0.4.5",
 		"@types/webpack-env": "^1.16.2",
 		"@types/ws": "^7.4.7",
 		"@types/yargs-parser": "^21.0.0",
-		"schema-dts": "^1.1.2"
+		"schema-dts": "^1.1.2",
+		"speed-measure-webpack-v5-plugin": "^1.5.2"
 	}
 }

package/server/app/container/console/index.ts

@@ -258,7 +258,7 @@ export default class Console {
         if (filepath.startsWith( projectRoot ))
             filepath = filepath.substring( projectRoot.length )
 
-        const frameworkRoot = '/node_modules/5htp-core/';
+        const frameworkRoot = '/node_modules/proteum/';
         if (filepath.startsWith( frameworkRoot ))
             filepath = '@' + filepath.substring( frameworkRoot.length )
 

package/server/services/auth/index.ts

@@ -20,10 +20,47 @@ import { InputError, AuthRequired, Forbidden } from '@common/errors';
 - TYPES
 ----------------------------------*/
 
-export type TUserRole = typeof UserRoles[number]
+declare global {
+    /**
+     * Optional app-level role registry.
+     *
+     * Apps can add their own roles (keys are role ids):
+     * `interface ProteumAuthRoleCatalog { GOD: true }`
+     */
+    interface ProteumAuthRoleCatalog {}
+
+    /**
+     * App-level feature catalog consumed by auth permission checks.
+     *
+     * Apps can augment this interface with their own feature map:
+     * `interface ProteumAuthFeatureCatalog extends MyFeatures {}`
+     */
+    interface ProteumAuthFeatureCatalog {}
+
+    /**
+     * Canonical feature keys union used across app + framework.
+     *
+     * Notes:
+     * - If the app does not define a feature catalog, this defaults to `string`.
+     * - Otherwise it becomes the string keys of `ProteumAuthFeatureCatalog`.
+     */
+    type FeatureKeys = (
+        keyof ProteumAuthFeatureCatalog extends never
+            ? string
+            : Extract<keyof ProteumAuthFeatureCatalog, string>
+    );
+}
+
+export type TUserRole = (
+    typeof UserRoles[number]
+    |
+    Extract<keyof ProteumAuthRoleCatalog, string>
+);
 
 export type THttpRequest = express.Request | http.IncomingMessage;
 
+export type TFeatureKey = FeatureKeys;
+
 /*----------------------------------
 - CONFIG
 ----------------------------------*/
@@ -167,7 +204,7 @@ export default abstract class AuthService<
         return session;
     }
 
-    public createSession( session: TJwtSession, request: TRequest ): string {
+    public createSession( session: TJwtSession, request2: TRequest ): string {
 
         this.config.debug && console.info(LogPrefix, `Creating new session:`, session);
 
@@ -175,7 +212,7 @@ export default abstract class AuthService<
 
         this.config.debug && console.info(LogPrefix, `Generated JWT token for session:` + token);
 
-        request.res.cookie('authorization', token, {
+        request2.res.cookie('authorization', token, {
             maxAge: this.config.jwt.expiration,
         });
 
@@ -191,30 +228,28 @@ export default abstract class AuthService<
         request.res.clearCookie('authorization');
     }
 
-    public check( 
-        request: TRequest, 
-        role: TUserRole, 
-        motivation?: string, 
-        dataForDebug?: { [key: string]: any }
-    ): TUser;
-
-    public check( 
-        request: TRequest, 
-        role: false, 
-        motivation?: string, 
-        dataForDebug?: { [key: string]: any }
-    ): null;
-
-    public check( 
-        request: TRequest, 
-        role: TUserRole | false = 'USER', 
-        motivation?: string, 
-        dataForDebug?: { [key: string]: any }
+    public check(
+        request: TRequest,
+        role?: TUserRole | false,
+    ): TUser | null;
+
+    public check(
+        request: TRequest,
+        role: TUserRole | false,
+        feature: FeatureKeys,
+        action?: string,
+    ): TUser | null;
+
+    public check(
+        request: TRequest,
+        role: TUserRole | false = 'USER',
+        feature?: FeatureKeys,
+        action?: string,
     ): TUser | null {
 
         const user = request.user;
 
-        this.config.debug && console.warn(LogPrefix, `Check auth, role = ${role}. Current user =`, user?.name, motivation);
+        this.config.debug && console.warn(LogPrefix, `Check auth, role = ${role}. Current user =`, user?.name, feature);
 
         if (user === undefined) {
 
@@ -223,13 +258,13 @@ export default abstract class AuthService<
         // Shoudln't be logged
         } else if (role === false) {
 
-            return user;
+            return user as TUser;
 
         // Not connected
         } else if (user === null) {
 
             console.warn(LogPrefix, "Refusé pour anonyme (" + request.ip + ")");
-            throw new AuthRequired('Please login to continue', motivation, dataForDebug);
+            throw new AuthRequired('Please login to continue', feature as any, action as any);
             
         // Insufficient permissions
         } else if (!user.roles.includes(role)) {
@@ -244,7 +279,7 @@ export default abstract class AuthService<
 
         }
 
-        return user;
+        return user as TUser;
     }
 
-}
+}