feat(json-crdt): 🎸 add .toBinary() for File

Author: streamich

src/json-crdt/file/File.ts

@@ -6,6 +6,9 @@ import {Encoder as StructuralEncoderCompact} from '../codec/structural/compact/E
 import {Encoder as StructuralEncoderVerbose} from '../codec/structural/verbose/Encoder';
 import {encode as encodeCompact} from '../../json-crdt-patch/codec/compact/encode';
 import {encode as encodeVerbose} from '../../json-crdt-patch/codec/verbose/encode';
+import {Writer} from '../../util/buffers/Writer';
+import {CborEncoder} from '../../json-pack/cbor/CborEncoder';
+import {JsonEncoder} from '../../json-pack/json/JsonEncoder';
 import {printTree} from '../../util/print/printTree';
 import type * as types from './types';
 import type {Printable} from '../../util/print/types';
@@ -78,6 +81,26 @@ export class File implements Printable {
     return [view, metadata, model, history];
   }
 
+  public toBinary(params: types.FileEncodingParams): Uint8Array {
+    const sequence = this.serialize(params);
+    const writer = new Writer(16 * 1024);
+    switch (params.format) {
+      case 'ndjson': {
+        const json = new JsonEncoder(writer);
+        for (const component of sequence) {
+          json.writeAny(component);
+          json.writer.u8('\n'.charCodeAt(0));
+        }
+        return json.writer.flush();
+      }
+      case 'seq.cbor': {
+        const cbor = new CborEncoder(writer);
+        for (const component of sequence) cbor.writeAny(component);
+        return cbor.writer.flush();
+      }
+    }
+  }
+
   // ---------------------------------------------------------------- Printable
 
   public toString(tab?: string) {

src/json-crdt/file/__tests__/File.spec.ts

@@ -1,6 +1,15 @@
 import {s} from '../../../json-crdt-patch';
 import {Model} from '../../model';
 import {File} from '../File';
+import {JsonDecoder} from '../../../json-pack/json/JsonDecoder';
+import {CborDecoder} from '../../../json-pack/cbor/CborDecoder';
+
+const setup = (view: unknown) => {
+  const model = Model.withServerClock();
+  model.api.root(view);
+  const file = File.fromModel(model);
+  return {model, file};
+};
 
 test('can create File from new model', () => {
   const model = Model.withServerClock().setSchema(
@@ -18,3 +27,23 @@ test('can create File from new model', () => {
 
 test.todo('patches are flushed and stored in memory');
 test.todo('can replay history');
+
+describe('.toBinary()', () => {
+  describe('can read first value as view', () => {
+    test('.ndjson', () => {
+      const {file} = setup({foo: 'bar'});
+      const blob = file.toBinary({format: 'ndjson', model: 'compact', history: 'compact'});
+      const decoder = new JsonDecoder();
+      const view = decoder.read(blob);
+      expect(view).toEqual({foo: 'bar'});
+    });
+
+    test('.seq.cbor', () => {
+      const {file} = setup({foo: 'bar'});
+      const blob = file.toBinary({format: 'seq.cbor'});
+      const decoder = new CborDecoder();
+      const view = decoder.read(blob);
+      expect(view).toEqual({foo: 'bar'});
+    });
+  });
+});

src/json-crdt/file/types.ts

@@ -18,3 +18,7 @@ export interface FileSerializeParams {
   model?: 'sidecar' | 'binary' | 'compact' | 'verbose';
   history?: 'binary' | 'compact' | 'verbose';
 }
+
+export interface FileEncodingParams extends FileSerializeParams {
+  format: 'ndjson' | 'seq.cbor';
+}