datanautics 2.2.9 → 3.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 +10 -0
- package/README.md +3 -8
- package/dist/constants/default-datanautics-options.js +0 -3
- package/dist/constants/default-datanautics-options.js.map +1 -1
- package/dist/constants/index.d.ts +0 -2
- package/dist/constants/index.js +0 -2
- package/dist/constants/index.js.map +1 -1
- package/dist/datanautics.d.ts +2 -6
- package/dist/datanautics.js +4 -24
- package/dist/datanautics.js.map +1 -1
- package/dist/options/datanautics-options.d.ts +0 -2
- package/package.json +1 -1
- package/test/test.js +1 -1
- package/dist/constants/default-dump-interval.d.ts +0 -1
- package/dist/constants/default-dump-interval.js +0 -5
- package/dist/constants/default-dump-interval.js.map +0 -1
- package/dist/constants/dump-event.d.ts +0 -2
- package/dist/constants/dump-event.js +0 -6
- package/dist/constants/dump-event.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,16 @@ 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
|
+
## [3.0.0] - 2025-06-20 (**Breaking changes!**)
|
|
9
|
+
|
|
10
|
+
### Removed
|
|
11
|
+
|
|
12
|
+
- Replaced Auto-Save Mechanism with Event Based Save Mechanism (triggers once you change data);
|
|
13
|
+
- Removed **mode** and **dumpInterval** from options
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
|
|
8
18
|
## [2.2.9] - 2025-06-20
|
|
9
19
|
|
|
10
20
|
### 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
|
|
|
@@ -26,12 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
26
26
|
exports.defaultDatanauticsOptions = void 0;
|
|
27
27
|
const console = __importStar(require("console"));
|
|
28
28
|
const path_1 = require("path");
|
|
29
|
-
const default_dump_interval_1 = require("./default-dump-interval");
|
|
30
29
|
exports.defaultDatanauticsOptions = {
|
|
31
|
-
dumpInterval: default_dump_interval_1.DEFAULT_DUMP_INTERVAL,
|
|
32
30
|
verbose: true,
|
|
33
31
|
logger: console,
|
|
34
32
|
dumpPath: (0, path_1.resolve)(__dirname, '../../data/data.txt'),
|
|
35
|
-
mode: 'writer'
|
|
36
33
|
};
|
|
37
34
|
//# 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;
|
|
1
|
+
{"version":3,"file":"default-datanautics-options.js","sourceRoot":"","sources":["../../src/constants/default-datanautics-options.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AACnC,+BAA+B;AAIlB,QAAA,yBAAyB,GAAuB;IAC3D,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,IAAA,cAAO,EAAC,SAAS,EAAE,qBAAqB,CAAC;CACpD,CAAC"}
|
package/dist/constants/index.js
CHANGED
|
@@ -14,7 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./default-dump-interval"), exports);
|
|
18
|
-
__exportStar(require("./dump-event"), exports);
|
|
19
17
|
__exportStar(require("./default-datanautics-options"), exports);
|
|
20
18
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C"}
|
package/dist/datanautics.d.ts
CHANGED
|
@@ -1,14 +1,10 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
import { EventEmitter } from 'events';
|
|
3
1
|
import { DatanauticsOptions } from './options';
|
|
4
2
|
export declare class Datanautics {
|
|
5
3
|
protected options: DatanauticsOptions;
|
|
6
4
|
protected data: Record<string, any>;
|
|
7
|
-
protected writeEventEmitter: EventEmitter;
|
|
8
|
-
protected readEventEmitter: EventEmitter;
|
|
9
5
|
constructor(options?: DatanauticsOptions);
|
|
10
|
-
store():
|
|
11
|
-
protected createDump():
|
|
6
|
+
store(): boolean;
|
|
7
|
+
protected createDump(): boolean;
|
|
12
8
|
protected useDump(): void;
|
|
13
9
|
set(key: string, value: any): boolean;
|
|
14
10
|
get(key: string): any;
|
package/dist/datanautics.js
CHANGED
|
@@ -1,43 +1,21 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.Datanautics = void 0;
|
|
4
|
-
const events_1 = require("events");
|
|
5
4
|
const fs_1 = require("fs");
|
|
6
5
|
const property_accessor_1 = require("property-accessor");
|
|
7
6
|
const _const_1 = require("./constants");
|
|
8
7
|
class Datanautics {
|
|
9
8
|
options;
|
|
10
9
|
data;
|
|
11
|
-
writeEventEmitter;
|
|
12
|
-
readEventEmitter;
|
|
13
10
|
constructor(options) {
|
|
14
11
|
this.options = { ..._const_1.defaultDatanauticsOptions, ...(options || {}) };
|
|
15
12
|
this.data = {};
|
|
16
|
-
this.writeEventEmitter = new events_1.EventEmitter();
|
|
17
|
-
this.readEventEmitter = new events_1.EventEmitter();
|
|
18
13
|
if ((0, fs_1.existsSync)(this.options.dumpPath)) {
|
|
19
14
|
this.useDump();
|
|
20
15
|
}
|
|
21
|
-
this.
|
|
22
|
-
this.createDump();
|
|
23
|
-
setTimeout(() => {
|
|
24
|
-
this.writeEventEmitter.emit(_const_1.WRITE_EVENT);
|
|
25
|
-
}, this.options.dumpInterval);
|
|
26
|
-
});
|
|
27
|
-
this.readEventEmitter.on(_const_1.READ_EVENT, async () => {
|
|
16
|
+
(0, fs_1.watchFile)(this.options.dumpPath, () => {
|
|
28
17
|
this.useDump();
|
|
29
|
-
setTimeout(() => {
|
|
30
|
-
this.readEventEmitter.emit(_const_1.READ_EVENT);
|
|
31
|
-
}, this.options.dumpInterval);
|
|
32
18
|
});
|
|
33
|
-
switch (options.mode) {
|
|
34
|
-
case 'reader':
|
|
35
|
-
this.readEventEmitter.emit(_const_1.READ_EVENT);
|
|
36
|
-
break;
|
|
37
|
-
case 'writer':
|
|
38
|
-
this.writeEventEmitter.emit(_const_1.WRITE_EVENT);
|
|
39
|
-
break;
|
|
40
|
-
}
|
|
41
19
|
}
|
|
42
20
|
store() {
|
|
43
21
|
return this.createDump();
|
|
@@ -53,11 +31,13 @@ class Datanautics {
|
|
|
53
31
|
}
|
|
54
32
|
}
|
|
55
33
|
(0, fs_1.writeFileSync)(this.options.dumpPath, data.join('\n'), 'utf8');
|
|
34
|
+
return true;
|
|
56
35
|
}
|
|
57
36
|
catch (e) {
|
|
58
37
|
if (this.options.verbose) {
|
|
59
38
|
this.options.logger.error(e);
|
|
60
39
|
}
|
|
40
|
+
return false;
|
|
61
41
|
}
|
|
62
42
|
}
|
|
63
43
|
useDump() {
|
|
@@ -79,7 +59,7 @@ class Datanautics {
|
|
|
79
59
|
}
|
|
80
60
|
}
|
|
81
61
|
set(key, value) {
|
|
82
|
-
return property_accessor_1.PropertyAccessor.set(key, value, this.data);
|
|
62
|
+
return property_accessor_1.PropertyAccessor.set(key, value, this.data) && this.createDump();
|
|
83
63
|
}
|
|
84
64
|
get(key) {
|
|
85
65
|
return property_accessor_1.PropertyAccessor.get(key, this.data);
|
package/dist/datanautics.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,2BAAwE;AACxE,yDAAqD;AAErD,mCAAmD;AAGnD,MAAa,WAAW;IACZ,OAAO,CAAqB;IAC5B,IAAI,CAAsB;IAEpC,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,IAAA,eAAU,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;QACD,IAAA,cAAS,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC,CAAA;IACJ,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,CAAC;YAC9D,OAAO,IAAI,CAAC;QACd,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;YACD,OAAO,KAAK,CAAC;QACf,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,CACJ,CAAC,EACD,CAAC,EACF,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,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,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1E,CAAC;IAEM,GAAG,CAAC,GAAW;QACpB,OAAO,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;CACF;AAnED,kCAmEC"}
|
package/package.json
CHANGED
package/test/test.js
CHANGED
|
@@ -8,7 +8,7 @@ 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 db = new Datanautics({ dumpPath
|
|
11
|
+
const db = new Datanautics({ dumpPath });
|
|
12
12
|
|
|
13
13
|
assert.equal(db.set('user.firstname', data.user.firstname), true);
|
|
14
14
|
assert.equal(db.set('user.lastname', data.user.lastname), true);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const DEFAULT_DUMP_INTERVAL: number;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"default-dump-interval.js","sourceRoot":"","sources":["../../src/constants/default-dump-interval.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAW,IAAI,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"dump-event.js","sourceRoot":"","sources":["../../src/constants/dump-event.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAW,OAAO,CAAC;AAC9B,QAAA,UAAU,GAAW,MAAM,CAAC"}
|