Skip to content

feat(y-partyserver): add compatibility with yjs 14.x #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
agcty wants to merge 2 commits into
base: main
Choose a base branch
from
+24 −3
Open

feat(y-partyserver): add compatibility with yjs 14.x #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c9fc1c
feat(y-partyserver): add compatibility with yjs 14.x
agcty Jan 3, 2026
880c816
refactor: use @ts-expect-error instead of @ts-ignore
agcty Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/y-partyserver/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"peerDependencies": {
"@cloudflare/workers-types": "^4.20240729.0",
"partyserver": "^0.1.0",
"yjs": "^13.6.14"
"yjs": "^13.6.14 || ^14.0.0-0"
},
"devDependencies": {
"@cloudflare/workers-types": "^4.20251218.0",
Expand Down
25 changes: 23 additions & 2 deletions packages/y-partyserver/src/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
/**
* Y.js server implementation for PartyServer.
*
* This module is compatible with both yjs 13.x and yjs 14.x (beta).
*
* Key differences between versions:
* - yjs 14 changed AbstractType generic signature from <EventType> to <EventDelta, Self>
* - yjs 14 uses stricter type constraints (T extends YValue)
* - yjs 14 changed doc.share type from Map<string, AbstractType<YEvent<any>>> to Map<string, YType>
* - Event handler signatures have additional parameters in yjs 14
*
* We use permissive types (any) where necessary to maintain compatibility.
*/

import * as decoding from "lib0/decoding";
import * as encoding from "lib0/encoding";
import debounce from "lodash.debounce";
Expand Down Expand Up @@ -100,7 +114,11 @@ class WSSharedDoc extends YDoc {
});
};
this.awareness.on("update", awarenessChangeHandler);
// @ts-expect-error - TODO: fix this
// Note: Event handler signature differs between yjs 13 and 14, but both are
// compatible at runtime since we only use the first 3 parameters.
// yjs 13: on("update", (update: Uint8Array, origin: any, doc: Doc) => void)
// yjs 14: on("update", (update: Uint8Array, origin: any, doc: Doc, transaction: Transaction) => void)
// @ts-expect-error - Type compatibility varies between yjs versions
this.on("update", updateHandler);
}
}
Expand Down Expand Up @@ -410,7 +428,10 @@ export class YServer<
}
} catch (err) {
console.error(err);
// @ts-expect-error - TODO: fix this
// Note: emit() signature uses a rest parameter internally but the
// TypeScript declaration uses a single array parameter. This is intentional and
// works correctly at runtime for both yjs 13 and 14.
// @ts-expect-error - Type compatibility varies between yjs versions
this.document.emit("error", [err]);
}
}
Expand Down