core-3nweb-client-lib 0.43.17 → 0.43.19

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

@@ -1,5 +1,5 @@
 /*
- Copyright (C) 2016 - 2018, 2020, 2022, 2025 3NSoft Inc.
+ Copyright (C) 2016 - 2018, 2020, 2022, 2025 - 2026 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
@@ -1281,9 +1281,7 @@ declare namespace web3n.files {
 		 * Returns a state of on-disk cache of an item in fs.
 		 * @param version 
 		 */
-		isRemoteVersionOnDisk(
-			path: string, version: number
-		): Promise<'partial'|'complete'|'none'>;
+		isRemoteVersionOnDisk(path: string, version: number): Promise<'partial'|'complete'|'none'>;
 
 		/**
 		 * This downloads bytes onto disk, skipping decryption, as item's content isn't read here.
@@ -1301,7 +1299,7 @@ declare namespace web3n.files {
 		adoptRemote(path: string, opts?: OptionsToAdopteRemote): Promise<void>;
 
 		/**
-		 * Calculates diff between current local and remote states of folder at given path.
+		 * Calculates diff between current and remote states of folder at given path.
 		 * @param path 
 		 * @param remoteVersion 
 		 */
@@ -1331,33 +1329,97 @@ declare namespace web3n.files {
 		 */
 		getRemoteFileItem(path: string, remoteItemName: string, remoteVersion?: number): Promise<ReadonlyFile>;
 
+		/**
+		 * Returns child folder from remote version of a folder.
+		 * @param path of folder
+		 * @param remoteItemName 
+		 * @param remoteVersion of folder. Default is current remote.
+		 */
 		getRemoteFolderItem(path: string, remoteItemName: string, remoteVersion?: number): Promise<ReadonlyFS>;
 
+		// XXX method to work around demaged files
+		// reloadFromServer(path: string): Promise<SyncStatus>;
+
 	}
 
 	/**
-	 * 
+	 * Difference between two versions of folder node.
+	 * Folder items that same in both versions are not included.
 	 */
 	interface FolderDiff {
+		/**
+		 * Current version against which this diff is done.
+		 */
 		currentVersion: number;
+
+		/**
+		 * Flag indicating if current version is local, i.e. never uploaded.
+		 */
 		isCurrentLocal: boolean;
+
+		/**
+		 * Remote version against which this diff is done.
+		 */
 		remoteVersion?: number;
+
+		/**
+		 * Flag indicating if remote version is archived.
+		 * If remote is archived/delete, it has nothing inside, and with this implicit
+		 * understanding there is no need to have other data fields populated here.
+		 */
 		isRemoteArchived: boolean;
+
+		/**
+		 * Items present only in current version.
+		 */
 		inCurrent?: ListingEntry[];
+
+		/**
+		 * Items present only in remote version.
+		 */
 		inRemote?: ListingEntry[];
 
-		// XXX 
-		// differentNames?: ;
+		/**
+		 * Different names are for items that are same nodes but have different names
+		 * in local and remote branches.
+		 */
+		differentNames?: {
+			localName: string;
+			remoteName: string;
+		}[];
+
+		/**
+		 * Different keys identifies items that have different encryption keys in
+		 * local and remote branches. Keys may be changed, hence, given situation
+		 * should be reflected.
+		 */
+		differentKeys?: string[];
 
+		/**
+		 * Name overlaps are items with same name, but different node objects underneath.
+		 */
 		nameOverlaps?: string[];
+
+		/**
+		 * Creation time should always be same.
+		 * But there is no way to enforce it, hence, we have this field.
+		 */
 		ctime: {
 			remote?: Date;
 			current: Date;
 		};
+
+		/**
+		 * Modification time most probably be different between versions.
+		 */
 		mtime: {
 			remote?: Date;
 			current: Date;
 		};
+
+		/**
+		 * Difference between xattrs. Same xattrs in both versions are not included.
+		 */
 		xattrs?: {
 			inCurrent?: { name: string; value: any; }[];
 			inRemote?: { name: string; value: any; }[];
@@ -1391,7 +1453,8 @@ declare namespace web3n.files {
 
 		/**
 		 * This method is for resolving conflicts on folders.
-		 * It adopts some folder items, and not the whole folder state.
+		 * It adopts given folder item, that is present in remote version and is missing in local version.
+		 * Returns new local version.
 		 * @param path 
 		 * @param remoteItemName 
 		 * @param opts 
@@ -1400,6 +1463,15 @@ declare namespace web3n.files {
 			path: string, remoteItemName: string, opts?: OptionsToAdoptRemoteItem
 		): Promise<number>;
 
+		/**
+		 * This method is for resolving conflicts on folders.
+		 * It adopts all folder items, that are present in remote version and are missing in local version.
+		 * Returns new local version, if there were remote items to adopt and their were added to local state.
+		 * @param path 
+		 * @param opts
+		 */
+		adoptAllRemoteItems(path: string, opts?: OptionsToAdoptAllRemoteItems): Promise<number|undefined>;
+
 	}
 
 	interface OptionsToAdoptRemoteItem {
@@ -1422,6 +1494,22 @@ declare namespace web3n.files {
 		newItemName?: string;
 	}
 
+	interface OptionsToAdoptAllRemoteItems {
+		/**
+		 * Folder's local version. If not given, current local version is used.
+		 */
+		localVersion?: number;
+		/**
+		 * Folder's remote version. If not given, current remote version is used.
+		 */
+		remoteVersion?: number;
+		/**
+		 * Postfix to add to remote item names that have overlapping names with existing local items.
+		 * If there are name overlaps and postfix isn't given, then exception is thrown.
+		 */
+		postfixForNameOverlaps?: string;
+	}
+
 	interface FSEvent {
 		path: string;
 	}

package/build/core-ipc/fs.d.ts

@@ -4,7 +4,6 @@ import { Caller, CoreSideServices } from "../ipc-via-protobuf/connector";
 import { FileMsg } from "./file";
 type FS = web3n.files.FS;
 type FSItem = web3n.files.FSItem;
-type OptionsToAdoptRemoteItem = web3n.files.OptionsToAdoptRemoteItem;
 export declare function makeFSCaller(caller: Caller, fsMsg: FSMsg): FS;
 export declare function exposeFSService(fs: FS, expServices: CoreSideServices): FSMsg;
 export interface FSMsg {
@@ -38,12 +37,4 @@ export declare namespace fsItem {
     function exposeFSItem(expServices: CoreSideServices, item: FSItem): FSItemMsg;
     function fsItemFromMsg(caller: Caller, msg: FSItemMsg): FSItem;
 }
-interface OptionsToAdoptRemoteItemMsg {
-    localVersion?: Value<number>;
-    remoteVersion?: Value<number>;
-    replaceLocalItem?: Value<boolean>;
-    newItemName?: Value<string>;
-}
-export declare function optionsToAdoptRemoteItemToMsg(opts: OptionsToAdoptRemoteItem | undefined): OptionsToAdoptRemoteItemMsg | undefined;
-export declare function optionsToAdoptRemoteItemFromMsg(msg: OptionsToAdoptRemoteItemMsg | undefined): OptionsToAdoptRemoteItem | undefined;
 export {};

package/build/core-ipc/fs.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2020, 2022, 2025 3NSoft Inc.
+ Copyright (C) 2020, 2022, 2025 - 2026 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
@@ -19,8 +19,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fsItem = exports.fsMsgType = void 0;
 exports.makeFSCaller = makeFSCaller;
 exports.exposeFSService = exposeFSService;
-exports.optionsToAdoptRemoteItemToMsg = optionsToAdoptRemoteItemToMsg;
-exports.optionsToAdoptRemoteItemFromMsg = optionsToAdoptRemoteItemFromMsg;
 const protobuf_msg_1 = require("../ipc-via-protobuf/protobuf-msg");
 const protobuf_type_1 = require("../lib-client/protobuf-type");
 const fs_proto_1 = require("../protos/fs.proto");
@@ -117,6 +115,7 @@ function makeFSCaller(caller, fsMsg) {
                 fs.v.sync.startUpload = vsStartUpload.makeCaller(caller, vsPath);
                 fs.v.sync.upload = vsUpload.makeCaller(caller, vsPath);
                 fs.v.sync.adoptRemoteFolderItem = vsAdoptRemoteFolderItem.makeCaller(caller, vsPath);
+                fs.v.sync.adoptAllRemoteItems = vsAdoptAllRemoteItems.makeCaller(caller, vsPath);
             }
         }
     }
@@ -200,6 +199,7 @@ function exposeFSService(fs, expServices) {
                 implExp.v.sync.startUpload = vsStartUpload.wrapService(fs.v.sync.startUpload);
                 implExp.v.sync.upload = vsUpload.wrapService(fs.v.sync.upload);
                 implExp.v.sync.adoptRemoteFolderItem = vsAdoptRemoteFolderItem.wrapService(fs.v.sync.adoptRemoteFolderItem);
+                implExp.v.sync.adoptAllRemoteItems = vsAdoptAllRemoteItems.wrapService(fs.v.sync.adoptAllRemoteItems);
             }
         }
     }
