reptree 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1,5 +1,3 @@
-import * as Y from 'yjs';
-
 interface OpId {
     readonly counter: number;
     readonly peerId: string;
@@ -26,18 +24,8 @@ type TreeVertexId = string;
 /**
  * Serializable CRDT data for operations
  */
-interface CRDTType {
-    type: string;
-    value: Uint8Array;
-}
-/**
- * Property type for state - includes Y.Doc for runtime usage
- */
-type VertexPropertyType = string | number | boolean | string[] | number[] | boolean[] | undefined | Y.Doc;
-/**
- * Property type for operations - includes CRDTType instead of Y.Doc
- */
-type VertexPropertyTypeInOperation = string | number | boolean | string[] | number[] | boolean[] | undefined | CRDTType;
+/** Property type for state */
+type VertexPropertyType = string | number | boolean | string[] | number[] | boolean[] | undefined;
 type TreeVertexProperty = {
     readonly key: string;
     readonly value: VertexPropertyType;
@@ -79,17 +67,15 @@ interface SetVertexProperty {
     id: OpId;
     targetId: string;
     key: string;
-    value: VertexPropertyTypeInOperation;
+    value: VertexPropertyType;
     transient: boolean;
 }
 type VertexOperation = MoveVertex | SetVertexProperty;
 declare function isMoveVertexOp(op: VertexOperation): op is MoveVertex;
 declare function isAnyPropertyOp(op: VertexOperation): op is SetVertexProperty;
-declare function isLWWPropertyOp(op: VertexOperation): op is SetVertexProperty;
-declare function isModifyPropertyOp(op: VertexOperation): op is SetVertexProperty;
 declare function newMoveVertexOp(clock: number, peerId: string, targetId: string, parentId: string | null): MoveVertex;
-declare function newSetVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyTypeInOperation): SetVertexProperty;
-declare function newSetTransientVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyTypeInOperation): SetVertexProperty;
+declare function newSetVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyType): SetVertexProperty;
+declare function newSetTransientVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyType): SetVertexProperty;
 
 type FieldSchemaLike = {
     safeParse?: (input: unknown) => {
@@ -242,7 +228,6 @@ declare class RepTree {
     private setPropertyOps;
     private propertiesAndTheirOpIds;
     private transientPropertiesAndTheirOpIds;
-    private yjsObservers;
     private localOps;
     private pendingMovesWithMissingParent;
     private pendingPropertiesWithMissingVertex;
@@ -273,12 +258,23 @@ declare class RepTree {
      * Can be used to get all operations that were generated from this peer and need to be sent to other peers.
      */
     popLocalOps(): VertexOperation[];
+    /**
+     * This is the first vertex that will contain all other vertices.
+     * If you plan to replicate a tree then don't use this method and instead merge
+     * in the ops from another tree (that will also contain the root vertex).
+     * @returns The root vertex
+     */
     createRoot(): Vertex;
     newVertex(parentId: string, props?: Record<string, VertexPropertyType> | object | null): Vertex;
     newNamedVertex(parentId: string, name: string, props?: Record<string, VertexPropertyType> | object | null): Vertex;
     moveVertex(vertexId: string, parentId: string): void;
     deleteVertex(vertexId: string): void;
     setTransientVertexProperty(vertexId: string, key: string, value: VertexPropertyType): void;
+    /**
+     * Promotes all transient (temporary) properties to persistent properties.
+     * @param vertexId - The ID of the vertex to commit transients for.
+     * @returns
+     */
     commitTransients(vertexId: string): void;
     setVertexProperty(vertexId: string, key: string, value: VertexPropertyType): void;
     setVertexProperties(vertexId: string, props: Record<string, VertexPropertyType> | object): void;
@@ -307,10 +303,8 @@ declare class RepTree {
     private applyMove;
     private setLLWPropertyAndItsOpId;
     private setTransientPropertyAndItsOpId;
-    private setupYjsObserver;
     private applyProperty;
     private applyLLWProperty;
-    private applyModifyProperty;
     private applyOperation;
     private reportOpAsApplied;
     private tryToMove;
@@ -428,4 +422,4 @@ declare class StateVector {
 
 declare function uuid(): string;
 
-export { type AliasRule, type BindOptions, type BindedVertex, type CRDTType, type MoveVertex, type OpId, type OpIdRange, RepTree, type SchemaLike, type SetVertexProperty, StateVector, TreeState, type TreeVertexId, type TreeVertexProperty, Vertex, type VertexChangeEvent, type VertexChildrenChangeEvent, type VertexMoveEvent, type VertexOperation, type VertexPropertyChangeEvent, type VertexPropertyType, type VertexPropertyTypeInOperation, VertexState, bindVertex, defaultAliases, isAnyPropertyOp, isLWWPropertyOp, isModifyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };
+export { type AliasRule, type BindOptions, type BindedVertex, type MoveVertex, type OpId, type OpIdRange, RepTree, type SchemaLike, type SetVertexProperty, StateVector, TreeState, type TreeVertexId, type TreeVertexProperty, Vertex, type VertexChangeEvent, type VertexChildrenChangeEvent, type VertexMoveEvent, type VertexOperation, type VertexPropertyChangeEvent, type VertexPropertyType, VertexState, bindVertex, defaultAliases, isAnyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import * as Y from 'yjs';
-
 interface OpId {
     readonly counter: number;
     readonly peerId: string;
@@ -26,18 +24,8 @@ type TreeVertexId = string;
 /**
  * Serializable CRDT data for operations
  */
-interface CRDTType {
-    type: string;
-    value: Uint8Array;
-}
-/**
- * Property type for state - includes Y.Doc for runtime usage
- */
-type VertexPropertyType = string | number | boolean | string[] | number[] | boolean[] | undefined | Y.Doc;
-/**
- * Property type for operations - includes CRDTType instead of Y.Doc
- */
-type VertexPropertyTypeInOperation = string | number | boolean | string[] | number[] | boolean[] | undefined | CRDTType;
+/** Property type for state */
+type VertexPropertyType = string | number | boolean | string[] | number[] | boolean[] | undefined;
 type TreeVertexProperty = {
     readonly key: string;
     readonly value: VertexPropertyType;
@@ -79,17 +67,15 @@ interface SetVertexProperty {
     id: OpId;
     targetId: string;
     key: string;
-    value: VertexPropertyTypeInOperation;
+    value: VertexPropertyType;
     transient: boolean;
 }
 type VertexOperation = MoveVertex | SetVertexProperty;
 declare function isMoveVertexOp(op: VertexOperation): op is MoveVertex;
 declare function isAnyPropertyOp(op: VertexOperation): op is SetVertexProperty;
-declare function isLWWPropertyOp(op: VertexOperation): op is SetVertexProperty;
-declare function isModifyPropertyOp(op: VertexOperation): op is SetVertexProperty;
 declare function newMoveVertexOp(clock: number, peerId: string, targetId: string, parentId: string | null): MoveVertex;
-declare function newSetVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyTypeInOperation): SetVertexProperty;
-declare function newSetTransientVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyTypeInOperation): SetVertexProperty;
+declare function newSetVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyType): SetVertexProperty;
+declare function newSetTransientVertexPropertyOp(clock: number, peerId: string, targetId: string, key: string, value: VertexPropertyType): SetVertexProperty;
 
 type FieldSchemaLike = {
     safeParse?: (input: unknown) => {
@@ -242,7 +228,6 @@ declare class RepTree {
     private setPropertyOps;
     private propertiesAndTheirOpIds;
     private transientPropertiesAndTheirOpIds;
-    private yjsObservers;
     private localOps;
     private pendingMovesWithMissingParent;
     private pendingPropertiesWithMissingVertex;
@@ -273,12 +258,23 @@ declare class RepTree {
      * Can be used to get all operations that were generated from this peer and need to be sent to other peers.
      */
     popLocalOps(): VertexOperation[];
+    /**
+     * This is the first vertex that will contain all other vertices.
+     * If you plan to replicate a tree then don't use this method and instead merge
+     * in the ops from another tree (that will also contain the root vertex).
+     * @returns The root vertex
+     */
     createRoot(): Vertex;
     newVertex(parentId: string, props?: Record<string, VertexPropertyType> | object | null): Vertex;
     newNamedVertex(parentId: string, name: string, props?: Record<string, VertexPropertyType> | object | null): Vertex;
     moveVertex(vertexId: string, parentId: string): void;
     deleteVertex(vertexId: string): void;
     setTransientVertexProperty(vertexId: string, key: string, value: VertexPropertyType): void;
+    /**
+     * Promotes all transient (temporary) properties to persistent properties.
+     * @param vertexId - The ID of the vertex to commit transients for.
+     * @returns
+     */
     commitTransients(vertexId: string): void;
     setVertexProperty(vertexId: string, key: string, value: VertexPropertyType): void;
     setVertexProperties(vertexId: string, props: Record<string, VertexPropertyType> | object): void;
@@ -307,10 +303,8 @@ declare class RepTree {
     private applyMove;
     private setLLWPropertyAndItsOpId;
     private setTransientPropertyAndItsOpId;
-    private setupYjsObserver;
     private applyProperty;
     private applyLLWProperty;
-    private applyModifyProperty;
     private applyOperation;
     private reportOpAsApplied;
     private tryToMove;
@@ -428,4 +422,4 @@ declare class StateVector {
 
 declare function uuid(): string;
 
-export { type AliasRule, type BindOptions, type BindedVertex, type CRDTType, type MoveVertex, type OpId, type OpIdRange, RepTree, type SchemaLike, type SetVertexProperty, StateVector, TreeState, type TreeVertexId, type TreeVertexProperty, Vertex, type VertexChangeEvent, type VertexChildrenChangeEvent, type VertexMoveEvent, type VertexOperation, type VertexPropertyChangeEvent, type VertexPropertyType, type VertexPropertyTypeInOperation, VertexState, bindVertex, defaultAliases, isAnyPropertyOp, isLWWPropertyOp, isModifyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };
+export { type AliasRule, type BindOptions, type BindedVertex, type MoveVertex, type OpId, type OpIdRange, RepTree, type SchemaLike, type SetVertexProperty, StateVector, TreeState, type TreeVertexId, type TreeVertexProperty, Vertex, type VertexChangeEvent, type VertexChildrenChangeEvent, type VertexMoveEvent, type VertexOperation, type VertexPropertyChangeEvent, type VertexPropertyType, VertexState, bindVertex, defaultAliases, isAnyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };

package/dist/index.js

@@ -52,12 +52,6 @@ function isMoveVertexOp(op) {
 function isAnyPropertyOp(op) {
   return "key" in op;
 }
-function isLWWPropertyOp(op) {
-  return "key" in op && "value" in op && (!op.value || typeof op.value !== "object" || !("type" in op.value));
-}
-function isModifyPropertyOp(op) {
-  return "key" in op && "value" in op && typeof op.value === "object" && op.value !== null && "type" in op.value;
-}
 function newMoveVertexOp(clock, peerId, targetId, parentId) {
   return { id: createOpId(clock, peerId), targetId, parentId };
 }
@@ -500,7 +494,6 @@ function bindVertex(tree, id, schemaOrOptions) {
 }
 
 // src/Vertex.ts
-import * as Y from "yjs";
 var Vertex = class _Vertex {
   constructor(tree, state) {
     this.tree = tree;
@@ -674,10 +667,8 @@ var Vertex = class _Vertex {
           continue;
         }
       } else if (typeof value === "object" && value !== null) {
-        if (!(value instanceof Y.Doc)) {
-          skipped.push(rawKey);
-          continue;
-        }
+        skipped.push(rawKey);
+        continue;
       } else if (!isPrimitive(value)) {
         skipped.push(rawKey);
         continue;
@@ -877,7 +868,6 @@ var StateVector = class _StateVector {
 };
 
 // src/RepTree.ts
-import * as Y2 from "yjs";
 var _RepTree = class _RepTree {
   /**
    * @param peerId - The peer ID of the current client. Should be unique across all peers.
@@ -889,7 +879,7 @@ var _RepTree = class _RepTree {
     this.setPropertyOps = [];
     this.propertiesAndTheirOpIds = /* @__PURE__ */ new Map();
     this.transientPropertiesAndTheirOpIds = /* @__PURE__ */ new Map();
-    this.yjsObservers = /* @__PURE__ */ new Map();
+    // Observers for non-structural properties are not used
     this.localOps = [];
     this.pendingMovesWithMissingParent = /* @__PURE__ */ new Map();
     this.pendingPropertiesWithMissingVertex = /* @__PURE__ */ new Map();
@@ -991,6 +981,12 @@ var _RepTree = class _RepTree {
     this.localOps = [];
     return ops;
   }
+  /**
+   * This is the first vertex that will contain all other vertices.
+   * If you plan to replicate a tree then don't use this method and instead merge
+   * in the ops from another tree (that will also contain the root vertex).
+   * @returns The root vertex
+   */
   createRoot() {
     if (this.rootVertexId) {
       throw new Error("Root vertex already exists");
@@ -1038,21 +1034,15 @@ var _RepTree = class _RepTree {
   }
   setTransientVertexProperty(vertexId, key, value) {
     this.lamportClock++;
-    let opValue;
-    if (value instanceof Y2.Doc) {
-      const state = Y2.encodeStateAsUpdate(value);
-      opValue = {
-        type: "yjs",
-        value: state
-      };
-      this.setupYjsObserver(value, vertexId, key);
-    } else {
-      opValue = value;
-    }
-    const op = newSetTransientVertexPropertyOp(this.lamportClock, this.peerId, vertexId, key, opValue);
+    const op = newSetTransientVertexPropertyOp(this.lamportClock, this.peerId, vertexId, key, value);
     this.localOps.push(op);
     this.applyProperty(op);
   }
+  /**
+   * Promotes all transient (temporary) properties to persistent properties.
+   * @param vertexId - The ID of the vertex to commit transients for.
+   * @returns 
+   */
   commitTransients(vertexId) {
     const vertex = this.state.getVertex(vertexId);
     if (!vertex) {
@@ -1069,18 +1059,7 @@ var _RepTree = class _RepTree {
   }
   setVertexProperty(vertexId, key, value) {
     this.lamportClock++;
-    let opValue;
-    if (value instanceof Y2.Doc) {
-      const state = Y2.encodeStateAsUpdate(value);
-      opValue = {
-        type: "yjs",
-        value: state
-      };
-      this.setupYjsObserver(value, vertexId, key);
-    } else {
-      opValue = value;
-    }
-    const op = newSetVertexPropertyOp(this.lamportClock, this.peerId, vertexId, key, opValue);
+    const op = newSetVertexPropertyOp(this.lamportClock, this.peerId, vertexId, key, value);
     this.localOps.push(op);
     this.applyProperty(op);
   }
@@ -1243,13 +1222,7 @@ var _RepTree = class _RepTree {
         if (!propB) {
           return false;
         }
-        if (propA.value instanceof Y2.Doc && propB.value instanceof Y2.Doc) {
-          const snapshotA = Y2.snapshot(propA.value);
-          const snapshotB = Y2.snapshot(propB.value);
-          if (!Y2.equalSnapshots(snapshotA, snapshotB)) {
-            return false;
-          }
-        } else if (propA.value !== propB.value) {
+        if (propA.value !== propB.value) {
           return false;
         }
       }
@@ -1346,40 +1319,6 @@ var _RepTree = class _RepTree {
     this.state.setTransientProperty(op.targetId, op.key, op.value);
     this.reportOpAsApplied(op);
   }
-  setupYjsObserver(doc, vertexId, key) {
-    const propertyKey = `${key}@${vertexId}`;
-    if (this.yjsObservers.has(propertyKey)) {
-      const existingDoc = this.getVertexProperty(vertexId, key);
-      if (existingDoc instanceof Y2.Doc) {
-        existingDoc.off("update", this.yjsObservers.get(propertyKey));
-      }
-      this.yjsObservers.delete(propertyKey);
-    }
-    const ydocObserver = (update, origin, doc2, transaction) => {
-      if (!transaction.local) {
-        return;
-      }
-      const crdtValue = {
-        type: "yjs",
-        value: update
-      };
-      this.lamportClock++;
-      const op = newSetVertexPropertyOp(
-        this.lamportClock,
-        this.peerId,
-        vertexId,
-        key,
-        crdtValue
-      );
-      this.localOps.push(op);
-      this.applyProperty(op);
-      if (this._stateVectorEnabled) {
-        this.stateVector.updateFromOp(op);
-      }
-    };
-    doc.on("update", ydocObserver);
-    this.yjsObservers.set(propertyKey, ydocObserver);
-  }
   applyProperty(op) {
     const targetVertex = this.state.getVertex(op.targetId);
     if (!targetVertex) {
@@ -1393,11 +1332,7 @@ var _RepTree = class _RepTree {
       return;
     }
     this.updateLamportClock(op);
-    if (isModifyPropertyOp(op)) {
-      this.applyModifyProperty(op, targetVertex);
-    } else {
-      this.applyLLWProperty(op, targetVertex);
-    }
+    this.applyLLWProperty(op, targetVertex);
   }
   applyLLWProperty(op, targetVertex) {
     const prevTransientOpId = this.transientPropertiesAndTheirOpIds.get(`${op.key}@${op.targetId}`);
@@ -1419,28 +1354,7 @@ var _RepTree = class _RepTree {
       }
     }
   }
-  applyModifyProperty(op, targetVertex) {
-    if (op.transient) {
-      console.warn("Not implemented: transient non LWW property");
-      return;
-    }
-    this.setPropertyOps.push(op);
-    const crdtValue = op.value;
-    if (crdtValue.type !== "yjs") {
-      throw new Error("Unknown CRDT type");
-    }
-    const ydoc = targetVertex.getProperty(op.key);
-    if (ydoc instanceof Y2.Doc) {
-      Y2.applyUpdate(ydoc, crdtValue.value);
-    } else {
-      const newDoc = new Y2.Doc();
-      this.setupYjsObserver(newDoc, op.targetId, op.key);
-      this.state.setProperty(op.targetId, op.key, newDoc);
-      Y2.applyUpdate(newDoc, crdtValue.value);
-    }
-    this.propertiesAndTheirOpIds.set(`${op.key}@${op.targetId}`, op.id);
-    this.reportOpAsApplied(op);
-  }
+  // Non-LWW modify-property flow removed
   applyOperation(op) {
     if (isMoveVertexOp(op)) {
       this.applyMove(op);
@@ -1565,8 +1479,6 @@ export {
   bindVertex,
   defaultAliases,
   isAnyPropertyOp,
-  isLWWPropertyOp,
-  isModifyPropertyOp,
   isMoveVertexOp,
   newMoveVertexOp,
   newSetTransientVertexPropertyOp,