memorio 4.1.6 → 4.2.1

package/{docs/markdown → 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 → 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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "memorio",
   "codeName": "memorio",
-  "version": "4.1.6",
+  "version": "4.2.1",
   "description": "Memorio, State + Observer, Store and iDB for an easy life - Cross-platform compatible",
   "main": "./index.cjs",
   "browser": "./index.cjs",

package/types/memorio.d.ts

@@ -54,6 +54,7 @@ interface _memorio {
     session: any
     cache: any
   }
+  help?: () => void
 }
 
 type memorio = _memorio

package/docs/README.md

@@ -1,307 +0,0 @@
-# [memorio](https://npmjs.com/package/memorio)
-
-![image](https://raw.githubusercontent.com/passariello/container/refs/heads/main/memorio/banner.svg)
-
-![version](https://img.shields.io/npm/v/memorio.svg)
-![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=memorio&query=$.install.pretty&label=install%20size&style=flat-square)
-![downloads](https://img.shields.io/npm/dm/memorio.svg)
-
-![Node.js](https://img.shields.io/badge/Node.js-gray?logo=node.js)
-![Browser](https://img.shields.io/badge/Browser-gray?logo=google-chrome)
-![Deno](https://img.shields.io/badge/Deno-gray?logo=deno)
-![TypeScript](https://img.shields.io/badge/TypeScript-gray?logo=typescript)
-![MIT](https://img.shields.io/badge/MIT-green?logo=open-source-initiative)
-![tsup](https://img.shields.io/badge/tsup-gray?logo=tsup)
-
-**State management that actually makes your life easier.**
-Zero friction. Zero bloat. Single import. Works everywhere JavaScript runs.
-
-[Get Started](#-quick-start) · [API Reference](#-api-reference) · [License: MIT](https://opensource.org/licenses/MIT)
-
----
-
-## Why memorio?
-
-| | memorio | Redux | Zustand |
-|---|---|---|---|
-| **Setup** | 1 import | Boilerplate hell | Moderate |
-| **Dependencies** | **Zero** | Many | Few |
-| **TypeScript** | ✅ Native | ✅ | ✅ |
-| **Binary storage** | ✅ Built-in IDB | ❌ Add-on | ❌ |
-| **Observer** | ✅ Built-in | ❌ Add-on | ❌ |
-| **DevTools** | ✅ Built-in + dphelper-manager extension | ❌ Extension | ❌ |
-| **Running on the edge** | ✅ Workers, Deno | ⚠️ Limited | ⚠️ Limited |
-
-If you need a `store` on the server. A `cache` in the edge worker.
-Session isolation in Next.js. IndexedDB in a Service Worker.
-All from one import, zero configuration.
-
----
-
-## Features
-
-| | |
-|---|---|
-| **`state`** | Reactive, volatile state — listen with `useObserver` |
-| **`store`** | localStorage persistence — survives refresh |
-| **`session`** | sessionStorage — dies with the tab |
-| **`cache`** | In-memory cache — fastest read possible |
-| **`idb`** | IndexedDB with typed tables — structured, persistent, async |
-| **`observer`** | Object watcher — legacy, still works |
-| **`useObserver`** | React hook with auto-discovery — drops in |
-| **`devtools`** | `memorio.devtools.inspect()` — see everything in console |
-| **`logger`** | Auto-log every state change with timestamps |
-| **Session Isolation** | Every browser tab, every request: isolated namespace |
-| **Platform Detection** | `isBrowser`, `isNode`, `isDeno`, `isEdge` |
-
-No Zustand. No Redux. No provider boilerplate.
-Just import it and start storing.
-
----
-
-## Quick Start
-
-```bash
-npm i memorio
-```
-
-```typescript
-// memorio/index.ts — import once at your app entry point
-import 'memorio'
-
-// Memory
-state.user = { name: 'Sara', role: 'admin' }
-state.counter++
-state.settings = { theme: 'dark', lang: 'it' }
-
-// Call it "a store" but make it observe automatically
-useObserver(
-  () => { console.debug('user changed:', state.user) },
-  [state.user]
-)
-```
-
-That is it.
-No context providers. No `<Store>` wrappers. No action creators.
-Import → assign → done.
-
----
-
-## API Reference
-
-### `state` — Volatile reactive state
-
-Global, Proxy-based, reactive. Access anywhere.
-
-```javascript
-// Set
-state.user = { name: 'Sara', role: 'admin' }
-state.items = [1, 2, 3]
-
-// Get
-const name = state.user.name    // 'Sara'
-
-// List all keys
-console.debug(state.list)         // ['user', 'items']
-
-// Remove one key
-state.remove('items')
-
-// Clear all — lock/unlock available for frozen objects
-state.removeAll()
-state.lock()       // freeze everything
-state.unlock()     // unfreeze
-```
-
-### `store` — localStorage, survives refresh
-
-```javascript
-store.set('preferences', { theme: 'dark' })
-const prefs = store.get('preferences')     // { theme: 'dark' } or null
-store.remove('preferences')
-store.removeAll()
-console.debug(store.size(), 'chars stored')
-console.debug(store.isPersistent)         // true → real localStorage
-```
-
-### `session` — sessionStorage, dies with tab
-
-```javascript
-session.set('token', 'user-abc-123')
-const token = session.get('token')         // 'user-abc-123' or null
-session.removeAll()
-```
-
-### `cache` — In-memory, disappears on refresh
-
-```javascript
-cache.set('temp', computeExpensiveResult())
-const result = cache.get('temp')           // undefined or the value
-cache.clear()                              // empty it all
-```
-
-### `idb` — IndexedDB, structured & typed
-
-```javascript
-await idb.db.create('my-db')
-await idb.table.create('my-db', 'users')
-await idb.data.set('my-db', 'users', { id: 1, name: 'Sara' })
-const user = await idb.data.get('my-db', 'users', 1)
-```
-
-### `observer` — Object watcher (DEPRECATED)
-
-```javascript
-globalThis.observer('state.user', (newVal, oldVal) => {
-  console.debug('user changed:', newVal, oldVal)
-})
-```
-
-### `useObserver` — React observer hook
-
-Available globally after `import 'memorio'`.
-
-```jsx
-import 'memorio'
-
-function Counter() {
-  const [, forceUpdate] = useReducer(x => x + 1, 0)
-
-  useObserver(forceUpdate, [state.counter])
-  // State path auto-discovered during render — no manual deps needed
-
-  return <div>Count: {state.counter}</div>
-}
-```
-
-### `devtools` — inspect everything in one call
-
-```javascript
-memorio.devtools.inspect()   // pretty-prints state, store, session, cache
-memorio.devtools.stats()     // { stateKeys, storeKeys, sessionKeys, ... }
-memorio.devtools.clear('state')
-memorio.devtools.exportData() // JSON snapshot
-$state  // console shortcut — same as globalThis.state
-```
-
-> **Browser Extension Integration:** When used with dphelper-manager browser extension, memorio's global state namespace is automatically detected and visualized through a dedicated DevTools panel, providing time-travel debugging and structural guardrails.
-
-### `logger` — track every change
-
-```javascript
-memorio.logger.configure({ enabled: true, logToConsole: true })
-memorio.logger.getHistory()   // [{ timestamp, module, action, path, value }, ...]
-memorio.logger.getStats()     // { total, state, set, get, ... }
-memorio.logger.exportLogs()   // JSON string of all history
-```
-
-### Platform detection
-
-Access via `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 caps = memorio.getCapabilities()
-// { platform: 'browser', hasLocalStorage: true, hasIndexedDB: true, ... }
-```
-
-### Context (multi-tenant)
-
-```javascript
-memorio.createContext('tenant-name')
-memorio.listContexts()
-memorio.deleteContext('context-id')
-memorio.isolate('tenant-name')
-```
-
----
-
-## Cross-Platform
-
-Memorio runs in every JavaScript environment, with automatic fallbacks.
-
-| | Browser | Node.js | Deno | Edge / Workers |
-|---|---|---|---|---|
-| `state` | ✅ | ✅ | ✅ | ✅ |
-| `observer` / `useObserver` | ✅ | ✅ | ✅ | ✅ |
-| `cache` | ✅ | ✅ | ✅ | ✅ |
-| `store` | ✅ localStorage | ⚠️ memory | ⚠️ memory | ✅ localStorage |
-| `session` | ✅ sessionStorage | ⚠️ memory | ⚠️ memory | ✅ sessionStorage |
-| `idb` | ✅ IndexedDB | ❌ | ❌ | ⚠️ |
-| `devtools` | ✅ | ❌ | ❌ | ⚠️ |
-
-> **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
-
-- Zero production dependencies — no supply chain surprises
-- NIST & NSA aligned — enterprise-grade security standards
-- No `eval`, no obfuscation, no hardcoded secrets
-- All inputs validated, keys sanitized, errors caught
-- Secure random session IDs via `crypto.randomUUID`
-- MIT license — full audit trail on [`SECURITY.md`](.github/SECURITY.md)
-
----
-
-## 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/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-modernist