crdt_lf 1.0.0

crdt_lf: ^1.0.0 copied to clipboard

Breaking changes Create a set of exception classes to be used across the library. Replace StateError with CrdtException and its subclasses.

• applyChange: throws CausallyNotReadyException instead of StateError when a change's dependencies are not met;
• On import when a cycle is detected among changes throws ChangesCycleException instead of StateError;
• On add node when a node already exists throws DuplicateNodeException instead of StateError;
• On add node when a dependency is missing throws MissingDependencyException instead of StateError;
• On Fugue tree insertion when a node already exists throws DuplicateNodeException instead of Exception.

Removed redundant hlc from Change. change.hlc is also available as getter 37

Hlc in version vector is now serialized as string instead of int64. This avoids precision loss when serialized as JSON for web interoperability.

Added #

• documentId to CRDTDocument, specified document identity to remove ambiguity between peer and document 38
• toString to Snapshot and VersionVector
• added a stream to CRDTDocument to be notified of every change (changes, snapshots, merges, ...)
• added mutable and method to VersionVector to create mutable copies
• added a export changes method to CRDTDocument to export changes that are newer than a given version vector

Changed #

• chore: setup .github/workflows and update coverage links 33
• chore: update readme with recommended approach for complex handler types
• chore: update topological sort implementation 3
• chore: added benchmarks

Fixed #

• Fix CRDTFugueTextHandler to ensure state is synchronized before performing operations 39
• Fix readme reference links
• Fix double hlc increment on CRDTDocument.createChange
• Fix snapshot initialization for handlers that return a non primitive value

Added #

• Added update operation for every handler 30

Changed #

• Update documentation

Fixed #

• Chore: update readme links

Added #

• CRDTDocument.mergeSnapshot to merge a snapshot with the current snapshot
• CRDTDocument.import to import changes and snapshots with a single method and different strategies

Changed #

• On changes pruning, if a change has a dependency on a pruned change, the dependency is removed to preserve integrity

Fixed #

• Fix snapshot initialization for handlers that return a non primitive value

Breaking

• Operation.toPayload is now a Map<String, dynamic> instead of dynamic (every operation was already returning a Map<String, dynamic>)

Added #

• CRDTMapHandler: a new handler for maps 13

Changed #

• chore: apply linter rules
• chore: more documentation on public api

Fixed #

• Fix folder name clash with gitignore rules

Breaking

• rename document.import in document.binaryImportChanges
• rename document.export in document.binaryExportChanges

Added #

• Snapshot implementation 14
• Version vector (foundational for building snapshots)

Fixed #

• Fix Fugue tree insertion

Changed #

• chore: move test utils under helpers folder

Added #

• CRDTDocument expose localChanges stream to listen to local changes 18
• flutter_example contains a routing with a basic example for each use case (currently only todo list)16
• Split Fugue algorithm from text handler 4

Added #

• Tests 6

Fixed #

• Fix cached value in handlers

Initial release

Added #

• CRDTDocument with ChangeStore and Frontiers
• CRDTTextHandler
• CRDTListHandler
• CRDTFugueTextHandler