createNativeProvider

The built-in CRDT provider backed by @robonen/crdt: a fractional-ordered set of blocks, each a text RGA + mark store. Writekit steps map to CRDT ops via DocumentCrdt; ops sync as op batches over any transport.

Source

Signature

export function createNativeProvider(options: NativeProviderOptions): CrdtProvider{ ... }

Parameters

Parameter	Type	Default	Description
`options`	`NativeProviderOptions`	—	—

Returns

CrdtProvider

Property	Type	Default	Description
`name`	`string`	—	—
`load`	`() => WritekitDocument`	—	The current document materialized from CRDT state.
`applyLocal`	`(tr: Transaction) => void`	—	Translate a local transaction's steps into CRDT ops and apply them.
`applyUpdate`	`(bytes: Uint8Array, origin?: unknown) => void`	—	Merge a remote update (encoded ops) into the CRDT.
`encodeStateVector`	`() => Uint8Array`	—	Encode this replica's version vector for a sync handshake.
`encodeDelta`	`(remoteStateVector?: Uint8Array) => Uint8Array`	—	Encode ops a remote is missing (by its state vector); omit for a full snapshot.
`onLocalOps`	`(listener: (bytes: Uint8Array) => void) => () => void`	—	Subscribe to locally-produced op batches (to broadcast). Returns unsubscribe.
`onRemoteApplied`	`(listener: () => void) => () => void`	—	Subscribe to "remote ops were applied" (to reflect into writekit state). Returns unsubscribe.
`setLocalSelection`	`(selection: Selection \| null) => void`	—	Publish the local selection as presence (anchored to char ids).
`onLocalAwareness`	`(listener: (bytes: Uint8Array) => void) => () => void`	—	Subscribe to locally-produced awareness frames (to broadcast). Returns unsubscribe.
`applyAwareness`	`(bytes: Uint8Array) => void`	—	Merge a remote awareness frame.
`onAwareness`	`(listener: (cursors: RemoteCursor[]) => void) => () => void`	—	Subscribe to the resolved set of remote cursors. Returns unsubscribe.
`gc`	`(stableStateVector?: Uint8Array) => { blocks: number; chars: number }`	—	Compact tombstones and removed blocks covered by `stableStateVector` (or this replica's version when omitted). Safe only at quiescence — all peers fully synced, nothing in flight. Returns how much was dropped.
`destroy`	`() => void`	—	—

Related Types

WritekitOp

The CRDT operation log entry. Each carries an op id for the oplog; structural ops address blocks by their stable string id, text ops by character op ids.

export type WritekitOp
  = | { readonly id: OpId; readonly kind: 'block-insert'; readonly blockId: string; readonly blockType: string; readonly attrs: Attrs; readonly posKey: string; readonly isText: boolean }
    | { readonly id: OpId; readonly kind: 'block-remove'; readonly blockId: string }
    | { readonly id: OpId; readonly kind: 'block-move'; readonly blockId: string; readonly posKey: string }
    | { readonly id: OpId; readonly kind: 'block-attrs'; readonly blockId: string; readonly attrs: Attrs }
    | { readonly id: OpId; readonly kind: 'block-type'; readonly blockId: string; readonly blockType: string; readonly attrs: Attrs }
    | { readonly id: OpId; readonly kind: 'text-insert'; readonly blockId: string; readonly afterId: OpId | null; readonly ch: string }
    | { readonly id: OpId; readonly kind: 'text-delete'; readonly blockId: string; readonly charId: OpId }
    | { readonly id: OpId; readonly kind: 'mark-add'; readonly blockId: string; readonly markType: string; readonly value: MarkValue; readonly startId: OpId; readonly endId: OpId };