edytor 4.0.0 → 5.0.0

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

@@ -28,7 +28,7 @@ export declare const crdt: {
     Awareness: typeof import("../../index.js").Awareness;
     doc: {
         SCHEMA: {
-            readonly version: 10;
+            readonly version: 11;
             readonly name: "edytor-doc";
             readonly roots: {
                 readonly registry: "blocks";
@@ -39,7 +39,7 @@ export declare const crdt: {
                 readonly schema: "schema";
             };
         };
-        SCHEMA_VERSION: 10;
+        SCHEMA_VERSION: 11;
         SCHEMA_NAME: "edytor-doc";
         META_KEY: "meta";
         init: (doc: E.EngineDoc, opts?: {
@@ -55,48 +55,36 @@ export declare const crdt: {
         assertSchema: (doc: E.EngineDoc, docName?: string) => void;
         SchemaMismatchError: typeof E.SchemaMismatchError;
         create: (doc: E.EngineDoc, config?: import("../../crdt/edytor-doc.js").EdytorDocConfig) => {
-            prepare: {
-                insertFlow: (target: import("../../index.js").FlowTarget, flow: import("../../index.js").Flow, view?: import("../../index.js").FlowView) => import("../../index.js").Prepared;
-                deleteRange: (from: import("../../index.js").DocPosition, to: import("../../index.js").DocPosition, view?: import("../../index.js").RangeView) => import("../../index.js").Prepared;
-                replaceRange: (from: import("../../index.js").DocPosition, to: import("../../index.js").DocPosition, view?: import("../../index.js").RangeView) => import("../../index.js").Prepared;
-                insertBlocks: (dest: import("../../index.js").Destination, specs: readonly (import("../../index.js").BlockSpec | import("../../index.js").JSONBlock)[]) => import("../../index.js").Prepared;
-                moveBlocks: (ids: readonly import("../../index.js").BlockId[], dest: import("../../index.js").Destination) => import("../../index.js").Prepared;
-                nestBlock: (id: import("../../index.js").BlockId, parent: import("../../index.js").BlockId) => import("../../index.js").Prepared;
-                unNestBlock: (id: import("../../index.js").BlockId) => import("../../index.js").Prepared;
-                unNestBlocks: (ids: readonly import("../../index.js").BlockId[]) => import("../../index.js").Prepared;
-                liftOut: (id: import("../../index.js").BlockId, kind: string, { keep, after }?: {
-                    keep?: boolean;
-                    after?: readonly import("../../index.js").BlockSpec[];
-                }) => import("../../index.js").Prepared;
-                placeBeside: (ids: readonly import("../../index.js").BlockId[], target: import("../../index.js").BlockId, side: "left" | "right", kind?: string) => import("../../index.js").Prepared;
-                wrapInLayout: (ids: readonly import("../../index.js").BlockId[], kind?: string, columns?: number) => import("../../index.js").Prepared;
-                splitBlock: (id: import("../../index.js").BlockId, offset: number, newId: import("../../index.js").BlockId, tail?: import("../../index.js").SplitTail) => import("../../index.js").Prepared;
-                mergeBlocks: (fromId: import("../../index.js").BlockId, intoId: import("../../index.js").BlockId) => import("../../index.js").Prepared;
-                mergeBackward: (id: import("../../index.js").BlockId) => import("../../index.js").Prepared;
-                mergeForward: (id: import("../../index.js").BlockId) => import("../../index.js").Prepared;
-                deleteBlock: (id: import("../../index.js").BlockId, opts?: {
-                    keepChildren?: boolean;
-                }) => import("../../index.js").Prepared;
-                setBlock: (id: import("../../index.js").BlockId, value: {
-                    type?: string;
-                    data?: Record<string, unknown>;
-                    content?: (import("../../index.js").ContentItem | import("../../index.js").JSONText | import("../../index.js").JSONInlineBlock)[];
-                    children?: (import("../../index.js").BlockSpec | import("../../index.js").JSONBlock)[];
-                }) => import("../../index.js").Prepared;
-                setBlockType: (id: import("../../index.js").BlockId, type: string) => import("../../index.js").Prepared;
-                patchData: (target: import("../../index.js").DataTarget, patches: readonly import("../../index.js").DataPatch[]) => import("../../index.js").Prepared;
-                duplicateBlock: (id: import("../../index.js").BlockId, freshId?: (oldId: string, kind: "block" | "inline") => string) => import("../../index.js").Prepared;
-                insertText: (id: import("../../index.js").BlockId, offset: number, text: string, marks?: Record<string, unknown>) => import("../../index.js").Prepared;
-                deleteText: (id: import("../../index.js").BlockId, offset: number, length: number) => import("../../index.js").Prepared;
-                formatRange: (id: import("../../index.js").BlockId, offset: number, length: number, marks: Record<string, unknown>) => import("../../index.js").Prepared;
-                clearMarks: (id: import("../../index.js").BlockId, offset: number, length: number) => import("../../index.js").Prepared;
-                insertInline: (id: import("../../index.js").BlockId, offset: number, atom: import("../../crdt/doc/content.js").NewInline) => import("../../index.js").Prepared;
-                removeInline: (id: import("../../index.js").BlockId, inlineId: string) => import("../../index.js").Prepared;
-                deleteBlocks: (ids: readonly import("../../index.js").BlockId[]) => import("../../index.js").Prepared;
-            };
-            apply: (p: import("../../index.js").Prepared) => import("../../index.js").OpResult;
-            compose: (...parts: import("../../index.js").Prepared[]) => import("../../index.js").Prepared;
-            transact: <R>(fn: () => R, origin?: unknown) => R;
+            init: (opts?: Parameters<(doc: E.EngineDoc, opts?: {
+                content?: import("../../index.js").BlockSpec[];
+                defaultType?: string;
+            }) => void>[1]) => void;
+            seed: (value: import("../../index.js").JSONBlock[], data?: import("../../crdt/doc/types.js").JsonObj) => void;
+            isInitialized: () => boolean;
+            schemaVersion: () => number | undefined;
+            checkSchema: () => E.SchemaProblem | null;
+            assertSchema: () => void;
+            dispose: () => void;
+            createUndoManager: (options?: import("../../crdt/doc/history.js").HistoryOptions) => import("../../crdt/doc/history.js").UndoManager;
+            part: import("../../crdt/doc/suggest.js").SuggestContext;
+            childSlots: (parent: import("../../index.js").BlockId | null) => import("../../crdt/placement/model.js").ChildSlot[];
+            slotOf: (id: string) => {
+                parent: import("../../index.js").BlockId | null;
+                rank: string;
+            } | null;
+            crdtId: (id: string) => string | null;
+            resolveBlock: (id: string) => E.EngineNode | null;
+            followUndo: (anchor: import("../../index.js").DocAnchor) => import("../../index.js").DocAnchor;
+            rolesChanged: (place?: boolean) => void;
+            defaultChild: (id: string | null) => string;
+            contentJSON: (id: string) => ({
+                text: string;
+                marks?: Record<string, unknown>;
+            } | {
+                id?: string;
+                type: string;
+                data?: unknown;
+            })[];
             model: {
                 REGISTRY_KEY: string;
                 registryOf: (doc: E.EngineDoc) => E.EngineNode;
@@ -166,64 +154,94 @@ export declare const crdt: {
                 };
             };
             runsView: import("../../crdt/text/runs.js").RunView;
+            api: object;
+        } & {
+            prepare: {
+                insertFlow: (target: import("../../index.js").FlowTarget, flow: import("../../index.js").Flow, view?: import("../../index.js").FlowView) => import("../../index.js").Prepared;
+                deleteRange: (from: import("../../index.js").DocPosition, to: import("../../index.js").DocPosition, view?: import("../../index.js").RangeView) => import("../../index.js").Prepared;
+                replaceRange: (from: import("../../index.js").DocPosition, to: import("../../index.js").DocPosition, view?: import("../../index.js").RangeView) => import("../../index.js").Prepared;
+                nestBlock: (id: import("../../index.js").BlockId, parent: import("../../index.js").BlockId) => import("../../index.js").Prepared;
+                deleteBlocks: (ids: readonly import("../../index.js").BlockId[]) => import("../../index.js").Prepared;
+                insertText: (id: import("../../index.js").BlockId, offset: number, text: string, marks?: Record<string, unknown>) => import("../../index.js").Prepared;
+                deleteText: (id: import("../../index.js").BlockId, offset: number, length: number) => import("../../index.js").Prepared;
+                formatRange: (id: import("../../index.js").BlockId, offset: number, length: number, marks: Record<string, unknown>) => import("../../index.js").Prepared;
+                clearMarks: (id: import("../../index.js").BlockId, offset: number, length: number) => import("../../index.js").Prepared;
+                insertInline: (id: import("../../index.js").BlockId, offset: number, atom: import("../../crdt/doc/content.js").NewInline) => import("../../index.js").Prepared;
+                removeInline: (id: import("../../index.js").BlockId, inlineId: string) => import("../../index.js").Prepared;
+                setBlockType: (id: import("../../index.js").BlockId, type: string) => import("../../index.js").Prepared;
+                patchData: (target: import("../../index.js").DataTarget, patches: readonly import("../../index.js").DataPatch[]) => import("../../index.js").Prepared;
+                setBlock: (id: import("../../index.js").BlockId, value: {
+                    type?: string;
+                    data?: Record<string, unknown>;
+                    content?: (import("../../index.js").ContentItem | import("../../index.js").JSONText | import("../../index.js").JSONInlineBlock)[];
+                    children?: (import("../../index.js").BlockSpec | import("../../index.js").JSONBlock)[];
+                }) => import("../../index.js").Prepared;
+                deleteBlock: (id: import("../../index.js").BlockId, opts?: {
+                    keepChildren?: boolean;
+                }) => import("../../index.js").Prepared;
+                splitBlock: (id: import("../../index.js").BlockId, offset: number, newId: import("../../index.js").BlockId, tail?: import("../../index.js").SplitTail) => import("../../index.js").Prepared;
+                mergeBlocks: (fromId: import("../../index.js").BlockId, intoId: import("../../index.js").BlockId) => import("../../index.js").Prepared;
+                mergeBackward: (id: import("../../index.js").BlockId) => import("../../index.js").Prepared;
+                mergeForward: (id: import("../../index.js").BlockId) => import("../../index.js").Prepared;
+                placeBeside: (ids: readonly import("../../index.js").BlockId[], target: import("../../index.js").BlockId, side: "left" | "right", kind?: string) => import("../../index.js").Prepared;
+                wrapInLayout: (ids: readonly import("../../index.js").BlockId[], kind?: string, columns?: number) => import("../../index.js").Prepared;
+                insertBlocks: (dest: import("../../index.js").Destination, specs: readonly (import("../../index.js").BlockSpec | import("../../index.js").JSONBlock)[]) => import("../../index.js").Prepared;
+                moveBlocks: (ids: readonly import("../../index.js").BlockId[], dest: import("../../index.js").Destination) => import("../../index.js").Prepared;
+                unNestBlocks: (ids: readonly import("../../index.js").BlockId[]) => import("../../index.js").Prepared;
+                unNestBlock: (id: import("../../index.js").BlockId) => import("../../index.js").Prepared;
+                liftOut: (id: import("../../index.js").BlockId, kind: string, { keep, after }?: {
+                    keep?: boolean;
+                    after?: readonly import("../../index.js").BlockSpec[];
+                }) => import("../../index.js").Prepared;
+                duplicateBlock: (id: import("../../index.js").BlockId, freshId?: (oldId: string, kind: "block" | "inline") => string) => import("../../index.js").Prepared;
+            };
+            apply: (p: import("../../index.js").Prepared, quiet?: boolean) => import("../../index.js").OpResult;
+            compose: (...parts: import("../../index.js").Prepared[]) => import("../../index.js").Prepared;
+            transact: <R>(fn: () => R, origin?: unknown) => R;
             version: number;
             insertFlow: (target: import("../../index.js").FlowTarget, flow: import("../../index.js").Flow, view?: import("../../index.js").FlowView | undefined) => import("../../index.js").OpResult;
             deleteRange: (from: import("../../index.js").DocPosition, to: import("../../index.js").DocPosition, view?: import("../../index.js").RangeView | undefined) => import("../../index.js").OpResult;
             replaceRange: (from: import("../../index.js").DocPosition, to: import("../../index.js").DocPosition, view?: import("../../index.js").RangeView | undefined) => import("../../index.js").OpResult;
-            insertBlocks: (dest: import("../../index.js").Destination, specs: readonly (import("../../index.js").BlockSpec | import("../../index.js").JSONBlock)[]) => import("../../index.js").OpResult;
-            moveBlocks: (ids: readonly string[], dest: import("../../index.js").Destination) => import("../../index.js").OpResult;
             nestBlock: (id: string, parent: string) => import("../../index.js").OpResult;
-            unNestBlock: (id: string) => import("../../index.js").OpResult;
-            unNestBlocks: (ids: readonly string[]) => import("../../index.js").OpResult;
-            liftOut: (id: string, kind: string, args_2?: {
-                keep?: boolean;
-                after?: readonly import("../../index.js").BlockSpec[];
-            } | undefined) => import("../../index.js").OpResult;
-            placeBeside: (ids: readonly string[], target: string, side: "left" | "right", kind?: string | undefined) => import("../../index.js").OpResult;
-            wrapInLayout: (ids: readonly string[], kind?: string | undefined, columns?: number | undefined) => import("../../index.js").OpResult;
-            splitBlock: (id: string, offset: number, newId: string, tail?: import("../../index.js").SplitTail | undefined) => import("../../index.js").OpResult;
-            mergeBlocks: (fromId: string, intoId: string) => import("../../index.js").OpResult;
-            mergeBackward: (id: string) => import("../../index.js").OpResult;
-            mergeForward: (id: string) => import("../../index.js").OpResult;
-            deleteBlock: (id: string, opts?: {
-                keepChildren?: boolean;
-            } | undefined) => import("../../index.js").OpResult;
+            deleteBlocks: (ids: readonly string[]) => import("../../index.js").OpResult;
+            insertText: (id: string, offset: number, text: string, marks?: Record<string, unknown> | undefined) => import("../../index.js").OpResult;
+            deleteText: (id: string, offset: number, length: number) => import("../../index.js").OpResult;
+            formatRange: (id: string, offset: number, length: number, marks: Record<string, unknown>) => import("../../index.js").OpResult;
+            clearMarks: (id: string, offset: number, length: number) => import("../../index.js").OpResult;
+            insertInline: (id: string, offset: number, atom: import("../../crdt/doc/content.js").NewInline) => import("../../index.js").OpResult;
+            removeInline: (id: string, inlineId: string) => import("../../index.js").OpResult;
+            setBlockType: (id: string, type: string) => import("../../index.js").OpResult;
+            patchData: (target: import("../../index.js").DataTarget, patches: readonly import("../../index.js").DataPatch[]) => import("../../index.js").OpResult;
             setBlock: (id: string, value: {
                 type?: string;
                 data?: Record<string, unknown>;
                 content?: (import("../../index.js").ContentItem | import("../../index.js").JSONText | import("../../index.js").JSONInlineBlock)[];
                 children?: (import("../../index.js").BlockSpec | import("../../index.js").JSONBlock)[];
             }) => import("../../index.js").OpResult;
-            setBlockType: (id: string, type: string) => import("../../index.js").OpResult;
-            patchData: (target: import("../../index.js").DataTarget, patches: readonly import("../../index.js").DataPatch[]) => import("../../index.js").OpResult;
+            deleteBlock: (id: string, opts?: {
+                keepChildren?: boolean;
+            } | undefined) => import("../../index.js").OpResult;
+            splitBlock: (id: string, offset: number, newId: string, tail?: import("../../index.js").SplitTail | undefined) => import("../../index.js").OpResult;
+            mergeBlocks: (fromId: string, intoId: string) => import("../../index.js").OpResult;
+            mergeBackward: (id: string) => import("../../index.js").OpResult;
+            mergeForward: (id: string) => import("../../index.js").OpResult;
+            placeBeside: (ids: readonly string[], target: string, side: "left" | "right", kind?: string | undefined) => import("../../index.js").OpResult;
+            wrapInLayout: (ids: readonly string[], kind?: string | undefined, columns?: number | undefined) => import("../../index.js").OpResult;
+            insertBlocks: (dest: import("../../index.js").Destination, specs: readonly (import("../../index.js").JSONBlock | import("../../index.js").BlockSpec)[]) => import("../../index.js").OpResult;
+            moveBlocks: (ids: readonly string[], dest: import("../../index.js").Destination) => import("../../index.js").OpResult;
+            unNestBlocks: (ids: readonly string[]) => import("../../index.js").OpResult;
+            unNestBlock: (id: string) => import("../../index.js").OpResult;
+            liftOut: (id: string, kind: string, args_2?: {
+                keep?: boolean;
+                after?: readonly import("../../index.js").BlockSpec[];
+            } | undefined) => import("../../index.js").OpResult;
             duplicateBlock: (id: string, freshId?: ((oldId: string, kind: "block" | "inline") => string) | undefined) => import("../../index.js").OpResult;
-            insertText: (id: string, offset: number, text: string, marks?: Record<string, unknown> | undefined) => import("../../index.js").OpResult;
-            deleteText: (id: string, offset: number, length: number) => import("../../index.js").OpResult;
-            formatRange: (id: string, offset: number, length: number, marks: Record<string, unknown>) => import("../../index.js").OpResult;
-            clearMarks: (id: string, offset: number, length: number) => import("../../index.js").OpResult;
-            insertInline: (id: string, offset: number, atom: import("../../crdt/doc/content.js").NewInline) => import("../../index.js").OpResult;
-            removeInline: (id: string, inlineId: string) => import("../../index.js").OpResult;
-            deleteBlocks: (ids: readonly string[]) => import("../../index.js").OpResult;
-            init: (opts?: Parameters<(doc: E.EngineDoc, opts?: {
-                content?: import("../../index.js").BlockSpec[];
-                defaultType?: string;
-            }) => void>[1]) => void;
-            seed: (value: import("../../index.js").JSONBlock[], data?: import("../../crdt/doc/types.js").JsonObj) => void;
-            isInitialized: () => boolean;
-            schemaVersion: () => number | undefined;
-            checkSchema: () => E.SchemaProblem | null;
-            assertSchema: () => void;
-            dispose: () => void;
-            createUndoManager: (options?: import("../../crdt/doc/history.js").HistoryOptions) => import("../../crdt/doc/history.js").UndoManager;
             project: () => import("../../index.js").ProjectedDoc;
-            toJSON: () => JSONDoc;
+            toJSON: (options?: {
+                suggestions?: boolean;
+            } | undefined) => JSONDoc;
             blockJSON: (id: string) => import("../../index.js").JSONBlock;
             childrenIds: (id: string | null) => string[];
-            childSlots: (parent: import("../../index.js").BlockId | null) => import("../../crdt/placement/model.js").ChildSlot[];
-            slotOf: (id: string) => {
-                parent: import("../../index.js").BlockId | null;
-                rank: string;
-            } | null;
             positionOf: (id: string) => import("../../index.js").Destination | null;
             pathOf: (id: string) => number[] | null;
             parentOf: (id: string) => string | null;
@@ -241,8 +259,6 @@ export declare const crdt: {
                 ids: (path: readonly string[]) => string[];
             } | null;
             blockAttribution: (id: string) => import("../../index.js").BlockAttribution | undefined;
-            crdtId: (id: string) => string | null;
-            resolveBlock: (id: string) => E.EngineNode | null;
             displayLength: (id: string) => number;
             contentItems: (id: string) => import("../../index.js").ContentItem[];
             hasBlock: (id: string) => boolean;
@@ -256,8 +272,6 @@ export declare const crdt: {
                 blockId: import("../../index.js").BlockId;
                 offset: number;
             } | null;
-            followUndo: (anchor: import("../../index.js").DocAnchor) => import("../../index.js").DocAnchor;
-            rolesChanged: () => void;
             isVoid: (id: string) => boolean;
             isIsland: (id: string) => boolean;
             isLines: (id: string) => boolean;
@@ -289,20 +303,11 @@ export declare const crdt: {
                 parent: string | null;
                 levels: string[];
             };
-            defaultChild: (id: string | null) => string;
             runs: (id: string) => readonly import("../../index.js").ContentRun[];
-            contentJSON: (id: string) => ({
-                text: string;
-                marks?: Record<string, unknown>;
-            } | {
-                id?: string;
-                type: string;
-                data?: unknown;
-            })[];
             onChange: (cb: (change: import("../../index.js").DocChange) => void) => (() => void);
         };
         newDoc: (opts?: ConstructorParameters<E.EngineApi["Doc"]>[0]) => YDoc;
-        purge: (doc: E.EngineDoc, facade: {
+        purge: (doc: E.EngineDoc, facade: Partial<import("../../crdt/doc/suggest.js").SuggestFacade> & {
             model: import("../../crdt/placement/model.js").PlacementModel;
             text: import("../../crdt/text/model.js").TextEngine;
         }, horizon: import("../../crdt/purge.js").Horizon | null) => import("../index.js").PurgeReport;
@@ -530,11 +535,11 @@ export declare const crdt: {
                 destroy(): void;
                 disconnect(): void;
                 connect(): void;
-                emit<N extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: N, args: Parameters<E.WebsocketProviderEvents[N]>): void;
+                emit<N extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "access" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: N, args: Parameters<E.WebsocketProviderEvents[N]>): void;
                 _observers: Map<string, Set<any>>;
-                on<NAME extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: NAME, f: E.WebsocketProviderEvents[NAME]): E.WebsocketProviderEvents[NAME];
-                once<NAME extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: NAME, f: E.WebsocketProviderEvents[NAME]): void;
-                off<NAME extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: NAME, f: E.WebsocketProviderEvents[NAME]): void;
+                on<NAME extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "access" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: NAME, f: E.WebsocketProviderEvents[NAME]): E.WebsocketProviderEvents[NAME];
+                once<NAME extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "access" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: NAME, f: E.WebsocketProviderEvents[NAME]): void;
+                off<NAME extends "refused" | "status" | "failed" | "schema-mismatch" | "message-error" | "protocol-mismatch" | "synced" | "access" | "connection-close" | "connection-error" | "saved" | "permission-denied" | "expired" | "unreachable">(name: NAME, f: E.WebsocketProviderEvents[NAME]): void;
             };
         };
         watchComments: (server: string | null, roomName: string, listener: (message: E.CommentMessage) => void) => (() => void);
