memorio 4.1.6 → 4.2.0

package/README.md

@@ -59,12 +59,24 @@ Just import it and start storing.
 
 ---
 
-## Quick Start
+## Installation options
 
 ```bash
+# npm
 npm i memorio
+
+# pnpm
+pnpm add memorio
+
+# yarn
+yarn add memorio
+
+# React peer dep (optional, React ≥ 16.8)
+npm i react react-dom
 ```
 
+## **Setup**
+
 ```typescript
 // memorio/index.ts — import once at your app entry point
 import 'memorio'
@@ -113,7 +125,7 @@ state.lock()       // freeze everything
 state.unlock()     // unfreeze
 ```
 
-### `store` — localStorage, survives refresh
+### `store` — survives refresh
 
 ```javascript
 store.set('preferences', { theme: 'dark' })
@@ -124,7 +136,7 @@ console.debug(store.size(), 'chars stored')
 console.debug(store.isPersistent)         // true → real localStorage
 ```
 
-### `session` — sessionStorage, dies with tab
+### `session` — dies with tab
 
 ```javascript
 session.set('token', 'user-abc-123')
@@ -140,7 +152,7 @@ const result = cache.get('temp')           // undefined or the value
 cache.clear()                              // empty it all
 ```
 
-### `idb` — IndexedDB, structured & typed
+### `idb` — structured & typed
 
 ```javascript
 await idb.db.create('my-db')
@@ -236,20 +248,6 @@ Memorio runs in every JavaScript environment, with automatic fallbacks.
 
 > **Why memory fallbacks on the server?** There is no browser. `store` and `session` gracefully fall back to `Map`. You still get the same API. Same `state`, same `cache`, same `useObserver`. No extra config required.
 
-### Platform detection
-
-Access via `memorio.*` after `import 'memorio'`:
-
-```javascript
-memorio.isBrowser()       // true in Chrome, Firefox, Safari
-memorio.isNode()          // true in Node.js
-memorio.isDeno()          // true in Deno
-memorio.isEdge()          // true in Cloudflare Workers, Vercel Edge
-
-const c = memorio.getCapabilities()
-// { platform: 'browser', hasLocalStorage: true, hasIndexedDB: true, ... }
-```
-
 ---
 
 ## Security
@@ -263,45 +261,6 @@ const c = memorio.getCapabilities()
 
 ---
 
-## Installation options
-
-```bash
-# npm
-npm i memorio
-
-# pnpm
-pnpm add memorio
-
-# yarn
-yarn add memorio
-
-# React peer dep (optional, React ≥ 16.8)
-npm i react react-dom
-```
-
----
-
-## Testing
-
-```
-95 tests  ·  8 suites  ·  all passing
-
-basic | state | store | session | cache | idb | observer | useObserver
-```
-
-| Suite | Tests | Status |
-|-------|-------|--------|
-| Basic | 7 | ✅ |
-| State | 24 | ✅ |
-| Store | 17 | ✅ |
-| Session | 12 | ✅ |
-| IDB | 7 | ✅ |
-| Cache | 5 | ✅ |
-| Observer | 12 | ✅ |
-| useObserver | 12 | ✅ |
-
----
-
 ## License
 
 MIT © [Dario Passariello](https://dario.passariello.ca)

package/docs/README.md

@@ -59,12 +59,24 @@ Just import it and start storing.
 
 ---
 
-## Quick Start
+## Installation options
 
 ```bash
+# npm
 npm i memorio
+
+# pnpm
+pnpm add memorio
+
+# yarn
+yarn add memorio
+
+# React peer dep (optional, React ≥ 16.8)
+npm i react react-dom
 ```
 
+## **Setup**
+
 ```typescript
 // memorio/index.ts — import once at your app entry point
 import 'memorio'
@@ -113,7 +125,7 @@ state.lock()       // freeze everything
 state.unlock()     // unfreeze
 ```
 
-### `store` — localStorage, survives refresh
+### `store` — survives refresh
 
 ```javascript
 store.set('preferences', { theme: 'dark' })
@@ -124,7 +136,7 @@ console.debug(store.size(), 'chars stored')
 console.debug(store.isPersistent)         // true → real localStorage
 ```
 
-### `session` — sessionStorage, dies with tab
+### `session` — dies with tab
 
 ```javascript
 session.set('token', 'user-abc-123')
@@ -140,7 +152,7 @@ const result = cache.get('temp')           // undefined or the value
 cache.clear()                              // empty it all
 ```
 
-### `idb` — IndexedDB, structured & typed
+### `idb` — structured & typed
 
 ```javascript
 await idb.db.create('my-db')
@@ -236,20 +248,6 @@ Memorio runs in every JavaScript environment, with automatic fallbacks.
 
 > **Why memory fallbacks on the server?** There is no browser. `store` and `session` gracefully fall back to `Map`. You still get the same API. Same `state`, same `cache`, same `useObserver`. No extra config required.
 
