@underpostnet/underpost 2.98.3 → 2.99.0

package/src/server/dns.js

@@ -2,17 +2,17 @@
  * Provides a comprehensive set of DNS and IP management utilities,
  * primarily focused on dynamic DNS (DDNS) updates and network checks.
  * @module src/server/dns.js
- * @namespace DnsManager
+ * @namespace UnderpostDns
  */
 import axios from 'axios';
 import dotenv from 'dotenv';
 import fs from 'fs';
 import validator from 'validator';
 import { loggerFactory } from './logger.js';
-import UnderpostRootEnv from '../cli/env.js';
 import dns from 'node:dns';
 import os from 'node:os';
 import { shellExec, pbcopy } from './process.js';
+import Underpost from '../index.js';
 
 dotenv.config();
 
@@ -23,14 +23,14 @@ const logger = loggerFactory(import.meta);
  * All utility methods are implemented as static to serve as a namespace container.
  * @class Dns
  * @augments Dns
- * @memberof DnsManager
+ * @memberof UnderpostDns
  */
 class Dns {
   /**
    * Retrieves the current public IP address (IPv4 or IPv6).
    * @async
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @returns {Promise<string>} The public IP address.
    */
   static async getPublicIp() {
@@ -49,7 +49,7 @@ class Dns {
   /**
    * Checks for active internet connection by performing a DNS lookup on a specified domain.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} [domain='google.com'] The domain to check the connection against.
    * @returns {Promise<boolean>} True if connected, false otherwise.
    */
@@ -61,9 +61,9 @@ class Dns {
    * Determines the default network interface name using shell command.
    * This method is primarily intended for Linux environments.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @returns {string} The default network interface name.
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    */
   static getDefaultNetworkInterface() {
     return shellExec(`ip route | grep default | cut -d ' ' -f 5`, {
@@ -77,7 +77,7 @@ class Dns {
    * Gets the local device's IPv4 address by determining the active network interface.
    * This relies on shell execution (`ip route`) and is primarily intended for Linux environments.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @returns {string} The local IPv4 address.
    */
   static getLocalIPv4Address() {
@@ -105,7 +105,7 @@ class Dns {
   /**
    * Setup nftables tables and chains if they don't exist.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    */
   static setupNftables() {
     shellExec(`sudo nft add table inet filter 2>/dev/null`, { silent: true });
@@ -126,7 +126,7 @@ class Dns {
   /**
    * Bans an IP address from ingress traffic.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} ip - The IP address to ban.
    */
   static banIngress(ip) {
@@ -142,7 +142,7 @@ class Dns {
   /**
    * Bans an IP address from egress traffic.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} ip - The IP address to ban.
    */
   static banEgress(ip) {
@@ -159,7 +159,7 @@ class Dns {
   /**
    * Helper to get nftables rule handles for a specific IP and chain.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} chain - The chain name (input, output, forward).
    * @param {string} ip - The IP address.
    * @param {string} type - The type (saddr or daddr).
@@ -184,7 +184,7 @@ class Dns {
   /**
    * Unbans an IP address from ingress traffic.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} ip - The IP address to unban.
    */
   static unbanIngress(ip) {
@@ -198,7 +198,7 @@ class Dns {
   /**
    * Unbans an IP address from egress traffic.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} ip - The IP address to unban.
    */
   static unbanEgress(ip) {
@@ -216,7 +216,7 @@ class Dns {
   /**
    * Lists all banned ingress IPs.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    */
   static listBannedIngress() {
     const output = shellExec(`sudo nft list chain inet filter input`, { stdout: true, silent: true });
@@ -226,7 +226,7 @@ class Dns {
   /**
    * Lists all banned egress IPs.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    */
   static listBannedEgress() {
     console.log('--- Output Chain ---');
@@ -238,7 +238,7 @@ class Dns {
   /**
    * Clears all banned ingress IPs.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    */
   static clearBannedIngress() {
     shellExec(`sudo nft flush chain inet filter input`, { silent: true });
@@ -248,7 +248,7 @@ class Dns {
   /**
    * Clears all banned egress IPs.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    */
   static clearBannedEgress() {
     shellExec(`sudo nft flush chain inet filter output`, { silent: true });
@@ -261,7 +261,7 @@ class Dns {
    * It checks if the public IP has changed and, if so, updates the configured DNS records.
    * @async
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} deployList Comma-separated string of deployment IDs to process.
    * @returns {Promise<void>}
    */
@@ -278,11 +278,11 @@ class Dns {
       logger.error(error, { testIp, stack: error.stack });
     }
 
-    const currentIp = UnderpostRootEnv.API.get('ip');
+    const currentIp = Underpost.env.get('ip');
 
     if (validator.isIP(testIp) && currentIp !== testIp) {
       logger.info(`New IP detected`, testIp);
-      UnderpostRootEnv.API.set('monitor-input', 'pause');
+      Underpost.env.set('monitor-input', 'pause');
 
       for (const _deployId of deployList.split(',')) {
         const deployId = _deployId.trim();
@@ -326,8 +326,8 @@ class Dns {
           logger.info(ipUrlTest + ' verify ip', verifyIp);
           if (verifyIp === testIp) {
             logger.info('IP updated successfully and verified', testIp);
-            UnderpostRootEnv.API.set('ip', testIp);
-            UnderpostRootEnv.API.delete('monitor-input');
+            Underpost.env.set('ip', testIp);
+            Underpost.env.delete('monitor-input');
           } else {
             logger.error('IP not updated or verification failed', { expected: testIp, received: verifyIp });
           }
@@ -345,14 +345,14 @@ class Dns {
   /**
    * Internal collection of external DNS service update functions.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @property {object} updateIp - Functions keyed by DNS provider name to update A/AAAA records.
    */
   static services = {
     updateIp: {
       /**
        * Updates the IP address for a dondominio.com DNS record.
-       * @memberof DnsManager
+       * @memberof UnderpostDns
        * @param {object} options
        * @param {string} options.user - The dondominio DDNS username.
        * @param {string} options.api_key - The dondominio DDNS password/API key.
@@ -392,7 +392,7 @@ class Dns {
   /**
    * Dispatcher for IP ban/unban/list/clear operations based on CLI options.
    * @static
-   * @memberof DnsManager
+   * @memberof UnderpostDns
    * @param {string} [ips=''] Comma-separated string of IPs to process.
    * @param {object} options - Options indicating which action to perform.
    * @property {boolean} [options.banIngressAdd=false] - Ban IPs from ingress.
@@ -483,7 +483,7 @@ class Dns {
 
 /**
  * @function isInternetConnection
- * @memberof DnsManager
+ * @memberof UnderpostDns
  * @description Exported function for backward compatibility.
  * @param {string} [domain='google.com']
  * @returns {Promise<boolean>}
@@ -492,13 +492,21 @@ const isInternetConnection = Dns.isInternetConnection;
 
 /**
  * @function getLocalIPv4Address
- * @memberof DnsManager
+ * @memberof UnderpostDns
  * @description Exported function for backward compatibility.
  * @returns {string}
  */
 const getLocalIPv4Address = Dns.getLocalIPv4Address;
 
-// Export the class as default and all original identifiers for backward compatibility.
-export default Dns;
+/**
+ * Main UnderpostDns class exposing the Dns API.
+ * @class UnderpostDns
+ * @memberof UnderpostDns
+ */
+class UnderpostDns {
+  static API = Dns;
+}
+
+export default UnderpostDns;
 
-export { Dns, isInternetConnection, getLocalIPv4Address };
+export { Dns, isInternetConnection, getLocalIPv4Address, UnderpostDns };

package/src/server/peer.js

@@ -10,7 +10,7 @@
 import { PeerServer } from 'peer';
 import dotenv from 'dotenv';
 import { loggerFactory } from './logger.js';
-import UnderpostStartUp from './start.js';
+import Underpost from '../index.js';
 
 dotenv.config();
 
@@ -61,7 +61,7 @@ const createPeerServer = async ({ port, origins, path }) => {
   };
 
   // Use the framework's factory to listen on the server, ensuring graceful startup/shutdown
-  const peerServer = UnderpostStartUp.API.listenServerFactory(async () => PeerServer(options));
+  const peerServer = Underpost.start.listenServerFactory(async () => PeerServer(options));
 
   return { options, peerServer, meta: import.meta };
 };

package/src/server/process.js

@@ -11,7 +11,7 @@ import shell from 'shelljs';
 import dotenv from 'dotenv';
 import { loggerFactory } from './logger.js';
 import clipboard from 'clipboardy';
-import UnderpostRootEnv from '../cli/env.js';
+import Underpost from '../index.js';
 
 dotenv.config();
 
@@ -83,7 +83,7 @@ const ProcessController = {
       this.logger.info(`process on exit`, args);
     });
     this.onSigListen();
-    UnderpostRootEnv.API.delete('await-deploy');
+    Underpost.env.delete('await-deploy');
   },
 };
 

package/src/server/proxy.js

@@ -12,12 +12,13 @@ import dotenv from 'dotenv';
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import { loggerFactory, loggerMiddleware } from './logger.js';
 import { buildPortProxyRouter, buildProxyRouter, getTlsHosts, isDevProxyContext, isTlsDevProxy } from './conf.js';
-import UnderpostStartUp from './start.js';
-import UnderpostDeploy from '../cli/deploy.js';
+
 import { SSL_BASE, TLS } from './tls.js';
 import { shellExec } from './process.js';
 import fs from 'fs-extra';
 
+import Underpost from '../index.js';
+
 dotenv.config();
 
 const logger = loggerFactory(import.meta);
@@ -85,12 +86,12 @@ class ProxyService {
             case 443:
               // For port 443 (HTTPS), create the SSL server
               const { ServerSSL } = await TLS.createSslServer(app, hosts);
-              await UnderpostStartUp.API.listenPortController(ServerSSL, port, runningData);
+              await Underpost.start.listenPortController(ServerSSL, port, runningData);
               break;
 
             default:
               // For other ports in production, use standard HTTP
-              await UnderpostStartUp.API.listenPortController(app, port, runningData);
+              await Underpost.start.listenPortController(app, port, runningData);
               break;
           }
           break;
@@ -108,18 +109,18 @@ class ProxyService {
                 }
               }
               const { ServerSSL } = await TLS.createSslServer(app, tlsHosts);
-              await UnderpostStartUp.API.listenPortController(ServerSSL, port, runningData);
+              await Underpost.start.listenPortController(ServerSSL, port, runningData);
               break;
             }
             default: // In non-production, always use standard HTTP listener
-              await UnderpostStartUp.API.listenPortController(app, port, runningData);
+              await Underpost.start.listenPortController(app, port, runningData);
               break;
           }
       }
       logger.info('Proxy running', { port, options });
       if (process.env.NODE_ENV === 'development')
         logger.info(
-          UnderpostDeploy.API.etcHostFactory(Object.keys(options.router), {
+          Underpost.deploy.etcHostFactory(Object.keys(options.router), {
             append: true,
           }).renderHosts,
         );

package/src/server/runtime.js

@@ -10,7 +10,6 @@ import fs from 'fs-extra';
 import dotenv from 'dotenv';
 import * as promClient from 'prom-client';
 
-import UnderpostStartUp from './start.js';
 import { loggerFactory } from './logger.js';
 import { newInstance } from '../client/components/core/CommonJs.js';
 import { Lampp } from '../runtime/lampp/Lampp.js';
@@ -18,6 +17,8 @@ import { getInstanceContext } from './conf.js';
 
 import ExpressService from '../runtime/express/Express.js';
 
+import Underpost from '../index.js';
+
 dotenv.config();
 
 const logger = loggerFactory(import.meta);
@@ -142,11 +143,7 @@ const buildRuntime = async () => {
               resetRouter: currentPort === initPort,
             });
             if (disabled) continue;
-            await UnderpostStartUp.API.listenPortController(
-              UnderpostStartUp.API.listenServerFactory(),
-              port,
-              runningData,
-            );
+            await Underpost.start.listenPortController(Underpost.start.listenServerFactory(), port, runningData);
           }
           break;
         default:
@@ -159,7 +156,7 @@ const buildRuntime = async () => {
 
   if (Lampp.enabled() && Lampp.router) Lampp.initService();
 
-  UnderpostStartUp.API.logRuntimeRouter();
+  Underpost.start.logRuntimeRouter();
 };
 
 export { buildRuntime };

package/src/server/start.js

@@ -4,13 +4,11 @@
  * @namespace UnderpostStartUp
  */
 
-import UnderpostDeploy from '../cli/deploy.js';
 import fs from 'fs-extra';
 import { awaitDeployMonitor } from './conf.js';
 import { actionInitLog, loggerFactory } from './logger.js';
 import { shellCd, shellExec } from './process.js';
-import UnderpostRootEnv from '../cli/env.js';
-
+import Underpost from '../index.js';
 const logger = loggerFactory(import.meta);
 
 /**
@@ -19,17 +17,32 @@ const logger = loggerFactory(import.meta);
  * @memberof UnderpostStartUp
  */
 class UnderpostStartUp {
+  /**
+   * Holds the NETWORK configuration.
+   * @memberof UnderpostStartUp
+   * @type {Object}
+   * @static
+   */
+  static NETWORK = {};
   static API = {
     /**
-     * Logs the runtime network configuration.
+     * Gets the current NETWORK configuration.
+     * @memberof UnderpostStartUp
+     * @returns {Object} The current NETWORK configuration.
+     */
+    get NETWORK() {
+      return UnderpostStartUp.NETWORK;
+    },
+    /**
+     * Logs the runtime this.NETWORK configuration.
      * @memberof UnderpostStartUp
      */
     logRuntimeRouter: () => {
       const displayLog = {};
 
-      for (const host of Object.keys(UnderpostDeploy.NETWORK))
-        for (const path of Object.keys(UnderpostDeploy.NETWORK[host]))
-          displayLog[UnderpostDeploy.NETWORK[host][path].publicHost] = UnderpostDeploy.NETWORK[host][path].local;
+      for (const host of Object.keys(this.NETWORK))
+        for (const path of Object.keys(this.NETWORK[host]))
+          displayLog[this.NETWORK[host][path].publicHost] = this.NETWORK[host][path].local;
 
       logger.info('Runtime network', displayLog);
     },
@@ -85,8 +98,8 @@ class UnderpostStartUp {
           if (error.length > 0) throw new Error('Listen port controller requires values: ' + error.join(', '));
 
           server.listen(port, () => {
-            if (!UnderpostDeploy.NETWORK[host]) UnderpostDeploy.NETWORK[host] = {};
-            UnderpostDeploy.NETWORK[host][path] = {
+            if (!this.NETWORK[host]) this.NETWORK[host] = {};
+            this.NETWORK[host][path] = {
               meta,
               client,
               runtime,
@@ -124,10 +137,10 @@ class UnderpostStartUp {
       env = 'development',
       options = { build: false, run: false, underpostQuicklyInstall: false },
     ) {
-      UnderpostRootEnv.API.set('container-status', `${deployId}-${env}-build-deployment`);
-      if (options.build === true) await UnderpostStartUp.API.build(deployId, env, options);
-      UnderpostRootEnv.API.set('container-status', `${deployId}-${env}-initializing-deployment`);
-      if (options.run === true) await UnderpostStartUp.API.run(deployId, env, options);
+      Underpost.env.set('container-status', `${deployId}-${env}-build-deployment`);
+      if (options.build === true) await Underpost.start.build(deployId, env, options);
+      Underpost.env.set('container-status', `${deployId}-${env}-initializing-deployment`);
+      if (options.run === true) await Underpost.start.run(deployId, env, options);
     },
     /**
      * Run itc-scripts and builds client bundle.
@@ -177,7 +190,7 @@ class UnderpostStartUp {
       shellExec(`node bin/deploy conf ${deployId} ${env}`);
       shellExec(`npm ${runCmd} ${deployId}`, { async: true });
       await awaitDeployMonitor(true);
-      UnderpostRootEnv.API.set('container-status', `${deployId}-${env}-running-deployment`);
+      Underpost.env.set('container-status', `${deployId}-${env}-running-deployment`);
     },
   };
 }
@@ -188,7 +201,7 @@ class UnderpostStartUp {
  * @returns
  */
 const createKeepAliveProcess = async () =>
-  await UnderpostStartUp.API.listenPortController(UnderpostStartUp.API.listenServerFactory(), ':');
+  await Underpost.start.listenPortController(Underpost.start.listenServerFactory(), ':');
 
 export default UnderpostStartUp;
 

package/src/ws/IoServer.js

@@ -8,8 +8,7 @@
 
 import { Server } from 'socket.io';
 import { loggerFactory } from '../server/logger.js';
-import UnderpostStartUp from '../server/start.js';
-
+import Underpost from '../index.js';
 import http from 'http';
 
 const logger = loggerFactory(import.meta);
@@ -60,7 +59,7 @@ class IoServerClass {
       path: options.path !== '/' ? `${options.path}/socket.io/` : '/socket.io/',
     };
 
-    const ioServerInstance = UnderpostStartUp.API.listenServerFactory(() =>
+    const ioServerInstance = Underpost.start.listenServerFactory(() =>
       new Server(httpServer, wsOptions).on('connection', ConnectionHandler),
     );
 

package/src/cli/script.js

@@ -1,85 +0,0 @@
-/**
- * Script module for managing the execution of scripts.
- * @module src/cli/script.js
- * @namespace UnderpostScript
- */
-
-import { getNpmRootPath } from '../server/conf.js';
-import { loggerFactory } from '../server/logger.js';
-import { shellExec } from '../server/process.js';
-import fs from 'fs-extra';
-import UnderpostDeploy from './deploy.js';
-
-const logger = loggerFactory(import.meta);
-
-/**
- * @class UnderpostScript
- * @description Manages the execution of scripts.
- * @memberof UnderpostScript
- */
-class UnderpostScript {
-  static API = {
-    /**
-     * @method set
-     * @description Sets a script in the package.json file.
-     * @param {string} key - The key for the script.
-     * @param {string} value - The value for the script.
-     * @memberof UnderpostScript
-     */
-    set(key, value) {
-      const npmRoot = `${getNpmRootPath()}/underpost`;
-      const packageJson = JSON.parse(fs.readFileSync(`${npmRoot}/package.json`, 'utf8'));
-      packageJson.scripts[key] = value;
-      fs.writeFileSync(`${npmRoot}/package.json`, JSON.stringify(packageJson, null, 4));
-    },
-    /**
-     * @method run
-     * @description Runs a script.
-     * @param {string} key - The key for the script.
-     * @param {string} value - The value for the script.
-     * @param {object} options - The options for the script.
-     * @memberof UnderpostScript
-     */
-    run(key, value, options) {
-      const npmRoot = `${getNpmRootPath()}/underpost`;
-      const packageJson = JSON.parse(fs.readFileSync(`${npmRoot}/package.json`, 'utf8'));
-      if (options.itc === true) {
-        value = packageJson.scripts[key];
-        const podScriptPath = `${options.itcPath && typeof options.itcPath === 'string' ? options.itcPath : '/'}${value
-          .split('/')
-          .pop()}`;
-        const nameSpace = options.ns && typeof options.ns === 'string' ? options.ns : 'default';
-        const podMatch = options.podName && typeof options.podName === 'string' ? options.podName : key;
-
-        if (fs.existsSync(`${value}`)) {
-          for (const pod of UnderpostDeploy.API.get(podMatch)) {
-            shellExec(`sudo kubectl cp ${value} ${nameSpace}/${pod.NAME}:${podScriptPath}`);
-            const cmd = `node ${podScriptPath}`;
-            shellExec(`sudo kubectl exec -i ${pod.NAME} -- sh -c "${cmd}"`);
-          }
-        } else {
-          for (const pod of UnderpostDeploy.API.get(podMatch)) {
-            shellExec(`sudo kubectl exec -i ${pod.NAME} -- sh -c "${value}"`);
-          }
-        }
-
-        return;
-      }
-      shellExec(`cd ${npmRoot} && npm run ${key}`);
-    },
-    /**
-     * @method get
-     * @description Gets a script from the package.json file.
-     * @param {string} key - The key for the script.
-     * @memberof UnderpostScript
-     */
-    get(key) {
-      const npmRoot = `${getNpmRootPath()}/underpost`;
-      const packageJson = JSON.parse(fs.readFileSync(`${npmRoot}/package.json`, 'utf8'));
-      logger.info('[get] ' + key, packageJson.scripts[key]);
-      return packageJson.scripts[key];
-    },
-  };
-}
-
-export default UnderpostScript;

package/src/monitor.js

@@ -1,34 +0,0 @@
-'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();
-
-const deployId = process.argv[2];
-const env = process.argv[3] || 'production';
-const replicas = process.argv[4] || '1';
-const namespace = process.argv[5] || 'default';
-
-UnderpostMonitor.API.callback(deployId, env, {
-  type: 'blue-green',
-  sync: true,
-  replicas,
-  namespace,
-});
-
-ProcessController.init(logger);