Merge pull request #912 from streamich/arr-update-operation

Introduce "upd_arr" operation

Author: streamich

package.json

@@ -124,13 +124,13 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "rxjs": "^7.8.2",
-    "ts-jest": "^29.1.2",
-    "ts-loader": "^9.5.1",
+    "ts-jest": "^29.4.0",
+    "ts-loader": "^9.5.2",
     "ts-node": "^10.9.2",
-    "tslib": "^2.6.2",
+    "tslib": "^2.8.1",
     "tslint": "^6.1.3",
     "tslint-config-common": "^1.6.2",
-    "typescript": "^5.4.5",
+    "typescript": "^5.8.3",
     "use-t": "^1.6.3",
     "webpack": "^5.95.0",
     "webpack-cli": "^5.1.4",

src/json-crdt-extensions/ModelWithExt.ts

@@ -4,7 +4,6 @@ import {Extensions} from '../json-crdt/extensions/Extensions';
 import {Model} from '../json-crdt/model';
 import type {NodeBuilder} from '../json-crdt-patch';
 import type {SchemaToJsonNode} from '../json-crdt/schema/types';
-import type {JsonNode} from '../json-crdt/nodes';
 
 const extensions = new Extensions();
 
@@ -21,7 +20,7 @@ export class ModelWithExt {
   public static readonly create = <S extends NodeBuilder | unknown>(
     schema?: S,
     sidOrClock: clock.ClockVector | number = Model.sid(),
-  ): Model<S extends NodeBuilder ? SchemaToJsonNode<S> : JsonNode> => {
+  ) => {
     const model = Model.create(schema, sidOrClock);
     model.ext = extensions;
     return model;

src/json-crdt-extensions/mval/__tests__/MvalExt.spec.ts

@@ -8,7 +8,7 @@ test('view should preserve identity', () => {
       mv: mval.new(1),
     }),
   );
-  expect(model.s.mv.toView()).toBe(model.s.mv.toView());
+  expect(model.s.mv.$.view()).toBe(model.s.mv.$.view());
 });
 
 test('can set new values in single fork', () => {

src/json-crdt-extensions/peritext/__tests__/extension.spec.ts

@@ -16,7 +16,7 @@ const schema = s.obj({
 
 test('view should preserve identity', () => {
   const model = ModelWithExt.create(schema);
-  expect(model.s.nested.obj.text.toView()).toBe(model.s.nested.obj.text.toView());
+  expect(model.s.nested.obj.text.$.view()).toBe(model.s.nested.obj.text.$.view());
 });
 
 describe('non-typed access', () => {
@@ -94,7 +94,7 @@ describe('typed access', () => {
 
   test('can access PeritextApi using parent proxy selector', () => {
     const model = ModelWithExt.create(schema);
-    const api = model.s.nested.obj.text.toApi();
+    const api = model.s.nested.obj.text.$;
     expect(api).toBeInstanceOf(VecApi);
     let node = api.node.ext();
     expect(node).toBeInstanceOf(PeritextNode);

src/json-crdt-extensions/quill-delta/__tests__/extension.spec.ts

@@ -15,7 +15,7 @@ const schema = s.obj({
 
 test('view should preserve identity', () => {
   const model = ModelWithExt.create(schema);
-  expect(model.s.nested.obj.text.toView()).toBe(model.s.nested.obj.text.toView());
+  expect(model.s.nested.obj.text.$.view()).toBe(model.s.nested.obj.text.$.view());
 });
 
 describe('typed access', () => {
@@ -43,7 +43,7 @@ describe('typed access', () => {
 
   test('can access Quill Delta node using parent proxy selector', () => {
     const model = ModelWithExt.create(schema);
-    const api = model.s.nested.obj.text.toApi();
+    const api = model.s.nested.obj.text.$;
     expect(api).toBeInstanceOf(VecApi);
     let node = api.node.ext();
     expect(node).toBeInstanceOf(QuillDeltaNode);

src/json-crdt-patch/Patch.ts

@@ -21,6 +21,7 @@ export type JsonCrdtPatchOperation =
   | operations.InsStrOp
   | operations.InsBinOp
   | operations.InsArrOp
+  | operations.UpdArrOp
   | operations.DelOp
   | operations.NopOp;
 
@@ -130,6 +131,8 @@ export class Patch implements Printable {
       else if (op instanceof operations.NewArrOp) patchOps.push(new operations.NewArrOp(ts(op.id)));
       else if (op instanceof operations.InsArrOp)
         patchOps.push(new operations.InsArrOp(ts(op.id), ts(op.obj), ts(op.ref), op.data.map(ts)));
+      else if (op instanceof operations.UpdArrOp)
+        patchOps.push(new operations.UpdArrOp(ts(op.id), ts(op.obj), ts(op.ref), ts(op.val)));
       else if (op instanceof operations.InsStrOp)
         patchOps.push(new operations.InsStrOp(ts(op.id), ts(op.obj), ts(op.ref), op.data));
       else if (op instanceof operations.InsBinOp)

src/json-crdt-patch/PatchBuilder.ts

@@ -160,8 +160,8 @@ export class PatchBuilder {
    * @returns ID of the new operation.
    */
   public insObj(obj: ITimestampStruct, data: [key: string, value: ITimestampStruct][]): ITimestampStruct {
-    this.pad();
     if (!data.length) throw new Error('EMPTY_TUPLES');
+    this.pad();
     const id = this.clock.tick(1);
     const op = new operations.InsObjOp(id, obj, data);
     const span = op.span();
@@ -176,8 +176,8 @@ export class PatchBuilder {
    * @returns ID of the new operation.
    */
   public insVec(obj: ITimestampStruct, data: [index: number, value: ITimestampStruct][]): ITimestampStruct {
-    this.pad();
     if (!data.length) throw new Error('EMPTY_TUPLES');
+    this.pad();
     const id = this.clock.tick(1);
     const op = new operations.InsVecOp(id, obj, data);
     const span = op.span();
@@ -206,8 +206,8 @@ export class PatchBuilder {
    * @returns ID of the new operation.
    */
   public insStr(obj: ITimestampStruct, ref: ITimestampStruct, data: string): ITimestampStruct {
-    this.pad();
     if (!data.length) throw new Error('EMPTY_STRING');
+    this.pad();
     const id = this.clock.tick(1);
     const op = new operations.InsStrOp(id, obj, ref, data);
     const span = op.span();
@@ -222,8 +222,8 @@ export class PatchBuilder {
    * @returns ID of the new operation.
    */
   public insBin(obj: ITimestampStruct, ref: ITimestampStruct, data: Uint8Array): ITimestampStruct {
-    this.pad();
     if (!data.length) throw new Error('EMPTY_BINARY');
+    this.pad();
     const id = this.clock.tick(1);
     const op = new operations.InsBinOp(id, obj, ref, data);
     const span = op.span();
@@ -247,6 +247,19 @@ export class PatchBuilder {
     return id;
   }
 
+  /**
+   * Update an element in an "arr" object.
+   *
+   * @returns ID of the new operation.
+   */
+  public updArr(arr: ITimestampStruct, ref: ITimestampStruct, val: ITimestampStruct): ITimestampStruct {
+    this.pad();
+    const id = this.clock.tick(1);
+    const op = new operations.UpdArrOp(id, arr, ref, val);
+    this.patch.ops.push(op);
+    return id;
+  }
+
   /**
    * Delete a span of operations.
    *

src/json-crdt-patch/codec/binary/Decoder.ts

@@ -165,6 +165,13 @@ export class Decoder extends CborDecoder<CrdtReader> {
         builder.insArr(obj, after, elements);
         break;
       }
+      case JsonCrdtPatchOpcode.upd_arr: {
+        const obj = this.decodeId();
+        const ref = this.decodeId();
+        const val = this.decodeId();
+        builder.updArr(obj, ref, val);
+        break;
+      }
       case JsonCrdtPatchOpcode.del: {
         const length = octet & 0b111 || reader.vu57();
         const obj = this.decodeId();

src/json-crdt-patch/codec/binary/Encoder.ts

@@ -205,6 +205,14 @@ export class Encoder extends CborEncoder<CrdtWriter> {
         for (let i = 0; i < length; i++) this.encodeId(elements[i]);
         break;
       }
+      case operations.UpdArrOp: {
+        const operation = <operations.UpdArrOp>op;
+        writer.u8(JsonCrdtPatchOpcodeOverlay.upd_arr);
+        this.encodeId(operation.obj);
+        this.encodeId(operation.ref);
+        this.encodeId(operation.val);
+        break;
+      }
       case operations.DelOp: {
         const operation = <operations.DelOp>op;
         const what = operation.what;

src/json-crdt-patch/codec/binary/__tests__/codec.spec.ts

@@ -104,6 +104,10 @@ test('encodes a patch with all operation types', () => {
   assertCodec();
   builder.arr();
   assertCodec();
+  builder.updArr(ts(1, 1), ts(2, 2), ts(3, 3));
+  assertCodec();
+  builder.nop(1);
+  assertCodec();
 });
 
 test('supports consts with undefined value', () => {