proteum 1.0.0-1

package/doc/front/router.md

@@ -0,0 +1,27 @@
+# Disallowed
+
+- To destructure page data objects
+
+```
+route.page('/withdraw', { bodyId: 'withdraw' }, ({}, { api }) => ({
+
+    withdraw: api.get('/withdraw')
+
+}), ({ withdraw: { history, balance, minimum, fees } }, { api, modal, page, user }) => {
+
+    ...
+```
+
+Do instead:
+
+```
+route.page('/withdraw', { bodyId: 'withdraw' }, ({}, { api }) => ({
+
+    withdraw: api.get('/withdraw')
+
+}), ({ withdraw }, { api, modal, page, user }) => {
+
+    const { history, balance, minimum, fees } = withdraw;
+
+    ...
+```

package/package.json

@@ -0,0 +1,171 @@
+{
+	"name": "proteum",
+	"description": "Convenient TypeScript framework designed for Performance and Productivity.",
+	"version": "1.0.0-1",
+	"author": "Gaetan Le Gac (https://github.com/gaetanlegac)",
+	"repository": "git://github.com/gaetanlegac/proteum.git",
+	"license": "MIT",
+	"engines": {
+		"node": ">=16.1.0",
+		"npm": ">=3.10.10"
+	},
+	"keywords": [
+		"framework"
+	],
+	"bin": {
+		"proteum": "cli/bin.js"
+	},
+	"dependencies": {
+		"@lexical/file": "^0.19.0",
+		"@lexical/headless": "^0.18.0",
+		"@lexical/html": "^0.18.0",
+		"@lexical/react": "^0.18.0",
+		"@prisma/client": "^6.5.0",
+		"accepts": "^1.3.7",
+		"activity-detector": "^3.0.0",
+		"ansi-to-html": "^0.7.1",
+		"array-move": "^3.0.1",
+		"aws-sdk": "^2.1415.0",
+		"bowser": "^2.11.0",
+		"chart.js": "^3.6.2",
+		"cli-highlight": "^2.1.11",
+		"compression": "^1.7.4",
+		"cookie-parser": "^1.4.5",
+		"core-js": "^3.18.1",
+		"cors": "^2.8.5",
+		"cron-parser": "^4.0.0",
+		"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",
+		"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",
+		"intl": "^1.2.5",
+		"iso-639-1": "^2.1.9",
+		"js-cookie": "^3.0.1",
+		"jsdom": "^25.0.1",
+		"jsonwebtoken": "^8.5.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",
+		"module-alias": "^2.2.2",
+		"mysql2": "^2.3.0",
+		"object-sizeof": "^1.6.3",
+		"path-to-regexp": "^6.2.0",
+		"picomatch": "^2.3.1",
+		"preact": "^10.27.1",
+		"preact-render-to-string": "^6.6.1",
+		"prettier": "^3.3.3",
+		"react-scrollbars-custom": "^4.0.27",
+		"react-textarea-autosize": "^8.5.9",
+		"regenerator-runtime": "^0.13.9",
+		"request": "^2.88.2",
+		"slugify": "^1.6.6",
+		"source-map-support": "^0.5.21",
+		"sql-formatter": "^4.0.2",
+		"stopword": "^3.1.1",
+		"tslog": "^4.9.1",
+		"uuid": "^8.3.2",
+		"uuid-by-string": "^3.0.4",
+		"validator": "^13.7.0",
+		"ws": "^8.2.2",
+		"yaml": "^1.10.2",
+		"yargs-parser": "^21.1.1",
+		"youch": "^3.3.3",
+		"youch-terminal": "^2.2.3",
+		"zod": "^4.1.5",
+		"@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",
+		"@prefresh/webpack": "^3.3.2",
+		"@squoosh/lib": "^0.4.0",
+		"@tailwindcss/postcss": "^4.1.17",
+		"autoprefixer": "^10.4.21",
+		"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",
+		"brotli-webpack-plugin": "^1.1.0",
+		"browser-sync": "^2.27.5",
+		"compression-webpack-plugin": "^8.0.1",
+		"console-table-printer": "^2.10.0",
+		"css-loader": "^6.2.0",
+		"css-minimizer-webpack-plugin": "^7.0.4",
+		"favicons": "^7.2.0",
+		"filesize": "^8.0.3",
+		"image-minimizer-webpack-plugin": "^4.1.4",
+		"imagemin": "^9.0.1",
+		"imagemin-svgo": "^10.0.0",
+		"imagemin-webp": "^6.0.0",
+		"json5": "^2.2.0",
+		"less-loader": "^10.0.1",
+		"less-vars-to-js": "^1.3.0",
+		"mini-css-extract-plugin": "^2.2.2",
+		"minimatch": "^3.0.4",
+		"node-cmd": "^5.0.0",
+		"node-notifier": "^10.0.0",
+		"null-loader": "^4.0.1",
+		"postcss-loader": "^8.2.0",
+		"prompts": "^2.4.2",
+		"react-dev-utils": "^11.0.4",
+		"replace-once": "^1.0.0",
+		"responsive-loader": "^3.1.2",
+		"serialize-javascript": "^6.0.2",
+		"sharp": "^0.34.3",
+		"speed-measure-webpack-plugin": "^1.5.0",
+		"tailwindcss": "^4.1.17",
+		"terser-webpack-plugin": "^5.2.4",
+		"ts-alias": "^0.0.7",
+		"ts-node": "^10.9.1",
+		"webfont": "^11.2.26",
+		"webpack": "^5.98.0",
+		"webpack-assets-manifest": "^5.0.6",
+		"webpack-bundle-analyzer": "^4.4.2",
+		"webpack-dev-middleware": "^5.1.0",
+		"webpack-hot-middleware": "^2.25.0",
+		"webpack-node-externals": "^3.0.0",
+		"webpack-virtual-modules": "^0.4.3"
+	},
+	"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"
+	}
+}

