Merge pull request #606 from streamich/overlay-2

Peritext Overlay marker points

Author: streamich

CHANGELOG.md

@@ -1,14 +1,12 @@
 # [15.6.0](https://github.com/streamich/json-joy/compare/v15.5.0...v15.6.0) (2024-04-28)
 
-
 ### Bug Fixes
 
-* **json-crdt:** 🐛 store golbal session in clock vector ([407c383](https://github.com/streamich/json-joy/commit/407c38321ea43916cc8ccd0ce0ff3f678e5be76e))
-
+- **json-crdt:** 🐛 store golbal session in clock vector ([407c383](https://github.com/streamich/json-joy/commit/407c38321ea43916cc8ccd0ce0ff3f678e5be76e))
 
 ### Features
 
-* **json-crdt:** 🎸 use SESSION.GLOBAL for default value and schema setup ([4813bc9](https://github.com/streamich/json-joy/commit/4813bc99d91e5a7287fc23b51ad29b0a37a18d91))
+- **json-crdt:** 🎸 use SESSION.GLOBAL for default value and schema setup ([4813bc9](https://github.com/streamich/json-joy/commit/4813bc99d91e5a7287fc23b51ad29b0a37a18d91))
 
 # [15.5.0](https://github.com/streamich/json-joy/compare/v15.4.1...v15.5.0) (2024-04-26)
 

src/json-crdt-extensions/peritext/overlay/MarkerOverlayPoint.ts

@@ -0,0 +1,51 @@
+import {OverlayPoint} from './OverlayPoint';
+import {SliceType} from '../types';
+import type {Anchor} from '../rga/constants';
+import type {AbstractRga} from '../../../json-crdt/nodes/rga';
+import type {ITimestampStruct} from '../../../json-crdt-patch/clock';
+import type {MarkerSlice} from '../slice/MarkerSlice';
+import {printTree} from 'sonic-forest/lib/print/printTree';
+
+export class MarkerOverlayPoint extends OverlayPoint {
+  /**
+   * Hash value of the preceding text contents, up until the next marker.
+   */
+  public textHash: number = 0;
+
+  constructor(
+    protected readonly rga: AbstractRga<string>,
+    id: ITimestampStruct,
+    anchor: Anchor,
+    public readonly marker: MarkerSlice,
+  ) {
+    super(rga, id, anchor);
+  }
+
+  /**
+   * @todo Rename or access it directly.
+   * @deprecated
+   */
+  public markerHash(): number {
+    return this.marker ? this.marker.hash : 0;
+  }
+
+  public type(): SliceType {
+    return this.marker && this.marker.type;
+  }
+
+  public data(): unknown {
+    return this.marker && this.marker.data();
+  }
+
+  // ---------------------------------------------------------------- Printable
+
+  public toStringName(tab: string, lite?: boolean): string {
+    const hash = lite ? '' : `#${this.textHash.toString(36).slice(-4)}`;
+    const tag = lite ? '' : `, type = ${JSON.stringify(this.type() as any)}`;
+    return `${super.toStringName(tab, lite)}${lite ? '' : ' '}${hash}${tag}`;
+  }
+
+  public toString(tab: string = '', lite?: boolean): string {
+    return super.toString(tab, lite) + (lite ? '' : printTree(tab, [(tab) => this.marker.toString(tab)]));
+  }
+}

src/json-crdt-extensions/peritext/overlay/OverlayPoint.ts

@@ -2,7 +2,7 @@ import {Point} from '../rga/Point';
 import {compare} from '../../../json-crdt-patch/clock';
 import {OverlayRef, OverlayRefSliceEnd, OverlayRefSliceStart} from './refs';
 import {printTree} from 'sonic-forest/lib/print/printTree';
-import type {SplitSlice} from '../slice/SplitSlice';
+import type {MarkerSlice} from '../slice/MarkerSlice';
 import type {HeadlessNode} from 'sonic-forest/lib/types';
 import type {Printable} from '../../../util/print/types';
 import type {Slice} from '../slice/types';
@@ -157,7 +157,7 @@ export class OverlayPoint extends Point implements Printable, HeadlessNode {
    *
    * @param slice A marker (split slice).
    */
-  public addMarkerRef(slice: SplitSlice): void {
+  public addMarkerRef(slice: MarkerSlice): void {
     this.refs.push(slice);
     this.addMarker(slice);
   }

src/json-crdt-extensions/peritext/overlay/refs.ts

@@ -1,4 +1,4 @@
-import type {SplitSlice} from '../slice/SplitSlice';
+import type {MarkerSlice} from '../slice/MarkerSlice';
 import type {Slice} from '../slice/types';
 
 /**
@@ -8,7 +8,7 @@ import type {Slice} from '../slice/types';
  * and one to the end slice.
  */
 export type OverlayRef =
-  | SplitSlice // Ref to a *marker* slice
+  | MarkerSlice // Ref to a *marker*
   | OverlayRefSliceStart // Ref to the start of an annotation slice
   | OverlayRefSliceEnd; // Ref to the end of an annotation slice
 

src/json-crdt-extensions/peritext/slice/MarkerSlice.ts

@@ -0,0 +1,9 @@
+import {PersistedSlice} from './PersistedSlice';
+
+/**
+ * Represents a block split in the text, i.e. it is a *marker* that shows
+ * where a block was split.
+ *
+ * @deprecated
+ */
+export class MarkerSlice extends PersistedSlice {}

src/json-crdt-extensions/peritext/slice/PersistedSlice.ts

@@ -10,7 +10,6 @@ import {VecNode} from '../../../json-crdt/nodes';
 import {prettyOneLine} from '../../../json-pretty';
 import {validateType} from './util';
 import {s} from '../../../json-crdt-patch';
-import type {JsonNode} from '../../../json-crdt/nodes';
 import type {ITimestampStruct} from '../../../json-crdt-patch/clock';
 import type {ArrChunk} from '../../../json-crdt/nodes';
 import type {MutableSlice, SliceUpdateParams} from './types';

src/json-crdt-extensions/peritext/slice/Slices.ts

@@ -5,7 +5,7 @@ import {updateRga} from '../../../json-crdt/hash';
 import {CONST, updateNum} from '../../../json-hash';
 import {printTree} from '../../../util/print/printTree';
 import {SliceBehavior, SliceHeaderShift, SliceTupleIndex} from './constants';
-import {SplitSlice} from './SplitSlice';
+import {MarkerSlice} from './MarkerSlice';
 import {VecNode} from '../../../json-crdt/nodes';
 import {AvlMap} from 'sonic-forest/lib/avl/AvlMap';
 import type {Slice} from './types';
@@ -56,14 +56,17 @@ export class Slices implements Stateful, Printable {
     const txt = this.txt;
     const slice =
       behavior === SliceBehavior.Split
-        ? new SplitSlice(txt, txt.str, chunk, tuple, behavior, type, start, end)
+        ? new MarkerSlice(txt, txt.str, chunk, tuple, behavior, type, start, end)
         : new PersistedSlice(txt, txt.str, chunk, tuple, behavior, type, start, end);
     this.list.set(chunk.id, slice);
     return slice;
   }
 
-  public insSplit(range: Range, type: SliceType, data?: unknown): SplitSlice {
-    return this.ins(range, SliceBehavior.Split, type, data) as SplitSlice;
+  /**
+   * @todo Rename to `insMarker`.
+   */
+  public insSplit(range: Range, type: SliceType, data?: unknown): MarkerSlice {
+    return this.ins(range, SliceBehavior.Split, type, data) as MarkerSlice;
   }
 
   public insStack(range: Range, type: SliceType, data?: unknown): PersistedSlice {
@@ -89,7 +92,7 @@ export class Slices implements Stateful, Printable {
     let slice = PersistedSlice.deserialize(txt, rga, chunk, tuple);
     // TODO: Simplify, remove `SplitSlice` class.
     if (slice.isSplit())
-      slice = new SplitSlice(txt, rga, chunk, tuple, slice.behavior, slice.type, slice.start, slice.end);
+      slice = new MarkerSlice(txt, rga, chunk, tuple, slice.behavior, slice.type, slice.start, slice.end);
     return slice;
   }
 

src/json-crdt-extensions/peritext/slice/SplitSlice.ts

@@ -27,6 +27,8 @@ export const enum SliceBehavior {
   /**
    * A Split slice, which is used to mark a block split position in the document.
    * For example, paragraph, heading, blockquote, etc.
+   *
+   * @todo Rename to `Marker`.
    */
   Split = 0b000,