reptree 0.2.2 → 0.2.3

package/dist/index.d.cts

@@ -89,6 +89,32 @@ declare function newMoveVertexOp(clock: number, peerId: string, targetId: string
 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;
 
+type FieldSchemaLike = {
+    safeParse?: (input: unknown) => {
+        success: true;
+        data: unknown;
+    } | {
+        success: false;
+    };
+};
+type SchemaLike<T> = {
+    safeParse?: (input: unknown) => {
+        success: true;
+        data: T;
+    } | {
+        success: false;
+    };
+    parse?: (input: unknown) => T;
+    shape?: Record<string, FieldSchemaLike>;
+};
+/**
+ * Returns a live object that proxies reads/writes to a vertex.
+ * - Reads reflect the latest CRDT state.
+ * - Writes persist to the CRDT.
+ * - If a schema is provided, writes are validated. If a field schema exists in `schema.shape`, field-level validation is applied.
+ */
+declare function bindVertex<T extends Record<string, unknown>>(tree: RepTree, id: string, schema?: SchemaLike<T>): T;
+
 /**
  * A wrapper class for VertexState that provides a more convenient API
  * for working with vertices in a RepTree.
@@ -124,6 +150,8 @@ declare class Vertex {
     observeChildrenAsTypedArray<T>(listener: (children: T[]) => void): () => void;
     delete(): void;
     moveTo(parent: Vertex): void;
+    /** Returns a live reactive object bound to this vertex. Optional schema validates writes. */
+    bind<T extends Record<string, unknown>>(schema?: SchemaLike<T>): T;
 }
 
 /**
@@ -236,6 +264,12 @@ declare class RepTree {
      * When enabled, rebuilds the state vector from existing operations if needed
      */
     set stateVectorEnabled(value: boolean);
