@spec counter_get(node_ref(), doc_id(), path(), binary()) :: integer()

Get the current counter value.

Examples

42 = IrohEx.Automerge.counter_get(node, doc_id, [], "views")

@spec counter_increment(node_ref(), doc_id(), path(), binary(), integer()) ::
  integer()

Increment a counter (creates it if it doesn't exist).

Counters are a special CRDT type that always converge correctly, even with concurrent increments from multiple nodes.

Examples

1 = IrohEx.Automerge.counter_increment(node, doc_id, [], "views", 1)
6 = IrohEx.Automerge.counter_increment(node, doc_id, [], "views", 5)
4 = IrohEx.Automerge.counter_increment(node, doc_id, [], "views", -2)

@spec create_list(node_ref(), doc_id(), path(), binary()) ::
  {:ok, binary()} | {:error, term()}

Create a list at the given path.

Examples

IrohEx.Automerge.create_list(node, doc_id, [], "items")

@spec create_map(node_ref(), doc_id(), path(), binary()) ::
  {:ok, binary()} | {:error, term()}

Create a nested map structure.

Examples

IrohEx.Automerge.create_map(node, doc_id, [], "users")
IrohEx.Automerge.create_map(node, doc_id, ["users"], "alice")
:ok = IrohEx.Automerge.put(node, doc_id, ["users", "alice"], "name", "Alice")

@spec create_text(node_ref(), doc_id(), path(), binary(), binary()) ::
  {:ok, binary()} | {:error, term()}

Create a collaborative text object.

Text objects support character-level concurrent editing with automatic conflict resolution.

Examples

IrohEx.Automerge.create_text(node, doc_id, [], "content", "Hello World")

@spec delete(node_ref(), doc_id()) :: boolean()

Delete a document from memory.

Examples

true = IrohEx.Automerge.delete(node, doc_id)

@spec delete_key(node_ref(), doc_id(), path(), binary()) :: :ok | {:error, term()}

Delete a key from a map.

Examples

:ok = IrohEx.Automerge.delete_key(node, doc_id, [], "old_field")

@spec fork(node_ref(), doc_id()) :: doc_id()

Fork a document (create a copy with shared history).

Forking is useful for:

• Simulating concurrent edits in tests
• Creating branches of a document
• Offline editing that will be merged later

Examples

doc2 = IrohEx.Automerge.fork(node, doc_id)

@spec get(node_ref(), doc_id(), path(), binary()) :: term()

Get a value at a nested path.

Examples

"Alice" = IrohEx.Automerge.get(node, doc_id, [], "name")
:not_found = IrohEx.Automerge.get(node, doc_id, [], "nonexistent")

@spec keys(node_ref(), doc_id(), path()) :: [binary()]

Get all keys from a map.

Examples

["name", "age", "email"] = IrohEx.Automerge.keys(node, doc_id, [])

@spec list(node_ref()) :: [doc_id()]

List all document IDs.

Examples

doc_ids = IrohEx.Automerge.list(node)

@spec list_delete(node_ref(), doc_id(), path(), non_neg_integer()) ::
  :ok | {:error, term()}

Delete a value from a list by index.

Examples

:ok = IrohEx.Automerge.list_delete(node, doc_id, ["items"], 0)

@spec list_get(node_ref(), doc_id(), path(), non_neg_integer()) :: term()

Get a value from a list by index.

Examples

"first" = IrohEx.Automerge.list_get(node, doc_id, ["items"], 0)

@spec list_insert(node_ref(), doc_id(), path(), non_neg_integer(), term()) ::
  :ok | {:error, term()}

Insert a value at a specific index.

Examples

:ok = IrohEx.Automerge.list_insert(node, doc_id, ["items"], 0, "at_beginning")

@spec list_length(node_ref(), doc_id(), path()) :: non_neg_integer()

Get the length of a list.

Examples

3 = IrohEx.Automerge.list_length(node, doc_id, ["items"])

@spec list_push(node_ref(), doc_id(), path(), term()) :: :ok | {:error, term()}

Push a value to the end of a list.

Examples

IrohEx.Automerge.create_list(node, doc_id, [], "items")
:ok = IrohEx.Automerge.list_push(node, doc_id, ["items"], "first")
:ok = IrohEx.Automerge.list_push(node, doc_id, ["items"], "second")

@spec load(node_ref(), binary()) :: {:ok, doc_id()} | {:error, term()}

Load a document from binary data.

Examples

{:ok, doc_id} = IrohEx.Automerge.load(node, saved_bytes)

@spec merge(node_ref(), doc_id(), binary()) :: :ok | {:error, term()}

Merge another document's changes into this one.

Examples

{:ok, other_bytes} = IrohEx.Automerge.save(node, other_doc_id)
:ok = IrohEx.Automerge.merge(node, doc_id, other_bytes)

@spec new(node_ref()) :: doc_id()

Create a new empty automerge document.

Examples

doc_id = IrohEx.Automerge.new(node)

@spec put(node_ref(), doc_id(), path(), binary(), term()) :: :ok | {:error, term()}

Put a value at a nested path.

Parameters

• node - The node reference
• doc_id - The document ID
• path - List of keys to navigate to (empty for root)
• key - The key to set
• value - The value (string, integer, float, boolean, or binary)

Examples

# Set at root level
:ok = IrohEx.Automerge.put(node, doc_id, [], "name", "Alice")

# Set at nested path (path must exist)
:ok = IrohEx.Automerge.put(node, doc_id, ["users", "alice"], "email", "alice@example.com")

@spec save(node_ref(), doc_id()) :: {:ok, binary()} | {:error, term()}

Save a document to binary format.

The binary format is compact and can be stored or transmitted.

Examples

{:ok, bytes} = IrohEx.Automerge.save(node, doc_id)
File.write!("document.automerge", bytes)

@spec sync(node_ref(), doc_id()) :: :ok | {:error, term()}

Sync document with all connected peers via gossip.

This broadcasts the full document to all peers in the gossip network.

Examples

:ok = IrohEx.Automerge.sync(node, doc_id)

@spec text_delete(node_ref(), doc_id(), path(), non_neg_integer(), non_neg_integer()) ::
  :ok | {:error, term()}

Delete text at a position.

Examples

:ok = IrohEx.Automerge.text_delete(node, doc_id, ["content"], 5, 10)
# Deletes 10 characters starting at position 5

@spec text_get(node_ref(), doc_id(), path()) :: binary()

Get the full text content.

Examples

"Hello World" = IrohEx.Automerge.text_get(node, doc_id, ["content"])

@spec text_insert(node_ref(), doc_id(), path(), non_neg_integer(), binary()) ::
  :ok | {:error, term()}

Insert text at a position.

Examples

:ok = IrohEx.Automerge.text_insert(node, doc_id, ["content"], 5, " Beautiful")
# "Hello Beautiful World"

@spec to_json(node_ref(), doc_id()) :: binary()

Get document as JSON string for debugging.

Examples

json = IrohEx.Automerge.to_json(node, doc_id)
IO.puts(json)