@encorejs/saaz 1.0.0

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,166 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { SaazFront } from './front/SaazFront';
+import { FrontMemoryAdapter } from './front/FrontMemoryAdapter';
+import SaazBack from './back/SaazBack';
+import { BackMemoryAdapter } from './back/BackMemoryAdapter';
+jest.setTimeout(1000);
+describe(`saaz`, () => {
+    test('everything', () => __awaiter(void 0, void 0, void 0, function* () {
+        let randNum = 10;
+        const generators = {
+            rand: () => {
+                return randNum++;
+            },
+        };
+        const opEditors = {
+            increaseBy(state, generators, opts) {
+                var _a;
+                let count = (_a = state.opCount) !== null && _a !== void 0 ? _a : 0;
+                state.opCount = count + opts.by;
+            },
+            // this is a bad editor because it uses a random number generator, so it's not deterministic.
+            // we expect saaz.tx() to throw an error if we try to use it.
+            randomizeCountBadly(state, generators, opts) {
+                state.opCount = Math.random();
+            },
+            // this is a good editor because it uses a random number generator, but it's deterministic.
+            randomizeCountWell(state, generators, opts) {
+                state.opCount = generators.rand();
+            },
+        };
+        const schema = {
+            opShape: null,
+            // migrateOp(state: $IntentionalAny) {},
+            // migrateCell(s) {},
+            version: 1,
+            editors: opEditors,
+            generators: generators,
+            cellShape: null,
+        };
+        const mem = new FrontMemoryAdapter();
+        const backend = new SaazBack({
+            storageAdapter: new BackMemoryAdapter(),
+            dbName: 'test',
+            schema,
+        });
+        const saaz = new SaazFront({
+            schema,
+            backend,
+            peerId: 'peer1',
+            storageAdapter: mem,
+            dbName: 'test',
+        });
+        yield saaz.ready;
+        expect(saaz.state.op.opCount).toEqual(undefined);
+        expect(saaz.state.cell.cellCount).toEqual(undefined);
+        expect(() => saaz.tx((editors) => {
+            editors.randomizeCountBadly({});
+        })).toThrow();
+        expect(() => saaz.tx(undefined, (draft) => {
+            draft.cellCount = 1;
+            throw new Error('oops');
+        })).toThrow();
+        expect(saaz.state.op.opCount).toEqual(undefined);
+        expect(saaz.state.cell.cellCount).toEqual(undefined);
+        expect(() => saaz.tx((editors) => {
+            editors.increaseBy({ by: 1 });
+            throw new Error('oops');
+        })).toThrow();
+        expect(saaz.state.op.opCount).toEqual(undefined);
+        expect(() => saaz.tx((editors) => {
+            editors.randomizeCountWell({});
+        })).not.toThrow();
+        yield new Promise((resolve) => setTimeout(resolve, 100));
+        expect(saaz.state.op.opCount).toEqual(10);
+        saaz.tx(undefined, (draft) => {
+            draft.cellCount = 1;
+        });
+        expect(saaz.state.cell.cellCount).toEqual(1);
+        saaz.tx((editors) => {
+            editors.increaseBy({ by: 3 });
+        });
+        expect(saaz.state.op.opCount).toEqual(13);
+        yield saaz.waitForBackendSync();
+        yield saaz.waitForStorageSync();
+        expect(mem.export().sessions['peer1'].keyval.sessionState
+            .value.op).toEqual({ opCount: 13 });
+        // const fauxBackennd: SaazBackInterface = {
+        //   async getUpdatesSinceClock() {
+        //     return {clock: null, hasUpdates: false}
+        //   },
+        //   applyUpdates(opts) {
+        //     return Promise.resolve({ok: true, hasUpdates: false})
+        //   },
+        //   updatePresence(opts) {
+        //     return Promise.resolve({ok: true})
+        //   },
+        //   async subscribe() {
+        //     return () => {}
+        //   },
+        // }
+        const saaz2 = new SaazFront({
+            schema,
+            peerId: '2',
+            storageAdapter: new FrontMemoryAdapter(),
+            dbName: 'test',
+            backend: backend,
+        });
+        yield saaz2.ready;
+        yield saaz2.waitForBackendSync();
+        expect(saaz2.state).toEqual(saaz.state);
+        const saaz3 = new SaazFront({
+            schema,
+            peerId: '3',
+            storageAdapter: new FrontMemoryAdapter(),
+            dbName: 'test',
+            backend: backend,
+        });
+        yield saaz3.ready;
+        yield saaz3.waitForBackendSync();
+        expect(saaz3.state).toEqual(saaz.state);
+        saaz.tx(undefined, (draft) => {
+            draft.cellCount = 2;
+        });
+        expect(saaz.state.cell.cellCount).toEqual(2);
+        saaz.tx(undefined, (draft) => {
+            draft.cellCount = 3;
+        });
+        expect(saaz.state.cell.cellCount).toEqual(3);
+        yield saaz.waitForBackendSync();
+        yield saaz3.waitForBackendSync();
+        expect(saaz3.state).toEqual(saaz.state);
+        saaz.undo();
+        expect(saaz.state.cell.cellCount).toEqual(2);
+        yield saaz.waitForBackendSync();
+        yield saaz3.waitForBackendSync();
+        expect(saaz3.state).toEqual(saaz.state);
+        saaz.undo();
+        expect(saaz.state.cell.cellCount).toEqual(1);
+        saaz.redo();
+        expect(saaz.state.cell.cellCount).toEqual(2);
+        saaz.redo();
+        expect(saaz.state.cell.cellCount).toEqual(3);
+        saaz.undo();
+        saaz.undo();
+        expect(saaz.state.cell.cellCount).toEqual(1);
+        saaz.tx(undefined, (draft) => {
+            draft.cellCount = 4;
+        });
+        expect(saaz.state.cell.cellCount).toEqual(4);
+        saaz.redo();
+        expect(saaz.state.cell.cellCount).toEqual(4);
+        saaz.undo();
+        expect(saaz.state.cell.cellCount).toEqual(1);
+        saaz.teardown();
+        saaz2.teardown();
+        saaz3.teardown();
+    }));
+});

