mobx-keystone-yjs 1.5.4 → 1.6.0

package/dist/types/binding/YjsTextModel.d.ts

@@ -1,9 +1,9 @@
-import { IAtom } from "mobx";
-import { Frozen } from "mobx-keystone";
+import { IAtom } from 'mobx';
+import { Frozen } from 'mobx-keystone';
 import * as Y from "yjs";
 export declare const yjsTextModelId = "mobx-keystone-yjs/YjsTextModel";
-declare const YjsTextModel_base: import("mobx-keystone")._Model<unknown, {
-    deltaList: import("mobx-keystone").OptionalModelProp<Frozen<unknown[]>[]>;
+declare const YjsTextModel_base: import('mobx-keystone')._Model<unknown, {
+    deltaList: import('mobx-keystone').OptionalModelProp<Frozen<unknown[]>[]>;
 }, never, never>;
 /**
  * A mobx-keystone model that represents a Yjs.Text object.
@@ -34,6 +34,7 @@ export declare class YjsTextModel extends YjsTextModel_base {
      * Shortcut for `yjsText.toString()`, but computed.
      */
     get text(): string;
+    private deltaListToText;
     protected onInit(): () => void;
 }
 export {};

package/dist/types/binding/applyMobxChangeToYjsObject.d.ts

@@ -0,0 +1,3 @@
+import { DeepChange } from 'mobx-keystone';
+import * as Y from "yjs";
+export declare function applyMobxChangeToYjsObject(change: DeepChange, yjsObject: Y.Map<any> | Y.Array<any> | Y.Text): void;

package/dist/types/binding/applyYjsEventToMobx.d.ts

@@ -0,0 +1,8 @@
+import * as Y from "yjs";
+export type ReconciliationMap = Map<string, object>;
+/**
+ * Applies a Y.js event directly to the MobX model tree using proper mutations
+ * (splice for arrays, property assignment for objects).
+ * This is more efficient than converting to patches first.
+ */
+export declare function applyYjsEventToMobx(event: Y.YEvent<any>, boundObject: object, reconciliationMap: ReconciliationMap): void;

package/dist/types/binding/bindYjsToMobxKeystone.d.ts

@@ -1,4 +1,4 @@
-import { AnyDataModel, AnyModel, AnyStandardType, ModelClass, TypeToData } from "mobx-keystone";
+import { AnyDataModel, AnyModel, AnyStandardType, ModelClass, TypeToData } from 'mobx-keystone';
 import * as Y from "yjs";
 /**
  * Creates a bidirectional binding between a Y.js data structure and a mobx-keystone model.

package/dist/types/binding/convertJsonToYjsData.d.ts

@@ -1,6 +1,17 @@
+import { PlainArray, PlainObject, PlainValue } from '../plainTypes';
+import { YjsData } from './convertYjsDataToJson';
 import * as Y from "yjs";
-import { YjsData } from "./convertYjsDataToJson";
-import { PlainArray, PlainObject, PlainValue } from "../plainTypes";
+/**
+ * Options for applying JSON data to Y.js data structures.
+ */
+export interface ApplyJsonToYjsOptions {
+    /**
+     * The mode to use when applying JSON data to Y.js data structures.
+     * - `add`: Creates new Y.js containers for objects/arrays (default, backwards compatible)
+     * - `merge`: Recursively merges values, preserving existing container references where possible
+     */
+    mode?: "add" | "merge";
+}
 /**
  * Converts a plain value to a Y.js data structure.
  * Objects are converted to Y.Maps, arrays to Y.Arrays, primitives are untouched.
@@ -9,9 +20,17 @@ import { PlainArray, PlainObject, PlainValue } from "../plainTypes";
 export declare function convertJsonToYjsData(v: PlainValue): YjsData;
 /**
  * Applies a JSON array to a Y.Array, using the convertJsonToYjsData to convert the values.
+ *
+ * @param dest The destination Y.Array.
+ * @param source The source JSON array.
+ * @param options Options for applying the JSON data.
  */
-export declare const applyJsonArrayToYArray: (dest: Y.Array<any>, source: PlainArray) => void;
+export declare const applyJsonArrayToYArray: (dest: Y.Array<any>, source: PlainArray, options?: ApplyJsonToYjsOptions) => void;
 /**
  * Applies a JSON object to a Y.Map, using the convertJsonToYjsData to convert the values.
+ *
+ * @param dest The destination Y.Map.
+ * @param source The source JSON object.
+ * @param options Options for applying the JSON data.
  */
-export declare const applyJsonObjectToYMap: (dest: Y.Map<any>, source: PlainObject) => void;
+export declare const applyJsonObjectToYMap: (dest: Y.Map<any>, source: PlainObject, options?: ApplyJsonToYjsOptions) => void;

package/dist/types/binding/convertYjsDataToJson.d.ts

@@ -1,4 +1,4 @@
+import { PlainValue } from '../plainTypes';
 import * as Y from "yjs";
-import { PlainValue } from "../plainTypes";
 export type YjsData = Y.Array<any> | Y.Map<any> | Y.Text | PlainValue;
 export declare const convertYjsDataToJson: (yjsData: YjsData) => PlainValue;

