fastkv 0.2.0 → 2.0.0

package/README.md

@@ -6,8 +6,9 @@
 
 FastKV is a key-value store which offers the following features:
 
-- Persistent storage in JSON files 📁
-- Caching with in-memory storage 🕒
+-   Supports temporary in-memory storage 🕒
+-   Supports persistent storage with JSON files 📁
+-   Lightweight with no dependencies ⚡
 
 ## Installation
 
@@ -19,6 +20,8 @@ npm install fastkv
 yarn add fastkv
 # or
 pnpm add fastkv
+# or
+bun add fastkv
 ```
 
 ## Example
@@ -28,19 +31,20 @@ import { KV } from 'fastkv';
 
 // For TypeScript users, the KV supports generics:
 // const example = new KV<string>();
+// Or: example.get<string>('my-key-name');
 
 const kv = new KV('./db.json'); // Save the data. Path resolves with process.cwd()
 const cache = new KV('::memory::'); // Keep the data in the system's memory.
 
 // Set data
-await kv.set('userSettings', { theme: 'dark' }); // => Promise<KV>
+kv.set('userSettings', { theme: 'dark' });
 
 // Retreive data by a key
-await kv.get('userSettings'); // => Promise resolving to { theme: 'dark' }
+kv.get('userSettings'); // -> { theme: 'dark' }
 
 // Retreive all data
-await kv.all(); // => Promise resolving an array: [{ key: 'userSettings', value: { theme: 'dark' } }]
+kv.all(); // -> [{ key: 'userSettings', value: { theme: 'dark' } }]
 
 // Clear the store
-await kv.clear(); // => Promise<KV>
+kv.clear();
 ```

package/dist/index.d.mts

@@ -1,39 +1,31 @@
-/**
- * Represents a key-value store.
- * Initializing with `::memory::` uses in-memory storage.
- */
+type Entry<T = any> = {
+    __id: string;
+    key: string;
+    value: T;
+};
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
 declare class KV<T = any> {
     #private;
-    /**
-     * Creates a new instance of the class.
-     * @param location - Where the data will be stored.
-     * Can be `::memory::` or a file location.
-     */
-    constructor(location?: string);
-    /**
-     * Sets a value to a key.
-     * @param key - The name of the key.
-     * @param value - The value to store.
-     * @returns The value.
-     */
-    set(key: string, value: T): T;
-    /**
-     * Gets data by a key.
-     * @param key - The existing key's name.
-     * @returns The found data, or null.
-     */
-    get(key: string): T | null;
-    /**
-     * Gets all data in the store.
-     * @returns An array of data.
-     */
-    all(): T[];
-    /**
-     * Clears all data in the store.
-     * @returns The KV instance.
-     */
-    clear(): this;
+    path?: string;
+    constructor(options?: {
+        path?: string;
+        prettify?: boolean;
+    });
+    set(key: string, value: T): Promise<Entry<T>>;
+    upsert(options: {
+        where: DeepPartial<T> | string;
+        create?: DeepPartial<T>;
+        update?: DeepPartial<T>;
+    }): Promise<Entry<T>>;
+    find(options: {
+        in?: "key" | "value";
+        where: T | string | number | boolean;
+    }): Promise<Entry<T>[]>;
+    get(query: string): Promise<Entry<T> | T | null>;
+    all(): Promise<Entry<T>[]>;
+    clear(): Promise<void>;
 }
-declare const _default: KV<any>;
 
-export { KV, _default as default };
+export { KV, KV as default };

package/dist/index.d.ts

