@vulkano/core 1.18.0 → 1.19.0

package/.oxlintrc.json

@@ -0,0 +1,42 @@
+{
+  "env": {
+    "node": true,
+    "browser": true,
+    "es6": true
+  },
+  "globals": {
+    "app": "readonly",
+    "io": "readonly",
+    "ApiClient": "readonly",
+    "Download": "readonly",
+    "Paginate": "readonly",
+    "Mixed": "readonly",
+    "Crontab": "readonly",
+    "Encrypter": "readonly",
+    "Filter": "readonly",
+    "i18n": "readonly",
+    "Jwt": "readonly",
+    "VSError": "readonly",
+    "ABS_PATH": "readonly",
+    "APP_PATH": "readonly",
+    "CORE_PATH": "readonly",
+    "PUBLIC_PATH": "readonly"
+  },
+  "rules": {
+    "curly": "error",
+    "no-console": "off",
+    "no-underscore-dangle": "off",
+    "no-throw-literal": "off",
+    "no-unneeded-ternary": "off",
+    "guard-for-in": "off"
+  },
+  "ignorePatterns": [
+    "node_modules",
+    "test",
+    "bundle",
+    "tasks",
+    "docs",
+    "public",
+    "setup"
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "oxc.enable": true,
+  "oxc.configPath": ".oxlintrc.json",
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.formatOnSave": true,
+  "javascript.format.enable": false,
+  "typescript.format.enable": false,
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  }
+}

package/app.js

@@ -10,9 +10,9 @@
 global.START_TIME = Date.now();
 
 const dotenv = require('dotenv');
-const path = require('path');
-const v8 = require('v8');
-const fs = require('fs');
+const path = require('node:path');
+const v8 = require('node:v8');
+const fs = require('node:fs');
 
 global.app = {};
 
@@ -81,11 +81,7 @@ const NODE_ENV = (process.env.NODE_ENV || 'development').toLowerCase();
 
 app.PRODUCTION = NODE_ENV === 'production' ? true : false;
 
-const {
-  views,
-  local,
-  env
-} = config || {};
+const { views, local, env } = config || {};
 
 // NODE_ENV
 const environmentConfig = env ? env[NODE_ENV] || {} : {};
@@ -121,12 +117,7 @@ app.config = allConfig;
 app.pkg = appPkg;
 
 // Include all components
-const {
-  lineWidth,
-  colors,
-  showCenteredText,
-  showColumn
-} = require('./bootstrap/logger');
+const { lineWidth, colors, showCenteredText, showColumn } = require('./bootstrap/logger');
 
 // Include all components
 const loadDatabase = require('./database/mongodb');
