@storix-js/persist 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,24 @@
+# @storix-js/persist
+
+Persistence plugin for Storix with `localStorage` and `indexedDB` backends.
+
+## Install
+
+```bash
+npm install @storix-js/core @storix-js/persist
+```
+
+## Usage
+
+```ts
+import { createStorix } from '@storix-js/core';
+import { persistPlugin } from '@storix-js/persist';
+
+const storix = createStorix({
+  plugins: [
+    persistPlugin({ storage: 'localStorage', debounce: 100 })
+  ]
+});
+```
+
+Use `storage: 'indexedDB'` for larger or more durable client-side state.

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@storix-js/persist",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -19,6 +26,6 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@storix-js/core": "workspace:*"
+    "@storix-js/core": "^0.1.1"
   }
 }

package/dist/index.d.ts

@@ -1,17 +0,0 @@
-type PersistStorage = 'localStorage' | 'indexedDB';
-export interface IndexedDBPersistOptions {
-    dbName?: string;
-    storeName?: string;
-}
-export interface PersistPluginOptions {
-    keyPrefix?: string;
-    include?: string[];
-    storage?: PersistStorage;
-    serialize?: (value: Record<string, unknown>) => string;
-    deserialize?: (raw: string) => Record<string, unknown>;
-    debounce?: number;
-    indexedDB?: IndexedDBPersistOptions;
-}
-export declare function persistPlugin(options?: PersistPluginOptions): import("@storix-js/core").StorePlugin;
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,KAAK,cAAc,GAAG,cAAc,GAAG,WAAW,CAAC;AAEnD,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC;IACvD,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AASD,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,yCAuL/D"}

package/src/index.ts