package/dist/types/binding/resolveYjsPath.d.ts

@@ -1 +1,14 @@
-export declare function resolveYjsPath(yjsObject: unknown, path: readonly (string | number)[]): unknown;
+import * as Y from "yjs";
+/**
+ * Resolves a path within a Yjs object structure.
+ * Returns the Yjs container at the specified path.
+ *
+ * When a Y.Text is encountered during path resolution (either at the start
+ * or mid-path), it is returned immediately since Y.Text doesn't support
+ * nested path traversal.
+ *
+ * @param yjsObject The root Yjs object
+ * @param path Array of keys/indices to traverse
+ * @returns The Yjs container at the path, or Y.Text if encountered during traversal
+ */
+export declare function resolveYjsPath(yjsObject: Y.Map<unknown> | Y.Array<unknown> | Y.Text, path: readonly (string | number)[]): unknown;

package/dist/types/binding/yjsBindingContext.d.ts

@@ -1,4 +1,4 @@
-import { AnyType } from "mobx-keystone";
+import { AnyType } from 'mobx-keystone';
 import * as Y from "yjs";
 /**
  * Context with info on how a mobx-keystone model is bound to a Y.js data structure.
@@ -32,4 +32,4 @@ export interface YjsBindingContext {
 /**
  * Context with info on how a mobx-keystone model is bound to a Y.js data structure.
  */
-export declare const yjsBindingContext: import("mobx-keystone").Context<YjsBindingContext | undefined>;
+export declare const yjsBindingContext: import('mobx-keystone').Context<YjsBindingContext | undefined>;

package/dist/types/binding/yjsSnapshotTracking.d.ts

@@ -0,0 +1,24 @@
+import * as Y from "yjs";
+/**
+ * WeakMap that tracks which snapshot each Y.js container was last synced from.
+ * This is used during reconciliation to skip containers that are already up-to-date.
+ *
+ * The key is the Y.js container (Y.Map or Y.Array).
+ * The value is the snapshot (plain object or array) that was last synced to it.
+ */
+export declare const yjsContainerToSnapshot: WeakMap<Y.Map<any> | Y.Array<any>, unknown>;
+/**
+ * Updates the snapshot tracking for a Y.js container.
+ * Call this after syncing a snapshot to a Y.js container.
+ */
+export declare function setYjsContainerSnapshot(container: Y.Map<any> | Y.Array<any>, snapshot: unknown): void;
+/**
+ * Gets the last synced snapshot for a Y.js container.
+ * Returns undefined if the container has never been synced.
+ */
+export declare function getYjsContainerSnapshot(container: Y.Map<any> | Y.Array<any>): unknown;
+/**
+ * Checks if a Y.js container is up-to-date with the given snapshot.
+ * Uses reference equality to check if the snapshot is the same.
+ */
+export declare function isYjsContainerUpToDate(container: Y.Map<any> | Y.Array<any>, snapshot: unknown): boolean;

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
-export { YjsTextModel, yjsTextModelId } from "./binding/YjsTextModel";
-export { bindYjsToMobxKeystone } from "./binding/bindYjsToMobxKeystone";
-export { applyJsonArrayToYArray, applyJsonObjectToYMap, convertJsonToYjsData, } from "./binding/convertJsonToYjsData";
-export { yjsBindingContext } from "./binding/yjsBindingContext";
-export type { YjsBindingContext } from "./binding/yjsBindingContext";
-export { MobxKeystoneYjsError } from "./utils/error";
+export { bindYjsToMobxKeystone } from './binding/bindYjsToMobxKeystone';
+export type { ApplyJsonToYjsOptions } from './binding/convertJsonToYjsData';
+export { applyJsonArrayToYArray, applyJsonObjectToYMap, convertJsonToYjsData, } from './binding/convertJsonToYjsData';
+export { YjsTextModel, yjsTextModelId } from './binding/YjsTextModel';
+export type { YjsBindingContext } from './binding/yjsBindingContext';
+export { yjsBindingContext } from './binding/yjsBindingContext';
+export { MobxKeystoneYjsError } from './utils/error';

package/dist/types/utils/isYjsValueDeleted.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if a Y.js value has been deleted or its document destroyed.
+ *
+ * @param yjsValue The Y.js value to check.
+ * @returns `true` if the value is deleted or destroyed, `false` otherwise.
+ */
+export declare function isYjsValueDeleted(yjsValue: unknown): boolean;

package/package.json

