@underpostnet/underpost 2.99.5 → 2.99.7

package/src/index.js

@@ -6,6 +6,7 @@
 
 import UnderpostBaremetal from './cli/baremetal.js';
 import UnderpostCloudInit from './cli/cloud-init.js';
+import UnderpostKickStart from './cli/kickstart.js';
 import UnderpostCluster from './cli/cluster.js';
 import UnderpostDB from './cli/db.js';
 import UnderpostDeploy from './cli/deploy.js';
@@ -20,6 +21,7 @@ import UnderpostSecret from './cli/secrets.js';
 import UnderpostSSH from './cli/ssh.js';
 import UnderpostStatic from './cli/static.js';
 import UnderpostTest from './cli/test.js';
+import UnderpostSystemProvisionig from './cli/system.js';
 
 import UnderpostDns from './server/dns.js';
 import UnderpostBackup from './server/backup.js';
@@ -39,7 +41,7 @@ class Underpost {
    * @type {String}
    * @memberof Underpost
    */
-  static version = 'v2.99.5';
+  static version = 'v2.99.7';
 
   /**
    * Required Node.js major version
@@ -179,6 +181,16 @@ class Underpost {
     return UnderpostCloudInit.API;
   }
 
+  /**
+   * KickStart cli API
+   * @static
+   * @type {UnderpostKickStart.API}
+   * @memberof Underpost
+   */
+  static get kickstart() {
+    return UnderpostKickStart.API;
+  }
+
   /**
    * Run cli API
    * @static
@@ -200,7 +212,17 @@ class Underpost {
   }
 
   /**
-   * Dns cli API
+   * System Provisioning cli API
+   * @static
+   * @type {UnderpostSystemProvisionig.API}
+   * @memberof Underpost
+   */
+  static get system() {
+    return UnderpostSystemProvisionig.API;
+  }
+
+  /**
+   * Dns server API
    * @static
    * @type {UnderpostDns.API}
    * @memberof Underpost
@@ -210,7 +232,7 @@ class Underpost {
   }
 
   /**
-   * BackUp cli API
+   * BackUp server API
    * @static
    * @type {UnderpostBackup.API}
    * @memberof Underpost
@@ -220,7 +242,7 @@ class Underpost {
   }
 
   /**
-   * Cron cli API
+   * Cron server API
    * @static
    * @type {UnderpostCron.API}
    * @memberof Underpost
@@ -230,7 +252,7 @@ class Underpost {
   }
 
   /**
-   * Start Up cli API
+   * Start Up server API
    * @static
    * @type {UnderpostStartUp.API}
    * @memberof Underpost
@@ -273,6 +295,7 @@ export {
   UnderpostImage,
   UnderpostStatic,
   UnderpostLxd,
+  UnderpostKickStart,
   UnderpostMonitor,
   UnderpostRepository,
   UnderpostRun,

package/src/mailer/EmailRender.js

@@ -3,13 +3,13 @@ import { ssrFactory } from '../server/ssr.js';
 /**
  * Module for handling the rendering and styling of HTML emails using SSR components.
  * @module src/mailer/EmailRender.js
- * @namespace EmailRenderNamespace
+ * @namespace EmailRenderService
  */
 
 /**
  * @class
  * @alias EmailRenderService
- * @memberof EmailRenderNamespace
+ * @memberof EmailRenderService
  * @classdesc Utility class for managing CSS styles and rendering email templates using
  * Server-Side Rendering (SSR) components.
  */
@@ -108,7 +108,7 @@ class EmailRenderService {
 /**
  * Singleton instance of the EmailRenderService class for backward compatibility.
  * @alias EmailRender
- * @memberof EmailRenderNamespace
+ * @memberof EmailRenderService
  * @type {EmailRenderService}
  */
 const EmailRender = new EmailRenderService();

package/src/mailer/MailerProvider.js

@@ -5,7 +5,7 @@ import { EmailRender } from './EmailRender.js';
 /**
  * Module for configuring and sending emails using Nodemailer.
  * @module src/mailer/MailerProvider.js
- * @namespace MailerProviderNamespace
+ * @namespace MailerProviderService
  */
 
 const logger = loggerFactory(import.meta);
@@ -27,13 +27,13 @@ const logger = loggerFactory(import.meta);
  * @property {string} [host=''] - Application host for context.
  * @property {string} [path=''] - Application path for context.
  * @property {object.<string, string>} templates - Map of template keys to SSR component file names.
- * @memberof MailerProviderNamespace
+ * @memberof MailerProviderService
  */
 
 /**
  * @class
  * @alias MailerProviderService
- * @memberof MailerProviderNamespace
+ * @memberof MailerProviderService
  * @classdesc Manages multiple Nodemailer transporter instances and handles loading of
  * email templates and sending emails.
  */
@@ -205,7 +205,7 @@ class MailerProviderService {
 /**
  * Singleton instance of the MailerProviderService class for backward compatibility.
  * @alias MailerProvider
- * @memberof MailerProviderNamespace
+ * @memberof MailerProviderService
  * @type {MailerProviderService}
  */
 const MailerProvider = new MailerProviderService();

package/src/server/backup.js

@@ -1,13 +1,14 @@
 /**
  * Manages backup operations for deployments.
  * @module src/server/backup.js
- * @namespace BackUp
+ * @namespace UnderpostBakcUp
  */
 
 import fs from 'fs-extra';
 import { loggerFactory } from './logger.js';
 import { shellExec } from './process.js';
 import dotenv from 'dotenv';
+import Underpost from '../index.js';
 
 dotenv.config();
 
@@ -16,7 +17,7 @@ const logger = loggerFactory(import.meta);
 /**
  * @class BackUp
  * @description Manages backup operations for deployments.
- * @memberof BackUp
+ * @memberof UnderpostBakcUp
  */
 class BackUp {
   /**
@@ -25,7 +26,11 @@ class BackUp {
    * @param {string} deployList - The list of deployments to backup.
    * @param {Object} options - The options for the backup operation.
    * @param {boolean} options.git - Whether to backup data using Git.
-   * @memberof BackUp
+   * @param {boolean} [options.k3s] - Use k3s cluster context.
+   * @param {boolean} [options.kind] - Use kind cluster context.
+   * @param {boolean} [options.kubeadm] - Use kubeadm cluster context.
+   * @param {boolean} [options.ssh] - Execute backup commands via SSH on the remote node.
+   * @memberof UnderpostBakcUp
    */
   static callback = async function (deployList, options = { git: false }) {
     if ((!deployList || deployList === 'dd') && fs.existsSync(`./engine-private/deploy/dd.router`))
@@ -34,12 +39,25 @@ class BackUp {
     logger.info('init backups callback', deployList);
     await logger.setUpInfo();
 
+    const clusterFlag = options.k3s ? ' --k3s' : options.kind ? ' --kind' : options.kubeadm ? ' --kubeadm' : '';
+
     for (const _deployId of deployList.split(',')) {
       const deployId = _deployId.trim();
       if (!deployId) continue;
 
-      logger.info('Executing database export for', deployId);
-      shellExec(`node bin db ${options.git ? '--git ' : ''}--export ${deployId}`);
+      const command = `node bin db ${options.git ? '--git --force-clone ' : ''}--export --primary-pod${clusterFlag} ${deployId}`;
+
+      if (options.ssh) {
+        logger.info('Executing database export via SSH for', deployId);
+        await Underpost.ssh.sshRemoteRunner(command, {
+          remote: true,
+          useSudo: true,
+          cd: '/home/dd/engine',
+        });
+      } else {
+        logger.info('Executing database export for', deployId);
+        shellExec(command);
+      }
     }
   };
 }

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

@@ -1,5 +1,11 @@
 'use strict';
 
+/**
+ * Module for building project documentation (JSDoc, Swagger, Coverage).
+ * @module src/server/client-build-docs.js
+ * @namespace clientBuildDocs
+ */
+
 import fs from 'fs-extra';
 import swaggerAutoGen from 'swagger-autogen';
 import { shellExec } from './process.js';
@@ -8,6 +14,8 @@ import { JSONweb } from './client-formatted.js';
 
 /**
  * Builds API documentation using Swagger
+ * @function buildApiDocs
+ * @memberof clientBuildDocs
  * @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
@@ -126,18 +134,32 @@ const buildApiDocs = async ({
 
 /**
  * Builds JSDoc documentation
+ * @function buildJsDocs
+ * @memberof clientBuildDocs
  * @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
+ * @param {string} options.publicClientId - Client ID used to resolve the tutorials/references directory
  */
-const buildJsDocs = async ({ host, path, metadata = {} }) => {
+const buildJsDocs = async ({ host, path, metadata = {}, publicClientId }) => {
   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`}`;
+  jsDocsConfig.opts.theme_opts.favicon = `./public/${host}${path === '/' ? '/' : `${path}/`}favicon.ico`;
+
+  const tutorialsPath = `./src/client/public/${publicClientId}/docs/references`;
+  if (fs.existsSync(tutorialsPath)) {
+    jsDocsConfig.opts.tutorials = tutorialsPath;
+    if (jsDocsConfig.opts.theme_opts.sections && !jsDocsConfig.opts.theme_opts.sections.includes('Tutorials')) {
+      jsDocsConfig.opts.theme_opts.sections.push('Tutorials');
+    }
+    logger.info('build jsdoc tutorials', tutorialsPath);
+  } else {
+    delete jsDocsConfig.opts.tutorials;
+  }
 
   fs.writeFileSync(`./jsdoc.json`, JSON.stringify(jsDocsConfig, null, 4), 'utf8');
   logger.warn('build jsdoc view', jsDocsConfig.opts.destination);
@@ -147,6 +169,8 @@ const buildJsDocs = async ({ host, path, metadata = {} }) => {
 
 /**
  * Builds test coverage documentation
+ * @function buildCoverage
+ * @memberof clientBuildDocs
  * @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
@@ -168,6 +192,8 @@ const buildCoverage = async ({ host, path }) => {
 
 /**
  * Main function to build all documentation
+ * @function buildDocs
+ * @memberof clientBuildDocs
  * @param {Object} options - Documentation build options
  * @param {string} options.host - The hostname
  * @param {string} options.path - The base path
@@ -188,7 +214,7 @@ const buildDocs = async ({
   rootClientPath,
   packageData,
 }) => {
-  await buildJsDocs({ host, path, metadata });
+  await buildJsDocs({ host, path, metadata, publicClientId });
   await buildCoverage({ host, path });
   await buildApiDocs({
     host,

package/src/server/conf.js

@@ -1167,19 +1167,12 @@ const getPathsSSR = (conf) => {
 };
 
 /**
- * @method Cmd
+ * @method CmdUnderpost
  * @description The command factory.
  * @memberof ServerConfBuilder
+ * @namespace CmdUnderpost
  */
 const Cmd = {
-  /**
-   * @method delete
-   * @description Deletes the deploy.
-   * @param {string} deployId - The deploy ID.
-   * @returns {string} - The delete command.
-   * @memberof Cmd
-   */
-  delete: (deployId) => `pm2 delete ${deployId}`,
   /**
    * @method run
    * @description Runs the deploy.
@@ -1192,7 +1185,7 @@ const Cmd = {
    * @description Builds the deploy.
    * @param {string} deployId - The deploy ID.
    * @returns {string} - The build command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   build: (deployId) => `node bin/deploy build-full-client ${deployId}`,
   /**
@@ -1201,7 +1194,7 @@ const Cmd = {
    * @param {string} deployId - The deploy ID.
    * @param {string} env - The environment.
    * @returns {string} - The conf command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   conf: (deployId, env) => `node bin/deploy conf ${deployId} ${env ? env : 'production'}`,
   /**
@@ -1211,30 +1204,16 @@ const Cmd = {
    * @param {string} host - The host.
    * @param {string} path - The path.
    * @returns {string} - The replica command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   replica: (deployId, host, path) => `node bin/deploy build-single-replica ${deployId} ${host} ${path}`,
   /**
    * @method syncPorts
    * @description Syncs the ports.
    * @returns {string} - The sync ports command.
-   * @memberof Cmd
+   * @memberof CmdUnderpost
    */
   syncPorts: () => `node bin/deploy sync-env-port`,
-  /**
-   * @method cron
-   * @description Creates a cron job.
-   * @param {string} deployList - The deploy list.
-   * @param {string} jobList - The job list.
-   * @param {string} name - The name.
-   * @param {string} expression - The expression.
-   * @param {object} options - The options.
-   * @param {number} instances - The number of PM2 instances (default: 1).
-   * @returns {string} - The cron command.
-   * @memberof Cmd
-   */
-  cron: (deployList, jobList, name, expression, options, instances = 1) =>
-    `pm2 start ./bin/index.js --no-autorestart --instances ${instances} --cron "${expression}" --name ${name} -- cron ${options?.git ? `--git ` : ''}${deployList} ${jobList}`,
 };
 
 /**