@@ -135,7 +126,6 @@ const loadControllers = require('./controllers/controllers');
 const loadServer = require('./bootstrap/server');
 
 async function startVulkano() {
-
   // Load Services
   loadServices();
 
@@ -155,17 +145,19 @@ async function startVulkano() {
   const cutLine = '-'.padEnd(lineWidth, '-');
 
   console.log('');
-  console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
+  console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
   console.log('');
-  console.log(colors.fg.cyan, showCenteredText('🌋'), colors.reset);
-  console.log(colors.fg.cyan, showCenteredText(`${appName} ${appVersion}`), colors.reset);
-  console.log(colors.fg.cyan, showCenteredText(`${pkg.name} ${pkg.version}`.toUpperCase()), colors.reset);
+  console.log(`${colors.fg.cyan}${showCenteredText('🌋')}${colors.reset}`);
+  console.log(`${colors.fg.cyan}${showCenteredText(`${appName} ${appVersion}`)}${colors.reset}`);
+  console.log(
+    `${colors.fg.cyan}${showCenteredText(`${pkg.name} ${pkg.version}`.toUpperCase())}${colors.reset}`
+  );
   console.log('');
-  console.log(colors.fg.blue, '🔗 github.com/vulkanojs/vulkano', colors.reset);
-  console.log(colors.fg.cyan, '☕ buymeacoffee.com/argordmel', colors.reset);
+  console.log(`${colors.fg.blue}🔗 github.com/vulkanojs/vulkano${colors.reset}`);
+  console.log(`${colors.fg.cyan}☕ buymeacoffee.com/argordmel${colors.reset}`);
   console.log('');
   console.log(` Author: ${colors.fg.green}${author}${colors.reset}`);
-  console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
+  console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
 
   // Routes
   app.routes = controllers;
@@ -181,33 +173,21 @@ async function startVulkano() {
     ...app.config.routes
   };
 
-  const {
-    bootstrap
-  } = config;
+  const { bootstrap } = config;
 
   if (!bootstrap || typeof bootstrap !== 'function') {
     console.log('Missing the boostrap file to start app: app/config/bootstrap.js');
     return;
   }
 
-  bootstrap( (callbackAfterInitVulkano) => {
-
+  bootstrap((callbackAfterInitVulkano) => {
     // Start Express
-    app.server.start( () => {
+    app.server.start(() => {
+      const { sockets, settings: configSettings, vite } = app.config || {};
 
-      const {
-        sockets,
-        settings: configSettings,
-        vite
-      } = app.config || {};
+      const { database } = configSettings || {};
 
-      const {
-        database
-      } = configSettings || {};
-
-      const {
-        connection
-      } = database || {};
+      const { connection } = database || {};
 
       const connectionToShow = connection && process.env.MONGO_URI ? 'MONGO_URI' : connection;
 
@@ -215,12 +195,13 @@ async function startVulkano() {
 
       const nodeVersion = process.version.match(/^v(\d+\.\d+\.\d+)/)[1];
       const portText = String(app.vulkano.get('port') || 8000);
-      const socketText = sockets.enabled ? 'YES' : 'NO';
-      const adapterText = sockets.enabled ? String(sockets.adapter || 'memory').toUpperCase() : 'NO';
+      const socketText = sockets.enabled ? String(sockets.adapter || 'memory').toUpperCase() : 'NO';
 
-      serverConfig.push(` PORT: ${colors.fg.green}${showColumn(portText, 7)}${colors.reset}`);
+      serverConfig.push(`🚀 PORT: ${colors.fg.green}${showColumn(portText, 7)}${colors.reset}`);
       serverConfig.push(' | ');
-      serverConfig.push(` ENV: ${app.PRODUCTION ? colors.fg.red : colors.fg.green}${showColumn(NODE_ENV, 0)}${colors.reset}`);
+      serverConfig.push(
+        `🌿 ENV: ${app.PRODUCTION ? colors.fg.red : colors.fg.green}${showColumn(NODE_ENV, 0)}${colors.reset}`
+      );
 
       console.log(serverConfig.join(''));
 
@@ -228,26 +209,41 @@ async function startVulkano() {
       const totalHeapSizeGb = (totalHeapSize / 1024 / 1024 / 1024).toFixed(2);
 
       const nodeConfig = [];
-      nodeConfig.push(` NODE: ${colors.fg.green}${showColumn(nodeVersion, 7)}${colors.reset}`);
+      nodeConfig.push(`📦 NODE: ${colors.fg.green}${showColumn(nodeVersion, 7)}${colors.reset}`);
       nodeConfig.push(' | ');
-      nodeConfig.push(' MAX MEM: ', `${colors.fg.green}${totalHeapSizeGb} GB${colors.reset}`);
+      nodeConfig.push(`🧠 MAX MEM: `, `${colors.fg.green}${totalHeapSizeGb} GB${colors.reset}`);
       console.log(nodeConfig.join(''));
 
       const startUpConfig = [];
-      startUpConfig.push(' SOCKETS: ', `${colors.fg.green}${showColumn(socketText, 10)}${colors.reset}`);
+      startUpConfig.push(
+        `🔌 SOCKETS: `,
+        `${sockets.enabled ? colors.fg.green : colors.fg.blue}${showColumn(socketText, 10)}${colors.reset}`
+      );
       startUpConfig.push(' | ');
-      startUpConfig.push(` STARTUP: ${colors.fg.green}${((Date.now() - global.START_TIME) / 1000).toFixed(3)}s${colors.reset}`);
+      startUpConfig.push(
+        `🍃 DB: `,
+        connection
+          ? `${colors.fg.green}${connectionToShow}${colors.reset}`
+          : `${colors.fg.blue}NO DATABASE${colors.reset}`
+      );
       console.log(startUpConfig.join(''));
 
-      const dbConfig = [];
-      dbConfig.push(' ADAPTER: ', `${colors.fg.green}${showColumn(adapterText, 10)}${colors.reset}`);
-      dbConfig.push(' | ');
-      dbConfig.push(' DB: ', connection ? `${colors.fg.green}${connectionToShow}${colors.reset}` : `${colors.fg.blue}NO DATABASE${colors.reset}`);
-      console.log(dbConfig.join(''));
+      if (vite?.enabled) {
+        console.log(
+          `${colors.fg.yellow}⚡ VITE${colors.reset}`,
+          `${colors.fg.green}${showColumn('ENABLED', 5)}${colors.reset}`,
+          `${colors.dim}${vite.buildPath || 'public/.vite'}${colors.reset}`
+        );
+      }
 
-      console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
+      const startupMs = ((Date.now() - global.START_TIME) / 1000).toFixed(3);
+      console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
+      console.log(
+        `${colors.bright}${colors.fg.cyan}${showCenteredText(`⚡ Ready in ${startupMs}s`)}${colors.reset}`
+      );
+      console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
 
-      if (vite && vite.enabled) {
+      if (vite?.enabled) {
         app.vite = Vite.init(vite.buildPath || 'public/.vite');
       }
 
@@ -255,11 +251,8 @@ async function startVulkano() {
       if (callbackAfterInitVulkano && typeof callbackAfterInitVulkano === 'function') {
         callbackAfterInitVulkano();
       }
-
     });
-
   });
-
 }
 
 module.exports = startVulkano;

package/bin/setup.js

@@ -7,9 +7,9 @@
  * creates the minimal folder structure and config files needed to start.
  */
 
-const fs = require('fs');
-const path = require('path');
-const readline = require('readline');
+const fs = require('node:fs');
+const path = require('node:path');
+const readline = require('node:readline');
 
 // npm sets INIT_CWD to the directory where `npm install` was invoked.
 // npm_config_local_prefix is the project root (directory containing node_modules).

package/biome.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.4.15/schema.json",
+  "files": {
+    "includes": [
+      "**",
+      "!node_modules",
+      "!test",
+      "!bundle",
+      "!tasks",
+      "!docs",
+      "!public",
+      "!setup"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "linter": {
+    "enabled": true
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingCommas": "none",
+      "semicolons": "always"
+    }
+  }
+}

package/bootstrap/engines/handlebars.js

@@ -0,0 +1,55 @@
+const { create: hbsCreate } = require('express-handlebars');
+
+// Wraps a Nunjucks-style function so it works as a Handlebars helper:
+//   Hash params  → {{{helper key=val}}}  calls fn({ key: val })
+//   Positional   → {{helper value}}      calls fn(value)
+//   String output is wrapped in SafeString to prevent double-escaping
+function wrapHelper(hbs, fn) {
+  return function hbsHelper(...args) {
+    const hbsOpts = args[args.length - 1];
+    const isHbsOptions = hbsOpts && typeof hbsOpts === 'object' && 'hash' in hbsOpts;
+    let result;
+    if (isHbsOptions) {
+      const positional = args.slice(0, -1);
+      result = positional.length === 0 ? fn(hbsOpts.hash) : fn(...positional);
+    } else {
+      result = fn(...args);
+    }
+    return typeof result === 'string' ? new hbs.handlebars.SafeString(result) : result;
+  };
+}
+
+function registerGroup(hbs, groups, method) {
+  (groups || []).forEach((group) => {
+    Object.keys(group || {}).forEach((key) => {
+      hbs.handlebars[method](key, wrapHelper(hbs, group[key]));
+    });
+  });
+}
+
+module.exports = function setupHandlebars(vulkano, views, viewsExt) {
+  const hbs = hbsCreate({
+    extname: viewsExt,
+    defaultLayout: views.defaultLayout !== undefined ? views.defaultLayout : 'default',
+    layoutsDir: views.layoutsDir || `${views.path}/_shared/templates`,
+    partialsDir: views.partialsDir || `${views.path}/_shared/partials`,
+    ...(views.settings || {})
+  });
+
+  registerGroup(hbs, views.filters, 'registerHelper');
+  registerGroup(hbs, views.helpers, 'registerHelper');
+
+  vulkano.use((_req, res, next) => {
+    (views.globals || []).forEach((group) => {
+      Object.assign(res.locals, group || {});
+    });
+    res.locals.app = app;
+    next();
+  });
+
+  vulkano.engine(viewsExt, hbs.engine);
+  vulkano.set('view engine', viewsExt);
+
+  app.server.views._engine = hbs;
+  app.handlebars = hbs;
+};

package/bootstrap/engines/index.js

@@ -0,0 +1,31 @@
+const viewsConfig = require('../views');
+
+const SUPPORTED_ENGINES = ['nunjucks', 'handlebars'];
+
+module.exports = function setupViewEngine(vulkano) {
+  const views = {
+    ext: '.html',
+    ...viewsConfig,
+    ...(app.server.views || {})
+  };
+
+  const engine = views.engine || 'nunjucks';
+  const ext = views.ext || '.html';
+
+  if (!SUPPORTED_ENGINES.includes(engine)) {
+    throw new Error(
+      `Vulkano: unsupported view engine "${engine}". Supported engines: ${SUPPORTED_ENGINES.join(', ')}.`
+    );
+  }
+
+  vulkano.set('views', views.path);
+
+  if (engine === 'handlebars') {
+    require('./handlebars')(vulkano, views, ext);
+  } else {
+    require('./nunjucks')(vulkano, views);
+  }
+
+  // Error view subfolder depends on engine (core dev-mode error templates)
+  return engine;
+};

package/bootstrap/engines/nunjucks.js

@@ -0,0 +1,33 @@
+const nunjucks = require('nunjucks');
+
+module.exports = function setupNunjucks(vulkano, views) {
+  const settings = {
+    autoescape: true,
+    watch: !app.PRODUCTION,
+    ...(views.settings || {}),
+    express: vulkano
+  };
+
+  const env = nunjucks.configure([views.path, CORE_PATH], settings);
+
+  env.addGlobal('app', app);
+
+  (views.globals || []).forEach((group) => {
+    Object.keys(group || {}).forEach((key) => env.addGlobal(key, group[key]));
+  });
+
+  (views.helpers || []).forEach((group) => {
+    Object.keys(group || {}).forEach((key) => env.addGlobal(key, group[key]));
+  });
+
+  (views.filters || []).forEach((group) => {
+    Object.keys(group || {}).forEach((key) => env.addFilter(key, group[key]));
+  });
+
+  (views.extensions || []).forEach((group) => {
+    Object.keys(group || {}).forEach((key) => env.addExtension(key, group[key]));
+  });
+
+  app.server.views._engine = env;
+  app.nunjucks = nunjucks;
+};

package/bootstrap/express.js

@@ -1,4 +1,4 @@
-const path = require('path');
+const path = require('node:path');
 
 const merge = require('../libs/Merge');
 

package/bootstrap/logger.js

@@ -1,6 +1,6 @@
 const logger = {
 
-  lineWidth: 39,
+  lineWidth: 41,
 
   colors: {
     reset: '\x1b[0m',
@@ -36,7 +36,7 @@ const logger = {
 
   showCenteredText(text) {
 
-    const colSize = (logger.lineWidth / 2) - 3;
+    const colSize = logger.lineWidth / 2;
     const textLength = (text || '').length;
     const textLeftSize = Math.trunc(textLength / 2);
     const textRightSize = textLength - textLeftSize;

package/bootstrap/responses.js

@@ -1,4 +1,4 @@
-const path = require('path');
+const path = require('node:path');
 
 // Include all user's responses
 const VulkanoResponses = require('include-all')({