mentie 0.0.11 → 0.1.2

package/modules/environment.js

@@ -17,13 +17,13 @@ export const is_node = typeof process !== 'undefined' && process.versions && pro
  * Checks if the code is running in a Firebase functions emulator environment.
  * @returns {boolean} Returns true if the code is running in a Firebase environment, otherwise returns false.
  */
-export const is_emulator = process.env.FUNCTIONS_EMULATOR === 'true'
+export const is_emulator = typeof process !== 'undefined' && process.env?.FUNCTIONS_EMULATOR === 'true'
 
 // ///////////////////////////////
 // Mode and loglevel detection
 // ///////////////////////////////
 
-const node_dev = process.env.NODE_ENV === 'development'
+const node_dev = typeof process !== 'undefined' && process.env?.NODE_ENV === 'development'
 const web_dev = typeof location !== 'undefined' && ( `${ location.href }`.includes( 'debug=true' ) || `${ location.href }`.includes( 'localhost' ) )
 
 /**
@@ -34,15 +34,15 @@ export const dev = node_dev || web_dev
 
 /**
  * The log level for web applications.
- * @type {string}
+ * @type {string} - Log level. Valid values are: 'info', 'warn', 'error'
  */
-export const web_loglevel = is_web && new URLSearchParams( location.search ).get( 'loglevel' )
+export const web_loglevel = is_web && new URLSearchParams( location?.search ).get( 'loglevel' )
 
 /**
  * The log level for the Node environment.
- * @type {string}
+ * @type {string} - Log level. Valid values are: 'info', 'warn', 'error'
  */