-### Platform detection
-
-Access via `memorio.*` after `import 'memorio'`:
-
-```javascript
-memorio.isBrowser()       // true in Chrome, Firefox, Safari
-memorio.isNode()          // true in Node.js
-memorio.isDeno()          // true in Deno
-memorio.isEdge()          // true in Cloudflare Workers, Vercel Edge
-
-const c = memorio.getCapabilities()
-// { platform: 'browser', hasLocalStorage: true, hasIndexedDB: true, ... }
-```
-
 ---
 
 ## Security
@@ -263,45 +261,6 @@ const c = memorio.getCapabilities()
 
 ---
 
-## Installation options
-
-```bash
-# npm
-npm i memorio
-
-# pnpm
-pnpm add memorio
-
-# yarn
-yarn add memorio
-
-# React peer dep (optional, React ≥ 16.8)
-npm i react react-dom
-```
-
----
-
-## Testing
-
-```
-95 tests  ·  8 suites  ·  all passing
-
-basic | state | store | session | cache | idb | observer | useObserver
-```
-
-| Suite | Tests | Status |
-|-------|-------|--------|
-| Basic | 7 | ✅ |
-| State | 24 | ✅ |
-| Store | 17 | ✅ |
-| Session | 12 | ✅ |
-| IDB | 7 | ✅ |
-| Cache | 5 | ✅ |
-| Observer | 12 | ✅ |
-| useObserver | 12 | ✅ |
-
----
-
 ## License
 
 MIT © [Dario Passariello](https://dario.passariello.ca)

package/docs/markdown/PLATFORM.md

@@ -125,9 +125,8 @@ session.isPersistent; // false - data lost on restart
 Each instance/session gets unique storage keys to prevent conflicts:
 
 ```javascript
-// Keys are prefixed with session ID
-// store: "memorio_store_[sessionId]_key"
-// session: "memorio_session_[sessionId]_key"
+// Without context: "memorio_store_[sessionId]_key"
+// With context: "[contextName]-key"
 ```
 
 This ensures:
@@ -146,7 +145,11 @@ For server-side applications handling multiple tenants (e.g., different users/re
 
 ```javascript
 // Create isolated context for a user/session
-const ctx = memorio.createContext('user-123');
+const ctx = memorio.isolate('user-123');
+
+// Keys in store/session are prefixed with context name
+// store: "user-123-key"
+// session: "user-123-key"
 
 // Use context's isolated storage
 ctx.state.user = { name: 'Isolated User' };
@@ -167,11 +170,10 @@ console.debug(contexts); // ['user-123', 'user-456', ...]
 
 // Delete a context (cleanup)
 memorio.deleteContext('user-123');
-
-// Shorthand for createContext
-const ctx2 = memorio.isolate('tenant-A');
 ```
 
+> **Note**: `memorio.isolate('name')` is a shorthand alias for creating isolated contexts.
+
 ### Context Use Cases
 
 #### 1. Per-Request Isolation (Express/Fastify)
@@ -246,10 +248,9 @@ Same as browser - localStorage and sessionStorage are available.
 
 | Function | Returns | Description |
 |----------|---------|-------------|
-| `memorio.createContext(name?)` | `Context` | Create isolated context |
+| `memorio.isolate(name?)` | `Context` | Create isolated context |
 | `memorio.listContexts()` | `string[]` | List all context IDs |
 | `memorio.deleteContext(id)` | `boolean` | Delete a context |
-| `memorio.isolate(name?)` | `Context` | Alias for createContext |
 
 ### Properties
 

package/docs/markdown/SECURITY.md

@@ -108,18 +108,23 @@ Each session gets a unique namespace to prevent data leakage:
 
 ### Isolation Mechanism
 
-| Component | Isolation Method |
-|-----------|-----------------|
-| Session ID | `crypto.randomUUID()` |
-| Store Keys | `memorio_store_[uuid]_keyname` |
-| Session Keys | `memorio_session_[uuid]_keyname` |
-| State | In-memory (per-instance) |
+| Component | Without Context | With Context |
+|-----------|-----------------|--------------|
+| Session ID | `crypto.randomUUID()` | Context name |
+| Store Keys | `memorio_store_[uuid]-keyname` | `[contextName]-keyname` |
+| Session Keys | `memorio_session_[uuid]-keyname` | `[contextName]-keyname` |
+| State | In-memory (per-instance) | In-memory (per-instance) |
 
 ### Key Prefix Format
 
 ```
-memorio_store_[session-uuid]_username
-memorio_session_[session-uuid]_auth-token
+// Without context:
+memorio_store-[session-uuid]-username
+memorio_session-[session-uuid]-auth-token
+
+// With context (createContext('user-123')):
+user-123-username
+user-123-auth-token
 ```
 
 ### Cross-Session Protection
@@ -138,8 +143,8 @@ For server-side applications, contexts provide complete data isolation:
 
 ```typescript
 // Create isolated context per tenant
-const tenantA = memorio.createContext('tenant-A')
-const tenantB = memorio.createContext('tenant-B')
+const tenantA = memorio.isolate('tenant-A')
+const tenantB = memorio.isolate('tenant-B')
 
 // Each context has completely separate storage
 tenantA.state.secret = 'Tenant A data'  // Isolated