edytor 1.0.0-rc.1 → 1.0.0-rc.3

package/README.md

@@ -17,7 +17,7 @@
 
 Edytor aims to be for Svelte what Slate.js is for React: a heavily customizable editor with an API to build any kind of collaborative rich text editor.
 
-> **Release candidate.** Edytor `1.0.0-rc.1` is the 1.0 release candidate (`edytor` on npm): its API is frozen, and a change to it before 1.0 is a listed breaking change. It has no production track record yet: read the [limitations](https://edytor.dev/docs/reference/limitations) before you build on it. Issues and PRs are welcome: when you report a bug, include the document's JSON value.
+> **Release candidate.** Edytor `1.0.0-rc.3` is the 1.0 release candidate (`edytor` on npm): its API is frozen, and a change to it before 1.0 is a listed breaking change. It has no production track record yet: read the [limitations](https://edytor.dev/docs/reference/limitations) before you build on it. Issues and PRs are welcome: when you report a bug, include the document's JSON value.
 
 ## Features
 

package/dist/block/block.svelte.js

@@ -117,10 +117,10 @@ export class Block {
         this.patchData({ ops: [{ path: [], value: data }] });
     };
     get selected() {
-        return this.edytor.selection.selectedBlocks.has(this);
+        return this.edytor.selection.isSelected(this);
     }
     get focused() {
-        return this.edytor.selection.focusedBlocks.has(this) && !this.selected;
+        return this.edytor.selection.isFocused(this) && !this.selected;
     }
     /** May this block move at all: `canPlace` without a destination (drag handles). */
     get movable() {
@@ -195,10 +195,24 @@ export class Block {
         return this.edytor.facade.isVisibleBlock(this.id);
     }
     get nextBlock() {
-        return this.parent ? this.parent.children[this.index + 1] : null;
+        return this.#sibling(1);
     }
     get previousBlock() {
-        return this.parent ? this.parent.children[this.index - 1] : null;
+        return this.#sibling(-1);
+    }
+    /**
+     * The sibling `step` places away (none past either end): one id read, no
+     * handle for every sibling (a top-level block's are the whole page's).
+     * Tracks what `parent` and `index` track: this block's cell and its
+     * parent's child list.
+     */
+    #sibling(step) {
+        const parent = this.parent;
+        if (!parent)
+            return null;
+        const ids = this.edytor.facade.childrenIds(parent.isRoot ? null : parent.id);
+        const id = ids[this.index + step];
+        return id === undefined ? null : this.edytor.idToBlock.block(id);
     }
     get closestPreviousBlock() {
         return this.edytor.blockBefore(this);
@@ -422,6 +436,8 @@ export class Block {
                 node.setAttribute(name, value);
         this.node = node;
         const release = this.edytor.surface.register(node, 'block', this.id);
+        // Its attributes follow its own selected and focused membership.
+        this.edytor.selection.keep(this);
         // A block laid out again with no commit moves the chrome beside it (the overlay measures).
         const unobserve = this.edytor.overlay.observe(node);
         const onDestroy = this.edytor.plugins.flatMap((plugin) => {

package/dist/clipboard/htmlFlow.d.ts

@@ -7,7 +7,12 @@ export type ImportKinds = Pick<Edytor, 'blocks' | 'marks'> & Partial<Pick<Edytor
     document: Pick<Edytor['document'], 'defaultChild'>;
 };
 type Values = Record<string, SerializableContent>;
-/** The tag a kind writes for `data`: its export form's first tag, else its element's, else its content element's. */
+/**
+ * The tag a kind writes for `data`: its export form's first tag, else its
+ * element's, else its content element's. A generic one (`div`, `span`) is
+ * none: an export form written as one (a callout's `<div data-edytor-callout>`)
+ * is found by its `parse` hook only.
+ */
 export declare const tagOf: (type: string, kind: BlockDefinition, data: Values) => string | undefined;
 /**
  * External HTML as a flow: the browser parses (inert: no script

package/dist/clipboard/htmlFlow.js

@@ -33,14 +33,21 @@ const isGlyph = (node) => {
 };
 /** Tags that carry no meaning of their own: a kind rendering one is not found by it. */
 const GENERIC = /^(div|span)$/;
-/** The tag a kind writes for `data`: its export form's first tag, else its element's, else its content element's. */
+/**
+ * The tag a kind writes for `data`: its export form's first tag, else its
+ * element's, else its content element's. A generic one (`div`, `span`) is
+ * none: an export form written as one (a callout's `<div data-edytor-callout>`)
+ * is found by its `parse` hook only.
+ */
 export const tagOf = (type, kind, data) => {
     const { html, element, contentElement } = kind;
     if (typeof html === 'string')
         return html;
     try {
-        if (html)
-            return /^<([a-z][\w-]*)/i.exec(html({ type, data }, '', ''))?.[1]?.toLowerCase();
+        if (html) {
+            const tag = /^<([a-z][\w-]*)/i.exec(html({ type, data }, '', ''))?.[1]?.toLowerCase();
+            return tag && !GENERIC.test(tag) ? tag : undefined;
+        }
     }
     catch {
         return undefined;
@@ -251,18 +258,24 @@ export const flowOfHtml = (kinds, html) => {
                 texts.add(current);
             }
         };
+        /** Whether a leading paragraph gave the element its text: one only, empty or not. */
+        let led = false;
         for (const node of element.childNodes)
             if (isVoid(node))
                 at.apart(node);
             else if (!isBlock(node))
                 inline(node, at, {}, pre);
-            // A leading plain paragraph is the element's own text (`<li><p>Item</p></li>`).
-            else if (!current.content.length &&
+            // A leading plain paragraph is the element's own text (`<li><p>Item</p></li>`,
+            // a callout's title): an empty one too, so the paragraph after it is a child.
+            else if (!led &&
+                !current.content.length &&
                 !current.children?.length &&
                 !kindOf(node) &&
-                !wraps(node))
+                !wraps(node)) {
+                led = true;
                 for (const child of node.childNodes)
                     inline(child, at, {}, pre);
+            }
             else
                 (current.children ??= []).push(...blockOf(node, childType));
         for (const part of texts)

package/dist/cloudflare/DocumentRoom.d.ts

@@ -47,7 +47,7 @@
  *   replace: those deletes wait with them, in memory); compaction keeps
  *   the pending records apart, and rewrites them as the deletes still
  *   waiting; a frame that discards a forged stamp drops them. At most
- *   {@link MAX_WAITING_DELETES} ranges wait, stored or in memory: a frame
+ *   `MAX_WAITING_DELETES` ranges wait, stored or in memory: a frame
  *   that would pass it has its waiting deletes dropped (refusal `waiting`,
  *   left out of the ack), the rest applied. Compaction reclaims the
  *   waiting deletes of client ids no user registered and no socket holds;
@@ -112,6 +112,7 @@ import type { CommitResult, ExportedBlocks, ImportReceipt, ImportRequest, LateEd
 import type { AwarenessEntry } from '../crdt/protocol.js';
 import type { DocumentSemanticsConfig, DocumentOperations, JSONBlock, JSONDoc, YDoc } from '../crdt/index.js';
 import type { CommentActor, CommentChange, CommentOutcome, CommentRequest, CommentSnapshot } from '../crdt/protocols/comments.js';
+export { closedSocket, COMMENTS_HEADER, DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, HISTORY_HEADER, HISTORY_KEY_HEADER, IDENTITY_HEADERS, MAX_REFUSALS, MAX_WAITING_DELETES, noTimers, PROBE_HEADER, PURGE_ORIGIN, RESTORE_ORIGIN, ROOM_ORIGIN, SOCKET_TAG } from './room/shared.js';
 /** Under SQLite-backed Durable Objects' 2 MB row cap, with room for the other columns. */
 export declare const DEFAULT_MAX_ROW_BYTES: number;
 /** Update records before the rows are merged into one snapshot. */
@@ -127,6 +128,8 @@ export declare const DEFAULT_SAVE_AFTER = 2000;
  * about 100 MB at worst. Raise it for documents of long text.
  */
 export declare const DEFAULT_MAX_DOCUMENT_BYTES: number;
+/** The share of the document quota past which the room logs its size, by default. */
+export declare const DEFAULT_DOCUMENT_WARNING = 0.8;
 /**
  * The largest frame a socket may send, reassembled from chunks: room for a
  * whole document at the default quota (a client seeding an empty room).
@@ -166,14 +169,6 @@ export declare const DEFAULT_MAX_PRESENCE_PER_SECOND = 50;
  * would send 50,000 frames a second.
  */
 export declare const DEFAULT_MAX_PRESENCE_FANOUT = 2000;
-/**
- * Delete ranges the room keeps waiting for items it does not hold (a
- * relayer's delete of an author's edit a restore lost). Every update the
- * engine applies re-reads them, so they are capped.
- */
-export declare const MAX_WAITING_DELETES = 1024;
-/** Refusals kept in `refusals` (the newest); `refusalCounts` counts every one. */
-export declare const MAX_REFUSALS = 100;
 /**
  * A client id and the user who owns it (the room's replica registry). An
  * empty `user` marks an id a restore without a registry left unowned: its
@@ -208,33 +203,6 @@ export type SavedDocument = {
 };
 /** What `onLoad` may return: JSON, a bare v14 update, or `{ update, replicas }` (a `SavedDocument`). */
 export type LoadedDocument = JSONDoc | Uint8Array | Pick<SavedDocument, 'update' | 'replicas'>;
-/** The header `routeDocumentSocket` sets on an authorized probe: `lastUpdated` or `snapshot`. */
-export declare const PROBE_HEADER = "X-Edytor-Probe";
-/** The transaction origin of the room's own edits (`transact`, `onLoad` seeds). */
-export declare const ROOM_ORIGIN: unique symbol;
-/** The transaction origin of a history restore: the room's restore history tracks it. */
-export declare const RESTORE_ORIGIN: unique symbol;
-/** The transaction origin of the room's purge: tracked by no history. */
-export declare const PURGE_ORIGIN: unique symbol;
-/** The header `routeDocumentHistory` sets on an authorized history request. */
-export declare const HISTORY_HEADER = "X-Edytor-History";
-/** The version key of a history `read` or `restore` request. */
-export declare const HISTORY_KEY_HEADER = "X-Edytor-History-Key";
-/** The header `routeDocumentComments` sets on an authorized comments request: `list` or `post`. */
-export declare const COMMENTS_HEADER = "X-Edytor-Comments";
-/**
- * Headers carrying the identity `routeDocumentSocket` verified — never the
- * client's. The user id is percent-encoded (`encodeURIComponent`): a header
- * value is trimmed and cannot carry every character, and a user id is any
- * string.
- */
-export declare const IDENTITY_HEADERS: {
-    readonly user: "X-Edytor-User";
-    readonly replica: "X-Edytor-Replica";
-    readonly access: "X-Edytor-Access";
-    /** When the credential expires, ms since the epoch (absent: never). */
-    readonly expires: "X-Edytor-Expires";
-};
 /**
  * Optional knobs (strings, as `vars` arrive): row size, outgoing frame
  * limit and compaction threshold. The defaults are the platform limits.
@@ -245,6 +213,8 @@ export type DocumentRoomEnv = {
     EDYTOR_COMPACT_AFTER?: string | number;
     EDYTOR_SAVE_AFTER?: string | number;
     EDYTOR_MAX_DOCUMENT_BYTES?: string | number;
+    /** The share of the document quota past which the room logs its size (`documentWarning`). */
+    EDYTOR_DOCUMENT_WARNING?: string | number;
     EDYTOR_MAX_INBOUND_FRAME_BYTES?: string | number;
     EDYTOR_MAX_BUFFERED_BYTES?: string | number;
     EDYTOR_MAX_UPDATES_PER_SECOND?: string | number;
@@ -324,6 +294,8 @@ export type Timing = {
 export type RoomMetrics = {
     /** The document's size as the document quota measures it: its records, uncompressed. */
     documentBytes: number;
+    /** The document quota (`maxDocumentBytes`): writes past it are refused (`4413`). */
+    documentLimit: number;
     /** What its rows take in storage (a snapshot compressed). */
     storedBytes: number;
     /** Logical records stored (the generation record included), and their rows. */
@@ -400,6 +372,11 @@ export type RoomLogEntry = {
     edytor: 'quota';
     user: string;
     quota: string;
+} | {
+    edytor: 'size';
+    bytes: number;
+    limit: number;
+    share: number;
 } | {
     edytor: 'denied';
     user: string;
@@ -434,15 +411,6 @@ export type RoomLogEntry = {
 };
 /** `pending`: deletes of items the room does not hold yet (they wait for them). */
 type RowKind = 'generation' | 'update' | 'snapshot' | 'pending';
-/**
- * An upgrade accepted and closed at once, so the client reads `code`: a
- * browser sees an HTTP error at the upgrade only as `1006`, which a
- * provider cannot tell from a network failure. Refuse a dial your Worker
- * turns away itself with it: the provider stops at `1008` or `4xxx`
- * (except `4401`, redialed), and redials after anything else (`CLOSE`,
- * `isRefusal` in `crdt/providers/room.ts`).
- */
-export declare const closedSocket: (code: number, reason: string) => Response;
 /** A stored record, reassembled: its kind, record number, bytes, and whether they are v2 (a v2 container's snapshot). */
 export type StoredRecord = {
     kind: RowKind;
@@ -450,8 +418,6 @@ export type StoredRecord = {
     bytes: Uint8Array<ArrayBuffer>;
     v2: boolean;
 };
-/** Run an entry point with timers forbidden — a pending timer keeps a Durable Object from hibernating. */
-export declare const noTimers: <T>(fn: () => T) => T;
 /** A block as `validate` reads it, before or after a frame. */
 export type ValidatedBlock = {
     id: string;
@@ -496,24 +462,20 @@ export type CommentOptions = {
     maxLength?: number;
     /**
      * The bytes the room's comments may hold (default
-     * {@link DEFAULT_MAX_COMMENT_BYTES}, 4 MiB): each body and quote in UTF-8
+     * `DEFAULT_MAX_COMMENT_BYTES`, 4 MiB): each body and quote in UTF-8
      * plus 128 a comment. A thread or reply past it is refused `413`; a
      * delete frees its bytes.
      */
     maxBytes?: number;
     /**
      * Comment requests per second (default
-     * {@link DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND}, a ten-second burst):
+     * `DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND`, a ten-second burst):
      * over HTTP per verified user (past it, `429`), and a socket's comment
      * messages per socket (past it, dropped). RPC calls are the host's own and
      * are not counted.
      */
     maxRequestsPerSecond?: number;
 };
-/** The bytes a room's comments hold at most, by default (4 MiB). */
-export declare const DEFAULT_MAX_COMMENT_BYTES: number;
-/** Comment requests per second and user (or socket), by default. */
-export declare const DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND = 2;
 /** What {@link attachRoom} (and `DocumentRoom`) takes. */
 export type AttachRoomOptions = {
     /**
@@ -544,6 +506,12 @@ export type AttachRoomOptions = {
     tablePrefix?: string;
     /** Largest document, in stored bytes (default {@link DEFAULT_MAX_DOCUMENT_BYTES}). */
     maxDocumentBytes?: number;
+    /**
+     * The share of `maxDocumentBytes` past which the room logs the
+     * document's size (`size`, once per crossing), above 0 and at most 1
+     * (default {@link DEFAULT_DOCUMENT_WARNING}, 0.8).
+     */
+    documentWarning?: number;
     /** Largest frame a socket may send, reassembled (default {@link DEFAULT_MAX_INBOUND_FRAME_BYTES}). */
     maxInboundFrameBytes?: number;
     /**
@@ -599,7 +567,8 @@ export type AttachRoomOptions = {
      */
     semantics?: DocumentSemanticsConfig;
     /**
-     * Version history in KV (`room.history.*`): the room writes its
+     * Version history, in the store `HistoryOptions.store` names (a KV namespace, an R2 bucket or
+     * the room's own storage): the room writes its
      * state twice a day — the morning's at local noon, the evening's at
      * midnight, in `timeZone` — when it changed, for `retentionDays`; read
      * and restore them with `listHistory`, `readHistory`, `restoreHistory`
@@ -622,8 +591,6 @@ export type AttachRoomOptions = {
      */
     comments?: CommentOptions | false;
 };
-/** The tag of the document's sockets: other sockets of the object are left to you. */
-export declare const SOCKET_TAG = "edytor";
 /**
  * One edytor document living in a Durable Object's storage: the room
  * logic, independent of the class that hosts it. Create it with
@@ -638,6 +605,7 @@ export declare class AttachedDocument {
     readonly compactAfter: number;
     readonly saveAfter: number;
     readonly maxDocumentBytes: number;
+    readonly documentWarning: number;
     readonly maxInboundFrameBytes: number;
     readonly maxBufferedBytes: number;
     readonly maxUpdatesPerSecond: number;
@@ -648,7 +616,7 @@ export declare class AttachedDocument {
     failure: Error | null;
     /** Latest presence entry per replica, for join snapshots (memory: refills after a wake). */
     presence: Map<number, E.AwarenessEntry>;
-    /** The newest {@link MAX_REFUSALS} refusals since this instance started (diagnostics; memory only). */
+    /** The newest `MAX_REFUSALS` refusals since this instance started (diagnostics; memory only). */
     refusals: Refusal[];
     /** Every refusal since this instance started, by reason. */
     refusalCounts: Partial<Record<Refusal['reason'], number>>;
@@ -746,7 +714,7 @@ export declare class AttachedDocument {
     };
     /**
      * When the room last stored a change (ms since the epoch), or `null`
-     * for a room that stored none since 0.1.0-next.23. Cheap: one
+     * for a room that stored none since it records the time. Cheap: one
      * row, no document. `routeDocumentSocket` answers it over HTTP
      * (`GET <room>?lastUpdated`), also over RPC.
      */
@@ -857,7 +825,7 @@ export declare class AttachedDocument {
     metrics(): RoomMetrics;
     /**
      * Drop every waiting delete, stored or in memory (callable over RPC):
-     * the way out when a writer filled {@link MAX_WAITING_DELETES} with
+     * the way out when a writer filled `MAX_WAITING_DELETES` with
      * deletes of registered ids' items, which compaction keeps. A dropped
      * delete's item shows if it ever arrives — but for an entry a waiting
      * rewrite replaces, which that rewrite deletes should it integrate.
@@ -1056,4 +1024,3 @@ export declare class DocumentRoom<Env = DocumentRoomEnv> extends DurableObject<E
     get origin(): AttachedDocument['origin'];
     records(): ReturnType<AttachedDocument['records']>;
 }
-export {};

package/dist/cloudflare/DocumentRoom.js

@@ -47,7 +47,7 @@
  *   replace: those deletes wait with them, in memory); compaction keeps
  *   the pending records apart, and rewrites them as the deletes still
  *   waiting; a frame that discards a forged stamp drops them. At most
- *   {@link MAX_WAITING_DELETES} ranges wait, stored or in memory: a frame
+ *   `MAX_WAITING_DELETES` ranges wait, stored or in memory: a frame
  *   that would pass it has its waiting deletes dropped (refusal `waiting`,
  *   left out of the ack), the rest applied. Compaction reclaims the
  *   waiting deletes of client ids no user registered and no socket holds;
@@ -120,6 +120,8 @@ import { ReplicaRegistry } from './room/replicas.js';
 import { Scheduler } from './room/scheduler.js';
 import { RoomStorage } from './room/storage.js';
 import { RoomValidation } from './room/validation.js';
+import { noTimers, SOCKET_TAG } from './room/shared.js';
+export { closedSocket, COMMENTS_HEADER, DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, HISTORY_HEADER, HISTORY_KEY_HEADER, IDENTITY_HEADERS, MAX_REFUSALS, MAX_WAITING_DELETES, noTimers, PROBE_HEADER, PURGE_ORIGIN, RESTORE_ORIGIN, ROOM_ORIGIN, SOCKET_TAG } from './room/shared.js';
 /** Under SQLite-backed Durable Objects' 2 MB row cap, with room for the other columns. */
 export const DEFAULT_MAX_ROW_BYTES = 2_000_000 - 4096;
 /** Update records before the rows are merged into one snapshot. */
@@ -135,6 +137,8 @@ export const DEFAULT_SAVE_AFTER = 2000;
  * about 100 MB at worst. Raise it for documents of long text.
  */
 export const DEFAULT_MAX_DOCUMENT_BYTES = 2 * 1024 * 1024;
+/** The share of the document quota past which the room logs its size, by default. */
+export const DEFAULT_DOCUMENT_WARNING = 0.8;
 /**
  * The largest frame a socket may send, reassembled from chunks: room for a
  * whole document at the default quota (a client seeding an empty room).
@@ -177,75 +181,6 @@ export const DEFAULT_MAX_PRESENCE_FANOUT = 2000;
 /** Seconds of the update rate a socket may spend at once. */
 /** The ceiling of a quota knob (a host may raise the defaults up to it). */
 const QUOTA_CEILING = 2 ** 40;
-/**
- * Delete ranges the room keeps waiting for items it does not hold (a
- * relayer's delete of an author's edit a restore lost). Every update the
- * engine applies re-reads them, so they are capped.
- */
-export const MAX_WAITING_DELETES = 1024;
-/** Refusals kept in `refusals` (the newest); `refusalCounts` counts every one. */
-export const MAX_REFUSALS = 100;
-/** The header `routeDocumentSocket` sets on an authorized probe: `lastUpdated` or `snapshot`. */
-export const PROBE_HEADER = 'X-Edytor-Probe';
-/** The transaction origin of the room's own edits (`transact`, `onLoad` seeds). */
-export const ROOM_ORIGIN = Symbol('edytor-room');
-/** The transaction origin of a history restore: the room's restore history tracks it. */
-export const RESTORE_ORIGIN = Symbol('edytor-restore');
-/** The transaction origin of the room's purge: tracked by no history. */
-export const PURGE_ORIGIN = Symbol('edytor-purge');
-/** The header `routeDocumentHistory` sets on an authorized history request. */
-export const HISTORY_HEADER = 'X-Edytor-History';
-/** The version key of a history `read` or `restore` request. */
-export const HISTORY_KEY_HEADER = 'X-Edytor-History-Key';
-/** The header `routeDocumentComments` sets on an authorized comments request: `list` or `post`. */
-export const COMMENTS_HEADER = 'X-Edytor-Comments';
-/**
- * Headers carrying the identity `routeDocumentSocket` verified — never the
- * client's. The user id is percent-encoded (`encodeURIComponent`): a header
- * value is trimmed and cannot carry every character, and a user id is any
- * string.
- */
-export const IDENTITY_HEADERS = {
-    user: 'X-Edytor-User',
-    replica: 'X-Edytor-Replica',
-    access: 'X-Edytor-Access',
-    /** When the credential expires, ms since the epoch (absent: never). */
-    expires: 'X-Edytor-Expires'
-};
-/**
- * An upgrade accepted and closed at once, so the client reads `code`: a
- * browser sees an HTTP error at the upgrade only as `1006`, which a
- * provider cannot tell from a network failure. Refuse a dial your Worker
- * turns away itself with it: the provider stops at `1008` or `4xxx`
- * (except `4401`, redialed), and redials after anything else (`CLOSE`,
- * `isRefusal` in `crdt/providers/room.ts`).
- */
-export const closedSocket = (code, reason) => {
-    const [client, server] = Object.values(new WebSocketPair());
-    server.accept();
-    server.close(code, reason);
-    return new Response(null, { status: 101, webSocket: client });
-};
-/** Run an entry point with timers forbidden — a pending timer keeps a Durable Object from hibernating. */
-export const noTimers = (fn) => {
-    const g = globalThis;
-    const saved = [g.setTimeout, g.setInterval];
-    const forbidden = () => {
-        throw new Error('room scheduled a timer (a Durable Object could not hibernate)');
-    };
-    g.setTimeout = forbidden;
-    g.setInterval = forbidden;
-    try {
-        return fn();
-    }
-    finally {
-        [g.setTimeout, g.setInterval] = saved;
-    }
-};
-/** The bytes a room's comments hold at most, by default (4 MiB). */
-export const DEFAULT_MAX_COMMENT_BYTES = 4 * 1024 * 1024;
-/** Comment requests per second and user (or socket), by default. */
-export const DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND = 2;
 /** `EDYTOR_PURGE_AFTER_DAYS`: `off` (or `false`) never purges; a number of days; anything else the default. */
 const purgeAfterDays = (value) => {
     if (value === 'off' || value === 'false' || value === false)
@@ -253,8 +188,6 @@ const purgeAfterDays = (value) => {
     const n = Number(value);
     return Number.isInteger(n) && n > 0 ? n : undefined;
 };
-/** The tag of the document's sockets: other sockets of the object are left to you. */
-export const SOCKET_TAG = 'edytor';
 /**
  * One edytor document living in a Durable Object's storage: the room
  * logic, independent of the class that hosts it. Create it with
@@ -269,6 +202,7 @@ export class AttachedDocument {
     compactAfter;
     saveAfter;
     maxDocumentBytes;
+    documentWarning;
     maxInboundFrameBytes;
     maxBufferedBytes;
     maxUpdatesPerSecond;
@@ -279,7 +213,7 @@ export class AttachedDocument {
     failure = null;
     /** Latest presence entry per replica, for join snapshots (memory: refills after a wake). */
     presence = new Map();
-    /** The newest {@link MAX_REFUSALS} refusals since this instance started (diagnostics; memory only). */
+    /** The newest `MAX_REFUSALS` refusals since this instance started (diagnostics; memory only). */
     refusals = [];
     /** Every refusal since this instance started, by reason. */
     refusalCounts = {};
@@ -294,6 +228,8 @@ export class AttachedDocument {
         this.compactAfter = knob(options.compactAfter, DEFAULT_COMPACT_AFTER, 1e9);
         this.saveAfter = knob(options.saveAfter, DEFAULT_SAVE_AFTER, 1e9);
         this.maxDocumentBytes = knob(options.maxDocumentBytes, DEFAULT_MAX_DOCUMENT_BYTES, QUOTA_CEILING);
+        const warning = Number(options.documentWarning);
+        this.documentWarning = warning > 0 && warning <= 1 ? warning : DEFAULT_DOCUMENT_WARNING;
         this.maxInboundFrameBytes = knob(options.maxInboundFrameBytes, DEFAULT_MAX_INBOUND_FRAME_BYTES, QUOTA_CEILING);
         this.maxBufferedBytes = Math.max(this.maxInboundFrameBytes, knob(options.maxBufferedBytes, 2 * this.maxInboundFrameBytes, QUOTA_CEILING));
         this.maxUpdatesPerSecond = knob(options.maxUpdatesPerSecond, DEFAULT_MAX_UPDATES_PER_SECOND, QUOTA_CEILING);
@@ -427,7 +363,7 @@ export class AttachedDocument {
     }
     /**
      * When the room last stored a change (ms since the epoch), or `null`
-     * for a room that stored none since 0.1.0-next.23. Cheap: one
+     * for a room that stored none since it records the time. Cheap: one
      * row, no document. `routeDocumentSocket` answers it over HTTP
      * (`GET <room>?lastUpdated`), also over RPC.
      */
@@ -561,6 +497,7 @@ export class AttachedDocument {
             const { counters } = room;
             return {
                 documentBytes: room.storage.documentBytes,
+                documentLimit: room.limits.maxDocumentBytes,
                 storedBytes: stored?.bytes ?? 0,
                 records: stored?.records ?? 0,
                 rows: stored?.rows ?? 0,
@@ -582,7 +519,7 @@ export class AttachedDocument {
     }
     /**
      * Drop every waiting delete, stored or in memory (callable over RPC):
-     * the way out when a writer filled {@link MAX_WAITING_DELETES} with
+     * the way out when a writer filled `MAX_WAITING_DELETES` with
      * deletes of registered ids' items, which compaction keeps. A dropped
      * delete's item shows if it ever arrives — but for an entry a waiting
      * rewrite replaces, which that rewrite deletes should it integrate.
@@ -718,6 +655,7 @@ export class DocumentRoom extends DurableObject {
             compactAfter: Number(knobs.EDYTOR_COMPACT_AFTER),
             saveAfter: Number(knobs.EDYTOR_SAVE_AFTER),
             maxDocumentBytes: Number(knobs.EDYTOR_MAX_DOCUMENT_BYTES),
+            documentWarning: Number(knobs.EDYTOR_DOCUMENT_WARNING),
             maxInboundFrameBytes: Number(knobs.EDYTOR_MAX_INBOUND_FRAME_BYTES),
             maxBufferedBytes: Number(knobs.EDYTOR_MAX_BUFFERED_BYTES),
             maxUpdatesPerSecond: Number(knobs.EDYTOR_MAX_UPDATES_PER_SECOND),

package/dist/cloudflare/history.d.ts

@@ -200,8 +200,8 @@ export declare const historyEntry: (room: string, name: string, metadata: unknow
  * Versions in a Workers KV namespace (the room history's first store): KV's
  * TTL expires them (`nativeTtl`, `expirationTtl` = the retention, at least
  * KV's 60 s), its listing's `expiration` is each one's `expiresAt`, its
- * metadata the room's. Values up to KV's 25 MiB. Versions written by
- * 0.1.0-next.24 and next.25 (a bare namespace as the store) read as they are.
+ * metadata the room's. Values up to KV's 25 MiB. Versions written by the
+ * pre-releases that took a bare namespace as the store read as they are.
  */
 export declare const kvHistory: (namespace: KVLike) => HistoryStore;
 /**

package/dist/cloudflare/history.js

@@ -145,8 +145,8 @@ const finite = (value) => {
  * Versions in a Workers KV namespace (the room history's first store): KV's
  * TTL expires them (`nativeTtl`, `expirationTtl` = the retention, at least
  * KV's 60 s), its listing's `expiration` is each one's `expiresAt`, its
- * metadata the room's. Values up to KV's 25 MiB. Versions written by
- * 0.1.0-next.24 and next.25 (a bare namespace as the store) read as they are.
+ * metadata the room's. Values up to KV's 25 MiB. Versions written by the
+ * pre-releases that took a bare namespace as the store read as they are.
  */
 export const kvHistory = (namespace) => ({
     maxValueBytes: HISTORY_MAX_VALUE_BYTES,

package/dist/cloudflare/index.d.ts

@@ -4,7 +4,7 @@
  * `cloudflare:workers`); built on the Worker-safe CRDT entry. Documented in
  * the site's `server/` section (room, authorization, extending, protocol).
  */
-export { DocumentRoom, AttachedDocument, attachRoom, SOCKET_TAG, closedSocket, type AttachRoomOptions, type CommentOptions, DEFAULT_COMPACT_AFTER, DEFAULT_MAX_ROW_BYTES, DEFAULT_SAVE_AFTER, DEFAULT_MAX_DOCUMENT_BYTES, DEFAULT_MAX_INBOUND_FRAME_BYTES, DEFAULT_MAX_BUFFERED_BYTES, DEFAULT_MAX_UPDATES_PER_SECOND, DEFAULT_MAX_PRESENCE_BYTES, DEFAULT_MAX_PRESENCE_PER_SECOND, DEFAULT_MAX_PRESENCE_FANOUT, DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, MAX_REFUSALS, MAX_WAITING_DELETES, ROOM_ORIGIN, RESTORE_ORIGIN, PURGE_ORIGIN, IDENTITY_HEADERS, PROBE_HEADER, noTimers, type Attachment, type DocumentRoomEnv, type LoadedDocument, type Refusal, type ReplicaOwner, type SavedDocument, type SocketIdentity, type StoredRecord, type FrameValidation, type ValidatedBlock, type RoomMetrics, type RoomLogEntry, type RestoreResult, type Timing } from './DocumentRoom.js';
+export { DocumentRoom, AttachedDocument, attachRoom, SOCKET_TAG, closedSocket, type AttachRoomOptions, type CommentOptions, DEFAULT_COMPACT_AFTER, DEFAULT_MAX_ROW_BYTES, DEFAULT_SAVE_AFTER, DEFAULT_MAX_DOCUMENT_BYTES, DEFAULT_DOCUMENT_WARNING, DEFAULT_MAX_INBOUND_FRAME_BYTES, DEFAULT_MAX_BUFFERED_BYTES, DEFAULT_MAX_UPDATES_PER_SECOND, DEFAULT_MAX_PRESENCE_BYTES, DEFAULT_MAX_PRESENCE_PER_SECOND, DEFAULT_MAX_PRESENCE_FANOUT, DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, MAX_REFUSALS, MAX_WAITING_DELETES, ROOM_ORIGIN, RESTORE_ORIGIN, PURGE_ORIGIN, IDENTITY_HEADERS, PROBE_HEADER, noTimers, type Attachment, type DocumentRoomEnv, type LoadedDocument, type Refusal, type ReplicaOwner, type SavedDocument, type SocketIdentity, type StoredRecord, type FrameValidation, type ValidatedBlock, type RoomMetrics, type RoomLogEntry, type RestoreResult, type Timing } from './DocumentRoom.js';
 export { DEFAULT_RETENTION_DAYS, HISTORY_MAX_VALUE_BYTES, R2_HISTORY_MAX_VALUE_BYTES, ROOM_HISTORY_MAX_BYTES, ROOM_HISTORY_MAX_VALUE_BYTES, kvHistory, r2History, roomHistory, type HistoryEntry, type HistoryMetadata, type HistoryOptions, type HistoryRoomStorage, type HistoryStore, type HistoryStoreFactory, type HistoryStoreRecord, type KVLike, type R2BucketLike } from './history.js';
 export { type PurgeReport } from '../crdt/purge.js';
 export { COMMENT_ROW_BYTES, COMMENT_STATUS, MAX_COMMENT_LENGTH, MAX_COMMENTS_PER_THREAD, MAX_THREADS, commentAnchors, commentBytes, decideComment, type ThreadComment, type CommentActor, type CommentChange, type CommentOutcome, type CommentRefusal, type CommentRequest, type CommentRun, type CommentSnapshot, type CommentThread } from '../crdt/protocols/comments.js';

package/dist/cloudflare/index.js

@@ -4,7 +4,7 @@
  * `cloudflare:workers`); built on the Worker-safe CRDT entry. Documented in
  * the site's `server/` section (room, authorization, extending, protocol).
  */
-export { DocumentRoom, AttachedDocument, attachRoom, SOCKET_TAG, closedSocket, DEFAULT_COMPACT_AFTER, DEFAULT_MAX_ROW_BYTES, DEFAULT_SAVE_AFTER, DEFAULT_MAX_DOCUMENT_BYTES, DEFAULT_MAX_INBOUND_FRAME_BYTES, DEFAULT_MAX_BUFFERED_BYTES, DEFAULT_MAX_UPDATES_PER_SECOND, DEFAULT_MAX_PRESENCE_BYTES, DEFAULT_MAX_PRESENCE_PER_SECOND, DEFAULT_MAX_PRESENCE_FANOUT, DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, MAX_REFUSALS, MAX_WAITING_DELETES, ROOM_ORIGIN, RESTORE_ORIGIN, PURGE_ORIGIN, IDENTITY_HEADERS, PROBE_HEADER, noTimers } from './DocumentRoom.js';
+export { DocumentRoom, AttachedDocument, attachRoom, SOCKET_TAG, closedSocket, DEFAULT_COMPACT_AFTER, DEFAULT_MAX_ROW_BYTES, DEFAULT_SAVE_AFTER, DEFAULT_MAX_DOCUMENT_BYTES, DEFAULT_DOCUMENT_WARNING, DEFAULT_MAX_INBOUND_FRAME_BYTES, DEFAULT_MAX_BUFFERED_BYTES, DEFAULT_MAX_UPDATES_PER_SECOND, DEFAULT_MAX_PRESENCE_BYTES, DEFAULT_MAX_PRESENCE_PER_SECOND, DEFAULT_MAX_PRESENCE_FANOUT, DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, MAX_REFUSALS, MAX_WAITING_DELETES, ROOM_ORIGIN, RESTORE_ORIGIN, PURGE_ORIGIN, IDENTITY_HEADERS, PROBE_HEADER, noTimers } from './DocumentRoom.js';
 export { DEFAULT_RETENTION_DAYS, HISTORY_MAX_VALUE_BYTES, R2_HISTORY_MAX_VALUE_BYTES, ROOM_HISTORY_MAX_BYTES, ROOM_HISTORY_MAX_VALUE_BYTES, kvHistory, r2History, roomHistory } from './history.js';
 export {} from '../crdt/purge.js';
 export { COMMENT_ROW_BYTES, COMMENT_STATUS, MAX_COMMENT_LENGTH, MAX_COMMENTS_PER_THREAD, MAX_THREADS, commentAnchors, commentBytes, decideComment } from '../crdt/protocols/comments.js';

package/dist/cloudflare/room/access.js

@@ -6,7 +6,7 @@
  * revocation, a changed access, an expired credential.
  */
 import { CLOSE } from '../../crdt/providers/room.js';
-import { COMMENTS_HEADER, HISTORY_HEADER, HISTORY_KEY_HEADER, IDENTITY_HEADERS, PROBE_HEADER, SOCKET_TAG, closedSocket, noTimers } from '../DocumentRoom.js';
+import { COMMENTS_HEADER, HISTORY_HEADER, HISTORY_KEY_HEADER, IDENTITY_HEADERS, PROBE_HEADER, SOCKET_TAG, closedSocket, noTimers } from './shared.js';
 import { STORAGE_FAILURE } from './context.js';
 import { readOnlyFrame, step1Frame } from './frames.js';
 import { StorageFault } from './replicas.js';

package/dist/cloudflare/room/admission.js

@@ -12,7 +12,7 @@
 import { Y } from '../../crdt/engine.js';
 import * as E from '../../crdt/protocol.js';
 import { ChunkLimitError, ChunkSequenceError, CLOSE } from '../../crdt/providers/room.js';
-import { MAX_WAITING_DELETES, noTimers } from '../DocumentRoom.js';
+import { MAX_WAITING_DELETES, noTimers } from './shared.js';
 import { STORAGE_FAILURE, now, sync, tally } from './context.js';
 import { attributionWrites, BINDING_PREFIX, forgedAttributionDeletes, forgedDeletes, forgedWriters } from './forged.js';
 import { MalformedFrame, decode, readOnlyDenialFrame, savedFrame, step1Frame, storedStep2, updateFrame } from './frames.js';

package/dist/cloudflare/room/comments.d.ts

@@ -8,7 +8,7 @@
  */
 import * as E from '../../crdt/protocol.js';
 import { type CommentActor, type CommentOutcome, type CommentRequest, type CommentSnapshot } from '../../crdt/protocols/comments.js';
-import { type Attachment, type SocketIdentity } from '../DocumentRoom.js';
+import type { Attachment, SocketIdentity } from '../DocumentRoom.js';
 import { type RoomContext } from './context.js';
 /** The largest request body `routeDocumentComments` forwards, in bytes. */
 export declare const MAX_COMMENT_REQUEST_BYTES: number;

package/dist/cloudflare/room/comments.js

@@ -8,7 +8,7 @@
  */
 import * as E from '../../crdt/protocol.js';
 import { COMMENT_MARK, COMMENT_ROW_BYTES, COMMENT_STATUS, commentAnchors, decideComment, OVER_BYTE_QUOTA, parseCommentRequest, validCommentId } from '../../crdt/protocols/comments.js';
-import { DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, SOCKET_TAG, noTimers } from '../DocumentRoom.js';
+import { DEFAULT_MAX_COMMENT_BYTES, DEFAULT_MAX_COMMENT_REQUESTS_PER_SECOND, SOCKET_TAG, noTimers } from './shared.js';
 import { allowance } from './admission.js';
 import { knob } from './context.js';
 import { decode } from './frames.js';

package/dist/cloudflare/room/context.d.ts

@@ -10,7 +10,7 @@
 import { Y } from '../../crdt/engine.js';
 import * as E from '../../crdt/protocol.js';
 import type { DocumentSemanticsConfig, EdytorDoc, JSONDoc, YDoc } from '../../crdt/index.js';
-import { type AttachRoomOptions, type AttachedDocument, type Refusal, type RoomLogEntry, type Timing } from '../DocumentRoom.js';
+import type { AttachRoomOptions, AttachedDocument, Refusal, RoomLogEntry, Timing } from '../DocumentRoom.js';
 import type { RoomAccess } from './access.js';
 import type { Admission } from './admission.js';
 import type { RoomComments } from './comments.js';
@@ -685,6 +685,7 @@ export type RoomLimits = Readonly<{
     compactAfter: number;
     saveAfter: number;
     maxDocumentBytes: number;
+    documentWarning: number;
     maxInboundFrameBytes: number;
     maxBufferedBytes: number;
     maxUpdatesPerSecond: number;

package/dist/cloudflare/room/context.js

@@ -12,7 +12,7 @@ import * as E from '../../crdt/protocol.js';
 import { CLOSE } from '../../crdt/providers/room.js';
 import { asEngineDoc } from '../../crdt/structs.js';
 import { defaultSemantics, facadeConfigOf, semanticsDigest } from '../../crdt/semantics.js';
-import { MAX_REFUSALS, ROOM_ORIGIN, SOCKET_TAG, noTimers } from '../DocumentRoom.js';
+import { MAX_REFUSALS, ROOM_ORIGIN, SOCKET_TAG, noTimers } from './shared.js';
 /** The engine API the room is built on (the Worker-safe CRDT entry). */
 export const crdt = E.bindCrdt(Y);
 export const sync = crdt.sync;