@@ -1930,35 +1930,35 @@ var vsUpload;
     vsUpload.makeCaller = makeCaller;
 })(vsUpload || (vsUpload = {}));
 Object.freeze(vsUpload);
-function optionsToAdoptRemoteItemToMsg(opts) {
-    if (!opts) {
-        return;
-    }
-    return {
-        localVersion: (0, protobuf_msg_1.toOptVal)(opts.localVersion),
-        remoteVersion: (0, protobuf_msg_1.toOptVal)(opts.remoteVersion),
-        replaceLocalItem: (0, protobuf_msg_1.toOptVal)(opts.replaceLocalItem),
-        newItemName: (0, protobuf_msg_1.toOptVal)(opts.newItemName)
-    };
-}
-function optionsToAdoptRemoteItemFromMsg(msg) {
-    if (!msg) {
-        return;
-    }
-    return {
-        localVersion: (0, protobuf_msg_1.valOfOptInt)(msg.localVersion),
-        remoteVersion: (0, protobuf_msg_1.valOfOptInt)(msg.remoteVersion),
-        replaceLocalItem: (0, protobuf_msg_1.valOfOpt)(msg.replaceLocalItem),
-        newItemName: (0, protobuf_msg_1.valOfOpt)(msg.newItemName)
-    };
-}
 var vsAdoptRemoteFolderItem;
 (function (vsAdoptRemoteFolderItem) {
     const requestType = protobuf_type_1.ProtoType.for(fs_proto_1.fs.AdoptRemoteFolderItemRequestBody);
+    function optionsFromMsg(msg) {
+        if (!msg) {
+            return;
+        }
+        return {
+            localVersion: (0, protobuf_msg_1.valOfOptInt)(msg.localVersion),
+            remoteVersion: (0, protobuf_msg_1.valOfOptInt)(msg.remoteVersion),
+            replaceLocalItem: (0, protobuf_msg_1.valOfOpt)(msg.replaceLocalItem),
+            newItemName: (0, protobuf_msg_1.valOfOpt)(msg.newItemName)
+        };
+    }
+    function optionsToMsg(opts) {
+        if (!opts) {
+            return;
+        }
+        return {
+            localVersion: (0, protobuf_msg_1.toOptVal)(opts.localVersion),
+            remoteVersion: (0, protobuf_msg_1.toOptVal)(opts.remoteVersion),
+            replaceLocalItem: (0, protobuf_msg_1.toOptVal)(opts.replaceLocalItem),
+            newItemName: (0, protobuf_msg_1.toOptVal)(opts.newItemName)
+        };
+    }
     function wrapService(fn) {
         return buf => {
             const { path, itemName, opts } = requestType.unpack(buf);
-            const promise = fn(path, itemName, optionsToAdoptRemoteItemFromMsg(opts))
+            const promise = fn(path, itemName, optionsFromMsg(opts))
                 .then(protobuf_msg_1.packInt);
             return { promise };
         };
@@ -1968,13 +1968,55 @@ var vsAdoptRemoteFolderItem;
         const ipcPath = (0, protobuf_msg_1.methodPathFor)(objPath, 'adoptRemoteFolderItem');
         return (path, itemName, opts) => caller
             .startPromiseCall(ipcPath, requestType.pack({
-            path, itemName, opts: optionsToAdoptRemoteItemToMsg(opts)
+            path, itemName, opts: optionsToMsg(opts)
         }))
             .then(protobuf_msg_1.unpackInt);
     }
     vsAdoptRemoteFolderItem.makeCaller = makeCaller;
 })(vsAdoptRemoteFolderItem || (vsAdoptRemoteFolderItem = {}));
 Object.freeze(vsAdoptRemoteFolderItem);
