tinybase 7.3.5 → 8.0.0-beta.1

package/@types/omni/index.d.ts

@@ -19,6 +19,7 @@ export * from '../common/index.d.ts';
 export * from '../indexes/index.d.ts';
 export * from '../mergeable-store/index.d.ts';
 export * from '../metrics/index.d.ts';
+export * from '../middleware/index.d.ts';
 export * from '../persisters/index.d.ts';
 export * from '../persisters/persister-automerge/index.d.ts';
 export * from '../persisters/persister-browser/index.d.ts';

package/@types/omni/with-schemas/index.d.ts

@@ -19,6 +19,7 @@ export * from '../../common/with-schemas/index.d.ts';
 export * from '../../indexes/with-schemas/index.d.ts';
 export * from '../../mergeable-store/with-schemas/index.d.ts';
 export * from '../../metrics/with-schemas/index.d.ts';
+export * from '../../middleware/with-schemas/index.d.ts';
 export * from '../../persisters/persister-automerge/with-schemas/index.d.ts';
 export * from '../../persisters/persister-browser/with-schemas/index.d.ts';
 export * from '../../persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts';

package/@types/store/index.d.ts

@@ -7680,7 +7680,6 @@ export interface Store {
    * @since v5.0.0
    */
   isMergeable(): boolean;
-  //
 }
 
 /**

package/@types/with-schemas/index.d.ts

@@ -12,6 +12,7 @@ export * from '../common/with-schemas/index.d.ts';
 export * from '../indexes/with-schemas/index.d.ts';
 export * from '../mergeable-store/with-schemas/index.d.ts';
 export * from '../metrics/with-schemas/index.d.ts';
+export * from '../middleware/with-schemas/index.d.ts';
 export * from '../queries/with-schemas/index.d.ts';
 export * from '../relationships/with-schemas/index.d.ts';
 export * from '../store/with-schemas/index.d.ts';

package/agents.md

@@ -300,7 +300,7 @@ from source code and markdown files.
    source files for guides on the website.
 
 4. **Generated Files**: `/releases.md` and `/readme.md` in the root are
-   **GENERATED** from `/site/guides/16_releases.md` and `/site/home/index.md`.
+   **GENERATED** from `/site/guides/17_releases.md` and `/site/home/index.md`.
    **Never edit the generated files directly**.
 
 ### Documentation Testing
@@ -314,12 +314,13 @@ npx vitest run ./test/unit/documentation.test.ts --retry=0
 
 **How it works**:
 
-- Extracts all code blocks from markdown files and `docs.js` files
-- Concatenates all examples from each file together
-- Parses and executes them to ensure they work
-- This means examples in the same file share scope
+- Extracts code blocks from markdown files and `docs.js` files
+- For **guide `.md` files**: concatenates all code blocks from the file together
+  and runs them as a single test — examples in the same file share scope
+- For **`docs.js` files**: each `@example` block is extracted independently (via
+  regex) and run as its own isolated test — examples do NOT share scope
 
-**Critical constraints**:
+**Critical constraints for guide `.md` files**:
 
 - Don't redeclare variables across examples in the same file
 - First example can declare `const store = createStore()`, subsequent examples
@@ -328,18 +329,30 @@ npx vitest run ./test/unit/documentation.test.ts --retry=0
 - Avoid async operations in examples unless necessary
 - Keep examples simple and focused
 
+**Critical constraints for `docs.js` files**:
+
+- Each `@example` block runs in complete isolation
+- You CAN (and should) reuse simple variable names like `store`, `middleware`
+  across `@example` blocks — no suffixing needed
+- Each `@example` must include its own imports and setup
+- Keep examples self-contained
+- Try to make the tests about simple data that relates to a real life pet store
+  (eg 'pets', 'species', 'employees' etc)
+
 **Common pitfalls**:
 
-- ❌ Declaring `const store` multiple times in the same file
+- ❌ Declaring `const store` multiple times in the same **guide** file
 - ❌ Using undefined functions (forgot import statement)
-- ✅ First example: `const store = createStore()`
-- ✅ Later examples: `store.setCell(...)` (reuses existing store)
+- ❌ Adding unnecessary suffixes (`store2`, `store3`) in `docs.js` examples
+- ✅ First guide example: `const store = createStore()`
+- ✅ Later guide examples: `store.setCell(...)` (reuses existing store)
+- ✅ Each `docs.js` `@example`: `const store = createStore()` (independent)
 
 ### Adding New Documentation
 
 1. **API Documentation**: Edit `docs.js` file next to the type definition
 2. **Guide Content**: Edit markdown files in `/site/guides/`
-3. **Release Notes**: Edit `/site/guides/16_releases.md` (not `/releases.md`)
+3. **Release Notes**: Edit `/site/guides/17_releases.md` (not `/releases.md`)
 4. **Always run documentation tests** after changes to verify examples work
 
 ## Creating New Schematizers
@@ -472,7 +485,7 @@ All code examples in a guide file are concatenated and executed as a test:
 
 When adding a new feature:
 
-1. **Update `/site/guides/16_releases.md`** (NOT `/releases.md`):
+1. **Update `/site/guides/17_releases.md`** (NOT `/releases.md`):
    - Add new version section at the top
    - Include working code example that will be tested
    - Link to relevant guide if applicable
@@ -519,3 +532,12 @@ npm run testE2e               # Run E2E tests to verify demos
 - You only need `compileForProd` once, unless you've changed TinyBase source
 - E2E tests use Playwright to verify demos work in a real browser
 - Individual E2E tests can be run for faster verification during iteration
+
+## Maintaining This Guide
+
+At the end of each major project or task, add any new **general** learnings to
+this file. This ensures future agents benefit from discoveries about the
+codebase, build system, testing patterns, or documentation conventions. Only add
+broadly applicable insights — not project-specific implementation details.
+
+

package/checkpoints/index.js

@@ -19,13 +19,6 @@ const arrayPop = (array) => array.pop();
 const arrayUnshift = (array, ...values) => array.unshift(...values);
 const arrayShift = (array) => array.shift();
 
-const setOrDelCell = (store, tableId, rowId, cellId, cell) =>
-  isUndefined(cell)
-    ? store.delCell(tableId, rowId, cellId, true)
-    : store.setCell(tableId, rowId, cellId, cell);
-const setOrDelValue = (store, valueId, value) =>
-  isUndefined(value) ? store.delValue(valueId) : store.setValue(valueId, value);
-
 const collSizeN = (collSizer) => (coll) =>
   arrayReduce(collValues(coll), (total, coll2) => total + collSizer(coll2), 0);
 const collSize = (coll) => coll?.size ?? 0;
@@ -207,12 +200,18 @@ const createCheckpoints = getCreateFunction(
         collForEach(cellsDelta2, (table, tableId) =>
           collForEach(table, (row, rowId) =>
             collForEach(row, (oldNew, cellId) =>
-              setOrDelCell(store, tableId, rowId, cellId, oldNew[oldOrNew]),
+              store.setOrDelCell(
+                tableId,
+                rowId,
+                cellId,
+                oldNew[oldOrNew],
+                true,
+              ),
             ),
           ),
         );
         collForEach(valuesDelta2, (oldNew, valueId) =>
-          setOrDelValue(store, valueId, oldNew[oldOrNew]),
+          store.setOrDelValue(valueId, oldNew[oldOrNew], true),
         );
       });
       listening = 1;

package/checkpoints/with-schemas/index.js

@@ -19,13 +19,6 @@ const arrayPop = (array) => array.pop();
 const arrayUnshift = (array, ...values) => array.unshift(...values);
 const arrayShift = (array) => array.shift();
 
-const setOrDelCell = (store, tableId, rowId, cellId, cell) =>
-  isUndefined(cell)
-    ? store.delCell(tableId, rowId, cellId, true)
-    : store.setCell(tableId, rowId, cellId, cell);
-const setOrDelValue = (store, valueId, value) =>
-  isUndefined(value) ? store.delValue(valueId) : store.setValue(valueId, value);
-
 const collSizeN = (collSizer) => (coll) =>
   arrayReduce(collValues(coll), (total, coll2) => total + collSizer(coll2), 0);
 const collSize = (coll) => coll?.size ?? 0;
@@ -207,12 +200,18 @@ const createCheckpoints = getCreateFunction(
         collForEach(cellsDelta2, (table, tableId) =>
           collForEach(table, (row, rowId) =>
             collForEach(row, (oldNew, cellId) =>
-              setOrDelCell(store, tableId, rowId, cellId, oldNew[oldOrNew]),
+              store.setOrDelCell(
+                tableId,
+                rowId,
+                cellId,
+                oldNew[oldOrNew],
+                true,
+              ),
             ),
           ),
         );
         collForEach(valuesDelta2, (oldNew, valueId) =>
-          setOrDelValue(store, valueId, oldNew[oldOrNew]),
+          store.setOrDelValue(valueId, oldNew[oldOrNew], true),
         );
       });
       listening = 1;