some-common-functions-js 1.1.2 → 1.1.4

package/CHANGELOG.md

@@ -45,3 +45,10 @@ Improve README.md documentation.
 
 ## Version 1.1.2 - 2025/12/26 - ITA
 Corrected a minor error in the README documentation.
+
+## Version 1.1.3 - 2025/12/27 - ITA
+- Improved getObjArrayWithNoDuplicates() and getNextDifferent functions to handle more test cases.
+- Added the unset() function.
+
+## Version 1.1.4 - 2025/12/27 - ITA
+Added the outstanding change log for the previous version.

package/README.md

@@ -134,6 +134,30 @@ console.log(emptyObj);
 */
 ```  
   
+### `unset(anObject, path)`  
+Remove a field from an object at the specified path.  
+Can take the place of lodash unset() function.  
+  
+***Example***  
+```
+const {unset} = require("some-common-functions-js");
+let testObj = {
+    firstName: 'John',
+    lastName: 'Rambo',
+    address: { country: { name: 'South Africa', code: 'ZA' } }
+};
+
+unset(testObj, "address.country.code");
+unset(testObj, "lastName");
+console.log(testObj); // Expecting to have "address.country.code" and "lastName" removed.
+/*
+    {
+        firstName: 'John',
+        address: { country: { name: 'South Africa' } }
+    }
+*/
+```  
+    
 ### `hasOnly(anObject, ...fields)`
 Returns `true` if the object contains **only** some or all of the specified fields and no others.  
   
@@ -460,59 +484,73 @@ Create an array of objects with duplicates eliminated. Taking only the first or
 ***Example***  
 ```
 const { getObjArrayWithNoDuplicates } = require("some-common-functions-js");  
