reptree 0.7.0 → 0.8.0

package/dist/index.cjs

@@ -501,18 +501,29 @@ function bindVertex(tree, id, schemaOrOptions) {
 // src/Vertex.ts
 var Vertex = class _Vertex {
   constructor(tree, state) {
-    this.tree = tree;
     this.state = state;
+    this._tree = tree;
   }
+  /** Returns the tree this vertex belongs to. */
+  get tree() {
+    return this._tree;
+  }
+  set tree(value) {
+    this._tree = value;
+  }
+  /** Returns the ID of this vertex. */
   get id() {
     return this.state.id;
   }
+  /** Returns the name of this vertex. The name is stored as a property with the key 'name'. */
   get name() {
     return this.getProperty("name");
   }
+  /** Sets the name of this vertex. The name is stored as a property with the key 'name'. */
   set name(name) {
     this.tree.setVertexProperty(this.id, "name", name);
   }
+  /** Returns the creation date of this vertex. The creation date is stored as a property with the key '_c'. */
   get createdAt() {
     const createdAt = this.getProperty("_c");
     if (!createdAt) {
@@ -520,30 +531,51 @@ var Vertex = class _Vertex {
     }
     return new Date(createdAt);
   }
-  get path() {
-    throw new Error("Not implemented");
-  }
+  /** Returns the ID of the parent vertex of this vertex. */
   get parentId() {
     return this.state.parentId;
   }
+  /** Returns the parent vertex of this vertex. */
   get parent() {
     if (!this.parentId) {
       return void 0;
     }
     return this.tree.getVertex(this.parentId);
   }
+  /** Returns the children vertices of this vertex. */
   get children() {
     return this.tree.getChildren(this.id);
   }
+  /** Returns the IDs of the children vertices of this vertex. */
   get childrenIds() {
     return this.tree.getChildrenIds(this.id);
   }
+  /** Returns the ancestors of this vertex. The first element is the root vertex.
+   * E.g root -> grandparent -> parent.
+   * Doesn't include this vertex in the array.
+   */
+  get ancestors() {
+    return this.tree.getAncestors(this.id);
+  }
+  /** Returns the ID of the root vertex of the tree this vertex belongs to. */
+  get treeId() {
+    return this.root.id;
+  }
+  /** Returns the root vertex of the tree this vertex belongs to. */
+  get root() {
+    const root = this.tree.root;
+    if (!root) {
+      throw new Error("Root vertex of the tree is not set");
+    }
+    return root;
+  }
   getAsTypedObject() {
     return this.getProperties();
   }
   getChildrenAsTypedArray() {
     return this.children.map((v) => v.getAsTypedObject());
   }
+  /** Creates a new child vertex of this vertex. */
   newChild(props) {
     if (props && typeof props === "object" && "children" in props) {
       throw new Error("Passing children inside props is not supported at the moment");
@@ -551,6 +583,7 @@ var Vertex = class _Vertex {
     const normalized = _Vertex.normalizePropsForCreation(props);
     return this.tree.newVertex(this.id, normalized);
   }
+  /** Creates a new named child vertex of this vertex. */
   newNamedChild(name, props) {
     if (props && typeof props === "object" && "children" in props) {
       throw new Error("Passing children inside props is not supported at the moment");
@@ -558,6 +591,7 @@ var Vertex = class _Vertex {
     const normalized = _Vertex.normalizePropsForCreation(props);
     return this.tree.newNamedVertex(this.id, name, normalized);
   }
+  /** Sets a property on this vertex. */
   setProperty(key, value) {
     const existingValue = this.getProperty(key, false);
     if (existingValue === value) {
@@ -565,6 +599,7 @@ var Vertex = class _Vertex {
     }
     this.tree.setVertexProperty(this.id, key, value);
   }
+  /** Sets a transient property on this vertex. Transient properties are not persisted to the tree and are not included in the state vector. */
   setTransientProperty(key, value) {
     const existingValue = this.getProperty(key);
     if (existingValue === value) {
@@ -572,17 +607,21 @@ var Vertex = class _Vertex {
     }
     this.tree.setTransientVertexProperty(this.id, key, value);
   }
+  /** Promotes all transient (temporary) properties to persistent properties. */
   commitTransients() {
     this.tree.commitTransients(this.id);
   }
+  /** Sets multiple properties on this vertex. */
   setProperties(props) {
     for (const [key, value] of Object.entries(props)) {
       this.setProperty(key, value);
     }
   }
+  /** Returns the value of a property on this vertex. */
   getProperty(key, includingTransient = true) {
     return this.tree.getVertexProperty(this.id, key, includingTransient);
   }
+  /** Returns all properties on this vertex. */
   getProperties() {
     const props = {};
     this.tree.getVertexProperties(this.id).forEach((p) => {
@@ -602,10 +641,12 @@ var Vertex = class _Vertex {
   findAllTypedChildrenWithProperty(key, value) {
     return this.findAllChildrenWithProperty(key, value).map((c) => c.getAsTypedObject());
   }
+  /** Observes changes to this vertex. */
   observe(listener) {
     const unobserve = this.tree.observe(this.id, listener);
     return () => unobserve();
   }
+  /** Observes changes to the children of this vertex. */
   observeChildren(listener) {
     const unobserve = this.tree.observe(this.id, (events) => {
       if (events.some((e) => e.type === "children")) {
@@ -935,7 +976,6 @@ var _RepTree = class _RepTree {
     this.setPropertyOps = [];
     this.propertiesAndTheirOpIds = /* @__PURE__ */ new Map();
     this.transientPropertiesAndTheirOpIds = /* @__PURE__ */ new Map();
-    // Observers for non-structural properties are not used
     this.localOps = [];
     this.pendingMovesWithMissingParent = /* @__PURE__ */ new Map();
     this.pendingPropertiesWithMissingVertex = /* @__PURE__ */ new Map();
@@ -1000,6 +1040,7 @@ var _RepTree = class _RepTree {
   getChildrenIds(vertexId) {
     return this.state.getChildrenIds(vertexId);
   }
+  /** Returns the ancestors of the given vertex. The first element is the root vertex. */
   getAncestors(vertexId) {
     const ancestors = [];
     let currentVertex = this.state.getVertex(vertexId);