memorio 4.6.4 → 4.6.5

package/COPYRIGHT.md

@@ -0,0 +1,6 @@
+# Copyright
+
+Copyright (c) 2025, Dario Passariello. All rights reserved.
+<https://dario.passariello.ca>
+
+This 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/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Dario Passariello
+
+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/SECURITY.md

@@ -0,0 +1,48 @@
+# Security
+
+Memorio follows NIST and NSA security standards at the enterprise level.
+
+## Security Standards
+
+- **NIST Guidelines**: Follows NIST SP 800-53 security controls and NIST Cybersecurity Framework
+- **NSA Standards**: Defense-grade security practices; considers nation-state level threats in risk assessment
+
+## Supply Chain Security
+
+- **Socket.dev**: Minimum target score 90%; all alarms must be resolved before release
+- **Dependency Management**: Zero production dependencies (fully dependency-free); dev dependencies audited regularly
+- **Prohibited**: No `eval()` usage, no encrypted/obfuscated code in builds, no hardcoded secrets
+
+## Code Security
+
+- No hardcoded credentials or API keys
+- Secure random session ID generation (`crypto.randomUUID` → `crypto.getRandomValues` → fallback)
+- Input validation on all public APIs
+- XSS prevention on DevTools data export
+- Property-based access control on global objects (`Object.defineProperty` with `enumerable: false`)
+
+## OWASP Compliance
+
+Addresses OWASP Top 10 (2021):
+- A01:2021 — Broken Access Control (global object protection, property locks)
+- A02:2021 — Cryptographic Failures (crypto.randomUUID for session IDs)
+- A03:2021 — Injection (CSS sanitization in devtools)
+- A05:2021 — Security Misconfiguration (minimal surface area, no bundled secrets)
+- A06:2021 — Vulnerable and Outdated Components (regular npm audit, Socket.dev)
+- A07:2021 — Identification and Authentication Failures (N/A — library, no auth)
+- A08:2021 — Software and Data Integrity Failures (strict tsconfig, lock files)
+- A09:2021 — Security Logging and Monitoring Failures (DevTools inspect, Logger module)
+- A10:2021 — Server-Side Request Forgery (N/A — no network requests)
+
+## Reporting Security Issues
+
+If you find a security vulnerability:
+
+1. Email [Dario Passariello](mailto:dariopassarielloa@gmail.com)
+2. Or visit https://dario.passariello.ca/contact/
+
+Do not open public issues for security vulnerabilities.
+
+---
+*Document version: 2.0 — Last updated: 2026-05-19*
+*Owner: BigLogic Security Team*

package/index.cjs

