core-3nweb-client-lib 0.43.12 → 0.43.13

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

@@ -83,6 +83,7 @@ declare namespace web3n.files {
 		notSynced?: true;
 		remoteIsArchived?: true;
 		remoteFolderItemNotFound?: true;
+		overlapsLocalItem?: true;
 	}
 
 	/**
@@ -1304,9 +1305,17 @@ declare namespace web3n.files {
 		 * @param path 
 		 * @param remoteVersion 
 		 */
-		diffCurrentAndRemoteFolderVersions(
-			path: string, remoteVersion?: number
-		): Promise<FolderDiff|undefined>;
+		diffCurrentAndRemoteFolderVersions(path: string, remoteVersion?: number): Promise<FolderDiff|undefined>;
+
+
+		// XXX (Christmas methods)
+		// add following methods to read remote item, facilitating decisions in conflict situations.
+
+		// statRemoteItem(path: string, remoteItemName: string, remoteVersion?: number): Promise<Stats>;
+
+		// listRemoteFolderItem(path: string, remoteItemName: string, remoteVersion?: number): Promise<ListingEntry[]>;
+
+		// getRemoteFileItem(path: string, remoteItemName: string, remoteVersion?: number): Promise<ReadonlyFile>;
 
 	}
 
@@ -1355,26 +1364,39 @@ declare namespace web3n.files {
 		 * @param path 
 		 * @param opts 
 		 */
-		upload(
-			path: string, opts?: OptionsToUploadLocal
-		): Promise<number|undefined>;
+		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 remoteItemName 
 		 * @param opts 
 		 */
 		adoptRemoteFolderItem(
-			path: string, itemName: string, opts?: OptionsToAdoptRemoteItem
+			path: string, remoteItemName: string, opts?: OptionsToAdoptRemoteItem
 		): Promise<number>;
 
 	}
 
 	interface OptionsToAdoptRemoteItem {
+		/**
+		 * 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;
+		/**
+		 * Flag to force replacement of locally referenced item under the same item name (or new name).
+		 * If not given, and there is an overlapping local, an exception is thrown.
+		 */
+		replaceLocalItem?: boolean;
+		/**
+		 * Name for item when it is added into local folder version.
+		 */
+		newItemName?: string;
 	}
 
 	interface FSEvent {

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

@@ -41,6 +41,8 @@ export declare namespace 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;

package/build/core-ipc/fs.js

@@ -1920,7 +1920,9 @@ function optionsToAdoptRemoteItemToMsg(opts) {
     }
     return {
         localVersion: (0, protobuf_msg_1.toOptVal)(opts.localVersion),
-        remoteVersion: (0, protobuf_msg_1.toOptVal)(opts.remoteVersion)
+        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) {
@@ -1929,7 +1931,9 @@ function optionsToAdoptRemoteItemFromMsg(msg) {
     }
     return {
         localVersion: (0, protobuf_msg_1.valOfOptInt)(msg.localVersion),
-        remoteVersion: (0, protobuf_msg_1.valOfOptInt)(msg.remoteVersion)
+        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;

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

@@ -157,7 +157,7 @@ export declare class FolderNode extends NodeInFS<FolderPersistance> {
         createOnRemote: boolean;
     } | undefined>;
     private getNodesRemovedBetweenVersions;
-    adoptRemoteFolderItem(itemName: string, opts: OptionsToAdoptRemoteItem | undefined): Promise<number>;
+    adoptRemoteFolderItem(remoteItemName: string, opts: OptionsToAdoptRemoteItem | undefined): Promise<number>;
     private addRemoteChild;
     private replaceLocalChildWithRemote;
     diffCurrentAndRemote(remoteVersion: number | undefined): Promise<FolderDiff | undefined>;

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

@@ -890,7 +890,7 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         const { removedNodes } = identifyChanges(syncedState.nodes, stateToUpload.nodes);
         return removedNodes;
     }
-    async adoptRemoteFolderItem(itemName, opts) {
+    async adoptRemoteFolderItem(remoteItemName, opts) {
         if (opts === null || opts === void 0 ? void 0 : opts.localVersion) {
             if (this.version !== opts.localVersion) {
                 throw (0, exceptions_1.makeFSSyncException)(this.name, {
@@ -922,30 +922,44 @@ class FolderNode extends node_in_fs_1.NodeInFS {
         const storage = this.syncedStorage();
         const srcOfRemote = await storage.getObjSrcOfRemoteVersion(this.objId, remote.latest);
         const { folderInfo: { nodes: remoteNodes } } = await this.crypto.read(srcOfRemote);
-        const remoteChildNode = remoteNodes[itemName];
+        const remoteChildNode = remoteNodes[remoteItemName];
         if (!remoteChildNode) {
             throw (0, exceptions_1.makeFSSyncException)(this.name, {
                 remoteFolderItemNotFound: true,
-                message: `Item '${itemName}' is not found in remote version`
+                message: `Item '${remoteItemName}' is not found in remote version`
             });
         }
-        const localNodeToRm = this.getNodeInfo(itemName, true);
-        if (!localNodeToRm) {
-            return await this.addRemoteChild(remoteChildNode);
+        let dstItemName = remoteItemName;
+        if (typeof (opts === null || opts === void 0 ? void 0 : opts.newItemName) === 'string') {
+            const newItemName = opts.newItemName.trim();
+            if (newItemName.length > 0) {
+                dstItemName = newItemName;
+            }
+        }
+        const localNodeWithSameName = this.getNodeInfo(dstItemName, true);
+        if (!localNodeWithSameName) {
+            return await this.addRemoteChild(remoteChildNode, dstItemName);
         }
-        else if (localNodeToRm.objId === remoteChildNode.objId) {
-            (0, assert_1.assert)(typeOfNode(localNodeToRm) === typeOfNode(remoteChildNode));
+        else if (localNodeWithSameName.objId === remoteChildNode.objId) {
+            (0, assert_1.assert)(typeOfNode(localNodeWithSameName) === typeOfNode(remoteChildNode));
             // XXX
             throw new Error(`Adaptation of changing keys needs implementation`);
         }
-        else {
+        else if (opts === null || opts === void 0 ? void 0 : opts.replaceLocalItem) {
             return await this.replaceLocalChildWithRemote(remoteChildNode);
         }
+        else {
+            throw (0, exceptions_1.makeFSSyncException)(this.name, {
+                overlapsLocalItem: true,
+                message: `Local item exists under name '${dstItemName}' and option flag is not forcing replacement`
+            });
+        }
     }
-    async addRemoteChild(remoteChildNode) {
+    async addRemoteChild(remoteChildNode, childName) {
         let newVersion;
         await this.doTransition(async (state, version) => {
             newVersion = version;
+            remoteChildNode.name = childName;
             state.nodes[remoteChildNode.name] = remoteChildNode;
             const event = {
                 type: 'entry-addition',

package/build/protos/asmail.proto.js

@@ -33583,6 +33583,8 @@ $root.fs = (function() {
              * @interface IOptions
              * @property {common.IUInt64Value|null} [localVersion] Options localVersion
              * @property {common.IUInt64Value|null} [uploadVersion] Options uploadVersion
+             * @property {common.IBooleanValue|null} [replaceLocalItem] Options replaceLocalItem
+             * @property {common.IStringValue|null} [newItemName] Options newItemName
              */
 
             /**
@@ -33616,6 +33618,22 @@ $root.fs = (function() {
              */
             Options.prototype.uploadVersion = null;
 
+            /**
+             * Options replaceLocalItem.
+             * @member {common.IBooleanValue|null|undefined} replaceLocalItem
+             * @memberof fs.AdoptRemoteFolderItemRequestBody.Options
+             * @instance
+             */
+            Options.prototype.replaceLocalItem = null;
+
+            /**
+             * Options newItemName.
+             * @member {common.IStringValue|null|undefined} newItemName
+             * @memberof fs.AdoptRemoteFolderItemRequestBody.Options
+             * @instance
+             */
+            Options.prototype.newItemName = null;
+
             /**
              * Creates a new Options instance using the specified properties.
              * @function create
@@ -33644,6 +33662,10 @@ $root.fs = (function() {
                     $root.common.UInt64Value.encode(message.localVersion, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
                 if (message.uploadVersion != null && Object.hasOwnProperty.call(message, "uploadVersion"))
                     $root.common.UInt64Value.encode(message.uploadVersion, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
+                if (message.replaceLocalItem != null && Object.hasOwnProperty.call(message, "replaceLocalItem"))
+                    $root.common.BooleanValue.encode(message.replaceLocalItem, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
+                if (message.newItemName != null && Object.hasOwnProperty.call(message, "newItemName"))
+                    $root.common.StringValue.encode(message.newItemName, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim();
                 return writer;
             };
 
@@ -33688,6 +33710,14 @@ $root.fs = (function() {
                             message.uploadVersion = $root.common.UInt64Value.decode(reader, reader.uint32());
                             break;
                         }
+                    case 3: {
+                            message.replaceLocalItem = $root.common.BooleanValue.decode(reader, reader.uint32());
+                            break;
+                        }
+                    case 4: {
+                            message.newItemName = $root.common.StringValue.decode(reader, reader.uint32());
+                            break;
+                        }
                     default:
                         reader.skipType(tag & 7);
                         break;
@@ -33733,6 +33763,16 @@ $root.fs = (function() {
                     if (error)
                         return "uploadVersion." + error;
                 }
+                if (message.replaceLocalItem != null && message.hasOwnProperty("replaceLocalItem")) {
+                    var error = $root.common.BooleanValue.verify(message.replaceLocalItem);
+                    if (error)
+                        return "replaceLocalItem." + error;
+                }
+                if (message.newItemName != null && message.hasOwnProperty("newItemName")) {
+                    var error = $root.common.StringValue.verify(message.newItemName);
+                    if (error)
+                        return "newItemName." + error;
+                }
                 return null;
             };
 
@@ -33758,6 +33798,16 @@ $root.fs = (function() {
                         throw TypeError(".fs.AdoptRemoteFolderItemRequestBody.Options.uploadVersion: object expected");
                     message.uploadVersion = $root.common.UInt64Value.fromObject(object.uploadVersion);
                 }
+                if (object.replaceLocalItem != null) {
+                    if (typeof object.replaceLocalItem !== "object")
+                        throw TypeError(".fs.AdoptRemoteFolderItemRequestBody.Options.replaceLocalItem: object expected");
+                    message.replaceLocalItem = $root.common.BooleanValue.fromObject(object.replaceLocalItem);
+                }
+                if (object.newItemName != null) {
+                    if (typeof object.newItemName !== "object")
+                        throw TypeError(".fs.AdoptRemoteFolderItemRequestBody.Options.newItemName: object expected");
+                    message.newItemName = $root.common.StringValue.fromObject(object.newItemName);
+                }
                 return message;
             };
 
@@ -33777,11 +33827,17 @@ $root.fs = (function() {
                 if (options.defaults) {
                     object.localVersion = null;
                     object.uploadVersion = null;
+                    object.replaceLocalItem = null;
+                    object.newItemName = null;
                 }
                 if (message.localVersion != null && message.hasOwnProperty("localVersion"))
                     object.localVersion = $root.common.UInt64Value.toObject(message.localVersion, options);
                 if (message.uploadVersion != null && message.hasOwnProperty("uploadVersion"))
                     object.uploadVersion = $root.common.UInt64Value.toObject(message.uploadVersion, options);
+                if (message.replaceLocalItem != null && message.hasOwnProperty("replaceLocalItem"))
+                    object.replaceLocalItem = $root.common.BooleanValue.toObject(message.replaceLocalItem, options);
+                if (message.newItemName != null && message.hasOwnProperty("newItemName"))
+                    object.newItemName = $root.common.StringValue.toObject(message.newItemName, options);
                 return object;
             };
 

package/build/protos/fs.proto.js

@@ -14604,6 +14604,8 @@ $root.fs = (function() {
              * @interface IOptions
              * @property {common.IUInt64Value|null} [localVersion] Options localVersion
              * @property {common.IUInt64Value|null} [uploadVersion] Options uploadVersion
+             * @property {common.IBooleanValue|null} [replaceLocalItem] Options replaceLocalItem
+             * @property {common.IStringValue|null} [newItemName] Options newItemName
              */
 
             /**
@@ -14637,6 +14639,22 @@ $root.fs = (function() {
              */
             Options.prototype.uploadVersion = null;
 
+            /**
+             * Options replaceLocalItem.
+             * @member {common.IBooleanValue|null|undefined} replaceLocalItem
+             * @memberof fs.AdoptRemoteFolderItemRequestBody.Options
+             * @instance
+             */
+            Options.prototype.replaceLocalItem = null;
+
+            /**
+             * Options newItemName.
+             * @member {common.IStringValue|null|undefined} newItemName
+             * @memberof fs.AdoptRemoteFolderItemRequestBody.Options
+             * @instance
+             */
+            Options.prototype.newItemName = null;
+
             /**
              * Creates a new Options instance using the specified properties.
              * @function create
@@ -14665,6 +14683,10 @@ $root.fs = (function() {
                     $root.common.UInt64Value.encode(message.localVersion, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
                 if (message.uploadVersion != null && Object.hasOwnProperty.call(message, "uploadVersion"))
                     $root.common.UInt64Value.encode(message.uploadVersion, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
+                if (message.replaceLocalItem != null && Object.hasOwnProperty.call(message, "replaceLocalItem"))
+                    $root.common.BooleanValue.encode(message.replaceLocalItem, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
+                if (message.newItemName != null && Object.hasOwnProperty.call(message, "newItemName"))
+                    $root.common.StringValue.encode(message.newItemName, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim();
                 return writer;
             };
 
@@ -14709,6 +14731,14 @@ $root.fs = (function() {
                             message.uploadVersion = $root.common.UInt64Value.decode(reader, reader.uint32());
                             break;
                         }
+                    case 3: {
+                            message.replaceLocalItem = $root.common.BooleanValue.decode(reader, reader.uint32());
+                            break;
+                        }
+                    case 4: {
+                            message.newItemName = $root.common.StringValue.decode(reader, reader.uint32());
+                            break;
+                        }
                     default:
                         reader.skipType(tag & 7);
                         break;
@@ -14754,6 +14784,16 @@ $root.fs = (function() {
                     if (error)
                         return "uploadVersion." + error;
                 }
+                if (message.replaceLocalItem != null && message.hasOwnProperty("replaceLocalItem")) {
+                    var error = $root.common.BooleanValue.verify(message.replaceLocalItem);
+                    if (error)
+                        return "replaceLocalItem." + error;
+                }
+                if (message.newItemName != null && message.hasOwnProperty("newItemName")) {
+                    var error = $root.common.StringValue.verify(message.newItemName);
+                    if (error)
+                        return "newItemName." + error;
+                }
                 return null;
             };
 
@@ -14779,6 +14819,16 @@ $root.fs = (function() {
                         throw TypeError(".fs.AdoptRemoteFolderItemRequestBody.Options.uploadVersion: object expected");
                     message.uploadVersion = $root.common.UInt64Value.fromObject(object.uploadVersion);
                 }
+                if (object.replaceLocalItem != null) {
+                    if (typeof object.replaceLocalItem !== "object")
+                        throw TypeError(".fs.AdoptRemoteFolderItemRequestBody.Options.replaceLocalItem: object expected");
+                    message.replaceLocalItem = $root.common.BooleanValue.fromObject(object.replaceLocalItem);
+                }
+                if (object.newItemName != null) {
+                    if (typeof object.newItemName !== "object")
+                        throw TypeError(".fs.AdoptRemoteFolderItemRequestBody.Options.newItemName: object expected");
+                    message.newItemName = $root.common.StringValue.fromObject(object.newItemName);
+                }
                 return message;
             };
 
@@ -14798,11 +14848,17 @@ $root.fs = (function() {
                 if (options.defaults) {
                     object.localVersion = null;
                     object.uploadVersion = null;
+                    object.replaceLocalItem = null;
+                    object.newItemName = null;
                 }
                 if (message.localVersion != null && message.hasOwnProperty("localVersion"))
                     object.localVersion = $root.common.UInt64Value.toObject(message.localVersion, options);
                 if (message.uploadVersion != null && message.hasOwnProperty("uploadVersion"))
                     object.uploadVersion = $root.common.UInt64Value.toObject(message.uploadVersion, options);
+                if (message.replaceLocalItem != null && message.hasOwnProperty("replaceLocalItem"))
+                    object.replaceLocalItem = $root.common.BooleanValue.toObject(message.replaceLocalItem, options);
+                if (message.newItemName != null && message.hasOwnProperty("newItemName"))
+                    object.newItemName = $root.common.StringValue.toObject(message.newItemName, options);
                 return object;
             };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.43.12",
+  "version": "0.43.13",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",

package/protos/fs.proto

@@ -531,6 +531,8 @@ message AdoptRemoteFolderItemRequestBody {
 	message Options {
 		common.UInt64Value local_version = 1;
 		common.UInt64Value upload_version = 2;
+		common.BooleanValue replace_local_item = 3;
+		common.StringValue new_item_name = 4;
 	}
 	string path = 1;
 	string item_name = 2;