underpost 2.8.871 → 2.8.872

package/src/client/components/core/Router.js

@@ -1,21 +1,131 @@
+/**
+ * Vanilla JavaScript module for manipulating the DOM.
+ * @module src/client/components/core/Router.js
+ * @namespace PwaRouter
+ */
+
 import { titleFormatted } from './CommonJs.js';
 import { loggerFactory } from './Logger.js';
-import { getProxyPath, getQueryParams, htmls, s, setPath } from './VanillaJs.js';
+import { htmls, s } from './VanillaJs.js';
 import { Modal } from './Modal.js';
 import { Worker } from './Worker.js';
 
-// Router
+const logger = loggerFactory(import.meta, { trace: true });
 
+/**
+ * @type {Object.<string, function>}
+ * @description Holds event listeners for router changes.
+ * @memberof PwaRouter
+ */
 const RouterEvents = {};
+
+/**
+ * @type {string[]}
+ * @description Array of core UI component IDs that should not trigger modal close route changes.
+ * @memberof PwaRouter
+ */
+const coreUI = ['modal-menu', 'main-body', 'main-body-top', 'bottom-bar', 'board-notification'];
+/**
+ * @type {Object.<string, function>}
+ * @description Holds event listeners for route changes that should close a modal.
+ * @memberof PwaRouter
+ */
 const closeModalRouteChangeEvents = {};
 