package/dist/rogue.d.ts

@@ -0,0 +1,63 @@
+type BranchName = 'base' | string;
+type Branch = {
+    $boxedValue?: any;
+    $mapProps?: {
+        [key in string]?: Cell;
+    };
+};
+export type Cell = {
+    $type: [type: 'map' | 'boxed' | 'deleted', branchName: BranchName];
+    $branches?: {
+        [asOf in BranchName]?: Branch;
+    };
+};
+type CellToJSON<T extends Cell> = T extends {
+    $type: ['boxed', any];
+} ? CellBoxedToJSON<T> : T extends {
+    $type: ['map'];
+} ? MapCellToJSON<T> : never;
+type CellBoxedToJSON<T extends Cell> = T['$branches'] extends {
+    [key: string]: {
+        $boxedValue: infer V;
+    };
+} ? V : never;
+type MapCellToJSON<T extends Cell> = T['$branches'] extends {
+    [key: string]: {
+        $mapProps: infer V;
+    };
+} ? {
+    [Key in keyof V]: V[Key] extends Cell ? CellToJSON<V[Key]> : never;
+} : never;
+export type Root = Cell;
+declare const NOT_DEFINED: {};
+export type Ops = Op[];
+type Op = ChnangeTypeOp | SetBoxedValue;
+type ChnangeTypeOp = {
+    type: 'ChangeType';
+    path: Array<[branchName: BranchName, mapProp: string]>;
+    value: Cell['$type'];
+};
+type SetBoxedValue = {
+    type: 'SetBoxedValue';
+    path: Array<[branchName: BranchName, mapProp: string]>;
+    branchName: BranchName;
+    value: any;
+};
+export declare function makeDraft<S extends Cell>(base: any): [draft: any, finish: () => [cell: Cell, forwardOps: Ops, backwardOps: Ops]];
+export declare function change(base: any, fn: (draft: any) => void): [cell: any, ops: Ops, backwardOps: Ops];
+export declare function fromOps(base: any, ops: Ops): [cell: any];
+export declare const current: <T extends {}>(draft: T) => T;
+export declare function isPlainObject(value: any): boolean;
+declare const BOXED: unique symbol;
+export declare function boxed<V>(value: V): {
+    [BOXED]: true;
+    value: V;
+};
+declare const RESET: unique symbol;
+export declare function reset<V>(value: V): {
+    [RESET]: true;
+    value: V;
+};
+export declare function jsonFromCell<V extends Cell | {}>(v: V): V extends Cell ? CellToJSON<V> : typeof NOT_DEFINED;
+export {};
+//# sourceMappingURL=rogue.d.ts.map

