Merge pull request #463 from streamich/api-improvements

API improvements

Author: streamich

package.json

@@ -59,7 +59,7 @@
     "demo:json-pointer": "ts-node src/json-pointer/__demos__/json-pointer.ts",
     "demo:reactive-rpc:server": "ts-node src/reactive-rpc/__demos__/server.ts",
     "coverage": "yarn test --collectCoverage",
-    "typedoc": "typedoc",
+    "typedoc": "npx typedoc",
     "build:pages": "rimraf gh-pages && mkdir -p gh-pages && cp -r typedocs/* gh-pages && cp -r coverage gh-pages/coverage",
     "deploy:pages": "gh-pages -d gh-pages",
     "publish-coverage-and-typedocs": "yarn typedoc && yarn coverage && yarn build:pages && yarn deploy:pages"
@@ -152,7 +152,6 @@
     "tslib": "^2.5.0",
     "tslint": "^6.1.3",
     "tslint-config-common": "^1.6.2",
-    "typedoc": "^0.25.3",
     "typescript": "^5.2.2",
     "uWebSockets.js": "uNetworking/uWebSockets.js#v20.23.0",
     "webpack": "^5.84.1",

src/json-crdt-patch/index.ts

@@ -111,6 +111,7 @@
  */
 
 export * from './types';
+export * from './clock';
 export * from './operations';
 export * from './Patch';
 export * from './PatchBuilder';

src/json-crdt/codec/indexed/binary/index.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './Encoder';
+export * from './Decoder';

src/json-crdt/codec/sidecar/binary/index.ts

@@ -0,0 +1,2 @@
+export * from './Encoder';
+export * from './Decoder';

src/json-crdt/codec/structural/binary/index.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export * from './Encoder';
+export * from './Decoder';
+export * from './ViewDecoder';

src/json-crdt/codec/structural/compact/index.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './Encoder';
+export * from './Decoder';

src/json-crdt/codec/structural/verbose/index.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './Encoder';
+export * from './Decoder';

src/json-crdt/index.ts

@@ -1,3 +1,5 @@
 export * from './nodes';
 export * from './extensions/types';
 export * from './model';
+
+export * from '../json-crdt-patch';

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

@@ -12,3 +12,12 @@ test('can insert a value and delete all previous ones', () => {
   arr.ins(1, [69]);
   expect(arr.view()).toEqual([42, 69]);
 });
+
+test('.length()', () => {
+  const doc = Model.withLogicalClock();
+  doc.api.root({
+    arr: [1, 2, 3],
+  });
+  const arr = doc.api.arr(['arr']);
+  expect(arr.length()).toBe(3);
+});

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

@@ -1,3 +1,4 @@
+import {s} from '../../../../json-crdt-patch';
 import {Model} from '../../Model';
 
 test('can edit a simple binary', () => {
@@ -25,3 +26,12 @@ test('can delete across two chunks', () => {
   bin.del(1, 7);
   expect(bin.view()).toEqual(new Uint8Array([3, 1]));
 });
+
+test('.length()', () => {
+  const doc = Model.withLogicalClock().setSchema(
+    s.obj({
+      bin: s.bin(new Uint8Array([1, 2, 3])),
+    }),
+  );
+  expect(doc.find.val.bin.toApi().length()).toBe(3);
+});