@coherent.js/state 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thomas Drouvin
+
+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,102 @@
+# @coherent.js/state
+
+Reactive state management for Coherent.js applications with SSR support, persistence, and validation.
+
+## Installation
+
+```bash
+npm install @coherent.js/state@beta
+# or
+pnpm add @coherent.js/state@beta
+# or
+yarn add @coherent.js/state@beta
+```
+
+## Features
+
+- **Reactive State**: Observable values with computed properties and watchers
+- **SSR-Compatible State**: Server-side state management during rendering
+- **State Persistence**: LocalStorage, SessionStorage, and IndexedDB support
+- **State Validation**: Built-in validation with custom validators
+- **Context API**: Share state across components during SSR
+- **Zero Dependencies**: Uses only @coherent.js/core as peer dependency
+
+## Usage
+
+### Reactive State (Client-Side)
+
+```javascript
+import { createReactiveState, observable, computed } from '@coherent.js/state';
+
+// Create observable values
+const count = observable(0);
+const doubled = computed(() => count.value * 2);
+
+// Watch for changes
+count.watch((newValue, oldValue) => {
+  console.log(`Count changed from ${oldValue} to ${newValue}`);
+});
+
+// Update value
+count.value = 5; // Triggers watcher and updates computed
+console.log(doubled.value); // 10
+```
+
+### SSR-Compatible State
+
+```javascript
+import { createState, provideContext } from '@coherent.js/state';
+
+// Create state container for a request
+const state = createState({ userId: 123, theme: 'dark' });
+
+// Provide context during SSR
+provideContext('request', state);
+
+// Access in components
+import { useContext } from '@coherent.js/state';
+
+function MyComponent() {
+  const requestState = useContext('request');
+  const userId = requestState.get('userId');
+  // ... render component
+}
+```
+
+### State Persistence
+
+```javascript
+import { withLocalStorage, withSessionStorage } from '@coherent.js/state';
+
+// Auto-persist to localStorage
+const userPrefs = withLocalStorage({ theme: 'dark', lang: 'en' }, 'user-prefs');
+
+// Auto-persist to sessionStorage
+const sessionData = withSessionStorage({ cart: [] }, 'session-data');
+```
+
+### State Validation
+
+```javascript
+import { createValidatedState, validators } from '@coherent.js/state';
+
+const userForm = createValidatedState(
+  { email: '', age: 0 },
+  {
+    validators: {
+      email: validators.email(),
+      age: validators.range(18, 120)
+    }
+  }
+);
+
+userForm.set('email', 'invalid-email'); // Throws validation error
+```
+
+## API Reference
+
+See the [full documentation](https://docs.coherentjs.dev/state) for detailed API reference.
+
+## License
+
+MIT