collab

Sep 27, 2026

Changes in this version

type ClientConfig

+ MaxOperations int

Sep 26, 2026

Changes in this version

type Capability

+ const CapDigest

Sep 26, 2026

Changes in this version

+ var ErrDiverged = errors.New("collab: two snapshots claim the same history and hold different documents")

Sep 26, 2026

Changes in this version

+ type ConditionalStore interface

+ LoadToken func(ctx context.Context, document string) ([]byte, Token, error)

+ SaveIf func(ctx context.Context, document string, snapshot []byte, expect Token) (Token, error)

+ type Token []byte

Sep 25, 2026

Changes in this version

type Config

+ MaxOperations int

Sep 25, 2026

Changes in this version

+ func Sites(batches ...crdt.PartOps) iter.Seq[crdt.SiteID]

+ func SpeaksFor(...) func(context.Context, string, crdt.SiteID, []crdt.PartOps) error

Sep 24, 2026

Changes in this version

type Config

+ OnOperationsRefused func(document string, from crdt.SiteID, err error)

Sep 6, 2026

Changes in this version

+ func OwnSiteOnly(_ context.Context, _ string, from crdt.SiteID, batches []crdt.PartOps) error

Sep 6, 2026

Changes in this version

+ func CheckSnapshot(snapshot []byte) []byte

Sep 6, 2026

Changes in this version

+ func PackSnapshot(snapshot []byte) []byte

+ func UnpackSnapshot(stored []byte) ([]byte, error)

Sep 5, 2026

Changes in this version

+ var ErrUnmergeable = errors.New("collab: neither snapshot can serve the other")

Sep 5, 2026

Changes in this version

+ func GRPCServerOptions() []grpc.ServerOption — darwin/amd64, linux/amd64, windows/amd64

Sep 1, 2026

Changes in this version

+ type Capabilities map[Capability][]byte

+ func Mine() Capabilities

+ func (c *Capabilities) UnmarshalBinary(data []byte) error

+ func (c Capabilities) Accepts(name Capability, version byte) bool

+ func (c Capabilities) MarshalBinary() ([]byte, error)

+ type Capability string

+ const CapComposite

+ const CapList

+ const CapMap

+ const CapText

Aug 30, 2026

Changes in this version

type DirStore — darwin/amd64, linux/amd64, windows/amd64

+ func (s *DirStore) LoadSites(_ context.Context, document string) ([]byte, error)

+ func (s *DirStore) SaveSites(_ context.Context, document string, sites []byte) error

type MemoryStore

+ func (m *MemoryStore) LoadSites(_ context.Context, document string) ([]byte, error)

+ func (m *MemoryStore) SaveSites(_ context.Context, document string, sites []byte) error

+ type SiteStore interface

+ LoadSites func(ctx context.Context, document string) ([]byte, error)

+ SaveSites func(ctx context.Context, document string, sites []byte) error

Aug 28, 2026

Changes in this version

+ var ErrTooFarBehind = errors.New(...)

type Config

+ CollectEvery time.Duration

type Server

+ func (s *Server) Stable(name string) (crdt.CompositeVersion, bool)

Aug 25, 2026

Changes in this version

type Map

+ func (m *Map) Edit(fn func(*crdt.Map) ([]crdt.MapOp, error)) error

+ func (m *Map) Read(fn func(*crdt.Map))

Aug 25, 2026

Changes in this version

type Client — darwin/amd64, linux/amd64, windows/amd64

+ func JoinWithRetry(ctx context.Context, dial Dialer, cfg ClientConfig, policy RetryPolicy) (*Client, error)

Aug 25, 2026

Changes in this version

+ var ErrChanged = errors.New("collab: the document changed since it was read")

+ var ErrHostSuperseded = errors.New("collab: another tab is hosting this room")

+ type Archivable interface

+ Idle func(ctx context.Context, d time.Duration) ([]string, error)

+ Release func(ctx context.Context, document string, want []byte) error

+ type BroadcastSession struct — js/wasm

+ func OpenBroadcastSession(ctx context.Context, room string, window time.Duration) (*BroadcastSession, error)

+ func (bs *BroadcastSession) Close() error

+ func (bs *BroadcastSession) Role() Role

+ func (bs *BroadcastSession) Serve(s *Server) error

+ func (bs *BroadcastSession) Transport() Transport

type Config

+ OnPersistError func(document string, err error)

type DirStore — darwin/amd64, linux/amd64, windows/amd64

+ func (s *DirStore) Idle(_ context.Context, d time.Duration) ([]string, error)

+ func (s *DirStore) Release(ctx context.Context, document string, want []byte) error

type MemoryStore

+ func (s *MemoryStore) Idle(_ context.Context, d time.Duration) ([]string, error)

+ func (s *MemoryStore) Release(_ context.Context, document string, want []byte) error

+ type Tiered struct

+ func NewTiered(hot Archivable, cold Store) *Tiered

+ func (t *Tiered) Archive(ctx context.Context, idleFor time.Duration) (int, error)

