@mdfn/server 0.1.0

package/README.md

@@ -0,0 +1,26 @@
+# `@mdfn/server`
+
+Self-hosted document CRUD, canonical source validation, optimistic versioning,
+immutable revisions, editorial workflows, persisted collaboration updates,
+authorization hooks, and a Web Standard router. The incoming
+`@superfunctions/db` adapter is always wrapped internally with the MDFN schema.
+
+Durable mode is the default and rejects database adapters without transaction
+and relational-constraint support. Create/update/restore/editorial writes
+validate both Markdown and the complete sidecar, run atomically, and support idempotency through the
+`Idempotency-Key` header or request body. Delete atomically removes the
+document, revisions, receipts, and collaboration updates. Ephemeral mode must
+be selected explicitly and is intended only for memory-backed tests.
+
+The router exposes document and version CRUD, version restore, sidecar and
+audit reads, comment/reply/resolve, suggestion/decision, review transitions,
+and collaboration update append/read/compact routes under `/api/mdfn` by
+default. Version history returns bounded lightweight metadata pages; fetch an
+individual version for its Markdown and sidecar. Collaboration reads return a
+bounded page containing the updates, their exact `includedUpdateIds`, and a
+stable `nextCursor` when another page remains; pass that cursor back as the
+`cursor` query parameter. Compaction requires the represented ids and preserves
+updates that arrive concurrently without invalidating an existing cursor. The
+default collaboration and router body limits are derived from the configured maximum
+Markdown size plus Yjs and transport-encoding overhead. Every operation is
+tenant/owner scoped and passes through the host's authorization callback.