refactor(json-crdt): 💡 cleanup ModelApi, remove duplicate methods

Author: streamich

src/json-crdt/__demos__/events.ts

@@ -24,7 +24,7 @@ const model = Model.create(void 0, 1234); // 1234 is the session ID
 // });
 
 // DOM Level 2 node events
-const root = model.api.r;
+const root = model.api;
 root.events.onViewChanges.listen(() => {
   console.log('Root value changed');
 });

src/json-crdt/json-patch/JsonPatch.ts

@@ -167,11 +167,11 @@ export class JsonPatch<N extends JsonNode = JsonNode<any>> {
   }
 
   public get(path: string | Path): unknown {
-    return (this.base ?? this.model.api.r).read(this.toPath(path));
+    return (this.base ?? this.model.api).read(this.toPath(path));
   }
 
   private json(steps: Path): unknown {
-    const json = (this.base ?? this.model.api.r).read(steps);
+    const json = (this.base ?? this.model.api).read(steps);
     if (json === undefined) throw new Error('NOT_FOUND');
     return json;
   }

src/json-crdt/model/Model.ts

@@ -258,7 +258,7 @@ export class Model<N extends JsonNode = JsonNode<any>> implements Printable {
    * typed proxy wrapper around the value of the root node.
    */
   public get s() {
-    return this.api.r.proxy().val;
+    return this.api.proxy().val;
   }
 
   /**

src/json-crdt/model/__tests__/Model.schema.spec.ts

@@ -35,9 +35,9 @@ describe('.setSchema()', () => {
         num: s.con(123),
       }),
     );
-    expect(model.api.r.get().node.id.sid).toBe(SESSION.GLOBAL);
-    expect(model.api.r.get().get('id').node.id.sid).toBe(SESSION.GLOBAL);
-    expect(model.api.r.get().get('num').node.id.sid).toBe(SESSION.GLOBAL);
+    expect(model.api.get().node.id.sid).toBe(SESSION.GLOBAL);
+    expect(model.api.get().get('id').node.id.sid).toBe(SESSION.GLOBAL);
+    expect(model.api.get().get('num').node.id.sid).toBe(SESSION.GLOBAL);
   });
 
   test('allows to specify custom session ID', () => {
@@ -46,9 +46,9 @@ describe('.setSchema()', () => {
       num: s.con(123),
     });
     const model = Model.create().setSchema(schema, false);
-    expect(model.api.r.get().node.id.sid).toBe(model.clock.sid);
-    expect(model.api.r.get().get('id').node.id.sid).toBe(model.clock.sid);
-    expect(model.api.r.get().get('num').node.id.sid).toBe(model.clock.sid);
+    expect(model.api.get().node.id.sid).toBe(model.clock.sid);
+    expect(model.api.get().get('id').node.id.sid).toBe(model.clock.sid);
+    expect(model.api.get().get('num').node.id.sid).toBe(model.clock.sid);
   });
 
   test('resets session ID to user specified', () => {
@@ -59,12 +59,12 @@ describe('.setSchema()', () => {
       }),
     );
     expect(model.view().num).toBe(123);
-    expect(model.api.r.get().get('num').node.id.sid).toBe(SESSION.GLOBAL);
-    model.api.r.get().set({
+    expect(model.api.get().get('num').node.id.sid).toBe(SESSION.GLOBAL);
+    model.api.get().set({
       num: 456,
     });
     expect(model.view().num).toBe(456);
-    expect(model.api.r.get().get('num').node.id.sid).not.toBe(SESSION.GLOBAL);
+    expect(model.api.get().get('num').node.id.sid).not.toBe(SESSION.GLOBAL);
   });
 });
 

src/json-crdt/model/api/__tests__/BinaryApi.spec.ts

@@ -33,5 +33,5 @@ test('.length()', () => {
       bin: s.bin(new Uint8Array([1, 2, 3])),
     }),
   );
-  expect(doc.api.r.proxy().val.bin.$.length()).toBe(3);
+  expect(doc.api.proxy().val.bin.$.length()).toBe(3);
 });

src/json-crdt/model/api/__tests__/ModelApi.proxy.spec.ts

@@ -15,7 +15,7 @@ test('proxy API supports object types', () => {
     foo: 'asdf',
     bar: 1234,
   });
-  const root = model.api.r.proxy();
+  const root = model.api.proxy();
   const rootApi = root.$;
   expect(rootApi).toBeInstanceOf(ValApi);
   expect(rootApi.node).toBeInstanceOf(RootNode);
@@ -59,7 +59,7 @@ describe('supports all node types', () => {
   // console.log(model.root + '');
 
   test('object as root node', () => {
-    const proxy = model.api.r.proxy();
+    const proxy = model.api.proxy();
     const obj = proxy.val;
     const objApi: ObjApi = obj.$;
     expect(objApi).toBeInstanceOf(ObjApi);

src/json-crdt/model/api/__tests__/NodeApi.diff.spec.ts

@@ -36,7 +36,7 @@ describe('.merge()', () => {
       foo: 'bar',
       x: 123,
     });
-    doc.api.r.merge({
+    doc.api.merge({
       foo: 'baz!',
       x: 123,
       y: 'new',
@@ -57,7 +57,7 @@ describe('.merge()', () => {
         },
       },
     });
-    doc.api.r.merge({
+    doc.api.merge({
       foo: {
         bar: {
           baz: 'asdf!',

src/json-crdt/model/api/__tests__/NodeApi.spec.ts

@@ -83,7 +83,7 @@ describe('.read()', () => {
 
   test('retrieve deep within document', () => {
     const doc = createUntypedModel();
-    expect(doc.api.r.read('/foo')).toEqual('bar');
+    expect(doc.api.read('/foo')).toEqual('bar');
     expect(doc.api.read('/foo')).toEqual('bar');
     expect(doc.api.read('/arr/0')).toEqual(1);
     expect(doc.api.read('/arr/2/nested/1')).toEqual(2);

src/json-crdt/model/api/__tests__/in.spec.ts

@@ -6,17 +6,17 @@ describe('can use .in() method to reference any model node', () => {
   const doc = Model.create();
 
   test('can access root node', () => {
-    const node = doc.api.r.asVal();
+    const node = doc.api.asVal();
     expect(node.node).toBeInstanceOf(RootNode);
   });
 
   doc.api.set({
     foo: [1],
   });
-  doc.api.r.in('/foo/0').asVal().set({bar: 'baz'});
+  doc.api.in('/foo/0').asVal().set({bar: 'baz'});
 
   test('can access array element ValNode and its contents', () => {
-    const register1 = doc.api.r.in().in('foo').in(0).asVal();
+    const register1 = doc.api.in().in('foo').in(0).asVal();
     const register2 = doc.api.val('/foo/0');
     const register3 = doc.api.val(['foo', 0]);
     expect(register1).toBeInstanceOf(ValApi);
@@ -31,7 +31,7 @@ describe('can use .in() method to reference any model node', () => {
   doc.api.obj([]).set({val: doc.api.builder.jsonVal(123)});
 
   test('can access object key ValNode and its contents', () => {
-    const register1 = doc.api.r.in().in('val').asVal();
+    const register1 = doc.api.in().in('val').asVal();
     const register2 = doc.api.val('/val');
     const register3 = doc.api.val(['val']);
     expect(register1).toBeInstanceOf(ValApi);

src/json-crdt/model/api/nodes.ts

@@ -900,13 +900,7 @@ export class ModelApi<N extends JsonNode = JsonNode> extends ValApi<RootNode<N>>
     } else throw new Error('UNKNOWN_NODE');
   }
 
-  /**
-   * Local changes API for the root node.
-   */
-  public get r() {
-    return new ValApi(this.model.root, this);
-  }
-
+  // TODO: Move to node.
   public get $(): JsonNodeToProxyPathNode<N> {
     return proxy$((path) => {
       try {
@@ -917,17 +911,6 @@ export class ModelApi<N extends JsonNode = JsonNode> extends ValApi<RootNode<N>>
     }, '$') as any;
   }
 
-  /**
-   * Traverses the model starting from the root node and returns a local
-   * changes API for a node at the given path.
-   *
-   * @param path Path at which to locate a node.
-   * @returns A local changes API for a node at the given path.
-   */
-  public in(path?: ApiPath) {
-    return this.r.in(path);
-  }
-
   /**
    * Given a JSON/CBOR value, constructs CRDT nodes recursively out of it and
    * sets the root node of the model to the constructed nodes.
@@ -977,34 +960,6 @@ export class ModelApi<N extends JsonNode = JsonNode> extends ValApi<RootNode<N>>
     this.onLocalChange.emit(from);
   }
 
-  public select(path?: ApiPath, leaf?: boolean) {
-    return this.r.select(path, leaf);
-  }
-
-  /**
-   * Reads the value at the given path in the model. If no path is provided,
-   * returns the root node's view.
-   *
-   * @param path Path at which to read the value.
-   * @returns The value at the given path, or the root node's view if no path
-   *     is provided.
-   */
-  public read(path?: ApiPath): unknown {
-    return this.r.read(path);
-  }
-
-  public add(path: ApiPath, value: unknown): boolean {
-    return this.r.add(path, value);
-  }
-
-  public replace(path: ApiPath, value: unknown): boolean {
-    return this.r.replace(path, value);
-  }
-
-  public remove(path: ApiPath, length?: number): boolean {
-    return this.r.remove(path, length);
-  }
-
   private inTx = false;
   public transaction(callback: () => void) {
     if (this.inTx) callback();