core-3nweb-client-lib 0.43.2 → 0.43.4

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

@@ -77,6 +77,7 @@ declare namespace web3n.files {
 		removedOnServer?: true;
 		versionMismatch?: true;
 		conflict?: true;
+		isBehind?: true;
 		notSynced?: true;
 		remoteIsArchived?: true;
 		remoteFolderItemNotFound?: true;
@@ -497,6 +498,9 @@ declare namespace web3n.files {
 			flags?: VersionedReadFlags
 		): Promise<{ current?: number; archived?: number[]; }>;
 
+		/**
+		 * File from synced storage has this api
+		 */
 		sync?: ReadonlyFileSyncAPI;
 
 	}
@@ -567,6 +571,9 @@ declare namespace web3n.files {
 
 		archiveCurrent(version?: number): Promise<number>;
 
+		/**
+		 * File from synced storage has this api
+		 */
 		sync?: WritableFileSyncAPI;
 
 	}
@@ -580,12 +587,24 @@ declare namespace web3n.files {
 		 */
 		status(skipServerCheck?: boolean): Promise<SyncStatus>;
 
+		/**
+		 * Returns a state of on-disk cache.
+		 * @param version 
+		 */
 		isRemoteVersionOnDisk(
 			version: number
 		): Promise<'partial'|'complete'|'none'>;
 
+		/**
+		 * This downloads bytes onto disk, skipping decryption, as file content isn't read here.
+		 * @param version 
+		 */
 		download(version: number): Promise<void>;
 
+		/**
+		 * Adopts remote version.
+		 * @param opts options let one to pass exact remote version, to trigger download.
+		 */
 		adoptRemote(opts?: OptionsToAdopteRemote): Promise<void>;
 
 	}
@@ -598,6 +617,10 @@ declare namespace web3n.files {
 
 	interface WritableFileSyncAPI extends ReadonlyFileSyncAPI {
 
+		/**
+		 * Upload in conflicting and behind state of sync requires explicit upload version.
+		 * @param opts 
+		 */
 		upload(opts?: OptionsToUploadLocal): Promise<number|undefined>;
 
 	}
@@ -1106,6 +1129,9 @@ declare namespace web3n.files {
 			path: string
 		): Promise<{ current?: number; archived?: number[]; }>;
 
+		/**
+		 * Folder/FS from synced storage has this api
+		 */
 		sync?: ReadonlyFSSyncAPI;
 
 	}
@@ -1169,6 +1195,9 @@ declare namespace web3n.files {
 
 		archiveCurrent(path: string, version?: number): Promise<number>;
 
+		/**
+		 * Folder/FS from synced storage has this api
+		 */
 		sync?: WritableFSSyncAPI;
 
 	}
