property-accessor 2.0.0 → 2.1.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 +17 -4
- package/README.md +15 -3
- package/dist/helpers/flat-key-helper.d.ts +1 -0
- package/dist/helpers/flat-key-helper.js +22 -0
- package/dist/helpers/flat-key-helper.js.map +1 -0
- package/dist/helpers/index.d.ts +1 -0
- package/dist/helpers/index.js +1 -0
- package/dist/helpers/index.js.map +1 -1
- package/dist/helpers/validate-path.js +1 -3
- package/dist/helpers/validate-path.js.map +1 -1
- package/dist/library/property-accessor.d.ts +2 -0
- package/dist/library/property-accessor.js +8 -0
- package/dist/library/property-accessor.js.map +1 -1
- package/package.json +1 -1
- package/test/test.js +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -5,18 +5,31 @@ 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.1.0] - 2025-05-01
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Flat methods to receive flat object
|
|
13
|
+
|
|
14
|
+
## [2.0.1] - 2025-05-01
|
|
15
|
+
|
|
16
|
+
### Fixed
|
|
17
|
+
|
|
18
|
+
- Fixed changelog
|
|
19
|
+
- Refactored code
|
|
20
|
+
|
|
8
21
|
## [2.0.0] - 2025-05-01
|
|
9
22
|
|
|
10
23
|
### Added
|
|
24
|
+
|
|
11
25
|
- Re-implemented with TypeScript
|
|
12
26
|
- Added path validation
|
|
13
27
|
- Added tests
|
|
14
28
|
|
|
15
|
-
###
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
16
31
|
- Refactored code
|
|
17
32
|
|
|
18
33
|
## [1.0.0] - 2019-06-27
|
|
19
34
|
|
|
20
|
-
Basic package implementation with ES2015
|
|
21
|
-
|
|
22
|
-
|
|
35
|
+
Basic package implementation with ES2015
|
package/README.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# Property Accessor
|
|
2
|
+
#### [Changelog](./CHANGELOG.md)
|
|
2
3
|
|
|
3
4
|
This utility provides methods to **evaluate and manipulate deeply nested properties** of objects using string-based paths like:
|
|
4
5
|
|
|
@@ -32,7 +33,7 @@ Retrieves a value from the object using a dot/bracket notation path.
|
|
|
32
33
|
|
|
33
34
|
### `PropertyAccessor.set(key: string, value: any, target: any): boolean`
|
|
34
35
|
|
|
35
|
-
Sets a value at the given path. Returns `true` on success, `false` otherwise.
|
|
36
|
+
Sets a value at the given path. Returns `true` on success, `false` otherwise.
|
|
36
37
|
**Automatically creates nested objects and arrays as needed**.
|
|
37
38
|
|
|
38
39
|
- **Parameters:**
|
|
@@ -42,6 +43,15 @@ Sets a value at the given path. Returns `true` on success, `false` otherwise.
|
|
|
42
43
|
|
|
43
44
|
---
|
|
44
45
|
|
|
46
|
+
### `PropertyAccessor.flat(target: any): any`
|
|
47
|
+
|
|
48
|
+
Returns flat object based on target.
|
|
49
|
+
|
|
50
|
+
- **Parameters:**
|
|
51
|
+
- `target` (`object`): The target object
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
45
55
|
## Usage Example
|
|
46
56
|
|
|
47
57
|
```js
|
|
@@ -50,8 +60,8 @@ const { PropertyAccessor } = require('property-accessor');
|
|
|
50
60
|
const target = {
|
|
51
61
|
users: [
|
|
52
62
|
{ firstName: 'John', surName: 'Doe', age: 25 },
|
|
53
|
-
{ firstName: 'Ann', surName: 'Doe', age: 23 }
|
|
54
|
-
]
|
|
63
|
+
{ firstName: 'Ann', surName: 'Doe', age: 23 },
|
|
64
|
+
],
|
|
55
65
|
};
|
|
56
66
|
|
|
57
67
|
console.log(PropertyAccessor.get('users[0].firstName', target));
|
|
@@ -75,6 +85,8 @@ For backward compatibility, you can also create an instance and bind a specific
|
|
|
75
85
|
```js
|
|
76
86
|
const propertyAccessor = new PropertyAccessor({ a: [{ b: 3 }] });
|
|
77
87
|
propertyAccessor.set('a[1].b', 4);
|
|
88
|
+
propertyAccessor.get('a[1].b');
|
|
89
|
+
propertyAccessor.flat();
|
|
78
90
|
```
|
|
79
91
|
|
|
80
92
|
---
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function flatKeyHelper(source: any, accumulator: any, prefix?: string): void;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.flatKeyHelper = void 0;
|
|
4
|
+
function flatKeyHelper(source, accumulator, prefix = '') {
|
|
5
|
+
if (typeof source !== 'object') {
|
|
6
|
+
accumulator[prefix] = source;
|
|
7
|
+
}
|
|
8
|
+
else if (Array.isArray(source)) {
|
|
9
|
+
for (let i = 0; i < source.length; i++) {
|
|
10
|
+
const property = `${prefix}[${i}]`;
|
|
11
|
+
flatKeyHelper(source[i], accumulator, property);
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
else {
|
|
15
|
+
for (const key in source) {
|
|
16
|
+
const property = `${prefix}.${key}`;
|
|
17
|
+
flatKeyHelper(source[key], accumulator, property);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
exports.flatKeyHelper = flatKeyHelper;
|
|
22
|
+
//# sourceMappingURL=flat-key-helper.js.map
|
|
@@ -0,0 +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;IAC9E,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,GAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC;YACnC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;YACpC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAdD,sCAcC"}
|
package/dist/helpers/index.d.ts
CHANGED
package/dist/helpers/index.js
CHANGED
|
@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./validate-path"), exports);
|
|
18
|
+
__exportStar(require("./flat-key-helper"), exports);
|
|
18
19
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,oDAAkC"}
|
|
@@ -3,9 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.validatePath = void 0;
|
|
4
4
|
const _const_1 = require("../constants");
|
|
5
5
|
function validatePath(key) {
|
|
6
|
-
const normalizedKey = key
|
|
7
|
-
.replace(/\['([^']+)'\]/g, '[$1]')
|
|
8
|
-
.replace(/\["([^"]+)"\]/g, '[$1]');
|
|
6
|
+
const normalizedKey = key.replace(/\['([^']+)'\]/g, '[$1]').replace(/\["([^"]+)"\]/g, '[$1]');
|
|
9
7
|
return _const_1.VALID_PATH_REGEX.test(normalizedKey);
|
|
10
8
|
}
|
|
11
9
|
exports.validatePath = validatePath;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validate-path.js","sourceRoot":"","sources":["../../src/helpers/validate-path.ts"],"names":[],"mappings":";;;AAAA,mCAA0C;AAE1C,SAAgB,YAAY,CAAC,GAAW;IACtC,MAAM,aAAa,GAAG,GAAG
|
|
1
|
+
{"version":3,"file":"validate-path.js","sourceRoot":"","sources":["../../src/helpers/validate-path.ts"],"names":[],"mappings":";;;AAAA,mCAA0C;AAE1C,SAAgB,YAAY,CAAC,GAAW;IACtC,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC9F,OAAO,yBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AAC9C,CAAC;AAHD,oCAGC"}
|
|
@@ -3,6 +3,8 @@ export declare class PropertyAccessor {
|
|
|
3
3
|
constructor(target: any);
|
|
4
4
|
get(key: string): any;
|
|
5
5
|
set(key: string, value: any): boolean;
|
|
6
|
+
flat(): any;
|
|
6
7
|
static get(path: string, src: any): any;
|
|
7
8
|
static set(path: string, value: any, src: any): boolean;
|
|
9
|
+
static flat(target: any): any;
|
|
8
10
|
}
|
|
@@ -13,6 +13,9 @@ class PropertyAccessor {
|
|
|
13
13
|
set(key, value) {
|
|
14
14
|
return PropertyAccessor.set(key, value, this.target);
|
|
15
15
|
}
|
|
16
|
+
flat() {
|
|
17
|
+
return PropertyAccessor.flat(this.target);
|
|
18
|
+
}
|
|
16
19
|
static get(path, src) {
|
|
17
20
|
if (!src) {
|
|
18
21
|
return;
|
|
@@ -67,6 +70,11 @@ class PropertyAccessor {
|
|
|
67
70
|
}
|
|
68
71
|
return true;
|
|
69
72
|
}
|
|
73
|
+
static flat(target) {
|
|
74
|
+
const flat = {};
|
|
75
|
+
(0, _helpers_1.flatKeyHelper)(target, flat);
|
|
76
|
+
return flat;
|
|
77
|
+
}
|
|
70
78
|
}
|
|
71
79
|
exports.PropertyAccessor = PropertyAccessor;
|
|
72
80
|
//# sourceMappingURL=property-accessor.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"property-accessor.js","sourceRoot":"","sources":["../../src/library/property-accessor.ts"],"names":[],"mappings":";;;AAAA,
|
|
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;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,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;AA9ED,4CA8EC"}
|
package/package.json
CHANGED
package/test/test.js
CHANGED
|
@@ -7,15 +7,15 @@ const target = {
|
|
|
7
7
|
b: [
|
|
8
8
|
{
|
|
9
9
|
c: 'd',
|
|
10
|
-
e: 1
|
|
10
|
+
e: 1,
|
|
11
11
|
},
|
|
12
12
|
{
|
|
13
13
|
f: 'g',
|
|
14
|
-
h: 2
|
|
15
|
-
}
|
|
16
|
-
]
|
|
17
|
-
}
|
|
18
|
-
]
|
|
14
|
+
h: 2,
|
|
15
|
+
},
|
|
16
|
+
],
|
|
17
|
+
},
|
|
18
|
+
],
|
|
19
19
|
};
|
|
20
20
|
|
|
21
21
|
assert.equal(PropertyAccessor.get('a[0]b[0].c', target), 'd');
|
|
@@ -26,7 +26,7 @@ assert.equal(PropertyAccessor.set('a[0]b[5].f', 3, target), true);
|
|
|
26
26
|
assert.equal(PropertyAccessor.set('a[1]b.c.d.f', 3, target), true);
|
|
27
27
|
assert.equal(PropertyAccessor.get('a[0]b.length', target), 6);
|
|
28
28
|
|
|
29
|
-
const propertyAccessor = new PropertyAccessor({ a: [
|
|
29
|
+
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);
|