datanautics 1.1.1 → 2.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 CHANGED
@@ -5,12 +5,27 @@ 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.0.0] - 2025-05-17 (**Breaking changes!**)
9
+
10
+ ### Added
11
+ - Instead of background storing entire object store each key-value eventually
12
+ - Replaced dumpInterval from options
13
+
14
+ ---
15
+ ## [1.1.2] - 2025-05-17
16
+
17
+ ### Fixed
18
+ - Non-blocking storing
19
+
20
+ ---
21
+
8
22
  ## [1.1.1] - 2025-05-17
9
23
 
10
24
  ### Fixed
11
25
  - Replaced fs usage with child_process
12
26
 
13
27
  ---
28
+
14
29
  ## [1.1.0] - 2025-05-17
15
30
 
16
31
  ### Fixed
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Datanautics
2
2
 
3
- **Datanautics** is a lightweight key-value storage system with support for nested property access, persistent dumps to disk, and configurable autosave intervals.
3
+ **Datanautics** is a lightweight key-value storage system with support for nested property access and persistent dumps to disk.
4
4
 
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.
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 files for durability.
6
6
 
7
7
  ---
8
8
 
@@ -30,8 +30,7 @@ npm install datanautics
30
30
  const { Datanautics } = require('datanautics');
31
31
 
32
32
  const store = new Datanautics({
33
- dumpPath: './data.json',
34
- dumpInterval: 1000, // every 1 second
33
+ dumpPath: './data',
35
34
  verbose: true,
36
35
  logger: console
37
36
  });
@@ -49,7 +48,6 @@ 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
53
 
@@ -71,14 +69,6 @@ Returns `undefined` if the path does not exist or is non-evaluable.
71
69
 
72
70
  ---
73
71
 
74
- ## 📂 Auto-Save Mechanism
75
-
76
- - A background event loop triggers a dump to `options.dumpPath` every `options.dumpInterval` ms.
77
- - All data is saved as a JSON file, preserving nested structures.
78
- - On startup, the class will attempt to read and restore previous data from the file.
79
-
80
- ---
81
-
82
72
  ## ✅ Requirements
83
73
 
84
74
  - Node.js 14+
@@ -26,9 +26,7 @@ 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.json'),
@@ -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,sBAAsB,CAAC;CACrD,CAAC"}
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,sBAAsB,CAAC;CACrD,CAAC"}
@@ -1,3 +1,2 @@
1
- export * from './default-dump-interval';
2
1
  export * from './dump-event';
3
2
  export * from './default-datanautics-options';
@@ -14,7 +14,6 @@ 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
17
  __exportStar(require("./dump-event"), exports);
19
18
  __exportStar(require("./default-datanautics-options"), exports);
20
19
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,+CAA6B;AAC7B,gEAA8C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,gEAA8C"}
@@ -1,12 +1,9 @@
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 eventEmitter: EventEmitter;
8
5
  constructor(options?: DatanauticsOptions);
9
- protected createDump(): void;
6
+ protected store(key: string): void;
10
7
  protected useDump(): void;
11
8
  set(key: string, value: any): boolean;
12
9
  get(key: string): any;
@@ -3,18 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Datanautics = void 0;
4
4
  const fs_1 = require("fs");
5
5
  const child_process_1 = require("child_process");
6
- const events_1 = require("events");
7
6
  const property_accessor_1 = require("property-accessor");
8
7
  const _const_1 = require("./constants");
9
8
  class Datanautics {
10
9
  options;
11
10
  data;
12
- eventEmitter;
13
11
  constructor(options) {
14
12
  this.options = Object.assign(_const_1.defaultDatanauticsOptions, options || {});
15
13
  this.data = {};
16
- this.eventEmitter = new events_1.EventEmitter();
17
- this.eventEmitter = new events_1.EventEmitter();
18
14
  if (!(0, fs_1.existsSync)(this.options.dumpPath)) {
19
15
  (0, fs_1.mkdirSync)(this.options.dumpPath, { recursive: true });
20
16
  }
@@ -26,44 +22,36 @@ class Datanautics {
26
22
  this.options.logger.error(e);
27
23
  }
28
24
  }
29
- this.eventEmitter.on(_const_1.DUMP_EVENT, () => {
30
- this.createDump();
31
- setTimeout(() => {
32
- this.eventEmitter.emit(_const_1.DUMP_EVENT);
33
- }, this.options.dumpInterval);
34
- });
35
- this.eventEmitter.emit(_const_1.DUMP_EVENT);
36
25
  }
