property-accessor 2.3.0 → 2.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -1
- package/README.md +11 -0
- package/dist/helpers/flat-key-helper.d.ts +1 -1
- package/dist/helpers/flat-key-helper.js +9 -5
- package/dist/helpers/flat-key-helper.js.map +1 -1
- package/dist/library/property-accessor.d.ts +4 -2
- package/dist/library/property-accessor.js +37 -4
- package/dist/library/property-accessor.js.map +1 -1
- package/package.json +1 -1
- package/test/test.js +3 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,11 +5,23 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
|
6
6
|
and this project adheres to [Semantic Versioning](http://semver.org/).
|
|
7
7
|
|
|
8
|
+
## [2.5.0] - 2026-01-16
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Added spaceReplacer to flatKeyHelper and flat method (to replace space characters)
|
|
13
|
+
|
|
14
|
+
## [2.4.0] - 2025-12-11
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
- Added delete method (both static and instance)
|
|
19
|
+
|
|
8
20
|
## [2.3.0] - 2025-05-20
|
|
9
21
|
|
|
10
22
|
### Fixed
|
|
11
23
|
|
|
12
|
-
- Decided to don't deal with float-like keys, since it is not possible to clarify parsing strategy for some cases
|
|
24
|
+
- Decided to don't deal with float-like keys, since it is not possible to clarify parsing strategy for some cases
|
|
13
25
|
|
|
14
26
|
## [2.2.0] - 2025-05-19
|
|
15
27
|
|
package/README.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# Property Accessor
|
|
2
|
+
|
|
2
3
|
#### [Changelog](./CHANGELOG.md)
|
|
3
4
|
|
|
4
5
|
This utility provides methods to **evaluate and manipulate deeply nested properties** of objects using string-based paths like:
|
|
@@ -31,6 +32,16 @@ Retrieves a value from the object using a dot/bracket notation path.
|
|
|
31
32
|
|
|
32
33
|
---
|
|
33
34
|
|
|
35
|
+
### `PropertyAccessor.delete(key: string): boolean`
|
|
36
|
+
|
|
37
|
+
Removes a value from the object using a dot/bracket notation path.
|
|
38
|
+
|
|
39
|
+
- **Parameters:**
|
|
40
|
+
- `key` (`string`): Property path (e.g. `"prop1.prop2[0]['name']"`)
|
|
41
|
+
- `target` (`object`): The target object to evaluate
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
34
45
|
### `PropertyAccessor.set(key: string, value: any, target: any): boolean`
|
|
35
46
|
|
|
36
47
|
Sets a value at the given path. Returns `true` on success, `false` otherwise.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare function flatKeyHelper(source: any, accumulator: any, prefix?: string): void;
|
|
1
|
+
export declare function flatKeyHelper(source: any, accumulator: any, prefix?: string, spaceReplacer?: string): void;
|
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.flatKeyHelper = void 0;
|
|
4
|
-
function flatKeyHelper(source, accumulator, prefix = '') {
|
|
4
|
+
function flatKeyHelper(source, accumulator, prefix = '', spaceReplacer) {
|
|
5
5
|
if (typeof source !== 'object') {
|
|
6
6
|
accumulator[prefix] = source;
|
|
7
7
|
}
|
|
8
8
|
else if (Array.isArray(source)) {
|
|
9
9
|
for (let i = 0; i < source.length; i++) {
|
|
10
|
-
const property = `${prefix}[${i}]`;
|
|
11
|
-
flatKeyHelper(source[i], accumulator, property);
|
|
10
|
+
const property = `${prefix ? (spaceReplacer ? prefix.replace(/\s/g, spaceReplacer) : prefix) : ''}[${i}]`;
|
|
11
|
+
flatKeyHelper(source[i], accumulator, property, spaceReplacer);
|
|
12
12
|
}
|
|
13
13
|
}
|
|
14
14
|
else {
|
|
15
15
|
for (const key in source) {
|
|
16
|
-
const property = prefix
|
|
17
|
-
|
|
16
|
+
const property = prefix
|
|
17
|
+
? spaceReplacer
|
|
18
|
+
? `${prefix.replace(/\s/g, spaceReplacer)}.${key}`
|
|
19
|
+
: `${prefix}.${key}`
|
|
20
|
+
: key;
|
|
21
|
+
flatKeyHelper(source[key], accumulator, property, spaceReplacer);
|
|
18
22
|
}
|
|
19
23
|
}
|
|
20
24
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flat-key-helper.js","sourceRoot":"","sources":["../../src/helpers/flat-key-helper.ts"],"names":[],"mappings":";;;AAAA,SAAgB,aAAa,CAAC,MAAW,EAAE,WAAgB,EAAE,SAAiB,EAAE;
|
|
1
|
+
{"version":3,"file":"flat-key-helper.js","sourceRoot":"","sources":["../../src/helpers/flat-key-helper.ts"],"names":[],"mappings":";;;AAAA,SAAgB,aAAa,CAAC,MAAW,EAAE,WAAgB,EAAE,SAAiB,EAAE,EAAE,aAAsB;IACtG,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC/B,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC;YAC1G,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,MAAM;gBACrB,CAAC,CAAC,aAAa;oBACb,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,GAAG,EAAE;oBAClD,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE;gBACtB,CAAC,CAAC,GAAG,CAAC;YACR,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAlBD,sCAkBC"}
|
|
@@ -3,8 +3,10 @@ export declare class PropertyAccessor {
|
|
|
3
3
|
constructor(target: any);
|
|
4
4
|
get(key: string): any;
|
|
5
5
|
set(key: string, value: any): any;
|
|
6
|
-
|
|
6
|
+
delete(key: string): boolean;
|
|
7
|
+
flat(spaceReplacer?: string): any;
|
|
7
8
|
static get(path: string, src: any): any;
|
|
8
9
|
static set(path: string, value: any, src: any): boolean;
|
|
9
|
-
static
|
|
10
|
+
static delete(path: string, src: any): boolean;
|
|
11
|
+
static flat(target: any, spaceReplacer?: string): any;
|
|
10
12
|
}
|
|
@@ -13,8 +13,11 @@ class PropertyAccessor {
|
|
|
13
13
|
set(key, value) {
|
|
14
14
|
return PropertyAccessor.set(key, value, this.target);
|
|
15
15
|
}
|
|
16
|
-
|
|
17
|
-
return PropertyAccessor.
|
|
16
|
+
delete(key) {
|
|
17
|
+
return PropertyAccessor.delete(key, this.target);
|
|
18
|
+
}
|
|
19
|
+
flat(spaceReplacer) {
|
|
20
|
+
return PropertyAccessor.flat(this.target, spaceReplacer);
|
|
18
21
|
}
|
|
19
22
|
static get(path, src) {
|
|
20
23
|
if (!src) {
|
|
@@ -70,9 +73,39 @@ class PropertyAccessor {
|
|
|
70
73
|
}
|
|
71
74
|
return true;
|
|
72
75
|
}
|
|
73
|
-
static
|
|
76
|
+
static delete(path, src) {
|
|
77
|
+
if (!src) {
|
|
78
|
+
return;
|
|
79
|
+
}
|
|
80
|
+
if (!path) {
|
|
81
|
+
return false;
|
|
82
|
+
}
|
|
83
|
+
if (!(0, _helpers_1.validatePath)(path)) {
|
|
84
|
+
return false;
|
|
85
|
+
}
|
|
86
|
+
const keys = path.split('.');
|
|
87
|
+
let target = src;
|
|
88
|
+
for (let i = 0; i < keys.length; i++) {
|
|
89
|
+
const parts = keys[i].split(/[\[\]]/).filter(Boolean);
|
|
90
|
+
for (let j = 0; j < parts.length; j++) {
|
|
91
|
+
const key = parts[j];
|
|
92
|
+
const isLastKey = i === keys.length - 1 && j === parts.length - 1;
|
|
93
|
+
if (isLastKey) {
|
|
94
|
+
delete target[key];
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
if (!target[key] || typeof target[key] !== 'object') {
|
|
98
|
+
target[key] = /^\d+$/.test(parts[j + 1] || '') ? [] : {};
|
|
99
|
+
}
|
|
100
|
+
target = target[key];
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
return true;
|
|
105
|
+
}
|
|
106
|
+
static flat(target, spaceReplacer) {
|
|
74
107
|
const flat = {};
|
|
75
|
-
(0, _helpers_1.flatKeyHelper)(target, flat);
|
|
108
|
+
(0, _helpers_1.flatKeyHelper)(target, flat, '', spaceReplacer);
|
|
76
109
|
return flat;
|
|
77
110
|
}
|
|
78
111
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"property-accessor.js","sourceRoot":"","sources":["../../src/library/property-accessor.ts"],"names":[],"mappings":";;;AAAA,uCAAuD;AAEvD,MAAa,gBAAgB;IACjB,MAAM,CAAM;IAEtB,YAAY,MAAW;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACM,GAAG,CAAC,GAAW;QACpB,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAU;QAChC,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAEM,IAAI;
|
|
1
|
+
{"version":3,"file":"property-accessor.js","sourceRoot":"","sources":["../../src/library/property-accessor.ts"],"names":[],"mappings":";;;AAAA,uCAAuD;AAEvD,MAAa,gBAAgB;IACjB,MAAM,CAAM;IAEtB,YAAY,MAAW;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACM,GAAG,CAAC,GAAW;QACpB,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAU;QAChC,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAEM,MAAM,CAAC,GAAW;QACvB,OAAO,gBAAgB,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAEM,IAAI,CAAC,aAAsB;QAChC,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,GAAQ;QAC/B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,CAAC,IAAA,uBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,IAAY,EAAE,EAAE;YAC1D,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACtC,OAAO;YACT,CAAC;YACD,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC7D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,GAAG,GAAG,GAAG,EAAE,CAAC,IAAW,CAAC,CAAC;gBACzB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;oBACtB,OAAO;gBACT,CAAC;YACH,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,KAAU,EAAE,GAAQ;QAC3C,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,IAAA,uBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,MAAM,GAAG,GAAG,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACrB,MAAM,SAAS,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;gBAClE,IAAI,SAAS,EAAE,CAAC;oBACd,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACtB,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;wBACpD,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC3D,CAAC;oBACD,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,GAAQ;QAClC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,IAAA,uBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,MAAM,GAAG,GAAG,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACrB,MAAM,SAAS,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;gBAClE,IAAI,SAAS,EAAE,CAAC;oBACd,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;wBACpD,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC3D,CAAC;oBACD,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,MAAW,EAAE,aAAsB;QAC7C,MAAM,IAAI,GAAwB,EAAE,CAAC;QACrC,IAAA,wBAAa,EAAC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhHD,4CAgHC"}
|
package/package.json
CHANGED
package/test/test.js
CHANGED
|
@@ -33,5 +33,7 @@ assert.equal(propertyAccessor.set('a[0].c', 3), true);
|
|
|
33
33
|
assert.equal(propertyAccessor.get('a[0].c'), 3);
|
|
34
34
|
assert.equal(propertyAccessor.set('a[0].23',1), true);
|
|
35
35
|
assert.equal(propertyAccessor.get('a[0].23'), 1);
|
|
36
|
-
|
|
36
|
+
propertyAccessor.delete('a[0].23');
|
|
37
|
+
assert.equal(propertyAccessor.get('a[0].23'), undefined);
|
|
38
|
+
|
|
37
39
|
console.log('tests passed');
|