+ func (t *Tiered) Load(ctx context.Context, document string) ([]byte, error)

+ func (t *Tiered) Save(ctx context.Context, document string, snapshot []byte) error

Aug 25, 2026

Changes in this version

+ const DefaultElectionWindow — js/wasm

+ var ErrBroadcastClosed = errors.New("collab: broadcast channel closed")

+ type Role int

+ const RoleClient

+ const RoleHost

+ func HostOrJoin(ctx context.Context, room string, window time.Duration) (Role, error)

type Server — js/wasm

+ func (s *Server) ServeBroadcastChannel(ctx context.Context, room string) error

type Transport — js/wasm

+ func JoinBroadcastChannel(room string) Transport

Aug 24, 2026

Changes in this version

+ const DefaultRetryCeiling — darwin/amd64, linux/amd64, windows/amd64

+ const DefaultRetryWait — darwin/amd64, linux/amd64, windows/amd64

+ func MergeSnapshots(ours, theirs []byte) ([]byte, error)

+ type Dialer func(ctx context.Context) (Transport, error) — darwin/amd64, linux/amd64, windows/amd64

+ type LinkStatus struct — darwin/amd64, linux/amd64, windows/amd64

+ Attempt int

+ DownFor time.Duration

+ Err error

+ RetryIn time.Duration

+ Up bool

+ type MultiStore struct

+ func NewMultiStore(stores ...Store) *MultiStore

+ func (m *MultiStore) Load(ctx context.Context, document string) ([]byte, error)

+ func (m *MultiStore) Save(ctx context.Context, document string, snapshot []byte) error

+ type RetryPolicy struct — darwin/amd64, linux/amd64, windows/amd64

+ Ceiling time.Duration

+ Notify func(LinkStatus)

+ Permanent func(error) bool

+ Wait time.Duration

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) FollowWithRetry(ctx context.Context, dial Dialer, document string, as crdt.SiteID, ...) error

Aug 24, 2026

Changes in this version

type Config

+ AuthorizeOperations func(ctx context.Context, document string, from crdt.SiteID, batches []crdt.PartOps) error

Aug 21, 2026

Changes in this version

+ var ErrPipeClosed = errors.New("collab: pipe closed")

+ func Pipe() (Transport, *PipeConn)

+ type PipeConn struct

type Server

+ func (s *Server) ServePipe(ctx context.Context, sc *PipeConn) error

Aug 20, 2026

Changes in this version

+ type ICEServerAuth struct — js/wasm

+ Credential string

+ URLs []string

+ Username string

type PeerConfig — js/wasm

+ ICEServersAuth []ICEServerAuth

Aug 20, 2026

Changes in this version

+ type Peer struct — js/wasm

+ func NewPeer(cfg PeerConfig) (*Peer, error)

+ func (p *Peer) AcceptAnswer(blob string) error

+ func (p *Peer) Answer(ctx context.Context, remoteOffer string) (string, error)

+ func (p *Peer) Close() error

+ func (p *Peer) DataChannel(ctx context.Context) (js.Value, error)

+ func (p *Peer) Offer(ctx context.Context, label string) (string, error)

+ type PeerConfig struct — js/wasm

+ ICEServers []string

Aug 18, 2026

Changes in this version

type Config — js/wasm

+ Clock func() time.Time

+ EvictAfter time.Duration

+ OnEvictError func(document string, err error)

+ PersistEvery time.Duration

+ type GRPCServer struct — darwin/amd64, linux/amd64, windows/amd64

+ func GRPCService(s *Server) *GRPCServer

+ func (g *GRPCServer) Session(stream collabpb.Collab_SessionServer) error

type Server — js/wasm

+ func (s *Server) Close(ctx context.Context) error

+ func (s *Server) ServeDataChannel(ctx context.Context, ch js.Value) error

type Transport — js/wasm

+ func DataChannel(ch js.Value) Transport

Aug 18, 2026

Changes in this version

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) Follow(ctx context.Context, peer Transport, document string, as crdt.SiteID) error

Aug 17, 2026

Changes in this version

+ var ErrNoDocument = errors.New("collab: a document must have a name") — darwin/amd64, linux/amd64, windows/amd64

type Config — darwin/amd64, linux/amd64, windows/amd64

+ Clock func() time.Time

+ EvictAfter time.Duration

+ OnEvictError func(document string, err error)

+ PersistEvery time.Duration

+ type DirStore struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewDirStore(dir string) (*DirStore, error)

+ func (s *DirStore) Documents() ([]string, error)

+ func (s *DirStore) Load(_ context.Context, document string) ([]byte, error)

+ func (s *DirStore) Save(_ context.Context, document string, snapshot []byte) error

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) Close(ctx context.Context) error

Aug 17, 2026

Changes in this version

type Text

+ func (t *Text) AnchorUTF16(pos int) (crdt.ID, error)

+ func (t *Text) AuthorRunsUTF16() []crdt.AuthorRun

