core-3nweb-client-lib 0.26.1 → 0.27.3

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.26.1",
+  "version": "0.27.3",
   "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": {
@@ -30,15 +31,16 @@
     "protobufjs": "^6.11.3",
     "punycode": "^2.1.1",
     "rxjs": "^6.5.2",
+    "tsuml2": "^0.6.1",
     "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.4.0",
-    "typescript": "^3.7.3"
+    "spec-3nweb-server": "^1.6.3",
+    "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;
 }
 
 
@@ -22,14 +38,6 @@ message File {
 // Request body is empty
 // Reply body is StatsMsg
 message StatsMsg {
-	message SyncInfo {
-		string state = 1;
-		common.UInt64Value latest = 2;
-		common.UInt64Value remote = 3;
-		repeated uint64 conflicting_remote = 4;
-		common.BooleanValue deleted_on_remote = 5;
-	}
-
 	common.BooleanValue is_file = 1;
 	common.BooleanValue is_folder = 2;
 	common.BooleanValue is_link = 3;
@@ -38,7 +46,7 @@ message StatsMsg {
 	common.UInt64Value mtime = 6;
 	common.UInt64Value ctime = 7;
 	common.UInt64Value version = 8;
-	SyncInfo sync = 9;
+	SyncStatusMsg sync = 9;
 }
 
 // --- ReadonlyFile.getXAttr ---
@@ -85,10 +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 uploaded = 15;
+	common.UInt64Value removed_arch_ver = 5;
+	common.UInt64Value archived_version = 6;
 }
 
 
@@ -139,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) ====
 
@@ -148,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;
 }
 
@@ -223,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 uploaded = 15;
-	common.UInt64Value move_label = 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/id-manager.d.ts

@@ -1,46 +0,0 @@
-import { user as mid } from '../lib-common/mid-sigs-NaCl-Ed';
-import { JsonKey } from '../lib-common/jwkeys';
-import { GenerateKey } from './sign-in';
-import { LogError, LogWarning } from '../lib-client/logging/log-to-file';
-import { NetClient } from '../lib-client/request-utils';
-import { ServiceLocator } from '../lib-client/service-locator';
-declare type WritableFS = web3n.files.WritableFS;
-/**
- * This function completes provisioning process, returning a promise, resolvable
- * to either true, when all is done, or to false, when challenge reply is not
- * accepted by the server.
- */
-export interface CompleteProvisioning {
-    keyParams: any;
-    complete(defaultSKey: Uint8Array): Promise<boolean>;
-}
-/**
- * This returns a promise, resolvable to mailerId signer.
- */
-export declare type GetSigner = () => Promise<mid.MailerIdSigner>;
-export declare class IdManager {
-    private makeNet;
-    private midServiceFor;
-    private readonly logError;
-    private readonly logWarning;
-    private address;
-    private signer;
-    private localFS;
-    private syncedFS;
-    private provisioningProc;
-    private constructor();
-    static initInOneStepWithoutStore(address: string, midLoginKey: GenerateKey | Uint8Array, resolver: ServiceLocator, makeNet: () => NetClient, logError: LogError, logWarning: LogWarning): Promise<IdManager | undefined>;
-    static initWithoutStore(address: string, resolver: ServiceLocator, makeNet: () => NetClient, logError: LogError, logWarning: LogWarning): Promise<((midLoginKey: GenerateKey | Uint8Array) => Promise<IdManager | undefined>) | undefined>;
-    static initFromLocalStore(address: string, localFS: WritableFS, resolver: ServiceLocator, makeNet: () => NetClient, logError: LogError, logWarning: LogWarning): Promise<IdManager | undefined>;
-    private ensureLocalCacheOfKeys;
-    private getSavedKey;
-    setStorages(localFS: WritableFS | undefined, syncedFS: WritableFS, keysToSave?: JsonKey[]): Promise<void>;
-    private provisionWithGivenKey;
-    private provisionUsingSavedKey;
-    getId(): string;
-    getSigner: GetSigner;
-    isProvisionedAndValid(): boolean;
-    makeMailerIdCAP(): Service;
-}
-declare type Service = web3n.mailerid.Service;
-export {};