dex-jstore 1.1.10

package/LICENCE

@@ -0,0 +1,8 @@
+
+MIT © Lavender Incognito
+
+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/lib/index.d.ts

@@ -0,0 +1,50 @@
+import type { FilterFn, JstoreEventName, JstoreListener, JsonObject, JsonValue, LoadOptions, MapFn, Result, Transaction, Validator } from "./types.js";
+export declare class Jstore {
+    #private;
+    constructor(fp: string, options?: LoadOptions);
+    get filePath(): string;
+    close(): void;
+    reload(): void;
+    all(): JsonObject;
+    clear(): void;
+    get size(): number;
+    on<E extends JstoreEventName>(event: E, listener: JstoreListener<E>): this;
+    once<E extends JstoreEventName>(event: E, listener: JstoreListener<E>): this;
+    off<E extends JstoreEventName>(event: E, listener: JstoreListener<E>): this;
+    addValidator<T extends JsonValue>(key: string, validator: Validator<T>): this;
+    removeValidator(key: string): this;
+    get<T extends JsonValue = JsonValue>(key: string): T | undefined;
+    tryGet<T extends JsonValue = JsonValue>(key: string): Result<T>;
+    set(key: string, value: JsonValue): this;
+    setIfAbsent(key: string, value: JsonValue): boolean;
+    has(key: string): boolean;
+    del(key: string): boolean;
+    rename(from: string, to: string): boolean;
+    bool(key: string): boolean;
+    toggle(key: string): boolean;
+    increment(key: string, amount?: number): number;
+    decrement(key: string, amount?: number): number;
+    push(key: string, ...values: JsonValue[]): this;
+    pull(key: string, predicate: (item: JsonValue) => boolean): this;
+    merge(key: string, value: JsonObject): this;
+    forEach(fn: (value: JsonValue, key: string) => void): void;
+    filter<T extends JsonValue>(predicate: FilterFn<T>): JsonObject;
+    map<T extends JsonValue, R extends JsonValue>(fn: MapFn<T, R>): JsonObject;
+    findKeys(predicate: FilterFn): string[];
+    getPath<T extends JsonValue = JsonValue>(dotPath: string): T | undefined;
+    tryGetPath<T extends JsonValue = JsonValue>(dotPath: string): Result<T>;
+    setPath(dotPath: string, value: JsonValue): this;
+    hasPath(dotPath: string): boolean;
+    delPath(dotPath: string): boolean;
+    mergePath(dotPath: string, value: JsonObject): this;
+    boolPath(dotPath: string): boolean;
+    togglePath(dotPath: string): boolean;
+    incrementPath(dotPath: string, amount?: number): number;
+    pushPath(dotPath: string, ...values: JsonValue[]): this;
+    transaction(): Transaction;
+    toJSON(indent?: number): string;
+    fromJSON(raw: string): this;
+    absorb(other: Jstore, overwrite?: boolean): this;
+}
+export { ok, err } from "./types.js";
+export type { AllowedSeparators, FilterFn, JstoreEventMap, JstoreEventName, JstoreListener, JsonArray, JsonObject, JsonValue, JsonPrimitive, LoadOptions, MapFn, Result, SchemaMap, Transaction, Validator, } from "./types.js";

package/lib/index.js