-const logger = loggerFactory(import.meta);
+/**
+ * Determines the base path for the application, often used for routing within a sub-directory.
+ * It checks the current URL's pathname and `window.Routes` to return the appropriate proxy path.
+ *
+ * @returns {string} The calculated proxy path. Returns `/<first-segment>/` if a segment exists,
+ *          otherwise `/`. If `window.Routes` indicates the path is a root route, it returns `/`.
+ * @memberof PwaRouter
+ */
+const getProxyPath = () => {
+  let path = location.pathname.split('/')[1] ? `/${location.pathname.split('/')[1]}/` : '/';
+  if (window.Routes && path !== '/' && path.slice(0, -1) in window.Routes()) path = '/';
+  return path;
+};
+
+/**
+ * Sets the browser's path using the History API. It sanitizes the path, handles query strings and hashes,
+ * and prevents pushing the same state twice.
+ * @param {string} [path='/'] - The new path to set. Can include query strings and hashes.
+ * @param {object} [options={ removeSearch: false, removeHash: false }] - Options for path manipulation.
+ * @param {boolean} [options.removeSearch=false] - If true, removes the search part of the URL.
+ * @param {boolean} [options.removeHash=false] - If true, removes the hash part of the URL. Defaults to `false`.
+ * @param {object} [stateStorage={}] - State object to associate with the history entry.
+ * @param {string} [title=''] - The title for the new history entry.
+ * @memberof PwaRouter
+ * @returns {void | undefined} Returns `undefined` if the new path is the same as the current path, otherwise `void` (result of `history.pushState`).
+ */
+const setPath = (path = '/', options = { removeSearch: false, removeHash: false }, stateStorage = {}, title = '') => {
+  logger.warn(`Set path input`, `${path}`);
+  if (!path) path = '/';
+
+  let [inputPath, inputSearchHash] = `${path}`.split('?');
+  let [inputSearch, inputHash] = inputSearchHash ? inputSearchHash.split('#') : [];
+
+  let sanitizedPath = (inputPath[0] !== '/' ? `/${inputPath}` : inputPath)
+    .trim()
+    .replaceAll('//', '/')
+    .replaceAll(`\\`, '/');
+
+  if (sanitizedPath.length > 1 && sanitizedPath[sanitizedPath.length - 1] === '/')
+    sanitizedPath = sanitizedPath.slice(0, -1);
+
+  const newFullPath = `${sanitizedPath}${inputSearch && !options.removeSearch ? `?${inputSearch}` : ''}${
+    inputHash && !options.removeHash ? `#${inputHash}` : ''
+  }`;
+  const currentFullPath = `${window.location.pathname}${location.search}${location.hash}`;
+  logger.warn(`Set path output`, {
+    inputPath: inputPath,
+    inputSearch: inputSearch,
+    inputHash: inputHash,
+    sanitizedPath: sanitizedPath,
+    currentLocationSearch: location.search,
+    currentLocationHash: location.hash,
+    currentFullPath,
+    newFullPath,
+  });
+  if (currentFullPath === newFullPath) {
+    logger.warn('Prevent overwriting same path', { currentFullPath, newFullPath });
+    return;
+  }
+  return history.pushState.call(history, stateStorage, title, newFullPath);
+};
+
+/**
+ * Extracts query parameters from the current URL's search string and returns them as an object.
+ * @returns An object containing the query parameters from the current URL is being returned.
+ * @memberof PwaRouter
+ */
+const getQueryParams = () => {
+  const params = new URLSearchParams(window.location.search);
+  let queries = {};
+  for (const param of params) {
+    queries[param[0]] = param[1];
+  }
+  return queries;
+};
 
+/**
+ * Sanitizes a route string for use in CSS classes or other identifiers.
+ * Defaults to 'home' for empty, '/', or '\' routes.
+ * @param {string} route - The route string to sanitize.
+ * @returns {string} The sanitized route string.
+ * @memberof PwaRouter
+ */
 const sanitizeRoute = (route) =>
   !route || route === '/' || route === `\\`
     ? 'home'
     : route.toLowerCase().replaceAll('/', '').replaceAll(`\\`, '').replaceAll(' ', '-');
 
+/**
+ * Sets the document title and updates the active state of the main menu button corresponding to the route.
+ * The title is formatted and appended with the main application title from `Worker.title` if it's not already present.
+ * @param {string} route - The current route string.
+ * @memberof PwaRouter
+ */
 const setDocTitle = (route) => {
   const _route = sanitizeRoute(route);
   // logger.warn('setDocTitle', _route);
@@ -27,6 +137,14 @@ const setDocTitle = (route) => {
   }
 };
 
+/**
+ * Main router function. It matches the current URL path against the provided routes configuration
+ * and renders the corresponding component. It also fires registered router events.
+ * @param {object} [options={ Routes: () => {}, e: new PopStateEvent() }] - The router options.
+ * @param {function} options.Routes - A function that returns the routes object.
+ * @param {PopStateEvent} options.e - The popstate event object.
+ * @memberof PwaRouter
+ */
 const Router = function (options = { Routes: () => {}, e: new PopStateEvent() }) {
   const { e, Routes } = options;
   const proxyPath = getProxyPath();
@@ -50,20 +168,43 @@ const Router = function (options = { Routes: () => {}, e: new PopStateEvent() })
   }
 };
 
+/**
+ * Initializes the router and sets up the `onpopstate` event listener to handle browser
+ * back/forward navigation.
+ * @param {object} RouterInstance - The router instance configuration, including the `Routes` function.
+ * @memberof PwaRouter
+ */
 const LoadRouter = function (RouterInstance) {
   Router(RouterInstance);
   window.onpopstate = (e) => Router({ ...RouterInstance, e });
 };
 
-const setQueryPath = (options = { path: '', queryPath: '', replace: false }, queryKey = 'cid') => {
-  const { queryPath, path, replace } = options;
+/**
+ * Sets the URL path with a specific query parameter, commonly used for content IDs.
+ * This function constructs a new URI based on the proxy path, a given path, and an optional query parameter.
+ * @param {object} [options={ path: '', queryPath: '' }] - The path options.
+ * @param {string} [options.path=''] - The base path segment.
+ * @memberof PwaRouter
+ */
+const setQueryPath = (options = { path: '', queryPath: '' }, queryKey = 'cid') => {
+  const { queryPath, path } = options;
   const newUri = `${getProxyPath()}${path === 'home' ? '' : `${path}/`}${
     typeof queryPath === 'string' && queryPath ? `?${queryKey}=${queryPath}` : ''
   }`;
   const currentUri = `${window.location.pathname}${location.search}`;
-  if (currentUri !== newUri && currentUri !== `${newUri}/`) setPath(newUri, {}, '', { replace });
+  if (currentUri !== newUri && currentUri !== `${newUri}/`) setPath(newUri, {}, '');
 };
 
+/**
+ * Registers a listener for route changes that specifically watches for a `queryKey` parameter
+ * on a matching `routeId`. The provided event callback is triggered with the query parameter's value.
+ * @param {object} options - The listener options.
+ * @param {string} options.id - A unique ID for the listener.
+ * @param {string} options.routeId - The route ID to listen for.
+ * @param {function(string): void} options.event - The callback function to execute with the query path value (or an empty string if not found).
+ * @param {string} [queryKey='cid'] - The query parameter key to look for.
+ * @memberof PwaRouter
+ */
 const listenQueryPathInstance = ({ id, routeId, event }, queryKey = 'cid') => {
   RouterEvents[id] = ({ path, pushPath, proxyPath, route }) => {
     if ((route === '' && routeId === 'home') || (route && routeId && route === routeId)) {
@@ -80,14 +221,21 @@ const listenQueryPathInstance = ({ id, routeId, event }, queryKey = 'cid') => {
     });
 };
 
-const triggerCloseModalRouteChangeEvents = (newPath) => {
-  console.warn('[closeModalRouteChangeEvent]', newPath);
-  for (const event of Object.keys(closeModalRouteChangeEvents)) closeModalRouteChangeEvents[event](newPath);
-};
-
+/**
+ * Handles the logic for changing the route when a modal is closed. It determines the next URL
+ * based on the remaining open modals or falls back to a home URL.
+ * @param {object} [options={}] - Options for the modal close event.
+ * @param {string} options.closedId - The ID of the modal that was just closed.
+ * @memberof PwaRouter
+ */
 const closeModalRouteChangeEvent = (options = {}) => {
-  const { closedId, homeCid } = options;
+  logger.warn('closeModalRouteChangeEvent', options);
+  const { closedId } = options;
   if (!closedId) return;
+  if (coreUI.find((id) => closedId.startsWith(id))) {
+    logger.warn('prevent core ui component close');
+    return;
+  }
 
   const remainingModals = Object.keys(Modal.Data).filter(
     (id) => id !== closedId && (Modal.Data[id]?.options?.route || Modal.Data[id]?.options?.query),
@@ -95,27 +243,20 @@ const closeModalRouteChangeEvent = (options = {}) => {
 
   const topModalId = remainingModals.reverse().find((id) => Modal.Data[id]);
 
-  if (topModalId) {
-    const topModal = Modal.Data[topModalId];
-    const route = topModal.options.route;
-    const query = topModal.query;
-    const path = route ? `${getProxyPath()}${route}` : location.pathname;
-    const newUrl = `${path}${query || ''}`;
-
-    triggerCloseModalRouteChangeEvents(newUrl);
-    setPath(newUrl, {}, '', { replace: true });
-    setDocTitle(route || path);
-    Modal.setTopModalCallback(topModalId);
-  } else {
-    const homeUrl = `${getProxyPath()}${homeCid ? `?cid=${homeCid}` : ''}`;
-    triggerCloseModalRouteChangeEvents(homeUrl);
-    setPath(homeUrl, {}, '', { replace: true });
-    setDocTitle('home');
-  }
+  for (const event of Object.keys(closeModalRouteChangeEvents)) closeModalRouteChangeEvents[event]();
+  if (topModalId) Modal.setTopModalCallback(topModalId);
+  setPath(`${getProxyPath()}${Modal.Data[topModalId]?.options?.route || 'home'}`);
 };
 
-const handleModalViewRoute = (options = {}) => {
-  const { route, RouterInstance } = options;
+/**
+ * Handles routing for modals that are meant to be displayed as a "view" (e.g., a full-page modal).
+ * It updates the URL to reflect the modal's route.
+ * @param {object} [options={ route: 'home' }] - The options for handling the modal view route.
+ * @param {string} options.route - The route associated with the modal view.
+ * @memberof PwaRouter
+ */
+const handleModalViewRoute = (options = { route: 'home' }) => {
+  const { route } = options;
   if (!route) return;
 
   let path = window.location.pathname;
@@ -130,13 +271,17 @@ const handleModalViewRoute = (options = {}) => {
 };
 
 export {
+  RouterEvents,
+  closeModalRouteChangeEvents,
+  coreUI,
   Router,
   setDocTitle,
   LoadRouter,
-  RouterEvents,
   setQueryPath,
   listenQueryPathInstance,
   closeModalRouteChangeEvent,
   handleModalViewRoute,
-  closeModalRouteChangeEvents,
+  getQueryParams,
+  getProxyPath,
+  setPath,
 };

package/src/client/components/core/Stream.js

@@ -1,5 +1,5 @@
 import { loggerFactory } from './Logger.js';
-import { getProxyPath } from './VanillaJs.js';
+import { getProxyPath } from './Router.js';
 
 // https://peerjs.com/docs/
 

package/src/client/components/core/VanillaJs.js

@@ -132,71 +132,6 @@ const copyData = (data) =>
  */
 const pasteData = () => new Promise((resolve) => navigator.clipboard.readText().then((clipText) => resolve(clipText)));
 
-/**
- * The setPath function in JavaScript updates the browser's history with a new path, state, and title.
- * @param path - The `path` parameter is a string that represents the URL path where you want to
- * navigate or update in the browser history. It is the first parameter in the `setPath` function and
- * has a default value of `'/'`.
- * @param stateStorage - The `stateStorage` parameter in the `setPath` function is an object that
- * represents the state object associated with the new history entry. It is used to store data related
- * to the state of the application when navigating to a new path using `history.pushState()`. This data
- * can be accessed later
- * @param title - The `title` parameter in the `setPath` function is a string that represents the
- * title of the new history entry. It is used as the title of the new history entry in the browser's
- * history.
- * @param {object} [options={}] - Additional options.
- * @param {boolean} [options.replace=false] - If true, use `history.replaceState` instead of `history.pushState`.
- * @memberof VanillaJS
- */
-const setPath = (path = '/', stateStorage = {}, title = '', options = {}) => {
-  if (!path) path = '/';
-
-  const [inputPath, inputSearch] = `${path}`.split('?');
-
-  let sanitizedPath = (inputPath[0] !== '/' ? `/${inputPath}` : inputPath)
-    .trim()
-    .replaceAll('//', '/')
-    .replaceAll(`\\`, '/');
-
-  if (sanitizedPath.length > 1 && sanitizedPath[sanitizedPath.length - 1] === '/')
-    sanitizedPath = sanitizedPath.slice(0, -1);
-
-  const newFullPath = `${sanitizedPath}${inputSearch ? `?${inputSearch}` : location.search}${location.hash ?? ''}`;
-  const currentFullPath = `${window.location.pathname}${location.search}${location.hash}`;
-
-  if (currentFullPath === newFullPath) {
-    console.warn('Prevent overwriting same path', {
-      newFullPath,
-      currentFullPath,
-    });
-    return;
-  }
-  const historyMethod = options.replace ? history.replaceState : history.pushState;
-  console.warn(`Set path (${options.replace ? 'replace' : 'push'})`, {
-    inputPath: inputPath,
-    inputSearch: inputSearch,
-    sanitizedPath: sanitizedPath,
-    currentLocationSearch: location.search,
-    currentLocationHash: location.hash,
-  });
-  return historyMethod.call(history, stateStorage, title, newFullPath);
-};
-
-/**
- * The function `getQueryParams` extracts query parameters from the current URL and returns them as an
- * object.
- * @returns An object containing the query parameters from the current URL is being returned.
- * @memberof VanillaJS
- */
-const getQueryParams = () => {
-  const params = new URLSearchParams(window.location.search);
-  let queries = {};
-  for (const param of params) {
-    queries[param[0]] = param[1];
-  }
-  return queries;
-};
-
 /**
  * The `preHTML` function in JavaScript replaces special characters like &, <, and > with their
  * corresponding HTML entities.
@@ -374,21 +309,6 @@ const getBlobFromUint8ArrayFile = (data = [[]], mimetype = 'application/octet-st
   return new Blob([new Uint8Array(data)], { type: mimetype });
 };
 
-// Router
-/**
- * The function `getProxyPath` returns a proxy path based on the current location pathname.
- * @returns The `getProxyPath` function returns the path based on the current location. If the first
- * segment of the pathname is not empty, it returns `/<first-segment>/`, otherwise it returns `/`. If
- * the `window.Routes` object exists and the path is not `/` and the path without the trailing slash is
- * a key in the `window.Routes` object, it returns `/`.
- * @memberof VanillaJS
- */
-const getProxyPath = () => {
-  let path = location.pathname.split('/')[1] ? `/${location.pathname.split('/')[1]}/` : '/';
-  if (window.Routes && path !== '/' && path.slice(0, -1) in window.Routes()) path = '/';
-  return path;
-};
-
 /**
  * The function `isNavigator` checks if the user agent string contains a specified name.
  * @param name - The `name` parameter is a string that represents the name of a browser or device to
@@ -477,8 +397,6 @@ export {
   sa,
   copyData,
   pasteData,
-  setPath,
-  getQueryParams,
   preHTML,
   disableOptionsClick,
   checkFullScreen,
@@ -487,7 +405,6 @@ export {
   getResponsiveData,
   isElement,
   downloadFile,
-  getProxyPath,
   getRawContentFile,
   getBlobFromUint8ArrayFile,
   isNavigator,

package/src/client/components/core/Worker.js

@@ -5,8 +5,8 @@ import { LoadingAnimation } from './LoadingAnimation.js';
 import { loggerFactory } from './Logger.js';
 import { LoadRouter } from './Router.js';
 import { Translate } from './Translate.js';
-import { getProxyPath, htmls, s } from './VanillaJs.js';
-
+import { s } from './VanillaJs.js';
+import { getProxyPath } from './Router.js';
 const logger = loggerFactory(import.meta);
 
 const Worker = {

package/src/client/components/default/MenuDefault.js

@@ -17,10 +17,11 @@ import { LogOut } from '../core/LogOut.js';
 import { buildBadgeToolTipMenuOption, Modal, renderMenuLabel, renderViewTitle } from '../core/Modal.js';
 import { SignUp } from '../core/SignUp.js';
 import { Translate } from '../core/Translate.js';
-import { getProxyPath, htmls, s } from '../core/VanillaJs.js';
+import { htmls, s } from '../core/VanillaJs.js';
+import { getProxyPath } from '../core/Router.js';
 import { ElementsDefault } from './ElementsDefault.js';
 import Sortable from 'sortablejs';
-import { RouterDefault } from './RoutesDefault.js';
+import { RouterDefault, BannerAppTemplate } from './RoutesDefault.js';
 import { SettingsDefault } from './SettingsDefault.js';
 import { Badge } from '../core/Badge.js';
 import { Docs } from '../core/Docs.js';
@@ -35,7 +36,7 @@ const MenuDefault = {
     const id = getId(this.Data, 'menu-');
     this.Data[id] = {};
     const RouterInstance = RouterDefault();
-    const { BannerAppTemplate } = RouterInstance;
+
     const { barConfig } = await Themes[Css.currentTheme]();
     const heightTopBar = 50;
     const heightBottomBar = 50;

package/src/client/components/default/RoutesDefault.js

@@ -1,6 +1,7 @@
 import { loggerFactory } from '../core/Logger.js';
 import { Modal } from '../core/Modal.js';
-import { getProxyPath, s } from '../core/VanillaJs.js';
+import { s } from '../core/VanillaJs.js';
+import { getProxyPath } from '../core/Router.js';
 
 const logger = loggerFactory(import.meta);
 
@@ -39,7 +40,7 @@ const RoutesDefault = () => {
 window.Routes = RoutesDefault;
 
 const RouterDefault = () => {
-  return { Routes: RoutesDefault, BannerAppTemplate };
+  return { Routes: RoutesDefault };
 };
 
 export { RoutesDefault, RouterDefault, BannerAppTemplate };

package/src/client/services/core/core.service.js

@@ -1,6 +1,6 @@
 import { Auth } from '../../components/core/Auth.js';
 import { loggerFactory } from '../../components/core/Logger.js';
-import { getProxyPath } from '../../components/core/VanillaJs.js';
+import { getProxyPath } from '../../components/core/Router.js';
 
 const logger = loggerFactory(import.meta);
 

package/src/client/ssr/head/DefaultScripts.js

@@ -1,3 +1,4 @@
 SrrComponent = ({ ssrPath }) => html`
   <script type="text/javascript" src="${ssrPath}dist/validator/validator.min.js"></script>