package/server/app/commands.ts

@@ -0,0 +1,141 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// Npm
+import yargsParser from 'yargs-parser';
+
+// Core
+import type { Application } from '@server/app';
+import Service from '@server/app/service';
+import { NotFound } from '@common/errors';
+
+/*----------------------------------
+- TYPES
+----------------------------------*/
+
+type CommandCallback<TArgs extends any[]> = (...args: TArgs) => Promise<any>
+
+export type CommandsList = {
+    [commandName: string]: Command
+}
+
+export type Command<TArgs extends any[] = any[]> = {
+    name: string,
+    description: string,
+    run?: CommandCallback<TArgs>
+    childrens: CommandsList
+}
+
+/*----------------------------------
+- SERVICE TYPES
+----------------------------------*/
+
+const LogPrefix = `[commands]`;
+
+export type Config = {
+    debug: boolean
+}
+
+export type Hooks = {
+
+}
+
+export type Services = {
+
+}
+
+/*----------------------------------
+- SERVICE
+----------------------------------*/
+export default class CommandsManager extends Service<Config, Hooks, Application> {
+
+    public priority = 2 as 2;
+
+    public commandsIndex: CommandsList = {}
+    
+    public command<TArgs extends any[]>( 
+        ...args: (
+            [name: string, description: string, childrens: Command[]]
+            |
+            [name: string, description: string, run: CommandCallback<TArgs>, childrens?: Command[]]
+        )
+    ): Command {
+
+        let name: string, description: string;
+        let childrens: Command[] | undefined;
+        let run: CommandCallback<TArgs> | undefined;
+
+        if (typeof args[2] === 'object')
+            ([name, description, childrens] = args)
+        else
+            ([name, description, run, childrens] = args)
+        
+        const command: Command = {
+            name,
+            description,
+            run, 
+            childrens: childrens ? this.indexFromList(childrens) : {}
+        }
+
+        return command;
+    }
+
+    private indexFromList( list: Command[] ): CommandsList {
+
+        const index: CommandsList = {}
+        for (const command of list)
+            index[ command.name ] = command;
+
+        return index;
+    }
+
+    /*----------------------------------
+    - REGISTER
+    ----------------------------------*/
+    public fromList( list: Command[] ) {
+        for (const command of list) {
+
+            if (this.commandsIndex[ command.name ] !== undefined)
+                throw new Error(`Tried to register command "${command.name}", but it already has been defined.`);
+
+            this.commandsIndex[ command.name ] = command;
+        }
+    }
+
+    /*----------------------------------
+    - RUN
+    ----------------------------------*/
+    public async run( commandString: string ) {
+
+        const { _, ...args } = yargsParser(commandString);
+
+        this.config.debug && console.log(LogPrefix, `Run command: ${commandString} | Parsed:`, { _, ...args });
+
+        let command: Command | undefined;
+        for (const commandName of _) {
+
+            const commandsList: CommandsList = command === undefined 
+                ? this.commandsIndex
+                : command.childrens;
+
+            command = commandsList[commandName];
+
+            if (command === undefined)
+                break;
+        }
+
+        if (command === undefined)
+            throw new NotFound(`Command not found.`);
+
+        if (command.run === undefined)
+            throw new NotFound(`This command isn't runnable.`);
+
+        // TODO: order correctly & validate type according to injected typescript typedefs (command.run.params)
+        const argsList = Object.values(args);
+
+        const result = await command.run(argsList);
+
+        return result;    
+    }
+}

package/server/app/container/config.ts

