memorio 4.9.30 → 4.9.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +126 -126
- package/README.md +239 -163
- package/examples/cross-platform-guards.ts +57 -57
- package/examples/multi-tenant-context.ts +44 -44
- package/examples/react-observer.tsx +63 -63
- package/examples/semantic-memory.ts +60 -60
- package/examples/sqlite-batched-writes.ts +57 -57
- package/index.cjs +1 -1
- package/index.js +1 -1
- package/llms.txt +1 -1
- package/modules/redux.cjs.map +1 -1
- package/modules/redux.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,18 +18,29 @@ state.counter++
|
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
No provider tree. No reducers. No actions. No boilerplate.
|
|
21
|
-
Just data
|
|
21
|
+
Just data, available where your application needs it.
|
|
22
|
+
|
|
23
|
+
**And if you don't want a global API, don't use one:**
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import { state, store, session, cache, idb, sqlite, memorio } from 'memorio'
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The global API is a **choice**, not an architectural requirement.
|
|
22
30
|
|
|
23
31
|
---
|
|
24
32
|
|
|
25
33
|
## Table of contents
|
|
26
34
|
|
|
27
35
|
- [Why memorio](#why-memorio)
|
|
36
|
+
- [Global is optional](#global-is-optional)
|
|
28
37
|
- [Which layer should I use](#which-layer-should-i-use)
|
|
29
38
|
- [Install](#install)
|
|
30
39
|
- [Quick start](#quick-start)
|
|
31
40
|
- [Observing changes](#observing-changes)
|
|
32
|
-
- [The layers](#the-layers) —
|
|
41
|
+
- [The layers](#the-layers) — store · session · cache · idb · sqlite · memory
|
|
42
|
+
- [Redux and other state managers](#redux-and-other-state-managers)
|
|
43
|
+
- [memorio vs Redux, at a glance](#memorio-vs-redux-at-a-glance)
|
|
33
44
|
- [React integration](#react-integration)
|
|
34
45
|
- [Typed state & schema validation](#typed-state--schema-validation)
|
|
35
46
|
- [Local-first sync](#local-first-sync)
|
|
@@ -38,62 +49,80 @@ Just data that exists where your application needs it — and grows with it.
|
|
|
38
49
|
- [Honest limitations](#honest-limitations)
|
|
39
50
|
- [When to use something else](#when-to-use-something-else)
|
|
40
51
|
- [Design philosophy](#design-philosophy)
|
|
52
|
+
- [A mental model](#a-mental-model)
|
|
41
53
|
- [License](#license)
|
|
42
54
|
|
|
43
55
|
---
|
|
44
56
|
|
|
45
57
|
## Why memorio
|
|
46
58
|
|
|
47
|
-
Modern
|
|
59
|
+
Modern JavaScript applications often split their data across systems that don't talk to each other: a state manager, `localStorage`, `sessionStorage`, IndexedDB, a cache, SQLite, a server database, maybe an AI memory layer, maybe a sync layer on top. Each with its own API, its own lifecycle, its own mental model.
|
|
48
60
|
|
|
49
|
-
memorio
|
|
61
|
+
memorio brings these concerns into **one runtime and one consistent model**, while keeping each layer independent.
|
|
50
62
|
|
|
51
|
-
| Layer | Purpose |
|
|
52
|
-
|
|
53
|
-
| `state` |
|
|
54
|
-
| `cache` | transient runtime data |
|
|
55
|
-
| `session` | session
|
|
56
|
-
| `store` | persistent key/value data |
|
|
57
|
-
| `idb` | durable structured browser data |
|
|
58
|
-
| `sqlite` | relational
|
|
59
|
-
| `memory` |
|
|
60
|
-
| `journal` | local-first operation history |
|
|
63
|
+
| Layer | Purpose | Persistence | Reactive |
|
|
64
|
+
|---|---|---:|---:|
|
|
65
|
+
| `state` | application state | No | Yes |
|
|
66
|
+
| `cache` | transient runtime data | No | No |
|
|
67
|
+
| `session` | tab/session data | Yes | No |
|
|
68
|
+
| `store` | persistent key/value data | Yes | No |
|
|
69
|
+
| `idb` | durable structured browser data | Yes | No |
|
|
70
|
+
| `sqlite` *(beta)* | relational local SQL | Optional | No |
|
|
71
|
+
| `memory` | structured application memory | Yes | Optional |
|
|
72
|
+
| `journal` *(beta)* | local-first operation history | Yes | No |
|
|
61
73
|
|
|
62
|
-
Start with `state`. Add
|
|
74
|
+
Start with `state`. Add persistence or memory only when your application actually needs it.
|
|
75
|
+
|
|
76
|
+
## Global is optional
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import 'memorio'
|
|
80
|
+
state.user = { name: 'Sara' }
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
is useful when an application benefits from a shared runtime and a simple API. But memorio does **not** require applications to expose or use global state — explicit imports work against the exact same runtime:
|
|
84
|
+
|
|
85
|
+
```ts
|
|
86
|
+
import { state } from 'memorio'
|
|
87
|
+
state.user = { name: 'Sara' }
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
This makes memorio suitable for small apps, modular apps, libraries, component systems, tests, or applications that already use another state manager and prefer explicit dependencies.
|
|
91
|
+
|
|
92
|
+
**Global when convenient. Explicit when appropriate.**
|
|
63
93
|
|
|
64
94
|
## Which layer should I use
|
|
65
95
|
|
|
66
96
|
```text
|
|
67
97
|
Does the UI need to react automatically to changes?
|
|
68
98
|
│
|
|
69
|
-
├─ Yes → state
|
|
99
|
+
├─ Yes → state
|
|
70
100
|
│
|
|
71
|
-
└─ No
|
|
101
|
+
└─ No
|
|
72
102
|
│
|
|
73
|
-
├─
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
about (confidence, source, expiry)? → memory
|
|
103
|
+
├─ Only while the runtime exists? → cache
|
|
104
|
+
├─ Only for this browser tab/session? → session
|
|
105
|
+
├─ Small persistent key/value data? → store
|
|
106
|
+
├─ Larger or structured browser data? → idb
|
|
107
|
+
├─ Relations, joins, or SQL? → sqlite
|
|
108
|
+
└─ Knowledge the application should
|
|
109
|
+
remember (confidence, source, expiry)? → memory
|
|
81
110
|
```
|
|
82
111
|
|
|
83
112
|
## Install
|
|
84
113
|
|
|
85
114
|
```bash
|
|
86
|
-
npm
|
|
115
|
+
npm install memorio
|
|
87
116
|
```
|
|
88
117
|
|
|
89
118
|
Optional peers, only loaded when used:
|
|
90
119
|
|
|
91
120
|
```bash
|
|
92
|
-
npm
|
|
93
|
-
npm
|
|
121
|
+
npm install react react-dom # React integration
|
|
122
|
+
npm install sql.js # sqlite engine
|
|
94
123
|
```
|
|
95
124
|
|
|
96
|
-
**Zero production dependencies
|
|
125
|
+
**Zero production dependencies** in the core package. See [Security](#security).
|
|
97
126
|
|
|
98
127
|
## Quick start
|
|
99
128
|
|
|
@@ -101,16 +130,24 @@ npm i sql.js # SQLite engine
|
|
|
101
130
|
import 'memorio'
|
|
102
131
|
|
|
103
132
|
state.user = { name: 'Sara', role: 'admin' }
|
|
104
|
-
|
|
133
|
+
state.counter++
|
|
134
|
+
|
|
135
|
+
console.log(state.user.name)
|
|
136
|
+
console.log(state.counter)
|
|
105
137
|
```
|
|
106
138
|
|
|
107
|
-
Reactive,
|
|
139
|
+
Reactive, Proxy-based state. No provider tree to configure, no reducer to maintain.
|
|
140
|
+
|
|
141
|
+
Lock a slice you don't want mutated by accident:
|
|
108
142
|
|
|
109
143
|
```ts
|
|
110
144
|
state.config = { maxUsers: 100 }
|
|
111
145
|
state.config.lock()
|
|
146
|
+
|
|
112
147
|
state.config.maxUsers = 200 // throws
|
|
148
|
+
|
|
113
149
|
state.config.unlock()
|
|
150
|
+
state.config.maxUsers = 200 // ok
|
|
114
151
|
```
|
|
115
152
|
|
|
116
153
|
Prefer explicit imports over the global? Same runtime either way:
|
|
@@ -121,7 +158,7 @@ import { state, store, session, cache, idb, sqlite, memorio } from 'memorio'
|
|
|
121
158
|
|
|
122
159
|
## Observing changes
|
|
123
160
|
|
|
124
|
-
Reactivity
|
|
161
|
+
Reactivity is part of the runtime — it is not tied to React.
|
|
125
162
|
|
|
126
163
|
```ts
|
|
127
164
|
observer('state.user', (next, previous) => {
|
|
@@ -132,102 +169,40 @@ observer('state.user', (next, previous) => {
|
|
|
132
169
|
observer('state.user.name', callback)
|
|
133
170
|
```
|
|
134
171
|
|
|
135
|
-
|
|
172
|
+
Lower-level event access is also available:
|
|
136
173
|
|
|
137
174
|
```ts
|
|
138
175
|
const off = memorio.dispatch.listen('state.user', event => console.debug(event.detail))
|
|
139
176
|
memorio.dispatch.set('state.user', { detail: { name: 'Sara' } })
|
|
140
177
|
|
|
141
|
-
off()
|
|
142
|
-
memorio.dispatch.remove('state.user') // remove all subscriptions on a name
|
|
178
|
+
off() // remove only this subscription
|
|
143
179
|
```
|
|
144
180
|
|
|
145
|
-
|
|
146
|
-
its own unsubscribe. Prefer the returned `off()` over `remove()` for per-caller
|
|
147
|
-
teardown, since `remove()` clears *every* listener registered under that name.
|
|
148
|
-
|
|
149
|
-
`observer` paths are runtime strings — for compiler-checked access, see [typed state](#typed-state--schema-validation).
|
|
181
|
+
Each subscription owns its own unsubscribe function. Prefer the returned `off()` over `memorio.dispatch.remove('state.user')`, which removes **all** listeners registered under that name.
|
|
150
182
|
|
|
151
183
|
React apps get a dedicated hook, `useObserver` — see [React integration](#react-integration).
|
|
152
184
|
|
|
153
|
-
## Redux / state-manager integration
|
|
154
|
-
|
|
155
|
-
Memorio ships its Redux integration as a **separate, optional entrypoint** (`memorio/redux`). It is
|
|
156
|
-
*not* part of core and is **never imported by `import memorio from 'memorio'`** — so applications
|
|
157
|
-
that don't use Redux pay nothing. Redux is neither a dependency of Memorio nor of the adapter: the
|
|
158
|
-
adapter talks to any store that satisfies a tiny structural shape (`getState` / `subscribe` /
|
|
159
|
-
`dispatch`), so `redux`, Redux Toolkit, Zustand, NgRx, etc. are all accepted without importing the
|
|
160
|
-
`redux` types.
|
|
161
|
-
|
|
162
|
-
> **Ownership rule:** *Redux owns application state. Memorio owns memory.* The adapter only writes
|
|
163
|
-
> **selected** values (declared opt-in mappings) into Memorio memory, and only recalls them once,
|
|
164
|
-
> at bootstrap. It never mirrors the whole Redux tree and never two-way syncs.
|
|
165
|
-
|
|
166
|
-
```ts
|
|
167
|
-
import memorio from 'memorio'
|
|
168
|
-
import { createMemorioReduxBridge } from 'memorio/redux'
|
|
169
|
-
|
|
170
|
-
type AppState = { user: { name: string; preferences?: { theme?: string } } }
|
|
171
|
-
|
|
172
|
-
const memorioRedux = createMemorioReduxBridge<AppState>({
|
|
173
|
-
// Opt-in: only these paths become durable memory.
|
|
174
|
-
mappings: {
|
|
175
|
-
'user.preferences': {
|
|
176
|
-
selector: (s) => s.user.preferences,
|
|
177
|
-
type: 'preference',
|
|
178
|
-
scope: 'local', // never 'hot' for Redux mappings
|
|
179
|
-
tags: ['app', 'user']
|
|
180
|
-
},
|
|
181
|
-
'user.name': (s) => s.user.name // a bare selector is also accepted
|
|
182
|
-
},
|
|
183
|
-
// Performance: only consider the action types that can mutate mapped state.
|
|
184
|
-
whitelist: ['user/preferencesChanged', 'user/nameChanged'],
|
|
185
|
-
// Diagnostics
|
|
186
|
-
debug: true
|
|
187
|
-
})
|
|
188
|
-
|
|
189
|
-
const store = createStore(reducer, applyMiddleware(memorioRedux.middleware))
|
|
190
|
-
|
|
191
|
-
// Bootstrap hydration (Memorio -> Redux, one-shot). The bridge arms a
|
|
192
|
-
// re-entrancy guard so the restore dispatch does not echo back to Memorio.
|
|
193
|
-
await memorioRedux.hydrate(store, {
|
|
194
|
-
onHydration: (values) => store.dispatch(restorePreferences(values))
|
|
195
|
-
})
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
Directional flow, no loops:
|
|
199
|
-
|
|
200
|
-
| Direction | Mechanism | Ownership |
|
|
201
|
-
| --- | --- | --- |
|
|
202
|
-
| Redux -> Memorio | middleware persists only `mappings` whose selector changed **and** whose action type isn't blacklisted (#30) | Memorio is the durable owner (#31) |
|
|
203
|
-
| Memorio -> Redux | `hydrate()` recalls once at bootstrap; the app dispatches its own restore actions | Redux owns runtime state |
|
|
204
|
-
|
|
205
|
-
- **No store mirroring:** only mapped selectors are persisted — never `store.getState()` wholesale.
|
|
206
|
-
- **No synchronization loops:** hydration arms `setHydrating(true)` + seeds the change-detection cache, so the restore dispatch is seen as "no change" and is not re-persisted.
|
|
207
|
-
- **Async is off the reducer path:** middleware defers `memorio.memory.remember` to a microtask and coerces a burst of actions into a single flush.
|
|
208
|
-
- **Failure-isolated:** Memorio errors are swallowed by default (`failSoft: true`, default) and routed to `onError`; Redux dispatch always completes normally.
|
|
209
|
-
- **Production-safe:** nothing in the adapter exposes Memorio's database on `globalThis` / DevTools.
|
|
210
|
-
|
|
211
185
|
## The layers
|
|
212
186
|
|
|
213
|
-
### `store` — persistent key/value
|
|
187
|
+
### `store` — persistent key/value data
|
|
214
188
|
|
|
215
189
|
```ts
|
|
216
190
|
store.set('preferences', { theme: 'dark' })
|
|
217
191
|
const preferences = store.get('preferences')
|
|
218
192
|
```
|
|
219
193
|
|
|
220
|
-
Backed by `localStorage` in the browser
|
|
194
|
+
Backed by `localStorage` in the browser. Falls back to memory in environments without persistent storage — check `store.isPersistent` when portability matters.
|
|
221
195
|
|
|
222
|
-
### `session` —
|
|
196
|
+
### `session` — data for the current session
|
|
223
197
|
|
|
224
198
|
```ts
|
|
225
|
-
session.set('
|
|
199
|
+
session.set('wizard-step', 3)
|
|
200
|
+
const step = session.get('wizard-step')
|
|
226
201
|
```
|
|
227
202
|
|
|
228
|
-
Backed by `sessionStorage`. Good for
|
|
203
|
+
Backed by `sessionStorage`. Good for multi-step workflows, temporary preferences, tab-scoped data.
|
|
229
204
|
|
|
230
|
-
### `cache` — volatile
|
|
205
|
+
### `cache` — volatile runtime data
|
|
231
206
|
|
|
232
207
|
```ts
|
|
233
208
|
cache.set('expensive-result', computeExpensiveResult())
|
|
@@ -235,18 +210,19 @@ cache.set('expensive-result', computeExpensiveResult())
|
|
|
235
210
|
|
|
236
211
|
Disappears when the runtime disappears. No persistence guarantee, ever.
|
|
237
212
|
|
|
238
|
-
### `idb` — durable
|
|
213
|
+
### `idb` — durable structured browser data
|
|
239
214
|
|
|
240
215
|
```ts
|
|
241
216
|
await idb.db.create('app')
|
|
242
217
|
await idb.table.create('app', 'users')
|
|
243
218
|
await idb.data.set('app', 'users', { id: 1, name: 'Sara' })
|
|
219
|
+
|
|
244
220
|
const user = await idb.data.get('app', 'users', 1)
|
|
245
221
|
```
|
|
246
222
|
|
|
247
|
-
Check before
|
|
223
|
+
Check runtime support before depending on it: `memorio.getCapabilities()`.
|
|
248
224
|
|
|
249
|
-
### `sqlite` —
|
|
225
|
+
### `sqlite` — local SQL
|
|
250
226
|
|
|
251
227
|
```ts
|
|
252
228
|
await sqlite.ready
|
|
@@ -260,17 +236,17 @@ await sqlite.query.run('app', `INSERT INTO users (name, role) VALUES (?, ?)`, ['
|
|
|
260
236
|
const admins = await sqlite.query.select('app', `SELECT * FROM users WHERE role = ?`, ['admin'])
|
|
261
237
|
```
|
|
262
238
|
|
|
263
|
-
Runs **in memory by default**,
|
|
239
|
+
Runs **in memory by default**, using `sql.js`. Persistence is explicit:
|
|
264
240
|
|
|
265
241
|
```ts
|
|
266
242
|
await sqlite.db.create('app', { persistence: true })
|
|
267
243
|
```
|
|
268
244
|
|
|
269
|
-
> ⚠️ Persistence serializes the **entire** database on
|
|
245
|
+
> ⚠️ **Persistence is not incremental.** It serializes the **entire** database on flush — fine for small/medium local datasets, but large databases should not be persisted after every mutation. Batch writes and flush deliberately. memorio's SQLite layer is an embedded local SQL runtime, not a replacement for a server database.
|
|
270
246
|
|
|
271
|
-
### `memory` —
|
|
247
|
+
### `memory` — application memory
|
|
272
248
|
|
|
273
|
-
The layer that makes memorio more than a state manager.
|
|
249
|
+
The layer that makes memorio more than a state manager. `memory` represents information the application wants to **remember**, not just store — it can carry type, confidence, source, scope, tags, lifetime, status, and history.
|
|
274
250
|
|
|
275
251
|
```ts
|
|
276
252
|
await memorio.memory.remember('user.language', 'Italian', {
|
|
@@ -284,14 +260,14 @@ await memorio.memory.remember('user.language', 'Italian', {
|
|
|
284
260
|
const language = await memorio.memory.recall('user.language')
|
|
285
261
|
```
|
|
286
262
|
|
|
287
|
-
Updates don't overwrite — they
|
|
263
|
+
Updates don't overwrite — they supersede, preserving history:
|
|
288
264
|
|
|
289
265
|
```ts
|
|
290
266
|
await memorio.memory.update('user.language', 'English', { confidence: 0.95 })
|
|
291
|
-
//
|
|
267
|
+
// previous entry → status: 'superseded' | new entry → status: 'active'
|
|
292
268
|
```
|
|
293
269
|
|
|
294
|
-
Retrieve what's
|
|
270
|
+
Retrieve what's relevant to the current operation, not everything:
|
|
295
271
|
|
|
296
272
|
```ts
|
|
297
273
|
const context = await memorio.memory.context({
|
|
@@ -302,13 +278,86 @@ const context = await memorio.memory.context({
|
|
|
302
278
|
})
|
|
303
279
|
```
|
|
304
280
|
|
|
305
|
-
|
|
281
|
+
The context system considers tags, type, confidence, and recency.
|
|
282
|
+
|
|
283
|
+
> ℹ️ **"Semantic" here means structured, not embedding-based.** `memory.context()` ranks by tags, type, confidence and recency — there is no hidden vector database and no claim that free text has been understood through embeddings. If you need true similarity search, pair a dedicated embedding/vector store with `memorio.memory` for the lifecycle on top (confidence, source, TTL, scope, history, supersession).
|
|
284
|
+
|
|
285
|
+
In short: `sqlite` answers "what data do I have?" — `memory` answers "what does my app remember, and how sure is it?" They're not competing for the same job.
|
|
286
|
+
|
|
287
|
+
## Redux and other state managers
|
|
288
|
+
|
|
289
|
+
memorio does not need to replace your existing state manager. Its Redux integration ships as a **separate, optional entry point**:
|
|
290
|
+
|
|
291
|
+
```ts
|
|
292
|
+
import { createMemorioReduxBridge } from 'memorio/redux'
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
Redux is not a dependency of memorio — the adapter works against a small structural interface (`getState` / `subscribe` / `dispatch`), so it can work with Redux-style stores without coupling memorio's core to Redux.
|
|
296
|
+
|
|
297
|
+
> **Ownership rule:** your state manager owns application state. memorio owns memory.
|
|
298
|
+
|
|
299
|
+
The bridge does not mirror the entire store — only explicitly mapped values are persisted:
|
|
300
|
+
|
|
301
|
+
```ts
|
|
302
|
+
const memorioRedux = createMemorioReduxBridge<AppState>({
|
|
303
|
+
mappings: {
|
|
304
|
+
'user.preferences': {
|
|
305
|
+
selector: state => state.user.preferences,
|
|
306
|
+
type: 'preference',
|
|
307
|
+
scope: 'local',
|
|
308
|
+
tags: ['app', 'user'],
|
|
309
|
+
},
|
|
310
|
+
'user.name': state => state.user.name,
|
|
311
|
+
},
|
|
312
|
+
whitelist: ['user/preferencesChanged', 'user/nameChanged'],
|
|
313
|
+
debug: true,
|
|
314
|
+
})
|
|
315
|
+
|
|
316
|
+
const store = createStore(reducer, applyMiddleware(memorioRedux.middleware))
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
Hydration is explicit and one-shot:
|
|
306
320
|
|
|
307
|
-
|
|
321
|
+
```ts
|
|
322
|
+
await memorioRedux.hydrate(store, {
|
|
323
|
+
onHydration(values) {
|
|
324
|
+
store.dispatch(restorePreferences(values))
|
|
325
|
+
},
|
|
326
|
+
})
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
Direction of ownership — there is intentionally no permanent two-way mirror:
|
|
330
|
+
|
|
331
|
+
```text
|
|
332
|
+
Redux ─────────────→ memorio memorio ────────────→ Redux
|
|
333
|
+
application state durable memory bootstrap hydration
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
- only mapped selectors are persisted — the entire Redux tree is never mirrored
|
|
337
|
+
- hydration is one-shot; restore dispatches do not create synchronization loops
|
|
338
|
+
- persistence happens outside the reducer path; bursts of actions are coalesced
|
|
339
|
+
- memorio failures do not break Redux dispatch — errors can be reported through `onError`
|
|
340
|
+
- the adapter does not expose the memorio database through `globalThis` or DevTools
|
|
341
|
+
|
|
342
|
+
### memorio vs Redux, at a glance
|
|
343
|
+
|
|
344
|
+
Not a replacement — a different scope. Useful mainly for deciding which one (or both) fits a given piece of state.
|
|
345
|
+
|
|
346
|
+
| | Redux | memorio |
|
|
347
|
+
|---|---|---|
|
|
348
|
+
| Core model | single store, plain object | multiple independent layers (`state`, `store`, `session`, `cache`, `idb`, `sqlite`, `memory`) |
|
|
349
|
+
| State changes | via dispatched actions + reducers | direct mutation on a reactive proxy |
|
|
350
|
+
| Persistence | not built in (needs `redux-persist` or similar) | built into `store`/`session`/`idb`/`sqlite` |
|
|
351
|
+
| Structured "memory" (confidence, TTL, source, supersession) | not a concept in Redux | native, via the `memory` layer |
|
|
352
|
+
| Offline sync / conflict resolution | not built in | built into `memory.configure()` (operations + journal + HLC ordering) |
|
|
353
|
+
| Time-travel debugging, strict middleware pipelines | yes, mature ecosystem | not a goal — see [When to use something else](#when-to-use-something-else) |
|
|
354
|
+
| Dependencies | small core, large plugin ecosystem | zero production dependencies |
|
|
355
|
+
|
|
356
|
+
Pick Redux when you need its action-pipeline discipline and tooling. Pick memorio when you want state, persistence, and structured memory under one runtime without wiring several libraries together. Nothing stops you from using both — that's exactly what the [Redux bridge](#redux-and-other-state-managers) is for.
|
|
308
357
|
|
|
309
358
|
## React integration
|
|
310
359
|
|
|
311
|
-
React is an integration, not a requirement — `useObserver`
|
|
360
|
+
React is an integration, not a requirement — `useObserver` connects to the same observer system described above.
|
|
312
361
|
|
|
313
362
|
```tsx
|
|
314
363
|
function Counter() {
|
|
@@ -318,9 +367,11 @@ function Counter() {
|
|
|
318
367
|
}
|
|
319
368
|
```
|
|
320
369
|
|
|
370
|
+
The runtime itself remains independent of React.
|
|
371
|
+
|
|
321
372
|
## Typed state & schema validation
|
|
322
373
|
|
|
323
|
-
TypeScript types
|
|
374
|
+
TypeScript types give compile-time guarantees without creating another state container:
|
|
324
375
|
|
|
325
376
|
```ts
|
|
326
377
|
interface AppState {
|
|
@@ -330,12 +381,12 @@ interface AppState {
|
|
|
330
381
|
|
|
331
382
|
const app = memorio.typed<AppState>()
|
|
332
383
|
app.theme = 'dark'
|
|
333
|
-
app.theme = 'purple' //
|
|
384
|
+
app.theme = 'purple' // TypeScript error
|
|
334
385
|
```
|
|
335
386
|
|
|
336
|
-
`app === state` — same
|
|
387
|
+
`app === state` — same proxy, no duplicated store.
|
|
337
388
|
|
|
338
|
-
Runtime validation
|
|
389
|
+
Runtime validation protects values crossing trust boundaries:
|
|
339
390
|
|
|
340
391
|
```ts
|
|
341
392
|
memorio.registerSchema('user', {
|
|
@@ -347,41 +398,40 @@ memorio.registerSchema('user', {
|
|
|
347
398
|
},
|
|
348
399
|
})
|
|
349
400
|
|
|
350
|
-
state.user = { name: 'Sara' } // rejected
|
|
401
|
+
state.user = { name: 'Sara' } // rejected: missing required "email"
|
|
351
402
|
```
|
|
352
403
|
|
|
353
|
-
|
|
404
|
+
Arrays validate each element via `items`:
|
|
354
405
|
|
|
355
406
|
```ts
|
|
356
|
-
memorio.registerSchema('tags', {
|
|
357
|
-
type: 'array',
|
|
358
|
-
items: { type: 'string' },
|
|
359
|
-
})
|
|
407
|
+
memorio.registerSchema('tags', { type: 'array', items: { type: 'string' } })
|
|
360
408
|
|
|
361
409
|
state.tags = ['a', 'b'] // accepted
|
|
362
|
-
state.tags = [1, 2, 3] // rejected
|
|
410
|
+
state.tags = [1, 2, 3] // rejected
|
|
363
411
|
```
|
|
364
412
|
|
|
365
413
|
## Local-first sync
|
|
366
414
|
|
|
367
|
-
The local application owns its data
|
|
368
|
-
|
|
369
|
-
memorio syncs **operations** (`remember`, `update`, `forget`, `expire`, `confirm`, `supersede`), not database dumps, via a local journal that survives network failure:
|
|
415
|
+
The local application owns its data — the cloud is optional transport. memorio synchronizes **operations** (`remember`, `update`, `forget`, `expire`, `confirm`, `supersede`), not database dumps. A local journal records operations so temporary network failures don't stop the application from working.
|
|
370
416
|
|
|
371
417
|
```ts
|
|
372
418
|
memorio.memory.configure({
|
|
373
419
|
namespace: 'user:123:device:abc',
|
|
374
420
|
provider: {
|
|
375
|
-
push:
|
|
376
|
-
pull:
|
|
421
|
+
push: ops => fetch('/api/sync', { method: 'POST', body: JSON.stringify(ops) }),
|
|
422
|
+
pull: since => fetch(`/api/sync?since=${since}`).then(r => r.json()),
|
|
377
423
|
},
|
|
378
424
|
auto: true,
|
|
379
425
|
})
|
|
380
426
|
```
|
|
381
427
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
428
|
+
```text
|
|
429
|
+
local application → memorio memory → local journal → offline / cloud
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
The network is an extension of the local application, not its prerequisite.
|
|
433
|
+
|
|
434
|
+
Remote operations are ordered causally using HLC timestamps. For concurrent writes to the same key, memorio provides a deterministic default — a custom resolver can override it:
|
|
385
435
|
|
|
386
436
|
```ts
|
|
387
437
|
memorio.memory.configure({
|
|
@@ -392,66 +442,92 @@ memorio.memory.configure({
|
|
|
392
442
|
})
|
|
393
443
|
```
|
|
394
444
|
|
|
395
|
-
|
|
396
|
-
tie. The resolver only settles *client-side* divergence between what memorio has seen locally —
|
|
397
|
-
the provider is still responsible for the final server-side policy.
|
|
445
|
+
Without a resolver, the default policy applies the remote entry on a tie. The resolver operates client-side — the sync provider is still responsible for any final server-side conflict policy.
|
|
398
446
|
|
|
399
447
|
## Cross-platform support
|
|
400
448
|
|
|
401
449
|
| API | Browser | Node.js | Deno | Edge / Workers |
|
|
402
|
-
|
|
450
|
+
|---|:---:|:---:|:---:|:---:|
|
|
403
451
|
| `state` / `observer` / `cache` | ✅ | ✅ | ✅ | ✅ |
|
|
404
452
|
| `store` / `session` | persistent | memory fallback | memory fallback | capability-dependent |
|
|
405
453
|
| `idb` | ✅ | ❌ | ❌ | capability-dependent |
|
|
406
454
|
| `sqlite` | ✅ | ❌ | ❌ | capability-dependent |
|
|
407
|
-
| `devtools` |
|
|
455
|
+
| `devtools` | dev-only | ❌ | ❌ | capability-dependent |
|
|
408
456
|
|
|
409
457
|
```ts
|
|
410
458
|
memorio.getCapabilities()
|
|
411
|
-
memorio.isBrowser() / isNode() / isDeno() / isEdge()
|
|
459
|
+
memorio.isBrowser() / memorio.isNode() / memorio.isDeno() / memorio.isEdge()
|
|
412
460
|
```
|
|
413
461
|
|
|
462
|
+
Do not assume every persistence backend exists in every runtime.
|
|
463
|
+
|
|
414
464
|
## Security
|
|
415
465
|
|
|
416
|
-
- Zero production dependencies — [
|
|
466
|
+
- Zero production dependencies — [checked by Socket.dev](https://socket.dev/npm/package/memorio) and [scanned by Snyk](https://snyk.io/test/npm/memorio)
|
|
417
467
|
- No `eval`, no dynamic code execution, no bundled telemetry
|
|
418
468
|
- Sanitized keys, validated inputs, caught module-boundary errors
|
|
419
|
-
- UUID-based session identifiers
|
|
469
|
+
- Bounded journal entries, UUID-based session identifiers
|
|
470
|
+
|
|
471
|
+
> ⚠️ **memorio does not encrypt data by default.** This applies to `state`, `store`, `session`, `idb`, `memory`, and `sqlite`. Treat browser storage as client-controlled data — if your application handles auth secrets, credentials, or regulated data, bring your own encryption, backend authorization, and server-side security controls.
|
|
420
472
|
|
|
421
|
-
**
|
|
473
|
+
**Contexts are not security boundaries.** `memorio.createContext('tenant-123')` is useful for organizing and isolating application concerns — it is **not** an authorization mechanism. Code running inside the same JS runtime can potentially access other memorio contexts. Real tenant isolation belongs at the backend/authentication layer.
|
|
422
474
|
|
|
423
|
-
|
|
475
|
+
memorio's DevTools are intended for development only, disabled via runtime detection (`process.env.NODE_ENV`) — not build-time removal. Make sure your bundler actually defines this correctly in production; don't treat DevTools absence as a security boundary.
|
|
424
476
|
|
|
425
477
|
## Honest limitations
|
|
426
478
|
|
|
427
|
-
|
|
479
|
+
memorio deliberately documents its edges.
|
|
428
480
|
|
|
429
|
-
-
|
|
430
|
-
- **SQLite persistence is
|
|
431
|
-
- **
|
|
432
|
-
- **
|
|
433
|
-
- **DevTools are
|
|
481
|
+
- **Semantic memory is structured, not vector-based.** `memory.context()` uses structured ranking, not embedding similarity search.
|
|
482
|
+
- **SQLite persistence is not incremental** — the current strategy serializes the complete database on flush; large datasets need deliberate batching.
|
|
483
|
+
- **Contexts and namespaces are not authorization** — they organize application data, they don't replace authentication or backend authorization.
|
|
484
|
+
- **Data is not encrypted automatically** — memorio doesn't pretend local persistence is secure storage.
|
|
485
|
+
- **DevTools are runtime-controlled, not build-removed** — production builds should still configure `NODE_ENV` correctly.
|
|
434
486
|
|
|
435
487
|
## When to use something else
|
|
436
488
|
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
- **Need
|
|
440
|
-
- **Need
|
|
489
|
+
memorio is intentionally not everything.
|
|
490
|
+
|
|
491
|
+
- **Need strict Redux-style architecture** (action pipelines, reducer-based transitions, extensive middleware, time-travel debugging, event-sourcing)? memorio can integrate with such systems rather than replace them.
|
|
492
|
+
- **Need a server database** (authoritative persistence, multi-user authorization, server-side transactions, backend-controlled access)? Use one — memorio doesn't provide it.
|
|
493
|
+
- **Need true embedding similarity / vector search**? Pair a dedicated vector database with `memorio.memory`, which can still manage the lifecycle and metadata of the retrieved knowledge.
|
|
441
494
|
|
|
442
495
|
## Design philosophy
|
|
443
496
|
|
|
444
|
-
1. **Local first** — the
|
|
445
|
-
2. **Persistence is
|
|
446
|
-
3. **The cloud is optional** —
|
|
447
|
-
4. **
|
|
448
|
-
5. **Memory has meaning** — confidence, source,
|
|
449
|
-
6. **
|
|
450
|
-
7. **
|
|
497
|
+
1. **Local first** — the application stays useful when the network disappears.
|
|
498
|
+
2. **Persistence is optional** — start in memory, persist only when it provides value.
|
|
499
|
+
3. **The cloud is optional** — remote sync extends the local application; it does not define it.
|
|
500
|
+
4. **Use the right primitive** — don't put relational data in a key/value store, or semantic memory in ordinary state.
|
|
501
|
+
5. **Memory has meaning** — confidence, source, type, scope, TTL, tags, history, status. That's different from simply storing a value.
|
|
502
|
+
6. **Global access is a convenience, not a requirement** — both `import 'memorio'` and `import { state } from 'memorio'` are valid; memorio does not impose one architecture.
|
|
503
|
+
7. **Tell the truth about boundaries** — local data is not automatically secure, persistence is not authorization, structured memory is not automatically AI semantic search.
|
|
504
|
+
8. **Keep the common case tiny:**
|
|
451
505
|
```ts
|
|
452
506
|
import 'memorio'
|
|
453
507
|
state.value = 42
|
|
454
508
|
```
|
|
509
|
+
Everything else is there when you need it.
|
|
510
|
+
|
|
511
|
+
## A mental model
|
|
512
|
+
|
|
513
|
+
```text
|
|
514
|
+
memorio
|
|
515
|
+
│
|
|
516
|
+
┌──────────────┼──────────────┐
|
|
517
|
+
│ │ │
|
|
518
|
+
runtime persistence memory
|
|
519
|
+
│ │ │
|
|
520
|
+
┌─────┼─────┐ ┌────┼────┐ structured
|
|
521
|
+
│ │ │ │ │ │ knowledge
|
|
522
|
+
state cache session store idb sqlite
|
|
523
|
+
│
|
|
524
|
+
observer
|
|
525
|
+
│
|
|
526
|
+
▼
|
|
527
|
+
application → journal → optional sync → cloud
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
The important part is not that memorio has many layers — it's that **you do not have to use them all**.
|
|
455
531
|
|
|
456
532
|
## License
|
|
457
533
|
|