extensions

Aug 1, 2026

Changes in this version

+ var ErrYJSStoreLimit = errors.New("crdt extensions: Yjs store limit exceeded")

+ var ErrYJSStoreRejected = errors.New("crdt extensions: Yjs store rejected request")

+ var ErrYJSStoreUnavailable = errors.New("crdt extensions: Yjs store unavailable")

+ type YJSApplyResult struct

+ Applied bool

+ Cursor uint64

+ StateVector []byte

type YJSConfig

+ StoreTimeout time.Duration

+ type YJSDocument struct

+ Epoch uint64

+ Format YJSStoreFormat

+ Room string

+ Schema string

+ Tenant string

type YJSRoomConfig

+ Document YJSDocument

+ MaxStateVectorBytes int

+ MaxSyncBytes int

+ Store YJSStore

+ type YJSSnapshot struct

+ Cursor uint64

+ StateVector []byte

+ Update []byte

+ type YJSStore interface

+ Apply func(context.Context, YJSDocument, []byte) (YJSApplyResult, error)

+ Diff func(context.Context, YJSDocument, []byte) ([]byte, error)

+ Merge func(context.Context, YJSDocument, [][]byte) ([]byte, error)

+ Snapshot func(context.Context, YJSDocument) (YJSSnapshot, error)

+ StateVector func(context.Context, YJSDocument) ([]byte, error)

+ func NewYJSStore(config YJSStoreConfig) (YJSStore, error)

+ type YJSStoreConfig struct

+ Endpoint string

+ HTTPClient *http.Client

+ MaxMergeUpdates int

+ MaxSnapshotBytes int

+ MaxStateVectorBytes int

+ MaxUpdateBytes int

+ Token string

+ type YJSStoreFormat string

+ const YJSStoreFormatV1

+ const YJSStoreFormatV2

Jul 31, 2026

Changes in this version

+ type YJSAuthorize func(Peer, string, YJSMessageKind) error

+ type YJSAuthorizeSubscription func(Peer, string) error

+ type YJSConfig struct

+ Authenticate Authenticate

+ Authorize YJSAuthorize

+ AuthorizeSubscription YJSAuthorizeSubscription

+ HandshakeTimeout time.Duration

+ MaxAwarenessClients int

+ MaxMessageBytes int

+ MaxQueuedBytes int

+ MaxQueuedMessages int

+ OriginPatterns []string

+ Rooms []*YJSRoom

+ WriteTimeout time.Duration

+ type YJSHandler struct

+ func NewYJSHandler(config YJSConfig) (*YJSHandler, error)