+var vsAdoptAllRemoteItems;
+(function (vsAdoptAllRemoteItems) {
+    const requestType = protobuf_type_1.ProtoType.for(fs_proto_1.fs.AdoptAllRemoteFolderItemsRequestBody);
+    function optionsFromMsg(msg) {
+        if (!msg) {
+            return;
+        }
+        return {
+            localVersion: (0, protobuf_msg_1.valOfOptInt)(msg.localVersion),
+            remoteVersion: (0, protobuf_msg_1.valOfOptInt)(msg.remoteVersion),
+            postfixForNameOverlaps: (0, protobuf_msg_1.valOfOpt)(msg.postfixForNameOverlaps),
+        };
+    }
+    function optionsToMsg(opts) {
+        if (!opts) {
+            return;
+        }
+        return {
+            localVersion: (0, protobuf_msg_1.toOptVal)(opts.localVersion),
+            remoteVersion: (0, protobuf_msg_1.toOptVal)(opts.remoteVersion),
+            postfixForNameOverlaps: (0, protobuf_msg_1.toOptVal)(opts.postfixForNameOverlaps),
+        };
+    }
+    const replyType = protobuf_type_1.ProtoType.for(fs_proto_1.fs.AdoptAllRemoteFolderItemsReplyBody);
+    function wrapService(fn) {
+        return buf => {
+            const { path, opts } = requestType.unpack(buf);
+            const promise = fn(path, optionsFromMsg(opts))
+                .then(newVersion => replyType.pack({ newVersion: (0, protobuf_msg_1.toOptVal)(newVersion) }));
+            return { promise };
+        };
+    }
+    vsAdoptAllRemoteItems.wrapService = wrapService;
+    function makeCaller(caller, objPath) {
+        const ipcPath = (0, protobuf_msg_1.methodPathFor)(objPath, 'adoptAllRemoteItems');
+        return (path, opts) => caller
+            .startPromiseCall(ipcPath, requestType.pack({ path, opts: optionsToMsg(opts) }))
+            .then(buf => (0, protobuf_msg_1.valOfOptInt)(replyType.unpack(buf).newVersion));
+    }
+    vsAdoptAllRemoteItems.makeCaller = makeCaller;
+})(vsAdoptAllRemoteItems || (vsAdoptAllRemoteItems = {}));
+Object.freeze(vsAdoptAllRemoteItems);
 var vsAdoptRemote;
 (function (vsAdoptRemote) {
     const requestType = protobuf_type_1.ProtoType.for(fs_proto_1.fs.AdoptRemoteRequestBody);
@@ -2152,6 +2194,8 @@ function folderDiffToMsg(diff) {
         inCurrent: (_a = diff.inCurrent) === null || _a === void 0 ? void 0 : _a.map(lsEntryToMsg),
         inRemote: (_b = diff.inRemote) === null || _b === void 0 ? void 0 : _b.map(lsEntryToMsg),
         nameOverlaps: diff.nameOverlaps,
+        differentKeys: diff.differentKeys,
+        differentNames: diff.differentNames,
         ctime: diffTStoMsg(diff.ctime),
         mtime: diffTStoMsg(diff.mtime),
         xattrs: (diff.xattrs ? {
@@ -2177,20 +2221,19 @@ function folderDiffFromMsg(msg) {
         currentVersion: (0, protobuf_msg_1.fixInt)(msg.currentVersion),
         isCurrentLocal: msg.isCurrentLocal,
         isRemoteArchived: msg.isRemoteArchived,
-        inCurrent: ((msg.inCurrent.length > 0) ?
-            msg.inCurrent.map(lsEntryFromMsg) : undefined),
-        inRemote: ((msg.inRemote.length > 0) ?
-            msg.inRemote.map(lsEntryFromMsg) : undefined),
-        nameOverlaps: ((msg.nameOverlaps.length > 0) ?
-            msg.nameOverlaps : undefined),
+        inCurrent: ((msg.inCurrent && (msg.inCurrent.length > 0)) ? msg.inCurrent.map(lsEntryFromMsg) : undefined),
+        inRemote: ((msg.inRemote && (msg.inRemote.length > 0)) ? msg.inRemote.map(lsEntryFromMsg) : undefined),
+        nameOverlaps: ((msg.nameOverlaps && (msg.nameOverlaps.length > 0)) ? msg.nameOverlaps : undefined),
+        differentKeys: ((msg.differentKeys && (msg.differentKeys.length > 0)) ? msg.differentKeys : undefined),
+        differentNames: ((msg.differentNames && (msg.differentNames.length > 0)) ? msg.differentNames : undefined),
         ctime: diffTSfromMsg(msg.ctime),
         mtime: diffTSfromMsg(msg.mtime),
         xattrs: (msg.xattrs ? {
-            inCurrent: ((msg.xattrs.inCurrent.length > 0) ?
+            inCurrent: ((msg.xattrs.inCurrent && (msg.xattrs.inCurrent.length > 0)) ?
                 msg.xattrs.inCurrent.map(file.xattrFromMsg) : undefined),
-            inRemote: ((msg.xattrs.inRemote.length > 0) ?
+            inRemote: ((msg.xattrs.inRemote && (msg.xattrs.inRemote.length > 0)) ?
                 msg.xattrs.inRemote.map(file.xattrFromMsg) : undefined),
-            nameOverlaps: ((msg.xattrs.nameOverlaps.length > 0) ?
+            nameOverlaps: ((msg.xattrs.nameOverlaps && (msg.xattrs.nameOverlaps.length > 0)) ?
                 msg.xattrs.nameOverlaps : undefined)
         } : undefined)
     };

package/build/lib-client/fs-utils/files.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2016 - 2022, 2025 3NSoft Inc.
+ Copyright (C) 2016 - 2022, 2025 - 2026 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
@@ -241,6 +241,7 @@ function wrapWritableFSSyncAPI(sImpl) {
         startUpload: sImpl.startUpload.bind(sImpl),
         upload: sImpl.upload.bind(sImpl),
         adoptRemoteFolderItem: sImpl.adoptRemoteFolderItem.bind(sImpl),
+        adoptAllRemoteItems: sImpl.adoptAllRemoteItems.bind(sImpl),
         statRemoteItem: sImpl.statRemoteItem.bind(sImpl),
         listRemoteFolderItem: sImpl.listRemoteFolderItem.bind(sImpl),
         getRemoteFileItem: sImpl.getRemoteFileItem.bind(sImpl),

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

@@ -11,6 +11,7 @@ type XAttrsChanges = web3n.files.XAttrsChanges;
 type FolderDiff = web3n.files.FolderDiff;
 type OptionsToAdopteRemote = web3n.files.OptionsToAdopteRemote;
 type OptionsToAdoptRemoteItem = web3n.files.OptionsToAdoptRemoteItem;
+type OptionsToAdoptAllRemoteItems = web3n.files.OptionsToAdoptAllRemoteItems;
 type OptionsToUploadLocal = web3n.files.OptionsToUploadLocal;
 type VersionedReadFlags = web3n.files.VersionedReadFlags;
 type Stats = web3n.files.Stats;
@@ -96,6 +97,16 @@ export declare class FolderNode extends NodeInFS<FolderPersistance> {
     getFile(name: string, undefOnMissing?: boolean): Promise<FileNode | undefined>;
     getLink(name: string, undefOnMissing?: boolean): Promise<LinkNode | undefined>;
     private fixMissingChildAndThrow;
+    adoptItemsFromRemoteVersion(opts: OptionsToAdoptAllRemoteItems | undefined): Promise<number | undefined>;
+    /**
+     * If no initial local version given, then this performs like doTransition(change) method.
+     * When initial local version is given and check, exceptions are thrown if versions mismatch,
+     * or when there is another concurrent process that is already transitioning folder state to new state.
+     * This returns value of new local version.
+     * @param initLocalVersion
+     * @param change
+     */
+    private doChangeWhileTrackingVersion;
     /**
      * This method prepares a transition state, runs given action, and completes
      * transition to a new version.
@@ -161,6 +172,7 @@ export declare class FolderNode extends NodeInFS<FolderPersistance> {
     private getRemoteChildNodeInfo;
     private addRemoteChild;
     private replaceLocalChildWithRemote;
+    private readRemoteVersion;
     diffCurrentAndRemote(remoteVersion: number | undefined): Promise<FolderDiff | undefined>;
     private diffWithArchivedRemote;
     private diffWithRemote;