datanautics 2.2.9 → 4.0.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 +19 -0
- package/README.md +3 -8
- package/dist/constants/default-datanautics-options.js +2 -2
- package/dist/constants/default-datanautics-options.js.map +1 -1
- package/dist/constants/dump-event.d.ts +1 -2
- package/dist/constants/dump-event.js +2 -3
- package/dist/constants/dump-event.js.map +1 -1
- package/dist/datanautics.d.ts +1 -2
- package/dist/datanautics.js +19 -24
- package/dist/datanautics.js.map +1 -1
- package/dist/options/datanautics-options.d.ts +2 -2
- package/package.json +1 -1
- package/test/data.txt +3 -0
- package/test/test.js +13 -11
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,25 @@ 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
|
+
## [4.0.0] - 2025-06-25 (**Breaking changes!**)
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Returned Auto-Save Mechanism as more efficient;
|
|
13
|
+
- Added **writer** (boolean, default true) to options, this property enables auto-syncs
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## [3.0.0] - 2025-06-20 (**Breaking changes!**)
|
|
18
|
+
|
|
19
|
+
### Removed
|
|
20
|
+
|
|
21
|
+
- Replaced Auto-Save Mechanism with Event Based Save Mechanism (triggers once you change data);
|
|
22
|
+
- Removed **mode** and **dumpInterval** from options
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
|
|
8
27
|
## [2.2.9] - 2025-06-20
|
|
9
28
|
|
|
10
29
|
### Added
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Datanautics
|
|
2
2
|
|
|
3
|
-
**Datanautics** is a lightweight key-value storage system with support for nested property access
|
|
3
|
+
**Datanautics** is a lightweight key-value storage system with support for nested property access and persistent dumps to disk.
|
|
4
4
|
|
|
5
5
|
It uses string-based paths (like `user[0].profile.name`) to **get/set deeply nested data**, and periodically saves the current state to a JSON file for durability.
|
|
6
6
|
|
|
@@ -31,7 +31,6 @@ const { Datanautics } = require('datanautics');
|
|
|
31
31
|
|
|
32
32
|
const store = new Datanautics({
|
|
33
33
|
dumpPath: './data.json',
|
|
34
|
-
dumpInterval: 1000, // every 1 second
|
|
35
34
|
verbose: true,
|
|
36
35
|
logger: console,
|
|
37
36
|
});
|
|
@@ -49,10 +48,8 @@ You can pass the following options to the constructor:
|
|
|
49
48
|
| Option | Type | Description | Default |
|
|
50
49
|
|----------------|---------------------|---------------------------------------------------|------------------------------------------|
|
|
51
50
|
| `dumpPath` | `string`, optional | Path to the JSON file for persistent data storage | `node_modules/datanautics/data/data.json`|
|
|
52
|
-
| `dumpInterval` | `number`, optional | Interval in milliseconds between auto-dumps | `1000` (1 second) |
|
|
53
51
|
| `verbose` | `boolean`, optional | Log errors during reading/writing | `false` |
|
|
54
52
|
| `logger` | `object`, optional | Custom logger (`console`, `winston`, etc.) | `console` |
|
|
55
|
-
| `mode` | `string`, optional | Parameter that define behavior (reader or writer) | `writer` |
|
|
56
53
|
---
|
|
57
54
|
|
|
58
55
|
## Methods
|
|
@@ -75,11 +72,9 @@ Explicitly creates dump
|
|
|
75
72
|
|
|
76
73
|
---
|
|
77
74
|
|
|
78
|
-
## Auto-Save Mechanism
|
|
75
|
+
## Event based Auto-Save Mechanism
|
|
79
76
|
|
|
80
|
-
-
|
|
81
|
-
- All data is saved as a JSON file, preserving nested structures.
|
|
82
|
-
- On startup, the class will attempt to read and restore previous data from the file.
|
|
77
|
+
- Settings data triggers a dump to `options.dumpPath`;
|
|
83
78
|
|
|
84
79
|
---
|
|
85
80
|
|
|
@@ -31,7 +31,7 @@ exports.defaultDatanauticsOptions = {
|
|
|
31
31
|
dumpInterval: default_dump_interval_1.DEFAULT_DUMP_INTERVAL,
|
|
32
32
|
verbose: true,
|
|
33
33
|
logger: console,
|
|
34
|
-
dumpPath: (0, path_1.resolve)(__dirname, '../../data/data
|
|
35
|
-
|
|
34
|
+
dumpPath: (0, path_1.resolve)(__dirname, '../../data/data'),
|
|
35
|
+
writer: true
|
|
36
36
|
};
|
|
37
37
|
//# sourceMappingURL=default-datanautics-options.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"default-datanautics-options.js","sourceRoot":"","sources":["../../src/constants/default-datanautics-options.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AACnC,+BAA+B;AAG/B,mEAAgE;AAEnD,QAAA,yBAAyB,GAAuB;IAC3D,YAAY,EAAE,6CAAqB;IACnC,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAA,cAAO,EAAC,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"default-datanautics-options.js","sourceRoot":"","sources":["../../src/constants/default-datanautics-options.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AACnC,+BAA+B;AAG/B,mEAAgE;AAEnD,QAAA,yBAAyB,GAAuB;IAC3D,YAAY,EAAE,6CAAqB;IACnC,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAA,cAAO,EAAC,SAAS,EAAE,iBAAiB,CAAC;IAC/C,MAAM,EAAE,IAAI;CACb,CAAC"}
|
|
@@ -1,2 +1 @@
|
|
|
1
|
-
export declare const
|
|
2
|
-
export declare const READ_EVENT: string;
|
|
1
|
+
export declare const DUMP_EVENT: string;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.
|
|
5
|
-
exports.READ_EVENT = 'read';
|
|
3
|
+
exports.DUMP_EVENT = void 0;
|
|
4
|
+
exports.DUMP_EVENT = 'dump';
|
|
6
5
|
//# sourceMappingURL=dump-event.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dump-event.js","sourceRoot":"","sources":["../../src/constants/dump-event.ts"],"names":[],"mappings":";;;AAAa,QAAA,
|
|
1
|
+
{"version":3,"file":"dump-event.js","sourceRoot":"","sources":["../../src/constants/dump-event.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAW,MAAM,CAAC"}
|
package/dist/datanautics.d.ts
CHANGED
|
@@ -4,8 +4,7 @@ import { DatanauticsOptions } from './options';
|
|
|
4
4
|
export declare class Datanautics {
|
|
5
5
|
protected options: DatanauticsOptions;
|
|
6
6
|
protected data: Record<string, any>;
|
|
7
|
-
protected
|
|
8
|
-
protected readEventEmitter: EventEmitter;
|
|
7
|
+
protected eventEmitter: EventEmitter;
|
|
9
8
|
constructor(options?: DatanauticsOptions);
|
|
10
9
|
store(): void;
|
|
11
10
|
protected createDump(): void;
|
package/dist/datanautics.js
CHANGED
|
@@ -8,35 +8,30 @@ const _const_1 = require("./constants");
|
|
|
8
8
|
class Datanautics {
|
|
9
9
|
options;
|
|
10
10
|
data;
|
|
11
|
-
|
|
12
|
-
readEventEmitter;
|
|
11
|
+
eventEmitter;
|
|
13
12
|
constructor(options) {
|
|
14
13
|
this.options = { ..._const_1.defaultDatanauticsOptions, ...(options || {}) };
|
|
15
14
|
this.data = {};
|
|
16
|
-
this.
|
|
17
|
-
this.readEventEmitter = new events_1.EventEmitter();
|
|
15
|
+
this.eventEmitter = new events_1.EventEmitter();
|
|
18
16
|
if ((0, fs_1.existsSync)(this.options.dumpPath)) {
|
|
19
17
|
this.useDump();
|
|
20
18
|
}
|
|
21
|
-
|
|
22
|
-
this.
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
this.
|
|
36
|
-
|
|
37
|
-
case 'writer':
|
|
38
|
-
this.writeEventEmitter.emit(_const_1.WRITE_EVENT);
|
|
39
|
-
break;
|
|
19
|
+
else {
|
|
20
|
+
(0, fs_1.writeFileSync)(this.options.dumpPath, '', 'utf8');
|
|
21
|
+
}
|
|
22
|
+
if (options.writer) {
|
|
23
|
+
this.eventEmitter.on(_const_1.DUMP_EVENT, async () => {
|
|
24
|
+
this.createDump();
|
|
25
|
+
setTimeout(() => {
|
|
26
|
+
this.eventEmitter.emit(_const_1.DUMP_EVENT);
|
|
27
|
+
}, this.options.dumpInterval);
|
|
28
|
+
});
|
|
29
|
+
this.eventEmitter.emit(_const_1.DUMP_EVENT);
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
(0, fs_1.watchFile)(this.options.dumpPath, () => {
|
|
33
|
+
this.useDump();
|
|
34
|
+
});
|
|
40
35
|
}
|
|
41
36
|
}
|
|
42
37
|
store() {
|
|
@@ -64,7 +59,7 @@ class Datanautics {
|
|
|
64
59
|
const data = (0, fs_1.readFileSync)(this.options.dumpPath).toString('utf8');
|
|
65
60
|
const lines = data.split('\n');
|
|
66
61
|
for (const line of lines) {
|
|
67
|
-
const [k, v
|
|
62
|
+
const [k, v] = line.split(' ');
|
|
68
63
|
const key = k.trim();
|
|
69
64
|
if (v !== undefined) {
|
|
70
65
|
let value = v.trim();
|
package/dist/datanautics.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AACtC,
|
|
1
|
+
{"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AACtC,2BAAwE;AACxE,yDAAqD;AAErD,mCAA+D;AAG/D,MAAa,WAAW;IACZ,OAAO,CAAqB;IAC5B,IAAI,CAAsB;IAC1B,YAAY,CAAe;IAErC,YAAY,OAA4B;QACtC,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,kCAAyB,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,IAAA,eAAU,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,IAAA,kBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAU,EAAE,KAAK,IAAI,EAAE;gBAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,UAAU,CAAC,GAAG,EAAE;oBACd,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAU,CAAC,CAAC;gBACrC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAU,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,IAAA,cAAS,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACpC,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAES,UAAU;QAClB,IAAI,CAAC;YACH,MAAM,IAAI,GAA2B,oCAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtE,MAAM,IAAI,GAAU,EAAE,CAAC;YACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,KAAK,GAAG,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YACD,IAAA,kBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;QAC/D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBACzB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAES,OAAO;QACf,MAAM,IAAI,GAAG,IAAA,iBAAY,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClE,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpB,IAAI,KAAK,GAA8B,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChD,IAAI,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrC,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC7E,CAAC;qBAAM,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBACtC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;gBACD,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAU;QAChC,OAAO,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAEM,GAAG,CAAC,GAAW;QACpB,OAAO,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;CACF;AA5ED,kCA4EC"}
|
|
@@ -3,10 +3,10 @@ interface Logger {
|
|
|
3
3
|
error(...args: any[]): void;
|
|
4
4
|
}
|
|
5
5
|
export type DatanauticsOptions = {
|
|
6
|
-
dumpPath
|
|
6
|
+
dumpPath?: string;
|
|
7
7
|
dumpInterval?: number;
|
|
8
8
|
verbose?: boolean;
|
|
9
9
|
logger?: Logger;
|
|
10
|
-
|
|
10
|
+
writer?: boolean;
|
|
11
11
|
};
|
|
12
12
|
export {};
|
package/package.json
CHANGED
package/test/data.txt
ADDED
package/test/test.js
CHANGED
|
@@ -8,20 +8,22 @@ const { setTimeout } = require('timers');
|
|
|
8
8
|
const dumpPath = resolve(__dirname, './data.txt');
|
|
9
9
|
const data = { user: { firstname: 'John', lastname: 'Doe' }, score: [27] };
|
|
10
10
|
|
|
11
|
-
const
|
|
11
|
+
const writer = new Datanautics({ dumpPath, writer: true });
|
|
12
|
+
const reader = new Datanautics({ dumpPath, writer: false });
|
|
12
13
|
|
|
13
|
-
assert.equal(
|
|
14
|
-
assert.equal(
|
|
15
|
-
assert.equal(
|
|
14
|
+
assert.equal(writer.set('user.firstname', data.user.firstname), true);
|
|
15
|
+
assert.equal(writer.set('user.lastname', data.user.lastname), true);
|
|
16
|
+
assert.equal(writer.set('score[0]', data.score[0]), true);
|
|
16
17
|
|
|
17
|
-
assert.equal(
|
|
18
|
-
assert.equal(
|
|
19
|
-
assert.equal(
|
|
18
|
+
assert.equal(writer.get('user.firstname'), data.user.firstname);
|
|
19
|
+
assert.equal(writer.get('user.lastname'), data.user.lastname);
|
|
20
|
+
assert.equal(writer.get('score[0]'), data.score[0]);
|
|
20
21
|
|
|
21
22
|
setTimeout(() => {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
|
|
24
|
+
assert.equal(reader.get('user.firstname'), data.user.firstname);
|
|
25
|
+
assert.equal(reader.get('user.lastname'), data.user.lastname);
|
|
26
|
+
assert.equal(reader.get('score[0]'), data.score[0]);
|
|
25
27
|
console.log('tests passed');
|
|
26
28
|
process.exit(0);
|
|
27
|
-
},
|
|
29
|
+
}, 2000);
|