-export const node_loglevel = process.env.LOG_LEVEL
+export const node_loglevel = process.env?.LOG_LEVEL
 
 
 /**

package/modules/logging.js

@@ -1,5 +1,17 @@
 // Import environment data
-import { dev, loglevel } from "./environment.js"
+import { dev, is_emulator, loglevel } from "./environment.js"
+
+const should_log = levels => {
+
+    // Check if the loglevel matches this call
+    const valid_levels = [ 'info', 'warn', 'error' ]
+
+    // Check if the loglevel is valid
+    if( !valid_levels.includes( loglevel ) ) console.warn( `Invalid log level: ${ loglevel }` )
+
+    return levels.includes( loglevel )
+
+}
 
 /**
  * Logs the provided messages to the console.
@@ -15,17 +27,16 @@ import { dev, loglevel } from "./environment.js"
 export function log( ...messages ) {
 
     // Check if the loglevel matches this call
-    const levels = [ 'error', 'warn', 'info' ]
-    const should_log = dev || levels.includes( loglevel )
+    const levels = [ 'info' ]
 
     // Log the messages if the loglevel matches
-    if( should_log ) console.log( ...messages )
+    if( dev || should_log( levels ) ) console.log( ...messages )
 
 }
 
 /**
  * Logs the provided info messages to the console.
- * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn'
+ * Only logs in firebase emulator or if ?loglevel= or LOG_LEVEL= is set to: 'info'
  * 🎯 Goal: log info trace messages used only for extremely granular debugging
  * @example log.info( `Retreived key '${ key }' of type '${ typeof key }' from localstorage: `, cache )
  * @param {...any} messages - The messages to be logged.
@@ -33,17 +44,16 @@ export function log( ...messages ) {
 log.info = function( ...messages ) {
 
     // Check if the loglevel matches this call
-    const levels = [ 'error', 'warn', 'info' ]
-    const should_log = dev || levels.includes( loglevel )
+    const levels = [ 'info' ]
 
     // Log the messages if the loglevel matches
-    if( should_log ) console.info( ...messages )
+    if( is_emulator || should_log( levels ) ) console.info( ...messages )
 
 }
 
 /**
  * Logs the provided info messages to the console.
- * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn'
+ * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'warn', 'info'
  * 🎯 Goal: log warnings of things that should not happen, but do not break functionality
  * @example log.warn( `Transaction history was empty, this should never happen: `, history )
  * @param {...any} messages - The messages to be logged.
@@ -51,17 +61,16 @@ log.info = function( ...messages ) {
 log.warn = function( ...messages ) {
 
     // Check if the loglevel matches this call
-    const levels = [ 'error', 'warn' ]
-    const should_log = dev || levels.includes( loglevel )
+    const levels = [ 'warn', 'info' ]
 
     // Log the messages if the loglevel matches
-    if( should_log ) console.warn( ...messages )
+    if( dev || should_log( levels ) ) console.warn( ...messages )
 
 }
 
 /**
  * Logs the provided error messages to the console.
- * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error'
+ * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn', 'info'
  * @scope log errors that impact proper functioning of the application
  * @example log.error( `Error connecting to database: `, error )
  * @param {...any} messages - The messages to be logged.
@@ -69,9 +78,9 @@ log.warn = function( ...messages ) {
 log.error = function( ...messages ) {
 
     // Check if the loglevel matches this call
-    const levels = [ 'error' ]
+    const levels = [ 'error', 'warn', 'info' ]
     const should_log = dev || levels.includes( loglevel )
-    if( !should_log ) return
+    if( !dev || !should_log ) return
 
     // Log the messages if the loglevel matches
     console.error( ...messages )

package/modules/numbers.js

@@ -1,3 +1,10 @@
+/**
+ * Rounds a number to the specified number of decimals.
+ *
+ * @param {number} number - The number to round.
+ * @param {number} [decimals=4] - The number of decimals to round to. Default is 4.
+ * @returns {number} The rounded number.
+ */
 export const round_number_to_decimals = ( number, decimals=4 ) => {
 
     if( number == undefined ) return ''
@@ -7,12 +14,13 @@ export const round_number_to_decimals = ( number, decimals=4 ) => {
 }
 
 /**
- * Generates a random number between 1 and the specified maximum number.
+ * Generates a random number between a minimum and maximum value.
  *
- * @param {number} max_number - The maximum number for generating the random number.
+ * @param {number} max_num - The maximum value for the random number.
+ * @param {number} [min_num=1] - The minimum value for the random number
  * @returns {number} The generated random number.
  */
-export const random_number_of_max = max_number => Math.floor( Math.random() * max_number ) + 1
+export const random_number_between = ( max_num, min_num=1 ) => Math.floor( Math.random() * ( max_num - min_num + 1 ) ) + min_num
 
 
 /**
@@ -21,4 +29,4 @@ export const random_number_of_max = max_number => Math.floor( Math.random() * ma
  * @param {number} length - The length of the random number.
  * @returns {number} - The generated random number.
  */
-export const random_number_of_length = length => Number( [ ...Array( length ) ].map( () => random_number_of_max( 9 ) ).join( '' ) )
+export const random_number_of_length = length =>  parseInt( Array.from( { length }, () => Math.floor( Math.random() * 10 ) ).join( '' ), 10 )

package/modules/promises.js

@@ -69,7 +69,7 @@ export async function make_retryable( async_function, { retry_times=5, cooldown_
  * @returns {Promise<Array>} - A promise that resolves to an array of results from the async functions.
  * @see {@link https://www.npmjs.com/package/promise-parallel-throttle|promise-parallel-throttle}
  */
-async function throttle_and_retry( async_function_array=[], { max_parallell=2, retry_times, cooldown_in_s, cooldown_entropy, logger, fail_fast=true } ) {
+export async function throttle_and_retry( async_function_array=[], { max_parallel=2, retry_times, cooldown_in_s, cooldown_entropy, logger, fail_fast=true } ) {
 
     // Function dependencies 
     const Throttle = await import( 'promise-parallel-throttle' )
@@ -82,7 +82,7 @@ async function throttle_and_retry( async_function_array=[], { max_parallell=2, r
 
     // Throttle configuration
     const throttle_config = {
-        maxInProgress: max_parallell,
+        maxInProgress: max_parallel,
         failFast: fail_fast,
         ...logger && { progressCallback: logger }
     }

package/modules/text.js

@@ -9,19 +9,23 @@
 export const truncate = ( text, length=100, suffix='...' ) => {
     if( !text ) return ''
     if( text.length <= length ) return text
-    return `${ text.slice( 0, length ) }${ suffix }`
+    return `${ text.slice( 0, length ).trim() }${ suffix }`
 }
 
 /**
  * Copies the given text to the clipboard.
  * @param {string} text - The text to be copied to the clipboard.
- * @param {string} [success_message='Copied to clipboard'] - The success message to be displayed after copying.
+ * @param {object} options - The options for copying to the clipboard.
+ * @param {string} [options.success_message='Copied to clipboard'] - The success message to be displayed after copying.
+ * @param {function} [options.alerter] - The custom function to display the success message.
  * @returns {Promise<void>} - A promise that resolves when the text is successfully copied to the clipboard.
  */
-export const copy_to_clipboard = async ( text, success_message='Copied to clipboard' ) => {
+export const copy_to_clipboard = async ( text, { success_message='Copied to clipboard', alerter } ) => {
     if( !navigator?.clipboard?.writeText ) return alert( 'Your browser does not support copying to clipboard' )
     await navigator.clipboard.writeText( text )
-    alert( success_message )
+
+    if( alerter ) alerter( success_message )
+    else alert( success_message )
 }
 
 /**
@@ -30,4 +34,7 @@ export const copy_to_clipboard = async ( text, success_message='Copied to clipbo
  * @param {string} string - The input string.
  * @returns {string} The capitalized string.
  */
-export const capitalise = string => `${ string?.charAt( 0 ).toUpperCase() }${ string?.slice( 1, string?.length ) }`
+export const capitalise = string => { 
+    if( !string ) return ''
+    return `${ string?.charAt( 0 ).toUpperCase() }${ string?.slice( 1, string?.length ) }`
+}

package/modules/time.js

@@ -7,9 +7,9 @@
 export const wait = ( ms, error=false ) => new Promise( ( res, rej ) => setTimeout( error ? rej : res, ms ) )
 
 /**
- * Converts a timestamp to RFC-822 date format.
+ * Converts a timestamp to RFC-822 date format, specifically in GMT.
  * @param {number} timestamp - The timestamp to convert.
- * @returns {string} The RFC-822 formatted date string.
+ * @returns {string} The RFC-822 formatted date string in GMT.
  */
 export function timestamp_to_RFC822( timestamp ) {
 
@@ -18,7 +18,7 @@ export function timestamp_to_RFC822( timestamp ) {
     const months = [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ]
 
     // Create a date object from the timestamp
-    const date = new Date( timestamp )
+    const date = new Date( timestamp )    
 
     // Get components of the date
     const dayOfWeek = days[date.getUTCDay()]
@@ -35,11 +35,10 @@ export function timestamp_to_RFC822( timestamp ) {
     const minutesStr = minutes < 10 ? '0' + minutes : minutes
     const secondsStr = seconds < 10 ? '0' + seconds : seconds
 
-    // Get the timezone on the running machine
-    const { timeZone } = Intl.DateTimeFormat().resolvedOptions()
+    
 
     // Construct the RFC-822 date string
-    return `${ dayOfWeek }, ${ dayStr } ${ month } ${ year } ${ hoursStr }:${ minutesStr }:${ secondsStr } ${ timeZone }`
+    return `${ dayOfWeek }, ${ dayStr } ${ month } ${ year } ${ hoursStr }:${ minutesStr }:${ secondsStr } GMT`
 }
 
 /**

package/package.json

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