package/dist/rogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rogue.d.ts","sourceRoot":"","sources":["../src/rogue.ts"],"names":[],"mappings":"AAMA,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,CAAA;AAEjC,KAAK,MAAM,GAAG;IACZ,WAAW,CAAC,EAAE,GAAG,CAAA;IACjB,SAAS,CAAC,EAAE;SACT,GAAG,IAAI,MAAM,CAAC,CAAC,EAAE,IAAI;KACvB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAA;IAClE,SAAS,CAAC,EAAE;SACT,IAAI,IAAI,UAAU,CAAC,CAAC,EAAE,MAAM;KAC9B,CAAA;CACF,CAAA;AAED,KAAK,UAAU,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;IAC1C,KAAK,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;CACtB,GACG,eAAe,CAAC,CAAC,CAAC,GAClB,CAAC,SAAS;IAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAA;CAAC,GACxB,aAAa,CAAC,CAAC,CAAC,GAChB,KAAK,CAAA;AAEX,KAAK,eAAe,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS;IAC5D,CAAC,GAAG,EAAE,MAAM,GAAG;QAAC,WAAW,EAAE,MAAM,CAAC,CAAA;KAAC,CAAA;CACtC,GACG,CAAC,GACD,KAAK,CAAA;AAET,KAAK,aAAa,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS;IAC1D,CAAC,GAAG,EAAE,MAAM,GAAG;QAAC,SAAS,EAAE,MAAM,CAAC,CAAA;KAAC,CAAA;CACpC,GACG;KACG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK;CACnE,GACD,KAAK,CAAA;AAET,MAAM,MAAM,IAAI,GAAG,IAAI,CAAA;AAEvB,QAAA,MAAM,WAAW,IAAK,CAAA;AAItB,MAAM,MAAM,GAAG,GAAG,EAAE,EAAE,CAAA;AAEtB,KAAK,EAAE,GAAG,aAAa,GAAG,aAAa,CAAA;AAEvC,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,KAAK,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;IACtD,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;CACrB,CAAA;AAED,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,eAAe,CAAA;IACrB,IAAI,EAAE,KAAK,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;IACtD,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,GAAG,CAAA;CACX,CAAA;AAiBD,wBAAgB,SAAS,CAAC,CAAC,SAAS,IAAI,EACtC,IAAI,EAAE,GAAG,GACR,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC,CA0B7E;AAED,wBAAgB,MAAM,CACpB,IAAI,EAAE,GAAG,EACT,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,GACvB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,CAIzC;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAwCxD;AAmYD,eAAO,MAAM,OAAO,+BAQnB,CAAA;AA+BD,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAejD;AAED,QAAA,MAAM,KAAK,EAAE,OAAO,MAA4B,CAAA;AAEhD,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG;IAAC,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAC,CAE5D;AAUD,QAAA,MAAM,KAAK,EAAE,OAAO,MAA4B,CAAA;AAEhD,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG;IAAC,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAC,CAE5D;AAoBD,wBAAgB,YAAY,CAAC,CAAC,SAAS,IAAI,GAAG,EAAE,EAC9C,CAAC,EAAE,CAAC,GACH,CAAC,SAAS,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,WAAW,CAMrD"}