+  <script type="text/javascript" src="${ssrPath}dist/ag-grid-community/ag-grid-community.min.js"></script>
 `;

package/src/index.js

@@ -35,7 +35,7 @@ class Underpost {
    * @type {String}
    * @memberof Underpost
    */
-  static version = 'v2.8.871';
+  static version = 'v2.8.872';
   /**
    * Repository cli API
    * @static

package/src/server/runtime.js

@@ -404,6 +404,13 @@ const buildRuntime = async () => {
           const path404 = `${directory ? directory : `${getRootDirectory()}${rootHostPath}`}/404/index.html`;
           const page404 = fs.existsSync(path404) ? `${path === '/' ? '' : path}/404` : undefined;
           app.use(function (req, res, next) {
+            // if /<path>/home redirect to /<path>
+            const homeRedirectPath = `${path === '/' ? '' : path}/home`;
+            if (req.url.startsWith(homeRedirectPath)) {
+              const redirectUrl = req.url.replace('/home', '');
+              return res.redirect(redirectUrl.startsWith('/') ? redirectUrl : `/${redirectUrl}`);
+            }
+
             if (page404) return res.status(404).redirect(page404);
             else {
               res.set('Content-Type', 'text/html');

package/src/server/ssl.js

@@ -50,8 +50,7 @@ const buildSSL = async (host) => {
 
           fs.writeFileSync(`./engine-private/ssl/${host}/_ca_bundle.crt`, ca, 'utf8');
           fs.writeFileSync(`./engine-private/ssl/${host}/_ca_full_bundle.crt`, caFull, 'utf8');
-          // TODO: no repeat folderHost match
-          // fs.removeSync(`${sslPath}/${folderHost}`);
+
           return true;
         }
       }