use-idb-storage 0.0.1

package/README.md

@@ -0,0 +1,6 @@
+# sohanemon/idb
+
+![npm version](https://img.shields.io/npm/v/@sohanemon/idb)
+![npm downloads](https://img.shields.io/npm/dm/@sohanemon/idb)
+![License](https://img.shields.io/npm/l/@sohanemon/idb)
+![Tests](https://github.com/sohanemon/idb/actions/workflows/test.yml/badge.svg)

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+//#region src/config.d.ts
+/**
+ * Configure global defaults for IDBStorage.
+ */
+declare function configureIDBStorage(config: {
+  database?: string;
+  store?: string;
+}): void;
+//#endregion
+//#region src/types.d.ts
+/**
+ * Configuration options for IDBStorage.
+ */
+interface IDBStorageOptions<T extends Record<string, any>> {
+  /** The key for the stored value */
+  key: string;
+  /** The default value if no value is found in IndexedDB */
+  defaultValue: T;
+  /** The name of the IndexedDB database (optional, defaults to global config) */
+  database?: string;
+  /** The name of the object store (optional, defaults to global config) */
+  store?: string;
+}
+//#endregion
+//#region src/hook.d.ts
+/**
+ * Hook to persist state in IndexedDB with a clean object-based API.
+ *
+ * @param options - Configuration object containing key, defaultValue, and optional database/store names
+ * @returns A tuple of the stored value, an async updater function, and a remove function.
+ *
+ * @example
+ * ```tsx
+ * // Configure global defaults (optional)
+ * configureIDBStorage({
+ *   database: 'myApp',
+ *   store: 'data'
+ * });
+ *
+ * const [userData, setUserData, removeUserData] = useIDBStorage({
+ *   key: 'currentUser',
+ *   defaultValue: { name: '', email: '' },
+ *   // database: 'myApp', // optional, uses global default
+ *   // store: 'users' // optional, uses global default
+ * });
+ *
+ * // Update data
+ * await setUserData({ name: 'John', email: 'john@example.com' });
+ *
+ * // Remove data
+ * await removeUserData();
+ * ```
+ */
+declare function useIDBStorage<T extends Record<string, any>>(options: IDBStorageOptions<T>): [T, (value: T | ((prevState: T) => T)) => Promise<void>, () => Promise<void>];
+//#endregion
+export { configureIDBStorage, useIDBStorage };

package/dist/index.js

@@ -0,0 +1 @@
+import*as e from"react";let t={database:`sohanemon-idb`,store:`default`};function n(e){t={...t,...e}}function r(){return{...t}}const i=(e,t,n=1)=>new Promise((r,i)=>{let a=indexedDB.open(e,n);a.onerror=()=>i(a.error),a.onsuccess=()=>r(a.result),a.onupgradeneeded=e=>{let n=e.target.result;n.objectStoreNames.contains(t)||n.createObjectStore(t)}});function a(e,t,n){return new Promise((r,i)=>{let a=e.transaction([t],`readonly`).objectStore(t).get(n);a.onerror=()=>i(a.error),a.onsuccess=()=>r(a.result)})}const o=(e,t,n,r)=>new Promise((i,a)=>{let o=e.transaction([t],`readwrite`).objectStore(t).put(r,n);o.onerror=()=>a(o.error),o.onsuccess=()=>i()}),s=(e,t,n)=>new Promise((r,i)=>{let a=e.transaction([t],`readwrite`).objectStore(t).delete(n);a.onerror=()=>i(a.error),a.onsuccess=()=>r()});function c(t){let{key:n,defaultValue:c,database:l=r().database,store:u=r().store}=t,[d,f]=e.useState(c),[p,m]=e.useState(null);return e.useEffect(()=>{let e=!0;return(async()=>{try{let t=await i(l,u);e&&m(t)}catch(e){console.error(`Failed to open IndexedDB:`,e)}})(),()=>{e=!1}},[l,u]),e.useEffect(()=>{p&&(async()=>{try{let e=await a(p,u,n);e!==void 0&&f(e)}catch(e){console.error(`Failed to load value from IndexedDB:`,e)}})()},[p,u,n]),[d,e.useCallback(async e=>{if(!p)return;let t=typeof e==`function`?e(d):e;f(t);try{await o(p,u,n,t)}catch(e){console.error(`Failed to save value to IndexedDB:`,e)}},[p,u,n,d]),e.useCallback(async()=>{if(p){f(c);try{await s(p,u,n)}catch(e){console.error(`Failed to remove value from IndexedDB:`,e)}}},[p,u,n,c])]}export{n as configureIDBStorage,c as useIDBStorage};

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "use-idb-storage",
+  "version": "0.0.1",
+  "author": "Sohan Emon <sohanemon@outlook.com>",
+  "description": "",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:list": "vitest list",
+    "test:log": "vitest run --reporter verbose",
+    "test:ui": "vitest --ui",
+    "check": "biome check .",
+    "fix": "biome check --diagnostic-level=error --write .",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write --unsafe .",
+    "format": "biome format .",
+    "format:write": "biome format . --write",
+    "typecheck": "tsgo --noEmit",
+    "release": "tsgo --noEmit && npm run build && npm publish"
+  },
+  "keywords": [
+    "use-indexeddb",
+    "indexeddb",
+    "idb",
+    "localstorage"
+  ],
+  "license": "ISC",
+  "homepage": "https://sohanjs.web.app/idb",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sohanemon/idb.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sohanemon/idb/issues"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.3.8",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.0",
+    "@tsconfig/strictest": "^2.0.8",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.5",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.1",
+    "@vitest/ui": "^4.0.14",
+    "jsdom": "^27.2.0",
+    "tsdown": "^0.16.4",
+    "typescript": "^5.9.3",
+    "vite": "npm:rolldown-vite@^7.2.5",
+    "vitest": "^4.0.14"
+  },
+  "peerDependencies": {
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  }
+}