tiny-idb 1.0.0 → 1.1.0

package/README.md

@@ -17,7 +17,7 @@ Native IndexedDB requires managing requests, transactions, and version upgrades.
 The primary weakness of most storage wrappers is the "read-modify-write" race condition. If two parts of an application attempt to update the same key simultaneously, data loss often occurs. `tiny-idb` addresses this by executing `update`, `push`, and `merge` operations within a single IndexedDB transaction, ensuring that updates are processed sequentially and reliably.
 
 ### Resource Efficiency
-At only **596 bytes** (gzipped), the library introduces negligible overhead to your bundle. It is dependency-free and written in modern vanilla JavaScript, ensuring high performance across all environments that support IndexedDB.
+At only **611 bytes** (gzipped), the library introduces negligible overhead to your bundle. It is dependency-free and written in modern vanilla JavaScript, ensuring high performance across all environments that support IndexedDB.
 
 ### Intelligent Lifecycle Management
 The library handles database connection pooling, tab synchronization, and error recovery automatically. If a database connection is blocked by another tab or fails due to an environmental error, `tiny-idb` gracefully resets and recovers without requiring a page reload.
@@ -39,7 +39,7 @@ npm install tiny-idb
 </script>
 ```
 
-*   **Minified Module**: `https://unpkg.com/tiny-idb/tiny-idb.min.js` (596 bytes gzipped)
+*   **Minified Module**: `https://unpkg.com/tiny-idb/tiny-idb.min.js` (598 bytes gzipped)
 *   **Source**: `https://unpkg.com/tiny-idb/tiny-idb.js`
 
 ## Technical Comparison
@@ -65,7 +65,68 @@ npm install tiny-idb
 | `count()` | Returns the total number of entries. |
 | `update(key, fn)` | Performs an atomic read-modify-write operation. |
 | `push(key, value)` | Atomically appends a value to an array. |
-| `merge(key, object)` | Atomically shallow-merges an object. |
+| `merge(key, patch)` | Atomically shallow-merges an object. |
+
+## Example Use Cases
+
+### User Settings Management
+Easily manage and update partial user preferences without worrying about race conditions.
+```javascript
+import { tinyIDB } from 'tiny-idb';
+
+// Initial setup
+await tinyIDB.set('settings', { theme: 'dark', notifications: true });
+
+// Later, merge new settings
+await tinyIDB.merge('settings', { notifications: false, language: 'en' });
+
+// Result: { theme: 'dark', notifications: false, language: 'en' }
+```
+
+### Persistent Shopping Cart
+Atomically add items to a list, ensuring no items are lost during concurrent updates.
+```javascript
+// Add items from different parts of the UI
+await tinyIDB.push('cart', { id: 101, qty: 1 });
+await tinyIDB.push('cart', { id: 202, qty: 2 });
+
+const cart = await tinyIDB.get('cart');
+console.log(`Items in cart: ${cart.length}`);
+```
+
+### Atomic Counters
+Safely increment values using the `update` method.
+```javascript
+await tinyIDB.set('page_views', 0);
+
+// Increment safely
+await tinyIDB.update('page_views', count => (count || 0) + 1);
+```
+
+### localStorage Compatibility
+`tiny-idb` provides aliases for `get`, `set`, and `remove` to match the `localStorage` API.
+```javascript
+await tinyIDB.setItem('session_id', 'xyz-123');
+const sid = await tinyIDB.getItem('session_id');
+await tinyIDB.removeItem('session_id');
+```
+
+## Development
+
+### Running Tests
+```bash
+npm test
+```
+
+### Running Tests on Minified Build
+```bash
+npm run test:min
+```
+
+### Build
+```bash
+npm run build
+```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-idb",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "An extremely fast, super simple, and dependency-free IndexedDB wrapper. A drop-in replacement for localStorage with reliability and durability.",
   "main": "tiny-idb.js",
   "module": "tiny-idb.js",
