Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
admindemo
command
Command admindemo is a throwaway harness for eyeballing the built-in admin UI.
|
Command admindemo is a throwaway harness for eyeballing the built-in admin UI. |
|
benchserver
command
benchserver runs the sync engine with the syncplane.bench.v1 corpus for the browser benchmark suite (client/test/perf).
|
benchserver runs the sync engine with the syncplane.bench.v1 corpus for the browser benchmark suite (client/test/perf). |
|
mdtodo
command
mdtodo demonstrates layering the sync engine over an external source of truth: the todo app's entities live as Markdown files in a folder, kept bidirectionally converged with the engine by a connect.Connector.
|
mdtodo demonstrates layering the sync engine over an external source of truth: the todo app's entities live as Markdown files in a folder, kept bidirectionally converged with the engine by a connect.Connector. |
|
syncplaned
command
syncplaned runs the sync engine as a multi-app host: a server.Manager routes the public sync surface by a leading "/<appID>" path segment, while a separate, private listener serves the trusted AdminService for runtime schema registration (gated by a bearer TokenAuthorizer).
|
syncplaned runs the sync engine as a multi-app host: a server.Manager routes the public sync surface by a leading "/<appID>" path segment, while a separate, private listener serves the trusted AdminService for runtime schema registration (gated by a bearer TokenAuthorizer). |
|
testserver
command
testserver runs the sync engine with the test entities (Todo, Widget), the complete_all mutator and a deny-rule permission hook.
|
testserver runs the sync engine with the test entities (Todo, Widget), the complete_all mutator and a deny-rule permission hook. |
|
todoserver
command
todoserver backs the examples/todo web app: the sync engine with the todo entity, the complete_all mutator, the example permission policy, and permissive CORS so the Vite dev server can reach it.
|
todoserver backs the examples/todo web app: the sync engine with the todo entity, the complete_all mutator, the example permission policy, and permissive CORS so the Vite dev server can reach it. |
|
engine
|
|
|
blob
Package blob defines how the engine names and stores blobs: the immutable bytes, such as images, PDFs and videos, that rows refer to with a syncplane.v1.BlobRef.
|
Package blob defines how the engine names and stores blobs: the immutable bytes, such as images, PDFs and videos, that rows refer to with a syncplane.v1.BlobRef. |
|
blob/blobtest
Package blobtest provides a shared Ginkgo behavior suite every blob.Store implementation must pass.
|
Package blobtest provides a shared Ginkgo behavior suite every blob.Store implementation must pass. |
|
blob/fsstore
Package fsstore is a blob.Store that keeps blobs in a local directory.
|
Package fsstore is a blob.Store that keeps blobs in a local directory. |
|
blob/memstore
Package memstore is a blob.Store that keeps everything in memory.
|
Package memstore is a blob.Store that keeps everything in memory. |
|
client
Package client is a Go client for a remote syncplane server, for code that keeps no local copy of the data: backend jobs, tools and tests.
|
Package client is a Go client for a remote syncplane server, for code that keeps no local copy of the data: backend jobs, tools and tests. |
|
connect
Package connect binds the sync engine to an external source of truth — an adopter-owned store the engine does not manage (a folder of files, an existing database) — and keeps the two converged bidirectionally.
|
Package connect binds the sync engine to an external source of truth — an adopter-owned store the engine does not manage (a folder of files, an existing database) — and keeps the two converged bidirectionally. |
|
connect/sqlitestate
Package sqlitestate implements connect.State on SQLite via modernc.org/sqlite (pure Go, no CGO) — the shipped default for connector bookkeeping.
|
Package sqlitestate implements connect.State on SQLite via modernc.org/sqlite (pure Go, no CGO) — the shipped default for connector bookkeeping. |
|
cursorstate
Package cursorstate stores the bulky membership tail of pull cursors — the subscription set and the windowed/closure key-sets — so the cursor a client carries is a fixed-size reference instead of a restatement of everything it holds.
|
Package cursorstate stores the bulky membership tail of pull cursors — the subscription set and the windowed/closure key-sets — so the cursor a client carries is a fixed-size reference instead of a restatement of everything it holds. |
|
effects
Package effects runs server-side reactions to committed changes: webhooks, notifications, search indexing, agents — anything that should happen after a row is written and is not itself part of the write.
|
Package effects runs server-side reactions to committed changes: webhooks, notifications, search indexing, agents — anything that should happen after a row is written and is not itself part of the write. |
|
fractional
Package fractional makes order keys: strings that sort a list and that always have room for one more key between any two of them.
|
Package fractional makes order keys: strings that sort a list and that always have room for one more key between any two of them. |
|
id
Package id generates time-ordered entity identifiers: a UUIDv7 (RFC 9562) rendered as 26-character Crockford base32.
|
Package id generates time-ordered entity identifiers: a UUIDv7 (RFC 9562) rendered as 26-character Crockford base32. |
|
internal/lww
Package lww merges PATCH mutations into row snapshots using field masks.
|
Package lww merges PATCH mutations into row snapshots using field masks. |
|
internal/naming
Package naming holds the naming rules of the sync engine: what an entity may be called, what a workspace may be identified by, which fields may form a row key, how their values render into one, and what the resulting key may contain.
|
Package naming holds the naming rules of the sync engine: what an entity may be called, what a workspace may be identified by, which fields may form a row key, how their values render into one, and what the resulting key may contain. |
|
internal/pgtest
Package pgtest supplies the live Postgres the pgstore, pglisten, pgnotify and pgpresence suites run against.
|
Package pgtest supplies the live Postgres the pgstore, pglisten, pgnotify and pgpresence suites run against. |
|
internal/pubsub
Package pubsub provides change-notification fan-out.
|
Package pubsub provides change-notification fan-out. |
|
internal/pubsub/pubsubtest
Package pubsubtest provides a shared Ginkgo behavior suite every pubsub.Notifier implementation must pass.
|
Package pubsubtest provides a shared Ginkgo behavior suite every pubsub.Notifier implementation must pass. |
|
internal/telemetry
Package telemetry holds what every instrumented engine package shares: the instrumentation scope, the attribute keys, and the provider resolution that makes telemetry free when nobody has configured it.
|
Package telemetry holds what every instrumented engine package shares: the instrumentation scope, the attribute keys, and the provider resolution that makes telemetry free when nobody has configured it. |
|
internal/textpath
Package textpath finds the collaborative-text documents of an entity row and reads and writes them by instance path.
|
Package textpath finds the collaborative-text documents of an entity row and reads and writes them by instance path. |
|
lease
Package lease hands out per-workspace work leases: advisory try-locks that let one holder of a (role, workspace) pair proceed while everyone else skips.
|
Package lease hands out per-workspace work leases: advisory try-locks that let one holder of a (role, workspace) pair proceed while everyone else skips. |
|
notify/pgnotify
Package pgnotify implements the engine's change-notification fan-out over PostgreSQL LISTEN/NOTIFY, so pokes reach clients connected to any node rather than only the one that took the write.
|
Package pgnotify implements the engine's change-notification fan-out over PostgreSQL LISTEN/NOTIFY, so pokes reach clients connected to any node rather than only the one that took the write. |
|
pglisten
Package pglisten is the PostgreSQL LISTEN/NOTIFY transport the engine's cross-node fan-outs are built on: one connection parked on the channels a process listens to, one issuing pg_notify, and the reconnect loop that keeps both alive.
|
Package pglisten is the PostgreSQL LISTEN/NOTIFY transport the engine's cross-node fan-outs are built on: one connection parked on the channels a process listens to, one issuing pg_notify, and the reconnect loop that keeps both alive. |
|
presence
Package presence carries the sync engine's ephemeral plane: the state that only matters while someone is connected.
|
Package presence carries the sync engine's ephemeral plane: the state that only matters while someone is connected. |
|
presence/pgpresence
Package pgpresence implements the ephemeral plane's fan-out over PostgreSQL LISTEN/NOTIFY, so rooms reach clients connected to any node rather than only the one holding a given session's stream.
|
Package pgpresence implements the ephemeral plane's fan-out over PostgreSQL LISTEN/NOTIFY, so rooms reach clients connected to any node rather than only the one holding a given session's stream. |
|
presence/presencetest
Package presencetest provides a shared Ginkgo behavior suite every presence.Bus implementation must pass.
|
Package presencetest provides a shared Ginkgo behavior suite every presence.Bus implementation must pass. |
|
query
Package query builds, compiles and evaluates syncplane.v1.Condition predicates against protoreflect messages.
|
Package query builds, compiles and evaluates syncplane.v1.Condition predicates against protoreflect messages. |
|
search
Package search implements the text analyzer behind full-text search: the pipeline that turns field text and query strings into the terms the match evaluator and the search index agree on.
|
Package search implements the text analyzer behind full-text search: the pipeline that turns field text and query strings into the terms the match evaluator and the search index agree on. |
|
server
Reference-following subscriptions: a subscription's synced set is its base predicate scope UNION a bounded-depth closure reached by walking typed reference relations from the base-visible rows.
|
Reference-following subscriptions: a subscription's synced set is its base predicate scope UNION a bounded-depth closure reached by walking typed reference relations from the base-visible rows. |
|
storage
Package storage defines the pluggable persistence interface for the sync engine.
|
Package storage defines the pluggable persistence interface for the sync engine. |
|
storage/otelstore
Package otelstore instruments any storage.Adapter with OpenTelemetry.
|
Package otelstore instruments any storage.Adapter with OpenTelemetry. |
|
storage/pgstore
Package pgstore implements storage.Adapter on PostgreSQL via pgx v5.
|
Package pgstore implements storage.Adapter on PostgreSQL via pgx v5. |
|
storage/prefixstore
Package prefixstore partitions one storage adapter between several servers by giving each its own prefix of the workspace-id space.
|
Package prefixstore partitions one storage adapter between several servers by giving each its own prefix of the workspace-id space. |
|
storage/sqlitestore
Package sqlitestore implements storage.Adapter on SQLite via modernc.org/sqlite (pure Go, no CGO).
|
Package sqlitestore implements storage.Adapter on SQLite via modernc.org/sqlite (pure Go, no CGO). |
|
storage/storagetest
Package storagetest provides a shared Ginkgo behavior suite every storage.Adapter implementation must pass.
|
Package storagetest provides a shared Ginkgo behavior suite every storage.Adapter implementation must pass. |
|
text
Package text implements a convergent (CRDT) text document with Peritext-style marks and stable anchors, designed to live in a `bytes` entity field marked (syncplane.v1.field_behavior).text.
|
Package text implements a convergent (CRDT) text document with Peritext-style marks and stable anchors, designed to live in a `bytes` entity field marked (syncplane.v1.field_behavior).text. |
|
tunnel
Package tunnel carries HTTP exchanges over a message channel, so an http.Handler can serve clients that have no socket to it: a webview behind a desktop shell, a process on the other end of stdio, a page across a WebSocket or a MessagePort.
|
Package tunnel carries HTTP exchanges over a message channel, so an http.Handler can serve clients that have no socket to it: a webview behind a desktop shell, a process on the other end of stdio, a page across a WebSocket or a MessagePort. |
|
upstream
Package upstream keeps a local syncplane engine converged with an origin syncplane server, so that a Go process can serve, read and write synced data while offline: a desktop app whose webview syncs against the local engine, a server that syncs with another, or a local engine that forwards an origin to browsers.
|
Package upstream keeps a local syncplane engine converged with an origin syncplane server, so that a Go process can serve, read and write synced data while offline: a desktop app whose webview syncs against the local engine, a server that syncs with another, or a local engine that forwards an origin to browsers. |
|
upstream/blobbridge
Package blobbridge moves blob bytes between a local engine and the origin server it syncs with.
|
Package blobbridge moves blob bytes between a local engine and the origin server it syncs with. |
|
upstream/internal/rebase
Package rebase computes the rows a replica holds from the rows its origin confirmed and the local writes the origin has not confirmed yet.
|
Package rebase computes the rows a replica holds from the rows its origin confirmed and the local writes the origin has not confirmed yet. |
|
upstream/presencebridge
Package presencebridge joins the rooms of a local syncplane engine to the rooms of the origin server it syncs with, so that people connected to the origin and people connected to the local engine see each other's presence and broadcasts.
|
Package presencebridge joins the rooms of a local syncplane engine to the rooms of the origin server it syncs with, so that people connected to the origin and people connected to the local engine see each other's presence and broadcasts. |
|
internal
|
|
|
admin
Package admin is the built-in, read/write web UI for a server.Manager: it lists hosted apps, browses each app's entity data per workspace, and creates/edits/deletes rows through a generic, reflection-driven proto editor.
|
Package admin is the built-in, read/write web UI for a server.Manager: it lists hosted apps, browses each app's entity data per workspace, and creates/edits/deletes rows through a generic, reflection-driven proto editor. |
|
admin/ui
templ: version: v0.3.857
|
templ: version: v0.3.857 |
|
benchapp
Package benchapp holds the corpus the browser sync benchmarks measure against: the syncplane.bench.v1 issue tracker, its size tiers, and a deterministic generator that seeds a workspace server-side.
|
Package benchapp holds the corpus the browser sync benchmarks measure against: the syncplane.bench.v1 issue tracker, its size tiers, and a deterministic generator that seeds a workspace server-side. |
|
clilog
Package clilog builds the structured logger used by the engine's command binaries from -log-format / -log-level flags and installs it as slog.Default, so the server and connector libraries (which default to slog.Default) inherit the same handler.
|
Package clilog builds the structured logger used by the engine's command binaries from -log-format / -log-level flags and installs it as slog.Default, so the server and connector libraries (which default to slog.Default) inherit the same handler. |
|
exampleapp
Package exampleapp holds the todo-app wiring shared by cmd/testserver and cmd/todoserver: entity registration, the complete_all mutator, and a small permission policy exercised by the test suites.
|
Package exampleapp holds the todo-app wiring shared by cmd/testserver and cmd/todoserver: entity registration, the complete_all mutator, and a small permission policy exercised by the test suites. |
|
protoopts
Package protoopts reads the sync custom options — (syncplane.v1.entity), (syncplane.v1.reference) and (syncplane.v1.field_behavior) — off proto descriptors.
|
Package protoopts reads the sync custom options — (syncplane.v1.entity), (syncplane.v1.reference) and (syncplane.v1.field_behavior) — off proto descriptors. |
Click to show internal directories.
Click to hide internal directories.