@nexus-state/persist 0.1.3 → 0.1.4

package/README.md

@@ -1,37 +1,62 @@
 # @nexus-state/persist
 
-Persistence for Nexus State
+> Persistence for Nexus State — LocalStorage, sessionStorage, and custom storage adapters
+>
+> [![npm version](https://img.shields.io/npm/v/@nexus-state/persist)](https://www.npmjs.com/package/@nexus-state/persist)
+> [![npm downloads](https://img.shields.io/npm/dw/@nexus-state/persist)](https://www.npmjs.com/package/@nexus-state/persist)
+> [![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/eustatos/nexus-state/blob/main/LICENSE)
 
-## Description
+[Documentation](https://nexus-state.website.yandexcloud.net/) • [Repository](https://github.com/eustatos/nexus-state)
 
-The `@nexus-state/persist` package provides tools for saving application state between sessions.
+---
 
-## Installation
+## 🚀 Quick Start
+
+```javascript
+import { persistAtom } from '@nexus-state/persist';
+import { useAtomValue } from '@nexus-state/react';
+
+// Persist atom to localStorage
+const settingsAtom = persistAtom(
+  'settings',
+  { theme: 'dark', language: 'en' },
+  { storage: 'localStorage' }
+);
+
+// Value is automatically loaded from localStorage
+// and saved on every change
+```
+
+---
+
+## 📦 Installation
 
 ```bash
 npm install @nexus-state/persist
 ```
 
-## Key Features
+**Required:**
+```bash
+npm install @nexus-state/core
+```
 
-- State persistence in localStorage/sessionStorage
-- Support for different persistence strategies
-- Ability to selectively persist parts of the state
+---
 
-## Usage Example
+## 🔗 See Also
 
-```javascript
-import { createPersist } from '@nexus-state/persist';
+- **Core:** [@nexus-state/core](https://www.npmjs.com/package/@nexus-state/core) — Foundation (atoms, stores)
+- **Framework integration:**
+  - [@nexus-state/react](https://www.npmjs.com/package/@nexus-state/react) — React hooks
+  - [@nexus-state/vue](https://www.npmjs.com/package/@nexus-state/vue) — Vue composables
+  - [@nexus-state/svelte](https://www.npmjs.com/package/@nexus-state/svelte) — Svelte stores
+- **Related:**
+  - [@nexus-state/query](https://www.npmjs.com/package/@nexus-state/query) — Data fetching with caching
+  - [@nexus-state/form](https://www.npmjs.com/package/@nexus-state/form) — Form management
 
-const persist = createPersist({
-  key: 'my-app-state',
-  storage: localStorage
-});
+**Full ecosystem:** [Nexus State Packages](https://www.npmjs.com/org/nexus-state)
 
-// Connecting to the store
-store.use(persist);
-```
+---
 
-## License
+## 📄 License
 
 MIT

package/dist/vitest.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vite").UserConfig;
+export default _default;
+//# sourceMappingURL=vitest.config.d.ts.map

package/dist/vitest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":";AAEA,wBAoCG"}

package/dist/vitest.config.js

@@ -0,0 +1,39 @@
+import { defineConfig } from 'vitest/config';
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'jsdom',
+        coverage: {
+            provider: 'v8',
+            reporter: ['text', 'json', 'html', 'lcov'],
+            include: ['**/*.ts'],
+            exclude: [
+                'apps/**',
+                // Тестовые файлы и директории
+                '**/__tests__/**',
+                '**/__fixtures__/**',
+                '**/__mocks__/**',
+                '**/__benchmarks__/**',
+                '**/test-utils/**',
+                '**/test-utils.ts',
+                '**/*.test.ts',
+                '**/*.spec.ts',
+                '**/*.bench.ts',
+                '**/*.test-d.ts',
+                // Файлы деклараций и конфигурации
+                '**/*.d.ts',
+                '**/*.config.ts',
+                '**/*.config.js',
+                // Скомпилированные файлы и зависимости
+                '**/node_modules/**',
+                '**/dist/**',
+                '**/build/**',
+                '**/coverage/**',
+                // Прочее
+                '**/*.md',
+                '**/*.json',
+            ]
+        }
+    }
+});
+//# sourceMappingURL=vitest.config.js.map

package/dist/vitest.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,OAAO;QACpB,QAAQ,EAAE;YACR,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;YAC1C,OAAO,EAAE,CAAC,SAAS,CAAC;YACpB,OAAO,EAAE;gBACP,SAAS;gBACT,8BAA8B;gBAC9B,iBAAiB;gBACjB,oBAAoB;gBACpB,iBAAiB;gBACjB,sBAAsB;gBACtB,kBAAkB;gBAClB,kBAAkB;gBAClB,cAAc;gBACd,cAAc;gBACd,eAAe;gBACf,gBAAgB;gBAChB,kCAAkC;gBAClC,WAAW;gBACX,gBAAgB;gBAChB,gBAAgB;gBAChB,uCAAuC;gBACvC,oBAAoB;gBACpB,YAAY;gBACZ,aAAa;gBACb,gBAAgB;gBAChB,SAAS;gBACT,SAAS;gBACT,WAAW;aACZ;SACF;KACF;CACF,CAAC,CAAC"}

package/package.json

@@ -1,19 +1,36 @@
 {
   "name": "@nexus-state/persist",
-  "version": "0.1.3",
-  "main": "index.ts",
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc -w",
-    "test": "vitest",
-    "lint": "eslint . --ext .ts"
+  "version": "0.1.4",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
   },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
   "dependencies": {
-    "@nexus-state/core": "*"
+    "@nexus-state/core": "0.1.16"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^3.0.7",
     "typescript": "^5.0.0",
-    "vitest": "^0.34.0",
-    "eslint": "^8.40.0"
+    "vitest": "^3.0.7",
+    "eslint": "^8.40.0",
+    "jsdom": "^26.1.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "test": "vitest run src",
+    "test:coverage": "vitest run src --coverage",
+    "lint": "eslint . --ext .ts"
   }
-}
+}

package/.eslintrc.js

@@ -1,10 +0,0 @@
-module.exports = {
-  root: true,
-  extends: [
-    '../../.eslintrc.js'
-  ],
-  parserOptions: {
-    project: './tsconfig.json',
-    tsconfigRootDir: __dirname,
-  },
-};

package/.turbo/turbo-build.log

@@ -1,5 +0,0 @@
-⠙⠹
-> @nexus-state/persist@0.1.3 build
-> tsc
-
-⠹⠙

package/.turbo/turbo-lint.log

@@ -1,5 +0,0 @@
-⠙
-> @nexus-state/persist@0.0.0 lint
-> eslint . --ext .ts
-
-⠙⠙

package/index.ts

@@ -1,90 +0,0 @@
-// Persist plugin for nexus-state
-import { Atom, Store } from '@nexus-state/core';
-
-/**
- * Represents a storage interface for persisting atom values.
- * @typedef {Object} PersistStorage
- * @property {Function} getItem - Function to get an item from storage
- * @property {Function} setItem - Function to set an item in storage
- * @property {Function} removeItem - Function to remove an item from storage
- */
-export type PersistStorage = {
-  getItem: (key: string) => string | null;
-  setItem: (key: string, value: string) => void;
-  removeItem: (key: string) => void;
-};
-
-/**
- * Configuration options for the persist plugin.
- * @typedef {Object} PersistConfig
- * @property {string} key - The key to use for storing the atom's value
- * @property {PersistStorage} storage - The storage implementation to use
- * @property {Function} [serialize] - Function to serialize the value (defaults to JSON.stringify)
- * @property {Function} [deserialize] - Function to deserialize the value (defaults to JSON.parse)
- */
-export type PersistConfig<T> = {
-  key: string;
-  storage: PersistStorage;
-  serialize?: (value: T) => string;
-  deserialize?: (value: string) => T;
-};
-
-/**
- * Plugin to persist atom values to storage.
- * @template T - The type of the atom's value
- * @param {Atom<T>} atom - The atom to persist
- * @param {PersistConfig<T>} config - Configuration options for the plugin
- * @returns {Function} A function that applies the plugin to a store
- * @example
- * const store = createStore([
- *   persist(countAtom, { 
- *     key: 'count', 
- *     storage: localStorageStorage 
- *   })
- * ]);
- */
-export function persist<T>(atom: Atom<T>, config: PersistConfig<T>): (store: Store) => void {
-  return (store: Store) => {
-    const { key, storage, serialize = JSON.stringify, deserialize = JSON.parse } = config;
-    
-    // Attempt to restore the value from storage
-    const savedValue = storage.getItem(key);
-    if (savedValue !== null) {
-      try {
-        const deserializedValue = deserialize(savedValue);
-        store.set(atom, deserializedValue);
-      } catch (error) {
-        console.error(`Failed to deserialize persisted value for atom ${key}:`, error);
-      }
-    }
-
-    // Subscribe to atom changes to save to storage
-    store.subscribe(atom, () => {
-      const value = store.get(atom);
-      try {
-        const serializedValue = serialize(value);
-        storage.setItem(key, serializedValue);
-      } catch (error) {
-        console.error(`Failed to serialize value for atom ${key}:`, error);
-      }
-    });
-  };
-}
-
-/**
- * Predefined localStorage storage implementation.
- */
-export const localStorageStorage: PersistStorage = {
-  getItem: (key) => typeof localStorage !== 'undefined' ? localStorage.getItem(key) : null,
-  setItem: (key, value) => typeof localStorage !== 'undefined' && localStorage.setItem(key, value),
-  removeItem: (key) => typeof localStorage !== 'undefined' && localStorage.removeItem(key),
-};
-
-/**
- * Predefined sessionStorage storage implementation.
- */
-export const sessionStorageStorage: PersistStorage = {
-  getItem: (key) => typeof sessionStorage !== 'undefined' ? sessionStorage.getItem(key) : null,
-  setItem: (key, value) => typeof sessionStorage !== 'undefined' && sessionStorage.setItem(key, value),
-  removeItem: (key) => typeof sessionStorage !== 'undefined' && sessionStorage.removeItem(key),
-};

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true
-  },
-  "include": ["**/*.ts"],
-  "exclude": ["node_modules", "dist"]
-}