@finnair/path 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [3.0.0](https://github.com/finnair/v-validation/compare/v2.0.0...v3.0.0) (2022-10-03)
+# [4.0.0](https://github.com/finnair/v-validation/compare/v3.2.0...v4.0.0) (2022-11-07)
 
 **Note:** Version bump only for package @finnair/path
 
@@ -11,7 +11,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
-# [3.0.0-alpha.2](https://github.com/finnair/v-validation/compare/v2.0.0...v3.0.0-alpha.2) (2022-09-28)
+# [3.1.0](https://github.com/finnair/v-validation/compare/v3.0.0...v3.1.0) (2022-10-24)
 
 **Note:** Version bump only for package @finnair/path
 
@@ -19,57 +19,34 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
-# [3.0.0-alpha.1](https://github.com/finnair/v-validation/compare/v2.0.0...v3.0.0-alpha.1) (2022-09-26)
-
-**Note:** Version bump only for package @finnair/path
-
-
+# [3.0.0](https://github.com/finnair/v-validation/compare/v2.0.0...v3.0.0) (2022-10-03)
 
+### Features
 
+- Use Object.freeze to ensure immutability.
 
 # [2.0.0](https://github.com/finnair/v-validation/compare/v1.1.0...v2.0.0) (2022-09-08)
 
 **Note:** Version bump only for package @finnair/path
 
-
-
-
-
 # [1.1.0](https://github.com/finnair/v-validation/compare/v1.0.1...v1.1.0) (2022-08-29)
 
-
 ### Features
 
-* Support for Luxon ([94b3806](https://github.com/finnair/v-validation/commit/94b38060e07feeb0abb8c81659d8bda537a4d9aa))
-
-
-
-
+- Support for Luxon ([94b3806](https://github.com/finnair/v-validation/commit/94b38060e07feeb0abb8c81659d8bda537a4d9aa))
 
 # [1.1.0-alpha.6](https://github.com/finnair/v-validation/compare/v1.0.1...v1.1.0-alpha.6) (2022-08-17)
 
 **Note:** Version bump only for package @finnair/path
 
-
-
-
-
 # [1.1.0-alpha.5](https://github.com/finnair/v-validation/compare/v1.0.1...v1.1.0-alpha.5) (2022-08-16)
 
 **Note:** Version bump only for package @finnair/path
 
-
-
-
-
 # [1.1.0-alpha.0](https://github.com/finnair/v-validation/compare/v1.0.1...v1.1.0-alpha.0) (2022-08-12)
 
 **Note:** Version bump only for package @finnair/path
 
-
-
-
-
 ## [1.0.1](https://github.com/finnair/v-validation/compare/v0.9.1...v1.0.1) (2022-01-20)
 
 ### Features

package/README.md

@@ -64,6 +64,9 @@ changes.forEach((newValue, path) => {
 updateResource(latestValue);
 ```
 
+NOTE: Updating an array with `Path.set` will truncate possible undefined values from the end of the array. This allows
+removing trailing elements without leaving undefined elements in place.
+
 ### Include/Exclude Projection
 
 While GraphQL is all about projections, something similar can also be implemented in a REST API with include/exclude parameters. `Projection` and `parsePathMatcher` function provides means to process results safely based on such a user input. This is, of course, very simplified projection compared to what GraphQL has to offer, but it's also... well, simpler.
@@ -92,9 +95,7 @@ Path.of(); // Root object $ - also Path.ROOT
 Path.of('array', 1, 'property'); // $.array[1].property
 
 // Constructing with fluent syntax
-Path.of()
-  .property('array')
-  .index(0); // $.array[0]
+Path.of().property('array').index(0); // $.array[0]
 
 // Concatenating Paths
 Path.of('parent').concat(Path.of('child', 'name')); // $.parent.child.name
@@ -119,6 +120,9 @@ Path.of('array', 1).unset({ array: [1, 2, 3] }); // { array: [1, undefined, 3] }
 // ...but unsetting a value doesn't create intermediate objects
 Path.of('array', 1).unset({}); // {}
 
+// Trailing undefined elements will be removed from an array (i.e. array is resized)
+Path.of('array', 2).set({ array: [1, undefined, 3] }, undefined); // { array: [1] } where array.length === 1
+
 // toJSON() returns JsonPath compatible serialization
 Path.of('array', 0, 'property with spaces').toJSON(); // $.array[0]["property with spaces"]
 ```

package/dist/Path.js

@@ -56,22 +56,30 @@ class Path {
         if (this.path.length === 0) {
             return value;
         }
-        let index = -1;
+        let pathIndex = -1;
         const _root = toObject(root, this.path);
         let current = _root;
-        for (index = 0; index < this.path.length - 1 && current; index++) {
-            const component = this.path[index];
+        for (pathIndex = 0; pathIndex < this.path.length - 1 && current; pathIndex++) {
+            const component = this.path[pathIndex];
             const child = toObject(current[component], this.path);
             current[component] = child;
             current = child;
         }
         if (value === undefined) {
             if (current !== undefined) {
-                delete current[this.path[index]];
+                delete current[this.path[pathIndex]];
+                // Truncate undefined tail of an array
+                if (Array.isArray(current)) {
+                    let i = current.length - 1;
+                    while (i >= 0 && current[i] === undefined) {
+                        i--;
+                    }
+                    current.length = i + 1;
+                }
             }
         }
         else {
-            current[this.path[index]] = value;
+            current[this.path[pathIndex]] = value;
         }
         return _root;
         function toObject(current, path) {
@@ -79,7 +87,7 @@ class Path {
                 return current;
             }
             else if (value !== undefined) {
-                if (typeof path[index + 1] === 'number') {
+                if (typeof path[pathIndex + 1] === 'number') {
                     return [];
                 }
                 else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finnair/path",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "private": false,
   "description": "Simple object path as array of strings and numbers",
   "main": "dist/index.js",
@@ -22,5 +22,5 @@
   "scripts": {
     "build": "tsc -b ."
   },
-  "gitHead": "597b85f1fcef99722bccf47c6d30260973d6d88c"
+  "gitHead": "d6540b51c4f1c57563602f66bd3157637703529b"
 }