-let teamsArray = [  
-    { score: 90, numGames: 10 },  
-    { score: 90, numGames: 10 },  
-    { score: 90, numGames: 10 },  
-    { score: 90, numGames: 12 },  
-    { score: 90, numGames: 12 },  
-    { score: 90, numGames: 12 },  
-    { score: 85, numGames: 8 },  
-    { score: 85, numGames: 8 },  
-    { score: 85, numGames: 10 },  
-    { score: 85, numGames: 10 },  
-    { score: 85, numGames: 10 }  
+let teamsArray = [
+    { score: 90, numGames: 10, name: "John" },
+    { score: 90, numGames: 10, name: "Jane" },
+    { score: 90, numGames: 10, name: "Bob" },
+    { score: 90, numGames: 12, name: "Alice" },
+    { score: 90, numGames: 12, name: "Charlie" },
+    { score: 90, numGames: 12, name: "David" },
+    { score: 85, numGames: 8, name: "Eve" },
+    { score: 85, numGames: 8, name: "Frank" },
+    { score: 85, numGames: 10, name: "Grace" },
+    { score: 85, numGames: 10, name: "Henry" },
+    { score: 85, numGames: 10, name: "Ivy" }
 ]; // Sorted by "score desc", "numGames asc".  
 
 let noDuplicatesArray = getObjArrayWithNoDuplicates(teamsArray, true, "score desc", "numGames asc");  
-console.log(noDuplicatesArray); // Should contain only unique objects according to comparison fields.  
+console.log(noDuplicatesArray);
+// Should contain only unique objects according to comparison fields. First object per duplicate group.
 /*  
-    [  
-        { score: 90, numGames: 10 },  
-        { score: 90, numGames: 12 },  
-        { score: 85, numGames: 8 },  
-        { score: 85, numGames: 10 }  
-    ]  
+    [
+        { score: 90, numGames: 10, name: 'John' },
+        { score: 90, numGames: 12, name: 'Alice' },
+        { score: 85, numGames: 8, name: 'Eve' },
+        { score: 85, numGames: 10, name: 'Grace' }
+    ]
 */  
+
+let noDuplicatesArray = getObjArrayWithNoDuplicates(teamsArray, true, "score desc", "numGames asc");  
+console.log(noDuplicatesArray);
+// Should contain unique objects according to comparison fields. Last object per duplicate group.
+/*
+    [
+        { score: 90, numGames: 10, name: 'Bob' },
+        { score: 90, numGames: 12, name: 'David' },
+        { score: 85, numGames: 8, name: 'Frank' },
+        { score: 85, numGames: 10, name: 'Ivy' }
+    ]
+*/
 ```  
   
 ### `getNextDifferent(objArray, targetObj, startFrom, ...comparisonFields)` 
 Get the index in the array of objects, of the next element that is distinct from the target object.  
-Comparison fields must match the field & sort order of the object array.  
+Comparison fields must match the field & sort order of the object array. 
+Throw an error if the target object is greater than objArray[startFrom] in terms of sort order.
 Examples of comparison fields: "firstName", "lastName desc", "address.province asc", "address.townOrCity".  
   
 ***Example***  
 ```  
-const { getNextDifferentObj } = require("some-common-functions-js");
+const { getNextDifferent } = require("some-common-functions-js");
 
 teamsArray = [
-    { score: 90, numGames: 10 },
-    { score: 90, numGames: 10 },
-    { score: 90, numGames: 10 },
-    { score: 90, numGames: 12 },
-    { score: 90, numGames: 12 },
-    { score: 90, numGames: 12 },
-    { score: 85, numGames: 8 },
-    { score: 85, numGames: 8 },
-    { score: 85, numGames: 10 },
-    { score: 85, numGames: 10 },
-    { score: 85, numGames: 10 }
+    { score: 90, numGames: 10, name: "John" },
+    { score: 90, numGames: 10, name: "Jane" },
+    { score: 90, numGames: 10, name: "Bob" },
+    { score: 90, numGames: 12, name: "Alice" },
+    { score: 90, numGames: 12, name: "Charlie" },
+    { score: 90, numGames: 12, name: "David" },
+    { score: 85, numGames: 8, name: "Eve" },
+    { score: 85, numGames: 8, name: "Frank" },
+    { score: 85, numGames: 10, name: "Grace" },
+    { score: 85, numGames: 10, name: "Henry" },
+    { score: 85, numGames: 10, name: "Ivy" }
 ]; // Sorted by "score desc", "numGames asc".
 
-let next = getNextDifferentObj(teamsArray, { score: 85, numGames: 8 }, 0, "score desc", "numGames asc"); 
+let next = getNextDifferent(teamsArray, { score: 85, numGames: 8 }, 0, "score desc", "numGames asc"); 
 // Throws an error because the startFrom index is to the left ('less than') the target object in terms of the field sort order.
 
-next = getNextDifferentObj(teamsArray, { score: 90, numGames: 10 }, 0, "score desc", "numGames asc");
+next = getNextDifferent(teamsArray, { score: 90, numGames: 10 }, 0, "score desc", "numGames asc");
 // 3
 
 

package/index.js

@@ -5,7 +5,9 @@
  * 2025/11/28  ITA   1.01     Added function hasOnlyAll().
  * 2025/12/22  ITA   1.02     Improved documentation of the functions and moved in more functions.
  * 2025/12/30  ITA   1.03     Removed lodash dependency by re-implementing get() and set() object functions, significantly reducing this package size.
- *                            Added function getNextDifferent() to deal better with duplicate removal from arrays of objects. *                            .
+ *                            Added function getNextDifferent() to deal better with duplicate removal from arrays of objects.
+ * 2026/01/02  ITA   1.04     Improved the functions getNoDuplicatesArray() and getNextDifferent() to handle more test cases.
+ *                            Added function unset().
 */
 
 /**Return true if userName is valid
@@ -266,10 +268,6 @@ module.exports.get = get;
  * @param {*} value the value to set.
  */
 function set(anObject, path, value) {
-    /*if (hasAll(anObject, path) === false) {
-        throw new Error(`Path ${path} does not exist on the object.`);
-    }*/
-
     let paths = path.split('.');
     if (paths.length > 1) {
         if (!anObject[paths[0]]) {
@@ -285,6 +283,24 @@ function set(anObject, path, value) {
 }
 module.exports.set = set;
 
+/** Unset the value of a field specified by the path on an object.
+ * @param {object} anObject a Javascript object.
+ * @param {string} path a path specifying the field whose value is to be set.
+ * @param {*} value the value to set.
+ */
+function unset(anObject, path) {
+    let paths = path.split('.');
+    if (paths.length > 1) {
+        const subObject = anObject[paths[0]];
+        paths.splice(0, 1);
+        unset(subObject, paths.join('.'));
+    }
+    else {
+        delete anObject[paths[0]];
+    }
+}
+module.exports.unset = unset;
+
 /**
  * Determine whether an object contains only 1, some or all of the specified fields, and not any other fields.
  * @param {object} anObject a Javascript object.
@@ -466,9 +482,14 @@ function getNextDifferent(objArray, targetObj, startFrom, ...comparisonFields) {
     let start = startFrom,
           end = objArray.length - 1;
 
+    
+    if (start >= objArray.length) { // throw error if startFrom is outside the bounds of the array.
+        throw new Error('startFrom is outside the bounds of the array.');
+    }
     // If target object is to the right of objArray[start], then throw an error..
-    if (objCompare(targetObj, objArray[start], ...comparisonFields) > 0) 
+    if (objCompare(targetObj, objArray[start], ...comparisonFields) > 0) {
         throw new Error('targetObj is to the right (\'greater than\') objArray[startFrom].');
+    }
          
     while (start < end) {   
         let mid = Math.trunc((start + end) / 2);
@@ -507,7 +528,7 @@ function getObjArrayWithNoDuplicates(objArray, firstOfDuplicates, ...comparisonF
         throw new Error(`firstOfDuplicates must be boolean true or false.`);
 
     const noDuplicates = [];
-    let idx;
+    let idx = 0;
     let grpStart = 0; // Start index of current duplicate group.
     while (grpStart < objArray.length - 1) {
         if (firstOfDuplicates) {
@@ -524,9 +545,17 @@ function getObjArrayWithNoDuplicates(objArray, firstOfDuplicates, ...comparisonF
         }
         idx = grpStart;
     }
-
-    if (objCompare(objArray[idx], noDuplicates[noDuplicates.length - 1], ...comparisonFields) !== 0)
-        noDuplicates.push(objArray[idx]); // Add the last object.
+    if (noDuplicates.length === 0) { // All objects are duplicates.
+        if (firstOfDuplicates)
+            noDuplicates.push(objArray[0]);
+        else
+            noDuplicates.push(objArray[objArray.length - 1]);
+    }
+    else {
+        if (objCompare(noDuplicates[noDuplicates.length - 1], objArray[objArray.length - 1], ...comparisonFields) !== 0) {
+            noDuplicates.push(objArray[objArray.length - 1]);
+        }
+    }
 
     return noDuplicates;
 } // function getObjArrayWithNoDuplicates(objArray, ...comparisonFields) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "some-common-functions-js",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Common functions used with Javascript objects, and field validation functions.",
   "keywords": [
     "validation",
@@ -23,14 +23,14 @@
     "object utilities",
     "object validation",
     "object array search",
-    "object compaare",
+    "object compare",
     "nodejs"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/IsaiahTshabalala/common-functions"
   },
-  "license": "ISC",
+  "license": "MIT",
   "author": "ITA",
   "type": "commonjs",
   "main": "index.js",