underpost 2.8.844 → 2.8.846

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 };

package/src/server/client-build.js

@@ -17,11 +17,11 @@ import dotenv from 'dotenv';
 import AdmZip from 'adm-zip';
 import * as dir from 'path';
 import { shellExec } from './process.js';
-import swaggerAutoGen from 'swagger-autogen';
 import { SitemapStream, streamToPromise } from 'sitemap';
 import { Readable } from 'stream';
 import { buildIcons, buildTextImg, getBufferPngText } from './client-icons.js';
 import Underpost from '../index.js';
+import { buildDocs } from './client-build-docs.js';
 
 dotenv.config();
 
@@ -441,27 +441,13 @@ const buildClient = async (options = { liveClientBuildPaths: [], instances: [] }
                   case 'CyberiaDefaultSplashScreen':
                   case 'NexodevSplashScreen':
                   case 'DefaultSplashScreen':
-                    if (backgroundImage) {
+                    if (backgroundImage)
                       ssrHeadComponents += SrrComponent({
+                        ...metadata,
                         backgroundImage: (path === '/' ? path : `${path}/`) + backgroundImage,
                       });
-                      // `data:image/${backgroundImage.split('.').pop()};base64,${fs
-                      //     .readFileSync()
-                      //     .toString('base64')}`,
-                      break;
-                    } else {
-                      ssrHeadComponents += SrrComponent({ metadata });
-                      break;
-                      const bufferBackgroundImage = await getBufferPngText({
-                        text: ' ',
-                        textColor: metadata?.themeColor ? metadata.themeColor : '#ececec',
-                        size: '100x100',
-                        bgColor: metadata?.themeColor ? metadata.themeColor : '#ececec',
-                      });
-                      ssrHeadComponents += SrrComponent({
-                        backgroundImage: `data:image/png;base64,${bufferBackgroundImage.toString('base64')}`,
-                      });
-                    }
+                    else ssrHeadComponents += SrrComponent({ metadata });
+                    break;
 
                   case 'CyberiaSplashScreenLore': {
                     ssrBodyComponents += SrrComponent({
@@ -557,125 +543,16 @@ Sitemap: https://${host}${path === '/' ? '' : path}/sitemap.xml`,
       }
 
       if (!enableLiveRebuild && !process.argv.includes('l') && !process.argv.includes('deploy') && docsBuild) {
-        // https://www.pullrequest.com/blog/leveraging-jsdoc-for-better-code-documentation-in-javascript/
-        // https://jsdoc.app/about-configuring-jsdoc
-        // https://jsdoc.app/ Block tags
-
-        const jsDocsConfig = JSON.parse(fs.readFileSync(`./jsdoc.json`, 'utf8'));
-        jsDocsConfig.opts.destination = `./public/${host}${path === '/' ? path : `${path}/`}docs/`;
-        jsDocsConfig.opts.theme_opts.title = metadata && 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 });
-
-        // coverage
-        if (!fs.existsSync(`./coverage`)) {
-          shellExec(`npm test`);
-        }
-        const coverageBuildPath = `${jsDocsConfig.opts.destination}/coverage`;
-        fs.mkdirSync(coverageBuildPath, { recursive: true });
-        fs.copySync(`./coverage`, coverageBuildPath);
-
-        // https://swagger-autogen.github.io/docs/
-
-        const basePath = path === '/' ? `${process.env.BASE_API}` : `/${process.env.BASE_API}`;
-
-        const doc = {
-          info: {
-            version: packageData.version, // by default: '1.0.0'
-            title: metadata?.title ? `${metadata.title}` : 'REST API', // by default: 'REST API'
-            description: metadata?.description ? metadata.description : '', // by default: ''
-          },
-          servers: [
-            {
-              url:
-                process.env.NODE_ENV === 'development'
-                  ? `http://localhost:${port}${path}${basePath}`
-                  : `https://${host}${path}${basePath}`, // by default: 'http://localhost:3000'
-              description: `${process.env.NODE_ENV} server`, // by default: ''
-            },
-          ],
-          tags: [
-            // by default: empty Array
-            {
-              name: 'user', // Tag name
-              description: 'User API operations', // Tag description
-            },
-          ],
-          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`);
-        }
-
-        /* NOTE: If you are using the express Router, you must pass in the 'routes' only the 
-root file where the route starts, such as index.js, app.js, routes.js, etc ... */
-
-        await swaggerAutoGen({ openapi: '3.0.0' })(outputFile, routes, doc);
+        await buildDocs({
+          host,
+          path,
+          port,
+          metadata,
+          apis,
+          publicClientId,
+          rootClientPath,
+          packageData,
+        });
       }
 
       if (client) {

package/src/server/conf.js

@@ -89,12 +89,19 @@ const Config = {
 };
 
 const loadConf = (deployId, envInput, subConf) => {
+  if (deployId === 'current') {
+    console.log(process.env.DEPLOY_ID);
+    return;
+  }
   if (deployId === 'clean') {
-    shellExec(`git checkout package.json`);
-    shellExec(`git checkout .env.production`);
-    shellExec(`git checkout .env.development`);
-    shellExec(`git checkout .env.test`);
-    shellExec(`git checkout jsdoc.json`);
+    const path = envInput ?? '.';
+    fs.removeSync(`${path}/.env`);
+    shellExec(`git checkout ${path}/.env.production`);
+    shellExec(`git checkout ${path}/.env.development`);
+    shellExec(`git checkout ${path}/.env.test`);
+    if (fs.existsSync(`${path}/jsdoc.json`)) shellExec(`git checkout ${path}/jsdoc.json`);
+    shellExec(`git checkout ${path}/package.json`);
+    shellExec(`git checkout ${path}/package-lock.json`);
     return;
   }
   const folder = fs.existsSync(`./engine-private/replica/${deployId}`)