underpost 2.8.82 → 2.8.85

package/src/client/public/default/safari-pinned-tab.svg

@@ -0,0 +1,24 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="269.000000pt" height="269.000000pt" viewBox="0 0 269.000000 269.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.11, written by Peter Selinger 2001-2013
+</metadata>
+<g transform="translate(0.000000,269.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M980 2475 l0 -65 65 0 65 0 0 65 0 65 -65 0 -65 0 0 -65z"/>
+<path d="M1700 2475 l0 -65 65 0 65 0 0 65 0 65 -65 0 -65 0 0 -65z"/>
+<path d="M1110 2325 l0 -65 -85 0 -85 0 0 -140 0 -140 -60 0 -60 0 0 -160 0
+-160 75 0 75 0 0 -100 0 -100 95 0 95 0 0 -40 0 -40 -240 0 -240 0 0 -445 0
+-445 -65 0 -65 0 0 -135 0 -135 65 0 65 0 0 -55 0 -55 65 0 65 0 0 475 0 475
+85 0 85 0 0 -425 0 -425 425 0 425 0 0 425 0 425 85 0 85 0 0 -475 0 -475 65
+0 65 0 0 55 0 55 60 0 60 0 0 135 0 135 -60 0 -60 0 0 445 0 445 -240 0 -240
+0 0 35 0 35 95 0 95 0 0 105 0 105 75 0 75 0 0 160 0 160 -60 0 -60 0 0 140 0
+140 -85 0 -85 0 0 65 0 65 -75 0 -75 0 0 -65 0 -65 -145 0 -145 0 0 65 0 65
+-75 0 -75 0 0 -65z m210 -505 l0 -110 -110 0 -110 0 0 110 0 110 110 0 110 0
+0 -110z m390 0 l0 -70 -70 0 -70 0 0 70 0 70 70 0 70 0 0 -70z"/>
+</g>
+</svg>

package/src/client/ssr/body/DefaultSplashScreen.js

@@ -1,12 +1,12 @@
 SrrComponent = ({ backgroundImage, metadata }) => html`
   ${backgroundImage
-    ? html`<style>
+    ? html`<style class="style-ssr-background-image">
         .ssr-background-image {
           background-image: url('${backgroundImage}');
         }
       </style>`
     : metadata?.themeColor
-    ? html`<style>
+    ? html`<style class="style-ssr-background-image">
         .ssr-background-image {
           background: ${metadata.themeColor};
         }

package/src/index.js

@@ -16,8 +16,10 @@ import UnderpostImage from './cli/image.js';
 import UnderpostLxd from './cli/lxd.js';
 import UnderpostMonitor from './cli/monitor.js';
 import UnderpostRepository from './cli/repository.js';
+import UnderpostRun from './cli/run.js';
 import UnderpostScript from './cli/script.js';
 import UnderpostSecret from './cli/secrets.js';
+import UnderpostSSH from './cli/ssh.js';
 import UnderpostTest from './cli/test.js';
 import UnderpostStartUp from './server/start.js';
 