37
- createDump() {
38
- try {
39
- const flat = property_accessor_1.PropertyAccessor.flat(this.data);
40
- for (const key in flat) {
41
- const value = property_accessor_1.PropertyAccessor.get(key, this.data);
42
- if (value !== undefined) {
43
- (0, child_process_1.exec)(`echo ${property_accessor_1.PropertyAccessor.get(key, this.data).toString()} > ${this.options.dumpPath}/${key}`);
44
- }
45
- }
46
- }
47
- catch (e) {
48
- if (this.options.verbose) {
49
- this.options.logger.error(e);
50
- }
26
+ store(key) {
27
+ const value = property_accessor_1.PropertyAccessor.get(key, this.data);
28
+ if (value !== undefined) {
29
+ setTimeout(() => {
30
+ (0, child_process_1.exec)(`echo ${value.toString()} > ${this.options.dumpPath}/${key}`, () => { });
31
+ }, 0);
51
32
  }
52
33
  }
53
34
  useDump() {
54
35
  const files = (0, fs_1.readdirSync)(this.options.dumpPath);
55
36
  for (const file of files) {
56
37
  if (file !== '.gitkeep') {
57
- let value = (0, fs_1.readFileSync)(`${this.options.dumpPath}/${file}`).toString();
38
+ let value = (0, fs_1.readFileSync)(`${this.options.dumpPath}/${file}`).toString().replace(/\n/g, '');
58
39
  if (/^[+-]?\d+(\.\d+)?$/.test(value)) {
59
40
  value = /^[+-]?\d+$/.test(value) ? parseInt(value, 10) : parseFloat(value);
60
41
  }
42
+ else if (/^false|true$/.test(value)) {
43
+ value = /^true$/.test(value);
44
+ }
61
45
  property_accessor_1.PropertyAccessor.set(file, value, this.data);
62
46
  }
63
47
  }
64
48
  }
65
49
  set(key, value) {
66
- return property_accessor_1.PropertyAccessor.set(key, value, this.data);
50
+ const set = property_accessor_1.PropertyAccessor.set(key, value, this.data);
51
+ if (set) {
52
+ this.store(key);
53
+ }
54
+ return set;
67
55
  }
68
56
  get(key) {
69
57
  return property_accessor_1.PropertyAccessor.get(key, this.data);
@@ -1 +1 @@
1
- {"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,2BAAsE;AACtE,iDAAoC;AACpC,mCAAsC;AACtC,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,MAAM,CAAC,MAAM,CAAC,kCAAyB,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,IAAA,cAAS,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,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;QACD,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAU,EAAE,GAAG,EAAE;YACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAU,CAAC,CAAC;YACrC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAU,CAAC,CAAC;IACrC,CAAC;IAES,UAAU;QAClB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,oCAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,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,IAAA,oBAAI,EAAC,QAAQ,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,GAAG,EAAE,CAAC,CAAA;gBACnG,CAAC;YACH,CAAC;QACH,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,KAAK,GAAa,IAAA,gBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;gBACxB,IAAI,KAAK,GAAoB,IAAA,iBAAY,EAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACzF,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;gBACD,oCAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,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;AAjED,kCAiEC"}
1
+ {"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,2BAAsE;AACtE,iDAAoC;AACpC,yDAAqD;AAErD,mCAAmD;AAGnD,MAAa,WAAW;IACZ,OAAO,CAAqB;IAC5B,IAAI,CAAsB;IAEpC,YAAY,OAA4B;QACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,kCAAyB,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,IAAA,cAAS,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,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,KAAK,CAAC,GAAW;QACzB,MAAM,KAAK,GAAG,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,UAAU,CAAC,GAAG,EAAE;gBACd,IAAA,oBAAI,EAAC,QAAQ,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;YAC9E,CAAC,EAAE,CAAC,CAAC,CAAA;QACP,CAAC;IACH,CAAC;IAES,OAAO;QACf,MAAM,KAAK,GAAa,IAAA,gBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;gBACxB,IAAI,KAAK,GAA8B,IAAA,iBAAY,EAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACtH,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,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAU;QAChC,MAAM,GAAG,GAAI,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,GAAG,CAAC,GAAW;QACpB,OAAO,oCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;CACF;AAtDD,kCAsDC"}
@@ -4,7 +4,6 @@ interface Logger {
4
4
  }
5
5
  export type DatanauticsOptions = {
6
6
  dumpPath: string;
7
- dumpInterval?: number;
8
7
  verbose?: boolean;
9
8
  logger?: Logger;
10
9
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "datanautics",
3
- "version": "1.1.1",
3
+ "version": "2.0.0",
4
4
  "description": "",
5
5
  "keywords": [
6
6
  "data store",
@@ -1 +0,0 @@
1
- export declare const DEFAULT_DUMP_INTERVAL: number;
@@ -1,5 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DEFAULT_DUMP_INTERVAL = void 0;
4
- exports.DEFAULT_DUMP_INTERVAL = 1000;
5
- //# sourceMappingURL=default-dump-interval.js.map
@@ -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"}