@@ -695,6 +700,7 @@ export declare class RoomContext {
             claims: number;
             merged: number;
             released: number;
+            suggestions: number;
         };
         since: number;
     };
@@ -726,7 +732,10 @@ export declare class RoomContext {
     get lookups(): ReturnType<typeof lookups>;
     /** The digest of the room's block roles a client's advertised one is compared with. */
     get digest(): Record<string, string>;
-    /** A facade over `doc` obeying the room's block roles (`semantics`). */
+    /**
+     * A facade over `doc` obeying the room's block roles (`semantics`), its
+     * shared suggestions built: its `toJSON()` leaves the pending ones out.
+     */
     facadeOf(doc: YDoc): EdytorDoc;
     /**
      * The facade over the live document. Read while the room is idle, it

package/dist/cloudflare/room/context.js

@@ -11,6 +11,7 @@ import { Y } from '../../crdt/engine.js';
 import * as E from '../../crdt/protocol.js';
 import { CLOSE } from '../../crdt/providers/room.js';
 import { asEngineDoc } from '../../crdt/structs.js';
+import { suggestionsOf } from '../../crdt/doc/suggest.js';
 import { defaultSemantics, facadeConfigOf, semanticsDigest } from '../../crdt/semantics.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). */
@@ -53,7 +54,8 @@ const counters = () => ({
         records: 0,
         claims: 0,
         merged: 0,
-        released: 0
+        released: 0,
+        suggestions: 0
     },
     since: Date.now()
 });
