@nexus-state/persist 0.1.0

package/.eslintrc.js

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

package/.turbo/turbo-build.log

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

package/.turbo/turbo-lint.log

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

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @nexus-state/persist
+
+## 0.1.0
+
+### Minor Changes
+
+- feat: Add family atoms support
+
+### Patch Changes
+
+- Updated dependencies
+  - @nexus-state/core@0.1.0

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+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 declare function persist<T>(atom: Atom<T>, config: PersistConfig<T>): (store: Store) => void;
+/**
+ * Predefined localStorage storage implementation.
+ */
+export declare const localStorageStorage: PersistStorage;
+/**
+ * Predefined sessionStorage storage implementation.
+ */
+export declare const sessionStorageStorage: PersistStorage;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;IACxC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC;IACjC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CA0B1F;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,cAIjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,cAInC,CAAC"}

package/dist/index.js

@@ -0,0 +1,58 @@
+/**
+ * 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(atom, config) {
+    return (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 = {
+    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 = {
+    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),
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AA+BA;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,OAAO,CAAI,IAAa,EAAE,MAAwB;IAChE,OAAO,CAAC,KAAY,EAAE,EAAE;QACtB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,MAAM,CAAC;QAEtF,4CAA4C;QAC5C,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,iBAAiB,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;gBAClD,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,kDAAkD,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;YACjF,CAAC;QACH,CAAC;QAED,+CAA+C;QAC/C,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE;YACzB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC;gBACH,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;gBACzC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,sCAAsC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAmB;IACjD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;IACxF,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,YAAY,KAAK,WAAW,IAAI,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC;IAChG,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,YAAY,KAAK,WAAW,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC;CACzF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAmB;IACnD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,cAAc,KAAK,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;IAC5F,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,cAAc,KAAK,WAAW,IAAI,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC;IACpG,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,cAAc,KAAK,WAAW,IAAI,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC;CAC7F,CAAC"}

package/index.ts

@@ -0,0 +1,90 @@
+// 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/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@nexus-state/persist",
+  "version": "0.1.0",
+  "main": "index.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "test": "vitest",
+    "lint": "eslint . --ext .ts"
+  },
+  "dependencies": {
+    "@nexus-state/core": "*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vitest": "^0.34.0",
+    "eslint": "^8.40.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "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"]
+}