Build on the supported package contract
Use @absolutejs/sync-yjs through its supported public entry points.
@absolutejs/sync-yjs
@absolutejs/sync-yjsv0.1.0betaData & SyncYjs-backed collaborative-text CRDT adapter for @absolutejs/sync
#Installation
BASH
bun add @absolutejs/sync-yjs#Capabilities
Overview
A Yjs-backed collaborative-text CRDT for @absolutejs/sync, behind the same CrdtText / TextCrdtAdapter contract as the core's zero-dependency rgaText.
@absolutejs/sync/crdt ships a first-party RGA text CRDT that's great for offline-merge and moderate collaboration. When you need production-scale collaborative text — efficient deltas, no unbounded tombstone growth, the interleaving guarantees the community relies on — Yjs is the staple. This adapter lets you swap it in without touching your call sites.
Use
The serialized state is a base64 string of a Yjs update — JSON-safe for the sync engine's change feed and for storing as a row field. merge is commutative/associative/idempotent, so the order writes arrive in doesn't matter.
The contract
This package implements TextCrdtAdapter from @absolutejs/sync/crdt:
Member — What it does
create(replica, initial?) — A live CrdtText doc: text/setText/merge/state.
Show 3 more
merge(a, b) — Combine two persisted states (server-side, no live instance).
empty() — The serialized state of an empty document.
textOf(state) — The plain text of a persisted state.
Outcomes
What you can build
Hardening checklist
Production guidance
Make every external boundary explicitPin the deployed @absolutejs/sync-yjs version, replace example or memory-backed dependencies with durable implementations, bound external calls, protect credentials, and emit enough evidence to retry or recover safely.
Follow in order
Troubleshooting path
1
Trace from the first failed boundary
Reproduce the smallest canonical @absolutejs/sync-yjs example, confirm the supported entry point and version in the API explorer, then inspect the first boundary that did not produce its documented result.
#Use
Partial snippetWorking example for Use.
TS
import { yjsText } from '@absolutejs/sync-yjs';
// ...instead of: import { rgaText } from '@absolutejs/sync/crdt';
// Client — a live doc per replica (e.g. per tab/device)
const doc = yjsText.create('tab-a', initialStateFromServer);
doc.setText(textarea.value); // reconciles via a minimal diff
socket.send(doc.state()); // broadcast the serialized (base64) state
doc.merge(incomingState); // fold a peer's state into local edits
doc.text(); // the merged visible text
const cursor = doc.anchorAt?.(textarea.selectionStart); // stable relative cursor
doc.indexOfAnchor?.(cursor ?? null); // follows concurrent inserts/deletes
// Server — merge-on-write so concurrent writes combine instead of clobbering
const next = yjsText.merge(storedState, incomingState);
// store `next`; yjsText.textOf(next) is the plain text#Public entry points
Supported entry points declared by this package manifest.
Package entry point declared in package.json.
@absolutejs/sync-yjs@absolutejs/sync-yjs/manifest@absolutejs/sync-yjs/manifest.json
#Package commands
Scripts declared by this package manifest.
bun run buildrm -rf dist && bun build src/index.ts src/manifest.ts --outdir dist --sourcemap --target=bun --external @absolutejs/sync --external yjs && tsc --project tsconfig.build.json && absolute-manifest emit
bun run formatprettier --write "./**/*.{ts,json,md}"
bun run testbun test
bun run typechecktsc --noEmit
#API reference
Search the declarations exported by the current package type files. Expand a symbol to inspect its source-backed signature.