@feardread/feature-factory 3.0.1 → 4.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feardread/feature-factory",
-  "version": "3.0.1",
+  "version": "4.0.1",
   "description": "Library to interact with redux toolkit and reduce boilerplate / repeated code",
   "main": "dist/index.js",
   "scripts": {

package/src/factory/api.js

@@ -1,6 +1,6 @@
 import axios from "axios";
 import qs from "qs";
-import cache from "./cache";
+import CacheFactory from "./cache";
 
 
 const API_BASE_URL = (process.env.NODE_ENV === "production")
@@ -26,7 +26,7 @@ const instance = axios.create({
 
 instance.interceptors.request.use(
     (config) => {
-        const isAuth = cache.local.get("auth") ? cache.local.get("auth") : null;
+        const isAuth = CacheFactory.local.get("auth") ? CacheFactory.local.get("auth") : null;
         let token = isAuth !== null ? isAuth.token : "";
     
         config.headers = {
@@ -55,7 +55,7 @@ instance.interceptors.response.use(
         console.log("API ERROR :: ", error);
         if (error.response) {
             if (error.response.status === 401) {
-                cache.local.remove("auth");
+                CacheFactory.local.remove("auth");
                 return Promise.reject(error.response);
             }
             if (error.response.status === 500) {

package/src/factory/cache.js

@@ -1,71 +1,509 @@
+/**
+ * Storage types supported by the CacheFactory
+ */
+const STORAGE_TYPES = {
+  LOCAL: 'localStorage',
+  SESSION: 'sessionStorage',
+};
 
+/**
+ * Default configuration options
+ */
+const DEFAULT_OPTIONS = {
+  type: 'session',
+  prefix: '',
+  enableLogging: false,
+  fallbackToMemory: true,
+  maxRetries: 3,
+};
 
-// cache
-export const cache = (options = {}) => {
-  var engine = options.type == 'local' ? 'localStorage' : 'sessionStorage';
+/**
+ * In-memory fallback storage for when browser storage is unavailable
+ */
+class MemoryStorage {
+  constructor() {
+    this.data = new Map();
+  }
+
+  setItem(key, value) {
+    this.data.set(key, value);
+  }
+
+  getItem(key) {
+    return this.data.get(key) || null;
+  }
+
+  removeItem(key) {
+    this.data.delete(key);
+  }
+
+  clear() {
+    this.data.clear();
+  }
+
+  get length() {
+    return this.data.size;
+  }
+
+  key(index) {
+    const keys = Array.from(this.data.keys());
+    return keys[index] || null;
+  }
+
+  keys() {
+    return Array.from(this.data.keys());
+  }
+}
+
+/**
+ * Validates storage availability and functionality
+ * @param {Storage} storage - The storage object to test
+ * @returns {boolean} Whether storage is available and functional
+ */
+const isStorageAvailable = (storage) => {
+  if (!storage) return false;
+
+  try {
+    const testKey = '__cache_factory_test__';
+    const testValue = 'test';
+    
+    storage.setItem(testKey, testValue);
+    const retrieved = storage.getItem(testKey);
+    storage.removeItem(testKey);
+    
+    return retrieved === testValue;
+  } catch (error) {
+    return false;
+  }
+};
+
+/**
+ * Safely serializes data to JSON string
+ * @param {any} value - Value to serialize
+ * @returns {string|null} Serialized value or null if serialization fails
+ */
+const safeStringify = (value) => {
+  try {
+    return JSON.stringify(value);
+  } catch (error) {
+    console.error('CacheFactory: Failed to serialize value', error);
+    return null;
+  }
+};
+
+/**
+ * Safely parses JSON string
+ * @param {string} value - JSON string to parse
+ * @returns {any|null} Parsed value or null if parsing fails
+ */
+const safeParse = (value) => {
+  if (value === null || value === undefined) return null;
+  
+  try {
+    return JSON.parse(value);
+  } catch (error) {
+    // Return the original value if it's not valid JSON
+    return value;
+  }
+};
+
+/**
+ * Creates a cache instance with the specified configuration
+ * @param {Object} options - Configuration options
+ * @param {string} options.type - Storage type ('local' or 'session')
+ * @param {string} options.prefix - Key prefix for namespacing
+ * @param {boolean} options.enableLogging - Enable debug logging
+ * @param {boolean} options.fallbackToMemory - Use memory storage as fallback
+ * @param {number} options.maxRetries - Maximum retry attempts for operations
+ * @returns {Object} Cache instance with storage methods
+ */
+export const CacheFactory = (options = {}) => {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  const storageType = config.type === 'local' ? STORAGE_TYPES.LOCAL : STORAGE_TYPES.SESSION;
+  
+  let storage = null;
+  let usingMemoryFallback = false;
+
+  // Initialize storage
+  const initializeStorage = () => {
+    if (typeof window === 'undefined') {
+      // Server-side rendering or Node.js environment
+      if (config.fallbackToMemory) {
+        storage = new MemoryStorage();
+        usingMemoryFallback = true;
+        if (config.enableLogging) {
+          console.warn('CacheFactory: Browser storage unavailable, using memory fallback');
+        }
+      }
+      return;
+    }
+
+    const browserStorage = window[storageType];
+    
+    if (isStorageAvailable(browserStorage)) {
+      storage = browserStorage;
+    } else if (config.fallbackToMemory) {
+      storage = new MemoryStorage();
+      usingMemoryFallback = true;
+      if (config.enableLogging) {
+        console.warn(`CacheFactory: ${storageType} unavailable, using memory fallback`);
+      }
+    }
+  };
+
+  initializeStorage();
+
+  /**
+   * Generates a prefixed key
+   * @param {string} key - Original key
+   * @returns {string} Prefixed key
+   */
+  const getPrefixedKey = (key) => {
+    return config.prefix ? `${config.prefix}${key}` : key;
+  };
+
+  /**
+   * Removes prefix from key
+   * @param {string} prefixedKey - Prefixed key
+   * @returns {string} Original key
+   */
+  const removePrefixFromKey = (prefixedKey) => {
+    if (!config.prefix) return prefixedKey;
+    return prefixedKey.startsWith(config.prefix) 
+      ? prefixedKey.slice(config.prefix.length) 
+      : prefixedKey;
+  };
+
+  /**
+   * Logs debug information if logging is enabled
+   * @param {string} operation - Operation name
+   * @param {string} key - Storage key
+   * @param {any} data - Additional data to log
+   */
+  const log = (operation, key, data = null) => {
+    if (config.enableLogging) {
+      console.debug(`CacheFactory[${storageType}]: ${operation}`, { key, data, usingMemoryFallback });
+    }
+  };
+
+  /**
+   * Retries an operation with exponential backoff
+   * @param {Function} operation - Operation to retry
+   * @param {number} attempts - Current attempt number
+   * @returns {Promise<any>} Operation result
+   */
+  const retryOperation = async (operation, attempts = 0) => {
+    try {
+      return await operation();
+    } catch (error) {
+      if (attempts < config.maxRetries) {
+        const delay = Math.pow(2, attempts) * 100; // Exponential backoff
+        await new Promise(resolve => setTimeout(resolve, delay));
+        return retryOperation(operation, attempts + 1);
+      }
+      throw error;
+    }
+  };
 
   return {
-    check: () => {
-      if (!window[engine]) {
+    /**
+     * Checks if storage is available
+     * @returns {boolean} Storage availability status
+     */
+    isAvailable: () => {
+      return storage !== null;
+    },
+
+    /**
+     * Checks if using memory fallback
+     * @returns {boolean} Whether using memory storage
+     */
+    isUsingMemoryFallback: () => {
+      return usingMemoryFallback;
+    },
+
+    /**
+     * Gets storage type being used
+     * @returns {string} Storage type name
+     */
+    getStorageType: () => {
+      return usingMemoryFallback ? 'memory' : storageType;
+    },
+
+    /**
+     * Sets an item in storage
+     * @param {string} key - Storage key
+     * @param {any} value - Value to store
+     * @returns {Promise<boolean>} Success status
+     */
+    set: async (key, value) => {
+      if (!storage) {
+        console.error('CacheFactory: Storage not available');
         return false;
       }
-      return true;
-    },
-    set: (key, value) => {
-      if (!key) throw Error('Error:> Invalid key');
 
-      try {
-        window[engine].setItem(key, JSON.stringify(value));
+      if (!key || typeof key !== 'string') {
+        throw new Error('CacheFactory: Invalid key provided');
+      }
+
+      const prefixedKey = getPrefixedKey(key);
+      const serializedValue = safeStringify(value);
+
+      if (serializedValue === null) {
+        return false;
+      }
 
+      try {
+        await retryOperation(() => {
+          storage.setItem(prefixedKey, serializedValue);
+        });
+        
+        log('SET', key, value);
+        return true;
       } catch (error) {
-        console.error(`Error setting item ${key}:`, error);
+        console.error(`CacheFactory: Error setting item ${key}:`, error);
         return false;
       }
-      return true;
     },
-    get: (key) => {
+
+    /**
+     * Gets an item from storage
+     * @param {string} key - Storage key
+     * @param {any} defaultValue - Default value if key doesn't exist
+     * @returns {Promise<any>} Retrieved value or default
+     */
+    get: async (key, defaultValue = null) => {
+      if (!storage) {
+        console.warn('CacheFactory: Storage not available');
+        return defaultValue;
+      }
+
+      if (!key || typeof key !== 'string' || key === 'undefined') {
+        console.warn('CacheFactory: Invalid key provided for get operation');
+        return defaultValue;
+      }
+
+      const prefixedKey = getPrefixedKey(key);
+
       try {
-        if (key !== "undefined") {
-          const data = window[engine].getItem(key);
-          return data != 'undefined' ? JSON.parse(data) : null;
+        const data = await retryOperation(() => {
+          return storage.getItem(prefixedKey);
+        });
+
+        if (data === null || data === 'undefined') {
+          log('GET_MISS', key);
+          return defaultValue;
         }
 
+        const parsedData = safeParse(data);
+        log('GET_HIT', key, parsedData);
+        return parsedData;
+      } catch (error) {
+        console.error(`CacheFactory: Error getting item ${key}:`, error);
+        return defaultValue;
+      }
+    },
 
+    /**
+     * Removes an item from storage
+     * @param {string} key - Storage key
+     * @returns {Promise<boolean>} Success status
+     */
+    remove: async (key) => {
+      if (!storage) {
+        console.error('CacheFactory: Storage not available');
+        return false;
+      }
+
+      if (!key || typeof key !== 'string') {
+        console.warn('CacheFactory: Invalid key provided for remove operation');
+        return false;
+      }
+
+      const prefixedKey = getPrefixedKey(key);
+
+      try {
+        await retryOperation(() => {
+          storage.removeItem(prefixedKey);
+        });
+        
+        log('REMOVE', key);
+        return true;
       } catch (error) {
-        console.error(`Error getting item ${key}:`, error);
-        return null;
+        console.error(`CacheFactory: Error removing item ${key}:`, error);
+        return false;
       }
     },
-    remove: function (key) {
-      window[engine].removeItem(key);
+
+    /**
+     * Clears all items from storage (respects prefix)
+     * @returns {Promise<boolean>} Success status
+     */
+    clear: async () => {
+      if (!storage) {
+        console.error('CacheFactory: Storage not available');
+        return false;
+      }
+
+      try {
+        if (config.prefix) {
+          // Clear only prefixed items
+          const keys = await this.keys();
+          await Promise.all(keys.map(key => this.remove(key)));
+        } else {
+          await retryOperation(() => {
+            storage.clear();
+          });
+        }
+        
+        log('CLEAR');
+        return true;
+      } catch (error) {
+        console.error('CacheFactory: Error clearing storage:', error);
+        return false;
+      }
     },
-    clear: () => {
-      window[engine].clear();
+
+    /**
+     * Gets all keys from storage (without prefix)
+     * @returns {Promise<string[]>} Array of keys
+     */
+    keys: async () => {
+      if (!storage) {
+        console.warn('CacheFactory: Storage not available');
+        return [];
+      }
+
+      try {
+        let keys = [];
+
+        if (usingMemoryFallback) {
+          keys = storage.keys();
+        } else {
+          keys = Object.keys(storage);
+        }
+
+        // Filter by prefix and remove prefix from keys
+        const filteredKeys = config.prefix
+          ? keys.filter(key => key.startsWith(config.prefix))
+              .map(key => removePrefixFromKey(key))
+          : keys;
+
+        log('KEYS', null, filteredKeys);
+        return filteredKeys;
+      } catch (error) {
+        console.error('CacheFactory: Error getting keys:', error);
+        return [];
+      }
     },
-    keys: () => {
-      return Object.keys(window[engine]);
+
+    /**
+     * Checks if a key exists in storage
+     * @param {string} key - Storage key
+     * @returns {Promise<boolean>} Whether key exists
+     */
+    has: async (key) => {
+      if (!storage || !key || typeof key !== 'string') {
+        return false;
+      }
+
+      const prefixedKey = getPrefixedKey(key);
+
+      try {
+        const exists = await retryOperation(() => {
+          return storage.getItem(prefixedKey) !== null;
+        });
+        
+        log('HAS', key, exists);
+        return exists;
+      } catch (error) {
+        console.error(`CacheFactory: Error checking if key ${key} exists:`, error);
+        return false;
+      }
     },
-    has: (key) => {
-      return window[engine].getItem(key) !== null;
+
+    /**
+     * Gets storage usage information
+     * @returns {Promise<Object>} Storage usage stats
+     */
+    getStats: async () => {
+      const keys = await this.keys();
+      
+      return {
+        keyCount: keys.length,
+        storageType: this.getStorageType(),
+        usingMemoryFallback: usingMemoryFallback,
+        prefix: config.prefix || 'none',
+        keys: keys,
+      };
     },
-    /*
-    _extend: () => {
-      const destination = typeof arguments[0] === 'object' ? arguments[0] : {};
-
-      for (var i = 1; i < arguments.length; i++) {
-        if (arguments[i] && typeof arguments[i] === 'object') {
-          for (var property in arguments[i])
-            destination[property] = arguments[i][property];
-        }
-      }
 
-      return destination;
-    }
-      */
+    /**
+     * Bulk operations
+     */
+    bulk: {
+      /**
+       * Sets multiple items at once
+       * @param {Object} items - Key-value pairs to set
+       * @returns {Promise<Object>} Results of each operation
+       */
+      set: async (items) => {
+        const results = {};
+        
+        await Promise.all(
+          Object.entries(items).map(async ([key, value]) => {
+            results[key] = await this.set(key, value);
+          })
+        );
+        
+        return results;
+      },
+
+      /**
+       * Gets multiple items at once
+       * @param {string[]} keys - Keys to retrieve
+       * @returns {Promise<Object>} Retrieved key-value pairs
+       */
+      get: async (keys) => {
+        const results = {};
+        
+        await Promise.all(
+          keys.map(async (key) => {
+            results[key] = await this.get(key);
+          })
+        );
+        
+        return results;
+      },
+
+      /**
+       * Removes multiple items at once
+       * @param {string[]} keys - Keys to remove
+       * @returns {Promise<Object>} Results of each operation
+       */
+      remove: async (keys) => {
+        const results = {};
+        
+        await Promise.all(
+          keys.map(async (key) => {
+            results[key] = await this.remove(key);
+          })
+        );
+        
+        return results;
+      },
+    },
   };
-}
+};
+
+// Pre-configured instances for convenience
+CacheFactory.local = CacheFactory({ type: 'local' });
+CacheFactory.session = CacheFactory({ type: 'session' });
 
-cache.local = cache({ type: 'local' });
-cache.session = cache({ type: 'session' });
+// Memory-only instance for testing or server-side use
+CacheFactory.memory = CacheFactory({ 
+  type: 'session', 
+  fallbackToMemory: true 
+});
 
-export default cache;
+export default CacheFactory;