@@ -38,6 +38,8 @@
     "terser": "^5.46.1"
   },
   "scripts": {
-    "test": "node test.js"
+    "test": "node test.js",
+    "test:min": "TEST_MIN=1 node test.js",
+    "build": "terser tiny-idb.js -o tiny-idb.min.js -c toplevel,unsafe -m toplevel --comments false"
   }
 }

package/tiny-idb.js

@@ -6,14 +6,14 @@
  * @license MIT
  */
 
-const DB_NAME = 'tiny-idb', STORE_NAME = 's', VERSION = 1;
+const DB_NAME = 'tiny-idb', STORE_NAME = 's', READ_WRITE = 'readwrite', READ_ONLY = 'readonly';
 let dbPromise;
 
 const getDB = () => dbPromise || (dbPromise = new Promise((resolve, reject) => {
-  const req = indexedDB.open(DB_NAME, VERSION);
-  req.onupgradeneeded = e => e.target.result.createObjectStore(STORE_NAME);
-  req.onsuccess = e => {
-    const db = e.target.result;
+  const req = indexedDB.open(DB_NAME, 1);
+  req.onupgradeneeded = () => req.result.createObjectStore(STORE_NAME);
+  req.onsuccess = () => {
+    const db = req.result;
     db.onversionchange = () => { db.close(); dbPromise = null; };
     resolve(db);
   };
@@ -27,29 +27,35 @@ const prom = (req) => new Promise((res, rej) => {
 
 const tx = async (mode, cb) => {
   const db = await getDB();
-  return new Promise((resolve, reject) => {
+  return new Promise(async (resolve, reject) => {
     const t = db.transaction(STORE_NAME, mode);
-    let res;
-    try { res = cb(t.objectStore(STORE_NAME)); } catch (e) { t.abort(); return reject(e); }
-    t.oncomplete = () => resolve(res);
-    t.onerror = () => reject(t.error);
+    t.onabort = t.onerror = () => reject(t.error || new DOMException('Aborted'));
+    try {
+      const res = await cb(t.objectStore(STORE_NAME));
+      t.oncomplete = () => resolve(res);
+    } catch (e) {
+      try { t.abort(); } catch {}
+      reject(e);
+    }
   });
 };
 
 export const tinyIDB = {
-  set: (k, v) => tx('readwrite', s => prom(s.put(v, k))),
-  get: k => tx('readonly', s => prom(s.get(k))),
-  remove: k => tx('readwrite', s => prom(s.delete(k))),
-  clear: () => tx('readwrite', s => prom(s.clear())),
-  keys: () => tx('readonly', s => prom(s.getAllKeys())),
-  values: () => tx('readonly', s => prom(s.getAll())),
-  count: () => tx('readonly', s => prom(s.count())),
-  update: async (k, fn) => tx('readwrite', async s => {
-    const n = await fn(await prom(s.get(k)));
-    return prom(s.put(n, k));
+  set: (key, value) => tx(READ_WRITE, s => prom(s.put(value, key))),
+  get: key => tx(READ_ONLY, s => prom(s.get(key))),
+  remove: k => tx(READ_WRITE, s => prom(s.delete(k))),
+  clear: () => tx(READ_WRITE, s => prom(s.clear())),
+  keys: () => tx(READ_ONLY, s => prom(s.getAllKeys())),
+  values: () => tx(READ_ONLY, s => prom(s.getAll())),
+  count: () => tx(READ_ONLY, s => prom(s.count())),
+  update: async (key, fn) => tx(READ_WRITE, async s => {
+    const n = await fn(await prom(s.get(key)));
+    return prom(s.put(n, key));
   }),
-  push: (k, v) => tinyIDB.update(k, c => [...(Array.isArray(c) ? c : []), v]),
-  merge: (k, p) => tinyIDB.update(k, c => ({ ...(c && typeof c === 'object' ? c : {}), ...p }))
+  push: (key, value) => tinyIDB.update(key, c => [...(Array.isArray(c) ? c : []), value]),
+  merge: (key, patch) => tinyIDB.update(key, c => ({ ...(c && typeof c === 'object' ? c : {}), ...patch }))
 };
 
+['get', 'set', 'remove'].forEach(method => tinyIDB[method + 'Item'] = tinyIDB[method]);
+
 export default tinyIDB;

package/tiny-idb.min.js

@@ -1 +1 @@
-const DB_NAME="tiny-idb",STORE_NAME="s",VERSION=1;let dbPromise;const getDB=()=>dbPromise||(dbPromise=new Promise((e,r)=>{const t=indexedDB.open(DB_NAME,1);t.onupgradeneeded=e=>e.target.result.createObjectStore("s"),t.onsuccess=r=>{const t=r.target.result;t.onversionchange=()=>{t.close(),dbPromise=null},e(t)},t.onerror=()=>{dbPromise=null,r(t.error)}})),prom=e=>new Promise((r,t)=>{e.onsuccess=()=>r(e.result),e.onerror=()=>t(e.error)}),tx=async(e,r)=>{const t=await getDB();return new Promise((o,n)=>{const s=t.transaction("s",e);let a;try{a=r(s.objectStore("s"))}catch(e){return s.abort(),n(e)}s.oncomplete=()=>o(a),s.onerror=()=>n(s.error)})};export const tinyIDB={set:(e,r)=>tx("readwrite",t=>prom(t.put(r,e))),get:e=>tx("readonly",r=>prom(r.get(e))),remove:e=>tx("readwrite",r=>prom(r.delete(e))),clear:()=>tx("readwrite",e=>prom(e.clear())),keys:()=>tx("readonly",e=>prom(e.getAllKeys())),values:()=>tx("readonly",e=>prom(e.getAll())),count:()=>tx("readonly",e=>prom(e.count())),update:async(e,r)=>tx("readwrite",async t=>{const o=await r(await prom(t.get(e)));return prom(t.put(o,e))}),push:(e,r)=>tinyIDB.update(e,e=>[...Array.isArray(e)?e:[],r]),merge:(e,r)=>tinyIDB.update(e,e=>({...e&&"object"==typeof e?e:{},...r}))};export default tinyIDB;
+const e="readwrite",t="readonly";let r;const o=e=>new Promise((t,r)=>{e.onsuccess=()=>t(e.result),e.onerror=()=>r(e.error)}),n=async(e,t)=>{const o=await(r||(r=new Promise((e,t)=>{const o=indexedDB.open("tiny-idb",1);o.onupgradeneeded=()=>o.result.createObjectStore("s"),o.onsuccess=()=>{const t=o.result;t.onversionchange=()=>{t.close(),r=null},e(t)},o.onerror=()=>{r=null,t(o.error)}})));return new Promise(async(r,n)=>{const s=o.transaction("s",e);s.onabort=s.onerror=()=>n(s.error||new DOMException("Aborted"));try{const e=await t(s.objectStore("s"));s.oncomplete=()=>r(e)}catch(e){try{s.abort()}catch{}n(e)}})};export const tinyIDB={set:(t,r)=>n(e,e=>o(e.put(r,t))),get:e=>n(t,t=>o(t.get(e))),remove:t=>n(e,e=>o(e.delete(t))),clear:()=>n(e,e=>o(e.clear())),keys:()=>n(t,e=>o(e.getAllKeys())),values:()=>n(t,e=>o(e.getAll())),count:()=>n(t,e=>o(e.count())),update:async(t,r)=>n(e,async e=>{const n=await r(await o(e.get(t)));return o(e.put(n,t))}),push:(e,t)=>tinyIDB.update(e,e=>[...Array.isArray(e)?e:[],t]),merge:(e,t)=>tinyIDB.update(e,e=>({...e&&"object"==typeof e?e:{},...t}))};["get","set","remove"].forEach(e=>tinyIDB[e+"Item"]=tinyIDB[e]);export default tinyIDB;