memorio 2.5.3 → 2.6.5

package/docs/OBSERVER.md

@@ -1,180 +0,0 @@
-# Observer - Memorio
-
-> ⚠️ **DEPRECATED**: This function is deprecated and will be removed in future versions. Please use [`useObserver`](USEOBSERVER.md) instead.
-
-Observer lets you react to state changes. When a state key changes, your callback function runs.
-
-## Installation
-
-```bash
-npm install memorio
-```
-
-```javascript
-import 'memorio';
-```
-
----
-
-## Quick Examples
-
-### Example 1: Basic Usage
-
-```javascript
-// Simple observer (DEPRECATED - use useObserver instead)
-console.warn('observer() is deprecated. Please use useObserver() for React or memorio.dispatch for vanilla JS.');
-
-observer('state.counter', (newValue) => {
-  console.log('Counter is now:', newValue);
-});
-
-state.counter = 1;
-// Output: "Counter is now: 1"
-
-state.counter = 5;
-// Output: "Counter is now: 5"
-```
-
-> **Note**: For new projects, use [`useObserver`](USEOBSERVER.md) for React or [`memorio.dispatch`](SUMMARY.md) for vanilla JS.
-
-### Example 2: Intermediate
-
-```javascript
-// Observer with old value
-observer('state.user', (newValue, oldValue) => {
-  console.log(`User changed from ${oldValue?.name} to ${newValue?.name}`);
-});
-
-state.user = { name: 'Mario' };
-// Output: "User changed from undefined to Mario"
-
-state.user = { name: 'Luigi' };
-// Output: "User changed from Mario to Luigi"
-```
-
-### Example 3: Advanced
-
-```javascript
-// Multiple observers
-const obs1 = observer('state.data', handler1);
-const obs2 = observer('state.data', handler2);
-
-// List all observers
-console.log(observer.list);
-// Output: [{ name: 'state.data', id: '...' }, ...]
-
-// Remove specific observer
-observer.remove('state.data');
-
-// Remove all observers
-observer.removeAll();
-```
-
----
-
-## API Reference
-
-### observer(path, callback)
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `path` | `string` | State path to watch (e.g., `'state.counter'`) |
-| `callback` | `function` | Function called on change |
-
-### Callback Parameters
-
-```javascript
-observer('state.key', (newValue, oldValue) => {
-  // newValue: the new value
-  // oldValue: the previous value
-});
-```
-
-### Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `observer.list` | `Array` | Get all active observers |
-
-### Methods
-
-| Method | Parameters | Description |
-|--------|------------|-------------|
-| `observer.remove(name)` | `string` | Remove observer for specific path |
-| `observer.removeAll()` | none | Remove all observers |
-
----
-
-## React Integration
-
-### With useState
-
-```javascript
-const [count, setCount] = useState(0);
-
-observer('state.counter', () => {
-  setCount(state.counter);
-});
-```
-
-### With useEffect
-
-```javascript
-useEffect(() => {
-  const handleChange = (newVal) => {
-    console.log('Changed:', newVal);
-  };
-
-  observer('state.data', handleChange);
-
-  // Cleanup
-  return () => observer.remove('state.data');
-}, []);
-```
-
----
-
-## How It Works
-
-Observer subscribes to state changes via the Proxy's set trap. When `state.key = value` is called:
-1. The Proxy intercepts the set
-2. Fires all callbacks registered for that path
-3. Callbacks receive newValue and oldValue
-
----
-
-## Best Practices
-
-1. Clean up observers in React `useEffect` return
-2. Use specific paths: `'state.user.name'` not `'state'`
-3. Remove observers when components unmount
-4. Use `observer.removeAll()` on page navigation
-
----
-
-## Common Patterns
-
-### Form Validation
-
-```javascript
-observer('state.form.email', (email) => {
-  const isValid = email.includes('@');
-  state.form.isValid = isValid;
-});
-```
-
-### Analytics
-
-```javascript
-observer('state.page', (page) => {
-  analytics.track('page_view', { page });
-});
-```
-
-### Auto-save
-
-```javascript
-observer('state.draft', (content) => {
-  store.set('autosave', content);
-});
-```

package/docs/SESSION.md