@@ -33,102 +35,109 @@ class Underpost {
    * @type {String}
    * @memberof Underpost
    */
-  static version = 'v2.8.82';
+  static version = 'v2.8.85';
   /**
    * Repository cli API
    * @static
-   * @type {UnderpostRepository}
+   * @type {UnderpostRepository.API}
    * @memberof Underpost
    */
   static repo = UnderpostRepository.API;
   /**
    * Root Env cli API
    * @static
-   * @type {UnderpostRootEnv}
+   * @type {UnderpostRootEnv.API}
    * @memberof Underpost
    */
   static env = UnderpostRootEnv.API;
   /**
    * Test cli API
    * @static
-   * @type {UnderpostTest}
+   * @type {UnderpostTest.API}
    * @memberof Underpost
    */
   static test = UnderpostTest.API;
   /**
    * Underpost Start Up cli API
    * @static
-   * @type {UnderpostStartUp}
+   * @type {UnderpostStartUp.API}
    * @memberof Underpost
    */
   static start = UnderpostStartUp.API;
   /**
    * Cluster cli API
    * @static
-   * @type {UnderpostCluster}
+   * @type {UnderpostCluster.API}
    * @memberof Underpost
    */
   static cluster = UnderpostCluster.API;
   /**
    * Image cli API
    * @static
-   * @type {UnderpostImage}
+   * @type {UnderpostImage.API}
    * @memberof Underpost
    */
   static image = UnderpostImage.API;
   /**
    * Secrets cli API
    * @static
-   * @type {UnderpostSecret}
+   * @type {UnderpostSecret.API}
    * @memberof Underpost
    */
   static secret = UnderpostSecret.API;
   /**
    * Scripts cli API
    * @static
-   * @type {UnderpostScript}
+   * @type {UnderpostScript.API}
    * @memberof Underpost
    */
   static script = UnderpostScript.API;
   /**
    * Database cli API
    * @static
-   * @type {UnderpostDB}
+   * @type {UnderpostDB.API}
    * @memberof Underpost
    */
   static db = UnderpostDB.API;
   /**
    * Deployment cli API
    * @static
-   * @type {UnderpostDeploy}
+   * @type {UnderpostDeploy.API}
    * @memberof Underpost
    */
   static deploy = UnderpostDeploy.API;
   /**
    * Cron cli API
    * @static
-   * @type {UnderpostCron}
+   * @type {UnderpostCron.API}
    * @memberof Underpost
    */
   static cron = UnderpostCron.API;
   /**
    * File Storage cli API
    * @static
-   * @type {UnderpostFileStorage}
+   * @type {UnderpostFileStorage.API}
    * @memberof Underpost
    */
   static fs = UnderpostFileStorage.API;
   /**
    * Monitor cli API
    * @static
-   * @type {UnderpostMonitor}
+   * @type {UnderpostMonitor.API}
    * @memberof Underpost
    */
   static monitor = UnderpostMonitor.API;
+  /**
+   * SSH cli API
+   * @static
+   * @type {UnderpostSSH.API}
+   * @memberof Underpost
+   */
+  static ssh = UnderpostSSH.API;
   /**
    * LXD cli API
    * @static
-   * @type {UnderpostLxd}
+   * @type {UnderpostLxd.API}
    * @memberof Underpost
    */
   static lxd = UnderpostLxd.API;
@@ -136,15 +145,23 @@ class Underpost {
   /**
    * Cloud Init cli API
    * @static
-   * @type {UnderpostCloudInit}
+   * @type {UnderpostCloudInit.API}
    * @memberof Underpost
    */
   static cloudInit = UnderpostCloudInit.API;
 
+  /**
+   * Run cli API
+   * @static
+   * @type {UnderpostRun.API}
+   * @memberof Underpost
+   */
+  static run = UnderpostRun.API;
+
   /**
    * Baremetal cli API
    * @static
-   * @type {UnderpostBaremetal}
+   * @type {UnderpostBaremetal.API}
    * @memberof Underpost
    */
   static baremetal = UnderpostBaremetal.API;

package/src/monitor.js

@@ -0,0 +1,24 @@
+'use strict';
+
+// https://nodejs.org/api
+// https://expressjs.com/en/4x/api.html
+
+import dotenv from 'dotenv';
+import { loggerFactory } from './server/logger.js';
+import { ProcessController } from './server/process.js';
+import { getUnderpostRootPath } from './server/conf.js';
+import fs from 'fs-extra';
+import UnderpostMonitor from './cli/monitor.js';
+
+const underpostRootPath = getUnderpostRootPath();
+fs.existsSync(`${underpostRootPath}/.env`)
+  ? dotenv.config({ path: `${underpostRootPath}/.env`, override: true })
+  : dotenv.config();
+
+const logger = loggerFactory(import.meta);
+
+await logger.setUpInfo();
+
+UnderpostMonitor.API.callback(process.argv[2], process.argv[3], { type: 'blue-green', sync: true });
+
+ProcessController.init(logger);

package/src/runtime/lampp/Dockerfile

@@ -1,43 +1,35 @@
 FROM rockylinux:9
 
-RUN dnf install -y --allowerasing bzip2
-
-RUN dnf update -y
-RUN dnf install -y epel-release
-RUN dnf install -y --allowerasing sudo
-RUN dnf install -y --allowerasing curl
-RUN dnf install -y --allowerasing net-tools
-RUN dnf install -y --allowerasing openssh-server
-RUN dnf install -y --allowerasing nano
-RUN dnf install -y --allowerasing vim-enhanced
-RUN dnf install -y --allowerasing less
-RUN dnf install -y --allowerasing openssl-devel
-RUN dnf install -y --allowerasing wget
-RUN dnf install -y --allowerasing git
-RUN dnf install -y --allowerasing gnupg2
-RUN dnf clean all
-
-# Install LAMPP (XAMPP)
-# Download the XAMPP installer for Linux
-RUN curl -Lo xampp-linux-installer.run https://sourceforge.net/projects/xampp/files/XAMPP%20Linux/7.4.33/xampp-linux-x64-7.4.33-0-installer.run?from_af=true
-RUN chmod +x xampp-linux-installer.run
-# Run the XAMPP installer in silent mode
-RUN bash -c './xampp-linux-installer.run --mode unattended'
-# Create a symbolic link for easy access to lampp command
-RUN ln -sf /opt/lampp/lampp /usr/bin/lampp
-
-# Configure XAMPP
-# Enable XAMPP web interface (remove security checks)
-RUN sed -i.bak 's/Require local/Require all granted/g' /opt/lampp/etc/extra/httpd-xampp.conf
-# Enable error display in php
-RUN sed -i.bak 's/display_errors=Off/display_errors=On/g' /opt/lampp/etc/php.ini
-# Enable includes of several configuration files for Apache
-RUN mkdir -p /opt/lampp/apache2/conf.d
-RUN echo "IncludeOptional /opt/lampp/apache2/conf.d/*.conf" >>/opt/lampp/etc/httpd.conf
-# Create a /www folder and a symbolic link to it in /opt/lampp/htdocs
-# This is convenient because it doesn't interfere with xampp, phpmyadmin or other tools
-RUN mkdir /www
-RUN ln -s /www /opt/lampp/htdocs
+# --- 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 && \
+    dnf clean all
+
+# --- Download and install XAMPP
+RUN curl -L -o /tmp/xampp-linux-installer.run "https://sourceforge.net/projects/xampp/files/XAMPP%20Linux/7.4.33/xampp-linux-x64-7.4.33-0-installer.run" && \
+    chmod +x /tmp/xampp-linux-installer.run && \
+    bash -c "/tmp/xampp-linux-installer.run --mode unattended" && \
+    ln -sf /opt/lampp/lampp /usr/bin/lampp
+
+# --- Create /xampp/htdocs (static root) and set permissions
+RUN mkdir -p /opt/lampp/htdocs && \
+    chown -R root:root /opt/lampp/htdocs && \
+    chmod -R a+rX /opt/lampp/htdocs
 
 # Install Node.js
 RUN curl -fsSL https://rpm.nodesource.com/setup_23.x | bash -
@@ -51,7 +43,6 @@ RUN npm --version
 # Set working directory
 WORKDIR /home/dd
 
-# Expose necessary ports
 EXPOSE 22
 EXPOSE 80
 EXPOSE 443

package/src/runtime/lampp/Lampp.js

@@ -10,7 +10,16 @@ const Lampp = {
   initService: async function (options = { daemon: false }) {
     let cmd;
     // linux
-    fs.writeFileSync(`/opt/lampp/apache2/conf/httpd.conf`, this.router || '', 'utf8');
+    // /opt/lampp/apache2/conf/httpd.conf
+    fs.writeFileSync(`/opt/lampp/etc/extra/httpd-vhosts.conf`, this.router || '', 'utf8');
+    fs.writeFileSync(
+      `/opt/lampp/etc/httpd.conf`,
+      fs
+        .readFileSync(`/opt/lampp/etc/httpd.conf`, 'utf8')
+        .replace(`#Include etc/extra/httpd-vhosts.conf`, `Include etc/extra/httpd-vhosts.conf`),
+      'utf8',
+    );
+
     cmd = `sudo /opt/lampp/lampp stop`;
     if (!fs.readFileSync(`/opt/lampp/etc/httpd.conf`, 'utf8').match(`# Listen 80`))
       fs.writeFileSync(
@@ -42,7 +51,7 @@ const Lampp = {
     if (this.router) fs.writeFileSync(`./tmp/lampp-router.conf`, this.router, 'utf-8');
     shellExec(cmd);
   },
-  enabled: () => fs.existsSync(`/opt/lampp/apache2/conf/httpd.conf`),
+  enabled: () => fs.existsSync(`/opt/lampp/etc/httpd.conf`),
   appendRouter: function (render) {
     if (!this.router) {
       if (fs.existsSync(`./tmp/lampp-router.conf`))

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

@@ -0,0 +1,205 @@
+'use strict';
+
+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';
+
+/**
+ * Builds API documentation using Swagger
+ * @param {Object} options - Documentation build options
+ * @param {string} options.host - The hostname for the API
+ * @param {string} options.path - The base path for the API
+ * @param {number} options.port - The port number for the API
+ * @param {Object} options.metadata - Metadata for the API documentation
+ * @param {Array<string>} options.apis - List of API modules to document
+ * @param {string} options.publicClientId - Client ID for the public documentation
+ * @param {string} options.rootClientPath - Root path for client files
+ * @param {Object} options.packageData - Package.json data
+ */
+const buildApiDocs = async ({
+  host,
+  path,
+  port,
+  metadata = {},
+  apis = [],
+  publicClientId,
+  rootClientPath,
+  packageData,
+}) => {
+  const logger = loggerFactory(import.meta);
+  const basePath = path === '/' ? `${process.env.BASE_API}` : `/${process.env.BASE_API}`;
+
+  const doc = {
+    info: {
+      version: packageData.version,
+      title: metadata?.title ? `${metadata.title}` : 'REST API',
+      description: metadata?.description ? metadata.description : '',
+    },
+    servers: [
+      {
+        url:
+          process.env.NODE_ENV === 'development'
+            ? `http://localhost:${port}${path}${basePath}`
+            : `https://${host}${path}${basePath}`,
+        description: `${process.env.NODE_ENV} server`,
+      },
+    ],
+    tags: [
+      {
+        name: 'user',
+        description: 'User API operations',
+      },
+    ],
+    components: {
+      schemas: {
+        userRequest: {
+          username: 'user123',
+          password: 'Password123',
+          email: 'user@example.com',
+        },
+        userResponse: {
+          status: 'success',
+          data: {
+            token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjY2YzM3N2Y1N2Y5OWU1OTY5YjgxZG...',
+            user: {
+              _id: '66c377f57f99e5969b81de89',
+              email: 'user@example.com',
+              emailConfirmed: false,
+              username: 'user123',
+              role: 'user',
+              profileImageId: '66c377f57f99e5969b81de87',
+            },
+          },
+        },
+        userUpdateResponse: {
+          status: 'success',
+          data: {
+            _id: '66c377f57f99e5969b81de89',
+            email: 'user@example.com',
+            emailConfirmed: false,
+            username: 'user123222',
+            role: 'user',
+            profileImageId: '66c377f57f99e5969b81de87',
+          },
+        },
+        userGetResponse: {
+          status: 'success',
+          data: {
+            _id: '66c377f57f99e5969b81de89',
+            email: 'user@example.com',
+            emailConfirmed: false,
+            username: 'user123222',
+            role: 'user',
+            profileImageId: '66c377f57f99e5969b81de87',
+          },
+        },
+        userLogInRequest: {
+          email: 'user@example.com',
+          password: 'Password123',
+        },
+        userBadRequestResponse: {
+          status: 'error',
+          message: 'Bad request. Please check your inputs, and try again',
+        },
+      },
+      securitySchemes: {
+        bearerAuth: {
+          type: 'http',
+          scheme: 'bearer',
+        },
+      },
+    },
+  };
+
+  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`);
+  }
+
+  await swaggerAutoGen({ openapi: '3.0.0' })(outputFile, routes, doc);
+};
+
+/**
+ * Builds JSDoc documentation
+ * @param {Object} options - JSDoc build options
+ * @param {string} options.host - The hostname for the documentation
+ * @param {string} options.path - The base path for the documentation
+ * @param {Object} options.metadata - Metadata for the documentation
+ */
+const buildJsDocs = async ({ host, path, metadata = {} }) => {
+  const logger = loggerFactory(import.meta);
+  const jsDocsConfig = JSON.parse(fs.readFileSync(`./jsdoc.json`, 'utf8'));
+
+  jsDocsConfig.opts.destination = `./public/${host}${path === '/' ? path : `${path}/`}docs/`;
+  jsDocsConfig.opts.theme_opts.title = metadata?.title ? metadata.title : undefined;
+  jsDocsConfig.opts.theme_opts.favicon = `./public/${host}${path === '/' ? path : `${path}/favicon.ico`}`;
+
+  fs.writeFileSync(`./jsdoc.json`, JSON.stringify(jsDocsConfig, null, 4), 'utf8');
+  logger.warn('build jsdoc view', jsDocsConfig.opts.destination);
+
+  shellExec(`npm run docs`, { silent: true });
+};
+
+/**
+ * Builds test coverage documentation
+ * @param {Object} options - Coverage build options
+ * @param {string} options.host - The hostname for the coverage
+ * @param {string} options.path - The base path for the coverage
+ */
+const buildCoverage = async ({ host, path }) => {
+  const logger = loggerFactory(import.meta);
+  const jsDocsConfig = JSON.parse(fs.readFileSync(`./jsdoc.json`, 'utf8'));
+
+  if (!fs.existsSync(`./coverage`)) {
+    shellExec(`npm test`);
+  }
+
+  const coverageBuildPath = `${jsDocsConfig.opts.destination}/coverage`;
+  fs.mkdirSync(coverageBuildPath, { recursive: true });
+  fs.copySync(`./coverage`, coverageBuildPath);
+
+  logger.warn('build coverage', coverageBuildPath);
+};
+
+/**
+ * Main function to build all documentation
+ * @param {Object} options - Documentation build options
+ * @param {string} options.host - The hostname
+ * @param {string} options.path - The base path
+ * @param {number} options.port - The port number
+ * @param {Object} options.metadata - Metadata for the documentation
+ * @param {Array<string>} options.apis - List of API modules to document
+ * @param {string} options.publicClientId - Client ID for the public documentation
+ * @param {string} options.rootClientPath - Root path for client files
+ * @param {Object} options.packageData - Package.json data
+ */
+const buildDocs = async ({
+  host,
+  path,
+  port,
+  metadata = {},
+  apis = [],
+  publicClientId,
+  rootClientPath,
+  packageData,
+}) => {
+  await buildJsDocs({ host, path, metadata });
+  await buildCoverage({ host, path });
+  await buildApiDocs({
+    host,
+    path,
+    port,
+    metadata,
+    apis,
+    publicClientId,
+    rootClientPath,
+    packageData,
+  });
+};
+
+export { buildDocs };