@@ -1,39 +1,31 @@
-/**
- * Represents a key-value store.
- * Initializing with `::memory::` uses in-memory storage.
- */
+type Entry<T = any> = {
+    __id: string;
+    key: string;
+    value: T;
+};
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
 declare class KV<T = any> {
     #private;
-    /**
-     * Creates a new instance of the class.
-     * @param location - Where the data will be stored.
-     * Can be `::memory::` or a file location.
-     */
-    constructor(location?: string);
-    /**
-     * Sets a value to a key.
-     * @param key - The name of the key.
-     * @param value - The value to store.
-     * @returns The value.
-     */
-    set(key: string, value: T): T;
-    /**
-     * Gets data by a key.
-     * @param key - The existing key's name.
-     * @returns The found data, or null.
-     */
-    get(key: string): T | null;
-    /**
-     * Gets all data in the store.
-     * @returns An array of data.
-     */
-    all(): T[];
-    /**
-     * Clears all data in the store.
-     * @returns The KV instance.
-     */
-    clear(): this;
+    path?: string;
+    constructor(options?: {
+        path?: string;
+        prettify?: boolean;
+    });
+    set(key: string, value: T): Promise<Entry<T>>;
+    upsert(options: {
+        where: DeepPartial<T> | string;
+        create?: DeepPartial<T>;
+        update?: DeepPartial<T>;
+    }): Promise<Entry<T>>;
+    find(options: {
+        in?: "key" | "value";
+        where: T | string | number | boolean;
+    }): Promise<Entry<T>[]>;
+    get(query: string): Promise<Entry<T> | T | null>;
+    all(): Promise<Entry<T>[]>;
+    clear(): Promise<void>;
 }
-declare const _default: KV<any>;
 
-export { KV, _default as default };
+export { KV, KV as default };

package/dist/index.js

@@ -1 +1,151 @@
-"use strict";var a=Object.create;var e=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var f=Object.getPrototypeOf,d=Object.prototype.hasOwnProperty;var y=(r,t)=>{for(var i in t)e(r,i,{get:t[i],enumerable:!0})},o=(r,t,i,c)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of p(t))!d.call(r,s)&&s!==i&&e(r,s,{get:()=>t[s],enumerable:!(c=m(t,s))||c.enumerable});return r};var l=(r,t,i)=>(i=r!=null?a(f(r)):{},o(t||!r||!r.__esModule?e(i,"default",{value:r,enumerable:!0}):i,r)),g=r=>o(e({},"__esModule",{value:!0}),r);var b={};y(b,{KV:()=>n,default:()=>T});module.exports=g(b);var h=l(require("fs")),u=l(require("path")),n=class{#t;#r;constructor(t="::memory::"){this.#t=t,this.#r={},t!="::memory::"&&(this.#t=u.default.resolve(process.cwd(),this.#t),this.#r=this.#s())}#s(){if(this.#t==="::memory::")return{};try{let t=h.default.readFileSync(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}#i(){this.#t!=="::memory::"&&h.default.writeFileSync(this.#t,JSON.stringify(this.#r),"utf8")}set(t,i){return this.#r[t]=i,this.#i(),i}get(t){return this.#r[t]??null}all(){return Object.values(this.#r)}clear(){return this.#r={},this.#i(),this}},T=new n;0&&(module.exports={KV});
+"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 __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, {
+  KV: () => KV,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_crypto = require("crypto");
+var import_node_path = __toESM(require("path"));
+var import_promises = __toESM(require("fs/promises"));
+var KV = class {
+  path;
+  #data = [];
+  #ready;
+  #prettify;
+  constructor(options) {
+    if (options?.prettify) {
+      this.#prettify = options?.prettify;
+    } else {
+      this.#prettify = false;
+    }
+    if (options?.path) {
+      this.path = import_node_path.default.resolve(process.cwd(), options.path);
+      this.#ready = this.#loadFromFile();
+    } else {
+      this.#ready = Promise.resolve();
+    }
+  }
+  async #loadFromFile() {
+    try {
+      const content = await import_promises.default.readFile(this.path, "utf8");
+      this.#data = JSON.parse(content);
+    } catch {
+      this.#data = [];
+      await this.#saveToFile();
+    }
+  }
+  async #saveToFile() {
+    if (!this.path) return;
+    await import_promises.default.writeFile(
+      this.path,
+      JSON.stringify(this.#data, null, this.#prettify ? 2 : 0),
+      "utf8"
+    );
+  }
+  #resolvePath(object, path2) {
+    return path2.split(".").reduce((acc, part) => acc ? acc[part] : void 0, object);
+  }
+  #matches(value, where) {
+    if (typeof value !== typeof where) return false;
+    if (typeof value === "object" && value !== null && where !== null) {
+      return Object.entries(where).every(([k, v]) => this.#matches(value[k], v));
+    }
+    return value === where;
+  }
+  async set(key, value) {
+    await this.#ready;
+    const entry = this.#data.find((entry2) => entry2.key === key);
+    if (entry) {
+      entry.value = value;
+      await this.#saveToFile();
+      return entry;
+    }
+    const newEntry = { __id: (0, import_node_crypto.randomUUID)(), key, value };
+    this.#data.push(newEntry);
+    await this.#saveToFile();
+    return newEntry;
+  }
+  async upsert(options) {
+    await this.#ready;
+    let entry;
+    if (typeof options.where === "string") {
+      entry = this.#data.find((entry2) => entry2.key === options.where);
+    } else {
+      entry = this.#data.find((entry2) => this.#matches(entry2.value, options.where));
+    }
+    if (entry) {
+      if (options.update) {
+        entry.value = { ...entry.value, ...options.update };
+      }
+    } else {
+      const key = typeof options.where === "string" ? options.where : (0, import_node_crypto.randomUUID)();
+      entry = { __id: (0, import_node_crypto.randomUUID)(), key, value: { ...options.create ?? {} } };
+      this.#data.push(entry);
+    }
+    await this.#saveToFile();
+    return entry;
+  }
+  async find(options) {
+    await this.#ready;
+    const field = options.in ?? "value";
+    const where = options.where;
+    return this.#data.filter((entry) => {
+      if (field === "key") {
+        return typeof where === "string" && entry.key.includes(where);
+      }
+      return this.#matches(entry.value, where);
+    });
+  }
+  async get(query) {
+    await this.#ready;
+    const [baseKey, ...rest] = query.split(".");
+    const entry = this.#data.find((entry2) => entry2.key === baseKey);
+    if (!entry) return null;
+    if (rest.length === 0) return entry;
+    return this.#resolvePath({ value: entry.value }, rest.join(".")) ?? null;
+  }
+  async all() {
+    await this.#ready;
+    return [...this.#data];
+  }
+  async clear() {
+    await this.#ready;
+    this.#data = [];
+    await this.#saveToFile();
+  }
+};
+var index_default = KV;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KV
+});

