edytor 3.0.0 → 5.0.0

package/dist/crdt/providers/websocket.d.ts

@@ -7,6 +7,8 @@ export type WebsocketProviderEvents = {
     status: (event: {
         status: 'connected' | 'disconnected' | 'connecting';
     }) => void;
+    /** What the room says this connection's user may do, as it joins (and at a change in place). */
+    access: (access: 'write' | 'suggest' | 'comment' | 'read', provider: unknown) => void;
     synced: (state: boolean) => void;
     'connection-close': (event: CloseEvent | null, provider: unknown) => void;
     'connection-error': (event: Event, provider: unknown) => void;
@@ -221,11 +223,11 @@ export declare const bindWebsocketProvider: (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<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<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: WebsocketProviderEvents[NAME]): 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: 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: 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: WebsocketProviderEvents[NAME]): 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: 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: WebsocketProviderEvents[NAME]): void;
         };
     };
     watchComments: (server: string | null, roomName: string, listener: (message: CommentMessage) => void) => (() => void);

package/dist/crdt/providers/websocket.js

@@ -52,14 +52,14 @@ import * as math from 'lib0-v14/math';
 import * as url from 'lib0-v14/url';
 import { Awareness, removeAwarenessStates } from '../protocols/awareness.js';
 import { IsolatedObservable } from '../protocols/observable.js';
-import { messagePermissionDenied, messageReadOnly, READ_ONLY_DENIAL, readAuthMessage } from '../protocols/auth.js';
+import { messagePermissionDenied, messageAccess, messageReadOnly, READ_ONLY_DENIAL, SUGGEST_ONLY_DENIAL, readAuthMessage } from '../protocols/auth.js';
 import { bindSync } from '../protocols/sync.js';
 import { readCommentsMessage, writeCommentsSubscribe } from '../protocols/comments.js';
 import { frame } from '../protocols/envelope.js';
 import { assertRoomId, beginDestroy, bindRoomProtocol, tabs, chunkFrame, CLOSE, createChunkReader, emitFailed, initLifecycle, isRefusal, LOCAL_PRESENCE_LOSS, markSynced, messageAuth, messageChunk, messageComments, messageSaved, messageSync, MAX_FRAME_BYTES, SyncRefusedError } from './room.js';
 import { asEngineDoc } from '../structs.js';
 import { ATTRIBUTION_ROOT } from '../schema.js';
-import { ATTRIBUTION_ORIGIN } from '../attribution/attribution.js';
+import { ATTRIBUTION_ORIGIN, writerOf } from '../attribution/attribution.js';
 // @todo - this should depend on awareness.outdatedTime
 const messageReconnectTimeout = 30000;
 /** Silence after which the socket is sent one text `ping` (a room auto-answers `pong`). */
@@ -122,12 +122,17 @@ export const bindWebsocketProvider = (Y) => {
                     if (readOnly)
                         provider._writes.deny();
                     provider.emit('permission-denied', [reason, provider]);
-                    if (!readOnly)
+                    // What a suggest-only socket may not write is stripped: the socket stays.
+                    if (!readOnly && reason !== SUGGEST_ONLY_DENIAL)
                         emitFailed(provider, new Error(`permission denied: ${reason}`));
                 }, 
                 // The room's notice at the join: a state, not a refusal (no event).
