@docmentis/udoc-server 0.0.0-stage → 0.8.0

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 docMentis LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+# @docmentis/udoc-server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Self-hosted document services and collaboration for your application.**
+
+Host documents on your own infrastructure, access document content and rendered pages over HTTP, and support collaborative editing in applications built with docMentis.
+
+[![npm version](https://img.shields.io/npm/v/@docmentis/udoc-server)](https://www.npmjs.com/package/@docmentis/udoc-server)
+[![license](https://img.shields.io/npm/l/@docmentis/udoc-server)](https://github.com/docMentis/docmentis-udoc#open-source-packages-shared-runtime)
+
+**[Docs](https://www.docmentis.com/docs)** · **[API Reference](https://www.docmentis.com/docs/api/udoc-server)** · **[Changelog](https://github.com/docMentis/docmentis-udoc/blob/main/CHANGELOG.md)** · **[Report Issue](https://github.com/docMentis/docmentis-udoc/issues)**
+
+---
+
+## What it provides
+
+- **Document hosting.** Store and retrieve documents through a document service you operate.
+- **Document APIs.** Access pages, previews, and saved documents from your application.
+- **Remote document access.** Connect browser-based editors and Node.js integrations to documents held by the service.
+- **Collaborative editing.** Synchronize changes between participants working on a shared document.
+
+## Quick start
+
+```sh
+npm install -g @docmentis/udoc-server
+udoc-server --port 8080 --data-dir ./udoc-data
+```
+
+```sh
+curl --data-binary @report.pdf http://127.0.0.1:8080/documents
+```
+
+The service listens on loopback by default and does not provide end-user authentication. **Add authentication, authorization, and appropriate deployment controls before exposing it to users or the public internet.** See the package documentation for configuration, embedding it into an existing Node.js server, and collaboration endpoints.
+
+## Part of the udoc ecosystem
+
+The server works with [`@docmentis/udoc-editor`](https://www.npmjs.com/package/@docmentis/udoc-editor) for remote collaborative editing and builds on [`@docmentis/udoc-node`](https://www.npmjs.com/package/@docmentis/udoc-node).
+
+## Licensing
+
+The server's source code is open source under **MIT OR Apache-2.0**. It uses the proprietary, separately licensed [`@docmentis/udoc-wasm`](https://www.npmjs.com/package/@docmentis/udoc-wasm) engine. Free runtime use requires online authorization; commercial licensing is available for offline use.
+
+[Source and documentation](https://github.com/docMentis/docmentis-udoc)

package/config.example.toml

@@ -0,0 +1,26 @@
+# udoc-server settings — pass with `udoc-server --config <this file>`.
+#
+# Every key is a flag of the same name, in the same units, and a flag on the
+# command line overrides it. Each is shown at its default. An unknown key is an
+# error, so a typo never falls back to a default quietly.
+#
+# The license is not a setting: udoc-server reads it from the environment
+# (UDOC_LICENSE, for the domain in UDOC_DOMAIN), so this file can be committed.
+
+# The address to bind. Loopback by default: udoc-server does no authentication,
+# so put it behind whatever authenticates your users before exposing it.
+host = "127.0.0.1"
+
+# The port to listen on.
+port = 8080
+
+# Where documents are kept: a directory per document, holding its original and
+# its udoc package. A relative path is relative to this file.
+data-dir = "udoc-data"
+
+# How long, in seconds, a document's session stays open with no request for it.
+session-timeout = 300
+
+# How many sessions stay open once their requests finish. Past it, the least
+# recently used idle sessions close; a closed one reopens on its next request.
+session-pool = 32

package/dist/collaboration.d.ts

@@ -0,0 +1,25 @@
+import type { Upgrade } from "./http.ts";
+import type { SessionPool } from "./session-pool.ts";
+import type { DocumentStore } from "./store.ts";
+/** The collaboration on each document being edited now, and the clients arriving at them. */
+export declare class Collaborations {
+    #private;
+    /** Over the documents `store` keeps and the sessions `sessions` holds open; no message larger than `maxPayload` bytes. */
+    constructor(store: DocumentStore, sessions: SessionPool, maxPayload: number);
+    /**
+     * Take `upgrade` into document `id`'s collaboration, once its session is
+     * open. What refuses it — the server closing, a session that can't be
+     * opened — takes the upgrade and closes it with the code saying why.
+     */
+    join(id: string, upgrade: Upgrade): Promise<void>;
+    /**
+     * Take `upgrade` and close it with the code `error` calls for: no such
+     * document, a license refusal, or a document that can't be opened.
+     */
+    refuse(upgrade: Upgrade, error: unknown): void;
+    /** End document `id`'s collaboration, if one is under way: the document is no longer kept. */
+    end(id: string): void;
+    /** Refuse every client arriving from now on, and end every collaboration once its log is kept. */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=collaboration.d.ts.map

package/dist/collaboration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collaboration.d.ts","sourceRoot":"","sources":["../src/collaboration.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AA0BhD,6FAA6F;AAC7F,qBAAa,cAAc;;IAOvB,0HAA0H;gBAC9G,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM;IAM3E;;;;OAIG;IACG,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBvD;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAI9C,8FAA8F;IAC9F,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIrB,kGAAkG;IAC5F,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAwB/B"}

package/dist/collaboration.js

@@ -0,0 +1,348 @@
+// Clients editing a kept document together (docs/design/node-collaboration.md):
+// a collaboration is the document's pooled session, held open while any client
+// is connected; each client's edits are merged into it, sent on to every other
+// client, and kept in the store as the document's edit log. The engine does
+// the merging, and the server only carries its bytes, over a WebSocket.
+import { WebSocketServer } from "ws";
+import { LICENSE_CODES, failureOf, messageOf } from "./http.js";
+/**
+ * A collaboration message is a binary frame: one byte saying what it is, then
+ * its payload — the engine's own bytes, crossed as they are.
+ */
+const JOIN = 1;
+const PATCH = 2;
+const PRESENCE = 3;
+/** The content of opaque parts a client's next patch names — kept before that patch is merged. */
+const OPAQUE_PARTS = 4;
+/**
+ * Why the server ends a client's connection: the WebSocket close codes it
+ * sends — WebSocket's own where it defines the meaning, and this server's from
+ * 4000.
+ */
+const CLOSE_SERVER_CLOSING = 1001;
+const CLOSE_PROTOCOL_ERROR = 1002;
+const CLOSE_NOT_BINARY = 1003;
+const CLOSE_DID_NOT_MERGE = 1008;
+const CLOSE_SESSION_ENDED = 1011;
+const CLOSE_NO_DOCUMENT = 4000;
+const CLOSE_LICENSE_REFUSED = 4001;
+const CLOSE_CANNOT_OPEN = 4002;
+/** The collaboration on each document being edited now, and the clients arriving at them. */
+export class Collaborations {
+    #store;
+    #sessions;
+    #collaborations = new Map();
+    #sockets;
+    #closing = false;
+    /** Over the documents `store` keeps and the sessions `sessions` holds open; no message larger than `maxPayload` bytes. */
+    constructor(store, sessions, maxPayload) {
+        this.#store = store;
+        this.#sessions = sessions;
+        this.#sockets = new WebSocketServer({ noServer: true, maxPayload });
+    }
+    /**
+     * Take `upgrade` into document `id`'s collaboration, once its session is
+     * open. What refuses it — the server closing, a session that can't be
+     * opened — takes the upgrade and closes it with the code saying why.
+     */
+    async join(id, upgrade) {
+        if (this.#closing) {
+            this.#refuse(upgrade, CLOSE_SERVER_CLOSING, "the server is closing");
+            return;
+        }
+        const collaboration = this.#collaborationOf(id);
+        const arrival = collaboration.arrive();
+        // A client that goes before it is admitted leaves nothing held.
+        upgrade.socket.once("close", () => arrival.leave());
+        try {
+            await collaboration.session;
+        }
+        catch (error) {
+            arrival.leave();
+            this.refuse(upgrade, error);
+            return;
+        }
+        this.#sockets.handleUpgrade(upgrade.request, upgrade.socket, upgrade.head, (client) => arrival.admit(client));
+    }
+    /**
+     * Take `upgrade` and close it with the code `error` calls for: no such
+     * document, a license refusal, or a document that can't be opened.
+     */
+    refuse(upgrade, error) {
+        this.#refuse(upgrade, ...closeOf(error, false));
+    }
+    /** End document `id`'s collaboration, if one is under way: the document is no longer kept. */
+    end(id) {
+        this.#collaborations.get(id)?.end(CLOSE_NO_DOCUMENT, "the document was deleted");
+    }
+    /** Refuse every client arriving from now on, and end every collaboration once its log is kept. */
+    async close() {
+        this.#closing = true;
+        const ending = [...this.#collaborations.values()];
+        for (const collaboration of ending)
+            collaboration.end(CLOSE_SERVER_CLOSING, "the server is closing");
+        await Promise.all(ending.map((collaboration) => collaboration.done));
+        this.#sockets.close();
+    }
+    /** Document `id`'s collaboration: the one under way, or a new one. */
+    #collaborationOf(id) {
+        let collaboration = this.#collaborations.get(id);
+        if (!collaboration || collaboration.ended) {
+            collaboration = new Collaboration(id, this.#store, this.#sessions, (ended) => {
+                if (this.#collaborations.get(id) === ended)
+                    this.#collaborations.delete(id);
+            });
+            this.#collaborations.set(id, collaboration);
+        }
+        return collaboration;
+    }
+    /** Take `upgrade` and close it at once with `code` and `reason`. */
+    #refuse({ request, socket, head }, code, reason) {
+        this.#sockets.handleUpgrade(request, socket, head, (client) => client.close(code, truncateReason(reason)));
+    }
+}
+/**
+ * Document `id`'s collaboration: the clients editing it together over its
+ * pooled session, which it holds busy — so neither idled out nor evicted — for
+ * as long as any client is connected or arriving. A client's edits are merged
+ * into the session, sent on to every other client, and kept as the document's
+ * edit log; its presence is merged and sent on, and never kept.
+ *
+ * The log is the session's whole editing state, written after every merge —
+ * one write at a time, the next taking in everything merged meanwhile — and
+ * once more before the session is let go.
+ */
+class Collaboration {
+    /** The session, once the pool has it open; rejects when it can't be opened. */
+    session;
+    /** Settles once the collaboration is over and its log is kept. */
+    done;
+    #id;
+    #store;
+    #onEnd;
+    /** Every connected client; the joined ones are those edits are sent on to. */
+    #clients = new Set();
+    #joined = new Set();
+    #arriving = 0;
+    #ended = false;
+    #finish;
+    /** Whether something merged since the log was last written. */
+    #logBehind = false;
+    #logWriting;
+    constructor(id, store, sessions, onEnd) {
+        this.#id = id;
+        this.#store = store;
+        this.#onEnd = onEnd;
+        this.done = new Promise((resolve) => (this.#finish = resolve));
+        this.session = new Promise((resolve, reject) => {
+            // The collaboration is one long use of the pooled session.
+            sessions
+                .use(id, (session) => {
+                resolve(session);
+                // However it goes — closed, or its engine gone — the
+                // clients can't go on with it.
+                void session.closed.then((reason) => this.end(CLOSE_SESSION_ENDED, `the document's session ended: ${reason.message}`));
+                return this.done;
+            })
+                .catch((error) => {
+                reject(error);
+                this.#ended = true;
+                this.#finish();
+                this.#onEnd(this);
+            });
+        });
+        // Its failure is each arrival's to answer, not an unhandled rejection.
+        this.session.catch(() => { });
+    }
+    /** Whether it is over, so an arriving client needs a new one. */
+    get ended() {
+        return this.#ended;
+    }
+    /** Count a client arriving, so the collaboration lasts until it is admitted or leaves. */
+    arrive() {
+        this.#arriving++;
+        let settled = false;
+        const settle = () => {
+            if (settled)
+                return false;
+            settled = true;
+            this.#arriving--;
+            return true;
+        };
+        return {
+            admit: (client) => {
+                if (!settle()) {
+                    client.close(CLOSE_SESSION_ENDED, "the collaboration ended");
+                    return;
+                }
+                if (this.#ended) {
+                    client.close(CLOSE_SESSION_ENDED, "the collaboration ended");
+                    this.#settleIfEmpty();
+                    return;
+                }
+                this.#admit(client);
+            },
+            leave: () => {
+                if (settle())
+                    this.#settleIfEmpty();
+            },
+        };
+    }
+    /** End it now: close every client with `code` and `reason`, keep the log, let the session go. */
+    end(code, reason) {
+        if (this.#ended)
+            return;
+        this.#ended = true;
+        this.#onEnd(this);
+        for (const client of this.#clients)
+            client.close(code, reason);
+        void this.#logKept().then(() => this.#finish());
+    }
+    #admit(client) {
+        this.#clients.add(client);
+        // One message at a time per client, in the order it sent them.
+        let received = Promise.resolve();
+        client.on("message", (data, isBinary) => {
+            received = received.then(() => this.#receive(client, data, isBinary));
+        });
+        client.on("close", () => {
+            this.#clients.delete(client);
+            this.#joined.delete(client);
+            this.#settleIfEmpty();
+        });
+    }
+    async #receive(client, data, isBinary) {
+        const message = isBinary && Buffer.isBuffer(data) ? data : undefined;
+        if (!message || message.byteLength === 0) {
+            client.close(CLOSE_NOT_BINARY, "a message is a binary frame: its kind's byte, then its payload");
+            return;
+        }
+        const kind = message[0];
+        const payload = new Uint8Array(message.subarray(1));
+        const joined = this.#joined.has(client);
+        if (kind !== JOIN && !joined) {
+            client.close(CLOSE_PROTOCOL_ERROR, "join first");
+            return;
+        }
+        const session = await this.session;
+        try {
+            switch (kind) {
+                case JOIN: {
+                    if (joined) {
+                        client.close(CLOSE_PROTOCOL_ERROR, "already joined");
+                        return;
+                    }
+                    // Joined before it is answered, so an edit merged while the
+                    // answer is made is sent on to it too: it may get one
+                    // twice, which merging makes harmless, but never not at all.
+                    this.#joined.add(client);
+                    const missing = await session.patchSince(payload);
+                    const held = await session.versionVector();
+                    const presence = await session.presence();
+                    send(client, JOIN, held);
+                    send(client, PATCH, missing);
+                    send(client, PRESENCE, presence);
+                    return;
+                }
+                case OPAQUE_PARTS:
+                    // Kept before the patch that names them is merged or sent on,
+                    // so no client learns of a part it can't load.
+                    await this.#store.putOpaqueParts(this.#id, payload);
+                    return;
+                case PATCH:
+                    await session.merge(payload);
+                    this.#sendOn(client, PATCH, payload);
+                    this.#keepLog();
+                    return;
+                case PRESENCE:
+                    await session.mergePresence(payload);
+                    this.#sendOn(client, PRESENCE, payload);
+                    return;
+                default:
+                    client.close(CLOSE_PROTOCOL_ERROR, `no message is of kind ${kind}`);
+            }
+        }
+        catch (error) {
+            // What a client sent that the engine can't take ends that client
+            // alone; nothing of it was sent on or kept.
+            if (this.#ended)
+                return;
+            const [code, reason] = closeOf(error, true);
+            client.close(code, truncateReason(reason));
+        }
+    }
+    /** Send `payload` as `kind` to every joined client but `from`. */
+    #sendOn(from, kind, payload) {
+        for (const client of this.#joined)
+            if (client !== from)
+                send(client, kind, payload);
+    }
+    /** Once no client is connected or arriving, end it — unless one arrives while its log is written. */
+    #settleIfEmpty() {
+        if (this.#ended || this.#clients.size > 0 || this.#arriving > 0)
+            return;
+        void this.#logKept().then(() => {
+            if (this.#ended || this.#clients.size > 0 || this.#arriving > 0)
+                return;
+            this.#ended = true;
+            this.#onEnd(this);
+            this.#finish();
+        });
+    }
+    /** Write the log, now or after the write under way, which then takes this merge in too. */
+    #keepLog() {
+        this.#logBehind = true;
+        this.#logWriting ??= this.#writeLog().finally(() => (this.#logWriting = undefined));
+    }
+    async #writeLog() {
+        const session = await this.session;
+        while (this.#logBehind) {
+            this.#logBehind = false;
+            try {
+                await this.#store.putLog(this.#id, await session.snapshot());
+            }
+            catch (error) {
+                // A document deleted meanwhile has nothing to keep it for.
+                if (!this.#ended) {
+                    console.error(`udoc-server: document ${this.#id}'s edits could not be kept: ${messageOf(error)}`);
+                }
+            }
+        }
+    }
+    /** Settles once every merge so far is in the kept log. */
+    async #logKept() {
+        while (this.#logWriting)
+            await this.#logWriting;
+    }
+}
+/** Send `payload` to `client` as a message of `kind`. */
+function send(client, kind, payload) {
+    const message = new Uint8Array(payload.byteLength + 1);
+    message[0] = kind;
+    message.set(payload, 1);
+    client.send(message);
+}
+/** A close reason fits in a control frame: at most 123 bytes of UTF-8. */
+function truncateReason(reason) {
+    const bytes = new TextEncoder().encode(reason);
+    return bytes.byteLength <= 123 ? reason : `${new TextDecoder().decode(bytes.subarray(0, 120))}...`;
+}
+/**
+ * The close code and reason `error` calls for, picked by its code: a license
+ * refusal, or no such document; then, for a document that couldn't be opened,
+ * that; and once it is open, its session failing — `internal` or `crashed` —
+ * or else a payload the engine couldn't merge.
+ */
+function closeOf(error, opened) {
+    const { code, message } = failureOf(error);
+    if (LICENSE_CODES.has(code))
+        return [CLOSE_LICENSE_REFUSED, message];
+    if (code === "notFound")
+        return [CLOSE_NO_DOCUMENT, message];
+    if (!opened)
+        return [CLOSE_CANNOT_OPEN, message];
+    if (code === "internal" || code === "crashed")
+        return [CLOSE_SESSION_ENDED, message];
+    return [CLOSE_DID_NOT_MERGE, message];
+}
+//# sourceMappingURL=collaboration.js.map