package/dist/index.mjs

@@ -1 +1,116 @@
-import s from"node:fs";import e from"node:path";var r=class{#t;#r;constructor(t="::memory::"){this.#t=t,this.#r={},t!="::memory::"&&(this.#t=e.resolve(process.cwd(),this.#t),this.#r=this.#s())}#s(){if(this.#t==="::memory::")return{};try{let t=s.readFileSync(this.#t,"utf8");return JSON.parse(t)||{}}catch{return{}}}#i(){this.#t!=="::memory::"&&s.writeFileSync(this.#t,JSON.stringify(this.#r),"utf8")}set(t,i){return this.#r[t]=i,this.#i(),i}get(t){return this.#r[t]??null}all(){return Object.values(this.#r)}clear(){return this.#r={},this.#i(),this}},u=new r;export{r as KV,u as default};
+// src/index.ts
+import { randomUUID } from "crypto";
+import path from "path";
+import fs from "fs/promises";
+var KV = class {
+  path;
+  #data = [];
+  #ready;
+  #prettify;
+  constructor(options) {
+    if (options?.prettify) {
+      this.#prettify = options?.prettify;
+    } else {
+      this.#prettify = false;
+    }
+    if (options?.path) {
+      this.path = path.resolve(process.cwd(), options.path);
+      this.#ready = this.#loadFromFile();
+    } else {
+      this.#ready = Promise.resolve();
+    }
+  }
+  async #loadFromFile() {
+    try {
+      const content = await fs.readFile(this.path, "utf8");
+      this.#data = JSON.parse(content);
+    } catch {
+      this.#data = [];
+      await this.#saveToFile();
+    }
+  }
+  async #saveToFile() {
+    if (!this.path) return;
+    await fs.writeFile(
+      this.path,
+      JSON.stringify(this.#data, null, this.#prettify ? 2 : 0),
+      "utf8"
+    );
+  }
+  #resolvePath(object, path2) {
+    return path2.split(".").reduce((acc, part) => acc ? acc[part] : void 0, object);
+  }
+  #matches(value, where) {
+    if (typeof value !== typeof where) return false;
+    if (typeof value === "object" && value !== null && where !== null) {
+      return Object.entries(where).every(([k, v]) => this.#matches(value[k], v));
+    }
+    return value === where;
+  }
+  async set(key, value) {
+    await this.#ready;
+    const entry = this.#data.find((entry2) => entry2.key === key);
+    if (entry) {
+      entry.value = value;
+      await this.#saveToFile();
+      return entry;
+    }
+    const newEntry = { __id: randomUUID(), key, value };
+    this.#data.push(newEntry);
+    await this.#saveToFile();
+    return newEntry;
+  }
+  async upsert(options) {
+    await this.#ready;
+    let entry;
+    if (typeof options.where === "string") {
+      entry = this.#data.find((entry2) => entry2.key === options.where);
+    } else {
+      entry = this.#data.find((entry2) => this.#matches(entry2.value, options.where));
+    }
+    if (entry) {
+      if (options.update) {
+        entry.value = { ...entry.value, ...options.update };
+      }
+    } else {
+      const key = typeof options.where === "string" ? options.where : randomUUID();
+      entry = { __id: randomUUID(), key, value: { ...options.create ?? {} } };
+      this.#data.push(entry);
+    }
+    await this.#saveToFile();
+    return entry;
+  }
+  async find(options) {
+    await this.#ready;
+    const field = options.in ?? "value";
+    const where = options.where;
+    return this.#data.filter((entry) => {
+      if (field === "key") {
+        return typeof where === "string" && entry.key.includes(where);
+      }
+      return this.#matches(entry.value, where);
+    });
+  }
+  async get(query) {
+    await this.#ready;
+    const [baseKey, ...rest] = query.split(".");
+    const entry = this.#data.find((entry2) => entry2.key === baseKey);
+    if (!entry) return null;
+    if (rest.length === 0) return entry;
+    return this.#resolvePath({ value: entry.value }, rest.join(".")) ?? null;
+  }
+  async all() {
+    await this.#ready;
+    return [...this.#data];
+  }
+  async clear() {
+    await this.#ready;
+    this.#data = [];
+    await this.#saveToFile();
+  }
+};
+var index_default = KV;
+export {
+  KV,
+  index_default as default
+};

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "fastkv",
-  "version": "0.2.0",
+  "version": "2.0.0",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
   "description": "A key-value store, helpful for caches in apps.",
-  "main": "dist/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "repository": {
     "url": "https://github.com/m1-dev/fastkv"
   },
@@ -14,16 +21,29 @@
     "database",
     "json"
   ],
+  "prettier": {
+    "tabWidth": 4,
+    "printWidth": 95,
+    "arrowParens": "always",
+    "trailingComma": "es5",
+    "singleQuote": false,
+    "jsxSingleQuote": false,
+    "useTabs": false,
+    "semi": true
+  },
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^20.10.5",
-    "@underctrl/tsconfig": "^0.0.1",
+    "@types/node": "^20.11.16",
+    "prettier": "^3.2.5",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3"
   },
   "scripts": {
     "build": "tsup",
-    "lint": "tsc --noEmit true",
-    "prepublish": "pnpm run build"
+    "lint": "tsc --noEmit; prettier . --check --ignore-path=.prettierignore",
+    "prepublish": "pnpm run build",
+    "format": "prettier . --write --ignore-path=.prettierignore",
+    "deploy:fastkv:beta": "pnpm publish --no-git-checks --access public --tag beta",
+    "deploy:fastkv:stable": "pnpm publish --no-git-checks --access public"
   }
 }