property-accessor 2.2.0 → 2.4.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 +12 -0
- package/README.md +10 -0
- package/dist/library/property-accessor.d.ts +3 -2
- package/dist/library/property-accessor.js +62 -63
- package/dist/library/property-accessor.js.map +1 -1
- package/package.json +1 -1
- package/test/test.js +6 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,18 @@ 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.4.0] - 2025-12-11
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Added delete method (both static and instance)
|
|
13
|
+
|
|
14
|
+
## [2.3.0] - 2025-05-20
|
|
15
|
+
|
|
16
|
+
### Fixed
|
|
17
|
+
|
|
18
|
+
- Decided to don't deal with float-like keys, since it is not possible to clarify parsing strategy for some cases
|
|
19
|
+
|
|
8
20
|
## [2.2.0] - 2025-05-19
|
|
9
21
|
|
|
10
22
|
### Fixed
|
package/README.md
CHANGED
|
@@ -31,6 +31,16 @@ Retrieves a value from the object using a dot/bracket notation path.
|
|
|
31
31
|
|
|
32
32
|
---
|
|
33
33
|
|
|
34
|
+
### `PropertyAccessor.delete(key: string): boolean`
|
|
35
|
+
|
|
36
|
+
Removes a value from the object using a dot/bracket notation path.
|
|
37
|
+
|
|
38
|
+
- **Parameters:**
|
|
39
|
+
- `key` (`string`): Property path (e.g. `"prop1.prop2[0]['name']"`)
|
|
40
|
+
- `target` (`object`): The target object to evaluate
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
34
44
|
### `PropertyAccessor.set(key: string, value: any, target: any): boolean`
|
|
35
45
|
|
|
36
46
|
Sets a value at the given path. Returns `true` on success, `false` otherwise.
|
|
@@ -2,10 +2,11 @@ export declare class PropertyAccessor {
|
|
|
2
2
|
protected target: any;
|
|
3
3
|
constructor(target: any);
|
|
4
4
|
get(key: string): any;
|
|
5
|
-
set(key: string, value: any):
|
|
5
|
+
set(key: string, value: any): any;
|
|
6
|
+
delete(key: string): boolean;
|
|
6
7
|
flat(): any;
|
|
7
8
|
static get(path: string, src: any): any;
|
|
8
9
|
static set(path: string, value: any, src: any): boolean;
|
|
10
|
+
static delete(path: string, src: any): boolean;
|
|
9
11
|
static flat(target: any): any;
|
|
10
|
-
static parsePath(path: string): string[];
|
|
11
12
|
}
|
|
@@ -13,6 +13,9 @@ class PropertyAccessor {
|
|
|
13
13
|
set(key, value) {
|
|
14
14
|
return PropertyAccessor.set(key, value, this.target);
|
|
15
15
|
}
|
|
16
|
+
delete(key) {
|
|
17
|
+
return PropertyAccessor.delete(key, this.target);
|
|
18
|
+
}
|
|
16
19
|
flat() {
|
|
17
20
|
return PropertyAccessor.flat(this.target);
|
|
18
21
|
}
|
|
@@ -26,33 +29,76 @@ class PropertyAccessor {
|
|
|
26
29
|
if (!(0, _helpers_1.validatePath)(path)) {
|
|
27
30
|
return;
|
|
28
31
|
}
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
if (acc === undefined || acc === null)
|
|
32
|
+
return path.split('.').reduce((acc, part) => {
|
|
33
|
+
if (acc === undefined || acc === null) {
|
|
32
34
|
return;
|
|
33
|
-
|
|
35
|
+
}
|
|
36
|
+
const parts = part.split(/[\[\]]/).filter(Boolean);
|
|
37
|
+
for (const part of parts) {
|
|
38
|
+
acc = acc?.[part];
|
|
39
|
+
if (acc === undefined) {
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
34
43
|
return acc;
|
|
35
44
|
}, src);
|
|
36
45
|
}
|
|
37
46
|
static set(path, value, src) {
|
|
38
|
-
if (!src
|
|
47
|
+
if (!src) {
|
|
48
|
+
return;
|
|
49
|
+
}
|
|
50
|
+
if (!path) {
|
|
51
|
+
return false;
|
|
52
|
+
}
|
|
53
|
+
if (!(0, _helpers_1.validatePath)(path)) {
|
|
39
54
|
return false;
|
|
40
55
|
}
|
|
41
|
-
const keys =
|
|
56
|
+
const keys = path.split('.');
|
|
42
57
|
let target = src;
|
|
43
58
|
for (let i = 0; i < keys.length; i++) {
|
|
44
|
-
const
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
59
|
+
const parts = keys[i].split(/[\[\]]/).filter(Boolean);
|
|
60
|
+
for (let j = 0; j < parts.length; j++) {
|
|
61
|
+
const key = parts[j];
|
|
62
|
+
const isLastKey = i === keys.length - 1 && j === parts.length - 1;
|
|
63
|
+
if (isLastKey) {
|
|
64
|
+
target[key] = value;
|
|
65
|
+
}
|
|
66
|
+
else {
|
|
67
|
+
if (!target[key] || typeof target[key] !== 'object') {
|
|
68
|
+
target[key] = /^\d+$/.test(parts[j + 1] || '') ? [] : {};
|
|
69
|
+
}
|
|
70
|
+
target = target[key];
|
|
71
|
+
}
|
|
48
72
|
}
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
73
|
+
}
|
|
74
|
+
return true;
|
|
75
|
+
}
|
|
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];
|
|
54
101
|
}
|
|
55
|
-
target = target[key];
|
|
56
102
|
}
|
|
57
103
|
}
|
|
58
104
|
return true;
|
|
@@ -62,53 +108,6 @@ class PropertyAccessor {
|
|
|
62
108
|
(0, _helpers_1.flatKeyHelper)(target, flat);
|
|
63
109
|
return flat;
|
|
64
110
|
}
|
|
65
|
-
static parsePath(path) {
|
|
66
|
-
const parts = [];
|
|
67
|
-
let buffer = '';
|
|
68
|
-
let insideBracket = false;
|
|
69
|
-
for (let i = 0; i < path.length; i++) {
|
|
70
|
-
const char = path[i];
|
|
71
|
-
if (char === '.' && !insideBracket) {
|
|
72
|
-
if (buffer !== '') {
|
|
73
|
-
parts.push(buffer);
|
|
74
|
-
buffer = '';
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
else if (char === '[') {
|
|
78
|
-
if (buffer !== '') {
|
|
79
|
-
parts.push(buffer);
|
|
80
|
-
buffer = '';
|
|
81
|
-
}
|
|
82
|
-
insideBracket = true;
|
|
83
|
-
}
|
|
84
|
-
else if (char === ']') {
|
|
85
|
-
if (buffer !== '') {
|
|
86
|
-
parts.push(buffer);
|
|
87
|
-
buffer = '';
|
|
88
|
-
}
|
|
89
|
-
insideBracket = false;
|
|
90
|
-
}
|
|
91
|
-
else {
|
|
92
|
-
buffer += char;
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
if (buffer !== '') {
|
|
96
|
-
parts.push(buffer);
|
|
97
|
-
}
|
|
98
|
-
const mergedParts = [];
|
|
99
|
-
for (let i = 0; i < parts.length; i++) {
|
|
100
|
-
const cur = parts[i];
|
|
101
|
-
const next = parts[i + 1];
|
|
102
|
-
if (next && /^\d+$/.test(cur) && /^\d+$/.test(next)) {
|
|
103
|
-
mergedParts.push(`${cur}.${next}`);
|
|
104
|
-
i++;
|
|
105
|
-
}
|
|
106
|
-
else {
|
|
107
|
-
mergedParts.push(cur);
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
return mergedParts;
|
|
111
|
-
}
|
|
112
111
|
}
|
|
113
112
|
exports.PropertyAccessor = PropertyAccessor;
|
|
114
113
|
//# sourceMappingURL=property-accessor.js.map
|
|
@@ -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;
|
|
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;QACT,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5C,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;QACrB,MAAM,IAAI,GAAwB,EAAE,CAAC;QACrC,IAAA,wBAAa,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhHD,4CAgHC"}
|
package/package.json
CHANGED
package/test/test.js
CHANGED
|
@@ -30,5 +30,10 @@ const propertyAccessor = new PropertyAccessor({ a: [{ b: 2 }] });
|
|
|
30
30
|
|
|
31
31
|
assert.equal(propertyAccessor.get('a[0].b'), 2);
|
|
32
32
|
assert.equal(propertyAccessor.set('a[0].c', 3), true);
|
|
33
|
-
|
|
33
|
+
assert.equal(propertyAccessor.get('a[0].c'), 3);
|
|
34
|
+
assert.equal(propertyAccessor.set('a[0].23',1), true);
|
|
35
|
+
assert.equal(propertyAccessor.get('a[0].23'), 1);
|
|
36
|
+
propertyAccessor.delete('a[0].23');
|
|
37
|
+
assert.equal(propertyAccessor.get('a[0].23'), undefined);
|
|
38
|
+
console.log(propertyAccessor.flat())
|
|
34
39
|
console.log('tests passed');
|