core-3nweb-client-lib 0.25.6 → 0.27.0

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.25.6",
+  "version": "0.27.0",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",
   "scripts": {
     "build": "bash packing/protos-to-node-module.sh && tsc -p ts-code && bash packing/copy-api.sh && bash packing/build-wasm-cryptor.sh",
+    "build-only-ts": "tsc -p ts-code",
     "test": "node build/tests/jasmine.js"
   },
   "repository": {
@@ -27,18 +28,18 @@
   "license": "GPL-3.0-or-later",
   "dependencies": {
     "ecma-nacl": "^2.5.1",
-    "protobufjs": "^6.10.1",
+    "protobufjs": "^6.11.3",
     "punycode": "^2.1.1",
     "rxjs": "^6.5.2",
-    "ws": "^7.0.0",
+    "ws": "^7.4.6",
     "xsp-files": "^4.0.0"
   },
   "devDependencies": {
     "@types/jasmine": "^3.9.1",
-    "@types/node": "^12.0.4",
-    "@types/ws": "^4.0.0",
+    "@types/node": "^16.11.7",
+    "@types/ws": "^7.4.7",
     "jasmine": "^3.9.0",
-    "spec-3nweb-server": "^1.3.8",
-    "typescript": "^3.7.3"
+    "spec-3nweb-server": "^1.6.1",
+    "typescript": "^4.7.4"
   }
 }

package/protos/file.proto

@@ -13,6 +13,22 @@ message File {
 	// impl is a reference to object with methods of either
 	// ReadonlyFile or WritableFile
 	common.ObjectReference impl = 5;
+	bool is_synced = 6;
+}
+
+
+message SyncStatusMsg {
+	string state = 1;
+	SyncVersionsBranchMsg local = 2;
+	SyncVersionsBranchMsg synced = 3;
+	SyncVersionsBranchMsg remote = 4;
+	common.BooleanValue exists_in_synced_parent = 5;
+}
+
+message SyncVersionsBranchMsg {
+	common.UInt64Value latest = 1;
+	repeated uint64 archived = 2;
+	common.BooleanValue is_archived = 3;
 }
 
 
@@ -30,6 +46,7 @@ message StatsMsg {
 	common.UInt64Value mtime = 6;
 	common.UInt64Value ctime = 7;
 	common.UInt64Value version = 8;
+	SyncStatusMsg sync = 9;
 }
 
 // --- ReadonlyFile.getXAttr ---
