reptree 0.6.0 → 0.8.0

package/README.md

@@ -33,9 +33,10 @@ const qa = company.newNamedChild("qa");
 // Create a vertex in another vertex
 const alice = qa.newChild();
 
-// Set properties
+// Set properties (supports any JSON-serializable values)
 alice.setProperty("name", "Alice");
 alice.setProperty("age", 32);
+alice.setProperty("meta", { department: "QA", skills: ["cypress", "playwright"], flags: { lead: false } });
 
 // Move the vertex inside a different vertex
 alice.moveTo(devs);
@@ -89,8 +90,7 @@ const logoFile = imagesFolder.newNamedChild("logo.png");
 logoFile.setProperties({
   type: "file",
   size: 15360,
-  dimensions: "512x512",
-  format: "png",
+  meta: { dimensions: "512x512", format: "png" },
   s3Path: "s3://my-bucket/images/logo.png",
 });
 

package/dist/index.cjs

@@ -385,7 +385,7 @@ var TreeState = class {
   }
 };
 
-// src/uuid.ts
+// src/utils/uuid.ts
 var removeDashes = (guid) => guid.replace(/-/g, "");
 function uuid() {
   return removeDashes(crypto.randomUUID());
@@ -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,13 +583,15 @@ 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");
     }
-    const normalized = _Vertex.normalizePropsForCreation(props, name);
+    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")) {
@@ -634,21 +675,32 @@ var Vertex = class _Vertex {
    * - Filters unsupported field types with a console warning
    * - When a name param is provided to newNamedChild, ignores conflicting name in props
    */
-  static normalizePropsForCreation(props, explicitName) {
+  static normalizePropsForCreation(props) {
     if (!props) return null;
     const input = props;
     const out = {};
     const skipped = [];
+    const isJsonValue2 = (v) => {
+      if (v === null) return true;
+      const t = typeof v;
+      if (t === "string" || t === "number" || t === "boolean") return true;
+      if (Array.isArray(v)) return v.every(isJsonValue2);
+      if (t === "object") {
+        const proto = Object.getPrototypeOf(v);
+        if (proto !== Object.prototype && proto !== null) return false;
+        for (const val of Object.values(v)) {
+          if (!isJsonValue2(val)) return false;
+        }
+        return true;
+      }
+      return false;
+    };
     for (const [rawKey, rawValue] of Object.entries(input)) {
       if (rawValue === void 0) {
         continue;
       }
       if (rawKey === "children") continue;
       let key = rawKey;
-      if (rawKey === "name" && explicitName !== void 0) {
-        console.warn('newNamedChild: "name" in props is ignored because a name argument was provided');
-        continue;
-      }
       let value = rawValue;
       if (key === "_c") {
         if (value instanceof Date) {
@@ -659,23 +711,14 @@ var Vertex = class _Vertex {
           continue;
         }
       }
-      const isPrimitive = (v) => typeof v === "string" || typeof v === "number" || typeof v === "boolean";
-      if (Array.isArray(value)) {
-        if (!value.every(isPrimitive)) {
-          skipped.push(rawKey);
-          continue;
-        }
-      } else if (typeof value === "object" && value !== null) {
-        skipped.push(rawKey);
-        continue;
-      } else if (!isPrimitive(value)) {
+      if (!isJsonValue2(value)) {
         skipped.push(rawKey);
         continue;
       }
       out[key] = value;
     }
     if (skipped.length > 0) {
-      console.warn(`Some fields were skipped due to unsupported types: ${skipped.join(", ")}`);
+      throw new Error(`Unsupported property types for keys: ${skipped.join(", ")}`);
     }
     return Object.keys(out).length > 0 ? out : null;
   }
@@ -866,6 +909,61 @@ var StateVector = class _StateVector {
   }
 };
 
+// src/utils/deepEqual.ts
+function deepEqual(a, b) {
+  if (a === b) return true;
+  if (a === null || b === null) return a === b;
+  const ta = typeof a;
+  const tb = typeof b;
+  if (ta !== tb) return false;
+  if (ta !== "object") return false;
+  const aIsArr = Array.isArray(a);
+  const bIsArr = Array.isArray(b);
+  if (aIsArr || bIsArr) {
+    if (!(aIsArr && bIsArr)) return false;
+    if (a.length !== b.length) return false;
+    for (let i = 0; i < a.length; i++) {
+      if (!deepEqual(a[i], b[i])) return false;
+    }
+    return true;
+  }
+  const aProto = Object.getPrototypeOf(a);
+  const bProto = Object.getPrototypeOf(b);
+  if (aProto !== Object.prototype && aProto !== null || bProto !== Object.prototype && bProto !== null) {
+    return false;
+  }
+  const aKeys = Object.keys(a);
+  const bKeys = Object.keys(b);
+  if (aKeys.length !== bKeys.length) return false;
+  for (const key of aKeys) {
+    if (!Object.prototype.hasOwnProperty.call(b, key)) return false;
+    if (!deepEqual(a[key], b[key])) return false;
+  }
+  return true;
+}
+
+// src/utils/isJsonValue.ts
+function isJsonValue(v) {
+  if (v === void 0) return true;
+  if (v === null) return true;
+  const t = typeof v;
+  if (t === "string" || t === "number" || t === "boolean") return true;
+  if (t === "bigint" || t === "function" || t === "symbol") return false;
+  if (Array.isArray(v)) return v.every(isJsonValue);
+  if (t === "object") {
+    if (v instanceof Date) return false;
+    if (v instanceof Map || v instanceof Set || v instanceof RegExp) return false;
+    if (ArrayBuffer.isView(v)) return false;
+    const proto = Object.getPrototypeOf(v);
+    if (proto !== Object.prototype && proto !== null) return false;
+    for (const val of Object.values(v)) {
+      if (!isJsonValue(val)) return false;
+    }
+    return true;
+  }
+  return false;
+}
+
 // src/RepTree.ts
 var _RepTree = class _RepTree {
   /**
@@ -878,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();
@@ -943,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);
@@ -1032,6 +1130,9 @@ var _RepTree = class _RepTree {
     this.moveVertex(vertexId, _RepTree.NULL_VERTEX_ID);
   }
   setTransientVertexProperty(vertexId, key, value) {
+    if (!isJsonValue(value)) {
+      throw new Error(`Unsupported transient property value for key "${key}"`);
+    }
     this.lamportClock++;
     const op = newSetTransientVertexPropertyOp(this.lamportClock, this.peerId, vertexId, key, value);
     this.localOps.push(op);
@@ -1057,6 +1158,29 @@ var _RepTree = class _RepTree {
     vertex.clearAllTransientProperties();
   }
   setVertexProperty(vertexId, key, value) {
+    const isJsonValue2 = (v) => {
+      if (v === void 0) return true;
+      if (v === null) return true;
+      const t = typeof v;
+      if (t === "string" || t === "number" || t === "boolean") return true;
+      if (t === "bigint" || t === "function" || t === "symbol") return false;
+      if (Array.isArray(v)) return v.every(isJsonValue2);
+      if (t === "object") {
+        if (v instanceof Date) return false;
+        if (v instanceof Map || v instanceof Set || v instanceof RegExp) return false;
+        if (ArrayBuffer.isView(v)) return false;
+        const proto = Object.getPrototypeOf(v);
+        if (proto !== Object.prototype && proto !== null) return false;
+        for (const val of Object.values(v)) {
+          if (!isJsonValue2(val)) return false;
+        }
+        return true;
+      }
+      return false;
+    };
+    if (!isJsonValue2(value)) {
+      throw new Error(`Unsupported property value for key "${key}"`);
+    }
     this.lamportClock++;
     const op = newSetVertexPropertyOp(this.lamportClock, this.peerId, vertexId, key, value);
     this.localOps.push(op);
@@ -1218,12 +1342,8 @@ var _RepTree = class _RepTree {
       }
       for (const propA of propertiesA) {
         const propB = propertiesB.find((p) => p.key === propA.key);
-        if (!propB) {
-          return false;
-        }
-        if (propA.value !== propB.value) {
-          return false;
-        }
+        if (!propB) return false;
+        if (!deepEqual(propA.value, propB.value)) return false;
       }
     }
     for (const childId of childrenA) {
@@ -1353,7 +1473,6 @@ var _RepTree = class _RepTree {
       }
     }
   }
-  // Non-LWW modify-property flow removed
   applyOperation(op) {
     if (isMoveVertexOp(op)) {
       this.applyMove(op);