mobx-keystone-loro 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+## 1.0.0 (unreleased)
+
+- Refactored internal synchronization to use deep change observation instead of JSON patches. This provides proper array splice detection, avoiding the previous behavior where array operations were converted to individual element patches. The result is more efficient array synchronization and better alignment with how Loro handles array modifications.
+- Added `moveWithinArray(array, fromIndex, toIndex)` helper function for explicit array move operations. When used on a bound array, this translates to a native Loro `move()` operation, preserving item identity and history across clients. This replaces the previous automatic move detection logic which was complex and less predictable.
+- Fixed a synchronization issue where values added to a collection and then mutated within the same action could cause desync. Snapshots are now captured at change time rather than at action completion time.
+- Initial release of `mobx-keystone-loro`.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Javier González Garcés
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# mobx-keystone-loro
+
+Loro CRDT bindings for mobx-keystone.
+
+This package provides bidirectional synchronization between mobx-keystone models and Loro CRDT documents. It enables real-time collaborative editing of mobx-keystone state trees.
+
+## Features
+
+- Uses `LoroMap` for objects (LWW semantics)
+- Uses `LoroMovableList` for arrays with native move operations
+- Uses `LoroText` for rich text editing
+- Automatically detects and uses move operations when reordering array items
+- Full bidirectional sync between mobx-keystone and Loro
+
+## Installation
+
+```bash
+npm install mobx-keystone-loro
+# or
+yarn add mobx-keystone-loro
+```
+
+## Peer Dependencies
+
+- `mobx` ^4.3.1 || ^5.0.0 || ^6.0.0
+- `mobx-keystone` ^1.16.0
+- `loro-crdt` ^1.0.0
+
+## Usage
+
+```typescript
+import { LoroDoc } from "loro-crdt"
+import { Model, tProp, types, modelAction, registerRootStore } from "mobx-keystone"
+import { bindLoroToMobxKeystone } from "mobx-keystone-loro"
+
+// Define your model
+@model("myApp/Todo")
+class Todo extends Model({
+  text: tProp(types.string),
+  done: tProp(types.boolean, false),
+}) {
+  @modelAction
+  setText(text: string) {
+    this.text = text
+  }
+
+  @modelAction
+  toggle() {
+    this.done = !this.done
+  }
+}
+
+// Create a Loro document
+const doc = new LoroDoc()
+const rootMap = doc.getMap("root")
+
+// Initialize with snapshot data
+rootMap.set("text", "Hello")
+rootMap.set("done", false)
+doc.commit()
+
+// Bind to mobx-keystone
+const { boundObject, dispose } = bindLoroToMobxKeystone({
+  loroDoc: doc,
+  loroObject: rootMap,
+  mobxKeystoneType: Todo,
+})
+
+registerRootStore(boundObject)
+
+// Changes to boundObject will sync to Loro
+boundObject.setText("World")
+
+// Changes from Loro will sync to boundObject
+rootMap.set("done", true)
+doc.commit()
+
+// Clean up when done
+dispose()
+```
+
+## API
+
+### `bindLoroToMobxKeystone(options)`
+
+Creates a bidirectional binding between a Loro object and a mobx-keystone model.
+
+#### Options
+
+- `loroDoc: LoroDoc` - The Loro document
+- `loroObject: LoroMap | LoroMovableList | LoroText` - The Loro object to bind to
+- `mobxKeystoneType: ModelClass<T> | AnyStandardType` - The mobx-keystone model class or type
+
+#### Returns
+
+- `boundObject: T` - The mobx-keystone model instance
+- `dispose: () => void` - Function to clean up the binding
+- `loroOrigin: string` - The origin string used for Loro commits by the binding
+
+### `LoroTextModel`
+
+A mobx-keystone model for representing Loro rich text.
+
+```typescript
+import { LoroTextModel } from "mobx-keystone-loro"
+
+// Create a text model
+const textModel = LoroTextModel.withText("Hello, world!")
+
+// Access the plain text
+console.log(textModel.text) // "Hello, world!"
+
+// Access the delta for rich text (Quill format)
+console.log(textModel.delta)
+```
+
+## License
+
+MIT