@cocreate/unique 1.11.0 → 1.11.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.11.2](https://github.com/CoCreate-app/CoCreate-unique/compare/v1.11.1...v1.11.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. ([233efdf](https://github.com/CoCreate-app/CoCreate-unique/commit/233efdfa04d76a7823e028c4ab9e13e174822587))
+
+## [1.11.1](https://github.com/CoCreate-app/CoCreate-unique/compare/v1.11.0...v1.11.1) (2023-05-18)
+
+
+### Bug Fixes
+
+* Refactor module imports for client file ([c0b1f24](https://github.com/CoCreate-app/CoCreate-unique/commit/c0b1f246e5adc69d953f62447b4fd4a5c8b6ae9e))
+
 # [1.11.0](https://github.com/CoCreate-app/CoCreate-unique/compare/v1.10.8...v1.11.0) (2023-05-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/unique",
-  "version": "1.11.0",
+  "version": "1.11.2",
   "description": "A simple unique component in vanilla javascript. Easily configured using HTML5 attributes and/or JavaScript API.",
   "keywords": [
     "unique",
@@ -59,8 +59,8 @@
     "webpack-log": "^3.0.1"
   },
   "dependencies": {
-    "@cocreate/crud-client": "^1.20.4",
-    "@cocreate/docs": "^1.7.8",
-    "@cocreate/uuid": "^1.4.7"
+    "@cocreate/crud-client": "^1.21.1",
+    "@cocreate/docs": "^1.7.10",
+    "@cocreate/uuid": "^1.4.9"
   }
 }

package/src/client.js

@@ -2,18 +2,30 @@ import observer from '@cocreate/observer';
 import crud from '@cocreate/crud-client';
 
 
+/**
+* Initializes input event listeners for the specified elements. This is a convenience method for calling setInputEvent on each element.
+* 
+* @param elements - The HTMLElement or array of HTMLElements to listen
+*/
 function init(elements) {
+    // Returns an array of unique elements
     if (!elements)
         elements = document.querySelectorAll('[unique]')
+    // If elements is not an array of elements returns an array of elements.
     else if (!Array.isArray(elements))
         elements = [elements]
     for (let element of elements)
         setInputEvent(element)
 }
 
+/**
+* Sets the input event to prevent duplicate. This is necessary because IE doesn't support unique = " true " in HTML5.
+* 
+* @param input - The input element to listen for changes on. Note that it's an object
+*/
 function setInputEvent(input) {
     let delayTimer
-    input.addEventListener('input', function (e) {
+    input.addEventListener('input', function () {
         input.setAttribute('unique', true);
 
         clearTimeout(delayTimer);
@@ -23,6 +35,11 @@ function setInputEvent(input) {
     });
 }
 
+/**
+* Checks if a value is unique. This is a helper function for CRUD operations that need to be performed on documents in order to make sure they are unique.
+* 
+* @param element - The element that is being checked for uniqueness. It should have the attribute ` name `
+*/
 async function isUnique(element) {
     let name = element.getAttribute('name');
     let value = element.getValue();
@@ -44,14 +61,19 @@ async function isUnique(element) {
         name,
         unique: true
     };
+
+    // If a document is returned, unique is set to false  
     if (data.document && data.document.length) {
         response.unique = false;
     }
+
+    // If indexedb response is unique is true, check server response  
     if (response.unique) {
         delete request.db
         response = await crud.socket.send('isUnique', request)
     }
 
+    // Set unique attribute on the element
     if (response.unique)
         element.setAttribute('unique', true);
     else

package/src/index.js

@@ -1,6 +1,7 @@
+// Check if browser, return client or server file
 (function (root, factory) {
     if (typeof define === 'function' && define.amd) {
-        define(["./client"], function (CoCreateUnique) {
+        define(["./client.js"], function (CoCreateUnique) {
             return factory(CoCreateUnique)
         });
     } else if (typeof module === 'object' && module.exports) {

package/src/server.js

@@ -1,4 +1,7 @@
 class CoCreateUnique {
+    /**
+    * @param crud
+    */
     constructor(crud) {
         this.wsManager = crud.wsManager
         this.crud = crud
@@ -13,6 +16,14 @@ class CoCreateUnique {
     }
 
 
+    /**
+    * Checks if a document is unique by sending a message to the socket. This is a blocking call so it returns a Promise
+    * 
+    * @param socket - the socket to send the message to
+    * @param data - the data to read from the database usually an object
+    * 
+    * @return { Promise } - resolves with the response from the server or rejects with an error if there was a
+    */
     async isUnique(socket, data) {
         const self = this
         try {
@@ -21,10 +32,11 @@ class CoCreateUnique {
                     unique: true,
                     uid: data.uid
                 };
+                // If the document is unique
                 if (data.document.length) {
                     response.unique = false;
                 }
-                self.wsManager.send(socket, 'isUnique', response);
+                return self.wsManager.send(socket, 'isUnique', response);
             })
         } catch (error) {
             console.log(error);