@@ -0,0 +1,203 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+/*
+    WARNING: This file SHOULDN'T import deps from the project
+        Because it's imported by the CLI, which should be independant of the app escept for loading config
+*/
+
+// Npm
+import fs from 'fs-extra';
+import yaml from 'yaml';
+
+// Types
+import type { TDomainsList } from '@common/router';
+import type { TLogProfile } from './console';
+
+/*----------------------------------
+- TYPES
+----------------------------------*/
+
+declare global {
+    namespace Config {
+
+        type EnvName = TEnvConfig["name"];
+
+        type Env = TEnvConfig;
+        type Identity = AppIdentityConfig;
+        interface Services {}
+    }
+}
+
+/*
+    name: server
+    profile: prod
+
+    router:
+        port: 80
+        domains:
+            current: 'https://recruiters.becrosspath.com'
+            recruiters: 'https://recruiters.becrosspath.com'
+            landing: 'https://becrosspath.com'
+            employers: 'https://employers.becrosspath.com'
+            candidates: 'https://candidates.becrosspath.com'
+            csm: 'https://csm.becrosspath.com'
+
+    database:
+        name: 'aws'
+        databases: [railway]
+        host: 'mysql-z7vp.railway.internal'
+        port: 3306
+        login: root
+        password: "GMnVsczoyYkyzwvVqDkMUOAIjVsumEev"
+
+    console:
+        enable: false
+        debug: false
+        bufferLimit: 10000
+        level: 'log'
+*/
+
+export type TEnvName = TEnvConfig["name"];
+export type TEnvConfig = {
+    name: 'local' | 'server',
+    profile: 'dev' | 'testing' | 'prod',
+    
+    router: {
+        port: number,
+        domains: TDomainsList
+    },
+    console: {
+        enable: boolean,
+        debug: boolean,
+        bufferLimit: number,
+        level: TLogProfile,
+    },
+}
+
+type AppIdentityConfig = {
+
+    name: string,
+    identifier: string,
+    description: string,
+    author: {
+        name: string,
+        url: string,
+        email: string
+    },
+
+    social: {
+
+    },
+
+    locale: string
+    language: string
+    maincolor: string, 
+    iconsPack?: string,
+
+    web: {
+        title: string,
+        titleSuffix: string,
+        fullTitle: string,
+        description: string,
+        version: string,
+        metas?: {[name: string]: string},
+        jsonld?: {[name: string]: string},
+    }                         
+}
+
+export type AppConfig = { 
+    env: Config.Env, 
+    identity: Config.Identity,
+}
+
+const debug = false;
+
+/*----------------------------------
+- LOADE
+----------------------------------*/
+export default class ConfigParser {
+
+    public constructor(
+        public appDir: string,
+        public envName?: string
+    ) {
+
+    }
+
+    private loadYaml( filepath: string ) {
+        debug && console.info(`Loading config ${filepath}`);
+        const rawConfig = fs.readFileSync(filepath, 'utf-8');
+        return yaml.parse(rawConfig);
+    }
+
+    public env(): TEnvConfig {
+        // We assume that when we run 5htp dev, we're in local
+        // Otherwise, we're in production environment (docker)
+        console.log("[app] Using environment:", process.env.NODE_ENV);
+        const envFileName = this.appDir + '/env.yaml';
+        const envFile = this.loadYaml( envFileName );
+        return {
+            ...envFile,
+            version: BUILD_DATE
+        }
+    }
+
+    public identity() {
+        const identityFile = this.appDir + '/identity.yaml';
+        debug && console.info(`Loading identity ${identityFile}`);
+        return this.loadYaml( identityFile );
+    }
+}
+
+/*const walkYaml = (dir: string, configA: any, envName: string) => {
+
+    const files = fs.readdirSync(dir);
+    for (const file of files) {
+
+        const fullpath = dir + '/' + file;
+
+        // extension .yaml
+        const isDir = fs.lstatSync(fullpath).isDirectory();
+        let key = file;
+        if (!isDir) {
+
+            if (!file.endsWith('.yaml'))
+                continue;
+
+            key = key.substring(0, key.length - 5);
+
+        }
+
+        let fileConfig = configA;
+
+        // Ciblage environnement
+        // Before: /config/services/env.<envName>.yaml
+        // After: /config/services
+        if (key.startsWith('env.')) {
+
+            // Excluding not mtching env name
+            if (key.substring(4) !== envName)
+                continue;
+
+        // Créé l'entrée dans la config, sauf si le nom du fichier est default
+        } else if (key !== 'default') {
+
+            // Init config
+            if (!(key in fileConfig))
+                fileConfig[key] = {};
+
+            fileConfig = configA[key];
+
+        }
+
+        // Recursion
+        if (isDir)
+            walk(fullpath, fileConfig, envName);
+        // Lecture fichier
+        else
+            deepExtend(fileConfig, loadYaml(fullpath));
+
+    }
+}*/