+ func (handler *YJSHandler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

+ type YJSMessageKind uint8

+ const YJSAwareness

+ const YJSUpdate

+ type YJSRoom struct

+ func NewYJSRoom(config YJSRoomConfig) (*YJSRoom, error)

+ func (room *YJSRoom) Name() string

+ type YJSRoomConfig struct

+ MaxHistoryBytes int

+ MaxUpdateBytes int

+ MaxUpdates int

+ Name string

Jul 31, 2026

Changes in this version

+ const Relay_Sync_FullMethodName

+ var File_extensions_relay_proto protoreflect.FileDescriptor

+ var Relay_ServiceDesc = grpc.ServiceDesc

+ func RegisterRelayServer(s grpc.ServiceRegistrar, srv RelayServer)

type Config

+ Telemetry *telemetry.Reporter

+ type GRPCAuthenticate func(context.Context) (Peer, error)

+ type GRPCClient struct

+ func OpenGRPC(ctx context.Context, relay RelayClient, manifest replica.Manifest, ...) (*GRPCClient, error)

+ func (client *GRPCClient) Close() error

+ func (client *GRPCClient) Done() <-chan struct{}

+ func (client *GRPCClient) Err() error

+ func (client *GRPCClient) Publish(ctx context.Context, change replica.Change) error

+ type GRPCClientConfig struct

+ MaxActorBytes int

+ MaxMessageBytes int

+ OnChange func(replica.Change) error

+ Policy crdt.ProtocolPolicy

+ type GRPCConfig struct

+ Authenticate GRPCAuthenticate

+ Authorize Authorize

+ AuthorizeSubscription AuthorizeSubscription

+ Groups []*Group

+ MaxActorBytes int

+ MaxMessageBytes int

+ MaxQueuedBytes int

+ MaxQueuedMessages int

+ Telemetry *telemetry.Reporter

+ type GRPCRelay struct

+ func NewGRPCRelay(config GRPCConfig) (*GRPCRelay, error)

+ func NewGRPCServer(config GRPCConfig) (*grpc.Server, *GRPCRelay, error)

+ func (relay *GRPCRelay) ServerOptions() []grpc.ServerOption

+ func (relay *GRPCRelay) Sync(stream grpc.BidiStreamingServer[SyncMessage, SyncMessage]) error

+ type RelayClient interface

+ Sync func(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[SyncMessage, SyncMessage], error)

+ func NewRelayClient(cc grpc.ClientConnInterface) RelayClient

+ type RelayServer interface

+ Sync func(grpc.BidiStreamingServer[SyncMessage, SyncMessage]) error

+ type Relay_SyncClient = grpc.BidiStreamingClient[SyncMessage, SyncMessage]

+ type Relay_SyncServer = grpc.BidiStreamingServer[SyncMessage, SyncMessage]

+ type SyncMessage struct

+ Payload isSyncMessage_Payload

+ func (*SyncMessage) Descriptor() ([]byte, []int)

+ func (*SyncMessage) ProtoMessage()

+ func (x *SyncMessage) GetChange() []byte

+ func (x *SyncMessage) GetHello() []byte

+ func (x *SyncMessage) GetPayload() isSyncMessage_Payload

+ func (x *SyncMessage) ProtoReflect() protoreflect.Message

+ func (x *SyncMessage) Reset()

+ func (x *SyncMessage) String() string

+ type SyncMessage_Change struct

+ Change []byte

+ type SyncMessage_Hello struct

+ Hello []byte

+ type UnimplementedRelayServer struct

+ func (UnimplementedRelayServer) Sync(grpc.BidiStreamingServer[SyncMessage, SyncMessage]) error

+ type UnsafeRelayServer interface

Jul 29, 2026

Changes in this version

+ const BatchSubprotocol

+ var ErrBatchLimit = errors.New("crdt extensions: websocket batch limit exceeded")

+ var ErrBatchUnsupported = errors.New("crdt extensions: websocket batch subprotocol is not enabled")

type ClientConfig

+ EnableBatches bool

+ MaxBatchChanges int

type Config

+ MaxBatchChanges int

type Feature

+ const FeatureWebSocketBatch

type WebSocketClient

+ func (client *WebSocketClient) PublishBatch(ctx context.Context, changes []replica.Change) error

Jul 29, 2026

Changes in this version

+ const Subprotocol

+ var ErrClosed = errors.New("crdt extensions: client is closed")

+ var ErrInvalidConfig = errors.New("crdt extensions: invalid configuration")

+ var ErrUnauthorized = errors.New("crdt extensions: unauthorized")

+ type Authenticate func(*http.Request) (Peer, error)

+ type Authorize func(Peer, replica.Manifest, replica.Dot) error

+ type AuthorizeSubscription func(Peer, replica.Manifest) error

+ type ClientConfig struct

+ HTTPClient *http.Client

+ HandshakeTimeout time.Duration

+ Header http.Header

+ MaxActorBytes int

+ MaxMessageBytes int

+ OnChange func(replica.Change) error

+ Policy crdt.ProtocolPolicy

+ WriteTimeout time.Duration

+ type Config struct

+ Authenticate Authenticate

+ Authorize Authorize

+ AuthorizeSubscription AuthorizeSubscription

+ Features Feature

+ Groups []*Group

+ HandshakeTimeout time.Duration

+ MaxActorBytes int

+ MaxMessageBytes int

+ MaxQueuedBytes int

+ MaxQueuedMessages int

+ OriginPatterns []string

+ WriteTimeout time.Duration

+ type Feature uint8

+ const FeatureHTTP

+ const FeatureWebSocket

+ func (f Feature) Enabled(feature Feature) bool

+ type Group struct

+ func NewGroup(config GroupConfig) (*Group, error)

+ func (g *Group) Frontier() replica.Frontier

+ func (g *Group) Manifest() replica.Manifest

+ func (g *Group) Pending() (changes, bytes int)

+ type GroupConfig struct

+ Apply replica.ApplyDelta

+ Frontier replica.Frontier

+ Manifest replica.Manifest

+ MaxPendingBytes int

+ MaxPendingChanges int

+ Policy crdt.ProtocolPolicy

+ type HTTPClient struct

+ func ConnectHTTP(ctx context.Context, endpoint string, manifest replica.Manifest, ...) (*HTTPClient, error)

+ func (client *HTTPClient) Close() error

+ func (client *HTTPClient) Done() <-chan struct{}

+ func (client *HTTPClient) Err() error

+ func (client *HTTPClient) Publish(ctx context.Context, change replica.Change) error

+ type Handler struct

+ func NewHandler(config Config) (*Handler, error)

+ func (h *Handler) Mount(mux *http.ServeMux, prefix string) (err error)

+ func (h *Handler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

+ type Peer struct

+ ID string

+ type WebSocketClient struct

+ func DialWebSocket(ctx context.Context, endpoint string, manifest replica.Manifest, ...) (*WebSocketClient, error)

+ func (client *WebSocketClient) Close() error

+ func (client *WebSocketClient) Done() <-chan struct{}

+ func (client *WebSocketClient) Err() error

+ func (client *WebSocketClient) Publish(ctx context.Context, change replica.Change) error