svelte-persistent-runes 2.0.0

package/LICENSE.md

@@ -0,0 +1,22 @@
+# The MIT License (MIT)
+
+Copyright (c) 2024 [MacFJA](https://github.com/MacFJA)
+Copyright (c) 2025 [andrescera](https://github.com/andrescera)
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

package/README.md

@@ -0,0 +1,299 @@
+# Svelte persistent runes
+
+A Svelte reactive rune that keep its value through pages and reloads
+
+![GitHub Repo stars](https://img.shields.io/github/stars/andrescera/svelte-persistent-runes?style=social)
+![NPM bundle size](https://img.shields.io/bundlephobia/minzip/svelte-persistent-runes)
+![Download per week](https://img.shields.io/npm/dw/svelte-persistent-runes)
+![License](https://img.shields.io/npm/l/svelte-persistent-runes)
+![NPM version](https://img.shields.io/npm/v/svelte-persistent-runes)
+[![Checked with Biome](https://img.shields.io/badge/Checked_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev)
+
+## Installation
+
+With [NPM](https://www.npmjs.com/package/svelte-persistent-runes)
+```sh
+npm install --save-dev svelte-persistent-runes
+# or
+yarn add --save-dev svelte-persistent-runes
+# or
+pnpm add --save-dev svelte-persistent-runes
+# or
+deno install --dev npm:svelte-persistent-runes
+```
+
+## Quickstart
+
+Update your `./svelte.config.js` to add a new preprocessor:
+```diff
+ import adapter from '@sveltejs/adapter-auto';
++import persist from "svelte-persistent-runes/preprocessor"
+ const config = {
++ 	preprocess: [persist()],
+	kit: {
+		adapter: adapter()
+	}
+ };
+ export default config;
+```
+
+Replace your `$state` with `$persist`:
+```diff
+ <script>
++import "svelte-persistent-runes"
+-let count = $state(0);
++let count = $persist(0, 'counter');
+ </script>
+```
+
+## Usage
+
+This library have 2 parts:
+- A preprocessor to add the `$persist` rune (and optionally a Vite plugin).
+- A set of configuration to persist your data.
+
+You MUST add the preprocessor to use `$persist`.
+It's as simple as to add it in your Svelte configuration (`svelte.config.js`) with the import of `svelte-persistent-runes/plugins`
+
+<details>
+<summary>./svelte.config.js</summary>
+
+```js
+import adapter from '@sveltejs/adapter-auto';
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+import { persistPreprocessor } from "svelte-persistent-runes/plugins"
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+	preprocess: [vitePreprocess(), persistPreprocessor()],
+	kit: {
+		adapter: adapter()
+	}
+};
+
+export default config;
+```
+
+</details>
+
+> [!IMPORTANT]
+> If you are using `*.svelte.js`/`*.svelte.ts` file you need to also add a Vite plugin:
+> <details><summary>./vite.config.ts</summary>
+>
+> ```ts
+> import { sveltekit } from '@sveltejs/kit/vite';
+> import { defineConfig } from 'vite';
+> import { persistPlugin as persist } from "svelte-persistent-runes/plugins";
+>
+> export default defineConfig({
+>   plugins: [persist(), sveltekit()]
+> });
+> ```
+>
+> </details>
+
+Now that the preprocessor is added, you can use the `$persist` rune instead of the `$state` rune.
+
+<details>
+<summary>./src/anywhere/component.svelte</summary>
+
+```html
+<script>
+import "svelte-persistent-runes"
+let count = $persist(0, 'counter');
+</script>
+<div class="counter">
+    <button onclick={() => (count -= 1)} aria-label="Decrease the counter by one">-</button>
+    <div><strong>{count}</strong></div>
+    <button onclick={() => (count += 1)} aria-label="Increase the counter by one">+</button>
+</div>
+```
+
+</details>
+
+<details>
+<summary>./src/anywhere/data.svelte.ts</summary>
+
+```ts
+import "svelte-persistent-runes"
+export class Person {
+    name = $persist('John', 'user-name')
+    age = $persist(33, 'user-age')
+    
+    greet(): string {
+        return `Hello ${this.name}`;
+    }
+    birthday(): string {
+        this.age += 1;
+        return `Happy birthday ${this.name}!`
+    }
+}
+export const currentUser = new Person()
+```
+
+</details>
+
+> [!IMPORTANT]
+> You need to import `import "svelte-persistent-runes"` to prevent Typescript to complain about the unknown function `$persist`
+>
+> ---
+>
+> You can add this import in an ambient Typescript Module (like `./src/app.d.ts` in SvelteKit), and you won't need to import it in every file
+
+### Definition
+
+```ts
+type PersistentRunesOptions = {
+    /**
+     * Convert the source data into its string representation
+     * @param input The source data
+     * @return The string representation of data
+     */
+    serialize<T>(input: T): string;
+    /**
+     * Convert back the string representation into the source data
+     * @param input The string representation of the date
+     * @return The new data based on its string representation
+     */
+    deserialize<T>(input: string): T;
+    /**
+     * Write data into the store
+     * @param key The storage key to write
+     * @param value The data to write
+     */
+    storageWrite(key: string, value: string): void;
+    /**
+     * Read data from the storage
+     * @param key The storage key to read
+     * @returns The data or `undefined` if the data don't exist in the storage
+     */
+    storageRead(key: string): string | undefined;
+};
+
+/**
+ * A reactive state, that can restore its state upon page reload
+ * @param initial The initial value of the state
+ * @param key The storage key of the state. Must be unique in your application
+ * @param options The persistence options (how and where)
+ */
+declare function $persist<T>(initial: T, key: string, options?: Partial<PersistentRunesOption>)
+```
+
+### Options
+
+You can customize how and where the state value is persisted.
+
+The `$persist` runes take a third (and optional) parameter of type `PersistentRunesOption`.
+
+The options consist of 2 main part: the serializer and the storage. It can be defined as a plain object or as the result of the `buildOptions` (imported from `svelte-persistent-runes/options`)
+
+```ts
+/**
+ * Create a `PersistentRunesOptions` from a serializer and a storage
+ * @param serializer The serializer to use (if `undefined` then `JsonSerializer` will be used)
+ * @param storage The storage to use (if `undefined` then `BrowserLocalStorage` will be used)
+ */
+declare function buildOptions(
+    serializer: PersistentRunesSerializer | undefined, 
+    storage: PersistentRunesStorage | undefined
+): PersistentRunesOptions;
+```
+
+
+#### The serializer
+
+The serializer part of the option are:
+ - `serialize`: This function is responsible for converting the original type into a string
+ - `deserialize`: This function is responsible to convert back a string to the original type
+
+The library have several built-in serializer:
+ - `JsonSerializerFactory`: factory to create a JSON based serializer
+   - `JsonSerializer`: A basic JSON serializer (no replacer, nor reviver)
+ - `DevalueSerializerFactory`: factory to create a [Devalue] based serializer
+   - `DevalueSerializer`: A basic [Devalue] serializer (no reducers, nor revivers)
+ - `ESSerializerSerializerFactory`: factory to create a [ESSerializer] based serializer
+   - `ESSerializerSerializer`: A basic [ESSerializer] serializer (no SerializeOptions, nor classes)
+ - `MacfjaSerializerFactory`: factory to create a [@macfja/serializer] based serializer
+   - `MacfjaSerializer`: A basic [@macfja/serializer] serializer (no additional classes mapping)
+ - `SuperJsonSerializer`: A [superjson] serializer
+ - `NextJsonSerializerFactory`: factory to create a [next-json] based serializer
+   - `NextJsonSerializerFactory`: A basic [next-json] serializer (no options, nor replacers, nor revivers)
+ - `PhpSerializeSerializerFactory`: factory to create a [php-serialize] based serializer
+   - `PhpSerializeSerializer`: A basic [php-serialize] serializer (no options)
+ - `SerializeAnythingSerializerFactory`: factory to create a [serialize-anything] based serializer
+   - `SerializeAnythingSerializer`: A basic [serialize-anything] serializer (no options)
+
+[ESSerializer]: https://www.npmjs.com/package/esserializer
+[Devalue]: https://www.npmjs.com/package/devalue
+[@macfja/serializer]: https://www.npmjs.com/package/@macfja/serializer
+[superjson]: https://www.npmjs.com/package/superjson
+[next-json]: https://www.npmjs.com/package/next-json
+[php-serialize]: https://www.npmjs.com/package/php-serialize
+[serialize-anything]: https://www.npmjs.com/package/serialize-anything
+
+#### The storage
+
+The storage part of the option are:
+ - `storageWrite`: This function is responsible to write data into the storage
+ - `storageRead`: This function is responsible to read data from the storage
+
+The library have several built-in storage:
+- `BrowserCookieStorageFactory`: factory to create a Cookie based storage (DOM API, browser only)
+   - `BrowserCookieStorage`: A basic Cookie storage (no particular options, except for `samesite: Strict`)
+- `BrowserLocalStorage`: a browser localStorage storage ([DOM API](https://developer.mozilla.org/en-US/docs/Web/API/Storage), browser only)
+- `BrowserSessionStorage`: a browser sessionStorage storage ([DOM API](https://developer.mozilla.org/en-US/docs/Web/API/Storage), browser only)
+- `addEncryptionStorage`: a wrapper function to add AES [GCM encryption] on stored data
+
+[GCM encryption]: https://en.wikipedia.org/wiki/Galois/Counter_Mode
+
+#### Example
+
+<details>
+
+<summary>Browser session storage and @macfja/serializer</summary>
+
+```html
+<script>
+import "svelte-persistent-runes"
+import {
+    buildOptions,
+    MacfjaSerializer,
+    BrowserSessionStorage
+} from "svelte-persistent-runes/options"
+let count = $persist(0, 'counter', buildOptions(MacfjaSerializer, BrowserSessionStorage));
+</script>
+<div class="counter">
+    <button onclick={() => (count -= 1)} aria-label="Decrease the counter by one">-</button>
+    <div><strong>{count}</strong></div>
+    <button onclick={() => (count += 1)} aria-label="Increase the counter by one">+</button>
+</div>
+```
+
+</details>
+
+<details>
+
+<summary>Browser local storage, encrypted and SuperJson </summary>
+
+```html
+<script>
+import "svelte-persistent-runes"
+import {
+    buildOptions,
+    SuperJsonSerializer,
+    BrowserLocalStorage,
+    addEncryptionStorage
+} from "svelte-persistent-runes/options"
+let count = $persist(0, 'counter', buildOptions(
+    SuperJsonSerializer,
+    addEncryptionStorage(BrowserLocalStorage, '12345678901234567890123456879012')
+));
+</script>
+<div class="counter">
+    <button onclick={() => (count -= 1)} aria-label="Decrease the counter by one">-</button>
+    <div><strong>{count}</strong></div>
+    <button onclick={() => (count += 1)} aria-label="Increase the counter by one">+</button>
+</div>
+```
+
+</details>

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+type PersistentRunesOptions = {
+    /**
+     * Convert the source data into its string representation
+     * @param input The source data
+     * @return The string representation of data
+     */
+    serialize<T>(input: T): string;
+    /**
+     * Convert back the string representation into the source data
+     * @param input The string representation of the date
+     * @return The new data based on its string representation
+     */
+    deserialize<T>(input: string): T;
+    /**
+     * Write data into the store
+     * @param key The storage key to write
+     * @param value The data to write
+     */
+    storageWrite(key: string, value: string): void;
+    /**
+     * Read data from the storage
+     * @param key The storage key to read
+     * @returns The data or `undefined` if the data don't exist in the storage
+     */
+    storageRead(key: string): string | undefined;
+};
+declare global {
+    /**
+     * A reactive state, that can restore its state upon page reload
+     * @param initial The initial value of the state
+     * @param key The storage key of the state. Must be unique in your application
+     * @param options The persistence options (how and where)
+     */
+    export function $persist<T>(initial: T, key: string, options?: Partial<PersistentRunesOptions>): T;
+}
+declare function load<T>(key: string, options?: Partial<PersistentRunesOptions>): T | undefined;
+declare function save<T>(key: string, value: T, options?: Partial<PersistentRunesOptions>): void;
+
+export { load, save };
+export type { PersistentRunesOptions };

package/dist/index.js

@@ -0,0 +1 @@
+var m=Object.defineProperty;var e=(o,i)=>m(o,"name",{value:i,configurable:!0});import{buildOptions as n}from"./options.js";import"browser-cookies";import"sjcl-codec-hex/from-bits.js";import"sjcl-codec-hex/to-bits.js";import"sjcl-es";import"superjson";import"@macfja/serializer";import"devalue";import"esserializer";import"next-json";import"php-serialize";import"serialize-anything";function s(o,i){const t={...n(void 0,void 0),...i},r=t.storageRead(o);if(typeof r=="string")return t.deserialize(r)}e(s,"load");function d(o,i,t){if(i===void 0)return;const r={...n(void 0,void 0),...t},p=r.serialize(i);r.storageWrite(o,p)}e(d,"save");export{s as load,d as save};

package/dist/index.mjs

@@ -0,0 +1 @@
+var m=Object.defineProperty;var e=(o,i)=>m(o,"name",{value:i,configurable:!0});import{buildOptions as n}from"./options.mjs";import"browser-cookies";import"sjcl-codec-hex/from-bits.js";import"sjcl-codec-hex/to-bits.js";import"sjcl-es";import"superjson";import"@macfja/serializer";import"devalue";import"esserializer";import"next-json";import"php-serialize";import"serialize-anything";function s(o,i){const t={...n(void 0,void 0),...i},r=t.storageRead(o);if(typeof r=="string")return t.deserialize(r)}e(s,"load");function d(o,i,t){if(i===void 0)return;const r={...n(void 0,void 0),...t},p=r.serialize(i);r.storageWrite(o,p)}e(d,"save");export{s as load,d as save};

package/dist/options.d.ts

@@ -0,0 +1,62 @@
+import { CookieOptions } from 'browser-cookies';
+import { PersistentRunesOptions } from './index.js';
+import * as macfja from '@macfja/serializer';
+import * as dv from 'devalue';
+import ESSerializer from 'esserializer';
+import { NJSON } from 'next-json';
+import * as PhpSerialize from 'php-serialize';
+
+declare function PhpSerializeSerializerFactory(options?: {
+    givenOptions?: Parameters<typeof PhpSerialize.serialize>[2];
+    scope?: Parameters<typeof PhpSerialize.serialize>[1];
+}): PersistentRunesSerializer;
+declare function SerializeAnythingSerializerFactory(options?: {
+    maxDepth?: number;
+    pretty?: boolean;
+}): PersistentRunesSerializer;
+declare function JsonSerializerFactory(options?: {
+    replacer?: Parameters<typeof JSON.stringify>[1];
+    reviver?: Parameters<typeof JSON.parse>[1];
+    space?: Parameters<typeof JSON.stringify>[2];
+}): PersistentRunesSerializer;
+declare function DevalueSerializerFactory(options?: {
+    reducers?: Parameters<typeof dv.stringify>[1];
+    revivers?: Parameters<typeof dv.parse>[1];
+}): PersistentRunesSerializer;
+declare function ESSerializerSerializerFactory(options?: {
+    serializeOption?: Parameters<typeof ESSerializer.serialize>[1];
+    classes?: Parameters<typeof ESSerializer.deserialize>[1];
+}): PersistentRunesSerializer;
+declare function MacfjaSerializerFactory(options?: {
+    allowedClasses?: Parameters<typeof macfja.deserialize>[1];
+}): PersistentRunesSerializer;
+declare function NextJsonSerializerFactory(options?: {
+    stringifyOptionsOrReplacer?: Parameters<typeof NJSON.stringify>[1];
+    space?: Parameters<typeof NJSON.stringify>[2];
+    parseOptionsOrReviver?: Parameters<typeof NJSON.parse>[1];
+}): PersistentRunesSerializer;
+
+type PersistentRunesStorage = Pick<PersistentRunesOptions, "storageWrite" | "storageRead">;
+type PersistentRunesSerializer = Pick<PersistentRunesOptions, "serialize" | "deserialize">;
+declare const SuperJsonSerializer: PersistentRunesSerializer;
+declare function BrowserCookieStorageFactory(cookieOptions?: CookieOptions): PersistentRunesStorage;
+declare const BrowserLocalStorage: PersistentRunesStorage;
+declare const BrowserSessionStorage: PersistentRunesStorage;
+declare function addEncryptionStorage(onStorage: PersistentRunesStorage, encryptionKey: string, iv?: string): PersistentRunesStorage;
+declare const BrowserCookieStorage: PersistentRunesStorage;
+declare const JsonSerializer: PersistentRunesSerializer;
+declare const DevalueSerializer: PersistentRunesSerializer;
+declare const ESSerializerSerializer: PersistentRunesSerializer;
+declare const MacfjaSerializer: PersistentRunesSerializer;
+declare const NextJsonSerializer: PersistentRunesSerializer;
+declare const PhpSerializeSerializer: PersistentRunesSerializer;
+declare const SerializeAnythingSerializer: PersistentRunesSerializer;
+/**
+ * Create a `PersistentRunesOptions` from a serializer and a storage
+ * @param serializer The serializer to use (if `undefined` then `JsonSerializer` will be used)
+ * @param storage The storage to use (if `undefined` then `BrowserLocalStorage` will be used)
+ */
+declare function buildOptions(serializer: PersistentRunesSerializer | undefined, storage: PersistentRunesStorage | undefined): PersistentRunesOptions;
+
+export { BrowserCookieStorage, BrowserCookieStorageFactory, BrowserLocalStorage, BrowserSessionStorage, DevalueSerializer, DevalueSerializerFactory, ESSerializerSerializer, ESSerializerSerializerFactory, JsonSerializer, JsonSerializerFactory, MacfjaSerializer, MacfjaSerializerFactory, NextJsonSerializer, NextJsonSerializerFactory, PhpSerializeSerializer, PhpSerializeSerializerFactory, SerializeAnythingSerializer, SerializeAnythingSerializerFactory, SuperJsonSerializer, addEncryptionStorage, buildOptions };
+export type { PersistentRunesSerializer, PersistentRunesStorage };

package/dist/options.js

@@ -0,0 +1 @@
+var N=Object.defineProperty;var i=(e,r)=>N(e,"name",{value:r,configurable:!0});import{get as j,set as x}from"browser-cookies";import g from"sjcl-codec-hex/from-bits.js";import n from"sjcl-codec-hex/to-bits.js";import t from"sjcl-es";import*as u from"superjson";import*as d from"@macfja/serializer";import*as z from"devalue";import S from"esserializer";import{NJSON as f}from"next-json";import*as m from"php-serialize";import p from"serialize-anything";function w(e){return{deserialize(r){return m.unserialize(r,e?.scope,e?.givenOptions)},serialize(r){return m.serialize(r,e?.scope,e?.givenOptions)}}}i(w,"PhpSerializeSerializerFactory");function h(e){return{deserialize(r){return p.deserialize(r)},serialize(r){return p.serialize(r,e)}}}i(h,"SerializeAnythingSerializerFactory");function y(e){return{serialize(r){return JSON.stringify(r,e?.replacer,e?.space)},deserialize(r){return JSON.parse(r,e?.reviver)}}}i(y,"JsonSerializerFactory");function v(e){return{serialize(r){return z.stringify(r,e?.reducers)},deserialize(r){return z.parse(r,e?.revivers)}}}i(v,"DevalueSerializerFactory");function b(e){return{serialize(r){return S.serialize(r,e?.serializeOption)},deserialize(r){return S.deserialize(r,e?.classes)}}}i(b,"ESSerializerSerializerFactory");function T(e){return{serialize(r){return d.serialize(r)},deserialize(r){return d.deserialize(r,e?.allowedClasses)}}}i(T,"MacfjaSerializerFactory");function O(e){return{serialize(r){return f.stringify(r,e?.stringifyOptionsOrReplacer,e?.space)},deserialize(r){return f.parse(r,e?.parseOptionsOrReviver)}}}i(O,"NextJsonSerializerFactory");const I={serialize(e){return u.stringify(e)},deserialize(e){return u.parse(e)}};function F(e){return{storageWrite(r,a){x(r,a,{samesite:"Strict",...e})},storageRead(r){return j(r)||void 0}}}i(F,"BrowserCookieStorageFactory");const J={storageWrite(e,r){globalThis?.window&&"localStorage"in globalThis.window&&globalThis.window.localStorage.setItem(e,r)},storageRead(e){return globalThis?.window&&"localStorage"in globalThis.window&&globalThis.window.localStorage.getItem(e)||void 0}},W={storageWrite(e,r){globalThis?.window&&"sessionStorage"in globalThis.window&&globalThis.window.sessionStorage.setItem(e,r)},storageRead(e){return globalThis?.window&&"sessionStorage"in globalThis.window&&globalThis.window.sessionStorage.getItem(e)||void 0}};function E(e,r,a="spr"){const l=new t.cipher.aes(n(r));return{storageRead(s){const o=e.storageRead(s);if(o!==void 0)return t.codec.utf8String.fromBits(t.mode.gcm.decrypt(l,n(o.split(":")[0]),n(o.split(":")[1])))},storageWrite(s,o){const c=t.codec.utf8String.toBits(a),R=`${g(t.mode.gcm.encrypt(l,t.codec.utf8String.toBits(o),c,[],256))}:${g(c)}`;e.storageWrite(s,R)}}}i(E,"addEncryptionStorage");const A=F(),B=y(),C=v(),P=b(),k=T(),D=O(),H=w(),M=h();function $(e,r){return{...e??B,...r??J}}i($,"buildOptions");export{A as BrowserCookieStorage,F as BrowserCookieStorageFactory,J as BrowserLocalStorage,W as BrowserSessionStorage,C as DevalueSerializer,v as DevalueSerializerFactory,P as ESSerializerSerializer,b as ESSerializerSerializerFactory,B as JsonSerializer,y as JsonSerializerFactory,k as MacfjaSerializer,T as MacfjaSerializerFactory,D as NextJsonSerializer,O as NextJsonSerializerFactory,H as PhpSerializeSerializer,w as PhpSerializeSerializerFactory,M as SerializeAnythingSerializer,h as SerializeAnythingSerializerFactory,I as SuperJsonSerializer,E as addEncryptionStorage,$ as buildOptions};

package/dist/options.mjs

@@ -0,0 +1 @@
+var N=Object.defineProperty;var i=(e,r)=>N(e,"name",{value:r,configurable:!0});import{get as j,set as x}from"browser-cookies";import g from"sjcl-codec-hex/from-bits.js";import n from"sjcl-codec-hex/to-bits.js";import t from"sjcl-es";import*as u from"superjson";import*as d from"@macfja/serializer";import*as z from"devalue";import S from"esserializer";import{NJSON as f}from"next-json";import*as m from"php-serialize";import p from"serialize-anything";function w(e){return{deserialize(r){return m.unserialize(r,e?.scope,e?.givenOptions)},serialize(r){return m.serialize(r,e?.scope,e?.givenOptions)}}}i(w,"PhpSerializeSerializerFactory");function h(e){return{deserialize(r){return p.deserialize(r)},serialize(r){return p.serialize(r,e)}}}i(h,"SerializeAnythingSerializerFactory");function y(e){return{serialize(r){return JSON.stringify(r,e?.replacer,e?.space)},deserialize(r){return JSON.parse(r,e?.reviver)}}}i(y,"JsonSerializerFactory");function v(e){return{serialize(r){return z.stringify(r,e?.reducers)},deserialize(r){return z.parse(r,e?.revivers)}}}i(v,"DevalueSerializerFactory");function b(e){return{serialize(r){return S.serialize(r,e?.serializeOption)},deserialize(r){return S.deserialize(r,e?.classes)}}}i(b,"ESSerializerSerializerFactory");function T(e){return{serialize(r){return d.serialize(r)},deserialize(r){return d.deserialize(r,e?.allowedClasses)}}}i(T,"MacfjaSerializerFactory");function O(e){return{serialize(r){return f.stringify(r,e?.stringifyOptionsOrReplacer,e?.space)},deserialize(r){return f.parse(r,e?.parseOptionsOrReviver)}}}i(O,"NextJsonSerializerFactory");const I={serialize(e){return u.stringify(e)},deserialize(e){return u.parse(e)}};function F(e){return{storageWrite(r,a){x(r,a,{samesite:"Strict",...e})},storageRead(r){return j(r)||void 0}}}i(F,"BrowserCookieStorageFactory");const J={storageWrite(e,r){globalThis?.window&&"localStorage"in globalThis.window&&globalThis.window.localStorage.setItem(e,r)},storageRead(e){return globalThis?.window&&"localStorage"in globalThis.window&&globalThis.window.localStorage.getItem(e)||void 0}},W={storageWrite(e,r){globalThis?.window&&"sessionStorage"in globalThis.window&&globalThis.window.sessionStorage.setItem(e,r)},storageRead(e){return globalThis?.window&&"sessionStorage"in globalThis.window&&globalThis.window.sessionStorage.getItem(e)||void 0}};function E(e,r,a="spr"){const l=new t.cipher.aes(n(r));return{storageRead(s){const o=e.storageRead(s);if(o!==void 0)return t.codec.utf8String.fromBits(t.mode.gcm.decrypt(l,n(o.split(":")[0]),n(o.split(":")[1])))},storageWrite(s,o){const c=t.codec.utf8String.toBits(a),R=`${g(t.mode.gcm.encrypt(l,t.codec.utf8String.toBits(o),c,[],256))}:${g(c)}`;e.storageWrite(s,R)}}}i(E,"addEncryptionStorage");const A=F(),B=y(),C=v(),P=b(),k=T(),D=O(),H=w(),M=h();function $(e,r){return{...e??B,...r??J}}i($,"buildOptions");export{A as BrowserCookieStorage,F as BrowserCookieStorageFactory,J as BrowserLocalStorage,W as BrowserSessionStorage,C as DevalueSerializer,v as DevalueSerializerFactory,P as ESSerializerSerializer,b as ESSerializerSerializerFactory,B as JsonSerializer,y as JsonSerializerFactory,k as MacfjaSerializer,T as MacfjaSerializerFactory,D as NextJsonSerializer,O as NextJsonSerializerFactory,H as PhpSerializeSerializer,w as PhpSerializeSerializerFactory,M as SerializeAnythingSerializer,h as SerializeAnythingSerializerFactory,I as SuperJsonSerializer,E as addEncryptionStorage,$ as buildOptions};

package/dist/plugins.d.ts

@@ -0,0 +1,7 @@
+import { PreprocessorGroup } from 'svelte/compiler';
+import { Plugin } from 'vite';
+
+declare function persistPlugin(): Plugin;
+declare function persistPreprocessor(): PreprocessorGroup;
+
+export { persistPlugin, persistPreprocessor };

package/dist/plugins.js

@@ -0,0 +1,18 @@
+var v=Object.defineProperty;var l=(t,r)=>v(t,"name",{value:r,configurable:!0});import M from"magic-string";const h=/\$persist\s*\(/g,w=`import * as __persist from "svelte-persistent-runes";
+`;function C(t,r){let e=1,n=r,a=null,o=!1;for(;n<t.length&&e>0;){const c=t[n];if(o){o=!1,n++;continue}if(c==="\\"){o=!0,n++;continue}a?c===a&&(a=null):c==='"'||c==="'"||c==="`"?a=c:c==="("?e++:c===")"&&e--,n++}return n}l(C,"findMatchingParen");function P(t){const r=[];let e="",n=0,a=null,o=!1;for(let c=0;c<t.length;c++){const s=t[c];if(o){o=!1,e+=s;continue}if(s==="\\"){o=!0,e+=s;continue}a?(e+=s,s===a&&(a=null)):s==='"'||s==="'"||s==="`"?(a=s,e+=s):s==="("||s==="["||s==="{"?(n++,e+=s):s===")"||s==="]"||s==="}"?(n--,e+=s):s===","&&n===0?(r.push(e.trim()),e=""):e+=s}return e.trim()&&r.push(e.trim()),r}l(P,"splitArguments");function S(t,r){const e=t.lastIndexOf(`
+`,r-1)+1;if(t.slice(e,r).includes("//"))return!0;const a=t.slice(0,r),o=a.lastIndexOf("/*"),c=a.lastIndexOf("*/");return o!==-1&&o>c}l(S,"isInsideComment");function _(t,r){if(S(t,r))return null;const e=t.slice(0,r),n=e.match(/(?:(?:let|const|var)\s+)?(\w+)\s*=\s*$/);if(n){const a=e.match(/class\s+\w+[^{]*\{[^}]*$/);return{varName:n[1],isClassProperty:!!a}}return null}l(_,"findVarName");function y(t){const r=[];h.lastIndex=0;let e=h.exec(t);for(;e!==null;){const n=e.index,a=n+e[0].length,o=C(t,a),c=t.slice(a,o-1),s=P(c);if(s.length>=2){const i=_(t,n);i&&r.push({start:n,end:o,varName:i.varName,initial:s[0],key:s[1],options:s[2]||"undefined",isClassProperty:i.isClassProperty})}e=h.exec(t)}return r}l(y,"findPersistCalls");function N(t,r){if(!t.includes("$persist"))return null;const e=y(t);if(e.length===0)return null;const n=new M(t);n.prepend(w);const a=new Map,o=[];for(const s of e){if(s.isClassProperty){const u=t.slice(0,s.start).match(/class\s+(\w+)[^{]*\{[^}]*$/);if(u){const m=u[1],p=a.get(m)??[];p.push(s),a.set(m,p)}}else o.push(s);const i=`$state(__persist.load(${s.key}, ${s.options}) ?? ${s.initial})`;n.overwrite(s.start,s.end,i)}if(o.length>0){const s=o.map(i=>`$effect(() => __persist.save(${i.key}, $state.snapshot(${i.varName}), ${i.options}));`).join(`
+`);n.append(`
+$effect.root(() => {
+${s}
+});
+`)}for(const[s,i]of a){const u=new RegExp(`class\\s+${s}(?:\\s+extends\\s+\\w+)?\\s*\\{`).exec(t);if(u){const m=u.index+u[0].length,p=t.slice(m).match(/constructor\s*\([^)]*\)\s*\{/),d=`$effect.root(() => {
+${i.map(f=>`$effect(() => __persist.save(${f.key}, $state.snapshot(this.${f.varName}), ${f.options}));`).join(`
+`)}
+});`;if(p&&p.index!==void 0){const f=m+p.index+p[0].length;n.appendLeft(f,`
+${d}
+`)}else{const f=t.slice(u.index).match(/class\s+\w+\s+extends\s+(\w+)/),x=`
+constructor(${f?"...args: any[]":""}) {
+${f?`super(...args);
+`:""}${d}
+}
+`;n.appendLeft(m,x)}}}const c=n.generateMap({source:r,file:r,includeContent:!0,hires:!0});return{code:n.toString(),map:{version:c.version,file:c.file??r,sources:c.sources,sourcesContent:c.sourcesContent?.filter(s=>s!==null),names:c.names,mappings:c.mappings}}}l(N,"transformContent");function k(){const t=g();return{name:"svelte-persistent-runes",transform(r,e){if(!/\.svelte\.(c|m)?[jt]s$/.test(e))return null;const n=t.script?.({content:r,filename:e,attributes:{},markup:""});return!n||n.code===r?null:{code:n.code,map:n.map}}}}l(k,"persistPlugin");function g(){return{name:"svelte-persistent-runes",script({content:t,filename:r="unknown.js"}){const e=N(t,r);return e?{code:e.code,map:e.map}:{code:t}}}}l(g,"persistPreprocessor");export{k as persistPlugin,g as persistPreprocessor};

package/dist/plugins.mjs

@@ -0,0 +1,18 @@
+var v=Object.defineProperty;var l=(t,r)=>v(t,"name",{value:r,configurable:!0});import M from"magic-string";const h=/\$persist\s*\(/g,w=`import * as __persist from "svelte-persistent-runes";
+`;function C(t,r){let e=1,n=r,a=null,o=!1;for(;n<t.length&&e>0;){const c=t[n];if(o){o=!1,n++;continue}if(c==="\\"){o=!0,n++;continue}a?c===a&&(a=null):c==='"'||c==="'"||c==="`"?a=c:c==="("?e++:c===")"&&e--,n++}return n}l(C,"findMatchingParen");function P(t){const r=[];let e="",n=0,a=null,o=!1;for(let c=0;c<t.length;c++){const s=t[c];if(o){o=!1,e+=s;continue}if(s==="\\"){o=!0,e+=s;continue}a?(e+=s,s===a&&(a=null)):s==='"'||s==="'"||s==="`"?(a=s,e+=s):s==="("||s==="["||s==="{"?(n++,e+=s):s===")"||s==="]"||s==="}"?(n--,e+=s):s===","&&n===0?(r.push(e.trim()),e=""):e+=s}return e.trim()&&r.push(e.trim()),r}l(P,"splitArguments");function S(t,r){const e=t.lastIndexOf(`
+`,r-1)+1;if(t.slice(e,r).includes("//"))return!0;const a=t.slice(0,r),o=a.lastIndexOf("/*"),c=a.lastIndexOf("*/");return o!==-1&&o>c}l(S,"isInsideComment");function _(t,r){if(S(t,r))return null;const e=t.slice(0,r),n=e.match(/(?:(?:let|const|var)\s+)?(\w+)\s*=\s*$/);if(n){const a=e.match(/class\s+\w+[^{]*\{[^}]*$/);return{varName:n[1],isClassProperty:!!a}}return null}l(_,"findVarName");function y(t){const r=[];h.lastIndex=0;let e=h.exec(t);for(;e!==null;){const n=e.index,a=n+e[0].length,o=C(t,a),c=t.slice(a,o-1),s=P(c);if(s.length>=2){const i=_(t,n);i&&r.push({start:n,end:o,varName:i.varName,initial:s[0],key:s[1],options:s[2]||"undefined",isClassProperty:i.isClassProperty})}e=h.exec(t)}return r}l(y,"findPersistCalls");function N(t,r){if(!t.includes("$persist"))return null;const e=y(t);if(e.length===0)return null;const n=new M(t);n.prepend(w);const a=new Map,o=[];for(const s of e){if(s.isClassProperty){const u=t.slice(0,s.start).match(/class\s+(\w+)[^{]*\{[^}]*$/);if(u){const m=u[1],p=a.get(m)??[];p.push(s),a.set(m,p)}}else o.push(s);const i=`$state(__persist.load(${s.key}, ${s.options}) ?? ${s.initial})`;n.overwrite(s.start,s.end,i)}if(o.length>0){const s=o.map(i=>`$effect(() => __persist.save(${i.key}, $state.snapshot(${i.varName}), ${i.options}));`).join(`
+`);n.append(`
+$effect.root(() => {
+${s}
+});
+`)}for(const[s,i]of a){const u=new RegExp(`class\\s+${s}(?:\\s+extends\\s+\\w+)?\\s*\\{`).exec(t);if(u){const m=u.index+u[0].length,p=t.slice(m).match(/constructor\s*\([^)]*\)\s*\{/),d=`$effect.root(() => {
+${i.map(f=>`$effect(() => __persist.save(${f.key}, $state.snapshot(this.${f.varName}), ${f.options}));`).join(`
+`)}
+});`;if(p&&p.index!==void 0){const f=m+p.index+p[0].length;n.appendLeft(f,`
+${d}
+`)}else{const f=t.slice(u.index).match(/class\s+\w+\s+extends\s+(\w+)/),x=`
+constructor(${f?"...args: any[]":""}) {
+${f?`super(...args);
+`:""}${d}
+}
+`;n.appendLeft(m,x)}}}const c=n.generateMap({source:r,file:r,includeContent:!0,hires:!0});return{code:n.toString(),map:{version:c.version,file:c.file??r,sources:c.sources,sourcesContent:c.sourcesContent?.filter(s=>s!==null),names:c.names,mappings:c.mappings}}}l(N,"transformContent");function k(){const t=g();return{name:"svelte-persistent-runes",transform(r,e){if(!/\.svelte\.(c|m)?[jt]s$/.test(e))return null;const n=t.script?.({content:r,filename:e,attributes:{},markup:""});return!n||n.code===r?null:{code:n.code,map:n.map}}}}l(k,"persistPlugin");function g(){return{name:"svelte-persistent-runes",script({content:t,filename:r="unknown.js"}){const e=N(t,r);return e?{code:e.code,map:e.map}:{code:t}}}}l(g,"persistPreprocessor");export{k as persistPlugin,g as persistPreprocessor};

package/dist/preprocessor.d.ts

@@ -0,0 +1,3 @@
+export { persistPreprocessor as default } from './plugins.js';
+import 'svelte/compiler';
+import 'vite';

package/dist/preprocessor.js

@@ -0,0 +1 @@
+import{persistPreprocessor as s}from"./plugins.js";import"magic-string";export{s as default};

package/dist/preprocessor.mjs

@@ -0,0 +1 @@
+import{persistPreprocessor as s}from"./plugins.mjs";import"magic-string";export{s as default};

package/package.json

@@ -0,0 +1,97 @@
+{
+	"name": "svelte-persistent-runes",
+	"version": "2.0.0",
+	"description": "A Svelte reactive rune that keep its value through pages and reloads",
+	"license": "MIT",
+	"author": "andrescera",
+	"homepage": "https://github.com/andrescera/svelte-persistent-runes",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/andrescera/svelte-persistent-runes"
+	},
+	"bugs": "https://github.com/andrescera/svelte-persistent-runes/issues",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.mjs",
+			"default": "./dist/index.js"
+		},
+		"./preprocessor": {
+			"types": "./dist/preprocessor.d.ts",
+			"import": "./dist/preprocessor.mjs",
+			"default": "./dist/preprocessor.js"
+		},
+		"./plugins": {
+			"types": "./dist/plugins.d.ts",
+			"import": "./dist/plugins.mjs",
+			"default": "./dist/plugins.js"
+		},
+		"./options": {
+			"types": "./dist/options.d.ts",
+			"import": "./dist/options.mjs",
+			"default": "./dist/options.js"
+		}
+	},
+	"main": "dist/index.js",
+	"files": [
+		"dist/"
+	],
+	"scripts": {
+		"build": "pkgroll --minify --clean-dist",
+		"fix": "biome check --write .",
+		"lint": "biome check .",
+		"prepublishOnly": "npm run build",
+		"test": "ava",
+		"test:watch": "ava --watch"
+	},
+	"types": "dist/index.d.ts",
+	"dependencies": {
+		"@macfja/serializer": "^1.1.4",
+		"browser-cookies": "^1.2.0",
+		"cookie": "^1.1.1",
+		"devalue": "^5.6.1",
+		"esserializer": "^1.3.11",
+		"magic-string": "^0.30.21",
+		"next-json": "^0.5.1",
+		"php-serialize": "^5.1.3",
+		"serialize-anything": "^1.2.3",
+		"sjcl-codec-hex": "^1.0.0",
+		"sjcl-es": "^2.0.0",
+		"superjson": "^2.2.6"
+	},
+	"peerDependencies": {
+		"svelte": "^5.0.0",
+		"vite": "^5 || ^6 || ^7"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.3.10",
+		"ava": "^6.4.1",
+		"pkgroll": "^2.21.4",
+		"rollup": "^4.54.0",
+		"tsimp": "^2.0.12",
+		"typescript": "^5.9.3",
+		"vite": "^7.3.0"
+	},
+	"keywords": [
+		"cookie",
+		"encryptedStorage",
+		"localStorage",
+		"persist",
+		"persistent",
+		"rune",
+		"runes",
+		"sessionStorage",
+		"svelte",
+		"sveltejs",
+		"sveltekit"
+	],
+	"ava": {
+		"extensions": {
+			"ts": "module"
+		},
+		"nodeArguments": [
+			"--import=tsimp"
+		]
+	}
+}