@cocreate/local-storage 1.7.1 → 1.7.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.7.3](https://github.com/CoCreate-app/CoCreate-local-storage/compare/v1.7.2...v1.7.3) (2023-05-21)
+
+
+### Bug Fixes
+
+* Update dependencies versions for [@cocreate](https://github.com/cocreate) libraries ([a3ebbb8](https://github.com/CoCreate-app/CoCreate-local-storage/commit/a3ebbb882d7137522328c79ddf611a33cfa12bc3))
+
+## [1.7.2](https://github.com/CoCreate-app/CoCreate-local-storage/compare/v1.7.1...v1.7.2) (2023-05-19)
+
+
+### Bug Fixes
+
+* update packages to latest version. This commit updates various packages in the dependencies section of the package.json file to their latest published versions, thereby fixing multiple bugs and improving overall performance. ([c689cc4](https://github.com/CoCreate-app/CoCreate-local-storage/commit/c689cc4a6b70756932abfbfb0f3e99e5443d8fbb))
+
 ## [1.7.1](https://github.com/CoCreate-app/CoCreate-local-storage/compare/v1.7.0...v1.7.1) (2023-05-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/local-storage",
-  "version": "1.7.1",
+  "version": "1.7.3",
   "description": "A Simple component similar to CoCreate-input & CoCreate-fetch which Save and fetch data for inputs, textarea, selects from localstorage. Easily configured using HTML5 attributes and/or JavaScript API",
   "keywords": [
     "local-storage",
@@ -59,8 +59,8 @@
     "webpack-log": "^3.0.1"
   },
   "dependencies": {
-    "@cocreate/actions": "^1.8.8",
-    "@cocreate/docs": "^1.7.8",
-    "@cocreate/observer": "^1.7.6"
+    "@cocreate/actions": "^1.8.11",
+    "@cocreate/docs": "^1.7.12",
+    "@cocreate/observer": "^1.7.9"
   }
 }

package/src/index.js

@@ -2,36 +2,53 @@ import observer from '@cocreate/observer';
 import action from '@cocreate/actions'
 
 const CoCreateLocalStorage = {
-	support: true,
+    support: true,
     storage: new Map(),
 
-	init: function() {
+    /**
+    * Listen for storage events and update elements if needed. This is called on window. storage and when it's time to get / set data
+    */
+    init: function () {
         const self = this
-		var elements = document.querySelectorAll('[localstorage-set], [localstorage-get]');
-		this.initElements(elements)
-        window.addEventListener('storage', function(e) {
+        var elements = document.querySelectorAll('[localstorage-set], [localstorage-get]');
+        this.initElements(elements)
+        /**
+        * @param e
+        */
+        window.addEventListener('storage', function (e) {
             elements = document.querySelectorAll(`[localstorage-get="${e.key}"]`)
             for (let element of elements) {
                 let value = self.getItem(e.key)
-                if (value != null){
+                // Set the value of the element.
+                if (value != null) {
                     element.setValue(value)
                 }
             }
-		});
-	},
+        });
+    },
 
-	initElements: function(elements) {
-		for (let element of elements)
-			this.initElement(element)
-	},
+    /**
+    * @param elements
+    */
+    initElements: function (elements) {
+        for (let element of elements)
+            this.initElement(element)
+    },
 
-	initElement: function(element) {
+    /**
+    * @param element
+    * 
+    * @return { Object } The binding
+    */
+    initElement: function (element) {
         this.getItem(element)
         element.addEventListener('input', (e) => {
             let isRealtime = element.getAttribute('realtime')
-			if (isRealtime == "false") return;
+            // Returns if realtime false.
+            if (isRealtime == "false") return;
 
             let key = e.target.getAttribute('localstorage-set');
+            // Set the key and value in the localstorage.
             if (key)
                 this.setItem(key, e.target.value);
 
@@ -39,54 +56,79 @@ const CoCreateLocalStorage = {
             for (let el of elements) {
                 if (el != element) {
                     let value = this.getItem(key)
-                    if (value != null){
+                    // Set the value of the element.
+                    if (value != null) {
                         el.setValue(value)
                     }
                 }
-        
+
             }
-		})
+        })
     },
-    
-    getItem: function(key) {
+
+    /**
+    * @param key
+    * 
+    * @return { Mixed } The value associated with the key or undefined if not found. Note that this will be returned as a string if the key is an array
+    */
+    getItem: function (key) {
+        // Returns the value of the key in the storage.
         if (this.support)
             return window.localStorage.getItem(key)
         else
             return this.storage.get(key)
-    }, 
-    
-    setItem: function(key, value) {
+    },
+
+    /**
+    * @param key - key name to store the value under
+    * @param value - value to store
+    */
+    setItem: function (key, value) {
+        // Set the value of the item.
         if (this.support)
             window.localStorage.setItem(key, value);
         else
             this.storage.set(key, value)
     },
 
-    removeItem: function(key) {
+    /**
+    * @param key - The key name to delete from the storage
+    */
+    removeItem: function (key) {
+        // Removes an item from the storage.
         if (this.support)
             window.localStorage.removeItem(key)
         else
             this.storage.delete(key)
-    }, 
-        
-    runStorage: function(btn) {
+    },
+
+    /**
+    * @param btn
+    * 
+    * @return { undefined } No return
+    */
+    runStorage: function (btn) {
         const form = btn.form;
+        // If the form is not a form return false.
         if (!form) return;
-        
+
         let set_els = form.querySelectorAll('[localstorage-set]')
         for (let el of set_els) {
             let key = el.getAttribute('localstorage-set');
             let value = el.getValue()
-            if (value && key){
+            // Sets the value of an item.
+            if (value && key) {
                 this.setItem(key, value);
             }
         }
         let get_els = form.querySelectorAll('[localstorage-get]')
         for (let el of get_els) {
             let key = el.getAttribute('localstorage-get');
+            // If key is not set return false.
             if (!key) return;
             let value = this.getItem(key)
-            if (value != null){
+            // Set the value of the element.
+            if (value != null) {
                 el.setValue(value)
             }
         }
@@ -94,60 +136,56 @@ const CoCreateLocalStorage = {
         for (let el of remove_els) {
             el.setValue('')
             let key = el.getAttribute('localstorage-remove');
+            // Removes an item from the list.
             if (key) {
                 this.removeItem(key)
             }
         }
-        
+
         document.dispatchEvent(new CustomEvent('localStorage', {
-			detail: {}
-		}))
-       
+            detail: {}
+        }))
+
     },
 
-    checkSupport: function() {
+    checkSupport: function () {
+        // Check if the browser supports localStorage.
         if (!('localStorage' in window)) {
             console.log("This browser doesn't support localStorage.");
             this.support = false;
-        } else { 
+        } else {
             try {
                 let test = window.localStorage.getItem('test')
+                // If the CoCreateConfig. localStorage is false this method will set support to false.
                 if (window.CoCreateConfig)
+                    // If the server supports local storage
                     if (window.CoCreateConfig.localStorage === false)
                         this.support = false;
-            } catch(e) {
+            } catch (e) {
                 this.support = false;
             } finally {
+                // Initialize the component. If support is enabled the method init is called.
                 if (this.support)
                     this.init()
             }
         }
-    }    
+    }
 }
 
-// observer.init({
-// 	name: 'CoCreateLocalstorage',
-// 	observe: ['addedNodes'],
-// 	target: '[localstorage-key]',
-// 	callback: function(mutation) {
-// 		CoCreateLocalStorage._initSessionIds(mutation.target);
-// 	}
-// });
-
 action.init({
-	name: "localStorage",
-	endEvent: "localStorage",
-	callback: (btn, data) => {
-		CoCreateLocalStorage.runStorage(btn)
-	},
+    name: "localStorage",
+    endEvent: "localStorage",
+    callback: (btn, data) => {
+        CoCreateLocalStorage.runStorage(btn)
+    },
 })
 
 action.init({
-	name: "localStorageRemove",
-	endEvent: "localStorageRemoved",
-	callback: (btn, data) => {
-		CoCreateLocalStorage.runStorage(btn)
-	},
+    name: "localStorageRemove",
+    endEvent: "localStorageRemoved",
+    callback: (btn, data) => {
+        CoCreateLocalStorage.runStorage(btn)
+    },
 })
 
 CoCreateLocalStorage.checkSupport()