@@ -1,129 +0,0 @@
-# Session - Memorio
-
-Session provides temporary storage using browser sessionStorage. Data persists until the tab or window is closed.
-
-## Installation
-
-```bash
-npm install memorio
-```
-
-```javascript
-import 'memorio';
-```
-
----
-
-## Quick Examples
-
-### Example 1: Basic Usage
-
-```javascript
-// Save session data
-session.set('token', 'abc123');
-session.set('userId', 42);
-
-// Read session data
-console.log(session.get('token')); // "abc123"
-```
-
-### Example 2: Intermediate
-
-```javascript
-// Store objects
-session.set('user', { name: 'Mario', role: 'admin' });
-
-// Remove specific item
-session.remove('token');
-
-// Clear all session data
-session.removeAll();
-```
-
-### Example 3: Advanced
-
-```javascript
-// Check if session has data
-if (session.get('authToken')) {
-  // User is logged in
-}
-
-// Get storage quota (returns Promise<[usage, quota]> in KB)
-const [used, total] = await session.quota();
-console.log(`Using ${used} out of ${total} KB`);
-
-// Get total size in characters
-const size = session.size();
-console.log(`${size} bytes`);
-
-// Handle session expiry
-window.addEventListener('storage', (e) => {
-  if (e.key === 'session' && !e.newValue) {
-    // Session cleared
-    redirectToLogin();
-  }
-});
-```
-
----
-
-## API Reference
-
-### Methods
-
-| Method | Parameters | Returns | Description |
-|--------|------------|---------|-------------|
-| `session.get(name)` | `name: string` | `any` | Get value from session |
-| `session.set(name, value)` | `name: string, value: any` | `void` | Save value to session |
-| `session.remove(name)` | `name: string` | `boolean` | Remove single item |
-| `session.delete(name)` | `name: string` | `boolean` | Alias for remove |
-| `session.removeAll()` | `none` | `boolean` | Clear all session data |
-| `session.clearAll()` | `none` | `boolean` | Alias for removeAll |
-| `session.size()` | `none` | `number` | Get total size in characters |
-| `session.quota()` | `none` | `Promise<[number, number]>` | Get storage usage/quota in KB |
-
----
-
-## Store vs Session
-
-| Feature | Store | Session |
-|---------|-------|---------|
-| Storage | localStorage | sessionStorage |
-| Lifetime | Forever | Until tab closes |
-| Use case | User preferences | Temporary auth |
-| Shared across tabs | Yes | No |
-
----
-
-## Best Practices
-
-1. Use for auth tokens: `session.set('token', jwt)`
-2. Clear on logout: `session.removeAll()`
-3. Don't use for persistent data
-4. Check for null: `session.get('key') || defaultValue`
-
----
-
-## Common Use Cases
-
-### Authentication
-
-```javascript
-// Login
-session.set('authToken', response.token);
-session.set('user', response.user);
-
-// Logout
-session.removeAll();
-router.push('/login');
-```
-
-### Form Progress
-
-```javascript
-// Save form draft
-session.set('formDraft', formData);
-
-// Restore on page refresh
-const draft = session.get('formDraft');
-if (draft) restoreForm(draft);

package/docs/STATE.md

@@ -1,135 +0,0 @@
-# State - Memorio
-
-State is a reactive global state manager using JavaScript Proxies. It's simple, powerful, and requires no setup. Data persists only in memory during the session.
-
-## Installation
-
-```bash
-npm install memorio
-```
-
-```javascript
-import 'memorio';
-```
-
-That's it. `state` is now global.
-
----
-
-## Quick Examples
-
-### Example 1: Basic Usage
-
-```javascript
-// Set a value
-state.name = 'Mario';
-state.age = 25;
-
-// Get a value
-console.log(state.name); // "Mario"
-
-// Simple object
-state.user = { name: 'Luigi', level: 1 };
-```
-
-### Example 2: Intermediate
-
-```javascript
-// Array operations
-state.items = [1, 2, 3];
-state.items.push(4);
-console.log(state.items); // [1, 2, 3, 4]
-
-// Nested objects
-state.config = { theme: 'dark', lang: 'en' };
-state.config.theme = 'light';
-
-// List all states
-console.log(state.list);
-```
-
-### Example 3: Advanced
-
-```javascript
-// Lock state to prevent modifications
-state.frozenConfig = { maxUsers: 100 };
-state.frozenConfig.lock();
-// Now state.frozenConfig cannot be modified
-
-// Path tracking
-const path = state.user.path;
-console.log(path.name); // "user"
-console.log(path.profile.name); // "user.profile"
-
-// Get full path as string
-console.log(state.user.__path); // "state.user"
-
-// Protected keys (internal use)
-console.log(protect); // Array of protected keys
-```
-
----
-
-## API Reference
-
-### Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `state.list` | Array | Get all current state keys (deep copy) |
-| `state.path` | Object | Get path tracker for current location |
-| `state.__path` | string | Get full path as string |
-
-### Methods
-
-| Method | Parameters | Description |
-|--------|------------|-------------|
-| `state.remove(key)` | `key: string` | Remove a specific state |
-| `state.removeAll()` | none | Clear all states |
-
-### Lock
-
-```javascript
-// Lock an object or array
-state.myArray = [1, 2, 3];
-state.myArray.lock();
-
-// Now any modification will fail
-state.myArray.push(4); // Error: state 'myArray' is locked
-```
-
----
-
-## How It Works
-
-Memorio uses JavaScript `Proxy` to intercept get/set operations on the global `state` object. This allows:
-
-1. **Reactivity** - Any change can trigger observers
-2. **Nested objects** - Deep path tracking
-3. **Type safety** - Full TypeScript support
-
----
-
-## Best Practices
-
-1. Use descriptive keys: `state.userProfile` not `state.up`
-2. Group related data: `state.cart.items` not `state.cartItems`
-3. Lock static config: `state.appConfig.lock()`
-4. Clean up on logout: `state.removeAll()`
-5. Use path tracking for debugging: `state.myData.__path`
-
----
-
-## Common Errors
-
-```javascript
-// Error: protected key
-state._internal = 'value';
-// Output: "key _internal is protected"
-
-// Error: locked state
-state.locked = { x: 1 };
-state.locked.lock();
-state.locked.x = 2;
-// Output: "Error: state 'locked' is locked"
-```

package/docs/STORE.md

@@ -1,137 +0,0 @@
-# Store - Memorio
-
-Store provides persistent localStorage management with a simple API. Data survives page refreshes and browser restarts.
-
-## Installation
-
-```bash
-npm install memorio
-```
-
-```javascript
-import 'memorio';
-```
-
----
-
-## Quick Examples
-
-### Example 1: Basic Usage
-
-```javascript
-// Save data
-store.set('username', 'Mario');
-store.set('score', 1500);
-
-// Read data
-console.log(store.get('username')); // "Mario"
-console.log(store.get('score'));    // 1500
-```
-
-### Example 2: Intermediate
-
-```javascript
-// Store objects
-store.set('user', { name: 'Luigi', level: 5 });
-const user = store.get('user');
-console.log(user.name); // "Luigi"
-
-// Remove single item
-store.remove('username');
-
-// Check size
-const totalSize = store.size();
-console.log(`${totalSize} bytes`);
-```
-
-### Example 3: Advanced
-
-```javascript
-// Get storage quota (returns Promise<[usage, quota]> in KB)
-const [used, total] = await store.quota();
-console.log(`Using ${used} out of ${total} KB`);
-
-// Get total size in characters
-const size = store.size();
-console.log(`${size} bytes`);
-
-// Clear all data
-store.removeAll();
-// or use alias
-store.clearAll();
-
-// Handle errors gracefully
-try {
-  store.set('largeData', hugeObject);
-} catch (err) {
-  console.error('Storage full:', err);
-}
-```
-
----
-
-## API Reference
-
-### Methods
-
-| Method | Parameters | Returns | Description |
-|--------|------------|---------|-------------|
-| `store.get(name)` | `name: string` | `any` | Get value from storage |
-| `store.set(name, value)` | `name: string, value: any` | `void` | Save value to storage |
-| `store.remove(name)` | `name: string` | `boolean` | Remove single item |
-| `store.delete(name)` | `name: string` | `boolean` | Alias for remove |
-| `store.removeAll()` | none | `boolean` | Clear all storage |
-| `store.clearAll()` | none | `boolean` | Alias for removeAll |
-| `store.size()` | none | `number` | Get total size in characters |
-| `store.quota()` | none | `Promise<[number, number]>` | Get storage usage/quota in KB |
-
-### Supported Types
-
-```javascript
-// All JSON-serializable types work
-store.set('string', 'hello');
-store.set('number', 42);
-store.set('boolean', true);
-store.set('array', [1, 2, 3]);
-store.set('object', { key: 'value' });
-store.set('null', null);
-store.set('undefined', null); // converted to null
-```
-
-### Not Supported
-
-```javascript
-// Functions will log an error
-store.set('myFunc', () => {});
-// Output: "It's not secure to store functions."
-```
-
----
-
-## How It Works
-
-Store wraps the browser's `localStorage` API with:
-
-- Automatic JSON serialization/deserialization
-- Error handling for parse failures
-- Size calculation
-- Quota monitoring
-
----
-
-## Storage Limits
-
-- **Chrome/Safari**: ~5-10 MB
-- **Firefox**: ~10 MB
-- **Edge**: ~5-10 MB
-
-Use `store.quota()` to monitor usage.
-
----
-
-## Best Practices
-
-1. Prefix keys: `store.set('app_username', '...')`
-2. Check before set: `if (store.get('key')) { ... }`
-3. Handle quota: Try/catch around large data
-4. Clean up: `store.removeAll()` on logout

package/docs/SUMMARY.md

@@ -1,25 +0,0 @@
-# Table of contents
-
-* [README](../README.md)
-
-## Core Modules
-
-* [State](STATE.md) - Reactive global state management
-* [Observer](OBSERVER.md) - ⚠️ Deprecated (use useObserver)
-* [useObserver](USEOBSERVER.md) - React hook for state observation
-* [Cache](CACHE.md) - In-memory caching (lost on refresh)
-* [Store](STORE.md) - Persistent localStorage management
-* [Session](SESSION.md) - Temporary sessionStorage management
-* [IDB](IDB.md) - IndexedDB for large data storage
-
-## Additional Resources
-
-* [License](../LICENSE.md)
-* [Contributing](../CONTRIBUTING.md)
-* [Code of Conduct](../CODE_OF_CONDUCT.md)
-* [Security](../SECURITY.md)
-
-## Changelog
-
-* [Changelog](../CHANGELOG.md)
-* [History](../HISTORY.md)