+    /**
+     * Parses the vertex properties with a provided schema that has a `parse` method (e.g., Zod schema)
+     */
+    parseVertex<T>(vertexId: string, schema: {
+        parse: (data: unknown) => T;
+    }): T;
 }
 
 declare class TreeState {
@@ -321,4 +355,4 @@ declare class StateVector {
 
 declare function uuid(): string;
 
-export { type CRDTType, type MoveVertex, type OpId, type OpIdRange, RepTree, type SetVertexProperty, StateVector, TreeState, type TreeVertexId, type TreeVertexProperty, Vertex, type VertexChangeEvent, type VertexChildrenChangeEvent, type VertexMoveEvent, type VertexOperation, type VertexPropertyChangeEvent, type VertexPropertyType, type VertexPropertyTypeInOperation, VertexState, isAnyPropertyOp, isLWWPropertyOp, isModifyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };
+export { type CRDTType, type MoveVertex, type OpId, type OpIdRange, RepTree, 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, isAnyPropertyOp, isLWWPropertyOp, isModifyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };

package/dist/index.d.ts

@@ -89,6 +89,32 @@ declare function newMoveVertexOp(clock: number, peerId: string, targetId: string
 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;
 
+type FieldSchemaLike = {
+    safeParse?: (input: unknown) => {
+        success: true;
+        data: unknown;
+    } | {
+        success: false;
+    };
+};
+type SchemaLike<T> = {
+    safeParse?: (input: unknown) => {
+        success: true;
+        data: T;
+    } | {
+        success: false;
+    };
+    parse?: (input: unknown) => T;
+    shape?: Record<string, FieldSchemaLike>;
+};
+/**
+ * Returns a live object that proxies reads/writes to a vertex.
+ * - Reads reflect the latest CRDT state.
+ * - Writes persist to the CRDT.
+ * - If a schema is provided, writes are validated. If a field schema exists in `schema.shape`, field-level validation is applied.
+ */
+declare function bindVertex<T extends Record<string, unknown>>(tree: RepTree, id: string, schema?: SchemaLike<T>): T;
+
 /**
  * A wrapper class for VertexState that provides a more convenient API
  * for working with vertices in a RepTree.
@@ -124,6 +150,8 @@ declare class Vertex {
     observeChildrenAsTypedArray<T>(listener: (children: T[]) => void): () => void;
     delete(): void;
     moveTo(parent: Vertex): void;
+    /** Returns a live reactive object bound to this vertex. Optional schema validates writes. */
+    bind<T extends Record<string, unknown>>(schema?: SchemaLike<T>): T;
 }
 
 /**
@@ -236,6 +264,12 @@ declare class RepTree {
      * When enabled, rebuilds the state vector from existing operations if needed
      */
     set stateVectorEnabled(value: boolean);
+    /**
+     * Parses the vertex properties with a provided schema that has a `parse` method (e.g., Zod schema)
+     */
+    parseVertex<T>(vertexId: string, schema: {
+        parse: (data: unknown) => T;
+    }): T;
 }
 
 declare class TreeState {
@@ -321,4 +355,4 @@ declare class StateVector {
 
 declare function uuid(): string;
 
-export { type CRDTType, type MoveVertex, type OpId, type OpIdRange, RepTree, type SetVertexProperty, StateVector, TreeState, type TreeVertexId, type TreeVertexProperty, Vertex, type VertexChangeEvent, type VertexChildrenChangeEvent, type VertexMoveEvent, type VertexOperation, type VertexPropertyChangeEvent, type VertexPropertyType, type VertexPropertyTypeInOperation, VertexState, isAnyPropertyOp, isLWWPropertyOp, isModifyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };
+export { type CRDTType, type MoveVertex, type OpId, type OpIdRange, RepTree, 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, isAnyPropertyOp, isLWWPropertyOp, isModifyPropertyOp, isMoveVertexOp, newMoveVertexOp, newSetTransientVertexPropertyOp, newSetVertexPropertyOp, uuid };

package/dist/index.js

@@ -354,6 +354,57 @@ function uuid() {
   return removeDashes(crypto.randomUUID());
 }
 
+// src/reactive.ts
+function toObject(tree, id) {
+  const obj = {};
+  for (const { key, value } of tree.getVertexProperties(id)) obj[key] = value;
+  return obj;
+}
+function bindVertex(tree, id, schema) {
+  return new Proxy({}, {
+    get(_target, prop) {
+      if (typeof prop !== "string") return void 0;
+      return tree.getVertexProperty(id, prop);
+    },
+    set(_target, prop, value) {
+      if (typeof prop !== "string") return true;
+      if (schema?.shape && schema.shape[prop]) {
+        const field = schema.shape[prop];
+        if (field.safeParse) {
+          const res = field.safeParse(value);
+          if (!res.success) throw new Error(`Invalid value for ${String(prop)}`);
+          value = res.data ?? value;
+        }
+      } else if (schema?.safeParse) {
+        const next = { ...toObject(tree, id), [prop]: value };
+        const res = schema.safeParse(next);
+        if (!res.success) throw new Error(`Invalid value for ${String(prop)}`);
+        const parsed = res.data;
+        if (parsed && Object.prototype.hasOwnProperty.call(parsed, prop)) {
+          value = parsed[prop];
+        }
+      }
+      tree.setVertexProperty(id, prop, value);
+      return true;
+    },
+    deleteProperty(_target, prop) {
+      if (typeof prop !== "string") return true;
+      tree.setVertexProperty(id, prop, void 0);
+      return true;
+    },
+    has(_target, prop) {
+      if (typeof prop !== "string") return false;
+      return !!schema?.shape && Object.prototype.hasOwnProperty.call(schema.shape, prop);
+    },
+    ownKeys() {
+      return Object.keys(schema?.shape ?? {});
+    },
+    getOwnPropertyDescriptor() {
+      return { enumerable: true, configurable: true };
+    }
+  });
+}
+
 // src/Vertex.ts
 var Vertex = class {
   constructor(tree, state) {
@@ -472,6 +523,10 @@ var Vertex = class {
   moveTo(parent) {
     this.tree.moveVertex(this.id, parent.id);
   }
+  /** Returns a live reactive object bound to this vertex. Optional schema validates writes. */
+  bind(schema) {
+    return bindVertex(this.tree, this.id, schema);
+  }
 };
 
 // src/StateVector.ts
@@ -1311,6 +1366,17 @@ var _RepTree = class _RepTree {
       this.stateVector = new StateVector();
     }
   }
+  /**
+   * Parses the vertex properties with a provided schema that has a `parse` method (e.g., Zod schema)
+   */
+  parseVertex(vertexId, schema) {
+    const propsArray = this.getVertexProperties(vertexId);
+    const propsObject = {};
+    for (const { key, value } of propsArray) {
+      propsObject[key] = value;
+    }
+    return schema.parse(propsObject);
+  }
 };
 _RepTree.NULL_VERTEX_ID = "0";
 var RepTree = _RepTree;
@@ -1320,6 +1386,7 @@ export {
   TreeState,
   Vertex,
   VertexState,
+  bindVertex,
   isAnyPropertyOp,
   isLWWPropertyOp,
   isModifyPropertyOp,