node-sqlite-kv 0.3.1 → 1.0.0

package/.prettierrc.json

@@ -0,0 +1,11 @@
+{
+    "arrowParens": "always",
+    "jsxSingleQuote": false,
+    "printWidth": 90,
+    "quoteProps": "as-needed",
+    "semi": false,
+    "singleQuote": false,
+    "tabWidth": 4,
+    "trailingComma": "es5",
+    "useTabs": false
+}

package/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "prettier.configPath": ".prettierrc.json",
+    "prettier.prettierPath": "node_modules/prettier"
+}

package/LICENSE

@@ -1,7 +1,24 @@
-Copyright 2026 Andrew (e60m5ss / wlix)
+This is free and unencumbered software released into the public domain.
 
-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:
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
 
-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.
+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 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.
+
+For more information, please refer to <https://unlicense.org/>

package/README.md

@@ -1,6 +1,8 @@
 <h1 align="center">node-sqlite-kv</h1>
 
-> Key-value store with node:sqlite (Node.js v22.5.0 or higher is required)
+A simple key-value store with `node:sqlite`.
+
+> ⚠️ Node.js v22 or higher is required.
 
 ## Installation
 
@@ -17,46 +19,56 @@ bun add node-sqlite-kv
 ## Example
 
 ```js
-import { KVSync } from "node-sqlite-kv";
+import { JournalModes, KVSync } from "node-sqlite-kv"
 
+// none of these options are required
 const kv = new KVSync({
-    // use :memory: for in-memory storage
-    // path is optional, defaults to :memory:
+    // sqlite journal mode; defaults to DELETE for
+    // in-memory stores, or WAL for persistent ones
+    journalMode: JournalModes.WAL,
+
+    // whether the database is open upon
+    // being instantiated; defaults to true
+    open: true,
+
+    // defaults to :memory: (in-memory storage)
     path: "./data.sqlite",
 
-    // optional journal mode
-    // default: DELETE
-    journalMode: "WAL",
-});
+    // override the default table name of "kv"
+    // note: it's not recommended to use one file for
+    // multiple key value stores; this is only
+    // for the ability of changing the default name
+    tableName: "kv",
+})
 
 // set values
-kv.set("number", 123);
-kv.set("string", "hello world");
-kv.set("boolean", true);
-kv.set("null", null);
-kv.set("array", [1, 2, 3]);
-kv.set("object", { settings: { theme: "dark" } });
-kv.set("date", new Date());
+kv.set("number", 123)
+kv.set("string", "hello world")
+kv.set("boolean", true)
+kv.set("null", null)
+kv.set("array", [1, 2, 3])
+kv.set("object", { settings: { theme: "dark" } })
+kv.set("date", new Date())
 
 // get values
-kv.get("number"); // 123
-kv.get("string"); // "hello world"
-kv.get("boolean"); // true
-kv.get("null"); // null
-kv.get("array"); // [1, 2, 3]
-kv.get("object"); // { settings: { theme: "dark" } }
-kv.get("date"); // Date
+kv.get("number") // 123
+kv.get("string") // "hello world"
+kv.get("boolean") // true
+kv.get("null") // null
+kv.get("array") // [1, 2, 3]
+kv.get("object") // { settings: { theme: "dark" } }
+kv.get("date") // Date
 
 // update values
-kv.set("number", 999);
-kv.get("number"); // 999
+kv.set("number", 999)
+kv.get("number") // 999
 
 // delete values
-kv.delete("array"); // [1, 2, 3]
-kv.get("array"); // null
+kv.delete("array")
+kv.get("array") // undefined
 
 // list all entries
-kv.all();
+kv.all()
 // [
 //      { key: "string", value: "hello world" },
 //      { key: "number", value: 999 },
@@ -64,26 +76,59 @@ kv.all();
 //      // ...
 // ];
 
+// check if a key exists
+kv.exists("string") // true
+kv.exists("nonexistent") // false
+
+// get total number of entries
+kv.size() // 6
+
+// get all keys
+kv.keys() // ["string", "number", "boolean", "null", "object", "date"]
+
+// get all values
+kv.values() // ["hello world", 999, true, null, { settings: { theme: "dark" } }, Date]
+
 // transactions
-kv.set("user:1", { name: "Andrew", age: 19 });
-kv.set("user:2", { name: "Josh", age: 22 });
-kv.set("user:3", { name: "Gabe", age: 20 });
+kv.set("user:1", { name: "Andrew", age: 19 })
+kv.set("user:2", { name: "Josh", age: 22 })
+kv.set("user:3", { name: "Gabe", age: 20 })
 
 // ...store what changed in transactions
 const { oldValues, newValues } = kv.transaction((tx) => {
-    tx.set("user:1", { name: "Andrew", age: 20 });
-    tx.set("user:4", { name: "Kris", age: 21 });
-    tx.delete("user:2");
-});
+    tx.set("user:1", { name: "Andrew", age: 20 })
+    tx.set("user:4", { name: "Kris", age: 21 })
+    tx.delete("user:2")
+})
 
 // delete all entries
-kv.clear();
+kv.clear()
+
+// close the database
+kv.close()
+```
+
+### TS Generics Example
+
+```ts
+import { KVSync } from "node-sqlite-kv"
+const kv = new KVSync({ path: "./data.sqlite" })
+
+interface User {
+    name: string
+}
+
+kv.set("user", { name: "Andrew" })
+kv.get<User>("user") // User | null
+
+kv.set("example", 123)
+kv.get<number>("example") // number | null
 ```
 
 ## Contributing
 
