npm package: @seandawson/hypermerge
Description: Node.js library for building p2p collaborative applications without server infrastructure
Latest version: 2.0.10-ad

Note: This is a temporary fork to get the NPM package to work properly
We are not the maintainers of Hypermerge

# Hypermerge

Hypermerge is a Node.js library for building p2p collaborative applications
without any server infrastructure. It combines [Automerge](https://github.com/automerge/automerge),
a CRDT, with [hypercore](https://github.com/mafintosh/hypercore), a distributed append-only log.

This project provides a way to have apps data sets that are
conflict free and offline first (thanks to CRDT's) and serverless (thanks to
hypercore/DAT).

While the DAT community has done a lot of work to secure their tool set, zero
effort has been made with hypermerge itself to deal with security and privacy
concerns. Due to the secure nature of the tools its built upon a properly
audited and secure version of this library would be possible in the future.

## How it works

<TODO>

## Examples

There are several example repos in the `/examples` directory, including a very simple two-repo
code demo and a simple CLI-based chat application.

The best demonstration of Hypermerge is PushPin, which shows Hypermerge in "full flight", including
taking advantage of splitting the fast, simple front-end from the more expensive, slower back-end.

## Concepts

The base object you make with hypermerge is a Repo. A repo is responsible for
managing documents and replicating to peers.

### Basic Setup (Serverless or with a Server)

```ts
import { Repo } from 'hypermerge'
import Hyperswarm from 'hyperswarm'

const path = '.data'

const repo = new Repo({ path })

repo.setSwarm(Hyperswarm())
```

### Create / Edit / View / Delete a document

```ts
const url = repo.create({ hello: 'world' })

repo.doc<any>(url, (doc) => {
  console.log(doc) // { hello: "world" }
})

// this is an automerge change function - see automerge for more info
// basically you get to treat the state as a plain old javacript object
// operations you make will be added to an internal append only log and
// replicated to peers

repo.change(url, (state: any) => {
  state.foo = 'bar'
})

repo.doc<any>(url, (doc) => {
  console.log(doc) // { hello: "world", foo: "bar" }
})

// to watch a document that changes over time ...
const handle = repo.watch(url, (doc: any) => {
  console.log(doc)
  if (doc.foo === 'bar') {
    handle.close()
  }
})
```

_NOTE_: If you're familiar with Automerge: the `change` function in Hypermerge
is asynchronous, while the `Automerge.change` function is synchronous. What this
means is that although `Automerge.change` returns an object representing the new
state of your document, `repo.change` (or `handle.change`) does NOT. So:

```ts
// ok in Automerge!
doc1 = Automerge.change(doc1, 'msg', (doc) => {
  doc.foo = 'bar'
})

// NOT ok in Hypermerge!
doc1 = repo.change(url1, (doc) => {
  doc.foo = 'bar'
})
```

Instead, you should expect to get document state updates via `repo.watch`
(or `handle.subscribe`) as shown in the example above.

### Two repos on different machines

```ts
const docUrl = repoA.create({ numbers: [2, 3, 4] })
// this will block until the state has replicated to machine B

repoA.watch<MyDoc>(docUrl, (state) => {
  console.log('RepoA', state)
  // { numbers: [2,3,4] }
  // { numbers: [2,3,4,5], foo: "bar" }
  // { numbers: [2,3,4,5], foo: "bar" } // (local changes repeat)
  // { numbers: [1,2,3,4,5], foo: "bar", bar: "foo" }
})

repoB.watch<MyDoc>(docUrl, (state) => {
  console.log('RepoB', state)
  // { numbers: [1,2,3,4,5], foo: "bar", bar: "foo" }
})

repoA.change<MyDoc>(docUrl, (state) => {
  state.numbers.push(5)
  state.foo = 'bar'
})

repoB.change<MyDoc>(docUrl, (state) => {
  state.numbers.unshift(1)
  state.bar = 'foo'
})
```

### Accessing Files

Hypermerge supports a special kind of core called a hyperfile. Hyperfiles are
unchanging, written-once hypercores that store binary data.

Here's a simple example of reading and writing files.

```ts
// Write an hyperfile
const fileStream = fs.createReadStream('image.png')
const { url } = await repo.files.write(fileStream, 'image/png')

// Read an hyperfile
const fileStream = fs.createWriteStream('image.png')
const hyperfileStream = await repo.files.read(url)

hyperfileStream.pipe(fileStream)
```

Note that hyperfiles are conveniently well-suited to treatment as a native
protocol for Electron applications. This allows you to refer to them throughout
your application directly as though they were regular files for images and other
assets without any special treatment. Here's how to register that:

```js
protocol.registerStreamProtocol(
  'hyperfile',
  (request, callback) => {
    try {
      const stream = await repo.files.read(request.url)
      callback(stream)
    } catch (e) {
      log(e)
    }
  },
  (error) => {
    if (error) {
      log('Failed to register protocol')
    }
  }
)
```

### Splitting the Front-end and Back-end

Both Hypermerge and Automerge supports separating the front-end (where materialized documents live and changes are made) from the backend (where CRDT computations are handled as well as networking and compression.) This is useful for maintaining application performance by moving expensive computation operations off of the render thread to another location where they don't block user input.

The communication between front-end and back-end is all done via simple Javascript objects and can be serialized/deserialized through JSON if required.

```js
  // establish a back-end
  const back = new RepoBackend({ path: HYPERMERGE_PATH, port: 0 })
  const swarm = Hyperswarm({ /* your config here */ })
  back.setSwarm(swarm)

  // elsewhere, create a front-end (you'll probably want to do this in different threads)
  const front = new RepoFrontend()

  // the `subscribe` method sends a message stream, the `receive` receives it
  // for demonstration here we simply output JSON and parse it back in the same location
  // note that front-end and back-end must each subscribe to each other's streams
  back.subscribe((msg) => front.receive(JSON.parse(JSON.stringify(msg))))
  front.subscribe((msg) => back.receive(JSON.parse(JSON.stringify(msg))))

}
```

_Note: each back-end only supports a single front-end today._

### Related libraries

[automerge]: https://github.com/automerge/automerge
[hypercore]: https://github.com/mafintosh/hypercore