refactor: rename interfaces away from the 'store' terminology to simply 'keyval' or 'kv'. BREAKING CHANGE

Author: ox-harris

dist/idb.js.map

@@ -9,7 +9,7 @@
     "keyval",
     "redis",
     "indexeddb",
-    "memory-store",
+    "object-store",
     "file-store",
     "nosql"
   ],
@@ -27,14 +27,14 @@
   "type": "module",
   "exports": {
     ".": "./src/index.js",
-    "./memory": "./src/MemoryStore.js",
-    "./redis": "./src/RedisStore.js",
-    "./idb": "./src/IDBStore.js",
-    "./file": "./src/FileStore.js"
+    "./file": "./src/FileKV.js",
+    ".//indexeddb": "./src/IndexedDBKV.js",
+    "./inmemory": "./src/InMemoryKV.js",
+    "./redis": "./src/RedisKV.js"
   },
   "scripts": {
     "test": "mocha --extension .test.js --recursive --timeout 5000 --exit",
-    "build": "esbuild main=src/MemoryStore.js idb=src/IDBStore.js --bundle --minify --sourcemap --outdir=dist",
+    "build": "esbuild main=src/InMemoryKV.js idb=src/IndexedDBKV.js --bundle --minify --sourcemap --outdir=dist",
     "preversion": "npm run test && npm run build && git add -A dist",
     "postversion": "git push && git push --tags",
     "version:next": "npm version prerelease --preid=next"

dist/main.js.map

@@ -1,13 +1,13 @@
 import fs from 'fs/promises';
 import Path from 'path';
-import { Store } from './Store.js';
-export { Store };
+import { KV } from './KV.js';
+export { KV };
 
-export class FileStore extends Store {
+export class FileKV extends KV {
 
     #file;
 
-    constructor({ dir = '.webqit_store', ...options }) {
+    constructor({ dir = '.webqit_keyval', ...options }) {
         super(options);
         const safePath = this.path.map(p =>
             p.replace(/[\/\\]/g, '_')

package.json

@@ -1,7 +1,7 @@
-import { Store } from './Store.js';
-export { Store };
+import { KV } from './KV.js';
+export { KV };
 
-export class MemoryStore extends Store {
+export class InMemoryKV extends KV {
 
     #exists(node) {
         if (!node?.subtree.has('value')) return;

src/FileStore.js src/FileKV.jssrc/FileStore.js renamed to src/FileKV.js

@@ -1,7 +1,7 @@
-import { Store } from './Store.js';
-export { Store };
+import { KV } from './KV.js';
+export { KV };
 
-export class IDBStore extends Store {
+export class IndexedDBKV extends KV {
 
     static #dbCache = new Map;
 
@@ -10,7 +10,7 @@ export class IDBStore extends Store {
     #storeName;
     #channel;
 
-    constructor({ dbName = 'webqit_store', channel = null, ...options }) {
+    constructor({ dbName = 'webqit_keyval', channel = null, ...options }) {
         super(options);
         this.#dbName = dbName;
         this.#storeName = this.path.join(':');
@@ -27,7 +27,7 @@ export class IDBStore extends Store {
             db.close();
 
             // Invalidate local handle so next op reopens
-            IDBStore.#dbCache.delete(this.#dbName);
+            IndexedDBKV.#dbCache.delete(this.#dbName);
 
             this.#db = null;
         };
@@ -36,8 +36,8 @@ export class IDBStore extends Store {
     async #open() {
         const cacheKey = this.#dbName;
 
-        if (IDBStore.#dbCache.has(cacheKey)) {
-            this.#db = IDBStore.#dbCache.get(cacheKey);
+        if (IndexedDBKV.#dbCache.has(cacheKey)) {
+            this.#db = IndexedDBKV.#dbCache.get(cacheKey);
             if (this.#db.objectStoreNames.contains(this.#storeName)) {
                 return this.#db;
             }
@@ -75,7 +75,7 @@ export class IDBStore extends Store {
             this.#db = initialDB;
         }
 
-        IDBStore.#dbCache.set(cacheKey, this.#db);
+        IndexedDBKV.#dbCache.set(cacheKey, this.#db);
         this.#attachDBLifecycle(this.#db);
         return this.#db;
     }
@@ -103,7 +103,7 @@ export class IDBStore extends Store {
         this.#channel?.close();
         this.#db?.close();
 
-        IDBStore.#dbCache.delete(this.#dbName);
+        IndexedDBKV.#dbCache.delete(this.#dbName);
         this.#db = null;
 
         await super.close();

src/MemoryStore.js src/InMemoryKV.jssrc/MemoryStore.js renamed to src/InMemoryKV.js

@@ -1,4 +1,4 @@
-export class Store {
+export class KV {
 
     static create(options) { return new this(options); }
 

src/IDBStore.js src/IndexedDBKV.jssrc/IDBStore.js renamed to src/IndexedDBKV.js

@@ -1,9 +1,9 @@
-import { Store } from './Store.js';
+import { KV } from './KV.js';
 import { createClient } from 'redis';
 export { createClient };
-export { Store };
+export { KV };
 
-export class RedisStore extends Store {
+export class RedisKV extends KV {
 
     #redis;
     #redisPath;

src/Store.js src/KV.jssrc/Store.js renamed to src/KV.js

@@ -1,5 +1,5 @@
-export * from './Store.js';
-export * from './MemoryStore.js';
-export * from './RedisStore.js';
-export * from './IDBStore.js';
-export * from './FileStore.js';
+export * from './KV.js';
+export * from './FileKV.js';
+export * from './IndexedDBKV.js';
+export * from './InMemoryKV.js';
+export * from './RedisKV.js';

src/RedisStore.js src/RedisKV.jssrc/RedisStore.js renamed to src/RedisKV.js

@@ -1,10 +1,10 @@
 import fs from 'fs/promises';
 import os from 'os';
 import path from 'path';
-import { FileStore } from '../src/FileStore.js';
-import { runStoreContract } from './helpers/storeContract.js';
+import { FileKV } from '../src/FileKV.js';
+import { runKVContract } from './helpers/kvContract.js';
 
-describe('FileStore', () => {
+describe('FileKV', () => {
 
     let dir;
     let store;
@@ -14,7 +14,7 @@ describe('FileStore', () => {
             path.join(os.tmpdir(), 'filestore-test-')
         );
 
-        store = new FileStore({
+        store = new FileKV({
             dir,
             path: ['test'],
             ttl: 1
@@ -26,5 +26,5 @@ describe('FileStore', () => {
         await fs.rm(dir, { recursive: true, force: true });
     });
 
-    runStoreContract(async () => store);
+    runKVContract(async () => store);
 });