underpost 2.8.885 → 2.8.886

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

@@ -1,3 +1,9 @@
+/**
+ * Module for live building client-side code
+ * @module src/server/client-build-live.js
+ * @namespace clientLiveBuild
+ */
+
 import fs from 'fs-extra';
 import { Config, loadConf } from './conf.js';
 import { loggerFactory } from './logger.js';
@@ -5,6 +11,11 @@ import { buildClient } from './client-build.js';
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @function clientLiveBuild
+ * @description Initiates a live build of client-side code.
+ * @memberof clientLiveBuild
+ */
 const clientLiveBuild = async () => {
   if (fs.existsSync(`./tmp/client.build.json`)) {
     const deployId = process.argv[2];
@@ -33,16 +44,7 @@ const clientLiveBuild = async () => {
         ),
       );
       const confServer = JSON.parse(
-        fs.readFileSync(
-          fs.existsSync(`./engine-private/conf/${deployId}/conf.server.dev.${subConf}.json`)
-            ? `./engine-private/conf/${deployId}/conf.server.dev.${subConf}.json`
-            : fs.existsSync(`./engine-private/replica/${deployId}`)
-            ? `./engine-private/replica/${deployId}/conf.server.json`
-            : fs.existsSync(`./engine-private/conf/${deployId}/conf.server.json`)
-            ? `./engine-private/conf/${deployId}/conf.server.json`
-            : `./conf/conf.server.json`,
-          'utf8',
-        ),
+        fs.readFileSync(`./engine-private/conf/${deployId}/conf.server.dev.${subConf}.json`, 'utf8'),
       );
       host = process.argv[4];
       path = process.argv[5];

package/src/server/client-build.js

@@ -1,3 +1,9 @@
+/**
+ * Manages the client-side build process, including full builds and incremental builds.
+ * @module server/client-build.js
+ * @namespace clientBuild
+ */
+
 'use strict';
 
 import fs from 'fs-extra';
@@ -26,97 +32,17 @@ dotenv.config();
 
 // Static Site Generation (SSG)
 
-const buildAcmeChallengePath = (acmeChallengeFullPath = '') => {
-  fs.mkdirSync(acmeChallengeFullPath, {
-    recursive: true,
-  });
-  fs.writeFileSync(`${acmeChallengeFullPath}/.gitkeep`, '', 'utf8');
-};
-
-const fullBuild = async ({
-  path,
-  logger,
-  client,
-  db,
-  dists,
-  rootClientPath,
-  acmeChallengeFullPath,
-  publicClientId,
-  iconsBuild,
-  metadata,
-}) => {
-  logger.warn('Full build', rootClientPath);
-
-  buildAcmeChallengePath(acmeChallengeFullPath);
-
-  if (publicClientId && publicClientId.startsWith('html-website-templates')) {
-    if (!fs.existsSync(`/home/dd/html-website-templates/`))
-      shellExec(`cd /home/dd && git clone https://github.com/designmodo/html-website-templates.git`);
-    if (!fs.existsSync(`${rootClientPath}/index.php`)) {
-      fs.copySync(`/home/dd/html-website-templates/${publicClientId.split('-publicClientId-')[1]}`, rootClientPath);
-      shellExec(`cd ${rootClientPath} && git init && git add . && git commit -m "Base template implementation"`);
-      // git remote add origin git@github.com:<username>/<repo>.git
-      fs.writeFileSync(`${rootClientPath}/.git/.htaccess`, `Deny from all`, 'utf8');
-    }
-    return;
-  }
-
-  fs.removeSync(rootClientPath);
-
-  if (fs.existsSync(`./src/client/public/${publicClientId}`)) {
-    if (iconsBuild === true) await buildIcons({ publicClientId, metadata });
-
-    fs.copySync(
-      `./src/client/public/${publicClientId}`,
-      rootClientPath /* {
-          filter: function (name) {
-            console.log(name);
-            return true;
-          },
-        } */,
-    );
-  } else if (fs.existsSync(`./engine-private/src/client/public/${publicClientId}`)) {
-    switch (publicClientId) {
-      case 'mysql_test':
-        if (db) {
-          fs.copySync(`./engine-private/src/client/public/${publicClientId}`, rootClientPath);
-          fs.writeFileSync(
-            `${rootClientPath}/index.php`,
-            fs
-              .readFileSync(`${rootClientPath}/index.php`, 'utf8')
-              .replace('test_servername', 'localhost')
-              .replace('test_username', db.user)
-              .replace('test_password', db.password)
-              .replace('test_dbname', db.name),
-            'utf8',
-          );
-        } else logger.error('not provided db config');
-        break;
-
-      default:
-        break;
-    }
-  }
-  if (dists)
-    for (const dist of dists) {
-      if ('folder' in dist) {
-        if (fs.statSync(dist.folder).isDirectory()) {
-          fs.mkdirSync(`${rootClientPath}${dist.public_folder}`, { recursive: true });
-          fs.copySync(dist.folder, `${rootClientPath}${dist.public_folder}`);
-        } else {
-          const folder = dist.public_folder.split('/');
-          folder.pop();
-          fs.mkdirSync(`${rootClientPath}${folder.join('/')}`, { recursive: true });
-          fs.copyFileSync(dist.folder, `${rootClientPath}${dist.public_folder}`);
-        }
-      }
-      if ('styles' in dist) {
-        fs.mkdirSync(`${rootClientPath}${dist.public_styles_folder}`, { recursive: true });
-        fs.copySync(dist.styles, `${rootClientPath}${dist.public_styles_folder}`);
-      }
-    }
-};
-
+/**
+ * @async
+ * @function buildClient
+ * @memberof clientBuild
+ * @param {Object} options - Options for the build process.
+ * @param {Array} options.liveClientBuildPaths - List of paths to build incrementally.
+ * @param {Array} options.instances - List of instances to build.
+ * @returns {Promise<void>} - Promise that resolves when the build is complete.
+ * @throws {Error} - If the build fails.
+ * @memberof clientBuild
+ */
 const buildClient = async (options = { liveClientBuildPaths: [], instances: [] }) => {
   const logger = loggerFactory(import.meta);
   const confClient = JSON.parse(fs.readFileSync(`./conf/conf.client.json`, 'utf8'));
@@ -126,6 +52,125 @@ const buildClient = async (options = { liveClientBuildPaths: [], instances: [] }
   const acmeChallengePath = `/.well-known/acme-challenge`;
   const publicPath = `./public`;
 
+  /**
+   * @async
+   * @function buildAcmeChallengePath
+   * @memberof clientBuild
+   * @param {string} acmeChallengeFullPath - Full path to the acme-challenge directory.
+   * @returns {void}
+   * @throws {Error} - If the directory cannot be created.
+   * @memberof clientBuild
+   */
+  const buildAcmeChallengePath = (acmeChallengeFullPath = '') => {
+    fs.mkdirSync(acmeChallengeFullPath, {
+      recursive: true,
+    });
+    fs.writeFileSync(`${acmeChallengeFullPath}/.gitkeep`, '', 'utf8');
+  };
+
+  /**
+   * @async
+   * @function fullBuild
+   * @memberof clientBuild
+   * @param {Object} options - Options for the full build process.
+   * @param {string} options.path - Path to the client directory.
+   * @param {Object} options.logger - Logger instance.
+   * @param {string} options.client - Client name.
+   * @param {Object} options.db - Database configuration.
+   * @param {Array} options.dists - List of distributions to build.
+   * @param {string} options.rootClientPath - Full path to the client directory.
+   * @param {string} options.acmeChallengeFullPath - Full path to the acme-challenge directory.
+   * @param {string} options.publicClientId - Public client ID.
+   * @param {boolean} options.iconsBuild - Whether to build icons.
+   * @param {Object} options.metadata - Metadata for the client.
+   * @returns {Promise<void>} - Promise that resolves when the full build is complete.
+   * @throws {Error} - If the full build fails.
+   * @memberof clientBuild
+   */
+  const fullBuild = async ({
+    path,
+    logger,
+    client,
+    db,
+    dists,
+    rootClientPath,
+    acmeChallengeFullPath,
+    publicClientId,
+    iconsBuild,
+    metadata,
+  }) => {
+    logger.warn('Full build', rootClientPath);
+
+    buildAcmeChallengePath(acmeChallengeFullPath);
+
+    if (publicClientId && publicClientId.startsWith('html-website-templates')) {
+      if (!fs.existsSync(`/home/dd/html-website-templates/`))
+        shellExec(`cd /home/dd && git clone https://github.com/designmodo/html-website-templates.git`);
+      if (!fs.existsSync(`${rootClientPath}/index.php`)) {
+        fs.copySync(`/home/dd/html-website-templates/${publicClientId.split('-publicClientId-')[1]}`, rootClientPath);
+        shellExec(`cd ${rootClientPath} && git init && git add . && git commit -m "Base template implementation"`);
+        // git remote add origin git@github.com:<username>/<repo>.git
+        fs.writeFileSync(`${rootClientPath}/.git/.htaccess`, `Deny from all`, 'utf8');
+      }
+      return;
+    }
+
+    fs.removeSync(rootClientPath);
+
+    if (fs.existsSync(`./src/client/public/${publicClientId}`)) {
+      if (iconsBuild === true) await buildIcons({ publicClientId, metadata });
+
+      fs.copySync(
+        `./src/client/public/${publicClientId}`,
+        rootClientPath /* {
+            filter: function (name) {
+              console.log(name);
+              return true;
+            },
+          } */,
+      );
+    } else if (fs.existsSync(`./engine-private/src/client/public/${publicClientId}`)) {
+      switch (publicClientId) {
+        case 'mysql_test':
+          if (db) {
+            fs.copySync(`./engine-private/src/client/public/${publicClientId}`, rootClientPath);
+            fs.writeFileSync(
+              `${rootClientPath}/index.php`,
+              fs
+                .readFileSync(`${rootClientPath}/index.php`, 'utf8')
+                .replace('test_servername', 'localhost')
+                .replace('test_username', db.user)
+                .replace('test_password', db.password)
+                .replace('test_dbname', db.name),
+              'utf8',
+            );
+          } else logger.error('not provided db config');
+          break;
+
+        default:
+          break;
+      }
+    }
+    if (dists)
+      for (const dist of dists) {
+        if ('folder' in dist) {
+          if (fs.statSync(dist.folder).isDirectory()) {
+            fs.mkdirSync(`${rootClientPath}${dist.public_folder}`, { recursive: true });
+            fs.copySync(dist.folder, `${rootClientPath}${dist.public_folder}`);
+          } else {
+            const folder = dist.public_folder.split('/');
+            folder.pop();
+            fs.mkdirSync(`${rootClientPath}${folder.join('/')}`, { recursive: true });
+            fs.copyFileSync(dist.folder, `${rootClientPath}${dist.public_folder}`);
+          }
+        }
+        if ('styles' in dist) {
+          fs.mkdirSync(`${rootClientPath}${dist.public_styles_folder}`, { recursive: true });
+          fs.copySync(dist.styles, `${rootClientPath}${dist.public_styles_folder}`);
+        }
+      }
+  };
+
   // { srcBuildPath, publicBuildPath }
   const enableLiveRebuild =
     options && options.liveClientBuildPaths && options.liveClientBuildPaths.length > 0 ? true : false;

package/src/server/client-dev-server.js

@@ -1,12 +1,26 @@
+/**
+ * Module for creating a client-side development server
+ * @module src/server/client-dev-server.js
+ * @namespace clientDevServer
+ */
 import fs from 'fs-extra';
 import nodemon from 'nodemon';
 import { shellExec } from './process.js';
 import { loggerFactory } from './logger.js';
-import { writeEnv } from './conf.js';
-import dotenv from 'dotenv';
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @function createClientDevServer
+ * @description Creates a client-side development server.
+ * @memberof clientDevServer
+ * @param {string} deployId - The deployment ID.
+ * @param {string} subConf - The sub-configuration.
+ * @param {string} host - The host.
+ * @param {string} path - The path.
+ * @returns {void}
+ * @memberof clientDevServer
+ */
 const createClientDevServer = (
   deployId = process.argv[2] || 'dd-default',
   subConf = process.argv[3] || '',

package/src/server/client-icons.js

@@ -1,3 +1,8 @@
+/**
+ * Module for building client-side icons
+ * @module src/server/client-icons.js
+ * @namespace clientIcons
+ */
 import { favicons } from 'favicons';
 import { loggerFactory } from './logger.js';
 import fs from 'fs-extra';
@@ -5,6 +10,20 @@ import { getCapVariableName } from '../client/components/core/CommonJs.js';
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @function buildIcons
+ * @description Builds icons for a client-side application.
+ * @memberof clientIcons
+ * @param {Object} metadata - The metadata for the client-side application.
+ * @param {string} metadata.title - The title of the client-side application.
+ * @param {string} metadata.description - The description of the client-side application.
+ * @param {string} metadata.keywords - The keywords for the client-side application.
+ * @param {string} metadata.author - The author of the client-side application.
+ * @param {string} metadata.thumbnail - The thumbnail of the client-side application.
+ * @param {string} metadata.themeColor - The theme color of the client-side application.
+ * @param {string} metadata.baseBuildIconReference - The base build icon reference for the client-side application.
+ * @returns {Promise<void>}
+ */
 const buildIcons = async ({
   publicClientId,
   metadata: { title, description, keywords, author, thumbnail, themeColor, baseBuildIconReference },