@fireproof/core 0.0.4 → 0.0.6

package/test/db-index.test.js

@@ -214,4 +214,5 @@ describe('Index query with bad index definition', () => {
       console.error = oldErrFn
     })
   })
+  it.skip('reproduce missing block error from browser so we can turn off always rebuild', async () => {})
 })

package/test/fireproof.test.js

@@ -20,12 +20,84 @@ describe('Fireproof', () => {
   it('put and get document', async () => {
     assert(resp0.id, 'should have id')
     assert.equal(resp0.id, '1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
-
     const avalue = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
     assert.equal(avalue.name, 'alice')
     assert.equal(avalue.age, 42)
     assert.equal(avalue._id, '1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
   })
+  it('mvcc put and get document with _clock that matches', async () => {
+    assert(resp0.clock, 'should have clock')
+    assert.equal(resp0.clock[0].toString(), 'bafyreieth2ckopwivda5mf6vu76xwqvox3q5wsaxgbmxy2dgrd4hfuzmma')
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    theDoc._clock = database.clock
+    const put2 = await database.put(theDoc)
+    assert.equal(put2.id, '1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    assert.equal(put2.clock.length, 1)
+    assert.equal(put2.clock[0].toString(), 'bafyreida2c2ckhjfoz5ulmbbfe66ey4svvedrl4tzbvtoxags2qck7lj2i')
+  })
+  it('get should return an object instance that is not the same as the one in the db', async () => {
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    const theDoc2 = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    assert.notEqual(theDoc, theDoc2)
+    theDoc.name = 'really alice'
+    assert.equal(theDoc.name, 'really alice')
+    assert.equal(theDoc2.name, 'alice')
+  })
+  it('get with mvcc option', async () => {
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c', { mvcc: true })
+    assert(theDoc._clock, 'should have _clock')
+    assert.equal(theDoc._clock[0].toString(), 'bafyreieth2ckopwivda5mf6vu76xwqvox3q5wsaxgbmxy2dgrd4hfuzmma')
+  })
+  it('get with mvcc option where someone else changed another document first', async () => {
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c', { mvcc: true })
+    const put2 = await database.put({ something: 'else' })
+    assert(put2.clock, 'should have clock')
+    assert.notEqual(put2.clock.toString(), resp0.clock.toString())
+    assert.equal(theDoc._clock.toString(), resp0.clock.toString())
+    theDoc.name = 'somone else'
+    const put3works = await database.put(theDoc)
+    assert(put3works.clock, 'should have id')
+  })
+  it('get from an old snapshot with mvcc option', async () => {
+    const ogClock = resp0.clock
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    theDoc.name = 'not alice'
+    const put2 = await database.put(theDoc)
+    assert.equal(put2.id, '1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    assert.notEqual(put2.clock.toString(), ogClock.toString())
+    const theDoc2 = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c', { clock: ogClock })
+    assert.equal(theDoc2.name, 'alice')
+  })
+  it('put and get document with _clock that does not match b/c the doc changed', async () => {
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c', { mvcc: true })
+    theDoc.name = 'not alice'
+    const put2 = await database.put(theDoc)
+    assert.equal(put2.id, '1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+    assert.notEqual(put2.clock.toString(), theDoc._clock.toString())
+
+    const err = await database.put(theDoc).catch((err) => err)
+    assert.match(err.message, /MVCC conflict/)
+  })
+  it('put and get document with _clock that does not match b/c a different doc changed should succeed', async () => {
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c', { mvcc: true })
+    assert.equal(theDoc.name, 'alice')
+
+    const putAnotherDoc = await database.put({ nothing: 'to see here' })
+    assert.notEqual(putAnotherDoc.clock.toString(), theDoc._clock.toString())
+
+    const ok = await database.put({ name: "isn't alice", ...theDoc })
+    assert.equal(ok.id, '1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c')
+  })
+  it('put and get document with _clock that does not match b/c the doc was deleted', async () => {
+    const theDoc = await database.get('1ef3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c', { mvcc: true })
+    assert.equal(theDoc.name, 'alice')
+    const del = await database.del(theDoc)
+    assert(del.id)
+    const err = await database.put(theDoc).catch((err) => err)
+    console.log('err', err)
+    assert.match(err.message, /MVCC conflict/)
+  })
+
   it('has a factory for making new instances with default settings', async () => {
     // TODO if you pass it an email it asks the local keyring, and if no key, does the email validation thing
     const db = await Fireproof.storage({ email: 'jchris@gmail.com' })

package/test/fulltext.test.js

@@ -0,0 +1,66 @@
+import { describe, it, beforeEach } from 'mocha'
+import assert from 'node:assert'
+import Fireproof from '../src/fireproof.js'
+import flexsearch from 'flexsearch'
+const { Index } = flexsearch
+// this is an illustration of how to use the flexsearch library
+
+let database, flexed
+
+describe('Fulltext with flexsearch', () => {
+  beforeEach(async () => {
+    database = Fireproof.storage()
+    flexed = withFlexsearch(database) // this is a function that adds the flexsearch library to the database object
+
+    const messages = [
+      'Hello World, this is a test',
+      'We are testing the flexsearch library',
+      'When we test we test',
+      'Apples are red',
+      'Bananas are yellow',
+      'Oranges are orange',
+      'Pears are green',
+      'Grapes are purple',
+      'Strawberries are red',
+      'Blueberries are blue',
+      'Raspberries are red',
+      'Watermelons are green',
+      'Pineapples are yellow'
+    ]
+    for (let i = 0, len = messages.length; i < len; i++) {
+      await database.put({
+        _id: `message-${i}`,
+        message: messages[i]
+      })
+    }
+  })
+
+  it('search the index', async () => {
+    const changes = await database.changesSince()
+    assert.equal(changes.rows.length, 13)
+    const results = await flexed.search('red')
+    assert.equal(results.length, 3)
+    for (let i = 0, len = results.length; i < len; i++) {
+      const doc = await database.get(results[i])
+      assert.match(doc.message, /red/)
+    }
+  })
+  // it('add more docs and search again', async () => {})
+  // it('delete some docs and search again', async () => {})
+  // it('update some docs and search again', async () => {})
+})
+
+function withFlexsearch (database, flexsearchOptions = {}) {
+  const index = new Index(flexsearchOptions)
+  let clock = null
+  const search = async (query, options) => {
+    const changes = await database.changesSince(clock)
+    clock = changes.clock
+    for (let i = 0; i < changes.rows.length; i++) {
+      const { key, value } = changes.rows[i]
+      await index.add(key, value.message)
+    }
+    return index.search(query, options)
+  }
+  return { search }
+}

package/test/prolly.test.js

@@ -146,9 +146,11 @@ class TestPail {
    */
   async put (key, value) {
     const result = await put(this.blocks, this.head, { key, value })
-    if (!result) { console.log('failed', key, value) }
+    if (!result) {
+      console.log('failed', key, value)
+    }
     this.blocks.putSync(result.event.cid, result.event.bytes)
-    result.additions.forEach(a => this.blocks.putSync(a.cid, a.bytes))
+    result.additions.forEach((a) => this.blocks.putSync(a.cid, a.bytes))
     this.head = result.head
     this.root = result.root.cid
     // this difference probably matters, but we need to test it
@@ -162,42 +164,27 @@ class TestPail {
 
   /** @param {import('../src/clock').EventLink<import('../src/crdt').EventData>} event */
   async advance (event) {
-    this.head = await advance(this.blocks, this.head, event)
-    this.root = (await root(this.blocks, this.head)).block.cid
+    const { head } = await advance(this.blocks, this.head, event)
+    this.head = head
+    this.root = (await root(this.blocks, this.head)).node.block.cid
     return this.head
   }
 
-  // /**
-  //  * @param {string} key
-  //  * @param {import('../src/link.js').AnyLink} value
-  //  */
-  // async putAndVis (key, value) {
-  //   const result = await this.put(key, value)
-  //   /** @param {import('../src/link').AnyLink} l */
-  //   const shortLink = l => `${String(l).slice(0, 4)}..${String(l).slice(-4)}`
-  //   /** @type {(e: import('../src/clock').EventBlockView<import('../src/crdt').EventData>) => string} */
-  //   const renderNodeLabel = event => {
-  //     return event.value.data.type === 'put'
-  //       ? `${shortLink(event.cid)}\\nput(${event.value.data.key}, ${shortLink(event.value.data.value)})`
-  //       : `${shortLink(event.cid)}\\ndel(${event.value.data.key})`
-  //   }
-  //   for await (const line of vis(this.blocks, result.head, { renderNodeLabel })) {
-  //     console.log(line)
-  //   }
-  //   return result
-  // }
-
   /** @param {string} key */
   async get (key) {
-    return get(this.blocks, this.head, key)
+    const resp = await get(this.blocks, this.head, key)
+    console.log('prolly GET', key, resp)
+    return resp.result
   }
 
   /** @param {string} key */
   async getAll () {
-    return getAll(this.blocks, this.head)
+    const resp = await getAll(this.blocks, this.head)
+    return resp.result
   }
 
   async getSince (since) {
-    return eventsSince(this.blocks, this.head, since)
+    const resp = await eventsSince(this.blocks, this.head, since)
+    return resp.result
   }
 }

package/test/proofs.test.js

@@ -0,0 +1,53 @@
+import { describe, it, beforeEach } from 'mocha'
+import assert from 'node:assert'
+import Fireproof from '../src/fireproof.js'
+
+let database, ok, doc
+
+describe('Proofs', () => {
+  beforeEach(async () => {
+    database = Fireproof.storage()
+    ok = await database.put({
+      _id: 'test1',
+      score: 75
+    })
+    doc = await database.get(ok.id, { mvcc: true })
+  })
+
+  it.skip('first put result shoud not include proof', async () => {
+    assert(ok.proof)
+    assert(ok.proof.data)
+    assert(ok.proof.clock)
+    console.log('ok', ok)
+    assert.equal(ok.proof.data.length, 0)
+    assert.equal(ok.proof.clock.length, 0)
+
+    // assert.equal(ok.proof.data[0], 'bafyreibsbxxd4ueujryihk6xza2ekwhzsh6pzuu5fysft5ilz7cbw6bjju')
+    // assert.equal(ok.proof.clock[0].toString(), 'bafyreiactx5vku7zueq27i5zdrgcjnczxvepceo5yszjqb2exufwrwxg44')
+  })
+
+  it.skip('second put result shoud include proof', async () => {
+    const ok2 = await database.put({ ...doc, winner: true })
+    assert(ok2.proof)
+    assert(ok2.proof.data)
+    assert(ok2.proof.clock)
+    console.log('ok2', ok2)
+    assert.equal(ok2.proof.data.length, 1)
+    assert.equal(ok2.proof.clock.length, 1)
+
+    // assert.equal(ok.proof.data[0], 'bafyreibsbxxd4ueujryihk6xza2ekwhzsh6pzuu5fysft5ilz7cbw6bjju')
+    // assert.equal(ok.proof.clock[0].toString(), 'bafyreiactx5vku7zueq27i5zdrgcjnczxvepceo5yszjqb2exufwrwxg44')
+  })
+
+  it('get result shoud include proof', async () => {
+    assert(doc._clock)
+    assert(doc._proof)
+
+    assert(doc._proof.data)
+    assert(doc._proof.clock)
+    assert.equal(doc._proof.data.length, 1)
+    assert.equal(doc._proof.clock.length, 1)
+    assert.equal(doc._proof.data[0], 'bafyreibsbxxd4ueujryihk6xza2ekwhzsh6pzuu5fysft5ilz7cbw6bjju')
+    assert.equal(doc._proof.clock[0].toString(), 'bafyreiactx5vku7zueq27i5zdrgcjnczxvepceo5yszjqb2exufwrwxg44')
+  })
+})

package/test/reproduce-fixture-bug.test.js

@@ -0,0 +1,65 @@
+import { describe, it, beforeEach } from 'mocha'
+import assert from 'node:assert'
+import Fireproof from '../src/fireproof.js'
+import DbIndex from '../src/db-index.js'
+
+let database
+
+describe('IPLD encode error', () => {
+  beforeEach(async () => {
+    database = Fireproof.storage()
+    defineIndexes(database)
+  })
+
+  it('reproduce', async () => {
+    await loadFixtures(database)
+    assert(true)
+  })
+})
+
+const defineIndexes = (database) => {
+  database.allLists = new DbIndex(database, function (doc, map) {
+    if (doc.type === 'list') map(doc.type, doc)
+  })
+  database.todosByList = new DbIndex(database, function (doc, map) {
+    if (doc.type === 'todo' && doc.listId) {
+      map([doc.listId, doc.createdAt], doc)
+    }
+  })
+  return database
+}
+
+function mulberry32 (a) {
+  return function () {
+    let t = (a += 0x6d2b79f5)
+    t = Math.imul(t ^ (t >>> 15), t | 1)
+    t ^= t + Math.imul(t ^ (t >>> 7), t | 61)
+    return ((t ^ (t >>> 14)) >>> 0) / 4294967296
+  }
+}
+const rand = mulberry32(1) // determinstic fixtures
+
+async function loadFixtures (database) {
+  const nextId = (prefix = '') => prefix + rand().toString(32).slice(2)
+  const ok = await database.put({ title: 'Building Apps', type: 'list', _id: nextId() })
+
+  await database.put({
+    _id: nextId(),
+    title: 'In the browser',
+    listId: ok.id,
+    completed: rand() > 0.75,
+    type: 'todo',
+    createdAt: '2'
+  })
+  await reproduceBug(database)
+}
+
+const reproduceBug = async (database) => {
+  const id = '02pkji8'
+  const doc = await database.get(id)
+  // (await database.put({ completed: !completed, ...doc }))
+  const ok = await database.put(doc)
+  await database.todosByList.query({ range: [0, 1] })
+
+  console.log('ok', ok)
+}

package/README.md

@@ -1,148 +0,0 @@
-# 🔥 Fireproof
-
-Fireproof is a realtime database for today's interactive applications. It uses immutable data and distributed protocols 
-to offer a new kind of database that:
-- can be embedded in any page or app, with a flexible data ownership model
-- scales without incurring developer costs, thanks to Filecoin
-- uses cryptographically verifiable protocols (what plants crave)
-
-Learn more about the concepts and architecture behind Fireproof [in our plan,](https://hackmd.io/@j-chris/SyoE-Plpj) or jump to the [quick start](#quick-start) for React and server-side examples.
-
-### Status
-
-Fireproof is alpha software, you should only use it if you are planning to contribute. For now, [check out our React TodoMVC implementation running in browser-local mode.](https://main--lucky-naiad-5aa507.netlify.app/) It demonstrates document persistence, index queries, and event subscriptions, and uses the [`useFireproof()` React hook.](https://github.com/jchris/fireproof/blob/main/examples/todomvc/src/hooks/useFireproof.js)
-
-[![Test](https://github.com/jchris/fireproof/actions/workflows/test.yml/badge.svg)](https://github.com/jchris/fireproof/actions/workflows/test.yml)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-
-## Usage
-
-```js
-import Fireproof from 'fireproof';
-
-async function main() {
-  const database = new Fireproof();
-  const ok = await database.put({
-    name: 'alice',
-    age: 42
-  });
-  
-  const doc = await database.get(ok.id);
-  console.log(doc.name); // 'alice'
-}
-
-main();
-```
-
-## Features
-
-### Document Store
-
-A simple put, get, and delete interface for keeping track of all your JSON documents. Once your data is in Fireproof you can access it from any app or website. Fireproof document store uses MVCC versioning and Merkle clocks so you can always recover the version you are looking for.
-
-```js
-const { id, ref } = await database.put({
-    _id: 'three-thousand'
-    name: 'André',
-    age: 47
-});
-const doc = await database.get('three-thousand')
-// {
-//    _id  : 'three-thousand'
-//    _ref : CID(bafy84...agfw7)
-//    name : 'André',
-//    age  : 47
-// }
-```
-
-The `_ref` allows you to query a stable snapshot of that version of the database. Fireproof uses immutable data structures under the hood, so you can always rollback to old data. Files can be embedded anywhere in your document using IPFS links like `{"/":"bafybeih3e3zdiehbqfpxzpppxrb6kaaw4xkbqzyr2f5pwr5refq2te2ape"}`, with API sugar coming soon.
-
-### Flexible Indexes
-
-Fireproof indexes are defined by custom JavaScript functions that you write, allowing you to easily index and search your data in the way that works best for your application. Easily handle data variety and schema drift by normalizing any data to the desired index.
-
-```js
-const index = new Index(database, function (doc, map) {
-  map(doc.age, doc.name)
-})
-const { rows, ref } = await index.query({ range: [40, 52] })
-// [ { key: 42, value: 'alice', id: 'a1s3b32a-3c3a-4b5e-9c1c-8c5c0c5c0c5c' },
-//   { key: 47, value: 'André', id: 'three-thousand' } ]
-```
-
-### Realtime Updates
-
-Subscribe to query changes in your application, so your UI updates automatically. Use the supplied React hooks, our Redux connector, or simple function calls to be notified of relevant changes.
-
-```js
-const listener = new Listener(database, function(doc, emit) {
-  if (doc.type == 'member') {
-    emit('member')
-  }
-})
-listener.on('member', (id) => {
-  const doc = await db.get(id)
-  alert(`Member update ${doc.name}`)
-})
-```
-
-### Self-soverign Identity
-
-Fireproof is so easy to integrate with any site or app because you can get started right away, and set up an account later. By default users write to their own database copy, so you can get pretty far before you even have to think about API keys. [Authorization is via non-extractable keypair](https://ucan.xyz), like TouchID / FaceID.
-
-### Automatic Replication
-
-Documents changes are persisted to [Filecoin](https://filecoin.io) via [web3.storage](https://web3.storage), and made available over [IPFS] and on a global content delivery network. All you need to do to sync state is send a link to the latest database head, and Fireproof will take care of the rest. [Learn how to enable replication.](#status)
-
-### Cryptographic Proofs
-
-The [UCAN protocol](https://ucan.xyz) verifably links Fireproof updates to authorized agents via cryptographic proof chains. These proofs are portable like bearer tokens, but because invocations are signed by end-user device keys, UCAN proofs don't need to be hidden to be secure, allowing for delegation of service capabilities across devices and parties. Additionally, Fireproof's Merkle clocks and hash trees are immutable and self-validating, making merging changes safe and efficient. Fireproof makes cryptographic proofs available for all of it's operations, making it an ideal verfiable document database for smart contracts and other applications running in trustless environments. [Proof chains provide performance benefits as well](https://purrfect-tracker-45c.notion.site/Data-Routing-23c37b269b4c4c3dacb60d0077113bcb), by allowing recipients to skip costly I/O operations and instead cryptographically verify that changes contain all of the required context.
-
-## Limitations 💣
-
-### Security
-
-Until encryption support is enabled, all data written to Fireproof is public. There are no big hurdles for this feature but it's not ready yet.
-
-### Persistence
-
-Currently Fireproof writes transactions and proofs to in-memory [CAR files](https://ipld.io/specs/transport/car/carv2/) which are well suited for peer and cloud replication. Durability coming soon.
-
-### Pre-beta Software
-
-While the underlying data structures and libraries Fireproof uses are trusted with billions of dollars worth of data, Fireproof started in February of 2023. Results may vary.
-
-## Thanks 🙏
-
-Fireproof is a synthesis of work done by people in the web community over the years. I couldn't even begin to name all the folks who made pivotal contributions. Without npm, React, and VS Code all this would have taken so much longer. Thanks to everyone who supported me getting into database development via Apache CouchDB, one of the original document databases. The distinguishing work on immutable datastructures comes from the years of consideration [IPFS](https://ipfs.tech), [IPLD](https://ipld.io), and the [Filecoin APIs](https://docs.filecoin.io) have enjoyed.
-
-Thanks to Alan Shaw and Mikeal Rogers without whom this project would have never got started. The core Merkle hash-tree clock is based on [Alan's Pail](https://github.com/alanshaw/pail), and you can see the repository history goes all the way back to work begun as a branch of that repo. Mikeal wrote [the prolly trees implementation](https://github.com/mikeal/prolly-trees).
-
-## Quick Start
-
-Look in the `examples/` directory for projects using the database. It's not picky how you use it, but we want to provide convenient jumping off places. Think of the examples as great to fork when starting your next project.
-
-If are adding Fireproof to an existing page, just install it and try some operations.
-
-```
-npm install @fireproof/core
-```
-
-In your `app.js` or `app.tsx` file:
-
-```
-import { Fireproof } from '@fireproof/core'
-const fireproof = Fireproof.storage()
-const ok = await fireproof.put({ hello: 'world' })
-const doc = await fireproof.get(ok.id)
-```
-
-🤫 I like to drop a `window.fireproof = fireproof` in there as a development aid.
-
-# Contributing
-
-Feel free to join in. All welcome. [Open an issue](https://github.com/jchris/fireproof/issues)!
-
-# License
-
-Dual-licensed under [MIT or Apache 2.0](https://github.com/jchris/fireproof/blob/main/LICENSE.md)

package/hooks/use-fireproof.md

@@ -1,149 +0,0 @@
-# useFireproof hook for React
-
- React hook to initialize a Fireproof database, automatically saving and loading the clock.
- 
- The hook takes two optional setup function arguments, `defineDatabaseFn` and `setupDatabaseFn`. See below for examples.
- 
-The return value looks like `{ ready, database, addSubscriber }` where the `database` is your Fireproof instance that you can interact with using `put` and `get`, or via your indexes. The `ready` flag turns true after setup completes, you can use this to activate your UI. The `addSubscriber` function is used to update your app in realtime, see example. 
-
-## Usage Example
-
-In App.js:
-
-```js
-import { FireproofCtx, useFireproof } from '@fireproof/core/hooks/use-fireproof'
-
-function App() {
-  // establish the Fireproof context value
-  const fpCtxValue = useFireproof()
-
-  // render the rest of the application wrapped in the Fireproof provider
-  return (
-    <FireproofCtx.Provider value={fpCtxValue}>
-        <MyComponent />
-    </FireproofCtx.Provider>
-  )
-}
-```
-
-In your components:
-
-```js
-import { FireproofCtx } from '@fireproof/core/hooks/use-fireproof'
-
-function MyComponent() {
-  // get Fireproof context
-  const { ready, database, addSubscriber } = useContext(FireproofCtx)
-
-  // set a default empty document
-  const [doc, setDoc] = useState({})
-  
-  // function to load the document from the database
-  const getDataFn = async () => {
-    setDoc(await database.get("my-doc-id"))
-  }
-
-  // run that function when the database changes
-  addSubscriber('MyComponent', getDataFn)
-
-  // run the loader on first mount
-  useEffect(() => getDataFn(), [])
-
-  // a function to change the value of the document
-  const updateFn = async () => {
-    await database.put({ _id : "my-doc-id", hello: "world", updated_at: new Date()})
-  }
-
-  // render the document with a click handler to update it
-  return <pre onclick={updateFn}>JSON.stringify(doc)</pre>
-}
-```
-
-This should result in a tiny application that updates the document when you click it. In a real appliction you'd probably query an index to present eg. all of the photos in a gallery.
-
-## Setup Functions
-
-### defineDatabaseFn 
- 
- Synchronous function that defines the database, run this before any async calls. You can use it to do stuff like set up Indexes. Here's an example:
-
- ```js
- const defineIndexes = (database) => {
-  database.allLists = new Index(database, function (doc, map) {
-    if (doc.type === 'list') map(doc.type, doc)
-  })
-  database.todosByList = new Index(database, function (doc, map) {
-    if (doc.type === 'todo' && doc.listId) {
-      map([doc.listId, doc.createdAt], doc)
-    }
-  })
-  window.fireproof = database // 🤫 for dev
-  return database
-}
- ```
-
-### setupDatabaseFn
-
- Asynchronous function that uses the database when it's ready, run this to load fixture data, insert a dataset from somewhere else, etc. Here's a simple example:
-
-
-```
-async function setupDatabase(database)) {
-    const apiData = await (await fetch('https://dummyjson.com/products')).json()
-    for (const product of apiData.products) {
-        await database.put(product)
-    }  
-}
-```
-
-Note there are no protections against you running the same thing over and over again, so you probably want to put some logic in there to do the right thing.
-
-Here is an example of generating deterministic fixtures, using `mulberry32` for determinstic randomness so re-runs give the same CID, avoiding unnecessary bloat at development time, taken from the TodoMVC demo app.
-
- ```js
- function mulberry32(a) {
-  return function () {
-    let t = (a += 0x6d2b79f5)
-    t = Math.imul(t ^ (t >>> 15), t | 1)
-    t ^= t + Math.imul(t ^ (t >>> 7), t | 61)
-    return ((t ^ (t >>> 14)) >>> 0) / 4294967296
-  }
-}
-const rand = mulberry32(1) // determinstic fixtures
-
-export default async function loadFixtures(database) {
-  const nextId = (prefix = '') => prefix + rand().toString(32).slice(2)
-  const listTitles = ['Building Apps', 'Having Fun', 'Getting Groceries']
-  const todoTitles = [
-    [
-      'In the browser',
-      'On the phone',
-      'With or without Redux',
-      'Login components',
-      'GraphQL queries',
-      'Automatic replication and versioning',
-    ],
-    ['Rollerskating meetup', 'Motorcycle ride', 'Write a sci-fi story with ChatGPT'],
-    ['Macadamia nut milk', 'Avocado toast', 'Coffee', 'Bacon', 'Sourdough bread', 'Fruit salad'],
-  ]
-  let ok
-  for (let j = 0; j < 3; j++) {
-    ok = await database.put({ 
-        title: listTitles[j], 
-        type: 'list', 
-        _id: nextId('' + j) 
-    })
-    for (let i = 0; i < todoTitles[j].length; i++) {
-      await database.put({
-        _id: nextId(),
-        title: todoTitles[j][i],
-        listId: ok.id,
-        completed: rand() > 0.75,
-        type: 'todo',
-      })
-    }
-  }
-}
- ```
-
-