-Pull requests are always welcomed. For more major changes, please open an issue to discuss what you wish to change.
+[pnpm](https://pnpm.io) is used throughout this project for packages and scripts. Pull requests are always welcome. For more major changes, please open an issue to discuss what you wish to change.
 
 ## License
 
-[MIT](LICENSE)
+[Unlicensed](LICENSE)

package/dist/index.cjs

@@ -0,0 +1,250 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let node_sqlite = require("node:sqlite");
+let node_v8 = require("node:v8");
+let node_fs = require("node:fs");
+node_fs = __toESM(node_fs);
+let node_path = require("node:path");
+node_path = __toESM(node_path);
+
+//#region src/classes/kv-error.ts
+/** Class representing a KVError */
+var KVError = class extends Error {
+	static name = "KVError";
+	scope;
+	constructor(scope, ...args) {
+		super(args.join(" "));
+		this.scope = scope;
+		Error.captureStackTrace?.(this, this.constructor);
+	}
+	get name() {
+		return `${this.constructor.name} (${this.scope})`;
+	}
+};
+
+//#endregion
+//#region src/constants.ts
+/** List of journal modes SQLite supports */
+const JournalModes = {
+	Delete: "DELETE",
+	Memory: "MEMORY",
+	OFF: "OFF",
+	Persist: "PERSIST",
+	Truncate: "TRUNCATE",
+	WAL: "WAL"
+};
+
+//#endregion
+//#region src/classes/kv-sync.ts
+/** Class representing a synchronous key-value store */
+var KVSync = class {
+	#db;
+	/**
+	* The name of the table with keys and values
+	* @default "kv"
+	*/
+	tableName = "kv";
+	/**
+	* Instantiate a new key-value store
+	* @param props KVSync options
+	*/
+	constructor(props) {
+		const dbPath = props?.path ?? ":memory:";
+		if (dbPath !== ":memory:") node_fs.default.mkdirSync(node_path.default.dirname(dbPath), { recursive: true });
+		this.tableName = props?.tableName ?? "kv";
+		this.#db = new node_sqlite.DatabaseSync(dbPath, { open: props?.open ?? true });
+		if (props?.open !== false) {
+			this.setJournalMode(props?.journalMode ?? (dbPath !== ":memory:" ? JournalModes.WAL : JournalModes.Delete));
+			this.#db.exec(`CREATE TABLE IF NOT EXISTS ${this.tableName} (key TEXT PRIMARY KEY NOT NULL, value BLOB NOT NULL) STRICT`);
+		}
+	}
+	/**
+	* Set a key in the database
+	* @param key Key name
+	* @param value Key value
+	* @returns Provided value
+	*/
+	set(key, value) {
+		if (!this.#db.isOpen) throw new KVError("set", "Database is not open");
+		if (!key || typeof key !== "string") throw new KVError("set", "Key must be provided and be a non-empty string");
+		if (value === void 0) throw new KVError("set", "Provided value is undefined, did you mean to use delete()?");
+		this.#db.prepare(`INSERT OR REPLACE INTO ${this.tableName} (key, value) VALUES (?, ?)`).run(key, (0, node_v8.serialize)(value));
+		return value;
+	}
+	/**
+	* Get a value from the database
+	* @param key Key name
+	* @returns Value or undefined
+	*/
+	get(key) {
+		if (!this.#db.isOpen) throw new KVError("get", "Database is not open");
+		if (!key || typeof key !== "string") throw new KVError("get", "Key must be provided and be a non-empty string.");
+		const row = this.#db.prepare(`SELECT value FROM ${this.tableName} WHERE key = ?`).get(key);
+		return row ? (0, node_v8.deserialize)(row.value) : void 0;
+	}
+	/**
+	* Delete a key from the database
+	* @param key Key name
+	* @returns KVSync instance
+	*/
+	delete(key) {
+		if (!this.#db.isOpen) throw new KVError("delete", "Database is not open");
+		if (!key || typeof key !== "string") throw new KVError("delete", "Key must be provided and be a non-empty string.");
+		this.#db.prepare(`DELETE FROM ${this.tableName} WHERE key = ?`).run(key);
+		return this;
+	}
+	/**
+	* Get all data in the database
+	* @returns Array of objects containing keys and values
+	*/
+	all(filter) {
+		if (!this.#db.isOpen) throw new KVError("all", "Database is not open");
+		const result = [];
+		const rows = this.#db.prepare(`SELECT key, value FROM ${this.tableName}`).iterate();
+		for (const row of rows) {
+			const key = row.key;
+			const value = (0, node_v8.deserialize)(row.value);
+			if (!filter || filter(key, value)) result.push({
+				key,
+				value
+			});
+		}
+		return result;
+	}
+	/**
+	* Remove all entries from the database
+	*/
+	clear() {
+		if (!this.#db.isOpen) throw new KVError("clear", "Database is not open");
+		this.#db.exec(`DELETE FROM ${this.tableName}`);
+		return this;
+	}
+	/**
+	* Update the journal mode
+	* @param mode New journal mode
+	*/
+	setJournalMode(mode) {
+		if (!this.#db.isOpen) throw new KVError("setJournalMode", "Database is not open");
+		if (!Object.values(JournalModes).includes(mode)) throw new KVError("setJournalMode", `Invalid journal mode specified - received: "${mode}", expected one of: ${Object.values(JournalModes).join(", ")}`);
+		this.#db.exec(`PRAGMA journal_mode = ${mode}`);
+		return this;
+	}
+	/**
+	* Perform a transaction
+	* @param callback Callback with KVSync instance
+	* @returns Object containing oldValues and newValues each containing arrays of keys and values
+	*/
+	transaction(callback) {
+		if (!this.#db.isOpen) throw new KVError("transaction", "Database is not open");
+		if (!callback) throw new KVError("transaction", "A callback must be provided when using transaction().");
+		if (typeof callback !== "function") throw new KVError("transaction", `Transaction callback must be of type function. Received: ${typeof callback}`);
+		const oldMap = /* @__PURE__ */ new Map();
+		const newMap = /* @__PURE__ */ new Map();
+		const tx = Object.create(this);
+		tx.set = (key, value) => {
+			if (!oldMap.has(key)) {
+				const oldValue = this.get(key);
+				oldMap.set(key, oldValue);
+			}
+			newMap.set(key, value);
+			return value;
+		};
+		tx.delete = (key) => {
+			if (!oldMap.has(key)) {
+				const oldValue = this.get(key);
+				oldMap.set(key, oldValue);
+			}
+			newMap.set(key, void 0);
+			return tx;
+		};
+		try {
+			this.#db.exec("BEGIN TRANSACTION");
+			callback(tx);
+			for (const [key, value] of newMap.entries()) if (value === void 0) this.delete(key);
+			else this.set(key, value);
+			this.#db.exec("COMMIT");
+		} catch (error) {
+			this.#db.exec("ROLLBACK");
+			throw error;
+		}
+		return {
+			oldValues: Array.from(oldMap.entries()).map(([key, value]) => ({
+				key,
+				value
+			})),
+			newValues: Array.from(newMap.entries()).map(([key, value]) => ({
+				key,
+				value
+			}))
+		};
+	}
+	/**
+	* Check if a key exists
+	* @param key Key name
+	* @returns Boolean representing whether a key exists
+	*/
+	exists(key) {
+		if (!this.#db.isOpen) throw new KVError("exists", "Database is not open");
+		if (!key || typeof key !== "string") throw new KVError("exists", "Key must be provided and be a non-empty string.");
+		return this.#db.prepare(`SELECT 1 FROM ${this.tableName} WHERE key = ?`).get(key) !== void 0;
+	}
+	/** Get total number of entries in the database */
+	size() {
+		if (!this.#db.isOpen) throw new KVError("size", "Database is not open");
+		return this.#db.prepare(`SELECT COUNT(*) as count FROM ${this.tableName}`).get().count;
+	}
+	/** Get all keys in the database */
+	keys() {
+		if (!this.#db.isOpen) throw new KVError("keys", "Database is not open");
+		return this.#db.prepare(`SELECT key FROM ${this.tableName}`).all().map((row) => row.key);
+	}
+	/** Get all values in the database */
+	values() {
+		if (!this.#db.isOpen) throw new KVError("values", "Database is not open");
+		return this.#db.prepare(`SELECT value FROM ${this.tableName}`).all().map((row) => (0, node_v8.deserialize)(row.value));
+	}
+	/** Open the database */
+	open() {
+		if (this.#db.isOpen) throw new KVError("open", "Database is already open");
+		this.#db.open();
+		this.#db.exec(`CREATE TABLE IF NOT EXISTS ${this.tableName} (key TEXT PRIMARY KEY NOT NULL, value BLOB NOT NULL) STRICT`);
+		return this;
+	}
+	/** Close the database */
+	close() {
+		if (!this.#db.isOpen) throw new KVError("close", "Database is not open");
+		this.#db.close();
+		return this;
+	}
+};
+
+//#endregion
+exports.JournalModes = JournalModes;
+exports.KVError = KVError;
+exports.KVSync = KVSync;

package/dist/index.d.cts

@@ -0,0 +1,121 @@
+//#region src/constants.d.ts
+/** List of journal modes SQLite supports */
+declare const JournalModes: {
+  readonly Delete: "DELETE";
+  readonly Memory: "MEMORY";
+  readonly OFF: "OFF";
+  readonly Persist: "PERSIST";
+  readonly Truncate: "TRUNCATE";
+  readonly WAL: "WAL";
+};
+//#endregion
+//#region src/types.d.ts
+/**
+ * SQLite journal mode
+ * @default DELETE (:memory: databases)
+ * @default WAL (persistent databases)
+ */
+type JournalMode = (typeof JournalModes)[keyof typeof JournalModes];
+/** KVSync configuration options */
+interface KVSyncProps {
+  journalMode?: JournalMode;
+  open?: boolean;
+  path?: SQLitePath;
+  tableName?: string;
+}
+/** File path, or :memory: (for SQLite use) */
+type SQLitePath = ":memory:" | (string & {});
+//#endregion
+//#region src/classes/kv-error.d.ts
+/** Class representing a KVError */
+declare class KVError extends Error {
+  static name: string;
+  readonly scope: string;
+  constructor(scope: string, ...args: unknown[]);
+  get name(): string;
+}
+//#endregion
+//#region src/classes/kv-sync.d.ts
+/** Class representing a synchronous key-value store */
+declare class KVSync<T = any> {
+  #private;
+  /**
+   * The name of the table with keys and values
+   * @default "kv"
+   */
+  tableName: string;
+  /**
+   * Instantiate a new key-value store
+   * @param props KVSync options
+   */
+  constructor(props?: KVSyncProps);
+  /**
+   * Set a key in the database
+   * @param key Key name
+   * @param value Key value
+   * @returns Provided value
+   */
+  set<K = T>(key: string, value: K | undefined): K;
+  /**
+   * Get a value from the database
+   * @param key Key name
+   * @returns Value or undefined
+   */
+  get<K = T>(key: string): K | undefined;
+  /**
+   * Delete a key from the database
+   * @param key Key name
+   * @returns KVSync instance
+   */
+  delete(key: string): KVSync;
+  /**
+   * Get all data in the database
+   * @returns Array of objects containing keys and values
+   */
+  all<K = T>(filter?: (key: string, value: K) => boolean): {
+    key: string;
+    value: K;
+  }[];
+  /**
+   * Remove all entries from the database
+   */
+  clear(): KVSync;
+  /**
+   * Update the journal mode
+   * @param mode New journal mode
+   */
+  setJournalMode(mode: JournalMode): this;
+  /**
+   * Perform a transaction
+   * @param callback Callback with KVSync instance
+   * @returns Object containing oldValues and newValues each containing arrays of keys and values
+   */
+  transaction<R>(callback: (kv: KVSync<T>) => R): {
+    oldValues: {
+      key: string;
+      value: T | undefined;
+    }[];
+    newValues: {
+      key: string;
+      value: T | undefined;
+    }[];
+  };
+  /**
+   * Check if a key exists
+   * @param key Key name
+   * @returns Boolean representing whether a key exists
+   */
+  exists(key: string): boolean;
+  /** Get total number of entries in the database */
+  size(): number;
+  /** Get all keys in the database */
+  keys(): string[];
+  /** Get all values in the database */
+  values<K = T>(): K[];
+  /** Open the database */
+  open(): KVSync;
+  /** Close the database */
+  close(): KVSync;
+}
+//#endregion
+export { JournalMode, JournalModes, KVError, KVSync, KVSyncProps, SQLitePath };

package/package.json

@@ -1,40 +1,33 @@
 {
   "name": "node-sqlite-kv",
   "description": "Key-value store with node:sqlite",
-  "version": "0.3.1",
+  "version": "1.0.0",
+  "license": "UNLICENSED",
   "repository": {
-    "url": "https://github.com/e60m5ss/node-sqlite-kv"
+    "url": "https://github.com/andrewdku/node-sqlite-kv"
   },
   "author": {
-    "name": "e60m5ss",
-    "url": "https://github.com/e60m5ss"
+    "name": "andrewdku",
+    "url": "https://github.com/andrewdku"
   },
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "exports": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "type": "module",
   "engineStrict": true,
   "engines": {
     "node": ">=22.5.0"
   },
-  "prettier": {
-    "jsxSingleQuote": false,
-    "printWidth": 85,
-    "semi": true,
-    "singleQuote": false,
-    "tabWidth": 4,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
   "devDependencies": {
-    "@types/node": "^25.2.0",
+    "@types/node": "^25.5.0",
     "prettier": "^3.8.1",
-    "tsup": "^8.5.1",
+    "tsdown": "^0.21.4",
     "typescript": "^5.9.3"
   },
   "scripts": {
-    "build": "tsup",
-    "format": "prettier ./src --write --ignore-path=.prettierignore",
+    "build": "tsdown -c tsdown.config.mjs",
+    "format": "prettier --write . --config .prettierrc.json",
     "lint": "tsc --noEmit; prettier ./src --check --ignore-path=.prettierignore",
-    "prepublish": "tsup"
+    "prepublish": "tsdown -c tsdown.config.mjs"
   }
 }

package/tsdown.config.mjs

@@ -0,0 +1,17 @@
+// @ts-check
+
+import { defineConfig } from "tsdown"
+
+export default defineConfig({
+    cjsDefault: true,
+    clean: true,
+    deps: { skipNodeModulesBundle: true },
+    dts: true,
+    entry: ["src/index.ts"],
+    format: ["cjs"],
+    minify: false,
+    platform: "node",
+    removeNodeProtocol: false,
+    shims: true,
+    target: "node22",
+})

package/dist/index.d.mts

@@ -1,32 +0,0 @@
-type JournalMode = "DELETE" | "MEMORY" | "OFF" | "PERSIST" | "TRUNCATE" | "WAL";
-interface KVSyncOptions {
-    path?: SQLitePath;
-    journalMode?: JournalMode;
-}
-type SQLitePath = ":memory:" | (string & {});
-declare const journalModes: JournalMode[];
-declare class KVSync<T = any> {
-    #private;
-    constructor(options?: KVSyncOptions);
-    set<K = T>(key: string, value: K | undefined): K;
-    get<K = T>(key: string): K | null;
-    delete(key: string): KVSync;
-    all<K = T>(filter?: (key: string, value: K) => boolean): {
-        key: string;
-        value: K;
-    }[];
-    clear(): KVSync;
-    setJournalMode(mode: JournalMode): this;
-    transaction<R>(callback: (kv: KVSync<T>) => R): {
-        oldValues: {
-            key: string;
-            value: T | null | undefined;
-        }[];
-        newValues: {
-            key: string;
-            value: T | null;
-        }[];
-    };
-}
-
-export { type JournalMode, KVSync, type KVSyncOptions, type SQLitePath, journalModes };

package/dist/index.d.ts

@@ -1,32 +0,0 @@
-type JournalMode = "DELETE" | "MEMORY" | "OFF" | "PERSIST" | "TRUNCATE" | "WAL";
-interface KVSyncOptions {
-    path?: SQLitePath;
-    journalMode?: JournalMode;
-}
-type SQLitePath = ":memory:" | (string & {});
-declare const journalModes: JournalMode[];
-declare class KVSync<T = any> {
-    #private;
-    constructor(options?: KVSyncOptions);
-    set<K = T>(key: string, value: K | undefined): K;
-    get<K = T>(key: string): K | null;
-    delete(key: string): KVSync;
-    all<K = T>(filter?: (key: string, value: K) => boolean): {
-        key: string;
-        value: K;
-    }[];
-    clear(): KVSync;
-    setJournalMode(mode: JournalMode): this;
-    transaction<R>(callback: (kv: KVSync<T>) => R): {
-        oldValues: {
-            key: string;
-            value: T | null | undefined;
-        }[];
-        newValues: {
-            key: string;
-            value: T | null;
-        }[];
-    };
-}
-
-export { type JournalMode, KVSync, type KVSyncOptions, type SQLitePath, journalModes };

package/dist/index.js

@@ -1,220 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  KVSync: () => KVSync,
-  journalModes: () => journalModes
-});
-module.exports = __toCommonJS(index_exports);
-var import_node_sqlite = require("node:sqlite");
-var import_node_v8 = require("node:v8");
-var import_node_fs = __toESM(require("node:fs"));
-var import_node_path = __toESM(require("node:path"));
-var journalModes = [
-  "DELETE",
-  "MEMORY",
-  "OFF",
-  "PERSIST",
-  "TRUNCATE",
-  "WAL"
-];
-var KVSync = class {
-  static {
-    __name(this, "KVSync");
-  }
-  #db;
-  /**
-   * Instantiate a new key-value store
-   * @param path Where the database is stored, or `:memory:` for in-memory storage
-   */
-  constructor(options) {
-    const dbPath = options?.path ?? ":memory:";
-    if (dbPath !== ":memory:") {
-      import_node_fs.default.mkdirSync(import_node_path.default.dirname(dbPath), { recursive: true });
-    }
-    this.#db = new import_node_sqlite.DatabaseSync(dbPath);
-    this.setJournalMode(options?.journalMode ?? "DELETE");
-    this.#db.exec(
-      "CREATE TABLE IF NOT EXISTS kv (key TEXT PRIMARY KEY NOT NULL, value BLOB NOT NULL) STRICT;"
-    );
-  }
-  /**
-   * Set a key in the database
-   * @param key Key name
-   * @param value Key value
-   * @returns Provided value
-   */
-  set(key, value) {
-    if (!key || typeof key !== "string") {
-      throw new Error(
-        "[KVSync]: Key must be provided and be a non-empty string."
-      );
-    }
-    if (value === void 0) {
-      throw new Error(
-        "[KVSync]: Provided value is undefined. Did you mean to use delete() instead?"
-      );
-    }
-    this.#db.prepare("INSERT OR REPLACE INTO kv (key, value) VALUES (?, ?)").run(key, (0, import_node_v8.serialize)(value));
-    return value;
-  }
-  /**
-   * Get a value from the database
-   * @param key Key name
-   * @returns Value or null
-   */
-  get(key) {
-    if (!key || typeof key !== "string") {
-      throw new Error(
-        "[KVSync]: Key must be provided and be a non-empty string."
-      );
-    }
-    const row = this.#db.prepare("SELECT value FROM kv WHERE key = ?").get(key);
-    return row ? (0, import_node_v8.deserialize)(row.value) : null;
-  }
-  /**
-   * Delete a key from the database
-   * @param key Key name
-   * @returns KVSync instance
-   */
-  delete(key) {
-    if (!key || typeof key !== "string") {
-      throw new Error(
-        "[KVSync]: Key must be provided and be a non-empty string."
-      );
-    }
-    this.#db.prepare("DELETE FROM kv WHERE key = ?").run(key);
-    return this;
-  }
-  /**
-   * Get all data in the database
-   * @returns Array of objects containing keys and values
-   */
-  all(filter) {
-    const rows = this.#db.prepare("SELECT key, value FROM kv").iterate();
-    const result = [];
-    for (const row of rows) {
-      const key = row.key;
-      const value = (0, import_node_v8.deserialize)(row.value);
-      if (!filter || filter(key, value)) {
-        result.push({ key, value });
-      }
-    }
-    return result;
-  }
-  /**
-   * Remove all entries from the database
-   */
-  clear() {
-    this.#db.exec("DELETE FROM kv;");
-    return this;
-  }
-  /**
-   * Update the journal mode
-   * @param mode New journal mode
-   */
-  setJournalMode(mode) {
-    if (!journalModes.includes(mode)) {
-      throw new Error(
-        `[KVSync]: Invalid journal mode specified. Received: "${mode}", expected one of: ${journalModes.join(", ")}`
-      );
-    }
-    this.#db.exec(`PRAGMA journal_mode = ${mode};`);
-    return this;
-  }
-  /**
-   * Perform a transaction
-   * @param callback Callback with KVSync instance
-   * @returns Object containing oldValues and newValues each containing arrays of keys and values
-   */
-  transaction(callback) {
-    if (!callback) {
-      throw new Error(
-        "[KVSync]: A callback must be provided when using transaction()."
-      );
-    }
-    if (typeof callback !== "function") {
-      throw new Error(
-        `[KVSync]: Transaction callback must be of type function. Received: ${typeof callback}`
-      );
-    }
-    const oldMap = /* @__PURE__ */ new Map();
-    const newMap = /* @__PURE__ */ new Map();
-    const tx = Object.create(this);
-    tx.set = (key, value) => {
-      if (!oldMap.has(key)) {
-        const oldValue = this.get(key);
-        oldMap.set(key, oldValue === null ? void 0 : oldValue);
-      }
-      newMap.set(key, value);
-      return value ?? null;
-    };
-    tx.delete = (key) => {
-      if (!oldMap.has(key)) {
-        const oldValue = this.get(key);
-        oldMap.set(key, oldValue === null ? void 0 : oldValue);
-      }
-      newMap.set(key, null);
-      return tx;
-    };
-    try {
-      callback(tx);
-      this.#db.exec("BEGIN TRANSACTION;");
-      for (const [key, value] of newMap.entries()) {
-        if (value === null) {
-          this.delete(key);
-        } else {
-          this.set(key, value);
-        }
-      }
-      this.#db.exec("COMMIT;");
-    } catch (error) {
-      this.#db.exec("ROLLBACK;");
-      throw error;
-    }
-    return {
-      oldValues: Array.from(oldMap.entries()).map(([key, value]) => ({
-        key,
-        value
-      })),
-      newValues: Array.from(newMap.entries()).map(([key, value]) => ({
-        key,
-        value
-      }))
-    };
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  KVSync,
-  journalModes
-});

package/dist/index.mjs

@@ -1,186 +0,0 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-
-// src/index.ts
-import { DatabaseSync } from "node:sqlite";
-import { serialize, deserialize } from "node:v8";
-import fs from "node:fs";
-import path from "node:path";
-var journalModes = [
-  "DELETE",
-  "MEMORY",
-  "OFF",
-  "PERSIST",
-  "TRUNCATE",
-  "WAL"
-];
-var KVSync = class {
-  static {
-    __name(this, "KVSync");
-  }
-  #db;
-  /**
-   * Instantiate a new key-value store
-   * @param path Where the database is stored, or `:memory:` for in-memory storage
-   */
-  constructor(options) {
-    const dbPath = options?.path ?? ":memory:";
-    if (dbPath !== ":memory:") {
-      fs.mkdirSync(path.dirname(dbPath), { recursive: true });
-    }
-    this.#db = new DatabaseSync(dbPath);
-    this.setJournalMode(options?.journalMode ?? "DELETE");
-    this.#db.exec(
-      "CREATE TABLE IF NOT EXISTS kv (key TEXT PRIMARY KEY NOT NULL, value BLOB NOT NULL) STRICT;"
-    );
-  }
-  /**
-   * Set a key in the database
-   * @param key Key name
-   * @param value Key value
-   * @returns Provided value
-   */
-  set(key, value) {
-    if (!key || typeof key !== "string") {
-      throw new Error(
-        "[KVSync]: Key must be provided and be a non-empty string."
-      );
-    }
-    if (value === void 0) {
-      throw new Error(
-        "[KVSync]: Provided value is undefined. Did you mean to use delete() instead?"
-      );
-    }
-    this.#db.prepare("INSERT OR REPLACE INTO kv (key, value) VALUES (?, ?)").run(key, serialize(value));
-    return value;
-  }
-  /**
-   * Get a value from the database
-   * @param key Key name
-   * @returns Value or null
-   */
-  get(key) {
-    if (!key || typeof key !== "string") {
-      throw new Error(
-        "[KVSync]: Key must be provided and be a non-empty string."
-      );
-    }
-    const row = this.#db.prepare("SELECT value FROM kv WHERE key = ?").get(key);
-    return row ? deserialize(row.value) : null;
-  }
-  /**
-   * Delete a key from the database
-   * @param key Key name
-   * @returns KVSync instance
-   */
-  delete(key) {
-    if (!key || typeof key !== "string") {
-      throw new Error(
-        "[KVSync]: Key must be provided and be a non-empty string."
-      );
-    }
-    this.#db.prepare("DELETE FROM kv WHERE key = ?").run(key);
-    return this;
-  }
-  /**
-   * Get all data in the database
-   * @returns Array of objects containing keys and values
-   */
-  all(filter) {
-    const rows = this.#db.prepare("SELECT key, value FROM kv").iterate();
-    const result = [];
-    for (const row of rows) {
-      const key = row.key;
-      const value = deserialize(row.value);
-      if (!filter || filter(key, value)) {
-        result.push({ key, value });
-      }
-    }
-    return result;
-  }
-  /**
-   * Remove all entries from the database
-   */
-  clear() {
-    this.#db.exec("DELETE FROM kv;");
-    return this;
-  }
-  /**
-   * Update the journal mode
-   * @param mode New journal mode
-   */
-  setJournalMode(mode) {
-    if (!journalModes.includes(mode)) {
-      throw new Error(
-        `[KVSync]: Invalid journal mode specified. Received: "${mode}", expected one of: ${journalModes.join(", ")}`
-      );
-    }
-    this.#db.exec(`PRAGMA journal_mode = ${mode};`);
-    return this;
-  }
-  /**
-   * Perform a transaction
-   * @param callback Callback with KVSync instance
-   * @returns Object containing oldValues and newValues each containing arrays of keys and values
-   */
-  transaction(callback) {
-    if (!callback) {
-      throw new Error(
-        "[KVSync]: A callback must be provided when using transaction()."
-      );
-    }
-    if (typeof callback !== "function") {
-      throw new Error(
-        `[KVSync]: Transaction callback must be of type function. Received: ${typeof callback}`
-      );
-    }
-    const oldMap = /* @__PURE__ */ new Map();
-    const newMap = /* @__PURE__ */ new Map();
-    const tx = Object.create(this);
-    tx.set = (key, value) => {
-      if (!oldMap.has(key)) {
-        const oldValue = this.get(key);
-        oldMap.set(key, oldValue === null ? void 0 : oldValue);
-      }
-      newMap.set(key, value);
-      return value ?? null;
-    };
-    tx.delete = (key) => {
-      if (!oldMap.has(key)) {
-        const oldValue = this.get(key);
-        oldMap.set(key, oldValue === null ? void 0 : oldValue);
-      }
-      newMap.set(key, null);
-      return tx;
-    };
-    try {
-      callback(tx);
-      this.#db.exec("BEGIN TRANSACTION;");
-      for (const [key, value] of newMap.entries()) {
-        if (value === null) {
-          this.delete(key);
-        } else {
-          this.set(key, value);
-        }
-      }
-      this.#db.exec("COMMIT;");
-    } catch (error) {
-      this.#db.exec("ROLLBACK;");
-      throw error;
-    }
-    return {
-      oldValues: Array.from(oldMap.entries()).map(([key, value]) => ({
-        key,
-        value
-      })),
-      newValues: Array.from(newMap.entries()).map(([key, value]) => ({
-        key,
-        value
-      }))
-    };
-  }
-};
-export {
-  KVSync,
-  journalModes
-};