@@ -1183,14 +1212,33 @@ declare namespace web3n.files {
 		 */
 		status(path: string, skipServerCheck?: boolean): Promise<SyncStatus>;
 
+		/**
+		 * Returns a state of on-disk cache of an item in fs.
+		 * @param version 
+		 */
 		isRemoteVersionOnDisk(
 			path: string, version: number
 		): Promise<'partial'|'complete'|'none'>;
 
+		/**
+		 * This downloads bytes onto disk, skipping decryption, as item's content isn't read here.
+		 * @param path 
+		 * @param version 
+		 */
 		download(path: string, version: number): Promise<void>;
 
+		/**
+		 * Adopts remote version of fs object at given path
+		 * @param path 
+		 * @param opts options let one to pass exact remote version, to trigger download.
+		 */
 		adoptRemote(path: string, opts?: OptionsToAdopteRemote): Promise<void>;
 
+		/**
+		 * Calculates diff between current local and remote states of folder at given path.
+		 * @param path 
+		 * @param remoteVersion 
+		 */
 		diffCurrentAndRemoteFolderVersions(
 			path: string, remoteVersion?: number
 		): Promise<FolderDiff|undefined>;
@@ -1222,10 +1270,22 @@ declare namespace web3n.files {
 
 	interface WritableFSSyncAPI extends ReadonlyFSSyncAPI {
 
+		/**
+		 * Upload in conflicting and behind state of sync requires explicit upload version.
+		 * @param path 
+		 * @param opts 
+		 */
 		upload(
 			path: string, opts?: OptionsToUploadLocal
 		): Promise<number|undefined>;
 
+		/**
+		 * This method is for resolving conflicts on folders.
+		 * It adopts some folder items, and not the whole folder state.
+		 * @param path 
+		 * @param itemName 
+		 * @param opts 
+		 */
 		adoptRemoteFolderItem(
 			path: string, itemName: string, opts?: OptionsToAdoptRemoteItem
 		): Promise<number>;

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2022 - 2023 3NSoft Inc.
+ Copyright (C) 2022 - 2023, 2025 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
@@ -211,7 +211,7 @@ class SqliteFiles {
         (0, file_1.ensureCorrectFS)(syncedFS, 'synced', true);
         const files = new SqliteFiles(syncedFS);
         const records = await files.makeRecords();
-        files.startSyncing();
+        // files.startSyncing();
         return { files, records };
     }
     async makeRecords() {

package/build/lib-client/ws-utils.js

@@ -28,8 +28,11 @@ function openSocket(url, sessionId) {
     const headers = {};
     headers[request_utils_1.SESSION_ID_HEADER] = sessionId;
     const ws = new WebSocket(url, { headers, agent: https_1.globalAgent });
-    const opening = (0, deferred_1.defer)();
-    const initOnError = (err) => opening.reject((0, http_1.makeConnectionException)(url, undefined, `Cannot open websocket connection due to error: ${err.message}`));
+    let opening = (0, deferred_1.defer)();
+    const initOnError = (err) => {
+        opening === null || opening === void 0 ? void 0 : opening.reject((0, http_1.makeConnectionException)(url, undefined, `WebSocket connection error: ${err.message}`));
+        opening = undefined;
+    };
     const onNonOkReply = (req, res) => {
         const errReply = {
             url,
@@ -37,7 +40,8 @@ function openSocket(url, sessionId) {
             status: res.statusCode,
             data: undefined
         };
-        opening.resolve(errReply);
+        opening === null || opening === void 0 ? void 0 : opening.resolve(errReply);
+        opening = undefined;
     };
     ws.on('error', initOnError);
     ws.on('unexpected-response', onNonOkReply);
@@ -48,10 +52,15 @@ function openSocket(url, sessionId) {
             status: 200,
             data: ws
         };
-        opening.resolve(okReply);
+        opening === null || opening === void 0 ? void 0 : opening.resolve(okReply);
+        opening = undefined;
         ws.removeListener('error', initOnError);
         ws.removeListener('unexpected-response', onNonOkReply);
     });
+    ws.on('error', err => {
+        // XXX we need 
+        console.error(`Error in ${ws.url} connection`, err);
+    });
     return opening.promise;
 }
 Object.freeze(exports);

package/build/lib-client/xsp-fs/folder-node.d.ts

@@ -145,7 +145,7 @@ export declare class FolderNode extends NodeInFS<FolderPersistance> {
     upload(opts: OptionsToUploadLocal | undefined): Promise<number | undefined>;
     private uploadRemovalOf;
     private listRemovedInTreeToUploadRm;
-    protected needUpload(localVersion: number | undefined): Promise<{
+    protected needUpload(opts: OptionsToUploadLocal | undefined): Promise<{
         localVersion: number;
         uploadVersion: number;
         createOnRemote: boolean;

package/build/lib-client/xsp-fs/folder-node.js

@@ -788,7 +788,7 @@ class FolderNode extends node_in_fs_1.NodeInFS {
     }
     async upload(opts) {
         try {
-            const toUpload = await this.needUpload(opts === null || opts === void 0 ? void 0 : opts.localVersion);
+            const toUpload = await this.needUpload(opts);
             if (!toUpload) {
                 return;
             }
@@ -848,8 +848,8 @@ class FolderNode extends node_in_fs_1.NodeInFS {
             return node.objId;
         }
     }
-    async needUpload(localVersion) {
-        const toUpload = await super.needUpload(localVersion);
+    async needUpload(opts) {
+        const toUpload = await super.needUpload(opts);
         if (!toUpload) {
             return;
         }

package/build/lib-client/xsp-fs/node-in-fs.d.ts

@@ -77,7 +77,7 @@ export declare abstract class NodeInFS<P extends NodePersistance> implements Nod
     download(version: number): Promise<void>;
     protected abstract setCurrentStateFrom(src: ObjSource): Promise<void>;
     adoptRemote(opts: OptionsToAdopteRemote | undefined): Promise<void>;
-    protected needUpload(localVersion: number | undefined): Promise<{
+    protected needUpload(opts: OptionsToUploadLocal | undefined): Promise<{
         localVersion: number;
         uploadVersion: number;
         createOnRemote: boolean;

package/build/lib-client/xsp-fs/node-in-fs.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2020, 2022 3NSoft Inc.
+ Copyright (C) 2015 - 2020, 2022, 2025 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
@@ -337,8 +337,10 @@ class NodeInFS {
             }
         });
     }
-    async needUpload(localVersion) {
-        const { local, remote, synced } = await this.syncStatus();
+    async needUpload(opts) {
+        var _a;
+        const { local, remote, synced, state } = await this.syncStatus();
+        let localVersion = opts === null || opts === void 0 ? void 0 : opts.localVersion;
         if (localVersion) {
             if (localVersion !== this.currentVersion) {
                 throw (0, exceptions_1.makeFSSyncException)(this.name, {
@@ -349,8 +351,8 @@ class NodeInFS {
             }
             if (!local || (local.latest !== localVersion)) {
                 throw (0, exceptions_1.makeFSSyncException)(this.name, {
-                    versionMismatch: true,
-                    message: `No local version ${localVersion} to upload`
+                    versionNotFound: true,
+                    message: `There is no local version ${localVersion} to upload`
                 });
             }
         }
@@ -360,38 +362,73 @@ class NodeInFS {
             }
             localVersion = this.currentVersion;
         }
-        if (remote) {
-            if (remote.latest) {
-                const uploadVersion = remote.latest + 1;
-                return { createOnRemote: false, localVersion, uploadVersion };
+        if ((remote && !remote.latest) || (synced && !synced.latest)) {
+            throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                versionMismatch: true,
+                removedOnServer: true
+            });
+        }
+        let uploadVersion = opts === null || opts === void 0 ? void 0 : opts.uploadVersion;
+        if (state === 'unsynced') {
+            if (uploadVersion) {
+                if (((synced === null || synced === void 0 ? void 0 : synced.latest) && ((synced.latest + 1) !== uploadVersion))) {
+                    throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                        versionMismatch: true,
+                        message: `Given uploadVersion is ${uploadVersion} is not a +1 increment over synced version ${(_a = synced.latest) !== null && _a !== void 0 ? _a : 0}, in unsynced state.`
+                    });
+                }
+            }
+            else {
+                uploadVersion = (synced === null || synced === void 0 ? void 0 : synced.latest) ? ((synced === null || synced === void 0 ? void 0 : synced.latest) + 1) : 1;
+            }
+        }
+        else if (state === 'conflicting') {
+            if (uploadVersion) {
+                if (uploadVersion <= remote.latest) {
+                    throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                        versionMismatch: true,
+                        conflict: true,
+                        message: `Given upload version ${uploadVersion} is not greater than remote version ${remote === null || remote === void 0 ? void 0 : remote.latest}.`
+                    });
+                }
             }
             else {
                 throw (0, exceptions_1.makeFSSyncException)(this.name, {
                     versionMismatch: true,
-                    removedOnServer: true
+                    conflict: true,
+                    message: `Upload version is not given during upload from conflicting state.`
                 });
             }
         }
-        else if (synced) {
-            if (synced.latest) {
-                const uploadVersion = synced.latest + 1;
-                return { createOnRemote: false, localVersion, uploadVersion };
+        else if (state === 'behind') {
+            if (uploadVersion) {
+                if (uploadVersion <= remote.latest) {
+                    throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                        versionMismatch: true,
+                        isBehind: true,
+                        message: `Given upload version ${uploadVersion} is not greater than remote version ${remote === null || remote === void 0 ? void 0 : remote.latest}.`
+                    });
+                }
             }
             else {
                 throw (0, exceptions_1.makeFSSyncException)(this.name, {
                     versionMismatch: true,
-                    removedOnServer: true
+                    isBehind: true,
+                    message: `Upload version is not given during upload when synced state is behind remote.`
                 });
             }
         }
+        else if (state === 'synced') {
+            return;
+        }
         else {
-            const uploadVersion = 1;
-            return { createOnRemote: true, localVersion, uploadVersion };
+            throw new Error(`Unrecognized sync state ${state}`);
         }
+        return { createOnRemote: (uploadVersion === 1), localVersion, uploadVersion };
     }
     async upload(opts) {
         try {
-            const toUpload = await this.needUpload(opts === null || opts === void 0 ? void 0 : opts.localVersion);
+            const toUpload = await this.needUpload(opts);
             if (!toUpload) {
                 return;
             }

package/build/lib-common/ipc/ws-ipc.js

@@ -38,15 +38,12 @@ function makeJsonCommPoint(ws) {
     const observers = new generic_ipc_1.MultiObserverWrap();
     const { heartbeat, healthyBeat, otherBeat } = makeHeartbeat(ws.url);
     ws.on('message', data => {
-        if (typeof data !== 'string') {
-            return;
-        }
         if (observers.done) {
             return;
         }
         let env;
         try {
-            env = JSON.parse(data);
+            env = JSON.parse(data.toString('utf8'));
         }
         catch (err) {
             ws.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.43.2",
+  "version": "0.43.4",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",
@@ -32,13 +32,13 @@
     "protobufjs": "^7.0.1",
     "punycode": "^2.1.1",
     "rxjs": "^7.5.7",
-    "ws": "^7.4.6",
+    "ws": "^8.18.3",
     "xsp-files": "^4.2.1"
   },
   "devDependencies": {
     "@types/jasmine": "^3.9.1",
     "@types/node": "^16.11.7",
-    "@types/ws": "^7.4.7",
+    "@types/ws": "^8.18.1",
     "jasmine": "^3.9.0",
     "protobufjs-cli": "^1.0.2",
     "spec-3nweb-server": "^1.8.0",