@underpostnet/underpost 2.99.8 → 3.0.0

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.8';
+  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/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,7 +1335,7 @@ 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');
+  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/manifests/lxd/underpost-setup.sh

@@ -1,163 +0,0 @@
-#!/bin/bash
-
-# Exit immediately if a command exits with a non-zero status.
-set -e
-
-echo "Starting Underpost Kubernetes Node Setup for Production (Kubeadm/K3s Use Case)..."
-
-# --- Disk Partition Resizing (Keep as is, seems functional) ---
-echo "Expanding /dev/sda2 partition and resizing filesystem..."
-
-# Check if parted is installed
-if ! command -v parted &>/dev/null; then
-    echo "parted not found, installing..."
-    sudo dnf install -y parted
-fi
-
-# Get start sector of /dev/sda2
-START_SECTOR=$(sudo parted /dev/sda -ms unit s print | awk -F: '/^2:/{print $2}' | sed 's/s//')
-
-# Resize the partition
-# Using 'sudo' for parted commands
-sudo parted /dev/sda ---pretend-input-tty <<EOF
-unit s
-resizepart 2 100%
-Yes
-quit
-EOF
-
-# Resize the filesystem
-sudo resize2fs /dev/sda2
-
-echo "Disk and filesystem resized successfully."
-
-# --- Essential System Package Installation ---
-echo "Installing essential system packages..."
-sudo dnf install -y tar bzip2 git epel-release
-
-# Perform a system update to ensure all packages are up-to-date
-sudo dnf -y update
-
-# --- NVM and Node.js Installation ---
-echo "Installing NVM and Node.js v24.10.0..."
-curl -o- https://cdn.jsdelivr.net/gh/nvm-sh/nvm@v0.40.1/install.sh | bash
-
-# Load nvm for the current session
-export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
-[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
-
-nvm install 24.10.0
-nvm use 24.10.0
-
-echo "
-██╗░░░██╗███╗░░██╗██████╗░███████╗██████╗░██████╗░░█████╗░░██████╗████████╗
-██║░░░██║████╗░██║██╔══██╗██╔════╝██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝
-██║░░░██║██╔██╗██║██║░░██║█████╗░░██████╔╝██████╔╝██║░░██║╚█████╗░░░░██║░░░
-██║░░░██║██║╚████║██║░░██║██╔══╝░░██╔══██╗██╔═══╝░██║░░██║░╚═══██╗░░░██║░░░
-╚██████╔╝██║░╚███║██████╔╝███████╗██║░░██║██║░░░░░╚█████╔╝██████╔╝░░░██║░░░
-░╚═════╝░╚═╝░░╚══╝╚═════╝░╚══════╝╚═╝░░╚═╝╚═╝░░░░░░╚════╝░╚═════╝░░░░╚═╝░░░
-
-Installing underpost k8s node...
-"
-
-# Install underpost globally
-npm install -g underpost
-
-# Ensure underpost executable is in PATH and has execute permissions
-# Adjusting this for global npm install which usually handles permissions
-# If you still face issues, ensure /root/.nvm/versions/node/v24.10.0/bin is in your PATH
-# For global installs, it's usually handled automatically.
-# chmod +x /root/.nvm/versions/node/v24.10.0/bin/underpost # This might not be necessary for global npm installs
-
-# --- Kernel Module for Bridge Filtering ---
-# This is crucial for Kubernetes networking (CNI)
-echo "Loading br_netfilter kernel module..."
-sudo modprobe br_netfilter
-
-# --- Initial Host Setup for Kubernetes Prerequisites ---
-# This calls the initHost method in cluster.js to install Docker, Podman, Kind, Kubeadm, Helm.
-echo "Running initial host setup for Kubernetes prerequisites..."
-# Ensure the current directory is where 'underpost' expects its root, or use absolute paths.
-# Assuming 'underpost root' correctly points to the base directory of your project.
-cd "$(underpost root)/underpost"
-underpost cluster --init-host
-
-# --- Argument Parsing for Kubeadm/Kind/K3s/Worker ---
-USE_KUBEADM=false
-USE_KIND=false # Not the primary focus for this request, but keeping the logic
-USE_K3S=false  # New K3s option
-USE_WORKER=false
-
-for arg in "$@"; do
-    case "$arg" in
-    --kubeadm)
-        USE_KUBEADM=true
-        ;;
-    --kind)
-        USE_KIND=true
-        ;;
-    --k3s) # New K3s argument
-        USE_K3S=true
-        ;;
-    --worker)
-        USE_WORKER=true
-        ;;
-    esac
-done
-
-echo "USE_KUBEADM = $USE_KUBEADM"
-echo "USE_KIND      = $USE_KIND"
-echo "USE_K3S      = $USE_K3S" # Display K3s flag status
-echo "USE_WORKER   = $USE_WORKER"
-
-# --- Kubernetes Cluster Initialization Logic ---
-
-# Apply host configuration (SELinux, Containerd, Sysctl, and now firewalld disabling)
-echo "Applying Kubernetes host configuration (SELinux, Containerd, Sysctl, Firewalld)..."
-underpost cluster --config
-
-if $USE_KUBEADM; then
-    if $USE_WORKER; then
-        echo "Running worker node setup for kubeadm..."
-        # For worker nodes, the 'underpost cluster --worker' command will handle joining
-        # the cluster. The join command itself needs to be provided from the control plane.
-        # This script assumes the join command will be executed separately or passed in.
-        # Example: underpost cluster --worker --join-command "kubeadm join ..."
-        # For now, this just runs the worker-specific config.
-        underpost cluster --worker
-        underpost cluster --chown
-        echo "Worker node setup initiated. You will need to manually join this worker to your control plane."
-        echo "On your control plane, run 'kubeadm token create --print-join-command' and execute the output here."
-    else
-        echo "Running control plane setup with kubeadm..."
-        # This will initialize the kubeadm control plane and install Calico
-        underpost cluster --kubeadm
-        echo "Kubeadm control plane initialized. Check cluster status with 'kubectl get nodes'."
-    fi
-elif $USE_K3S; then # New K3s initialization block
-    if $USE_WORKER; then
-        echo "Running worker node setup for K3s..."
-        # For K3s worker nodes, the 'underpost cluster --worker' command will handle joining
-        # the cluster. The K3s join command (k3s agent --server ...) needs to be provided.
-        underpost cluster --worker --k3s
-        underpost cluster --chown
-        echo "K3s Worker node setup initiated. You will need to manually join this worker to your control plane."
-        echo "On your K3s control plane, get the K3S_TOKEN from /var/lib/rancher/k3s/server/node-token"
-        echo "and the K3S_URL (e.g., https://<control-plane-ip>:6443)."
-        echo "Then execute: K3S_URL=${K3S_URL} K3S_TOKEN=${K3S_TOKEN} curl -sfL https://get.k3s.io | sh -"
-    else
-        echo "Running control plane setup with K3s..."
-        underpost cluster --k3s
-        echo "K3s control plane initialized. Check cluster status with 'kubectl get nodes'."
-    fi
-elif $USE_KIND; then
-    echo "Running control node with kind..."
-    underpost cluster
-    echo "Kind cluster initialized. Check cluster status with 'kubectl get nodes'."
-else
-    echo "No specific cluster role (--kubeadm, --kind, --k3s, --worker) specified. Please provide one."
-    exit 1
-fi
-
-echo "Underpost Kubernetes Node Setup completed."
-echo "Remember to verify cluster health with 'kubectl get nodes' and 'kubectl get pods --all-namespaces'."