core-3nweb-client-lib 0.25.3 → 0.26.0

package/README.md

@@ -10,9 +10,9 @@ After repository clone, bring down all NodeJS modules, by running in project's f
 npm ci
 ```
 
-Tests have some unit and integrated components. Integration test uses 3NWeb spec server. `spec-server` folder with server's code should be present either near this project's folder, or inside of it. Cloned spec server code repository should also be `npm ci`
+Tests have some unit and integrated components. Integration test uses 3NWeb spec server. Integrated tests use server and dns mocking from `spec-3nweb-server`.
 
-Just build is done with
+Build is done with
 ```
 npm run build
 ```

package/build/api-defs/files.d.ts

@@ -40,6 +40,7 @@ declare namespace web3n.files {
 		attrsNotEnabledInFS?: true;
 		versionMismatch?: true;
 		isEndless?: true;
+		storageClosed?: true;
 	}
 
 	interface exceptionCode {
@@ -58,6 +59,7 @@ declare namespace web3n.files {
 		parsingError: 'parsing-error';
 		notImplemented: 'ENOSYS';
 		isEndless: 'is-endless';
+		storageClosed: 'storage-closed';
 	}
 
 	/**
@@ -124,8 +126,22 @@ declare namespace web3n.files {
 		 */
 		version?: number;
 
+		/**
+		 * This tells object's latest sync state.
+		 * If such information cannot be provided, this field will be absent.
+		 */
+		sync?: {
+			state: SyncState;
+			latest?: number;
+			conflictingRemote?: number[];
+			remote?: number;
+			deletedOnRemote?: true;
+		};
+
 	}
 
+	type SyncState = 'synced' | 'behind' | 'unsynced' | 'conflicting';
+
 	interface FileByteSource {
 
 		/**
@@ -988,37 +1004,25 @@ declare namespace web3n.files {
 		type: 'removed';
 	}
 
-	interface MovedEvent extends FSEvent {
-		type: 'moved';
-	}
-
-	interface SyncedEvent extends FSEvent {
-		type: 'synced';
+	interface SyncUploadEvent extends FSEvent {
+		type: 'sync-upload';
+		uploaded: number;
 		current: number;
 	}
 
-	interface UnsyncedEvent extends FSEvent {
-		type: 'unsynced';
-		lastSynced: number;
-	}
-
-	interface ConflictEvent extends FSEvent {
-		type: 'conflicting';
-		remoteVersion: number;
-	}
-
 	type FolderEvent = EntryRemovalEvent | EntryAdditionEvent |
-		EntryRenamingEvent | RemovedEvent | MovedEvent |
-		SyncedEvent | UnsyncedEvent | ConflictEvent;
+		EntryRenamingEvent | RemovedEvent | SyncUploadEvent;
 
 	interface EntryRemovalEvent extends FSEvent {
 		type: 'entry-removal';
 		name: string;
+		moveLabel?: number;
 	}
 
 	interface EntryAdditionEvent extends FSEvent {
 		type: 'entry-addition';
 		entry: ListingEntry;
+		moveLabel?: number;
 	}
 
 	interface EntryRenamingEvent extends FSEvent {
@@ -1027,8 +1031,7 @@ declare namespace web3n.files {
 		newName: string;
 	}
 
-	type FileEvent = FileChangeEvent | RemovedEvent | MovedEvent |
-		SyncedEvent | UnsyncedEvent | ConflictEvent;
+	type FileEvent = FileChangeEvent | RemovedEvent | SyncUploadEvent;
 
 	interface FileChangeEvent extends FSEvent {
 		type: 'file-change';

package/build/core/asmail/config/common.js

@@ -18,7 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParamOnFileAndServer = void 0;
 const json_utils_1 = require("../../../lib-common/json-utils");
 const file_based_json_1 = require("../../../lib-client/3nstorage/util/file-based-json");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 class ParamOnFileAndServer extends file_based_json_1.JsonFileProc {
     constructor(paramPath, serviceConf) {
         super();
@@ -27,7 +27,7 @@ class ParamOnFileAndServer extends file_based_json_1.JsonFileProc {
         // XXX This should be done in a transactional style, with set on server
         // first. FolderNode with its base class is an example of transactional
         // mechanism implementation.
-        this.changesProc = new processes_1.SingleProc();
+        this.changesProc = new synced_1.SingleProc();
     }
     async start(file) {
         await super.start(file, async () => {

package/build/core/asmail/delivery/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2016 - 2017, 2020 - 2021 3NSoft Inc.
+ Copyright (C) 2016 - 2017, 2020 - 2022 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -24,6 +24,7 @@ const common_1 = require("./common");
 const json_utils_1 = require("../../../lib-common/json-utils");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const utils_for_observables_1 = require("../../../lib-common/utils-for-observables");
 const SMALL_MSG_SIZE = 1024 * 1024;
 const MSGS_FOLDER = 'msgs';
 function idToMsgFolder(id) {
@@ -120,11 +121,11 @@ class Delivery {
             }
             return () => { };
         }
-        const subToProgress = msg.progress$.subscribe(observer);
+        const subToProgress = msg.progress$.subscribe(utils_for_observables_1.toRxObserver(observer));
         return () => { subToProgress.unsubscribe(); };
     }
     observeAllDeliveries(observer) {
-        const subToProgress = this.allDeliveries$.subscribe(observer);
+        const subToProgress = this.allDeliveries$.subscribe(utils_for_observables_1.toRxObserver(observer));
         return () => subToProgress.unsubscribe();
     }
     async preFlight(recipient) {

package/build/core/asmail/delivery/msg.js

@@ -17,12 +17,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Msg = void 0;
 const packer_1 = require("../msg/packer");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
 const common_1 = require("./common");
 const per_recipient_wip_1 = require("./per-recipient-wip");
 const rxjs_1 = require("rxjs");
 const json_utils_1 = require("../../../lib-common/json-utils");
+const deferred_1 = require("../../../lib-common/processes/deferred");
 const MAIN_OBJ_FILE_NAME = 'msg.json';
 const PROGRESS_INFO_FILE_NAME = 'progress.json';
 const WIPS_INFO_FILE_NAME = 'wips.json';
@@ -48,9 +49,9 @@ class Msg {
         this.r = r;
         this.progress = progress;
         this.msgFS = msgFS;
-        this.sendingProc = new processes_1.SingleProc();
+        this.sendingProc = new synced_1.SingleProc();
         this.completionPromise = undefined;
-        this.progressSavingProc = new processes_1.SingleProc();
+        this.progressSavingProc = new synced_1.SingleProc();
         this.cancelled = false;
         this.sender = undefined;
         this.recipients = undefined;
@@ -197,7 +198,7 @@ class Msg {
             throw new Error(`Message delivery has already completed.`);
         }
         if (!this.completionPromise) {
-            this.completionPromise = processes_1.defer();
+            this.completionPromise = deferred_1.defer();
         }
         return this.completionPromise.promise;
     }

package/build/core/asmail/delivery/per-recipient-wip.js

@@ -19,7 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WIP = void 0;
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
 const sender_1 = require("../../../lib-client/asmail/sender");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const key_verification_1 = require("../key-verification");
 const MSG_SIZE_FOR_STATE_RECORDING = 1024 * 1024;
 const EMPTY_BYTE_ARR = new Uint8Array(0);
@@ -34,7 +34,7 @@ class WIP {
         this.msg = msg;
         this.state = state;
         this.cryptor = cryptor;
-        this.proc = new processes_1.SingleProc();
+        this.proc = new synced_1.SingleProc();
         this.sender = undefined;
         this.packer = undefined;
         this.currentObjIndInMeta = 0;

package/build/core/asmail/inbox/attachments/fs.js

@@ -29,6 +29,12 @@ class AttachmentStore {
         this.nodes = new common_1.NodesContainer();
         Object.seal(this);
     }
+    getNodeEvents() {
+        throw new Error(`Attachment's storage is readonly.`);
+    }
+    broadcastNodeEvent() {
+        throw new Error(`Attachment's storage is readonly.`);
+    }
     storageForLinking(type, location) {
         if (type === 'share') {
             return this.getStorages('share', location);

package/build/core/asmail/inbox/cached-msgs.js

@@ -20,12 +20,12 @@ exports.CachedMessages = void 0;
 const msg_on_disk_1 = require("./msg-on-disk");
 const timed_cache_1 = require("../../../lib-common/timed-cache");
 const obj_folders_1 = require("../../../lib-client/objs-on-disk/obj-folders");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 class CachedMessages {
     constructor(folders, downloader) {
         this.folders = folders;
         this.downloader = downloader;
-        this.syncProc = new processes_1.NamedProcs();
+        this.syncProc = new synced_1.NamedProcs();
         this.msgFiles = timed_cache_1.makeTimedCache(60 * 1000);
         Object.freeze(this);
     }

package/build/core/asmail/inbox/inbox-events.js

@@ -19,6 +19,7 @@ exports.InboxEvents = void 0;
 const retrieval_1 = require("../../../lib-common/service-api/asmail/retrieval");
 const server_events_1 = require("../../../lib-client/server-events");
 const operators_1 = require("rxjs/operators");
+const utils_for_observables_1 = require("../../../lib-common/utils-for-observables");
 const SERVER_EVENTS_RESTART_WAIT_SECS = 30;
 /**
  * Instance of this class handles event subscription from UI side. It observes
@@ -38,7 +39,7 @@ class InboxEvents {
     }
     subscribe(event, observer) {
         if (event === 'message') {
-            const subscription = this.newMsg$.subscribe(observer);
+            const subscription = this.newMsg$.subscribe(utils_for_observables_1.toRxObserver(observer));
             return () => subscription.unsubscribe();
         }
         else {

package/build/core/asmail/inbox/index.js

@@ -18,7 +18,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InboxOnServer = void 0;
 const error_1 = require("../../../lib-common/exceptions/error");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const recipient_1 = require("../../../lib-client/asmail/recipient");
 const opener_1 = require("../msg/opener");
 const msg_indexing_1 = require("./msg-indexing");
@@ -48,7 +48,7 @@ class InboxOnServer {
         this.cache = cache;
         this.index = index;
         this.logError = logError;
-        this.procs = new processes_1.NamedProcs();
+        this.procs = new synced_1.NamedProcs();
         this.recentlyOpenedMsgs = timed_cache_1.makeTimedCache(60 * 1000);
         this.inboxEvents = new inbox_events_1.InboxEvents(this.msgReceiver, this.getMsg.bind(this), this.logError);
         Object.seal(this);

package/build/core/asmail/inbox/msg-downloader.js

@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>. */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MsgDownloader = void 0;
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
 const MAX_GETTING_CHUNK = 512 * 1024;
 const DOWNLOAD_START_CHUNK = 128 * 1024;
@@ -32,7 +32,7 @@ class MsgDownloader {
          * When it comes to the download start, if chain exists, it means that
          * process has already started.
          */
-        this.downloadProcs = new processes_1.NamedProcs();
+        this.downloadProcs = new synced_1.NamedProcs();
         Object.freeze(this);
     }
     async sync(msgId, objId, action) {

package/build/core/asmail/inbox/msg-indexing.js

@@ -17,7 +17,7 @@
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MsgIndex = void 0;
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
 const timed_cache_1 = require("../../../lib-common/timed-cache");
 const LIMIT_RECORDS_PER_FILE = 200;
@@ -99,7 +99,7 @@ class MsgIndex {
         this.latest = undefined;
         this.cached = timed_cache_1.makeTimedCache(10 * 60 * 1000);
         this.fileTSs = undefined;
-        this.fileProc = new processes_1.SingleProc();
+        this.fileProc = new synced_1.SingleProc();
         Object.seal(this);
     }
     static async makeWith(files) {
@@ -297,7 +297,7 @@ class MsgIndex {
             }
             if (msgFound) {
                 removeFrom(records, msgId);
-                if ((records.fileTS !== null) && (records.ordered.length === 0)) {
+                if (!!records.fileTS && (records.ordered.length === 0)) {
                     await this.files.deleteFile(records.fileTS + INDEX_EXT);
                 }
                 else {

package/build/core/asmail/inbox/msg-on-disk.js

@@ -18,7 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MsgOnDisk = void 0;
 const fs = require("../../../lib-common/async-fs-node");
 const obj_on_disk_1 = require("../../../lib-client/objs-on-disk/obj-on-disk");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const error_1 = require("../../../lib-common/exceptions/error");
 const path_1 = require("path");
 const META_FNAME = 'meta.json';
@@ -39,7 +39,7 @@ class MsgOnDisk {
         this.msgDownloader = msgDownloader;
         this.status = status;
         this.objsIds = objsIds;
-        this.syncProc = new processes_1.SingleProc();
+        this.syncProc = new synced_1.SingleProc();
         this.objs = new Map();
         this.objDownloader = this.msgDownloader.getObjDownloader(msgId);
         Object.freeze(this.objDownloader);

package/build/core/asmail/keyring/keyring-storage.js

@@ -16,10 +16,10 @@
  this program. If not, see <http://www.gnu.org/licenses/>. */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeKeyringStorage = void 0;
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const KEYRING_FNAME = 'keyring.json';
 function makeKeyringStorage(fs) {
-    const proc = new processes_1.SingleProc();
+    const proc = new synced_1.SingleProc();
     // initialization for code that works only with version 1
     proc.start(async () => {
         fs = await checkAndUpgradeDataToV1(fs);

package/build/core/asmail/sending-params/own-params.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OwnSendingParams = void 0;
 const file_based_json_1 = require("../../../lib-client/3nstorage/util/file-based-json");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 const json_utils_1 = require("../../../lib-common/json-utils");
 const DEFAULT_INVITE_LABEL = 'Default';
 const DEFAULT_INVITE_MAX_MSG_SIZE = 1024 * 1024 * 1024;
@@ -33,7 +33,7 @@ class OwnSendingParams extends file_based_json_1.JsonFileProc {
         this.anonInvites = anonInvites;
         this.params = new Map();
         this.defaultParams = undefined;
-        this.changesProc = new processes_1.SingleProc();
+        this.changesProc = new synced_1.SingleProc();
         this.getFor = async (address) => {
             let p = this.params.get(address);
             if (p) {

package/build/core/asmail/sending-params/params-from-others.js

@@ -17,12 +17,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParamsFromOthers = void 0;
 const file_based_json_1 = require("../../../lib-client/3nstorage/util/file-based-json");
-const processes_1 = require("../../../lib-common/processes");
+const synced_1 = require("../../../lib-common/processes/synced");
 class ParamsFromOthers extends file_based_json_1.JsonFileProc {
     constructor() {
         super();
         this.params = new Map();
-        this.changesProc = new processes_1.SingleProc();
+        this.changesProc = new synced_1.SingleProc();
         this.getFor = (address) => {
             const p = this.params.get(address);
             if (!p) {

package/build/core/id-manager.js

@@ -20,7 +20,7 @@ exports.IdManager = void 0;
 const ecma_nacl_1 = require("ecma-nacl");
 const provisioner_1 = require("../lib-client/mailer-id/provisioner");
 const jwkeys_1 = require("../lib-common/jwkeys");
-const processes_1 = require("../lib-common/processes");
+const synced_1 = require("../lib-common/processes/synced");
 const login_1 = require("../lib-client/mailer-id/login");
 const CERTIFICATE_DURATION_SECONDS = 16 * 60 * 60;
 const ASSERTION_VALIDITY = 15 * 60;
@@ -36,7 +36,7 @@ class IdManager {
         this.signer = undefined;
         this.localFS = undefined;
         this.syncedFS = undefined;
-        this.provisioningProc = new processes_1.SingleProc();
+        this.provisioningProc = new synced_1.SingleProc();
         this.getSigner = async () => {
             if (!this.address) {
                 throw new Error('Address is not set in id manager');

package/build/core/sign-in.d.ts

@@ -20,10 +20,11 @@ export declare class SignIn {
     exposedService(): SignInService;
     private startLoginToRemoteStorage;
     private completeLoginAndLocalSetup;
-    private doneBroadcast;
-    existingUser$: import("rxjs").Observable<IdManager>;
+    private readonly doneBroadcast;
+    readonly existingUser$: import("rxjs").Observable<IdManager>;
     private useExistingStorage;
-    private log;
+    private logAndWrap;
 }
-export declare function makeKeyGenProgressCB(progressStart: number, progressEnd: number, progressCB: (progress: number) => void): (p: number) => void;
+export declare type ProgressCB = (p: number) => void;
+export declare function makeKeyGenProgressCB(progressStart: number, progressEnd: number, progressCB: ProgressCB): ProgressCB;
 export {};

package/build/core/sign-in.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2018, 2020 3NSoft Inc.
+ Copyright (C) 2015 - 2018, 2020, 2022 3NSoft Inc.
 
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -34,8 +34,7 @@ class SignIn {
                 return !!this.completeInitWithoutCache;
             }
             catch (err) {
-                await this.log(err, 'Failing to initialize without cache');
-                throw err;
+                throw await this.logAndWrap(err, 'Fail to start login to remote storage');
             }
         };
         this.completeLoginAndLocalSetup = async (pass, progressCB) => {
@@ -46,7 +45,7 @@ class SignIn {
                 const midKeyProgressCB = makeKeyGenProgressCB(0, 50, progressCB);
                 const midKeyGen = async (params) => (await key_derivation_1.deriveMidKeyPair(this.cryptor, pass, params, midKeyProgressCB)).skey;
                 const storeKeyProgressCB = makeKeyGenProgressCB(51, 100, progressCB);
-                const storeKeyGen = params => key_derivation_1.deriveStorageSKey(this.cryptor, pass, params, storeKeyProgressCB);
+                const storeKeyGen = (params) => key_derivation_1.deriveStorageSKey(this.cryptor, pass, params, storeKeyProgressCB);
                 const idManager = await this.completeInitWithoutCache(midKeyGen, storeKeyGen);
                 if (!idManager) {
                     return false;
@@ -55,8 +54,7 @@ class SignIn {
                 return true;
             }
             catch (err) {
-                await this.log(err, 'Failing to initialize from a state without cache');
-                throw err;
+                throw await this.logAndWrap(err, 'Fail to initialize from a state without cache');
             }
         };
         this.doneBroadcast = new rxjs_1.Subject();
@@ -84,8 +82,7 @@ class SignIn {
                 return true;
             }
             catch (err) {
-                await this.log(err, 'Failing to start in a state with cache');
-                throw err;
+                throw await this.logAndWrap(err, 'Failing to start in a state with cache');
             }
         };
         Object.seal(this);
@@ -99,8 +96,9 @@ class SignIn {
         };
         return Object.freeze(service);
     }
-    async log(err, msg) {
-        await this.logError(error_1.errWithCause(err, msg));
+    async logAndWrap(err, msg) {
+        await this.logError(err, msg);
+        return error_1.errWithCause(err, msg);
     }
 }
 exports.SignIn = SignIn;
@@ -113,7 +111,7 @@ function makeKeyGenProgressCB(progressStart, progressEnd, progressCB) {
     let currentProgress = 0;
     let totalProgress = progressStart;
     const progressRange = progressEnd - progressStart;
-    return (p) => {
+    return p => {
         if (currentProgress >= p) {
             return;
         }

package/build/core/sign-up.d.ts

@@ -28,6 +28,7 @@ export declare class SignUp {
     private genStorageParams;
     private genMidParams;
     private addUser;
+    private logAndWrap;
     private forgetKeys;
     private doneBroadcast;
     newUser$: import("rxjs").Observable<CreatedUser>;

package/build/core/sign-up.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2020 3NSoft Inc.
+ Copyright (C) 2015 - 2020, 2022 3NSoft Inc.
 
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -27,6 +27,7 @@ const random = require("../lib-common/random-node");
 const ecma_nacl_1 = require("ecma-nacl");
 const sign_in_1 = require("./sign-in");
 const rxjs_1 = require("rxjs");
+const error_1 = require("../lib-common/exceptions/error");
 /**
  * With these parameters scrypt shall use memory around:
  * (2^7)*r*N === (2^7)*(2^3)*(2^17) === 2^27 === (2^7)*(2^20) === 128MB
@@ -84,8 +85,7 @@ class SignUp {
                 storage: this.store.params,
                 signupToken
             }).catch(async (err) => {
-                await this.logError(err, `Failed to create user account ${address}.`);
-                throw err;
+                throw await this.logAndWrap(err, `Failed to create user account ${address}.`);
             });
             if (!accountCreated) {
                 return false;
@@ -169,6 +169,10 @@ class SignUp {
             }
         };
     }
+    async logAndWrap(err, msg) {
+        await this.logError(err, msg);
+        return error_1.errWithCause(err, msg);
+    }
     forgetKeys() {
         this.store = undefined;
         this.mid = undefined;

package/build/core/storage/common/json-saving.d.ts

@@ -0,0 +1,21 @@
+export declare class JSONSavingProc<T> {
+    private readonly path;
+    private readonly getForSerialization;
+    private proc;
+    private jsonNeedsSaving;
+    /**
+     * @param path where json file is saved
+     * @param getForSerialization function that either returns something to
+     * jsonify and save, or undefined to remove the file.
+     * @param logError is an optional log function saving errors.
+     */
+    constructor(path: string, getForSerialization: () => T | undefined);
+    /**
+     * This triggers saving. One may await returned promise, but doesn't have to.
+     * Several triggers can be done, but overlapping ones will save only the
+     * latest value.
+     */
+    trigger(): Promise<void>;
+    isSaved(): boolean;
+    private save;
+}

package/build/core/storage/common/json-saving.js

@@ -0,0 +1,82 @@
+"use strict";
+/*
+ Copyright (C) 2022 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSONSavingProc = void 0;
+const async_fs_node_1 = require("../../../lib-common/async-fs-node");
+class JSONSavingProc {
+    /**
+     * @param path where json file is saved
+     * @param getForSerialization function that either returns something to
+     * jsonify and save, or undefined to remove the file.
+     * @param logError is an optional log function saving errors.
+     */
+    constructor(path, getForSerialization) {
+        this.path = path;
+        this.getForSerialization = getForSerialization;
+        this.proc = undefined;
+        this.jsonNeedsSaving = false;
+        Object.seal(this);
+    }
+    /**
+     * This triggers saving. One may await returned promise, but doesn't have to.
+     * Several triggers can be done, but overlapping ones will save only the
+     * latest value.
+     */
+    trigger() {
+        if (!this.jsonNeedsSaving) {
+            this.jsonNeedsSaving = true;
+            if (!this.proc) {
+                this.proc = this.save();
+            }
+        }
+        return this.proc;
+    }
+    isSaved() {
+        return !this.jsonNeedsSaving;
+    }
+    async save() {
+        try {
+            this.jsonNeedsSaving = false;
+            const serialForm = this.getForSerialization();
+            if (serialForm === undefined) {
+                await async_fs_node_1.unlink(this.path)
+                    .catch((e) => {
+                    if (!e.notFound) {
+                        throw e;
+                    }
+                });
+            }
+            else {
+                const json = JSON.stringify(serialForm);
+                await async_fs_node_1.writeFile(this.path, json, { encoding: 'utf8' });
+            }
+        }
+        finally {
+            if (this.jsonNeedsSaving) {
+                return this.save();
+            }
+            {
+                this.proc = undefined;
+            }
+        }
+    }
+}
+exports.JSONSavingProc = JSONSavingProc;
+Object.freeze(JSONSavingProc.prototype);
+Object.freeze(JSONSavingProc);
+Object.freeze(exports);