@underpostnet/underpost 2.97.0 → 2.97.5

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

@@ -19,7 +19,7 @@ const SignUp = {
         {
           model: 'username',
           id: `sign-up-username`,
-          rules: [{ type: 'isEmpty' }, { type: 'isLength', options: { min: 2, max: 20 } }],
+          rules: [{ type: 'isEmpty' }, { type: 'isLength', options: { min: 2, max: 20 } }, { type: 'isValidUsername' }],
         },
         { model: 'email', id: `sign-up-email`, rules: [{ type: 'isEmpty' }, { type: 'isEmail' }] },
         {
@@ -43,23 +43,42 @@ const SignUp = {
           if ('model' in inputData) body[inputData.model] = s(`.${inputData.id}`).value;
         }
         const result = await UserService.post({ body });
+        const handleSignUpError = (data) => {
+          let error = '';
+          if (data.message) {
+            if (data.message.match('duplicate')) {
+              if (data.message.match('username')) error += Translate.Render('error-username-taken');
+              if (data.message.match('email')) error += Translate.Render('error-email-taken');
+            } else {
+              if (data.message.match('username')) error += Translate.Render('error-username-invalid');
+              if (data.message.match('email')) error += Translate.Render('error-email-invalid');
+              if (data.message.match('password')) error += Translate.Render('error-password-invalid');
+            }
+            return error;
+          }
+          return Translate.Render('error-register-user');
+        };
         NotificationManager.Push({
           html:
             typeof result.data === 'string'
               ? result.data
               : result.status === 'success'
-              ? Translate.Render(`success-register-user`)
-              : Translate.Render(`no-valid-register`),
+                ? Translate.Render(`success-register-user`)
+                : handleSignUpError(result),
           status: result.status,
         });
         if (result.status === 'success') {
           await Auth.sessionIn(result);
-          s(`.btn-close-${options.idModal}`).click();
+          setTimeout(() => {
+            if (s(`.btn-close-${options.idModal}`)) s(`.btn-close-${options.idModal}`).click();
+          });
         }
       });
