@coaction/yjs 2.0.0 → 3.0.0

package/README.md

@@ -1,15 +1,15 @@
 # @coaction/yjs
 
-![Node CI](https://github.com/coactionjs/coaction/workflows/Node%20CI/badge.svg)
-[![npm](https://img.shields.io/npm/v/@coaction/yjs.svg)](https://www.npmjs.com/package/@coaction/yjs)
-![license](https://img.shields.io/npm/l/@coaction/yjs)
+![Node CI](https://github.com/coactionjs/coaction/workflows/Node%20CI/badge.svg) [![npm](https://img.shields.io/npm/v/@coaction/yjs.svg)](https://www.npmjs.com/package/@coaction/yjs) ![license](https://img.shields.io/npm/l/@coaction/yjs)
+
+[English documentation](https://coactionjs.github.io/coaction/en/docs/) · [中文文档](https://coactionjs.github.io/coaction/zh/docs/)
 
 A Coaction integration tool for Yjs.
 
 ## Installation
 
 ```sh
-npm install coaction @coaction/yjs
+pnpm add coaction @coaction/yjs
 ```
 
 ## Quick Start
@@ -112,6 +112,9 @@ Middleware wrapper around `bindYjs`. It also wires cleanup into `store.destroy()
 - Keep the synced state plain and serializable.
 - Methods and getters are Coaction runtime behavior and are not the synchronization payload.
 - Prefer a plain object at the root of your store state.
+- Remote snapshots and delete operations obey Coaction's fixed schema rules:
+  unknown root keys are rejected, while known single-store root keys may be
+  absent and then read as `undefined` from the public state object.
 
 ## Compatibility and Limits
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Middleware, Store } from "coaction";
+import { Middleware, Store } from "coaction/adapter";
 import * as Y from "yjs";
 export * from "yjs";
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Middleware, Store } from "coaction";
+import { Middleware, Store } from "coaction/adapter";
 import * as Y from "yjs";
 export * from "yjs";
 

package/dist/index.js

@@ -21,7 +21,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
-let coaction = require("coaction");
+let coaction_adapter = require("coaction/adapter");
 let yjs = require("yjs");
 yjs = __toESM(yjs);
 //#region packages/coaction-yjs/src/shared.ts
@@ -145,6 +145,24 @@ function toArrayIndex(segment) {
 	if (typeof segment === "string" && String(index) !== segment) return;
 	return index;
 }
+function assertCanSetPathSegment(target, key, path) {
+	if (Object.prototype.hasOwnProperty.call(target, key)) return;
+	if (Object.isExtensible(target)) return;
+	throw new coaction_adapter.StateSchemaError(`Unknown state key '${path.map((segment) => String(segment)).join(".")}' cannot be added after store initialization. Coaction state schema is fixed.`);
+}
+function clearObjectKey(target, key) {
+	if (!Object.prototype.hasOwnProperty.call(target, key)) return;
+	const descriptor = Object.getOwnPropertyDescriptor(target, key);
+	if (descriptor?.configurable) {
+		delete target[key];
+		return;
+	}
+	if (descriptor && "set" in descriptor && descriptor.set) {
+		target[key] = void 0;
+		return;
+	}
+	if (descriptor && "writable" in descriptor && descriptor.writable) target[key] = void 0;
+}
 function compactOperations(operations) {
 	const deduplicated = /* @__PURE__ */ new Map();
 	for (const operation of operations) {
@@ -182,12 +200,17 @@ function setAtPath(target, path, value) {
 		const targetKey = typeof segmentIndex === "undefined" ? segment : segmentIndex;
 		const nextValue = current[targetKey];
 		const needsArray = typeof nextSegment === "number" || Array.isArray(nextValue) && typeof toArrayIndex(nextSegment) !== "undefined";
-		if (typeof nextValue !== "object" || nextValue === null || (needsArray ? !Array.isArray(nextValue) : Array.isArray(nextValue))) current[targetKey] = typeof nextSegment === "number" ? [] : {};
+		if (typeof nextValue !== "object" || nextValue === null || (needsArray ? !Array.isArray(nextValue) : Array.isArray(nextValue))) {
+			assertCanSetPathSegment(current, targetKey, path.slice(0, index + 1));
+			current[targetKey] = typeof nextSegment === "number" ? [] : {};
+		}
 		current = current[targetKey];
 	}
 	const leaf = path[path.length - 1];
 	const leafIndex = Array.isArray(current) ? toArrayIndex(leaf) : void 0;
-	current[typeof leafIndex === "undefined" ? leaf : leafIndex] = cloneForStore(value);
+	const leafKey = typeof leafIndex === "undefined" ? leaf : leafIndex;
+	assertCanSetPathSegment(current, leafKey, path);
+	current[leafKey] = cloneForStore(value);
 }
 function deleteAtPath(target, path) {
 	if (path.length === 0) return;
@@ -205,7 +228,7 @@ function deleteAtPath(target, path) {
 		if (typeof leafIndex !== "undefined" && leafIndex >= 0 && leafIndex < current.length) current.splice(leafIndex, 1);
 		return;
 	}
-	delete current[leaf];
+	clearObjectKey(current, leaf);
 }
 function collectRemoteOperations(events, stateMap) {
 	const operations = [];
@@ -414,53 +437,6 @@ const assertYjsSerializableState = (state, path = []) => {
 const assertRemoteOperationsSerializable = (operations) => {
 	for (const operation of operations) if (operation.type === "set") assertYjsSerializableState(operation.value, operation.path);
 };
-const createRootReplacementPatches = (currentState, nextState) => {
-	const patches = [];
-	const inversePatches = [];
-	const nextKeys = new Set(getOwnEnumerableKeys(nextState));
-	for (const key of getOwnEnumerableKeys(currentState)) {
-		if (typeof key === "symbol" || nextKeys.has(key)) continue;
-		patches.push({
-			op: "remove",
-			path: [key]
-		});
-		inversePatches.push({
-			op: "add",
-			path: [key],
-			value: currentState[key]
-		});
-	}
-	for (const key of nextKeys) {
-		if (typeof key === "symbol") continue;
-		if (!Object.prototype.hasOwnProperty.call(currentState, key)) {
-			patches.push({
-				op: "add",
-				path: [key],
-				value: nextState[key]
-			});
-			inversePatches.push({
-				op: "remove",
-				path: [key]
-			});
-			continue;
-		}
-		if (Object.is(currentState[key], nextState[key])) continue;
-		patches.push({
-			op: "replace",
-			path: [key],
-			value: nextState[key]
-		});
-		inversePatches.push({
-			op: "replace",
-			path: [key],
-			value: currentState[key]
-		});
-	}
-	return {
-		patches,
-		inversePatches
-	};
-};
 const __unsafeTestOnly__ = {
 	getYValueAtPath: (root, path) => getYValueAtPath(root, path),
 	setAtPath: (target, path, value) => {
@@ -494,31 +470,22 @@ const bindYjs = (store, options = {}) => {
 			syncingFromYjs = false;
 		}
 	};
+	const applyReplacementState = (next) => {
+		if (store.share === "main") {
+			store.setState(next, () => {
+				return (0, coaction_adapter.applyRootReplacementWithPatches)(store, next);
+			});
+			return;
+		}
+		store.setState(null);
+		store.apply(next);
+	};
 	const applyRemoteState = (state) => {
 		assertYjsSerializableState(state);
 		const next = sanitizePlainValue(state);
 		syncingFromYjs = true;
 		try {
-			if (store.share === "main") store.setState(next, () => {
-				const { patches, inversePatches } = createRootReplacementPatches(store.getPureState(), next);
-				const finalPatches = store.patch ? store.patch({
-					patches,
-					inversePatches
-				}) : {
-					patches,
-					inversePatches
-				};
-				if (finalPatches.patches.length) store.apply(store.getPureState(), finalPatches.patches);
-				return [
-					store.getPureState(),
-					finalPatches.patches,
-					finalPatches.inversePatches
-				];
-			});
-			else {
-				store.setState(null);
-				store.apply(next);
-			}
+			applyReplacementState(next);
 			const pureState = clone(store.getPureState());
 			lastSyncedState = isPlainObject(pureState) ? pureState : {};
 		} finally {
@@ -530,6 +497,16 @@ const bindYjs = (store, options = {}) => {
 		assertRemoteOperationsSerializable(operations);
 		syncingFromYjs = true;
 		try {
+			if (operations.some((operation) => operation.type === "delete" && operation.path.length === 1)) {
+				const next = clone(store.getPureState());
+				if (!isPlainObject(next)) return;
+				for (const operation of operations) if (operation.type === "set") setAtPath(next, operation.path, operation.value);
+				else deleteAtPath(next, operation.path);
+				applyReplacementState(next);
+				const pureState = clone(store.getPureState());
+				lastSyncedState = isPlainObject(pureState) ? pureState : {};
+				return;
+			}
 			store.setState((draft) => {
 				const mutableDraft = draft;
 				for (const operation of operations) if (operation.type === "set") setAtPath(mutableDraft, operation.path, operation.value);
@@ -566,7 +543,7 @@ const bindYjs = (store, options = {}) => {
 					setTimeout(scheduleFlushFromYjs, 0);
 					return;
 				}
-				if (isYjsSerializableStateError(error)) {
+				if (isYjsSerializableStateError(error) || (0, coaction_adapter.isStateSchemaError)(error)) {
 					restoreRootState();
 					return;
 				}
@@ -584,7 +561,7 @@ const bindYjs = (store, options = {}) => {
 				setTimeout(scheduleFlushFromYjs, 0);
 				return;
 			}
-			if (isYjsSerializableStateError(error)) {
+			if (isYjsSerializableStateError(error) || (0, coaction_adapter.isStateSchemaError)(error)) {
 				restoreRootState();
 				return;
 			}
@@ -657,7 +634,7 @@ const bindYjs = (store, options = {}) => {
 			try {
 				applyRemoteState(state);
 			} catch (error) {
-				if (isYjsSerializableStateError(error)) {
+				if (isYjsSerializableStateError(error) || (0, coaction_adapter.isStateSchemaError)(error)) {
 					restoreRootState();
 					return;
 				}
@@ -731,7 +708,7 @@ const bindYjs = (store, options = {}) => {
 };
 const yjs$1 = (options = {}) => (store) => {
 	let binding;
-	const cancelBinding = (0, coaction.onStoreReady)(store, () => {
+	const cancelBinding = (0, coaction_adapter.onStoreReady)(store, () => {
 		binding = bindYjs(store, options);
 	});
 	const baseDestroy = store.destroy;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { onStoreReady } from "coaction";
+import { StateSchemaError, applyRootReplacementWithPatches, isStateSchemaError, onStoreReady } from "coaction/adapter";
 import * as Y from "yjs";
 export * from "yjs";
 //#endregion
@@ -123,6 +123,24 @@ function toArrayIndex(segment) {
 	if (typeof segment === "string" && String(index) !== segment) return;
 	return index;
 }
+function assertCanSetPathSegment(target, key, path) {
+	if (Object.prototype.hasOwnProperty.call(target, key)) return;
+	if (Object.isExtensible(target)) return;
+	throw new StateSchemaError(`Unknown state key '${path.map((segment) => String(segment)).join(".")}' cannot be added after store initialization. Coaction state schema is fixed.`);
+}
+function clearObjectKey(target, key) {
+	if (!Object.prototype.hasOwnProperty.call(target, key)) return;
+	const descriptor = Object.getOwnPropertyDescriptor(target, key);
+	if (descriptor?.configurable) {
+		delete target[key];
+		return;
+	}
+	if (descriptor && "set" in descriptor && descriptor.set) {
+		target[key] = void 0;
+		return;
+	}
+	if (descriptor && "writable" in descriptor && descriptor.writable) target[key] = void 0;
+}
 function compactOperations(operations) {
 	const deduplicated = /* @__PURE__ */ new Map();
 	for (const operation of operations) {
@@ -160,12 +178,17 @@ function setAtPath(target, path, value) {
 		const targetKey = typeof segmentIndex === "undefined" ? segment : segmentIndex;
 		const nextValue = current[targetKey];
 		const needsArray = typeof nextSegment === "number" || Array.isArray(nextValue) && typeof toArrayIndex(nextSegment) !== "undefined";
-		if (typeof nextValue !== "object" || nextValue === null || (needsArray ? !Array.isArray(nextValue) : Array.isArray(nextValue))) current[targetKey] = typeof nextSegment === "number" ? [] : {};
+		if (typeof nextValue !== "object" || nextValue === null || (needsArray ? !Array.isArray(nextValue) : Array.isArray(nextValue))) {
+			assertCanSetPathSegment(current, targetKey, path.slice(0, index + 1));
+			current[targetKey] = typeof nextSegment === "number" ? [] : {};
+		}
 		current = current[targetKey];
 	}
 	const leaf = path[path.length - 1];
 	const leafIndex = Array.isArray(current) ? toArrayIndex(leaf) : void 0;
-	current[typeof leafIndex === "undefined" ? leaf : leafIndex] = cloneForStore(value);
+	const leafKey = typeof leafIndex === "undefined" ? leaf : leafIndex;
+	assertCanSetPathSegment(current, leafKey, path);
+	current[leafKey] = cloneForStore(value);
 }
 function deleteAtPath(target, path) {
 	if (path.length === 0) return;
@@ -183,7 +206,7 @@ function deleteAtPath(target, path) {
 		if (typeof leafIndex !== "undefined" && leafIndex >= 0 && leafIndex < current.length) current.splice(leafIndex, 1);
 		return;
 	}
-	delete current[leaf];
+	clearObjectKey(current, leaf);
 }
 function collectRemoteOperations(events, stateMap) {
 	const operations = [];
@@ -392,53 +415,6 @@ const assertYjsSerializableState = (state, path = []) => {
 const assertRemoteOperationsSerializable = (operations) => {
 	for (const operation of operations) if (operation.type === "set") assertYjsSerializableState(operation.value, operation.path);
 };
-const createRootReplacementPatches = (currentState, nextState) => {
-	const patches = [];
-	const inversePatches = [];
-	const nextKeys = new Set(getOwnEnumerableKeys(nextState));
-	for (const key of getOwnEnumerableKeys(currentState)) {
-		if (typeof key === "symbol" || nextKeys.has(key)) continue;
-		patches.push({
-			op: "remove",
-			path: [key]
-		});
-		inversePatches.push({
-			op: "add",
-			path: [key],
-			value: currentState[key]
-		});
-	}
-	for (const key of nextKeys) {
-		if (typeof key === "symbol") continue;
-		if (!Object.prototype.hasOwnProperty.call(currentState, key)) {
-			patches.push({
-				op: "add",
-				path: [key],
-				value: nextState[key]
-			});
-			inversePatches.push({
-				op: "remove",
-				path: [key]
-			});
-			continue;
-		}
-		if (Object.is(currentState[key], nextState[key])) continue;
-		patches.push({
-			op: "replace",
-			path: [key],
-			value: nextState[key]
-		});
-		inversePatches.push({
-			op: "replace",
-			path: [key],
-			value: currentState[key]
-		});
-	}
-	return {
-		patches,
-		inversePatches
-	};
-};
 const __unsafeTestOnly__ = {
 	getYValueAtPath: (root, path) => getYValueAtPath(root, path),
 	setAtPath: (target, path, value) => {
@@ -472,31 +448,22 @@ const bindYjs = (store, options = {}) => {
 			syncingFromYjs = false;
 		}
 	};
+	const applyReplacementState = (next) => {
+		if (store.share === "main") {
+			store.setState(next, () => {
+				return applyRootReplacementWithPatches(store, next);
+			});
+			return;
+		}
+		store.setState(null);
+		store.apply(next);
+	};
 	const applyRemoteState = (state) => {
 		assertYjsSerializableState(state);
 		const next = sanitizePlainValue(state);
 		syncingFromYjs = true;
 		try {
-			if (store.share === "main") store.setState(next, () => {
-				const { patches, inversePatches } = createRootReplacementPatches(store.getPureState(), next);
-				const finalPatches = store.patch ? store.patch({
-					patches,
-					inversePatches
-				}) : {
-					patches,
-					inversePatches
-				};
-				if (finalPatches.patches.length) store.apply(store.getPureState(), finalPatches.patches);
-				return [
-					store.getPureState(),
-					finalPatches.patches,
-					finalPatches.inversePatches
-				];
-			});
-			else {
-				store.setState(null);
-				store.apply(next);
-			}
+			applyReplacementState(next);
 			const pureState = clone(store.getPureState());
 			lastSyncedState = isPlainObject(pureState) ? pureState : {};
 		} finally {
@@ -508,6 +475,16 @@ const bindYjs = (store, options = {}) => {
 		assertRemoteOperationsSerializable(operations);
 		syncingFromYjs = true;
 		try {
+			if (operations.some((operation) => operation.type === "delete" && operation.path.length === 1)) {
+				const next = clone(store.getPureState());
+				if (!isPlainObject(next)) return;
+				for (const operation of operations) if (operation.type === "set") setAtPath(next, operation.path, operation.value);
+				else deleteAtPath(next, operation.path);
+				applyReplacementState(next);
+				const pureState = clone(store.getPureState());
+				lastSyncedState = isPlainObject(pureState) ? pureState : {};
+				return;
+			}
 			store.setState((draft) => {
 				const mutableDraft = draft;
 				for (const operation of operations) if (operation.type === "set") setAtPath(mutableDraft, operation.path, operation.value);
@@ -544,7 +521,7 @@ const bindYjs = (store, options = {}) => {
 					setTimeout(scheduleFlushFromYjs, 0);
 					return;
 				}
-				if (isYjsSerializableStateError(error)) {
+				if (isYjsSerializableStateError(error) || isStateSchemaError(error)) {
 					restoreRootState();
 					return;
 				}
@@ -562,7 +539,7 @@ const bindYjs = (store, options = {}) => {
 				setTimeout(scheduleFlushFromYjs, 0);
 				return;
 			}
-			if (isYjsSerializableStateError(error)) {
+			if (isYjsSerializableStateError(error) || isStateSchemaError(error)) {
 				restoreRootState();
 				return;
 			}
@@ -635,7 +612,7 @@ const bindYjs = (store, options = {}) => {
 			try {
 				applyRemoteState(state);
 			} catch (error) {
-				if (isYjsSerializableStateError(error)) {
+				if (isYjsSerializableStateError(error) || isStateSchemaError(error)) {
 					restoreRootState();
 					return;
 				}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coaction/yjs",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "A Coaction integration tool for Yjs",
   "keywords": [
     "coaction",
@@ -28,9 +28,14 @@
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
       "default": "./dist/index.mjs"
     },
     "./package.json": "./package.json"
@@ -41,10 +46,10 @@
   },
   "devDependencies": {
     "yjs": "^13.6.27",
-    "coaction": "2.0.0"
+    "coaction": "3.0.0"
   },
   "peerDependencies": {
-    "coaction": "^2.0.0",
+    "coaction": "^3.0.0",
     "yjs": "^13.6.0"
   },
   "authors": [