refactor(util): 💡 rename iterator next type and class

Author: streamich

src/json-crdt-extensions/peritext/block/Block.ts

@@ -1,7 +1,7 @@
 import {printTree} from 'tree-dump/lib/printTree';
 import {CONST, updateJson, updateNum} from '../../../json-hash/hash';
 import {MarkerOverlayPoint} from '../overlay/MarkerOverlayPoint';
-import {UndefEndIter, type UndefIterator} from '../../../util/iterator';
+import {UndEndIterator, type UndEndNext} from '../../../util/iterator';
 import {Inline} from './Inline';
 import {formatType, getTag} from '../slice/util';
 import {Range} from '../rga/Range';
@@ -60,7 +60,7 @@ export class Block<T = string, Attr = unknown> extends Range<T> implements IBloc
    * Iterate through all overlay points of this block, until the next marker
    * (regardless if that marker is a child or not).
    */
-  public points0(withMarker: boolean = false): UndefIterator<OverlayPoint<T>> {
+  public points0(withMarker: boolean = false): UndEndNext<OverlayPoint<T>> {
     const txt = this.txt;
     const overlay = txt.overlay;
     const iterator = overlay.points0(this.marker);
@@ -82,10 +82,10 @@ export class Block<T = string, Attr = unknown> extends Range<T> implements IBloc
   }
 
   public points(withMarker?: boolean): IterableIterator<OverlayPoint<T>> {
-    return new UndefEndIter(this.points0(withMarker));
+    return new UndEndIterator(this.points0(withMarker));
   }
 
-  protected tuples0(): UndefIterator<OverlayTuple<T>> {
+  protected tuples0(): UndEndNext<OverlayTuple<T>> {
     const overlay = this.txt.overlay;
     const marker = this.marker;
     const iterator = overlay.tuples0(marker);
@@ -103,7 +103,7 @@ export class Block<T = string, Attr = unknown> extends Range<T> implements IBloc
   /**
    * @todo Consider moving inline-related methods to {@link LeafBlock}.
    */
-  public texts0(): UndefIterator<Inline<T>> {
+  public texts0(): UndEndNext<Inline<T>> {
     const txt = this.txt;
     const overlay = txt.overlay;
     const iterator = this.tuples0();
@@ -114,7 +114,7 @@ export class Block<T = string, Attr = unknown> extends Range<T> implements IBloc
     let isFirst = true;
     let next = iterator();
     let closed = false;
-    const newIterator: UndefIterator<Inline<T>> = () => {
+    const newIterator: UndEndNext<Inline<T>> = () => {
       if (closed) return;
       const pair = next;
       next = iterator();
@@ -146,7 +146,7 @@ export class Block<T = string, Attr = unknown> extends Range<T> implements IBloc
    * @todo Consider moving inline-related methods to {@link LeafBlock}.
    */
   public texts(): IterableIterator<Inline<T>> {
-    return new UndefEndIter(this.texts0());
+    return new UndEndIterator(this.texts0());
   }
 
   public text(): string {

src/json-crdt-extensions/peritext/editor/Editor.ts

@@ -11,7 +11,7 @@ import {CommonSliceType, type SliceTypeSteps, type SliceType, type SliceTypeStep
 import {isLetter, isPunctuation, isWhitespace, stepsEqual} from './util';
 import {ValueSyncStore} from '../../../util/events/sync-store';
 import {MarkerOverlayPoint} from '../overlay/MarkerOverlayPoint';
-import {UndefEndIter, type UndefIterator} from '../../../util/iterator';
+import {UndEndIterator, type UndEndNext} from '../../../util/iterator';
 import {tick, Timespan, type ITimespanStruct} from '../../../json-crdt-patch';
 import {CursorAnchor, SliceStacking, SliceHeaderMask, SliceHeaderShift, SliceTypeCon} from '../slice/constants';
 import type {Point} from '../rga/Point';
@@ -114,7 +114,7 @@ export class Editor<T = string> implements Printable {
     return cursor ?? this.addCursor();
   }
 
-  public cursors0(): UndefIterator<Cursor<T>> {
+  public cursors0(): UndEndNext<Cursor<T>> {
     const iterator = this.txt.localSlices.iterator0();
     return () => {
       while (true) {
@@ -130,7 +130,7 @@ export class Editor<T = string> implements Printable {
   }
 
   public cursors() {
-    return new UndefEndIter(this.cursors0());
+    return new UndEndIterator(this.cursors0());
   }
 
   public forCursor(callback: (cursor: Cursor<T>) => void): void {

src/json-crdt-extensions/peritext/editor/types.ts

@@ -1,11 +1,11 @@
-import type {UndefIterator} from '../../../util/iterator';
+import type {UndEndNext} from '../../../util/iterator';
 import type {Point} from '../rga/Point';
 import type {Range} from '../rga/Range';
 import type {SliceType} from '../slice';
 import type {SliceStacking} from '../slice/constants';
 import type {ChunkSlice} from '../util/ChunkSlice';
 
-export type CharIterator<T> = UndefIterator<ChunkSlice<T>>;
+export type CharIterator<T> = UndEndNext<ChunkSlice<T>>;
 export type CharPredicate<T> = (char: T) => boolean;
 
 export type EditorPosition<T = string> = Point<T> | number | [at: number, anchor: 0 | 1];

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

@@ -10,7 +10,7 @@ import {OverlayRefSliceEnd, OverlayRefSliceStart} from './refs';
 import {compare, type ITimestampStruct} from '../../../json-crdt-patch/clock';
 import {CONST, updateNum} from '../../../json-hash/hash';
 import {MarkerSlice} from '../slice/MarkerSlice';
-import {UndefEndIter, type UndefIterator} from '../../../util/iterator';
+import {UndEndIterator, type UndEndNext} from '../../../util/iterator';
 import {SliceStacking} from '../slice/constants';
 import type {Point} from '../rga/Point';
 import type {Range} from '../rga/Range';
@@ -196,7 +196,7 @@ export class Overlay<T = string> implements Printable, Stateful {
     }) as Chunk<T>;
   }
 
-  public points0(after: undefined | OverlayPoint<T>, inclusive?: boolean): UndefIterator<OverlayPoint<T>> {
+  public points0(after: undefined | OverlayPoint<T>, inclusive?: boolean): UndEndNext<OverlayPoint<T>> {
     let curr = after ? (inclusive ? after : next(after)) : this.first();
     return () => {
       const ret = curr;
@@ -206,7 +206,7 @@ export class Overlay<T = string> implements Printable, Stateful {
   }
 
   public points(after?: undefined | OverlayPoint<T>, inclusive?: boolean): IterableIterator<OverlayPoint<T>> {
-    return new UndefEndIter(this.points0(after, inclusive));
+    return new UndEndIterator(this.points0(after, inclusive));
   }
 
   /**
@@ -220,7 +220,7 @@ export class Overlay<T = string> implements Printable, Stateful {
    * @returns All marker points in the overlay, starting from the given marker
    *     point.
    */
-  public markers0(after: undefined | MarkerOverlayPoint<T>): UndefIterator<MarkerOverlayPoint<T>> {
+  public markers0(after: undefined | MarkerOverlayPoint<T>): UndEndNext<MarkerOverlayPoint<T>> {
     let curr = after ? next2(after) : first2(this.root2);
     return () => {
       const ret = curr;
@@ -229,8 +229,8 @@ export class Overlay<T = string> implements Printable, Stateful {
     };
   }
 
-  public markers(after?: undefined | MarkerOverlayPoint<T>): UndefEndIter<MarkerOverlayPoint<T>> {
-    return new UndefEndIter(this.markers0(after));
+  public markers(after?: undefined | MarkerOverlayPoint<T>): UndEndIterator<MarkerOverlayPoint<T>> {
+    return new UndEndIterator(this.markers0(after));
   }
 
   /**
@@ -242,7 +242,7 @@ export class Overlay<T = string> implements Printable, Stateful {
    * @returns All marker points in the overlay, starting from the given marker
    *     point.
    */
-  public markersFrom0(point: Point<T>): UndefIterator<MarkerOverlayPoint<T>> {
+  public markersFrom0(point: Point<T>): UndEndNext<MarkerOverlayPoint<T>> {
     if (point.isAbsStart()) return this.markers0(undefined);
     let after = this.getOrNextLowerMarker(point);
     if (after && after.cmp(point) === 0) after = prev2(after);
@@ -261,7 +261,7 @@ export class Overlay<T = string> implements Printable, Stateful {
    *     continues until the end of the overlay.
    * @returns Iterator that returns pairs of overlay points.
    */
-  public markerPairs0(start: Point<T>, end?: Point<T>): UndefIterator<MarkerOverlayPair<T>> {
+  public markerPairs0(start: Point<T>, end?: Point<T>): UndEndNext<MarkerOverlayPair<T>> {
     const i = this.markersFrom0(start);
     let closed = false;
     let p1: MarkerOverlayPoint<T> | undefined;
@@ -293,7 +293,7 @@ export class Overlay<T = string> implements Printable, Stateful {
     };
   }
 
-  public pairs0(after: undefined | OverlayPoint<T>): UndefIterator<OverlayPair<T>> {
+  public pairs0(after: undefined | OverlayPoint<T>): UndEndNext<OverlayPair<T>> {
     const isEmpty = !this.root;
     if (isEmpty) {
       const u = undefined;
@@ -325,10 +325,10 @@ export class Overlay<T = string> implements Printable, Stateful {
   }
 
   public pairs(after?: undefined | OverlayPoint<T>): IterableIterator<OverlayPair<T>> {
-    return new UndefEndIter(this.pairs0(after));
+    return new UndEndIterator(this.pairs0(after));
   }
 
-  public tuples0(after: undefined | OverlayPoint<T>): UndefIterator<OverlayTuple<T>> {
+  public tuples0(after: undefined | OverlayPoint<T>): UndEndNext<OverlayTuple<T>> {
     const iterator = this.pairs0(after);
     return () => {
       const pair = iterator();
@@ -340,7 +340,7 @@ export class Overlay<T = string> implements Printable, Stateful {
   }
 
   public tuples(after?: undefined | OverlayPoint<T>): IterableIterator<OverlayTuple<T>> {
-    return new UndefEndIter(this.tuples0(after));
+    return new UndEndIterator(this.tuples0(after));
   }
 
   /**