reactronic 0.22.204 → 0.22.205

package/README.md

@@ -310,7 +310,7 @@ function sensitive<T>(sensitivity: Sensitivity, func: F<T>, ...args: any[]): T
 export interface SnapshotOptions {
   readonly hint?: string
   readonly standalone?: StandaloneMode
-  readonly journal?: TransactionJournal
+  readonly journal?: EditJournal
   readonly logging?: Partial<LoggingOptions>
   readonly token?: any
 }
@@ -323,7 +323,7 @@ interface MemberOptions {
   readonly triggeringArgs: boolean
   readonly throttling: number // milliseconds, -1 is immediately, Number.MAX_SAFE_INTEGER is never
   readonly reentrance: Reentrance
-  readonly journal: TransactionJournal | undefined
+  readonly journal: EditJournal | undefined
   readonly monitor: Monitor | null
   readonly logging?: Partial<LoggingOptions>
 }

package/build/dist/source/Options.d.ts

@@ -1,12 +1,12 @@
 import { LoggingOptions } from './Logging';
 import { StandaloneMode } from './impl/Data';
 export { LoggingOptions, ProfilingOptions, LoggingLevel } from './Logging';
-import { TransactionJournal } from './impl/TransactionJournal';
+import { EditJournal } from './impl/EditJournal';
 import { Monitor } from './impl/Monitor';
 export interface SnapshotOptions {
     readonly hint?: string;
     readonly standalone?: StandaloneMode;
-    readonly journal?: TransactionJournal;
+    readonly journal?: EditJournal;
     readonly logging?: Partial<LoggingOptions>;
     readonly token?: any;
 }
@@ -18,7 +18,7 @@ export interface MemberOptions {
     readonly triggeringArgs: boolean;
     readonly throttling: number;
     readonly reentrance: Reentrance;
-    readonly journal: TransactionJournal | undefined;
+    readonly journal: EditJournal | undefined;
     readonly monitor: Monitor | null;
     readonly logging?: Partial<LoggingOptions>;
 }

package/build/dist/source/api.d.ts

@@ -10,5 +10,5 @@ export { ObservableObject } from './impl/Hooks';
 export { Snapshot } from './impl/Snapshot';
 export { Transaction } from './impl/Transaction';
 export { Monitor } from './impl/Monitor';
-export { TransactionJournal } from './impl/TransactionJournal';
+export { EditJournal } from './impl/EditJournal';
 export { Rx, nonreactive, sensitive, unobservable, transaction, reaction, cached, options } from './Rx';

package/build/dist/source/api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.options = exports.cached = exports.reaction = exports.transaction = exports.unobservable = exports.sensitive = exports.nonreactive = exports.Rx = exports.TransactionJournal = exports.Monitor = exports.Transaction = exports.Snapshot = exports.ObservableObject = exports.ToggleRef = exports.Ref = exports.Controller = exports.LoggingLevel = exports.Reentrance = exports.Kind = exports.SealedSet = exports.SealedMap = exports.SealedArray = exports.pause = exports.all = void 0;
+exports.options = exports.cached = exports.reaction = exports.transaction = exports.unobservable = exports.sensitive = exports.nonreactive = exports.Rx = exports.EditJournal = exports.Monitor = exports.Transaction = exports.Snapshot = exports.ObservableObject = exports.ToggleRef = exports.Ref = exports.Controller = exports.LoggingLevel = exports.Reentrance = exports.Kind = exports.SealedSet = exports.SealedMap = exports.SealedArray = exports.pause = exports.all = void 0;
 var Utils_1 = require("./util/Utils");
 Object.defineProperty(exports, "all", { enumerable: true, get: function () { return Utils_1.all; } });
 Object.defineProperty(exports, "pause", { enumerable: true, get: function () { return Utils_1.pause; } });
