underpost 2.8.87 → 2.8.88

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

@@ -1,21 +1,131 @@
+/**
+ * Router module for handling routing in a PWA application.
+ * @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 });
 };
 
+/**
+ * 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' ? `?${queryKey}=${queryPath}` : ''
+    typeof queryPath === 'string' && queryPath ? `?${queryKey}=${queryPath}` : ''
   }`;
   const currentUri = `${window.location.pathname}${location.search}`;
-  if (currentUri !== newUri && currentUri !== `${newUri}/`) setPath(newUri);
+  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,38 +221,43 @@ 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 { route, RouterInstance, homeCid } = options;
-  if (!route) return;
+  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;
+  }
 
-  let path = window.location.pathname;
-  if (path[path.length - 1] !== '/') path = `${path}/`;
-  let newPath = `${getProxyPath()}`;
+  const remainingModals = Object.keys(Modal.Data).filter(
+    (id) => id !== closedId && (Modal.Data[id]?.options?.route || Modal.Data[id]?.options?.query),
+  );
 
-  if (path !== newPath) {
-    for (const subIdModal of Object.keys(Modal.Data).reverse()) {
-      if (Modal.Data[subIdModal]?.options?.route) {
-        newPath = `${newPath}${Modal.Data[subIdModal].options.route}`;
-        triggerCloseModalRouteChangeEvents(newPath);
-        setPath(newPath);
-        setDocTitle(newPath);
-        Modal.setTopModalCallback(subIdModal);
-      }
-    }
-    newPath = `${newPath}${homeCid ? `?cid=${homeCid}` : ''}`;
-    triggerCloseModalRouteChangeEvents(newPath);
-    setPath(newPath);
-    setDocTitle(newPath);
-  }
+  const topModalId = remainingModals.reverse().find((id) => Modal.Data[id]);
+
+  for (const event of Object.keys(closeModalRouteChangeEvents)) closeModalRouteChangeEvents[event]();
+  if (topModalId) Modal.setTopModalCallback(topModalId);
+  setPath(`${getProxyPath()}${Modal.Data[topModalId]?.options?.route ?? ''}`);
+  setDocTitle(Modal.Data[topModalId]?.options?.route ?? '');
 };
 
-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: '' }) => {
+  const { route } = options;
   if (!route) return;
 
   let path = window.location.pathname;
@@ -125,14 +271,44 @@ const handleModalViewRoute = (options = {}) => {
   }
 };
 
+/**
+ * Sets or updates query parameters in the URL.
+ * It preserves the existing path, hash, and other query parameters.
+ *
+ * @param {Object.<string, string|number>} newParams - An object of query parameters to set or update.
+ *        If a value is `null` or `undefined`, the parameter will be removed.
+ * @param {object} [options={ replace: true }] - Options for history manipulation.
+ * @param {boolean} [options.replace=true] - If true, uses `history.replaceState` instead of `history.pushState`.
+ * @memberof PwaRouter
+ */
+const setQueryParams = (newParams, options = { replace: true }) => {
+  const url = new URL(window.location.href);
+  Object.entries(newParams).forEach(([key, value]) => {
+    if (value === null || value === undefined) {
+      url.searchParams.delete(key);
+    } else {
+      url.searchParams.set(key, value);
+    }
+  });
+
+  const newPath = url.pathname + url.search + url.hash;
+
+  history.pushState(history.state, '', newPath);
+};
+
 export {
+  RouterEvents,
+  closeModalRouteChangeEvents,
+  coreUI,
   Router,
   setDocTitle,
   LoadRouter,
-  RouterEvents,
   setQueryPath,
   listenQueryPathInstance,
   closeModalRouteChangeEvent,
   handleModalViewRoute,
-  closeModalRouteChangeEvents,
+  getQueryParams,
+  getProxyPath,
+  setPath,
+  setQueryParams,
 };

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

