mentie 0.3.21 → 0.3.23

package/modules/environment.js

@@ -63,7 +63,7 @@ env.dev = () => env.node_dev() || env.web_dev()
  * Retrieves the log level set via URL parameters in a web environment.
  * @returns {string|null} The log level from URL parameters, or null if not set.
  */
-env.web_loglevel = () => env.is_web() && new URLSearchParams( location?.search ).get( 'loglevel' )
+env.web_loglevel = () => env.is_web() && new URLSearchParams( location?.search ).get( 'loglevel' ) || new URLSearchParams( location?.search ).get( 'log_level' )
 
 /**
  * Retrieves the log level set via environment variables in a Node.js environment.

package/modules/manipulations.js

@@ -1,3 +1,5 @@
+import { is_ipv4 } from "./validations"
+
 /**
  * Shuffle an array using the Fisher-Yates algorithm.
  * @param {Array} array 
@@ -20,4 +22,56 @@ export const shuffle_array = ( array, in_place=true ) => {
 
     return to_shuffle
 
+}
+
+/**
+ * Trims whitespace from each line of a multiline string.
+ * @param {string} string - The multiline string to trim.
+ * @returns {string} - The trimmed multiline string.
+ */
+export const multiline_trim = string => `${ string }`.split( '\n' ).map( s => s?.trim() ).join( '\n' ).trim()
+
+/**
+ * Sanitizes a string by removing leading and trailing whitespace and converting it to lowercase.
+ *
+ * @param {string} string - The string to be sanitized.
+ * @param {boolean} [multiline=true] - Whether to trim each line of a multiline string.
+ * @returns {string} - The sanitized string.
+ */
+export const sanetise_string = ( string, multiline=true ) => {
+    string = `${ string }`.toLowerCase()
+    if( multiline ) string = multiline_trim( string )
+    else string = string.trim()
+    return string
+}
+
+/**
+ * Sanitizes and optionally validates an IPv4 address.
+ * @param {Object} options - The options object.
+ * @param {string} options.ip - The IP address to sanitize.
+ * @param {boolean} [options.validate=false] - Whether to validate the IP address.
+ * @param {boolean} [options.error_on_invalid=false] - Whether to throw an error on an invalid IP.
+ * @returns {string|null} The sanitized IPv4 address, or null if validation fails and error_on_invalid is false.
+ * @throws {Error} If the IP address is not provided or invalid when error_on_invalid is true.
+ */
+export const sanetise_ipv4 = ( { ip, validate=false, error_on_invalid=false } ) => {
+
+    // Ensure ip was provided
+    if( !ip ) throw new Error( 'IP address is required' )
+
+    // Sanetise ip address as string
+    ip = sanetise_string( ip )
+
+    // Remove ipv6 prefix if present
+    ip = ip.replace( '::ffff:', '' )
+
+    // Check if the IP address is valid
+    if( validate && !is_ipv4( ip ) ) {
+        if( error_on_invalid ) throw new Error( `Invalid IPv4 address: ${ ip }` )
+        return null
+    }
+
+    // Return the sanitized IP address
+    return ip
+
 }

package/modules/validations.js

@@ -7,13 +7,6 @@ import stringify from "safe-stable-stringify"
  */
 export const email_regex = /(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/i
 
-/**
- * Sanitizes a string by removing leading and trailing whitespace and converting it to lowercase.
- *
- * @param {string} string - The string to be sanitized.
- * @returns {string} - The sanitized string.
- */
-export const sanetise_string = string => `${ string }`.trim().toLowerCase()
 
 /**
  * Validates whether a given string is a valid IPv4 address.
@@ -23,7 +16,7 @@ export const sanetise_string = string => `${ string }`.trim().toLowerCase()
 export const is_ipv4 = ip => {
 
     // Split the IP address into its components and make then numbers
-    const octets = ip.split( '.' ).map( octet => parseInt( octet, 10 ) )
+    const octets = `${ ip }`.split( '.' ).map( octet => parseInt( octet, 10 ) )
 
     // Check if the IP address has 4 octets and each octet is between 0 and 255
     return octets.length === 4 && octets.every( octet => !isNaN( octet ) && octet >= 0 && octet <= 255 )
@@ -49,36 +42,6 @@ export const is_ipv6 = ip => {
 
 }
 
-/**
- * Sanitizes and optionally validates an IPv4 address.
- * @param {Object} options - The options object.
- * @param {string} options.ip - The IP address to sanitize.
- * @param {boolean} [options.validate=false] - Whether to validate the IP address.
- * @param {boolean} [options.error_on_invalid=false] - Whether to throw an error on an invalid IP.
- * @returns {string|null} The sanitized IPv4 address, or null if validation fails and error_on_invalid is false.
- * @throws {Error} If the IP address is not provided or invalid when error_on_invalid is true.
- */
-export const sanetise_ipv4 = ( { ip, validate=false, error_on_invalid=false } ) => {
-
-    // Ensure ip was provided
-    if( !ip ) throw new Error( 'IP address is required' )
-
-    // Sanetise ip address as string
-    ip = sanetise_string( ip )
-
-    // Remove ipv6 prefix if present
-    ip = ip.replace( '::ffff:', '' )
-
-    // Check if the IP address is valid
-    if( validate && !is_ipv4( ip ) ) {
-        if( error_on_invalid ) throw new Error( `Invalid IPv4 address: ${ ip }` )
-        return null
-    }
-
-    // Return the sanitized IP address
-    return ip
-
-}
 
 /**
  * Checks if an object contains all the required properties.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mentie",
-  "version": "0.3.21",
+  "version": "0.3.23",
   "description": "Mentor's toolbelt",
   "type": "module",
   "main": "index.js",