@finnair/path 3.1.0 → 5.0.0

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0](https://github.com/finnair/v-validation/compare/v4.3.0...v5.0.0) (2023-10-13)
+
+
+### Features
+
+* use ECMAScript modules (ESM) instead of CommonJS ([#95](https://github.com/finnair/v-validation/issues/95)) ([92e9118](https://github.com/finnair/v-validation/commit/92e9118235957ec4bc2bcf2de73e195ea940378c))
+
+
+
+
+
+# [5.0.0](https://github.com/finnair/v-validation/compare/v4.3.0...v5.0.0) (2023-10-13)
+
+
+### Features
+
+* use ECMAScript modules (ESM) instead of CommonJS ([#95](https://github.com/finnair/v-validation/issues/95)) ([92e9118](https://github.com/finnair/v-validation/commit/92e9118235957ec4bc2bcf2de73e195ea940378c))
+
+
+
+
+
+# [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
+
+
+
+
+
 # [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

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.d.ts

@@ -1,4 +1,4 @@
-export declare type PathComponent = number | string;
+export type PathComponent = number | string;
 export declare class Path {
     static readonly ROOT: Path;
     private readonly path;

package/dist/Path.js

@@ -1,8 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Path = void 0;
 const identifierPattern = /^[a-zA-Z_][a-zA-Z0-9_]*$/;
-class Path {
+export class Path {
+    static ROOT = new Path([]);
+    path;
     constructor(path) {
         this.path = path;
         Object.freeze(this.path);
@@ -56,22 +55,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 +86,7 @@ class Path {
                 return current;
             }
             else if (value !== undefined) {
-                if (typeof path[index + 1] === 'number') {
+                if (typeof path[pathIndex + 1] === 'number') {
                     return [];
                 }
                 else {
@@ -152,5 +159,3 @@ class Path {
         }
     }
 }
-exports.Path = Path;
-Path.ROOT = new Path([]);

package/dist/PathMatcher.d.ts

@@ -1,5 +1,5 @@
-import { Path, PathComponent } from './Path';
-import { Node, PathExpression, PropertyMatcher, IndexMatcher, AnyIndex, AnyProperty, UnionMatcher } from './matchers';
+import { Path, PathComponent } from './Path.js';
+import { Node, PathExpression, PropertyMatcher, IndexMatcher, AnyIndex, AnyProperty, UnionMatcher } from './matchers.js';
 export declare class PathMatcher {
     private readonly expressions;
     readonly allowGaps: boolean;

package/dist/PathMatcher.js

@@ -1,15 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnionMatcher = exports.Node = exports.IndexMatcher = exports.PropertyMatcher = exports.AnyProperty = exports.AnyIndex = exports.PathMatcher = void 0;
-const Path_1 = require("./Path");
-const matchers_1 = require("./matchers");
-Object.defineProperty(exports, "Node", { enumerable: true, get: function () { return matchers_1.Node; } });
-Object.defineProperty(exports, "PropertyMatcher", { enumerable: true, get: function () { return matchers_1.PropertyMatcher; } });
-Object.defineProperty(exports, "IndexMatcher", { enumerable: true, get: function () { return matchers_1.IndexMatcher; } });
-Object.defineProperty(exports, "AnyIndex", { enumerable: true, get: function () { return matchers_1.AnyIndex; } });
-Object.defineProperty(exports, "AnyProperty", { enumerable: true, get: function () { return matchers_1.AnyProperty; } });
-Object.defineProperty(exports, "UnionMatcher", { enumerable: true, get: function () { return matchers_1.UnionMatcher; } });
-class PathMatcher {
+import { Path } from './Path.js';
+import { Node, PropertyMatcher, IndexMatcher, AnyIndex, AnyProperty, UnionMatcher, isPathExpression } from './matchers.js';
+export class PathMatcher {
+    expressions;
+    allowGaps;
     constructor(expressions) {
         this.expressions = expressions;
         let allowGaps = false;
@@ -20,7 +13,7 @@ class PathMatcher {
     }
     find(root, first) {
         if (this.expressions.length === 0) {
-            return [new matchers_1.Node(Path_1.Path.ROOT, root)];
+            return [new Node(Path.ROOT, root)];
         }
         if (typeof root !== 'object') {
             return [];
@@ -42,7 +35,7 @@ class PathMatcher {
         }
         function resultHandler() {
             return (value, component) => {
-                results.push(new matchers_1.Node(Path_1.Path.of(...currentPath, component), value));
+                results.push(new Node(Path.of(...currentPath, component), value));
                 return !first;
             };
         }
@@ -120,16 +113,16 @@ class PathMatcher {
         return new PathMatcher(path.map(component => {
             const type = typeof component;
             if (type === 'number') {
-                return new matchers_1.IndexMatcher(component);
+                return new IndexMatcher(component);
             }
             if (type === 'string') {
-                return new matchers_1.PropertyMatcher(component);
+                return new PropertyMatcher(component);
             }
-            if ((0, matchers_1.isPathExpression)(component)) {
+            if (isPathExpression(component)) {
                 return component;
             }
             throw new Error(`Unrecognized PathComponent: ${component} of type ${type}`);
         }));
     }
 }
-exports.PathMatcher = PathMatcher;
+export { AnyIndex, AnyProperty, PropertyMatcher, IndexMatcher, Node, UnionMatcher };

package/dist/Projection.d.ts

@@ -1,5 +1,5 @@
-import { PathMatcher } from './PathMatcher';
-import { Path } from './Path';
+import { PathMatcher } from './PathMatcher.js';
+import { Path } from './Path.js';
 export declare class Projection {
     private readonly includes;
     private readonly excludes;

package/dist/Projection.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.projection = exports.Projection = void 0;
-const PathMatcher_1 = require("./PathMatcher");
-class Projection {
+import { PathMatcher } from './PathMatcher.js';
+export class Projection {
+    includes;
+    excludes;
+    allowGaps;
     constructor(includes, excludes, allowGaps) {
         this.includes = includes;
         this.excludes = excludes;
@@ -49,14 +49,12 @@ class Projection {
         return new Projection(includes, excludes, allowGaps);
     }
 }
-exports.Projection = Projection;
-function projection(includes, excludes) {
+export function projection(includes, excludes) {
     const projection = Projection.of(includes, excludes);
     return (input) => projection.map(input);
 }
-exports.projection = projection;
 function validatePathMatcher(value) {
-    if (value instanceof PathMatcher_1.PathMatcher) {
+    if (value instanceof PathMatcher) {
         return value;
     }
     else {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { Path, PathComponent } from './Path';
-export * from './PathMatcher';
-export * from './matchers';
-export * from './Projection';
+export { Path, PathComponent } from './Path.js';
+export * from './PathMatcher.js';
+export * from './matchers.js';
+export * from './Projection.js';

package/dist/index.js

@@ -1,22 +1,4 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Path = void 0;
-var Path_1 = require("./Path");
-Object.defineProperty(exports, "Path", { enumerable: true, get: function () { return Path_1.Path; } });
-__exportStar(require("./PathMatcher"), exports);
-__exportStar(require("./matchers"), exports);
-__exportStar(require("./Projection"), exports);
+export { Path } from './Path.js';
+export * from './PathMatcher.js';
+export * from './matchers.js';
+export * from './Projection.js';

package/dist/matchers.d.ts

@@ -1,5 +1,5 @@
-import { Path, PathComponent } from './Path';
-declare type Continue = boolean;
+import { Path, PathComponent } from './Path.js';
+type Continue = boolean;
 export interface MatchHandler {
     (value: any, component: PathComponent): Continue;
 }

package/dist/matchers.js

@@ -1,23 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnyProperty = exports.AnyIndex = exports.UnionMatcher = exports.PropertyMatcher = exports.IndexMatcher = exports.Node = exports.isPathExpression = void 0;
-const Path_1 = require("./Path");
-function isPathExpression(component) {
+import { Path } from './Path.js';
+export function isPathExpression(component) {
     return !!component && typeof component.test === 'function' && typeof component.find === 'function';
 }
-exports.isPathExpression = isPathExpression;
-class Node {
+export class Node {
+    path;
+    value;
     constructor(path, value) {
         this.path = path;
         this.value = value;
     }
 }
-exports.Node = Node;
-class IndexMatcher {
+export class IndexMatcher {
+    index;
+    allowGaps = true;
     constructor(index) {
         this.index = index;
-        this.allowGaps = true;
-        Path_1.Path.validateIndex(index);
+        Path.validateIndex(index);
     }
     find(current, callback) {
         if (Array.isArray(current) && this.index < current.length) {
@@ -29,15 +27,15 @@ class IndexMatcher {
         return component === this.index;
     }
     toString() {
-        return Path_1.Path.indexToString(this.index);
+        return Path.indexToString(this.index);
     }
 }
-exports.IndexMatcher = IndexMatcher;
-class PropertyMatcher {
+export class PropertyMatcher {
+    property;
+    allowGaps = false;
     constructor(property) {
         this.property = property;
-        this.allowGaps = false;
-        Path_1.Path.validateProperty(property);
+        Path.validateProperty(property);
     }
     find(current, callback) {
         if (typeof current === 'object' && current.hasOwnProperty(this.property)) {
@@ -49,17 +47,17 @@ class PropertyMatcher {
         return String(component) === this.property;
     }
     toString() {
-        return Path_1.Path.propertyToString(this.property);
+        return Path.propertyToString(this.property);
     }
 }
-exports.PropertyMatcher = PropertyMatcher;
-class UnionMatcher {
+export class UnionMatcher {
+    components;
     constructor(components) {
         this.components = components;
         if (components.length < 2) {
             throw new Error('Expected at least 2 properties');
         }
-        components.forEach(Path_1.Path.validateComponent);
+        components.forEach(Path.validateComponent);
     }
     find(current, callback) {
         if (typeof current === 'object') {
@@ -90,8 +88,7 @@ class UnionMatcher {
         return JSON.stringify(property);
     }
 }
-exports.UnionMatcher = UnionMatcher;
-exports.AnyIndex = {
+export const AnyIndex = {
     allowGaps: false,
     find: (current, callback) => {
         if (Array.isArray(current)) {
@@ -110,7 +107,7 @@ exports.AnyIndex = {
         return '[*]';
     },
 };
-exports.AnyProperty = {
+export const AnyProperty = {
     allowGaps: false,
     find: (current, callback) => {
         if (typeof current === 'object') {

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@finnair/path",
-  "version": "3.1.0",
+  "version": "5.0.0",
   "private": false,
   "description": "Simple object path as array of strings and numbers",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "license": "MIT",
   "homepage": "https://github.com/finnair/v-validation/tree/master/packages/path#readme",
   "bugs": "https://github.com/finnair/v-validation/issues",
@@ -22,5 +29,5 @@
   "scripts": {
     "build": "tsc -b ."
   },
-  "gitHead": "5182a63fa61cc1f5c8991e1482c5bbffe14798c3"
+  "gitHead": "b20762715a79e2a336f9c8ceb5107a4d84104a14"
 }