@@ -0,0 +1,396 @@
+import fs from "node:fs";
+import path from "node:path";
+import { EventEmitter } from "node:events";
+import { err, ok } from "./types.js";
+function isObject(v) {
+    return v !== null && typeof v === "object" && !Array.isArray(v);
+}
+function deepClone(v) {
+    return JSON.parse(JSON.stringify(v));
+}
+function deepMerge(target, source) {
+    const result = { ...target };
+    for (const key of Object.keys(source)) {
+        if (isObject(source[key]) && isObject(target[key])) {
+            result[key] = deepMerge(target[key], source[key]);
+        }
+        else {
+            result[key] = source[key];
+        }
+    }
+    return result;
+}
+export class Jstore {
+    #fp;
+    #sep;
+    #createOnMissing;
+    #indent;
+    #encode;
+    #emitter;
+    #schema;
+    #data;
+    #watcher = null;
+    constructor(fp, options = {}) {
+        this.#fp = path.resolve(fp);
+        this.#sep = options.separator ?? ".";
+        this.#createOnMissing = options.createOnMissing ?? true;
+        this.#indent = options.indent ?? 2;
+        this.#encode = options.encode ?? false;
+        this.#emitter = new EventEmitter();
+        this.#schema = {};
+        this.#data = this.#loadFile();
+        if (options.watch)
+            this.#startWatcher();
+    }
+    #loadFile() {
+        if (!fs.existsSync(this.#fp)) {
+            if (!this.#createOnMissing) {
+                throw new Error(`[jstore] File not found: ${this.#fp}`);
+            }
+            fs.mkdirSync(path.dirname(this.#fp), { recursive: true });
+            fs.writeFileSync(this.#fp, this.#encode ? btoa("{}") : "{}", "utf-8");
+            return {};
+        }
+        const raw = fs.readFileSync(this.#fp, "utf-8").trim();
+        try {
+            return JSON.parse(this.#encode ? atob(raw) : raw);
+        }
+        catch {
+            this.#emit("error", { message: `Failed to parse JSON at ${this.#fp}` });
+            throw new Error(`[jstore] Invalid JSON in file: ${this.#fp}`);
+        }
+    }
+    #save() {
+        const content = JSON.stringify(this.#data, null, this.#indent);
+        fs.writeFileSync(this.#fp, this.#encode ? btoa(content) : content, "utf-8");
+        this.#emit("save", {});
+    }
+    #resolvePath(dotPath) {
+        if (!dotPath)
+            throw new Error("[jstore] Path must be a non-empty string");
+        return dotPath.split(this.#sep);
+    }
+    #emit(event, payload) {
+        this.#emitter.emit(event, payload);
+    }
+    #startWatcher() {
+        this.#watcher = fs.watch(this.#fp, () => {
+            try {
+                this.#data = this.#loadFile();
+                this.#emit("reload", {});
+            }
+            catch {
+            }
+        });
+        this.#watcher.unref();
+    }
+    get filePath() {
+        return this.#fp;
+    }
+    close() {
+        this.#watcher?.close();
+        this.#watcher = null;
+    }
+    reload() {
+        this.#data = this.#loadFile();
+        this.#emit("reload", {});
+    }
+    all() {
+        return deepClone(this.#data);
+    }
+    clear() {
+        this.#data = {};
+        this.#save();
+        this.#emit("clear", {});
+    }
+    get size() {
+        return Object.keys(this.#data).length;
+    }
+    on(event, listener) {
+        this.#emitter.on(event, listener);
+        return this;
+    }
+    once(event, listener) {
+        this.#emitter.once(event, listener);
+        return this;
+    }
+    off(event, listener) {
+        this.#emitter.off(event, listener);
+        return this;
+    }
+    addValidator(key, validator) {
+        this.#schema[key] = validator;
+        return this;
+    }
+    removeValidator(key) {
+        delete this.#schema[key];
+        return this;
+    }
+    get(key) {
+        const val = this.#data[key];
+        return val !== undefined ? deepClone(val) : undefined;
+    }
+    tryGet(key) {
+        const val = this.get(key);
+        return val !== undefined
+            ? ok(val)
+            : err(`Key "${key}" not found`);
+    }
+    set(key, value) {
+        const validator = this.#schema[key];
+        if (validator && !validator(value)) {
+            throw new Error(`[jstore] Validation failed for key "${key}"`);
+        }
+        this.#data[key] = deepClone(value);
+        this.#save();
+        this.#emit("set", { key, value });
+        return this;
+    }
+    setIfAbsent(key, value) {
+        if (this.has(key))
+            return false;
+        this.set(key, value);
+        return true;
+    }
+    has(key) {
+        return Object.hasOwn(this.#data, key);
+    }
+    del(key) {
+        if (!this.has(key))
+            return false;
+        delete this.#data[key];
+        this.#save();
+        this.#emit("del", { key });
+        return true;
+    }
+    rename(from, to) {
+        if (!this.has(from))
+            return false;
+        this.#data[to] = this.#data[from];
+        delete this.#data[from];
+        this.#save();
+        return true;
+    }
+    bool(key) {
+        const val = this.get(key);
+        if (typeof val === "boolean")
+            return val;
+        if (val === 1)
+            return true;
+        if (val === 0)
+            return false;
+        throw new Error(`[jstore] bool() expects boolean or 0/1 for key "${key}", got: ${JSON.stringify(val)}`);
+    }
+    toggle(key) {
+        const current = this.bool(key);
+        this.set(key, !current);
+        return !current;
+    }
+    increment(key, amount = 1) {
+        const current = this.get(key) ?? 0;
+        if (typeof current !== "number") {
+            throw new Error(`[jstore] increment() requires a numeric value for key "${key}"`);
+        }
+        const next = current + amount;
+        this.set(key, next);
+        return next;
+    }
+    decrement(key, amount = 1) {
+        return this.increment(key, -amount);
+    }
+    push(key, ...values) {
+        const current = this.get(key);
+        if (current !== undefined && !Array.isArray(current)) {
+            throw new Error(`[jstore] push() requires an array value for key "${key}"`);
+        }
+        this.set(key, [...(current ?? []), ...values]);
+        return this;
+    }
+    pull(key, predicate) {
+        const current = this.get(key);
+        if (!Array.isArray(current)) {
+            throw new Error(`[jstore] pull() requires an array value for key "${key}"`);
+        }
+        this.set(key, current.filter((item) => !predicate(item)));
+        return this;
+    }
+    merge(key, value) {
+        const current = this.get(key) ?? {};
+        if (!isObject(current)) {
+            throw new Error(`[jstore] merge() requires an object value for key "${key}"`);
+        }
+        this.set(key, deepMerge(current, value));
+        return this;
+    }
+    forEach(fn) {
+        for (const [k, v] of Object.entries(this.#data)) {
+            fn(deepClone(v), k);
+        }
+    }
+    filter(predicate) {
+        return Object.fromEntries(Object.entries(this.#data).filter(([k, v]) => predicate(v, k)));
+    }
+    map(fn) {
+        return Object.fromEntries(Object.entries(this.#data).map(([k, v]) => [k, fn(v, k)]));
+    }
+    findKeys(predicate) {
+        return Object.keys(this.#data).filter((k) => predicate(this.#data[k], k));
+    }
+    getPath(dotPath) {
+        const keys = this.#resolvePath(dotPath);
+        let current = this.#data;
+        for (const key of keys) {
+            if (!isObject(current))
+                return undefined;
+            current = current[key];
+            if (current === undefined)
+                return undefined;
+        }
+        return deepClone(current);
+    }
+    tryGetPath(dotPath) {
+        const val = this.getPath(dotPath);
+        return val !== undefined
+            ? ok(val)
+            : err(`Path "${dotPath}" not found`);
+    }
+    setPath(dotPath, value) {
+        const keys = this.#resolvePath(dotPath);
+        let current = this.#data;
+        for (let i = 0; i < keys.length - 1; i++) {
+            const key = keys[i];
+            if (!isObject(current[key])) {
+                current[key] = {};
+            }
+            current = current[key];
+        }
+        current[keys.at(-1)] = deepClone(value);
+        this.#save();
+        this.#emit("setPath", { path: dotPath, value });
+        return this;
+    }
+    hasPath(dotPath) {
+        return this.getPath(dotPath) !== undefined;
+    }
+    delPath(dotPath) {
+        const keys = this.#resolvePath(dotPath);
+        let current = this.#data;
+        for (let i = 0; i < keys.length - 1; i++) {
+            if (!isObject(current))
+                return false;
+            current = current[keys[i]];
+            if (current === undefined)
+                return false;
+        }
+        const parent = current;
+        const lastKey = keys.at(-1);
+        if (!Object.hasOwn(parent, lastKey))
+            return false;
+        delete parent[lastKey];
+        this.#save();
+        this.#emit("delPath", { path: dotPath });
+        return true;
+    }
+    mergePath(dotPath, value) {
+        const current = this.getPath(dotPath) ?? {};
+        if (!isObject(current)) {
+            throw new Error(`[jstore] mergePath() requires an object at "${dotPath}"`);
+        }
+        this.setPath(dotPath, deepMerge(current, value));
+        return this;
+    }
+    boolPath(dotPath) {
+        const val = this.getPath(dotPath);
+        if (typeof val === "boolean")
+            return val;
+        if (val === 1)
+            return true;
+        if (val === 0)
+            return false;
+        throw new Error(`[jstore] boolPath() expects boolean or 0/1 at "${dotPath}", got: ${JSON.stringify(val)}`);
+    }
+    togglePath(dotPath) {
+        const current = this.boolPath(dotPath);
+        this.setPath(dotPath, !current);
+        return !current;
+    }
+    incrementPath(dotPath, amount = 1) {
+        const current = this.getPath(dotPath) ?? 0;
+        if (typeof current !== "number") {
+            throw new Error(`[jstore] incrementPath() requires a numeric value at "${dotPath}"`);
+        }
+        const next = current + amount;
+        this.setPath(dotPath, next);
+        return next;
+    }
+    pushPath(dotPath, ...values) {
+        const current = this.getPath(dotPath);
+        if (current !== undefined && !Array.isArray(current)) {
+            throw new Error(`[jstore] pushPath() requires an array at "${dotPath}"`);
+        }
+        this.setPath(dotPath, [...(current ?? []), ...values]);
+        return this;
+    }
+    transaction() {
+        const snapshot = deepClone(this.#data);
+        let draft = deepClone(this.#data);
+        const tx = {
+            set: (key, value) => {
+                draft[key] = deepClone(value);
+                return tx;
+            },
+            del: (key) => {
+                delete draft[key];
+                return tx;
+            },
+            setPath: (dotPath, value) => {
+                const keys = dotPath.split(this.#sep);
+                let current = draft;
+                for (let i = 0; i < keys.length - 1; i++) {
+                    if (!isObject(current[keys[i]]))
+                        current[keys[i]] = {};
+                    current = current[keys[i]];
+                }
+                current[keys.at(-1)] = deepClone(value);
+                return tx;
+            },
+            delPath: (dotPath) => {
+                const keys = dotPath.split(this.#sep);
+                let current = draft;
+                for (let i = 0; i < keys.length - 1; i++) {
+                    if (!isObject(current))
+                        return tx;
+                    current = current[keys[i]];
+                }
+                if (isObject(current))
+                    delete current[keys.at(-1)];
+                return tx;
+            },
+            commit: () => {
+                this.#data = draft;
+                this.#save();
+            },
+            rollback: () => {
+                draft = snapshot;
+            },
+        };
+        return tx;
+    }
+    toJSON(indent = this.#indent) {
+        return JSON.stringify(this.#data, null, indent);
+    }
+    fromJSON(raw) {
+        this.#data = JSON.parse(raw);
+        this.#save();
+        return this;
+    }
+    absorb(other, overwrite = true) {
+        for (const [k, v] of Object.entries(other.all())) {
+            if (overwrite || !this.has(k))
+                this.#data[k] = v;
+        }
+        this.#save();
+        return this;
+    }
+}
+export { ok, err } from "./types.js";

package/lib/types.d.ts

@@ -0,0 +1,66 @@
+export type AllowedSeparators = "/" | ">" | "." | "?" | "::" | "->";
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export type JsonArray = JsonValue[];
+export interface JsonObject {
+    [key: string]: JsonValue;
+}
+export type Paths<T, Sep extends string = "."> = T extends JsonObject ? {
+    [K in keyof T & string]: K | (T[K] extends JsonObject ? `${K}${Sep}${Paths<T[K], Sep> & string}` : never);
+}[keyof T & string] : never;
+export type PathValue<T, P extends string, Sep extends string = "."> = P extends `${infer K}${Sep}${infer Rest}` ? K extends keyof T ? PathValue<T[K], Rest, Sep> : never : P extends keyof T ? T[P] : never;
+export interface LoadOptions {
+    separator?: AllowedSeparators;
+    createOnMissing?: boolean;
+    indent?: number;
+    watch?: boolean;
+    encode?: boolean;
+}
+export type JstoreEventMap = {
+    set: {
+        key: string;
+        value: JsonValue;
+    };
+    del: {
+        key: string;
+    };
+    setPath: {
+        path: string;
+        value: JsonValue;
+    };
+    delPath: {
+        path: string;
+    };
+    clear: Record<string, never>;
+    reload: Record<string, never>;
+    save: Record<string, never>;
+    error: {
+        message: string;
+        cause?: unknown;
+    };
+};
+export type JstoreEventName = keyof JstoreEventMap;
+export type JstoreListener<E extends JstoreEventName> = (payload: JstoreEventMap[E]) => void;
+export type FilterFn<T extends JsonValue = JsonValue> = (value: T, key: string) => boolean;
+export type MapFn<T extends JsonValue = JsonValue, R extends JsonValue = JsonValue> = (value: T, key: string) => R;
+export interface Transaction {
+    set(key: string, value: JsonValue): Transaction;
+    del(key: string): Transaction;
+    setPath(dotPath: string, value: JsonValue): Transaction;
+    delPath(dotPath: string): Transaction;
+    commit(): void;
+    rollback(): void;
+}
+export type Validator<T extends JsonValue = JsonValue> = (value: unknown) => value is T;
+export type SchemaMap = Record<string, Validator>;
+export type Ok<T> = {
+    ok: true;
+    value: T;
+};
+export type Err = {
+    ok: false;
+    error: string;
+};
+export type Result<T> = Ok<T> | Err;
+export declare const ok: <T>(value: T) => Ok<T>;
+export declare const err: (error: string) => Err;

package/lib/types.js

@@ -0,0 +1,2 @@
+export const ok = (value) => ({ ok: true, value });
+export const err = (error) => ({ ok: false, error });

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "dex-jstore",
+  "version": "1.1.10",
+  "description": "Mini-json lib to control json files",
+  "license": "MIT",
+  "author": "lavender-incognito",
+  "type": "module",
+  "main": "lib/index.js",
+  "readme": "README.md",
+  "scripts": {
+    "test": "node tests/test.js",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "publish": "npm run prepublishOnly && npm publish"
+  },
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "types": "./lib/index.d.ts"
+    }
+  },
+  "files": [
+    "lib"
+  ],
+  "devDependencies": {
+    "@types/node": "^25.6.0",
+    "typescript": "^6.0.3"
+  }
+}

package/readme.md

@@ -0,0 +1,734 @@
+# dex-jstore
+
+> A production-grade, type-safe JSON flat-file store — zero dependencies, zero ceremony.
+
+```ts
+import { Jstore } from "dex-jstore";
+
+const db = new Jstore("./store.json");
+db.set("user.theme", "dark");
+db.increment("visits");
+console.log(db.getPath("user.theme")); // "dark"
+```
+
+Made by **Lavender Incognito** · MIT License
+
+---
+
+## Table of Contents
+
+- [Why dex-jstore](#why-dex-jstore)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Constructor & Options](#constructor--options)
+- [API Reference](#api-reference)
+  - [Lifecycle](#lifecycle)
+  - [Flat Key Operations](#flat-key-operations)
+  - [Boolean Helpers](#boolean-helpers)
+  - [Numeric Helpers](#numeric-helpers)
+  - [Array Helpers](#array-helpers)
+  - [Object Merge](#object-merge)
+  - [Dot-Path Operations](#dot-path-operations)
+  - [Functional Iteration](#functional-iteration)
+  - [Transactions](#transactions)
+  - [Events](#events)
+  - [Schema Validation](#schema-validation)
+  - [Import / Export](#import--export)
+- [Type System](#type-system)
+- [Result Type](#result-type)
+- [Recipes](#recipes)
+- [FAQ](#faq)
+- [License](#license)
+
+---
+
+## Why dex-jstore
+
+Most projects don't need a database. They need a place to persist a handful of settings, counters, or lightweight records without spinning up Postgres or bundling SQLite. `dex-jstore` is that place.
+
+- **Zero runtime dependencies** — only Node's built-in `node:fs`, `node:path`, and `node:events`
+- **True private fields** — class internals use `#` syntax; no accidental access through casts
+- **Deep TypeScript inference** — `Paths<T>` and `PathValue<T, P>` give you autocomplete on nested keys at compile time
+- **Railway-oriented errors** — every read has a `try*` variant that returns `Result<T>` instead of throwing
+- **Atomic transactions** — group multiple writes into a single commit; roll back cleanly on failure
+- **Typed event emitter** — subscribe to `set`, `del`, `clear`, `reload`, `save`, `error`, and more
+- **Runtime schema validation** — attach validators per key; bad data is rejected before it ever hits disk
+- **File watcher** — optionally auto-reload when the file is edited externally
+- **Fluent, chainable API** — every mutation returns `this`
+
+---
+
+## Installation
+
+```bash
+npm install dex-jstore
+# or
+pnpm add dex-jstore
+# or
+yarn add dex-jstore
+```
+
+Requires **Node.js ≥ 22** and **TypeScript ≥ 5.4** (for `using` / `Paths` support). ESM-only package.
+
+---
+
+## Quick Start
+
+```ts
+import { Jstore } from "dex-jstore";
+
+const db = new Jstore("./data.json");
+
+// Flat keys
+db.set("app.name", "my-app");
+db.set("visits", 0);
+
+// Dot-path access
+db.setPath("user.prefs.theme", "dark");
+console.log(db.getPath("user.prefs.theme")); // "dark"
+
+// Numeric helpers
+db.increment("visits");       // 1
+db.increment("visits", 5);    // 6
+db.decrement("visits");       // 5
+
+// Boolean helpers
+db.set("debug", false);
+db.toggle("debug");           // true
+
+// Array helpers
+db.set("tags", []);
+db.push("tags", "typescript", "json");
+db.pull("tags", (t) => t === "json");
+
+// Transactions
+const tx = db.transaction();
+tx.set("version", 2).setPath("user.role", "admin");
+tx.commit(); // single disk write
+
+// Events
+db.on("set", ({ key, value }) => console.log(`${key} →`, value));
+
+// Safe reads
+const result = db.tryGet("missing-key");
+if (!result.ok) console.error(result.error); // "Key "missing-key" not found"
+```
+
+---
+
+## Constructor & Options
+
+```ts
+new Jstore(filePath: string, options?: LoadOptions)
+```
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `separator` | `AllowedSeparators` | `"."` | Delimiter used to split dot-paths |
+| `createOnMissing` | `boolean` | `true` | Create the file (and parent dirs) if absent |
+| `indent` | `number` | `2` | JSON pretty-print spaces; set `0` for minified output |
+| `watch` | `boolean` | `false` | Auto-reload on external file changes |
+| `encode` | `boolean` | `false` | Base64-obfuscate the stored content |
+
+```ts
+// Custom separator
+const db = new Jstore("./cfg.json", { separator: "/" });
+db.setPath("user/prefs/lang", "fr");
+
+// Minified storage
+const db = new Jstore("./prod.json", { indent: 0 });
+
+// File watcher
+const db = new Jstore("./shared.json", { watch: true });
+db.on("reload", () => console.log("Store reloaded from disk"));
+```
+
+### Allowed separators
+
+```ts
+type AllowedSeparators = "." | "/" | ">" | "?" | "::" | "->";
+```
+
+---
+
+## API Reference
+
+### Lifecycle
+
+#### `filePath` *(getter)*
+```ts
+db.filePath // "/absolute/path/to/store.json"
+```
+The resolved absolute path of the backing file.
+
+#### `size` *(getter)*
+```ts
+db.size // number of top-level keys
+```
+
+#### `all()`
+```ts
+db.all(): JsonObject
+```
+Returns a deep clone of the entire store. Mutations to the returned object do not affect the store.
+
+#### `reload()`
+```ts
+db.reload(): void
+```
+Re-reads the file from disk, discarding any in-memory state. Fires the `reload` event.
+
+#### `clear()`
+```ts
+db.clear(): void
+```
+Removes all keys and persists an empty object. Fires the `clear` event.
+
+#### `close()`
+```ts
+db.close(): void
+```
+Stops the file watcher (if `watch: true` was set). Safe to call multiple times. Should be called on graceful shutdown.
+
+---
+
+### Flat Key Operations
+
+#### `get<T>(key)`
+```ts
+db.get<T>(key: string): T | undefined
+```
+Returns a deep clone of the value at `key`, or `undefined` if absent.
+
+#### `tryGet<T>(key)`
+```ts
+db.tryGet<T>(key: string): Result<T>
+```
+Like `get`, but returns `{ ok: true, value }` or `{ ok: false, error }` instead of `undefined`. See [Result Type](#result-type).
+
+#### `set(key, value)`
+```ts
+db.set(key: string, value: JsonValue): this
+```
+Stores `value` at `key` and writes to disk. Runs the registered validator for `key` if one exists. Fires the `set` event. Returns `this` for chaining.
+
+#### `setIfAbsent(key, value)`
+```ts
+db.setIfAbsent(key: string, value: JsonValue): boolean
+```
+Sets `value` only if `key` does not already exist. Returns `true` if the value was set, `false` if it was skipped.
+
+#### `has(key)`
+```ts
+db.has(key: string): boolean
+```
+
+#### `del(key)`
+```ts
+db.del(key: string): boolean
+```
+Deletes `key`. Returns `true` if it existed and was deleted. Fires the `del` event.
+
+#### `rename(from, to)`
+```ts
+db.rename(from: string, to: string): boolean
+```
+Atomically renames a key. Returns `false` if `from` does not exist.
+
+---
+
+### Boolean Helpers
+
+#### `bool(key)`
+```ts
+db.bool(key: string): boolean
+```
+Interprets the value at `key` as a boolean. Accepts `true`/`false` and `1`/`0`. Throws on anything else.
+
+#### `toggle(key)`
+```ts
+db.toggle(key: string): boolean
+```
+Flips the boolean at `key` and persists. Returns the new value.
+
+---
+
+### Numeric Helpers
+
+#### `increment(key, amount?)`
+```ts
+db.increment(key: string, amount?: number): number
+```
+Increments the numeric value at `key` by `amount` (default `1`). Creates the key at `0` if absent. Returns the new value.
+
+#### `decrement(key, amount?)`
+```ts
+db.decrement(key: string, amount?: number): number
+```
+Equivalent to `increment(key, -amount)`.
+
+```ts
+db.set("score", 10);
+db.increment("score");      // 11
+db.increment("score", 4);   // 15
+db.decrement("score", 5);   // 10
+```
+
+---
+
+### Array Helpers
+
+#### `push(key, ...values)`
+```ts
+db.push(key: string, ...values: JsonValue[]): this
+```
+Appends values to the array at `key`. Creates an empty array if the key is absent.
+
+#### `pull(key, predicate)`
+```ts
+db.pull(key: string, predicate: (item: JsonValue) => boolean): this
+```
+Removes all elements matching `predicate` from the array at `key`.
+
+```ts
+db.set("roles", ["viewer", "editor", "admin"]);
+db.pull("roles", (r) => r === "admin");
+db.get("roles"); // ["viewer", "editor"]
+```
+
+---
+
+### Object Merge
+
+#### `merge(key, value)`
+```ts
+db.merge(key: string, value: JsonObject): this
+```
+Deep-merges `value` into the existing object at `key`. Does not overwrite nested keys not present in `value`.
+
+```ts
+db.set("config", { a: 1, b: { x: 10 } });
+db.merge("config", { b: { y: 20 }, c: 3 });
+db.get("config"); // { a: 1, b: { x: 10, y: 20 }, c: 3 }
+```
+
+---
+
+### Dot-Path Operations
+
+All flat key methods have a `*Path` variant that accepts a separator-delimited path string to traverse nested objects.
+
+#### `getPath<T>(dotPath)`
+```ts
+db.getPath<T>(dotPath: string): T | undefined
+```
+
+#### `tryGetPath<T>(dotPath)`
+```ts
+db.tryGetPath<T>(dotPath: string): Result<T>
+```
+
+#### `setPath(dotPath, value)`
+```ts
+db.setPath(dotPath: string, value: JsonValue): this
+```
+Intermediate objects are created automatically if absent.
+
+#### `hasPath(dotPath)`
+```ts
+db.hasPath(dotPath: string): boolean
+```
+
+#### `delPath(dotPath)`
+```ts
+db.delPath(dotPath: string): boolean
+```
+
+#### `mergePath(dotPath, value)`
+```ts
+db.mergePath(dotPath: string, value: JsonObject): this
+```
+
+#### `boolPath(dotPath)` / `togglePath(dotPath)`
+```ts
+db.boolPath(dotPath: string): boolean
+db.togglePath(dotPath: string): boolean
+```
+
+#### `incrementPath(dotPath, amount?)`
+```ts
+db.incrementPath(dotPath: string, amount?: number): number
+```
+
+#### `pushPath(dotPath, ...values)`
+```ts
+db.pushPath(dotPath: string, ...values: JsonValue[]): this
+```
+
+```ts
+db.setPath("metrics.requests.total", 0);
+db.incrementPath("metrics.requests.total", 100);
+db.getPath("metrics.requests.total"); // 100
+```
+
+---
+
+### Functional Iteration
+
+These methods operate on top-level entries and **never mutate** the store.
+
+#### `forEach(fn)`
+```ts
+db.forEach((value: JsonValue, key: string) => void): void
+```
+
+#### `filter<T>(predicate)`
+```ts
+db.filter<T>(predicate: FilterFn<T>): JsonObject
+```
+Returns a new plain object containing only the entries for which `predicate` returns `true`.
+
+#### `map<T, R>(fn)`
+```ts
+db.map<T, R>(fn: MapFn<T, R>): JsonObject
+```
+Returns a new plain object with each value transformed by `fn`.
+
+#### `findKeys(predicate)`
+```ts
+db.findKeys(predicate: FilterFn): string[]
+```
+Returns all top-level keys for which `predicate` returns `true`.
+
+```ts
+db.set("a", 1);
+db.set("b", "hello");
+db.set("c", 42);
+
+db.filter<number>((v) => typeof v === "number"); // { a: 1, c: 42 }
+db.findKeys((v) => typeof v === "string");        // ["b"]
+db.map<number, number>((v) => (v as number) * 2); // { a: 2, c: 84 } (b NaN-safe)
+```
+
+---
+
+### Transactions
+
+A transaction lets you group multiple operations into a single atomic write. Changes are staged in memory and only flushed to disk on `commit()`. Calling `rollback()` discards all staged changes.
+
+```ts
+transaction(): Transaction
+```
+
+```ts
+interface Transaction {
+  set(key: string, value: JsonValue): Transaction;
+  del(key: string): Transaction;
+  setPath(dotPath: string, value: JsonValue): Transaction;
+  delPath(dotPath: string): Transaction;
+  commit(): void;
+  rollback(): void;
+}
+```
+
+```ts
+const tx = db.transaction();
+
+try {
+  tx
+    .set("status", "migrating")
+    .setPath("user.role", "admin")
+    .del("legacy_flag");
+
+  tx.commit(); // ← one single write to disk
+} catch (e) {
+  tx.rollback(); // ← no disk write occurred
+}
+```
+
+> **Note:** Transactions do not fire individual `set` / `del` events. Only the `save` event fires on `commit()`.
+
+---
+
+### Events
+
+`Jstore` extends `EventEmitter` with fully typed events.
+
+```ts
+db.on(event, listener): this
+db.once(event, listener): this
+db.off(event, listener): this
+```
+
+| Event | Payload | Fired when |
+|---|---|---|
+| `set` | `{ key, value }` | A flat key is written |
+| `del` | `{ key }` | A flat key is deleted |
+| `setPath` | `{ path, value }` | A dot-path is written |
+| `delPath` | `{ path }` | A dot-path is deleted |
+| `clear` | `{}` | The store is cleared |
+| `reload` | `{}` | The store is reloaded from disk |
+| `save` | `{}` | Any write reaches disk |
+| `error` | `{ message, cause? }` | A parse or I/O error occurs |
+
+```ts
+db.on("set", ({ key, value }) => {
+  console.log(`[store] SET ${key} =`, value);
+});
+
+db.on("error", ({ message }) => {
+  console.error("[store] Error:", message);
+});
+
+// One-time listener
+db.once("reload", () => console.log("Reloaded from external edit"));
+```
+
+---
+
+### Schema Validation
+
+Register a type guard per key. Any `set()` or `setPath()` call whose value fails validation will throw before touching the store.
+
+```ts
+db.addValidator(key: string, validator: Validator<T>): this
+db.removeValidator(key: string): this
+```
+
+```ts
+// Zod-compatible — any (value: unknown) => value is T works
+db.addValidator("port", (v): v is number =>
+  typeof v === "number" && Number.isInteger(v) && v > 0 && v < 65536
+);
+
+db.addValidator("theme", (v): v is "light" | "dark" =>
+  v === "light" || v === "dark"
+);
+
+db.set("port", 3000);   // ✓
+db.set("port", 99999);  // ✗ throws: [jstore] Validation failed for key "port"
+db.set("theme", "dim"); // ✗ throws: [jstore] Validation failed for key "theme"
+```
+
+---
+
+### Import / Export
+
+#### `toJSON(indent?)`
+```ts
+db.toJSON(indent?: number): string
+```
+Serializes the store to a JSON string. Uses the instance's `indent` setting by default.
+
+#### `fromJSON(raw)`
+```ts
+db.fromJSON(raw: string): this
+```
+Overwrites the entire store with a parsed JSON string and persists.
+
+#### `absorb(other, overwrite?)`
+```ts
+db.absorb(other: Jstore, overwrite?: boolean): this
+```
+Merges all top-level entries from `other` into this store. Set `overwrite` to `false` to preserve existing keys.
+
+```ts
+const defaults = new Jstore("./defaults.json");
+const user    = new Jstore("./user.json");
+
+// Apply defaults without overwriting user values
+user.absorb(defaults, false);
+```
+
+---
+
+## Type System
+
+`dex-jstore` ships a rich set of utility types in `types.ts`.
+
+### `Paths<T, Sep>`
+
+Produces a union of all valid dot-separated key paths into `T`, up to 4 levels deep.
+
+```ts
+type Config = {
+  server: { host: string; port: number };
+  debug: boolean;
+};
+
+type ConfigPaths = Paths<Config>;
+// "server" | "server.host" | "server.port" | "debug"
+```
+
+### `PathValue<T, P, Sep>`
+
+Resolves the value type at a given path.
+
+```ts
+type PortType = PathValue<Config, "server.port">;
+// number
+```
+
+### `JsonValue`
+
+```ts
+type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
+```
+
+### `Result<T>`
+
+```ts
+type Result<T> = { ok: true; value: T } | { ok: false; error: string };
+```
+
+### `AllowedSeparators`
+
+```ts
+type AllowedSeparators = "." | "/" | ">" | "?" | "::" | "->";
+```
+
+---
+
+## Result Type
+
+Every read method has a safe `try*` variant that returns a `Result<T>` instead of `undefined` or throwing. This enables clean, exhaustive error handling without `try/catch`.
+
+```ts
+import { Jstore, ok, err } from "dex-jstore";
+import type { Result } from "dex-jstore";
+
+const result: Result<number> = db.tryGet<number>("hits");
+
+if (result.ok) {
+  console.log("Hits:", result.value);
+} else {
+  console.warn("Not found:", result.error);
+}
+```
+
+You can also construct results directly:
+
+```ts
+import { ok, err } from "dex-jstore";
+
+function safeRead(key: string): Result<string> {
+  const val = db.get<string>(key);
+  return val !== undefined ? ok(val) : err(`Missing key: ${key}`);
+}
+```
+
+---
+
+## Recipes
+
+### App configuration store
+
+```ts
+const cfg = new Jstore("./app.config.json", { createOnMissing: true });
+
+cfg.setIfAbsent("port", 3000);
+cfg.setIfAbsent("host", "localhost");
+cfg.setIfAbsent("debug", false);
+
+export const port = cfg.get<number>("port")!;
+export const debug = cfg.bool("debug");
+```
+
+### Session / request counter
+
+```ts
+const stats = new Jstore("./stats.json");
+
+// In your request handler:
+stats.increment("requests.total");
+stats.incrementPath("requests.by_method.GET");
+```
+
+### Feature flags
+
+```ts
+const flags = new Jstore("./flags.json");
+flags.addValidator("beta", (v): v is boolean => typeof v === "boolean");
+
+flags.set("beta", false);
+flags.toggle("beta"); // true
+
+if (flags.bool("beta")) {
+  // enable beta features
+}
+```
+
+### Shared store with auto-reload
+
+```ts
+// In a multi-process scenario where another process may write the file:
+const shared = new Jstore("./shared.json", { watch: true });
+
+shared.on("reload", () => {
+  console.log("Shared store updated:", shared.all());
+});
+```
+
+### Atomic multi-step migration
+
+```ts
+const db = new Jstore("./store.json");
+const tx = db.transaction();
+
+try {
+  tx.del("old_user_id")
+    .set("user_id", generateNewId())
+    .setPath("migration.v2", true)
+    .set("schema_version", 2);
+  tx.commit();
+} catch (e) {
+  tx.rollback();
+  throw e;
+}
+```
+
+### Absorbing defaults
+
+```ts
+const defaults = new Jstore("./defaults.json");
+const config   = new Jstore("./config.json");
+
+// Load defaults first, then overlay user config
+const merged = new Jstore("./merged.json");
+merged.absorb(defaults).absorb(config, true);
+```
+
+---
+
+## FAQ
+
+**Does dex-jstore work in the browser?**
+No — it uses `node:fs` for persistence. For browser use, consider wrapping `localStorage` with a compatible interface.
+
+**Is it safe to use from multiple processes simultaneously?**
+Not without external coordination. File writes are synchronous and not locked. For multi-process scenarios, use the `watch: true` option on readers and designate a single writer process.
+
+**Can I use it without TypeScript?**
+Yes. It's standard ESM JavaScript at runtime. You just lose the compile-time path inference.
+
+**What happens if the JSON file is corrupted?**
+The constructor throws an error with the file path. An `error` event is also emitted before the throw. Consider wrapping the constructor in a try/catch and falling back to `fromJSON("{}")`.
+
+**Does `transaction()` support `setPath` / `delPath`?**
+Yes — the `Transaction` interface exposes all four core mutators: `set`, `del`, `setPath`, and `delPath`.
+
+**Can I use Zod validators?**
+Yes. Zod's `.parse` throws, but `.safeParse` returns a result you can use to build a `Validator<T>`:
+
+```ts
+import { z } from "zod";
+
+const UserSchema = z.object({ name: z.string(), age: z.number().min(0) });
+
+db.addValidator("user", (v): v is z.infer<typeof UserSchema> =>
+  UserSchema.safeParse(v).success
+);
+```
+
+---
+