automerge-bundle

an automerge bundle that can be used directly in the browser (e.g., for no-build environments like REPLs or similar) (live demo)

automerge uses WASM under the hood and can therefore not directly be imported into a browser - you will have to use a bundler (such as Vite) that brings your web application into a format that can be loaded into a browser.

Or, alternatively, you just load the automerge-bundle from this repository using a simple <script/> element, wait for automerge to become available (because it has to be loaded as a JavaScript module) and then use it in your code:

<script type="module" src="https://rozek.github.io/automerge-bundle/dist/automerge-bundle.js"></script>

<script>
  if (window.automerge == null) {
    document.addEventListener('automerge',runApplication)
  } else {
    runApplication()
  }

  function runApplication () {
    const {
      next, isValidAutomergeUrl, Repo,
      IndexedDBStorageAdapter, BrowserWebSocketClientAdapter, BroadcastChannelNetworkAdapter
    } = window.automerge

// ....insert your automerge code here
  }
</script>

automerge-bundle creates a global called automerge with the following contents

• next - imported from @automerge/automerge
• isValidAutomergeUrl and Repo - imported from @automerge/automerge-repo
• IndexedDBStorageAdapter - imported from @automerge/automerge-repo-storage-indexeddb
• BrowserWebSocketClientAdapter - imported from @automerge/automerge-repo-network-websocket
• BroadcastChannelNetworkAdapter - imported from @automerge/automerge-repo-network-broadcastchannel

As a consequence, instead of

import { next } from "@automerge/automerge"

you now write

const { next } = window.automerge

or similar - as soon as automerge has become available.

Build Instructions

You may easily build this package yourself.

Just install NPM according to the instructions for your platform and follow these steps:

1. either clone this repository using git or download a ZIP archive with its contents to your disk and unpack it there
2. open a shell and navigate to the root directory of this repository
3. run npm install in order to install the complete build environment
4. execute npm run build to create a new build

License

MIT License