core-3nweb-client-lib 0.27.0 → 0.27.4

package/build/lib-client/3nstorage/xsp-fs/common.d.ts

@@ -1,6 +1,7 @@
 import { ScryptGenParams } from '../../key-derivation';
 import { AsyncSBoxCryptor, Subscribe, ObjSource } from 'xsp-files';
 import { Observable } from 'rxjs';
+import { LogError } from '../../logging/log-to-file';
 export { AsyncSBoxCryptor } from 'xsp-files';
 export { FolderInJSON } from './folder-node';
 declare type StorageType = web3n.files.FSType;
@@ -16,7 +17,6 @@ export interface Node {
     objId: string;
     name: string;
     type: NodeType;
-    removeObj(src?: FSChangeSrc): Promise<void>;
 }
 export declare type NodeType = 'file' | 'link' | 'folder';
 export declare type ObjId = string | null;
@@ -58,6 +58,7 @@ export interface Storage {
     readonly versioned: boolean;
     readonly cryptor: AsyncSBoxCryptor;
     readonly nodes: NodesContainer;
+    readonly logError: LogError;
     getNodeEvents(): Observable<NodeEvent>;
     broadcastNodeEvent(objId: ObjId, parentObjId: ObjId | undefined, childObjId: ObjId | undefined, ev: NodeEvent['event']): void;
     /**
@@ -73,10 +74,8 @@ export interface Storage {
     generateNewObjId(): Promise<string>;
     /**
      * This returns a promise, resolvable to source for a requested object.
-     * @param objId
-     * @param version
      */
-    getObjSrc(objId: ObjId, version?: number): Promise<ObjSource>;
+    getObjSrc(objId: ObjId, version?: number, allowArchived?: boolean): Promise<ObjSource>;
     /**
      * This saves given object, asynchronously.
      * @param objId
@@ -114,6 +113,7 @@ export interface SyncedStorage extends Storage {
     getRootKeyDerivParamsFromServer(): Promise<ScryptGenParams>;
     adoptRemote(objId: ObjId, opts: OptionsToAdopteRemote | undefined): Promise<number | undefined>;
     updateStatusInfo(objId: ObjId): Promise<SyncStatus>;
+    isObjOnDisk(objId: ObjId): Promise<boolean>;
     isRemoteVersionOnDisk(objId: ObjId, version: number): Promise<'partial' | 'complete' | 'none'>;
     download(objId: ObjId, version: number): Promise<void>;
     upload(objId: ObjId, localVersion: number, uploadVersion: number, uploadHeader: UploadHeaderChange | undefined, createOnRemote: boolean): Promise<void>;
@@ -124,6 +124,7 @@ export interface SyncedStorage extends Storage {
 export interface SyncedObjStatus extends LocalObjStatus {
     syncStatus(): SyncStatus;
     neverUploaded(): boolean;
+    versionBeforeUnsyncedRemoval(): number | undefined;
 }
 export interface UploadHeaderChange {
     localVersion: number;

package/build/lib-client/3nstorage/xsp-fs/common.js

@@ -98,6 +98,7 @@ function wrapStorageImplementation(impl) {
         type: impl.type,
         versioned: impl.versioned,
         nodes: impl.nodes,
+        logError: impl.logError,
         getNodeEvents: impl.getNodeEvents.bind(impl),
         broadcastNodeEvent: impl.broadcastNodeEvent.bind(impl),
         storageForLinking: impl.storageForLinking.bind(impl),

package/build/lib-client/3nstorage/xsp-fs/file-node.d.ts

@@ -11,6 +11,7 @@ import { NodePersistance } from './node-persistence';
 declare type FileByteSource = web3n.files.FileByteSource;
 declare type FileByteSink = web3n.files.FileByteSink;
 declare type XAttrsChanges = web3n.files.XAttrsChanges;
+declare type VersionedReadFlags = web3n.files.VersionedReadFlags;
 interface FileAttrs {
     attrs: CommonAttrs;
     size: number;
@@ -19,14 +20,8 @@ interface FileAttrs {
 declare class FilePersistance extends NodePersistance {
     constructor(zNonce: Uint8Array, key: Uint8Array, cryptor: AsyncSBoxCryptor);
     getAttrs(objSrc: ObjSource): Promise<FileAttrs>;
-    getFileSource(objSrc: ObjSource, getAttrs?: boolean): Promise<{
-        src: FileByteSource;
-        fileAttrs?: FileAttrs;
-    }>;
-    readBytes(objSrc: ObjSource, start: number | undefined, end: number | undefined, getAttrs?: boolean): Promise<{
-        bytes?: Uint8Array;
-        fileAttrs?: FileAttrs;
-    }>;
+    getFileSource(objSrc: ObjSource): Promise<FileByteSource>;
+    readBytes(objSrc: ObjSource, start: number | undefined, end: number | undefined): Promise<Uint8Array | undefined>;
     saveBytes(bytes: Uint8Array | Uint8Array[], version: number, attrs: CommonAttrs, xattrs: XAttrs | undefined): Promise<Subscribe>;
     getFileSink(version: number, attrs: CommonAttrs, xattrs: XAttrs | undefined, base: ObjSource | undefined): Promise<{
         sinkPromise: Promise<FileByteSink>;
@@ -48,11 +43,11 @@ export declare class FileNode extends NodeInFS<FilePersistance> {
     protected setCurrentStateFrom(src: ObjSource): Promise<void>;
     private setUpdatedState;
     get size(): number;
-    readSrc(): Promise<{
+    readSrc(flags: VersionedReadFlags | undefined): Promise<{
         src: FileByteSource;
         version: number;
     }>;
-    readBytes(start: number | undefined, end: number | undefined): Promise<{
+    readBytes(start: number | undefined, end: number | undefined, flags: VersionedReadFlags | undefined): Promise<{
         bytes: Uint8Array | undefined;
         version: number;
     }>;

package/build/lib-client/3nstorage/xsp-fs/file-node.js

@@ -43,14 +43,11 @@ class FilePersistance extends node_persistence_1.NodePersistance {
         const payload = await super.readonlyPayload(objSrc);
         return await fileAttrsFrom(payload);
     }
-    async getFileSource(objSrc, getAttrs = false) {
+    async getFileSource(objSrc) {
         const payload = await this.readonlyPayload(objSrc);
-        const src = payload.makeFileByteSource();
-        return (getAttrs ?
-            { src, fileAttrs: await fileAttrsFrom(payload) } :
-            { src });
+        return payload.makeFileByteSource();
     }
-    async readBytes(objSrc, start, end, getAttrs = false) {
+    async readBytes(objSrc, start, end) {
         if ((typeof start === 'number') && (start < 0)) {
             throw new Error(`Parameter start has bad value: ${start}`);
         }
@@ -64,22 +61,18 @@ class FilePersistance extends node_persistence_1.NodePersistance {
             end = size;
         }
         else if (start >= size) {
-            return (getAttrs ? { fileAttrs: await fileAttrsFrom(payload) } : {});
+            return;
         }
         if (typeof end === 'number') {
             end = Math.min(size, end);
             if (end <= start) {
-                return (getAttrs ?
-                    { fileAttrs: await fileAttrsFrom(payload) } : {});
+                return;
             }
         }
         else {
             end = size;
         }
-        const bytes = await payload.readSomeContentBytes(start, end);
-        return (getAttrs ?
-            { bytes, fileAttrs: await fileAttrsFrom(payload) } :
-            { bytes });
+        return await payload.readSomeContentBytes(start, end);
     }
     async saveBytes(bytes, version, attrs, xattrs) {
         return super.writeWhole(bytes, version, attrs, xattrs);
@@ -139,45 +132,50 @@ class FileNode extends node_in_fs_1.NodeInFS {
     get size() {
         return this.fileSize;
     }
-    async readSrc() {
-        const objSrc = await this.storage.getObjSrc(this.objId);
-        if ((this.storage.type === 'synced') || (this.storage.type === 'local')) {
-            const version = objSrc.version;
-            if (this.version < version) {
-                const { src, fileAttrs } = await this.crypto.getFileSource(objSrc, true);
-                this.setUpdatedState(version, fileAttrs);
-                return { src, version };
-            }
-            else {
-                const { src } = await this.crypto.getFileSource(objSrc);
-                return { src, version };
-            }
+    async readSrc(flags) {
+        const objSrc = await this.getObjSrcOfVersion(flags);
+        let version;
+        if ((this.storage.type === 'synced')
+            || (this.storage.type === 'local')
+            || (this.storage.type === 'share')) {
+            version = objSrc.version;
         }
         else {
-            const { src } = await this.crypto.getFileSource(objSrc);
-            // unversioned storage passes undefined version
-            return { src, version: undefined };
+            version = undefined;
         }
+        const src = await this.crypto.getFileSource(objSrc);
+        return { src, version };
     }
-    async readBytes(start, end) {
-        const objSrc = await this.storage.getObjSrc(this.objId);
-        if ((this.storage.type === 'synced') || (this.storage.type === 'local')) {
-            const version = objSrc.version;
-            if (this.version < version) {
-                const { bytes, fileAttrs } = await this.crypto.readBytes(objSrc, start, end, true);
-                this.setUpdatedState(version, fileAttrs);
-                return { bytes, version };
-            }
-            else {
-                const { bytes } = await this.crypto.readBytes(objSrc, start, end);
-                return { bytes, version };
-            }
+    async readBytes(start, end, flags) {
+        const objSrc = await this.getObjSrcOfVersion(flags);
+        let version;
+        if ((this.storage.type === 'synced')
+            || (this.storage.type === 'local')
+            || (this.storage.type === 'share')) {
+            version = objSrc.version;
         }
         else {
-            const { bytes } = await this.crypto.readBytes(objSrc, start, end);
-            // unversioned storage passes undefined version
-            return { bytes, version: undefined };
+            version = undefined;
         }
+        const bytes = await this.crypto.readBytes(objSrc, start, end);
+        return { bytes, version };
+        // if ((this.storage.type === 'synced') || (this.storage.type === 'local')) {
+        // 	const version = objSrc.version;
+        // 	if (this.version < version) {
+        // 		const {
+        // 			bytes, fileAttrs
+        // 		} = await this.crypto.readBytes(objSrc, start, end, true);
+        // 		// this.setUpdatedState(version, fileAttrs!);
+        // 		return { bytes, version };
+        // 	} else {
+        // 		const { bytes } = await this.crypto.readBytes(objSrc, start, end);
+        // 		return { bytes, version };
+        // 	}
+        // } else {
+        // 	const { bytes } = await this.crypto.readBytes(objSrc, start, end);
+        // 	// unversioned storage passes undefined version
+        // 	return { bytes, version: (undefined as any) };
+        // }
     }
     async writeSink(truncate, currentVersion, changes) {
         const deferredSink = (0, deferred_1.defer)();

package/build/lib-client/3nstorage/xsp-fs/file.d.ts

@@ -15,6 +15,7 @@ declare type SyncStatus = web3n.files.SyncStatus;
 declare type WritableFileVersionedAPI = web3n.files.WritableFileVersionedAPI;
 declare type OptionsToAdopteRemote = web3n.files.OptionsToAdopteRemote;
 declare type OptionsToUploadLocal = web3n.files.OptionsToUploadLocal;
+declare type VersionedReadFlags = web3n.files.VersionedReadFlags;
 export declare class FileObject implements WritableFile, Linkable {
     name: string;
     isNew: boolean;
@@ -54,11 +55,11 @@ declare class V implements WritableFileVersionedAPI, N {
     getNode(): Promise<FileNode>;
     ensureIsWritable(): void;
     updateXAttrs(changes: XAttrsChanges): Promise<number>;
-    getXAttr(xaName: string): Promise<{
+    getXAttr(xaName: string, flags?: VersionedReadFlags): Promise<{
         attr: any;
         version: number;
     }>;
-    listXAttrs(): Promise<{
+    listXAttrs(flags?: VersionedReadFlags): Promise<{
         lst: string[];
         version: number;
     }>;
@@ -67,23 +68,23 @@ declare class V implements WritableFileVersionedAPI, N {
         sink: FileByteSink;
         version: number;
     }>;
-    getByteSource(): Promise<{
+    getByteSource(flags?: VersionedReadFlags): Promise<{
         src: FileByteSource;
         version: number;
     }>;
     writeBytes(bytes: Uint8Array): Promise<number>;
     writeTxt(txt: string): Promise<number>;
     writeJSON(json: any): Promise<number>;
-    readBytes(start?: number, end?: number): Promise<{
+    readBytes(start?: number, end?: number, flags?: VersionedReadFlags): Promise<{
         bytes: Uint8Array | undefined;
         version: number;
     }>;
-    readTxt(): Promise<{
+    readTxt(flags?: VersionedReadFlags): Promise<{
         txt: string;
         version: number;
     }>;
     copy(file: File): Promise<number>;
-    readJSON<T>(): Promise<{
+    readJSON<T>(flags?: VersionedReadFlags): Promise<{
         json: T;
         version: number;
     }>;

package/build/lib-client/3nstorage/xsp-fs/file.js

@@ -148,19 +148,13 @@ class V {
         const node = await this.getNode();
         return node.updateXAttrs(changes);
     }
-    async getXAttr(xaName) {
+    async getXAttr(xaName, flags) {
         const node = await this.getNode();
-        return {
-            attr: node.getXAttr(xaName),
-            version: node.version
-        };
+        return await node.getXAttr(xaName, flags);
     }
-    async listXAttrs() {
+    async listXAttrs(flags) {
         const node = await this.getNode();
-        return {
-            lst: node.listXAttrs(),
-            version: node.version
-        };
+        return await node.listXAttrs(flags);
     }
     async getLinkParams() {
         if (!this.node) {
@@ -176,11 +170,11 @@ class V {
         const node = await this.getNode();
         return node.writeSink(truncate, currentVersion);
     }
-    async getByteSource() {
+    async getByteSource(flags) {
         if (!this.node) {
-            throw (0, file_1.makeFileException)(file_1.Code.notFound, this.name);
+            throw (0, file_1.makeFileException)('notFound', this.name);
         }
-        return this.node.readSrc();
+        return this.node.readSrc(flags);
     }
     async writeBytes(bytes) {
         this.ensureIsWritable();
@@ -194,14 +188,14 @@ class V {
     writeJSON(json) {
         return this.writeTxt(JSON.stringify(json));
     }
-    async readBytes(start, end) {
+    async readBytes(start, end, flags) {
         if (!this.node) {
-            throw (0, file_1.makeFileException)(file_1.Code.notFound, this.name);
+            throw (0, file_1.makeFileException)('notFound', this.name);
         }
-        return await this.node.readBytes(start, end);
+        return await this.node.readBytes(start, end, flags);
     }
-    async readTxt() {
-        const { bytes, version } = await this.readBytes();
+    async readTxt(flags) {
+        const { bytes, version } = await this.readBytes(undefined, undefined, flags);
         const txt = (bytes ? buffer_utils_1.utf8.open(bytes) : '');
         return { txt, version };
     }
@@ -212,8 +206,8 @@ class V {
         await (0, pipe_1.pipe)(src, sink);
         return version;
     }
-    async readJSON() {
-        const { txt, version } = await this.readTxt();
+    async readJSON(flags) {
+        const { txt, version } = await this.readTxt(flags);
         const json = JSON.parse(txt);
         return { json, version };
     }

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

@@ -1,4 +1,4 @@
-import { Storage, Node, NodeType, FSChangeSrc } from './common';
+import { Storage, NodeType } from './common';
 import { NodeInFS } from './node-in-fs';
 import { FileNode } from './file-node';
 import { LinkNode } from './link-node';
@@ -12,6 +12,7 @@ declare type FolderDiff = web3n.files.FolderDiff;
 declare type OptionsToAdopteRemote = web3n.files.OptionsToAdopteRemote;
 declare type OptionsToAdoptRemoteItem = web3n.files.OptionsToAdoptRemoteItem;
 declare type OptionsToUploadLocal = web3n.files.OptionsToUploadLocal;
+declare type VersionedReadFlags = web3n.files.VersionedReadFlags;
 export interface NodeInfo {
     /**
      * This is a usual file name.
@@ -58,6 +59,7 @@ declare class FolderPersistance extends NodePersistance {
         attrs: CommonAttrs;
         xattrs?: XAttrs;
     }>;
+    static readFolderContent(objId: string | null, key: Uint8Array, src: ObjSource, cryptor: AsyncSBoxCryptor): Promise<FolderInfo>;
 }
 export interface FolderLinkParams {
     folderName: string;
@@ -74,15 +76,19 @@ export declare class FolderNode extends NodeInFS<FolderPersistance> {
     static rootFromJSON(storage: Storage, name: string | undefined, folderJson: FolderInJSON): FolderNode;
     protected setCurrentStateFrom(src: ObjSource): Promise<void>;
     adoptRemote(opts: OptionsToAdopteRemote | undefined): Promise<void>;
+    private callRemoveObjOn;
     list(): {
         lst: ListingEntry[];
         version: number;
     };
+    listNonCurrent(flags: VersionedReadFlags): Promise<{
+        lst: ListingEntry[];
+        version: number;
+    }>;
     childExistsInSyncedVersion(childObjId: string): Promise<boolean>;
-    listFolders(): string[];
     getNodeInfo(name: string, undefOnMissing?: boolean): NodeInfo | undefined;
     hasChild(childName: string, throwIfMissing?: boolean): boolean;
-    getNode<T extends Node>(type: NodeType | undefined, name: string, undefOnMissing?: boolean): Promise<T | undefined>;
+    getNode<T extends NodeInFS<any>>(type: NodeType | undefined, name: string, undefOnMissing?: boolean): Promise<T | undefined>;
     private getOrMakeChildNodeForInfo;
     getFolder(name: string, undefOnMissing?: boolean): Promise<FolderNode | undefined>;
     getFile(name: string, undefOnMissing?: boolean): Promise<FileNode | undefined>;
@@ -131,17 +137,22 @@ export declare class FolderNode extends NodeInFS<FolderPersistance> {
      */
     isEmpty(): boolean;
     private getAllNodes;
-    protected delete(src: FSChangeSrc): Promise<void>;
+    private removeFolderObj;
+    private callRemoveObjOnAll;
+    private removeChildrenObjsInSyncedStorage;
+    private uploadRemovalOfObjs;
     getParamsForLink(): LinkParameters<FolderLinkParams>;
     upload(opts: OptionsToUploadLocal | undefined): Promise<void>;
+    private uploadRemovalOf;
+    private listRemovedInTreeToUploadRm;
     protected needUpload(localVersion: number | undefined): Promise<{
         localVersion: number;
         uploadVersion: number;
         createOnRemote: boolean;
     } | undefined>;
+    private getNodesRemovedBetweenVersions;
     adoptRemoteFolderItem(itemName: string, opts: OptionsToAdoptRemoteItem | undefined): Promise<number>;
     private addRemoteChild;
-    private setRemoteNodeInfo;
     private replaceLocalChildWithRemote;
     diffCurrentAndRemote(remoteVersion: number | undefined): Promise<FolderDiff | undefined>;
     private diffWithArchivedRemote;