@@ -53,8 +53,7 @@ const SignUp = {
           status: result.status,
         });
         if (result.status === 'success') {
-          await Auth.sessionOut();
-          await Auth.signUpToken(result);
+          await Auth.sessionIn(result);
           s(`.btn-close-${options.idModal}`).click();
         }
       });

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,72 +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.
- * @memberof VanillaJS
- */
-const setPath = (path = '/', stateStorage = {}, title = '') => {
-  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);
-
-  if (window.location.pathname === sanitizedPath && (!inputSearch || inputSearch === location.search)) {
-    console.warn('Prevent overwriting same path', {
-      inputPath: inputPath,
-      inputSearch: inputSearch,
-      sanitizedPath: sanitizedPath,
-      currentLocationSearch: location.search,
-      currentLocationHash: location.hash,
-    });
-    return;
-  }
-  console.warn('Set path', {
-    inputPath: inputPath,
-    inputSearch: inputSearch,
-    sanitizedPath: sanitizedPath,
-    currentLocationSearch: location.search,
-    currentLocationHash: location.hash,
-  });
-  return history.pushState(
-    stateStorage,
-    title,
-    `${sanitizedPath}${inputSearch ? `?${inputSearch}` : ''}${location.hash ?? ''}`,
-  );
-};
-
-/**
- * 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.
@@ -375,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
@@ -470,6 +389,8 @@ function hexToRgbA(hex) {
   throw new Error('Invalid Hex');
 }
 
+const htmlStrSanitize = (str) => (str ? str.replace(/<\/?[^>]+(>|$)/g, '').trim() : '');
+
 export {
   s,
   htmls,
@@ -478,8 +399,6 @@ export {
   sa,
   copyData,
   pasteData,
-  setPath,
-  getQueryParams,
   preHTML,
   disableOptionsClick,
   checkFullScreen,
@@ -488,7 +407,6 @@ export {
   getResponsiveData,
   isElement,
   downloadFile,
-  getProxyPath,
   getRawContentFile,
   getBlobFromUint8ArrayFile,
   isNavigator,
@@ -500,4 +418,5 @@ export {
   getDataFromInputFile,
   getLang,
   hexToRgbA,
+  htmlStrSanitize,
 };

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/LogInDefault.js

@@ -1,17 +1,11 @@
-import { UserService } from '../../services/user/user.service.js';
 import { Auth } from '../core/Auth.js';
 import { LogIn } from '../core/LogIn.js';
-import { s } from '../core/VanillaJs.js';
 import { ElementsDefault } from './ElementsDefault.js';
 
 const LogInDefault = async function () {
   LogIn.Event['LogInDefault'] = async (options) => {
     const { token, user } = options;
     ElementsDefault.Data.user.main.model.user = user;
-    s(`.main-btn-log-in`).style.display = 'none';
-    s(`.main-btn-sign-up`).style.display = 'none';
-    s(`.main-btn-log-out`).style.display = null;
-    s(`.main-btn-account`).style.display = null;
   };
   const { user } = await Auth.sessionIn();
   ElementsDefault.Data.user.main.model.user = user;

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

@@ -1,25 +1,9 @@
-import { Auth } from '../core/Auth.js';
 import { LogOut } from '../core/LogOut.js';
-import { NotificationManager } from '../core/NotificationManager.js';
-import { Translate } from '../core/Translate.js';
-import { s } from '../core/VanillaJs.js';
 import { ElementsDefault } from './ElementsDefault.js';
 
 const LogOutDefault = async function () {
   LogOut.Event['LogOutDefault'] = async (result = { user: { _id: '' } }) => {
     ElementsDefault.Data.user.main.model.user = result.user;
-
-    s(`.main-btn-log-out`).style.display = 'none';
-    s(`.main-btn-account`).style.display = 'none';
-    s(`.main-btn-log-in`).style.display = null;
-    s(`.main-btn-sign-up`).style.display = null;
-    if (s(`.modal-log-out`)) s(`.btn-close-modal-log-out`).click();
-    if (s(`.modal-account`)) s(`.btn-close-modal-account`).click();
-
-    NotificationManager.Push({
-      html: Translate.Render(`success-logout`),
-      status: 'success',
-    });
   };
 };