-                () => provider._writes.deny());
-                if (authType !== messagePermissionDenied && authType !== messageReadOnly) {
+                () => provider._writes.deny(), 
+                // The room's word at the join, and at a change in place (`read`).
+                (access) => provider.emit('access', [access, provider]));
+                if (authType !== messagePermissionDenied &&
+                    authType !== messageReadOnly &&
+                    authType !== messageAccess) {
                     // An auth type we do not speak inside a valid v14 envelope is
                     // protocol skew — reported, never dropped silently.
                     provider.emit('message-error', [
@@ -262,10 +267,12 @@ export const bindWebsocketProvider = (Y) => {
      * reload, its other tabs), and a seed writer (content any replica may
      * write, never stripped). Another actor's structs are not this replica's
      * to save: a room restored from a lagging snapshot strips them for good.
-     * A doc without a binding for its own id (a raw doc) owns all.
+     * The actor is the binding of the doc's own id, written with its first
+     * write, and before it the actor the document attached (`writerOf`). A
+     * raw doc, with neither, owns all.
      */
     const ownerOf = (doc) => {
-        const actor = actorOf(doc, doc.clientID);
+        const actor = writerOf(asEngineDoc(doc));
         return (client) => actor === undefined ||
             client === doc.clientID ||
             client < seedBand ||

package/dist/crdt/purge.d.ts

@@ -9,12 +9,16 @@
  * The horizon is a state vector: an item whose clock is below it was
  * stored by the room before the horizon's time (`room.purge.timing`). A
  * deletion's time is the struct that made it: a block's oldest live delete
- * mark (a withdrawn block: its withdraw mark, and the marks of what it last
- * held), a text delete mark record, a placement candidate.
+ * mark (a withdrawn block: its withdraw mark, and the records of what it last
+ * held), a text hold record, a move record. A delete of a session whose
+ * history ended (a release record, `hist.release.end`) is past the horizon
+ * whatever its time: a delete or withdraw mark, a text hold record of that
+ * writer below the record's clock. A move or a merge waits for the horizon.
  */
 import type { EngineApi, EngineDoc } from './engine-api.js';
 import { type PlacementModel } from './placement/model.js';
 import { type TextEngine } from './text/model.js';
+import { type SuggestFacade } from './doc/suggest.js';
 /** The horizon: the time and encoded state vector of the room's epoch (`room.purge.timing`). */
 export type Horizon = {
     at: number;
@@ -24,14 +28,12 @@ export type Horizon = {
 export type PurgeReport = {
     /** Blocks removed: registry entry deleted, node collected. */
     removed: number;
-    /** Deleted blocks kept (they delimit a live text, or a block is placed under them) whose stream, data and claims were deleted. */
+    /** Deleted blocks kept (a live block streams in their text, two boundaries name them, or a block is placed under them) whose stream, data and claims were deleted. */
     emptied: number;
-    /** Text delete mark records deleted. */
+    /** Text hold records deleted (what they held deleted with them). */
     marks: number;
-    /** Restoration records deleted (their copies collected). */
+    /** Move records dropped: old ones no block shows at any more (a lost move, a move of removed blocks). */
     records: number;
-    /** Placement candidates dropped (runner-ups of an old, accepted winner). */
-    candidates: number;
     /** Claims naming a removed block, deleted from the blocks that hold them. */
     claims: number;
     /**
@@ -40,13 +42,26 @@ export type PurgeReport = {
      * contributors at the merge): deleted, their registry entries kept.
      */
     merged: number;
+    /** Release records the horizon covers (`hist.release.end`): deleted. */
+    released: number;
+    /**
+     * Suggestions decided before the horizon (`sugg.purge`): nothing of them
+     * pending, their records' entries older than it: their records deleted.
+     */
+    suggestions: number;
 };
+/**
+ * The ended histories a document holds (`hist.release.end`): per writer,
+ * the clock its latest live release record ended at (what it wrote below
+ * it is released).
+ */
+export declare const releasesOf: (doc: EngineDoc) => Map<number, number>;
 /** The horizon a document holds (`null`: never purged). */
 export declare const readHorizon: (doc: EngineDoc) => Horizon | null;
 export declare const bindPurge: (Y: EngineApi) => {
-    purge: (doc: EngineDoc, facade: {
+    purge: (doc: EngineDoc, facade: Partial<SuggestFacade> & {
         model: PlacementModel;
         text: TextEngine;
-    }, horizon: Horizon) => PurgeReport;
+    }, horizon: Horizon | null) => PurgeReport;
 };
 export type PurgeBinding = ReturnType<typeof bindPurge>;