@underpostnet/underpost 2.99.7 → 3.0.0

package/src/db/mariadb/MariaDB.js

@@ -1,4 +1,4 @@
-import mariadb from 'mariadb';
+import { createPool } from 'mariadb';
 
 import { loggerFactory } from '../../server/logger.js';
 
@@ -32,7 +32,7 @@ class MariaDBService {
    */
   async query(options) {
     const { host, port, user, password, query } = options;
-    const pool = mariadb.createPool({
+    const pool = createPool({
       host: 'host' in options ? host : '127.0.0.1',
       port: 'port' in options ? port : 3306,
       user: 'user' in options ? user : 'root',

package/src/index.js

@@ -12,6 +12,7 @@ import UnderpostDB from './cli/db.js';
 import UnderpostDeploy from './cli/deploy.js';
 import UnderpostRootEnv from './cli/env.js';
 import UnderpostFileStorage from './cli/fs.js';
+import UnderpostIPFS from './cli/ipfs.js';
 import UnderpostImage from './cli/image.js';
 import UnderpostLxd from './cli/lxd.js';
 import UnderpostMonitor from './cli/monitor.js';
@@ -41,7 +42,7 @@ class Underpost {
    * @type {String}
    * @memberof Underpost
    */
-  static version = 'v2.99.7';
+  static version = 'v3.0.0';
 
   /**
    * Required Node.js major version
@@ -143,6 +144,15 @@ class Underpost {
   static get fs() {
     return UnderpostFileStorage.API;
   }
+  /**
+   * IPFS cli API
+   * @static
+   * @type {UnderpostIPFS.API}
+   * @memberof Underpost
+   */
+  static get ipfs() {
+    return UnderpostIPFS.API;
+  }
   /**
    * Monitor cli API
    * @static
@@ -296,6 +306,7 @@ export {
   UnderpostStatic,
   UnderpostLxd,
   UnderpostKickStart,
+  UnderpostIPFS,
   UnderpostMonitor,
   UnderpostRepository,
   UnderpostRun,

package/src/runtime/express/Dockerfile

@@ -1,23 +1,23 @@
 FROM rockylinux:9
 
-# --- Update and install required packages
+# Update and install required packages
 RUN dnf -y update && \
     dnf -y install epel-release && \
     dnf -y install --allowerasing \
-        bzip2 \
-        sudo \
-        curl \
-        net-tools \
-        openssh-server \
-        nano \
-        vim-enhanced \
-        less \
-        openssl-devel \
-        wget \
-        git \
-        gnupg2 \
-        libnsl \
-        perl && \
+    bzip2 \
+    sudo \
+    curl \
+    net-tools \
+    openssh-server \
+    nano \
+    vim-enhanced \
+    less \
+    openssl-devel \
+    wget \
+    git \
+    gnupg2 \
+    libnsl \
+    perl && \
     dnf clean all
 
 

package/src/runtime/lampp/Dockerfile

@@ -1,23 +1,23 @@
 FROM rockylinux:9
 
-# --- Update and install required packages
+# Update and install required packages
 RUN dnf -y update && \
     dnf -y install epel-release && \
     dnf -y install --allowerasing \
-        bzip2 \
-        sudo \
-        curl \
-        net-tools \
-        openssh-server \
-        nano \
-        vim-enhanced \
-        less \
-        openssl-devel \
-        wget \
-        git \
-        gnupg2 \
-        libnsl \
-        perl && \
+    bzip2 \
+    sudo \
+    curl \
+    net-tools \
+    openssh-server \
+    nano \
+    vim-enhanced \
+    less \
+    openssl-devel \
+    wget \
+    git \
+    gnupg2 \
+    libnsl \
+    perl && \
     dnf clean all
 
 # --- Download and install XAMPP

package/src/server/client-build-docs.js

@@ -7,7 +7,6 @@
  */
 
 import fs from 'fs-extra';
-import swaggerAutoGen from 'swagger-autogen';
 import { shellExec } from './process.js';
 import { loggerFactory } from './logger.js';
 import { JSONweb } from './client-formatted.js';
@@ -123,13 +122,33 @@ const buildApiDocs = async ({
 
   logger.warn('build swagger api docs', doc.info);
 
-  const outputFile = `./public/${host}${path === '/' ? path : `${path}/`}swagger-output.json`;
-  const routes = [];
-  for (const api of apis) {
-    if (['user'].includes(api)) routes.push(`./src/api/${api}/${api}.router.js`);
-  }
+  // swagger-autogen@2.9.2 bug: getProducesTag, getConsumesTag, getResponsesTag missing __¬¬¬__ decode before eval
+  fs.writeFileSync(
+    `node_modules/swagger-autogen/src/swagger-tags.js`,
+    fs
+      .readFileSync(`node_modules/swagger-autogen/src/swagger-tags.js`, 'utf8')
+      // getProducesTag and getConsumesTag: already decode " but not __¬¬¬__
+      .replaceAll(
+        `data.replaceAll('\\n', ' ').replaceAll('\u201c', '\u201d')`,
+        `data.replaceAll('\\n', ' ').replaceAll('\u201c', '\u201d').replaceAll('__\u00ac\u00ac\u00ac__', '"')`,
+      )
+      // getResponsesTag: decodes neither " nor __¬¬¬__
+      .replaceAll(
+        `data.replaceAll('\\n', ' ');`,
+        `data.replaceAll('\\n', ' ').replaceAll('__\u00ac\u00ac\u00ac__', '"');`,
+      ),
+    'utf8',
+  );
+  setTimeout(async () => {
+    const { default: swaggerAutoGen } = await import('swagger-autogen');
+    const outputFile = `./public/${host}${path === '/' ? path : `${path}/`}swagger-output.json`;
+    const routes = [];
+    for (const api of apis) {
+      if (['user'].includes(api)) routes.push(`./src/api/${api}/${api}.router.js`);
+    }
 
-  await swaggerAutoGen({ openapi: '3.0.0' })(outputFile, routes, doc);
+    await swaggerAutoGen({ openapi: '3.0.0' })(outputFile, routes, doc);
+  });
 };
 
 /**

package/src/server/conf.js

@@ -1335,26 +1335,9 @@ const buildCliDoc = (program, oldVersion, newVersion) => {
   });
   md = md.replaceAll(oldVersion, newVersion);
   fs.writeFileSync(`./src/client/public/nexodev/docs/references/Command Line Interface.md`, md, 'utf8');
-  fs.writeFileSync(`./cli.md`, md, 'utf8');
-  const readmeSplit = `pwa-microservices-template</a>`;
-  const readme = fs.readFileSync(`./README.md`, 'utf8').split(readmeSplit);
-  fs.writeFileSync(
-    './README.md',
-    (
-      readme[0] +
-      readmeSplit +
-      `
-
-` +
-      baseOptions +
-      `
-
-<a target="_top" href="https://github.com/${process.env.GITHUB_USERNAME}/pwa-microservices-template/blob/master/cli.md">See complete CLI Docs here.</a>
-
-`
-    ).replaceAll(oldVersion, newVersion),
-    'utf8',
-  );
+  fs.writeFileSync(`./CLI-HELP.md`, md, 'utf8');
+  const readme = fs.readFileSync(`./README.md`, 'utf8');
+  fs.writeFileSync('./README.md', readme.replaceAll(oldVersion, newVersion), 'utf8');
 };
 
 /**

package/src/server/logger.js

@@ -101,27 +101,37 @@ const setUpInfo = async (logger = new winston.Logger()) => {
  * @param meta - The `meta` parameter in the `loggerFactory` function is used to extract the last part
  * of a URL and use it to create log files in a specific directory.
  * @param logLevel - Specify the logging level for the logger instance. e.g., 'error', 'warn', 'info', 'debug'.
+ * @param enableFileLogs - Whether to write logs to files. Defaults to the value of the `ENABLE_FILE_LOGS` environment variable.
  * @returns {underpostLogger} The `loggerFactory` function returns a logger instance created using Winston logger
  * library. The logger instance is configured with various transports for printing out messages to
  * different destinations such as the terminal, error.log file, and all.log file. The logger instance
  * also has a method `setUpInfo` attached to it for setting up additional information.
  * @memberof Logger
  */
-const loggerFactory = (meta = { url: '' }, logLevel = '') => {
+const loggerFactory = (
+  meta = { url: '' },
+  logLevel = '',
+  enableFileLogs = process.env.ENABLE_FILE_LOGS === 'true' || process.env.ENABLE_FILE_LOGS === true,
+) => {
   meta = meta.url.split('/').pop();
   // Define which transports the logger must use to print out messages.
   // In this example, we are using three different transports
   const transports = [
     // Allow the use the terminal to print the messages
     new winston.transports.Console(),
-    // Allow to print all the error level messages inside the error.log file
-    // new winston.transports.File({
-    //   filename: `logs/${meta}/error.log`,
-    //   level: 'error',
-    // }),
-    // Allow to print all the error message inside the all.log file
-    // (also the error log that are also printed inside the error.log(
-    new winston.transports.File({ filename: `logs/${meta}/all.log` }),
+    // Optionally write log files when enableFileLogs is true
+    ...(enableFileLogs
+      ? [
+          // Allow to print all the error level messages inside the error.log file
+          new winston.transports.File({
+            filename: `logs/${meta}/error.log`,
+            level: 'error',
+          }),
+          // Allow to print all the error messages inside the all.log file
+          // (also includes error logs that are also printed inside error.log)
+          new winston.transports.File({ filename: `logs/${meta}/all.log` }),
+        ]
+      : []),
   ];
 
   // Create the logger instance that has to be exported
@@ -154,6 +164,7 @@ const loggerFactory = (meta = { url: '' }, logLevel = '') => {
  * @param {Object} meta - An object containing metadata, such as the URL, to be used in the logger.
  * @param {string} logLevel - The logging level to be used for the logger (e.g., 'error', 'warn', 'info', 'debug').
  * @param {Function} skip - A function to determine whether to skip logging for a particular request.
+ * @param {boolean} enableFileLogs - Whether to write logs to files. Defaults to false.
  * @returns {Function} A middleware function that can be used in an Express application to log HTTP requests.
  * @memberof Logger
  */
@@ -161,10 +172,11 @@ const loggerMiddleware = (
   meta = { url: '' },
   logLevel = 'info',
   skip = (req, res) => process.env.NODE_ENV === 'production',
+  enableFileLogs = process.env.ENABLE_FILE_LOGS === 'true' || process.env.ENABLE_FILE_LOGS === true,
 ) => {
   const stream = {
     // Use the http severity
-    write: (message) => loggerFactory(meta, logLevel).http(message),
+    write: (message) => loggerFactory(meta, logLevel, enableFileLogs).http(message),
   };
 
   morgan.token('host', function (req, res) {

package/.vscode/zed.keymap.json

@@ -1,39 +0,0 @@
-[
-  {
-    "context": "Editor",
-    "bindings": {
-      "ctrl-c": "editor::Copy",
-      "ctrl-x": "editor::Cut",
-      "ctrl-v": "editor::Paste",
-      "ctrl-shift-c": "editor::CopyAndTrim",
-      "ctrl-shift-v": "editor::Paste",
-      "cmd-c": "editor::Copy",
-      "cmd-x": "editor::Cut",
-      "cmd-v": "editor::Paste"
-    }
-  },
-  {
-    "context": "Terminal",
-    "bindings": {
-      "ctrl-shift-c": "terminal::Copy",
-      "ctrl-shift-v": "terminal::Paste",
-      "cmd-shift-c": "terminal::Copy",
-      "cmd-shift-v": "terminal::Paste"
-    }
-  },
-  {
-    "context": "Editor && edit_prediction",
-    "bindings": {
-      "tab": "editor::AcceptEditPrediction",
-      "alt-tab": "editor::AcceptEditPrediction",
-      "alt-l": null
-    }
-  },
-  {
-    "context": "Editor && edit_prediction_conflict",
-    "bindings": {
-      "alt-l": "editor::AcceptEditPrediction",
-      "tab": "editor::ComposeCompletion"
-    }
-  }
-]

package/.vscode/zed.settings.json

@@ -1,20 +0,0 @@
-{
-  "ui_font_size": 16,
-  "buffer_font_size": 15,
-  "theme": {
-    "mode": "system",
-    "light": "One Dark",
-    "dark": "One Dark"
-  },
-
-  "features": {
-    "edit_prediction_provider": "copilot",
-    "copilot": true // https://github.com/login/device
-  },
-
-  "show_edit_predictions": true,
-
-  "edit_predictions": {
-    "mode": "eager"
-  }
-}

package/bin/cron.js

@@ -1,47 +0,0 @@
-import { BackUpManagement } from '../src/server/backup.js';
-import { Cmd } from '../src/server/conf.js';
-import { Dns } from '../src/server/dns.js';
-import { loggerFactory } from '../src/server/logger.js';
-import { netWorkCron, saveRuntimeCron } from '../src/server/network.js';
-import { shellExec } from '../src/server/process.js';
-import fs from 'fs-extra';
-
-const logger = loggerFactory(import.meta);
-
-await logger.setUpInfo();
-
-switch (process.argv[2]) {
-  case 'backups':
-    {
-      await BackUpManagement.Init({ deployId: process.argv[3] });
-    }
-    break;
-  case 'dns':
-    {
-      await Dns.InitIpDaemon({ deployId: process.argv[3] });
-    }
-    break;
-
-  case 'run': {
-    const confCronConfig = JSON.parse(fs.readFileSync(`./engine-private/conf/${process.argv[3]}/conf.cron.json`));
-    if (confCronConfig.jobs && Object.keys(confCronConfig.jobs).length > 0) {
-      shellExec(`node bin/deploy conf ${process.argv[3]} production`);
-      for (const job of Object.keys(confCronConfig.jobs)) {
-        if (confCronConfig.jobs[job].enabled) {
-          shellExec(Cmd.cron(process.argv[3], job, confCronConfig.jobs[job].expression));
-          netWorkCron.push({
-            deployId: process.argv[3],
-            jobId: job,
-            expression: confCronConfig.jobs[job].expression,
-          });
-        }
-      }
-    }
-    await saveRuntimeCron();
-    if (fs.existsSync(`./tmp/await-deploy`)) fs.remove(`./tmp/await-deploy`);
-    break;
-  }
-
-  default:
-    break;
-}

package/bin/db.js

@@ -1,199 +0,0 @@
-import fs from 'fs-extra';
-import { shellExec } from '../src/server/process.js';
-import { loggerFactory } from '../src/server/logger.js';
-import { MariaDB } from '../src/db/mariadb/MariaDB.js';
-import { Lampp } from '../src/runtime/lampp/Lampp.js';
-import { getCapVariableName, loadConf, splitFileFactory } from '../src/server/conf.js';
-import { DataBaseProvider } from '../src/db/DataBaseProvider.js';
-import { hashPassword } from '../src/server/auth.js';
-
-const logger = loggerFactory(import.meta);
-
-logger.info('argv', process.argv);
-
-const [exe, dir, hostPath = '', operator, deployId, arg0, arg1, arg2] = process.argv;
-const [host, _path = ''] = hostPath.split('/');
-const path = `/${_path}`;
-
-try {
-  let cmd;
-  if (deployId) loadConf(deployId);
-  const confServer = JSON.parse(fs.readFileSync(`./conf/conf.server.json`, 'utf8'));
-  const { runtime, db, git, client, directory } = confServer[host][path];
-  const { provider, name, user, password = '', backupPath = '' } = db;
-  // logger.info('database', confServer[host][`/${path}`].db);
-  switch (provider) {
-    case 'mariadb':
-      // Login:
-      // mysql -u root -h localhost -p
-
-      // Get Users:
-      // SELECT user,authentication_string,plugin,host FROM mysql.user;
-
-      // Get DB User:
-      // SELECT User, Db, Host from mysql.db;
-
-      // Change password:
-      // ALTER USER 'root'@'127.0.0.1' IDENTIFIED BY 'NEW_PASSWORD';
-      // ALTER USER 'root'@'localhost' IDENTIFIED BY 'NEW_PASSWORD';
-      // ALTER USER 'root'@'::1' IDENTIFIED BY 'NEW_PASSWORD';
-
-      // Get all user privileges:
-      // select * from information_schema.user_privileges;
-
-      // Expose public server:
-      // '/etc/mysql/my.cnf' Change lines:
-      // bind-address = 127.0.0.1 -> bind-address = 0.0.0.0
-      // skip-networking -> #skip-networking
-
-      // Create user:
-      // DROP USER 'username'@'%';
-      // CREATE USER 'username'@'%' IDENTIFIED BY 'password';
-
-      // Set DB user:
-      // FLUSH PRIVILEGES;
-      // ON databasename.*
-      // TO 'username'@'%'
-      // IDENTIFIED BY 'newpassword';
-      // FLUSH PRIVILEGES;
-
-      // Set admin:
-      // FLUSH PRIVILEGES;
-      // GRANT ALL PRIVILEGES ON *.* TO 'username'@'%' IDENTIFIED BY 'password' WITH GRANT OPTION;
-      // FLUSH PRIVILEGES;
-
-      switch (operator) {
-        case 'show-all':
-          await MariaDB.query({ user, password, query: `SHOW DATABASES` });
-          break;
-        case 'show':
-          await MariaDB.query({ user, password, query: `SHOW TABLES FROM ${name}` });
-          break;
-        case 'create':
-          await MariaDB.query({ user, password, query: `CREATE DATABASE ${name}` });
-          break;
-        case 'delete':
-          await MariaDB.query({ user, password, query: `DROP DATABASE IF EXISTS ${name}` });
-          break;
-        case 'select':
-          {
-            const pageSize = 10;
-            const pageNumber = 1;
-            await MariaDB.query({
-              user,
-              password,
-              query: `SELECT ${arg0} FROM ${name}.${arg1} LIMIT ${pageSize} OFFSET ${(pageNumber - 1) * pageSize}`,
-            });
-          }
-          break;
-        case 'count': {
-          await MariaDB.query({
-            user,
-            password,
-            query: `SELECT COUNT(*) AS total FROM ${name}.${arg0}`,
-          });
-        }
-        case 'export':
-          {
-            const cmdBackupPath = `${arg0 ? `${arg0}/${name}.sql` : backupPath}`;
-
-            cmd = `mysqldump -u ${user} -p${password} ${name} > ${cmdBackupPath}`;
-            shellExec(cmd);
-            await splitFileFactory(name, cmdBackupPath);
-          }
-          break;
-        case 'import':
-          break;
-
-        case 'init-lampp-service':
-          await Lampp.initService();
-          break;
-        case 'remote-client-access':
-          {
-            // https://docs.anaconda.com/miniconda/install/#quick-command-line-install
-            // https://mariadb.com/kb/en/configuring-mariadb-for-remote-client-access/
-            // conf: /opt/lampp/etc
-            // conf: /etc/mysql/my.cnf
-            // conf: /etc/mysql/mariadb.conf.d/50-server.cnf
-            // cli: /opt/lampp/bin/mysql
-            // cli: mysql -h 127.0.0.1
-            // select db: use db0;
-          }
-          break;
-        default:
-          break;
-      }
-
-      break;
-
-    case 'mongoose':
-      // MongoDB App Services CLI
-      switch (operator) {
-        case 'update':
-          {
-            await DataBaseProvider.load({ apis: [arg0], host, path, db });
-            const models = DataBaseProvider.instance[`${host}${path}`].mongoose.models[getCapVariableName(arg0)];
-
-            const select = JSON.parse(arg1.replaceAll("'", `"`));
-            const update = JSON.parse(arg2.replaceAll("'", `"`));
-
-            console.log({ models, select, update });
-
-            switch (arg0) {
-              case 'user':
-                if (update.password) update.password = hashPassword(update.password);
-
-              default:
-                break;
-            }
-            let doc = await models.findOne(select);
-            if (doc) {
-              doc = await models.findByIdAndUpdate(doc._id, update, {
-                runValidators: true,
-              });
-              logger.info(`successfully updated doc`, doc._doc);
-              await DataBaseProvider.instance[`${host}${path}`].mongoose.close();
-            } else throw new Error(`no doc found`);
-          }
-          break;
-        case 'show-all':
-          // show dbs
-          break;
-        case 'show':
-          break;
-        case 'create':
-          break;
-        case 'delete':
-          {
-            await DataBaseProvider.load({ apis: [arg0], host, path, db });
-            const models = DataBaseProvider.instance[`${host}${path}`].mongoose.models[getCapVariableName(arg0)];
-            await models.collection.drop();
-            logger.info(`successfully drop collection`, arg0);
-            await DataBaseProvider.instance[`${host}${path}`].mongoose.close();
-          }
-          break;
-        case 'export':
-          // mongodump -d <database_name> -o <directory_backup>
-          shellExec(`mongodump -d ${name} -o ${arg0 ? arg0 : `./engine-private/mongodb-backup/`}`);
-          break;
-        case 'import':
-          // mongorestore -d <database_name> <directory_backup>
-          break;
-        case 'init-service':
-          break;
-        default:
-          break;
-      }
-      break;
-
-    default:
-      break;
-  }
-
-  // logger.info(`Run the following command`, cmd);
-  // await ncp.copy(cmd);
-  // await read({ prompt: 'Command copy to clipboard, press enter to continue.\n' });
-  // throw new Error(``);
-} catch (error) {
-  logger.error(error, error.stack);
-}

package/bin/hwt.js

@@ -1,49 +0,0 @@
-import fs from 'fs-extra';
-
-import { loggerFactory } from '../src/server/logger.js';
-
-const logger = loggerFactory(import.meta);
-
-logger.info('argv', process.argv);
-
-const [exe, dir, operator, templateId, publicPath] = process.argv;
-
-// engine for 'html-website-templates'
-
-try {
-  switch (operator) {
-    case 'set-base':
-      {
-        switch (parseInt(templateId)) {
-          // Horizontal Scroll One Page Template Website
-          case 0:
-            {
-              fs.writeFile(
-                `${publicPath}/index.html`,
-                fs
-                  .readFileSync(`${publicPath}/index.html`, 'utf8')
-                  .replace(`<ul class="menu">`, `<ul class="menu hidden">`)
-                  .replaceAll(`<section class="slide fade-6 kenBurns">`, `<section class="fade-6 kenBurns hidden">`)
-                  .replace(`<section class="fade-6 kenBurns hidden">`, `<section class="slide fade-6 kenBurns">`)
-                  .replaceAll(
-                    `<nav class="panel bottom forceMobileView">`,
-                    `<nav class="panel bottom forceMobileView hidden">`,
-                  ),
-
-                'utf8',
-              );
-            }
-            break;
-
-          default:
-            break;
-        }
-      }
-      break;
-
-    default:
-      break;
-  }
-} catch (error) {
-  logger.error(error, error.stack);
-}