+ func (t *Text) PositionUTF16(anchor crdt.ID) (pos int, ok bool)

Aug 17, 2026

Changes in this version

+ var ErrTransport = errors.New("collab: transport")

type Server — darwin/amd64, linux/amd64, windows/amd64

+ func (s *Server) ServeWebSocket(origins ...string) http.Handler

+ type Transport interface

+ func GRPC(conn grpc.ClientConnInterface) Transport

+ func WebSocket(url string, opts ...WebSocketOption) Transport

+ type WebSocketOption func(*wsTransport)

+ func WithHTTPHeader(h http.Header) WebSocketOption

Aug 17, 2026

Changes in this version

type Client

+ func (c *Client) List(name string) (*List, error)

+ func (c *Client) Map(name string) (*Map, error)

+ func (c *Client) Parts() []crdt.Part

+ type List struct

+ func (l *List) Append(values ...[]byte) error

+ func (l *List) Delete(pos, count int) error

+ func (l *List) Get(pos int) ([]byte, error)

+ func (l *List) Insert(pos int, values ...[]byte) error

+ func (l *List) Len() int

+ func (l *List) Name() string

+ func (l *List) Part() crdt.Part

+ func (l *List) Values() [][]byte

+ type Map struct

+ func (m *Map) Delete(key string) error

+ func (m *Map) Get(key string) ([]byte, bool)

+ func (m *Map) Keys() []string

+ func (m *Map) Len() int

+ func (m *Map) Name() string

+ func (m *Map) Part() crdt.Part

+ func (m *Map) Set(key string, value []byte) error

+ type Text struct

+ func (t *Text) Anchor(pos int) (crdt.ID, error)

+ func (t *Text) AuthorRuns() []crdt.AuthorRun

+ func (t *Text) Delete(pos, length int) error

+ func (t *Text) DeleteUTF16(pos, length int) error

+ func (t *Text) Insert(pos int, text string) error

+ func (t *Text) InsertUTF16(pos int, text string) error

+ func (t *Text) Len() int

+ func (t *Text) LenUTF16() int

+ func (t *Text) Name() string

+ func (t *Text) Part() crdt.Part

+ func (t *Text) Position(anchor crdt.ID) (int, bool)

+ func (t *Text) String() string

+ func (t *Text) Visible(anchor crdt.ID) bool

Aug 16, 2026

Changes in this version

type Client

+ func (c *Client) DeleteUTF16(pos, length int) error

+ func (c *Client) InsertUTF16(pos int, text string) error

+ func (c *Client) LenUTF16() int

Aug 16, 2026

Changes in this version

type Client

+ func (c *Client) Anchor(pos int) (crdt.ID, error)

+ func (c *Client) AuthorRuns() []crdt.AuthorRun

+ func (c *Client) Position(anchor crdt.ID) (int, bool)

+ func (c *Client) TakeChanges() []crdt.Change

+ func (c *Client) Visible(anchor crdt.ID) bool

Aug 16, 2026

Changes in this version

type Config

+ Authorize func(ctx context.Context, document string, site crdt.SiteID) error

Aug 16, 2026

Changes in this version

+ const DefaultBacklog

+ var ErrClosed = errors.New("collab: session closed")

+ var ErrProtocol = errors.New("collab: unexpected message from the server")

+ type Client struct

+ func Join(ctx context.Context, conn grpc.ClientConnInterface, cfg ClientConfig) (*Client, error)

+ func (c *Client) Changes() <-chan struct{}

+ func (c *Client) Close() error

+ func (c *Client) Delete(pos, length int) error

+ func (c *Client) Document() string

+ func (c *Client) Done() <-chan struct{}

+ func (c *Client) Err() error

+ func (c *Client) Insert(pos int, text string) error

+ func (c *Client) Len() int

+ func (c *Client) Peers() []awareness.Peer

+ func (c *Client) SetCursor(cursor awareness.Cursor, meta map[string]string) error

+ func (c *Client) Site() crdt.SiteID

+ func (c *Client) Snapshot() []byte

+ func (c *Client) Text() string

+ func (c *Client) Version() crdt.VersionVector

+ type ClientConfig struct

+ Document string

+ Resume []byte

+ Site crdt.SiteID

+ type Config struct

+ Backlog int

+ Store Store

+ type MemoryStore struct

+ func NewMemoryStore() *MemoryStore

+ func (s *MemoryStore) Documents() []string

+ func (s *MemoryStore) Load(_ context.Context, document string) ([]byte, error)

+ func (s *MemoryStore) Save(_ context.Context, document string, snapshot []byte) error

+ type Server struct

+ func NewServer(cfg Config) *Server

+ func (s *Server) Flush(ctx context.Context) error

+ func (s *Server) Session(stream collabpb.Collab_SessionServer) error

+ type Store interface

+ Load func(ctx context.Context, document string) ([]byte, error)

+ Save func(ctx context.Context, document string, snapshot []byte) error