edytor 4.0.0 → 5.0.0

package/dist/crdt/index.d.ts

@@ -46,6 +46,7 @@
  */
 export { EdytorDocument, createDocument, loadDocument, attachDocument, SemanticConflictError, DocumentNotReadyError, DocumentDestroyedError, DEFAULT_READINESS_BOUND, type DocumentActor, type DocumentOptions, type DocumentReadiness, type DocumentSemanticsConfig, type CreateDocumentOptions, type LoadDocumentOptions } from './document.js';
 export { defaultSemantics, richTextSemantics, codeSemantics, imageSemantics, mediaKinds, mediaSemantics, layoutSemantics, pageKinds, pageSemantics, tocKinds, tocSemantics, tableKinds, tableSemantics, equationKinds, equationSemantics, richTextKinds, codeKinds, imageKinds, layoutKinds, richTextMarks, commentMarks, facadeConfigOf, semanticsOf, mergeSemantics, semanticsDigest, semanticsMismatch, type KindSemantics, type KindRecord, type MergedSemantics } from './semantics.js';
+export { adoptSharedSuggestions, type SuggestedChange } from './doc/suggest.js';
 export { tableBlock, type TableBlockOptions } from './tables.js';
 export { markName, type MarkEdge } from './text/marks.js';
 export type { JSONDoc, JSONBlock, JSONText, JSONInlineBlock, SerializableContent } from '../utils/json.js';