@@ -1,78 +1,90 @@
-{
-  "name": "mobx-keystone-yjs",
-  "version": "1.5.4",
-  "description": "Yjs bindings for mobx-keystone",
-  "keywords": ["mobx", "mobx-keystone", "yjs", "crdt", "state management"],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/xaviergonz/mobx-keystone.git"
-  },
-  "bugs": {
-    "url": "https://github.com/xaviergonz/mobx-keystone/issues"
-  },
-  "homepage": "https://mobx-keystone.js.org",
-  "license": "MIT",
-  "author": "Javier González Garcés",
-  "source": "./src/index.ts",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "script": "./dist/mobx-keystone-yjs.umd.js",
-      "import": "./dist/mobx-keystone-yjs.esm.mjs",
-      "require": "./dist/mobx-keystone-yjs.umd.js",
-      "default": "./dist/mobx-keystone-yjs.esm.mjs"
-    }
-  },
-  "esmodule": "./dist/mobx-keystone-yjs.esm.js",
-  "module": "./dist/mobx-keystone-yjs.esm.js",
-  "jsnext:main": "./dist/mobx-keystone-yjs.esm.js",
-  "react-native": "./dist/mobx-keystone-yjs.umd.js",
-  "umd:main": "./dist/mobx-keystone-yjs.umd.js",
-  "unpkg": "./dist/mobx-keystone-yjs.umd.js",
-  "jsdelivr": "./dist/mobx-keystone-yjs.umd.js",
-  "main": "./dist/mobx-keystone-yjs.umd.js",
-  "types": "./dist/types/index.d.ts",
-  "typings": "./dist/types/index.d.ts",
-  "sideEffects": false,
-  "files": ["src", "dist", "LICENSE", "CHANGELOG.md", "README.md"],
-  "scripts": {
-    "quick-build": "tsc",
-    "quick-build-tests": "tsc -p test",
-    "copy-root-files": "shx cp ../../LICENSE .",
-    "build": "yarn quick-build && yarn copy-root-files && shx rm -rf dist && vite build && shx cp dist/mobx-keystone-yjs.esm.mjs dist/mobx-keystone-yjs.esm.js",
-    "test": "jest",
-    "test:ci": "yarn test -i",
-    "test:perf": "yarn build && yarn test:perf:run"
-  },
-  "peerDependencies": {
-    "mobx": "^6.0.0 || ^5.0.0 || ^4.0.0",
-    "mobx-keystone": "^1.9.0",
-    "yjs": "^13.0.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.26.8",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-decorators": "^7.25.9",
-    "@babel/preset-env": "^7.26.8",
-    "@babel/preset-typescript": "^7.26.0",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.1",
-    "babel-jest": "^29.7.0",
-    "jest": "^29.7.0",
-    "mobx-keystone": "workspace:packages/lib",
-    "rollup-plugin-typescript2": "^0.36.0",
-    "shx": "^0.3.4",
-    "spec.ts": "^1.1.3",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
-    "vite": "^6.1.0"
-  },
-  "dependencies": {
-    "tslib": "^2.8.1"
-  },
-  "directories": {
-    "test": "test"
-  }
-}
+{
+  "name": "mobx-keystone-yjs",
+  "version": "1.6.0",
+  "description": "Yjs bindings for mobx-keystone",
+  "keywords": [
+    "mobx",
+    "mobx-keystone",
+    "yjs",
+    "crdt",
+    "state",
+    "state-management",
+    "reactive",
+    "collaborative"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xaviergonz/mobx-keystone.git"
+  },
+  "bugs": {
+    "url": "https://github.com/xaviergonz/mobx-keystone/issues"
+  },
+  "homepage": "https://mobx-keystone.js.org",
+  "license": "MIT",
+  "author": "Javier González Garcés",
+  "source": "./src/index.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "script": "./dist/mobx-keystone-yjs.umd.js",
+      "import": "./dist/mobx-keystone-yjs.esm.mjs",
+      "require": "./dist/mobx-keystone-yjs.umd.js",
+      "default": "./dist/mobx-keystone-yjs.esm.mjs"
+    }
+  },
+  "esmodule": "./dist/mobx-keystone-yjs.esm.js",
+  "module": "./dist/mobx-keystone-yjs.esm.js",
+  "jsnext:main": "./dist/mobx-keystone-yjs.esm.js",
+  "react-native": "./dist/mobx-keystone-yjs.umd.js",
+  "umd:main": "./dist/mobx-keystone-yjs.umd.js",
+  "unpkg": "./dist/mobx-keystone-yjs.umd.js",
+  "jsdelivr": "./dist/mobx-keystone-yjs.umd.js",
+  "main": "./dist/mobx-keystone-yjs.umd.js",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "src",
+    "dist",
+    "LICENSE",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "scripts": {
+    "quick-build": "tsc",
+    "quick-build-tests": "tsc -p test",
+    "copy-root-files": "shx cp ../../LICENSE .",
+    "build": "yarn quick-build && yarn copy-root-files && shx rm -rf dist && vite build && shx cp dist/mobx-keystone-yjs.esm.mjs dist/mobx-keystone-yjs.esm.js",
+    "test": "jest",
+    "test:ci": "yarn test -i"
+  },
+  "peerDependencies": {
+    "mobx": "^6.0.0 || ^5.0.0 || ^4.0.0",
+    "mobx-keystone": "^1.12.0",
+    "yjs": "^13.0.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.28.5",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-decorators": "^7.28.0",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.3",
+    "babel-jest": "^30.2.0",
+    "jest": "^30.2.0",
+    "mobx-keystone": "workspace:packages/lib",
+    "shx": "^0.4.0",
+    "spec.ts": "^1.1.3",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "tslib": "^2.8.1"
+  },
+  "directories": {
+    "test": "test"
+  }
+}