@@ -76,11 +93,10 @@ message ReadBytesReplyBody {
 message FileEventMsg {
 	string type = 1;
 	string path = 2;
-	common.BooleanValue is_remote = 3;
+	common.StringValue src = 3;
 	common.UInt64Value new_version = 4;
-	common.UInt64Value current = 14;
-	common.UInt64Value last_synced = 15;
-	common.UInt64Value remote_version = 16;
+	common.UInt64Value removed_arch_ver = 5;
+	common.UInt64Value archived_version = 6;
 }
 
 
@@ -131,6 +147,13 @@ message VersionedGetByteSourceReplyBody {
 	common.ObjectReference src = 2;
 }
 
+// --- ReadonlyFileVersionedAPI.listVersions ---
+// Request body is empty
+message ListVersionsReplyBody {
+	common.UInt64Value current = 1;
+	repeated uint64 archived = 2;
+}
+
 
 // ==== WritableFile referable as impl object (extends ReadonlyFile) ====
 
@@ -140,14 +163,15 @@ message UpdateXAttrsRequestBody {
 	XAttrsChanges changes = 1;
 }
 
+message NameAndXAttrValue {
+	string xa_name = 1;
+	common.StringValue str = 2;
+	common.StringValue json = 3;
+	common.BytesValue bytes = 4;
+}
+
 message XAttrsChanges {
-	message NameAndAttrValue {
-		string xa_name = 1;
-		common.StringValue str = 2;
-		common.StringValue json = 3;
-		common.BytesValue bytes = 4;
-	}
-	repeated NameAndAttrValue set = 1;
+	repeated NameAndXAttrValue set = 1;
 	repeated string remove = 2;
 }
 
@@ -215,3 +239,59 @@ message VersionedGetByteSinkReplyBody {
 // --- WritableFileVersionedAPI.copy ---
 // Request body is CopyRequestBody
 // Reply body is common.UInt64Value
+
+// --- WritableFileVersionedAPI.archiveCurrent ---
+// Reply body is common.UInt64Value
+message ArchiveCurrentRequestBody {
+	common.UInt64Value version = 1;
+}
+
+
+// ==== ReadonlyFileSyncAPI referable object ====
+
+// --- ReadonlyFileSyncAPI.status ---
+// Request body is empty
+// Reply body is SyncStatusMsg
+
+// --- ReadonlyFileSyncAPI.updateStatusInfo ---
+// Request body is PathOnlyRequestBody
+// Reply body is SyncState
+
+// --- ReadonlyFileSyncAPI.isRemoteVersionOnDisk ---
+message FileSyncIsOnDiskRequestBody {
+	uint64 version = 1;
+}
+message FileSyncIsOnDiskReplyBody {
+	string status = 1;
+}
+
+// --- ReadonlyFileSyncAPI.download ---
+// Reply has only status and body is empty
+message FileSyncDownloadRequestBody {
+	uint64 version = 1;
+}
+
+// --- ReadonlyFileSyncAPI.adoptRemote ---
+// Reply has only status and body is empty
+message AdoptRemoteRequestBody {
+	OptionsToAdopteRemote opts = 1;
+}
+
+message OptionsToAdopteRemote {
+	common.BooleanValue drop_local_ver = 1;
+	common.UInt64Value remote_version = 2;
+}
+
+
+// ==== WritableFileSyncAPI referable object ====
+
+// --- WritableFileSyncAPI.upload ---
+// Reply has only status and body is empty
+message FileSyncUploadRequestBody {
+	OptionsToUploadLocal opts = 1;
+}
+
+message OptionsToUploadLocal {
+	common.UInt64Value local_version = 1;
+	common.UInt64Value upload_version = 2;
+}

package/protos/fs.proto

@@ -14,6 +14,7 @@ message FS {
 	// impl is a reference to object with methods of either
 	// ReadonlyFS or WritableFS
 	common.ObjectReference impl = 5;
+	bool is_synced = 6;
 }
 
 
@@ -78,15 +79,15 @@ message SymLinkTargetReplyBody {
 message FSEventMsg {
 	string type = 1;
 	string path = 2;
-	common.BooleanValue is_remote = 3;
+	common.StringValue src = 3;
 	common.UInt64Value new_version = 4;
-	common.StringValue name = 10;
-	common.StringValue old_name = 11;
-	common.StringValue new_name = 12;
-	ListingEntryMsg entry = 13;
-	common.UInt64Value current = 14;
-	common.UInt64Value last_synced = 15;
-	common.UInt64Value remote_version = 16;
+	common.StringValue name = 5;
+	common.StringValue old_name = 6;
+	common.StringValue new_name = 7;
+	ListingEntryMsg entry = 8;
+	common.UInt64Value move_label = 9;
+	common.UInt64Value removed_arch_ver = 10;
+	common.UInt64Value archived_version = 11;
 }
 
 // --- ReadonlyFS.watchFile ---
@@ -96,6 +97,10 @@ message FSEventMsg {
 // --- ReadonlyFS.watchTree ---
 // Its an observable call, and initial request is PathOnlyRequestBody
 // Observer expects FSEventMsg in next.
+message WatchTreeRequestBody {
+	string path = 1;
+	common.UInt32Value depth = 2;
+}
 
 // --- ReadonlyFS.close ---
 // Request body is empty
@@ -256,6 +261,10 @@ message VersionedListFolderReplyBody {
 // Request body is PathOnlyRequestBody
 // Reply body is file.VersionedGetByteSourceReplyBody
 
+// --- ReadonlyFSVersionedAPI.getByteSource ---
+// Request body is PathOnlyRequestBody
+// Reply body is file.ListVersionsReplyBody
+
 
 // ==== WritableFS referable as impl object (extends ReadonlyFS) ====
 
@@ -430,3 +439,93 @@ message VersionedGetByteSinkRequestBody {
 	VersionedFileFlags flags = 2;
 }
 
+// --- WritableFSVersionedAPI.archiveCurrent ---
+// Reply body is common.UInt64Value
+message ArchiveCurrentRequestBody {
+	string path = 1;
+	common.UInt64Value version = 2;
+}
+
+
+// ==== ReadonlyFSSyncAPI referable object ====
+
+// --- ReadonlyFSSyncAPI.status ---
+// Request body is PathOnlyRequestBody
+// Reply body is file.SyncState
+
+// --- ReadonlyFSSyncAPI.updateStatusInfo ---
+// Request body is PathOnlyRequestBody
+// Reply body is file.SyncState
+
+// --- ReadonlyFSSyncAPI.isRemoteVersionOnDisk ---
+message FSSyncIsOnDiskRequestBody {
+	string path = 1;
+	uint64 version = 2;
+}
+message FSSyncIsOnDiskReplyBody {
+	string status = 1;
+}
+
+// --- ReadonlyFSSyncAPI.download ---
+// Reply has only status and body is empty
+message FSSyncDownloadRequestBody {
+	string path = 1;
+	uint64 version = 2;
+}
+
+// --- ReadonlyFSSyncAPI.adoptRemote ---
+// Reply has only status and body is empty
+message AdoptRemoteRequestBody {
+	string path = 1;
+	file.OptionsToAdopteRemote opts = 2;
+}
+
+// --- ReadonlyFSSyncAPI.diffCurrentAndRemote ---
+message DiffCurrentAndRemoteRequestBody {
+	string path = 1;
+	common.UInt64Value remote_version = 2;
+}
+message DiffCurrentAndRemoteReplyBody {
+	FolderDiff diff = 1;
+}
+
+message FolderDiff {
+	message TimeStamps {
+		uint64 current = 1;
+		common.UInt64Value remote = 2;
+	}
+	message XAttrs {
+		repeated file.NameAndXAttrValue in_current = 1;
+		repeated file.NameAndXAttrValue in_remote = 2;
+		repeated string name_overlaps = 3;
+	}
+	uint64 current_version = 1;
+	common.UInt64Value remote_version = 2;
+	repeated ListingEntryMsg in_current = 3;
+	repeated ListingEntryMsg in_remote = 4;
+	repeated string name_overlaps = 5;
+	TimeStamps ctime = 6;
+	TimeStamps mtime = 7;
+	XAttrs xattrs = 8;
+}
+
+
+// ==== WritableFSSyncAPI referable object ====
+
+// --- WritableFSSyncAPI.upload ---
+// Reply has only status and body is empty
+message FSSyncUploadRequestBody {
+	string path = 1;
+	file.OptionsToUploadLocal opts = 2;
+}
+
+// --- WritableFSSyncAPI.adoptRemoteFolderItem ---
+message AdoptRemoteFolderItemRequestBody {
+	message Options {
+		common.UInt64Value local_version = 1;
+		common.UInt64Value upload_version = 2;
+	}
+	string path = 1;
+	string item_name = 2;
+	Options opts = 3;
+}

package/build/core/storage/synced/upsync-status.d.ts

@@ -1,41 +0,0 @@
-import { LogError } from '../../../lib-client/logging/log-to-file';
-export interface UploadInfo {
-    type: 'upload';
-    transactionId?: string;
-    awaiting?: {
-        header?: true;
-        segs: BytesSection[];
-        allByteOnDisk?: true;
-    };
-    version: number;
-    baseVersion?: number;
-    done: boolean;
-}
-export interface BytesSection {
-    ofs: number;
-    len: number;
-}
-export interface RemovalInfo {
-    type: 'removal';
-    archivedVersions?: number[] | number;
-    currentVersion?: true;
-}
-export interface ArchivalInfo {
-    type: 'archiving';
-    archivalOfCurrent?: true;
-}
-export declare type UpSyncTaskInfo = UploadInfo | RemovalInfo | ArchivalInfo;
-export declare function makeUploadInfo(version: number, baseVersion: number | undefined): UploadInfo;
-export declare class UpSyncTasks {
-    private readonly objFolder;
-    private readonly saveProc;
-    private status;
-    private initProc;
-    private tasksAwaitingInit;
-    constructor(objFolder: string, logError: LogError);
-    queueTask(t: UpSyncTaskInfo): void;
-    nextTask(): Promise<UpSyncTaskInfo | undefined>;
-    recordInterimStateOfCurrentTask(t: UploadInfo): Promise<void>;
-    recordTaskCompletion(t: UpSyncTaskInfo): Promise<void>;
-    isDone(): boolean;
-}

package/build/core/storage/synced/upsync-status.js

@@ -1,158 +0,0 @@
-"use strict";
-/*
- Copyright (C) 2020 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.UpSyncTasks = exports.makeUploadInfo = void 0;
-const processes_1 = require("../../../lib-common/processes");
-const fs = require("../../../lib-common/async-fs-node");
-const path_1 = require("path");
-const obj_info_file_1 = require("../common/obj-info-file");
-function makeUploadInfo(version, baseVersion) {
-    return {
-        type: 'upload',
-        done: false,
-        version,
-        baseVersion
-    };
-}
-exports.makeUploadInfo = makeUploadInfo;
-const UPSYNC_FILE_NAME = 'upsync';
-class UpSyncTasks {
-    constructor(objFolder, logError) {
-        this.objFolder = objFolder;
-        this.saveProc = new processes_1.DeduppedRunner(async () => {
-            if (this.isDone()) {
-                await fs.unlink(path_1.join(this.objFolder, UPSYNC_FILE_NAME)).catch((e) => { if (!e.notFound) {
-                    throw e;
-                } });
-            }
-            else {
-                await fs.writeFile(path_1.join(this.objFolder, UPSYNC_FILE_NAME), JSON.stringify(this.status), { encoding: 'utf8' });
-            }
-        });
-        this.status = undefined;
-        this.initProc = undefined;
-        this.tasksAwaitingInit = undefined;
-        this.initProc = readOrMakeUpSyncInfo(this.objFolder).then(status => {
-            this.status = status;
-            if (this.tasksAwaitingInit) {
-                for (const t of this.tasksAwaitingInit) {
-                    this.queueTask(t);
-                }
-                this.tasksAwaitingInit = undefined;
-            }
-            this.initProc = undefined;
-        }, err => {
-            logError(err, `Can't setup upsync status.`);
-            this.initProc = undefined;
-        });
-        Object.seal(this);
-    }
-    queueTask(t) {
-        if (this.status) {
-            addTaskToQueue(this.status.queued, t);
-            this.saveProc.trigger();
-        }
-        else {
-            if (!this.tasksAwaitingInit) {
-                this.tasksAwaitingInit = [];
-            }
-            this.tasksAwaitingInit.push(t);
-        }
-    }
-    async nextTask() {
-        if (!this.status) {
-            await this.initProc;
-            if (!this.status) {
-                throw new Error(`Status not set after wait`);
-            }
-        }
-        if (this.status.current) {
-            return this.status.current;
-        }
-        this.status.current = this.status.queued.shift();
-        if (this.status.current) {
-            await this.saveProc.trigger();
-        }
-        return this.status.current;
-    }
-    async recordInterimStateOfCurrentTask(t) {
-        if (!this.status) {
-            throw new Error(`This method is called too early.`);
-        }
-        if (this.status.current === t) {
-            await this.saveProc.trigger();
-        }
-        else {
-            throw new Error(`Can save interim state of a current task only`);
-        }
-    }
-    async recordTaskCompletion(t) {
-        if (!this.status) {
-            throw new Error(`This method is called too early.`);
-        }
-        if (this.status.current === t) {
-            this.status.current = undefined;
-            await this.saveProc.trigger();
-        }
-    }
-    isDone() {
-        if (!this.status) {
-            return false;
-        }
-        else {
-            return (!this.status.current && (this.status.queued.length === 0));
-        }
-    }
-}
-exports.UpSyncTasks = UpSyncTasks;
-Object.freeze(UpSyncTasks.prototype);
-Object.freeze(UpSyncTasks);
-function addTaskToQueue(q, t) {
-    if (t.type === 'upload') {
-        addUploadToQueue(q, t);
-    }
-    else if (t.type === 'removal') {
-        addRemovalToQueue(q, t);
-    }
-    else if (t.type === 'archiving') {
-        addArchivalToQueue(q, t);
-    }
-    else {
-        throw new Error(`Unsupported upsync task type`);
-    }
-}
-function addUploadToQueue(q, u) {
-    // XXX
-    q.push(u);
-}
-function addRemovalToQueue(q, r) {
-    // XXX
-    q.push(r);
-}
-function addArchivalToQueue(q, a) {
-    // XXX
-    q.push(a);
-}
-async function readOrMakeUpSyncInfo(objFolder) {
-    const status = await obj_info_file_1.readJSONInfoFileIn(objFolder, UPSYNC_FILE_NAME);
-    if (!status) {
-        return { queued: [] };
-    }
-    // XXX we may do some checks and sanitization here
-    return status;
-}
-Object.freeze(exports);