pathtrace 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-today Peter Placzek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,325 @@
+# pathtrace 🔍
+
+[![main](https://github.com/tada5hi/pathtrace/actions/workflows/main.yml/badge.svg)](https://github.com/tada5hi/pathtrace/actions/workflows/main.yml)
+[![CodeQL](https://github.com/tada5hi/pathtrace/actions/workflows/codeql.yml/badge.svg)](https://github.com/tada5hi/pathtrace/actions/workflows/codeql.yml)
+[![Known Vulnerabilities](https://snyk.io/test/github/tada5hi/pathtrace/badge.svg)](https://snyk.io/test/github/tada5hi/pathtrace)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+
+**Pathtrace** is a library for managing nested objects and arrays. 
+It offers straightforward methods for 
+retrieving ([getPathValue](#getPathValue)) and
+setting ([setPathValue](#setPathValue)) values at any path.
+Additionally, [getPathInfo](#getPathInfo) provides detailed path information, 
+making it ideal for handling complex data structures efficiently.
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [Usage](#usage)
+    - [getPathValue](#getpathvalue)
+    - [setPathValue](#setpathvalue)
+    - [getPathInfo](#getpathinfo)
+- [License](#license)
+
+## Installation
+
+```bash
+npm install pathtrace --save
+```
+
+## Usage
+The following examples demonstrate how to use the library.
+
+### getPathValue
+
+This method retrieves the value of a property at a given `path` 
+inside an `object`.
+
+```ts
+const obj = {
+    user: {
+        name: 'Alice',
+        roles: ['admin', 'editor'],
+        contact: {
+            email: 'alice@example.com',
+            phone: '123-456-7890',
+        },
+    },
+    settings: [
+        { theme: 'dark' },
+        { notifications: true },
+        [{ privacy: 'high' }]
+    ]
+};
+```
+
+**Example 1: Retrieving a simple property value**
+```ts
+import { getPathValue } from 'pathtrace';
+
+var value = getPathValue(obj, 'user.name');
+console.log(value); // 'Alice'
+```
+
+**Example 2: Retrieving a nested property value**
+```ts
+import { getPathValue } from 'pathtrace';
+
+var value = getPathValue(obj, 'user.contact.email');
+console.log(value); // 'alice@example.com'
+```
+
+**Example 3: Retrieving an array element by index**
+```ts
+import { getPathValue } from 'pathtrace';
+
+var value = getPathValue(obj, 'user.roles[1]');
+console.log(value); // 'editor'
+```
+
+**Example 4: Retrieving a nested property within an array**
+```ts
+import { getPathValue } from 'pathtrace';
+
+var value = getPathValue(obj, 'settings[1].notifications');
+console.log(value); // true
+```
+
+**Example 5: Retrieving a value from a multi-dimensional array**
+```ts
+import { getPathValue } from 'pathtrace';
+
+var value = getPathValue(obj, 'settings[2][0].privacy');
+console.log(value); // 'high'
+```
+
+**Example 6: Handling undefined objects and properties**
+```ts
+import { getPathValue } from 'pathtrace';
+
+var value = getPathValue(undefined, 'user.name');
+console.log(value); // undefined
+
+var value = getPathValue(obj, 'user.address');
+console.log(value); // undefined
+
+var value = getPathValue('hello', 'length');
+console.log(value); // 5
+```
+
+### setPathValue
+
+This method sets the `value` of a property at a given `path` 
+inside an `object` and returns the object in which the property has been set.
+
+```ts
+var obj = {
+    user: {
+        name: 'Alice',
+        roles: ['admin', 'editor'],
+        contact: {
+            email: 'alice@example.com',
+            phone: '123-456-7890',
+        },
+    },
+    settings: [
+        { theme: 'dark' },
+        { notifications: true },
+        [{ privacy: 'high' }]
+    ]
+};
+```
+
+**Example 1: Setting a simple property value**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'user.name', 'Bob');
+console.log(obj.user.name); // 'Bob'
+```
+
+**Example 2: Setting a nested property value**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'user.contact.email', 'bob@example.com');
+console.log(obj.user.contact.email); // 'bob@example.com'
+```
+
+**Example 3: Setting a nested array value**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'user.roles[1]', 'viewer');
+console.log(obj.user.roles[1]); // 'viewer'
+```
+
+**Example 4: Setting a value in an array**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'settings[2][0].privacy', 'low');
+console.log(obj.settings[2][0].privacy); // 'low'
+```
+
+**Example 5: Adding a new property to an object**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'user.contact.address', '123 Main St');
+console.log(obj.user.contact.address); // '123 Main St'
+```
+
+**Example 6: Setting a value in an object within an array**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'settings[1].notifications', false);
+console.log(obj.settings[1].notifications); // false
+```
+
+**Example 7: Creating a new array and setting values**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'user.history[0]', 'logged in');
+setPathValue(obj, 'user.history[2]', 'logged out');
+console.log(obj.user.history[0]); // 'logged in'
+console.log(obj.user.history[1]); // undefined
+console.log(obj.user.history[2]); // 'logged out'
+```
+
+**Example 8: Setting a value in a multi-dimensional array**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'settings[2][1]', { secure: true });
+console.log(obj.settings[2][1].secure); // true
+```
+
+**Example 9: Setting a value in an object inside an array**
+```ts
+import { setPathValue } from 'pathtrace';
+
+setPathValue(obj, 'settings[2][0].description', 'private settings');
+console.log(obj.settings[2][0].description); // 'private settings'
+```
+
+**Example 10: Returning the modified object**
+```ts
+import { setPathValue } from 'pathtrace';
+
+var modifiedObj = setPathValue(obj, 'user.contact.phone', '987-654-3210');
+console.log(modifiedObj === obj); // true
+```
+
+
+### getPathInfo
+
+This method returns an object with information indicating the value
+of the `parent` of that path, the `name` of the property being retrieved,
+and its `value`.
+
+```ts
+const obj = {
+    user: {
+        name: 'Alice',
+        roles: ['admin', 'editor'],
+        contact: {
+            email: 'alice@example.com',
+            phone: '123-456-7890',
+        },
+    },
+    'user.roles': {
+        '[1]': 'editor',
+    },
+};
+```
+
+**Example 1: Handling a nested property**
+
+```ts
+import { getPathInfo } from 'pathtrace';
+
+const info = getPathInfo(obj, 'user.contact.email');
+
+if (info.parent) {
+    console.log(info.parent.name); // 'contact'
+    console.log(info.parent.value); 
+    // { email: 'alice@example.com', phone: '123-456-7890' }
+    console.log(info.parent.exists); // true
+}
+console.log(info.value); // 'alice@example.com'
+console.log(info.exists); // true
+console.log(info.name); // 'email'
+
+```
+**Example 2: Handling an array index**
+
+```ts
+import { getPathInfo } from 'pathtrace';
+
+const info = getPathInfo(obj, 'user.roles[1]');
+
+if (info.parent) {
+    console.log(info.parent.name); // 'roles'
+    console.log(info.parent.value); // ['admin', 'editor']
+    console.log(info.parent.exists); // true
+}
+console.log(info.value); // 'editor'
+console.log(info.name); // '1'
+console.log(info.exists); // true
+```
+
+**Example 3: Handling a non-existent property**
+```ts
+import { getPathInfo } from 'pathtrace';
+
+const info = getPathInfo(obj, 'user.contact.address');
+
+if (info.parent) {
+    console.log(info.parent.name); // 'contact'
+    console.log(info.parent.value); 
+    // { email: 'alice@example.com', phone: '123-456-7890' }
+    console.log(info.parent.exists); // true
+}
+console.log(info.value); // undefined
+console.log(info.name); // 'address'
+console.log(info.exists); // false
+```
+
+**Example 4: Handling an out-of-bounds array index**
+```ts
+import { getPathInfo } from 'pathtrace';
+
+const info = getPathInfo(obj, 'user.roles[5]');
+
+if (info.parent) {
+    console.log(info.parent.name); // 'roles'
+    console.log(info.parent.value); // ['admin', 'editor']
+    console.log(info.parent.exists); // true
+}
+console.log(info.value); // undefined
+console.log(info.name); // '5'
+console.log(info.exists); // false
+```
+
+**Example 5: Handling backslash-escaping for . and []**
+```ts
+import { getPathInfo } from 'pathtrace';
+
+const info = getPathInfo(obj, 'user\\.roles.\\[1\\]');
+
+if (info.parent) {
+    console.log(info.parent.name); // '[1]'
+    console.log(info.parent.value); // 'editor'
+    console.log(info.exists); // true
+}
+console.log(info.value); // 'editor'
+console.log(info.name); // '1'
+console.log(info.exists); // true
+```
+
+## License
+
+Made with 💚

package/dist/get-path-info.d.ts

@@ -0,0 +1,2 @@
+import { PathInfo } from './path-info';
+export declare function getPathInfo(data: Record<string, any>, path?: string): PathInfo;

package/dist/get-path-value.d.ts

@@ -0,0 +1 @@
+export declare function getPathValue(data: unknown, path: string | string[]): unknown;

package/dist/helpers/array-to-path.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @see https://github.com/express-validator/express-validator/blob/bec1dcbaa29002dcd21093ec84818c4671063b5d/src/field-selection.ts#L214
+ * @param parts
+ */
+export declare function arrayToPath(parts: readonly string[]): string;

package/dist/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './array-to-path';
+export * from './path-to-array';

package/dist/helpers/path-to-array.d.ts

@@ -0,0 +1,10 @@
+export declare const BRACKET_NUMBER_REGEX: RegExp;
+/**
+ * Convert string to property path array.
+ *
+ * @see https://github.com/lodash/lodash/blob/main/src/.internal/stringToPath.ts
+ * @see https://github.com/chaijs/pathval
+ *
+ * @param segment
+ */
+export declare function pathToArray(segment: string): string[];

package/dist/index.cjs

@@ -0,0 +1,193 @@
+'use strict';
+
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ /**
+ * @see https://github.com/express-validator/express-validator/blob/bec1dcbaa29002dcd21093ec84818c4671063b5d/src/field-selection.ts#L214
+ * @param parts
+ */ function arrayToPath(parts) {
+    return parts.reduce((prev, segment)=>{
+        let part = '';
+        segment = segment === '\\*' ? '*' : segment;
+        segment = segment.replace(/^\[(\d+)]$/g, '\\[$1]');
+        segment = segment.replace(/\./g, '\\.');
+        if (/^\d+$/.test(segment)) {
+            // Index access
+            part = `[${segment}]`;
+        } else if (prev) {
+            // Object key access
+            part = `.${segment}`;
+        } else {
+            // Top level key
+            part = segment;
+        }
+        return prev + part;
+    }, '');
+}
+
+/*
+ * Copyright (c) 2024-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ const BRACKET_NUMBER_REGEX = RegExp("(?<!\\\\)\\[(\\d+)]$");
+/**
+ * Convert string to property path array.
+ *
+ * @see https://github.com/lodash/lodash/blob/main/src/.internal/stringToPath.ts
+ * @see https://github.com/chaijs/pathval
+ *
+ * @param segment
+ */ function pathToArray(segment) {
+    const str = segment.replace(/([^\\])\[/g, '$1.[');
+    const parts = str.match(/(\\\.|[^.]+?)+/g);
+    if (!parts) {
+        return [];
+    }
+    const result = [];
+    for(let i = 0; i < parts.length; i++){
+        if (parts[i] === 'constructor' || parts[i] === '__proto__' || parts[i] === 'prototype') {
+            continue;
+        }
+        const regex = BRACKET_NUMBER_REGEX.exec(parts[i]);
+        if (regex) {
+            result.push(regex[1]);
+        } else {
+            result.push(parts[i].replace(/\\([.[\]])/g, '$1'));
+        }
+    }
+    return result;
+}
+
+function getPathValue(data, path) {
+    const parts = Array.isArray(path) ? path : pathToArray(path);
+    let res;
+    let temp = data;
+    let index = 0;
+    while(index < parts.length){
+        if (temp === null || typeof temp === 'undefined') {
+            break;
+        }
+        if (parts[index] in Object(temp)) {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-expect-error
+            temp = temp[parts[index]];
+        } else {
+            break;
+        }
+        if (index === parts.length - 1) {
+            res = temp;
+        }
+        index++;
+    }
+    return res;
+}
+
+class PathInfo {
+    get value() {
+        if (typeof this._value !== 'undefined') {
+            return this._value;
+        }
+        if (this.pathParts.length > 0) {
+            this._value = getPathValue(this.data, this.pathParts);
+        } else {
+            this._value = this.data;
+        }
+        return this._value;
+    }
+    get name() {
+        if (this.pathParts.length > 0) {
+            return this.pathParts[this.pathParts.length - 1];
+        }
+        return null;
+    }
+    get parent() {
+        if (typeof this._parent !== 'undefined') {
+            return this._parent;
+        }
+        if (this.pathParts.length === 0) {
+            this._parent = null;
+            return this._parent;
+        }
+        if (this.pathParts.length > 1) {
+            const parentPathParts = this.pathParts.slice(0, this.pathParts.length - 1);
+            this._parent = new PathInfo(this.data, arrayToPath(parentPathParts));
+        } else {
+            this._parent = new PathInfo(this.data);
+        }
+        return this._parent;
+    }
+    get exists() {
+        if (typeof this._exists !== 'undefined') {
+            return this._exists;
+        }
+        if (!this.name || !this.parent) {
+            this._exists = true;
+            return this._exists;
+        }
+        if (this.parent.value !== null && typeof this.parent.value !== 'undefined') {
+            this._exists = this.name in Object(this.parent.value);
+        } else {
+            this._exists = false;
+        }
+        return this._exists;
+    }
+    constructor(data, path){
+        this.data = data;
+        this.path = path;
+        this.pathParts = this.path ? pathToArray(this.path) : [];
+    }
+}
+
+function getPathInfo(data, path) {
+    return new PathInfo(data, path);
+}
+
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ function isObject(input) {
+    return !!input && typeof input === 'object' && !Array.isArray(input);
+}
+
+const NUMBER_REGEX = /^\d+$/;
+function setPathValue(data, path, value) {
+    const parts = Array.isArray(path) ? path : pathToArray(path);
+    let temp = data;
+    let index = 0;
+    while(index < parts.length){
+        /* istanbul ignore next */ if (!Array.isArray(temp) && !isObject(temp)) {
+            break;
+        }
+        const key = parts[index];
+        // [foo, '0']
+        if (typeof temp[key] === 'undefined') {
+            const match = NUMBER_REGEX.test(key);
+            if (match) {
+                temp[key] = [];
+            } else {
+                temp[key] = {};
+            }
+        }
+        if (index === parts.length - 1) {
+            temp[key] = value;
+            break;
+        }
+        index++;
+        temp = temp[key];
+    }
+    return data;
+}
+
+exports.BRACKET_NUMBER_REGEX = BRACKET_NUMBER_REGEX;
+exports.arrayToPath = arrayToPath;
+exports.getPathInfo = getPathInfo;
+exports.getPathValue = getPathValue;
+exports.pathToArray = pathToArray;
+exports.setPathValue = setPathValue;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/helpers/array-to-path.ts","../src/helpers/path-to-array.ts","../src/get-path-value.ts","../src/path-info.ts","../src/get-path-info.ts","../src/utils/is-object.ts","../src/set-path-value.ts"],"sourcesContent":["/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\n/**\n * @see https://github.com/express-validator/express-validator/blob/bec1dcbaa29002dcd21093ec84818c4671063b5d/src/field-selection.ts#L214\n * @param parts\n */\nexport function arrayToPath(parts: readonly string[]) : string {\n    return parts.reduce((prev, segment) => {\n        let part = '';\n        segment = segment === '\\\\*' ? '*' : segment;\n\n        segment = segment.replace(/^\\[(\\d+)]$/g, '\\\\[$1]');\n        segment = segment.replace(/\\./g, '\\\\.');\n\n        if (/^\\d+$/.test(segment)) {\n            // Index access\n            part = `[${segment}]`;\n        } else if (prev) {\n            // Object key access\n            part = `.${segment}`;\n        } else {\n            // Top level key\n            part = segment;\n        }\n\n        return prev + part;\n    }, '');\n}\n","/*\n * Copyright (c) 2024-2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport const BRACKET_NUMBER_REGEX = /(?<!\\\\)\\[(\\d+)]$/;\n\n/**\n * Convert string to property path array.\n *\n * @see https://github.com/lodash/lodash/blob/main/src/.internal/stringToPath.ts\n * @see https://github.com/chaijs/pathval\n *\n * @param segment\n */\nexport function pathToArray(segment: string) : string[] {\n    const str = segment.replace(/([^\\\\])\\[/g, '$1.[');\n    const parts = str.match(/(\\\\\\.|[^.]+?)+/g);\n    if (!parts) {\n        return [];\n    }\n\n    const result : string[] = [];\n\n    for (let i = 0; i < parts.length; i++) {\n        if (\n            parts[i] === 'constructor' ||\n            parts[i] === '__proto__' ||\n            parts[i] === 'prototype'\n        ) {\n            continue;\n        }\n\n        const regex = BRACKET_NUMBER_REGEX.exec(parts[i]);\n        if (regex) {\n            result.push(regex[1]);\n        } else {\n            result.push(parts[i].replace(/\\\\([.[\\]])/g, '$1'));\n        }\n    }\n\n    return result;\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { pathToArray } from './helpers';\n\nexport function getPathValue(\n    data: unknown,\n    path: string | string[],\n): unknown {\n    const parts = Array.isArray(path) ? path : pathToArray(path);\n\n    let res : unknown | undefined;\n    let temp = data;\n    let index = 0;\n    while (index < parts.length) {\n        if (temp === null || typeof temp === 'undefined') {\n            break;\n        }\n\n        if (parts[index] in Object(temp)) {\n            // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n            // @ts-expect-error\n            temp = temp[parts[index]];\n        } else {\n            break;\n        }\n\n        if (index === parts.length - 1) {\n            res = temp;\n        }\n\n        index++;\n    }\n\n    return res;\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { getPathValue } from './get-path-value';\nimport { arrayToPath, pathToArray } from './helpers';\n\nexport class PathInfo {\n    protected data: unknown;\n\n    protected path : string | undefined;\n\n    protected pathParts: string[];\n\n    protected _value: unknown;\n\n    protected _parent: PathInfo | null | undefined;\n\n    protected _exists: boolean | undefined;\n\n    constructor(data: unknown, path?: string) {\n        this.data = data;\n        this.path = path;\n        this.pathParts = this.path ?\n            pathToArray(this.path) :\n            [];\n    }\n\n    get value() {\n        if (typeof this._value !== 'undefined') {\n            return this._value;\n        }\n\n        if (this.pathParts.length > 0) {\n            this._value = getPathValue(this.data, this.pathParts);\n        } else {\n            this._value = this.data;\n        }\n\n        return this._value;\n    }\n\n    get name() : string | null {\n        if (this.pathParts.length > 0) {\n            return this.pathParts[this.pathParts.length - 1];\n        }\n\n        return null;\n    }\n\n    get parent() : PathInfo | null {\n        if (typeof this._parent !== 'undefined') {\n            return this._parent;\n        }\n\n        if (this.pathParts.length === 0) {\n            this._parent = null;\n            return this._parent;\n        }\n\n        if (this.pathParts.length > 1) {\n            const parentPathParts = this.pathParts.slice(0, this.pathParts.length - 1);\n            this._parent = new PathInfo(\n                this.data,\n                arrayToPath(parentPathParts),\n            );\n        } else {\n            this._parent = new PathInfo(this.data);\n        }\n\n        return this._parent;\n    }\n\n    get exists() : boolean {\n        if (typeof this._exists !== 'undefined') {\n            return this._exists;\n        }\n\n        if (!this.name || !this.parent) {\n            this._exists = true;\n            return this._exists;\n        }\n\n        if (\n            this.parent.value !== null &&\n            typeof this.parent.value !== 'undefined'\n        ) {\n            this._exists = this.name in Object(this.parent.value);\n        } else {\n            this._exists = false;\n        }\n\n        return this._exists;\n    }\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { PathInfo } from './path-info';\n\nexport function getPathInfo(\n    data: Record<string, any>,\n    path?: string,\n) : PathInfo {\n    return new PathInfo(data, path);\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport function isObject(input: unknown) : input is Record<string, any> {\n    return !!input &&\n        typeof input === 'object' &&\n        !Array.isArray(input);\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { pathToArray } from './helpers';\nimport { isObject } from './utils';\n\nconst NUMBER_REGEX = /^\\d+$/;\n\nexport function setPathValue(\n    data: Record<string, any> | Record<string, any>[],\n    path: string | string[],\n    value: unknown,\n) {\n    const parts = Array.isArray(path) ? path : pathToArray(path);\n\n    let temp = data;\n    let index = 0;\n    while (index < parts.length) {\n        /* istanbul ignore next */\n        if (!Array.isArray(temp) && !isObject(temp)) {\n            break;\n        }\n\n        const key = parts[index] as keyof typeof temp;\n\n        // [foo, '0']\n        if (typeof temp[key] === 'undefined') {\n            const match = NUMBER_REGEX.test(key);\n            if (match) {\n                (temp as Record<string, any>)[key] = [];\n            } else {\n                temp[key] = {};\n            }\n        }\n\n        if (index === parts.length - 1) {\n            temp[key] = value;\n            break;\n        }\n\n        index++;\n        temp = temp[key];\n    }\n\n    return data;\n}\n"],"names":["arrayToPath","parts","reduce","prev","segment","part","replace","test","BRACKET_NUMBER_REGEX","pathToArray","str","match","result","i","length","regex","exec","push","getPathValue","data","path","Array","isArray","res","temp","index","Object","PathInfo","value","_value","pathParts","name","parent","_parent","parentPathParts","slice","exists","_exists","constructor","getPathInfo","isObject","input","NUMBER_REGEX","setPathValue","key"],"mappings":";;AAAA;;;;;;;;IAWO,SAASA,WAAAA,CAAYC,KAAwB,EAAA;AAChD,IAAA,OAAOA,KAAMC,CAAAA,MAAM,CAAC,CAACC,IAAMC,EAAAA,OAAAA,GAAAA;AACvB,QAAA,IAAIC,IAAO,GAAA,EAAA,CAAA;QACXD,OAAUA,GAAAA,OAAAA,KAAY,QAAQ,GAAMA,GAAAA,OAAAA,CAAAA;QAEpCA,OAAUA,GAAAA,OAAAA,CAAQE,OAAO,CAAC,aAAe,EAAA,QAAA,CAAA,CAAA;QACzCF,OAAUA,GAAAA,OAAAA,CAAQE,OAAO,CAAC,KAAO,EAAA,KAAA,CAAA,CAAA;QAEjC,IAAI,OAAA,CAAQC,IAAI,CAACH,OAAU,CAAA,EAAA;;AAEvBC,YAAAA,IAAAA,GAAO,CAAC,CAAC,EAAED,OAAAA,CAAQ,CAAC,CAAC,CAAA;AACzB,SAAA,MAAO,IAAID,IAAM,EAAA;;AAEbE,YAAAA,IAAAA,GAAO,CAAC,CAAC,EAAED,OAAAA,CAAQ,CAAC,CAAA;SACjB,MAAA;;YAEHC,IAAOD,GAAAA,OAAAA,CAAAA;AACX,SAAA;AAEA,QAAA,OAAOD,IAAOE,GAAAA,IAAAA,CAAAA;KACf,EAAA,EAAA,CAAA,CAAA;AACP;;AChCA;;;;;IAOaG,MAAAA,oBAAAA,GAAuB,MAAmB,CAAA,sBAAA,EAAA;AAEvD;;;;;;;IAQO,SAASC,WAAAA,CAAYL,OAAe,EAAA;AACvC,IAAA,MAAMM,GAAMN,GAAAA,OAAAA,CAAQE,OAAO,CAAC,YAAc,EAAA,MAAA,CAAA,CAAA;IAC1C,MAAML,KAAAA,GAAQS,GAAIC,CAAAA,KAAK,CAAC,iBAAA,CAAA,CAAA;AACxB,IAAA,IAAI,CAACV,KAAO,EAAA;AACR,QAAA,OAAO,EAAE,CAAA;AACb,KAAA;AAEA,IAAA,MAAMW,SAAoB,EAAE,CAAA;AAE5B,IAAA,IAAK,IAAIC,CAAI,GAAA,CAAA,EAAGA,IAAIZ,KAAMa,CAAAA,MAAM,EAAED,CAAK,EAAA,CAAA;AACnC,QAAA,IACIZ,KAAK,CAACY,CAAE,CAAA,KAAK,iBACbZ,KAAK,CAACY,CAAE,CAAA,KAAK,WACbZ,IAAAA,KAAK,CAACY,CAAAA,CAAE,KAAK,WACf,EAAA;AACE,YAAA,SAAA;AACJ,SAAA;AAEA,QAAA,MAAME,QAAQP,oBAAqBQ,CAAAA,IAAI,CAACf,KAAK,CAACY,CAAE,CAAA,CAAA,CAAA;AAChD,QAAA,IAAIE,KAAO,EAAA;AACPH,YAAAA,MAAAA,CAAOK,IAAI,CAACF,KAAK,CAAC,CAAE,CAAA,CAAA,CAAA;SACjB,MAAA;YACHH,MAAOK,CAAAA,IAAI,CAAChB,KAAK,CAACY,EAAE,CAACP,OAAO,CAAC,aAAe,EAAA,IAAA,CAAA,CAAA,CAAA;AAChD,SAAA;AACJ,KAAA;IAEA,OAAOM,MAAAA,CAAAA;AACX;;ACnCO,SAASM,YAAAA,CACZC,IAAa,EACbC,IAAuB,EAAA;AAEvB,IAAA,MAAMnB,QAAQoB,KAAMC,CAAAA,OAAO,CAACF,IAAAA,CAAAA,GAAQA,OAAOX,WAAYW,CAAAA,IAAAA,CAAAA,CAAAA;IAEvD,IAAIG,GAAAA,CAAAA;AACJ,IAAA,IAAIC,IAAOL,GAAAA,IAAAA,CAAAA;AACX,IAAA,IAAIM,KAAQ,GAAA,CAAA,CAAA;IACZ,MAAOA,KAAAA,GAAQxB,KAAMa,CAAAA,MAAM,CAAE;AACzB,QAAA,IAAIU,IAAS,KAAA,IAAA,IAAQ,OAAOA,IAAAA,KAAS,WAAa,EAAA;AAC9C,YAAA,MAAA;AACJ,SAAA;AAEA,QAAA,IAAIvB,KAAK,CAACwB,KAAM,CAAA,IAAIC,OAAOF,IAAO,CAAA,EAAA;;;AAG9BA,YAAAA,IAAAA,GAAOA,IAAI,CAACvB,KAAK,CAACwB,MAAM,CAAC,CAAA;SACtB,MAAA;AACH,YAAA,MAAA;AACJ,SAAA;AAEA,QAAA,IAAIA,KAAUxB,KAAAA,KAAAA,CAAMa,MAAM,GAAG,CAAG,EAAA;YAC5BS,GAAMC,GAAAA,IAAAA,CAAAA;AACV,SAAA;AAEAC,QAAAA,KAAAA,EAAAA,CAAAA;AACJ,KAAA;IAEA,OAAOF,GAAAA,CAAAA;AACX;;AC7BO,MAAMI,QAAAA,CAAAA;AAqBT,IAAA,IAAIC,KAAQ,GAAA;AACR,QAAA,IAAI,OAAO,IAAI,CAACC,MAAM,KAAK,WAAa,EAAA;YACpC,OAAO,IAAI,CAACA,MAAM,CAAA;AACtB,SAAA;AAEA,QAAA,IAAI,IAAI,CAACC,SAAS,CAAChB,MAAM,GAAG,CAAG,EAAA;YAC3B,IAAI,CAACe,MAAM,GAAGX,YAAa,CAAA,IAAI,CAACC,IAAI,EAAE,IAAI,CAACW,SAAS,CAAA,CAAA;SACjD,MAAA;AACH,YAAA,IAAI,CAACD,MAAM,GAAG,IAAI,CAACV,IAAI,CAAA;AAC3B,SAAA;QAEA,OAAO,IAAI,CAACU,MAAM,CAAA;AACtB,KAAA;AAEA,IAAA,IAAIE,IAAuB,GAAA;AACvB,QAAA,IAAI,IAAI,CAACD,SAAS,CAAChB,MAAM,GAAG,CAAG,EAAA;YAC3B,OAAO,IAAI,CAACgB,SAAS,CAAC,IAAI,CAACA,SAAS,CAAChB,MAAM,GAAG,CAAE,CAAA,CAAA;AACpD,SAAA;QAEA,OAAO,IAAA,CAAA;AACX,KAAA;AAEA,IAAA,IAAIkB,MAA2B,GAAA;AAC3B,QAAA,IAAI,OAAO,IAAI,CAACC,OAAO,KAAK,WAAa,EAAA;YACrC,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;AAEA,QAAA,IAAI,IAAI,CAACH,SAAS,CAAChB,MAAM,KAAK,CAAG,EAAA;YAC7B,IAAI,CAACmB,OAAO,GAAG,IAAA,CAAA;YACf,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;AAEA,QAAA,IAAI,IAAI,CAACH,SAAS,CAAChB,MAAM,GAAG,CAAG,EAAA;AAC3B,YAAA,MAAMoB,eAAkB,GAAA,IAAI,CAACJ,SAAS,CAACK,KAAK,CAAC,CAAA,EAAG,IAAI,CAACL,SAAS,CAAChB,MAAM,GAAG,CAAA,CAAA,CAAA;YACxE,IAAI,CAACmB,OAAO,GAAG,IAAIN,SACf,IAAI,CAACR,IAAI,EACTnB,WAAYkC,CAAAA,eAAAA,CAAAA,CAAAA,CAAAA;SAEb,MAAA;AACH,YAAA,IAAI,CAACD,OAAO,GAAG,IAAIN,QAAS,CAAA,IAAI,CAACR,IAAI,CAAA,CAAA;AACzC,SAAA;QAEA,OAAO,IAAI,CAACc,OAAO,CAAA;AACvB,KAAA;AAEA,IAAA,IAAIG,MAAmB,GAAA;AACnB,QAAA,IAAI,OAAO,IAAI,CAACC,OAAO,KAAK,WAAa,EAAA;YACrC,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;QAEA,IAAI,CAAC,IAAI,CAACN,IAAI,IAAI,CAAC,IAAI,CAACC,MAAM,EAAE;YAC5B,IAAI,CAACK,OAAO,GAAG,IAAA,CAAA;YACf,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;AAEA,QAAA,IACI,IAAI,CAACL,MAAM,CAACJ,KAAK,KAAK,IAAA,IACtB,OAAO,IAAI,CAACI,MAAM,CAACJ,KAAK,KAAK,WAC/B,EAAA;AACE,YAAA,IAAI,CAACS,OAAO,GAAG,IAAI,CAACN,IAAI,IAAIL,MAAAA,CAAO,IAAI,CAACM,MAAM,CAACJ,KAAK,CAAA,CAAA;SACjD,MAAA;YACH,IAAI,CAACS,OAAO,GAAG,KAAA,CAAA;AACnB,SAAA;QAEA,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,KAAA;IAzEAC,WAAYnB,CAAAA,IAAa,EAAEC,IAAa,CAAE;QACtC,IAAI,CAACD,IAAI,GAAGA,IAAAA,CAAAA;QACZ,IAAI,CAACC,IAAI,GAAGA,IAAAA,CAAAA;AACZ,QAAA,IAAI,CAACU,SAAS,GAAG,IAAI,CAACV,IAAI,GACtBX,WAAAA,CAAY,IAAI,CAACW,IAAI,CAAA,GACrB,EAAE,CAAA;AACV,KAAA;AAoEJ;;ACxFO,SAASmB,WAAAA,CACZpB,IAAyB,EACzBC,IAAa,EAAA;IAEb,OAAO,IAAIO,SAASR,IAAMC,EAAAA,IAAAA,CAAAA,CAAAA;AAC9B;;ACdA;;;;;IAOO,SAASoB,QAAAA,CAASC,KAAc,EAAA;IACnC,OAAO,CAAC,CAACA,KACL,IAAA,OAAOA,UAAU,QACjB,IAAA,CAACpB,KAAMC,CAAAA,OAAO,CAACmB,KAAAA,CAAAA,CAAAA;AACvB;;ACDA,MAAMC,YAAe,GAAA,OAAA,CAAA;AAEd,SAASC,YACZxB,CAAAA,IAAiD,EACjDC,IAAuB,EACvBQ,KAAc,EAAA;AAEd,IAAA,MAAM3B,QAAQoB,KAAMC,CAAAA,OAAO,CAACF,IAAAA,CAAAA,GAAQA,OAAOX,WAAYW,CAAAA,IAAAA,CAAAA,CAAAA;AAEvD,IAAA,IAAII,IAAOL,GAAAA,IAAAA,CAAAA;AACX,IAAA,IAAIM,KAAQ,GAAA,CAAA,CAAA;IACZ,MAAOA,KAAAA,GAAQxB,KAAMa,CAAAA,MAAM,CAAE;mCAEzB,IAAI,CAACO,KAAAA,CAAMC,OAAO,CAACE,IAAAA,CAAAA,IAAS,CAACgB,QAAAA,CAAShB,IAAO,CAAA,EAAA;AACzC,YAAA,MAAA;AACJ,SAAA;QAEA,MAAMoB,GAAAA,GAAM3C,KAAK,CAACwB,KAAM,CAAA,CAAA;;AAGxB,QAAA,IAAI,OAAOD,IAAI,CAACoB,GAAAA,CAAI,KAAK,WAAa,EAAA;YAClC,MAAMjC,KAAAA,GAAQ+B,YAAanC,CAAAA,IAAI,CAACqC,GAAAA,CAAAA,CAAAA;AAChC,YAAA,IAAIjC,KAAO,EAAA;gBACNa,IAA4B,CAACoB,GAAI,CAAA,GAAG,EAAE,CAAA;aACpC,MAAA;gBACHpB,IAAI,CAACoB,GAAI,CAAA,GAAG,EAAC,CAAA;AACjB,aAAA;AACJ,SAAA;AAEA,QAAA,IAAInB,KAAUxB,KAAAA,KAAAA,CAAMa,MAAM,GAAG,CAAG,EAAA;YAC5BU,IAAI,CAACoB,IAAI,GAAGhB,KAAAA,CAAAA;AACZ,YAAA,MAAA;AACJ,SAAA;AAEAH,QAAAA,KAAAA,EAAAA,CAAAA;QACAD,IAAOA,GAAAA,IAAI,CAACoB,GAAI,CAAA,CAAA;AACpB,KAAA;IAEA,OAAOzB,IAAAA,CAAAA;AACX;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './helpers';
+export * from './get-path-value';
+export * from './get-path-info';
+export * from './set-path-value';

package/dist/index.mjs

@@ -0,0 +1,186 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ /**
+ * @see https://github.com/express-validator/express-validator/blob/bec1dcbaa29002dcd21093ec84818c4671063b5d/src/field-selection.ts#L214
+ * @param parts
+ */ function arrayToPath(parts) {
+    return parts.reduce((prev, segment)=>{
+        let part = '';
+        segment = segment === '\\*' ? '*' : segment;
+        segment = segment.replace(/^\[(\d+)]$/g, '\\[$1]');
+        segment = segment.replace(/\./g, '\\.');
+        if (/^\d+$/.test(segment)) {
+            // Index access
+            part = `[${segment}]`;
+        } else if (prev) {
+            // Object key access
+            part = `.${segment}`;
+        } else {
+            // Top level key
+            part = segment;
+        }
+        return prev + part;
+    }, '');
+}
+
+/*
+ * Copyright (c) 2024-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ const BRACKET_NUMBER_REGEX = RegExp("(?<!\\\\)\\[(\\d+)]$");
+/**
+ * Convert string to property path array.
+ *
+ * @see https://github.com/lodash/lodash/blob/main/src/.internal/stringToPath.ts
+ * @see https://github.com/chaijs/pathval
+ *
+ * @param segment
+ */ function pathToArray(segment) {
+    const str = segment.replace(/([^\\])\[/g, '$1.[');
+    const parts = str.match(/(\\\.|[^.]+?)+/g);
+    if (!parts) {
+        return [];
+    }
+    const result = [];
+    for(let i = 0; i < parts.length; i++){
+        if (parts[i] === 'constructor' || parts[i] === '__proto__' || parts[i] === 'prototype') {
+            continue;
+        }
+        const regex = BRACKET_NUMBER_REGEX.exec(parts[i]);
+        if (regex) {
+            result.push(regex[1]);
+        } else {
+            result.push(parts[i].replace(/\\([.[\]])/g, '$1'));
+        }
+    }
+    return result;
+}
+
+function getPathValue(data, path) {
+    const parts = Array.isArray(path) ? path : pathToArray(path);
+    let res;
+    let temp = data;
+    let index = 0;
+    while(index < parts.length){
+        if (temp === null || typeof temp === 'undefined') {
+            break;
+        }
+        if (parts[index] in Object(temp)) {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-expect-error
+            temp = temp[parts[index]];
+        } else {
+            break;
+        }
+        if (index === parts.length - 1) {
+            res = temp;
+        }
+        index++;
+    }
+    return res;
+}
+
+class PathInfo {
+    get value() {
+        if (typeof this._value !== 'undefined') {
+            return this._value;
+        }
+        if (this.pathParts.length > 0) {
+            this._value = getPathValue(this.data, this.pathParts);
+        } else {
+            this._value = this.data;
+        }
+        return this._value;
+    }
+    get name() {
+        if (this.pathParts.length > 0) {
+            return this.pathParts[this.pathParts.length - 1];
+        }
+        return null;
+    }
+    get parent() {
+        if (typeof this._parent !== 'undefined') {
+            return this._parent;
+        }
+        if (this.pathParts.length === 0) {
+            this._parent = null;
+            return this._parent;
+        }
+        if (this.pathParts.length > 1) {
+            const parentPathParts = this.pathParts.slice(0, this.pathParts.length - 1);
+            this._parent = new PathInfo(this.data, arrayToPath(parentPathParts));
+        } else {
+            this._parent = new PathInfo(this.data);
+        }
+        return this._parent;
+    }
+    get exists() {
+        if (typeof this._exists !== 'undefined') {
+            return this._exists;
+        }
+        if (!this.name || !this.parent) {
+            this._exists = true;
+            return this._exists;
+        }
+        if (this.parent.value !== null && typeof this.parent.value !== 'undefined') {
+            this._exists = this.name in Object(this.parent.value);
+        } else {
+            this._exists = false;
+        }
+        return this._exists;
+    }
+    constructor(data, path){
+        this.data = data;
+        this.path = path;
+        this.pathParts = this.path ? pathToArray(this.path) : [];
+    }
+}
+
+function getPathInfo(data, path) {
+    return new PathInfo(data, path);
+}
+
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */ function isObject(input) {
+    return !!input && typeof input === 'object' && !Array.isArray(input);
+}
+
+const NUMBER_REGEX = /^\d+$/;
+function setPathValue(data, path, value) {
+    const parts = Array.isArray(path) ? path : pathToArray(path);
+    let temp = data;
+    let index = 0;
+    while(index < parts.length){
+        /* istanbul ignore next */ if (!Array.isArray(temp) && !isObject(temp)) {
+            break;
+        }
+        const key = parts[index];
+        // [foo, '0']
+        if (typeof temp[key] === 'undefined') {
+            const match = NUMBER_REGEX.test(key);
+            if (match) {
+                temp[key] = [];
+            } else {
+                temp[key] = {};
+            }
+        }
+        if (index === parts.length - 1) {
+            temp[key] = value;
+            break;
+        }
+        index++;
+        temp = temp[key];
+    }
+    return data;
+}
+
+export { BRACKET_NUMBER_REGEX, arrayToPath, getPathInfo, getPathValue, pathToArray, setPathValue };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/helpers/array-to-path.ts","../src/helpers/path-to-array.ts","../src/get-path-value.ts","../src/path-info.ts","../src/get-path-info.ts","../src/utils/is-object.ts","../src/set-path-value.ts"],"sourcesContent":["/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\n/**\n * @see https://github.com/express-validator/express-validator/blob/bec1dcbaa29002dcd21093ec84818c4671063b5d/src/field-selection.ts#L214\n * @param parts\n */\nexport function arrayToPath(parts: readonly string[]) : string {\n    return parts.reduce((prev, segment) => {\n        let part = '';\n        segment = segment === '\\\\*' ? '*' : segment;\n\n        segment = segment.replace(/^\\[(\\d+)]$/g, '\\\\[$1]');\n        segment = segment.replace(/\\./g, '\\\\.');\n\n        if (/^\\d+$/.test(segment)) {\n            // Index access\n            part = `[${segment}]`;\n        } else if (prev) {\n            // Object key access\n            part = `.${segment}`;\n        } else {\n            // Top level key\n            part = segment;\n        }\n\n        return prev + part;\n    }, '');\n}\n","/*\n * Copyright (c) 2024-2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport const BRACKET_NUMBER_REGEX = /(?<!\\\\)\\[(\\d+)]$/;\n\n/**\n * Convert string to property path array.\n *\n * @see https://github.com/lodash/lodash/blob/main/src/.internal/stringToPath.ts\n * @see https://github.com/chaijs/pathval\n *\n * @param segment\n */\nexport function pathToArray(segment: string) : string[] {\n    const str = segment.replace(/([^\\\\])\\[/g, '$1.[');\n    const parts = str.match(/(\\\\\\.|[^.]+?)+/g);\n    if (!parts) {\n        return [];\n    }\n\n    const result : string[] = [];\n\n    for (let i = 0; i < parts.length; i++) {\n        if (\n            parts[i] === 'constructor' ||\n            parts[i] === '__proto__' ||\n            parts[i] === 'prototype'\n        ) {\n            continue;\n        }\n\n        const regex = BRACKET_NUMBER_REGEX.exec(parts[i]);\n        if (regex) {\n            result.push(regex[1]);\n        } else {\n            result.push(parts[i].replace(/\\\\([.[\\]])/g, '$1'));\n        }\n    }\n\n    return result;\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { pathToArray } from './helpers';\n\nexport function getPathValue(\n    data: unknown,\n    path: string | string[],\n): unknown {\n    const parts = Array.isArray(path) ? path : pathToArray(path);\n\n    let res : unknown | undefined;\n    let temp = data;\n    let index = 0;\n    while (index < parts.length) {\n        if (temp === null || typeof temp === 'undefined') {\n            break;\n        }\n\n        if (parts[index] in Object(temp)) {\n            // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n            // @ts-expect-error\n            temp = temp[parts[index]];\n        } else {\n            break;\n        }\n\n        if (index === parts.length - 1) {\n            res = temp;\n        }\n\n        index++;\n    }\n\n    return res;\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { getPathValue } from './get-path-value';\nimport { arrayToPath, pathToArray } from './helpers';\n\nexport class PathInfo {\n    protected data: unknown;\n\n    protected path : string | undefined;\n\n    protected pathParts: string[];\n\n    protected _value: unknown;\n\n    protected _parent: PathInfo | null | undefined;\n\n    protected _exists: boolean | undefined;\n\n    constructor(data: unknown, path?: string) {\n        this.data = data;\n        this.path = path;\n        this.pathParts = this.path ?\n            pathToArray(this.path) :\n            [];\n    }\n\n    get value() {\n        if (typeof this._value !== 'undefined') {\n            return this._value;\n        }\n\n        if (this.pathParts.length > 0) {\n            this._value = getPathValue(this.data, this.pathParts);\n        } else {\n            this._value = this.data;\n        }\n\n        return this._value;\n    }\n\n    get name() : string | null {\n        if (this.pathParts.length > 0) {\n            return this.pathParts[this.pathParts.length - 1];\n        }\n\n        return null;\n    }\n\n    get parent() : PathInfo | null {\n        if (typeof this._parent !== 'undefined') {\n            return this._parent;\n        }\n\n        if (this.pathParts.length === 0) {\n            this._parent = null;\n            return this._parent;\n        }\n\n        if (this.pathParts.length > 1) {\n            const parentPathParts = this.pathParts.slice(0, this.pathParts.length - 1);\n            this._parent = new PathInfo(\n                this.data,\n                arrayToPath(parentPathParts),\n            );\n        } else {\n            this._parent = new PathInfo(this.data);\n        }\n\n        return this._parent;\n    }\n\n    get exists() : boolean {\n        if (typeof this._exists !== 'undefined') {\n            return this._exists;\n        }\n\n        if (!this.name || !this.parent) {\n            this._exists = true;\n            return this._exists;\n        }\n\n        if (\n            this.parent.value !== null &&\n            typeof this.parent.value !== 'undefined'\n        ) {\n            this._exists = this.name in Object(this.parent.value);\n        } else {\n            this._exists = false;\n        }\n\n        return this._exists;\n    }\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { PathInfo } from './path-info';\n\nexport function getPathInfo(\n    data: Record<string, any>,\n    path?: string,\n) : PathInfo {\n    return new PathInfo(data, path);\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nexport function isObject(input: unknown) : input is Record<string, any> {\n    return !!input &&\n        typeof input === 'object' &&\n        !Array.isArray(input);\n}\n","/*\n * Copyright (c) 2024.\n * Author Peter Placzek (tada5hi)\n * For the full copyright and license information,\n * view the LICENSE file that was distributed with this source code.\n */\n\nimport { pathToArray } from './helpers';\nimport { isObject } from './utils';\n\nconst NUMBER_REGEX = /^\\d+$/;\n\nexport function setPathValue(\n    data: Record<string, any> | Record<string, any>[],\n    path: string | string[],\n    value: unknown,\n) {\n    const parts = Array.isArray(path) ? path : pathToArray(path);\n\n    let temp = data;\n    let index = 0;\n    while (index < parts.length) {\n        /* istanbul ignore next */\n        if (!Array.isArray(temp) && !isObject(temp)) {\n            break;\n        }\n\n        const key = parts[index] as keyof typeof temp;\n\n        // [foo, '0']\n        if (typeof temp[key] === 'undefined') {\n            const match = NUMBER_REGEX.test(key);\n            if (match) {\n                (temp as Record<string, any>)[key] = [];\n            } else {\n                temp[key] = {};\n            }\n        }\n\n        if (index === parts.length - 1) {\n            temp[key] = value;\n            break;\n        }\n\n        index++;\n        temp = temp[key];\n    }\n\n    return data;\n}\n"],"names":["arrayToPath","parts","reduce","prev","segment","part","replace","test","BRACKET_NUMBER_REGEX","pathToArray","str","match","result","i","length","regex","exec","push","getPathValue","data","path","Array","isArray","res","temp","index","Object","PathInfo","value","_value","pathParts","name","parent","_parent","parentPathParts","slice","exists","_exists","constructor","getPathInfo","isObject","input","NUMBER_REGEX","setPathValue","key"],"mappings":"AAAA;;;;;;;;IAWO,SAASA,WAAAA,CAAYC,KAAwB,EAAA;AAChD,IAAA,OAAOA,KAAMC,CAAAA,MAAM,CAAC,CAACC,IAAMC,EAAAA,OAAAA,GAAAA;AACvB,QAAA,IAAIC,IAAO,GAAA,EAAA,CAAA;QACXD,OAAUA,GAAAA,OAAAA,KAAY,QAAQ,GAAMA,GAAAA,OAAAA,CAAAA;QAEpCA,OAAUA,GAAAA,OAAAA,CAAQE,OAAO,CAAC,aAAe,EAAA,QAAA,CAAA,CAAA;QACzCF,OAAUA,GAAAA,OAAAA,CAAQE,OAAO,CAAC,KAAO,EAAA,KAAA,CAAA,CAAA;QAEjC,IAAI,OAAA,CAAQC,IAAI,CAACH,OAAU,CAAA,EAAA;;AAEvBC,YAAAA,IAAAA,GAAO,CAAC,CAAC,EAAED,OAAAA,CAAQ,CAAC,CAAC,CAAA;AACzB,SAAA,MAAO,IAAID,IAAM,EAAA;;AAEbE,YAAAA,IAAAA,GAAO,CAAC,CAAC,EAAED,OAAAA,CAAQ,CAAC,CAAA;SACjB,MAAA;;YAEHC,IAAOD,GAAAA,OAAAA,CAAAA;AACX,SAAA;AAEA,QAAA,OAAOD,IAAOE,GAAAA,IAAAA,CAAAA;KACf,EAAA,EAAA,CAAA,CAAA;AACP;;AChCA;;;;;IAOaG,MAAAA,oBAAAA,GAAuB,MAAmB,CAAA,sBAAA,EAAA;AAEvD;;;;;;;IAQO,SAASC,WAAAA,CAAYL,OAAe,EAAA;AACvC,IAAA,MAAMM,GAAMN,GAAAA,OAAAA,CAAQE,OAAO,CAAC,YAAc,EAAA,MAAA,CAAA,CAAA;IAC1C,MAAML,KAAAA,GAAQS,GAAIC,CAAAA,KAAK,CAAC,iBAAA,CAAA,CAAA;AACxB,IAAA,IAAI,CAACV,KAAO,EAAA;AACR,QAAA,OAAO,EAAE,CAAA;AACb,KAAA;AAEA,IAAA,MAAMW,SAAoB,EAAE,CAAA;AAE5B,IAAA,IAAK,IAAIC,CAAI,GAAA,CAAA,EAAGA,IAAIZ,KAAMa,CAAAA,MAAM,EAAED,CAAK,EAAA,CAAA;AACnC,QAAA,IACIZ,KAAK,CAACY,CAAE,CAAA,KAAK,iBACbZ,KAAK,CAACY,CAAE,CAAA,KAAK,WACbZ,IAAAA,KAAK,CAACY,CAAAA,CAAE,KAAK,WACf,EAAA;AACE,YAAA,SAAA;AACJ,SAAA;AAEA,QAAA,MAAME,QAAQP,oBAAqBQ,CAAAA,IAAI,CAACf,KAAK,CAACY,CAAE,CAAA,CAAA,CAAA;AAChD,QAAA,IAAIE,KAAO,EAAA;AACPH,YAAAA,MAAAA,CAAOK,IAAI,CAACF,KAAK,CAAC,CAAE,CAAA,CAAA,CAAA;SACjB,MAAA;YACHH,MAAOK,CAAAA,IAAI,CAAChB,KAAK,CAACY,EAAE,CAACP,OAAO,CAAC,aAAe,EAAA,IAAA,CAAA,CAAA,CAAA;AAChD,SAAA;AACJ,KAAA;IAEA,OAAOM,MAAAA,CAAAA;AACX;;ACnCO,SAASM,YAAAA,CACZC,IAAa,EACbC,IAAuB,EAAA;AAEvB,IAAA,MAAMnB,QAAQoB,KAAMC,CAAAA,OAAO,CAACF,IAAAA,CAAAA,GAAQA,OAAOX,WAAYW,CAAAA,IAAAA,CAAAA,CAAAA;IAEvD,IAAIG,GAAAA,CAAAA;AACJ,IAAA,IAAIC,IAAOL,GAAAA,IAAAA,CAAAA;AACX,IAAA,IAAIM,KAAQ,GAAA,CAAA,CAAA;IACZ,MAAOA,KAAAA,GAAQxB,KAAMa,CAAAA,MAAM,CAAE;AACzB,QAAA,IAAIU,IAAS,KAAA,IAAA,IAAQ,OAAOA,IAAAA,KAAS,WAAa,EAAA;AAC9C,YAAA,MAAA;AACJ,SAAA;AAEA,QAAA,IAAIvB,KAAK,CAACwB,KAAM,CAAA,IAAIC,OAAOF,IAAO,CAAA,EAAA;;;AAG9BA,YAAAA,IAAAA,GAAOA,IAAI,CAACvB,KAAK,CAACwB,MAAM,CAAC,CAAA;SACtB,MAAA;AACH,YAAA,MAAA;AACJ,SAAA;AAEA,QAAA,IAAIA,KAAUxB,KAAAA,KAAAA,CAAMa,MAAM,GAAG,CAAG,EAAA;YAC5BS,GAAMC,GAAAA,IAAAA,CAAAA;AACV,SAAA;AAEAC,QAAAA,KAAAA,EAAAA,CAAAA;AACJ,KAAA;IAEA,OAAOF,GAAAA,CAAAA;AACX;;AC7BO,MAAMI,QAAAA,CAAAA;AAqBT,IAAA,IAAIC,KAAQ,GAAA;AACR,QAAA,IAAI,OAAO,IAAI,CAACC,MAAM,KAAK,WAAa,EAAA;YACpC,OAAO,IAAI,CAACA,MAAM,CAAA;AACtB,SAAA;AAEA,QAAA,IAAI,IAAI,CAACC,SAAS,CAAChB,MAAM,GAAG,CAAG,EAAA;YAC3B,IAAI,CAACe,MAAM,GAAGX,YAAa,CAAA,IAAI,CAACC,IAAI,EAAE,IAAI,CAACW,SAAS,CAAA,CAAA;SACjD,MAAA;AACH,YAAA,IAAI,CAACD,MAAM,GAAG,IAAI,CAACV,IAAI,CAAA;AAC3B,SAAA;QAEA,OAAO,IAAI,CAACU,MAAM,CAAA;AACtB,KAAA;AAEA,IAAA,IAAIE,IAAuB,GAAA;AACvB,QAAA,IAAI,IAAI,CAACD,SAAS,CAAChB,MAAM,GAAG,CAAG,EAAA;YAC3B,OAAO,IAAI,CAACgB,SAAS,CAAC,IAAI,CAACA,SAAS,CAAChB,MAAM,GAAG,CAAE,CAAA,CAAA;AACpD,SAAA;QAEA,OAAO,IAAA,CAAA;AACX,KAAA;AAEA,IAAA,IAAIkB,MAA2B,GAAA;AAC3B,QAAA,IAAI,OAAO,IAAI,CAACC,OAAO,KAAK,WAAa,EAAA;YACrC,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;AAEA,QAAA,IAAI,IAAI,CAACH,SAAS,CAAChB,MAAM,KAAK,CAAG,EAAA;YAC7B,IAAI,CAACmB,OAAO,GAAG,IAAA,CAAA;YACf,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;AAEA,QAAA,IAAI,IAAI,CAACH,SAAS,CAAChB,MAAM,GAAG,CAAG,EAAA;AAC3B,YAAA,MAAMoB,eAAkB,GAAA,IAAI,CAACJ,SAAS,CAACK,KAAK,CAAC,CAAA,EAAG,IAAI,CAACL,SAAS,CAAChB,MAAM,GAAG,CAAA,CAAA,CAAA;YACxE,IAAI,CAACmB,OAAO,GAAG,IAAIN,SACf,IAAI,CAACR,IAAI,EACTnB,WAAYkC,CAAAA,eAAAA,CAAAA,CAAAA,CAAAA;SAEb,MAAA;AACH,YAAA,IAAI,CAACD,OAAO,GAAG,IAAIN,QAAS,CAAA,IAAI,CAACR,IAAI,CAAA,CAAA;AACzC,SAAA;QAEA,OAAO,IAAI,CAACc,OAAO,CAAA;AACvB,KAAA;AAEA,IAAA,IAAIG,MAAmB,GAAA;AACnB,QAAA,IAAI,OAAO,IAAI,CAACC,OAAO,KAAK,WAAa,EAAA;YACrC,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;QAEA,IAAI,CAAC,IAAI,CAACN,IAAI,IAAI,CAAC,IAAI,CAACC,MAAM,EAAE;YAC5B,IAAI,CAACK,OAAO,GAAG,IAAA,CAAA;YACf,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,SAAA;AAEA,QAAA,IACI,IAAI,CAACL,MAAM,CAACJ,KAAK,KAAK,IAAA,IACtB,OAAO,IAAI,CAACI,MAAM,CAACJ,KAAK,KAAK,WAC/B,EAAA;AACE,YAAA,IAAI,CAACS,OAAO,GAAG,IAAI,CAACN,IAAI,IAAIL,MAAAA,CAAO,IAAI,CAACM,MAAM,CAACJ,KAAK,CAAA,CAAA;SACjD,MAAA;YACH,IAAI,CAACS,OAAO,GAAG,KAAA,CAAA;AACnB,SAAA;QAEA,OAAO,IAAI,CAACA,OAAO,CAAA;AACvB,KAAA;IAzEAC,WAAYnB,CAAAA,IAAa,EAAEC,IAAa,CAAE;QACtC,IAAI,CAACD,IAAI,GAAGA,IAAAA,CAAAA;QACZ,IAAI,CAACC,IAAI,GAAGA,IAAAA,CAAAA;AACZ,QAAA,IAAI,CAACU,SAAS,GAAG,IAAI,CAACV,IAAI,GACtBX,WAAAA,CAAY,IAAI,CAACW,IAAI,CAAA,GACrB,EAAE,CAAA;AACV,KAAA;AAoEJ;;ACxFO,SAASmB,WAAAA,CACZpB,IAAyB,EACzBC,IAAa,EAAA;IAEb,OAAO,IAAIO,SAASR,IAAMC,EAAAA,IAAAA,CAAAA,CAAAA;AAC9B;;ACdA;;;;;IAOO,SAASoB,QAAAA,CAASC,KAAc,EAAA;IACnC,OAAO,CAAC,CAACA,KACL,IAAA,OAAOA,UAAU,QACjB,IAAA,CAACpB,KAAMC,CAAAA,OAAO,CAACmB,KAAAA,CAAAA,CAAAA;AACvB;;ACDA,MAAMC,YAAe,GAAA,OAAA,CAAA;AAEd,SAASC,YACZxB,CAAAA,IAAiD,EACjDC,IAAuB,EACvBQ,KAAc,EAAA;AAEd,IAAA,MAAM3B,QAAQoB,KAAMC,CAAAA,OAAO,CAACF,IAAAA,CAAAA,GAAQA,OAAOX,WAAYW,CAAAA,IAAAA,CAAAA,CAAAA;AAEvD,IAAA,IAAII,IAAOL,GAAAA,IAAAA,CAAAA;AACX,IAAA,IAAIM,KAAQ,GAAA,CAAA,CAAA;IACZ,MAAOA,KAAAA,GAAQxB,KAAMa,CAAAA,MAAM,CAAE;mCAEzB,IAAI,CAACO,KAAAA,CAAMC,OAAO,CAACE,IAAAA,CAAAA,IAAS,CAACgB,QAAAA,CAAShB,IAAO,CAAA,EAAA;AACzC,YAAA,MAAA;AACJ,SAAA;QAEA,MAAMoB,GAAAA,GAAM3C,KAAK,CAACwB,KAAM,CAAA,CAAA;;AAGxB,QAAA,IAAI,OAAOD,IAAI,CAACoB,GAAAA,CAAI,KAAK,WAAa,EAAA;YAClC,MAAMjC,KAAAA,GAAQ+B,YAAanC,CAAAA,IAAI,CAACqC,GAAAA,CAAAA,CAAAA;AAChC,YAAA,IAAIjC,KAAO,EAAA;gBACNa,IAA4B,CAACoB,GAAI,CAAA,GAAG,EAAE,CAAA;aACpC,MAAA;gBACHpB,IAAI,CAACoB,GAAI,CAAA,GAAG,EAAC,CAAA;AACjB,aAAA;AACJ,SAAA;AAEA,QAAA,IAAInB,KAAUxB,KAAAA,KAAAA,CAAMa,MAAM,GAAG,CAAG,EAAA;YAC5BU,IAAI,CAACoB,IAAI,GAAGhB,KAAAA,CAAAA;AACZ,YAAA,MAAA;AACJ,SAAA;AAEAH,QAAAA,KAAAA,EAAAA,CAAAA;QACAD,IAAOA,GAAAA,IAAI,CAACoB,GAAI,CAAA,CAAA;AACpB,KAAA;IAEA,OAAOzB,IAAAA,CAAAA;AACX;;;;"}

package/dist/path-info.d.ts

@@ -0,0 +1,13 @@
+export declare class PathInfo {
+    protected data: unknown;
+    protected path: string | undefined;
+    protected pathParts: string[];
+    protected _value: unknown;
+    protected _parent: PathInfo | null | undefined;
+    protected _exists: boolean | undefined;
+    constructor(data: unknown, path?: string);
+    get value(): unknown;
+    get name(): string | null;
+    get parent(): PathInfo | null;
+    get exists(): boolean;
+}

package/dist/set-path-value.d.ts

@@ -0,0 +1 @@
+export declare function setPathValue(data: Record<string, any> | Record<string, any>[], path: string | string[], value: unknown): Record<string, any> | Record<string, any>[];

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './is-object';

package/dist/utils/is-object.d.ts

@@ -0,0 +1 @@
+export declare function isObject(input: unknown): input is Record<string, any>;

package/package.json

@@ -0,0 +1,73 @@
+{
+    "name": "pathtrace",
+    "version": "1.0.0-beta.1",
+    "description": "Simplifies working with nested objects and arrays by providing easy methods to retrieve, set, and check values at any path.",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.cjs"
+        }
+    },
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build:types": "tsc --emitDeclarationOnly -p tsconfig.json",
+        "build:js": "rollup -c",
+        "build": "rimraf ./dist && cross-env NODE_ENV=production npm run build:js && npm run build:types",
+        "test": "cross-env NODE_ENV=test jest --config ./test/jest.config.js",
+        "test:coverage": "npm run test -- --coverage",
+        "lint": "eslint --ext .js,.vue,.ts ./src ./test",
+        "lint:fix": "npm run lint -- --fix"
+    },
+    "bin": {
+        "authup": "dist/index.cjs"
+    },
+    "keywords": [
+        "nested-objects",
+        "path",
+        "path-retrival",
+        "javascript",
+        "path-info",
+        "deep-access"
+    ],
+    "author": {
+        "name": "Peter Placzek",
+        "email": "contact@tada5hi.net",
+        "url": "https://github.com/tada5hi"
+    },
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/tada5hi/pathtrace.git"
+    },
+    "bugs": {
+        "url": "https://github.com/tada5hi/pathtrace/issues"
+    },
+    "homepage": "https://github.com/tada5hi/pathtrace#readme",
+    "devDependencies": {
+        "@rollup/plugin-node-resolve": "^15.2.3",
+        "@rollup/plugin-swc": "^0.3.1",
+        "@swc/jest": "^0.2.36",
+        "@tada5hi/commitlint-config": "^1.2.1",
+        "@tada5hi/eslint-config-typescript": "^1.2.11",
+        "@tada5hi/semantic-release": "^0.3.1",
+        "@tada5hi/tsconfig": "^0.5.1",
+        "@types/jest": "^29.5.12",
+        "@types/node": "^22.5.0",
+        "@types/pathval": "^1.1.2",
+        "cross-env": "^7.0.3",
+        "eslint": "^8.37.0",
+        "husky": "^9.0.11",
+        "jest": "^29.7.0",
+        "rollup": "^4.21.1",
+        "semantic-release": "^22.0.12",
+        "ts-jest": "^29.2.5",
+        "typescript": "^5.5.4"
+    }
+}