datanautics 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2025-05-02
+
+### Added
+
+Basic package implementation

package/LICENSE

@@ -0,0 +1,18 @@
+(The MIT License)
+Copyright (c) 2024 Pavlo Lazunko <pavlo@databikers.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+and associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,94 @@
+# Datanautics
+
+**Datanautics** is a lightweight key-value storage system with support for nested property access, persistent dumps to disk, and configurable autosave intervals.
+
+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.
+
+---
+
+## ✨ Features
+
+- Dot/bracket notation access (`a.b[0]['c']`)
+- Persistent JSON file storage (auto-saves at configurable intervals)
+- Configurable verbosity and custom logger
+- Simple API: `.get(key)`, `.set(key, value)`
+- Built on top of [`property-accessor`](https://npmjs.com/package/property-accessor)
+
+---
+
+## 📦 Installation
+
+```bash
+npm install datanautics
+```
+
+---
+
+## 🛠 Usage
+
+```ts
+const { Datanautics } = require('datanautics');
+
+const store = new Datanautics({
+  dumpPath: './data.json',
+  dumpInterval: 1000, // every 1 second
+  verbose: true,
+  logger: console
+});
+
+store.set('users[0].name', 'Alice');
+console.log(store.get('users[0].name')); // Output: Alice
+```
+
+---
+
+## ⚙️ Configuration Options
+
+You can pass the following options to the constructor:
+
+| Option         | Type                | Description                                          | Default                                   |
+|----------------|---------------------|------------------------------------------------------|-------------------------------------------|
+| `dumpPath`     | `string`, optional  | Path to the JSON file for persistent data storage    | `node_modules/datanautics/data/data.json` |
+| `dumpInterval` | `number`, optional  | Interval in milliseconds between auto-dumps          | `1000` (1 second)                         |
+| `verbose`      | `boolean`, optional | Log errors during reading/writing                    | `false`                                   |
+| `logger`       | `object`, optional  | Custom logger (`console`, `winston`, etc.)           | `console`                                 |
+
+---
+
+## 🔧 Methods
+
+### `set(key: string, value: any): boolean`
+
+Sets a value in the internal store using a path-based key.
+
+Returns `true` on success, `false` if the key is invalid.
+
+### `get(key: string): any`
+
+Retrieves the value at the specified path.
+
+Returns `undefined` if the path does not exist or is non-evaluable.
+
+---
+
+## 📂 Auto-Save Mechanism
+
+- A background event loop triggers a dump to `options.dumpPath` every `options.dumpInterval` ms.
+- All data is saved as a JSON file, preserving nested structures.
+- On startup, the class will attempt to read and restore previous data from the file.
+
+---
+
+## ✅ Requirements
+
+- Node.js 14+
+
+---
+
+## 📚 Dependencies
+
+- [`property-accessor`](https://npmjs.com/package/property-accessor) – Used for safe deep get/set operations
+
+---
+
+## 📄 [License](./LICENSE) MIT

package/dist/constants/default-datanautics-options.d.ts

@@ -0,0 +1,2 @@
+import { DatanauticsOptions } from '../options';
+export declare const defaultDatanauticsOptions: DatanauticsOptions;

package/dist/constants/default-datanautics-options.js

@@ -0,0 +1,36 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultDatanauticsOptions = void 0;
+const console = __importStar(require("console"));
+const path_1 = require("path");
+const default_dump_interval_1 = require("./default-dump-interval");
+exports.defaultDatanauticsOptions = {
+    dumpInterval: default_dump_interval_1.DEFAULT_DUMP_INTERVAL,
+    verbose: true,
+    logger: console,
+    dumpPath: (0, path_1.resolve)(__dirname, '../../data/data.json'),
+};
+//# sourceMappingURL=default-datanautics-options.js.map

package/dist/constants/default-datanautics-options.js.map

@@ -0,0 +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"}

package/dist/constants/default-dump-interval.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_DUMP_INTERVAL: number;

package/dist/constants/default-dump-interval.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_DUMP_INTERVAL = void 0;
+exports.DEFAULT_DUMP_INTERVAL = 1000;
+//# sourceMappingURL=default-dump-interval.js.map

package/dist/constants/default-dump-interval.js.map

@@ -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"}

package/dist/constants/dump-event.d.ts

@@ -0,0 +1 @@
+export declare const DUMP_EVENT: string;

package/dist/constants/dump-event.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DUMP_EVENT = void 0;
+exports.DUMP_EVENT = 'dump';
+//# sourceMappingURL=dump-event.js.map

package/dist/constants/dump-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dump-event.js","sourceRoot":"","sources":["../../src/constants/dump-event.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAW,MAAM,CAAC"}

package/dist/constants/index.d.ts

@@ -0,0 +1,3 @@
+export * from './default-dump-interval';
+export * from './dump-event';
+export * from './default-datanautics-options';

package/dist/constants/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./default-dump-interval"), exports);
+__exportStar(require("./dump-event"), exports);
+__exportStar(require("./default-datanautics-options"), exports);
+//# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,+CAA6B;AAC7B,gEAA8C"}

package/dist/datanautics.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { DatanauticsOptions } from './options';
+export declare class Datanautics {
+    protected options: DatanauticsOptions;
+    protected data: Record<string, any>;
+    protected eventEmitter: EventEmitter;
+    constructor(options?: DatanauticsOptions);
+    protected createDump(): void;
+    set(key: string, value: any): boolean;
+    get(key: string): any;
+}

package/dist/datanautics.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Datanautics = void 0;
+const fs_1 = require("fs");
+const events_1 = require("events");
+const property_accessor_1 = require("property-accessor");
+const _const_1 = require("./constants");
+class Datanautics {
+    options;
+    data;
+    eventEmitter;
+    constructor(options) {
+        this.options = Object.assign(_const_1.defaultDatanauticsOptions, options || {});
+        this.data = {};
+        this.eventEmitter = new events_1.EventEmitter();
+        this.eventEmitter = new events_1.EventEmitter();
+        if ((0, fs_1.existsSync)(this.options.dumpPath)) {
+            try {
+                this.data = JSON.parse((0, fs_1.readFileSync)(this.options.dumpPath).toString());
+            }
+            catch (e) {
+                if (this.options.verbose) {
+                    this.options.logger.error(e);
+                }
+            }
+        }
+        this.eventEmitter.on(_const_1.DUMP_EVENT, () => {
+            this.createDump();
+            setTimeout(() => {
+                this.eventEmitter.emit(_const_1.DUMP_EVENT);
+            }, this.options.dumpInterval);
+        });
+        this.eventEmitter.emit(_const_1.DUMP_EVENT);
+    }
+    createDump() {
+        try {
+            (0, fs_1.writeFileSync)(this.options.dumpPath, JSON.stringify(this.data, null, 2), 'utf8');
+        }
+        catch (e) {
+            if (this.options.verbose) {
+                this.options.logger.error(e);
+            }
+        }
+    }
+    set(key, value) {
+        return property_accessor_1.PropertyAccessor.set(key, value, this.data);
+    }
+    get(key) {
+        return property_accessor_1.PropertyAccessor.get(key, this.data);
+    }
+}
+exports.Datanautics = Datanautics;
+//# sourceMappingURL=datanautics.js.map

package/dist/datanautics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datanautics.js","sourceRoot":"","sources":["../src/datanautics.ts"],"names":[],"mappings":";;;AAAA,2BAA6D;AAC7D,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,IAAA,eAAU,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC;gBACH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;YACzE,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACzB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC/B,CAAC;YACH,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,IAAA,kBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnF,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;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;AA7CD,kCA6CC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { DatanauticsOptions } from './options';
+export { Datanautics } from './datanautics';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Datanautics = void 0;
+var datanautics_1 = require("./datanautics");
+Object.defineProperty(exports, "Datanautics", { enumerable: true, get: function () { return datanautics_1.Datanautics; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,6CAA4C;AAAnC,0GAAA,WAAW,OAAA"}

package/dist/options/datanautics-options.d.ts

@@ -0,0 +1,11 @@
+interface Logger {
+    log(...args: any[]): void;
+    error(...args: any[]): void;
+}
+export type DatanauticsOptions = {
+    dumpPath: string;
+    dumpInterval?: number;
+    verbose?: boolean;
+    logger?: Logger;
+};
+export {};

package/dist/options/datanautics-options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=datanautics-options.js.map

package/dist/options/datanautics-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datanautics-options.js","sourceRoot":"","sources":["../../src/options/datanautics-options.ts"],"names":[],"mappings":""}

package/dist/options/index.d.ts

@@ -0,0 +1 @@
+export * from './datanautics-options';

package/dist/options/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./datanautics-options"), exports);
+//# sourceMappingURL=index.js.map

package/dist/options/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/options/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "datanautics",
+  "version": "1.0.0",
+  "description": "",
+  "keywords": [
+    "data store",
+    "local db",
+    "nested data",
+    "evaluate path"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "Pavlo Lazunko",
+  "license": "MIT",
+  "scripts": {
+    "build": "rm -rf dist && tsc && tsc-alias && eslint src/**/*.ts{,x}",
+    "eslint": "eslint src --ext .ts",
+    "prettier-check": "prettier . --check",
+    "prettier-write": "prettier . --write",
+    "test": "node test/test.js",
+    "runtime": "node dist/index.js"
+  },
+  "dependencies": {
+    "property-accessor": "^2.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "20.10.6",
+    "@types/prettier": "2.6.0",
+    "@types/uuid": "10.0.0",
+    "@typescript-eslint/eslint-plugin": "6.17.0",
+    "@typescript-eslint/parser": "6.17.0",
+    "eslint": "8.47.0",
+    "husky": "3.0.0",
+    "prettier": "3.3.3",
+    "prettier-plugin-multiline-arrays": "3.0.6",
+    "ts-node": "10.9.2",
+    "tsc-alias": "1.8.10",
+    "typescript": "5.3.3"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run eslint"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Paul-Lazunko/datanautics.git"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}

package/test/test.js

@@ -0,0 +1,23 @@
+const assert = require('assert');
+const { resolve } = require('path');
+const { readFileSync, unlinkSync } = require('fs');
+
+const { Datanautics } = require('../dist');
+const { setTimeout } = require('timers');
+
+const dumpPath = resolve(__dirname, './data.json');
+const data = { user: { firstname: 'John', lastname: 'Doe' }, score: [27] };
+
+const db = new Datanautics({ dumpPath, dumpInterval: 0 });
+
+assert.equal(db.set('user.firstname', data.user.firstname), true);
+assert.equal(db.set('user.lastname', data.user.lastname), true);
+assert.equal(db.set('score[0]', data.score[0]), true);
+
+setTimeout(() => {
+  const storedData = readFileSync(dumpPath).toString();
+  assert.equal(storedData, JSON.stringify(data, null, 2));
+  unlinkSync(dumpPath);
+  console.log('tests passed');
+  process.exit(0)
+});