@homeostate/store-mobx-state-tree 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @homeostate/store-mobx-state-tree
 
+## 0.1.2
+
+### Patch Changes
+
+- 30abf27: Remove draft release warnings, update docs links
+- Updated dependencies [30abf27]
+  - @homeostate/core@0.1.2
+
 ## 0.1.1
 
 ### Patch Changes

package/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -1,8 +1,5 @@
 # @homeostate/store-mobx-state-tree
 
-> **Early release.** The API is still being designed and may change in any `0.x` minor
-> version.
-
 [MobX-State-Tree](https://mobx-state-tree.js.org) store adapter for
 [`@homeostate/core`](https://github.com/mixedrays/homeostate/tree/main/packages/core).
 It keeps a state tree node in sync with a CRDT backend such as

package/package.json

@@ -1,8 +1,26 @@
 {
   "name": "@homeostate/store-mobx-state-tree",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "MobX-State-Tree adapter for @homeostate/core",
+  "license": "MIT",
   "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mixedrays/homeostate.git",
+    "directory": "packages/store-mobx-state-tree"
+  },
+  "homepage": "https://homeostate.pages.dev",
+  "bugs": {
+    "url": "https://github.com/mixedrays/homeostate/issues"
+  },
+  "keywords": [
+    "mobx-state-tree",
+    "mobx",
+    "crdt",
+    "sync",
+    "state-management",
+    "collaborative"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -13,10 +31,17 @@
   },
   "files": [
     "dist",
+    "src",
+    "!src/**/__tests__",
+    "README.md",
+    "LICENSE",
     "CHANGELOG.md"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
-    "@homeostate/core": "^0.1.1"
+    "@homeostate/core": "^0.1.2"
   },
   "peerDependencies": {
     "mobx": "^6.0.0 || ^7.0.0",

package/src/adapter.ts

@@ -0,0 +1,69 @@
+import {
+  applySnapshot,
+  getSnapshot,
+  onSnapshot,
+  type IStateTreeNode,
+  type IType,
+} from "mobx-state-tree";
+import type { StoreAdapter, Unsubscribe } from "@homeostate/core";
+
+/** A state tree node whose output snapshot is `S` */
+export type SnapshotNode<S> = IStateTreeNode<IType<unknown, S, unknown>>;
+
+/**
+ * MobX-State-Tree adapter that syncs a tree node through its snapshots.
+ * Snapshots go to the backend once per action, and remote changes are applied
+ * with `applySnapshot`, so instances with identifiers are reconciled in place.
+ *
+ * @example
+ * ```typescript
+ * import { types } from 'mobx-state-tree';
+ * import * as Y from 'yjs';
+ * import { createYjsBackend } from '@homeostate/crdt-yjs';
+ *
+ * const Counter = types
+ *   .model({ count: 0 })
+ *   .actions((self) => ({ increment() { self.count++; } }));
+ *
+ * const counter = Counter.create();
+ * const adapter = createMobxStateTreeAdapter(counter);
+ * const engine = createSyncEngine(createYjsBackend(new Y.Doc(), 'shared'), adapter);
+ * engine.connect();
+ * counter.increment();
+ * ```
+ */
+export class MobxStateTreeAdapter<S extends object> implements StoreAdapter<S> {
+  private node: SnapshotNode<S>;
+
+  /**
+   * Create a MobX-State-Tree adapter
+   * @param node - The tree node to sync; usually the root instance
+   */
+  constructor(node: SnapshotNode<S>) {
+    this.node = node;
+  }
+
+  getState(): S {
+    return getSnapshot(this.node);
+  }
+
+  setState(state: S): void {
+    applySnapshot(this.node, state);
+  }
+
+  subscribe(onStoreChange: () => void): Unsubscribe {
+    return onSnapshot(this.node, () => onStoreChange());
+  }
+}
+
+/**
+ * Factory function to create a MobX-State-Tree adapter
+ *
+ * @param node - The tree node to sync; usually the root instance
+ * @returns StoreAdapter instance for the node
+ */
+export function createMobxStateTreeAdapter<S extends object>(
+  node: SnapshotNode<S>,
+): StoreAdapter<S> {
+  return new MobxStateTreeAdapter(node);
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { MobxStateTreeAdapter, createMobxStateTreeAdapter } from "./adapter.js";
+export type { SnapshotNode } from "./adapter.js";

package/dist/__tests__/adapter.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=adapter.test.d.ts.map

package/dist/__tests__/adapter.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"adapter.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/adapter.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/adapter.test.js

@@ -1,113 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { getSnapshot, types } from "mobx-state-tree";
-import { createMemoryBackend, createSyncEngine, } from "@homeostate/core";
-import { createMobxStateTreeAdapter } from "../index.js";
-const Todo = types.model("Todo", {
-    id: types.identifier,
-    title: types.string,
-    done: false,
-});
-const TodoStore = types
-    .model("TodoStore", {
-    todos: types.array(Todo),
-    filter: types.optional(types.string, "all"),
-})
-    .actions((self) => ({
-    add(id, title) {
-        self.todos.push({ id, title });
-    },
-    toggle(id) {
-        const todo = self.todos.find((t) => t.id === id);
-        if (todo)
-            todo.done = !todo.done;
-    },
-    reset(filter) {
-        self.todos.clear();
-        self.filter = filter;
-    },
-}));
-const createStore = () => TodoStore.create({
-    todos: [
-        { id: "1", title: "a" },
-        { id: "2", title: "b" },
-    ],
-});
-const countingWrites = (backend) => {
-    const writes = [];
-    const counting = {
-        ...backend,
-        write: (next) => {
-            writes.push(next);
-            backend.write(next);
-        },
-    };
-    return { backend: counting, writes };
-};
-describe("MobxStateTreeAdapter", () => {
-    it("seeds the backend, writes actions, and applies remote changes", () => {
-        const store = createStore();
-        const backend = createMemoryBackend();
-        const engine = createSyncEngine(backend, createMobxStateTreeAdapter(store));
-        engine.connect();
-        expect(backend.read()).toEqual({
-            todos: [
-                { id: "1", title: "a", done: false },
-                { id: "2", title: "b", done: false },
-            ],
-            filter: "all",
-        });
-        store.toggle("2");
-        expect(backend.read().todos[1].done).toBe(true);
-        backend.receive({
-            todos: [{ id: "3", title: "c", done: true }],
-            filter: "done",
-        });
-        expect(getSnapshot(store)).toEqual({
-            todos: [{ id: "3", title: "c", done: true }],
-            filter: "done",
-        });
-        expect(store.todos[0].done).toBe(true);
-    });
-    it("adopts a non-empty backend as the initial state", () => {
-        const store = createStore();
-        const backend = createMemoryBackend({ todos: [], filter: "active" });
-        createSyncEngine(backend, createMobxStateTreeAdapter(store)).connect();
-        expect(getSnapshot(store)).toEqual({ todos: [], filter: "active" });
-    });
-    it("writes once per action even when the action mutates several fields", () => {
-        const store = createStore();
-        const { backend, writes } = countingWrites(createMemoryBackend());
-        createSyncEngine(backend, createMobxStateTreeAdapter(store)).connect();
-        expect(writes).toHaveLength(1);
-        store.reset("done");
-        expect(writes).toHaveLength(2);
-        expect(backend.read()).toEqual({ todos: [], filter: "done" });
-    });
-    it("reconciles remote changes onto existing instances by identifier", () => {
-        const store = createStore();
-        const backend = createMemoryBackend();
-        createSyncEngine(backend, createMobxStateTreeAdapter(store)).connect();
-        const second = store.todos[1];
-        backend.receive({
-            todos: [
-                { id: "1", title: "a", done: true },
-                { id: "2", title: "b", done: false },
-            ],
-            filter: "all",
-        });
-        expect(store.todos[0].done).toBe(true);
-        expect(store.todos[1]).toBe(second);
-    });
-    it("stops both directions after disconnect", () => {
-        const store = createStore();
-        const backend = createMemoryBackend();
-        const engine = createSyncEngine(backend, createMobxStateTreeAdapter(store));
-        engine.connect();
-        engine.disconnect();
-        store.add("3", "c");
-        expect(backend.read().todos).toHaveLength(2);
-        backend.receive({ todos: [], filter: "all" });
-        expect(store.todos).toHaveLength(3);
-    });
-});
-//# sourceMappingURL=adapter.test.js.map

package/dist/__tests__/adapter.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"adapter.test.js","sourceRoot":"","sources":["../../src/__tests__/adapter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,gBAAgB,GAEjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;IAC/B,EAAE,EAAE,KAAK,CAAC,UAAU;IACpB,KAAK,EAAE,KAAK,CAAC,MAAM;IACnB,IAAI,EAAE,KAAK;CACZ,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,KAAK;KACpB,KAAK,CAAC,WAAW,EAAE;IAClB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IACxB,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC;CAC5C,CAAC;KACD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAClB,GAAG,CAAC,EAAU,EAAE,KAAa;QAC3B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,CAAC,EAAU;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;IACnC,CAAC;IACD,KAAK,CAAC,MAAc;QAClB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF,CAAC,CAAC,CAAC;AAEN,MAAM,WAAW,GAAG,GAAG,EAAE,CACvB,SAAS,CAAC,MAAM,CAAC;IACf,KAAK,EAAE;QACL,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;QACvB,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;KACxB;CACF,CAAC,CAAC;AAEL,MAAM,cAAc,GAAG,CAAC,OAAsB,EAAE,EAAE;IAChD,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAkB;QAC9B,GAAG,OAAO;QACV,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;YACd,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AACvC,CAAC,CAAC;AAEF,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;QAE5E,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;YAC7B,KAAK,EAAE;gBACL,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;gBACpC,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;aACrC;YACD,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QAEH,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClB,MAAM,CACH,OAAO,CAAC,IAAI,EAAqC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CACjE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,OAAO,CAAC,OAAO,CAAC;YACd,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC5C,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;YACjC,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC5C,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,mBAAmB,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;QAErE,gBAAgB,CAAC,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAEvE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC5E,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAClE,gBAAgB,CAAC,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAE/B,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;QACtC,gBAAgB,CAAC,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACvE,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE9B,OAAO,CAAC,OAAO,CAAC;YACd,KAAK,EAAE;gBACL,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE;gBACnC,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;aACrC;YACD,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5E,MAAM,CAAC,OAAO,EAAE,CAAC;QAEjB,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACpB,MAAM,CAAE,OAAO,CAAC,IAAI,EAA2B,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAEvE,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}