@@ -75,7 +76,7 @@ export declare const bindCrdt: (Y: EngineApi) => {
     Awareness: typeof _Awareness;
     doc: {
         SCHEMA: {
-            readonly version: 10;
+            readonly version: 11;
             readonly name: "edytor-doc";
             readonly roots: {
                 readonly registry: "blocks";
@@ -86,7 +87,7 @@ export declare const bindCrdt: (Y: EngineApi) => {
                 readonly schema: "schema";
             };
         };
-        SCHEMA_VERSION: 10;
+        SCHEMA_VERSION: 11;
         SCHEMA_NAME: "edytor-doc";
         META_KEY: "meta";
         init: (doc: import("./engine-api.js").EngineDoc, opts?: {
@@ -102,48 +103,36 @@ export declare const bindCrdt: (Y: EngineApi) => {
         assertSchema: (doc: import("./engine-api.js").EngineDoc, docName?: string) => void;
         SchemaMismatchError: typeof import("./edytor-doc.js").SchemaMismatchError;
         create: (doc: import("./engine-api.js").EngineDoc, config?: import("./edytor-doc.js").EdytorDocConfig) => {
-            prepare: {
-                insertFlow: (target: import("./flow.js").FlowTarget, flow: import("./flow.js").Flow, view?: import("./flow.js").FlowView) => import("./edytor-doc.js").Prepared;
-                deleteRange: (from: import("./rangeDelete.js").DocPosition, to: import("./rangeDelete.js").DocPosition, view?: import("./rangeDelete.js").RangeView) => import("./edytor-doc.js").Prepared;
-                replaceRange: (from: import("./rangeDelete.js").DocPosition, to: import("./rangeDelete.js").DocPosition, view?: import("./rangeDelete.js").RangeView) => import("./edytor-doc.js").Prepared;
-                insertBlocks: (dest: import("./index.js").Destination, specs: readonly (import("./index.js").BlockSpec | import("./index.js").JSONBlock)[]) => import("./edytor-doc.js").Prepared;
-                moveBlocks: (ids: readonly import("./index.js").BlockId[], dest: import("./index.js").Destination) => import("./edytor-doc.js").Prepared;
-                nestBlock: (id: import("./index.js").BlockId, parent: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
-                unNestBlock: (id: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
-                unNestBlocks: (ids: readonly import("./index.js").BlockId[]) => import("./edytor-doc.js").Prepared;
-                liftOut: (id: import("./index.js").BlockId, kind: string, { keep, after }?: {
-                    keep?: boolean;
-                    after?: readonly import("./index.js").BlockSpec[];
-                }) => import("./edytor-doc.js").Prepared;
-                placeBeside: (ids: readonly import("./index.js").BlockId[], target: import("./index.js").BlockId, side: "left" | "right", kind?: string) => import("./edytor-doc.js").Prepared;
-                wrapInLayout: (ids: readonly import("./index.js").BlockId[], kind?: string, columns?: number) => import("./edytor-doc.js").Prepared;
-                splitBlock: (id: import("./index.js").BlockId, offset: number, newId: import("./index.js").BlockId, tail?: import("./placement/model.js").SplitTail) => import("./edytor-doc.js").Prepared;
-                mergeBlocks: (fromId: import("./index.js").BlockId, intoId: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
-                mergeBackward: (id: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
-                mergeForward: (id: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
-                deleteBlock: (id: import("./index.js").BlockId, opts?: {
-                    keepChildren?: boolean;
-                }) => import("./edytor-doc.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("./edytor-doc.js").Prepared;
-                setBlockType: (id: import("./index.js").BlockId, type: string) => import("./edytor-doc.js").Prepared;
-                patchData: (target: import("./edytor-doc.js").DataTarget, patches: readonly import("./data.js").DataPatch[]) => import("./edytor-doc.js").Prepared;
-                duplicateBlock: (id: import("./index.js").BlockId, freshId?: (oldId: string, kind: "block" | "inline") => string) => import("./edytor-doc.js").Prepared;
-                insertText: (id: import("./index.js").BlockId, offset: number, text: string, marks?: Record<string, unknown>) => import("./edytor-doc.js").Prepared;
-                deleteText: (id: import("./index.js").BlockId, offset: number, length: number) => import("./edytor-doc.js").Prepared;
-                formatRange: (id: import("./index.js").BlockId, offset: number, length: number, marks: Record<string, unknown>) => import("./edytor-doc.js").Prepared;
-                clearMarks: (id: import("./index.js").BlockId, offset: number, length: number) => import("./edytor-doc.js").Prepared;
-                insertInline: (id: import("./index.js").BlockId, offset: number, atom: import("./doc/content.js").NewInline) => import("./edytor-doc.js").Prepared;
-                removeInline: (id: import("./index.js").BlockId, inlineId: string) => import("./edytor-doc.js").Prepared;
-                deleteBlocks: (ids: readonly import("./index.js").BlockId[]) => import("./edytor-doc.js").Prepared;
-            };
-            apply: (p: import("./edytor-doc.js").Prepared) => import("./edytor-doc.js").OpResult;
-            compose: (...parts: import("./edytor-doc.js").Prepared[]) => import("./edytor-doc.js").Prepared;
-            transact: <R>(fn: () => R, origin?: unknown) => R;
+            init: (opts?: Parameters<(doc: import("./engine-api.js").EngineDoc, opts?: {
+                content?: import("./index.js").BlockSpec[];
+                defaultType?: string;
+            }) => void>[1]) => void;
+            seed: (value: import("./index.js").JSONBlock[], data?: import("./doc/types.js").JsonObj) => void;
+            isInitialized: () => boolean;
+            schemaVersion: () => number | undefined;
+            checkSchema: () => import("./edytor-doc.js").SchemaProblem | null;
+            assertSchema: () => void;
+            dispose: () => void;
+            createUndoManager: (options?: import("./doc/history.js").HistoryOptions) => import("./doc/history.js").UndoManager;
+            part: import("./doc/suggest.js").SuggestContext;
+            childSlots: (parent: import("./index.js").BlockId | null) => import("./placement/model.js").ChildSlot[];
+            slotOf: (id: string) => {
+                parent: import("./index.js").BlockId | null;
+                rank: string;
+            } | null;
+            crdtId: (id: string) => string | null;
+            resolveBlock: (id: string) => import("./engine-api.js").EngineNode | null;
+            followUndo: (anchor: import("./edytor-doc.js").DocAnchor) => import("./edytor-doc.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: import("./engine-api.js").EngineDoc) => import("./engine-api.js").EngineNode;
@@ -213,64 +202,94 @@ export declare const bindCrdt: (Y: EngineApi) => {
                 };
             };
             runsView: import("./text/runs.js").RunView;
+            api: object;
+        } & {
+            prepare: {
+                insertFlow: (target: import("./flow.js").FlowTarget, flow: import("./flow.js").Flow, view?: import("./flow.js").FlowView) => import("./edytor-doc.js").Prepared;
+                deleteRange: (from: import("./rangeDelete.js").DocPosition, to: import("./rangeDelete.js").DocPosition, view?: import("./rangeDelete.js").RangeView) => import("./edytor-doc.js").Prepared;
+                replaceRange: (from: import("./rangeDelete.js").DocPosition, to: import("./rangeDelete.js").DocPosition, view?: import("./rangeDelete.js").RangeView) => import("./edytor-doc.js").Prepared;
+                nestBlock: (id: import("./index.js").BlockId, parent: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
+                deleteBlocks: (ids: readonly import("./index.js").BlockId[]) => import("./edytor-doc.js").Prepared;
+                insertText: (id: import("./index.js").BlockId, offset: number, text: string, marks?: Record<string, unknown>) => import("./edytor-doc.js").Prepared;
+                deleteText: (id: import("./index.js").BlockId, offset: number, length: number) => import("./edytor-doc.js").Prepared;
+                formatRange: (id: import("./index.js").BlockId, offset: number, length: number, marks: Record<string, unknown>) => import("./edytor-doc.js").Prepared;
+                clearMarks: (id: import("./index.js").BlockId, offset: number, length: number) => import("./edytor-doc.js").Prepared;
+                insertInline: (id: import("./index.js").BlockId, offset: number, atom: import("./doc/content.js").NewInline) => import("./edytor-doc.js").Prepared;
+                removeInline: (id: import("./index.js").BlockId, inlineId: string) => import("./edytor-doc.js").Prepared;
+                setBlockType: (id: import("./index.js").BlockId, type: string) => import("./edytor-doc.js").Prepared;
+                patchData: (target: import("./edytor-doc.js").DataTarget, patches: readonly import("./data.js").DataPatch[]) => import("./edytor-doc.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("./edytor-doc.js").Prepared;
+                deleteBlock: (id: import("./index.js").BlockId, opts?: {
+                    keepChildren?: boolean;
+                }) => import("./edytor-doc.js").Prepared;
+                splitBlock: (id: import("./index.js").BlockId, offset: number, newId: import("./index.js").BlockId, tail?: import("./placement/model.js").SplitTail) => import("./edytor-doc.js").Prepared;
+                mergeBlocks: (fromId: import("./index.js").BlockId, intoId: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
+                mergeBackward: (id: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
+                mergeForward: (id: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
+                placeBeside: (ids: readonly import("./index.js").BlockId[], target: import("./index.js").BlockId, side: "left" | "right", kind?: string) => import("./edytor-doc.js").Prepared;
+                wrapInLayout: (ids: readonly import("./index.js").BlockId[], kind?: string, columns?: number) => import("./edytor-doc.js").Prepared;
+                insertBlocks: (dest: import("./index.js").Destination, specs: readonly (import("./index.js").BlockSpec | import("./index.js").JSONBlock)[]) => import("./edytor-doc.js").Prepared;
+                moveBlocks: (ids: readonly import("./index.js").BlockId[], dest: import("./index.js").Destination) => import("./edytor-doc.js").Prepared;
+                unNestBlocks: (ids: readonly import("./index.js").BlockId[]) => import("./edytor-doc.js").Prepared;
+                unNestBlock: (id: import("./index.js").BlockId) => import("./edytor-doc.js").Prepared;
+                liftOut: (id: import("./index.js").BlockId, kind: string, { keep, after }?: {
+                    keep?: boolean;
+                    after?: readonly import("./index.js").BlockSpec[];
+                }) => import("./edytor-doc.js").Prepared;
+                duplicateBlock: (id: import("./index.js").BlockId, freshId?: (oldId: string, kind: "block" | "inline") => string) => import("./edytor-doc.js").Prepared;
+            };
+            apply: (p: import("./edytor-doc.js").Prepared, quiet?: boolean) => import("./edytor-doc.js").OpResult;
+            compose: (...parts: import("./edytor-doc.js").Prepared[]) => import("./edytor-doc.js").Prepared;
+            transact: <R>(fn: () => R, origin?: unknown) => R;
             version: number;
             insertFlow: (target: import("./flow.js").FlowTarget, flow: import("./flow.js").Flow, view?: import("./flow.js").FlowView | undefined) => import("./edytor-doc.js").OpResult;
             deleteRange: (from: import("./rangeDelete.js").DocPosition, to: import("./rangeDelete.js").DocPosition, view?: import("./rangeDelete.js").RangeView | undefined) => import("./edytor-doc.js").OpResult;
             replaceRange: (from: import("./rangeDelete.js").DocPosition, to: import("./rangeDelete.js").DocPosition, view?: import("./rangeDelete.js").RangeView | undefined) => import("./edytor-doc.js").OpResult;
-            insertBlocks: (dest: import("./index.js").Destination, specs: readonly (import("./index.js").BlockSpec | import("./index.js").JSONBlock)[]) => import("./edytor-doc.js").OpResult;
-            moveBlocks: (ids: readonly string[], dest: import("./index.js").Destination) => import("./edytor-doc.js").OpResult;
             nestBlock: (id: string, parent: string) => import("./edytor-doc.js").OpResult;
-            unNestBlock: (id: string) => import("./edytor-doc.js").OpResult;
-            unNestBlocks: (ids: readonly string[]) => import("./edytor-doc.js").OpResult;
-            liftOut: (id: string, kind: string, args_2?: {
-                keep?: boolean;
-                after?: readonly import("./index.js").BlockSpec[];
-            } | undefined) => import("./edytor-doc.js").OpResult;
-            placeBeside: (ids: readonly string[], target: string, side: "left" | "right", kind?: string | undefined) => import("./edytor-doc.js").OpResult;
-            wrapInLayout: (ids: readonly string[], kind?: string | undefined, columns?: number | undefined) => import("./edytor-doc.js").OpResult;
-            splitBlock: (id: string, offset: number, newId: string, tail?: import("./placement/model.js").SplitTail | undefined) => import("./edytor-doc.js").OpResult;
-            mergeBlocks: (fromId: string, intoId: string) => import("./edytor-doc.js").OpResult;
-            mergeBackward: (id: string) => import("./edytor-doc.js").OpResult;
-            mergeForward: (id: string) => import("./edytor-doc.js").OpResult;
-            deleteBlock: (id: string, opts?: {
-                keepChildren?: boolean;
-            } | undefined) => import("./edytor-doc.js").OpResult;
+            deleteBlocks: (ids: readonly string[]) => import("./edytor-doc.js").OpResult;
+            insertText: (id: string, offset: number, text: string, marks?: Record<string, unknown> | undefined) => import("./edytor-doc.js").OpResult;
+            deleteText: (id: string, offset: number, length: number) => import("./edytor-doc.js").OpResult;
+            formatRange: (id: string, offset: number, length: number, marks: Record<string, unknown>) => import("./edytor-doc.js").OpResult;
+            clearMarks: (id: string, offset: number, length: number) => import("./edytor-doc.js").OpResult;
+            insertInline: (id: string, offset: number, atom: import("./doc/content.js").NewInline) => import("./edytor-doc.js").OpResult;
+            removeInline: (id: string, inlineId: string) => import("./edytor-doc.js").OpResult;
+            setBlockType: (id: string, type: string) => import("./edytor-doc.js").OpResult;
+            patchData: (target: import("./edytor-doc.js").DataTarget, patches: readonly import("./data.js").DataPatch[]) => import("./edytor-doc.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("./edytor-doc.js").OpResult;
-            setBlockType: (id: string, type: string) => import("./edytor-doc.js").OpResult;
-            patchData: (target: import("./edytor-doc.js").DataTarget, patches: readonly import("./data.js").DataPatch[]) => import("./edytor-doc.js").OpResult;
+            deleteBlock: (id: string, opts?: {
+                keepChildren?: boolean;
+            } | undefined) => import("./edytor-doc.js").OpResult;
+            splitBlock: (id: string, offset: number, newId: string, tail?: import("./placement/model.js").SplitTail | undefined) => import("./edytor-doc.js").OpResult;
+            mergeBlocks: (fromId: string, intoId: string) => import("./edytor-doc.js").OpResult;
+            mergeBackward: (id: string) => import("./edytor-doc.js").OpResult;
+            mergeForward: (id: string) => import("./edytor-doc.js").OpResult;
+            placeBeside: (ids: readonly string[], target: string, side: "left" | "right", kind?: string | undefined) => import("./edytor-doc.js").OpResult;
+            wrapInLayout: (ids: readonly string[], kind?: string | undefined, columns?: number | undefined) => import("./edytor-doc.js").OpResult;
+            insertBlocks: (dest: import("./index.js").Destination, specs: readonly (import("./index.js").JSONBlock | import("./index.js").BlockSpec)[]) => import("./edytor-doc.js").OpResult;
+            moveBlocks: (ids: readonly string[], dest: import("./index.js").Destination) => import("./edytor-doc.js").OpResult;
+            unNestBlocks: (ids: readonly string[]) => import("./edytor-doc.js").OpResult;
+            unNestBlock: (id: string) => import("./edytor-doc.js").OpResult;
+            liftOut: (id: string, kind: string, args_2?: {
+                keep?: boolean;
+                after?: readonly import("./index.js").BlockSpec[];
+            } | undefined) => import("./edytor-doc.js").OpResult;
             duplicateBlock: (id: string, freshId?: ((oldId: string, kind: "block" | "inline") => string) | undefined) => import("./edytor-doc.js").OpResult;
-            insertText: (id: string, offset: number, text: string, marks?: Record<string, unknown> | undefined) => import("./edytor-doc.js").OpResult;
-            deleteText: (id: string, offset: number, length: number) => import("./edytor-doc.js").OpResult;
-            formatRange: (id: string, offset: number, length: number, marks: Record<string, unknown>) => import("./edytor-doc.js").OpResult;
-            clearMarks: (id: string, offset: number, length: number) => import("./edytor-doc.js").OpResult;
-            insertInline: (id: string, offset: number, atom: import("./doc/content.js").NewInline) => import("./edytor-doc.js").OpResult;
-            removeInline: (id: string, inlineId: string) => import("./edytor-doc.js").OpResult;
-            deleteBlocks: (ids: readonly string[]) => import("./edytor-doc.js").OpResult;
-            init: (opts?: Parameters<(doc: import("./engine-api.js").EngineDoc, opts?: {
-                content?: import("./index.js").BlockSpec[];
-                defaultType?: string;
-            }) => void>[1]) => void;
-            seed: (value: import("./index.js").JSONBlock[], data?: import("./doc/types.js").JsonObj) => void;
-            isInitialized: () => boolean;
-            schemaVersion: () => number | undefined;
-            checkSchema: () => import("./edytor-doc.js").SchemaProblem | null;
-            assertSchema: () => void;
-            dispose: () => void;
-            createUndoManager: (options?: import("./doc/history.js").HistoryOptions) => import("./doc/history.js").UndoManager;
             project: () => import("./index.js").ProjectedDoc;
-            toJSON: () => import("./index.js").JSONDoc;
+            toJSON: (options?: {
+                suggestions?: boolean;
+            } | undefined) => import("./index.js").JSONDoc;
             blockJSON: (id: string) => import("./index.js").JSONBlock;
             childrenIds: (id: string | null) => string[];
-            childSlots: (parent: import("./index.js").BlockId | null) => import("./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;
@@ -288,8 +307,6 @@ export declare const bindCrdt: (Y: EngineApi) => {
                 ids: (path: readonly string[]) => string[];
             } | null;
             blockAttribution: (id: string) => import("./index.js").BlockAttribution | undefined;
-            crdtId: (id: string) => string | null;
-            resolveBlock: (id: string) => import("./engine-api.js").EngineNode | null;
             displayLength: (id: string) => number;
             contentItems: (id: string) => import("./index.js").ContentItem[];
             hasBlock: (id: string) => boolean;
@@ -303,8 +320,6 @@ export declare const bindCrdt: (Y: EngineApi) => {
                 blockId: import("./index.js").BlockId;
                 offset: number;
             } | null;
-            followUndo: (anchor: import("./edytor-doc.js").DocAnchor) => import("./edytor-doc.js").DocAnchor;
-            rolesChanged: () => void;
             isVoid: (id: string) => boolean;
             isIsland: (id: string) => boolean;
             isLines: (id: string) => boolean;
@@ -336,20 +351,11 @@ export declare const bindCrdt: (Y: EngineApi) => {
                 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("./edytor-doc.js").DocChange) => void) => (() => void);
         };
         newDoc: (opts?: ConstructorParameters<EngineApi["Doc"]>[0]) => YDoc;
-        purge: (doc: import("./engine-api.js").EngineDoc, facade: {
+        purge: (doc: import("./engine-api.js").EngineDoc, facade: Partial<import("./doc/suggest.js").SuggestFacade> & {
             model: import("./placement/model.js").PlacementModel;
             text: import("./text/model.js").TextEngine;
         }, horizon: import("./purge.js").Horizon | null) => import("./purge.js").PurgeReport;
@@ -577,11 +583,11 @@ export declare const bindCrdt: (Y: EngineApi) => {
                 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<import("./protocol.js").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<import("./protocol.js").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: import("./protocol.js").WebsocketProviderEvents[NAME]): import("./protocol.js").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: import("./protocol.js").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: import("./protocol.js").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: import("./protocol.js").WebsocketProviderEvents[NAME]): import("./protocol.js").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: import("./protocol.js").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: import("./protocol.js").WebsocketProviderEvents[NAME]): void;
             };
         };
         watchComments: (server: string | null, roomName: string, listener: (message: import("./protocol.js").CommentMessage) => void) => (() => void);

package/dist/crdt/index.js

@@ -61,6 +61,9 @@ export { EdytorDocument, createDocument, loadDocument, attachDocument, SemanticC
 // `blocks`), `mergeSemantics` merges configs field by field, and the digest
 // is the dev-time check a room logs mismatches with. Frozen.
 export { defaultSemantics, richTextSemantics, codeSemantics, imageSemantics, mediaKinds, mediaSemantics, layoutSemantics, pageKinds, pageSemantics, tocKinds, tocSemantics, tableKinds, tableSemantics, equationKinds, equationSemantics, richTextKinds, codeKinds, imageKinds, layoutKinds, richTextMarks, commentMarks, facadeConfigOf, semanticsOf, mergeSemantics, semanticsDigest, semanticsMismatch } from './semantics.js';
+// A document read without a view leaves its pending shared suggestions out
+// of `toJSON()` once they are built over it (`sugg.json.base`).
+export { adoptSharedSuggestions } from './doc/suggest.js';
 // A new table as document JSON (`table.*`).
 export { tableBlock } from './tables.js';
 // Paired marks — a mark's edge as document semantics, the record a key names.

package/dist/crdt/operations.d.ts

@@ -7,8 +7,10 @@
  * a view (`edytor.insertBlocks(…)`) they are dispatched. The facade a
  * document binds has more (the index, the engine hooks): those stay
  * internal. `DOCUMENT_OPERATIONS` lists the names, `DOCUMENT_WRITES` the
- * writes, checked against the interfaces here and against the facade in
- * `document.ts`. Worker-safe: types and two lists.
+ * writes, checked against the interfaces here; the document and the view
+ * read the names from the facade itself (its `api` and `prepare`, checked
+ * against `DocumentOperations` in `document.ts`). Worker-safe: types and
+ * two lists.
  */
 import type { BlockAttribution } from './attribution/block.js';
 import type { AnchorAffinity, DataTarget, DocAnchor, DocChange, JsonObj, OpResult, OrderPolicy, Prepared } from './doc/types.js';
@@ -63,7 +65,14 @@ export interface DocumentWrites {
 }
 /** The document's reads (transaction-aware where the reference says so). */
 export interface DocumentReads {
-    toJSON(): JSONDoc;
+    /**
+     * The document as JSON, without its pending suggestions (their inserted
+     * text and blocks left out, their proposals not applied); with
+     * `suggestions: true`, as shown, pending suggestions included.
+     */
+    toJSON(options?: {
+        suggestions?: boolean;
+    }): JSONDoc;
     docData(): JsonObj;
     dataItemIds(target: DataTarget, path: readonly string[]): string[];
     project(): ProjectedDoc;

package/dist/crdt/parts.d.ts

@@ -0,0 +1,43 @@
+/**
+ * A block's content as its parts: the text segments between inline atoms
+ * and the atoms, alternating, starting and ending with a segment (an empty
+ * content is one empty `start` segment), each at its display offsets (an
+ * atom counts 1). One pure function of the index's runs, memoized per runs
+ * array: the cells render it, the handles and the projection read it.
+ */
+import type { ContentRun } from './text/runs.js';
+export declare const START = "start";
+type TextRun = Extract<ContentRun, {
+    kind: 'text';
+}>;
+/** The text between two inline atoms (or a content edge), keyed causally. */
+export type Segment = {
+    readonly kind: 'text';
+    /** The id of the atom before this segment, or {@link START}. */
+    readonly key: string;
+    readonly text: string;
+    readonly runs: readonly TextRun[];
+    /** Its position among the block's segments. */
+    readonly segOrd: number;
+    readonly start: number;
+    readonly end: number;
+};
+export type AtomPart = {
+    readonly kind: 'inline';
+    readonly key: string;
+    readonly id: string;
+    readonly type: string;
+    readonly data: Readonly<Record<string, unknown>> | undefined;
+    readonly start: number;
+    readonly end: number;
+};
+export type Part = Segment | AtomPart;
+export declare const partsOf: (runs: readonly ContentRun[]) => readonly Part[];
+/** The text segment showing `offset`: the first ending at or after it (a seam belongs to the left text), else the last. */
+export declare const segmentAt: <P extends {
+    kind: string;
+    end: number;
+}>(parts: readonly P[], offset: number) => Extract<P, {
+    kind: "text";
+}>;
+export {};

package/dist/crdt/parts.js

@@ -0,0 +1,44 @@
+export const START = 'start';
+const memo = new WeakMap();
+export const partsOf = (runs) => {
+    const hit = memo.get(runs);
+    if (hit)
+        return hit;
+    const parts = [];
+    let [key, segment, start, at, segOrd] = [START, [], 0, 0, 0];
+    const close = () => parts.push(Object.freeze({
+        kind: 'text',
+        key,
+        text: segment.map((run) => run.text).join(''),
+        runs: Object.freeze(segment),
+        segOrd: segOrd++,
+        start,
+        end: at
+    }));
+    for (const run of runs) {
+        if (run.kind === 'text') {
+            segment.push(run);
+            at += run.text.length;
+            continue;
+        }
+        close();
+        parts.push(Object.freeze({
+            kind: 'inline',
+            key: run.id,
+            id: run.id,
+            type: run.type,
+            data: run.data,
+            start: at,
+            end: ++at
+        }));
+        [key, segment, start] = [run.id, [], at];
+    }
+    close();
+    memo.set(runs, Object.freeze(parts));
+    return parts;
+};
+/** The text segment showing `offset`: the first ending at or after it (a seam belongs to the left text), else the last. */
+export const segmentAt = (parts, offset) => {
+    const texts = parts.filter((part) => part.kind === 'text');
+    return texts.find((part) => offset <= part.end) ?? texts.at(-1);
+};

package/dist/crdt/placement/display.d.ts

@@ -68,7 +68,7 @@ export declare const displayParentOf: (own: DisplayOwnership, pl: ResolvedPlacem
  * promoted one ({@link displaySlotOf}).
  */
 export declare const childrenIndex: (placements: Map<BlockId, ResolvedPlacement>, own: DisplayOwnership) => Map<BlockId | null, ChildSlot[]>;
-/** The order of a children list: by rank, ties by id. */
+/** The order of a children list: by rank, ties by id ({@link compareIds}). */
 export declare const bySlot: (a: {
     id: BlockId;
     rank: string;

package/dist/crdt/placement/display.js

@@ -7,7 +7,7 @@
  * (`order.split.text`: a split-born slot's key, fork patch YP22).
  */
 import { DEAD } from '../text/model.js';
-import { claimedRank, promotedRank } from './keys.js';
+import { claimedRank, compareIds, promotedRank } from './keys.js';
 /**
  * THE liveness answer: `id` carries no live delete mark, owns
  * itself (`own.hidden` covers both: a delete-marked or unknown block owns
@@ -210,8 +210,8 @@ export const childrenIndex = (placements, own) => {
         bucket.sort(bySlot);
     return index;
 };
-/** The order of a children list: by rank, ties by id. */
-export const bySlot = (a, b) => (a.rank === b.rank ? a.id.localeCompare(b.id) : a.rank < b.rank ? -1 : 1);
+/** The order of a children list: by rank, ties by id ({@link compareIds}). */
+export const bySlot = (a, b) => (a.rank === b.rank ? compareIds(a.id, b.id) : a.rank < b.rank ? -1 : 1);
 export const documentOrder = (kids) => {
     const ids = [];
     const at = new Map();

package/dist/crdt/placement/keys.d.ts

@@ -22,6 +22,11 @@
  *   above every key character;
  * - a table's cells show in column order ({@link cellKey}).
  */
+/**
+ * The one order of two ids on a tie (a children list, the seam, the root's
+ * tail): their code units, the order every replica computes the same.
+ */
+export declare const compareIds: (a: string, b: string) => number;
 /** Sorts below every key character: the separator of a promoted child's key. */
 export declare const PROMOTED = "!";
 /**

package/dist/crdt/placement/keys.js

@@ -22,6 +22,11 @@
  *   above every key character;
  * - a table's cells show in column order ({@link cellKey}).
  */
+/**
+ * The one order of two ids on a tie (a children list, the seam, the root's
+ * tail): their code units, the order every replica computes the same.
+ */
+export const compareIds = (a, b) => (a < b ? -1 : a > b ? 1 : 0);
 /**
  * Order-preserving alphabet: charCode order equals numeric order (64
  * characters, all safe inside a JSON string).

package/dist/crdt/placement/resolve.js

@@ -3,6 +3,7 @@ import { baseIdOf, incarnationId, incarnationsOf, LIVE_WRITERS } from '../incarn
 import { attrItems, firstItem, itemOf } from '../structs.js';
 import { cmpStamp, isBlockSlot, isRecord, itemAt, sameUnit, stampOf, unitsOf } from './slots.js';
 import { DEAD } from '../text/model.js';
+import { compareIds } from './keys.js';
 /** The stamp of a home slot's edge: below every record's. */
 const HOME = 0;
 /** The stamp of a block with no slot: below every edge (it shows at the root's tail). */
@@ -130,7 +131,7 @@ export const cycleThrough = (accepted, ownerOf, block, parent) => {
     return null;
 };
 /** The order of the blocks at the root's tail (rejected or slotless): by their edge's stamp, then id. */
-export const byTail = (a, b) => cmpStamp(a.stamp, b.stamp) || (a.id < b.id ? -1 : a.id > b.id ? 1 : 0);
+export const byTail = (a, b) => cmpStamp(a.stamp, b.stamp) || compareIds(a.id, b.id);
 /**
  * The home slot of block `id` among the slots naming its registry id
  * (`slots`: every `{ b }` slot by `b`): the one its writer wrote

package/dist/crdt/protocol.d.ts

@@ -29,7 +29,7 @@ export { SCHEMA_VERSION, META_KEY } from './edytor-doc.js';
 export { GENERATION, generationWord, frame, PROTOCOL_VERSION, GENERATION_RECORD, GenerationMismatchError, readProtocolVersion, type GenerationRecord } from './protocols/envelope.js';
 export { messageSync, messageAwareness, messageAuth, messageQueryAwareness, messageSaved, messageChunk, messageComments, MAX_FRAME_BYTES, chunkFrame, createChunkReader, ChunkError, type ChunkReader, CLOSE } from './providers/room.js';
 export { messageYjsSyncStep1, messageYjsSyncStep2, messageYjsUpdate, type SyncProtocol } from './protocols/sync.js';
-export { messagePermissionDenied, messageReadOnly, writePermissionDenied, writeReadOnly } from './protocols/auth.js';
+export { messageAccess, messagePermissionDenied, messageReadOnly, writeAccess, writePermissionDenied, writeReadOnly } from './protocols/auth.js';
 export { commentsSubscribe, commentsSnapshot, commentsChange, writeCommentsSubscribe, writeCommentsSnapshot, writeCommentsChange, readCommentsMessage, type CommentChange, type CommentMessage, type CommentSnapshot, type CommentThread, type ThreadComment } from './protocols/comments.js';
 export { applyAwarenessUpdate, encodeAwarenessUpdate, readAwarenessEntries, writeAwarenessEntries, type AwarenessEntry } from './protocols/awareness.js';
 export { createDecoder, readVarUint, readVarUint8Array, type Decoder } from 'lib0-v14/decoding';

package/dist/crdt/protocol.js

@@ -32,7 +32,7 @@ export { GENERATION, generationWord, frame, PROTOCOL_VERSION, GENERATION_RECORD,
 // ── Message types, acknowledgements and chunks ─────────────────────────
 export { messageSync, messageAwareness, messageAuth, messageQueryAwareness, messageSaved, messageChunk, messageComments, MAX_FRAME_BYTES, chunkFrame, createChunkReader, ChunkError, CLOSE } from './providers/room.js';
 export { messageYjsSyncStep1, messageYjsSyncStep2, messageYjsUpdate } from './protocols/sync.js';
-export { messagePermissionDenied, messageReadOnly, writePermissionDenied, writeReadOnly } from './protocols/auth.js';
+export { messageAccess, messagePermissionDenied, messageReadOnly, writeAccess, writePermissionDenied, writeReadOnly } from './protocols/auth.js';
 export { commentsSubscribe, commentsSnapshot, commentsChange, writeCommentsSubscribe, writeCommentsSnapshot, writeCommentsChange, readCommentsMessage } from './protocols/comments.js';
 export { applyAwarenessUpdate, encodeAwarenessUpdate, readAwarenessEntries, writeAwarenessEntries } from './protocols/awareness.js';
 // Minimal wire codec for frame bodies (lib0 — the codec the frames are

package/dist/crdt/protocols/auth.d.ts

@@ -14,10 +14,20 @@ import * as decoding from 'lib0-v14/decoding';
 export declare const messagePermissionDenied = 0;
 /** The denial of a read-only socket's write: that socket still syncs (not a terminal refusal). */
 export declare const READ_ONLY_DENIAL = "read-only";
+/** The denial of what a suggest-only socket wrote that is no suggestion's: it still syncs. */
+export declare const SUGGEST_ONLY_DENIAL = "suggest-only";
 export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
 /** The socket may read but not write: sent when it joins, before any write is refused. */
 export declare const messageReadOnly = 1;
 export declare const writeReadOnly: (encoder: encoding.Encoder) => void;
+/**
+ * The socket's access (the string that follows: `write`, `suggest` or
+ * `comment`), sent when it joins, before anything else it reads; a
+ * `comment` one's after its read-only notice (a `read` one has only the
+ * notice).
+ */
+export declare const messageAccess = 2;
+export declare const writeAccess: (encoder: encoding.Encoder, access: string) => void;
 export type PermissionDeniedHandler = (ydoc: unknown, reason: string) => void;
 /**
  * Decode one auth payload. Returns the auth message subtype so the caller
@@ -25,4 +35,4 @@ export type PermissionDeniedHandler = (ydoc: unknown, reason: string) => void;
  * do not speak is protocol skew, and this stack's contract is that skew is
  * reported, not silently dropped (same rule as unknown sync subtypes).
  */
-export declare const readAuthMessage: (decoder: decoding.Decoder, y: unknown, permissionDeniedHandler: PermissionDeniedHandler, readOnlyHandler?: (ydoc: unknown) => void) => number;
+export declare const readAuthMessage: (decoder: decoding.Decoder, y: unknown, permissionDeniedHandler: PermissionDeniedHandler, readOnlyHandler?: (ydoc: unknown) => void, accessHandler?: (access: string) => void) => number;

package/dist/crdt/protocols/auth.js

@@ -14,6 +14,8 @@ import * as decoding from 'lib0-v14/decoding';
 export const messagePermissionDenied = 0;
 /** The denial of a read-only socket's write: that socket still syncs (not a terminal refusal). */
 export const READ_ONLY_DENIAL = 'read-only';
+/** The denial of what a suggest-only socket wrote that is no suggestion's: it still syncs. */
+export const SUGGEST_ONLY_DENIAL = 'suggest-only';
 export const writePermissionDenied = (encoder, reason) => {
     encoding.writeVarUint(encoder, messagePermissionDenied);
     encoding.writeVarString(encoder, reason);
@@ -23,13 +25,24 @@ export const messageReadOnly = 1;
 export const writeReadOnly = (encoder) => {
     encoding.writeVarUint(encoder, messageReadOnly);
 };
+/**
+ * The socket's access (the string that follows: `write`, `suggest` or
+ * `comment`), sent when it joins, before anything else it reads; a
+ * `comment` one's after its read-only notice (a `read` one has only the
+ * notice).
+ */
+export const messageAccess = 2;
+export const writeAccess = (encoder, access) => {
+    encoding.writeVarUint(encoder, messageAccess);
+    encoding.writeVarString(encoder, access);
+};
 /**
  * Decode one auth payload. Returns the auth message subtype so the caller
  * can surface unknown subtypes — a valid envelope carrying an auth type we
  * do not speak is protocol skew, and this stack's contract is that skew is
  * reported, not silently dropped (same rule as unknown sync subtypes).
  */
-export const readAuthMessage = (decoder, y, permissionDeniedHandler, readOnlyHandler) => {
+export const readAuthMessage = (decoder, y, permissionDeniedHandler, readOnlyHandler, accessHandler) => {
     const authMessageType = decoding.readVarUint(decoder);
     switch (authMessageType) {
         case messagePermissionDenied:
@@ -38,6 +51,9 @@ export const readAuthMessage = (decoder, y, permissionDeniedHandler, readOnlyHan
         case messageReadOnly:
             // Unclaimed, it is returned like any subtype the caller does not speak.
             readOnlyHandler?.(y);
+            break;
+        case messageAccess:
+            accessHandler?.(decoding.readVarString(decoder));
     }
     return authMessageType;
 };