import * as automerge from "https://deno.land/x/automerge@2.2.2/next.ts";

The next API

This module contains new features we are working on which are backwards incompatible with the current API of Automerge. This module will become the API of the next major version of Automerge

Differences from stable

In the stable API text objects are represented using the Text class. This means you must decide up front whether your string data might need concurrent merges in the future and if you change your mind you have to figure out how to migrate your data. In the unstable API the Text class is gone and all strings are represented using the text CRDT, allowing for concurrent changes. Modifying a string is done using the splice function. You can still access the old behaviour of strings which do not support merging behaviour via the RawString class.

This leads to the following differences from stable:

There is no unstable.Text class, all strings are text objects
Reading strings in an unstable document is the same as reading any other javascript string
To modify strings in an unstable document use splice
The AutomergeValue type does not include the Text class but the RawString class is included in the ScalarValue type

CHANGELOG

Rename this module to next to reflect our increased confidence in it and stability commitment to it
Introduce this module to expose the new API which has no Text class

Classes

c Counter	The most basic CRDT: an integer value that can be changed only by incrementing and decrementing. Since addition of integers is commutative, the value trivially converges.
c Float64
c Int
c RawString
c Uint

Variables

getBackend

Functions

f applyChanges	Apply changes received from another document
f block	Get the block marker at the given index
f change	Update the contents of an automerge document
f changeAt	Make a change to the document as it was at a particular point in history
f clone	Make a full writable copy of an automerge document
f decodeChange
f decodeSyncMessage
f decodeSyncState	Decode some binary data into a SyncState
f deleteAt	Function for use in change which deletes values from a list at a given index
f diff	Create a set of patches representing the change from one set of heads to another
f dump
f emptyChange	Make a change to a document which does not modify the document
f encodeChange
f encodeSyncMessage
f encodeSyncState	encode a SyncState into binary to send over the network
f equals
f free	Explicity free the memory backing a document. Note that this is note necessary in environments which support `FinalizationRegistry`
f from	Create an automerge document from a POJO
f generateSyncMessage	Generate a sync message to send to the peer represented by `inState`
f getActorId	Get the actor ID associated with the document
f getAllChanges	Get all the changes in a document
f getChanges	Get the changes which are in `newState` but not in `oldState`. The returned changes can be loaded in `oldState` via applyChanges.
f getConflicts	Get the conflicts associated with a property
f getCursor	Returns a cursor for the given position in a string.
f getCursorPosition	Returns the current index of the cursor.
f getHeads	Get the hashes of the heads of this document
f getHistory
f getLastLocalChange	Get the binary representation of the last change which was made to this doc
f getMissingDeps	Get any changes in `doc` which are not dependencies of `heads`
f getObjectId	Return the object ID of an arbitrary javascript value
f init	Create a new automerge document
f initSyncState	Create a new, blank SyncState
f insertAt	Function for use in change which inserts values into a list at a given index
f isAutomerge
f joinBlock	Delete the block marker at the given index
f load	Load an automerge document from a compressed document produce by save
f loadIncremental	Load changes produced by saveIncremental, or partial changes
f mark
f marks
f marksAt
f merge	Merge `remote` into `local`
f receiveSyncMessage	Update a document and our sync state on receiving a sync message
f save	Export the contents of a document to a compressed format
f saveIncremental	Create binary save data to be appended to a save file or fed into loadIncremental
f saveSince
f spans	Return the text + block markers at a given path
f splice	Modify a string
f splitBlock	Insert a new block marker at the given index
f toJS
f unmark
f updateBlock	Update the block marker at the given index
f updateSpans	Update the spans at the given path
f updateText	Update the value of a string
f view	Make an immutable view of an automerge document as at `heads`

Interfaces

MarkSet

Type Aliases

T ActorId
T ApplyOptions	Options passed to loadIncremental, applyChanges, and receiveSyncMessage
T AutomergeValue
T Change
T ChangeAtResult	The type returned from changeAt
T ChangeFn	Function which is called by change when making changes to a `Doc<T>`
T ChangeOptions	Options passed to change, and emptyChange
T Cursor
T DecodedChange
T DecodedSyncMessage
T DelPatch
T Doc	An automerge document.
T Heads
T IncPatch
T InitOptions
T InsertPatch
T Mark
T MarkPatch
T MarkRange
T MarkValue
T MaterializeValue
T Patch
T PatchCallback	Callback which is called by various methods in this library to notify the user of what changes have been made.
T PatchInfo
T PatchSource
T Prop
T PutPatch
T ScalarValue
T Span
T SpliceTextPatch
T SyncMessage
T SyncState	An opaque type tracking the state of sync with a remote peer