@@ -27,8 +27,8 @@ var Transaction_1 = require("./impl/Transaction");
 Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return Transaction_1.Transaction; } });
 var Monitor_1 = require("./impl/Monitor");
 Object.defineProperty(exports, "Monitor", { enumerable: true, get: function () { return Monitor_1.Monitor; } });
-var TransactionJournal_1 = require("./impl/TransactionJournal");
-Object.defineProperty(exports, "TransactionJournal", { enumerable: true, get: function () { return TransactionJournal_1.TransactionJournal; } });
+var EditJournal_1 = require("./impl/EditJournal");
+Object.defineProperty(exports, "EditJournal", { enumerable: true, get: function () { return EditJournal_1.EditJournal; } });
 var Rx_1 = require("./Rx");
 Object.defineProperty(exports, "Rx", { enumerable: true, get: function () { return Rx_1.Rx; } });
 Object.defineProperty(exports, "nonreactive", { enumerable: true, get: function () { return Rx_1.nonreactive; } });

package/build/dist/source/impl/EditJournal.d.ts

@@ -0,0 +1,37 @@
+import { ObservableObject } from './Hooks';
+import { ObjectHolder, ObjectRevision, Patch } from './Data';
+export declare abstract class EditJournal extends ObservableObject {
+    abstract capacity: number;
+    abstract readonly isSaving: boolean;
+    abstract readonly edits: ReadonlyArray<Patch>;
+    abstract readonly canUndo: boolean;
+    abstract readonly canRedo: boolean;
+    abstract undo(count?: number): void;
+    abstract redo(count?: number): void;
+    abstract getUnsaved(): Patch | undefined;
+    abstract beginSave(): void;
+    abstract endSave(success: boolean): void;
+    abstract register(patch: Patch): void;
+    static create(): EditJournal;
+}
+export declare class EditJournalImpl extends EditJournal {
+    private _capacity;
+    private _isSaving;
+    private _edits;
+    private _position;
+    private _saved;
+    get capacity(): number;
+    set capacity(value: number);
+    get isSaving(): boolean;
+    get edits(): ReadonlyArray<Patch>;
+    get canUndo(): boolean;
+    get canRedo(): boolean;
+    undo(count?: number): void;
+    redo(count?: number): void;
+    getUnsaved(): Patch | undefined;
+    beginSave(): void;
+    endSave(success: boolean): void;
+    register(p: Patch): void;
+    static buildPatch(hint: string, changeset: Map<ObjectHolder, ObjectRevision>): Patch;
+    static applyPatch(patch: Patch, undo: boolean): void;
+}

package/build/dist/source/impl/{TransactionJournal.js → EditJournal.js}

@@ -1,62 +1,89 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionJournalImpl = exports.TransactionJournal = void 0;
+exports.EditJournalImpl = exports.EditJournal = void 0;
 const Hooks_1 = require("./Hooks");
 const Data_1 = require("./Data");
 const Snapshot_1 = require("./Snapshot");
 const Transaction_1 = require("./Transaction");
 const Sealant_1 = require("../util/Sealant");
