core-3nweb-client-lib 0.27.0 → 0.27.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.27.0",
+  "version": "0.27.4",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",
@@ -31,6 +31,7 @@
     "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"
   },
@@ -39,7 +40,7 @@
     "@types/node": "^16.11.7",
     "@types/ws": "^7.4.7",
     "jasmine": "^3.9.0",
-    "spec-3nweb-server": "^1.6.1",
+    "spec-3nweb-server": "^1.6.3",
     "typescript": "^4.7.4"
   }
 }

package/protos/file.proto

@@ -102,8 +102,20 @@ message FileEventMsg {
 
 // ==== ReadonlyFileVersionedAPI referable object ====
 
+message VersionedReadFlags {
+	common.UInt64Value archived_version = 1;
+	common.UInt64Value remote_version = 2;
+}
+
+message RequestWithVersionedReadFlags {
+	VersionedReadFlags flags = 1;
+}
+
 // --- ReadonlyFileVersionedAPI.getXAttr ---
-// Request body is GetXAttrRequestBody
+message VersionedGetXAttrRequestBody {
+	string xa_name = 1;
+	VersionedReadFlags flags = 2;
+}
 message VersionedGetXAttrReplyBody {
 	uint64 version = 1;
 	common.StringValue str = 2;
@@ -112,35 +124,39 @@ message VersionedGetXAttrReplyBody {
 }
 
 // --- ReadonlyFileVersionedAPI.listXAttrs ---
-// Request body is empty
+// Request body is RequestWithVersionedReadFlags
 message VersionedListXAttrsReplyBody {
 	uint64 version = 1;
 	repeated string xa_names = 2;
 }
 
 // --- ReadonlyFileVersionedAPI.readBytes ---
-// Request body is ReadBytesRequestBody
+message VersionedReadBytesRequestBody {
+	common.UInt64Value start = 1;
+	common.UInt64Value end = 2;
+	VersionedReadFlags flags = 10;
+}
 message VersionedReadBytesReplyBody {
 	uint64 version = 1;
 	common.BytesValue bytes = 2;
 }
 
 // --- ReadonlyFileVersionedAPI.readTxt ---
-// Request body is empty
+// Request body is RequestWithVersionedReadFlags
 message VersionedReadTxtReplyBody {
 	uint64 version = 1;
 	string txt = 2;
 }
 
 // --- ReadonlyFileVersionedAPI.readJSON ---
-// Request body is empty
+// Request body is RequestWithVersionedReadFlags
 message VersionedReadJsonReplyBody {
 	uint64 version = 1;
 	string json = 2;
 }
 
 // --- ReadonlyFileVersionedAPI.getByteSource ---
-// Request body is empty
+// Request body is RequestWithVersionedReadFlags
 message VersionedGetByteSourceReplyBody {
 	uint64 version = 1;
 	// src is a reference to FileByteSource
@@ -148,7 +164,7 @@ message VersionedGetByteSourceReplyBody {
 }
 
 // --- ReadonlyFileVersionedAPI.listVersions ---
-// Request body is empty
+// Request body is RequestWithVersionedReadFlags
 message ListVersionsReplyBody {
 	common.UInt64Value current = 1;
 	repeated uint64 archived = 2;

package/protos/fs.proto

@@ -231,38 +231,52 @@ message CollectionEvent {
 // ==== ReadonlyFSVersionedAPI referable object ====
 
 // --- ReadonlyFSVersionedAPI.getXAttr ---
-// Request body is GetXAttrRequestBody
+message VersionedGetXAttrRequestBody {
+	string path = 1;
+	string xa_name = 2;
+	file.VersionedReadFlags flags = 10;
+}
 // Reply body is file.VersionedGetXAttrReplyBody
 
+message PathAndFlagsRequestBody {
+	string path = 1;
+	file.VersionedReadFlags flags = 2;
+}
+
 // --- ReadonlyFSVersionedAPI.listXAttrs ---
-// Request body is PathOnlyRequestBody
+// Request body is PathAndFlagsRequestBody
 // Reply body is file.VersionedListXAttrsReplyBody
 
 // --- ReadonlyFSVersionedAPI.listFolder ---
-// Request body is PathOnlyRequestBody
+// Request body is PathAndFlagsRequestBody
 message VersionedListFolderReplyBody {
 	uint64 version = 1;
 	repeated ListingEntryMsg entries = 2;
 }
 
 // --- ReadonlyFSVersionedAPI.readJSONFile ---
-// Request body is PathOnlyRequestBody
+// Request body is PathAndFlagsRequestBody
 // Reply body is file.VersionedReadJsonReplyBody
 
 // --- ReadonlyFSVersionedAPI.readTxtFile ---
-// Request body is PathOnlyRequestBody
+// Request body is PathAndFlagsRequestBody
 // Reply body is file.VersionedReadTxtReplyBody
 
 // --- ReadonlyFSVersionedAPI.readBytes ---
-// Request body is ReadBytesRequestBody
+message VersionedReadBytesRequestBody {
+	string path = 1;
+	common.UInt64Value start = 2;
+	common.UInt64Value end = 3;
+	file.VersionedReadFlags flags = 10;
+}
 // Reply body is file.VersionedReadBytesReplyBody
 
 // --- ReadonlyFSVersionedAPI.getByteSource ---
-// Request body is PathOnlyRequestBody
+// Request body is PathAndFlagsRequestBody
 // Reply body is file.VersionedGetByteSourceReplyBody
 
 // --- ReadonlyFSVersionedAPI.getByteSource ---
-// Request body is PathOnlyRequestBody
+// Request body is PathAndFlagsRequestBody
 // Reply body is file.ListVersionsReplyBody
 
 
@@ -406,10 +420,10 @@ message WriteBytesRequestBody {
 message VersionedWriteJsonFileRequestBody {
 	string path = 1;
 	string json = 2;
-	VersionedFileFlags flags = 3;
+	VersionedFileWriteFlags flags = 3;
 }
 
-message VersionedFileFlags {
+message VersionedFileWriteFlags {
 	common.BooleanValue truncate = 1;
 	common.BooleanValue create = 2;
 	common.BooleanValue exclusive = 3;
@@ -421,7 +435,7 @@ message VersionedFileFlags {
 message VersionedWriteTxtFileRequestBody {
 	string path = 1;
 	string txt = 2;
-	VersionedFileFlags flags = 3;
+	VersionedFileWriteFlags flags = 3;
 }
 
 // --- WritableFSVersionedAPI.writeBytes ---
@@ -429,14 +443,14 @@ message VersionedWriteTxtFileRequestBody {
 message VersionedWriteBytesRequestBody {
 	string path = 1;
 	bytes bytes = 2;
-	VersionedFileFlags flags = 3;
+	VersionedFileWriteFlags flags = 3;
 }
 
 // --- WritableFSVersionedAPI.getByteSink ---
 // Reply body is file.VersionedGetByteSinkReplyBody
 message VersionedGetByteSinkRequestBody {
 	string path = 1;
-	VersionedFileFlags flags = 2;
+	VersionedFileWriteFlags flags = 2;
 }
 
 // --- WritableFSVersionedAPI.archiveCurrent ---

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 {};