offdex 1.0.3 → 1.0.4

package/README.md

@@ -15,9 +15,7 @@ npm install offdex
 
 ## Quick start
 ```js
-import { OfflineStorage } from "offdex";
-
-const storage = new OfflineStorage();
+import { storage } from "offdex";
 
 const profile = {
   id: crypto.randomUUID(), // UUIDv4 string
@@ -34,19 +32,21 @@ await storage.delete(profile.id);
 ```
 
 ## API
+### `storage`
+- Ready-to-use singleton instance shared across every import in the same origin.
+- Uses the `offline` database and `objects` store under the hood.
+
 ### `class OfflineStorage`
-- `constructor()` — opens (or creates) the `offline` database with the `objects` store.
+- `constructor()` — opens (or creates) the `offline` database with the `objects` store. Use this only if you need a separate instance.
 - `put(object: { id: UUIDv4 } & Record<string, unknown>): Promise<void>` — upserts an object keyed by `id`.
 - `get(id: UUIDv4): Promise<{ id: UUIDv4 } & Record<string, unknown> | undefined>` — fetches by `id`, returning `undefined` when missing.
 - `delete(id: UUIDv4): Promise<void>` — removes an object by `id`.
 
 ### Types
 - `UUIDv4` — template literal type for UUID strings.
+- `StoredObject` — `{ id: UUIDv4 } & Record<string, unknown>`.
 
 ## Notes
 - Runs in any environment that exposes `indexedDB` (secure contexts in modern browsers).
 - Data is shared per origin; open multiple tabs or workers and you will see the same store.
 - There is no schema migration system; keep your stored objects backward compatible or manage migrations externally if you need them.
-
-## Quick manual test
-Open `in-browser-testing.html` in a browser (or serve it locally) to poke at the API from DevTools: the module attaches `OfflineStorage` to `globalThis`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "offdex",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "ID-driven object storage wrapper for IndexedDB with zero schema/versioning overhead. Shared across all browser threads, offline-persistent, large capacity, simple API.",
   "keywords": [
     "indexeddb",

package/src/index.d.ts

@@ -17,3 +17,5 @@ export class OfflineStorage {
    */
   delete(id: UUIDv4): Promise<void>;
 }
+
+export const storage: OfflineStorage;

package/src/index.js

@@ -28,13 +28,13 @@ export class OfflineStorage {
 
   constructor() {
     this.storage = OfflineStorage.#open();
-  }
-
-  /**
-   * @param {import("./types").StoredObject} object
-   * @returns {Promise<void>}
-   */
-  async put(object) {
+  }
+
+  /**
+   * @param {import("./types").StoredObject} object
+   * @returns {Promise<void>}
+   */
+  async put(object) {
     const db = await this.storage;
     return new Promise((resolve, reject) => {
       const tx = db.transaction(OfflineStorage.#store, "readwrite");
@@ -45,12 +45,12 @@ export class OfflineStorage {
       tx.onerror = () => reject(new Error(`[OfflineStorage] ${tx.error}`));
     });
   }
-
-  /**
-   * @param {import("./types").UUIDv4} id
-   * @returns {Promise<import("./types").StoredObject | undefined>}
-   */
-  async get(id) {
+
+  /**
+   * @param {import("./types").UUIDv4} id
+   * @returns {Promise<import("./types").StoredObject | undefined>}
+   */
+  async get(id) {
     const db = await this.storage;
     return new Promise((resolve, reject) => {
       const tx = db.transaction(OfflineStorage.#store, "readonly");
@@ -63,11 +63,11 @@ export class OfflineStorage {
       tx.onerror = () => reject(new Error(`[OfflineStorage] ${tx.error}`));
     });
   }
-  /**
-   *
-   * @param {import("./types").UUIDv4} id
-   * @returns {Promise<void>}
-   */
+  /**
+   *
+   * @param {import("./types").UUIDv4} id
+   * @returns {Promise<void>}
+   */
   async delete(id) {
     const db = await this.storage;
     return new Promise((resolve, reject) => {
@@ -79,3 +79,5 @@ export class OfflineStorage {
     });
   }
 }
+
+export const storage = new OfflineStorage();