@@ -132,9 +134,14 @@ export class RoomContext {
     get digest() {
         return (this.#_digest ??= semanticsDigest(this.options.semantics ?? defaultSemantics));
     }
-    /** A facade over `doc` obeying the room's block roles (`semantics`). */
+    /**
+     * A facade over `doc` obeying the room's block roles (`semantics`), its
+     * shared suggestions built: its `toJSON()` leaves the pending ones out.
+     */
     facadeOf(doc) {
-        return crdt.doc.create(asEngineDoc(doc), this.lookups);
+        const facade = crdt.doc.create(asEngineDoc(doc), this.lookups);
+        suggestionsOf(facade);
+        return facade;
     }
     /**
      * The facade over the live document. Read while the room is idle, it

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

@@ -1,5 +1,10 @@
 import type { YDoc } from '../../crdt/index.js';
 import type { Decoded, Struct } from './context.js';
+type Id = {
+    client: number;
+    clock: number;
+};
+export declare const isId: (value: unknown) => value is Id;
 /**
  * The clients of a frame (but `skip`) that write a per-writer block mark
  * of another writer: a struct whose key is `del.<n>` or `wd.<n>` on a
@@ -39,6 +44,14 @@ export type AttributionWrites = {
  * it again (`#bindOrphan`).
  */
 export declare const attributionWrites: (doc: YDoc, structs: Struct[], skip: Set<number>, user: string, owns: (client: number) => boolean, ownerOf: (client: number) => string | undefined) => AttributionWrites;
+/**
+ * The suggestion writers of a frame that bind themselves to `user`: `n`
+ * writes a record in the suggestions' root and `c/<n>` naming `user` — a
+ * suggestion writer's first frame registers it as the user's
+ * (`sugg.writer.binding`). Any other self-bound id stays a replica's,
+ * claimed only by its own dial.
+ */
+export declare const selfBound: (doc: YDoc, structs: Struct[], user: string) => Set<number>;
 /**
  * Of a frame's deletes, those of live attribution entries `user` may not
  * delete, with their keys: a binding of a replica the user does not own
@@ -48,3 +61,4 @@ export declare const forgedAttributionDeletes: (doc: YDoc, ds: Decoded["ds"], us
     ids: Decoded["ds"];
     keys: string[];
 };
+export {};

package/dist/cloudflare/room/forged.js

@@ -7,7 +7,7 @@
  * find.
  */
 import { Y } from '../../crdt/engine.js';
-import { ATTRIBUTION_ROOT, DEL_PREFIX, HORIZON_ROOT, REGISTRY_KEY, WITHDRAW_PREFIX } from '../../crdt/schema.js';
+import { ATTRIBUTION_ROOT, DEL_PREFIX, HORIZON_ROOT, REGISTRY_KEY, SUGGEST_ROOT, WITHDRAW_PREFIX } from '../../crdt/schema.js';
 import { heldClock, runsOf, storedStruct, structAt } from './updates.js';
 // ── Per-writer marks ──────────────────────────────────────────
 /** The writer `n` of a per-writer block mark key (`del.<n>`, `wd.<n>`), or `null`. */
@@ -22,7 +22,7 @@ const markWriter = (key) => {
     const digits = prefix === null ? '' : key.slice(prefix.length);
     return /^\d{1,16}$/.test(digits) ? Number(digits) : null;
 };
-const isId = (value) => typeof value === 'object' &&
+export const isId = (value) => typeof value === 'object' &&
     value !== null &&
     typeof value.client === 'number' &&
     typeof value.clock === 'number' &&
@@ -198,6 +198,34 @@ export const attributionWrites = (doc, structs, skip, user, owns, ownerOf) => {
     }
     return writes;
 };
+/**
+ * The suggestion writers of a frame that bind themselves to `user`: `n`
+ * writes a record in the suggestions' root and `c/<n>` naming `user` — a
+ * suggestion writer's first frame registers it as the user's
+ * (`sugg.writer.binding`). Any other self-bound id stays a replica's,
+ * claimed only by its own dial.
+ */
+export const selfBound = (doc, structs, user) => {
+    const frame = runsOf(structs);
+    const records = new Set();
+    const bound = new Set();
+    for (const struct of structs) {
+        if (!(struct instanceof Y.Item))
+            continue;
+        const place = placeOf(doc, frame, struct.id);
+        if (place?.key == null)
+            continue;
+        const { parent } = place;
+        if (parent === SUGGEST_ROOT || (parent != null && parent === doc.share.get(SUGGEST_ROOT)))
+            records.add(struct.id.client);
+        if (!isAttribution(doc, parent))
+            continue;
+        const content = struct.content.getContent();
+        if (boundReplica(place.key) === struct.id.client && content[content.length - 1] === user)
+            bound.add(struct.id.client);
+    }
+    return new Set([...bound].filter((client) => records.has(client)));
+};
 /**
  * Of a frame's deletes, those of live attribution entries `user` may not
  * delete, with their keys: a binding of a replica the user does not own

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

@@ -27,5 +27,9 @@ export declare const updateFrame: (update: Uint8Array) => Uint8Array;
 export declare const readOnlyFrame: () => Uint8Array;
 /** The denial of a read-only socket's write: it stays, and still syncs. */
 export declare const readOnlyDenialFrame: () => Uint8Array;
+/** The denial of what a suggest-only socket may not write (stripped): it stays, and still syncs. */
+export declare const suggestOnlyDenialFrame: () => Uint8Array;
+/** The socket's access, at the join and at a change in place (`write`, `suggest`, `comment`, `read`). */
+export declare const accessFrame: (access: string) => Uint8Array;
 /** A Step2 of what the room STORED: the engine's pending store (never stored) is left out. */
 export declare const storedStep2: (doc: YDoc, sv: Uint8Array) => Uint8Array;

package/dist/cloudflare/room/frames.js

@@ -4,7 +4,7 @@
  * room's.
  */
 import * as encoding from 'lib0-v14/encoding';
-import { READ_ONLY_DENIAL } from '../../crdt/protocols/auth.js';
+import { READ_ONLY_DENIAL, SUGGEST_ONLY_DENIAL } from '../../crdt/protocols/auth.js';
 import * as E from '../../crdt/protocol.js';
 import { sync } from './context.js';
 import { withoutPending } from './updates.js';
@@ -49,5 +49,9 @@ export const updateFrame = (update) => E.frame(E.messageSync, (e) => sync.writeU
 export const readOnlyFrame = () => E.frame(E.messageAuth, (e) => E.writeReadOnly(e));
 /** The denial of a read-only socket's write: it stays, and still syncs. */
 export const readOnlyDenialFrame = () => E.frame(E.messageAuth, (e) => E.writePermissionDenied(e, READ_ONLY_DENIAL));
+/** The denial of what a suggest-only socket may not write (stripped): it stays, and still syncs. */
+export const suggestOnlyDenialFrame = () => E.frame(E.messageAuth, (e) => E.writePermissionDenied(e, SUGGEST_ONLY_DENIAL));
+/** The socket's access, at the join and at a change in place (`write`, `suggest`, `comment`, `read`). */
+export const accessFrame = (access) => E.frame(E.messageAuth, (e) => E.writeAccess(e, access));
 /** A Step2 of what the room STORED: the engine's pending store (never stored) is left out. */
 export const storedStep2 = (doc, sv) => withoutPending(doc, () => E.frame(E.messageSync, (e) => sync.writeSyncStep2(e, doc, sv)));

package/dist/cloudflare/room/purge.js

@@ -125,7 +125,8 @@ export class RoomPurge {
             'records',
             'claims',
             'merged',
-            'released'
+            'released',
+            'suggestions'
         ];
         // Nothing an ended session deleted was left: no compaction, no run.
         if (horizon === null && !wrote)

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

@@ -28,14 +28,16 @@ export declare class ReplicaRegistry {
      * stripped from its frame (the rest of the frame is applied: never
      * refused whole). Written: its user's ids, and its own replica (the
      * dialed or bound one), which claims an unowned id or a fresh one, as
-     * `bind` would. A socket with no replica claims fresh ids it writes.
+     * `bind` would. A socket with no replica claims fresh ids it writes, and
+     * any socket a fresh id that binds itself to its user in the frame
+     * (`bound`: a suggestion's writer).
      * Any other id is relayed — another replica's structs, which a restore
      * from a lagging snapshot may have lost: kept, and left unowned (`''`,
      * claimable only by its own dial), when the room holds none of that id's
      * clocks and no user owns it; stripped otherwise (logged `replica`).
      * Ownership never moves to a relayer.
      */
-    attribute({ user, replica }: Attachment, writers: Set<number>, sv: Map<number, number>, orphans: Set<number>): Set<number>;
+    attribute({ user, replica }: Attachment, writers: Set<number>, sv: Map<number, number>, orphans: Set<number>, bound?: Set<number>): Set<number>;
     /**
      * Bind the sender's replicas whose `c/<n>` a frame set to another actor
      * to its verified user (`room.attribution.trust`): one room write after the frame's, which

package/dist/cloudflare/room/replicas.js

@@ -75,14 +75,16 @@ export class ReplicaRegistry {
      * stripped from its frame (the rest of the frame is applied: never
      * refused whole). Written: its user's ids, and its own replica (the
      * dialed or bound one), which claims an unowned id or a fresh one, as
-     * `bind` would. A socket with no replica claims fresh ids it writes.
+     * `bind` would. A socket with no replica claims fresh ids it writes, and
+     * any socket a fresh id that binds itself to its user in the frame
+     * (`bound`: a suggestion's writer).
      * Any other id is relayed — another replica's structs, which a restore
      * from a lagging snapshot may have lost: kept, and left unowned (`''`,
      * claimable only by its own dial), when the room holds none of that id's
      * clocks and no user owns it; stripped otherwise (logged `replica`).
      * Ownership never moves to a relayer.
      */
-    attribute({ user, replica }, writers, sv, orphans) {
+    attribute({ user, replica }, writers, sv, orphans, bound = new Set()) {
         const room = this.room;
         const claimed = [];
         const relayed = [];
@@ -93,7 +95,10 @@ export class ReplicaRegistry {
                 continue;
             const held = (sv.get(client) ?? 0) > 0;
             const fresh = owner === undefined && !held;
-            if (client === replica ? fresh || owner === '' : replica === null && fresh) {
+            // A fresh id the frame binds to its user by itself (a suggestion's writer) is the user's.
+            if (client === replica
+                ? fresh || owner === ''
+                : (replica === null || bound.has(client)) && fresh) {
                 claimed.push({ replica: client, user });
                 if (owner === '')
                     orphans.add(client);

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

@@ -0,0 +1,7 @@
+import type { YDoc } from '../../crdt/index.js';
+import type { Decoded } from './context.js';
+/** What a frame of a suggest-only socket may not write: the clients to strip, the deletes to drop. */
+export declare const suggestOnly: (doc: YDoc, { structs, ds }: Decoded, skip: Set<number>, owns: (client: number) => boolean, replica: number | null) => {
+    strip: Set<number>;
+    deletes: Decoded["ds"];
+};