core-3nweb-client-lib 0.43.18 → 0.43.20

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

@@ -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 
 		 */
@@ -1345,32 +1343,83 @@ declare namespace web3n.files {
 	}
 
 	/**
-	 * 
+	 * 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;
-		isRemoteArchived: boolean;
+
+		/**
+		 * Flag indicating if remote version is removed, i.e. has no current version.
+		 * If remote is removed, it has nothing inside, and with this implicit
+		 * understanding there is no need to have other data fields populated here.
+		 */
+		isRemoteRemoved: boolean;
+
+		/**
+		 * Items present only in current version.
+		 */
 		inCurrent?: ListingEntry[];
+
+		/**
+		 * Items present only in remote version.
+		 */
 		inRemote?: ListingEntry[];
 
-		// XXX add indication for items that have different name
+		/**
+		 * 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; }[];

package/build/core-ipc/fs.js

@@ -199,7 +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.adoptAllRemoteFolderItems = vsAdoptAllRemoteItems.wrapService(fs.v.sync.adoptAllRemoteItems);
+                implExp.v.sync.adoptAllRemoteItems = vsAdoptAllRemoteItems.wrapService(fs.v.sync.adoptAllRemoteItems);
             }
         }
     }
@@ -2012,7 +2012,7 @@ var vsAdoptAllRemoteItems;
         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.valOfOpt)(replyType.unpack(buf).newVersion));
+            .then(buf => (0, protobuf_msg_1.valOfOptInt)(replyType.unpack(buf).newVersion));
     }
     vsAdoptAllRemoteItems.makeCaller = makeCaller;
 })(vsAdoptAllRemoteItems || (vsAdoptAllRemoteItems = {}));
@@ -2190,10 +2190,12 @@ function folderDiffToMsg(diff) {
         remoteVersion: (0, protobuf_msg_1.toOptVal)(diff.remoteVersion),
         currentVersion: diff.currentVersion,
         isCurrentLocal: diff.isCurrentLocal,
-        isRemoteArchived: diff.isRemoteArchived,
+        isRemoteRemoved: diff.isRemoteRemoved,
         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 ? {
@@ -2218,21 +2220,20 @@ function folderDiffFromMsg(msg) {
         remoteVersion: (0, protobuf_msg_1.valOfOptInt)(msg.remoteVersion),
         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),
+        isRemoteRemoved: msg.isRemoteRemoved,
+        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)
     };