@@ -1,210 +0,0 @@
-import { definePlugin } from '@storix-js/core';
-
-type PersistStorage = 'localStorage' | 'indexedDB';
-
-export interface IndexedDBPersistOptions {
-  dbName?: string;
-  storeName?: string;
-}
-
-export interface PersistPluginOptions {
-  keyPrefix?: string;
-  include?: string[];
-  storage?: PersistStorage;
-  serialize?: (value: Record<string, unknown>) => string;
-  deserialize?: (raw: string) => Record<string, unknown>;
-  debounce?: number;
-  indexedDB?: IndexedDBPersistOptions;
-}
-
-type ScopedStore = {
-  $id: string;
-  $namespace: string;
-  $scopeId: string;
-  $patch: (patch: Record<string, unknown>, origin?: 'local' | 'remote') => void;
-};
-
-export function persistPlugin(options: PersistPluginOptions = {}) {
-  const keyPrefix = options.keyPrefix ?? 'storix';
-  const include = new Set(options.include ?? []);
-  const storage = options.storage ?? 'localStorage';
-  const serialize = options.serialize ?? JSON.stringify;
-  const deserialize = options.deserialize ?? ((raw: string) => JSON.parse(raw) as Record<string, unknown>);
-  const debounceMs = options.debounce ?? 100;
-  const idbDatabaseName = options.indexedDB?.dbName ?? `${keyPrefix}-persist`;
-  const idbStoreName = options.indexedDB?.storeName ?? 'stores';
-
-  const cache = new Map<string, Record<string, unknown>>();
-  const timers = new Map<string, ReturnType<typeof setTimeout>>();
-
-  let dbPromise: Promise<IDBDatabase> | null = null;
-
-  const shouldPersistStore = (store: ScopedStore) => {
-    const ids = [store.$id, store.$scopeId];
-    if (include.size > 0 && !ids.some((value) => include.has(value))) return false;
-    return true;
-  };
-
-  const getKey = (store: ScopedStore) => `${keyPrefix}:${store.$namespace}:${store.$id}`;
-
-  const getDb = () => {
-    if (dbPromise) return dbPromise;
-
-    dbPromise = new Promise<IDBDatabase>((resolve, reject) => {
-      const request = window.indexedDB.open(idbDatabaseName, 1);
-      request.onupgradeneeded = () => {
-        const db = request.result;
-        if (!db.objectStoreNames.contains(idbStoreName)) {
-          db.createObjectStore(idbStoreName);
-        }
-      };
-      request.onsuccess = () => resolve(request.result);
-      request.onerror = () => reject(request.error ?? new Error('IndexedDB open failed'));
-    });
-
-    return dbPromise;
-  };
-
-  const readFromIndexedDb = async (store: ScopedStore) => {
-    const db = await getDb();
-    const key = getKey(store);
-
-    return new Promise<Record<string, unknown> | null>((resolve, reject) => {
-      const tx = db.transaction(idbStoreName, 'readonly');
-      const req = tx.objectStore(idbStoreName).get(key);
-
-      req.onsuccess = () => {
-        const result = req.result;
-        if (typeof result !== 'string') {
-          resolve(null);
-          return;
-        }
-
-        try {
-          resolve(deserialize(result));
-        } catch {
-          resolve(null);
-        }
-      };
-
-      req.onerror = () => reject(req.error ?? new Error('IndexedDB read failed'));
-    });
-  };
-
-  const writeToIndexedDb = async (store: ScopedStore, value: Record<string, unknown>) => {
-    const db = await getDb();
-    const key = getKey(store);
-    const raw = serialize(value);
-
-    return new Promise<void>((resolve, reject) => {
-      const tx = db.transaction(idbStoreName, 'readwrite');
-      tx.objectStore(idbStoreName).put(raw, key);
-
-      tx.oncomplete = () => resolve();
-      tx.onerror = () => reject(tx.error ?? new Error('IndexedDB write failed'));
-      tx.onabort = () => reject(tx.error ?? new Error('IndexedDB write aborted'));
-    });
-  };
-
-  const readSnapshot = async (store: ScopedStore) => {
-    if (typeof window === 'undefined') return null;
-
-    if (storage === 'indexedDB' && 'indexedDB' in window) {
-      try {
-        return await readFromIndexedDb(store);
-      } catch {
-        return null;
-      }
-    }
-
-    try {
-      const raw = window.localStorage.getItem(getKey(store));
-      if (!raw) return null;
-      return deserialize(raw);
-    } catch {
-      return null;
-    }
-  };
-
-  const writeSnapshot = (store: ScopedStore) => {
-    if (typeof window === 'undefined') return;
-
-    const snapshot = cache.get(store.$scopeId);
-    if (!snapshot) return;
-
-    if (storage === 'indexedDB' && 'indexedDB' in window) {
-      void writeToIndexedDb(store, snapshot).catch(() => {
-        // noop
-      });
-      return;
-    }
-
-    try {
-      window.localStorage.setItem(getKey(store), serialize(snapshot));
-    } catch {
-      // noop
-    }
-  };
-
-  const scheduleWrite = (store: ScopedStore) => {
-    const timerKey = store.$scopeId;
-    const existing = timers.get(timerKey);
-    if (existing) {
-      clearTimeout(existing);
-      timers.delete(timerKey);
-    }
-
-    if (debounceMs <= 0) {
-      writeSnapshot(store);
-      return;
-    }
-
-    const timer = setTimeout(() => {
-      timers.delete(timerKey);
-      writeSnapshot(store);
-    }, debounceMs);
-
-    timers.set(timerKey, timer);
-  };
-
-  const flush = (store: ScopedStore) => {
-    const timerKey = store.$scopeId;
-    const timer = timers.get(timerKey);
-    if (timer) {
-      clearTimeout(timer);
-      timers.delete(timerKey);
-    }
-    writeSnapshot(store);
-  };
-
-  return definePlugin({
-    name: 'persist',
-    onInit(store) {
-      const scopedStore = store as ScopedStore;
-      if (typeof window === 'undefined') return;
-      if (!shouldPersistStore(scopedStore)) return;
-
-      void (async () => {
-        const snapshot = await readSnapshot(scopedStore);
-        if (!snapshot) return;
-        cache.set(scopedStore.$scopeId, snapshot);
-        scopedStore.$patch(snapshot, 'remote');
-      })();
-    },
-    onMutation(store, mutation) {
-      const scopedStore = store as ScopedStore;
-      if (typeof window === 'undefined') return;
-      if (!shouldPersistStore(scopedStore)) return;
-
-      const snapshot = cache.get(scopedStore.$scopeId) ?? {};
-      snapshot[mutation.key] = mutation.newValue;
-      cache.set(scopedStore.$scopeId, snapshot);
-      scheduleWrite(scopedStore);
-    },
-    onDispose(store) {
-      const scopedStore = store as ScopedStore;
-      if (!shouldPersistStore(scopedStore)) return;
-      flush(scopedStore);
-    }
-  });
-}

package/tsconfig.build.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "paths": {}
-  }
-}

package/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "include": ["src"]
-}

package/vite.config.ts

@@ -1,15 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-  build: {
-    lib: {
-      entry: 'src/index.ts',
-      name: 'StorixPersist',
-      fileName: 'index',
-      formats: ['es', 'cjs']
-    }
-  },
-  test: {
-    environment: 'node'
-  }
-});