-class TransactionJournal extends Hooks_1.ObservableObject {
-    static create() { return new TransactionJournalImpl(); }
+class EditJournal extends Hooks_1.ObservableObject {
+    static create() { return new EditJournalImpl(); }
 }
-exports.TransactionJournal = TransactionJournal;
-class TransactionJournalImpl extends TransactionJournal {
+exports.EditJournal = EditJournal;
+class EditJournalImpl extends EditJournal {
     constructor() {
         super(...arguments);
         this._capacity = 5;
-        this._items = [];
+        this._isSaving = false;
+        this._edits = [];
         this._position = 0;
+        this._saved = 0;
     }
     get capacity() { return this._capacity; }
-    set capacity(value) { this._capacity = value; if (value < this._items.length)
-        this._items.splice(0, this._items.length - value); }
-    get items() { return this._items; }
-    get canUndo() { return this._items.length > 0 && this._position > 0; }
-    get canRedo() { return this._position < this._items.length; }
-    remember(p) {
-        Transaction_1.Transaction.run({ hint: 'TransactionJournal.remember', standalone: 'isolated' }, () => {
-            const items = this._items = this._items.toMutable();
-            if (items.length >= this._capacity)
-                items.shift();
-            else
-                items.splice(this._position);
-            items.push(p);
-            this._position = items.length;
-        });
-    }
+    set capacity(value) { this._capacity = value; if (value < this._edits.length)
+        this._edits.splice(0, this._edits.length - value); }
+    get isSaving() { return this._isSaving; }
+    get edits() { return this._edits; }
+    get canUndo() { return this._edits.length > 0 && this._position > 0; }
+    get canRedo() { return this._position < this._edits.length; }
     undo(count = 1) {
-        Transaction_1.Transaction.run({ hint: 'TransactionJournal.undo', standalone: 'isolated' }, () => {
+        Transaction_1.Transaction.run({ hint: 'EditJournal.undo', standalone: 'isolated' }, () => {
             let i = this._position - 1;
             while (i >= 0 && count > 0) {
-                const patch = this._items[i];
-                TransactionJournalImpl.applyPatch(patch, true);
+                const patch = this._edits[i];
+                EditJournalImpl.applyPatch(patch, true);
                 i--, count--;
             }
             this._position = i + 1;
         });
     }
     redo(count = 1) {
-        Transaction_1.Transaction.run({ hint: 'TransactionJournal.redo', standalone: 'isolated' }, () => {
+        Transaction_1.Transaction.run({ hint: 'EditJournal.redo', standalone: 'isolated' }, () => {
             let i = this._position;
-            while (i < this._items.length && count > 0) {
-                const patch = this._items[i];
-                TransactionJournalImpl.applyPatch(patch, false);
+            while (i < this._edits.length && count > 0) {
+                const patch = this._edits[i];
+                EditJournalImpl.applyPatch(patch, false);
                 i++, count--;
             }
             this._position = i;
         });
     }
-    static createPatch(hint, changeset) {
+    getUnsaved() {
+        let result = undefined;
+        const length = Math.abs(this._position - this._saved);
+        if (length !== 0) {
+            result = { hint: 'unsaved changes', objects: new Map() };
+            const direction = Math.sign(this._position - this._saved);
+            let i = 0;
+            while (i < length) {
+                const patch = this._edits[this._position + direction * (i + 1)];
+                patch.objects.forEach((p, obj) => {
+                });
+                i++;
+            }
+        }
+        return result;
+    }
+    beginSave() {
+        this._isSaving = true;
+    }
+    endSave(success) {
+        if (success)
+            this._saved = this._position;
+        this._isSaving = false;
+    }
+    register(p) {
+        Transaction_1.Transaction.run({ hint: 'EditJournal.remember', standalone: 'isolated' }, () => {
+            const items = this._edits = this._edits.toMutable();
+            if (items.length >= this._capacity)
+                items.shift();
+            else
+                items.splice(this._position);
+            items.push(p);
+            this._position = items.length;
+        });
+    }
+    static buildPatch(hint, changeset) {
         const patch = { hint, objects: new Map() };
         changeset.forEach((r, h) => {
             const p = { current: {}, former: {} };
@@ -95,7 +122,7 @@ class TransactionJournalImpl extends TransactionJournal {
         });
     }
 }
-exports.TransactionJournalImpl = TransactionJournalImpl;
+exports.EditJournalImpl = EditJournalImpl;
 function unseal(observable) {
     const result = observable.value;
     const createCopy = result === null || result === void 0 ? void 0 : result[Sealant_1.Sealant.CreateCopy];

package/build/dist/source/impl/Hooks.d.ts

@@ -2,7 +2,7 @@ import { F } from '../util/Utils';
 import { MemberOptions, Kind, Reentrance } from '../Options';
 import { LoggingOptions, ProfilingOptions } from '../Logging';
 import { MemberName, ObjectHolder, StandaloneMode } from './Data';
-import { TransactionJournal } from './TransactionJournal';
+import { EditJournal } from './EditJournal';
 import { Monitor } from './Monitor';
 export declare abstract class ObservableObject {
     constructor();
@@ -18,7 +18,7 @@ export declare class OptionsImpl implements MemberOptions {
     readonly triggeringArgs: boolean;
     readonly throttling: number;
     readonly reentrance: Reentrance;
-    readonly journal: TransactionJournal | undefined;
+    readonly journal: EditJournal | undefined;
     readonly monitor: Monitor | null;
     readonly logging?: Partial<LoggingOptions>;
     static readonly INITIAL: Readonly<OptionsImpl>;

package/build/dist/source/impl/Operation.js

@@ -9,7 +9,7 @@ const Snapshot_1 = require("./Snapshot");
 const Transaction_1 = require("./Transaction");
 const Monitor_1 = require("./Monitor");
 const Hooks_1 = require("./Hooks");
-const TransactionJournal_1 = require("./TransactionJournal");
+const EditJournal_1 = require("./EditJournal");
 const BOOT_ARGS = [];
 const BOOT_CAUSE = '<boot>';
 const ROOT_HOLDER = new Data_1.ObjectHolder(undefined, undefined, Hooks_1.Hooks.proxy, Snapshot_1.ROOT_REV, '<root>');
@@ -490,7 +490,7 @@ class Operation extends Data_1.Observable {
                     Operation.propagateMemberChangeThroughSubscriptions(true, since, r, m, h, reactions);
         });
         reactions.sort(compareReactionsByOrder);
-        (_a = snapshot.options.journal) === null || _a === void 0 ? void 0 : _a.remember(TransactionJournal_1.TransactionJournalImpl.createPatch(snapshot.hint, snapshot.changeset));
+        (_a = snapshot.options.journal) === null || _a === void 0 ? void 0 : _a.register(EditJournal_1.EditJournalImpl.buildPatch(snapshot.hint, snapshot.changeset));
     }
     static revokeAllSubscriptions(snapshot) {
         snapshot.changeset.forEach((r, h) => r.changes.forEach((o, m) => Operation.propagateMemberChangeThroughSubscriptions(true, snapshot.timestamp, r, m, h, undefined)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reactronic",
-  "version": "0.22.204",
+  "version": "0.22.205",
   "description": "Reactronic - Transactional Reactive State Management",
   "main": "build/dist/source/api.js",
   "types": "build/dist/source/api.d.ts",

package/build/dist/source/impl/TransactionJournal.d.ts

@@ -1,27 +0,0 @@
-import { ObservableObject } from './Hooks';
-import { ObjectHolder, ObjectRevision, Patch } from './Data';
-export declare abstract class TransactionJournal extends ObservableObject {
-    abstract capacity: number;
-    abstract readonly items: ReadonlyArray<Patch>;
-    abstract readonly canUndo: boolean;
-    abstract readonly canRedo: boolean;
-    abstract undo(count?: number): void;
-    abstract redo(count?: number): void;
-    abstract remember(patch: Patch): void;
-    static create(): TransactionJournal;
-}
-export declare class TransactionJournalImpl extends TransactionJournal {
-    private _capacity;
-    private _items;
-    private _position;
-    get capacity(): number;
-    set capacity(value: number);
-    get items(): ReadonlyArray<Patch>;
-    get canUndo(): boolean;
-    get canRedo(): boolean;
-    remember(p: Patch): void;
-    undo(count?: number): void;
-    redo(count?: number): void;
-    static createPatch(hint: string, changeset: Map<ObjectHolder, ObjectRevision>): Patch;
-    static applyPatch(patch: Patch, undo: boolean): void;
-}