tiny-essentials 1.8.4 → 1.8.5

package/dist/legacy/http/fileCache.d.mts

@@ -4,8 +4,8 @@
  * Sends a stringified file as a response with caching, security headers, and optional metadata.
  * If `data.file` is not a string, the request is passed to the next middleware.
  *
- * @param {object} res - Express response object.
- * @param {Function} next - Express next middleware function.
+ * @param {import('express').Response} res - Express response object.
+ * @param {import('express').NextFunction} next - Express next middleware function.
  * @param {object} data - Configuration object for the file response.
  * @param {string} [data.file] - The content of the file to send (must be a string).
  * @param {number} [data.fileMaxAge] - Max age in seconds for cache expiration.
@@ -26,7 +26,7 @@
  *   });
  * });
  */
-export default function fileCache(res: object, next: Function, data: {
+export default function fileCache(res: import("express").Response, next: import("express").NextFunction, data: {
     file?: string | undefined;
     fileMaxAge?: number | undefined;
     date?: string | undefined;

package/dist/legacy/http/fileCache.mjs

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import _ from 'lodash';
 import moment from 'moment-timezone';
 import md5 from 'md5';
@@ -9,8 +8,8 @@ import byteLength from 'byte-length';
  * Sends a stringified file as a response with caching, security headers, and optional metadata.
  * If `data.file` is not a string, the request is passed to the next middleware.
  *
- * @param {object} res - Express response object.
- * @param {Function} next - Express next middleware function.
+ * @param {import('express').Response} res - Express response object.
+ * @param {import('express').NextFunction} next - Express next middleware function.
  * @param {object} data - Configuration object for the file response.
  * @param {string} [data.file] - The content of the file to send (must be a string).
  * @param {number} [data.fileMaxAge] - Max age in seconds for cache expiration.

package/dist/legacy/http/getDomainURL.cjs

@@ -2,16 +2,13 @@
 
 var check_domain = require('./check_domain.cjs');
 
-// @ts-nocheck
-
-
 /**
  * @function getDomainURL
  *
  * Constructs a full URL string from a domain and optional port, determining the proper protocol.
  * It also supports extracting the domain from an Express `req` object via `checkDomain.get(req)`.
  *
- * @param {string|object} domain - A domain string (e.g. "example.com") or Express `req` object.
+ * @param {string|import('express').Request} domain - A domain string (e.g. "example.com") or Express `req` object.
  * @param {number} [port] - Optional port to include in the URL (not added for ports 80 or 443).
  * @param {string} [httpResult='https'] - The protocol to use (usually "http" or "https").
  *
@@ -34,16 +31,16 @@ function getDomainURL(domain, port, httpResult = 'https') {
   // Domain
   if (typeof domainSelected === 'string') {
     // Port
-    let finalPort = port;
+    let finalPort = '';
     let finalURL = '';
-    if (typeof finalPort === 'number' && finalPort !== 80 && finalPort !== 443) {
+    if (typeof port === 'number' && port !== 80 && port !== 443) {
       finalPort = ':' + finalPort;
     } else {
       finalPort = '';
     }
 
     // Normal Domain
-    if (!domainSelected.startsWith('localhost:') && !domainSelected === 'localhost')
+    if (!domainSelected.startsWith('localhost:') && domainSelected !== 'localhost')
       finalURL = `${httpResult}://${domainSelected}`;
     // Localhost
     else finalURL = `http://${domainSelected}`;

package/dist/legacy/http/getDomainURL.d.mts

@@ -4,7 +4,7 @@
  * Constructs a full URL string from a domain and optional port, determining the proper protocol.
  * It also supports extracting the domain from an Express `req` object via `checkDomain.get(req)`.
  *
- * @param {string|object} domain - A domain string (e.g. "example.com") or Express `req` object.
+ * @param {string|import('express').Request} domain - A domain string (e.g. "example.com") or Express `req` object.
  * @param {number} [port] - Optional port to include in the URL (not added for ports 80 or 443).
  * @param {string} [httpResult='https'] - The protocol to use (usually "http" or "https").
  *
@@ -15,5 +15,5 @@
  * getDomainURL('localhost', 3000);  // "http://localhost:3000"
  * getDomainURL(req, 8080);          // Uses domain from request object
  */
-export default function getDomainURL(domain: string | object, port?: number, httpResult?: string): string;
+export default function getDomainURL(domain: string | import("express").Request, port?: number, httpResult?: string): string;
 //# sourceMappingURL=getDomainURL.d.mts.map

package/dist/legacy/http/getDomainURL.mjs

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import checkDomain from './check_domain.mjs';
 /**
  * @function getDomainURL
@@ -6,7 +5,7 @@ import checkDomain from './check_domain.mjs';
  * Constructs a full URL string from a domain and optional port, determining the proper protocol.
  * It also supports extracting the domain from an Express `req` object via `checkDomain.get(req)`.
  *
- * @param {string|object} domain - A domain string (e.g. "example.com") or Express `req` object.
+ * @param {string|import('express').Request} domain - A domain string (e.g. "example.com") or Express `req` object.
  * @param {number} [port] - Optional port to include in the URL (not added for ports 80 or 443).
  * @param {string} [httpResult='https'] - The protocol to use (usually "http" or "https").
  *
@@ -29,16 +28,16 @@ export default function getDomainURL(domain, port, httpResult = 'https') {
     // Domain
     if (typeof domainSelected === 'string') {
         // Port
-        let finalPort = port;
+        let finalPort = '';
         let finalURL = '';
-        if (typeof finalPort === 'number' && finalPort !== 80 && finalPort !== 443) {
+        if (typeof port === 'number' && port !== 80 && port !== 443) {
             finalPort = ':' + finalPort;
         }
         else {
             finalPort = '';
         }
         // Normal Domain
-        if (!domainSelected.startsWith('localhost:') && !domainSelected === 'localhost')
+        if (!domainSelected.startsWith('localhost:') && domainSelected !== 'localhost')
             finalURL = `${httpResult}://${domainSelected}`;
         // Localhost
         else

package/dist/legacy/http/userIP.cjs

@@ -2,18 +2,19 @@
 
 var _ = require('lodash');
 
-// @ts-nocheck
-
+/**
+ * @typedef {{ value: string[] | string, type: string | null }} IpResult
+ */
 
 /**
  * Retrieves the client's IP address from the Express request object,
  * supporting detection for Firebase/Cloud Functions, proxies, and direct connections.
  *
  * @param {import('express').Request} req - The Express request object.
- * @param {Record<string, any>} [options] - Optional configuration.
+ * @param {Object} [options] - Optional configuration.
  * @param {boolean} [options.isFirebase=false] - Enable detection for Firebase environments (e.g., Fastly).
  *
- * @returns {{ value: string[] | null, type: string | null }} An object containing the list of IP addresses and the detection source type.
+ * @returns {IpResult} An object containing the list of IP addresses and the detection source type.
  *
  * @example
  * const ipInfo = userIp(req);
@@ -21,7 +22,8 @@ var _ = require('lodash');
  * console.log(ipInfo.type);  // 'x-forwarded-for'
  */
 function userIp(req, options) {
-  let ip = { value: null, type: null };
+  /** @type {IpResult} */
+  const ip = {};
 
   const tinyCfg = _.defaultsDeep({}, options, {
     isFirebase: false,

package/dist/legacy/http/userIP.d.mts

@@ -1,20 +1,26 @@
+/**
+ * @typedef {{ value: string[] | string, type: string | null }} IpResult
+ */
 /**
  * Retrieves the client's IP address from the Express request object,
  * supporting detection for Firebase/Cloud Functions, proxies, and direct connections.
  *
  * @param {import('express').Request} req - The Express request object.
- * @param {Record<string, any>} [options] - Optional configuration.
+ * @param {Object} [options] - Optional configuration.
  * @param {boolean} [options.isFirebase=false] - Enable detection for Firebase environments (e.g., Fastly).
  *
- * @returns {{ value: string[] | null, type: string | null }} An object containing the list of IP addresses and the detection source type.
+ * @returns {IpResult} An object containing the list of IP addresses and the detection source type.
  *
  * @example
  * const ipInfo = userIp(req);
  * console.log(ipInfo.value); // ['192.168.0.1']
  * console.log(ipInfo.type);  // 'x-forwarded-for'
  */
-export default function userIp(req: import("express").Request, options?: Record<string, any>): {
-    value: string[] | null;
+export default function userIp(req: import("express").Request, options?: {
+    isFirebase?: boolean | undefined;
+}): IpResult;
+export type IpResult = {
+    value: string[] | string;
     type: string | null;
 };
 //# sourceMappingURL=userIP.d.mts.map

package/dist/legacy/http/userIP.mjs

@@ -1,14 +1,16 @@
-// @ts-nocheck
 import _ from 'lodash';
+/**
+ * @typedef {{ value: string[] | string, type: string | null }} IpResult
+ */
 /**
  * Retrieves the client's IP address from the Express request object,
  * supporting detection for Firebase/Cloud Functions, proxies, and direct connections.
  *
  * @param {import('express').Request} req - The Express request object.
- * @param {Record<string, any>} [options] - Optional configuration.
+ * @param {Object} [options] - Optional configuration.
  * @param {boolean} [options.isFirebase=false] - Enable detection for Firebase environments (e.g., Fastly).
  *
- * @returns {{ value: string[] | null, type: string | null }} An object containing the list of IP addresses and the detection source type.
+ * @returns {IpResult} An object containing the list of IP addresses and the detection source type.
  *
  * @example
  * const ipInfo = userIp(req);
@@ -16,7 +18,8 @@ import _ from 'lodash';
  * console.log(ipInfo.type);  // 'x-forwarded-for'
  */
 export default function userIp(req, options) {
-    let ip = { value: null, type: null };
+    /** @type {IpResult} */
+    const ip = {};
     const tinyCfg = _.defaultsDeep({}, options, {
         isFirebase: false,
     });

package/dist/legacy/index.cjs

@@ -1,7 +1,6 @@
 'use strict';
 
-var countObj = require('./get/countObj.cjs');
-var objType = require('./get/objType.cjs');
+var objFilter = require('../v1/basics/objFilter.cjs');
 var super_string_filter = require('./get/super_string_filter.cjs');
 var auth = require('./http/auth.cjs');
 var check_domain = require('./http/check_domain.cjs');
@@ -48,10 +47,10 @@ const legacyModules = {
   checkDomain: check_domain,
 
   // Get Obj Type
-  getObjType: objType,
+  getObjType: objFilter.objType,
 
   // Count Obj
-  countObj: countObj,
+  countObj: objFilter.countObj,
 
   // HTTP Auth Generator
   httpAuth: auth,

package/dist/legacy/index.d.mts

@@ -2,7 +2,7 @@ export default legacyModules;
 declare const legacyModules: {
     convertBytes: {
         list: any;
-        sequence: import("./libs/convertBytes.mjs").SizeUnit[];
+        sequence: string[];
         get: (bytes: number, selected: SizeUnit) => number;
         convert: (bytes: number, selected: SizeUnit) => number;
     };
@@ -10,18 +10,17 @@ declare const legacyModules: {
         readonly list: {
             [x: number]: string;
         };
-        send: (res: import("express").Response, http_code: number, callback?: (arg0: number) => void) => any;
+        send: (res: import("express").Response, http_code: number, callback?: (arg0: number) => import("express").Response) => import("express").Response;
         sendAsync: (res: import("express").Response, http_code: number, callback?: (arg0: number) => Promise<any>) => Promise<any>;
     };
     momentjs: typeof momentjs;
     checkDomain: {
-        validators: Array<{
+        validators: {
             type: string;
-            callback: (arg0: req) => Object;
-            the_domain?: string;
-        }>;
-        validator: (req: Record<string, any>, the_domain: string) => boolean;
-        get: (req: Record<string, any>) => string | null;
+            callback: (req: import("express").Request, the_domain: string) => string | boolean | string[] | null | undefined;
+        }[];
+        validator: (req: import("express").Request, the_domain: string) => boolean;
+        get: (req: import("express").Request) => string | true | string[] | null;
     };
     getObjType: typeof objType;
     countObj: typeof countObj;
@@ -31,7 +30,7 @@ declare const legacyModules: {
     superStringFilter: typeof super_string_filter;
     customModuleManager: {
         validator: (custom_modules: Record<string, any>, type: string) => boolean;
-        run: (custom_modules: Object | Function[], db_prepare: any, hookType: string, options?: Record<string, any>) => Promise<void>;
+        run: (custom_modules: Record<string, Function> | Function[], db_prepare: any, hookType: string, options?: Record<string, any>) => Promise<void>;
     };
     errorsCallback: typeof errorsCallback;
     domainValidator: typeof domainValidator;

package/dist/legacy/libs/arraySortPositions.cjs

@@ -1,13 +1,11 @@
 'use strict';
 
-// @ts-nocheck
-
 /**
  * Generates a comparator function to sort an array of objects by a given key.
  *
  * @param {string} item - The object key to sort by.
  * @param {boolean} [isReverse=false] - If `true`, the sorting will be in descending order.
- * @returns {(a: Object, b: Object) => number} Comparator function compatible with Array.prototype.sort().
+ * @returns {(a: Object<string|number, *>, b: Object<string|number, *>) => number} Comparator function compatible with Array.prototype.sort().
  *
  * @example
  * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];

package/dist/legacy/libs/arraySortPositions.d.mts

@@ -3,7 +3,7 @@
  *
  * @param {string} item - The object key to sort by.
  * @param {boolean} [isReverse=false] - If `true`, the sorting will be in descending order.
- * @returns {(a: Object, b: Object) => number} Comparator function compatible with Array.prototype.sort().
+ * @returns {(a: Object<string|number, *>, b: Object<string|number, *>) => number} Comparator function compatible with Array.prototype.sort().
  *
  * @example
  * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
@@ -13,5 +13,5 @@
  * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
  * arr.sort(arraySortPositions('pos', true)); // Descending: [{pos: 3}, {pos: 2}, {pos: 1}]
  */
-export default function arraySortPositions(item: string, isReverse?: boolean): (a: Object, b: Object) => number;
+export default function arraySortPositions(item: string, isReverse?: boolean): (a: any, b: any) => number;
 //# sourceMappingURL=arraySortPositions.d.mts.map

package/dist/legacy/libs/arraySortPositions.mjs

@@ -1,10 +1,9 @@
-// @ts-nocheck
 /**
  * Generates a comparator function to sort an array of objects by a given key.
  *
  * @param {string} item - The object key to sort by.
  * @param {boolean} [isReverse=false] - If `true`, the sorting will be in descending order.
- * @returns {(a: Object, b: Object) => number} Comparator function compatible with Array.prototype.sort().
+ * @returns {(a: Object<string|number, *>, b: Object<string|number, *>) => number} Comparator function compatible with Array.prototype.sort().
  *
  * @example
  * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];

package/dist/legacy/libs/capitalize.cjs

@@ -1,7 +1,5 @@
 'use strict';
 
-// @ts-nocheck
-
 /**
  * Capitalizes the first letter of each word in a given string.
  *

package/dist/legacy/libs/capitalize.mjs

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * Capitalizes the first letter of each word in a given string.
  *

package/dist/legacy/libs/convertBytes.cjs

@@ -1,7 +1,5 @@
 'use strict';
 
-// @ts-nocheck
-
 /**
  * A utility module to convert between bytes and higher order units (KB, MB, GB, etc).
  */
@@ -32,7 +30,7 @@ const convertBytes = {
 
   /**
    * Ordered list of size units.
-   * @type {SizeUnit[]}
+   * @type {string[]}
    */
   sequence: sequence,
 

package/dist/legacy/libs/convertBytes.mjs

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * A utility module to convert between bytes and higher order units (KB, MB, GB, etc).
  */
@@ -25,7 +24,7 @@ const convertBytes = {
     list: convertList,
     /**
      * Ordered list of size units.
-     * @type {SizeUnit[]}
+     * @type {string[]}
      */
     sequence: sequence,
     /**

package/dist/legacy/libs/custom_module_loader.cjs

@@ -1,9 +1,6 @@
 'use strict';
 
-var objType = require('../get/objType.cjs');
-
-// @ts-nocheck
-
+var objFilter = require('../../v1/basics/objFilter.cjs');
 
 /**
  * A custom module manager to validate and run hooks on external modules dynamically.
@@ -34,7 +31,7 @@ const custom_module_manager = {
    * Executes all functions inside the given modules.
    * Accepts either an array of functions or an object with typed module arrays.
    *
-   * @param {Object|Function[]} custom_modules - The modules or functions to run.
+   * @param {Record<string, function>|function[]} custom_modules - The modules or functions to run.
    * @param {*} db_prepare - A value to pass to each module when called.
    * @param {string} hookType - A string representing the hook (e.g., 'before', 'after').
    * @param {Record<string, any>} [options] - Optional. Object with keys matching types in `custom_modules`.
@@ -45,11 +42,18 @@ const custom_module_manager = {
    * await custom_module_manager.run(customModules, db, 'after', { paypal: true });
    */
   run: async function (custom_modules, db_prepare, hookType, options) {
+    /**
+     * @async
+     * @param {string} [type]
+     */
     const run_custom_module = async function (type) {
       let module_list = null;
 
-      if (type) {
-        if (custom_modules && custom_modules[type]) module_list = custom_modules[type];
+      if (typeof type === 'string') {
+        // @ts-ignore
+        if (custom_modules && typeof custom_modules[type] === 'function')
+          // @ts-ignore
+          module_list = custom_modules[type];
       } else module_list = custom_modules;
 
       if (Array.isArray(module_list)) {
@@ -59,7 +63,6 @@ const custom_module_manager = {
               await module_list[item](db_prepare, hookType);
             } catch (err) {
               console.error(err);
-              console.error(err.message);
             }
           } else {
             const err = new Error(
@@ -72,8 +75,9 @@ const custom_module_manager = {
       }
     };
 
-    if (objType(options, 'object')) {
+    if (objFilter.objType(options, 'object')) {
       for (const item in options) {
+        // @ts-ignore
         if (options[item] && Array.isArray(custom_modules[item])) await run_custom_module(item);
       }
     } else {

package/dist/legacy/libs/custom_module_loader.d.mts

@@ -1,6 +1,6 @@
 export default custom_module_manager;
 declare namespace custom_module_manager {
     function validator(custom_modules: Record<string, any>, type: string): boolean;
-    function run(custom_modules: Object | Function[], db_prepare: any, hookType: string, options?: Record<string, any>): Promise<void>;
+    function run(custom_modules: Record<string, Function> | Function[], db_prepare: any, hookType: string, options?: Record<string, any>): Promise<void>;
 }
 //# sourceMappingURL=custom_module_loader.d.mts.map

package/dist/legacy/libs/custom_module_loader.mjs

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import objType from '../get/objType.mjs';
 /**
  * A custom module manager to validate and run hooks on external modules dynamically.
@@ -27,7 +26,7 @@ const custom_module_manager = {
      * Executes all functions inside the given modules.
      * Accepts either an array of functions or an object with typed module arrays.
      *
-     * @param {Object|Function[]} custom_modules - The modules or functions to run.
+     * @param {Record<string, function>|function[]} custom_modules - The modules or functions to run.
      * @param {*} db_prepare - A value to pass to each module when called.
      * @param {string} hookType - A string representing the hook (e.g., 'before', 'after').
      * @param {Record<string, any>} [options] - Optional. Object with keys matching types in `custom_modules`.
@@ -38,10 +37,16 @@ const custom_module_manager = {
      * await custom_module_manager.run(customModules, db, 'after', { paypal: true });
      */
     run: async function (custom_modules, db_prepare, hookType, options) {
+        /**
+         * @async
+         * @param {string} [type]
+         */
         const run_custom_module = async function (type) {
             let module_list = null;
-            if (type) {
-                if (custom_modules && custom_modules[type])
+            if (typeof type === 'string') {
+                // @ts-ignore
+                if (custom_modules && typeof custom_modules[type] === 'function')
+                    // @ts-ignore
                     module_list = custom_modules[type];
             }
             else
@@ -54,7 +59,6 @@ const custom_module_manager = {
                         }
                         catch (err) {
                             console.error(err);
-                            console.error(err.message);
                         }
                     }
                     else {
@@ -67,6 +71,7 @@ const custom_module_manager = {
         };
         if (objType(options, 'object')) {
             for (const item in options) {
+                // @ts-ignore
                 if (options[item] && Array.isArray(custom_modules[item]))
                     await run_custom_module(item);
             }

package/dist/legacy/libs/dice.cjs

@@ -1,7 +1,5 @@
 'use strict';
 
-// @ts-nocheck
-
 /**
  * A simple random number generator (dice roller) utility.
  * Supports a vanilla dice roll from 1 to N.

package/dist/legacy/libs/dice.mjs

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * A simple random number generator (dice roller) utility.
  * Supports a vanilla dice roll from 1 to N.

package/dist/legacy/libs/markdown.cjs

@@ -1,15 +1,24 @@
 'use strict';
 
-// @ts-nocheck
-
 /**
  * A lightweight Markdown parser that can convert to HTML or BBCode.
  * @namespace markdownManager
  */
 const markdownManager = {
   /**
-   * Conversion rules for Markdown elements.
-   * Each rule includes a regex pattern, an HTML output, and a BBCode equivalent.
+   * A dictionary of Markdown element conversion rules.
+   *
+   * Each key represents a Markdown syntax identifier (like `h1`, `strong`, `image`, etc.),
+   * and its value contains the regular expression used to match the Markdown element,
+   * along with its HTML and BBCode equivalents.
+   *
+   * @type {{
+   *   [key: string]: {
+   *     regex: RegExp,              // The regex pattern used to identify the Markdown syntax.
+   *     result: string,             // The HTML output replacement string, using capture groups.
+   *     bbcode: string              // The BBCode equivalent of the Markdown syntax.
+   *   }
+   * }}
    */
   values: {
     h3: {

package/dist/legacy/libs/markdown.d.mts

@@ -1,76 +1,12 @@
 export default markdownManager;
 declare namespace markdownManager {
-    namespace values {
-        namespace h3 {
-            let regex: RegExp;
-            let result: string;
-            let bbcode: string;
-        }
-        namespace h2 {
-            let regex_1: RegExp;
-            export { regex_1 as regex };
-            let result_1: string;
-            export { result_1 as result };
-            let bbcode_1: string;
-            export { bbcode_1 as bbcode };
-        }
-        namespace h1 {
-            let regex_2: RegExp;
-            export { regex_2 as regex };
-            let result_2: string;
-            export { result_2 as result };
-            let bbcode_2: string;
-            export { bbcode_2 as bbcode };
-        }
-        namespace blockquote {
-            let regex_3: RegExp;
-            export { regex_3 as regex };
-            let result_3: string;
-            export { result_3 as result };
-            let bbcode_3: string;
-            export { bbcode_3 as bbcode };
-        }
-        namespace strong {
-            let regex_4: RegExp;
-            export { regex_4 as regex };
-            let result_4: string;
-            export { result_4 as result };
-            let bbcode_4: string;
-            export { bbcode_4 as bbcode };
-        }
-        namespace italic {
-            let regex_5: RegExp;
-            export { regex_5 as regex };
-            let result_5: string;
-            export { result_5 as result };
-            let bbcode_5: string;
-            export { bbcode_5 as bbcode };
-        }
-        namespace image {
-            let regex_6: RegExp;
-            export { regex_6 as regex };
-            let result_6: string;
-            export { result_6 as result };
-            let bbcode_6: string;
-            export { bbcode_6 as bbcode };
-        }
-        namespace url {
-            let regex_7: RegExp;
-            export { regex_7 as regex };
-            let result_7: string;
-            export { result_7 as result };
-            let bbcode_7: string;
-            export { bbcode_7 as bbcode };
-        }
-        namespace br {
-            let regex_8: RegExp;
-            export { regex_8 as regex };
-            let result_8: string;
-            export { result_8 as result };
-            let bbcode_8: string;
-            export { bbcode_8 as bbcode };
-        }
-    }
+    let values: {
+        [key: string]: {
+            regex: RegExp;
+            result: string;
+            bbcode: string;
+        };
+    };
     function parseMarkdown(markdownText: string, type?: "result" | "bbcode"): string;
 }
 //# sourceMappingURL=markdown.d.mts.map

package/dist/legacy/libs/markdown.mjs

@@ -1,12 +1,22 @@
-// @ts-nocheck
 /**
  * A lightweight Markdown parser that can convert to HTML or BBCode.
  * @namespace markdownManager
  */
 const markdownManager = {
     /**
-     * Conversion rules for Markdown elements.
-     * Each rule includes a regex pattern, an HTML output, and a BBCode equivalent.
+     * A dictionary of Markdown element conversion rules.
+     *
+     * Each key represents a Markdown syntax identifier (like `h1`, `strong`, `image`, etc.),
+     * and its value contains the regular expression used to match the Markdown element,
+     * along with its HTML and BBCode equivalents.
+     *
+     * @type {{
+     *   [key: string]: {
+     *     regex: RegExp,              // The regex pattern used to identify the Markdown syntax.
+     *     result: string,             // The HTML output replacement string, using capture groups.
+     *     bbcode: string              // The BBCode equivalent of the Markdown syntax.
+     *   }
+     * }}
      */
     values: {
         h3: {