@@ -1187,7 +1187,7 @@ var Se = {
 
 i(), j(), j(), i();
 
-var Ce = "4.6.4";
+var Ce = "4.6.5";
 
 Q(), c(), Object.defineProperty(globalThis, "memorio", {
     value: {

package/index.js

@@ -1170,7 +1170,7 @@ var xe = {
 
 u(), k(), k(), u();
 
-var Ie = "4.6.4";
+var Ie = "4.6.5";
 
 te(), d(), Object.defineProperty(globalThis, "memorio", {
     value: {

package/llms.txt

@@ -0,0 +1,405 @@
+# Memorio - LLM Documentation
+
+## Overview
+
+**Memorio** is a cross-platform state management library that provides reactive state, persistence, and observation capabilities with zero dependencies. It works in Node.js, Deno, browsers, and edge environments.
+
+```
+npm i memorio
+```
+
+## Core Concepts
+
+Memorio provides 6 storage modules plus utilities:
+
+| Module | Purpose | Persistence |
+|--------|---------|-------------|
+| `state` | Reactive, volatile state | In-memory (resets on refresh) |
+| `store` | localStorage persistence | Survives browser refresh |
+| `session` | sessionStorage | Dies with browser tab |
+| `cache` | In-memory cache | Fastest read, no persistence |
+| `idb` | IndexedDB | Structured, async, persistent (browser-only) |
+| `observer` | Object watcher | Legacy |
+| `useObserver` | React hook | Auto-discovery of state paths |
+
+## Quick Start
+
+```javascript
+import 'memorio'
+
+// Set reactive state
+state.user = { name: 'Sara', role: 'admin' }
+state.counter = 0
+
+// Observe changes (React hook)
+useObserver(
+  () => { console.debug('counter:', state.counter) },
+  [state.counter]
+)
+```
+
+## API Reference
+
+### `state` — Reactive State
+
+Global, Proxy-based, reactive state management.
+
+```javascript
+// Set values
+state.user = { name: 'Sara', role: 'admin' }
+state.items = [1, 2, 3]
+state.counter = 0
+
+// Get values
+const name = state.user.name    // 'Sara'
+
+// List all keys
+console.debug(state.list)         // ['user', 'items', 'counter']
+
+// Remove one key
+state.remove('items')
+
+// Clear all
+state.removeAll()
+
+// Lock/unlock for frozen objects
+state.lock()    // freeze everything
+state.unlock()  // unfreeze
+```
+
+**Features:**
+- Automatic path tracking via `__path` property
+- Nested proxy support
+- Lock/unlock per-key or globally
+- Auto-dispatches events on changes
+
+### `store` — localStorage Persistence
+
+Persistent storage that survives browser refresh.
+
+```javascript
+// Set
+store.set('preferences', { theme: 'dark' })
+
+// Get
+const prefs = store.get('preferences')  // { theme: 'dark' } or null
+
+// List all keys
+store.list()  // { preferences: { theme: 'dark' } }
+
+// Remove
+store.remove('preferences')
+
+// Delete (alias for remove)
+store.delete('preferences')
+
+// Clear all memorio items
+store.removeAll()
+
+// Clear all (alias for removeAll)
+store.clearAll()
+
+// Check size
+console.debug(store.size(), 'chars stored')
+
+// Check if persistent (real localStorage vs memory fallback)
+console.debug(store.isPersistent)  // true → real localStorage
+
+// Estimate quota usage (returns [0, 0] for localStorage)
+await store.quota()  // [usage, quota] in KB
+```
+
+### `session` — sessionStorage
+
+Storage that dies when browser tab closes.
+
+```javascript
+// Set
+session.set('token', 'user-abc-123')
+
+// Get
+const token = session.get('token')  // 'user-abc-123' or null
+
+// List all keys
+session.list()  // { token: 'user-abc-123' }
+
+// Remove
+session.remove('token')
+
+// Delete (alias for remove)
+session.delete('token')
+
+// Clear all
+session.removeAll()
+
+// Clear all (alias for removeAll)
+session.clearAll()
+
+// Check size
+console.debug(session.size(), 'chars stored')
+
+// Check if persistent
+console.debug(session.isPersistent)
+```
+
+### `cache` — In-Memory Cache
+
+Fastest possible read, data lost on refresh.
+
+```javascript
+// Set
+cache.set('temp', computeExpensiveResult())
+
+// Get
+const result = cache.get('temp')  // undefined or the value
+
+// List all keys
+cache.list()  // { temp: <value> }
+
+// Remove
+cache.remove('temp')
+
+// Clear all
+cache.clear()
+
+// Remove all (alias for clear)
+cache.removeAll()
+
+// Direct access (also works)
+cache['myKey'] = value
+const value = cache['myKey']
+delete cache['myKey']
+```
+
+### `idb` — IndexedDB
+
+Structured, persistent, async database (browser-only).
+
+```javascript
+// Create database
+await idb.db.create('my-db', 1)  // version defaults to 1
+
+// Create table (object store)
+await idb.table.create('my-db', 'users')
+
+// Set data
+await idb.data.set('my-db', 'users', { id: 1, name: 'Sara' })
+
+// Get data by key
+const user = await idb.data.get('my-db', 'users', 1)
+
+// Delete data
+await idb.data.delete('my-db', 'users', 1)
+
+// List databases
+const dbs = await idb.db.list()
+
+// Check if database exists
+const exists = await idb.db.exist('my-db')
+
+// Delete database
+await idb.db.delete('my-db')
+
+// Get database size
+const size = await idb.db.size('my-db')
+
+// Get table size
+const tableSize = await idb.table.size('my-db', 'users')
+
+// Check support
+idb.db.support()  // true if IndexedDB available
+
+// Check quota
+const [usage, quota] = await idb.db.quota()
+```
+
+**Note:** In Node.js/Deno, `idb` is disabled with a warning. Use `store` or `session` instead.
+
+### `observer` — Object Watcher
+
+Legacy observer API. Use `useObserver` instead.
+
+```javascript
+// Listen to state changes
+observer('state.user', (newVal, oldVal) => {
+  console.debug('user changed:', newVal, oldVal)
+})
+
+// Toggle listening (no callback)
+observer('state.counter')
+
+// Remove observer
+observer.remove('state.user')
+
+// List all observers
+console.debug(observer.list)
+
+// Remove all observers
+observer.removeAll()
+```
+
+### `useObserver` — React Hook
+
+Primary way to observe state changes in React components.
+
+```jsx
+import 'memorio'
+import { useReducer } from 'react'
+
+function Counter() {
+  const [, forceUpdate] = useReducer(x => x + 1, 0)
+
+  // Auto-discovery mode (no deps)
+  useObserver(() => {
+    console.debug('counter:', state.counter)
+  }, state.counter)
+
+  // Explicit deps mode
+  useObserver(
+    () => { console.debug('user:', state.user) },
+    [state.user]
+  )
+
+  return <div>Count: {state.counter}</div>
+}
+```
+
+**Features:**
+- Auto-discovery of state paths during render
+- Returns cleanup function to stop monitoring
+- Supports both Proxy objects and string paths
+
+### `devtools` — Inspection Tools
+
+Inspect all memorio data in console.
+
+```javascript
+// Pretty-print state, store, session, cache
+memorio.devtools.inspect()
+
+// Get stats
+memorio.devtools.stats()  // { stateKeys, storeKeys, sessionKeys, ... }
+
+// Clear specific module
+memorio.devtools.clear('state')
+
+// Clear all modules
+memorio.devtools.clearAll()
+
+// Export all data as JSON
+memorio.devtools.exportData()
+
+// Import data from JSON
+memorio.devtools.importData(jsonString)
+
+// Show help
+memorio.devtools.help()
+
+// Console shortcuts
+$state    // same as globalThis.state
+$store    // same as globalThis.store
+$session  // same as globalThis.session
+$cache    // same as globalThis.cache
+```
+
+### `logger` — Change Tracking
+
+Track every state change with timestamps.
+
+```javascript
+// Configure logger
+memorio.logger.configure({
+  enabled: true,
+  logToConsole: true,
+  modules: ['state', 'store', 'session', 'cache', 'idb']
+})
+
+// Get history
+memorio.logger.getHistory()  // [{ timestamp, module, action, path, value }, ...]
+
+// Get stats
+memorio.logger.getStats()    // { total, state, store, session, cache, idb, set, get, ... }
+
+// Clear history
+memorio.logger.clearHistory()
+
+// Export logs
+memorio.logger.exportLogs()  // JSON string of all history
+```
+
+## 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 caps = memorio.getCapabilities()
+// { platform: 'browser', hasLocalStorage: true, hasIndexedDB: true, sessionId: 'uuid', ... }
+
+// Create isolated context
+memorio.createContext('tenant-name')
+memorio.listContexts()
+memorio.deleteContext('context-id')
+memorio.isolate('tenant-name')  // alias for createContext
+```
+
+## Cross-Platform Support
+
+| Module | Browser | Node.js | Deno | Edge/Workers |
+|--------|---------|---------|------|--------------|
+| `state` | ✅ | ✅ | ✅ | ✅ |
+| `observer` / `useObserver` | ✅ | ✅ | ✅ | ✅ |
+| `cache` | ✅ | ✅ | ✅ | ✅ |
+| `store` | ✅ localStorage | ⚠️ memory | ⚠️ memory | ✅ localStorage |
+| `session` | ✅ sessionStorage | ⚠️ memory | ⚠️ memory | ✅ sessionStorage |
+| `idb` | ✅ IndexedDB | ❌ | ❌ | ⚠️ |
+| `devtools` | ✅ | ❌ | ❌ | ⚠️ |
+
+**Note:** `store` and `session` fall back to in-memory `Map` in Node.js/Deno.
+
+## Session Isolation
+
+Each browser tab and server request gets an isolated namespace automatically via session IDs.
+
+```javascript
+// Create isolated context
+memorio.createContext('tenant-name')
+memorio.listContexts()
+memorio.deleteContext('context-id')
+memorio.isolate('tenant-name')  // alias for createContext
+```
+
+## Security
+
+- Zero production dependencies
+- NIST & NSA aligned security standards
+- No `eval`, no obfuscation, no hardcoded secrets
+- All inputs validated, keys sanitized
+- Secure random session IDs via `crypto.randomUUID`
+
+## License
+
+MIT © Dario Passariello (BigLogic Inc Canada)
+
+## Utilities
+
+### `memorio.dispatch` — Event Dispatch System
+
+Internal event system used by state changes.
+
+```javascript
+// Dispatch a custom event
+memorio.dispatch.set('custom:event', { detail: { data: 'value' } })
+
+// Listen for an event
+memorio.dispatch.listen('custom:event', (e) => {
+  console.debug('Event triggered:', e.detail)
+})
+
+// Remove listener
+memorio.dispatch.remove('custom:event')
+```

package/package.json

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