-      s(`.btn-sign-up-i-have-account`).onclick = () => {
-        s(`.main-btn-log-in`).click();
-      };
+      setTimeout(() => {
+        s(`.btn-sign-up-i-have-account`).onclick = () => {
+          s(`.main-btn-log-in`).click();
+        };
+      });
     });
     return html`
       ${await BtnIcon.Render({

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

@@ -21,9 +21,12 @@ const SocketIo = {
   },
   Init: async function (options) {
     if (this.socket) this.socket.disconnect();
-    this.host = options.host ?? getWsBaseUrl({ wsBasePath: '' });
-    logger.info(`ws host:`, this.host);
-    const path = typeof options.path === 'string' ? options.path : getWsBasePath();
+    const path = getWsBasePath();
+    this.host = options.host ? options.host : getWsBaseUrl({ wsBasePath: '' });
+    logger.info(`ws host:`, {
+      host: this.host,
+      path,
+    });
     const connectOptions = {
       path: path === '/' ? undefined : path,
       // auth: {

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

@@ -111,6 +111,30 @@ const TranslateCore = {
         es: 'Este campo no cumple con los requisitos específicos',
         en: 'This field does not meet specific requirements',
       },
+      'error-username-invalid': {
+        es: 'Nombre de usuario no válido. Debe contener solo letras, números y guiones bajos.',
+        en: 'Invalid username. Must contain only letters, numbers, and underscores.',
+      },
+      'error-email-invalid': {
+        es: 'Dirección de correo electrónico no válida.',
+        en: 'Invalid email address.',
+      },
+      'error-password-invalid': {
+        es: 'Contraseña no válida. Debe tener al menos 8 caracteres, incluir mayúsculas, minúsculas, números y símbolos.',
+        en: 'Invalid password. Must be at least 8 characters long and include uppercase, lowercase, numbers, and symbols.',
+      },
+      'error-username-taken': {
+        es: 'Este nombre de usuario ya está en uso. Por favor, elige otro.',
+        en: 'This username is already taken. Please choose another one.',
+      },
+      'error-email-taken': {
+        es: 'Esta dirección de correo electrónico ya está registrada.',
+        en: 'This email address is already registered.',
+      },
+      'error-register-user': {
+        es: 'Error al registrar el usuario. Por favor, intenta nuevamente.',
+        en: 'Error registering user. Please try again.',
+      },
     };
     Translate.Data['isMobilePhone'] = {
       en: 'Invalid mobile phone number. Please check the format and try again.',
@@ -141,6 +165,16 @@ const TranslateCore = {
     Translate.Data['download'] = { en: 'download', es: 'Descargar' };
     Translate.Data['delete'] = { en: 'delete', es: 'Eliminar' };
     Translate.Data['success-delete'] = { en: 'success delete item', es: 'Item eliminado con exito' };
+    Translate.Data['document-now-public'] = { en: 'Document is now public', es: 'El documento ahora es público' };
+    Translate.Data['document-now-private'] = { en: 'Document is now private', es: 'El documento ahora es privado' };
+    Translate.Data['error-toggle-public'] = {
+      en: 'Failed to toggle public status',
+      es: 'Error al cambiar estado público',
+    };
+    Translate.Data['confirm-make-public'] = {
+      en: 'Are you sure you want to make this document public?',
+      es: '¿Estás seguro de que deseas hacer público este documento?',
+    };
     Translate.Data['invalid-data'] = { en: 'Invalid data', es: 'Datos invalidos' };
     Translate.Data['upload'] = { en: 'upload', es: 'Subir' };
     Translate.Data['load'] = { en: 'load', es: 'Cargar' };
@@ -179,6 +213,10 @@ const TranslateCore = {
       en: 'Error during user login. Please check your credentials and try again.',
       es: 'Error durante el inicio de sesión del usuario. Por favor, verifica tus credenciales e intenta nuevamente.',
     };
+    Translate.Data['error-user-not-authenticated'] = {
+      en: 'You must be logged in to perform this action.',
+      es: 'Debe iniciar sesión para realizar esta acción.',
+    };
     Translate.Data['confirm-logout'] = { en: 'Confirm Logout', es: 'Confirmar cierre de sesión' };
     Translate.Data['success-logout'] = { en: 'Successful session logout', es: 'Cierre de sesión exitoso' };
     Translate.Data['account'] = { en: 'Account', es: 'Cuenta' };
@@ -531,6 +569,66 @@ const TranslateCore = {
       en: 'Require title and content or file',
       es: 'Requiere título y contenido o archivo',
     };
+    Translate.Data['public-profile'] = {
+      en: 'Public Profile',
+      es: 'Perfil Público',
+    };
+    Translate.Data['private-profile'] = {
+      en: 'Private Profile',
+      es: 'Perfil Privado',
+    };
+    Translate.Data['brief-description'] = {
+      en: 'Brief Description',
+      es: 'Descripción Breve',
+    };
+    Translate.Data['brief-description-cannot-be-empty'] = {
+      en: 'Brief description cannot be empty',
+      es: 'La descripción breve no puede estar vacía',
+    };
+    Translate.Data['user-not-found'] = {
+      en: 'User not found',
+      es: 'Usuario no encontrado',
+    };
+    Translate.Data['error-loading-profile'] = {
+      en: 'Error loading profile',
+      es: 'Error al cargar el perfil',
+    };
+    Translate.Data['profile-is-private'] = {
+      en: 'This profile is private',
+      es: 'Este perfil es privado',
+    };
+    Translate.Data['no-description'] = {
+      en: 'No description provided',
+      es: 'Sin descripción',
+    };
+    Translate.Data['member-since'] = {
+      en: 'Member since',
+      es: 'Miembro desde',
+    };
+    Translate.Data['followers'] = {
+      en: 'Followers',
+      es: 'Seguidores',
+    };
+    Translate.Data['following'] = {
+      en: 'Following',
+      es: 'Siguiendo',
+    };
+    Translate.Data['invalid-username-format'] = {
+      en: 'Username can only contain letters, numbers, hyphens, and underscores',
+      es: 'El nombre de usuario solo puede contener letras, números, guiones e guiones bajos',
+    };
+    Translate.Data['go-home'] = {
+      en: 'Go Home',
+      es: 'Ir a Inicio',
+    };
+    Translate.Data['go-back'] = {
+      en: 'Go Back',
+      es: 'Volver',
+    };
+    Translate.Data['public-profile'] = {
+      en: 'Public Profile',
+      es: 'Perfil Público',
+    };
   },
 };
 

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

@@ -66,6 +66,21 @@ const Validator = {
 
                 break;
               }
+              case 'isValidUsername': {
+                const username = s(`.${validatorData.id}`).value;
+                // Check if username is empty or only whitespace
+                if (!username || username.trim() === '') {
+                  errorMessage += this.renderErrorMessage(undefined, Translate.Render('invalid-username-format'));
+                  break;
+                }
+                // Check if username contains only valid characters (no spaces or special chars)
+                const usernameRegex = /^[a-zA-Z0-9_-]+$/;
+                if (!usernameRegex.test(username)) {
+                  errorMessage += this.renderErrorMessage(undefined, Translate.Render('invalid-username-format'));
+                }
+
+                break;
+              }
               default:
                 if (
                   validator[rule.type] &&

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

@@ -53,7 +53,7 @@ export class PwaWindowDimensions {
   // --- Private Static Getters (Encapsulating browser APIs) ---
 
   /**
-   * @private
+   * @method
    * @static
    * Try visualViewport values (most accurate for "what's actually visible").
    * @returns {{height: number|null, width: number|null}}
@@ -68,7 +68,7 @@ export class PwaWindowDimensions {
   }
 
   /**
-   * @private
+   * @method
    * @static
    * Try layout viewport (doctype-root) measurements.
    * document.documentElement.clientHeight/clientWidth are stable and widely used.
@@ -84,7 +84,7 @@ export class PwaWindowDimensions {
   }
 
   /**
-   * @private
+   * @method
    * @static
    * Try window.* measurements (innerHeight/innerWidth are widely supported).
    * @returns {{height: number|null, width: number|null}}
@@ -98,7 +98,7 @@ export class PwaWindowDimensions {
   }
 
   /**
-   * @private
+   * @method
    * @static
    * Try body measurements (less reliable, used as a fallback).
    * @returns {{height: number|null, width: number|null}}
@@ -112,7 +112,7 @@ export class PwaWindowDimensions {
   }
 
   /**
-   * @private
+   * @method
    * @static
    * Try screen measurements (physical screen/last-resort fallback).
    * @returns {{height: number|null, width: number|null}}
@@ -130,7 +130,7 @@ export class PwaWindowDimensions {
   }
 
   /**
-   * @private
+   * @method
    * @static
    * Try outer dimensions (less reliable, sometimes available fallback).
    * @returns {{height: number|null, width: number|null}}

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

@@ -1,16 +1,7 @@
 import { Account } from '../core/Account.js';
 import { BtnIcon } from '../core/BtnIcon.js';
 import { getId, newInstance } from '../core/CommonJs.js';
-import {
-  borderChar,
-  boxShadow,
-  Css,
-  darkTheme,
-  extractBackgroundImageUrl,
-  renderCssAttr,
-  ThemeEvents,
-  Themes,
-} from '../core/Css.js';
+import { Css, darkTheme, ThemeEvents, Themes } from '../core/Css.js';
 import { EventsUI } from '../core/EventsUI.js';
 import { LogIn } from '../core/LogIn.js';
 import { LogOut } from '../core/LogOut.js';
@@ -18,19 +9,19 @@ import { buildBadgeToolTipMenuOption, Modal, renderMenuLabel, renderViewTitle }
 import { SignUp } from '../core/SignUp.js';
 import { Translate } from '../core/Translate.js';
 import { htmls, s } from '../core/VanillaJs.js';
-import { getProxyPath } from '../core/Router.js';
+import { extractUsernameFromPath, getProxyPath, getQueryParams } from '../core/Router.js';
 import { ElementsDefault } from './ElementsDefault.js';
 import Sortable from 'sortablejs';
 import { RouterDefault, BannerAppTemplate } from './RoutesDefault.js';
 import { SettingsDefault } from './SettingsDefault.js';
 import { Badge } from '../core/Badge.js';
-import { Docs } from '../core/Docs.js';
 import { Recover } from '../core/Recover.js';
 import { DefaultManagement } from '../../services/default/default.management.js';
 import { Page500 } from '../core/500.js';
 import { Page404 } from '../core/404.js';
 import { PanelForm } from '../core/PanelForm.js';
 import { Chat } from '../core/Chat.js';
+import { PublicProfile } from '../core/PublicProfile.js';
 
 const MenuDefault = {
   Data: {},
@@ -111,6 +102,19 @@ const MenuDefault = {
             handleContainerClass: 'handle-btn-container',
             tooltipHtml: await Badge.Render(buildBadgeToolTipMenuOption('account')),
           })}
+          ${await BtnIcon.Render({
+            class: 'in wfa main-btn-menu main-btn-public-profile',
+            useMenuBtn: true,
+            label: renderMenuLabel({
+              icon: html`<i class="fas fa-user-tag"></i>`,
+              text: html`<span class="menu-label-text">${Translate.Render('public-profile')}</span>`,
+            }),
+            style: 'display: none',
+            attrs: `data-id="public-profile"`,
+            tabHref: `${getProxyPath()}u`,
+            handleContainerClass: 'handle-btn-container',
+            tooltipHtml: await Badge.Render(buildBadgeToolTipMenuOption('public-profile')),
+          })}
           ${await BtnIcon.Render({
             class: 'in wfa main-btn-menu main-btn-settings',
             useMenuBtn: true,
@@ -558,6 +562,49 @@ const MenuDefault = {
       });
     });
 
+    EventsUI.onClick(`.main-btn-public-profile`, async () => {
+      const { barConfig } = await Themes[Css.currentTheme]();
+      const idModal = 'modal-public-profile';
+      const user = ElementsDefault.Data.user.main.model.user;
+
+      // Check if modal already exists
+      const existingModal = s(`.${idModal}`);
+      if (existingModal) {
+        const usernameFromPath = extractUsernameFromPath();
+        const queryParams = getQueryParams();
+        const cid = usernameFromPath || queryParams.cid || user.username || null;
+        if (cid) {
+          await PublicProfile.Update({
+            idModal: 'modal-public-profile',
+            user: { username: cid },
+          });
+          return;
+        }
+      }
+
+      await Modal.Render({
+        id: idModal,
+        route: 'u',
+        barConfig,
+        title: '',
+        //   renderViewTitle({
+        //   icon: html`<i class="fas fa-user-circle"></i>`,
+        //   text: Translate.Render('public-profile'),
+        // }),
+        html: async () =>
+          await PublicProfile.Render({
+            idModal,
+            user,
+          }),
+        handleType: 'bar',
+        maximize: true,
+        mode: 'view',
+        slideMenu: 'modal-menu',
+        RouterInstance,
+        observer: true,
+      });
+    });
+
     EventsUI.onClick(`.main-btn-settings`, async () => {
       const { barConfig } = await Themes[Css.currentTheme]();
       await Modal.Render({

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

@@ -34,6 +34,7 @@ const RoutesDefault = () => {
       title: 'default-management',
       render: () => s(`.main-btn-default-management`).click(),
     },
+    '/u': { title: 'public-profile', render: () => s(`.main-btn-public-profile`).click() },
     '/404': { title: '404 Not Found', render: () => s(`.main-btn-404`).click() },
     '/500': { title: '500 Server Error', render: () => s(`.main-btn-500`).click() },
   };

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

@@ -1,3 +1,10 @@
+/**
+ * Core Service Client
+ * Provides methods to interact and build URLs for the core API endpoints.
+ * @module src/client/services/core/core.service.js
+ * @namespace CoreServiceClient
+ */
+
 import { Auth } from '../../components/core/Auth.js';
 import { loggerFactory } from '../../components/core/Logger.js';
 import { getProxyPath } from '../../components/core/Router.js';
@@ -9,8 +16,23 @@ logger.info('Load service');
 const endpoint = 'core';
 
 // https://developer.mozilla.org/en-US/docs/Web/API/AbortController
+
+/**
+ * Gets the base host for API requests.
+ * Uses the apiBaseHost from renderPayload if available, otherwise falls back to location.host.
+ * @memberof CoreServiceClient
+ * @return {string} The base host string.
+ */
 const getBaseHost = () => (window.renderPayload?.apiBaseHost ? window.renderPayload.apiBaseHost : location.host);
 
+/**
+ * Gets the base path for API requests.
+ * Constructs the path using proxyPath and apiBasePath from renderPayload or defaults.
+ * @memberof CoreServiceClient
+ * @param {Object} [options] - Options for constructing the base path.
+ * @param {string} [options.proxyPath] - Custom proxy path to use.
+ * @return {string} The constructed API base path.
+ */
 const getApiBasePath = (options) =>
   `${
     options?.proxyPath
@@ -22,18 +44,51 @@ const getApiBasePath = (options) =>
         : getProxyPath()
   }${window.renderPayload?.apiBasePath ? window.renderPayload.apiBasePath : 'api'}/`;
 
+/**
+ * Constructs the full API base URL for making requests.
+ * Combines protocol, host, base path, endpoint, and optional ID.
+ * @memberof CoreServiceClient
+ * @param {Object} [options={}] - Options for constructing the URL.
+ * @param {string} [options.id=''] - Optional resource ID to append to the URL.
+ * @param {string} [options.endpoint=''] - API endpoint name.
+ * @param {string} [options.proxyPath=''] - Custom proxy path to use.
+ * @return {string} The full API base URL.
+ */
 const getApiBaseUrl = (options = { id: '', endpoint: '', proxyPath: '' }) =>
   `${location.protocol}//${getBaseHost()}${getApiBasePath(options)}${options?.endpoint ? options.endpoint : ''}${
     options?.id ? `/${options.id}` : ''
   }`;
 
-const getWsBasePath = () => (getProxyPath() !== '/' ? `${getProxyPath()}socket.io/` : undefined);
+/**
+ * Gets the base path for WebSocket connections.
+ * Constructs the socket.io path using the proxy path.
+ * @memberof CoreServiceClient
+ * @return {string} The WebSocket base path.
+ */
+const getWsBasePath = () => (getProxyPath() !== '/' ? `${getProxyPath()}socket.io/` : '/socket.io/');
 
+/**
+ * Constructs the full WebSocket base URL for connections.
+ * Uses wss: for HTTPS and ws: for HTTP protocols.
+ * @memberof CoreServiceClient
+ * @param {Object} [options={}] - Options for constructing the WebSocket URL.
+ * @param {string} [options.id=''] - Optional resource ID to append to the URL.
+ * @param {string} [options.endpoint=''] - WebSocket endpoint name.
+ * @param {string} [options.wsBasePath=''] - Custom WebSocket base path to use.
+ * @return {string} The full WebSocket base URL.
+ */
 const getWsBaseUrl = (options = { id: '', endpoint: '', wsBasePath: '' }) =>
   `${window.location.protocol === 'https:' ? 'wss:' : 'ws:'}//${getBaseHost()}${
     options?.wsBasePath !== undefined ? options.wsBasePath : getWsBasePath()
   }${options?.endpoint ? options.endpoint : ''}${options?.id ? `/${options.id}` : ''}`;
 
+/**
+ * Creates HTTP headers for API requests.
+ * Includes Authorization header with JWT token and Content-Type based on headerId.
+ * @memberof CoreServiceClient
+ * @param {string} [headerId=''] - Header type identifier. Use 'file' for file uploads (no Content-Type).
+ * @return {Object} Headers object for fetch requests.
+ */
 const headersFactory = (headerId = '') => {
   const headers = {
     Authorization: Auth.getJWT(),
@@ -48,12 +103,77 @@ const headersFactory = (headerId = '') => {
   }
 };
 
+/**
+ * Prepares the request body payload for API requests.
+ * Returns FormData as-is, otherwise stringifies the body as JSON.
+ * @memberof CoreServiceClient
+ * @param {Object|FormData} body - The request body to process.
+ * @return {string|FormData} The processed payload ready for fetch.
+ */
 const payloadFactory = (body) => {
   if (body instanceof FormData) return body;
   return JSON.stringify(body);
 };
 
+/**
+ * Builds a URL with query parameters for pagination, filtering, and sorting.
+ * Supports AG Grid filterModel/sortModel as well as legacy simple sort params.
+ * @memberof CoreServiceClient
+ * @param {string} baseUrl - The base API URL.
+ * @param {Object} [options={}] - Query options.
+ * @param {number} [options.page] - Page number for pagination.
+ * @param {number} [options.limit] - Items per page for pagination.
+ * @param {Object|string} [options.filterModel] - AG Grid filterModel (object or JSON string).
+ * @param {Array|string} [options.sortModel] - AG Grid sortModel (array or JSON string).
+ * @param {string} [options.sort] - Simple sort field (legacy).
+ * @param {string|boolean} [options.asc] - Simple sort direction (legacy).
+ * @param {string} [options.order] - Order string, e.g. "field1:asc,field2:desc" (legacy).
+ * @return {URL} The URL object with query parameters set.
+ */
+const buildQueryUrl = (baseUrl, options = {}) => {
+  const url = new URL(baseUrl);
+  const { page, limit, filterModel, sortModel, sort, asc, order } = options;
+
+  // Add pagination params
+  if (page !== undefined) url.searchParams.set('page', page);
+  if (limit !== undefined) url.searchParams.set('limit', limit);
+
+  // Add filter model (AG Grid format) - send as JSON string
+  if (filterModel) {
+    const filterStr = typeof filterModel === 'string' ? filterModel : JSON.stringify(filterModel);
+    if (filterStr && filterStr !== '{}' && filterStr !== 'null') {
+      url.searchParams.set('filterModel', filterStr);
+    }
+  }
+
+  // Add sort model (AG Grid format) - send as JSON string
+  if (sortModel) {
+    const sortStr = typeof sortModel === 'string' ? sortModel : JSON.stringify(sortModel);
+    if (sortStr && sortStr !== '[]' && sortStr !== 'null') {
+      url.searchParams.set('sortModel', sortStr);
+    }
+  }
+
+  // Add simple sort params for backwards compatibility
+  if (sort) url.searchParams.set('sort', sort);
+  if (asc !== undefined) url.searchParams.set('asc', asc);
+  if (order) url.searchParams.set('order', order);
+
+  return url;
+};
+
+/**
+ * Core Service object providing CRUD operations for the core API endpoint.
+ * @memberof CoreServiceClient
+ */
 const CoreService = {
+  /**
+   * Performs a raw GET request to fetch content as text.
+   * @memberof CoreServiceClient.CoreService
+   * @param {Object} [options={}] - Request options.
+   * @param {string} [options.url=''] - The full URL to fetch.
+   * @return {Promise<string>} A promise that resolves with the response text.
+   */
   getRaw: (options = { url: '' }) =>
     new Promise((resolve, reject) =>
       fetch(options.url, {
@@ -71,6 +191,15 @@ const CoreService = {
           return reject(error);
         }),
     ),
+
+  /**
+   * Performs a POST request to create a new resource.
+   * @memberof CoreServiceClient.CoreService
+   * @param {Object} [options={}] - Request options.
+   * @param {string} [options.id=''] - Optional resource ID to append to the URL.
+   * @param {Object} [options.body={}] - The request body payload.
+   * @return {Promise<Object>} A promise that resolves with the JSON response.
+   */
   post: (options = { id: '', body: {} }) =>
     new Promise((resolve, reject) =>
       fetch(getApiBaseUrl({ id: options.id, endpoint }), {
@@ -91,6 +220,15 @@ const CoreService = {
           return reject(error);
         }),
     ),
+
+  /**
+   * Performs a PUT request to update an existing resource.
+   * @memberof CoreServiceClient.CoreService
+   * @param {Object} [options={}] - Request options.
+   * @param {string} [options.id=''] - The resource ID to update.
+   * @param {Object} [options.body={}] - The request body payload with updated data.
+   * @return {Promise<Object>} A promise that resolves with the JSON response.
+   */
   put: (options = { id: '', body: {} }) =>
     new Promise((resolve, reject) =>
       fetch(getApiBaseUrl({ id: options.id, endpoint }), {
@@ -111,6 +249,15 @@ const CoreService = {
           return reject(error);
         }),
     ),
+
+  /**
+   * Performs a GET request to retrieve a resource.
+   * @memberof CoreServiceClient.CoreService
+   * @param {Object} [options={}] - Request options.
+   * @param {string} [options.id=''] - Optional resource ID to retrieve.
+   * @param {Object} [options.body={}] - Unused, kept for API consistency.
+   * @return {Promise<Object>} A promise that resolves with the JSON response.
+   */
   get: (options = { id: '', body: {} }) =>
     new Promise((resolve, reject) =>
       fetch(getApiBaseUrl({ id: options.id, endpoint }), {
@@ -130,6 +277,15 @@ const CoreService = {
           return reject(error);
         }),
     ),
+
+  /**
+   * Performs a DELETE request to remove a resource.
+   * @memberof CoreServiceClient.CoreService
+   * @param {Object} [options={}] - Request options.
+   * @param {string} [options.id=''] - The resource ID to delete.
+   * @param {Object} [options.body={}] - Optional request body payload.
+   * @return {Promise<Object>} A promise that resolves with the JSON response.
+   */
   delete: (options = { id: '', body: {} }) =>
     new Promise((resolve, reject) =>
       fetch(getApiBaseUrl({ id: options.id, endpoint }), {
@@ -152,12 +308,18 @@ const CoreService = {
     ),
 };
 
+/**
+ * Alias for getApiBaseUrl function.
+ * @memberof CoreServiceClient
+ * @type {Function}
+ */
 const ApiBase = getApiBaseUrl;
 
 export {
   CoreService,
   headersFactory,
   payloadFactory,
+  buildQueryUrl,
   getBaseHost,
   getApiBasePath,
   getApiBaseUrl,