mentie 0.2.37 → 0.3.0

package/README.md

@@ -2,3 +2,8 @@
 
 Mentor's favorite helpers.
 
+## Logging
+
+Cross environment logging depends on the `LOGLEVEL` variable. In web it is set with `?loglevel=`, in others with an environment variable `LOGLEVEL`.
+
+Valid values: `info`, `warn`, `error`.

package/modules/cache.js

@@ -14,9 +14,10 @@ const _cache = {}
  *
  * @param {string} key - The key to cache the value.
  * @param {*} [value] - The value to be cached (optional).
+ * @param {number} [expires_in_ms=Infinity] - The expiration time in milliseconds (optional).
  * @returns {*} The cached value.
  */
-export function cache( key, value ) {
+export function cache( key, value, expires_in_ms=Infinity ) {
 
     // If the key is undefined, log a warning
     if( key === undefined ) {
@@ -28,8 +29,14 @@ export function cache( key, value ) {
         log.warn( `The cache key ${ key } contains 'undefined', this may indicate a bug in your cache logic` )
     }
 
-    if( value ) _cache[key] = value
-    return _cache[key]
+    // If value is provided, save value and expiration
+    if( value ) _cache[key] = { value, expires: Date.now() + expires_in_ms }
+
+    // If cache has value, but it expired, remove it
+    if( _cache[key] && _cache[key].expires < Date.now() ) delete _cache[key]
+    
+    // Return the value of the cache key, which may be undefined
+    return _cache[key]?.value
 }
 
 /**

package/modules/environment.js

@@ -77,6 +77,41 @@ env.node_loglevel = () => env.is_node() && process.env?.LOG_LEVEL
  */
 env.loglevel = () => env.web_loglevel() || env.node_loglevel() || env.dev() ? 'info' : 'error'
 
+/**
+ * Checks if the code is running in a web browser and the platform is Mac.
+ * @returns {boolean} True if the code is running in a web browser and the platform is Mac, otherwise false.
+ */
+env.is_mac = () => env.is_web() && navigator.userAgent?.toUpperCase().includes( 'MAC' )
+
+/**
+ * Checks if the code is running in a web browser and the platform is iPhone.
+ * @returns {boolean} True if the code is running in a web browser and the platform is iPhone, otherwise false.
+ */
+env.is_iphone = () => env.is_web() && navigator.userAgent?.toUpperCase().includes( 'IPHONE' )
+
+/**
+ * Checks if the code is running in a web browser and the platform is Android.
+ * @returns {boolean} True if the code is running in a web browser and the platform is Android, otherwise false.
+ */
+env.is_android = () => env.is_web() && navigator.userAgent?.toUpperCase().includes( 'ANDROID' )
+
+/**
+ * Checks if the code is running in a web browser and the platform is iOS.
+ * @returns {boolean} True if the code is running in a web browser and the platform is made by Apple
+ */
+env.is_apple = () => env.is_web() && navigator.userAgent?.toUpperCase().includes( 'MAC OS X' )
+
+/**
+ * Checks if the code is running in a web browser and the platform is Windows.
+ * @returns {boolean} True if the code is running in a web browser and the platform is Linux, otherwise false.
+ */
+env.is_linux = () => env.is_web() && navigator.userAgent?.toUpperCase().includes( 'LINUX' )
+
+/**
+ * Checks if the code is running in a web browser and the platform is Windows.
+ * @returns {boolean} True if the code is running in a web browser and the platform is Windows, otherwise false.
+ */
+env.is_windows = () => env.is_web() && navigator.userAgent?.toUpperCase().includes( 'WIN' )
 
 /**
  * Checks if the code is running in a web environment.
@@ -114,6 +149,36 @@ export const is_emulator = env.is_emulator()
  */
 export const is_github_actions = typeof process !== 'undefined' && process.env?.GITHUB_ACTIONS == true
 
+/**
+ * @returns {boolean} Returns true if the code is running on an Apple device, otherwise returns false.
+ */
+export const is_apple = env.is_apple()
+
+/**
+ * @returns {boolean} Returns true if the code is running on an iPhone, otherwise returns false.
+ */
+export const is_iphone = env.is_iphone()
+
+/**
+ * @returns {boolean} Returns true if the code is running on a Mac, otherwise returns false.
+ */
+export const is_mac = env.is_mac()
+
+/**
+ * @returns {boolean} Returns true if the code is running on an Android device, otherwise returns false.
+ */
+export const is_android = env.is_android()
+
+/**
+ * @returns {boolean} Returns true if the code is running on a Linux device, otherwise returns false.
+ */
+export const is_linux = env.is_linux()
+
+/**
+ * @returns {boolean} Returns true if the code is running on a Windows device, otherwise returns false.
+ */
+export const is_windows = env.is_windows()
+
 // ///////////////////////////////
 // Mode and loglevel detection
 // ///////////////////////////////
@@ -156,7 +221,15 @@ export const log_environment = logger => {
             is_web,
             loglevel: web_loglevel,
             window: typeof window !== 'undefined' && window,
-            search: typeof location !== 'undefined' && location.search
+            search: typeof location !== 'undefined' && location.search,
+            platform: {
+                is_android,
+                is_apple,
+                is_iphone,
+                is_linux,
+                is_mac,
+                is_windows
+            }
         },
         node: {
             is_node,

package/package.json

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